-.TH AFPD 8 "23 Feb 1999" "netatalk 1.4b2/asun 2.1.3"
-
-.SH NAME
-afpd \- AppleTalk Filing Protocol daemon
-.SH SYNOPSIS
-.B afpd
-[
-.B -duptDTvI
-]
-[
-.B -f
-.I defaultvolumes
-]
-[
-.B -s
-.I systemvolumes
-]
-[
-.B -n
-.I nbpname
-]
-[
-.B -c
-.I maxconnections
-]
-[
-.B -g
-.I guest
-]
-[
-.B -P
-.I pidfile
-]
-[
-.B -S
-.I port
-]
-[
-.B -L
-.I message
-]
-[
-.B -F
-.I config
-]
-[
-.B -U
-.I uams
-]
-[
-.B -m
-.I umask
-]
-.SH DESCRIPTION
-.B afpd
-provides an AppleTalk Filing Protocol (AFP)
-interface to the Unix file system. It is normally started at boot time
-from
-.BR /etc/rc .
+'\" t
+.\" Title: afpd
+.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
+.\" Date: 21 Apr 2010
+.\" Manual: Netatalk 2.1
+.\" Source: Netatalk 2.1
+.\" Language: English
+.\"
+.TH "AFPD" "8" "21 Apr 2010" "Netatalk 2.1" "Netatalk 2.1"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+afpd \- Apple Filing Protocol daemon
+.SH "SYNOPSIS"
+.HP \w'\fBafpd\fR\fB\fR\fBafpd\fR\fB\fR\ 'u
+\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]
+.br
+\fBafpd\fR\fB\fR \-v | \-V | \-h
+.SH "DESCRIPTION"
+.PP
+\fBafpd\fR
+provides an Apple Filing Protocol (AFP) interface to the Unix file system\&. It is normally started at boot time from /etc/rc\&.
+.PP
+:ETCDIR:/afpd\&.conf
+is the configuration file used by
+\fBafpd\fR
+to determine the behavior and configuration of the different virtual file servers that it provides\&.
+.PP
The list of volumes offered to the user is generated from
-.B :ETCDIR:/AppleVolumes.system
+:ETCDIR:/AppleVolumes\&.system
and one of
-.BR :ETCDIR:/AppleVolumes.default ,
-.BR ~/AppleVolumes ,
-or
-.BR ~/.AppleVolumes .
-.LP
-The
-.B AppleVolumes
-files is used to specify volumes to mount and file name extension mappings.
-It is formatted as follows, one specification per line:
-.RS
-.sp
-.I pathname
-[
-.I volumename
-]
-.br
-.RI . extension
-[
-.I type
-[
-.I creator
-]
-]
-.sp
+:ETCDIR:/AppleVolumes\&.default,
+~/AppleVolumes,
+~/\&.AppleVolumes,
+~/applevolumes, or
+~/\&.applevolumes\&. The
+AppleVolumes
+files is used to specify volumes to mount and file name extension mappings\&.
+.PP
+.SH "OPTIONS"
+.PP
+\-d
+.RS 4
+Specifies that the daemon should not fork\&. If netatalk has been configured with
+\fI\-\-enable\-debug1\fR, a trace of all AFP commands will be written to stdout\&.
+.RE
+.PP
+\-p
+.RS 4
+Prevents clients from saving their passwords\&. (Equivalent to \-\fBnosavepasswd\fR
+in
+afpd\&.conf\&.)
+.RE
+.PP
+\-t
+.RS 4
+Allows clients to change their passwords\&. (Equivalent to
+\fB\-setpasswd\fR
+in
+afpd\&.conf\&.)
+.RE
+.PP
+\-D
+.RS 4
+Use DDP (AppleTalk) as transport protocol\&. (Equivalent to
+\fB\-ddp\fR
+in
+afpd\&.cond\&.)
+.RE
+.PP
+\-T
+.RS 4
+Use TCP/IP as transport protocol\&. (Equivalent to
+\fB\-tcp\fR
+in
+afpd\&.conf\&.)
+.RE
+.PP
+\-v
+.RS 4
+Print version information and exit\&.
+.RE
+.PP
+\-V
+.RS 4
+Print verbose information and exit\&.
+.RE
+.PP
+\-h
+.RS 4
+Print help and exit\&.
+.RE
+.PP
+\-I
+.RS 4
+Use a platform specific icon\&. (Equivalent to
+\fB\-icon\fR
+in
+afpd\&.conf\&.) (Recent Mac OS don\'t display it\&.)
.RE
-If
-.I volumename
-is unspecified, the last component of
-.I pathname
-is used. No two volumes may have the same name. If
-.I type
-is unspecified
-.RB ' ???? '
-is used. If
-.I creator
-is unspecified
-.RB ' UNIX '
-is used. The extension
-.RB ' . '
-sets the default creator and type for otherwise untyped Unix files.
-Blank lines and lines beginning with `#' are ignored.
-.SH OPTIONS
-.TP
-.B \-d
-Specifies that the daemon not fork, and that a trace of all AFP
-commands be written to stdout.
-.TP
-.BI \-f " defaultvolumes"
+.PP
+\-f \fIdefaultvolumes\fR
+.RS 4
Specifies that
-.I defaultvolumes
+\fIdefaultvolumes\fR
should be read for a list of default volumes to offer, instead of
-.BR :ETCDIR:/AppleVolumes.default .
-.TP
-.BI \-s " systemvolumes"
+:ETCDIR:/AppleVolumes\&.default\&.
+.RE
+.PP
+\-s \fIsystemvolumes\fR
+.RS 4
Specifies that
-.I systemvolumes
-should be read for a list of volume that all users will be offered,
-instead of
-.BR :ETCDIR:/AppleVolumes.system .
-.TP
-.B \-u
-Read the user's
-.B AppleVolumes
-file first. This option causes volume names in the user's
-.B AppleVolumes
-file to override volume names in the system's
-.B AppleVolumes
-file. The default is to read the system
-.B AppleVolumes
-file first. Note that this option doesn't effect the precendence of
-filename extension mappings: the user's AppleVolumes file always has
-precedence.
-.TP
-.BI \-n " nbpname"
+\fIsystemvolumes\fR
+should be read for a list of volume that all users will be offered, instead of
+:ETCDIR:/AppleVolumes\&.system\&.
+.RE
+.PP
+\-u
+.RS 4
+Read the user\'s
+AppleVolumes
+file first\&. This option causes volume names in the user\'s
+AppleVolumes
+file to override volume names in the system\'s
+AppleVolumes
+file\&. The default is to read the system
+AppleVolumes
+file first\&. Note that this option doesn\'t effect the precendence of filename extension mappings: the user\'s
+AppleVolumes
+file always has precedence\&.
+.RE
+.PP
+\-n \fInbpname\fR
+.RS 4
Specifies that
-.I nbpname
-should be used for NBP registration, instead of the first component of
-the hostname in the local zone.
-.TP
-.BI \-c " maxconnections"
+\fInbpname\fR
+should be used for NBP registration, instead of the first component of the hostname in the local zone\&.
+.RE
+.PP
+\-c \fImaxconnections\fR
+.RS 4
Specifies the maximum number of connections to allow for this
-.BR afpd .
-The default is 5.
-.TP
-.BI \-g " guest"
-Specifies the name of the guest account. The default is ``nobody''.
-.TP
-.BI \-P " pidfile"
+\fBafpd\fR\&. The default is 20\&.
+.RE
+.PP
+\-g \fIguest\fR
+.RS 4
+Specifies the name of the guest account\&. The default is \'\fInobody\fR\'\&.
+.RE
+.PP
+\-P \fIpidfile\fR
+.RS 4
Specifies the file in which
-.B afpd
-stores its process id.
-.TP
-.B \-p
-Prevents clients from saving their passwords. (Equivalent to
-.I \-nosavepasswd
-in
-.BR afpd.conf .)
-.TP
-.B \-t
-Allows clients to change their passwords. (Equivalent to
-.I \-setpasswd
-in
-.BR afpd.conf .)
-.TP
-.B \-D
-Use DDP (AppleTalk) as transport protocol. (Equivalent to
-.I \-ddp
-in
-.BR afpd.cond .)
-.TP
-.B \-T
-Use TCP/IP as transport protocol. (Equivalent to
-.I \-tcp
-in
-.BR afpd.conf .)
-.TP
-.BI \-S " port"
-Specifies the port to register with when doing AFPoverTCP. Defaults to
-.IR 548 .
-(Equivalent to
-.I -port
-in
-.BR afpd.conf .)
-.TP
-.BI \-L " message"
-Specifies the login message that will be sent to clients. (Equivalent to
-.I \-loginmsg
-in
-.BR afpd.conf .)
-.TP
-.BI \-F " config"
-Specifies the configuration file to use. (Defaults to
-.IR :ETCDIR:/afpd.conf .)
-.TP
-.BI \-U " uams"
-Comma-separated list of UAMs to use for the authentication process.
-(Equivalent to
-.I -uamlist
+\fBafpd\fR
+stores its process id\&.
+.RE
+.PP
+\-S \fIport\fR
+.RS 4
+Specifies the port to register with when doing AFPoverTCP\&. Defaults to 548\&. (Equivalent to
+\fB\-port \fRin
+afpd\&.conf\&.)
+.RE
+.PP
+\-L \fImessage\fR
+.RS 4
+Specifies the login message that will be sent to clients\&. (Equivalent to
+\fB\-loginmsg\fR
in
-.BR afpd.conf .)
-.TP
-.B \-I
-Use a platform specific icon. (Equivalent to
-.I \-icon
+afpd\&.conf\&.)
+.RE
+.PP
+\-F \fIconfigfile\fR
+.RS 4
+Specifies the configuration file to use\&. (Defaults to
+:ETCDIR:/netatalk/afpd\&.conf\&.)
+.RE
+.PP
+\-U \fIuams\fR
+.RS 4
+Comma\-separated list of UAMs to use for the authentication process\&. (Equivalent to
+\fB\-uamlist\fR
in
-.BR afpd.conf .)
-.TP
-.BR \-m " umask"
-Use this umask for the creation of folders in Netatalk.
-.TP
-.B \-v
-Print version information and exit.
-.SH AUTHENTICATION
-.B afpd
-currently understands three User Authentication Methods (UAMs):
-.BR NoUserAuthent ,
-or guest,
-.B Cleartxt
-.BR passwrd ,
-and
-.B Kerberos
-.BR IV .
-If a user uses
-.BR NoUserAuthent ,
-s/he will only be offered default volumes to mount, and will only be able
-to read and write files that are permitted to the guest user. The
-.B -G
-option disables
-.BR NoUserAuthent .
-With
-.B Cleartxt passwd
-and
-.B Kerberos
-.BR IV ,
-.B afpd
-offers the user all volumes listed in
-.BR ~/AppleVolumes .
-The user may also read and write all files that s/he normally could.
-.B Cleartxt passwd
-is not recommended for AFS use.
-.B Kerberos IV
-is recommended for AFS use.
-A forth, depricated UAM is also included in the distribution,
-.B AFS
-.BR Kerberos .
-.SH CAVEATS
-.BR afpd 's
-Directory IDs are only fixed for the duration of a session. This means
-that Mac aliases won't work correctly in all cases.
-.LP
-If a user renames a folder that has an application as its progeny, the
-.B APPL
-mapping for the application will not longer be available. This implies
-that double-clicking on one of the application's documents will no
-longer launch the application. The
-.B APPL
-mapping will be rebuilt by the mac, the next time the Finder see the
-application.
-.LP
-If
-.B afpd
-is configured to downcase Macintosh filenames, Unix filenames with
-mixed case will be unavailable.
-.LP
-If carriage return/line feed translation is enabled, it is not
-safe to copy Unix binaries to a Macintosh.
-.LP
-It is not possible to move directories between devices.
-.LP
-When mounting the parent of an existing volume, the desktop database of
-the existing volume will not be available to the parent volume. The
-.B APPL
-mappings and icons of applications with the
-.B BNDL
-bit set will be generated in the parent volume as the applications are
-seen by the Finder.
-.LP
-If a user edits his
-.B ~/AppleVolumes
-so that his home directory is no longer offered, he will no longer be able
-to edit his
-.B ~/AppleVolumes
-from the Macintosh.
-.LP
-Unix files beginning with `.' are not accessible from the mac.
-.LP
-If the
-.I pathname
-in an
-.B ~/AppleVolumes
-file does not exist, the volume will not be offered in the Chooser.
-.LP
-Microsoft Word
-.B TEXT
-documents do not get carriage return/line feed translation. This is
-because MS Word uses a type other than
-.B TEXT
-while writing the document, then changes the type to
-.BR TEXT .
-To allow users to edit their
-.BR ~/AppleVolumes ,
-.B afpd
-parses the files with either end of line character.
-.LP
-Unix filenames that are longer than 31 characters are inaccessible from
-the Macintosh.
-
-.SH SIGNALS
+afpd\&.conf\&.)
+.RE
+.PP
+\-m \fIumask\fR
+.RS 4
+Use this
+\fIumask\fR
+for the creation of folders in Netatalk\&.
+.RE
+.SH "SIGNALS"
+.PP
Signals that are sent to the main
-.B afpd
-process are propagated to the children, so all will be affected.
-.TP 13
-.B SIGHUP
+\fBafpd\fR
+process are propagated to the children, so all will be affected\&.
+.PP
+SIGHUP
+.RS 4
+Sending a
+\fBSIGHUP\fR
+to afpd will cause it to reload its configuration files\&.
+.RE
+.PP
+SIGINT
+.RS 4
+Sending a
+\fBSIGINT\fR
+to a child
+\fBafpd\fR
+enables
+\fImax_debug\fR
+logging for this process\&. The log is sent to fhe file
+/tmp/afpd\&.PID\&.XXXXXX\&. Sending another
+\fBSIGINT\fR
+will terminate the process\&.
+.RE
+.PP
+SIGUSR1
+.RS 4
The
-.B afpd
-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
-.BR afpd ,
-the other children are not affected. However, the main process will still
-exit, disabling all new connections.
-.TP 13
-.B SIGUSR1
-If the
-.B --with-message-dir
-configure option was used, the
-.B afpd
-process will set the
-.B debug
-option and redirect the messages to
-.RI /var/tmp/afpd-debug- pid .
-This should only be sent to a child
-.BR afpd .
-.B Warning:
-If the
-.B --with-message-dir
-option was not used, this will kill the
-.B afpd
-process.
-
-.TP 13
-.B SIGUSR2
+\fBafpd\fR
+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\&.
+.RE
+.PP
+SIGUSR2
+.RS 4
The
-.B afpd
-process will look in the
-.I msg
-directory for a file named
-.RI 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.
-
-.SH FILES
-.TP 20
-.B :ETCDIR:/AppleVolumes.default
+\fBafpd\fR
+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
+\fBafpd\fR\&.
+.sp
+To shut down a user\'s
+\fBafpd\fR
+process it is recommended that
+\fBSIGKILL (\-9)\fR
+\fINOT\fR
+be used, except as a last resort, as this may leave the CNID database in an inconsistent state\&. The safe way to terminate an
+\fBafpd\fR
+is to send it a
+\fBSIGTERM (\-15)\fR
+signal and wait for it to die on its own\&.
+.RE
+.SH "FILES"
+.PP
+:ETCDIR:/afpd\&.conf
+.RS 4
+configuration file used by afpd
+.RE
+.PP
+:ETCDIR:/AppleVolumes\&.default
+.RS 4
list of default volumes to mount
-.TP 20
-.B :ETCDIR:/AppleVolumes.system
+.RE
+.PP
+:ETCDIR:/AppleVolumes\&.system
+.RS 4
list of volumes to offer all users
-.TP 20
-.B ~/AppleVolumes
-user's list of volumes to mount
-.TP 20
-.BI :ETCDIR:/msg/message. pid
-contains messages to be sent to users.
-.TP 20
-.BI /var/tmp/afpd-debug- pid
-contains debug output, if triggered.
-.SH BUGS
-A few calls from the AFP specification are not implemented, because the
-Macintosh does not use them.
+.RE
+.PP
+~/AppleVolumes, ~/\&.AppleVolumes, ~/applevolumes, ~/\&.applevolumes
+.RS 4
+user\'s list of volumes to mount
+.RE
+.PP
+:ETCDIR:/afp_signature\&.conf
+.RS 4
+list of server signature
+.RE
+.PP
+:ETCDIR:/netatalk/msg/message\&.pid
+.RS 4
+contains messages to be sent to users\&.
+.RE
+.SH "BUGS"
+.PP
+.SH "SEE ALSO"
+.PP
+\fBhosts_access\fR(5),
+\fBafpd.conf\fR(5),
+\fBAppleVolumes.default\fR(5),
+\fBafp_signature.conf\fR(5),
+\fBdbd\fR(1)\&.
projects / netatalk.git / blobdiff