X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=netatalk.git;a=blobdiff_plain;f=doc%2Fmanpages%2Fman5%2Fafp.conf.5.xml;h=44e083c282f1f20a757ffaae0eb89ae60d290938;hp=44b5a4681806a0e8cb8ed24c885455c4165d23bc;hb=3a84db87064922ad10ac10cc1d6833380e575995;hpb=530376ceef7d0d5e4187dbf7246bd217782d9e5a
diff --git a/doc/manpages/man5/afp.conf.5.xml b/doc/manpages/man5/afp.conf.5.xml
index 44b5a468..44e083c2 100644
--- a/doc/manpages/man5/afp.conf.5.xml
+++ b/doc/manpages/man5/afp.conf.5.xml
@@ -5,9 +5,9 @@
5
- 30 Apr 2013
+ 05 Jun 2014
- :NETATALK_VERSION:
+ @NETATALK_VERSION@
@@ -157,7 +157,7 @@
VARIABLE SUBSTITUTIONSYou can use variables in volume names. The use of variables in paths
- is not supported for now.
+ is limited to $u.
@@ -383,7 +383,7 @@
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 "". See
afppasswd
@@ -428,7 +428,7 @@
Sets the default path for UAMs for this server (default is
- :LIBDIR:/netatalk).
+ @libdir@/netatalk).
@@ -509,7 +509,7 @@
Sets the path to the Randnum UAM passwd file for this server
- (default is :ETCDIR:/afppasswd).
+ (default is @pkgconfdir@/afppasswd).
@@ -554,6 +554,16 @@
+
+ afp interfaces = name [name ...]
+ (G)
+
+ 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.
+
+
+
afp listen = ip address[:port] [ip address[:port]
...](G)
@@ -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.
+ IPv6 address + port combination must use URL the format
+ using square brackets [IPv6]:port
@@ -661,10 +673,10 @@
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
+ 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
@@ -701,6 +713,24 @@
+
+ recvfile = BOOLEAN (default:
+ no) (G)
+
+
+ Whether to use splice() on Linux for receiving data.
+
+
+
+
+ splice size = number (default:
+ 64k) (G)
+
+
+ Maximum number of bytes spliced.
+
+
+
use sendfile = BOOLEAN (default:
yes) (G)
@@ -712,6 +742,7 @@
+
zeroconf = BOOLEAN (default:
yes) (G)
@@ -776,6 +807,29 @@
+
+ chmod request = preserve (default) | ignore | simple
+ (G/V)
+
+
+ Advanced permission control that deals with ACLs.
+
+
+
+ - UNIX chmod() requests are completely ignored
+
+
+ - preserve ZFS ACEs for
+ named users and groups or POSIX ACL group mask
+
+
+ - just to a chmod() as
+ requested without any extra steps
+
+
+
+
+
close vol = BOOLEAN (default:
no) (G)
@@ -787,6 +841,44 @@
+
+ cnid mysql host = MySQL server address
+ (G)
+
+
+ name or address of a MySQL server for use with the mysql CNID
+ backend.
+
+
+
+
+ cnid mysql user = MySQL user
+ (G)
+
+
+ MySQL user for authentication with the server.
+
+
+
+
+ cnid mysql pw = password
+ (G)
+
+
+ Password for MySQL server.
+
+
+
+
+ cnid mysql db = database name
+ (G)
+
+
+ Name of an existing database for which the specified user
+ has full privileges.
+
+
+
cnid server = ipaddress[:port](G)/(V)
@@ -799,6 +891,16 @@
+
+ dbus daemon = path
+ (G)
+
+
+ Sets the path to dbus-daemon binary used by Spotlight feature.
+ The default is /bin/dbus-daemon.
+
+
+
dircachesize = number(G)
@@ -822,7 +924,23 @@
Sets the path to the file which defines file extension
- type/creator mappings. (default is :ETCDIR:/extmap.conf).
+ type/creator mappings. (default is @pkgconfdir@/extmap.conf).
+
+
+
+
+ force xattr with sticky bit =
+ BOOLEAN (default:
+ no) (G/V)
+
+
+ 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.
+
+ By enabling this option Netatalk will write the
+ metadata xattr as root.
@@ -846,6 +964,21 @@
+
+ ignored attributes = all | nowrite | nodelete | norename
+ (G)/(V)
+
+
+ Speficy a set of file and directory attributes that shall
+ be ignored by the server, includes all
+ the other options.
+ 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 ignored attributes = all.
+
+
+
login message = message(G)/(V)
@@ -878,7 +1011,7 @@
characters. This option is useful for clustered environments, to
provide fault isolation etc. By default, afpd generate signature
and saving it to
- :STATEDIR:/netatalk/afp_signature.conf
+ @localstatedir@/netatalk/afp_signature.conf
automatically (based on random number). See also
asip-status.pl(1).
@@ -896,15 +1029,109 @@
+
+ sparql results limit =
+ NUMBER (default:
+ UNLIMITED) (G)
+
+
+ Impose a limit on the number of results queried from Tracker
+ via SPARQL queries.
+
+
+
+
+ spotlight =
+ BOOLEAN (default:
+ no) (G)/(V)
+
+
+ Whether to enable Spotlight searches. Note: once the global
+ option is enabled, any volume that is not enabled won't be
+ searchable at all. See also dbus daemon
+ option.
+
+
+
+
+ spotlight attributes =
+ COMMA SEPERATED STRING (default:
+ EMPTY) (G)
+
+
+ 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: spotlight
+ attributes = *,kMDItemTextContent
+
+
+
+
+
+ spotlight expr =
+ BOOLEAN (default:
+ yes) (G)
+
+
+ Whether to allow the use of logic expression in
+ searches.
+
+
+
+
+ start dbus =
+ BOOLEAN (default:
+ yes) (G)
+
+
+ Whether to start a dbus instance for use with Tracker.
+
+
+
+
+ start tracker =
+ BOOLEAN (default:
+ yes) (G)
+
+
+ Whether to start Tracker with
+ tracker-control -s.
+
+
+
+
+ veto message = BOOLEAN (default:
+ no) (G)
+
+
+ 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.
+
+
+
vol dbpath = path
- (G)
+ (G)/(V)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
- :STATEDIR:/netatalk/CNID/.
+ @localstatedir@/netatalk/CNID/$v/.
+
+
+
+
+ vol dbnest = BOOLEAN (default:
+ no) (G)
+
+
+ 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.
@@ -1093,7 +1320,7 @@
mode. You can adjust this behaviour with the configuration option
:
-
+ map acls = none|rights|mode(G)
@@ -1276,6 +1503,16 @@
+
+ ldap group attr = dn
+ (G)
+
+
+ Name of the LDAP attribute with the groups short
+ name.
+
+
+
ldap uuid string = STRING(G)
@@ -1301,7 +1538,8 @@
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.
-
+ See also the options and
+ .string
@@ -1323,14 +1561,27 @@
- ldap group attr = dn
+ ldap user filter = STRING (default: unused)(G)
- Name of the LDAP attribute with the groups short
- name.
+ 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.
+ Recommended setting for Active Directory: objectClass=user.
+
+
+
+
+ ldap group filter = STRING (default: unused)
+ (G)
+
+
+ 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.
+ Recommended setting for Active Directory: objectClass=group.
+
@@ -1446,8 +1697,8 @@
set the CNID backend to be used for the volume, default is
- [:DEFAULT_CNID_SCHEME:] available schemes:
- [:COMPILED_BACKENDS:]
+ [@DEFAULT_CNID_SCHEME@] available schemes:
+ [@compiled_backends@]
@@ -1647,7 +1898,8 @@
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/".
+ terminated with a '/', eg. "veto files = veto1/", "veto files =
+ veto1/veto2/".
@@ -1694,6 +1946,23 @@
+
+ delete veto files = BOOLEAN
+ (default: no) (V)
+
+
+ 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.
+ If this option is set to yes, then Netatalk will attempt to
+ recursively delete any files and directories within the vetoed
+ directory.
+
+
+
follow symlinks = BOOLEAN (default:
no) (V)
@@ -1704,6 +1973,10 @@
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".
+
+ This option will subtly break when the symlinks point
+ across filesystem boundaries.
+
@@ -1821,7 +2094,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
- :STATEDIR:/netatalk/CNID/(volumename)/.AppleDB/
+ @localstatedir@/netatalk/CNID/(volumename)/.AppleDB/
directory.