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