]> arthur.barton.de Git - netatalk.git/blobdiff - man/man8/afpd.8.tmpl
Merge master
[netatalk.git] / man / man8 / afpd.8.tmpl
index 0e735a9d39119104daa90b4af036073214184ba1..6ce60fd41ef68274000299dbcef1746e5557e6dc 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.1beta
-.\"    Source: Netatalk 2.1beta
+.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
+.\"      Date: 08 Mar 2011
+.\"    Manual: Netatalk 2.2
+.\"    Source: Netatalk 2.2
 .\"  Language: English
 .\"
-.TH "AFPD" "8" "08 Feb 2010" "Netatalk 2.1beta" "Netatalk 2.1beta"
+.TH "AFPD" "8" "08 Mar 2011" "Netatalk 2.2" "Netatalk 2.2"
 .\" -----------------------------------------------------------------
 .\" * 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 [\-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 AppleTalk Filing Protocol (AFP) interface to the Unix file system\&. It is normally started at boot time from /etc/rc\&.
+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
 :ETCDIR:/AppleVolumes\&.system
 and one of
 :ETCDIR:/AppleVolumes\&.default,
-~/AppleVolumes, or
-~/\&.AppleVolumes\&. The
+~/AppleVolumes,
+~/\&.AppleVolumes,
+~/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\&.
+files is used to specify volumes to mount and file name extension mappings\&.
 .PP
 .SH "OPTIONS"
 .PP
@@ -81,12 +90,22 @@ afpd\&.conf\&.)
 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\&.)
+afpd\&.conf\&.) (Recent Mac OS don\'t display it\&.)
 .RE
 .PP
 \-f \fIdefaultvolumes\fR
@@ -182,19 +201,37 @@ for the creation of folders in Netatalk\&.
 .RE
 .SH "SIGNALS"
 .PP
-Signals that are sent to the main
+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\&.
+.PP
+SIGTERM and SIGUSR1 signals that are sent to the main
 \fBafpd\fR
 process are propagated to the children, so all will be affected\&.
 .PP
+SIGTERM
+.RS 4
+Clean exit\&. Propagates from master to childs\&.
+.RE
+.PP
+SIGQUIT
+.RS 4
+Send this to the master
+\fBafpd\fR, it will exit leaving all children running! Can be used to implement AFP service without downtime\&.
+.RE
+.PP
 SIGHUP
 .RS 4
 Sending a
 \fBSIGHUP\fR
-to afpd will cause it to reload its configuration files\&. The master
-\fBafpd\fR
-process will reread all files while the children
-\fBafpd\fR
-processes will only reread the volume configuration\&.
+to afpd will cause it to reload its configuration files\&.
 .RE
 .PP
 SIGINT
@@ -208,7 +245,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
@@ -224,20 +261,14 @@ 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:/afpd\&.conf
+.RS 4
+configuration file used by afpd
+.RE
+.PP
 :ETCDIR:/AppleVolumes\&.default
 .RS 4
 list of default volumes to mount
@@ -248,12 +279,27 @@ list of default volumes to mount
 list of volumes to offer all users
 .RE
 .PP
-~/AppleVolumes
+~/AppleVolumes, ~/\&.AppleVolumes, ~/applevolumes, ~/\&.applevolumes
 .RS 4
 user\'s list of volumes to mount
 .RE
 .PP
-:ETCDIR:/netatalk/msg/message\&.pid
+:ETCDIR:/afp_signature\&.conf
+.RS 4
+list of server signature
+.RE
+.PP
+:ETCDIR:/afp_voluuid\&.conf
+.RS 4
+list of UUID for Time Machine volume
+.RE
+.PP
+:ETCDIR:/afp_ldap\&.conf
+.RS 4
+configuration file for LDAP and ACL support
+.RE
+.PP
+:ETCDIR:/msg/message\&.pid
 .RS 4
 contains messages to be sent to users\&.
 .RE
@@ -264,5 +310,7 @@ contains messages to be sent to users\&.
 \fBhosts_access\fR(5),
 \fBafpd.conf\fR(5),
 \fBAppleVolumes.default\fR(5),
-\fBAppleVolumes.system\fR(5),
+\fBafp_signature.conf\fR(5),
+\fBafp_voluuid.conf\fR(5),
+\fBafp_ldap.conf\fR(5),
 \fBdbd\fR(1)\&.