man/man8/afpd.8.tmpl

   1 .TH AFPD 8 "23 Feb 1999" "netatalk 1.4b2/asun 2.1.3"
   2
   3 .SH NAME
   4 afpd \- AppleTalk Filing Protocol daemon
   5 .SH SYNOPSIS
   6 .B afpd
   7 [
   8 .B -duptDTvI
   9 ]
  10 [
  11 .B -f
  12 .I defaultvolumes
  13 ]
  14 [
  15 .B -s
  16 .I systemvolumes
  17 ]
  18 [
  19 .B -n
  20 .I nbpname
  21 ]
  22 [
  23 .B -c
  24 .I maxconnections
  25 ]
  26 [
  27 .B -g
  28 .I guest
  29 ]
  30 [
  31 .B -P
  32 .I pidfile
  33 ]
  34 [
  35 .B -S
  36 .I port
  37 ]
  38 [
  39 .B -L
  40 .I message
  41 ]
  42 [
  43 .B -F
  44 .I config
  45 ]
  46 [
  47 .B -U
  48 .I uams
  49 ]
  50 [
  51 .B -m
  52 .I umask
  53 ]
  54 .SH DESCRIPTION
  55 .B afpd
  56 provides an AppleTalk Filing Protocol (AFP)
  57 interface to the Unix file system.  It is normally started at boot time
  58 from
  59 .BR /etc/rc .
  60 The list of volumes offered to the user is generated from
  61 .B :ETCDIR:/AppleVolumes.system
  62 and one of
  63 .BR :ETCDIR:/AppleVolumes.default ,
  64 .BR ~/AppleVolumes ,
  65 or
  66 .BR ~/.AppleVolumes .
  67 .LP
  68 The
  69 .B AppleVolumes
  70 files is used to specify volumes to mount and file name extension mappings.
  71 It is formatted as follows, one specification per line:
  72 .RS
  73 .sp
  74 .I pathname
  75 [
  76 .I volumename
  77 ]
  78 .br
  79 .RI . extension
  80 [
  81 .I type
  82 [
  83 .I creator
  84 ]
  85 ]
  86 .sp
  87 .RE
  88 If
  89 .I volumename
  90 is unspecified, the last component of
  91 .I pathname
  92 is used.  No two volumes may have the same name.  If
  93 .I type
  94 is unspecified
  95 .RB ' ???? '
  96 is used.  If
  97 .I creator
  98 is unspecified
  99 .RB ' UNIX '
 100 is used.  The extension
 101 .RB ' . '
 102 sets the default creator and type for otherwise untyped Unix files.
 103 Blank lines and lines beginning with `#' are ignored.
 104 .SH OPTIONS
 105 .TP
 106 .B \-d
 107 Specifies that the daemon not fork, and that a trace of all AFP
 108 commands be written to stdout.
 109 .TP
 110 .BI \-f " defaultvolumes"
 111 Specifies that
 112 .I defaultvolumes
 113 should be read for a list of default volumes to offer, instead of
 114 .BR :ETCDIR:/AppleVolumes.default .
 115 .TP
 116 .BI \-s " systemvolumes"
 117 Specifies that
 118 .I systemvolumes
 119 should be read for a list of volume that all users will be offered,
 120 instead of
 121 .BR :ETCDIR:/AppleVolumes.system .
 122 .TP
 123 .B \-u
 124 Read the user's
 125 .B AppleVolumes
 126 file first.  This option causes volume names in the user's
 127 .B AppleVolumes
 128 file to override volume names in the system's
 129 .B AppleVolumes
 130 file.  The default is to read the system
 131 .B AppleVolumes
 132 file first.  Note that this option doesn't effect the precendence of
 133 filename extension mappings: the user's AppleVolumes file always has
 134 precedence.
 135 .TP
 136 .BI \-n " nbpname"
 137 Specifies that
 138 .I nbpname
 139 should be used for NBP registration, instead of the first component of
 140 the hostname in the local zone.
 141 .TP
 142 .BI \-c " maxconnections"
 143 Specifies the maximum number of connections to allow for this
 144 .BR afpd .
 145 The default is 5.
 146 .TP
 147 .BI \-g " guest"
 148 Specifies the name of the guest account.  The default is ``nobody''.
 149 .TP
 150 .BI \-P " pidfile"
 151 Specifies the file in which
 152 .B afpd
 153 stores its process id.
 154 .TP
 155 .B \-p
 156 Prevents clients from saving their passwords. (Equivalent to
 157 .I \-nosavepasswd
 158 in
 159 .BR afpd.conf .)
 160 .TP
 161 .B \-t
 162 Allows clients to change their passwords. (Equivalent to
 163 .I \-setpasswd
 164 in
 165 .BR afpd.conf .)
 166 .TP
 167 .B \-D
 168 Use DDP (AppleTalk) as transport protocol. (Equivalent to
 169 .I \-ddp
 170 in
 171 .BR afpd.cond .)
 172 .TP
 173 .B \-T
 174 Use TCP/IP as transport protocol. (Equivalent to
 175 .I \-tcp
 176 in
 177 .BR afpd.conf .)
 178 .TP
 179 .BI \-S " port"
 180 Specifies the port to register with when doing AFPoverTCP. Defaults to
 181 .IR 548 .
 182 (Equivalent to
 183 .I -port
 184 in
 185 .BR afpd.conf .)
 186 .TP
 187 .BI \-L " message"
 188 Specifies the login message that will be sent to clients. (Equivalent to
 189 .I \-loginmsg
 190 in
 191 .BR afpd.conf .)
 192 .TP
 193 .BI \-F " config"
 194 Specifies the configuration file to use. (Defaults to
 195 .IR :ETCDIR:/afpd.conf .)
 196 .TP
 197 .BI \-U " uams"
 198 Comma-separated list of UAMs to use for the authentication process.
 199 (Equivalent to
 200 .I -uamlist
 201 in
 202 .BR afpd.conf .)
 203 .TP
 204 .B \-I
 205 Use a platform specific icon. (Equivalent to
 206 .I \-icon
 207 in
 208 .BR afpd.conf .)
 209 .TP
 210 .BR \-m " umask"
 211 Use this umask for the creation of folders in Netatalk.
 212 .TP
 213 .B \-v
 214 Print version information and exit.
 215 .SH AUTHENTICATION
 216 .B afpd
 217 currently understands three User Authentication Methods (UAMs):
 218 .BR NoUserAuthent ,
 219 or guest,
 220 .B Cleartxt
 221 .BR passwrd ,
 222 and
 223 .B Kerberos
 224 .BR IV .
 225 If a user uses
 226 .BR NoUserAuthent ,
 227 s/he will only be offered default volumes to mount, and will only be able
 228 to read and write files that are permitted to the guest user.  The
 229 .B -G
 230 option disables
 231 .BR NoUserAuthent .
 232 With
 233 .B Cleartxt passwd
 234 and
 235 .B Kerberos
 236 .BR IV ,
 237 .B afpd
 238 offers the user all volumes listed in
 239 .BR ~/AppleVolumes .
 240 The user may also read and write all files that s/he normally could.
 241 .B Cleartxt passwd
 242 is not recommended for AFS use.
 243 .B Kerberos IV
 244 is recommended for AFS use.
 245 A forth, depricated UAM is also included in the distribution,
 246 .B AFS
 247 .BR Kerberos .
 248 .SH CAVEATS
 249 .BR afpd 's
 250 Directory IDs are only fixed for the duration of a session.  This means
 251 that Mac aliases won't work correctly in all cases.
 252 .LP
 253 If a user renames a folder that has an application as its progeny, the
 254 .B APPL
 255 mapping for the application will not longer be available. This implies
 256 that double-clicking on one of the application's documents will no
 257 longer launch the application. The
 258 .B APPL
 259 mapping will be rebuilt by the mac, the next time the Finder see the
 260 application.
 261 .LP
 262 If
 263 .B afpd
 264 is configured to downcase Macintosh filenames, Unix filenames with
 265 mixed case will be unavailable.
 266 .LP
 267 If carriage return/line feed translation is enabled, it is not
 268 safe to copy Unix binaries to a Macintosh.
 269 .LP
 270 It is not possible to move directories between devices.
 271 .LP
 272 When mounting the parent of an existing volume, the desktop database of
 273 the existing volume will not be available to the parent volume.  The
 274 .B APPL
 275 mappings and icons of applications with the
 276 .B BNDL
 277 bit set will be generated in the parent volume as the applications are
 278 seen by the Finder.
 279 .LP
 280 If a user edits his
 281 .B ~/AppleVolumes
 282 so that his home directory is no longer offered, he will no longer be able
 283 to edit his
 284 .B ~/AppleVolumes
 285 from the Macintosh.
 286 .LP
 287 Unix files beginning with `.' are not accessible from the mac.
 288 .LP
 289 If the
 290 .I pathname
 291 in an
 292 .B ~/AppleVolumes
 293 file does not exist, the volume will not be offered in the Chooser.
 294 .LP
 295 Microsoft Word
 296 .B TEXT
 297 documents do not get carriage return/line feed translation.  This is
 298 because MS Word uses a type other than
 299 .B TEXT
 300 while writing the document, then changes the type to
 301 .BR TEXT .
 302 To allow users to edit their
 303 .BR ~/AppleVolumes ,
 304 .B afpd
 305 parses the files with either end of line character.
 306 .LP
 307 Unix filenames that are longer than 31 characters are inaccessible from
 308 the Macintosh.
 309
 310 .SH SIGNALS
 311 Signals that are sent to the main
 312 .B afpd
 313 process are propagated to the children, so all will be affected.
 314 .TP 13
 315 .B SIGHUP
 316 The
 317 .B afpd
 318 process will send the message "The server is going down for maintenance."
 319 to the client and shut itself down in 5 minutes.  New connections are not
 320 allowed.  If this is sent to a child
 321 .BR afpd ,
 322 the other children are not affected.  However, the main process will still
 323 exit, disabling all new connections.
 324 .TP 13
 325 .B SIGUSR1
 326 If the
 327 .B --with-message-dir
 328 configure option was used, the
 329 .B afpd
 330 process will set the
 331 .B debug
 332 option and redirect the messages to
 333 .RI /var/tmp/afpd-debug- pid .
 334 This should only be sent to a child
 335 .BR afpd .
 336 .B Warning:
 337 If the
 338 .B --with-message-dir
 339 option was not used, this will kill the
 340 .B afpd
 341 process.
 342
 343 .TP 13
 344 .B SIGUSR2
 345 The
 346 .B afpd
 347 process will look in the
 348 .I msg
 349 directory for a file named
 350 .RI message. pid .
 351 For each one found, a the contents will be sent as a message to the
 352 associated AFP client.  The file is removed after the message is sent.
 353
 354 .SH FILES
 355 .TP 20
 356 .B :ETCDIR:/AppleVolumes.default
 357 list of default volumes to mount
 358 .TP 20
 359 .B :ETCDIR:/AppleVolumes.system
 360 list of volumes to offer all users
 361 .TP 20
 362 .B ~/AppleVolumes
 363 user's list of volumes to mount
 364 .TP 20
 365 .BI :ETCDIR:/msg/message. pid
 366 contains messages to be sent to users.
 367 .TP 20
 368 .BI /var/tmp/afpd-debug- pid
 369 contains debug output, if triggered.
 370 .SH BUGS
 371 A few calls from the AFP specification are not implemented, because the
 372 Macintosh does not use them.