man/man8/afpd.8.tmpl

   1 '\" t
   2 .\"     Title: afpd
   3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
   5 .\"      Date: 21 Apr 2010
   6 .\"    Manual: Netatalk 2.1
   7 .\"    Source: Netatalk 2.1
   8 .\"  Language: English
   9 .\"
  10 .TH "AFPD" "8" "21 Apr 2010" "Netatalk 2.1" "Netatalk 2.1"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 afpd \- Apple Filing Protocol daemon
  23 .SH "SYNOPSIS"
  24 .HP \w'\fBafpd\fR\fB\fR\fBafpd\fR\fB\fR\ 'u
  25 \fBafpd\fR\fB\fR [\-duptDTI] [\-f\ \fIdefaultvolumes\fR] [\-s\ \fIsystemvolumes\fR] [\-n\ \fInbpname\fR] [\-c\ \fImaxconnections\fR] [\-g\ \fIguest\fR] [\-P\ \fIpidfile\fR] [\-S\ \fIport\fR] [\-L\ \fImessage\fR] [\-F\ \fIconfigfile\fR] [\-U\ \fIuams\fR] [\-m\ \fIumask\fR]
  26 .br
  27 \fBafpd\fR\fB\fR \-v | \-V | \-h
  28 .SH "DESCRIPTION"
  29 .PP
  30 \fBafpd\fR
  31 provides an Apple Filing Protocol (AFP) interface to the Unix file system\&. It is normally started at boot time from /etc/rc\&.
  32 .PP
  33 :ETCDIR:/afpd\&.conf
  34 is the configuration file used by
  35 \fBafpd\fR
  36 to determine the behavior and configuration of the different virtual file servers that it provides\&.
  37 .PP
  38 The list of volumes offered to the user is generated from
  39 :ETCDIR:/AppleVolumes\&.system
  40 and one of
  41 :ETCDIR:/AppleVolumes\&.default,
  42 ~/AppleVolumes,
  43 ~/\&.AppleVolumes,
  44 ~/applevolumes, or
  45 ~/\&.applevolumes\&. The
  46 AppleVolumes
  47 files is used to specify volumes to mount and file name extension mappings\&.
  48 .PP
  49 .SH "OPTIONS"
  50 .PP
  51 \-d
  52 .RS 4
  53 Specifies that the daemon should not fork\&. If netatalk has been configured with
  54 \fI\-\-enable\-debug1\fR, a trace of all AFP commands will be written to stdout\&.
  55 .RE
  56 .PP
  57 \-p
  58 .RS 4
  59 Prevents clients from saving their passwords\&. (Equivalent to \-\fBnosavepasswd\fR
  60 in
  61 afpd\&.conf\&.)
  62 .RE
  63 .PP
  64 \-t
  65 .RS 4
  66 Allows clients to change their passwords\&. (Equivalent to
  67 \fB\-setpasswd\fR
  68 in
  69 afpd\&.conf\&.)
  70 .RE
  71 .PP
  72 \-D
  73 .RS 4
  74 Use DDP (AppleTalk) as transport protocol\&. (Equivalent to
  75 \fB\-ddp\fR
  76 in
  77 afpd\&.cond\&.)
  78 .RE
  79 .PP
  80 \-T
  81 .RS 4
  82 Use TCP/IP as transport protocol\&. (Equivalent to
  83 \fB\-tcp\fR
  84 in
  85 afpd\&.conf\&.)
  86 .RE
  87 .PP
  88 \-v
  89 .RS 4
  90 Print version information and exit\&.
  91 .RE
  92 .PP
  93 \-V
  94 .RS 4
  95 Print verbose information and exit\&.
  96 .RE
  97 .PP
  98 \-h
  99 .RS 4
 100 Print help and exit\&.
 101 .RE
 102 .PP
 103 \-I
 104 .RS 4
 105 Use a platform specific icon\&. (Equivalent to
 106 \fB\-icon\fR
 107 in
 108 afpd\&.conf\&.) (Recent Mac OS don\'t display it\&.)
 109 .RE
 110 .PP
 111 \-f \fIdefaultvolumes\fR
 112 .RS 4
 113 Specifies that
 114 \fIdefaultvolumes\fR
 115 should be read for a list of default volumes to offer, instead of
 116 :ETCDIR:/AppleVolumes\&.default\&.
 117 .RE
 118 .PP
 119 \-s \fIsystemvolumes\fR
 120 .RS 4
 121 Specifies that
 122 \fIsystemvolumes\fR
 123 should be read for a list of volume that all users will be offered, instead of
 124 :ETCDIR:/AppleVolumes\&.system\&.
 125 .RE
 126 .PP
 127 \-u
 128 .RS 4
 129 Read the user\'s
 130 AppleVolumes
 131 file first\&. This option causes volume names in the user\'s
 132 AppleVolumes
 133 file to override volume names in the system\'s
 134 AppleVolumes
 135 file\&. The default is to read the system
 136 AppleVolumes
 137 file first\&. Note that this option doesn\'t effect the precendence of filename extension mappings: the user\'s
 138 AppleVolumes
 139 file always has precedence\&.
 140 .RE
 141 .PP
 142 \-n \fInbpname\fR
 143 .RS 4
 144 Specifies that
 145 \fInbpname\fR
 146 should be used for NBP registration, instead of the first component of the hostname in the local zone\&.
 147 .RE
 148 .PP
 149 \-c \fImaxconnections\fR
 150 .RS 4
 151 Specifies the maximum number of connections to allow for this
 152 \fBafpd\fR\&. The default is 20\&.
 153 .RE
 154 .PP
 155 \-g \fIguest\fR
 156 .RS 4
 157 Specifies the name of the guest account\&. The default is \'\fInobody\fR\'\&.
 158 .RE
 159 .PP
 160 \-P \fIpidfile\fR
 161 .RS 4
 162 Specifies the file in which
 163 \fBafpd\fR
 164 stores its process id\&.
 165 .RE
 166 .PP
 167 \-S \fIport\fR
 168 .RS 4
 169 Specifies the port to register with when doing AFPoverTCP\&. Defaults to 548\&. (Equivalent to
 170 \fB\-port \fRin
 171 afpd\&.conf\&.)
 172 .RE
 173 .PP
 174 \-L \fImessage\fR
 175 .RS 4
 176 Specifies the login message that will be sent to clients\&. (Equivalent to
 177 \fB\-loginmsg\fR
 178 in
 179 afpd\&.conf\&.)
 180 .RE
 181 .PP
 182 \-F \fIconfigfile\fR
 183 .RS 4
 184 Specifies the configuration file to use\&. (Defaults to
 185 :ETCDIR:/netatalk/afpd\&.conf\&.)
 186 .RE
 187 .PP
 188 \-U \fIuams\fR
 189 .RS 4
 190 Comma\-separated list of UAMs to use for the authentication process\&. (Equivalent to
 191 \fB\-uamlist\fR
 192 in
 193 afpd\&.conf\&.)
 194 .RE
 195 .PP
 196 \-m \fIumask\fR
 197 .RS 4
 198 Use this
 199 \fIumask\fR
 200 for the creation of folders in Netatalk\&.
 201 .RE
 202 .SH "SIGNALS"
 203 .PP
 204 Signals that are sent to the main
 205 \fBafpd\fR
 206 process are propagated to the children, so all will be affected\&.
 207 .PP
 208 SIGHUP
 209 .RS 4
 210 Sending a
 211 \fBSIGHUP\fR
 212 to afpd will cause it to reload its configuration files\&.
 213 .RE
 214 .PP
 215 SIGINT
 216 .RS 4
 217 Sending a
 218 \fBSIGINT\fR
 219 to a child
 220 \fBafpd\fR
 221 enables
 222 \fImax_debug\fR
 223 logging for this process\&. The log is sent to fhe file
 224 /tmp/afpd\&.PID\&.XXXXXX\&. Sending another
 225 \fBSIGINT\fR
 226 will terminate the process\&.
 227 .RE
 228 .PP
 229 SIGUSR1
 230 .RS 4
 231 The
 232 \fBafpd\fR
 233 process will send the message "The server is going down for maintenance\&." to the client and shut itself down in 5 minutes\&. New connections are not allowed\&. If this is sent to a child afpd, the other children are not affected\&. However, the main process will still exit, disabling all new connections\&.
 234 .RE
 235 .PP
 236 SIGUSR2
 237 .RS 4
 238 The
 239 \fBafpd\fR
 240 process will look in the message directory configured at build time for a file named message\&.pid\&. For each one found, a the contents will be sent as a message to the associated AFP client\&. The file is removed after the message is sent\&. This should only be sent to a child
 241 \fBafpd\fR\&.
 242 .sp
 243 To shut down a user\'s
 244 \fBafpd\fR
 245 process it is recommended that
 246 \fBSIGKILL (\-9)\fR
 247 \fINOT\fR
 248 be used, except as a last resort, as this may leave the CNID database in an inconsistent state\&. The safe way to terminate an
 249 \fBafpd\fR
 250 is to send it a
 251 \fBSIGTERM (\-15)\fR
 252 signal and wait for it to die on its own\&.
 253 .RE
 254 .SH "FILES"
 255 .PP
 256 :ETCDIR:/afpd\&.conf
 257 .RS 4
 258 configuration file used by afpd
 259 .RE
 260 .PP
 261 :ETCDIR:/AppleVolumes\&.default
 262 .RS 4
 263 list of default volumes to mount
 264 .RE
 265 .PP
 266 :ETCDIR:/AppleVolumes\&.system
 267 .RS 4
 268 list of volumes to offer all users
 269 .RE
 270 .PP
 271 ~/AppleVolumes, ~/\&.AppleVolumes, ~/applevolumes, ~/\&.applevolumes
 272 .RS 4
 273 user\'s list of volumes to mount
 274 .RE
 275 .PP
 276 :ETCDIR:/afp_signature\&.conf
 277 .RS 4
 278 list of server signature
 279 .RE
 280 .PP
 281 :ETCDIR:/netatalk/msg/message\&.pid
 282 .RS 4
 283 contains messages to be sent to users\&.
 284 .RE
 285 .SH "BUGS"
 286 .PP
 287 .SH "SEE ALSO"
 288 .PP
 289 \fBhosts_access\fR(5),
 290 \fBafpd.conf\fR(5),
 291 \fBAppleVolumes.default\fR(5),
 292 \fBafp_signature.conf\fR(5),
 293 \fBdbd\fR(1)\&.