File: afp.conf.5.xml

package info (click to toggle)
netatalk 3.1.12~ds-3
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 14,756 kB
  • sloc: ansic: 104,976; sh: 8,247; xml: 7,394; perl: 1,936; makefile: 1,430; python: 1,342; yacc: 309; lex: 49
file content (2320 lines) | stat: -rw-r--r-- 84,981 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
<?xml version="1.0" encoding="UTF-8"?>
<refentry id="afp.conf.5">
  <refmeta>
    <refentrytitle>afp.conf</refentrytitle>

    <manvolnum>5</manvolnum>

    <refmiscinfo class="date">27 Dec 2016</refmiscinfo>

    <refmiscinfo class="source">@NETATALK_VERSION@</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>afp.conf</refname>

    <refpurpose>Netatalk configuration file</refpurpose>
  </refnamediv>

  <refsect1>
    <title>SYNOPSIS</title>

    <para>The <filename>afp.conf</filename> file is the configuration file for
    the <emphasis role="bold">Netatalk</emphasis> AFP file server.</para>

    <para>All AFP specific configuration and AFP volume definitions are done
    via this file.</para>
  </refsect1>

  <refsect1 id="FILEFORMATSECT">
    <title>FILE FORMAT</title>

    <para>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: <programlisting>
    <replaceable>name</replaceable> = <replaceable>value </replaceable>
    </programlisting></para>

    <para>The file is line-based - that is, each newline-terminated line
    represents either a comment, a section name or a parameter.</para>

    <para>Section and parameter names are case sensitive.</para>

    <para>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.</para>

    <para>Any line beginning with a semicolon (<quote>;</quote>) or a hash
    (<quote>#</quote>) character is ignored, as are lines containing only
    whitespace.</para>

    <para>Any line ending in a <quote> <literal>\</literal> </quote> is
    continued on the next line in the customary UNIX fashion.</para>

    <para>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 "file perm"s are numeric.</para>

    <para>The parameter <option>include =
    <replaceable>path</replaceable></option> allows you to include one config
    file inside another. The file is included literally, as though typed in
    place. Nested includes are not supported.</para>
  </refsect1>

  <refsect1>
    <title>SECTION DESCRIPTIONS</title>

    <para>Each section in the configuration file (except for the [Global]
    section) describes a shared resource (known as a <quote>volume</quote>).
    The section name is the name of the volume and the parameters within the
    section define the volume attributes and options.</para>

    <para>There are two special sections, [Global] and [Homes], which are
    described under <emphasis>special sections</emphasis>. The following notes
    apply to ordinary section descriptions.</para>

    <para>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 <option>path</option> option must specify the
    directory to share.</para>

    <para>Any volume section without <option>path</option> option is
    considered a <emphasis>vol preset</emphasis> which can be selected in
    other volume sections via the <option>vol preset</option> option and
    constitutes defaults for the volume. For any option specified both in a
    preset <emphasis>and</emphasis> in a volume section the volume section
    setting completely substitutes the preset option.</para>

    <para>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.</para>

    <para>The following sample section defines an AFP volume. The user has
    full access to the path <filename>/foo/bar</filename>. The share is
    accessed via the share name <literal>baz</literal>: <programlisting> [baz]
    path = /foo/bar </programlisting></para>
  </refsect1>

  <refsect1>
    <title>SPECIAL SECTIONS</title>

    <refsect2>
      <title>The [Global] section</title>

      <para>Parameters in this section apply to the server as a whole.
      Parameters denoted by a (G) below are must be set in this
      section.</para>
    </refsect2>

    <refsect2>
      <title>The [Homes] section</title>

      <para>This section enable sharing of the UNIX server user home
      directories. Specifying an optional <option>path</option> parameter
      means that not the whole user home will be shared but the subdirectory
      <option>path</option>. It is necessary to define the <option>basedir
      regex</option> 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 <option>home name</option> can
      be used to change the AFP volume name which <emphasis>$u's
      home</emphasis> by default. See below under VARIABLE
      SUBSTITUTIONS.</para>

      <para>The following example illustrates this. Given all user home
      directories are stored under <filename>/home</filename>:
      <programlisting> [Homes]
      path = afp-data
      basedir regex = /home</programlisting> For a user
      <emphasis>john</emphasis> this results in an AFP home volume with a path
      of <filename>/home/john/afp-data</filename>.</para>

      <para>If <option>basedir regex</option> contains symlink, set the
      canonicalized absolute path. When <filename>/home</filename> links to
      <filename>/usr/home</filename>: <programlisting> [Homes]
      basedir regex = /usr/home</programlisting></para>
    </refsect2>
  </refsect1>

  <refsect1>
    <title>PARAMETERS</title>

    <para>Parameters define the specific attributes of sections.</para>

    <para>Some parameters are specific to the [Global] section (e.g.,
    <emphasis>log type</emphasis>). All others are permissible only in volume
    sections. The letter <emphasis>G</emphasis> in parentheses indicates that
    a parameter is specific to the [Global] section. The letter
    <emphasis>V</emphasis> indicates that a parameter can be specified in a
    volume specific section.</para>
  </refsect1>

  <refsect1>
    <title>VARIABLE SUBSTITUTIONS</title>

    <para>You can use variables in volume names. The use of variables in paths
     is limited to $u.</para>

    <orderedlist>
      <listitem>
        <para>if you specify an unknown variable, it will not get
        converted.</para>
      </listitem>

      <listitem>
        <para>if you specify a known variable, but that variable doesn't have
        a value, it will get ignored.</para>
      </listitem>
    </orderedlist>

    <para>The variables which can be used for substitutions are:</para>

    <variablelist>
      <varlistentry>
        <term>$b</term>

        <listitem>
          <para>basename</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>$c</term>

        <listitem>
          <para>client's ip address</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>$d</term>

        <listitem>
          <para>volume pathname on server</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>$f</term>

        <listitem>
          <para>full name (contents of the gecos field in the passwd
          file)</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>$g</term>

        <listitem>
          <para>group name</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>$h</term>

        <listitem>
          <para>hostname</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>$i</term>

        <listitem>
          <para>client's ip, without port</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>$s</term>

        <listitem>
          <para>server name (this can be the hostname)</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>$u</term>

        <listitem>
          <para>user name (if guest, it is the user that guest is running
          as)</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>$v</term>

        <listitem>
          <para>volume name</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>$$</term>

        <listitem>
          <para>prints dollar sign ($)</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>EXPLANATION OF GLOBAL PARAMETERS</title>

    <refsect2>
      <title>Authentication Options</title>

      <variablelist>
        <varlistentry>
          <term>ad domain = <parameter>DOMAIN</parameter>
          <type>(G)</type></term>

          <listitem>
            <para>Append @DOMAIN to username when authenticating. Useful in
            Active Directory environments that otherwise would require the
            user to enter the full user@domain string.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>admin auth user = <parameter>user</parameter>
          <type>(G)</type></term>

          <listitem>
            <para>Specifying e.g. "<option>admin auth user = root</option>"
            whenever a normal user login fails, afpd will try to authenticate
            as the specified <option>admin auth user</option>. If this
            succeeds, a normal session is created for the original connecting
            user. Said differently: if you know the password of <option>admin
            auth user</option>, you can authenticate as any other user.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>admin group = <replaceable>group</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>Allows users of a certain group to be seen as the superuser
            when they log in. This option is disabled by default.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>force user = <replaceable>USER</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>This specifies a UNIX user name that will be
            assigned as the default user for all users connecting to
            this server. This is useful for sharing files. You should
            also use it carefully as using it incorrectly can cause
            security problems.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>force group = <replaceable>GROUP</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>This specifies a UNIX group name that will be
            assigned as the default primary group for all users
            connecting to this server.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>k5 keytab = <replaceable>path</replaceable>
          <type>(G)</type></term>

          <term>k5 service = <replaceable>service</replaceable>
          <type>(G)</type></term>

          <term>k5 realm = <replaceable>realm</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>These are required if the server supports the Kerberos 5
            authentication UAM.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>nt domain = <parameter>DOMAIN</parameter>
          <type>(G)</type></term>

          <term>nt separator = <parameter>SEPARATOR</parameter>
          <type>(G)</type></term>

          <listitem>
            <para>Use for e.g. 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.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>save password = <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>yes</emphasis>) <type>(G)</type></term>

          <listitem>
            <para>Enables or disables the ability of clients to save passwords
            locally.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>set password = <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>no</emphasis>) <type>(G)</type></term>

          <listitem>
            <para>Enables or disables the ability of clients to change their
            passwords via chooser or the "connect to server" dialog.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>uam list = <replaceable>uam list</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>Space or comma separated list of UAMs. (The default is
            "uams_dhx.so uams_dhx2.so").</para>

            <para>The most commonly used UAMs are:</para>

            <variablelist>
              <varlistentry>
                <term>uams_guest.so</term>

                <listitem>
                  <para>allows guest logins</para>
                </listitem>
              </varlistentry>

              <varlistentry>
                <term>uams_clrtxt.so</term>

                <listitem>
                  <para>(uams_pam.so or uams_passwd.so) Allow logins with
                  passwords transmitted in the clear. (legacy)</para>
                </listitem>
              </varlistentry>

              <varlistentry>
                <term>uams_randnum.so</term>

                <listitem>
                  <para>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 "<option>passwd file</option>"). See
                  <citerefentry>
                      <refentrytitle>afppasswd</refentrytitle>

                      <manvolnum>1</manvolnum>
                    </citerefentry> for details. (legacy)</para>
                </listitem>
              </varlistentry>

              <varlistentry>
                <term>uams_dhx.so</term>

                <listitem>
                  <para>(uams_dhx_pam.so or uams_dhx_passwd.so) Allow
                  Diffie-Hellman eXchange (DHX) for authentication.</para>
                </listitem>
              </varlistentry>

              <varlistentry>
                <term>uams_dhx2.so</term>

                <listitem>
                  <para>(uams_dhx2_pam.so or uams_dhx2_passwd.so) Allow
                  Diffie-Hellman eXchange 2 (DHX2) for authentication.</para>
                </listitem>
              </varlistentry>

              <varlistentry>
                <term>uam_gss.so</term>

                <listitem>
                  <para>Allow Kerberos V for authentication (optional)</para>
                </listitem>
              </varlistentry>
            </variablelist>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>uam path = <replaceable>path</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>Sets the default path for UAMs for this server (default is
            @libdir@/netatalk).</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsect2>

    <refsect2>
      <title>Charset Options</title>

      <para>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.</para>

      <para>To be able to serve AFP3 and older clients at the same time,
      <command>afpd</command> 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's no way, <command>afpd</command> can detect the codepage a pre
      AFP3 client uses, you have to specify it using the <option>mac
      charset</option> option. The default is MacRoman, which should be fine
      for most western users.</para>

      <para>As <command>afpd</command> needs to interact with UNIX operating
      system as well, it needs to be able to convert from UTF8-MAC / Mac
      charset to the UNIX charset. By default <command>afpd</command> uses
      <emphasis>UTF8</emphasis>. You can set the UNIX charset using the
      <option>unix charset</option> option. If you're using extended
      characters in the configuration files for <command>afpd</command>, make
      sure your terminal matches the <option>unix charset</option>.</para>

      <variablelist>
        <varlistentry>
          <term>mac charset = <parameter>CHARSET</parameter>
          <type>(G)/(V)</type></term>

          <listitem>
            <para>Specifies the Mac clients charset, e.g.
            <emphasis>MAC_ROMAN</emphasis>. 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 <option>mac charset</option>.
            Defaults to <emphasis>MAC_ROMAN</emphasis>.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>unix charset = <parameter>CHARSET</parameter>
          <type>(G)</type></term>

          <listitem>
            <para>Specifies the servers unix charset, e.g.
            <emphasis>ISO-8859-15</emphasis> or <emphasis>EUC-JP</emphasis>.
            This is used to convert strings to/from the systems locale, e.g.
            for authentication, server messages and volume names. If
            <emphasis>LOCALE</emphasis> is set, the systems locale is used.
            Defaults to <emphasis>UTF8</emphasis>.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>vol charset = <parameter>CHARSET</parameter>
          <type>(G)/(V)</type></term>

          <listitem>
            <para>Specifies the encoding of the volumes filesystem. By
            default, it is the same as <option>unix charset</option>.</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsect2>

    <refsect2>
      <title>Password Options</title>

      <variablelist>
        <varlistentry>
          <term>passwd file = <parameter>path</parameter>
          <type>(G)</type></term>

          <listitem>
            <para>Sets the path to the Randnum UAM passwd file for this server
            (default is @pkgconfdir@/afppasswd).</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>passwd minlen = <parameter>number</parameter>
          <type>(G)</type></term>

          <listitem>
            <para>Sets the minimum password length, if supported by the
            UAM</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsect2>

    <refsect2>
      <title>Network Options</title>

      <variablelist>
        <varlistentry>
          <term>advertise ssh = <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>no</emphasis>) <type>(G)</type></term>

          <listitem>
            <para>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's answers to client's FPGetSrvrInfo requests
            contain an additional entry. It depends on both client's settings
            and a correctly configured and running <citerefentry>
                <refentrytitle>sshd</refentrytitle>

                <manvolnum>8</manvolnum>
              </citerefentry> on the server to let things work.</para>

            <note>
              <para>Setting this option is not recommended since globally
              encrypting AFP connections via SSH will increase the server's
              load significantly. On the other hand, Apple's client side
              implementation of this feature in MacOS X versions prior to
              10.3.4 contained a security flaw.</para>
            </note>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>afp interfaces = <replaceable>name [name ...]</replaceable>
            <type>(G)</type></term>
          <listitem>
            <para>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.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>afp listen = <replaceable>ip address[:port] [ip address[:port]
          ...]</replaceable> <type>(G)</type></term>

          <listitem>
            <para>Specifies the IP address that the server should advertise
            <emphasis role="bold">and</emphasis> 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.</para>
            <para>IPv6 address + port combination must use URL the format
            using square brackets [IPv6]:port</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>afp port = <replaceable>port number</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>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 <option>afp listen</option> option.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>cnid listen = <replaceable>ip address[:port] [ip
          address[:port] ...]</replaceable> <type>(G)</type></term>

          <listitem>
            <para>Specifies the IP address that the CNID server should listen
            on. The default is <emphasis
            role="bold">localhost:4700</emphasis>.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>disconnect time = <replaceable>number</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>Keep disconnected AFP sessions for
            <parameter>number</parameter> hours before dropping them. Default
            is 24 hours.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>dsireadbuf = <replaceable>number</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>Scale factor that determines the size of the DSI/TCP
            readahead buffer, default is 12. This is multiplies with the DSI
            server quantum (default 1MiB) to give the size of the buffer.
            Increasing this value might increase throughput in fast local
            networks for volume to volume copies. <emphasis>Note</emphasis>:
            This buffer is allocated per afpd child process, so specifying
            large values will eat up large amount of memory (buffer size *
            number of clients).</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>fqdn = <replaceable>name[:port]</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>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 &lt;= 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.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>hostname = <replaceable>name</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>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 <option>afp
            listen</option>.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>max connections = <replaceable>number</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>Sets the maximum number of clients that can simultaneously
            connect to the server (default is 200).</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>server quantum = <replaceable>number</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>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're
            absolutely sure, what you're doing</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>sleep time = <replaceable>number</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>Keep sleeping AFP sessions for <parameter>number</parameter>
            hours before disconnecting clients in sleep mode. Default is 10
            hours.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>tcprcvbuf = <replaceable>number</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>Try to set TCP receive buffer using setsockopt(). Often OSes
            impose restrictions on the applications ability to set this
            value.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>tcpsndbuf = <replaceable>number</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>Try to set TCP send buffer using setsockopt(). Often OSes
            impose restrictions on the applications ability to set this
            value.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>recvfile = <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>no</emphasis>) <type>(G)</type></term>

          <listitem>
            <para>Whether to use splice() on Linux for receiving data.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>splice size = <replaceable>number</replaceable> (default:
          <emphasis>64k</emphasis>) <type>(G)</type></term>

          <listitem>
            <para>Maximum number of bytes spliced.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>use sendfile = <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>yes</emphasis>) <type>(G)</type></term>

          <listitem>
            <para>Whether to use sendfile<indexterm>
                <primary>sendfile</primary>
              </indexterm> syscall for sending file data to clients.</para>
          </listitem>
        </varlistentry>


        <varlistentry>
          <term>zeroconf = <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>yes</emphasis>) <type>(G)</type></term>

          <listitem>
            <para>Whether to use automatic Zeroconf<indexterm>
                <primary>Zeroconf</primary>

                <secondary>Bonjour</secondary>
              </indexterm> service registration if Avahi or mDNSResponder were
            compiled in.</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsect2>

    <refsect2>
      <title>Miscellaneous Options</title>

      <variablelist>
        <varlistentry>
          <term>afp read locks = <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>no</emphasis>) <type>(G)</type></term>

          <listitem>
            <para>Whether to apply locks to the byte region read in FPRead
            calls. The AFP spec mandates this, but it's not really in line
            with UNIX semantics and is a performance hug.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>afpstats = <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>no</emphasis>) <type>(G)</type></term>

          <listitem>
            <para>Whether to provide AFP runtime statistics (connected
            users, open volumes) via dbus.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>basedir regex = <replaceable>regex</replaceable>
          <type>(H)</type></term>

          <listitem>
            <para>Regular expression which matches the parent directory of the
            user homes. If <option>basedir regex</option> contains symlink,
            you must set the canonicalized absolute path. In the simple case
            this is just a path i.e. <option>basedir regex =
            /home</option></para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>chmod request = <replaceable>preserve (default) | ignore | simple</replaceable>
          <type>(G)/(V)</type></term>

          <listitem>
            <para>Advanced permission control that deals with ACLs.</para>

            <itemizedlist>
              <listitem><para> <option>ignore</option> - UNIX chmod()
              requests are completely ignored, use this option to
              allow the parent directory's ACL inheritance full
              control over new items.  </para></listitem>
              <listitem><para>
                <option>preserve</option> - preserve ZFS ACEs for
                named users and groups or POSIX ACL group mask
		      </para></listitem>
              <listitem><para>
                <option>simple</option> - just to a chmod() as
                requested without any extra steps
		      </para></listitem>
		    </itemizedlist>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>close vol = <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>no</emphasis>) <type>(G)</type></term>

          <listitem>
            <para>Whether to close volumes possibly opened by clients when
            they're removed from the configuration and the configuration is
            reloaded.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>cnid mysql host = <replaceable>MySQL server address</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>name or address of a MySQL server for use with the mysql CNID
            backend.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>cnid mysql user = <replaceable>MySQL user</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>MySQL user for authentication with the server.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>cnid mysql pw = <replaceable>password</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>Password for MySQL server.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>cnid mysql db = <replaceable>database name</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>Name of an existing database for which the specified user
            has full privileges.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>cnid server = <replaceable>ipaddress[:port]</replaceable>
          <type>(G)/(V)</type></term>

          <listitem>
            <para>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.-</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>dbus daemon = <parameter>path</parameter>
          <type>(G)</type></term>

          <listitem>
            <para>Sets the path to dbus-daemon binary used by Spotlight feature.
            The default value <filename>[@DBUS_DAEMON_PATH@]</filename>
            is determined when building netatalk.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>dircachesize = <replaceable>number</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>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.</para>

            <para>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.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>extmap file = <parameter>path</parameter>
          <type>(G)</type></term>

          <listitem>
            <para>Sets the path to the file which defines file extension
            type/creator mappings. (default is @pkgconfdir@/extmap.conf).</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>force xattr with sticky bit =
          <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>no</emphasis>) <type>(G/V)</type></term>

          <listitem>
            <para>Writing metadata xattr on directories with the
            sticky bit set may fail even though we may have write
            access to a directory, because if the sticky bit is set
            only the owner is allowed to write xattrs.</para>

            <para>By enabling this option Netatalk will write the
            metadata xattr as root.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>guest account = <replaceable>name</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>Specifies the user that guests should use (default is
            "nobody"). The name should be quoted.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>home name = <replaceable>name</replaceable>
          <type>(H)</type></term>

          <listitem>
            <para>AFP user home volume name. The default is <emphasis>$u's
            home</emphasis>.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>ignored attributes = <replaceable>all | nowrite | nodelete | norename</replaceable>
          <type>(G)/(V)</type></term>

          <listitem>
            <para>Speficy a set of file and directory attributes that shall
            be ignored by the server, <option>all</option> includes all
            the other options.</para>
            <para>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 <emphasis>ignored attributes = all</emphasis>.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>login message = <replaceable>message</replaceable>
          <type>(G)/(V)</type></term>

          <listitem>
            <para>Sets a message to be displayed when clients logon to the
            server. The message should be in <option>unix charset</option> and
            should be quoted. Extended characters are allowed.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>mimic model = <replaceable>model</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>Specifies the icon model that appears on clients. Defaults
            to off. Note that netatalk must support Zeroconf.
            Examples: RackMac (same as Xserve), PowerBook, PowerMac,
            Macmini, iMac, MacBook, MacBookPro, MacBookAir, MacPro,
            AppleTV1,1, AirPort.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>signature = &lt;text&gt; <type>(G)</type></term>

          <listitem>
            <para>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
            <filename>@localstatedir@/netatalk/afp_signature.conf</filename>
            automatically (based on random number). See also
            asip-status.pl(1).</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>solaris share reservations =
          <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>yes</emphasis>) <type>(G)</type></term>

          <listitem>
            <para>Use share reservations on Solaris. Solaris CIFS server uses
            this too, so this makes a lock coherent multi protocol
            server.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>sparql results limit =
          <replaceable>NUMBER</replaceable> (default:
          <emphasis>UNLIMITED</emphasis>) <type>(G)</type></term>

          <listitem>
            <para>Impose a limit on the number of results queried from Tracker
	    via SPARQL queries.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>spotlight =
          <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>no</emphasis>) <type>(G)/(V)</type></term>

          <listitem>
            <para>Whether to enable Spotlight searches. Note: once the global
            option is enabled, any volume that is not enabled won't be
            searchable at all. See also <emphasis>dbus daemon</emphasis>
            option.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>spotlight attributes =
          <replaceable>COMMA SEPARATED STRING</replaceable> (default:
          <emphasis>EMPTY</emphasis>) <type>(G)</type></term>

          <listitem>
            <para>A list of attributes that are allowed to be used in
            Spotlight searches. By default all attributes can be
            searched, passing a string limits attributes to elements
            of the string. Example:
	    <programlisting>spotlight attributes = *,kMDItemTextContent</programlisting></para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>spotlight expr =
          <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>yes</emphasis>) <type>(G)</type></term>

          <listitem>
            <para>Whether to allow the use of logic expression in
            searches.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>start dbus =
          <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>yes</emphasis>) <type>(G)</type></term>

          <listitem>
            <para>Whether to start a dbus instance for use with Tracker.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>start tracker =
          <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>yes</emphasis>) <type>(G)</type></term>

          <listitem>
            <para>Whether to start Tracker with
            "<command>tracker daemon -s</command>".
            In case of old Tracker,
            "<command>tracker-control -s</command>"
            is used instead.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>veto message = <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>no</emphasis>) <type>(G)</type></term>

          <listitem>
            <para>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.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>vol dbpath = <replaceable>path</replaceable>
          <type>(G)/(V)</type></term>

          <listitem>
            <para>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
            <filename>@localstatedir@/netatalk/CNID/$v/</filename>.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>vol dbnest = <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>no</emphasis>) <type>(G)</type></term>

          <listitem>
            <para>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.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>volnamelen = <replaceable>number</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>Max length of UTF8-MAC volume name for Mac OS X. Note that
            Hangul is especially sensitive to this.</para>

            <para><programlisting>73: limit of Mac OS X 10.1
80: limit of Mac OS X 10.4/10.5 (default)
255: limit of recent Mac OS X</programlisting>
            Mac OS 9 and earlier are not influenced by
            this, because Maccharset volume name is always limited to 27
            bytes.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>vol preset = <replaceable>name</replaceable>
          <type>(G)/(V)</type></term>

          <listitem>
            <para>Use section <option>name</option> as option preset for all
            volumes (when set in the [Global] section) or for one volume (when
            set in that volume's section).</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>zeroconf name = <replaceable>name</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>Specifies a human-readable name that uniquely describes
            registered services. The zeroconf name is advertised as UTF-8,
            up to 63 octets (bytes) in length. Defaults to hostname. Note
            that netatalk must support Zeroconf.</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsect2>

    <refsect2>
      <title>Logging Options</title>

      <variablelist>
        <varlistentry>
          <term>log file = <replaceable>logfile</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>If not specified Netatalk logs to syslogs daemon facility.
            Otherwise it logs to <option>logfile</option>.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>log level = <replaceable>type:level [type:level
          ...]</replaceable> <type>(G)</type></term>

          <term>log level = <replaceable>type:level,[type:level,
          ...]</replaceable> <type>(G)</type></term>

          <listitem>
            <para>Specify that any message of a loglevel up to the given
            <option>log level</option> should be logged.</para>

            <para>By default afpd logs to syslog with a default logging setup
            equivalent to <option>default:note</option></para>

            <para>logtypes: default, afpdaemon, logger, uamsdaemon</para>

            <para>loglevels: severe, error, warn, note, info, debug, debug6,
            debug7, debug8, debug9, maxdebug</para>

            <note>
              <para>Both logtype and loglevels are case insensitive.</para>
            </note>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsect2>

    <refsect2 id="fceconf">
      <title>Filesystem Change Events (FCE<indexterm>
          <primary>FCE</primary>
        </indexterm>)</title>

      <para>Netatalk includes a nifty filesystem change event mechanism where
      afpd processes notify interested listeners about certain filesystem
      event by UDP network datagrams.</para>

      <para>The following FCE events are defined:</para>

      <itemizedlist>
        <listitem><para>file modification (<option>fmod</option>)</para></listitem>
        <listitem><para>file deletion (<option>fdel</option>)</para></listitem>
        <listitem><para>directory deletion (<option>ddel</option>)</para></listitem>
        <listitem><para>file creation (<option>fcre</option>)</para></listitem>
        <listitem><para>directory creation (<option>dcre</option>)</para></listitem>
        <listitem><para>file move or rename (<option>fmov</option>)</para></listitem>
        <listitem><para>directory move or rename (<option>dmov</option>)</para></listitem>
        <listitem><para>login (<option>login</option>)</para></listitem>
        <listitem><para>logout (<option>logout</option>)</para></listitem>
      </itemizedlist>

      <variablelist>
        <varlistentry>
          <term>fce listener = <replaceable>host[:port]</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>Enables sending FCE events to the specified
            <parameter>host</parameter>, default <parameter>port</parameter>
            is 12250 if not specified. Specifying multiple listeners is done
            by having this option once for each of them.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>fce version = <replaceable>1|2</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>FCE protocol version, default is 1. You need version
            2 for the fmov, dmov, login or logout events.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>fce events =
          <replaceable>fmod,fdel,ddel,fcre,dcre,fmov,dmov,login,logout</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>Specifies which FCE events are active, default is
            <parameter>fmod,fdel,ddel,fcre,dcre</parameter>.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>fce coalesce = <replaceable>all|delete|create</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>Coalesce FCE events.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>fce holdfmod = <replaceable>seconds</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>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.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>fce ignore names = <replaceable>NAME[/NAME2/...]</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>Slash delimited list of filenames for which FCE
            events shall not be generated. Default: .DS_Store.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>fce notify script = <replaceable>PATH</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>Script which will be executed for every FCE event,
            see contrib/shell_utils/fce_ev_script.sh from the Netatalk
            sources for an example script.</para>
          </listitem>
        </varlistentry>

      </variablelist>
    </refsect2>

    <refsect2>
      <title>Debug Parameters</title>

      <para>These options are useful for debugging only.</para>

      <variablelist>
        <varlistentry>
          <term>tickleval = <replaceable>number</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>Sets the tickle timeout interval (in seconds). Defaults to
            30.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>timeout = <replaceable>number</replaceable>
          <type>(G)</type></term>

          <listitem>
            <para>Specify the number of tickles to send before timing out a
            connection. The default is 4, therefore a connection will timeout
            after 2 minutes.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>client polling = <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>no</emphasis>) <type>(G)</type></term>

          <listitem>
            <para>With this option enabled, afpd won't 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. <emphasis>Note</emphasis>: Depending on the number of
            simultaneously connected clients and the network's speed, this can
            lead to a significant higher load on your network!</para>

            <para>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.</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsect2>

    <refsect2 id="acl_options">
      <title>Options for ACL handling</title>

      <para>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
      <option>map acls</option>:</para>

      <variablelist id="map_acls">
        <varlistentry>
          <term>map acls = <parameter>none|rights|mode</parameter>
          <type>(G)</type></term>

          <listitem>
            <para><variablelist>
                <varlistentry>
                  <term>none</term>

                  <listitem>
                    <para>no mapping of ACLs </para>
                  </listitem>
                </varlistentry>

                <varlistentry>
                  <term>rights</term>

                  <listitem>
                    <para>effective permissions are mapped to UARights
                    structure. This is the default.</para>
                  </listitem>
                </varlistentry>

                <varlistentry>
                  <term>mode</term>

                  <listitem>
                    <para>ACLs are additionally mapped to the UNIX mode of the
                    filesystem object.</para>
                  </listitem>
                </varlistentry>
              </variablelist></para>
          </listitem>
        </varlistentry>
      </variablelist>

      <para>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, e.g. LDAP, Open Directory, Active Directory). The
      reason is, in OS X ACLs are bound to UUIDs, not just uid's or gid's.
      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.</para>

      <para>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).</para>

      <para>The following LDAP options must be configured for Netatalk:</para>

      <variablelist>
        <varlistentry>
          <term>ldap auth method = <parameter>none|simple|sasl</parameter>
          <type>(G)</type></term>

          <listitem>
            <para>Authentication method: <option>none | simple |
            sasl</option></para>

            <para><variablelist>
                <varlistentry>
                  <term>none</term>

                  <listitem>
                    <para>anonymous LDAP bind</para>
                  </listitem>
                </varlistentry>

                <varlistentry>
                  <term>simple</term>

                  <listitem>
                    <para>simple LDAP bind</para>
                  </listitem>
                </varlistentry>

                <varlistentry>
                  <term>sasl</term>

                  <listitem>
                    <para>SASL. Not yet supported !</para>
                  </listitem>
                </varlistentry>
              </variablelist></para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>ldap auth dn = <parameter>dn</parameter>
          <type>(G)</type></term>

          <listitem>
            <para>Distinguished Name of the user for simple bind.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>ldap auth pw = <parameter>password</parameter>
          <type>(G)</type></term>

          <listitem>
            <para>Password for simple bind.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>ldap server = <parameter>host</parameter>
          <type>(G)</type></term>

          <listitem>
            <para>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.</para>

            <para>You can use <citerefentry>
                <refentrytitle>afpldaptest</refentrytitle>

                <manvolnum>1</manvolnum>
              </citerefentry> to syntactically check your config.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>ldap userbase = <parameter>base dn</parameter>
          <type>(G)</type></term>

          <listitem>
            <para>DN of the user container in LDAP.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>ldap userscope = <parameter>scope</parameter>
          <type>(G)</type></term>

          <listitem>
            <para>Search scope for user search: <option>base | one |
            sub</option></para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>ldap groupbase = <parameter>base dn</parameter>
          <type>(G)</type></term>

          <listitem>
            <para>DN of the group container in LDAP.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>ldap groupscope = <parameter>scope</parameter>
          <type>(G)</type></term>

          <listitem>
            <para>Search scope for group search: <option>base | one |
            sub</option></para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>ldap uuid attr = <parameter>dn</parameter>
          <type>(G)</type></term>

          <listitem>
            <para>Name of the LDAP attribute with the UUIDs.</para>

            <para>Note: this is used both for users and groups.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>ldap name attr = <parameter>dn</parameter>
          <type>(G)</type></term>

          <listitem>
            <para>Name of the LDAP attribute with the users short name.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>ldap group attr = <parameter>dn</parameter>
          <type>(G)</type></term>

          <listitem>
            <para>Name of the LDAP attribute with the groups short
            name.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>ldap uuid string = <parameter>STRING</parameter>
          <type>(G)</type></term>

          <listitem>
            <para>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.</para>

            <para>Default: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>ldap uuid encoding = <parameter>string | ms-guid (default:
          string)</parameter> <type>(G)</type></term>

          <listitem>
            <para>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.</para>
            <para>See also the options <option>ldap user filter</option> and
            <option>ldap group filter</option>.</para>
            <para><variablelist>
                <varlistentry>
                  <term>string</term>

                  <listitem>
                    <para>UUID is a string, use with e.g. OpenDirectory.</para>
                  </listitem>
                </varlistentry>

                <varlistentry>
                  <term>ms-guid</term>

                  <listitem>
                    <para>Binary objectGUID from Active Directory</para>
                  </listitem>
                </varlistentry>
              </variablelist></para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>ldap user filter = <parameter>STRING (default: unused)</parameter>
          <type>(G)</type></term>

          <listitem>
            <para>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.</para>
            <para>Recommended setting for Active Directory: <parameter>objectClass=user</parameter>.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>ldap group filter = <parameter>STRING (default: unused)</parameter>
          <type>(G)</type></term>

          <listitem>
            <para>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.</para>
            <para>Recommended setting for Active Directory: <parameter>objectClass=group</parameter>.</para>
          </listitem>
        </varlistentry>

      </variablelist>
    </refsect2>
  </refsect1>

  <refsect1>
    <title>EXPLANATION OF VOLUME PARAMETERS</title>

    <refsect2>
      <title>Parameters</title>

      <para>The section name defines the volume name.
      No two volumes may have the same
      name. The volume name cannot contain the <keycode>':'</keycode>
      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.</para>

      <variablelist>
        <varlistentry>
          <term>path = <replaceable>PATH</replaceable> <type>(V)</type></term>

          <listitem>
            <para>The path name must be a fully qualified path name.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>appledouble = <replaceable>ea|v2</replaceable>
          <type>(V)</type></term>

          <listitem>
            <para>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 <emphasis
            role="bold">ea</emphasis>.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>vol size limit = <replaceable>size in MiB</replaceable>
          <type>(V)</type></term>

          <listitem>
            <para>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. <emphasis role="bold">IMPORTANT:
            </emphasis> 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.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>valid users = <replaceable>user @group</replaceable>
          <type>(V)</type></term>

          <listitem>
            <para>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:
            <programlisting>valid users = user "user 2" @group “@group 2"</programlisting></para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>invalid users = <replaceable>users/groups</replaceable>
          <type>(V)</type></term>

          <listitem>
            <para>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.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>hosts allow = <replaceable>IP host address/IP netmask bits [
          ... ]</replaceable> <type>(V)</type></term>

          <listitem>
            <para>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.</para>

            <para>Example: hosts allow = 10.1.0.0/16 10.2.1.100
            2001:0db8:1234::/48</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>hosts deny = <replaceable>IP host address/IP netmask bits [
          ... ]</replaceable> <type>(V)</type></term>

          <listitem>
            <para>Listed hosts and nets are rejected, all others are
            allowed.</para>

            <para>Example: hosts deny = 192.168.100/24 10.1.1.1
            2001:db8::1428:57ab</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>cnid scheme = <replaceable>backend</replaceable>
          <type>(V)</type></term>

          <listitem>
            <para>set the CNID backend to be used for the volume, default is
            [@DEFAULT_CNID_SCHEME@] available schemes:
            [@compiled_backends@]</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>ea = <replaceable>none|auto|sys|ad|samba</replaceable>
          <type>(V)</type></term>

          <listitem>
            <para>Specify how Extended Attributes<indexterm>
                <primary>Extended Attributes</primary>
              </indexterm> are stored. <option>auto</option> is the
            default.</para>

            <variablelist>
              <varlistentry>
                <term>auto</term>

                <listitem>
                  <para>Try <option>sys</option> (by setting an EA on the
                  shared directory itself), fallback to <option>ad</option>.
                  Requires writable volume for performing test. "<option>read
                  only = yes</option>" overwrites <option>auto</option> with
                  <option>none</option>. Use explicit "<option>ea =
                  sys|ad</option>" for read-only volumes where
                  appropriate.</para>
                </listitem>
              </varlistentry>

              <varlistentry>
                <term>sys</term>

                <listitem>
                  <para>Use filesystem Extended Attributes.</para>
                </listitem>
              </varlistentry>

	      <varlistentry>
                <term>samba</term>

                <listitem>
                  <para>Use filesystem Extended Attributes, but append
                  a 0 byte to each xattr in order to be compatible
                  with Samba's vfs_streams_xattr.</para>
                </listitem>
              </varlistentry>

              <varlistentry>
                <term>ad</term>

                <listitem>
                  <para>Use files in <emphasis>.AppleDouble</emphasis>
                  directories.</para>
                </listitem>
              </varlistentry>

              <varlistentry>
                <term>none</term>

                <listitem>
                  <para>No Extended Attributes support.</para>
                </listitem>
              </varlistentry>
            </variablelist>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>mac charset = <replaceable>CHARSET</replaceable>
          <type>(V)</type></term>

          <listitem>
            <para>specifies the Mac client charset for this Volume, e.g.
            <emphasis>MAC_ROMAN</emphasis>, <emphasis>MAC_CYRILLIC</emphasis>.
            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.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>casefold = <option>option</option> <type>(V)</type></term>

          <listitem>
            <para>The casefold option handles, if the case of filenames should
            be changed. The available options are:</para>

            <para><option>tolower</option> - Lowercases names in both
            directions.</para>

            <para><option>toupper</option> - Uppercases names in both
            directions.</para>

            <para><option>xlatelower</option> - Client sees lowercase, server
            sees uppercase.</para>

            <para><option>xlateupper</option> - Client sees uppercase, server
            sees lowercase.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>password = <replaceable>password</replaceable>
          <type>(V)</type></term>

          <listitem>
            <para>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).</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>file perm = <replaceable>mode</replaceable>
          <type>(V)</type></term>

          <term>directory perm = <replaceable>mode</replaceable>
          <type>(V)</type></term>

          <listitem>
            <para>Add(or) with the client requested permissions: <option>file
            perm</option> is for files only, <option>directory perm</option>
            is for directories only. Don't use with "<option>unix priv =
            no</option>".</para>

            <example>
              <title>Volume for a collaborative workgroup</title>

              <para><programlisting>file perm = 0660 directory perm =
              0770</programlisting></para>
            </example>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>umask = <replaceable>mode</replaceable>
          <type>(V)</type></term>

          <listitem>
            <para>set perm mask. Don't use with "<option>unix priv =
            no</option>".</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>preexec = <replaceable>command</replaceable>
          <type>(V)</type></term>

          <listitem>
            <para>command to be run when the volume is mounted</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>postexec = <replaceable>command</replaceable>
          <type>(V)</type></term>

          <listitem>
            <para>command to be run when the volume is closed</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>root preexec = <replaceable>command</replaceable>
          <type>(V)</type></term>

          <listitem>
            <para>command to be run as root when the volume is mounted</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>root postexec = <replaceable>command</replaceable>
          <type>(V)</type></term>

          <listitem>
            <para>command to be run as root when the volume is closed</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>rolist = <option>users/groups</option> <type>(V)</type></term>

          <listitem>
            <para>Allows certain users and groups to have read-only access to
            a share. This follows the allow option format.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>rwlist = <replaceable>users/groups</replaceable>
          <type>(V)</type></term>

          <listitem>
            <para>Allows certain users and groups to have read/write access to
            a share. This follows the allow option format.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>veto files = <replaceable>vetoed names</replaceable>
          <type>(V)</type></term>

          <listitem>
            <para>hide files and directories,where the path matches one of the
            '/' delimited vetoed names. The veto string must always be
            terminated with a '/', e.g. "veto files = veto1/", "veto files =
            veto1/veto2/".</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsect2>

    <refsect2>
      <title>Volume options</title>

      <para>Boolean volume options.</para>

      <variablelist>
        <varlistentry>
          <term>acls = <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>yes</emphasis>) <type>(V)</type></term>

          <listitem>
            <para>Whether to flag volumes as supporting ACLs. If ACL support
            is compiled in, this is yes by default.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>case sensitive = <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>yes</emphasis>) <type>(V)</type></term>

          <listitem>
            <para>Whether to flag volumes as supporting case-sensitive
            filenames. If the filesystem is case-insensitive, set to no.
            However, it is not fully verified.</para>
            <note>
              <para>In spite of being case sensitive as a matter of fact,
              netatalk 3.1.3 and earlier did not notify kCaseSensitive flag
              to the client. Starting with 3.1.4, it is notified correctly by
              default.</para>
            </note>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>cnid dev = <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>yes</emphasis>) <type>(V)</type></term>

          <listitem>
            <para>Whether to use the device number in the CNID backends. Helps
            when the device number is not constant across a reboot, e.g.
            cluster, ...</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>convert appledouble = <replaceable>BOOLEAN</replaceable>
          (default: <emphasis>yes</emphasis>) <type>(V)</type></term>

          <listitem>
            <para>Whether automatic conversion from <option>appledouble =
            v2</option> to <option>appledouble = ea</option> is performed when
            accessing filesystems from clients. This is generally useful, but
            costs some performance. It's recommendable to run
            <command>dbd</command> on volumes and do the conversion with that.
            Then this option can be set to no.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>delete veto files = <replaceable>BOOLEAN</replaceable>
          (default: <emphasis>no</emphasis>) <type>(V)</type></term>

          <listitem>
            <para>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.</para>
            <para>If this option is set to yes, then Netatalk will attempt to
            recursively delete any files and directories within the vetoed
            directory.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>follow symlinks = <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>no</emphasis>) <type>(V)</type></term>

          <listitem>
            <para>The default setting is false thus symlinks are not followed
            on the server. This is the same behaviour as OS X's 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't do any checks for "wide symlinks".</para>
            <note>
              <para>This option will subtly break when the symlinks point
              across filesystem boundaries.</para>
            </note>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>invisible dots = <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>no</emphasis>) <type>(V)</type></term>

          <listitem>
            <para>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's
              completely useless on Mac OS X, as both in Finder and in Terminal
              files starting with a dot are hidden anyway.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>network ids = <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>yes</emphasis>) <type>(V)</type></term>

          <listitem>
            <para>Whether the server support network ids. Setting this to
            <emphasis>no</emphasis> will result in the client not using ACL
            AFP functions.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>preexec close = <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>no</emphasis>) <type>(V)</type></term>

          <listitem>
            <para>A non-zero return code from preexec close the volume being
            immediately, preventing clients to mount/see the volume in
            question.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>read only = <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>no</emphasis>) <type>(V)</type></term>

          <listitem>
            <para>Specifies the share as being read only for all users.
            Overwrites <option>ea = auto</option> with <option>ea =
            none</option></para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>root preexec close= <replaceable>BOOLEAN</replaceable>
          (default: <emphasis>no</emphasis>) <type>(V)</type></term>

          <listitem>
            <para>A non-zero return code from root_preexec closes the volume
            immediately, preventing clients to mount/see the volume in
            question.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>search db = <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>no</emphasis>) <type>(V)</type></term>

          <listitem>
            <para>Use fast CNID database namesearch instead of slow recursive
            filesystem search. Relies on a consistent CNID database, i.e. Samba
            or local filesystem access lead to inaccurate or wrong results.
            Works only for "dbd" CNID db volumes.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>stat vol = <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>yes</emphasis>) <type>(V)</type></term>

          <listitem>
            <para>Whether to stat volume path when enumerating volumes list,
            useful for automounting or volumes created by a preexec
            script.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>time machine = <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>no</emphasis>) <type>(V)</type></term>

          <listitem>
            <para>Whether to enable Time Machine support for this
            volume.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>unix priv = <replaceable>BOOLEAN</replaceable> (default:
          <emphasis>yes</emphasis>) <type>(V)</type></term>

          <listitem>
            <para>Whether to use AFP3 UNIX privileges. This should be set for
            OS X clients. See also: <option>file perm</option>,
            <option>directory perm</option> and <option>umask</option>.</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsect2>
  </refsect1>

  <refsect1>
    <title>CNID backends</title>

    <para>The AFP protocol mostly refers to files and directories by ID and
    not by name. Netatalk needs a way to store these ID's in a persistent way,
    to achieve this several different CNID backends are available. The CNID
    Databases are by default located in the
    <filename>@localstatedir@/netatalk/CNID/(volumename)/.AppleDB/</filename>
    directory.</para>

    <variablelist>
      <varlistentry>
        <term>cdb</term>

        <listitem>
          <para>"Concurrent database", backend is based on Oracle Berkley DB.
          With this backend several <command>afpd</command> daemons access the
          CNID database directly. Berkeley DB locking is used to synchronize
          access, if more than one <command>afpd</command> process is active
          for a volume. The drawback is, that the crash of a single
          <command>afpd</command> process might corrupt the database.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>dbd</term>

        <listitem>
          <para>Access to the CNID database is restricted to the
          <command>cnid_metad</command> daemon process.
          <command>afpd</command> 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 <option>cdb</option></para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>last</term>

        <listitem>
          <para>This backend is an exception, in terms of ID persistency. ID's
          are only valid for the current session. This is basically what
          <command>afpd</command> 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 <emphasis>read only
          mode</emphasis> automatically.</para>

          <para><emphasis role="bold">Warning</emphasis>: It is
          <emphasis>NOT</emphasis> recommended to use this backend for volumes
          anymore, as <command>afpd</command> now relies heavily on a
          persistent ID database. Aliases will likely not work and filename
          mangling is not supported.</para>
        </listitem>
      </varlistentry>
    </variablelist>

    <para>Even though <command>./configure --help</command> might show that
    there are other CNID backends available, be warned those are likely broken
    or mainly used for testing. Don't use them unless you know what you're
    doing, they may be removed without further notice from future
    versions.</para>
  </refsect1>

  <refsect1>
    <title>Charset options</title>

    <para>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.</para>

    <para><command>afpd</command> needs a way to preserve extended
    Macintosh characters, or characters illegal in unix filenames,
    when saving files on a unix filesystem. This version now uses UTF-8
    as the default encoding for names. '<keycode>/</keycode>' will be
    converted to '<keycode>:</keycode>'.</para>

    <para>Earlier versions used the the so called CAP encoding. An extended
    character (&gt;0x7F) would be converted to a :xx sequence, e.g. the Apple
    Logo (MacRoman: 0xF0) was saved as <literal>:f0</literal>. Some special
    characters would be converted as to :xx notation as well.
    '<keycode>/</keycode>' would be encoded to <literal>:2f</literal>,
    a leading dot '<keycode>.</keycode>' might be encoded as
    <literal>:2e</literal>.</para>

    <para>The <option>vol charset</option> option will allow you to select
    another volume encoding. <command>afpd</command> will accept any
    <citerefentry>
        <refentrytitle><command>iconv</command></refentrytitle>

        <manvolnum>1</manvolnum>
      </citerefentry>
      provided charset. It is highly recommended to stick to the default
    UTF-8.</para>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>

    <para><citerefentry>
        <refentrytitle>afpd</refentrytitle>

        <manvolnum>8</manvolnum>
      </citerefentry>, <citerefentry>
        <refentrytitle>afppasswd</refentrytitle>

        <manvolnum>5</manvolnum>
      </citerefentry>, <citerefentry>
        <refentrytitle>afp_signature.conf</refentrytitle>

        <manvolnum>5</manvolnum>
      </citerefentry>, <citerefentry>
        <refentrytitle>extmap.conf</refentrytitle>

        <manvolnum>5</manvolnum>
      </citerefentry>, <citerefentry>
        <refentrytitle>cnid_metad</refentrytitle>

        <manvolnum>8</manvolnum>
      </citerefentry></para>
  </refsect1>
</refentry>