]> arthur.barton.de Git - netatalk.git/blob - man/man8/afpd.8.tmpl
be235032950a1ae8c89dddaadca2428cc056a3b7
[netatalk.git] / 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 :SBINDIR:/afpd
7 [
8 .B -d
9 ]
10 [
11 .B -f
12 .I defaultvolumes
13 ]
14 [
15 .B -s
16 .I systemvolumes
17 ]
18 [
19 .B -u
20 ]
21 [
22 .B -n
23 .I nbpname
24 ]
25 [
26 .B -c
27 .I maxconnections
28 ]
29 [
30 .B -g
31 .I guest
32 ]
33 [
34 .B -G
35 ]
36 [
37 .B -K
38 ]
39 [
40 .B -C
41 ]
42 [
43 .B -A
44 ]
45 .SH DESCRIPTION
46 .B afpd
47 provides an AppleTalk Filing Protocol (AFP)
48 interface to the Unix file system.  It is normally started at boot time
49 from
50 .BR /etc/rc .
51 The list of volumes offered to the user is generated from
52 .B :ETCDIR:/AppleVolumes.system
53 and one of
54 .BR :ETCDIR:/AppleVolumes.default ,
55 .BR ~/AppleVolumes ,
56 or
57 .BR ~/.AppleVolumes .
58 .LP
59 The
60 .B AppleVolumes
61 files is used to specify volumes to mount and file name extension mappings.
62 It is formatted as follows, one specification per line:
63 .RS
64 .sp
65 .I pathname
66 [
67 .I volumename
68 ]
69 .br
70 .RI . extension
71 [
72 .I type
73 [
74 .I creator
75 ]
76 ]
77 .sp
78 .RE
79 If
80 .I volumename
81 is unspecified, the last component of
82 .I pathname
83 is used.  No two volumes may have the same name.  If
84 .I type
85 is unspecified
86 .RB ' ???? '
87 is used.  If
88 .I creator
89 is unspecified
90 .RB ' UNIX '
91 is used.  The extension
92 .RB ' . '
93 sets the default creator and type for otherwise untyped Unix files.
94 Blank lines and lines beginning with `#' are ignored.
95 .SH OPTIONS
96 .TP
97 .B \-d
98 Specifies that the daemon not fork, and that a trace of all AFP
99 commands be written to stdout.
100 .TP
101 .BI \-f " defaultvolumes"
102 Specifies that
103 .I defaultvolumes
104 should be read for a list of default volumes to offer, instead of
105 .BR :ETCDIR:/AppleVolumes.default .
106 .TP
107 .BI \-s " systemvolumes"
108 Specifies that
109 .I systemvolumes
110 should be read for a list of volume that all users will be offered,
111 instead of
112 .BR :ETCDIR:/AppleVolumes.system .
113 .TP
114 .B \-u
115 Read the user's
116 .B AppleVolumes
117 file first.  This option causes volume names in the user's
118 .B AppleVolumes
119 file to override volume names in the system's
120 .B AppleVolumes
121 file.  The default is to read the system
122 .B AppleVolumes
123 file first.  Note that this option doesn't effect the precendence of
124 filename extension mappings: the user's AppleVolumes file always has
125 precedence.
126 .TP
127 .BI \-n " nbpname"
128 Specifies that
129 .I nbpname
130 should be used for NBP registration, instead of the first component of
131 the hostname in the local zone.
132 .TP
133 .BI \-c " maxconnections"
134 Specifies the maximum number of connections to allow for this
135 .BR afpd .
136 The default is 5.
137 .TP
138 .BI \-g " guest"
139 Specifies the name of the guest account.  The default is ``nobody''.
140 .TP
141 .B \-G
142 .TP
143 .B \-K
144 .TP
145 .B \-C
146 .TP
147 .B \-A
148 Causes the server to not offer
149 .BR NoUserAuthent ,
150 .BR "Kerberos IV" ,
151 .BR "Cleartxt Passwrd" ,
152 and
153 .B AFS Kerberos
154 logins, respectively.  The default is to enable all available login methods.
155 .SH AUTHENTICATION
156 .B afpd
157 currently understands three User Authentication Methods (UAMs):
158 .BR NoUserAuthent ,
159 or guest,
160 .B Cleartxt
161 .BR passwrd ,
162 and
163 .B Kerberos
164 .BR IV .
165 If a user uses
166 .BR NoUserAuthent ,
167 s/he will only be offered default volumes to mount, and will only be able
168 to read and write files that are permitted to the guest user.  The
169 .B -G
170 option disables
171 .BR NoUserAuthent .
172 With
173 .B Cleartxt passwd
174 and
175 .B Kerberos
176 .BR IV ,
177 .B afpd
178 offers the user all volumes listed in
179 .BR ~/AppleVolumes .
180 The user may also read and write all files that s/he normally could.
181 .B Cleartxt passwd
182 is not recommended for AFS use.
183 .B Kerberos IV
184 is recommended for AFS use.
185 A forth, depricated UAM is also included in the distribution,
186 .B AFS
187 .BR Kerberos .
188 .SH CAVEATS
189 .BR afpd 's
190 Directory IDs are only fixed for the duration of a session.  This means
191 that Mac aliases won't work correctly in all cases.
192 .LP
193 If a user renames a folder that has an application as its progeny, the
194 .B APPL
195 mapping for the application will not longer be available. This implies
196 that double-clicking on one of the application's documents will no
197 longer launch the application. The
198 .B APPL
199 mapping will be rebuilt by the mac, the next time the Finder see the
200 application.
201 .LP
202 If
203 .B afpd
204 is configured to downcase Macintosh filenames, Unix filenames with
205 mixed case will be unavailable.
206 .LP
207 If carriage return/line feed translation is enabled, it is not
208 safe to copy Unix binaries to a Macintosh.
209 .LP
210 It is not possible to move directories between devices.
211 .LP
212 When mounting the parent of an existing volume, the desktop database of
213 the existing volume will not be available to the parent volume.  The
214 .B APPL
215 mappings and icons of applications with the
216 .B BNDL
217 bit set will be generated in the parent volume as the applications are
218 seen by the Finder.
219 .LP
220 If a user edits his
221 .B ~/AppleVolumes
222 so that his home directory is no longer offered, he will no longer be able
223 to edit his
224 .B ~/AppleVolumes
225 from the Macintosh.
226 .LP
227 Unix files beginning with `.' are not accessible from the mac.
228 .LP
229 If the
230 .I pathname
231 in an
232 .B ~/AppleVolumes
233 file does not exist, the volume will not be offered in the Chooser.
234 .LP
235 Microsoft Word
236 .B TEXT
237 documents do not get carriage return/line feed translation.  This is
238 because MS Word uses a type other than
239 .B TEXT
240 while writing the document, then changes the type to
241 .BR TEXT .
242 To allow users to edit their
243 .BR ~/AppleVolumes ,
244 .B afpd
245 parses the files with either end of line character.
246 .LP
247 Unix filenames that are longer than 31 characters are inaccessible from
248 the Macintosh.
249 .SH FILES
250 .TP 20
251 .B :ETCDIR:/AppleVolumes.default
252 list of default volumes to mount
253 .TP 20
254 .B :ETCDIR:/AppleVolumes.system
255 list of volumes to offer all users
256 .TP 20
257 .B ~/AppleVolumes
258 user's list of volumes to mount
259 .SH BUGS
260 A few calls from the AFP specification are not implemented, because the
261 Macintosh does not use them.