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