New boolean volume option "delete veto files"

[netatalk.git] / doc / manpages / man5 / afp.conf.5.xml

diff --git a/doc/manpages/man5/afp.conf.5.xml b/doc/manpages/man5/afp.conf.5.xml
index 44b5a4681806a0e8cb8ed24c885455c4165d23bc..27e8b14e81d3aff738e6a25aeeeea572392e252c 100644 (file)
--- a/doc/manpages/man5/afp.conf.5.xml
+++ b/doc/manpages/man5/afp.conf.5.xml
@@ -7,7 +7,7 @@
 
     <refmiscinfo class="date">30 Apr 2013</refmiscinfo>
 
 
     <refmiscinfo class="date">30 Apr 2013</refmiscinfo>
 

-    <refmiscinfo class="source">:NETATALK_VERSION:</refmiscinfo>
+    <refmiscinfo class="source">@NETATALK_VERSION@</refmiscinfo>

   </refmeta>
 
   <refnamediv>
   </refmeta>
 
   <refnamediv>


@@ -383,7 +383,7 @@
                 <listitem>
                   <para>allows Random Number and Two-Way Random Number
                   Exchange for authentication (requires a separate file
                 <listitem>
                   <para>allows Random Number and Two-Way Random Number
                   Exchange for authentication (requires a separate file

-                  containing the passwords, either :ETCDIR:/afppasswd file or
+                  containing the passwords, either @pkgconfdir@/afppasswd file or

                   the one specified via "<option>passwd file</option>". See
                   <citerefentry>
                       <refentrytitle>afppasswd</refentrytitle>
                   the one specified via "<option>passwd file</option>". See
                   <citerefentry>
                       <refentrytitle>afppasswd</refentrytitle>


@@ -428,7 +428,7 @@
 
           <listitem>
             <para>Sets the default path for UAMs for this server (default is
 
           <listitem>
             <para>Sets the default path for UAMs for this server (default is

-            :LIBDIR:/netatalk).</para>
+            @libdir@/netatalk).</para>

           </listitem>
         </varlistentry>
       </variablelist>
           </listitem>
         </varlistentry>
       </variablelist>


@@ -509,7 +509,7 @@
 
           <listitem>
             <para>Sets the path to the Randnum UAM passwd file for this server
 
           <listitem>
             <para>Sets the path to the Randnum UAM passwd file for this server

-            (default is :ETCDIR:/afppasswd).</para>
+            (default is @pkgconfdir@/afppasswd).</para>

           </listitem>
         </varlistentry>
 
           </listitem>
         </varlistentry>
 


@@ -554,6 +554,16 @@
           </listitem>
         </varlistentry>
 
           </listitem>
         </varlistentry>
 

+        <varlistentry>
+          <term>afp interfaces = <replaceable>name [name ...]</replaceable>
+            <type>(G)</type></term>
+          <listitem>
+            <para>Specifies the network interfaces that the server should
+            listens on. The default is advertise the first IP address of the
+            system, but to listen for any incoming request.</para>
+          </listitem>
+        </varlistentry>
+

         <varlistentry>
           <term>afp listen = <replaceable>ip address[:port] [ip address[:port]
           ...]</replaceable> <type>(G)</type></term>
         <varlistentry>
           <term>afp listen = <replaceable>ip address[:port] [ip address[:port]
           ...]</replaceable> <type>(G)</type></term>


@@ -565,6 +575,8 @@
             any incoming request. The network address may be specified either
             in dotted-decimal format for IPv4 or in hexadecimal format for
             IPv6.</para>
             any incoming request. The network address may be specified either
             in dotted-decimal format for IPv4 or in hexadecimal format for
             IPv6.</para>

+            <para>IPv6 address + port combination must use URL the format
+            using square brackets [IPv6]:port</para>

           </listitem>
         </varlistentry>
 
           </listitem>
         </varlistentry>
 


@@ -822,7 +834,7 @@
 
           <listitem>
             <para>Sets the path to the file which defines file extension
 
           <listitem>
             <para>Sets the path to the file which defines file extension

-            type/creator mappings. (default is :ETCDIR:/extmap.conf).</para>
+            type/creator mappings. (default is @pkgconfdir@/extmap.conf).</para>

           </listitem>
         </varlistentry>
 
           </listitem>
         </varlistentry>
 


@@ -857,6 +869,21 @@
           </listitem>
         </varlistentry>
 
           </listitem>
         </varlistentry>
 

+        <varlistentry>
+          <term>ignored attributes = <replaceable>all | nowrite | nodelete | norename</replaceable>
+          <type>(G)/(V)</type></term>
+
+          <listitem>
+            <para>Speficy a set of file and directory attributes that shall
+            be ignored by the server, <attribute>all</attribute> includes all
+            the other options.</para>
+            <para>In OS X when the Finder sets a lock on a file/directory or you
+            set the BSD uchg flag in the Terminal, all three attributes are
+            used. Thus in order to ignore the Finder lock/BSD uchg flag, add
+            set <emphasis>ignored attributes = all</emphasis>.</para>
+          </listitem>
+        </varlistentry>
+

         <varlistentry>
           <term>mimic model = <replaceable>model</replaceable>
           <type>(G)</type></term>
         <varlistentry>
           <term>mimic model = <replaceable>model</replaceable>
           <type>(G)</type></term>


@@ -878,7 +905,7 @@
             characters. This option is useful for clustered environments, to
             provide fault isolation etc. By default, afpd generate signature
             and saving it to
             characters. This option is useful for clustered environments, to
             provide fault isolation etc. By default, afpd generate signature
             and saving it to

-            <filename>:STATEDIR:/netatalk/afp_signature.conf</filename>
+            <filename>@localstatedir@/netatalk/afp_signature.conf</filename>

             automatically (based on random number). See also
             asip-status.pl(1).</para>
           </listitem>
             automatically (based on random number). See also
             asip-status.pl(1).</para>
           </listitem>


@@ -896,6 +923,17 @@
           </listitem>
         </varlistentry>
 
           </listitem>
         </varlistentry>
 

+        <varlistentry>
+          <term>veto message = <replaceable>BOOLEAN</replaceable> (default:
+          <emphasis>no</emphasis>) <type>(G)</type></term>
+
+          <listitem>
+            <para>Use section <option>name</option> as option preset for all
+            volumes (when set in the [Global] section) or for one volume (when
+            set in that volume's section).</para>
+          </listitem>
+        </varlistentry>
+

         <varlistentry>
           <term>vol dbpath = <replaceable>path</replaceable>
           <type>(G)</type></term>
         <varlistentry>
           <term>vol dbpath = <replaceable>path</replaceable>
           <type>(G)</type></term>


@@ -904,7 +942,7 @@
             <para>Sets the database information to be stored in path. You have
             to specify a writable location, even if the volume is read only.
             The default is
             <para>Sets the database information to be stored in path. You have
             to specify a writable location, even if the volume is read only.
             The default is

-            <filename>:STATEDIR:/netatalk/CNID/</filename>.</para>
+            <filename>@localstatedir@/netatalk/CNID/</filename>.</para>

           </listitem>
         </varlistentry>
 
           </listitem>
         </varlistentry>
 


@@ -1446,8 +1484,8 @@
 
           <listitem>
             <para>set the CNID backend to be used for the volume, default is
 
           <listitem>
             <para>set the CNID backend to be used for the volume, default is

-            [:DEFAULT_CNID_SCHEME:] available schemes:
-            [:COMPILED_BACKENDS:]</para>
+            [@DEFAULT_CNID_SCHEME@] available schemes:
+            [@compiled_backends@]</para>

           </listitem>
         </varlistentry>
 
           </listitem>
         </varlistentry>
 


@@ -1694,6 +1732,23 @@
           </listitem>
         </varlistentry>
 
           </listitem>
         </varlistentry>
 

+        <varlistentry>
+          <term>delete veto files = <replaceable>BOOLEAN</replaceable>
+          (default: <emphasis>no</emphasis>) <type>(V)</type></term>
+
+          <listitem>
+            <para>This option is used when Netatalk is attempting to delete a
+            directory that contains one or more vetoed files or directories
+            (see the veto files option). If this option is set to no (the
+            default) then if a directory contains any non-vetoed files or
+            directories then the directory delete will fail. This is usually
+            what you want.</para>
+            <para>If this option is set to yes, then Netatalk will attempt to
+            recursively delete any files and directories within the vetoed
+            directory.</para>
+          </listitem>
+        </varlistentry>
+

         <varlistentry>
           <term>follow symlinks = <replaceable>BOOLEAN</replaceable> (default:
           <emphasis>no</emphasis>) <type>(V)</type></term>
         <varlistentry>
           <term>follow symlinks = <replaceable>BOOLEAN</replaceable> (default:
           <emphasis>no</emphasis>) <type>(V)</type></term>


@@ -1821,7 +1876,7 @@
     not by name. Netatalk needs a way to store these ID's in a persistent way,
     to achieve this several different CNID backends are available. The CNID
     Databases are by default located in the
     not by name. Netatalk needs a way to store these ID's in a persistent way,
     to achieve this several different CNID backends are available. The CNID
     Databases are by default located in the

-    <filename>:STATEDIR:/netatalk/CNID/(volumename)/.AppleDB/</filename>
+    <filename>@localstatedir@/netatalk/CNID/(volumename)/.AppleDB/</filename>

     directory.</para>
 
     <variablelist>
     directory.</para>
 
     <variablelist>