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">05 Jun 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>
 819                 <option>ignore</option> - UNIX chmod() requests are completely ignored
 820                       </para></listitem>
 821               <listitem><para>
 822                 <option>preserve</option> - preserve ZFS ACEs for
 823                 named users and groups or POSIX ACL group mask
 824                       </para></listitem>
 825               <listitem><para>
 826                 <option>simple</option> - just to a chmod() as
 827                 requested without any extra steps
 828                       </para></listitem>
 829                     </itemizedlist>
 830           </listitem>
 831         </varlistentry>
 832
 833         <varlistentry>
 834           <term>close vol = <replaceable>BOOLEAN</replaceable> (default:
 835           <emphasis>no</emphasis>) <type>(G)</type></term>
 836
 837           <listitem>
 838             <para>Whether to close volumes possibly opened by clients when
 839             they're removed from the configuration and the configuration is
 840             reloaded.</para>
 841           </listitem>
 842         </varlistentry>
 843
 844         <varlistentry>
 845           <term>cnid mysql host = <replaceable>MySQL server address</replaceable>
 846           <type>(G)</type></term>
 847
 848           <listitem>
 849             <para>name or address of a MySQL server for use with the mysql CNID
 850             backend.</para>
 851           </listitem>
 852         </varlistentry>
 853
 854         <varlistentry>
 855           <term>cnid mysql user = <replaceable>MySQL user</replaceable>
 856           <type>(G)</type></term>
 857
 858           <listitem>
 859             <para>MySQL user for authentication with the server.</para>
 860           </listitem>
 861         </varlistentry>
 862
 863         <varlistentry>
 864           <term>cnid mysql pw = <replaceable>password</replaceable>
 865           <type>(G)</type></term>
 866
 867           <listitem>
 868             <para>Password for MySQL server.</para>
 869           </listitem>
 870         </varlistentry>
 871
 872         <varlistentry>
 873           <term>cnid mysql db = <replaceable>database name</replaceable>
 874           <type>(G)</type></term>
 875
 876           <listitem>
 877             <para>Name of an existing database for which the specified user
 878             has full privileges.</para>
 879           </listitem>
 880         </varlistentry>
 881
 882         <varlistentry>
 883           <term>cnid server = <replaceable>ipaddress[:port]</replaceable>
 884           <type>(G)/(V)</type></term>
 885
 886           <listitem>
 887             <para>Specifies the IP address and port of a cnid_metad server,
 888             required for CNID dbd backend. Defaults to localhost:4700. The
 889             network address may be specified either in dotted-decimal format
 890             for IPv4 or in hexadecimal format for IPv6.-</para>
 891           </listitem>
 892         </varlistentry>
 893
 894         <varlistentry>
 895           <term>dbus daemon = <parameter>path</parameter>
 896           <type>(G)</type></term>
 897
 898           <listitem>
 899             <para>Sets the path to dbus-daemon binary used by Spotlight feature.
 900             The default is <filename>/bin/dbus-daemon</filename>.</para>
 901           </listitem>
 902         </varlistentry>
 903
 904         <varlistentry>
 905           <term>dircachesize = <replaceable>number</replaceable>
 906           <type>(G)</type></term>
 907
 908           <listitem>
 909             <para>Maximum possible entries in the directory cache. The cache
 910             stores directories and files. It is used to cache the full path to
 911             directories and CNIDs which considerably speeds up directory
 912             enumeration.</para>
 913
 914             <para>Default size is 8192, maximum size is 131072. Given value is
 915             rounded up to nearest power of 2. Each entry takes about 100
 916             bytes, which is not much, but remember that every afpd child
 917             process for every connected user has its cache.</para>
 918           </listitem>
 919         </varlistentry>
 920
 921         <varlistentry>
 922           <term>extmap file = <parameter>path</parameter>
 923           <type>(G)</type></term>
 924
 925           <listitem>
 926             <para>Sets the path to the file which defines file extension
 927             type/creator mappings. (default is @pkgconfdir@/extmap.conf).</para>
 928           </listitem>
 929         </varlistentry>
 930
 931         <varlistentry>
 932           <term>force xattr with sticky bit =
 933           <replaceable>BOOLEAN</replaceable> (default:
 934           <emphasis>no</emphasis>) <type>(G/V)</type></term>
 935
 936           <listitem>
 937             <para>Writing metadata xattr on directories with the
 938             sticky bit set may fail even though we may have write
 939             access to a directory, because if the sticky bit is set
 940             only the owner is allowed to write xattrs.</para>
 941
 942             <para>By enabling this option Netatalk will write the
 943             metadata xattr as root.</para>
 944           </listitem>
 945         </varlistentry>
 946
 947         <varlistentry>
 948           <term>guest account = <replaceable>name</replaceable>
 949           <type>(G)</type></term>
 950
 951           <listitem>
 952             <para>Specifies the user that guests should use (default is
 953             "nobody"). The name should be quoted.</para>
 954           </listitem>
 955         </varlistentry>
 956
 957         <varlistentry>
 958           <term>home name = <replaceable>name</replaceable>
 959           <type>(H)</type></term>
 960
 961           <listitem>
 962             <para>AFP user home volume name. The default is <emphasis>user's
 963             home</emphasis>.</para>
 964           </listitem>
 965         </varlistentry>
 966
 967         <varlistentry>
 968           <term>ignored attributes = <replaceable>all | nowrite | nodelete | norename</replaceable>
 969           <type>(G)/(V)</type></term>
 970
 971           <listitem>
 972             <para>Speficy a set of file and directory attributes that shall
 973             be ignored by the server, <option>all</option> includes all
 974             the other options.</para>
 975             <para>In OS X when the Finder sets a lock on a file/directory or you
 976             set the BSD uchg flag in the Terminal, all three attributes are
 977             used. Thus in order to ignore the Finder lock/BSD uchg flag, add
 978             set <emphasis>ignored attributes = all</emphasis>.</para>
 979           </listitem>
 980         </varlistentry>
 981
 982         <varlistentry>
 983           <term>login message = <replaceable>message</replaceable>
 984           <type>(G)/(V)</type></term>
 985
 986           <listitem>
 987             <para>Sets a message to be displayed when clients logon to the
 988             server. The message should be in <option>unix charset</option> and
 989             should be quoted. Extended characters are allowed.</para>
 990           </listitem>
 991         </varlistentry>
 992
 993         <varlistentry>
 994           <term>mimic model = <replaceable>model</replaceable>
 995           <type>(G)</type></term>
 996
 997           <listitem>
 998             <para>Specifies the icon model that appears on clients. Defaults
 999             to off. Note that afpd must support Zeroconf.
1000             Examples: RackMac (same as Xserve), PowerBook, PowerMac,
1001             Macmini, iMac, MacBook, MacBookPro, MacBookAir, MacPro,
1002             AppleTV1,1, AirPort.</para>
1003           </listitem>
1004         </varlistentry>
1005
1006         <varlistentry>
1007           <term>signature = &lt;text&gt; <type>(G)</type></term>
1008
1009           <listitem>
1010             <para>Specify a server signature. The maximum length is 16
1011             characters. This option is useful for clustered environments, to
1012             provide fault isolation etc. By default, afpd generate signature
1013             and saving it to
1014             <filename>@localstatedir@/netatalk/afp_signature.conf</filename>
1015             automatically (based on random number). See also
1016             asip-status.pl(1).</para>
1017           </listitem>
1018         </varlistentry>
1019
1020         <varlistentry>
1021           <term>solaris share reservations =
1022           <replaceable>BOOLEAN</replaceable> (default:
1023           <emphasis>yes</emphasis>) <type>(G)</type></term>
1024
1025           <listitem>
1026             <para>Use share reservations on Solaris. Solaris CIFS server uses
1027             this too, so this makes a lock coherent multi protocol
1028             server.</para>
1029           </listitem>
1030         </varlistentry>
1031
1032         <varlistentry>
1033           <term>sparql results limit =
1034           <replaceable>NUMBER</replaceable> (default:
1035           <emphasis>UNLIMITED</emphasis>) <type>(G)</type></term>
1036
1037           <listitem>
1038             <para>Impose a limit on the number of results queried from Tracker
1039             via SPARQL queries.</para>
1040           </listitem>
1041         </varlistentry>
1042
1043         <varlistentry>
1044           <term>spotlight =
1045           <replaceable>BOOLEAN</replaceable> (default:
1046           <emphasis>no</emphasis>) <type>(G)/(V)</type></term>
1047
1048           <listitem>
1049             <para>Whether to enable Spotlight searches. Note: once the global
1050             option is enabled, any volume that is not enabled won't be
1051             searchable at all. See also <emphasis>dbus daemon</emphasis>
1052             option.</para>
1053           </listitem>
1054         </varlistentry>
1055
1056         <varlistentry>
1057           <term>spotlight attributes =
1058           <replaceable>COMMA SEPERATED STRING</replaceable> (default:
1059           <emphasis>EMPTY</emphasis>) <type>(G)</type></term>
1060
1061           <listitem>
1062             <para>A list of attributes that are allowed to be used in
1063             Spotlight searches. By default all attributes can be
1064             searched, passing a string limits attributes to elements
1065             of the string. Example: <programlisting>spotlight
1066             attributes = *,kMDItemTextContent</programlisting>
1067             </para>
1068           </listitem>
1069         </varlistentry>
1070
1071         <varlistentry>
1072           <term>spotlight expr =
1073           <replaceable>BOOLEAN</replaceable> (default:
1074           <emphasis>yes</emphasis>) <type>(G)</type></term>
1075
1076           <listitem>
1077             <para>Whether to allow the use of logic expression in
1078             searches.</para>
1079           </listitem>
1080         </varlistentry>
1081
1082         <varlistentry>
1083           <term>start dbus =
1084           <replaceable>BOOLEAN</replaceable> (default:
1085           <emphasis>yes</emphasis>) <type>(G)</type></term>
1086
1087           <listitem>
1088             <para>Whether to start a dbus instance for use with Tracker.</para>
1089           </listitem>
1090         </varlistentry>
1091
1092         <varlistentry>
1093           <term>start tracker =
1094           <replaceable>BOOLEAN</replaceable> (default:
1095           <emphasis>yes</emphasis>) <type>(G)</type></term>
1096
1097           <listitem>
1098             <para>Whether to start Tracker with
1099             <emphasis>tracker-control -s</emphasis>.</para>
1100           </listitem>
1101         </varlistentry>
1102
1103         <varlistentry>
1104           <term>veto message = <replaceable>BOOLEAN</replaceable> (default:
1105           <emphasis>no</emphasis>) <type>(G)</type></term>
1106
1107           <listitem>
1108             <para>Send optional AFP messages for vetoed files. Then whenever a
1109             client tries to access any file or directory with a vetoed name,
1110             it will be sent an AFP message indicating the name and the
1111             directory.</para>
1112           </listitem>
1113         </varlistentry>
1114
1115         <varlistentry>
1116           <term>vol dbpath = <replaceable>path</replaceable>
1117           <type>(G)/(V)</type></term>
1118
1119           <listitem>
1120             <para>Sets the database information to be stored in path. You have
1121             to specify a writable location, even if the volume is read only.
1122             The default is
1123             <filename>@localstatedir@/netatalk/CNID/$v/</filename>.</para>
1124           </listitem>
1125         </varlistentry>
1126
1127         <varlistentry>
1128           <term>vol dbnest = <replaceable>BOOLEAN</replaceable> (default:
1129           <emphasis>no</emphasis>) <type>(G)</type></term>
1130
1131           <listitem>
1132             <para>Setting this option to true brings back Netatalk 2
1133             behaviour of storing the CNID database in a folder called
1134             .AppleDB inside the volume root of each share.</para>
1135           </listitem>
1136         </varlistentry>
1137
1138         <varlistentry>
1139           <term>volnamelen = <replaceable>number</replaceable>
1140           <type>(G)</type></term>
1141
1142           <listitem>
1143             <para>Max length of UTF8-MAC volume name for Mac OS X. Note that
1144             Hangul is especially sensitive to this.</para>
1145
1146             <para><programlisting> 73: limit of Mac OS X 10.1 80: limit of Mac
1147             OS X 10.4/10.5 (default) 255: limit of recent Mac OS
1148             X</programlisting> Mac OS 9 and earlier are not influenced by
1149             this, because Maccharset volume name is always limited to 27
1150             bytes.</para>
1151           </listitem>
1152         </varlistentry>
1153
1154         <varlistentry>
1155           <term>vol preset = <replaceable>name</replaceable>
1156           <type>(G)/(V)</type></term>
1157
1158           <listitem>
1159             <para>Use section <option>name</option> as option preset for all
1160             volumes (when set in the [Global] section) or for one volume (when
1161             set in that volume's section).</para>
1162           </listitem>
1163         </varlistentry>
1164       </variablelist>
1165     </refsect2>
1166
1167     <refsect2>
1168       <title>Logging Options</title>
1169
1170       <variablelist>
1171         <varlistentry>
1172           <term>log file = <replaceable>logfile</replaceable>
1173           <type>(G)</type></term>
1174
1175           <listitem>
1176             <para>If not specified Netatalk logs to syslogs daemon facility.
1177             Otherwise it logs to <option>logfile</option>.</para>
1178           </listitem>
1179         </varlistentry>
1180
1181         <varlistentry>
1182           <term>log level = <replaceable>type:level [type:level
1183           ...]</replaceable> <type>(G)</type></term>
1184
1185           <term>log level = <replaceable>type:level,[type:level,
1186           ...]</replaceable> <type>(G)</type></term>
1187
1188           <listitem>
1189             <para>Specify that any message of a loglevel up to the given
1190             <option>log level</option> should be logged.</para>
1191
1192             <para>By default afpd logs to syslog with a default logging setup
1193             equivalent to <option>default:note</option></para>
1194
1195             <para>logtypes: default, afpdaemon, logger, uamsdaemon</para>
1196
1197             <para>loglevels: severe, error, warn, note, info, debug, debug6,
1198             debug7, debug8, debug9, maxdebug</para>
1199
1200             <note>
1201               <para>Both logtype and loglevels are case insensitive.</para>
1202             </note>
1203           </listitem>
1204         </varlistentry>
1205       </variablelist>
1206     </refsect2>
1207
1208     <refsect2 id="fceconf">
1209       <title>Filesystem Change Events (FCE<indexterm>
1210           <primary>FCE</primary>
1211         </indexterm>)</title>
1212
1213       <para>Netatalk includes a nifty filesystem change event mechanism where
1214       afpd processes notify interested listeners about certain filesystem
1215       event by UDP network datagrams.</para>
1216
1217       <para>The following FCE events are defined:</para>
1218
1219       <itemizedlist>
1220         <listitem><para>file modification (<option>fmod</option>)</para></listitem>
1221         <listitem><para>file deletion (<option>fdel</option>)</para></listitem>
1222         <listitem><para>directory deletion (<option>ddel</option>)</para></listitem>
1223         <listitem><para>file creation (<option>fcre</option>)</para></listitem>
1224         <listitem><para>directory creation (<option>dcre</option>)</para></listitem>
1225         <listitem><para>file move or rename (<option>fmov</option>)</para></listitem>
1226         <listitem><para>directory move or rename (<option>dmov</option>)</para></listitem>
1227         <listitem><para>login (<option>login</option>)</para></listitem>
1228         <listitem><para>logout (<option>logout</option>)</para></listitem>
1229       </itemizedlist>
1230
1231       <variablelist>
1232         <varlistentry>
1233           <term>fce listener = <replaceable>host[:port]</replaceable>
1234           <type>(G)</type></term>
1235
1236           <listitem>
1237             <para>Enables sending FCE events to the specified
1238             <parameter>host</parameter>, default <parameter>port</parameter>
1239             is 12250 if not specified. Specifying multiple listeners is done
1240             by having this option once for each of them.</para>
1241           </listitem>
1242         </varlistentry>
1243
1244         <varlistentry>
1245           <term>fce version = <replaceable>1|2</replaceable>
1246           <type>(G)</type></term>
1247
1248           <listitem>
1249             <para>FCE protocol version, default is 1. You need version
1250             2 for the fmov, dmov, login or logout events.</para>
1251           </listitem>
1252         </varlistentry>
1253
1254         <varlistentry>
1255           <term>fce events =
1256           <replaceable>fmod,fdel,ddel,fcre,dcre,fmov,dmov,login,logout</replaceable>
1257           <type>(G)</type></term>
1258
1259           <listitem>
1260             <para>Specifies which FCE events are active, default is
1261             <parameter>fmod,fdel,ddel,fcre,dcre</parameter>.</para>
1262           </listitem>
1263         </varlistentry>
1264
1265         <varlistentry>
1266           <term>fce coalesce = <replaceable>all|delete|create</replaceable>
1267           <type>(G)</type></term>
1268
1269           <listitem>
1270             <para>Coalesce FCE events.</para>
1271           </listitem>
1272         </varlistentry>
1273
1274         <varlistentry>
1275           <term>fce holdfmod = <replaceable>seconds</replaceable>
1276           <type>(G)</type></term>
1277
1278           <listitem>
1279             <para>This determines the time delay in seconds which is always
1280             waited if another file modification for the same file is done by a
1281             client before sending an FCE file modification event (fmod). For
1282             example saving a file in Photoshop would generate multiple events
1283             by itself because the application is opening, modifying and
1284             closing a file multiple times for every "save". Default: 60
1285             seconds.</para>
1286           </listitem>
1287         </varlistentry>
1288
1289         <varlistentry>
1290           <term>fce ignore names = <replaceable>NAME[/NAME2/...]</replaceable>
1291           <type>(G)</type></term>
1292
1293           <listitem>
1294             <para>Slash delimited list of filenames for which FCE
1295             events shall not be generated. Default: .DS_Store.</para>
1296           </listitem>
1297         </varlistentry>
1298
1299         <varlistentry>
1300           <term>fce notify script = <replaceable>PATH</replaceable>
1301           <type>(G)</type></term>
1302
1303           <listitem>
1304             <para>Script which will be executed for every FCE event,
1305             see contrib/shell_utils/fce_ev_script.shfrom the Netatalk
1306             sources for an example script.</para>
1307           </listitem>
1308         </varlistentry>
1309
1310       </variablelist>
1311     </refsect2>
1312
1313     <refsect2>
1314       <title>Debug Parameters</title>
1315
1316       <para>These options are useful for debugging only.</para>
1317
1318       <variablelist>
1319         <varlistentry>
1320           <term>tickleval = <replaceable>number</replaceable>
1321           <type>(G)</type></term>
1322
1323           <listitem>
1324             <para>Sets the tickle timeout interval (in seconds). Defaults to
1325             30.</para>
1326           </listitem>
1327         </varlistentry>
1328
1329         <varlistentry>
1330           <term>timeout = <replaceable>number</replaceable>
1331           <type>(G)</type></term>
1332
1333           <listitem>
1334             <para>Specify the number of tickles to send before timing out a
1335             connection. The default is 4, therefore a connection will timeout
1336             after 2 minutes.</para>
1337           </listitem>
1338         </varlistentry>
1339
1340         <varlistentry>
1341           <term>client polling = <replaceable>BOOLEAN</replaceable> (default:
1342           <emphasis>no</emphasis>) <type>(G)</type></term>
1343
1344           <listitem>
1345             <para>With this option enabled, afpd won't advertise that it is
1346             capable of server notifications, so that connected clients poll
1347             the server every 10 seconds to detect changes in opened server
1348             windows. <emphasis>Note</emphasis>: Depending on the number of
1349             simultaneously connected clients and the network's speed, this can
1350             lead to a significant higher load on your network!</para>
1351
1352             <para>Do not use this option any longer as present Netatalk
1353             correctly supports server notifications, allowing connected
1354             clients to update folder listings in case another client changed
1355             the contents.</para>
1356           </listitem>
1357         </varlistentry>
1358       </variablelist>
1359     </refsect2>
1360
1361     <refsect2 id="acl_options">
1362       <title>Options for ACL handling</title>
1363
1364       <para>By default, the effective permission of the authenticated user are
1365       only mapped to the mentioned UARights permission structure, not the UNIX
1366       mode. You can adjust this behaviour with the configuration option
1367       <option>mac acls</option>:</para>
1368
1369       <variablelist id="map_acls">
1370         <varlistentry>
1371           <term>map acls = <parameter>none|rights|mode</parameter>
1372           <type>(G)</type></term>
1373
1374           <listitem>
1375             <para><variablelist>
1376                 <varlistentry>
1377                   <term>none</term>
1378
1379                   <listitem>
1380                     <para>no mapping of ACLs </para>
1381                   </listitem>
1382                 </varlistentry>
1383
1384                 <varlistentry>
1385                   <term>rights</term>
1386
1387                   <listitem>
1388                     <para>effective permissions are mapped to UARights
1389                     structure. This is the default.</para>
1390                   </listitem>
1391                 </varlistentry>
1392
1393                 <varlistentry>
1394                   <term>mode</term>
1395
1396                   <listitem>
1397                     <para>ACLs are additionally mapped to the UNIX mode of the
1398                     filesystem object.</para>
1399                   </listitem>
1400                 </varlistentry>
1401               </variablelist></para>
1402           </listitem>
1403         </varlistentry>
1404       </variablelist>
1405
1406       <para>If you want to be able to display ACLs on the client, you must
1407       setup both client and server as part on a authentication domain
1408       (directory service, eg LDAP, Open Directory, Active Directory). The
1409       reason is, in OS X ACLs are bound to UUIDs, not just uid's or gid's.
1410       Therefor Netatalk must be able to map every filesystem uid and gid to a
1411       UUID so that it can return the server side ACLs which are bound to UNIX
1412       uid and gid mapped to OS X UUIDs.</para>
1413
1414       <para>Netatalk can query a directory server using LDAP queries. Either
1415       the directory server already provides an UUID attribute for user and
1416       groups (Active Directory, Open Directory) or you reuse an unused
1417       attribute (or add a new one) to you directory server (eg
1418       OpenLDAP).</para>
1419
1420       <para>The following LDAP options must be configured for Netatalk:</para>
1421
1422       <variablelist>
1423         <varlistentry>
1424           <term>ldap auth method = <parameter>none|simple|sasl</parameter>
1425           <type>(G)</type></term>
1426
1427           <listitem>
1428             <para>Authentication method: <option>none | simple |
1429             sasl</option></para>
1430
1431             <para><variablelist>
1432                 <varlistentry>
1433                   <term>none</term>
1434
1435                   <listitem>
1436                     <para>anonymous LDAP bind</para>
1437                   </listitem>
1438                 </varlistentry>
1439
1440                 <varlistentry>
1441                   <term>simple</term>
1442
1443                   <listitem>
1444                     <para>simple LDAP bind</para>
1445                   </listitem>
1446                 </varlistentry>
1447
1448                 <varlistentry>
1449                   <term>sasl</term>
1450
1451                   <listitem>
1452                     <para>SASL. Not yet supported !</para>
1453                   </listitem>
1454                 </varlistentry>
1455               </variablelist></para>
1456           </listitem>
1457         </varlistentry>
1458
1459         <varlistentry>
1460           <term>ldap auth dn = <parameter>dn</parameter>
1461           <type>(G)</type></term>
1462
1463           <listitem>
1464             <para>Distinguished Name of the user for simple bind.</para>
1465           </listitem>
1466         </varlistentry>
1467
1468         <varlistentry>
1469           <term>ldap auth pw = <parameter>password</parameter>
1470           <type>(G)</type></term>
1471
1472           <listitem>
1473             <para>Distinguished Name of the user for simple bind.</para>
1474           </listitem>
1475         </varlistentry>
1476
1477         <varlistentry>
1478           <term>ldap server = <parameter>host</parameter>
1479           <type>(G)</type></term>
1480
1481           <listitem>
1482             <para>Name or IP address of your LDAP Server. This is only needed
1483             for explicit ACL support in order to be able to query LDAP for
1484             UUIDs.</para>
1485
1486             <para>You can use <citerefentry>
1487                 <refentrytitle>afpldaptest</refentrytitle>
1488
1489                 <manvolnum>1</manvolnum>
1490               </citerefentry> to syntactically check your config.</para>
1491           </listitem>
1492         </varlistentry>
1493
1494         <varlistentry>
1495           <term>ldap userbase = <parameter>base dn</parameter>
1496           <type>(G)</type></term>
1497
1498           <listitem>
1499             <para>DN of the user container in LDAP.</para>
1500           </listitem>
1501         </varlistentry>
1502
1503         <varlistentry>
1504           <term>ldap userscope = <parameter>scope</parameter>
1505           <type>(G)</type></term>
1506
1507           <listitem>
1508             <para>Search scope for user search: <option>base | one |
1509             sub</option></para>
1510           </listitem>
1511         </varlistentry>
1512
1513         <varlistentry>
1514           <term>ldap groupbase = <parameter>base dn</parameter>
1515           <type>(G)</type></term>
1516
1517           <listitem>
1518             <para>DN of the group container in LDAP.</para>
1519           </listitem>
1520         </varlistentry>
1521
1522         <varlistentry>
1523           <term>ldap groupscope = <parameter>scope</parameter>
1524           <type>(G)</type></term>
1525
1526           <listitem>
1527             <para>Search scope for user search: <option>base | one |
1528             sub</option></para>
1529           </listitem>
1530         </varlistentry>
1531
1532         <varlistentry>
1533           <term>ldap uuid attr = <parameter>dn</parameter>
1534           <type>(G)</type></term>
1535
1536           <listitem>
1537             <para>Name of the LDAP attribute with the UUIDs.</para>
1538
1539             <para>Note: this is used both for users and groups.</para>
1540           </listitem>
1541         </varlistentry>
1542
1543         <varlistentry>
1544           <term>ldap name attr = <parameter>dn</parameter>
1545           <type>(G)</type></term>
1546
1547           <listitem>
1548             <para>Name of the LDAP attribute with the users short name.</para>
1549           </listitem>
1550         </varlistentry>
1551
1552         <varlistentry>
1553           <term>ldap group attr = <parameter>dn</parameter>
1554           <type>(G)</type></term>
1555
1556           <listitem>
1557             <para>Name of the LDAP attribute with the groups short
1558             name.</para>
1559           </listitem>
1560         </varlistentry>
1561
1562         <varlistentry>
1563           <term>ldap uuid string = <parameter>STRING</parameter>
1564           <type>(G)</type></term>
1565
1566           <listitem>
1567             <para>Format of the uuid string in the directory. A series of x
1568             and -, where every x denotes a value 0-9a-f and every - is a
1569             separator.</para>
1570
1571             <para>Default: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</para>
1572           </listitem>
1573         </varlistentry>
1574
1575         <varlistentry>
1576           <term>ldap uuid encoding = <parameter>string | ms-guid (default:
1577           string)</parameter> <type>(G)</type></term>
1578
1579           <listitem>
1580             <para>Format of the UUID of the LDAP attribute, allows usage of
1581             the binary objectGUID fields from Active Directory. If left
1582             unspecified, string is the default, which passes through the ASCII
1583             UUID returned by most other LDAP stores. If set to ms-guid, the
1584             internal UUID representation is converted to and from the binary
1585             format used in the objectGUID attribute found on objects in Active
1586             Directory when interacting with the server.</para>
1587             <para>See also the options <option>ldap user filter</option> and
1588             <option>ldap group filter</option>.</para>
1589             <para><variablelist>
1590                 <varlistentry>
1591                   <term>string</term>
1592
1593                   <listitem>
1594                     <para>UUID is a string, use with eg OpenDirectory.</para>
1595                   </listitem>
1596                 </varlistentry>
1597
1598                 <varlistentry>
1599                   <term>ms-guid</term>
1600
1601                   <listitem>
1602                     <para>Binary objectGUID from Active Directory</para>
1603                   </listitem>
1604                 </varlistentry>
1605               </variablelist></para>
1606           </listitem>
1607         </varlistentry>
1608
1609         <varlistentry>
1610           <term>ldap user filter = <parameter>STRING (default: unused)</parameter>
1611           <type>(G)</type></term>
1612
1613           <listitem>
1614             <para>Optional LDAP filter that matches user objects. This is necessary for Active Directory
1615             environments where users and groups are stored in the same directory subtree.</para>
1616             <para>Recommended setting for Active Directory: <parameter>objectClass=user</parameter>.</para>
1617           </listitem>
1618         </varlistentry>
1619
1620         <varlistentry>
1621           <term>ldap group filter = <parameter>STRING (default: unused)</parameter>
1622           <type>(G)</type></term>
1623
1624           <listitem>
1625             <para>Optional LDAP filter that matches group objects. This is necessary for Active Directory
1626             environments where users and groups are stored in the same directory subtree.</para>
1627             <para>Recommended setting for Active Directory: <parameter>objectClass=group</parameter>.</para>
1628           </listitem>
1629         </varlistentry>
1630
1631       </variablelist>
1632     </refsect2>
1633   </refsect1>
1634
1635   <refsect1>
1636     <title>EXPLANATION OF VOLUME PARAMETERS</title>
1637
1638     <refsect2>
1639       <title>Parameters</title>
1640
1641       <para>The section name defines the volume name.
1642       No two volumes may have the same
1643       name. The volume name cannot contain the <keycode>':'</keycode>
1644       character. The volume name is mangled if it is very long. Mac charset
1645       volume name is limited to 27 characters. UTF8-MAC volume name is limited
1646       to volnamelen parameter.</para>
1647
1648       <variablelist>
1649         <varlistentry>
1650           <term>path = <replaceable>PATH</replaceable> <type>(V)</type></term>
1651
1652           <listitem>
1653             <para>The path name must be a fully qualified path name.</para>
1654           </listitem>
1655         </varlistentry>
1656
1657         <varlistentry>
1658           <term>appledouble = <replaceable>ea|v2</replaceable>
1659           <type>(V)</type></term>
1660
1661           <listitem>
1662             <para>Specify the format of the metadata files, which are used for
1663             saving Mac resource fork as well. Earlier versions used
1664             AppleDouble v2, the new default format is <emphasis
1665             role="bold">ea</emphasis>.</para>
1666           </listitem>
1667         </varlistentry>
1668
1669         <varlistentry>
1670           <term>vol size limit = <replaceable>size in MiB</replaceable>
1671           <type>(V)</type></term>
1672
1673           <listitem>
1674             <para>Useful for Time Machine: limits the reported volume size,
1675             thus preventing Time Machine from using the whole real disk space
1676             for backup. Example: "vol size limit = 1000" would limit the
1677             reported disk space to 1 GB. <emphasis role="bold">IMPORTANT:
1678             </emphasis> This is an approximated calculation taking into
1679             account the contents of Time Machine sparsebundle images. Therefor
1680             you MUST NOT use this volume to store other content when using
1681             this option, because it would NOT be accounted. The calculation
1682             works by reading the band size from the Info.plist XML file of the
1683             sparsebundle, reading the bands/ directory counting the number of
1684             band files, and then multiplying one with the other.</para>
1685           </listitem>
1686         </varlistentry>
1687
1688         <varlistentry>
1689           <term>valid users = <replaceable>user @group</replaceable>
1690           <type>(V)</type></term>
1691
1692           <listitem>
1693             <para>The allow option allows the users and groups that access a
1694             share to be specified. Users and groups are specified, delimited
1695             by spaces or commas. Groups are designated by a @ prefix. Names
1696             may be quoted in order to allow for spaces in names. Example:
1697             <programlisting>valid users = user "user 2" @group “@group 2"</programlisting></para>
1698           </listitem>
1699         </varlistentry>
1700
1701         <varlistentry>
1702           <term>invalid users = <replaceable>users/groups</replaceable>
1703           <type>(V)</type></term>
1704
1705           <listitem>
1706             <para>The deny option specifies users and groups who are not
1707             allowed access to the share. It follows the same format as the
1708             "valid users" option.</para>
1709           </listitem>
1710         </varlistentry>
1711
1712         <varlistentry>
1713           <term>hosts allow = <replaceable>IP host address/IP netmask bits [
1714           ... ]</replaceable> <type>(V)</type></term>
1715
1716           <listitem>
1717             <para>Only listed hosts and networks are allowed, all others are
1718             rejected. The network address may be specified either in
1719             dotted-decimal format for IPv4 or in hexadecimal format for
1720             IPv6.</para>
1721
1722             <para>Example: hosts allow = 10.1.0.0/16 10.2.1.100
1723             2001:0db8:1234::/48</para>
1724           </listitem>
1725         </varlistentry>
1726
1727         <varlistentry>
1728           <term>hosts deny = <replaceable>IP host address/IP netmask bits [
1729           ... ]</replaceable> <type>(V)</type></term>
1730
1731           <listitem>
1732             <para>Listed hosts and nets are rejected, all others are
1733             allowed.</para>
1734
1735             <para>Example: hosts deny = 192.168.100/24 10.1.1.1
1736             2001:db8::1428:57ab</para>
1737           </listitem>
1738         </varlistentry>
1739
1740         <varlistentry>
1741           <term>cnid scheme = <replaceable>backend</replaceable>
1742           <type>(V)</type></term>
1743
1744           <listitem>
1745             <para>set the CNID backend to be used for the volume, default is
1746             [@DEFAULT_CNID_SCHEME@] available schemes:
1747             [@compiled_backends@]</para>
1748           </listitem>
1749         </varlistentry>
1750
1751         <varlistentry>
1752           <term>ea = <replaceable>none|auto|sys|ad</replaceable>
1753           <type>(V)</type></term>
1754
1755           <listitem>
1756             <para>Specify how Extended Attributes<indexterm>
1757                 <primary>Extended Attributes</primary>
1758               </indexterm> are stored. <option>auto</option> is the
1759             default.</para>
1760
1761             <variablelist>
1762               <varlistentry>
1763                 <term>auto</term>
1764
1765                 <listitem>
1766                   <para>Try <option>sys</option> (by setting an EA on the
1767                   shared directory itself), fallback to <option>ad</option>.
1768                   Requires writable volume for performing test. "<option>read
1769                   only = yes</option>" overwrites <option>auto</option> with
1770                   <option>none</option>. Use explicit "<option>ea =
1771                   sys|ad</option>" for read-only volumes where
1772                   appropriate.</para>
1773                 </listitem>
1774               </varlistentry>
1775
1776               <varlistentry>
1777                 <term>sys</term>
1778
1779                 <listitem>
1780                   <para>Use filesystem Extended Attributes.</para>
1781                 </listitem>
1782               </varlistentry>
1783
1784               <varlistentry>
1785                 <term>ad</term>
1786
1787                 <listitem>
1788                   <para>Use files in <emphasis>.AppleDouble</emphasis>
1789                   directories.</para>
1790                 </listitem>
1791               </varlistentry>
1792
1793               <varlistentry>
1794                 <term>none</term>
1795
1796                 <listitem>
1797                   <para>No Extended Attributes support.</para>
1798                 </listitem>
1799               </varlistentry>
1800             </variablelist>
1801           </listitem>
1802         </varlistentry>
1803
1804         <varlistentry>
1805           <term>mac charset = <replaceable>CHARSET</replaceable>
1806           <type>(V)</type></term>
1807
1808           <listitem>
1809             <para>specifies the Mac client charset for this Volume, e.g.
1810             <emphasis>MAC_ROMAN</emphasis>, <emphasis>MAC_CYRILLIC</emphasis>.
1811             If not specified the global setting is applied. This setting is
1812             only required if you need volumes, where the Mac charset differs
1813             from the one globally set in the [Global] section.</para>
1814           </listitem>
1815         </varlistentry>
1816
1817         <varlistentry>
1818           <term>casefold = <option>option</option> <type>(V)</type></term>
1819
1820           <listitem>
1821             <para>The casefold option handles, if the case of filenames should
1822             be changed. The available options are:</para>
1823
1824             <para><option>tolower</option> - Lowercases names in both
1825             directions.</para>
1826
1827             <para><option>toupper</option> - Uppercases names in both
1828             directions.</para>
1829
1830             <para><option>xlatelower</option> - Client sees lowercase, server
1831             sees uppercase.</para>
1832
1833             <para><option>xlateupper</option> - Client sees uppercase, server
1834             sees lowercase.</para>
1835           </listitem>
1836         </varlistentry>
1837
1838         <varlistentry>
1839           <term>password = <replaceable>password</replaceable>
1840           <type>(V)</type></term>
1841
1842           <listitem>
1843             <para>This option allows you to set a volume password, which can
1844             be a maximum of 8 characters long (using ASCII strongly
1845             recommended at the time of this writing).</para>
1846           </listitem>
1847         </varlistentry>
1848
1849         <varlistentry>
1850           <term>file perm = <replaceable>mode</replaceable>
1851           <type>(V)</type></term>
1852
1853           <term>directory perm = <replaceable>mode</replaceable>
1854           <type>(V)</type></term>
1855
1856           <listitem>
1857             <para>Add(or) with the client requested permissions: <option>file
1858             perm</option> is for files only, <option>directory perm</option>
1859             is for directories only. Don't use with "<option>unix priv =
1860             no</option>".</para>
1861
1862             <example>
1863               <title>Volume for a collaborative workgroup</title>
1864
1865               <para><programlisting>file perm = 0660 directory perm =
1866               0770</programlisting></para>
1867             </example>
1868           </listitem>
1869         </varlistentry>
1870
1871         <varlistentry>
1872           <term>umask = <replaceable>mode</replaceable>
1873           <type>(V)</type></term>
1874
1875           <listitem>
1876             <para>set perm mask. Don't use with "<option>unix priv =
1877             no</option>".</para>
1878           </listitem>
1879         </varlistentry>
1880
1881         <varlistentry>
1882           <term>preexec = <replaceable>command</replaceable>
1883           <type>(V)</type></term>
1884
1885           <listitem>
1886             <para>command to be run when the volume is mounted, ignored for
1887             user defined volumes</para>
1888           </listitem>
1889         </varlistentry>
1890
1891         <varlistentry>
1892           <term>postexec = <replaceable>command</replaceable>
1893           <type>(V)</type></term>
1894
1895           <listitem>
1896             <para>command to be run when the volume is closed, ignored for
1897             user defined volumes</para>
1898           </listitem>
1899         </varlistentry>
1900
1901         <varlistentry>
1902           <term>root preexec = <replaceable>command</replaceable>
1903           <type>(V)</type></term>
1904
1905           <listitem>
1906             <para>command to be run as root when the volume is mounted,
1907             ignored for user defined volumes</para>
1908           </listitem>
1909         </varlistentry>
1910
1911         <varlistentry>
1912           <term>root postexec = <replaceable>command</replaceable>
1913           <type>(V)</type></term>
1914
1915           <listitem>
1916             <para>command to be run as root when the volume is closed, ignored
1917             for user defined volumes</para>
1918           </listitem>
1919         </varlistentry>
1920
1921         <varlistentry>
1922           <term>rolist = <option>users/groups</option> <type>(V)</type></term>
1923
1924           <listitem>
1925             <para>Allows certain users and groups to have read-only access to
1926             a share. This follows the allow option format.</para>
1927           </listitem>
1928         </varlistentry>
1929
1930         <varlistentry>
1931           <term>rwlist = <replaceable>users/groups</replaceable>
1932           <type>(V)</type></term>
1933
1934           <listitem>
1935             <para>Allows certain users and groups to have read/write access to
1936             a share. This follows the allow option format.</para>
1937           </listitem>
1938         </varlistentry>
1939
1940         <varlistentry>
1941           <term>veto files = <replaceable>vetoed names</replaceable>
1942           <type>(V)</type></term>
1943
1944           <listitem>
1945             <para>hide files and directories,where the path matches one of the
1946             '/' delimited vetoed names. The veto string must always be
1947             terminated with a '/', eg. "veto files = veto1/", "veto files =
1948             veto1/veto2/".</para>
1949           </listitem>
1950         </varlistentry>
1951       </variablelist>
1952     </refsect2>
1953
1954     <refsect2>
1955       <title>Volume options</title>
1956
1957       <para>Boolean volume options.</para>
1958
1959       <variablelist>
1960         <varlistentry>
1961           <term>acls = <replaceable>BOOLEAN</replaceable> (default:
1962           <emphasis>yes</emphasis>) <type>(V)</type></term>
1963
1964           <listitem>
1965             <para>Whether to flag volumes as supporting ACLs. If ACL support
1966             is compiled in, this is yes by default.</para>
1967           </listitem>
1968         </varlistentry>
1969
1970         <varlistentry>
1971           <term>cnid dev = <replaceable>BOOLEAN</replaceable> (default:
1972           <emphasis>yes</emphasis>) <type>(V)</type></term>
1973
1974           <listitem>
1975             <para>Whether to use the device number in the CNID backends. Helps
1976             when the device number is not constant across a reboot, eg
1977             cluster, ...</para>
1978           </listitem>
1979         </varlistentry>
1980
1981         <varlistentry>
1982           <term>convert appledouble = <replaceable>BOOLEAN</replaceable>
1983           (default: <emphasis>yes</emphasis>) <type>(V)</type></term>
1984
1985           <listitem>
1986             <para>Whether automatic conversion from <option>appledouble =
1987             v2</option> to <option>appledouble = ea</option> is performed when
1988             accessing filesystems from clients. This is generally useful, but
1989             costs some performance. It's recommendable to run
1990             <command>dbd</command> on volumes and do the conversion with that.
1991             Then this option can be set to no.</para>
1992           </listitem>
1993         </varlistentry>
1994
1995         <varlistentry>
1996           <term>delete veto files = <replaceable>BOOLEAN</replaceable>
1997           (default: <emphasis>no</emphasis>) <type>(V)</type></term>
1998
1999           <listitem>
2000             <para>This option is used when Netatalk is attempting to delete a
2001             directory that contains one or more vetoed files or directories
2002             (see the veto files option). If this option is set to no (the
2003             default) then if a directory contains any non-vetoed files or
2004             directories then the directory delete will fail. This is usually
2005             what you want.</para>
2006             <para>If this option is set to yes, then Netatalk will attempt to
2007             recursively delete any files and directories within the vetoed
2008             directory.</para>
2009           </listitem>
2010         </varlistentry>
2011
2012         <varlistentry>
2013           <term>follow symlinks = <replaceable>BOOLEAN</replaceable> (default:
2014           <emphasis>no</emphasis>) <type>(V)</type></term>
2015
2016           <listitem>
2017             <para>The default setting is false thus symlinks are not followed
2018             on the server. This is the same behaviour as OS X's AFP server.
2019             Setting the option to true causes afpd to follow symlinks on the
2020             server. symlinks may point outside of the AFP volume, currently
2021             afpd doesn't do any checks for "wide symlinks".</para>
2022             <note>
2023               <para>This option will subtly break when the symlinks point
2024               across filesystem boundaries.</para>
2025             </note>
2026           </listitem>
2027         </varlistentry>
2028
2029         <varlistentry>
2030           <term>invisible dots = <replaceable>BOOLEAN</replaceable> (default:
2031           <emphasis>no</emphasis>) <type>(V)</type></term>
2032
2033           <listitem>
2034             <para>make dot files invisible. WARNING: enabling this option will
2035               lead to unwanted sideeffects were OS X applications when saving
2036               files to a temporary file starting with a dot first, then renaming
2037               the temp file to its final name, result in the saved file being
2038               invisible. The only thing this option is useful for is making
2039               files that start with a dot invisible on Mac OS 9. It's
2040               completely useless on Mac OS X, as both in Finder and in Terminal
2041               files starting with a dot are hidden anyway.</para>
2042           </listitem>
2043         </varlistentry>
2044
2045         <varlistentry>
2046           <term>network ids = <replaceable>BOOLEAN</replaceable> (default:
2047           <emphasis>yes</emphasis>) <type>(V)</type></term>
2048
2049           <listitem>
2050             <para>Whether the server support network ids. Setting this to
2051             <emphasis>no</emphasis> will result in the client not using ACL
2052             AFP functions.</para>
2053           </listitem>
2054         </varlistentry>
2055
2056         <varlistentry>
2057           <term>preexec close = <replaceable>BOOLEAN</replaceable> (default:
2058           <emphasis>no</emphasis>) <type>(V)</type></term>
2059
2060           <listitem>
2061             <para>A non-zero return code from preexec close the volume being
2062             immediately, preventing clients to mount/see the volume in
2063             question.</para>
2064           </listitem>
2065         </varlistentry>
2066
2067         <varlistentry>
2068           <term>read only = <replaceable>BOOLEAN</replaceable> (default:
2069           <emphasis>no</emphasis>) <type>(V)</type></term>
2070
2071           <listitem>
2072             <para>Specifies the share as being read only for all users.
2073             Overwrites <option>ea = auto</option> with <option>ea =
2074             none</option></para>
2075           </listitem>
2076         </varlistentry>
2077
2078         <varlistentry>
2079           <term>root preexec close= <replaceable>BOOLEAN</replaceable>
2080           (default: <emphasis>no</emphasis>) <type>(V)</type></term>
2081
2082           <listitem>
2083             <para>A non-zero return code from root_preexec closes the volume
2084             immediately, preventing clients to mount/see the volume in
2085             question.</para>
2086           </listitem>
2087         </varlistentry>
2088
2089         <varlistentry>
2090           <term>search db = <replaceable>BOOLEAN</replaceable> (default:
2091           <emphasis>no</emphasis>) <type>(V)</type></term>
2092
2093           <listitem>
2094             <para>Use fast CNID database namesearch instead of slow recursive
2095             filesystem search. Relies on a consistent CNID database, ie Samba
2096             or local filesystem access lead to inaccurate or wrong results.
2097             Works only for "dbd" CNID db volumes.</para>
2098           </listitem>
2099         </varlistentry>
2100
2101         <varlistentry>
2102           <term>stat vol = <replaceable>BOOLEAN</replaceable> (default:
2103           <emphasis>yes</emphasis>) <type>(V)</type></term>
2104
2105           <listitem>
2106             <para>Whether to stat volume path when enumerating volumes list,
2107             useful for automounting or volumes created by a preexec
2108             script.</para>
2109           </listitem>
2110         </varlistentry>
2111
2112         <varlistentry>
2113           <term>time machine = <replaceable>BOOLEAN</replaceable> (default:
2114           <emphasis>no</emphasis>) <type>(V)</type></term>
2115
2116           <listitem>
2117             <para>Whether to enable Time Machine support for this
2118             volume.</para>
2119           </listitem>
2120         </varlistentry>
2121
2122         <varlistentry>
2123           <term>unix priv = <replaceable>BOOLEAN</replaceable> (default:
2124           <emphasis>yes</emphasis>) <type>(V)</type></term>
2125
2126           <listitem>
2127             <para>Whether to use AFP3 UNIX privileges. This should be set for
2128             OS X clients. See also: <option>file perm</option>,
2129             <option>directory perm</option> and <option>umask</option>.</para>
2130           </listitem>
2131         </varlistentry>
2132       </variablelist>
2133     </refsect2>
2134   </refsect1>
2135
2136   <refsect1>
2137     <title>CNID backends</title>
2138
2139     <para>The AFP protocol mostly refers to files and directories by ID and
2140     not by name. Netatalk needs a way to store these ID's in a persistent way,
2141     to achieve this several different CNID backends are available. The CNID
2142     Databases are by default located in the
2143     <filename>@localstatedir@/netatalk/CNID/(volumename)/.AppleDB/</filename>
2144     directory.</para>
2145
2146     <variablelist>
2147       <varlistentry>
2148         <term>cdb</term>
2149
2150         <listitem>
2151           <para>"Concurrent database", backend is based on Oracle Berkley DB.
2152           With this backend several <command>afpd</command> daemons access the
2153           CNID database directly. Berkeley DB locking is used to synchronize
2154           access, if more than one <command>afpd</command> process is active
2155           for a volume. The drawback is, that the crash of a single
2156           <command>afpd</command> process might corrupt the database.</para>
2157         </listitem>
2158       </varlistentry>
2159
2160       <varlistentry>
2161         <term>dbd</term>
2162
2163         <listitem>
2164           <para>Access to the CNID database is restricted to the
2165           <command>cnid_metad</command> daemon process.
2166           <command>afpd</command> processes communicate with the daemon for
2167           database reads and updates. If built with Berkeley DB transactions
2168           the probability for database corruption is practically zero, but
2169           performance can be slower than with <option>cdb</option></para>
2170         </listitem>
2171       </varlistentry>
2172
2173       <varlistentry>
2174         <term>last</term>
2175
2176         <listitem>
2177           <para>This backend is an exception, in terms of ID persistency. ID's
2178           are only valid for the current session. This is basically what
2179           <command>afpd</command> did in the 1.5 (and 1.6) versions. This
2180           backend is still available, as it is useful for e.g. sharing cdroms.
2181           Starting with Netatalk 3.0, it becomes the <emphasis>read only
2182           mode</emphasis> automatically.</para>
2183
2184           <para><emphasis role="bold">Warning</emphasis>: It is
2185           <emphasis>NOT</emphasis> recommended to use this backend for volumes
2186           anymore, as <command>afpd</command> now relies heavily on a
2187           persistent ID database. Aliases will likely not work and filename
2188           mangling is not supported.</para>
2189         </listitem>
2190       </varlistentry>
2191     </variablelist>
2192
2193     <para>Even though <command>./configure --help</command> might show that
2194     there are other CNID backends available, be warned those are likely broken
2195     or mainly used for testing. Don't use them unless you know what you're
2196     doing, they may be removed without further notice from future
2197     versions.</para>
2198   </refsect1>
2199
2200   <refsect1>
2201     <title>Charset options</title>
2202
2203     <para>With OS X Apple introduced the AFP3 protocol. One of the most
2204     important changes was that AFP3 uses unicode names encoded as UTF-8
2205     decomposed. Previous AFP/OS versions used codepages, like MacRoman,
2206     MacCentralEurope, etc.</para>
2207
2208     <para><command>afpd</command> needs a way to preserve extended Macintosh
2209     characters, or characters illegal in unix filenames, when saving files on
2210     a unix filesystem. Earlier versions used the the so called CAP encoding.
2211     An extended character (&gt;0x7F) would be converted to a :xx sequence,
2212     e.g. the Apple Logo (MacRoman: 0xF0) was saved as <literal>:f0</literal>.
2213     Some special characters will be converted as to :xx notation as well.
2214     '<keycode>/</keycode>' will be encoded to <literal>:2f</literal>, if
2215     <option>usedots</option> is not specified, a leading dot
2216     '<keycode>.</keycode>' will be encoded as <literal>:2e</literal>.</para>
2217
2218     <para>This version now uses UTF-8 as the default encoding for names.
2219     '<keycode>/</keycode>' will be converted to '<keycode>:</keycode>'.</para>
2220
2221     <para>The <option>vol charset</option> option will allow you to select
2222     another volume encoding. E.g. for western users another useful setting
2223     could be vol charset ISO-8859-15. <command>afpd</command> will accept any
2224     <citerefentry>
2225         <refentrytitle><command>iconv</command></refentrytitle>
2226
2227         <manvolnum>1</manvolnum>
2228       </citerefentry> provided charset. If a character cannot be converted
2229     from the <option>mac charset</option> to the selected <option>vol
2230     charset</option>, afpd will save it as a CAP encoded character. For AFP3
2231     clients, <command>afpd</command> will convert the UTF-8<indexterm>
2232         <primary>UTF8</primary>
2233
2234         <secondary>afpd's vol charset setting</secondary>
2235       </indexterm><indexterm>
2236         <primary>UTF8-MAC</primary>
2237
2238         <secondary>afpd's vol charset setting</secondary>
2239       </indexterm><indexterm>
2240         <primary>ISO-8859-15</primary>
2241
2242         <secondary>afpd's vol charset setting</secondary>
2243       </indexterm><indexterm>
2244         <primary>ISO-8859-1</primary>
2245
2246         <secondary>afpd's vol charset setting</secondary>
2247       </indexterm> character to <option>mac charset</option> first. If this
2248     conversion fails, you'll receive a -50 error on the mac.</para>
2249
2250     <para><emphasis>Note</emphasis>: Whenever you can, please stick with the
2251     default UTF-8 volume format.</para>
2252   </refsect1>
2253
2254   <refsect1>
2255     <title>SEE ALSO</title>
2256
2257     <para><citerefentry>
2258         <refentrytitle>afpd</refentrytitle>
2259
2260         <manvolnum>8</manvolnum>
2261       </citerefentry>, <citerefentry>
2262         <refentrytitle>afppasswd</refentrytitle>
2263
2264         <manvolnum>5</manvolnum>
2265       </citerefentry>, <citerefentry>
2266         <refentrytitle>afp_signature.conf</refentrytitle>
2267
2268         <manvolnum>5</manvolnum>
2269       </citerefentry>, <citerefentry>
2270         <refentrytitle>extmap.conf</refentrytitle>
2271
2272         <manvolnum>5</manvolnum>
2273       </citerefentry>, <citerefentry>
2274         <refentrytitle>cnid_metad</refentrytitle>
2275
2276         <manvolnum>8</manvolnum>
2277       </citerefentry></para>
2278   </refsect1>
2279 </refentry>