]> arthur.barton.de Git - netatalk.git/blob - man/man5/afp.conf.5.in
Support for using $u username variable in AFP volume definitions
[netatalk.git] / man / man5 / afp.conf.5.in
1 '\" t
2 .\"     Title: afp.conf
3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4 .\" Generator: DocBook XSL Stylesheets v1.78.0 <http://docbook.sf.net/>
5 .\"      Date: 09 Feb 2013
6 .\"    Manual: @NETATALK_VERSION@
7 .\"    Source: @NETATALK_VERSION@
8 .\"  Language: English
9 .\"
10 .TH "AFP\&.CONF" "5" "09 Feb 2013" "@NETATALK_VERSION@" "@NETATALK_VERSION@"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el       .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 afp.conf \- Netatalk configuration file
32 .SH "SYNOPSIS"
33 .PP
34 The
35 afp\&.conf
36 file is the configuration file for the
37 \fBNetatalk\fR
38 AFP file server\&.
39 .PP
40 All AFP specific configuration and AFP volume definitions are done via this file\&.
41 .SH "FILE FORMAT"
42 .PP
43 The file consists of sections and parameters\&. A section begins with the name of the section in square brackets and continues until the next section begins\&. Sections contain parameters of the form:
44 .sp
45 .if n \{\
46 .RS 4
47 .\}
48 .nf
49     \fIname\fR = \fIvalue \fR
50     
51 .fi
52 .if n \{\
53 .RE
54 .\}
55 .PP
56 The file is line\-based \- that is, each newline\-terminated line represents either a comment, a section name or a parameter\&.
57 .PP
58 Section and parameter names are case sensitive\&.
59 .PP
60 Only the first equals sign in a parameter is significant\&. Whitespace before or after the first equals sign is discarded\&. Leading, trailing and internal whitespace in section and parameter names is irrelevant\&. Leading and trailing whitespace in a parameter value is discarded\&. Internal whitespace within a parameter value is retained verbatim\&.
61 .PP
62 Any line beginning with a semicolon (\(lq;\(rq) or a hash (\(lq#\(rq) character is ignored, as are lines containing only whitespace\&.
63 .PP
64 Any line ending in a
65 \(lq \e \(rq
66 is continued on the next line in the customary UNIX fashion\&.
67 .PP
68 The values following the equals sign in parameters are all either a string (no quotes needed) or a boolean, which may be given as yes/no, 1/0 or true/false\&. Case is not significant in boolean values, but is preserved in string values\&. Some items such as create masks are numeric\&.
69 .PP
70 The parameter
71 \fBinclude = \fR\fB\fIpath\fR\fR
72 allows you to include one config file inside another\&. The file is included literally, as though typed in place\&. Nested includes are not supported\&.
73 .SH "SECTION DESCRIPTIONS"
74 .PP
75 Each section in the configuration file (except for the [Global] section) describes a shared resource (known as a
76 \(lqvolume\(rq)\&. The section name is the name of the volume and the parameters within the section define the volume attributes and options\&.
77 .PP
78 There are two special sections, [Global] and [Homes], which are described under
79 \fIspecial sections\fR\&. The following notes apply to ordinary section descriptions\&.
80 .PP
81 A volume consists of a directory to which access is being given plus a description of the access rights which are granted to the user of the service\&. For volumes the
82 \fBpath\fR
83 option must specify the directory to share\&.
84 .PP
85 Any volume section without
86 \fBpath\fR
87 option is considered a
88 \fIvol preset\fR
89 which can be selected in other volume sections via the
90 \fBvol preset\fR
91 option and constitutes defaults for the volume\&. For any option specified both in a preset
92 \fIand\fR
93 in a volume section the volume section setting completely substitutes the preset option\&.
94 .PP
95 The access rights granted by the server are masked by the access rights granted to the specified or guest UNIX user by the host system\&. The server does not grant more access than the host system grants\&.
96 .PP
97 The following sample section defines an AFP volume\&. The user has full access to the path
98 /foo/bar\&. The share is accessed via the share name
99 baz:
100 .sp
101 .if n \{\
102 .RS 4
103 .\}
104 .nf
105  [baz]
106     path = /foo/bar 
107 .fi
108 .if n \{\
109 .RE
110 .\}
111 .SH "SPECIAL SECTIONS"
112 .SS "The [Global] section"
113 .PP
114 Parameters in this section apply to the server as a whole\&. Parameters denoted by a (G) below are must be set in this section\&.
115 .SS "The [Homes] section"
116 .PP
117 This section enable sharing of the UNIX server user home directories\&. Specifying an optional
118 \fBpath\fR
119 parameter means that not the whole user home will be shared but the subdirectory
120 \fBpath\fR\&. It is necessary to define the
121 \fBbasedir regex\fR
122 option\&. It should be a regex which matches the parent directory of the user homes\&. Parameters denoted by a (H) belong to volume sections\&. The optional parameter
123 \fBhome name\fR
124 can be used to change the AFP volume name which
125 \fI$u\*(Aqs home\fR
126 by default\&. See below under VARIABLE SUBSTITUTIONS\&.
127 .PP
128 The following example illustrates this\&. Given all user home directories are stored under
129 /home:
130 .sp
131 .if n \{\
132 .RS 4
133 .\}
134 .nf
135  [Homes]
136       path = afp\-data
137       basedir regex = /home
138 .fi
139 .if n \{\
140 .RE
141 .\}
142 .sp
143 For a user
144 \fIjohn\fR
145 this results in an AFP home volume with a path of
146 /home/john/afp\-data\&.
147 .PP
148 If
149 \fBbasedir regex\fR
150 contains symlink, set the canonicalized absolute path\&. When
151 /home
152 links to
153 /usr/home:
154 .sp
155 .if n \{\
156 .RS 4
157 .\}
158 .nf
159  [Homes]
160       basedir regex = /usr/home
161 .fi
162 .if n \{\
163 .RE
164 .\}
165 .SH "PARAMETERS"
166 .PP
167 Parameters define the specific attributes of sections\&.
168 .PP
169 Some parameters are specific to the [Global] section (e\&.g\&.,
170 \fIlog type\fR)\&. All others are permissible only in volume sections\&. The letter
171 \fIG\fR
172 in parentheses indicates that a parameter is specific to the [Global] section\&. The letter
173 \fIV\fR
174 indicates that a parameter can be specified in a volume specific section\&.
175 .SH "VARIABLE SUBSTITUTIONS"
176 .PP
177 You can use variables in volume names\&. The use of variables in paths is limited to $u\&.
178 .sp
179 .RS 4
180 .ie n \{\
181 \h'-04' 1.\h'+01'\c
182 .\}
183 .el \{\
184 .sp -1
185 .IP "  1." 4.2
186 .\}
187 if you specify an unknown variable, it will not get converted\&.
188 .RE
189 .sp
190 .RS 4
191 .ie n \{\
192 \h'-04' 2.\h'+01'\c
193 .\}
194 .el \{\
195 .sp -1
196 .IP "  2." 4.2
197 .\}
198 if you specify a known variable, but that variable doesn\*(Aqt have a value, it will get ignored\&.
199 .RE
200 .PP
201 The variables which can be used for substitutions are:
202 .PP
203 $b
204 .RS 4
205 basename
206 .RE
207 .PP
208 $c
209 .RS 4
210 client\*(Aqs ip address
211 .RE
212 .PP
213 $d
214 .RS 4
215 volume pathname on server
216 .RE
217 .PP
218 $f
219 .RS 4
220 full name (contents of the gecos field in the passwd file)
221 .RE
222 .PP
223 $g
224 .RS 4
225 group name
226 .RE
227 .PP
228 $h
229 .RS 4
230 hostname
231 .RE
232 .PP
233 $i
234 .RS 4
235 client\*(Aqs ip, without port
236 .RE
237 .PP
238 $s
239 .RS 4
240 server name (this can be the hostname)
241 .RE
242 .PP
243 $u
244 .RS 4
245 user name (if guest, it is the user that guest is running as)
246 .RE
247 .PP
248 $v
249 .RS 4
250 volume name
251 .RE
252 .PP
253 $$
254 .RS 4
255 prints dollar sign ($)
256 .RE
257 .SH "EXPLANATION OF GLOBAL PARAMETERS"
258 .SS "Authentication Options"
259 .PP
260 ad domain = \fIDOMAIN\fR \fB(G)\fR
261 .RS 4
262 Append @DOMAIN to username when authenticating\&. Useful in Active Directory environments that otherwise would require the user to enter the full user@domain string\&.
263 .RE
264 .PP
265 admin auth user = \fIuser\fR \fB(G)\fR
266 .RS 4
267 Specifying eg "\fBadmin auth user = root\fR" whenever a normal user login fails, afpd will try to authenticate as the specified
268 \fBadmin auth user\fR\&. If this succeeds, a normal session is created for the original connecting user\&. Said differently: if you know the password of
269 \fBadmin auth user\fR, you can authenticate as any other user\&.
270 .RE
271 .PP
272 k5 keytab = \fIpath\fR \fB(G)\fR, k5 service = \fIservice\fR \fB(G)\fR, k5 realm = \fIrealm\fR \fB(G)\fR
273 .RS 4
274 These are required if the server supports the Kerberos 5 authentication UAM\&.
275 .RE
276 .PP
277 nt domain = \fIDOMAIN\fR \fB(G)\fR, nt separator = \fISEPARATOR\fR \fB(G)\fR
278 .RS 4
279 Use for eg\&. winbind authentication, prepends both strings before the username from login and then tries to authenticate with the result through the available and active UAM authentication modules\&.
280 .RE
281 .PP
282 save password = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR
283 .RS 4
284 Enables or disables the ability of clients to save passwords locally\&.
285 .RE
286 .PP
287 set password = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR
288 .RS 4
289 Enables or disables the ability of clients to change their passwords via chooser or the "connect to server" dialog\&.
290 .RE
291 .PP
292 uam list = \fIuam list\fR \fB(G)\fR
293 .RS 4
294 Space or comma separated list of UAMs\&. (The default is "uams_dhx\&.so uams_dhx2\&.so")\&.
295 .sp
296 The most commonly used UAMs are:
297 .PP
298 uams_guest\&.so
299 .RS 4
300 allows guest logins
301 .RE
302 .PP
303 uams_clrtxt\&.so
304 .RS 4
305 (uams_pam\&.so or uams_passwd\&.so) Allow logins with passwords transmitted in the clear\&. (legacy)
306 .RE
307 .PP
308 uams_randum\&.so
309 .RS 4
310 allows Random Number and Two\-Way Random Number Exchange for authentication (requires a separate file containing the passwords, either @pkgconfdir@/afppasswd file or the one specified via "\fBpasswd file\fR"\&. See
311 \fBafppasswd\fR(1)
312 for details\&. (legacy)
313 .RE
314 .PP
315 uams_dhx\&.so
316 .RS 4
317 (uams_dhx_pam\&.so or uams_dhx_passwd\&.so) Allow Diffie\-Hellman eXchange (DHX) for authentication\&.
318 .RE
319 .PP
320 uams_dhx2\&.so
321 .RS 4
322 (uams_dhx2_pam\&.so or uams_dhx2_passwd\&.so) Allow Diffie\-Hellman eXchange 2 (DHX2) for authentication\&.
323 .RE
324 .PP
325 uam_gss\&.so
326 .RS 4
327 Allow Kerberos V for authentication (optional)
328 .RE
329 .RE
330 .PP
331 uam path = \fIpath\fR \fB(G)\fR
332 .RS 4
333 Sets the default path for UAMs for this server (default is @libdir@/netatalk)\&.
334 .RE
335 .SS "Charset Options"
336 .PP
337 With OS X Apple introduced the AFP3 protocol\&. One of the big changes was, that AFP3 uses Unicode names encoded as Decomposed UTF\-8 (UTF8\-MAC)\&. Previous AFP/OS versions used charsets like MacRoman, MacCentralEurope, etc\&.
338 .PP
339 To be able to serve AFP3 and older clients at the same time,
340 \fBafpd\fR
341 needs to be able to convert between UTF\-8 and Mac charsets\&. Even OS X clients partly still rely on the mac charset\&. As there\*(Aqs no way,
342 \fBafpd\fR
343 can detect the codepage a pre AFP3 client uses, you have to specify it using the
344 \fBmac charset\fR
345 option\&. The default is MacRoman, which should be fine for most western users\&.
346 .PP
347 As
348 \fBafpd\fR
349 needs to interact with UNIX operating system as well, it need\*(Aqs to be able to convert from UTF8\-MAC / Mac charset to the UNIX charset\&. By default
350 \fBafpd\fR
351 uses
352 \fIUTF8\fR\&. You can set the UNIX charset using the
353 \fBunix charset\fR
354 option\&. If you\*(Aqre using extended characters in the configuration files for
355 \fBafpd\fR, make sure your terminal matches the
356 \fBunix charset\fR\&.
357 .PP
358 mac charset = \fICHARSET\fR \fB(G)/(V)\fR
359 .RS 4
360 Specifies the Mac clients charset, e\&.g\&.
361 \fIMAC_ROMAN\fR\&. This is used to convert strings and filenames to the clients codepage for OS9 and Classic, i\&.e\&. for authentication and AFP messages (SIGUSR2 messaging)\&. This will also be the default for the volumes
362 \fBmac charset\fR\&. Defaults to
363 \fIMAC_ROMAN\fR\&.
364 .RE
365 .PP
366 unix charset = \fICHARSET\fR \fB(G)\fR
367 .RS 4
368 Specifies the servers unix charset, e\&.g\&.
369 \fIISO\-8859\-15\fR
370 or
371 \fIEUC\-JP\fR\&. This is used to convert strings to/from the systems locale, e\&.g\&. for authentication, server messages and volume names\&. If
372 \fILOCALE\fR
373 is set, the systems locale is used\&. Defaults to
374 \fIUTF8\fR\&.
375 .RE
376 .PP
377 vol charset = \fICHARSET\fR \fB(G)/(V)\fR
378 .RS 4
379 Specifies the encoding of the volumes filesystem\&. By default, it is the same as
380 \fBunix charset\fR\&.
381 .RE
382 .SS "Password Options"
383 .PP
384 passwd file = \fIpath\fR \fB(G)\fR
385 .RS 4
386 Sets the path to the Randnum UAM passwd file for this server (default is @pkgconfdir@/afppasswd)\&.
387 .RE
388 .PP
389 passwd minlen = \fInumber\fR \fB(G)\fR
390 .RS 4
391 Sets the minimum password length, if supported by the UAM
392 .RE
393 .SS "Network Options"
394 .PP
395 advertise ssh = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR
396 .RS 4
397 Allows old Mac OS X clients (10\&.3\&.3\-10\&.4) to automagically establish a tunneled AFP connection through SSH\&. If this option is set, the server\*(Aqs answers to client\*(Aqs FPGetSrvrInfo requests contain an additional entry\&. It depends on both client\*(Aqs settings and a correctly configured and running
398 \fBsshd\fR(8)
399 on the server to let things work\&.
400 .if n \{\
401 .sp
402 .\}
403 .RS 4
404 .it 1 an-trap
405 .nr an-no-space-flag 1
406 .nr an-break-flag 1
407 .br
408 .ps +1
409 \fBNote\fR
410 .ps -1
411 .br
412 Setting this option is not recommended since globally encrypting AFP connections via SSH will increase the server\*(Aqs load significantly\&. On the other hand, Apple\*(Aqs client side implementation of this feature in MacOS X versions prior to 10\&.3\&.4 contained a security flaw\&.
413 .sp .5v
414 .RE
415 .RE
416 .PP
417 afp interfaces = \fIname [name \&.\&.\&.]\fR \fB(G)\fR
418 .RS 4
419 Specifies the network interfaces that the server should listens on\&. The default is advertise the first IP address of the system, but to listen for any incoming request\&.
420 .RE
421 .PP
422 afp listen = \fIip address[:port] [ip address[:port] \&.\&.\&.]\fR \fB(G)\fR
423 .RS 4
424 Specifies the IP address that the server should advertise
425 \fBand\fR
426 listens to\&. The default is advertise the first IP address of the system, but to listen for any incoming request\&. The network address may be specified either in dotted\-decimal format for IPv4 or in hexadecimal format for IPv6\&.
427 .sp
428 IPv6 address + port combination must use URL the format using square brackets [IPv6]:port
429 .RE
430 .PP
431 afp port = \fIport number\fR \fB(G)\fR
432 .RS 4
433 Allows a different TCP port to be used for AFP\&. The default is 548\&. Also sets the default port applied when none specified in an
434 \fBafp listen\fR
435 option\&.
436 .RE
437 .PP
438 cnid listen = \fIip address[:port] [ip address[:port] \&.\&.\&.]\fR \fB(G)\fR
439 .RS 4
440 Specifies the IP address that the CNID server should listen on\&. The default is
441 \fBlocalhost:4700\fR\&.
442 .RE
443 .PP
444 disconnect time = \fInumber\fR \fB(G)\fR
445 .RS 4
446 Keep disconnected AFP sessions for
447 \fInumber\fR
448 hours before dropping them\&. Default is 24 hours\&.
449 .RE
450 .PP
451 dsireadbuf = \fInumber\fR \fB(G)\fR
452 .RS 4
453 Scale factor that determines the size of the DSI/TCP readahead buffer, default is 12\&. This is multiplies with the DSI server quantum (default ~300k) to give the size of the buffer\&. Increasing this value might increase throughput in fast local networks for volume to volume copies\&.
454 \fINote\fR: This buffer is allocated per afpd child process, so specifying large values will eat up large amount of memory (buffer size * number of clients)\&.
455 .RE
456 .PP
457 fqdn = \fIname:port\fR \fB(G)\fR
458 .RS 4
459 Specifies a fully\-qualified domain name, with an optional port\&. This is discarded if the server cannot resolve it\&. This option is not honored by AppleShare clients <= 3\&.8\&.3\&. This option is disabled by default\&. Use with caution as this will involve a second name resolution step on the client side\&. Also note that afpd will advertise this name:port combination but not automatically listen to it\&.
460 .RE
461 .PP
462 hostname = \fIname\fR \fB(G)\fR
463 .RS 4
464 Use this instead of the result from calling hostname for determining which IP address to advertise, therefore the hostname is resolved to an IP which is the advertised\&. This is NOT used for listening and it is also overwritten by
465 \fBafp listen\fR\&.
466 .RE
467 .PP
468 max connections = \fInumber\fR \fB(G)\fR
469 .RS 4
470 Sets the maximum number of clients that can simultaneously connect to the server (default is 200)\&.
471 .RE
472 .PP
473 server quantum = \fInumber\fR \fB(G)\fR
474 .RS 4
475 This specifies the DSI server quantum\&. The default value is 0x100000 (1 MiB)\&. The maximum value is 0xFFFFFFFFF, the minimum is 32000\&. If you specify a value that is out of range, the default value will be set\&. Do not change this value unless you\*(Aqre absolutely sure, what you\*(Aqre doing
476 .RE
477 .PP
478 sleep time = \fInumber\fR \fB(G)\fR
479 .RS 4
480 Keep sleeping AFP sessions for
481 \fInumber\fR
482 hours before disconnecting clients in sleep mode\&. Default is 10 hours\&.
483 .RE
484 .PP
485 tcprcvbuf = \fInumber\fR \fB(G)\fR
486 .RS 4
487 Try to set TCP receive buffer using setsockpt()\&. Often OSes impose restrictions on the applications ability to set this value\&.
488 .RE
489 .PP
490 tcpsndbuf = \fInumber\fR \fB(G)\fR
491 .RS 4
492 Try to set TCP send buffer using setsockpt()\&. Often OSes impose restrictions on the applications ability to set this value\&.
493 .RE
494 .PP
495 recvfile = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR
496 .RS 4
497 Whether to use splice() on Linux for receiving data\&.
498 .RE
499 .PP
500 splice size = \fInumber\fR (default: \fI64k\fR) \fB(G)\fR
501 .RS 4
502 Maximum number of bytes spliced\&.
503 .RE
504 .PP
505 use sendfile = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR
506 .RS 4
507 Whether to use sendfile
508 syscall for sending file data to clients\&.
509 .RE
510 .PP
511 zeroconf = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR
512 .RS 4
513 Whether to use automatic Zeroconf
514 service registration if Avahi or mDNSResponder were compiled in\&.
515 .RE
516 .SS "Miscellaneous Options"
517 .PP
518 admin group = \fIgroup\fR \fB(G)\fR
519 .RS 4
520 Allows users of a certain group to be seen as the superuser when they log in\&. This option is disabled by default\&.
521 .RE
522 .PP
523 afp read locks = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR
524 .RS 4
525 Whether to apply locks to the byte region read in FPRead calls\&. The AFP spec mandates this, but it\*(Aqs not really in line with UNIX semantics and is a performance hug\&.
526 .RE
527 .PP
528 afpstats = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR
529 .RS 4
530 Whether to provide AFP runtime statistics (connected users, open volumes) via dbus\&.
531 .RE
532 .PP
533 basedir regex = \fIregex\fR \fB(H)\fR
534 .RS 4
535 Regular expression which matches the parent directory of the user homes\&. If
536 \fBbasedir regex\fR
537 contains symlink, you must set the canonicalized absolute path\&. In the simple case this is just a path ie
538 \fBbasedir regex = /home\fR
539 .RE
540 .PP
541 close vol = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR
542 .RS 4
543 Whether to close volumes possibly opened by clients when they\*(Aqre removed from the configuration and the configuration is reloaded\&.
544 .RE
545 .PP
546 cnid mysql host = \fIMySQL server address\fR \fB(G)\fR
547 .RS 4
548 name or address of a MySQL server for use with the mysql CNID backend\&.
549 .RE
550 .PP
551 cnid mysql user = \fIMySQL user\fR \fB(G)\fR
552 .RS 4
553 MySQL user for authentication with the server\&.
554 .RE
555 .PP
556 cnid mysql pw = \fIpassword\fR \fB(G)\fR
557 .RS 4
558 Password for MySQL server\&.
559 .RE
560 .PP
561 cnid mysql db = \fIdatabase name\fR \fB(G)\fR
562 .RS 4
563 Name of an existing database for which the specified user has full privileges\&.
564 .RE
565 .PP
566 cnid server = \fIipaddress[:port]\fR \fB(G)/(V)\fR
567 .RS 4
568 Specifies the IP address and port of a cnid_metad server, required for CNID dbd backend\&. Defaults to localhost:4700\&. The network address may be specified either in dotted\-decimal format for IPv4 or in hexadecimal format for IPv6\&.\-
569 .RE
570 .PP
571 dbus daemon = \fIpath\fR \fB(G)\fR
572 .RS 4
573 Sets the path to dbus\-daemon binary used by Spotlight feature\&. The default is
574 /bin/dbus\-daemon\&.
575 .RE
576 .PP
577 dircachesize = \fInumber\fR \fB(G)\fR
578 .RS 4
579 Maximum possible entries in the directory cache\&. The cache stores directories and files\&. It is used to cache the full path to directories and CNIDs which considerably speeds up directory enumeration\&.
580 .sp
581 Default size is 8192, maximum size is 131072\&. Given value is rounded up to nearest power of 2\&. Each entry takes about 100 bytes, which is not much, but remember that every afpd child process for every connected user has its cache\&.
582 .RE
583 .PP
584 extmap file = \fIpath\fR \fB(G)\fR
585 .RS 4
586 Sets the path to the file which defines file extension type/creator mappings\&. (default is @pkgconfdir@/extmap\&.conf)\&.
587 .RE
588 .PP
589 guest account = \fIname\fR \fB(G)\fR
590 .RS 4
591 Specifies the user that guests should use (default is "nobody")\&. The name should be quoted\&.
592 .RE
593 .PP
594 home name = \fIname\fR \fB(H)\fR
595 .RS 4
596 AFP user home volume name\&. The default is
597 \fIuser\*(Aqs home\fR\&.
598 .RE
599 .PP
600 ignored attributes = \fIall | nowrite | nodelete | norename\fR \fB(G)/(V)\fR
601 .RS 4
602 Speficy a set of file and directory attributes that shall be ignored by the server,
603 \fBall\fR
604 includes all the other options\&.
605 .sp
606 In OS X when the Finder sets a lock on a file/directory or you set the BSD uchg flag in the Terminal, all three attributes are used\&. Thus in order to ignore the Finder lock/BSD uchg flag, add set
607 \fIignored attributes = all\fR\&.
608 .RE
609 .PP
610 login message = \fImessage\fR \fB(G)/(V)\fR
611 .RS 4
612 Sets a message to be displayed when clients logon to the server\&. The message should be in
613 \fBunix charset\fR
614 and should be quoted\&. Extended characters are allowed\&.
615 .RE
616 .PP
617 mimic model = \fImodel\fR \fB(G)\fR
618 .RS 4
619 Specifies the icon model that appears on clients\&. Defaults to off\&. Note that afpd must support Zeroconf\&. Examples: RackMac (same as Xserve), PowerBook, PowerMac, Macmini, iMac, MacBook, MacBookPro, MacBookAir, MacPro, AppleTV1,1, AirPort\&.
620 .RE
621 .PP
622 signature = <text> \fB(G)\fR
623 .RS 4
624 Specify a server signature\&. The maximum length is 16 characters\&. This option is useful for clustered environments, to provide fault isolation etc\&. By default, afpd generate signature and saving it to
625 @localstatedir@/netatalk/afp_signature\&.conf
626 automatically (based on random number)\&. See also asip\-status\&.pl(1)\&.
627 .RE
628 .PP
629 solaris share reservations = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR
630 .RS 4
631 Use share reservations on Solaris\&. Solaris CIFS server uses this too, so this makes a lock coherent multi protocol server\&.
632 .RE
633 .PP
634 spotlight = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)/(V)\fR
635 .RS 4
636 Whether to enable Spotlight searches\&. Note: once the global option is enabled, any volume that is not enabled won\*(Aqt be searchable at all\&. See also
637 \fIdbus daemon\fR
638 option\&.
639 .RE
640 .PP
641 veto message = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR
642 .RS 4
643 Send optional AFP messages for vetoed files\&. Then whenever a client tries to access any file or directory with a vetoed name, it will be sent an AFP message indicating the name and the directory\&.
644 .RE
645 .PP
646 vol dbpath = \fIpath\fR \fB(G)/(V)\fR
647 .RS 4
648 Sets the database information to be stored in path\&. You have to specify a writable location, even if the volume is read only\&. The default is
649 @localstatedir@/netatalk/CNID/$v/\&.
650 .RE
651 .PP
652 vol dbnest = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR
653 .RS 4
654 Setting this option to true brings back Netatalk 2 behaviour of storing the CNID database in a folder called \&.AppleDB inside the volume root of each share\&.
655 .RE
656 .PP
657 volnamelen = \fInumber\fR \fB(G)\fR
658 .RS 4
659 Max length of UTF8\-MAC volume name for Mac OS X\&. Note that Hangul is especially sensitive to this\&.
660 .sp
661 .if n \{\
662 .RS 4
663 .\}
664 .nf
665  73: limit of Mac OS X 10\&.1 80: limit of Mac
666             OS X 10\&.4/10\&.5 (default) 255: limit of recent Mac OS
667             X
668 .fi
669 .if n \{\
670 .RE
671 .\}
672 .sp
673 Mac OS 9 and earlier are not influenced by this, because Maccharset volume name is always limited to 27 bytes\&.
674 .RE
675 .PP
676 vol preset = \fIname\fR \fB(G)/(V)\fR
677 .RS 4
678 Use section
679 \fBname\fR
680 as option preset for all volumes (when set in the [Global] section) or for one volume (when set in that volume\*(Aqs section)\&.
681 .RE
682 .SS "Logging Options"
683 .PP
684 log file = \fIlogfile\fR \fB(G)\fR
685 .RS 4
686 If not specified Netatalk logs to syslogs daemon facility\&. Otherwise it logs to
687 \fBlogfile\fR\&.
688 .RE
689 .PP
690 log level = \fItype:level [type:level \&.\&.\&.]\fR \fB(G)\fR, log level = \fItype:level,[type:level, \&.\&.\&.]\fR \fB(G)\fR
691 .RS 4
692 Specify that any message of a loglevel up to the given
693 \fBlog level\fR
694 should be logged\&.
695 .sp
696 By default afpd logs to syslog with a default logging setup equivalent to
697 \fBdefault:note\fR
698 .sp
699 logtypes: default, afpdaemon, logger, uamsdaemon
700 .sp
701 loglevels: severe, error, warn, note, info, debug, debug6, debug7, debug8, debug9, maxdebug
702 .if n \{\
703 .sp
704 .\}
705 .RS 4
706 .it 1 an-trap
707 .nr an-no-space-flag 1
708 .nr an-break-flag 1
709 .br
710 .ps +1
711 \fBNote\fR
712 .ps -1
713 .br
714 Both logtype and loglevels are case insensitive\&.
715 .sp .5v
716 .RE
717 .RE
718 .SS "Filesystem Change Events (FCE)"
719 .PP
720 Netatalk includes a nifty filesystem change event mechanism where afpd processes notify interested listeners about certain filesystem event by UDP network datagrams\&.
721 .PP
722 fce listener = \fIhost[:port]\fR \fB(G)\fR
723 .RS 4
724 Enables sending FCE events to the specified
725 \fIhost\fR, default
726 \fIport\fR
727 is 12250 if not specified\&. Specifying multiple listeners is done by having this option once for each of them\&.
728 .RE
729 .PP
730 fce events = \fIfmod,fdel,ddel,fcre,dcre,tmsz\fR \fB(G)\fR
731 .RS 4
732 Specifies which FCE events are active, default is
733 \fIfmod,fdel,ddel,fcre,dcre\fR\&.
734 .RE
735 .PP
736 fce coalesce = \fIall|delete|create\fR \fB(G)\fR
737 .RS 4
738 Coalesce FCE events\&.
739 .RE
740 .PP
741 fce holdfmod = \fIseconds\fR \fB(G)\fR
742 .RS 4
743 This determines the time delay in seconds which is always waited if another file modification for the same file is done by a client before sending an FCE file modification event (fmod)\&. For example saving a file in Photoshop would generate multiple events by itself because the application is opening, modifying and closing a file multiple times for every "save"\&. Default: 60 seconds\&.
744 .RE
745 .SS "Debug Parameters"
746 .PP
747 These options are useful for debugging only\&.
748 .PP
749 tickleval = \fInumber\fR \fB(G)\fR
750 .RS 4
751 Sets the tickle timeout interval (in seconds)\&. Defaults to 30\&.
752 .RE
753 .PP
754 timeout = \fInumber\fR \fB(G)\fR
755 .RS 4
756 Specify the number of tickles to send before timing out a connection\&. The default is 4, therefore a connection will timeout after 2 minutes\&.
757 .RE
758 .PP
759 client polling = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR
760 .RS 4
761 With this option enabled, afpd won\*(Aqt advertise that it is capable of server notifications, so that connected clients poll the server every 10 seconds to detect changes in opened server windows\&.
762 \fINote\fR: Depending on the number of simultaneously connected clients and the network\*(Aqs speed, this can lead to a significant higher load on your network!
763 .sp
764 Do not use this option any longer as present Netatalk correctly supports server notifications, allowing connected clients to update folder listings in case another client changed the contents\&.
765 .RE
766 .SS "Options for ACL handling"
767 .PP
768 By default, the effective permission of the authenticated user are only mapped to the mentioned UARights permission structure, not the UNIX mode\&. You can adjust this behaviour with the configuration option
769 \fBmac acls\fR:
770 .PP
771 map acls = \fInone|rights|mode\fR \fB(G)\fR
772 .RS 4
773 .PP
774 none
775 .RS 4
776 no mapping of ACLs
777 .RE
778 .PP
779 rights
780 .RS 4
781 effective permissions are mapped to UARights structure\&. This is the default\&.
782 .RE
783 .PP
784 mode
785 .RS 4
786 ACLs are additionally mapped to the UNIX mode of the filesystem object\&.
787 .RE
788 .RE
789 .PP
790 If you want to be able to display ACLs on the client, you must setup both client and server as part on a authentication domain (directory service, eg LDAP, Open Directory, Active Directory)\&. The reason is, in OS X ACLs are bound to UUIDs, not just uid\*(Aqs or gid\*(Aqs\&. Therefor Netatalk must be able to map every filesystem uid and gid to a UUID so that it can return the server side ACLs which are bound to UNIX uid and gid mapped to OS X UUIDs\&.
791 .PP
792 Netatalk can query a directory server using LDAP queries\&. Either the directory server already provides an UUID attribute for user and groups (Active Directory, Open Directory) or you reuse an unused attribute (or add a new one) to you directory server (eg OpenLDAP)\&.
793 .PP
794 The following LDAP options must be configured for Netatalk:
795 .PP
796 ldap auth method = \fInone|simple|sasl\fR \fB(G)\fR
797 .RS 4
798 Authentication method:
799 \fBnone | simple | sasl\fR
800 .PP
801 none
802 .RS 4
803 anonymous LDAP bind
804 .RE
805 .PP
806 simple
807 .RS 4
808 simple LDAP bind
809 .RE
810 .PP
811 sasl
812 .RS 4
813 SASL\&. Not yet supported !
814 .RE
815 .RE
816 .PP
817 ldap auth dn = \fIdn\fR \fB(G)\fR
818 .RS 4
819 Distinguished Name of the user for simple bind\&.
820 .RE
821 .PP
822 ldap auth pw = \fIpassword\fR \fB(G)\fR
823 .RS 4
824 Distinguished Name of the user for simple bind\&.
825 .RE
826 .PP
827 ldap server = \fIhost\fR \fB(G)\fR
828 .RS 4
829 Name or IP address of your LDAP Server\&. This is only needed for explicit ACL support in order to be able to query LDAP for UUIDs\&.
830 .sp
831 You can use
832 \fBafpldaptest\fR(1)
833 to syntactically check your config\&.
834 .RE
835 .PP
836 ldap userbase = \fIbase dn\fR \fB(G)\fR
837 .RS 4
838 DN of the user container in LDAP\&.
839 .RE
840 .PP
841 ldap userscope = \fIscope\fR \fB(G)\fR
842 .RS 4
843 Search scope for user search:
844 \fBbase | one | sub\fR
845 .RE
846 .PP
847 ldap groupbase = \fIbase dn\fR \fB(G)\fR
848 .RS 4
849 DN of the group container in LDAP\&.
850 .RE
851 .PP
852 ldap groupscope = \fIscope\fR \fB(G)\fR
853 .RS 4
854 Search scope for user search:
855 \fBbase | one | sub\fR
856 .RE
857 .PP
858 ldap uuid attr = \fIdn\fR \fB(G)\fR
859 .RS 4
860 Name of the LDAP attribute with the UUIDs\&.
861 .sp
862 Note: this is used both for users and groups\&.
863 .RE
864 .PP
865 ldap name attr = \fIdn\fR \fB(G)\fR
866 .RS 4
867 Name of the LDAP attribute with the users short name\&.
868 .RE
869 .PP
870 ldap group attr = \fIdn\fR \fB(G)\fR
871 .RS 4
872 Name of the LDAP attribute with the groups short name\&.
873 .RE
874 .PP
875 ldap uuid string = \fISTRING\fR \fB(G)\fR
876 .RS 4
877 Format of the uuid string in the directory\&. A series of x and \-, where every x denotes a value 0\-9a\-f and every \- is a separator\&.
878 .sp
879 Default: xxxxxxxx\-xxxx\-xxxx\-xxxx\-xxxxxxxxxxxx
880 .RE
881 .PP
882 ldap uuid encoding = \fIstring | ms\-guid (default: string)\fR \fB(G)\fR
883 .RS 4
884 Format of the UUID of the LDAP attribute, allows usage of the binary objectGUID fields from Active Directory\&. If left unspecified, string is the default, which passes through the ASCII UUID returned by most other LDAP stores\&. If set to ms\-guid, the internal UUID representation is converted to and from the binary format used in the objectGUID attribute found on objects in Active Directory when interacting with the server\&.
885 .sp
886 See also the options
887 \fBldap user filter\fR
888 and
889 \fBldap group filter\fR\&.
890 .PP
891 string
892 .RS 4
893 UUID is a string, use with eg OpenDirectory\&.
894 .RE
895 .PP
896 ms\-guid
897 .RS 4
898 Binary objectGUID from Active Directory
899 .RE
900 .RE
901 .PP
902 ldap user filter = \fISTRING (default: unused)\fR \fB(G)\fR
903 .RS 4
904 Optional LDAP filter that matches user objects\&. This is necessary for Active Directory environments where users and groups are stored in the same directory subtree\&.
905 .sp
906 Recommended setting for Active Directory:
907 \fIobjectClass=user\fR\&.
908 .RE
909 .PP
910 ldap group filter = \fISTRING (default: unused)\fR \fB(G)\fR
911 .RS 4
912 Optional LDAP filter that matches group objects\&. This is necessary for Active Directory environments where users and groups are stored in the same directory subtree\&.
913 .sp
914 Recommended setting for Active Directory:
915 \fIobjectClass=group\fR\&.
916 .RE
917 .SH "EXPLANATION OF VOLUME PARAMETERS"
918 .SS "Parameters"
919 .PP
920 The section name defines the volume name\&. No two volumes may have the same name\&. The volume name cannot contain the
921 \*(Aq:\*(Aq
922 character\&. The volume name is mangled if it is very long\&. Mac charset volume name is limited to 27 characters\&. UTF8\-MAC volume name is limited to volnamelen parameter\&.
923 .PP
924 path = \fIPATH\fR \fB(V)\fR
925 .RS 4
926 The path name must be a fully qualified path name\&.
927 .RE
928 .PP
929 appledouble = \fIea|v2\fR \fB(V)\fR
930 .RS 4
931 Specify the format of the metadata files, which are used for saving Mac resource fork as well\&. Earlier versions used AppleDouble v2, the new default format is
932 \fBea\fR\&.
933 .RE
934 .PP
935 vol size limit = \fIsize in MiB\fR \fB(V)\fR
936 .RS 4
937 Useful for Time Machine: limits the reported volume size, thus preventing Time Machine from using the whole real disk space for backup\&. Example: "vol size limit = 1000" would limit the reported disk space to 1 GB\&.
938 \fBIMPORTANT: \fR
939 This is an approximated calculation taking into account the contents of Time Machine sparsebundle images\&. Therefor you MUST NOT use this volume to store other content when using this option, because it would NOT be accounted\&. The calculation works by reading the band size from the Info\&.plist XML file of the sparsebundle, reading the bands/ directory counting the number of band files, and then multiplying one with the other\&.
940 .RE
941 .PP
942 valid users = \fIuser @group\fR \fB(V)\fR
943 .RS 4
944 The allow option allows the users and groups that access a share to be specified\&. Users and groups are specified, delimited by spaces or commas\&. Groups are designated by a @ prefix\&. Names may be quoted in order to allow for spaces in names\&. Example:
945 .sp
946 .if n \{\
947 .RS 4
948 .\}
949 .nf
950 valid users = user "user 2" @group \(lq@group 2"
951 .fi
952 .if n \{\
953 .RE
954 .\}
955 .RE
956 .PP
957 invalid users = \fIusers/groups\fR \fB(V)\fR
958 .RS 4
959 The deny option specifies users and groups who are not allowed access to the share\&. It follows the same format as the "valid users" option\&.
960 .RE
961 .PP
962 hosts allow = \fIIP host address/IP netmask bits [ \&.\&.\&. ]\fR \fB(V)\fR
963 .RS 4
964 Only listed hosts and networks are allowed, all others are rejected\&. The network address may be specified either in dotted\-decimal format for IPv4 or in hexadecimal format for IPv6\&.
965 .sp
966 Example: hosts allow = 10\&.1\&.0\&.0/16 10\&.2\&.1\&.100 2001:0db8:1234::/48
967 .RE
968 .PP
969 hosts deny = \fIIP host address/IP netmask bits [ \&.\&.\&. ]\fR \fB(V)\fR
970 .RS 4
971 Listed hosts and nets are rejected, all others are allowed\&.
972 .sp
973 Example: hosts deny = 192\&.168\&.100/24 10\&.1\&.1\&.1 2001:db8::1428:57ab
974 .RE
975 .PP
976 cnid scheme = \fIbackend\fR \fB(V)\fR
977 .RS 4
978 set the CNID backend to be used for the volume, default is [@DEFAULT_CNID_SCHEME@] available schemes: [@compiled_backends@]
979 .RE
980 .PP
981 ea = \fInone|auto|sys|ad\fR \fB(V)\fR
982 .RS 4
983 Specify how Extended Attributes
984 are stored\&.
985 \fBauto\fR
986 is the default\&.
987 .PP
988 auto
989 .RS 4
990 Try
991 \fBsys\fR
992 (by setting an EA on the shared directory itself), fallback to
993 \fBad\fR\&. Requires writable volume for performing test\&. "\fBread only = yes\fR" overwrites
994 \fBauto\fR
995 with
996 \fBnone\fR\&. Use explicit "\fBea = sys|ad\fR" for read\-only volumes where appropriate\&.
997 .RE
998 .PP
999 sys
1000 .RS 4
1001 Use filesystem Extended Attributes\&.
1002 .RE
1003 .PP
1004 ad
1005 .RS 4
1006 Use files in
1007 \fI\&.AppleDouble\fR
1008 directories\&.
1009 .RE
1010 .PP
1011 none
1012 .RS 4
1013 No Extended Attributes support\&.
1014 .RE
1015 .RE
1016 .PP
1017 mac charset = \fICHARSET\fR \fB(V)\fR
1018 .RS 4
1019 specifies the Mac client charset for this Volume, e\&.g\&.
1020 \fIMAC_ROMAN\fR,
1021 \fIMAC_CYRILLIC\fR\&. If not specified the global setting is applied\&. This setting is only required if you need volumes, where the Mac charset differs from the one globally set in the [Global] section\&.
1022 .RE
1023 .PP
1024 casefold = \fBoption\fR \fB(V)\fR
1025 .RS 4
1026 The casefold option handles, if the case of filenames should be changed\&. The available options are:
1027 .sp
1028 \fBtolower\fR
1029 \- Lowercases names in both directions\&.
1030 .sp
1031 \fBtoupper\fR
1032 \- Uppercases names in both directions\&.
1033 .sp
1034 \fBxlatelower\fR
1035 \- Client sees lowercase, server sees uppercase\&.
1036 .sp
1037 \fBxlateupper\fR
1038 \- Client sees uppercase, server sees lowercase\&.
1039 .RE
1040 .PP
1041 password = \fIpassword\fR \fB(V)\fR
1042 .RS 4
1043 This option allows you to set a volume password, which can be a maximum of 8 characters long (using ASCII strongly recommended at the time of this writing)\&.
1044 .RE
1045 .PP
1046 file perm = \fImode\fR \fB(V)\fR, directory perm = \fImode\fR \fB(V)\fR
1047 .RS 4
1048 Add(or) with the client requested permissions:
1049 \fBfile perm\fR
1050 is for files only,
1051 \fBdirectory perm\fR
1052 is for directories only\&. Don\*(Aqt use with "\fBunix priv = no\fR"\&.
1053 .PP
1054 \fBExample.\ \&Volume for a collaborative workgroup\fR
1055 .sp
1056 .if n \{\
1057 .RS 4
1058 .\}
1059 .nf
1060 file perm = 0660 directory perm =
1061               0770
1062 .fi
1063 .if n \{\
1064 .RE
1065 .\}
1066
1067 .RE
1068 .PP
1069 umask = \fImode\fR \fB(V)\fR
1070 .RS 4
1071 set perm mask\&. Don\*(Aqt use with "\fBunix priv = no\fR"\&.
1072 .RE
1073 .PP
1074 preexec = \fIcommand\fR \fB(V)\fR
1075 .RS 4
1076 command to be run when the volume is mounted, ignored for user defined volumes
1077 .RE
1078 .PP
1079 postexec = \fIcommand\fR \fB(V)\fR
1080 .RS 4
1081 command to be run when the volume is closed, ignored for user defined volumes
1082 .RE
1083 .PP
1084 root preexec = \fIcommand\fR \fB(V)\fR
1085 .RS 4
1086 command to be run as root when the volume is mounted, ignored for user defined volumes
1087 .RE
1088 .PP
1089 root postexec = \fIcommand\fR \fB(V)\fR
1090 .RS 4
1091 command to be run as root when the volume is closed, ignored for user defined volumes
1092 .RE
1093 .PP
1094 rolist = \fBusers/groups\fR \fB(V)\fR
1095 .RS 4
1096 Allows certain users and groups to have read\-only access to a share\&. This follows the allow option format\&.
1097 .RE
1098 .PP
1099 rwlist = \fIusers/groups\fR \fB(V)\fR
1100 .RS 4
1101 Allows certain users and groups to have read/write access to a share\&. This follows the allow option format\&.
1102 .RE
1103 .PP
1104 veto files = \fIvetoed names\fR \fB(V)\fR
1105 .RS 4
1106 hide files and directories,where the path matches one of the \*(Aq/\*(Aq delimited vetoed names\&. The veto string must always be terminated with a \*(Aq/\*(Aq, eg\&. "veto files = veto1/", "veto files = veto1/veto2/"\&.
1107 .RE
1108 .SS "Volume options"
1109 .PP
1110 Boolean volume options\&.
1111 .PP
1112 acls = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR
1113 .RS 4
1114 Whether to flag volumes as supporting ACLs\&. If ACL support is compiled in, this is yes by default\&.
1115 .RE
1116 .PP
1117 cnid dev = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR
1118 .RS 4
1119 Whether to use the device number in the CNID backends\&. Helps when the device number is not constant across a reboot, eg cluster, \&.\&.\&.
1120 .RE
1121 .PP
1122 convert appledouble = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR
1123 .RS 4
1124 Whether automatic conversion from
1125 \fBappledouble = v2\fR
1126 to
1127 \fBappledouble = ea\fR
1128 is performed when accessing filesystems from clients\&. This is generally useful, but costs some performance\&. It\*(Aqs recommendable to run
1129 \fBdbd\fR
1130 on volumes and do the conversion with that\&. Then this option can be set to no\&.
1131 .RE
1132 .PP
1133 delete veto files = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR
1134 .RS 4
1135 This option is used when Netatalk is attempting to delete a directory that contains one or more vetoed files or directories (see the veto files option)\&. If this option is set to no (the default) then if a directory contains any non\-vetoed files or directories then the directory delete will fail\&. This is usually what you want\&.
1136 .sp
1137 If this option is set to yes, then Netatalk will attempt to recursively delete any files and directories within the vetoed directory\&.
1138 .RE
1139 .PP
1140 follow symlinks = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR
1141 .RS 4
1142 The default setting is false thus symlinks are not followed on the server\&. This is the same behaviour as OS X\*(Aqs AFP server\&. Setting the option to true causes afpd to follow symlinks on the server\&. symlinks may point outside of the AFP volume, currently afpd doesn\*(Aqt do any checks for "wide symlinks"\&.
1143 .if n \{\
1144 .sp
1145 .\}
1146 .RS 4
1147 .it 1 an-trap
1148 .nr an-no-space-flag 1
1149 .nr an-break-flag 1
1150 .br
1151 .ps +1
1152 \fBNote\fR
1153 .ps -1
1154 .br
1155 This option will subtly break when the symlinks point across filesystem boundaries\&.
1156 .sp .5v
1157 .RE
1158 .RE
1159 .PP
1160 invisible dots = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR
1161 .RS 4
1162 make dot files invisible\&. WARNING: enabling this option will lead to unwanted sideeffects were OS X applications when saving files to a temporary file starting with a dot first, then renaming the temp file to its final name, result in the saved file being invisible\&. The only thing this option is useful for is making files that start with a dot invisible on Mac OS 9\&. It\*(Aqs completely useless on Mac OS X, as both in Finder and in Terminal files starting with a dot are hidden anyway\&.
1163 .RE
1164 .PP
1165 network ids = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR
1166 .RS 4
1167 Whether the server support network ids\&. Setting this to
1168 \fIno\fR
1169 will result in the client not using ACL AFP functions\&.
1170 .RE
1171 .PP
1172 preexec close = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR
1173 .RS 4
1174 A non\-zero return code from preexec close the volume being immediately, preventing clients to mount/see the volume in question\&.
1175 .RE
1176 .PP
1177 read only = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR
1178 .RS 4
1179 Specifies the share as being read only for all users\&. Overwrites
1180 \fBea = auto\fR
1181 with
1182 \fBea = none\fR
1183 .RE
1184 .PP
1185 root preexec close= \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR
1186 .RS 4
1187 A non\-zero return code from root_preexec closes the volume immediately, preventing clients to mount/see the volume in question\&.
1188 .RE
1189 .PP
1190 search db = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR
1191 .RS 4
1192 Use fast CNID database namesearch instead of slow recursive filesystem search\&. Relies on a consistent CNID database, ie Samba or local filesystem access lead to inaccurate or wrong results\&. Works only for "dbd" CNID db volumes\&.
1193 .RE
1194 .PP
1195 stat vol = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR
1196 .RS 4
1197 Whether to stat volume path when enumerating volumes list, useful for automounting or volumes created by a preexec script\&.
1198 .RE
1199 .PP
1200 time machine = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR
1201 .RS 4
1202 Whether to enable Time Machine support for this volume\&.
1203 .RE
1204 .PP
1205 unix priv = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR
1206 .RS 4
1207 Whether to use AFP3 UNIX privileges\&. This should be set for OS X clients\&. See also:
1208 \fBfile perm\fR,
1209 \fBdirectory perm\fR
1210 and
1211 \fBumask\fR\&.
1212 .RE
1213 .SH "CNID BACKENDS"
1214 .PP
1215 The AFP protocol mostly refers to files and directories by ID and not by name\&. Netatalk needs a way to store these ID\*(Aqs in a persistent way, to achieve this several different CNID backends are available\&. The CNID Databases are by default located in the
1216 @localstatedir@/netatalk/CNID/(volumename)/\&.AppleDB/
1217 directory\&.
1218 .PP
1219 cdb
1220 .RS 4
1221 "Concurrent database", backend is based on Oracle Berkley DB\&. With this backend several
1222 \fBafpd\fR
1223 daemons access the CNID database directly\&. Berkeley DB locking is used to synchronize access, if more than one
1224 \fBafpd\fR
1225 process is active for a volume\&. The drawback is, that the crash of a single
1226 \fBafpd\fR
1227 process might corrupt the database\&.
1228 .RE
1229 .PP
1230 dbd
1231 .RS 4
1232 Access to the CNID database is restricted to the
1233 \fBcnid_metad\fR
1234 daemon process\&.
1235 \fBafpd\fR
1236 processes communicate with the daemon for database reads and updates\&. If built with Berkeley DB transactions the probability for database corruption is practically zero, but performance can be slower than with
1237 \fBcdb\fR
1238 .RE
1239 .PP
1240 last
1241 .RS 4
1242 This backend is an exception, in terms of ID persistency\&. ID\*(Aqs are only valid for the current session\&. This is basically what
1243 \fBafpd\fR
1244 did in the 1\&.5 (and 1\&.6) versions\&. This backend is still available, as it is useful for e\&.g\&. sharing cdroms\&. Starting with Netatalk 3\&.0, it becomes the
1245 \fIread only mode\fR
1246 automatically\&.
1247 .sp
1248 \fBWarning\fR: It is
1249 \fINOT\fR
1250 recommended to use this backend for volumes anymore, as
1251 \fBafpd\fR
1252 now relies heavily on a persistent ID database\&. Aliases will likely not work and filename mangling is not supported\&.
1253 .RE
1254 .PP
1255 Even though
1256 \fB\&./configure \-\-help\fR
1257 might show that there are other CNID backends available, be warned those are likely broken or mainly used for testing\&. Don\*(Aqt use them unless you know what you\*(Aqre doing, they may be removed without further notice from future versions\&.
1258 .SH "CHARSET OPTIONS"
1259 .PP
1260 With OS X Apple introduced the AFP3 protocol\&. One of the most important changes was that AFP3 uses unicode names encoded as UTF\-8 decomposed\&. Previous AFP/OS versions used codepages, like MacRoman, MacCentralEurope, etc\&.
1261 .PP
1262 \fBafpd\fR
1263 needs a way to preserve extended Macintosh characters, or characters illegal in unix filenames, when saving files on a unix filesystem\&. Earlier versions used the the so called CAP encoding\&. An extended character (>0x7F) would be converted to a :xx sequence, e\&.g\&. the Apple Logo (MacRoman: 0xF0) was saved as
1264 :f0\&. Some special characters will be converted as to :xx notation as well\&. \*(Aq/\*(Aq will be encoded to
1265 :2f, if
1266 \fBusedots\fR
1267 is not specified, a leading dot \*(Aq\&.\*(Aq will be encoded as
1268 :2e\&.
1269 .PP
1270 This version now uses UTF\-8 as the default encoding for names\&. \*(Aq/\*(Aq will be converted to \*(Aq:\*(Aq\&.
1271 .PP
1272 The
1273 \fBvol charset\fR
1274 option will allow you to select another volume encoding\&. E\&.g\&. for western users another useful setting could be vol charset ISO\-8859\-15\&.
1275 \fBafpd\fR
1276 will accept any
1277 \fBiconv\fR(1)
1278 provided charset\&. If a character cannot be converted from the
1279 \fBmac charset\fR
1280 to the selected
1281 \fBvol charset\fR, afpd will save it as a CAP encoded character\&. For AFP3 clients,
1282 \fBafpd\fR
1283 will convert the UTF\-8
1284 character to
1285 \fBmac charset\fR
1286 first\&. If this conversion fails, you\*(Aqll receive a \-50 error on the mac\&.
1287 .PP
1288 \fINote\fR: Whenever you can, please stick with the default UTF\-8 volume format\&.
1289 .SH "SEE ALSO"
1290 .PP
1291 \fBafpd\fR(8),
1292 \fBafppasswd\fR(5),
1293 \fBafp_signature.conf\fR(5),
1294 \fBextmap.conf\fR(5),
1295 \fBcnid_metad\fR(8)