doc/manpages/man5/afp.conf.5.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="afp.conf.5">
   3   <refmeta>
   4     <refentrytitle>afp.conf</refentrytitle>
   5
   6     <manvolnum>5</manvolnum>
   7
   8     <refmiscinfo class="date">06 Aug 2014</refmiscinfo>
   9
  10     <refmiscinfo class="source">@NETATALK_VERSION@</refmiscinfo>
  11   </refmeta>
  12
  13   <refnamediv>
  14     <refname>afp.conf</refname>
  15
  16     <refpurpose>Netatalk configuration file <indexterm>
  17         <primary>afp.conf</primary>
  18       </indexterm></refpurpose>
  19   </refnamediv>
  20
  21   <refsect1>
  22     <title>SYNOPSIS</title>
  23
  24     <para>The <filename>afp.conf</filename> file is the configuration file for
  25     the <emphasis role="bold">Netatalk</emphasis> AFP file server.</para>
  26
  27     <para>All AFP specific configuration and AFP volume definitions are done
  28     via this file.</para>
  29   </refsect1>
  30
  31   <refsect1 id="FILEFORMATSECT">
  32     <title>FILE FORMAT</title>
  33
  34     <para>The file consists of sections and parameters. A section begins with
  35     the name of the section in square brackets and continues until the next
  36     section begins. Sections contain parameters of the form: <programlisting>
  37     <replaceable>name</replaceable> = <replaceable>value </replaceable>
  38     </programlisting></para>
  39
  40     <para>The file is line-based - that is, each newline-terminated line
  41     represents either a comment, a section name or a parameter.</para>
  42
  43     <para>Section and parameter names are case sensitive.</para>
  44
  45     <para>Only the first equals sign in a parameter is significant. Whitespace
  46     before or after the first equals sign is discarded. Leading, trailing and
  47     internal whitespace in section and parameter names is irrelevant. Leading
  48     and trailing whitespace in a parameter value is discarded. Internal
  49     whitespace within a parameter value is retained verbatim.</para>
  50
  51     <para>Any line beginning with a semicolon (<quote>;</quote>) or a hash
  52     (<quote>#</quote>) character is ignored, as are lines containing only
  53     whitespace.</para>
  54
  55     <para>Any line ending in a <quote> <literal>\</literal> </quote> is
  56     continued on the next line in the customary UNIX fashion.</para>
  57
  58     <para>The values following the equals sign in parameters are all either a
  59     string (no quotes needed) or a boolean, which may be given as yes/no, 1/0
  60     or true/false. Case is not significant in boolean values, but is preserved
  61     in string values. Some items such as create masks are numeric.</para>
  62
  63     <para>The parameter <option>include =
  64     <replaceable>path</replaceable></option> allows you to include one config
  65     file inside another. The file is included literally, as though typed in
  66     place. Nested includes are not supported.</para>
  67   </refsect1>
  68
  69   <refsect1>
  70     <title>SECTION DESCRIPTIONS</title>
  71
  72     <para>Each section in the configuration file (except for the [Global]
  73     section) describes a shared resource (known as a <quote>volume</quote>).
  74     The section name is the name of the volume and the parameters within the
  75     section define the volume attributes and options.</para>
  76
  77     <para>There are two special sections, [Global] and [Homes], which are
  78     described under <emphasis>special sections</emphasis>. The following notes
  79     apply to ordinary section descriptions.</para>
  80
  81     <para>A volume consists of a directory to which access is being given plus
  82     a description of the access rights which are granted to the user of the
  83     service. For volumes the <option>path</option> option must specify the
  84     directory to share.</para>
  85
  86     <para>Any volume section without <option>path</option> option is
  87     considered a <emphasis>vol preset</emphasis> which can be selected in
  88     other volume sections via the <option>vol preset</option> option and
  89     constitutes defaults for the volume. For any option specified both in a
  90     preset <emphasis>and</emphasis> in a volume section the volume section
  91     setting completely substitutes the preset option.</para>
  92
  93     <para>The access rights granted by the server are masked by the access
  94     rights granted to the specified or guest UNIX user by the host system. The
  95     server does not grant more access than the host system grants.</para>
  96
  97     <para>The following sample section defines an AFP volume. The user has
  98     full access to the path <filename>/foo/bar</filename>. The share is
  99     accessed via the share name <literal>baz</literal>: <programlisting> [baz]
 100     path = /foo/bar </programlisting></para>
 101   </refsect1>
 102
 103   <refsect1>
 104     <title>SPECIAL SECTIONS</title>
 105
 106     <refsect2>
 107       <title>The [Global] section</title>
 108
 109       <para>Parameters in this section apply to the server as a whole.
 110       Parameters denoted by a (G) below are must be set in this
 111       section.</para>
 112     </refsect2>
 113
 114     <refsect2>
 115       <title>The [Homes] section</title>
 116
 117       <para>This section enable sharing of the UNIX server user home
 118       directories. Specifying an optional <option>path</option> parameter
 119       means that not the whole user home will be shared but the subdirectory
 120       <option>path</option>. It is necessary to define the <option>basedir
 121       regex</option> option. It should be a regex which matches the parent
 122       directory of the user homes. Parameters denoted by a (H) belong to
 123       volume sections. The optional parameter <option>home name</option> can
 124       be used to change the AFP volume name which <emphasis>$u's
 125       home</emphasis> by default. See below under VARIABLE
 126       SUBSTITUTIONS.</para>
 127
 128       <para>The following example illustrates this. Given all user home
 129       directories are stored under <filename>/home</filename>:
 130       <programlisting> [Homes]
 131       path = afp-data
 132       basedir regex = /home</programlisting> For a user
 133       <emphasis>john</emphasis> this results in an AFP home volume with a path
 134       of <filename>/home/john/afp-data</filename>.</para>
 135
 136       <para>If <option>basedir regex</option> contains symlink, set the
 137       canonicalized absolute path. When <filename>/home</filename> links to
 138       <filename>/usr/home</filename>: <programlisting> [Homes]
 139       basedir regex = /usr/home</programlisting></para>
 140     </refsect2>
 141   </refsect1>
 142
 143   <refsect1>
 144     <title>PARAMETERS</title>
 145
 146     <para>Parameters define the specific attributes of sections.</para>
 147
 148     <para>Some parameters are specific to the [Global] section (e.g.,
 149     <emphasis>log type</emphasis>). All others are permissible only in volume
 150     sections. The letter <emphasis>G</emphasis> in parentheses indicates that
 151     a parameter is specific to the [Global] section. The letter
 152     <emphasis>V</emphasis> indicates that a parameter can be specified in a
 153     volume specific section.</para>
 154   </refsect1>
 155
 156   <refsect1>
 157     <title>VARIABLE SUBSTITUTIONS</title>
 158
 159     <para>You can use variables in volume names. The use of variables in paths
 160      is limited to $u.</para>
 161
 162     <orderedlist>
 163       <listitem>
 164         <para>if you specify an unknown variable, it will not get
 165         converted.</para>
 166       </listitem>
 167
 168       <listitem>
 169         <para>if you specify a known variable, but that variable doesn't have
 170         a value, it will get ignored.</para>
 171       </listitem>
 172     </orderedlist>
 173
 174     <para>The variables which can be used for substitutions are:</para>
 175
 176     <variablelist>
 177       <varlistentry>
 178         <term>$b</term>
 179
 180         <listitem>
 181           <para>basename</para>
 182         </listitem>
 183       </varlistentry>
 184
 185       <varlistentry>
 186         <term>$c</term>
 187
 188         <listitem>
 189           <para>client's ip address</para>
 190         </listitem>
 191       </varlistentry>
 192
 193       <varlistentry>
 194         <term>$d</term>
 195
 196         <listitem>
 197           <para>volume pathname on server</para>
 198         </listitem>
 199       </varlistentry>
 200
 201       <varlistentry>
 202         <term>$f</term>
 203
 204         <listitem>
 205           <para>full name (contents of the gecos field in the passwd
 206           file)</para>
 207         </listitem>
 208       </varlistentry>
 209
 210       <varlistentry>
 211         <term>$g</term>
 212
 213         <listitem>
 214           <para>group name</para>
 215         </listitem>
 216       </varlistentry>
 217
 218       <varlistentry>
 219         <term>$h</term>
 220
 221         <listitem>
 222           <para>hostname</para>
 223         </listitem>
 224       </varlistentry>
 225
 226       <varlistentry>
 227         <term>$i</term>
 228
 229         <listitem>
 230           <para>client's ip, without port</para>
 231         </listitem>
 232       </varlistentry>
 233
 234       <varlistentry>
 235         <term>$s</term>
 236
 237         <listitem>
 238           <para>server name (this can be the hostname)</para>
 239         </listitem>
 240       </varlistentry>
 241
 242       <varlistentry>
 243         <term>$u</term>
 244
 245         <listitem>
 246           <para>user name (if guest, it is the user that guest is running
 247           as)</para>
 248         </listitem>
 249       </varlistentry>
 250
 251       <varlistentry>
 252         <term>$v</term>
 253
 254         <listitem>
 255           <para>volume name</para>
 256         </listitem>
 257       </varlistentry>
 258
 259       <varlistentry>
 260         <term>$$</term>
 261
 262         <listitem>
 263           <para>prints dollar sign ($)</para>
 264         </listitem>
 265       </varlistentry>
 266     </variablelist>
 267   </refsect1>
 268
 269   <refsect1>
 270     <title>EXPLANATION OF GLOBAL PARAMETERS</title>
 271
 272     <refsect2>
 273       <title>Authentication Options</title>
 274
 275       <variablelist>
 276         <varlistentry>
 277           <term>ad domain = <parameter>DOMAIN</parameter>
 278           <type>(G)</type></term>
 279
 280           <listitem>
 281             <para>Append @DOMAIN to username when authenticating. Useful in
 282             Active Directory environments that otherwise would require the
 283             user to enter the full user@domain string.</para>
 284           </listitem>
 285         </varlistentry>
 286
 287         <varlistentry>
 288           <term>admin auth user = <parameter>user</parameter>
 289           <type>(G)</type></term>
 290
 291           <listitem>
 292             <para>Specifying eg "<option>admin auth user = root</option>"
 293             whenever a normal user login fails, afpd will try to authenticate
 294             as the specified <option>admin auth user</option>. If this
 295             succeeds, a normal session is created for the original connecting
 296             user. Said differently: if you know the password of <option>admin
 297             auth user</option>, you can authenticate as any other user.</para>
 298           </listitem>
 299         </varlistentry>
 300
 301         <varlistentry>
 302           <term>k5 keytab = <replaceable>path</replaceable>
 303           <type>(G)</type></term>
 304
 305           <term>k5 service = <replaceable>service</replaceable>
 306           <type>(G)</type></term>
 307
 308           <term>k5 realm = <replaceable>realm</replaceable>
 309           <type>(G)</type></term>
 310
 311           <listitem>
 312             <para>These are required if the server supports the Kerberos 5
 313             authentication UAM.</para>
 314           </listitem>
 315         </varlistentry>
 316
 317         <varlistentry>
 318           <term>nt domain = <parameter>DOMAIN</parameter>
 319           <type>(G)</type></term>
 320
 321           <term>nt separator = <parameter>SEPARATOR</parameter>
 322           <type>(G)</type></term>
 323
 324           <listitem>
 325             <para>Use for eg. winbind authentication, prepends both strings
 326             before the username from login and then tries to authenticate with
 327             the result through the available and active UAM authentication
 328             modules.</para>
 329           </listitem>
 330         </varlistentry>
 331
 332         <varlistentry>
 333           <term>save password = <replaceable>BOOLEAN</replaceable> (default:
 334           <emphasis>yes</emphasis>) <type>(G)</type></term>
 335
 336           <listitem>
 337             <para>Enables or disables the ability of clients to save passwords
 338             locally.</para>
 339           </listitem>
 340         </varlistentry>
 341
 342         <varlistentry>
 343           <term>set password = <replaceable>BOOLEAN</replaceable> (default:
 344           <emphasis>no</emphasis>) <type>(G)</type></term>
 345
 346           <listitem>
 347             <para>Enables or disables the ability of clients to change their
 348             passwords via chooser or the "connect to server" dialog.</para>
 349           </listitem>
 350         </varlistentry>
 351
 352         <varlistentry>
 353           <term>uam list = <replaceable>uam list</replaceable>
 354           <type>(G)</type></term>
 355
 356           <listitem>
 357             <para>Space or comma separated list of UAMs. (The default is
 358             "uams_dhx.so uams_dhx2.so").</para>
 359
 360             <para>The most commonly used UAMs are:</para>
 361
 362             <variablelist>
 363               <varlistentry>
 364                 <term>uams_guest.so</term>
 365
 366                 <listitem>
 367                   <para>allows guest logins</para>
 368                 </listitem>
 369               </varlistentry>
 370
 371               <varlistentry>
 372                 <term>uams_clrtxt.so</term>
 373
 374                 <listitem>
 375                   <para>(uams_pam.so or uams_passwd.so) Allow logins with
 376                   passwords transmitted in the clear. (legacy)</para>
 377                 </listitem>
 378               </varlistentry>
 379
 380               <varlistentry>
 381                 <term>uams_randum.so</term>
 382
 383                 <listitem>
 384                   <para>allows Random Number and Two-Way Random Number
 385                   Exchange for authentication (requires a separate file
 386                   containing the passwords, either @pkgconfdir@/afppasswd file or
 387                   the one specified via "<option>passwd file</option>". See
 388                   <citerefentry>
 389                       <refentrytitle>afppasswd</refentrytitle>
 390
 391                       <manvolnum>1</manvolnum>
 392                     </citerefentry> for details. (legacy)</para>
 393                 </listitem>
 394               </varlistentry>
 395
 396               <varlistentry>
 397                 <term>uams_dhx.so</term>
 398
 399                 <listitem>
 400                   <para>(uams_dhx_pam.so or uams_dhx_passwd.so) Allow
 401                   Diffie-Hellman eXchange (DHX) for authentication.</para>
 402                 </listitem>
 403               </varlistentry>
 404
 405               <varlistentry>
 406                 <term>uams_dhx2.so</term>
 407
 408                 <listitem>
 409                   <para>(uams_dhx2_pam.so or uams_dhx2_passwd.so) Allow
 410                   Diffie-Hellman eXchange 2 (DHX2) for authentication.</para>
 411                 </listitem>
 412               </varlistentry>
 413
 414               <varlistentry>
 415                 <term>uam_gss.so</term>
 416
 417                 <listitem>
 418                   <para>Allow Kerberos V for authentication (optional)</para>
 419                 </listitem>
 420               </varlistentry>
 421             </variablelist>
 422           </listitem>
 423         </varlistentry>
 424
 425         <varlistentry>
 426           <term>uam path = <replaceable>path</replaceable>
 427           <type>(G)</type></term>
 428
 429           <listitem>
 430             <para>Sets the default path for UAMs for this server (default is
 431             @libdir@/netatalk).</para>
 432           </listitem>
 433         </varlistentry>
 434       </variablelist>
 435     </refsect2>
 436
 437     <refsect2>
 438       <title>Charset Options</title>
 439
 440       <para>With OS X Apple introduced the AFP3 protocol. One of the big
 441       changes was, that AFP3 uses Unicode names encoded as Decomposed UTF-8
 442       (UTF8-MAC). Previous AFP/OS versions used charsets like MacRoman,
 443       MacCentralEurope, etc.</para>
 444
 445       <para>To be able to serve AFP3 and older clients at the same time,
 446       <command>afpd</command> needs to be able to convert between UTF-8 and
 447       Mac charsets. Even OS X clients partly still rely on the mac charset. As
 448       there's no way, <command>afpd</command> can detect the codepage a pre
 449       AFP3 client uses, you have to specify it using the <option>mac
 450       charset</option> option. The default is MacRoman, which should be fine
 451       for most western users.</para>
 452
 453       <para>As <command>afpd</command> needs to interact with UNIX operating
 454       system as well, it need's to be able to convert from UTF8-MAC / Mac
 455       charset to the UNIX charset. By default <command>afpd</command> uses
 456       <emphasis>UTF8</emphasis>. You can set the UNIX charset using the
 457       <option>unix charset</option> option. If you're using extended
 458       characters in the configuration files for <command>afpd</command>, make
 459       sure your terminal matches the <option>unix charset</option>.</para>
 460
 461       <variablelist>
 462         <varlistentry>
 463           <term>mac charset = <parameter>CHARSET</parameter>
 464           <type>(G)/(V)</type></term>
 465
 466           <listitem>
 467             <para>Specifies the Mac clients charset, e.g.
 468             <emphasis>MAC_ROMAN</emphasis>. This is used to convert strings
 469             and filenames to the clients codepage for OS9 and Classic, i.e.
 470             for authentication and AFP messages (SIGUSR2 messaging). This will
 471             also be the default for the volumes <option>mac charset</option>.
 472             Defaults to <emphasis>MAC_ROMAN</emphasis>.</para>
 473           </listitem>
 474         </varlistentry>
 475
 476         <varlistentry>
 477           <term>unix charset = <parameter>CHARSET</parameter>
 478           <type>(G)</type></term>
 479
 480           <listitem>
 481             <para>Specifies the servers unix charset, e.g.
 482             <emphasis>ISO-8859-15</emphasis> or <emphasis>EUC-JP</emphasis>.
 483             This is used to convert strings to/from the systems locale, e.g.
 484             for authentication, server messages and volume names. If
 485             <emphasis>LOCALE</emphasis> is set, the systems locale is used.
 486             Defaults to <emphasis>UTF8</emphasis>.</para>
 487           </listitem>
 488         </varlistentry>
 489
 490         <varlistentry>
 491           <term>vol charset = <parameter>CHARSET</parameter>
 492           <type>(G)/(V)</type></term>
 493
 494           <listitem>
 495             <para>Specifies the encoding of the volumes filesystem. By
 496             default, it is the same as <option>unix charset</option>.</para>
 497           </listitem>
 498         </varlistentry>
 499       </variablelist>
 500     </refsect2>
 501
 502     <refsect2>
 503       <title>Password Options</title>
 504
 505       <variablelist>
 506         <varlistentry>
 507           <term>passwd file = <parameter>path</parameter>
 508           <type>(G)</type></term>
 509
 510           <listitem>
 511             <para>Sets the path to the Randnum UAM passwd file for this server
 512             (default is @pkgconfdir@/afppasswd).</para>
 513           </listitem>
 514         </varlistentry>
 515
 516         <varlistentry>
 517           <term>passwd minlen = <parameter>number</parameter>
 518           <type>(G)</type></term>
 519
 520           <listitem>
 521             <para>Sets the minimum password length, if supported by the
 522             UAM</para>
 523           </listitem>
 524         </varlistentry>
 525       </variablelist>
 526     </refsect2>
 527
 528     <refsect2>
 529       <title>Network Options</title>
 530
 531       <variablelist>
 532         <varlistentry>
 533           <term>advertise ssh = <replaceable>BOOLEAN</replaceable> (default:
 534           <emphasis>no</emphasis>) <type>(G)</type></term>
 535
 536           <listitem>
 537             <para>Allows old Mac OS X clients (10.3.3-10.4) to automagically
 538             establish a tunneled AFP connection through SSH. If this option is
 539             set, the server's answers to client's FPGetSrvrInfo requests
 540             contain an additional entry. It depends on both client's settings
 541             and a correctly configured and running <citerefentry>
 542                 <refentrytitle>sshd</refentrytitle>
 543
 544                 <manvolnum>8</manvolnum>
 545               </citerefentry> on the server to let things work.</para>
 546
 547             <note>
 548               <para>Setting this option is not recommended since globally
 549               encrypting AFP connections via SSH will increase the server's
 550               load significantly. On the other hand, Apple's client side
 551               implementation of this feature in MacOS X versions prior to
 552               10.3.4 contained a security flaw.</para>
 553             </note>
 554           </listitem>
 555         </varlistentry>
 556
 557         <varlistentry>
 558           <term>afp interfaces = <replaceable>name [name ...]</replaceable>
 559             <type>(G)</type></term>
 560           <listitem>
 561             <para>Specifies the network interfaces that the server should
 562             listens on. The default is advertise the first IP address of the
 563             system, but to listen for any incoming request.</para>
 564           </listitem>
 565         </varlistentry>
 566
 567         <varlistentry>
 568           <term>afp listen = <replaceable>ip address[:port] [ip address[:port]
 569           ...]</replaceable> <type>(G)</type></term>
 570
 571           <listitem>
 572             <para>Specifies the IP address that the server should advertise
 573             <emphasis role="bold">and</emphasis> listens to. The default is
 574             advertise the first IP address of the system, but to listen for
 575             any incoming request. The network address may be specified either
 576             in dotted-decimal format for IPv4 or in hexadecimal format for
 577             IPv6.</para>
 578             <para>IPv6 address + port combination must use URL the format
 579             using square brackets [IPv6]:port</para>
 580           </listitem>
 581         </varlistentry>
 582
 583         <varlistentry>
 584           <term>afp port = <replaceable>port number</replaceable>
 585           <type>(G)</type></term>
 586
 587           <listitem>
 588             <para>Allows a different TCP port to be used for AFP. The default
 589             is 548. Also sets the default port applied when none specified in
 590             an <option>afp listen</option> option.</para>
 591           </listitem>
 592         </varlistentry>
 593
 594         <varlistentry>
 595           <term>cnid listen = <replaceable>ip address[:port] [ip
 596           address[:port] ...]</replaceable> <type>(G)</type></term>
 597
 598           <listitem>
 599             <para>Specifies the IP address that the CNID server should listen
 600             on. The default is <emphasis
 601             role="bold">localhost:4700</emphasis>.</para>
 602           </listitem>
 603         </varlistentry>
 604
 605         <varlistentry>
 606           <term>disconnect time = <replaceable>number</replaceable>
 607           <type>(G)</type></term>
 608
 609           <listitem>
 610             <para>Keep disconnected AFP sessions for
 611             <parameter>number</parameter> hours before dropping them. Default
 612             is 24 hours.</para>
 613           </listitem>
 614         </varlistentry>
 615
 616         <varlistentry>
 617           <term>dsireadbuf = <replaceable>number</replaceable>
 618           <type>(G)</type></term>
 619
 620           <listitem>
 621             <para>Scale factor that determines the size of the DSI/TCP
 622             readahead buffer, default is 12. This is multiplies with the DSI
 623             server quantum (default ~300k) to give the size of the buffer.
 624             Increasing this value might increase throughput in fast local
 625             networks for volume to volume copies. <emphasis>Note</emphasis>:
 626             This buffer is allocated per afpd child process, so specifying
 627             large values will eat up large amount of memory (buffer size *
 628             number of clients).</para>
 629           </listitem>
 630         </varlistentry>
 631
 632         <varlistentry>
 633           <term>fqdn = <replaceable>name:port</replaceable>
 634           <type>(G)</type></term>
 635
 636           <listitem>
 637             <para>Specifies a fully-qualified domain name, with an optional
 638             port. This is discarded if the server cannot resolve it. This
 639             option is not honored by AppleShare clients &lt;= 3.8.3. This
 640             option is disabled by default. Use with caution as this will
 641             involve a second name resolution step on the client side. Also
 642             note that afpd will advertise this name:port combination but not
 643             automatically listen to it.</para>
 644           </listitem>
 645         </varlistentry>
 646
 647         <varlistentry>
 648           <term>hostname = <replaceable>name</replaceable>
 649           <type>(G)</type></term>
 650
 651           <listitem>
 652             <para>Use this instead of the result from calling hostname for
 653             determining which IP address to advertise, therefore the hostname
 654             is resolved to an IP which is the advertised. This is NOT used for
 655             listening and it is also overwritten by <option>afp
 656             listen</option>.</para>
 657           </listitem>
 658         </varlistentry>
 659
 660         <varlistentry>
 661           <term>max connections = <replaceable>number</replaceable>
 662           <type>(G)</type></term>
 663
 664           <listitem>
 665             <para>Sets the maximum number of clients that can simultaneously
 666             connect to the server (default is 200).</para>
 667           </listitem>
 668         </varlistentry>
 669
 670         <varlistentry>
 671           <term>server quantum = <replaceable>number</replaceable>
 672           <type>(G)</type></term>
 673
 674           <listitem>
 675             <para>This specifies the DSI server quantum. The default value is
 676             0x100000 (1 MiB). The maximum value is 0xFFFFFFFFF, the minimum is
 677             32000. If you specify a value that is out of range, the default
 678             value will be set. Do not change this value unless you're
 679             absolutely sure, what you're doing</para>
 680           </listitem>
 681         </varlistentry>
 682
 683         <varlistentry>
 684           <term>sleep time = <replaceable>number</replaceable>
 685           <type>(G)</type></term>
 686
 687           <listitem>
 688             <para>Keep sleeping AFP sessions for <parameter>number</parameter>
 689             hours before disconnecting clients in sleep mode. Default is 10
 690             hours.</para>
 691           </listitem>
 692         </varlistentry>
 693
 694         <varlistentry>
 695           <term>tcprcvbuf = <replaceable>number</replaceable>
 696           <type>(G)</type></term>
 697
 698           <listitem>
 699             <para>Try to set TCP receive buffer using setsockpt(). Often OSes
 700             impose restrictions on the applications ability to set this
 701             value.</para>
 702           </listitem>
 703         </varlistentry>
 704
 705         <varlistentry>
 706           <term>tcpsndbuf = <replaceable>number</replaceable>
 707           <type>(G)</type></term>
 708
 709           <listitem>
 710             <para>Try to set TCP send buffer using setsockpt(). Often OSes
 711             impose restrictions on the applications ability to set this
 712             value.</para>
 713           </listitem>
 714         </varlistentry>
 715
 716         <varlistentry>
 717           <term>recvfile = <replaceable>BOOLEAN</replaceable> (default:
 718           <emphasis>no</emphasis>) <type>(G)</type></term>
 719
 720           <listitem>
 721             <para>Whether to use splice() on Linux for receiving data.</para>
 722           </listitem>
 723         </varlistentry>
 724
 725         <varlistentry>
 726           <term>splice size = <replaceable>number</replaceable> (default:
 727           <emphasis>64k</emphasis>) <type>(G)</type></term>
 728
 729           <listitem>
 730             <para>Maximum number of bytes spliced.</para>
 731           </listitem>
 732         </varlistentry>
 733
 734         <varlistentry>
 735           <term>use sendfile = <replaceable>BOOLEAN</replaceable> (default:
 736           <emphasis>yes</emphasis>) <type>(G)</type></term>
 737
 738           <listitem>
 739             <para>Whether to use sendfile<indexterm>
 740                 <primary>sendfile</primary>
 741               </indexterm> syscall for sending file data to clients.</para>
 742           </listitem>
 743         </varlistentry>
 744
 745
 746         <varlistentry>
 747           <term>zeroconf = <replaceable>BOOLEAN</replaceable> (default:
 748           <emphasis>yes</emphasis>) <type>(G)</type></term>
 749
 750           <listitem>
 751             <para>Whether to use automatic Zeroconf<indexterm>
 752                 <primary>Zeroconf</primary>
 753
 754                 <secondary>Bonjour</secondary>
 755               </indexterm> service registration if Avahi or mDNSResponder were
 756             compiled in.</para>
 757           </listitem>
 758         </varlistentry>
 759       </variablelist>
 760     </refsect2>
 761
 762     <refsect2>
 763       <title>Miscellaneous Options</title>
 764
 765       <variablelist>
 766         <varlistentry>
 767           <term>admin group = <replaceable>group</replaceable>
 768           <type>(G)</type></term>
 769
 770           <listitem>
 771             <para>Allows users of a certain group to be seen as the superuser
 772             when they log in. This option is disabled by default.</para>
 773           </listitem>
 774         </varlistentry>
 775
 776         <varlistentry>
 777           <term>afp read locks = <replaceable>BOOLEAN</replaceable> (default:
 778           <emphasis>no</emphasis>) <type>(G)</type></term>
 779
 780           <listitem>
 781             <para>Whether to apply locks to the byte region read in FPRead
 782             calls. The AFP spec mandates this, but it's not really in line
 783             with UNIX semantics and is a performance hug.</para>
 784           </listitem>
 785         </varlistentry>
 786
 787         <varlistentry>
 788           <term>afpstats = <replaceable>BOOLEAN</replaceable> (default:
 789           <emphasis>no</emphasis>) <type>(G)</type></term>
 790
 791           <listitem>
 792             <para>Whether to provide AFP runtime statistics (connected
 793             users, open volumes) via dbus.</para>
 794           </listitem>
 795         </varlistentry>
 796
 797         <varlistentry>
 798           <term>basedir regex = <replaceable>regex</replaceable>
 799           <type>(H)</type></term>
 800
 801           <listitem>
 802             <para>Regular expression which matches the parent directory of the
 803             user homes. If <option>basedir regex</option> contains symlink,
 804             you must set the canonicalized absolute path. In the simple case
 805             this is just a path ie <option>basedir regex =
 806             /home</option></para>
 807           </listitem>
 808         </varlistentry>
 809
 810         <varlistentry>
 811           <term>chmod request = <replaceable>preserve (default) | ignore | simple</replaceable>
 812           <type>(G/V)</type></term>
 813
 814           <listitem>
 815             <para>Advanced permission control that deals with ACLs.</para>
 816
 817             <itemizedlist>
 818               <listitem><para> <option>ignore</option> - UNIX chmod()
 819               requests are completely ignored, use this option to
 820               allow the parent directory's ACL inheritance full
 821               control over new items.  </para></listitem>
 822               <listitem><para>
 823                 <option>preserve</option> - preserve ZFS ACEs for
 824                 named users and groups or POSIX ACL group mask
 825                       </para></listitem>
 826               <listitem><para>
 827                 <option>simple</option> - just to a chmod() as
 828                 requested without any extra steps
 829                       </para></listitem>
 830                     </itemizedlist>
 831           </listitem>
 832         </varlistentry>
 833
 834         <varlistentry>
 835           <term>close vol = <replaceable>BOOLEAN</replaceable> (default:
 836           <emphasis>no</emphasis>) <type>(G)</type></term>
 837
 838           <listitem>
 839             <para>Whether to close volumes possibly opened by clients when
 840             they're removed from the configuration and the configuration is
 841             reloaded.</para>
 842           </listitem>
 843         </varlistentry>
 844
 845         <varlistentry>
 846           <term>cnid mysql host = <replaceable>MySQL server address</replaceable>
 847           <type>(G)</type></term>
 848
 849           <listitem>
 850             <para>name or address of a MySQL server for use with the mysql CNID
 851             backend.</para>
 852           </listitem>
 853         </varlistentry>
 854
 855         <varlistentry>
 856           <term>cnid mysql user = <replaceable>MySQL user</replaceable>
 857           <type>(G)</type></term>
 858
 859           <listitem>
 860             <para>MySQL user for authentication with the server.</para>
 861           </listitem>
 862         </varlistentry>
 863
 864         <varlistentry>
 865           <term>cnid mysql pw = <replaceable>password</replaceable>
 866           <type>(G)</type></term>
 867
 868           <listitem>
 869             <para>Password for MySQL server.</para>
 870           </listitem>
 871         </varlistentry>
 872
 873         <varlistentry>
 874           <term>cnid mysql db = <replaceable>database name</replaceable>
 875           <type>(G)</type></term>
 876
 877           <listitem>
 878             <para>Name of an existing database for which the specified user
 879             has full privileges.</para>
 880           </listitem>
 881         </varlistentry>
 882
 883         <varlistentry>
 884           <term>cnid server = <replaceable>ipaddress[:port]</replaceable>
 885           <type>(G)/(V)</type></term>
 886
 887           <listitem>
 888             <para>Specifies the IP address and port of a cnid_metad server,
 889             required for CNID dbd backend. Defaults to localhost:4700. The
 890             network address may be specified either in dotted-decimal format
 891             for IPv4 or in hexadecimal format for IPv6.-</para>
 892           </listitem>
 893         </varlistentry>
 894
 895         <varlistentry>
 896           <term>dbus daemon = <parameter>path</parameter>
 897           <type>(G)</type></term>
 898
 899           <listitem>
 900             <para>Sets the path to dbus-daemon binary used by Spotlight feature.
 901             The default is <filename>/bin/dbus-daemon</filename>.</para>
 902           </listitem>
 903         </varlistentry>
 904
 905         <varlistentry>
 906           <term>dircachesize = <replaceable>number</replaceable>
 907           <type>(G)</type></term>
 908
 909           <listitem>
 910             <para>Maximum possible entries in the directory cache. The cache
 911             stores directories and files. It is used to cache the full path to
 912             directories and CNIDs which considerably speeds up directory
 913             enumeration.</para>
 914
 915             <para>Default size is 8192, maximum size is 131072. Given value is
 916             rounded up to nearest power of 2. Each entry takes about 100
 917             bytes, which is not much, but remember that every afpd child
 918             process for every connected user has its cache.</para>
 919           </listitem>
 920         </varlistentry>
 921
 922         <varlistentry>
 923           <term>extmap file = <parameter>path</parameter>
 924           <type>(G)</type></term>
 925
 926           <listitem>
 927             <para>Sets the path to the file which defines file extension
 928             type/creator mappings. (default is @pkgconfdir@/extmap.conf).</para>
 929           </listitem>
 930         </varlistentry>
 931
 932         <varlistentry>
 933           <term>force xattr with sticky bit =
 934           <replaceable>BOOLEAN</replaceable> (default:
 935           <emphasis>no</emphasis>) <type>(G/V)</type></term>
 936
 937           <listitem>
 938             <para>Writing metadata xattr on directories with the
 939             sticky bit set may fail even though we may have write
 940             access to a directory, because if the sticky bit is set
 941             only the owner is allowed to write xattrs.</para>
 942
 943             <para>By enabling this option Netatalk will write the
 944             metadata xattr as root.</para>
 945           </listitem>
 946         </varlistentry>
 947
 948         <varlistentry>
 949           <term>guest account = <replaceable>name</replaceable>
 950           <type>(G)</type></term>
 951
 952           <listitem>
 953             <para>Specifies the user that guests should use (default is
 954             "nobody"). The name should be quoted.</para>
 955           </listitem>
 956         </varlistentry>
 957
 958         <varlistentry>
 959           <term>home name = <replaceable>name</replaceable>
 960           <type>(H)</type></term>
 961
 962           <listitem>
 963             <para>AFP user home volume name. The default is <emphasis>user's
 964             home</emphasis>.</para>
 965           </listitem>
 966         </varlistentry>
 967
 968         <varlistentry>
 969           <term>ignored attributes = <replaceable>all | nowrite | nodelete | norename</replaceable>
 970           <type>(G)/(V)</type></term>
 971
 972           <listitem>
 973             <para>Speficy a set of file and directory attributes that shall
 974             be ignored by the server, <option>all</option> includes all
 975             the other options.</para>
 976             <para>In OS X when the Finder sets a lock on a file/directory or you
 977             set the BSD uchg flag in the Terminal, all three attributes are
 978             used. Thus in order to ignore the Finder lock/BSD uchg flag, add
 979             set <emphasis>ignored attributes = all</emphasis>.</para>
 980           </listitem>
 981         </varlistentry>
 982
 983         <varlistentry>
 984           <term>login message = <replaceable>message</replaceable>
 985           <type>(G)/(V)</type></term>
 986
 987           <listitem>
 988             <para>Sets a message to be displayed when clients logon to the
 989             server. The message should be in <option>unix charset</option> and
 990             should be quoted. Extended characters are allowed.</para>
 991           </listitem>
 992         </varlistentry>
 993
 994         <varlistentry>
 995           <term>mimic model = <replaceable>model</replaceable>
 996           <type>(G)</type></term>
 997
 998           <listitem>
 999             <para>Specifies the icon model that appears on clients. Defaults
1000             to off. Note that afpd must support Zeroconf.
1001             Examples: RackMac (same as Xserve), PowerBook, PowerMac,
1002             Macmini, iMac, MacBook, MacBookPro, MacBookAir, MacPro,
1003             AppleTV1,1, AirPort.</para>
1004           </listitem>
1005         </varlistentry>
1006
1007         <varlistentry>
1008           <term>signature = &lt;text&gt; <type>(G)</type></term>
1009
1010           <listitem>
1011             <para>Specify a server signature. The maximum length is 16
1012             characters. This option is useful for clustered environments, to
1013             provide fault isolation etc. By default, afpd generate signature
1014             and saving it to
1015             <filename>@localstatedir@/netatalk/afp_signature.conf</filename>
1016             automatically (based on random number). See also
1017             asip-status.pl(1).</para>
1018           </listitem>
1019         </varlistentry>
1020
1021         <varlistentry>
1022           <term>solaris share reservations =
1023           <replaceable>BOOLEAN</replaceable> (default:
1024           <emphasis>yes</emphasis>) <type>(G)</type></term>
1025
1026           <listitem>
1027             <para>Use share reservations on Solaris. Solaris CIFS server uses
1028             this too, so this makes a lock coherent multi protocol
1029             server.</para>
1030           </listitem>
1031         </varlistentry>
1032
1033         <varlistentry>
1034           <term>sparql results limit =
1035           <replaceable>NUMBER</replaceable> (default:
1036           <emphasis>UNLIMITED</emphasis>) <type>(G)</type></term>
1037
1038           <listitem>
1039             <para>Impose a limit on the number of results queried from Tracker
1040             via SPARQL queries.</para>
1041           </listitem>
1042         </varlistentry>
1043
1044         <varlistentry>
1045           <term>spotlight =
1046           <replaceable>BOOLEAN</replaceable> (default:
1047           <emphasis>no</emphasis>) <type>(G)/(V)</type></term>
1048
1049           <listitem>
1050             <para>Whether to enable Spotlight searches. Note: once the global
1051             option is enabled, any volume that is not enabled won't be
1052             searchable at all. See also <emphasis>dbus daemon</emphasis>
1053             option.</para>
1054           </listitem>
1055         </varlistentry>
1056
1057         <varlistentry>
1058           <term>spotlight attributes =
1059           <replaceable>COMMA SEPERATED STRING</replaceable> (default:
1060           <emphasis>EMPTY</emphasis>) <type>(G)</type></term>
1061
1062           <listitem>
1063             <para>A list of attributes that are allowed to be used in
1064             Spotlight searches. By default all attributes can be
1065             searched, passing a string limits attributes to elements
1066             of the string. Example: <programlisting>spotlight
1067             attributes = *,kMDItemTextContent</programlisting>
1068             </para>
1069           </listitem>
1070         </varlistentry>
1071
1072         <varlistentry>
1073           <term>spotlight expr =
1074           <replaceable>BOOLEAN</replaceable> (default:
1075           <emphasis>yes</emphasis>) <type>(G)</type></term>
1076
1077           <listitem>
1078             <para>Whether to allow the use of logic expression in
1079             searches.</para>
1080           </listitem>
1081         </varlistentry>
1082
1083         <varlistentry>
1084           <term>start dbus =
1085           <replaceable>BOOLEAN</replaceable> (default:
1086           <emphasis>yes</emphasis>) <type>(G)</type></term>
1087
1088           <listitem>
1089             <para>Whether to start a dbus instance for use with Tracker.</para>
1090           </listitem>
1091         </varlistentry>
1092
1093         <varlistentry>
1094           <term>start tracker =
1095           <replaceable>BOOLEAN</replaceable> (default:
1096           <emphasis>yes</emphasis>) <type>(G)</type></term>
1097
1098           <listitem>
1099             <para>Whether to start Tracker with
1100             <emphasis>tracker-control -s</emphasis>.</para>
1101           </listitem>
1102         </varlistentry>
1103
1104         <varlistentry>
1105           <term>veto message = <replaceable>BOOLEAN</replaceable> (default:
1106           <emphasis>no</emphasis>) <type>(G)</type></term>
1107
1108           <listitem>
1109             <para>Send optional AFP messages for vetoed files. Then whenever a
1110             client tries to access any file or directory with a vetoed name,
1111             it will be sent an AFP message indicating the name and the
1112             directory.</para>
1113           </listitem>
1114         </varlistentry>
1115
1116         <varlistentry>
1117           <term>vol dbpath = <replaceable>path</replaceable>
1118           <type>(G)/(V)</type></term>
1119
1120           <listitem>
1121             <para>Sets the database information to be stored in path. You have
1122             to specify a writable location, even if the volume is read only.
1123             The default is
1124             <filename>@localstatedir@/netatalk/CNID/$v/</filename>.</para>
1125           </listitem>
1126         </varlistentry>
1127
1128         <varlistentry>
1129           <term>vol dbnest = <replaceable>BOOLEAN</replaceable> (default:
1130           <emphasis>no</emphasis>) <type>(G)</type></term>
1131
1132           <listitem>
1133             <para>Setting this option to true brings back Netatalk 2
1134             behaviour of storing the CNID database in a folder called
1135             .AppleDB inside the volume root of each share.</para>
1136           </listitem>
1137         </varlistentry>
1138
1139         <varlistentry>
1140           <term>volnamelen = <replaceable>number</replaceable>
1141           <type>(G)</type></term>
1142
1143           <listitem>
1144             <para>Max length of UTF8-MAC volume name for Mac OS X. Note that
1145             Hangul is especially sensitive to this.</para>
1146
1147             <para><programlisting> 73: limit of Mac OS X 10.1 80: limit of Mac
1148             OS X 10.4/10.5 (default) 255: limit of recent Mac OS
1149             X</programlisting> Mac OS 9 and earlier are not influenced by
1150             this, because Maccharset volume name is always limited to 27
1151             bytes.</para>
1152           </listitem>
1153         </varlistentry>
1154
1155         <varlistentry>
1156           <term>vol preset = <replaceable>name</replaceable>
1157           <type>(G)/(V)</type></term>
1158
1159           <listitem>
1160             <para>Use section <option>name</option> as option preset for all
1161             volumes (when set in the [Global] section) or for one volume (when
1162             set in that volume's section).</para>
1163           </listitem>
1164         </varlistentry>
1165       </variablelist>
1166     </refsect2>
1167
1168     <refsect2>
1169       <title>Logging Options</title>
1170
1171       <variablelist>
1172         <varlistentry>
1173           <term>log file = <replaceable>logfile</replaceable>
1174           <type>(G)</type></term>
1175
1176           <listitem>
1177             <para>If not specified Netatalk logs to syslogs daemon facility.
1178             Otherwise it logs to <option>logfile</option>.</para>
1179           </listitem>
1180         </varlistentry>
1181
1182         <varlistentry>
1183           <term>log level = <replaceable>type:level [type:level
1184           ...]</replaceable> <type>(G)</type></term>
1185
1186           <term>log level = <replaceable>type:level,[type:level,
1187           ...]</replaceable> <type>(G)</type></term>
1188
1189           <listitem>
1190             <para>Specify that any message of a loglevel up to the given
1191             <option>log level</option> should be logged.</para>
1192
1193             <para>By default afpd logs to syslog with a default logging setup
1194             equivalent to <option>default:note</option></para>
1195
1196             <para>logtypes: default, afpdaemon, logger, uamsdaemon</para>
1197
1198             <para>loglevels: severe, error, warn, note, info, debug, debug6,
1199             debug7, debug8, debug9, maxdebug</para>
1200
1201             <note>
1202               <para>Both logtype and loglevels are case insensitive.</para>
1203             </note>
1204           </listitem>
1205         </varlistentry>
1206       </variablelist>
1207     </refsect2>
1208
1209     <refsect2 id="fceconf">
1210       <title>Filesystem Change Events (FCE<indexterm>
1211           <primary>FCE</primary>
1212         </indexterm>)</title>
1213
1214       <para>Netatalk includes a nifty filesystem change event mechanism where
1215       afpd processes notify interested listeners about certain filesystem
1216       event by UDP network datagrams.</para>
1217
1218       <para>The following FCE events are defined:</para>
1219
1220       <itemizedlist>
1221         <listitem><para>file modification (<option>fmod</option>)</para></listitem>
1222         <listitem><para>file deletion (<option>fdel</option>)</para></listitem>
1223         <listitem><para>directory deletion (<option>ddel</option>)</para></listitem>
1224         <listitem><para>file creation (<option>fcre</option>)</para></listitem>
1225         <listitem><para>directory creation (<option>dcre</option>)</para></listitem>
1226         <listitem><para>file move or rename (<option>fmov</option>)</para></listitem>
1227         <listitem><para>directory move or rename (<option>dmov</option>)</para></listitem>
1228         <listitem><para>login (<option>login</option>)</para></listitem>
1229         <listitem><para>logout (<option>logout</option>)</para></listitem>
1230       </itemizedlist>
1231
1232       <variablelist>
1233         <varlistentry>
1234           <term>fce listener = <replaceable>host[:port]</replaceable>
1235           <type>(G)</type></term>
1236
1237           <listitem>
1238             <para>Enables sending FCE events to the specified
1239             <parameter>host</parameter>, default <parameter>port</parameter>
1240             is 12250 if not specified. Specifying multiple listeners is done
1241             by having this option once for each of them.</para>
1242           </listitem>
1243         </varlistentry>
1244
1245         <varlistentry>
1246           <term>fce version = <replaceable>1|2</replaceable>
1247           <type>(G)</type></term>
1248
1249           <listitem>
1250             <para>FCE protocol version, default is 1. You need version
1251             2 for the fmov, dmov, login or logout events.</para>
1252           </listitem>
1253         </varlistentry>
1254
1255         <varlistentry>
1256           <term>fce events =
1257           <replaceable>fmod,fdel,ddel,fcre,dcre,fmov,dmov,login,logout</replaceable>
1258           <type>(G)</type></term>
1259
1260           <listitem>
1261             <para>Specifies which FCE events are active, default is
1262             <parameter>fmod,fdel,ddel,fcre,dcre</parameter>.</para>
1263           </listitem>
1264         </varlistentry>
1265
1266         <varlistentry>
1267           <term>fce coalesce = <replaceable>all|delete|create</replaceable>
1268           <type>(G)</type></term>
1269
1270           <listitem>
1271             <para>Coalesce FCE events.</para>
1272           </listitem>
1273         </varlistentry>
1274
1275         <varlistentry>
1276           <term>fce holdfmod = <replaceable>seconds</replaceable>
1277           <type>(G)</type></term>
1278
1279           <listitem>
1280             <para>This determines the time delay in seconds which is always
1281             waited if another file modification for the same file is done by a
1282             client before sending an FCE file modification event (fmod). For
1283             example saving a file in Photoshop would generate multiple events
1284             by itself because the application is opening, modifying and
1285             closing a file multiple times for every "save". Default: 60
1286             seconds.</para>
1287           </listitem>
1288         </varlistentry>
1289
1290         <varlistentry>
1291           <term>fce ignore names = <replaceable>NAME[/NAME2/...]</replaceable>
1292           <type>(G)</type></term>
1293
1294           <listitem>
1295             <para>Slash delimited list of filenames for which FCE
1296             events shall not be generated. Default: .DS_Store.</para>
1297           </listitem>
1298         </varlistentry>
1299
1300         <varlistentry>
1301           <term>fce notify script = <replaceable>PATH</replaceable>
1302           <type>(G)</type></term>
1303
1304           <listitem>
1305             <para>Script which will be executed for every FCE event,
1306             see contrib/shell_utils/fce_ev_script.shfrom the Netatalk
1307             sources for an example script.</para>
1308           </listitem>
1309         </varlistentry>
1310
1311       </variablelist>
1312     </refsect2>
1313
1314     <refsect2>
1315       <title>Debug Parameters</title>
1316
1317       <para>These options are useful for debugging only.</para>
1318
1319       <variablelist>
1320         <varlistentry>
1321           <term>tickleval = <replaceable>number</replaceable>
1322           <type>(G)</type></term>
1323
1324           <listitem>
1325             <para>Sets the tickle timeout interval (in seconds). Defaults to
1326             30.</para>
1327           </listitem>
1328         </varlistentry>
1329
1330         <varlistentry>
1331           <term>timeout = <replaceable>number</replaceable>
1332           <type>(G)</type></term>
1333
1334           <listitem>
1335             <para>Specify the number of tickles to send before timing out a
1336             connection. The default is 4, therefore a connection will timeout
1337             after 2 minutes.</para>
1338           </listitem>
1339         </varlistentry>
1340
1341         <varlistentry>
1342           <term>client polling = <replaceable>BOOLEAN</replaceable> (default:
1343           <emphasis>no</emphasis>) <type>(G)</type></term>
1344
1345           <listitem>
1346             <para>With this option enabled, afpd won't advertise that it is
1347             capable of server notifications, so that connected clients poll
1348             the server every 10 seconds to detect changes in opened server
1349             windows. <emphasis>Note</emphasis>: Depending on the number of
1350             simultaneously connected clients and the network's speed, this can
1351             lead to a significant higher load on your network!</para>
1352
1353             <para>Do not use this option any longer as present Netatalk
1354             correctly supports server notifications, allowing connected
1355             clients to update folder listings in case another client changed
1356             the contents.</para>
1357           </listitem>
1358         </varlistentry>
1359       </variablelist>
1360     </refsect2>
1361
1362     <refsect2 id="acl_options">
1363       <title>Options for ACL handling</title>
1364
1365       <para>By default, the effective permission of the authenticated user are
1366       only mapped to the mentioned UARights permission structure, not the UNIX
1367       mode. You can adjust this behaviour with the configuration option
1368       <option>mac acls</option>:</para>
1369
1370       <variablelist id="map_acls">
1371         <varlistentry>
1372           <term>map acls = <parameter>none|rights|mode</parameter>
1373           <type>(G)</type></term>
1374
1375           <listitem>
1376             <para><variablelist>
1377                 <varlistentry>
1378                   <term>none</term>
1379
1380                   <listitem>
1381                     <para>no mapping of ACLs </para>
1382                   </listitem>
1383                 </varlistentry>
1384
1385                 <varlistentry>
1386                   <term>rights</term>
1387
1388                   <listitem>
1389                     <para>effective permissions are mapped to UARights
1390                     structure. This is the default.</para>
1391                   </listitem>
1392                 </varlistentry>
1393
1394                 <varlistentry>
1395                   <term>mode</term>
1396
1397                   <listitem>
1398                     <para>ACLs are additionally mapped to the UNIX mode of the
1399                     filesystem object.</para>
1400                   </listitem>
1401                 </varlistentry>
1402               </variablelist></para>
1403           </listitem>
1404         </varlistentry>
1405       </variablelist>
1406
1407       <para>If you want to be able to display ACLs on the client, you must
1408       setup both client and server as part on a authentication domain
1409       (directory service, eg LDAP, Open Directory, Active Directory). The
1410       reason is, in OS X ACLs are bound to UUIDs, not just uid's or gid's.
1411       Therefor Netatalk must be able to map every filesystem uid and gid to a
1412       UUID so that it can return the server side ACLs which are bound to UNIX
1413       uid and gid mapped to OS X UUIDs.</para>
1414
1415       <para>Netatalk can query a directory server using LDAP queries. Either
1416       the directory server already provides an UUID attribute for user and
1417       groups (Active Directory, Open Directory) or you reuse an unused
1418       attribute (or add a new one) to you directory server (eg
1419       OpenLDAP).</para>
1420
1421       <para>The following LDAP options must be configured for Netatalk:</para>
1422
1423       <variablelist>
1424         <varlistentry>
1425           <term>ldap auth method = <parameter>none|simple|sasl</parameter>
1426           <type>(G)</type></term>
1427
1428           <listitem>
1429             <para>Authentication method: <option>none | simple |
1430             sasl</option></para>
1431
1432             <para><variablelist>
1433                 <varlistentry>
1434                   <term>none</term>
1435
1436                   <listitem>
1437                     <para>anonymous LDAP bind</para>
1438                   </listitem>
1439                 </varlistentry>
1440
1441                 <varlistentry>
1442                   <term>simple</term>
1443
1444                   <listitem>
1445                     <para>simple LDAP bind</para>
1446                   </listitem>
1447                 </varlistentry>
1448
1449                 <varlistentry>
1450                   <term>sasl</term>
1451
1452                   <listitem>
1453                     <para>SASL. Not yet supported !</para>
1454                   </listitem>
1455                 </varlistentry>
1456               </variablelist></para>
1457           </listitem>
1458         </varlistentry>
1459
1460         <varlistentry>
1461           <term>ldap auth dn = <parameter>dn</parameter>
1462           <type>(G)</type></term>
1463
1464           <listitem>
1465             <para>Distinguished Name of the user for simple bind.</para>
1466           </listitem>
1467         </varlistentry>
1468
1469         <varlistentry>
1470           <term>ldap auth pw = <parameter>password</parameter>
1471           <type>(G)</type></term>
1472
1473           <listitem>
1474             <para>Distinguished Name of the user for simple bind.</para>
1475           </listitem>
1476         </varlistentry>
1477
1478         <varlistentry>
1479           <term>ldap server = <parameter>host</parameter>
1480           <type>(G)</type></term>
1481
1482           <listitem>
1483             <para>Name or IP address of your LDAP Server. This is only needed
1484             for explicit ACL support in order to be able to query LDAP for
1485             UUIDs.</para>
1486
1487             <para>You can use <citerefentry>
1488                 <refentrytitle>afpldaptest</refentrytitle>
1489
1490                 <manvolnum>1</manvolnum>
1491               </citerefentry> to syntactically check your config.</para>
1492           </listitem>
1493         </varlistentry>
1494
1495         <varlistentry>
1496           <term>ldap userbase = <parameter>base dn</parameter>
1497           <type>(G)</type></term>
1498
1499           <listitem>
1500             <para>DN of the user container in LDAP.</para>
1501           </listitem>
1502         </varlistentry>
1503
1504         <varlistentry>
1505           <term>ldap userscope = <parameter>scope</parameter>
1506           <type>(G)</type></term>
1507
1508           <listitem>
1509             <para>Search scope for user search: <option>base | one |
1510             sub</option></para>
1511           </listitem>
1512         </varlistentry>
1513
1514         <varlistentry>
1515           <term>ldap groupbase = <parameter>base dn</parameter>
1516           <type>(G)</type></term>
1517
1518           <listitem>
1519             <para>DN of the group container in LDAP.</para>
1520           </listitem>
1521         </varlistentry>
1522
1523         <varlistentry>
1524           <term>ldap groupscope = <parameter>scope</parameter>
1525           <type>(G)</type></term>
1526
1527           <listitem>
1528             <para>Search scope for user search: <option>base | one |
1529             sub</option></para>
1530           </listitem>
1531         </varlistentry>
1532
1533         <varlistentry>
1534           <term>ldap uuid attr = <parameter>dn</parameter>
1535           <type>(G)</type></term>
1536
1537           <listitem>
1538             <para>Name of the LDAP attribute with the UUIDs.</para>
1539
1540             <para>Note: this is used both for users and groups.</para>
1541           </listitem>
1542         </varlistentry>
1543
1544         <varlistentry>
1545           <term>ldap name attr = <parameter>dn</parameter>
1546           <type>(G)</type></term>
1547
1548           <listitem>
1549             <para>Name of the LDAP attribute with the users short name.</para>
1550           </listitem>
1551         </varlistentry>
1552
1553         <varlistentry>
1554           <term>ldap group attr = <parameter>dn</parameter>
1555           <type>(G)</type></term>
1556
1557           <listitem>
1558             <para>Name of the LDAP attribute with the groups short
1559             name.</para>
1560           </listitem>
1561         </varlistentry>
1562
1563         <varlistentry>
1564           <term>ldap uuid string = <parameter>STRING</parameter>
1565           <type>(G)</type></term>
1566
1567           <listitem>
1568             <para>Format of the uuid string in the directory. A series of x
1569             and -, where every x denotes a value 0-9a-f and every - is a
1570             separator.</para>
1571
1572             <para>Default: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</para>
1573           </listitem>
1574         </varlistentry>
1575
1576         <varlistentry>
1577           <term>ldap uuid encoding = <parameter>string | ms-guid (default:
1578           string)</parameter> <type>(G)</type></term>
1579
1580           <listitem>
1581             <para>Format of the UUID of the LDAP attribute, allows usage of
1582             the binary objectGUID fields from Active Directory. If left
1583             unspecified, string is the default, which passes through the ASCII
1584             UUID returned by most other LDAP stores. If set to ms-guid, the
1585             internal UUID representation is converted to and from the binary
1586             format used in the objectGUID attribute found on objects in Active
1587             Directory when interacting with the server.</para>
1588             <para>See also the options <option>ldap user filter</option> and
1589             <option>ldap group filter</option>.</para>
1590             <para><variablelist>
1591                 <varlistentry>
1592                   <term>string</term>
1593
1594                   <listitem>
1595                     <para>UUID is a string, use with eg OpenDirectory.</para>
1596                   </listitem>
1597                 </varlistentry>
1598
1599                 <varlistentry>
1600                   <term>ms-guid</term>
1601
1602                   <listitem>
1603                     <para>Binary objectGUID from Active Directory</para>
1604                   </listitem>
1605                 </varlistentry>
1606               </variablelist></para>
1607           </listitem>
1608         </varlistentry>
1609
1610         <varlistentry>
1611           <term>ldap user filter = <parameter>STRING (default: unused)</parameter>
1612           <type>(G)</type></term>
1613
1614           <listitem>
1615             <para>Optional LDAP filter that matches user objects. This is necessary for Active Directory
1616             environments where users and groups are stored in the same directory subtree.</para>
1617             <para>Recommended setting for Active Directory: <parameter>objectClass=user</parameter>.</para>
1618           </listitem>
1619         </varlistentry>
1620
1621         <varlistentry>
1622           <term>ldap group filter = <parameter>STRING (default: unused)</parameter>
1623           <type>(G)</type></term>
1624
1625           <listitem>
1626             <para>Optional LDAP filter that matches group objects. This is necessary for Active Directory
1627             environments where users and groups are stored in the same directory subtree.</para>
1628             <para>Recommended setting for Active Directory: <parameter>objectClass=group</parameter>.</para>
1629           </listitem>
1630         </varlistentry>
1631
1632       </variablelist>
1633     </refsect2>
1634   </refsect1>
1635
1636   <refsect1>
1637     <title>EXPLANATION OF VOLUME PARAMETERS</title>
1638
1639     <refsect2>
1640       <title>Parameters</title>
1641
1642       <para>The section name defines the volume name.
1643       No two volumes may have the same
1644       name. The volume name cannot contain the <keycode>':'</keycode>
1645       character. The volume name is mangled if it is very long. Mac charset
1646       volume name is limited to 27 characters. UTF8-MAC volume name is limited
1647       to volnamelen parameter.</para>
1648
1649       <variablelist>
1650         <varlistentry>
1651           <term>path = <replaceable>PATH</replaceable> <type>(V)</type></term>
1652
1653           <listitem>
1654             <para>The path name must be a fully qualified path name.</para>
1655           </listitem>
1656         </varlistentry>
1657
1658         <varlistentry>
1659           <term>appledouble = <replaceable>ea|v2</replaceable>
1660           <type>(V)</type></term>
1661
1662           <listitem>
1663             <para>Specify the format of the metadata files, which are used for
1664             saving Mac resource fork as well. Earlier versions used
1665             AppleDouble v2, the new default format is <emphasis
1666             role="bold">ea</emphasis>.</para>
1667           </listitem>
1668         </varlistentry>
1669
1670         <varlistentry>
1671           <term>vol size limit = <replaceable>size in MiB</replaceable>
1672           <type>(V)</type></term>
1673
1674           <listitem>
1675             <para>Useful for Time Machine: limits the reported volume size,
1676             thus preventing Time Machine from using the whole real disk space
1677             for backup. Example: "vol size limit = 1000" would limit the
1678             reported disk space to 1 GB. <emphasis role="bold">IMPORTANT:
1679             </emphasis> This is an approximated calculation taking into
1680             account the contents of Time Machine sparsebundle images. Therefor
1681             you MUST NOT use this volume to store other content when using
1682             this option, because it would NOT be accounted. The calculation
1683             works by reading the band size from the Info.plist XML file of the
1684             sparsebundle, reading the bands/ directory counting the number of
1685             band files, and then multiplying one with the other.</para>
1686           </listitem>
1687         </varlistentry>
1688
1689         <varlistentry>
1690           <term>valid users = <replaceable>user @group</replaceable>
1691           <type>(V)</type></term>
1692
1693           <listitem>
1694             <para>The allow option allows the users and groups that access a
1695             share to be specified. Users and groups are specified, delimited
1696             by spaces or commas. Groups are designated by a @ prefix. Names
1697             may be quoted in order to allow for spaces in names. Example:
1698             <programlisting>valid users = user "user 2" @group “@group 2"</programlisting></para>
1699           </listitem>
1700         </varlistentry>
1701
1702         <varlistentry>
1703           <term>invalid users = <replaceable>users/groups</replaceable>
1704           <type>(V)</type></term>
1705
1706           <listitem>
1707             <para>The deny option specifies users and groups who are not
1708             allowed access to the share. It follows the same format as the
1709             "valid users" option.</para>
1710           </listitem>
1711         </varlistentry>
1712
1713         <varlistentry>
1714           <term>hosts allow = <replaceable>IP host address/IP netmask bits [
1715           ... ]</replaceable> <type>(V)</type></term>
1716
1717           <listitem>
1718             <para>Only listed hosts and networks are allowed, all others are
1719             rejected. The network address may be specified either in
1720             dotted-decimal format for IPv4 or in hexadecimal format for
1721             IPv6.</para>
1722
1723             <para>Example: hosts allow = 10.1.0.0/16 10.2.1.100
1724             2001:0db8:1234::/48</para>
1725           </listitem>
1726         </varlistentry>
1727
1728         <varlistentry>
1729           <term>hosts deny = <replaceable>IP host address/IP netmask bits [
1730           ... ]</replaceable> <type>(V)</type></term>
1731
1732           <listitem>
1733             <para>Listed hosts and nets are rejected, all others are
1734             allowed.</para>
1735
1736             <para>Example: hosts deny = 192.168.100/24 10.1.1.1
1737             2001:db8::1428:57ab</para>
1738           </listitem>
1739         </varlistentry>
1740
1741         <varlistentry>
1742           <term>cnid scheme = <replaceable>backend</replaceable>
1743           <type>(V)</type></term>
1744
1745           <listitem>
1746             <para>set the CNID backend to be used for the volume, default is
1747             [@DEFAULT_CNID_SCHEME@] available schemes:
1748             [@compiled_backends@]</para>
1749           </listitem>
1750         </varlistentry>
1751
1752         <varlistentry>
1753           <term>ea = <replaceable>none|auto|sys|ad</replaceable>
1754           <type>(V)</type></term>
1755
1756           <listitem>
1757             <para>Specify how Extended Attributes<indexterm>
1758                 <primary>Extended Attributes</primary>
1759               </indexterm> are stored. <option>auto</option> is the
1760             default.</para>
1761
1762             <variablelist>
1763               <varlistentry>
1764                 <term>auto</term>
1765
1766                 <listitem>
1767                   <para>Try <option>sys</option> (by setting an EA on the
1768                   shared directory itself), fallback to <option>ad</option>.
1769                   Requires writable volume for performing test. "<option>read
1770                   only = yes</option>" overwrites <option>auto</option> with
1771                   <option>none</option>. Use explicit "<option>ea =
1772                   sys|ad</option>" for read-only volumes where
1773                   appropriate.</para>
1774                 </listitem>
1775               </varlistentry>
1776
1777               <varlistentry>
1778                 <term>sys</term>
1779
1780                 <listitem>
1781                   <para>Use filesystem Extended Attributes.</para>
1782                 </listitem>
1783               </varlistentry>
1784
1785               <varlistentry>
1786                 <term>ad</term>
1787
1788                 <listitem>
1789                   <para>Use files in <emphasis>.AppleDouble</emphasis>
1790                   directories.</para>
1791                 </listitem>
1792               </varlistentry>
1793
1794               <varlistentry>
1795                 <term>none</term>
1796
1797                 <listitem>
1798                   <para>No Extended Attributes support.</para>
1799                 </listitem>
1800               </varlistentry>
1801             </variablelist>
1802           </listitem>
1803         </varlistentry>
1804
1805         <varlistentry>
1806           <term>mac charset = <replaceable>CHARSET</replaceable>
1807           <type>(V)</type></term>
1808
1809           <listitem>
1810             <para>specifies the Mac client charset for this Volume, e.g.
1811             <emphasis>MAC_ROMAN</emphasis>, <emphasis>MAC_CYRILLIC</emphasis>.
1812             If not specified the global setting is applied. This setting is
1813             only required if you need volumes, where the Mac charset differs
1814             from the one globally set in the [Global] section.</para>
1815           </listitem>
1816         </varlistentry>
1817
1818         <varlistentry>
1819           <term>casefold = <option>option</option> <type>(V)</type></term>
1820
1821           <listitem>
1822             <para>The casefold option handles, if the case of filenames should
1823             be changed. The available options are:</para>
1824
1825             <para><option>tolower</option> - Lowercases names in both
1826             directions.</para>
1827
1828             <para><option>toupper</option> - Uppercases names in both
1829             directions.</para>
1830
1831             <para><option>xlatelower</option> - Client sees lowercase, server
1832             sees uppercase.</para>
1833
1834             <para><option>xlateupper</option> - Client sees uppercase, server
1835             sees lowercase.</para>
1836           </listitem>
1837         </varlistentry>
1838
1839         <varlistentry>
1840           <term>password = <replaceable>password</replaceable>
1841           <type>(V)</type></term>
1842
1843           <listitem>
1844             <para>This option allows you to set a volume password, which can
1845             be a maximum of 8 characters long (using ASCII strongly
1846             recommended at the time of this writing).</para>
1847           </listitem>
1848         </varlistentry>
1849
1850         <varlistentry>
1851           <term>file perm = <replaceable>mode</replaceable>
1852           <type>(V)</type></term>
1853
1854           <term>directory perm = <replaceable>mode</replaceable>
1855           <type>(V)</type></term>
1856
1857           <listitem>
1858             <para>Add(or) with the client requested permissions: <option>file
1859             perm</option> is for files only, <option>directory perm</option>
1860             is for directories only. Don't use with "<option>unix priv =
1861             no</option>".</para>
1862
1863             <example>
1864               <title>Volume for a collaborative workgroup</title>
1865
1866               <para><programlisting>file perm = 0660 directory perm =
1867               0770</programlisting></para>
1868             </example>
1869           </listitem>
1870         </varlistentry>
1871
1872         <varlistentry>
1873           <term>umask = <replaceable>mode</replaceable>
1874           <type>(V)</type></term>
1875
1876           <listitem>
1877             <para>set perm mask. Don't use with "<option>unix priv =
1878             no</option>".</para>
1879           </listitem>
1880         </varlistentry>
1881
1882         <varlistentry>
1883           <term>preexec = <replaceable>command</replaceable>
1884           <type>(V)</type></term>
1885
1886           <listitem>
1887             <para>command to be run when the volume is mounted, ignored for
1888             user defined volumes</para>
1889           </listitem>
1890         </varlistentry>
1891
1892         <varlistentry>
1893           <term>postexec = <replaceable>command</replaceable>
1894           <type>(V)</type></term>
1895
1896           <listitem>
1897             <para>command to be run when the volume is closed, ignored for
1898             user defined volumes</para>
1899           </listitem>
1900         </varlistentry>
1901
1902         <varlistentry>
1903           <term>root preexec = <replaceable>command</replaceable>
1904           <type>(V)</type></term>
1905
1906           <listitem>
1907             <para>command to be run as root when the volume is mounted,
1908             ignored for user defined volumes</para>
1909           </listitem>
1910         </varlistentry>
1911
1912         <varlistentry>
1913           <term>root postexec = <replaceable>command</replaceable>
1914           <type>(V)</type></term>
1915
1916           <listitem>
1917             <para>command to be run as root when the volume is closed, ignored
1918             for user defined volumes</para>
1919           </listitem>
1920         </varlistentry>
1921
1922         <varlistentry>
1923           <term>rolist = <option>users/groups</option> <type>(V)</type></term>
1924
1925           <listitem>
1926             <para>Allows certain users and groups to have read-only access to
1927             a share. This follows the allow option format.</para>
1928           </listitem>
1929         </varlistentry>
1930
1931         <varlistentry>
1932           <term>rwlist = <replaceable>users/groups</replaceable>
1933           <type>(V)</type></term>
1934
1935           <listitem>
1936             <para>Allows certain users and groups to have read/write access to
1937             a share. This follows the allow option format.</para>
1938           </listitem>
1939         </varlistentry>
1940
1941         <varlistentry>
1942           <term>veto files = <replaceable>vetoed names</replaceable>
1943           <type>(V)</type></term>
1944
1945           <listitem>
1946             <para>hide files and directories,where the path matches one of the
1947             '/' delimited vetoed names. The veto string must always be
1948             terminated with a '/', eg. "veto files = veto1/", "veto files =
1949             veto1/veto2/".</para>
1950           </listitem>
1951         </varlistentry>
1952       </variablelist>
1953     </refsect2>
1954
1955     <refsect2>
1956       <title>Volume options</title>
1957
1958       <para>Boolean volume options.</para>
1959
1960       <variablelist>
1961         <varlistentry>
1962           <term>acls = <replaceable>BOOLEAN</replaceable> (default:
1963           <emphasis>yes</emphasis>) <type>(V)</type></term>
1964
1965           <listitem>
1966             <para>Whether to flag volumes as supporting ACLs. If ACL support
1967             is compiled in, this is yes by default.</para>
1968           </listitem>
1969         </varlistentry>
1970
1971         <varlistentry>
1972           <term>case sensitive = <replaceable>BOOLEAN</replaceable> (default:
1973           <emphasis>yes</emphasis>) <type>(V)</type></term>
1974
1975           <listitem>
1976             <para>Whether to flag volumes as supporting case-sensitive
1977             filenames. If the filesystem is case-insensitive, set to no.
1978             However, it is not fully verified.</para>
1979             <note>
1980               <para>In spite of being case sensitive as a matter of fact,
1981               netatalk 3.1.3 and earlier did not notify kCaseSensitive flag
1982               to the client. Starting with 3.1.4, it is notified correctly by
1983               default.</para>
1984             </note>
1985           </listitem>
1986         </varlistentry>
1987
1988         <varlistentry>
1989           <term>cnid dev = <replaceable>BOOLEAN</replaceable> (default:
1990           <emphasis>yes</emphasis>) <type>(V)</type></term>
1991
1992           <listitem>
1993             <para>Whether to use the device number in the CNID backends. Helps
1994             when the device number is not constant across a reboot, eg
1995             cluster, ...</para>
1996           </listitem>
1997         </varlistentry>
1998
1999         <varlistentry>
2000           <term>convert appledouble = <replaceable>BOOLEAN</replaceable>
2001           (default: <emphasis>yes</emphasis>) <type>(V)</type></term>
2002
2003           <listitem>
2004             <para>Whether automatic conversion from <option>appledouble =
2005             v2</option> to <option>appledouble = ea</option> is performed when
2006             accessing filesystems from clients. This is generally useful, but
2007             costs some performance. It's recommendable to run
2008             <command>dbd</command> on volumes and do the conversion with that.
2009             Then this option can be set to no.</para>
2010           </listitem>
2011         </varlistentry>
2012
2013         <varlistentry>
2014           <term>delete veto files = <replaceable>BOOLEAN</replaceable>
2015           (default: <emphasis>no</emphasis>) <type>(V)</type></term>
2016
2017           <listitem>
2018             <para>This option is used when Netatalk is attempting to delete a
2019             directory that contains one or more vetoed files or directories
2020             (see the veto files option). If this option is set to no (the
2021             default) then if a directory contains any non-vetoed files or
2022             directories then the directory delete will fail. This is usually
2023             what you want.</para>
2024             <para>If this option is set to yes, then Netatalk will attempt to
2025             recursively delete any files and directories within the vetoed
2026             directory.</para>
2027           </listitem>
2028         </varlistentry>
2029
2030         <varlistentry>
2031           <term>follow symlinks = <replaceable>BOOLEAN</replaceable> (default:
2032           <emphasis>no</emphasis>) <type>(V)</type></term>
2033
2034           <listitem>
2035             <para>The default setting is false thus symlinks are not followed
2036             on the server. This is the same behaviour as OS X's AFP server.
2037             Setting the option to true causes afpd to follow symlinks on the
2038             server. symlinks may point outside of the AFP volume, currently
2039             afpd doesn't do any checks for "wide symlinks".</para>
2040             <note>
2041               <para>This option will subtly break when the symlinks point
2042               across filesystem boundaries.</para>
2043             </note>
2044           </listitem>
2045         </varlistentry>
2046
2047         <varlistentry>
2048           <term>invisible dots = <replaceable>BOOLEAN</replaceable> (default:
2049           <emphasis>no</emphasis>) <type>(V)</type></term>
2050
2051           <listitem>
2052             <para>make dot files invisible. WARNING: enabling this option will
2053               lead to unwanted sideeffects were OS X applications when saving
2054               files to a temporary file starting with a dot first, then renaming
2055               the temp file to its final name, result in the saved file being
2056               invisible. The only thing this option is useful for is making
2057               files that start with a dot invisible on Mac OS 9. It's
2058               completely useless on Mac OS X, as both in Finder and in Terminal
2059               files starting with a dot are hidden anyway.</para>
2060           </listitem>
2061         </varlistentry>
2062
2063         <varlistentry>
2064           <term>network ids = <replaceable>BOOLEAN</replaceable> (default:
2065           <emphasis>yes</emphasis>) <type>(V)</type></term>
2066
2067           <listitem>
2068             <para>Whether the server support network ids. Setting this to
2069             <emphasis>no</emphasis> will result in the client not using ACL
2070             AFP functions.</para>
2071           </listitem>
2072         </varlistentry>
2073
2074         <varlistentry>
2075           <term>preexec close = <replaceable>BOOLEAN</replaceable> (default:
2076           <emphasis>no</emphasis>) <type>(V)</type></term>
2077
2078           <listitem>
2079             <para>A non-zero return code from preexec close the volume being
2080             immediately, preventing clients to mount/see the volume in
2081             question.</para>
2082           </listitem>
2083         </varlistentry>
2084
2085         <varlistentry>
2086           <term>read only = <replaceable>BOOLEAN</replaceable> (default:
2087           <emphasis>no</emphasis>) <type>(V)</type></term>
2088
2089           <listitem>
2090             <para>Specifies the share as being read only for all users.
2091             Overwrites <option>ea = auto</option> with <option>ea =
2092             none</option></para>
2093           </listitem>
2094         </varlistentry>
2095
2096         <varlistentry>
2097           <term>root preexec close= <replaceable>BOOLEAN</replaceable>
2098           (default: <emphasis>no</emphasis>) <type>(V)</type></term>
2099
2100           <listitem>
2101             <para>A non-zero return code from root_preexec closes the volume
2102             immediately, preventing clients to mount/see the volume in
2103             question.</para>
2104           </listitem>
2105         </varlistentry>
2106
2107         <varlistentry>
2108           <term>search db = <replaceable>BOOLEAN</replaceable> (default:
2109           <emphasis>no</emphasis>) <type>(V)</type></term>
2110
2111           <listitem>
2112             <para>Use fast CNID database namesearch instead of slow recursive
2113             filesystem search. Relies on a consistent CNID database, ie Samba
2114             or local filesystem access lead to inaccurate or wrong results.
2115             Works only for "dbd" CNID db volumes.</para>
2116           </listitem>
2117         </varlistentry>
2118
2119         <varlistentry>
2120           <term>stat vol = <replaceable>BOOLEAN</replaceable> (default:
2121           <emphasis>yes</emphasis>) <type>(V)</type></term>
2122
2123           <listitem>
2124             <para>Whether to stat volume path when enumerating volumes list,
2125             useful for automounting or volumes created by a preexec
2126             script.</para>
2127           </listitem>
2128         </varlistentry>
2129
2130         <varlistentry>
2131           <term>time machine = <replaceable>BOOLEAN</replaceable> (default:
2132           <emphasis>no</emphasis>) <type>(V)</type></term>
2133
2134           <listitem>
2135             <para>Whether to enable Time Machine support for this
2136             volume.</para>
2137           </listitem>
2138         </varlistentry>
2139
2140         <varlistentry>
2141           <term>unix priv = <replaceable>BOOLEAN</replaceable> (default:
2142           <emphasis>yes</emphasis>) <type>(V)</type></term>
2143
2144           <listitem>
2145             <para>Whether to use AFP3 UNIX privileges. This should be set for
2146             OS X clients. See also: <option>file perm</option>,
2147             <option>directory perm</option> and <option>umask</option>.</para>
2148           </listitem>
2149         </varlistentry>
2150       </variablelist>
2151     </refsect2>
2152   </refsect1>
2153
2154   <refsect1>
2155     <title>CNID backends</title>
2156
2157     <para>The AFP protocol mostly refers to files and directories by ID and
2158     not by name. Netatalk needs a way to store these ID's in a persistent way,
2159     to achieve this several different CNID backends are available. The CNID
2160     Databases are by default located in the
2161     <filename>@localstatedir@/netatalk/CNID/(volumename)/.AppleDB/</filename>
2162     directory.</para>
2163
2164     <variablelist>
2165       <varlistentry>
2166         <term>cdb</term>
2167
2168         <listitem>
2169           <para>"Concurrent database", backend is based on Oracle Berkley DB.
2170           With this backend several <command>afpd</command> daemons access the
2171           CNID database directly. Berkeley DB locking is used to synchronize
2172           access, if more than one <command>afpd</command> process is active
2173           for a volume. The drawback is, that the crash of a single
2174           <command>afpd</command> process might corrupt the database.</para>
2175         </listitem>
2176       </varlistentry>
2177
2178       <varlistentry>
2179         <term>dbd</term>
2180
2181         <listitem>
2182           <para>Access to the CNID database is restricted to the
2183           <command>cnid_metad</command> daemon process.
2184           <command>afpd</command> processes communicate with the daemon for
2185           database reads and updates. If built with Berkeley DB transactions
2186           the probability for database corruption is practically zero, but
2187           performance can be slower than with <option>cdb</option></para>
2188         </listitem>
2189       </varlistentry>
2190
2191       <varlistentry>
2192         <term>last</term>
2193
2194         <listitem>
2195           <para>This backend is an exception, in terms of ID persistency. ID's
2196           are only valid for the current session. This is basically what
2197           <command>afpd</command> did in the 1.5 (and 1.6) versions. This
2198           backend is still available, as it is useful for e.g. sharing cdroms.
2199           Starting with Netatalk 3.0, it becomes the <emphasis>read only
2200           mode</emphasis> automatically.</para>
2201
2202           <para><emphasis role="bold">Warning</emphasis>: It is
2203           <emphasis>NOT</emphasis> recommended to use this backend for volumes
2204           anymore, as <command>afpd</command> now relies heavily on a
2205           persistent ID database. Aliases will likely not work and filename
2206           mangling is not supported.</para>
2207         </listitem>
2208       </varlistentry>
2209     </variablelist>
2210
2211     <para>Even though <command>./configure --help</command> might show that
2212     there are other CNID backends available, be warned those are likely broken
2213     or mainly used for testing. Don't use them unless you know what you're
2214     doing, they may be removed without further notice from future
2215     versions.</para>
2216   </refsect1>
2217
2218   <refsect1>
2219     <title>Charset options</title>
2220
2221     <para>With OS X Apple introduced the AFP3 protocol. One of the most
2222     important changes was that AFP3 uses unicode names encoded as UTF-8
2223     decomposed. Previous AFP/OS versions used codepages, like MacRoman,
2224     MacCentralEurope, etc.</para>
2225
2226     <para><command>afpd</command> needs a way to preserve extended Macintosh
2227     characters, or characters illegal in unix filenames, when saving files on
2228     a unix filesystem. Earlier versions used the the so called CAP encoding.
2229     An extended character (&gt;0x7F) would be converted to a :xx sequence,
2230     e.g. the Apple Logo (MacRoman: 0xF0) was saved as <literal>:f0</literal>.
2231     Some special characters will be converted as to :xx notation as well.
2232     '<keycode>/</keycode>' will be encoded to <literal>:2f</literal>, if
2233     <option>usedots</option> is not specified, a leading dot
2234     '<keycode>.</keycode>' will be encoded as <literal>:2e</literal>.</para>
2235
2236     <para>This version now uses UTF-8 as the default encoding for names.
2237     '<keycode>/</keycode>' will be converted to '<keycode>:</keycode>'.</para>
2238
2239     <para>The <option>vol charset</option> option will allow you to select
2240     another volume encoding. E.g. for western users another useful setting
2241     could be vol charset ISO-8859-15. <command>afpd</command> will accept any
2242     <citerefentry>
2243         <refentrytitle><command>iconv</command></refentrytitle>
2244
2245         <manvolnum>1</manvolnum>
2246       </citerefentry> provided charset. If a character cannot be converted
2247     from the <option>mac charset</option> to the selected <option>vol
2248     charset</option>, afpd will save it as a CAP encoded character. For AFP3
2249     clients, <command>afpd</command> will convert the UTF-8<indexterm>
2250         <primary>UTF8</primary>
2251
2252         <secondary>afpd's vol charset setting</secondary>
2253       </indexterm><indexterm>
2254         <primary>UTF8-MAC</primary>
2255
2256         <secondary>afpd's vol charset setting</secondary>
2257       </indexterm><indexterm>
2258         <primary>ISO-8859-15</primary>
2259
2260         <secondary>afpd's vol charset setting</secondary>
2261       </indexterm><indexterm>
2262         <primary>ISO-8859-1</primary>
2263
2264         <secondary>afpd's vol charset setting</secondary>
2265       </indexterm> character to <option>mac charset</option> first. If this
2266     conversion fails, you'll receive a -50 error on the mac.</para>
2267
2268     <para><emphasis>Note</emphasis>: Whenever you can, please stick with the
2269     default UTF-8 volume format.</para>
2270   </refsect1>
2271
2272   <refsect1>
2273     <title>SEE ALSO</title>
2274
2275     <para><citerefentry>
2276         <refentrytitle>afpd</refentrytitle>
2277
2278         <manvolnum>8</manvolnum>
2279       </citerefentry>, <citerefentry>
2280         <refentrytitle>afppasswd</refentrytitle>
2281
2282         <manvolnum>5</manvolnum>
2283       </citerefentry>, <citerefentry>
2284         <refentrytitle>afp_signature.conf</refentrytitle>
2285
2286         <manvolnum>5</manvolnum>
2287       </citerefentry>, <citerefentry>
2288         <refentrytitle>extmap.conf</refentrytitle>
2289
2290         <manvolnum>5</manvolnum>
2291       </citerefentry>, <citerefentry>
2292         <refentrytitle>cnid_metad</refentrytitle>
2293
2294         <manvolnum>8</manvolnum>
2295       </citerefentry></para>
2296   </refsect1>
2297 </refentry>