<manvolnum>5</manvolnum>
- <refmiscinfo class="date">30 Apr 2013</refmiscinfo>
+ <refmiscinfo class="date">09 Feb 2013</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>
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>
<para>This specifies the DSI server quantum. The default value is
- 1 MB. The maximum value is 0xFFFFFFFFF, the minimum is 32000. If
- you specify a value that is out of range, the default value will
- be set. Do not change this value unless you're absolutely sure,
- what you're doing</para>
+ 0x100000 (1 MiB). The maximum value is 0xFFFFFFFFF, the minimum is
+ 32000. If you specify a value that is out of range, the default
+ value will be set. Do not change this value unless you're
+ absolutely sure, what you're doing</para>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>recvfile = <replaceable>BOOLEAN</replaceable> (default:
+ <emphasis>no</emphasis>) <type>(G)</type></term>
+
+ <listitem>
+ <para>Whether to use splice() on Linux for receiving data.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>splice size = <replaceable>number</replaceable> (default:
+ <emphasis>64k</emphasis>) <type>(G)</type></term>
+
+ <listitem>
+ <para>Maximum number of bytes spliced.</para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term>use sendfile = <replaceable>BOOLEAN</replaceable> (default:
<emphasis>yes</emphasis>) <type>(G)</type></term>
</listitem>
</varlistentry>
+
<varlistentry>
<term>zeroconf = <replaceable>BOOLEAN</replaceable> (default:
<emphasis>yes</emphasis>) <type>(G)</type></term>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>cnid mysql host = <replaceable>MySQL server address</replaceable>
+ <type>(G)</type></term>
+
+ <listitem>
+ <para>name or address of a MySQL server for use with the mysql CNID
+ backend.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>cnid mysql user = <replaceable>MySQL user</replaceable>
+ <type>(G)</type></term>
+
+ <listitem>
+ <para>MySQL user for authentication with the server.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>cnid mysql pw = <replaceable>password</replaceable>
+ <type>(G)</type></term>
+
+ <listitem>
+ <para>Password for MySQL server.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>cnid mysql db = <replaceable>database name</replaceable>
+ <type>(G)</type></term>
+
+ <listitem>
+ <para>Name of an existing database for which the specified user
+ has full privileges.</para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term>cnid server = <replaceable>ipaddress[:port]</replaceable>
<type>(G)/(V)</type></term>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>dbus daemon = <parameter>path</parameter>
+ <type>(G)</type></term>
+
+ <listitem>
+ <para>Sets the path to dbus-daemon binary used by Spotlight feature.
+ The default is <filename>/bin/dbus-daemon</filename>.</para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term>dircachesize = <replaceable>number</replaceable>
<type>(G)</type></term>
</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, <option>all</option> 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>login message = <replaceable>message</replaceable>
<type>(G)/(V)</type></term>
<listitem>
<para>Whether to enable Spotlight searches. Note: once the global
option is enabled, any volume that is not enabled won't be
- searchable at all.</para>
+ searchable at all. See also <emphasis>dbus daemon</emphasis>
+ option.</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>
+
+ <listitem>
+ <para>Send optional AFP messages for vetoed files. Then whenever a
+ client tries to access any file or directory with a vetoed name,
+ it will be sent an AFP message indicating the name and the
+ directory.</para>
</listitem>
</varlistentry>
<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>
+
+ <varlistentry>
+ <term>vol dbnest = <replaceable>BOOLEAN</replaceable> (default:
+ <emphasis>no</emphasis>) <type>(G)</type></term>
+
+ <listitem>
+ <para>Setting this option to true brings back Netatalk 2
+ behaviour of storing the CNID database in a folder called
+ .AppleDB inside the volume root of each share.</para>
</listitem>
</varlistentry>
mode. You can adjust this behaviour with the configuration option
<option>mac acls</option>:</para>
- <variablelist id="mac_acls">
+ <variablelist id="map_acls">
<varlistentry>
<term>map acls = <parameter>none|rights|mode</parameter>
<type>(G)</type></term>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>ldap group attr = <parameter>dn</parameter>
+ <type>(G)</type></term>
+
+ <listitem>
+ <para>Name of the LDAP attribute with the groups short
+ name.</para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term>ldap uuid string = <parameter>STRING</parameter>
<type>(G)</type></term>
internal UUID representation is converted to and from the binary
format used in the objectGUID attribute found on objects in Active
Directory when interacting with the server.</para>
-
+ <para>See also the options <option>ldap user filter</option> and
+ <option>ldap group filter</option>.</para>
<para><variablelist>
<varlistentry>
<term>string</term>
</varlistentry>
<varlistentry>
- <term>ldap group attr = <parameter>dn</parameter>
+ <term>ldap user filter = <parameter>STRING (default: unused)</parameter>
<type>(G)</type></term>
<listitem>
- <para>Name of the LDAP attribute with the groups short
- name.</para>
+ <para>Optional LDAP filter that matches user objects. This is necessary for Active Directory
+ environments where users and groups are stored in the same directory subtree.</para>
+ <para>Recommended setting for Active Directory: <parameter>objectClass=user</parameter>.</para>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term>ldap group filter = <parameter>STRING (default: unused)</parameter>
+ <type>(G)</type></term>
+
+ <listitem>
+ <para>Optional LDAP filter that matches group objects. This is necessary for Active Directory
+ environments where users and groups are stored in the same directory subtree.</para>
+ <para>Recommended setting for Active Directory: <parameter>objectClass=group</parameter>.</para>
+ </listitem>
+ </varlistentry>
+
</variablelist>
</refsect2>
</refsect1>
<listitem>
<para>hide files and directories,where the path matches one of the
'/' delimited vetoed names. The veto string must always be
- terminated with a '/', eg. "veto1/", "veto1/veto2/".</para>
+ terminated with a '/', eg. "veto files = veto1/", "veto files =
+ veto1/veto2/".</para>
</listitem>
</varlistentry>
</variablelist>
</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>
Setting the option to true causes afpd to follow symlinks on the
server. symlinks may point outside of the AFP volume, currently
afpd doesn't do any checks for "wide symlinks".</para>
+ <note>
+ <para>This option will subtly break when the symlinks point
+ across filesystem boundaries.</para>
+ </note>
</listitem>
</varlistentry>
projects / netatalk.git / blobdiff