.\" Title: afp.conf
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\" Date: 23 Feb 2012
+.\" Date: 22 Mar 2012
.\" Manual: Netatalk 3.0
.\" Source: Netatalk 3.0
.\" Language: English
.\"
-.TH "AFP\&.CONF" "5" "23 Feb 2012" "Netatalk 3.0" "Netatalk 3.0"
+.TH "AFP\&.CONF" "5" "22 Mar 2012" "Netatalk 3.0" "Netatalk 3.0"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.RS 4
.\}
.nf
- \fIname\fR = \fIvalue \fR
+\fIname\fR = \fIvalue \fR
.fi
.if n \{\
.RS 4
.\}
.nf
- [baz]
- path = /foo/bar
+[baz]
+path = /foo/bar
.fi
.if n \{\
\fBpath\fR\&. It is neccessary to define the
\fBbasedir regex\fR
option\&. It should be a regex which matches the parent directory of the user homes\&. Parameters denoted by a (H) belong to volume sections\&. The optional parameter
-\fBname\fR
+\fBhome name\fR
can be used to change the AFP volume name which
-\fIusers\'s home\fR
+\fI$u\'s home\fR
by default\&. See below under VARIABLE SUBSTITUTIONS\&.
.PP
The following example illustrates this\&. Given all user home directories are stored under
.RS 4
.\}
.nf
- [Homes]
- path = afp\-data
- basedir regex = /home
+[Homes]
+path = afp\-data
+basedir regex = /home
.fi
.if n \{\
Parameters define the specific attributes of sections\&.
.PP
Some parameters are specific to the [Global] section (e\&.g\&.,
-\fIlogtype\fR)\&. All others are permissible only in volume sections\&. The letter
+\fIlog type\fR)\&. All others are permissible only in volume sections\&. The letter
\fIG\fR
in parentheses indicates that a parameter is specific to the [Global] section\&. The letter
\fIV\fR
indicates that a parameter can be specified in a volume specific section\&.
.SH "VARIABLE SUBSTITUTIONS"
.PP
-You can use variables in both volume path and volume name\&.
+You can use variables in volume names\&. The use of variables in paths is not supported for now\&.
.sp
.RS 4
.ie n \{\
.RS 4
prints dollar sign ($)
.RE
+.SH "EXPLANATION OF GLOBAL PARAMETERS"
+.SS "Authentication Options"
.PP
-\fBExample.\ \&Using variable substitution when defining volumes\fR
+save password = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR
+.RS 4
+Enables or disables the ability of clients to save passwords locally\&.
+.RE
.PP
-.if n \{\
+set password = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR
.RS 4
-.\}
-.nf
- [Groupdir for $g]
- /home/groups/$g
-
- [$f is the best one]
- ~
-
-.fi
-.if n \{\
+Enables or disables the ability of clients to change their passwords via chooser or the "connect to server" dialog\&.
.RE
-.\}
-.sp
-We define "groupdirs" for each primary group and use a personalized server name for homedir shares\&.
-.SH "EXPLANATION OF GLOBAL PARAMETERS"
-.SS "Authentication Methods"
.PP
-uamlist = \fIuams list\fR \fB(G)\fR
+uam list = \fIuam list\fR \fB(G)\fR
.RS 4
-Comma separated list of UAMs\&. (The default is uams_dhx\&.so,uams_dhx2\&.so)\&.
+Space or comma separated list of UAMs\&. (The default is "uams_dhx\&.so uams_dhx2\&.so")\&.
.sp
The most commonly used UAMs are:
.PP
.PP
uams_randum\&.so
.RS 4
-allows Random Number and Two\-Way Random Number Exchange for authentication (requires a separate file containing the passwords, either :ETCDIR:/afppasswd file or the one specified via
-\fB\-passwdfile\fR\&. See
+allows Random Number and Two\-Way Random Number Exchange for authentication (requires a separate file containing the passwords, either :ETCDIR:/afppasswd file or the one specified via "\fBpasswd file\fR"\&. See
\fBafppasswd\fR(1)
for details\&. (legacy)
.RE
.RE
.RE
.PP
-uampath = \fIpath\fR \fB(G)\fR
+uam path = \fIpath\fR \fB(G)\fR
.RS 4
Sets the default path for UAMs for this server (default is :ETCDIR:/uams)\&.
.RE
.PP
-k5keytab = \fIpath\fR \fB(G)\fR, k5service = \fIservice\fR \fB(G)\fR, k5realm = \fIrealm\fR \fB(G)\fR
+k5 keytab = \fIpath\fR \fB(G)\fR, k5 service = \fIservice\fR \fB(G)\fR, k5 realm = \fIrealm\fR \fB(G)\fR
.RS 4
These are required if the server supports the Kerberos 5 authentication UAM\&.
.RE
.PP
-ntdomain = \fIDOMAIN\fR \fB(G)\fR, ntseparator = \fISEPERATOR\fR \fB(G)\fR
+nt domain = \fIDOMAIN\fR \fB(G)\fR, nt separator = \fISEPERATOR\fR \fB(G)\fR
.RS 4
Use for eg\&. winbind authentication, prepends both strings before the username from login and then tries to authenticate with the result through the availabel and active UAM authentication modules\&.
.RE
.PP
-adminauthuser = \fIuser\fR \fB(G)\fR
+admin auth user = \fIuser\fR \fB(G)\fR
.RS 4
-Specifying eg
-\fBadminauthuser root\fR
-whenever a normal user login fails, afpd will try to authenticate as the specified
-\fBadminauthuser\fR\&. If this succeeds, a normal session is created for the original connecting user\&. Said differently: if you know the password of
-\fBadminauthuser\fR, you can authenticate as any other user\&.
+Specifying eg "\fBadmin auth user = root\fR" whenever a normal user login fails, afpd will try to authenticate as the specified
+\fBadmin auth user\fR\&. If this succeeds, a normal session is created for the original connecting user\&. Said differently: if you know the password of
+\fBadmin auth user\fR, you can authenticate as any other user\&.
.RE
.PP
-ldap_server = \fIhost\fR \fB(G)\fR
+ldap server = \fIhost\fR \fB(G)\fR
.RS 4
Name or IP address of your LDAP Server\&. This is only needed for explicit ACL support in order to be able to query LDAP for UUIDs\&.
.sp
to syntactically check your config\&.
.RE
.PP
-ldap_auth_method = \fInone|simple|sasl\fR \fB(G)\fR
+ldap auth method = \fInone|simple|sasl\fR \fB(G)\fR
.RS 4
Authentication method:
\fBnone | simple | sasl\fR
.RE
.RE
.PP
-ldap_auth_dn = \fIdn\fR \fB(G)\fR
+ldap auth dn = \fIdn\fR \fB(G)\fR
.RS 4
Distinguished Name of the user for simple bind\&.
.sp
.RE
.PP
-ldap_auth_pw = \fIpassword\fR \fB(G)\fR
+ldap auth pw = \fIpassword\fR \fB(G)\fR
.RS 4
Distinguished Name of the user for simple bind\&.
.sp
.RE
.PP
-ldap_userbase = \fIbase dn\fR \fB(G)\fR
+ldap userbase = \fIbase dn\fR \fB(G)\fR
.RS 4
DN of the user container in LDAP\&.
.sp
.RE
.PP
-ldap_userscope = \fIscope\fR \fB(G)\fR
+ldap userscope = \fIscope\fR \fB(G)\fR
.RS 4
Search scope for user search:
\fBbase | one | sub\fR
.sp
.RE
.PP
-ldap_groupbase = \fIbase dn\fR \fB(G)\fR
+ldap groupbase = \fIbase dn\fR \fB(G)\fR
.RS 4
DN of the group container in LDAP\&.
.sp
.RE
.PP
-ldap_groupscope = \fIscope\fR \fB(G)\fR
+ldap groupscope = \fIscope\fR \fB(G)\fR
.RS 4
Search scope for user search:
\fBbase | one | sub\fR
.sp
.RE
.PP
-ldap_uuuid_attr = \fIdn\fR \fB(G)\fR
+ldap uuuid attr = \fIdn\fR \fB(G)\fR
.RS 4
Name of the LDAP attribute with the UUIDs\&.
.sp
.sp
.RE
.PP
-ldap_name_attr = \fIdn\fR \fB(G)\fR
+ldap name attr = \fIdn\fR \fB(G)\fR
.RS 4
Name of the LDAP attribute with the users short name\&.
.sp
.RE
.PP
-ldap_group_attr = \fIdn\fR \fB(G)\fR
+ldap group attr = \fIdn\fR \fB(G)\fR
.RS 4
Name of the LDAP attribute with the groups short name\&.
.sp
.RE
-.SS "Codepage Options"
+.SS "Charset Options"
.PP
-With OS X Apple introduced the AFP3 protocol\&. One of the big changes was, that AFP3 uses Unicode names encoded as Decomposed UTF\-8 (UTF8\-MAC)\&. Previous AFP/OS versions used codepages like MacRoman, MacCentralEurope, etc\&.
+With OS X Apple introduced the AFP3 protocol\&. One of the big changes was, that AFP3 uses Unicode names encoded as Decomposed UTF\-8 (UTF8\-MAC)\&. Previous AFP/OS versions used charsets like MacRoman, MacCentralEurope, etc\&.
.PP
To be able to serve AFP3 and older clients at the same time,
\fBafpd\fR
-needs to be able to convert between UTF\-8 and Mac codepages\&. Even OS X clients partly still rely on codepages\&. As there\'s no way,
+needs to be able to convert between UTF\-8 and Mac charsets\&. Even OS X clients partly still rely on the mac charset\&. As there\'s no way,
\fBafpd\fR
can detect the codepage a pre AFP3 client uses, you have to specify it using the
-\fBmaccodepage\fR
+\fBmac charset\fR
option\&. The default is MacRoman, which should be fine for most western users\&.
.PP
As
\fBafpd\fR
-needs to interact with unix operating system as well, it need\'s to be able to convert from UTF8\-MAC/MacCodepage to the unix codepage\&. By default
+needs to interact with UNIX operating system as well, it need\'s to be able to convert from UTF8\-MAC / Mac charset to the UNIX charset\&. By default
\fBafpd\fR
-uses the systems LOCALE, or ASCII if your system doesn\'t support locales\&. You can set the unix codepage using the
-\fBunixcodepage\fR
+uses
+\fIUTF8\fR\&. You can set the UNIX charset using the
+\fBunix charset\fR
option\&. If you\'re using extended characters in the configuration files for
\fBafpd\fR, make sure your terminal matches the
-\fBunixcodepage\fR\&.
+\fBunix charset\fR\&.
.PP
-unixcodepage = \fICODEPAGE\fR \fB(G)\fR
+unix charset = \fICHARSET\fR \fB(G)\fR
.RS 4
-Specifies the servers unix codepage, e\&.g\&. "ISO\-8859\-15" or "UTF8"\&. This is used to convert strings to/from the systems locale, e\&.g\&. for authenthication, server messages and volume names\&. Defaults to LOCALE if your system supports it, otherwise ASCII will be used\&.
+Specifies the servers unix charset, e\&.g\&.
+\fIISO\-8859\-15\fR
+or
+\fIUTF8\fR\&. This is used to convert strings to/from the systems locale, e\&.g\&. for authenthication, server messages and volume names\&. Defaults to the systems locale setting\&.
.RE
.PP
-maccodepage = \fICODEPAGE\fR \fB(G)\fR
+mac charset = \fICHARSET\fR \fB(G)/(V)\fR
.RS 4
-Specifies the mac clients codepage, e\&.g\&. "MAC_ROMAN"\&. This is used to convert strings and filenames to the clients codepage for OS9 and Classic, i\&.e\&. for authentication and AFP messages (SIGUSR2 messaging)\&. This will also be the default for the volumes maccharset\&. Defaults to MAC_ROMAN\&.
+Specifies the Mac clients charset, e\&.g\&.
+\fIMAC_ROMAN\fR\&. This is used to convert strings and filenames to the clients codepage for OS9 and Classic, i\&.e\&. for authentication and AFP messages (SIGUSR2 messaging)\&. This will also be the default for the volumes
+\fBmac charset\fR\&. Defaults to
+\fIMAC_ROMAN\fR\&.
+.RE
+.PP
+vol charset = \fICHARSET\fR \fB(G)/(V)\fR
+.RS 4
+Specifies the encoding of the volumes filesystem, defaults to
+\fIUTF8\fR\&.
.RE
.SS "Password Options"
.PP
-passwdfile = \fIpath\fR \fB(G)\fR
+passwd file = \fIpath\fR \fB(G)\fR
.RS 4
Sets the path to the Randnum UAM passwd file for this server (default is :ETCDIR:/afppasswd)\&.
.RE
.PP
-passwdminlen = \fInumber\fR \fB(G)\fR
+passwd minlen = \fInumber\fR \fB(G)\fR
.RS 4
Sets the minimum password length, if supported by the UAM
.RE
.SS "Network Options"
.PP
+afp listen = \fIip address[:port] [ip adress[:port] \&.\&.\&.]\fR \fB(G)\fR
+.RS 4
+Specifies the IP address that the server should advertise
+\fBand\fR
+listens to\&. The default is advertise the first IP address of the system, but to listen for any incoming request\&. The network address may be specified either in dotted\-decimal format for IPv4 or in hexadecimal format for IPv6\&.
+.RE
+.PP
fqdn = \fIname:port\fR \fB(G)\fR
.RS 4
Specifies a fully\-qualified domain name, with an optional port\&. This is discarded if the server cannot resolve it\&. This option is not honored by AppleShare clients <= 3\&.8\&.3\&. This option is disabled by default\&. Use with caution as this will involve a second name resolution step on the client side\&. Also note that afpd will advertise this name:port combination but not automatically listen to it\&.
\fBafp listen\fR\&.
.RE
.PP
-afp listen = \fIip address[:port][,ip adress[:port], \&.\&.\&.]\fR \fB(G)\fR
-.RS 4
-Specifies the IP address that the server should advertise
-\fBand\fR
-listens to\&. The default is advertise the first IP address of the system, but to listen for any incoming request\&. The network address may be specified either in dotted\-decimal format for IPv4 or in hexadecimal format for IPv6\&.
-.RE
-.PP
-cnid listen = \fIip address[:port][,ip adress[:port], \&.\&.\&.]\fR \fB(G)\fR
+cnid listen = \fIip address[:port] [ip adress[:port] \&.\&.\&.]\fR \fB(G)\fR
.RS 4
Specifies the IP address that the CNID server should listen on\&. The default is
\fBlocalhost:4700\fR\&.
hours before dropping them\&. Default is 24 hours\&.
.RE
.PP
-server_quantum = \fInumber\fR \fB(G)\fR
+server quantum = \fInumber\fR \fB(G)\fR
.RS 4
This specifies the DSI server quantum\&. The default value is 303840\&. 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
.RE
.RS 4
Try to set TCP send buffer using setsockpt()\&. Often OSes impose restrictions on the applications ability to set this value\&.
.RE
+.PP
+advertise ssh = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR
+.RS 4
+Allows old Mac OS X clients (10\&.3\&.3\-10\&.4) to automagically establish a tunneled AFP connection through SSH\&. If this option is set, the server\'s answers to client\'s FPGetSrvrInfo requests contain an additional entry\&. It depends on both client\'s settings and a correctly configured and running
+\fBsshd\fR(8)
+on the server to let things work\&.
+.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
+Setting this option is not recommended since globally encrypting AFP connections via SSH will increase the server\'s load significantly\&. On the other hand, Apple\'s client side implementation of this feature in MacOS X versions prior to 10\&.3\&.4 contained a security flaw\&.
+.sp .5v
+.RE
+.RE
+.PP
+zeroconf = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR
+.RS 4
+Whether to use automatic Zeroconf
+service registration if Avahi or mDNSResponder were compiled in\&.
+.RE
+.PP
+use sendfile = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR
+.RS 4
+Whether to use sendfile
+syscall for sending file data to clients\&.
+.RE
.SS "Miscellaneous Options"
.PP
vol dbpath = \fIpath\fR \fB(G)\fR
\fBbasedir regex = /home\fR
.RE
.PP
-name = \fIname\fR \fB(H)\fR
+home name = \fIname\fR \fB(H)\fR
.RS 4
AFP user home volume name\&. The default is
\fIusers\'s home\fR\&.
.RS 4
Use section
\fBname\fR
-as option preset for all volumes (when set in the global section) or for one volume (when set in that volume\'s section)\&.
+as option preset for all volumes (when set in the [Global] section) or for one volume (when set in that volume\'s section)\&.
.RE
.PP
-admingroup = \fIgroup\fR \fB(G)\fR
+admin group = \fIgroup\fR \fB(G)\fR
.RS 4
Allows users of a certain group to be seen as the superuser when they log in\&. This option is disabled by default\&.
.RE
.PP
-cnidserver = \fIipaddress[:port]\fR \fB(G)/(V)\fR
+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
Default size is 8192, maximum size is 131072\&. Given value is rounded up to nearest power of 2\&. Each entry takes about 100 bytes, which is not much, but remember that every afpd child process for every connected user has its cache\&.
.RE
.PP
-fcelistener = \fIhost[:port]\fR \fB(G)\fR
+fce listener = \fIhost[:port]\fR \fB(G)\fR
.RS 4
Enables sending FCE events to the specified
\fIhost\fR, default
is 12250 if not specified\&. Specifying mutliple listeners is done by having this option once for each of them\&.
.RE
.PP
-fceevents = \fIfmod,fdel,ddel,fcre,dcre,tmsz\fR \fB(G)\fR
+fce events = \fIfmod,fdel,ddel,fcre,dcre,tmsz\fR \fB(G)\fR
.RS 4
Speficies which FCE events are active, default is
\fIfmod,fdel,ddel,fcre,dcre\fR\&.
.RE
.PP
-fcecoalesce = \fIall|delete|create\fR \fB(G)\fR
+fce coalesce = \fIall|delete|create\fR \fB(G)\fR
.RS 4
Coalesce FCE events\&.
.RE
.PP
-fceholdfmod = \fIseconds\fR \fB(G)\fR
+fce holdfmod = \fIseconds\fR \fB(G)\fR
.RS 4
This determines the time delay in seconds which is always waited if another file modification for the same file is done by a client before sending an FCE file modification event (fmod)\&. For example saving a file in Photoshop would generate multiple events by itself because the application is opening, modifying and closing a file mutliple times for every "save"\&. Defautl: 60 seconds\&.
.RE
.PP
-guestname = \fIname\fR \fB(G)\fR
+guest account = \fIname\fR \fB(G)\fR
.RS 4
Specifies the user that guests should use (default is "nobody")\&. The name should be quoted\&.
.RE
.PP
-loginmesg = \fImessage\fR \fB(G)\fR
+login message = \fImessage\fR \fB(G)\fR
.RS 4
Sets a message to be displayed when clients logon to the server\&. The message should be in
-\fBunixcodepage\fR
+\fBunix charset\fR
and should be quoted\&. Extended characters are allowed\&.
.RE
.PP
-mimicmodel = \fImodel\fR \fB(G)\fR
+mimic model = \fImodel\fR \fB(G)\fR
.RS 4
Specifies the icon model that appears on clients\&. Defaults to off\&. Examples: RackMac (same as Xserve), PowerBook, PowerMac, Macmini, iMac, MacBook, MacBookPro, MacBookAir, MacPro, AppleTV1,1, AirPort\&.
.RE
.PP
-signature = { user:<text> | auto } \fB(G)\fR
+signature = <text> \fB(G)\fR
.RS 4
-Specify a server signature\&. This option is useful while running multiple independent instances of afpd on one machine (eg\&. in clustered environments, to provide fault isolation etc\&.)\&. Default is "auto"\&. "auto" signature type allows afpd generating signature and saving it to
+Specify a server signature\&. The maximum length is 16 characters\&. This option is useful for clustered environments, to provide fault isolation etc\&. By default, afpd generate signature and saving it to
:ETCDIR:/afp_signature\&.conf
-automatically (based on random number)\&. "host" signature type switches back to "auto" because it is obsoleted\&. "user" signature type allows administrator to set up a signature string manually\&. The maximum length is 16 characters\&.
-.PP
-\fBExample.\ \&Three server definitions using 2 different server signatures\fR
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
-first \-signature user:USERS
- second \-signature user:USERS
- third \-signature user:ADMINS
-.fi
-.if n \{\
-.RE
-.\}
-
-
-First two servers will appear as one logical AFP service to the clients \- if user logs in to first one and then connects to second one, session will be automatically redirected to the first one\&. But if client connects to first and then to third, will be asked for password twice and will see resources of both servers\&. Traditional method of signature generation causes two independent afpd instances to have the same signature and thus cause clients to be redirected automatically to server (s)he logged in first\&.
+automatically (based on random number)\&. See also asip\-status\&.pl(1)\&.
.RE
.PP
volnamelen = \fInumber\fR \fB(G)\fR
.\}
.nf
73: limit of Mac OS X 10\&.1
- 80: limit for Mac OS X 10\&.4/10\&.5 (default)
- 255: limit of spec
+80: limit of Mac OS X 10\&.4/10\&.5 (default)
+255: limit of recent Mac OS X
.fi
.if n \{\
.RE
.sp
Mac OS 9 and earlier are not influenced by this, because Maccharset volume name is always limitted to 27 bytes\&.
.RE
+.PP
+icon = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR
+.RS 4
+Use the platform\-specific icon\&. Mac OS X doesn\'t display it\&.
+.RE
+.PP
+keep sessions = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR
+.RS 4
+Enable "Continuous AFP Service"\&. This means the ability to stop the master afpd process with a SIGQUIT signal, possibly install an afpd update and start the afpd process\&. Existing AFP sessions afpd processes will remain unaffected\&. Technically they will be notified of the master afpd shutdown, sleep 15\-20 seconds and then try to reconnect their IPC channel to the master afpd process\&. If this reconnect fails, the sessions are in an undefined state\&. Therefor it\'s absolutely critical to restart the master process in time!
+.RE
+.PP
+map acls = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR
+.RS 4
+Whether to map filesystem ACLs to effective permissions\&.
+.RE
+.PP
+close vol = \fIBOOLEAN\fR (default: \fIno\fR) \fB(G)\fR
+.RS 4
+Whether to close volumes possibly opened by clients when they\'re removed from the configuration and the configuration is reloaded\&.
+.RE
.SS "Logging Options"
.PP
-logfile = \fIfile\fR \fB(G)\fR
+log file = \fIlogfile\fR \fB(G)\fR
.RS 4
If not specified Netatalk logs to syslogs daemon facilify\&. Otherwise it logs to
\fBlogfile\fR\&.
.RE
.PP
-loglevel = \fItype:level,[type:level, \&.\&.\&.]\fR \fB(G)\fR
+log level = \fItype:level [type:level \&.\&.\&.]\fR \fB(G)\fR, log level = \fItype:level,[type:level, \&.\&.\&.]\fR \fB(G)\fR
.RS 4
Specify that any message of a loglevel up to the given
\fBloglevel\fR
.sp .5v
.RE
.RE
-.SS "Global Options"
-.PP
-options =
-\fIoption,[option,\&.\&.\&.]\fR
-\fB(G)\fR
-.PP
-options =
-\fIoption [option \&.\&.\&.]\fR
-\fB(G)\fR
-.PP
-This allows multiple options to be specified in a comma or space delimited format\&. The available options are:
-.PP
-[no]savepassword \fB(G)\fR
-.RS 4
-Enables or disables the ability of clients to save passwords locally
-.RE
-.PP
-[no]setpassword \fB(G)\fR
-.RS 4
-Enables or disables the ability of clients to change their passwords via chooser or the "connect to server" dialog
-.RE
-.PP
-advertise_ssh \fB(G)\fR
-.RS 4
-Allows Mac OS X clients (10\&.3\&.3\-10\&.4) to automagically establish a tunneled AFP connection through SSH\&. If this option is set, the server\'s answers to client\'s FPGetSrvrInfo requests contain an additional entry\&. It depends on both client\'s settings and a correctly configured and running
-\fBsshd\fR(8)
-on the server to let things work\&.
-.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
-Setting this option is not recommended since globally encrypting AFP connections via SSH will increase the server\'s load significantly\&. On the other hand, Apple\'s client side implementation of this feature in MacOS X versions prior to 10\&.3\&.4 contained a security flaw\&.
-.sp .5v
-.RE
-.RE
-.PP
-nozeroconf \fB(G)\fR
-.RS 4
-Disable automatic Zeroconf
-service registration if support was compiled in\&.
-.RE
-.PP
-client_polling \fB(G)\fR
-.RS 4
-With this switch enabled, afpd won\'t advertise that it is capable of server notifications, so that connected clients poll the server every 10 seconds to detect changes in opened server windows\&.
-\fINote\fR: Depending on the number of simultaneously connected clients and the network\'s speed, this can lead to a significant higher load on your network!
-.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
-Do not use this option any longer as Netatalk 2\&.x correctly supports server notifications, allowing connected clients to update folder listings in case another client changed the contents\&.
-.sp .5v
-.RE
-.RE
-.PP
-[no]icon \fB(G)\fR
-.RS 4
-[Don\'t] Use the platform\-specific icon\&. Recent Mac OS don\'t display it any longer\&.
-.RE
-.PP
-keepsessions \fB(G)\fR
-.RS 4
-Enable "Continuous AFP Service"\&. This means the ability to stop the master afpd process with a SIGQUIT signal, possibly install an afpd update and start the afpd process\&. Existing AFP sessions afpd processes will remain unaffected\&. Technically they will be notified of the master afpd shutdown, sleep 15\-20 seconds and then try to reconnect their IPC channel to the master afpd process\&. If this reconnect fails, the sessions are in an undefined state\&. Therefor it\'s absolutely critical to restart the master process in time!
-.RE
-.PP
-noacl2maccess \fB(G)\fR
-.RS 4
-Don\'t map filesystem ACLs to effective permissions\&.
-.RE
.SS "Debug Parameters"
.PP
These options are useful for debugging only\&.
.SH "EXPLANATION OF VOLUME PARAMETERS"
.SS "Parameters"
.PP
-The section name defines the volume name which is the name that appears in the Chooser ot the "connect to server" dialog on Macintoshes to represent the appropriate share\&. No two volumes may have the same name\&. The volume name cannot contain the
+The section name defines the volume name which is the name that appears in the Chooser or the "connect to server" dialog on Macintoshes to represent the appropriate share\&. No two volumes may have the same name\&. The volume name cannot contain the
\':\'
-character\&. The volume name is mangled if it is very long\&. Mac codepage volume name is limited to 27 characters\&. UTF8\-MAC volume name is limited to \-volnamelen parameter in afpd\&.conf
+character\&. The volume name is mangled if it is very long\&. Mac charset volume name is limited to 27 characters\&. UTF8\-MAC volume name is limited to volnamelen parameter\&.
.PP
path = \fIPATH\fR \fB(V)\fR
.RS 4
.sp
The volume name is the name that appears in the Chooser ot the "connect to server" dialog on Macintoshes to represent the appropriate share\&. If volumename is unspecified, the last component of pathname is used\&. No two volumes may have the same name\&. If there are spaces in the name, it should be in quotes (i\&.e\&. "File Share")\&. The volume name cannot contain the
\':\'
-character\&. The volume name is mangled if it is very long\&. Mac codepage volume name is limited to 27 characters\&. UTF8\-MAC volume name is limited to \-volnamelen parameter in afpd\&.conf
+character\&. The volume name is mangled if it is very long\&. Mac charset volume name is limited to 27 characters\&. UTF8\-MAC volume name is limited to volnamelen parameter\&.
.RE
.PP
-adouble = \fIea|v2\fR \fB(V)\fR
+appledouble = \fIea|v2\fR \fB(V)\fR
.RS 4
Specify the format of the metadata files, which are used for saving Mac resource fork as well\&. Earlier versions used AppleDouble v2, the new default format is
\fBea\fR\&.
.RE
.PP
-volsizelimit = \fIsize in MiB\fR \fB(V)\fR
+vol size limit = \fIsize in MiB\fR \fB(V)\fR
.RS 4
-Useful for TimeMachine: limits the reported volume size, thus preventing TM from using the whole real disk space for backup\&. Example: "volsizelimit:1000" would limit the reported disk space to 1 GB\&.
+Useful for Time Machine: limits the reported volume size, thus preventing Time Machine from using the whole real disk space for backup\&. Example: "vol size limit = 1000" would limit the reported disk space to 1 GB\&.
\fBIMPORTANT: \fR
-This is an approximated calculation taking into accout the contents of TM sparsebundle images\&. Therefor you MUST NOT use this volume to store other content when using this option, because it would NOT be accounted\&. The calculation works by reading the band size from the Info\&.plist XML file of the sparsebundle, reading the bands/ directory counting the number of band files, and then multiplying one with the other\&.
+This is an approximated calculation taking into accout the contents of Time Machine sparsebundle images\&. Therefor you MUST NOT use this volume to store other content when using this option, because it would NOT be accounted\&. The calculation works by reading the band size from the Info\&.plist XML file of the sparsebundle, reading the bands/ directory counting the number of band files, and then multiplying one with the other\&.
.RE
.PP
-allow = \fIusers/groups\fR \fB(V)\fR
+valid users = \fIusers/groups\fR \fB(V)\fR
.RS 4
-The allow option allows the users and groups that access a share to be specified\&. Users and groups are specified, delimited by commas\&. Groups are designated by a @ prefix\&. Example: allow:user1,user2,@group
+The allow option allows the users and groups that access a share to be specified\&. Users and groups are specified, delimited by spaces or commas\&. Groups are designated by a @ prefix\&. Example: "valid users = user1 user2 @group"
.RE
.PP
-deny = \fIusers/groups\fR \fB(V)\fR
+invalid users = \fIusers/groups\fR \fB(V)\fR
.RS 4
-The deny option specifies users and groups who are not allowed access to the share\&. It follows the same format as the allow option\&.
+The deny option specifies users and groups who are not allowed access to the share\&. It follows the same format as the "valid users" option\&.
.RE
.PP
-allowed_hosts = \fIIP host address/IP netmask bits[, \&.\&.\&. ]\fR \fB(V)\fR
+hosts allow = \fIIP host address/IP netmask bits[, \&.\&.\&. ]\fR \fB(V)\fR
.RS 4
Only listed hosts and networks are allowed, all others are rejected\&. The network address may be specified either in dotted\-decimal format for IPv4 or in hexadecimal format for IPv6\&.
.sp
-Example: allowed_hosts:10\&.1\&.0\&.0/16,10\&.2\&.1\&.100,2001:0db8:1234::/48
+Example: hosts allow = 10\&.1\&.0\&.0/16 10\&.2\&.1\&.100 2001:0db8:1234::/48
.RE
.PP
-denied_hosts = \fIIP host address/IP netmask bits[, \&.\&.\&.]\fR \fB(V)\fR
+hosts deny = \fIIP host address/IP netmask bits [\&.\&.\&.]\fR \fB(V)\fR
.RS 4
Listed hosts and nets are rejected, all others are allowed\&.
.sp
-Example: denied_hosts: 192\&.168\&.100/24,10\&.1\&.1\&.1,2001:db8::1428:57ab
+Example: hosts deny = 192\&.168\&.100/24 10\&.1\&.1\&.1 2001:db8::1428:57ab
.RE
.PP
-cnidscheme = \fIbackend\fR \fB(V)\fR
+cnid scheme = \fIbackend\fR \fB(V)\fR
.RS 4
set the CNID backend to be used for the volume, default is [:DEFAULT_CNID_SCHEME:] available schemes: [:COMPILED_BACKENDS:]
.RE
.PP
-cnidserver = \fIhost[:port]\fR \fB(V)\fR
-.RS 4
-Query this servername or IP address (default:\fIlocalhost\fR) and port (default:
-\fI4700\fR) for CNIDs\&. Only used with CNID backend "\fIdbd\fR"\&. This option here overrides any setting from
-afpd\&.conf:\fBcnidserver\fR\&.
-.RE
-.PP
ea = \fInone|auto|sys|ad\fR
.RS 4
Specify how Extended Attributes
Try
\fBsys\fR
(by setting an EA on the shared directory itself), fallback to
-\fBad\fR\&. Requires writeable volume for perfoming test\&.
-\fBoptions:ro\fR
-overwrites
+\fBad\fR\&. Requires writeable volume for perfoming test\&. "\fBread only = yes\fR" overwrites
\fBauto\fR
with
-\fBnone\fR\&. Use explicit
-\fBea:sys|ad\fR
-for read\-only volumes where appropiate\&.
+\fBnone\fR\&. Use explicit "\fBea = sys|ad\fR" for read\-only volumes where appropiate\&.
.RE
.PP
sys
.RE
.RE
.PP
-maccharset = \fIcharset\fR \fB(V)\fR
+mac charset = \fICHARSET\fR \fB(V)\fR
.RS 4
-specifies the mac client codepage for this Volume, e\&.g\&. "MAC_ROMAN", "MAC_CYRILLIC"\&. If not specified the setting from
-afpd\&.conf
-is inherited\&. This setting is only required if you need volumes, where the mac codepage differs from the one globally set in
-afpd\&.conf\&.
+specifies the Mac client charset for this Volume, e\&.g\&.
+\fIMAC_ROMAN\fR,
+\fIMAC_CYRILLIC\fR\&. If not specified the global setting is applied\&. This setting is only required if you need volumes, where the Mac charset differs from the one globally set in the [Global] section\&.
.RE
.PP
casefold = \fBoption\fR
This option allows you to set a volume password, which can be a maximum of 8 characters long (using ASCII strongly recommended at the time of this writing)\&.
.RE
.PP
-perm|fperm|dperm:\fImode\fR \fB(V)\fR
+file perm = \fImode\fR \fB(V)\fR, directory perm = \fImode\fR \fB(V)\fR
.RS 4
Add(or) with the client requested permissions:
-\fBperm\fR
-affects files and directories,
-\fBfperm\fR
+\fBfile perm\fR
is for files only,
-\fBdperm\fR
-is for directories only\&. Use with
-\fBoptions:upriv\fR\&.
+\fBdirectory perm\fR
+is for directories only\&. Don\'t use with "\fBunix priv = no\fR"\&.
.PP
\fBExample.\ \&Volume for a collaborative workgroup\fR
.sp
.RS 4
.\}
.nf
-/path/to/volume "Workgroup" options:upriv dperm:0770 fperm:0660
+file perm = 0660
+directory perm = 0770
.fi
.if n \{\
.RE
.\}
+
.RE
.PP
umask = \fImode\fR \fB(V)\fR
.RS 4
-set perm mask\&. Use with
-\fBoptions:upriv\fR\&.
+set perm mask\&. Don\'t use with "\fBunix priv = no\fR"\&.
.RE
.PP
preexec = \fIcommand\fR \fB(V)\fR
command to be run when the volume is closed, ignored for user defined volumes
.RE
.PP
-root_preexec = \fIcommand\fR \fB(V)\fR
+root preexec = \fIcommand\fR \fB(V)\fR
.RS 4
command to be run as root when the volume is mounted, ignored for user defined volumes
.RE
.PP
-root_postexec = \fIcommand\fR \fB(V)\fR
+root postexec = \fIcommand\fR \fB(V)\fR
.RS 4
command to be run as root when the volume is closed, ignored for user defined volumes
.RE
Allows certain users and groups to have read/write access to a share\&. This follows the allow option format\&.
.RE
.PP
-veto = \fIvetoed names\fR \fB(V)\fR
+veto files = \fIvetoed names\fR \fB(V)\fR
.RS 4
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/"\&.
.RE
-.PP
-volcharset = \fIcharset\fR \fB(V)\fR
-.RS 4
-specifies the volume codepage, e\&.g\&. "UTF8", "UTF8\-MAC", "ISO\-8859\-15"\&. Defaults to "UTF8"\&.
-.RE
.SS "Volume options"
.PP
-vol options =
-\fIoption,[option,\&.\&.\&.]\fR
-\fB(V)\fR
+Boolean volume options\&.
.PP
-vol options =
-\fIoption [option \&.\&.\&.]\fR
-\fB(V)\fR
+acls = \fIBOOLEAN\fR (default: \fItrue\fR) \fB(V)\fR
+.RS 4
+Whether to flag volumes as supporting ACLs\&. If ACL support is compiled in, this is true by default\&.
+.RE
.PP
-This allows multiple options to be specified in a comma or space delimited format\&. The available options are:
+cnid dev = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR
+.RS 4
+Whether to use the device number in the CNID backends\&. Helps when the device number is not constant across a reboot, eg cluster, \&.\&.\&.
+.RE
.PP
-searchdb \fB(V)\fR
+convert adouble = \fIBOOLEAN\fR (default: \fItrue\fR) \fB(V)\fR
.RS 4
-Use fast CNID database namesearch instead of slow recursive filesystem search\&. Relies on a consistent CNID database, ie Samba or local filesystem access lead to inaccurate or wrong results\&. Works only for "dbd" CNID db volumes\&.
+Whether automatic conversion from
+\fBappledouble = v2\fR
+to
+\fBappledouble = ea\fR
+is performed when accessing filesystems from clients\&. This is generally useful, but costs some performance\&. It\'s recommdable to run
+\fBdbd\fR
+on volumes and do the conversion with that\&. Then this option can be set to no\&.
.RE
.PP
-tm \fB(V)\fR
+hex encoding = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR
.RS 4
-Enable Time Machine suport for this volume\&.
+Whether :hex encoding is done for file and directory names containing the character
+/\&. Setting this option to no makes the
+/
+character illegal\&.
.RE
.PP
-invisibledots \fB(V)\fR
+invisible dots = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR
.RS 4
-Use with
-\fBusedots\fR: make dot files invisible\&.
+make dot files invisible\&. If "\fBuse dots = no\fR", this parameter is not unnecessary\&.
.RE
.PP
-nonetids \fB(V)\fR
+network ids = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR
.RS 4
-Try to force ACL unawareness on the client\&.
+Whether the server support network ids\&. Setting this to
+\fIno\fR
+will result in the client not using ACL AFP functions\&.
.RE
.PP
-preexec_close \fB(V)\fR
+preexec close = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR
.RS 4
-a non\-zero return code from preexec close the volume being immediately, preventing clients to mount/see the volume in question\&.
+A non\-zero return code from preexec close the volume being immediately, preventing clients to mount/see the volume in question\&.
.RE
.PP
-ro \fB(V)\fR
+read only = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR
.RS 4
-Specifies the share as being read only for all users\&. The \&.AppleDB directory has to be writeable, you can use the
-\fB\-dbpath\fR
-option to relocate it\&. Overwrites
-\fBea:auto\fR
+Specifies the share as being read only for all users\&. Overwrites
+\fBea = auto\fR
with
-\fBea:none\fR
+\fBea = none\fR
.RE
.PP
-root_preexec_close \fB(V)\fR
+root preexec close= \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR
.RS 4
-a non\-zero return code from root_preexec closes the volume immediately, preventing clients to mount/see the volume in question\&.
+A non\-zero return code from root_preexec closes the volume immediately, preventing clients to mount/see the volume in question\&.
.RE
.PP
-upriv \fB(V)\fR
+search db = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR
.RS 4
-use AFP3 unix privileges\&. This should be set for OS X clients\&. Starting with Netatalk 2\&.1 it\'s part of the default config :DEFAULT: line\&. See also:
-\fBperm|fperm|dperm\fR\&.
+Use fast CNID database namesearch instead of slow recursive filesystem search\&. Relies on a consistent CNID database, ie Samba or local filesystem access lead to inaccurate or wrong results\&. Works only for "dbd" CNID db volumes\&.
.RE
.PP
-usedots \fB(V)\fR
+stat vol = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR
.RS 4
-Don\'t do :hex translation for dot files\&. note: when this option gets set, certain file names become illegal\&. These are \&.Parent and anything that starts with \&.Apple\&. See also
-\fBinvisibledots\fR\&.
+Whether to stat volume path when enumerating volumes list, useful for automounting or volumes created by a preexec script\&.
.RE
.PP
-nodev \fB(V)\fR
+time machine = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR
.RS 4
-always use 0 for device number, helps when the device number is not constant across a reboot, cluster, \&.\&.\&.
+Whether to enable Time Machine suport for this volume\&.
.RE
.PP
-nohex \fB(V)\fR
+unix priv = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR
.RS 4
-Disables :hex translations for anything except dot files\&. This option makes the
-\'/\' character illegal\&.
+Whether to use AFP3 UNIX privileges\&. This should be set for OS X clients\&. See also:
+\fBfile perm\fR,
+\fBdirectory perm\fR
+and
+\fBumask\fR\&.
.RE
.PP
-nostat \fB(V)\fR
+use dots = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR
.RS 4
-don\'t stat volume path when enumerating volumes list, useful for automounting or volumes created by a preexec script\&.
+Whether to do :hex translation for dot files\&. See also
+\fBinvisible dots\fR\&.
.RE
.SH "CNID BACKENDS"
.PP
This version now uses UTF\-8 as the default encoding for names\&. Special characters, like \'/\' and a leading \'\&.\' will still be CAP style encoded \&.
.PP
The
-\fBvolcharset\fR
+\fBvol charset\fR
option will allow you to select another volume encoding\&. E\&.g\&. for western users another useful setting could be volcharset ISO\-8859\-15\&.
\fBapfd\fR
will accept any
\fBafpd\fR
will convert the UTF\-8
character to
-\fBmaccharset\fR
+\fBmac charset\fR
first\&. If this conversion fails, you\'ll receive a \-50 error on the mac\&.
.PP
\fINote\fR: Whenever you can, please stick with the default UTF\-8 volume format\&.
projects / netatalk.git / blobdiff