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">30 Apr 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           </listitem>
 579         </varlistentry>
 580
 581         <varlistentry>
 582           <term>afp port = <replaceable>port number</replaceable>
 583           <type>(G)</type></term>
 584
 585           <listitem>
 586             <para>Allows a different TCP port to be used for AFP. The default
 587             is 548. Also sets the default port applied when none specified in
 588             an <option>afp listen</option> option.</para>
 589           </listitem>
 590         </varlistentry>
 591
 592         <varlistentry>
 593           <term>cnid listen = <replaceable>ip address[:port] [ip
 594           address[:port] ...]</replaceable> <type>(G)</type></term>
 595
 596           <listitem>
 597             <para>Specifies the IP address that the CNID server should listen
 598             on. The default is <emphasis
 599             role="bold">localhost:4700</emphasis>.</para>
 600           </listitem>
 601         </varlistentry>
 602
 603         <varlistentry>
 604           <term>disconnect time = <replaceable>number</replaceable>
 605           <type>(G)</type></term>
 606
 607           <listitem>
 608             <para>Keep disconnected AFP sessions for
 609             <parameter>number</parameter> hours before dropping them. Default
 610             is 24 hours.</para>
 611           </listitem>
 612         </varlistentry>
 613
 614         <varlistentry>
 615           <term>dsireadbuf = <replaceable>number</replaceable>
 616           <type>(G)</type></term>
 617
 618           <listitem>
 619             <para>Scale factor that determines the size of the DSI/TCP
 620             readahead buffer, default is 12. This is multiplies with the DSI
 621             server quantum (default ~300k) to give the size of the buffer.
 622             Increasing this value might increase throughput in fast local
 623             networks for volume to volume copies. <emphasis>Note</emphasis>:
 624             This buffer is allocated per afpd child process, so specifying
 625             large values will eat up large amount of memory (buffer size *
 626             number of clients).</para>
 627           </listitem>
 628         </varlistentry>
 629
 630         <varlistentry>
 631           <term>fqdn = <replaceable>name:port</replaceable>
 632           <type>(G)</type></term>
 633
 634           <listitem>
 635             <para>Specifies a fully-qualified domain name, with an optional
 636             port. This is discarded if the server cannot resolve it. This
 637             option is not honored by AppleShare clients &lt;= 3.8.3. This
 638             option is disabled by default. Use with caution as this will
 639             involve a second name resolution step on the client side. Also
 640             note that afpd will advertise this name:port combination but not
 641             automatically listen to it.</para>
 642           </listitem>
 643         </varlistentry>
 644
 645         <varlistentry>
 646           <term>hostname = <replaceable>name</replaceable>
 647           <type>(G)</type></term>
 648
 649           <listitem>
 650             <para>Use this instead of the result from calling hostname for
 651             determining which IP address to advertise, therefore the hostname
 652             is resolved to an IP which is the advertised. This is NOT used for
 653             listening and it is also overwritten by <option>afp
 654             listen</option>.</para>
 655           </listitem>
 656         </varlistentry>
 657
 658         <varlistentry>
 659           <term>max connections = <replaceable>number</replaceable>
 660           <type>(G)</type></term>
 661
 662           <listitem>
 663             <para>Sets the maximum number of clients that can simultaneously
 664             connect to the server (default is 200).</para>
 665           </listitem>
 666         </varlistentry>
 667
 668         <varlistentry>
 669           <term>server quantum = <replaceable>number</replaceable>
 670           <type>(G)</type></term>
 671
 672           <listitem>
 673             <para>This specifies the DSI server quantum. The default value is
 674             1 MB. The maximum value is 0xFFFFFFFFF, the minimum is 32000. If
 675             you specify a value that is out of range, the default value will
 676             be set. Do not change this value unless you're absolutely sure,
 677             what you're doing</para>
 678           </listitem>
 679         </varlistentry>
 680
 681         <varlistentry>
 682           <term>sleep time = <replaceable>number</replaceable>
 683           <type>(G)</type></term>
 684
 685           <listitem>
 686             <para>Keep sleeping AFP sessions for <parameter>number</parameter>
 687             hours before disconnecting clients in sleep mode. Default is 10
 688             hours.</para>
 689           </listitem>
 690         </varlistentry>
 691
 692         <varlistentry>
 693           <term>tcprcvbuf = <replaceable>number</replaceable>
 694           <type>(G)</type></term>
 695
 696           <listitem>
 697             <para>Try to set TCP receive buffer using setsockpt(). Often OSes
 698             impose restrictions on the applications ability to set this
 699             value.</para>
 700           </listitem>
 701         </varlistentry>
 702
 703         <varlistentry>
 704           <term>tcpsndbuf = <replaceable>number</replaceable>
 705           <type>(G)</type></term>
 706
 707           <listitem>
 708             <para>Try to set TCP send buffer using setsockpt(). Often OSes
 709             impose restrictions on the applications ability to set this
 710             value.</para>
 711           </listitem>
 712         </varlistentry>
 713
 714         <varlistentry>
 715           <term>use sendfile = <replaceable>BOOLEAN</replaceable> (default:
 716           <emphasis>yes</emphasis>) <type>(G)</type></term>
 717
 718           <listitem>
 719             <para>Whether to use sendfile<indexterm>
 720                 <primary>sendfile</primary>
 721               </indexterm> syscall for sending file data to clients.</para>
 722           </listitem>
 723         </varlistentry>
 724
 725         <varlistentry>
 726           <term>zeroconf = <replaceable>BOOLEAN</replaceable> (default:
 727           <emphasis>yes</emphasis>) <type>(G)</type></term>
 728
 729           <listitem>
 730             <para>Whether to use automatic Zeroconf<indexterm>
 731                 <primary>Zeroconf</primary>
 732
 733                 <secondary>Bonjour</secondary>
 734               </indexterm> service registration if Avahi or mDNSResponder were
 735             compiled in.</para>
 736           </listitem>
 737         </varlistentry>
 738       </variablelist>
 739     </refsect2>
 740
 741     <refsect2>
 742       <title>Miscellaneous Options</title>
 743
 744       <variablelist>
 745         <varlistentry>
 746           <term>admin group = <replaceable>group</replaceable>
 747           <type>(G)</type></term>
 748
 749           <listitem>
 750             <para>Allows users of a certain group to be seen as the superuser
 751             when they log in. This option is disabled by default.</para>
 752           </listitem>
 753         </varlistentry>
 754
 755         <varlistentry>
 756           <term>afp read locks = <replaceable>BOOLEAN</replaceable> (default:
 757           <emphasis>no</emphasis>) <type>(G)</type></term>
 758
 759           <listitem>
 760             <para>Whether to apply locks to the byte region read in FPRead
 761             calls. The AFP spec mandates this, but it's not really in line
 762             with UNIX semantics and is a performance hug.</para>
 763           </listitem>
 764         </varlistentry>
 765
 766         <varlistentry>
 767           <term>afpstats = <replaceable>BOOLEAN</replaceable> (default:
 768           <emphasis>no</emphasis>) <type>(G)</type></term>
 769
 770           <listitem>
 771             <para>Whether to provide AFP runtime statistics (connected
 772             users, open volumes) via dbus.</para>
 773           </listitem>
 774         </varlistentry>
 775
 776         <varlistentry>
 777           <term>basedir regex = <replaceable>regex</replaceable>
 778           <type>(H)</type></term>
 779
 780           <listitem>
 781             <para>Regular expression which matches the parent directory of the
 782             user homes. If <option>basedir regex</option> contains symlink,
 783             you must set the canonicalized absolute path. In the simple case
 784             this is just a path ie <option>basedir regex =
 785             /home</option></para>
 786           </listitem>
 787         </varlistentry>
 788
 789         <varlistentry>
 790           <term>close vol = <replaceable>BOOLEAN</replaceable> (default:
 791           <emphasis>no</emphasis>) <type>(G)</type></term>
 792
 793           <listitem>
 794             <para>Whether to close volumes possibly opened by clients when
 795             they're removed from the configuration and the configuration is
 796             reloaded.</para>
 797           </listitem>
 798         </varlistentry>
 799
 800         <varlistentry>
 801           <term>cnid server = <replaceable>ipaddress[:port]</replaceable>
 802           <type>(G)/(V)</type></term>
 803
 804           <listitem>
 805             <para>Specifies the IP address and port of a cnid_metad server,
 806             required for CNID dbd backend. Defaults to localhost:4700. The
 807             network address may be specified either in dotted-decimal format
 808             for IPv4 or in hexadecimal format for IPv6.-</para>
 809           </listitem>
 810         </varlistentry>
 811
 812         <varlistentry>
 813           <term>dircachesize = <replaceable>number</replaceable>
 814           <type>(G)</type></term>
 815
 816           <listitem>
 817             <para>Maximum possible entries in the directory cache. The cache
 818             stores directories and files. It is used to cache the full path to
 819             directories and CNIDs which considerably speeds up directory
 820             enumeration.</para>
 821
 822             <para>Default size is 8192, maximum size is 131072. Given value is
 823             rounded up to nearest power of 2. Each entry takes about 100
 824             bytes, which is not much, but remember that every afpd child
 825             process for every connected user has its cache.</para>
 826           </listitem>
 827         </varlistentry>
 828
 829         <varlistentry>
 830           <term>extmap file = <parameter>path</parameter>
 831           <type>(G)</type></term>
 832
 833           <listitem>
 834             <para>Sets the path to the file which defines file extension
 835             type/creator mappings. (default is @pkgconfdir@/extmap.conf).</para>
 836           </listitem>
 837         </varlistentry>
 838
 839         <varlistentry>
 840           <term>guest account = <replaceable>name</replaceable>
 841           <type>(G)</type></term>
 842
 843           <listitem>
 844             <para>Specifies the user that guests should use (default is
 845             "nobody"). The name should be quoted.</para>
 846           </listitem>
 847         </varlistentry>
 848
 849         <varlistentry>
 850           <term>home name = <replaceable>name</replaceable>
 851           <type>(H)</type></term>
 852
 853           <listitem>
 854             <para>AFP user home volume name. The default is <emphasis>user's
 855             home</emphasis>.</para>
 856           </listitem>
 857         </varlistentry>
 858
 859         <varlistentry>
 860           <term>login message = <replaceable>message</replaceable>
 861           <type>(G)/(V)</type></term>
 862
 863           <listitem>
 864             <para>Sets a message to be displayed when clients logon to the
 865             server. The message should be in <option>unix charset</option> and
 866             should be quoted. Extended characters are allowed.</para>
 867           </listitem>
 868         </varlistentry>
 869
 870         <varlistentry>
 871           <term>mimic model = <replaceable>model</replaceable>
 872           <type>(G)</type></term>
 873
 874           <listitem>
 875             <para>Specifies the icon model that appears on clients. Defaults
 876             to off. Note that afpd must support Zeroconf.
 877             Examples: RackMac (same as Xserve), PowerBook, PowerMac,
 878             Macmini, iMac, MacBook, MacBookPro, MacBookAir, MacPro,
 879             AppleTV1,1, AirPort.</para>
 880           </listitem>
 881         </varlistentry>
 882
 883         <varlistentry>
 884           <term>signature = &lt;text&gt; <type>(G)</type></term>
 885
 886           <listitem>
 887             <para>Specify a server signature. The maximum length is 16
 888             characters. This option is useful for clustered environments, to
 889             provide fault isolation etc. By default, afpd generate signature
 890             and saving it to
 891             <filename>@localstatedir@/netatalk/afp_signature.conf</filename>
 892             automatically (based on random number). See also
 893             asip-status.pl(1).</para>
 894           </listitem>
 895         </varlistentry>
 896
 897         <varlistentry>
 898           <term>solaris share reservations =
 899           <replaceable>BOOLEAN</replaceable> (default:
 900           <emphasis>yes</emphasis>) <type>(G)</type></term>
 901
 902           <listitem>
 903             <para>Use share reservations on Solaris. Solaris CIFS server uses
 904             this too, so this makes a lock coherent multi protocol
 905             server.</para>
 906           </listitem>
 907         </varlistentry>
 908
 909         <varlistentry>
 910           <term>spotlight =
 911           <replaceable>BOOLEAN</replaceable> (default:
 912           <emphasis>no</emphasis>) <type>(G)/(V)</type></term>
 913
 914           <listitem>
 915             <para>Whether to enable Spotlight searches. Note: once the global
 916             option is enabled, any volume that is not enabled won't be
 917             searchable at all.</para>
 918           </listitem>
 919         </varlistentry>
 920
 921         <varlistentry>
 922           <term>vol dbpath = <replaceable>path</replaceable>
 923           <type>(G)</type></term>
 924
 925           <listitem>
 926             <para>Sets the database information to be stored in path. You have
 927             to specify a writable location, even if the volume is read only.
 928             The default is
 929             <filename>@localstatedir@/netatalk/CNID/</filename>.</para>
 930           </listitem>
 931         </varlistentry>
 932
 933         <varlistentry>
 934           <term>volnamelen = <replaceable>number</replaceable>
 935           <type>(G)</type></term>
 936
 937           <listitem>
 938             <para>Max length of UTF8-MAC volume name for Mac OS X. Note that
 939             Hangul is especially sensitive to this.</para>
 940
 941             <para><programlisting> 73: limit of Mac OS X 10.1 80: limit of Mac
 942             OS X 10.4/10.5 (default) 255: limit of recent Mac OS
 943             X</programlisting> Mac OS 9 and earlier are not influenced by
 944             this, because Maccharset volume name is always limited to 27
 945             bytes.</para>
 946           </listitem>
 947         </varlistentry>
 948
 949         <varlistentry>
 950           <term>vol preset = <replaceable>name</replaceable>
 951           <type>(G)/(V)</type></term>
 952
 953           <listitem>
 954             <para>Use section <option>name</option> as option preset for all
 955             volumes (when set in the [Global] section) or for one volume (when
 956             set in that volume's section).</para>
 957           </listitem>
 958         </varlistentry>
 959       </variablelist>
 960     </refsect2>
 961
 962     <refsect2>
 963       <title>Logging Options</title>
 964
 965       <variablelist>
 966         <varlistentry>
 967           <term>log file = <replaceable>logfile</replaceable>
 968           <type>(G)</type></term>
 969
 970           <listitem>
 971             <para>If not specified Netatalk logs to syslogs daemon facility.
 972             Otherwise it logs to <option>logfile</option>.</para>
 973           </listitem>
 974         </varlistentry>
 975
 976         <varlistentry>
 977           <term>log level = <replaceable>type:level [type:level
 978           ...]</replaceable> <type>(G)</type></term>
 979
 980           <term>log level = <replaceable>type:level,[type:level,
 981           ...]</replaceable> <type>(G)</type></term>
 982
 983           <listitem>
 984             <para>Specify that any message of a loglevel up to the given
 985             <option>log level</option> should be logged.</para>
 986
 987             <para>By default afpd logs to syslog with a default logging setup
 988             equivalent to <option>default:note</option></para>
 989
 990             <para>logtypes: default, afpdaemon, logger, uamsdaemon</para>
 991
 992             <para>loglevels: severe, error, warn, note, info, debug, debug6,
 993             debug7, debug8, debug9, maxdebug</para>
 994
 995             <note>
 996               <para>Both logtype and loglevels are case insensitive.</para>
 997             </note>
 998           </listitem>
 999         </varlistentry>
1000       </variablelist>
1001     </refsect2>
1002
1003     <refsect2 id="fceconf">
1004       <title>Filesystem Change Events (FCE<indexterm>
1005           <primary>FCE</primary>
1006         </indexterm>)</title>
1007
1008       <para>Netatalk includes a nifty filesystem change event mechanism where
1009       afpd processes notify interested listeners about certain filesystem
1010       event by UDP network datagrams.</para>
1011
1012       <variablelist>
1013         <varlistentry>
1014           <term>fce listener = <replaceable>host[:port]</replaceable>
1015           <type>(G)</type></term>
1016
1017           <listitem>
1018             <para>Enables sending FCE events to the specified
1019             <parameter>host</parameter>, default <parameter>port</parameter>
1020             is 12250 if not specified. Specifying multiple listeners is done
1021             by having this option once for each of them.</para>
1022           </listitem>
1023         </varlistentry>
1024
1025         <varlistentry>
1026           <term>fce events =
1027           <replaceable>fmod,fdel,ddel,fcre,dcre,tmsz</replaceable>
1028           <type>(G)</type></term>
1029
1030           <listitem>
1031             <para>Specifies which FCE events are active, default is
1032             <parameter>fmod,fdel,ddel,fcre,dcre</parameter>.</para>
1033           </listitem>
1034         </varlistentry>
1035
1036         <varlistentry>
1037           <term>fce coalesce = <replaceable>all|delete|create</replaceable>
1038           <type>(G)</type></term>
1039
1040           <listitem>
1041             <para>Coalesce FCE events.</para>
1042           </listitem>
1043         </varlistentry>
1044
1045         <varlistentry>
1046           <term>fce holdfmod = <replaceable>seconds</replaceable>
1047           <type>(G)</type></term>
1048
1049           <listitem>
1050             <para>This determines the time delay in seconds which is always
1051             waited if another file modification for the same file is done by a
1052             client before sending an FCE file modification event (fmod). For
1053             example saving a file in Photoshop would generate multiple events
1054             by itself because the application is opening, modifying and
1055             closing a file multiple times for every "save". Default: 60
1056             seconds.</para>
1057           </listitem>
1058         </varlistentry>
1059       </variablelist>
1060     </refsect2>
1061
1062     <refsect2>
1063       <title>Debug Parameters</title>
1064
1065       <para>These options are useful for debugging only.</para>
1066
1067       <variablelist>
1068         <varlistentry>
1069           <term>tickleval = <replaceable>number</replaceable>
1070           <type>(G)</type></term>
1071
1072           <listitem>
1073             <para>Sets the tickle timeout interval (in seconds). Defaults to
1074             30.</para>
1075           </listitem>
1076         </varlistentry>
1077
1078         <varlistentry>
1079           <term>timeout = <replaceable>number</replaceable>
1080           <type>(G)</type></term>
1081
1082           <listitem>
1083             <para>Specify the number of tickles to send before timing out a
1084             connection. The default is 4, therefore a connection will timeout
1085             after 2 minutes.</para>
1086           </listitem>
1087         </varlistentry>
1088
1089         <varlistentry>
1090           <term>client polling = <replaceable>BOOLEAN</replaceable> (default:
1091           <emphasis>no</emphasis>) <type>(G)</type></term>
1092
1093           <listitem>
1094             <para>With this option enabled, afpd won't advertise that it is
1095             capable of server notifications, so that connected clients poll
1096             the server every 10 seconds to detect changes in opened server
1097             windows. <emphasis>Note</emphasis>: Depending on the number of
1098             simultaneously connected clients and the network's speed, this can
1099             lead to a significant higher load on your network!</para>
1100
1101             <para>Do not use this option any longer as present Netatalk
1102             correctly supports server notifications, allowing connected
1103             clients to update folder listings in case another client changed
1104             the contents.</para>
1105           </listitem>
1106         </varlistentry>
1107       </variablelist>
1108     </refsect2>
1109
1110     <refsect2 id="acl_options">
1111       <title>Options for ACL handling</title>
1112
1113       <para>By default, the effective permission of the authenticated user are
1114       only mapped to the mentioned UARights permission structure, not the UNIX
1115       mode. You can adjust this behaviour with the configuration option
1116       <option>mac acls</option>:</para>
1117
1118       <variablelist id="mac_acls">
1119         <varlistentry>
1120           <term>map acls = <parameter>none|rights|mode</parameter>
1121           <type>(G)</type></term>
1122
1123           <listitem>
1124             <para><variablelist>
1125                 <varlistentry>
1126                   <term>none</term>
1127
1128                   <listitem>
1129                     <para>no mapping of ACLs </para>
1130                   </listitem>
1131                 </varlistentry>
1132
1133                 <varlistentry>
1134                   <term>rights</term>
1135
1136                   <listitem>
1137                     <para>effective permissions are mapped to UARights
1138                     structure. This is the default.</para>
1139                   </listitem>
1140                 </varlistentry>
1141
1142                 <varlistentry>
1143                   <term>mode</term>
1144
1145                   <listitem>
1146                     <para>ACLs are additionally mapped to the UNIX mode of the
1147                     filesystem object.</para>
1148                   </listitem>
1149                 </varlistentry>
1150               </variablelist></para>
1151           </listitem>
1152         </varlistentry>
1153       </variablelist>
1154
1155       <para>If you want to be able to display ACLs on the client, you must
1156       setup both client and server as part on a authentication domain
1157       (directory service, eg LDAP, Open Directory, Active Directory). The
1158       reason is, in OS X ACLs are bound to UUIDs, not just uid's or gid's.
1159       Therefor Netatalk must be able to map every filesystem uid and gid to a
1160       UUID so that it can return the server side ACLs which are bound to UNIX
1161       uid and gid mapped to OS X UUIDs.</para>
1162
1163       <para>Netatalk can query a directory server using LDAP queries. Either
1164       the directory server already provides an UUID attribute for user and
1165       groups (Active Directory, Open Directory) or you reuse an unused
1166       attribute (or add a new one) to you directory server (eg
1167       OpenLDAP).</para>
1168
1169       <para>The following LDAP options must be configured for Netatalk:</para>
1170
1171       <variablelist>
1172         <varlistentry>
1173           <term>ldap auth method = <parameter>none|simple|sasl</parameter>
1174           <type>(G)</type></term>
1175
1176           <listitem>
1177             <para>Authentication method: <option>none | simple |
1178             sasl</option></para>
1179
1180             <para><variablelist>
1181                 <varlistentry>
1182                   <term>none</term>
1183
1184                   <listitem>
1185                     <para>anonymous LDAP bind</para>
1186                   </listitem>
1187                 </varlistentry>
1188
1189                 <varlistentry>
1190                   <term>simple</term>
1191
1192                   <listitem>
1193                     <para>simple LDAP bind</para>
1194                   </listitem>
1195                 </varlistentry>
1196
1197                 <varlistentry>
1198                   <term>sasl</term>
1199
1200                   <listitem>
1201                     <para>SASL. Not yet supported !</para>
1202                   </listitem>
1203                 </varlistentry>
1204               </variablelist></para>
1205           </listitem>
1206         </varlistentry>
1207
1208         <varlistentry>
1209           <term>ldap auth dn = <parameter>dn</parameter>
1210           <type>(G)</type></term>
1211
1212           <listitem>
1213             <para>Distinguished Name of the user for simple bind.</para>
1214           </listitem>
1215         </varlistentry>
1216
1217         <varlistentry>
1218           <term>ldap auth pw = <parameter>password</parameter>
1219           <type>(G)</type></term>
1220
1221           <listitem>
1222             <para>Distinguished Name of the user for simple bind.</para>
1223           </listitem>
1224         </varlistentry>
1225
1226         <varlistentry>
1227           <term>ldap server = <parameter>host</parameter>
1228           <type>(G)</type></term>
1229
1230           <listitem>
1231             <para>Name or IP address of your LDAP Server. This is only needed
1232             for explicit ACL support in order to be able to query LDAP for
1233             UUIDs.</para>
1234
1235             <para>You can use <citerefentry>
1236                 <refentrytitle>afpldaptest</refentrytitle>
1237
1238                 <manvolnum>1</manvolnum>
1239               </citerefentry> to syntactically check your config.</para>
1240           </listitem>
1241         </varlistentry>
1242
1243         <varlistentry>
1244           <term>ldap userbase = <parameter>base dn</parameter>
1245           <type>(G)</type></term>
1246
1247           <listitem>
1248             <para>DN of the user container in LDAP.</para>
1249           </listitem>
1250         </varlistentry>
1251
1252         <varlistentry>
1253           <term>ldap userscope = <parameter>scope</parameter>
1254           <type>(G)</type></term>
1255
1256           <listitem>
1257             <para>Search scope for user search: <option>base | one |
1258             sub</option></para>
1259           </listitem>
1260         </varlistentry>
1261
1262         <varlistentry>
1263           <term>ldap groupbase = <parameter>base dn</parameter>
1264           <type>(G)</type></term>
1265
1266           <listitem>
1267             <para>DN of the group container in LDAP.</para>
1268           </listitem>
1269         </varlistentry>
1270
1271         <varlistentry>
1272           <term>ldap groupscope = <parameter>scope</parameter>
1273           <type>(G)</type></term>
1274
1275           <listitem>
1276             <para>Search scope for user search: <option>base | one |
1277             sub</option></para>
1278           </listitem>
1279         </varlistentry>
1280
1281         <varlistentry>
1282           <term>ldap uuid attr = <parameter>dn</parameter>
1283           <type>(G)</type></term>
1284
1285           <listitem>
1286             <para>Name of the LDAP attribute with the UUIDs.</para>
1287
1288             <para>Note: this is used both for users and groups.</para>
1289           </listitem>
1290         </varlistentry>
1291
1292         <varlistentry>
1293           <term>ldap name attr = <parameter>dn</parameter>
1294           <type>(G)</type></term>
1295
1296           <listitem>
1297             <para>Name of the LDAP attribute with the users short name.</para>
1298           </listitem>
1299         </varlistentry>
1300
1301         <varlistentry>
1302           <term>ldap uuid string = <parameter>STRING</parameter>
1303           <type>(G)</type></term>
1304
1305           <listitem>
1306             <para>Format of the uuid string in the directory. A series of x
1307             and -, where every x denotes a value 0-9a-f and every - is a
1308             separator.</para>
1309
1310             <para>Default: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</para>
1311           </listitem>
1312         </varlistentry>
1313
1314         <varlistentry>
1315           <term>ldap uuid encoding = <parameter>string | ms-guid (default:
1316           string)</parameter> <type>(G)</type></term>
1317
1318           <listitem>
1319             <para>Format of the UUID of the LDAP attribute, allows usage of
1320             the binary objectGUID fields from Active Directory. If left
1321             unspecified, string is the default, which passes through the ASCII
1322             UUID returned by most other LDAP stores. If set to ms-guid, the
1323             internal UUID representation is converted to and from the binary
1324             format used in the objectGUID attribute found on objects in Active
1325             Directory when interacting with the server.</para>
1326
1327             <para><variablelist>
1328                 <varlistentry>
1329                   <term>string</term>
1330
1331                   <listitem>
1332                     <para>UUID is a string, use with eg OpenDirectory.</para>
1333                   </listitem>
1334                 </varlistentry>
1335
1336                 <varlistentry>
1337                   <term>ms-guid</term>
1338
1339                   <listitem>
1340                     <para>Binary objectGUID from Active Directory</para>
1341                   </listitem>
1342                 </varlistentry>
1343               </variablelist></para>
1344           </listitem>
1345         </varlistentry>
1346
1347         <varlistentry>
1348           <term>ldap group attr = <parameter>dn</parameter>
1349           <type>(G)</type></term>
1350
1351           <listitem>
1352             <para>Name of the LDAP attribute with the groups short
1353             name.</para>
1354           </listitem>
1355         </varlistentry>
1356       </variablelist>
1357     </refsect2>
1358   </refsect1>
1359
1360   <refsect1>
1361     <title>EXPLANATION OF VOLUME PARAMETERS</title>
1362
1363     <refsect2>
1364       <title>Parameters</title>
1365
1366       <para>The section name defines the volume name.
1367       No two volumes may have the same
1368       name. The volume name cannot contain the <keycode>':'</keycode>
1369       character. The volume name is mangled if it is very long. Mac charset
1370       volume name is limited to 27 characters. UTF8-MAC volume name is limited
1371       to volnamelen parameter.</para>
1372
1373       <variablelist>
1374         <varlistentry>
1375           <term>path = <replaceable>PATH</replaceable> <type>(V)</type></term>
1376
1377           <listitem>
1378             <para>The path name must be a fully qualified path name.</para>
1379           </listitem>
1380         </varlistentry>
1381
1382         <varlistentry>
1383           <term>appledouble = <replaceable>ea|v2</replaceable>
1384           <type>(V)</type></term>
1385
1386           <listitem>
1387             <para>Specify the format of the metadata files, which are used for
1388             saving Mac resource fork as well. Earlier versions used
1389             AppleDouble v2, the new default format is <emphasis
1390             role="bold">ea</emphasis>.</para>
1391           </listitem>
1392         </varlistentry>
1393
1394         <varlistentry>
1395           <term>vol size limit = <replaceable>size in MiB</replaceable>
1396           <type>(V)</type></term>
1397
1398           <listitem>
1399             <para>Useful for Time Machine: limits the reported volume size,
1400             thus preventing Time Machine from using the whole real disk space
1401             for backup. Example: "vol size limit = 1000" would limit the
1402             reported disk space to 1 GB. <emphasis role="bold">IMPORTANT:
1403             </emphasis> This is an approximated calculation taking into
1404             account the contents of Time Machine sparsebundle images. Therefor
1405             you MUST NOT use this volume to store other content when using
1406             this option, because it would NOT be accounted. The calculation
1407             works by reading the band size from the Info.plist XML file of the
1408             sparsebundle, reading the bands/ directory counting the number of
1409             band files, and then multiplying one with the other.</para>
1410           </listitem>
1411         </varlistentry>
1412
1413         <varlistentry>
1414           <term>valid users = <replaceable>user @group</replaceable>
1415           <type>(V)</type></term>
1416
1417           <listitem>
1418             <para>The allow option allows the users and groups that access a
1419             share to be specified. Users and groups are specified, delimited
1420             by spaces or commas. Groups are designated by a @ prefix. Names
1421             may be quoted in order to allow for spaces in names. Example:
1422             <programlisting>valid users = user "user 2" @group “@group 2"</programlisting></para>
1423           </listitem>
1424         </varlistentry>
1425
1426         <varlistentry>
1427           <term>invalid users = <replaceable>users/groups</replaceable>
1428           <type>(V)</type></term>
1429
1430           <listitem>
1431             <para>The deny option specifies users and groups who are not
1432             allowed access to the share. It follows the same format as the
1433             "valid users" option.</para>
1434           </listitem>
1435         </varlistentry>
1436
1437         <varlistentry>
1438           <term>hosts allow = <replaceable>IP host address/IP netmask bits [
1439           ... ]</replaceable> <type>(V)</type></term>
1440
1441           <listitem>
1442             <para>Only listed hosts and networks are allowed, all others are
1443             rejected. The network address may be specified either in
1444             dotted-decimal format for IPv4 or in hexadecimal format for
1445             IPv6.</para>
1446
1447             <para>Example: hosts allow = 10.1.0.0/16 10.2.1.100
1448             2001:0db8:1234::/48</para>
1449           </listitem>
1450         </varlistentry>
1451
1452         <varlistentry>
1453           <term>hosts deny = <replaceable>IP host address/IP netmask bits [
1454           ... ]</replaceable> <type>(V)</type></term>
1455
1456           <listitem>
1457             <para>Listed hosts and nets are rejected, all others are
1458             allowed.</para>
1459
1460             <para>Example: hosts deny = 192.168.100/24 10.1.1.1
1461             2001:db8::1428:57ab</para>
1462           </listitem>
1463         </varlistentry>
1464
1465         <varlistentry>
1466           <term>cnid scheme = <replaceable>backend</replaceable>
1467           <type>(V)</type></term>
1468
1469           <listitem>
1470             <para>set the CNID backend to be used for the volume, default is
1471             [@DEFAULT_CNID_SCHEME@] available schemes:
1472             [@compiled_backends@]</para>
1473           </listitem>
1474         </varlistentry>
1475
1476         <varlistentry>
1477           <term>ea = <replaceable>none|auto|sys|ad</replaceable>
1478           <type>(V)</type></term>
1479
1480           <listitem>
1481             <para>Specify how Extended Attributes<indexterm>
1482                 <primary>Extended Attributes</primary>
1483               </indexterm> are stored. <option>auto</option> is the
1484             default.</para>
1485
1486             <variablelist>
1487               <varlistentry>
1488                 <term>auto</term>
1489
1490                 <listitem>
1491                   <para>Try <option>sys</option> (by setting an EA on the
1492                   shared directory itself), fallback to <option>ad</option>.
1493                   Requires writable volume for performing test. "<option>read
1494                   only = yes</option>" overwrites <option>auto</option> with
1495                   <option>none</option>. Use explicit "<option>ea =
1496                   sys|ad</option>" for read-only volumes where
1497                   appropriate.</para>
1498                 </listitem>
1499               </varlistentry>
1500
1501               <varlistentry>
1502                 <term>sys</term>
1503
1504                 <listitem>
1505                   <para>Use filesystem Extended Attributes.</para>
1506                 </listitem>
1507               </varlistentry>
1508
1509               <varlistentry>
1510                 <term>ad</term>
1511
1512                 <listitem>
1513                   <para>Use files in <emphasis>.AppleDouble</emphasis>
1514                   directories.</para>
1515                 </listitem>
1516               </varlistentry>
1517
1518               <varlistentry>
1519                 <term>none</term>
1520
1521                 <listitem>
1522                   <para>No Extended Attributes support.</para>
1523                 </listitem>
1524               </varlistentry>
1525             </variablelist>
1526           </listitem>
1527         </varlistentry>
1528
1529         <varlistentry>
1530           <term>mac charset = <replaceable>CHARSET</replaceable>
1531           <type>(V)</type></term>
1532
1533           <listitem>
1534             <para>specifies the Mac client charset for this Volume, e.g.
1535             <emphasis>MAC_ROMAN</emphasis>, <emphasis>MAC_CYRILLIC</emphasis>.
1536             If not specified the global setting is applied. This setting is
1537             only required if you need volumes, where the Mac charset differs
1538             from the one globally set in the [Global] section.</para>
1539           </listitem>
1540         </varlistentry>
1541
1542         <varlistentry>
1543           <term>casefold = <option>option</option> <type>(V)</type></term>
1544
1545           <listitem>
1546             <para>The casefold option handles, if the case of filenames should
1547             be changed. The available options are:</para>
1548
1549             <para><option>tolower</option> - Lowercases names in both
1550             directions.</para>
1551
1552             <para><option>toupper</option> - Uppercases names in both
1553             directions.</para>
1554
1555             <para><option>xlatelower</option> - Client sees lowercase, server
1556             sees uppercase.</para>
1557
1558             <para><option>xlateupper</option> - Client sees uppercase, server
1559             sees lowercase.</para>
1560           </listitem>
1561         </varlistentry>
1562
1563         <varlistentry>
1564           <term>password = <replaceable>password</replaceable>
1565           <type>(V)</type></term>
1566
1567           <listitem>
1568             <para>This option allows you to set a volume password, which can
1569             be a maximum of 8 characters long (using ASCII strongly
1570             recommended at the time of this writing).</para>
1571           </listitem>
1572         </varlistentry>
1573
1574         <varlistentry>
1575           <term>file perm = <replaceable>mode</replaceable>
1576           <type>(V)</type></term>
1577
1578           <term>directory perm = <replaceable>mode</replaceable>
1579           <type>(V)</type></term>
1580
1581           <listitem>
1582             <para>Add(or) with the client requested permissions: <option>file
1583             perm</option> is for files only, <option>directory perm</option>
1584             is for directories only. Don't use with "<option>unix priv =
1585             no</option>".</para>
1586
1587             <example>
1588               <title>Volume for a collaborative workgroup</title>
1589
1590               <para><programlisting>file perm = 0660 directory perm =
1591               0770</programlisting></para>
1592             </example>
1593           </listitem>
1594         </varlistentry>
1595
1596         <varlistentry>
1597           <term>umask = <replaceable>mode</replaceable>
1598           <type>(V)</type></term>
1599
1600           <listitem>
1601             <para>set perm mask. Don't use with "<option>unix priv =
1602             no</option>".</para>
1603           </listitem>
1604         </varlistentry>
1605
1606         <varlistentry>
1607           <term>preexec = <replaceable>command</replaceable>
1608           <type>(V)</type></term>
1609
1610           <listitem>
1611             <para>command to be run when the volume is mounted, ignored for
1612             user defined volumes</para>
1613           </listitem>
1614         </varlistentry>
1615
1616         <varlistentry>
1617           <term>postexec = <replaceable>command</replaceable>
1618           <type>(V)</type></term>
1619
1620           <listitem>
1621             <para>command to be run when the volume is closed, ignored for
1622             user defined volumes</para>
1623           </listitem>
1624         </varlistentry>
1625
1626         <varlistentry>
1627           <term>root preexec = <replaceable>command</replaceable>
1628           <type>(V)</type></term>
1629
1630           <listitem>
1631             <para>command to be run as root when the volume is mounted,
1632             ignored for user defined volumes</para>
1633           </listitem>
1634         </varlistentry>
1635
1636         <varlistentry>
1637           <term>root postexec = <replaceable>command</replaceable>
1638           <type>(V)</type></term>
1639
1640           <listitem>
1641             <para>command to be run as root when the volume is closed, ignored
1642             for user defined volumes</para>
1643           </listitem>
1644         </varlistentry>
1645
1646         <varlistentry>
1647           <term>rolist = <option>users/groups</option> <type>(V)</type></term>
1648
1649           <listitem>
1650             <para>Allows certain users and groups to have read-only access to
1651             a share. This follows the allow option format.</para>
1652           </listitem>
1653         </varlistentry>
1654
1655         <varlistentry>
1656           <term>rwlist = <replaceable>users/groups</replaceable>
1657           <type>(V)</type></term>
1658
1659           <listitem>
1660             <para>Allows certain users and groups to have read/write access to
1661             a share. This follows the allow option format.</para>
1662           </listitem>
1663         </varlistentry>
1664
1665         <varlistentry>
1666           <term>veto files = <replaceable>vetoed names</replaceable>
1667           <type>(V)</type></term>
1668
1669           <listitem>
1670             <para>hide files and directories,where the path matches one of the
1671             '/' delimited vetoed names. The veto string must always be
1672             terminated with a '/', eg. "veto1/", "veto1/veto2/".</para>
1673           </listitem>
1674         </varlistentry>
1675       </variablelist>
1676     </refsect2>
1677
1678     <refsect2>
1679       <title>Volume options</title>
1680
1681       <para>Boolean volume options.</para>
1682
1683       <variablelist>
1684         <varlistentry>
1685           <term>acls = <replaceable>BOOLEAN</replaceable> (default:
1686           <emphasis>yes</emphasis>) <type>(V)</type></term>
1687
1688           <listitem>
1689             <para>Whether to flag volumes as supporting ACLs. If ACL support
1690             is compiled in, this is yes by default.</para>
1691           </listitem>
1692         </varlistentry>
1693
1694         <varlistentry>
1695           <term>cnid dev = <replaceable>BOOLEAN</replaceable> (default:
1696           <emphasis>yes</emphasis>) <type>(V)</type></term>
1697
1698           <listitem>
1699             <para>Whether to use the device number in the CNID backends. Helps
1700             when the device number is not constant across a reboot, eg
1701             cluster, ...</para>
1702           </listitem>
1703         </varlistentry>
1704
1705         <varlistentry>
1706           <term>convert appledouble = <replaceable>BOOLEAN</replaceable>
1707           (default: <emphasis>yes</emphasis>) <type>(V)</type></term>
1708
1709           <listitem>
1710             <para>Whether automatic conversion from <option>appledouble =
1711             v2</option> to <option>appledouble = ea</option> is performed when
1712             accessing filesystems from clients. This is generally useful, but
1713             costs some performance. It's recommendable to run
1714             <command>dbd</command> on volumes and do the conversion with that.
1715             Then this option can be set to no.</para>
1716           </listitem>
1717         </varlistentry>
1718
1719         <varlistentry>
1720           <term>follow symlinks = <replaceable>BOOLEAN</replaceable> (default:
1721           <emphasis>no</emphasis>) <type>(V)</type></term>
1722
1723           <listitem>
1724             <para>The default setting is false thus symlinks are not followed
1725             on the server. This is the same behaviour as OS X's AFP server.
1726             Setting the option to true causes afpd to follow symlinks on the
1727             server. symlinks may point outside of the AFP volume, currently
1728             afpd doesn't do any checks for "wide symlinks".</para>
1729           </listitem>
1730         </varlistentry>
1731
1732         <varlistentry>
1733           <term>invisible dots = <replaceable>BOOLEAN</replaceable> (default:
1734           <emphasis>no</emphasis>) <type>(V)</type></term>
1735
1736           <listitem>
1737             <para>make dot files invisible. WARNING: enabling this option will
1738               lead to unwanted sideeffects were OS X applications when saving
1739               files to a temporary file starting with a dot first, then renaming
1740               the temp file to its final name, result in the saved file being
1741               invisible. The only thing this option is useful for is making
1742               files that start with a dot invisible on Mac OS 9. It's
1743               completely useless on Mac OS X, as both in Finder and in Terminal
1744               files starting with a dot are hidden anyway.</para>
1745           </listitem>
1746         </varlistentry>
1747
1748         <varlistentry>
1749           <term>network ids = <replaceable>BOOLEAN</replaceable> (default:
1750           <emphasis>yes</emphasis>) <type>(V)</type></term>
1751
1752           <listitem>
1753             <para>Whether the server support network ids. Setting this to
1754             <emphasis>no</emphasis> will result in the client not using ACL
1755             AFP functions.</para>
1756           </listitem>
1757         </varlistentry>
1758
1759         <varlistentry>
1760           <term>preexec close = <replaceable>BOOLEAN</replaceable> (default:
1761           <emphasis>no</emphasis>) <type>(V)</type></term>
1762
1763           <listitem>
1764             <para>A non-zero return code from preexec close the volume being
1765             immediately, preventing clients to mount/see the volume in
1766             question.</para>
1767           </listitem>
1768         </varlistentry>
1769
1770         <varlistentry>
1771           <term>read only = <replaceable>BOOLEAN</replaceable> (default:
1772           <emphasis>no</emphasis>) <type>(V)</type></term>
1773
1774           <listitem>
1775             <para>Specifies the share as being read only for all users.
1776             Overwrites <option>ea = auto</option> with <option>ea =
1777             none</option></para>
1778           </listitem>
1779         </varlistentry>
1780
1781         <varlistentry>
1782           <term>root preexec close= <replaceable>BOOLEAN</replaceable>
1783           (default: <emphasis>no</emphasis>) <type>(V)</type></term>
1784
1785           <listitem>
1786             <para>A non-zero return code from root_preexec closes the volume
1787             immediately, preventing clients to mount/see the volume in
1788             question.</para>
1789           </listitem>
1790         </varlistentry>
1791
1792         <varlistentry>
1793           <term>search db = <replaceable>BOOLEAN</replaceable> (default:
1794           <emphasis>no</emphasis>) <type>(V)</type></term>
1795
1796           <listitem>
1797             <para>Use fast CNID database namesearch instead of slow recursive
1798             filesystem search. Relies on a consistent CNID database, ie Samba
1799             or local filesystem access lead to inaccurate or wrong results.
1800             Works only for "dbd" CNID db volumes.</para>
1801           </listitem>
1802         </varlistentry>
1803
1804         <varlistentry>
1805           <term>stat vol = <replaceable>BOOLEAN</replaceable> (default:
1806           <emphasis>yes</emphasis>) <type>(V)</type></term>
1807
1808           <listitem>
1809             <para>Whether to stat volume path when enumerating volumes list,
1810             useful for automounting or volumes created by a preexec
1811             script.</para>
1812           </listitem>
1813         </varlistentry>
1814
1815         <varlistentry>
1816           <term>time machine = <replaceable>BOOLEAN</replaceable> (default:
1817           <emphasis>no</emphasis>) <type>(V)</type></term>
1818
1819           <listitem>
1820             <para>Whether to enable Time Machine support for this
1821             volume.</para>
1822           </listitem>
1823         </varlistentry>
1824
1825         <varlistentry>
1826           <term>unix priv = <replaceable>BOOLEAN</replaceable> (default:
1827           <emphasis>yes</emphasis>) <type>(V)</type></term>
1828
1829           <listitem>
1830             <para>Whether to use AFP3 UNIX privileges. This should be set for
1831             OS X clients. See also: <option>file perm</option>,
1832             <option>directory perm</option> and <option>umask</option>.</para>
1833           </listitem>
1834         </varlistentry>
1835       </variablelist>
1836     </refsect2>
1837   </refsect1>
1838
1839   <refsect1>
1840     <title>CNID backends</title>
1841
1842     <para>The AFP protocol mostly refers to files and directories by ID and
1843     not by name. Netatalk needs a way to store these ID's in a persistent way,
1844     to achieve this several different CNID backends are available. The CNID
1845     Databases are by default located in the
1846     <filename>@localstatedir@/netatalk/CNID/(volumename)/.AppleDB/</filename>
1847     directory.</para>
1848
1849     <variablelist>
1850       <varlistentry>
1851         <term>cdb</term>
1852
1853         <listitem>
1854           <para>"Concurrent database", backend is based on Oracle Berkley DB.
1855           With this backend several <command>afpd</command> daemons access the
1856           CNID database directly. Berkeley DB locking is used to synchronize
1857           access, if more than one <command>afpd</command> process is active
1858           for a volume. The drawback is, that the crash of a single
1859           <command>afpd</command> process might corrupt the database.</para>
1860         </listitem>
1861       </varlistentry>
1862
1863       <varlistentry>
1864         <term>dbd</term>
1865
1866         <listitem>
1867           <para>Access to the CNID database is restricted to the
1868           <command>cnid_metad</command> daemon process.
1869           <command>afpd</command> processes communicate with the daemon for
1870           database reads and updates. If built with Berkeley DB transactions
1871           the probability for database corruption is practically zero, but
1872           performance can be slower than with <option>cdb</option></para>
1873         </listitem>
1874       </varlistentry>
1875
1876       <varlistentry>
1877         <term>last</term>
1878
1879         <listitem>
1880           <para>This backend is an exception, in terms of ID persistency. ID's
1881           are only valid for the current session. This is basically what
1882           <command>afpd</command> did in the 1.5 (and 1.6) versions. This
1883           backend is still available, as it is useful for e.g. sharing cdroms.
1884           Starting with Netatalk 3.0, it becomes the <emphasis>read only
1885           mode</emphasis> automatically.</para>
1886
1887           <para><emphasis role="bold">Warning</emphasis>: It is
1888           <emphasis>NOT</emphasis> recommended to use this backend for volumes
1889           anymore, as <command>afpd</command> now relies heavily on a
1890           persistent ID database. Aliases will likely not work and filename
1891           mangling is not supported.</para>
1892         </listitem>
1893       </varlistentry>
1894     </variablelist>
1895
1896     <para>Even though <command>./configure --help</command> might show that
1897     there are other CNID backends available, be warned those are likely broken
1898     or mainly used for testing. Don't use them unless you know what you're
1899     doing, they may be removed without further notice from future
1900     versions.</para>
1901   </refsect1>
1902
1903   <refsect1>
1904     <title>Charset options</title>
1905
1906     <para>With OS X Apple introduced the AFP3 protocol. One of the most
1907     important changes was that AFP3 uses unicode names encoded as UTF-8
1908     decomposed. Previous AFP/OS versions used codepages, like MacRoman,
1909     MacCentralEurope, etc.</para>
1910
1911     <para><command>afpd</command> needs a way to preserve extended Macintosh
1912     characters, or characters illegal in unix filenames, when saving files on
1913     a unix filesystem. Earlier versions used the the so called CAP encoding.
1914     An extended character (&gt;0x7F) would be converted to a :xx sequence,
1915     e.g. the Apple Logo (MacRoman: 0xF0) was saved as <literal>:f0</literal>.
1916     Some special characters will be converted as to :xx notation as well.
1917     '<keycode>/</keycode>' will be encoded to <literal>:2f</literal>, if
1918     <option>usedots</option> is not specified, a leading dot
1919     '<keycode>.</keycode>' will be encoded as <literal>:2e</literal>.</para>
1920
1921     <para>This version now uses UTF-8 as the default encoding for names.
1922     '<keycode>/</keycode>' will be converted to '<keycode>:</keycode>'.</para>
1923
1924     <para>The <option>vol charset</option> option will allow you to select
1925     another volume encoding. E.g. for western users another useful setting
1926     could be vol charset ISO-8859-15. <command>afpd</command> will accept any
1927     <citerefentry>
1928         <refentrytitle><command>iconv</command></refentrytitle>
1929
1930         <manvolnum>1</manvolnum>
1931       </citerefentry> provided charset. If a character cannot be converted
1932     from the <option>mac charset</option> to the selected <option>vol
1933     charset</option>, afpd will save it as a CAP encoded character. For AFP3
1934     clients, <command>afpd</command> will convert the UTF-8<indexterm>
1935         <primary>UTF8</primary>
1936
1937         <secondary>afpd's vol charset setting</secondary>
1938       </indexterm><indexterm>
1939         <primary>UTF8-MAC</primary>
1940
1941         <secondary>afpd's vol charset setting</secondary>
1942       </indexterm><indexterm>
1943         <primary>ISO-8859-15</primary>
1944
1945         <secondary>afpd's vol charset setting</secondary>
1946       </indexterm><indexterm>
1947         <primary>ISO-8859-1</primary>
1948
1949         <secondary>afpd's vol charset setting</secondary>
1950       </indexterm> character to <option>mac charset</option> first. If this
1951     conversion fails, you'll receive a -50 error on the mac.</para>
1952
1953     <para><emphasis>Note</emphasis>: Whenever you can, please stick with the
1954     default UTF-8 volume format.</para>
1955   </refsect1>
1956
1957   <refsect1>
1958     <title>SEE ALSO</title>
1959
1960     <para><citerefentry>
1961         <refentrytitle>afpd</refentrytitle>
1962
1963         <manvolnum>8</manvolnum>
1964       </citerefentry>, <citerefentry>
1965         <refentrytitle>afppasswd</refentrytitle>
1966
1967         <manvolnum>5</manvolnum>
1968       </citerefentry>, <citerefentry>
1969         <refentrytitle>afp_signature.conf</refentrytitle>
1970
1971         <manvolnum>5</manvolnum>
1972       </citerefentry>, <citerefentry>
1973         <refentrytitle>extmap.conf</refentrytitle>
1974
1975         <manvolnum>5</manvolnum>
1976       </citerefentry>, <citerefentry>
1977         <refentrytitle>cnid_metad</refentrytitle>
1978
1979         <manvolnum>8</manvolnum>
1980       </citerefentry></para>
1981   </refsect1>
1982 </refentry>