]> arthur.barton.de Git - netatalk.git/blobdiff - man/man5/afp.conf.5.tmpl
Updates manpage and news
[netatalk.git] / man / man5 / afp.conf.5.tmpl
index 0724dd8c25d429d8d5f11ab3ede687447d672432..c96eddb828d95ab0c585d260245112ec3f1a9cc8 100644 (file)
@@ -2,12 +2,12 @@
 .\"     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: 22 Mar 2012
+.\"      Date: 26 Mar 2012
 .\"    Manual: Netatalk 3.0
 .\"    Source: Netatalk 3.0
 .\"  Language: English
 .\"
-.TH "AFP\&.CONF" "5" "22 Mar 2012" "Netatalk 3.0" "Netatalk 3.0"
+.TH "AFP\&.CONF" "5" "26 Mar 2012" "Netatalk 3.0" "Netatalk 3.0"
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
@@ -100,7 +100,6 @@ path = /foo/bar
 .if n \{\
 .RE
 .\}
-.sp
 .SH "SPECIAL SECTIONS"
 .SS "The [Global] section"
 .PP
@@ -284,7 +283,7 @@ Allow Kerberos V for authentication (optional)
 .PP
 uam path = \fIpath\fR \fB(G)\fR
 .RS 4
-Sets the default path for UAMs for this server (default is :ETCDIR:/uams)\&.
+Sets the default path for UAMs for this server (default is :LIBDIR:/netatalk)\&.
 .RE
 .PP
 k5 keytab = \fIpath\fR \fB(G)\fR, k5 service = \fIservice\fR \fB(G)\fR, k5 realm = \fIrealm\fR \fB(G)\fR
@@ -372,7 +371,7 @@ Search scope for user search:
 .sp
 .RE
 .PP
-ldap uuuid attr = \fIdn\fR \fB(G)\fR
+ldap uuid attr = \fIdn\fR \fB(G)\fR
 .RS 4
 Name of the LDAP attribute with the UUIDs\&.
 .sp
@@ -479,6 +478,11 @@ Allows a different TCP port to be used for AFP\&. The default is 548\&. Also set
 option\&.
 .RE
 .PP
+max connections = \fInumber\fR \fB(G)\fR
+.RS 4
+Sets the maximum number of clients that can simultaneously connect to the server (default is 200)\&.
+.RE
+.PP
 sleep time = \fInumber\fR \fB(G)\fR
 .RS 4
 Keep sleeping AFP sessions for
@@ -552,8 +556,7 @@ syscall for sending file data to clients\&.
 vol dbpath = \fIpath\fR \fB(G)\fR
 .RS 4
 Sets the database information to be stored in path\&. You have to specifiy a writable location, even if the volume is read only\&. The default is
-$localstatedir/netatalk/CNID/, where $localstatedir defaults to
-/var\&.
+:STATEDIR:/netatalk/CNID/\&.
 .RE
 .PP
 basedir regex = \fIregex\fR \fB(H)\fR
@@ -636,7 +639,7 @@ Specifies the icon model that appears on clients\&. Defaults to off\&. Examples:
 signature = <text> \fB(G)\fR
 .RS 4
 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
+:STATEDIR:/netatalk/afp_signature\&.conf
 automatically (based on random number)\&. See also asip\-status\&.pl(1)\&.
 .RE
 .PP
@@ -666,7 +669,9 @@ Use the platform\-specific icon\&. Mac OS X doesn\'t display it\&.
 .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!
+Enable "Continuous AFP Service"\&. This means restarting AFP and CNID service daemons master processes, but keeping the AFP session processes\&. This can be used to install (most) updates to Netatalk without interruping active AFP sessions\&. Existing AFP sessions will still run the version from before updating, but new AFP sessions will run the updated code\&. After enabling this option when sending SIGQUIT to the
+\fInetatalk\fR
+service controller process, the AFP and CNID daemons will exit and then the service controller will restart them\&. AFP session processes are notified of the master afpd shutdown, they will then sleep 15\-20 seconds and then try to reconnect their IPC channel to the master afpd process\&. The IPC channel between the AFP master service daemon and the AFP session child is used for keeping session state of AFP sessions in the AFP master process\&. The session state is needed when AFP clients experience eg network outages and try to reconnect to the AFP server\&.
 .RE
 .PP
 map acls = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(G)\fR
@@ -689,7 +694,7 @@ If not specified Netatalk logs to syslogs daemon facilify\&. Otherwise it logs t
 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
+\fBlog level\fR
 should be logged\&.
 .sp
 By default afpd logs to syslog with a default logging setup equivalent to
@@ -766,14 +771,14 @@ invalid users = \fIusers/groups\fR \fB(V)\fR
 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
-hosts allow = \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: hosts allow = 10\&.1\&.0\&.0/16 10\&.2\&.1\&.100 2001:0db8:1234::/48
 .RE
 .PP
-hosts deny = \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
@@ -937,17 +942,9 @@ 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
-hex encoding = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR
-.RS 4
-Whether :hex encoding is done for file and directory names containing the character
-/\&. Setting this option to no makes the
-/
-character illegal\&.
-.RE
-.PP
 invisible dots = \fIBOOLEAN\fR (default: \fIno\fR) \fB(V)\fR
 .RS 4
-make dot files invisible\&. If "\fBuse dots = no\fR", this parameter is not unnecessary\&.
+make dot files invisible\&.
 .RE
 .PP
 network ids = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR
@@ -998,12 +995,6 @@ Whether to use AFP3 UNIX privileges\&. This should be set for OS X clients\&. Se
 and
 \fBumask\fR\&.
 .RE
-.PP
-use dots = \fIBOOLEAN\fR (default: \fIyes\fR) \fB(V)\fR
-.RS 4
-Whether to do :hex translation for dot files\&. See also
-\fBinvisible dots\fR\&.
-.RE
 .SH "CNID BACKENDS"
 .PP
 The AFP protocol mostly refers to files and directories by ID and 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
@@ -1012,7 +1003,7 @@ folder in the volume root\&.
 .PP
 cdb
 .RS 4
-"Concurrent database", backend is based on Sleepycat\'s Berkely DB\&. With this backend several
+"Concurrent database", backend is based on Oracle Berkely DB\&. With this backend several
 \fBafpd\fR
 deamons access the CNID database directly\&. Berkeley DB locking is used to synchronize access, if more than one
 \fBafpd\fR