]> arthur.barton.de Git - netatalk.git/blobdiff - man/man8/afpd.8.tmpl
Import manpages from XML
[netatalk.git] / man / man8 / afpd.8.tmpl
index ff821c5eeeef067449a030aa70a6ede5298b40ab..f282ea8de0f425db44ceb7037a300d1176ccf251 100644 (file)
@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: afpd
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
-.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
-.\"      Date: 08 Feb 2010
-.\"    Manual: Netatalk 2.1
-.\"    Source: Netatalk 2.1
+.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
+.\"      Date: 21 Mar 2012
+.\"    Manual: Netatalk 3.0
+.\"    Source: Netatalk 3.0
 .\"  Language: English
 .\"
-.TH "AFPD" "8" "08 Feb 2010" "Netatalk 2.1" "Netatalk 2.1"
+.TH "AFPD" "8" "21 Mar 2012" "Netatalk 3.0" "Netatalk 3.0"
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
 .\" * MAIN CONTENT STARTS HERE *
 .\" -----------------------------------------------------------------
 .SH "NAME"
-afpd \- AppleTalk Filing Protocol daemon
+afpd \- Apple Filing Protocol daemon
 .SH "SYNOPSIS"
-.HP \w'\fBafpd\fR\fB\fR\ 'u
-\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]
+.HP \w'\fBafpd\fR\fB\fR\fBafpd\fR\fB\fR\ 'u
+\fBafpd\fR\fB\fR [\-d] [\-F\ \fIconfigfile\fR]
+.br
+\fBafpd\fR\fB\fR \-v | \-V | \-h 
 .SH "DESCRIPTION"
 .PP
 \fBafpd\fR
-provides an AppleTalk Filing Protocol (AFP) interface to the Unix file system\&. It is normally started at boot time from /etc/rc\&.
-.PP
-The list of volumes offered to the user is generated from
-:ETCDIR:/AppleVolumes\&.system
-and one of
-:ETCDIR:/AppleVolumes\&.default,
-~/AppleVolumes, or
-~/\&.AppleVolumes\&. The
-AppleVolumes
-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\&.
+provides an Apple Filing Protocol (AFP) interface to the Unix file system\&. It is normally started at boot time from /etc/rc\&.
 .PP
+:ETCDIR:/afp\&.conf
+is the configuration file used by
+\fBafpd\fR
+to determine the behavior and configuration of the different virtual file servers that it provides\&.
 .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\&.)
+Specifies that the daemon should not fork\&.
 .RE
 .PP
 \-v
@@ -81,110 +46,48 @@ afpd\&.conf\&.)
 Print version information and exit\&.
 .RE
 .PP
-\-I
-.RS 4
-Use a platform specific icon\&. (Equivalent to
-\fB\-icon\fR
-in
-afpd\&.conf\&.)
-.RE
-.PP
-\-f \fIdefaultvolumes\fR
+\-V
 .RS 4
-Specifies that
-\fIdefaultvolumes\fR
-should be read for a list of default volumes to offer, instead of
-:ETCDIR:/AppleVolumes\&.default\&.
+Print verbose information and exit\&.
 .RE
 .PP
-\-s \fIsystemvolumes\fR
+\-h
 .RS 4
-Specifies that
-\fIsystemvolumes\fR
-should be read for a list of volume that all users will be offered, instead of
-:ETCDIR:/AppleVolumes\&.system\&.
+Print help and exit\&.
 .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
-\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
-\fBafpd\fR\&. The default is 20\&.
-.RE
-.PP
-\-g \fIguest\fR
+\-F \fIconfigfile\fR
 .RS 4
-Specifies the name of the guest account\&. The default is \'\fInobody\fR\'\&.
+Specifies the configuration file to use\&. (Defaults to
+:ETCDIR:/netatalk/afp\&.conf\&.)
 .RE
+.SH "SIGNALS"
 .PP
-\-P \fIpidfile\fR
-.RS 4
-Specifies the file in which
+To shut down a user\'s
 \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
-afpd\&.conf\&.)
-.RE
+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\&.
 .PP
-\-F \fIconfigfile\fR
-.RS 4
-Specifies the configuration file to use\&. (Defaults to
-:ETCDIR:/netatalk/afpd\&.conf\&.)
-.RE
+SIGTERM and SIGUSR1 signals that are sent to the main
+\fBafpd\fR
+process are propagated to the children, so all will be affected\&.
 .PP
-\-U \fIuams\fR
+SIGTERM
 .RS 4
-Comma\-separated list of UAMs to use for the authentication process\&. (Equivalent to
-\fB\-uamlist\fR
-in
-afpd\&.conf\&.)
+Clean exit\&. Propagates from master to childs\&.
 .RE
 .PP
-\-m \fIumask\fR
+SIGQUIT
 .RS 4
-Use this
-\fIumask\fR
-for the creation of folders in Netatalk\&.
+Send this to the master
+\fBafpd\fR, it will exit leaving all children running! Can be used to implement AFP service without downtime\&.
 .RE
-.SH "SIGNALS"
-.PP
-Signals that are sent to the main
-\fBafpd\fR
-process are propagated to the children, so all will be affected\&.
 .PP
 SIGHUP
 .RS 4
@@ -204,7 +107,7 @@ enables
 logging for this process\&. The log is sent to fhe file
 /tmp/afpd\&.PID\&.XXXXXX\&. Sending another
 \fBSIGINT\fR
-will terminate the process\&.
+will revert to the original log settings\&.
 .RE
 .PP
 SIGUSR1
@@ -220,45 +123,32 @@ The
 \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:/AppleVolumes\&.default
+:ETCDIR:/afp\&.conf
 .RS 4
-list of default volumes to mount
+configuration file used by afpd
 .RE
 .PP
-:ETCDIR:/AppleVolumes\&.system
+afp_signature\&.conf
 .RS 4
-list of volumes to offer all users
+list of server signature
 .RE
 .PP
-~/AppleVolumes
+afp_voluuid\&.conf
 .RS 4
-user\'s list of volumes to mount
+list of UUID for Time Machine volume
 .RE
 .PP
-:ETCDIR:/netatalk/msg/message\&.pid
+:ETCDIR:/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),
-\fBAppleVolumes.system\fR(5),
+\fBafp.conf\fR(5),
+\fBafp_signature.conf\fR(5),
+\fBafp_voluuid.conf\fR(5),
 \fBdbd\fR(1)\&.