]> arthur.barton.de Git - netatalk.git/blob - man/man8/afpd.8.tmpl
mirror man pages from Docbook
[netatalk.git] / man / man8 / afpd.8.tmpl
1 .TH afpd 8 "06 Jan 2004" 2.0.2 Netatalk 
2 .SH NAME
3 afpd \- AppleTalk Filing Protocol daemon
4 .SH SYNOPSIS
5 \fBafpd\fR [\-duptDTvI] [\-f \fBdefaultvolumes\fR] [\-s \fBsystemvolumes\fR] [\-n \fBnbpname\fR] [\-c \fBmaxconnections\fR] [\-g \fBguest\fR] [\-P \fBpidfile\fR] [\-S \fBport\fR] [\-L \fBmessage\fR] [\-F \fBconfig\fR] [\-U \fBuamsv\fR] [\-m \fBumask\fR]
6 .SH DESCRIPTION
7 afpd provides an AppleTalk Filing Protocol (AFP)
8 interface to the Unix file system. It is normally started at boot time
9 from /etc/rc. 
10 .PP
11 The list of volumes offered to the user is generated from
12 \fB:ETCDIR:/AppleVolumes.system\fR and one of
13 \fB:ETCDIR:/AppleVolumes.default\fR, \fB~/AppleVolumes\fR,
14 or \fB~/.AppleVolumes\fR. The \fBAppleVolumes\fR
15 files is used to specify volumes to mount and file name extension
16 mappings. It is formatted as follows, one specification per line: pathname
17 [ volumename ] .extension [ type [ creator ] ] If volumename is
18 unspecified, the last component of pathname is used. No two volumes may
19 have the same name. If type is unspecified '????' is used. If
20 creator is unspecified 'UNIX' is used. The extension '.'
21 sets the default creator and type for otherwise untyped Unix files. Blank
22 lines and lines beginning with `#' are ignored.
23 .PP
24 .SH OPTIONS
25 .TP 
26 \-d
27 Specifies that the daemon should not fork. If netatalk has been
28 configured with \fI\-\-enable\-debug1\fR, a trace of
29 all AFP commands will be written to stdout.
30 .TP 
31 \-p
32 Prevents clients from saving their passwords. (Equivalent to \-\fBnosavepasswd\fR
33 in \fBafpd.conf\fR.)
34 .TP 
35 \-t
36 Allows clients to change their passwords. (Equivalent to
37 \fB\-setpasswd\fR in \fBafpd.conf\fR.)
38 .TP 
39 \-D
40 Use DDP (AppleTalk) as transport protocol. (Equivalent to
41 \fB\-ddp\fR in \fBafpd.cond\fR.)
42 .TP 
43 \-T
44 Use TCP/IP as transport protocol. (Equivalent to
45 \fB\-tcp\fR in \fBafpd.conf\fR.)
46 .TP 
47 \-v
48 Print version information and exit.
49 .TP 
50 \-I
51 Use a platform specific icon. (Equivalent to \fB\-icon\fR
52 in \fBafpd.conf\fR.)
53 .TP 
54 \-f \fIdefaultvolumes\fR
55 Specifies that \fIdefaultvolumes\fR
56 should be read for a list of default volumes to offer, instead of
57 \fB:ETCDIR:/AppleVolumes.default\fR.
58 .TP 
59 \-s \fIsystemvolumes\fR
60 Specifies that \fIsystemvolumes\fR should
61 be read for a list of volume that all users will be offered, instead
62 of \fB:ETCDIR:/AppleVolumes.system\fR.
63 .TP 
64 \-u
65 Read the user's \fBAppleVolumes\fR file
66 first. This option causes volume names in the user's
67 \fBAppleVolumes\fR file to override volume names in
68 the system's \fBAppleVolumes\fR file. The default
69 is to read the system \fBAppleVolumes\fR file first.
70 Note that this option doesn't effect the precendence of filename
71 extension mappings: the user's \fBAppleVolumes\fR
72 file always has precedence.
73 .TP 
74 \-n \fInbpname\fR
75 Specifies that \fInbpname\fR should be
76 used for NBP registration, instead of the first component of the
77 hostname in the local zone.
78 .TP 
79 \-c \fImaxconnections\fR
80 Specifies the maximum number of connections to allow for this
81 afpd. The default is 20.
82 .TP 
83 \-g \fIguest\fR
84 Specifies the name of the guest account. The default is
85 \&'\fInobody\fR'.
86 .TP 
87 \-P \fIpidfile\fR
88 Specifies the file in which afpd stores its
89 process id.
90 .TP 
91 \-S \fIport\fR
92 Specifies the port to register with when doing AFPoverTCP.
93 Defaults to 548. (Equivalent to \fB\-port \fRin
94 \fBafpd.conf\fR.)
95 .TP 
96 \-L \fImessage\fR
97 Specifies the login message that will be sent to clients.
98 (Equivalent to \fB\-loginmsg\fR in \fBafpd.conf\fR.)
99 .TP 
100 \-F \fIconfigfile\fR
101 Specifies the configuration file to use. (Defaults to
102 \fB:ETCDIR:/netatalk/afpd.conf\fR.)
103 .TP 
104 \-U \fIuams\fR
105 Comma\-separated list of UAMs to use for the authentication
106 process. (Equivalent to \fB\-uamlist\fR in
107 \fBafpd.conf\fR.)
108 .TP 
109 \-m \fIumask\fR
110 Use this umask for the creation of
111 folders in Netatalk.
112 .SH SIGNALS
113 Signals that are sent to the main afpd process
114 are propagated to the children, so all will be affected.
115 .TP 
116 SIGHUP
117 Sending a SIGHUP to afpd will cause it to
118 reload its configuration files.
119 .TP 
120 SIGUSR1
121 The afpd process will send the message
122 "The server is going down for maintenance." to the client
123 and shut itself down in 5 minutes. New connections are not allowed.
124 If this is sent to a child afpd, the other children are not
125 affected. However, the main process will still exit, disabling all
126 new connections.
127 .TP 
128 SIGUSR2
129 The afpd process will look in the message
130 directory configured at build time for a file named message.pid. For
131 each one found, a the contents will be sent as a message to the
132 associated AFP client. The file is removed after the message is
133 sent. This should only be sent to a child afpd.
134 Warning: If the \-\-with\-message\-dir option was not used, this will
135 kill the afpd process
136
137 To shut down a user's afpd process it
138 is recommended that SIGKILL (\-9)
139 \fINOT\fR be used, except as a last resort, as this
140 may leave the CNID database in an inconsistent state. The safe way
141 to terminate an afpd is to send it a
142 SIGTERM (\-15) signal and wait for it to die on
143 its own.
144 .SH FILES
145 .TP 
146 \fB:ETCDIR:/AppleVolumes.default\fR
147 list of default volumes to mount
148 .TP 
149 \fB:ETCDIR:/AppleVolumes.system\fR
150 list of volumes to offer all users
151 .TP 
152 \fB~/AppleVolumes\fR
153 user's list of volumes to mount
154 .TP 
155 \fB:ETCDIR:/netatalk/msg/message.pid\fR
156 contains messages to be sent to users.
157 .SH BUGS
158 .SH "SEE ALSO"
159 \fBhosts_access\fR(5),
160 \fBafpd.conf\fR(5),
161 \fBAppleVolumes.default\fR(5),
162 \fBAppleVolumes.system\fR(5).
163