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.74.3 <http://docbook.sf.net/>
   5 .\"      Date: 08 Feb 2010
   6 .\"    Manual: Netatalk 2.1
   7 .\"    Source: Netatalk 2.1
   8 .\"  Language: English
   9 .\"
  10 .TH "AFPD" "8" "08 Feb 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 The list of volumes offered to the user is generated from
  34 :ETCDIR:/AppleVolumes\&.system
  35 and one of
  36 :ETCDIR:/AppleVolumes\&.default,
  37 ~/AppleVolumes, or
  38 ~/\&.AppleVolumes\&. The
  39 AppleVolumes
  40 files is used to specify volumes to mount and file name extension mappings\&. It is formatted as follows, one specification per line: pathname [ volumename ] \&.extension [ type [ creator ] ] If volumename is unspecified, the last component of pathname is used\&. No two volumes may have the same name\&. The extension \'\&.\' sets the default creator and type for otherwise untyped Unix files\&. Blank lines and lines beginning with `#\' are ignored\&.
  41 .PP
  42 .SH "OPTIONS"
  43 .PP
  44 \-d
  45 .RS 4
  46 Specifies that the daemon should not fork\&. If netatalk has been configured with
  47 \fI\-\-enable\-debug1\fR, a trace of all AFP commands will be written to stdout\&.
  48 .RE
  49 .PP
  50 \-p
  51 .RS 4
  52 Prevents clients from saving their passwords\&. (Equivalent to \-\fBnosavepasswd\fR
  53 in
  54 afpd\&.conf\&.)
  55 .RE
  56 .PP
  57 \-t
  58 .RS 4
  59 Allows clients to change their passwords\&. (Equivalent to
  60 \fB\-setpasswd\fR
  61 in
  62 afpd\&.conf\&.)
  63 .RE
  64 .PP
  65 \-D
  66 .RS 4
  67 Use DDP (AppleTalk) as transport protocol\&. (Equivalent to
  68 \fB\-ddp\fR
  69 in
  70 afpd\&.cond\&.)
  71 .RE
  72 .PP
  73 \-T
  74 .RS 4
  75 Use TCP/IP as transport protocol\&. (Equivalent to
  76 \fB\-tcp\fR
  77 in
  78 afpd\&.conf\&.)
  79 .RE
  80 .PP
  81 \-v
  82 .RS 4
  83 Print version information and exit\&.
  84 .RE
  85 .PP
  86 \-V
  87 .RS 4
  88 Print verbose information and exit\&.
  89 .RE
  90 .PP
  91 \-h
  92 .RS 4
  93 Print help and exit\&.
  94 .RE
  95 .PP
  96 \-I
  97 .RS 4
  98 Use a platform specific icon\&. (Equivalent to
  99 \fB\-icon\fR
 100 in
 101 afpd\&.conf\&.) (Recent Mac OS don\'t display it\&.)
 102 .RE
 103 .PP
 104 \-f \fIdefaultvolumes\fR
 105 .RS 4
 106 Specifies that
 107 \fIdefaultvolumes\fR
 108 should be read for a list of default volumes to offer, instead of
 109 :ETCDIR:/AppleVolumes\&.default\&.
 110 .RE
 111 .PP
 112 \-s \fIsystemvolumes\fR
 113 .RS 4
 114 Specifies that
 115 \fIsystemvolumes\fR
 116 should be read for a list of volume that all users will be offered, instead of
 117 :ETCDIR:/AppleVolumes\&.system\&.
 118 .RE
 119 .PP
 120 \-u
 121 .RS 4
 122 Read the user\'s
 123 AppleVolumes
 124 file first\&. This option causes volume names in the user\'s
 125 AppleVolumes
 126 file to override volume names in the system\'s
 127 AppleVolumes
 128 file\&. The default is to read the system
 129 AppleVolumes
 130 file first\&. Note that this option doesn\'t effect the precendence of filename extension mappings: the user\'s
 131 AppleVolumes
 132 file always has precedence\&.
 133 .RE
 134 .PP
 135 \-n \fInbpname\fR
 136 .RS 4
 137 Specifies that
 138 \fInbpname\fR
 139 should be used for NBP registration, instead of the first component of the hostname in the local zone\&.
 140 .RE
 141 .PP
 142 \-c \fImaxconnections\fR
 143 .RS 4
 144 Specifies the maximum number of connections to allow for this
 145 \fBafpd\fR\&. The default is 20\&.
 146 .RE
 147 .PP
 148 \-g \fIguest\fR
 149 .RS 4
 150 Specifies the name of the guest account\&. The default is \'\fInobody\fR\'\&.
 151 .RE
 152 .PP
 153 \-P \fIpidfile\fR
 154 .RS 4
 155 Specifies the file in which
 156 \fBafpd\fR
 157 stores its process id\&.
 158 .RE
 159 .PP
 160 \-S \fIport\fR
 161 .RS 4
 162 Specifies the port to register with when doing AFPoverTCP\&. Defaults to 548\&. (Equivalent to
 163 \fB\-port \fRin
 164 afpd\&.conf\&.)
 165 .RE
 166 .PP
 167 \-L \fImessage\fR
 168 .RS 4
 169 Specifies the login message that will be sent to clients\&. (Equivalent to
 170 \fB\-loginmsg\fR
 171 in
 172 afpd\&.conf\&.)
 173 .RE
 174 .PP
 175 \-F \fIconfigfile\fR
 176 .RS 4
 177 Specifies the configuration file to use\&. (Defaults to
 178 :ETCDIR:/netatalk/afpd\&.conf\&.)
 179 .RE
 180 .PP
 181 \-U \fIuams\fR
 182 .RS 4
 183 Comma\-separated list of UAMs to use for the authentication process\&. (Equivalent to
 184 \fB\-uamlist\fR
 185 in
 186 afpd\&.conf\&.)
 187 .RE
 188 .PP
 189 \-m \fIumask\fR
 190 .RS 4
 191 Use this
 192 \fIumask\fR
 193 for the creation of folders in Netatalk\&.
 194 .RE
 195 .SH "SIGNALS"
 196 .PP
 197 Signals that are sent to the main
 198 \fBafpd\fR
 199 process are propagated to the children, so all will be affected\&.
 200 .PP
 201 SIGHUP
 202 .RS 4
 203 Sending a
 204 \fBSIGHUP\fR
 205 to afpd will cause it to reload its configuration files\&.
 206 .RE
 207 .PP
 208 SIGINT
 209 .RS 4
 210 Sending a
 211 \fBSIGINT\fR
 212 to a child
 213 \fBafpd\fR
 214 enables
 215 \fImax_debug\fR
 216 logging for this process\&. The log is sent to fhe file
 217 /tmp/afpd\&.PID\&.XXXXXX\&. Sending another
 218 \fBSIGINT\fR
 219 will terminate the process\&.
 220 .RE
 221 .PP
 222 SIGUSR1
 223 .RS 4
 224 The
 225 \fBafpd\fR
 226 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\&.
 227 .RE
 228 .PP
 229 SIGUSR2
 230 .RS 4
 231 The
 232 \fBafpd\fR
 233 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
 234 \fBafpd\fR\&.
 235 .sp
 236 To shut down a user\'s
 237 \fBafpd\fR
 238 process it is recommended that
 239 \fBSIGKILL (\-9)\fR
 240 \fINOT\fR
 241 be used, except as a last resort, as this may leave the CNID database in an inconsistent state\&. The safe way to terminate an
 242 \fBafpd\fR
 243 is to send it a
 244 \fBSIGTERM (\-15)\fR
 245 signal and wait for it to die on its own\&.
 246 .RE
 247 .SH "FILES"
 248 .PP
 249 :ETCDIR:/AppleVolumes\&.default
 250 .RS 4
 251 list of default volumes to mount
 252 .RE
 253 .PP
 254 :ETCDIR:/AppleVolumes\&.system
 255 .RS 4
 256 list of volumes to offer all users
 257 .RE
 258 .PP
 259 ~/AppleVolumes, ~/\&.AppleVolumes
 260 .RS 4
 261 user\'s list of volumes to mount
 262 .RE
 263 .PP
 264 :ETCDIR:/netatalk/msg/message\&.pid
 265 .RS 4
 266 contains messages to be sent to users\&.
 267 .RE
 268 .SH "BUGS"
 269 .PP
 270 .SH "SEE ALSO"
 271 .PP
 272 \fBhosts_access\fR(5),
 273 \fBafpd.conf\fR(5),
 274 \fBAppleVolumes.default\fR(5),
 275 \fBAppleVolumes.system\fR(5),
 276 \fBafp_signature.conf\fR(5),
 277 \fBdbd\fR(1)\&.