]> arthur.barton.de Git - netatalk.git/blobdiff - doc/manpages/man5/afp.conf.5.xml
Merge remote-tracking branch 'origin/branch-netatalk-3-1'
[netatalk.git] / doc / manpages / man5 / afp.conf.5.xml
index 8f398334ca45dbdcef3944e1674f4fd519f5eccc..2f5ef1a8e4abfc5d6360753aea81d5484601bd3e 100644 (file)
@@ -5,7 +5,7 @@
 
     <manvolnum>5</manvolnum>
 
-    <refmiscinfo class="date">09 Feb 2013</refmiscinfo>
+    <refmiscinfo class="date">05 Jun 2014</refmiscinfo>
 
     <refmiscinfo class="source">@NETATALK_VERSION@</refmiscinfo>
   </refmeta>
     <title>VARIABLE SUBSTITUTIONS</title>
 
     <para>You can use variables in volume names. The use of variables in paths
-    is not supported for now.</para>
+     is limited to $u.</para>
 
     <orderedlist>
       <listitem>
           </listitem>
         </varlistentry>
 
+        <varlistentry>
+          <term>chmod request = <replaceable>preserve (default) | ignore | simple</replaceable>
+          <type>(G/V)</type></term>
+
+          <listitem>
+            <para>Advanced permission control that deals with ACLs.</para>
+
+            <itemizedlist>
+              <listitem><para>
+                <option>ignore</option> - UNIX chmod() requests are completely ignored
+                     </para></listitem>
+              <listitem><para>
+                <option>preserve</option> - preserve ZFS ACEs for
+                named users and groups or POSIX ACL group mask
+                     </para></listitem>
+              <listitem><para>
+                <option>simple</option> - just to a chmod() as
+                requested without any extra steps
+                     </para></listitem>
+                   </itemizedlist>
+          </listitem>
+        </varlistentry>
+
         <varlistentry>
           <term>close vol = <replaceable>BOOLEAN</replaceable> (default:
           <emphasis>no</emphasis>) <type>(G)</type></term>
           </listitem>
         </varlistentry>
 
+        <varlistentry>
+          <term>force xattr with sticky bit =
+          <replaceable>BOOLEAN</replaceable> (default:
+          <emphasis>no</emphasis>) <type>(G/V)</type></term>
+
+          <listitem>
+            <para>Writing metadata xattr on directories with the
+            sticky bit set may fail even though we may have write
+            access to a directory, because if the sticky bit is set
+            only the owner is allowed to write xattrs.</para>
+
+            <para>By enabling this option Netatalk will write the
+            metadata xattr as root.</para>
+          </listitem>
+        </varlistentry>
+
         <varlistentry>
           <term>guest account = <replaceable>name</replaceable>
           <type>(G)</type></term>
           </listitem>
         </varlistentry>
 
+        <varlistentry>
+          <term>sparql results limit =
+          <replaceable>NUMBER</replaceable> (default:
+          <emphasis>UNLIMITED</emphasis>) <type>(G)</type></term>
+
+          <listitem>
+            <para>Impose a limit on the number of results queried from Tracker
+           via SPARQL queries.</para>
+          </listitem>
+        </varlistentry>
+
         <varlistentry>
           <term>spotlight =
           <replaceable>BOOLEAN</replaceable> (default:
           </listitem>
         </varlistentry>
 
+        <varlistentry>
+          <term>spotlight attributes =
+          <replaceable>COMMA SEPERATED STRING</replaceable> (default:
+          <emphasis>EMPTY</emphasis>) <type>(G)</type></term>
+
+          <listitem>
+            <para>A list of attributes that are allowed to be used in
+            Spotlight searches. By default all attributes can be
+            searched, passing a string limits attributes to elements
+            of the string. Example: <programlisting>spotlight
+            attributes = *,kMDItemTextContent</programlisting>
+           </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>spotlight expr =
+          <replaceable>BOOLEAN</replaceable> (default:
+          <emphasis>yes</emphasis>) <type>(G)</type></term>
+
+          <listitem>
+            <para>Whether to allow the use of logic expression in
+            searches.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>start dbus =
+          <replaceable>BOOLEAN</replaceable> (default:
+          <emphasis>yes</emphasis>) <type>(G)</type></term>
+
+          <listitem>
+            <para>Whether to start a dbus instance for use with Tracker.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>start tracker =
+          <replaceable>BOOLEAN</replaceable> (default:
+          <emphasis>yes</emphasis>) <type>(G)</type></term>
+
+          <listitem>
+            <para>Whether to start Tracker with 
+            <emphasis>tracker-control -s</emphasis>.</para>
+          </listitem>
+        </varlistentry>
+
         <varlistentry>
           <term>veto message = <replaceable>BOOLEAN</replaceable> (default:
           <emphasis>no</emphasis>) <type>(G)</type></term>
 
         <varlistentry>
           <term>vol dbpath = <replaceable>path</replaceable>
-          <type>(G)</type></term>
+          <type>(G)/(V)</type></term>
 
           <listitem>
             <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>@localstatedir@/netatalk/CNID/</filename>.</para>
+            <filename>@localstatedir@/netatalk/CNID/$v/</filename>.</para>
           </listitem>
         </varlistentry>
 
       afpd processes notify interested listeners about certain filesystem
       event by UDP network datagrams.</para>
 
+      <para>The following FCE events are defined:</para>
+
+      <itemizedlist>
+        <listitem><para>file modification (<option>fmod</option>)</para></listitem>
+        <listitem><para>file deletion (<option>fdel</option>)</para></listitem>
+        <listitem><para>directory deletion (<option>ddel</option>)</para></listitem>
+        <listitem><para>file creation (<option>fcre</option>)</para></listitem>
+        <listitem><para>directory creation (<option>dcre</option>)</para></listitem>
+        <listitem><para>file move or rename (<option>fmov</option>)</para></listitem>
+        <listitem><para>directory move or rename (<option>dmov</option>)</para></listitem>
+        <listitem><para>login (<option>login</option>)</para></listitem>
+        <listitem><para>logout (<option>logout</option>)</para></listitem>
+      </itemizedlist>
+
       <variablelist>
         <varlistentry>
           <term>fce listener = <replaceable>host[:port]</replaceable>
           </listitem>
         </varlistentry>
 
+        <varlistentry>
+          <term>fce version = <replaceable>1|2</replaceable>
+          <type>(G)</type></term>
+
+          <listitem>
+            <para>FCE protocol version, default is 1. You need version
+            2 for the fmov, dmov, login or logout events.</para>
+          </listitem>
+        </varlistentry>
+
         <varlistentry>
           <term>fce events =
-          <replaceable>fmod,fdel,ddel,fcre,dcre,tmsz</replaceable>
+          <replaceable>fmod,fdel,ddel,fcre,dcre,fmov,dmov,login,logout</replaceable>
           <type>(G)</type></term>
 
           <listitem>
             seconds.</para>
           </listitem>
         </varlistentry>
+
+        <varlistentry>
+          <term>fce ignore names = <replaceable>NAME[/NAME2/...]</replaceable>
+          <type>(G)</type></term>
+
+          <listitem>
+            <para>Slash delimited list of filenames for which FCE
+            events shall not be generated. Default: .DS_Store.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>fce notify script = <replaceable>PATH</replaceable>
+          <type>(G)</type></term>
+
+          <listitem>
+            <para>Script which will be executed for every FCE event,
+            see contrib/shell_utils/fce_ev_script.shfrom the Netatalk
+            sources for an example script.</para>
+          </listitem>
+        </varlistentry>
+
       </variablelist>
     </refsect2>