X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=netatalk.git;a=blobdiff_plain;f=man%2Fman5%2Fafp.conf.5.in;h=5356bdf2e9434591015b67173aa131fa83603db1;hp=f8ade925c8ac010a387258399c5ebbcb61914f57;hb=3a84db87064922ad10ac10cc1d6833380e575995;hpb=22fc09809589e0dff0d9b1e1ff1647206f052fad diff --git a/man/man5/afp.conf.5.in b/man/man5/afp.conf.5.in index f8ade925..5356bdf2 100644 --- a/man/man5/afp.conf.5.in +++ b/man/man5/afp.conf.5.in @@ -2,12 +2,12 @@ .\" Title: afp.conf .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.78.0 -.\" Date: 30 Apr 2013 +.\" Date: 05 Jun 2014 .\" Manual: @NETATALK_VERSION@ .\" Source: @NETATALK_VERSION@ .\" Language: English .\" -.TH "AFP\&.CONF" "5" "30 Apr 2013" "@NETATALK_VERSION@" "@NETATALK_VERSION@" +.TH "AFP\&.CONF" "5" "05 Jun 2014" "@NETATALK_VERSION@" "@NETATALK_VERSION@" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -174,7 +174,7 @@ in parentheses indicates that a parameter is specific to the [Global] section\&. indicates that a parameter can be specified in a volume specific section\&. .SH "VARIABLE SUBSTITUTIONS" .PP -You can use variables in volume names\&. The use of variables in paths is not supported for now\&. +You can use variables in volume names\&. The use of variables in paths is limited to $u\&. .sp .RS 4 .ie n \{\ @@ -472,7 +472,7 @@ Sets the maximum number of clients that can simultaneously connect to the server .PP server quantum = \fInumber\fR \fB(G)\fR .RS 4 -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\*(Aqre absolutely sure, what you\*(Aqre doing +This specifies the DSI server quantum\&. The default value is 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\*(Aqre absolutely sure, what you\*(Aqre doing .RE .PP sleep time = \fInumber\fR \fB(G)\fR @@ -492,6 +492,16 @@ tcpsndbuf = \fInumber\fR \fB(G)\fR Try to set TCP send buffer using setsockpt()\&. Often OSes impose restrictions on the applications ability to set this value\&. .RE .PP +recvfile = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR +.RS 4 +Whether to use splice() on Linux for receiving data\&. +.RE +.PP +splice size = \fInumber\fR (default: \fI64k\fR) \fB(G)\fR +.RS 4 +Maximum number of bytes spliced\&. +.RE +.PP use sendfile = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR .RS 4 Whether to use sendfile @@ -528,16 +538,86 @@ contains symlink, you must set the canonicalized absolute path\&. In the simple \fBbasedir regex = /home\fR .RE .PP +chmod request = \fIpreserve (default) | ignore | simple\fR \fB(G/V)\fR +.RS 4 +Advanced permission control that deals with ACLs\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBignore\fR +\- UNIX chmod() requests are completely ignored +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBpreserve\fR +\- preserve ZFS ACEs for named users and groups or POSIX ACL group mask +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBsimple\fR +\- just to a chmod() as requested without any extra steps +.RE +.RE +.PP close vol = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR .RS 4 Whether to close volumes possibly opened by clients when they\*(Aqre removed from the configuration and the configuration is reloaded\&. .RE .PP +cnid mysql host = \fIMySQL server address\fR \fB(G)\fR +.RS 4 +name or address of a MySQL server for use with the mysql CNID backend\&. +.RE +.PP +cnid mysql user = \fIMySQL user\fR \fB(G)\fR +.RS 4 +MySQL user for authentication with the server\&. +.RE +.PP +cnid mysql pw = \fIpassword\fR \fB(G)\fR +.RS 4 +Password for MySQL server\&. +.RE +.PP +cnid mysql db = \fIdatabase name\fR \fB(G)\fR +.RS 4 +Name of an existing database for which the specified user has full privileges\&. +.RE +.PP cnid server = \fIipaddress[:port]\fR \fB(G)/(V)\fR .RS 4 Specifies the IP address and port of a cnid_metad server, required for CNID dbd backend\&. Defaults to localhost:4700\&. The network address may be specified either in dotted\-decimal format for IPv4 or in hexadecimal format for IPv6\&.\- .RE .PP +dbus daemon = \fIpath\fR \fB(G)\fR +.RS 4 +Sets the path to dbus\-daemon binary used by Spotlight feature\&. The default is +/bin/dbus\-daemon\&. +.RE +.PP dircachesize = \fInumber\fR \fB(G)\fR .RS 4 Maximum possible entries in the directory cache\&. The cache stores directories and files\&. It is used to cache the full path to directories and CNIDs which considerably speeds up directory enumeration\&. @@ -550,6 +630,13 @@ extmap file = \fIpath\fR \fB(G)\fR Sets the path to the file which defines file extension type/creator mappings\&. (default is @pkgconfdir@/extmap\&.conf)\&. .RE .PP +force xattr with sticky bit = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G/V)\fR +.RS 4 +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\&. +.sp +By enabling this option Netatalk will write the metadata xattr as root\&. +.RE +.PP guest account = \fIname\fR \fB(G)\fR .RS 4 Specifies the user that guests should use (default is "nobody")\&. The name should be quoted\&. @@ -561,13 +648,6 @@ AFP user home volume name\&. The default is \fIuser\*(Aqs home\fR\&. .RE .PP -login message = \fImessage\fR \fB(G)/(V)\fR -.RS 4 -Sets a message to be displayed when clients logon to the server\&. The message should be in -\fBunix charset\fR -and should be quoted\&. Extended characters are allowed\&. -.RE -.PP ignored attributes = \fIall | nowrite | nodelete | norename\fR \fB(G)/(V)\fR .RS 4 Speficy a set of file and directory attributes that shall be ignored by the server, @@ -578,6 +658,13 @@ In OS X when the Finder sets a lock on a file/directory or you set the BSD uchg \fIignored attributes = all\fR\&. .RE .PP +login message = \fImessage\fR \fB(G)/(V)\fR +.RS 4 +Sets a message to be displayed when clients logon to the server\&. The message should be in +\fBunix charset\fR +and should be quoted\&. Extended characters are allowed\&. +.RE +.PP mimic model = \fImodel\fR \fB(G)\fR .RS 4 Specifies the icon model that appears on clients\&. Defaults to off\&. Note that afpd must support Zeroconf\&. Examples: RackMac (same as Xserve), PowerBook, PowerMac, Macmini, iMac, MacBook, MacBookPro, MacBookAir, MacPro, AppleTV1,1, AirPort\&. @@ -595,15 +682,65 @@ solaris share reservations = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR Use share reservations on Solaris\&. Solaris CIFS server uses this too, so this makes a lock coherent multi protocol server\&. .RE .PP +sparql results limit = \fINUMBER\fR (default: \fIUNLIMITED\fR) \fB(G)\fR +.RS 4 +Impose a limit on the number of results queried from Tracker via SPARQL queries\&. +.RE +.PP spotlight = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)/(V)\fR .RS 4 -Whether to enable Spotlight searches\&. Note: once the global option is enabled, any volume that is not enabled won\*(Aqt be searchable at all\&. +Whether to enable Spotlight searches\&. Note: once the global option is enabled, any volume that is not enabled won\*(Aqt be searchable at all\&. See also +\fIdbus daemon\fR +option\&. .RE .PP -vol dbpath = \fIpath\fR \fB(G)\fR +spotlight attributes = \fICOMMA SEPERATED STRING\fR (default: \fIEMPTY\fR) \fB(G)\fR +.RS 4 +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: +.sp +.if n \{\ +.RS 4 +.\} +.nf +spotlight + attributes = *,kMDItemTextContent +.fi +.if n \{\ +.RE +.\} +.sp +.RE +.PP +spotlight expr = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR +.RS 4 +Whether to allow the use of logic expression in searches\&. +.RE +.PP +start dbus = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR +.RS 4 +Whether to start a dbus instance for use with Tracker\&. +.RE +.PP +start tracker = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR +.RS 4 +Whether to start Tracker with +\fItracker\-control \-s\fR\&. +.RE +.PP +veto message = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR +.RS 4 +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\&. +.RE +.PP +vol dbpath = \fIpath\fR \fB(G)/(V)\fR .RS 4 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 -@localstatedir@/netatalk/CNID/\&. +@localstatedir@/netatalk/CNID/$v/\&. +.RE +.PP +vol dbnest = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR +.RS 4 +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\&. .RE .PP volnamelen = \fInumber\fR \fB(G)\fR @@ -819,6 +956,11 @@ ldap name attr = \fIdn\fR \fB(G)\fR Name of the LDAP attribute with the users short name\&. .RE .PP +ldap group attr = \fIdn\fR \fB(G)\fR +.RS 4 +Name of the LDAP attribute with the groups short name\&. +.RE +.PP ldap uuid string = \fISTRING\fR \fB(G)\fR .RS 4 Format of the uuid string in the directory\&. A series of x and \-, where every x denotes a value 0\-9a\-f and every \- is a separator\&. @@ -829,6 +971,11 @@ Default: xxxxxxxx\-xxxx\-xxxx\-xxxx\-xxxxxxxxxxxx ldap uuid encoding = \fIstring | ms\-guid (default: string)\fR \fB(G)\fR .RS 4 Format of the UUID of the LDAP attribute, allows usage of the binary objectGUID fields from Active Directory\&. If left unspecified, string is the default, which passes through the ASCII UUID returned by most other LDAP stores\&. If set to ms\-guid, the 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\&. +.sp +See also the options +\fBldap user filter\fR +and +\fBldap group filter\fR\&. .PP string .RS 4 @@ -841,9 +988,20 @@ Binary objectGUID from Active Directory .RE .RE .PP -ldap group attr = \fIdn\fR \fB(G)\fR +ldap user filter = \fISTRING (default: unused)\fR \fB(G)\fR .RS 4 -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\&. +.sp +Recommended setting for Active Directory: +\fIobjectClass=user\fR\&. +.RE +.PP +ldap group filter = \fISTRING (default: unused)\fR \fB(G)\fR +.RS 4 +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\&. +.sp +Recommended setting for Active Directory: +\fIobjectClass=group\fR\&. .RE .SH "EXPLANATION OF VOLUME PARAMETERS" .SS "Parameters" @@ -1034,7 +1192,7 @@ Allows certain users and groups to have read/write access to a share\&. This fol .PP veto files = \fIvetoed names\fR \fB(V)\fR .RS 4 -hide files and directories,where the path matches one of the \*(Aq/\*(Aq delimited vetoed names\&. The veto string must always be terminated with a \*(Aq/\*(Aq, eg\&. "veto1/", "veto1/veto2/"\&. +hide files and directories,where the path matches one of the \*(Aq/\*(Aq delimited vetoed names\&. The veto string must always be terminated with a \*(Aq/\*(Aq, eg\&. "veto files = veto1/", "veto files = veto1/veto2/"\&. .RE .SS "Volume options" .PP @@ -1061,9 +1219,31 @@ is performed when accessing filesystems from clients\&. This is generally useful on volumes and do the conversion with that\&. Then this option can be set to no\&. .RE .PP +delete veto files = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR +.RS 4 +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\&. +.sp +If this option is set to yes, then Netatalk will attempt to recursively delete any files and directories within the vetoed directory\&. +.RE +.PP follow symlinks = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR .RS 4 The default setting is false thus symlinks are not followed on the server\&. This is the same behaviour as OS X\*(Aqs AFP server\&. Setting the option to true causes afpd to follow symlinks on the server\&. symlinks may point outside of the AFP volume, currently afpd doesn\*(Aqt do any checks for "wide symlinks"\&. +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBNote\fR +.ps -1 +.br +This option will subtly break when the symlinks point across filesystem boundaries\&. +.sp .5v +.RE .RE .PP invisible dots = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR