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