Minor corrections

[netatalk.git] / man / man5 / AppleVolumes.default.5.tmpl

diff --git a/man/man5/AppleVolumes.default.5.tmpl b/man/man5/AppleVolumes.default.5.tmpl
index 899bdb703f79a2cb6b8ebbc1faaea0d10eda9452..e1c49ec58d9bc6c8ab219817101b69e270a886c1 100644 (file)
--- a/man/man5/AppleVolumes.default.5.tmpl
+++ b/man/man5/AppleVolumes.default.5.tmpl
@@ -2,12 +2,12 @@
 .\"     Title: AppleVolumes.default
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
-.\"      Date: 23 Dec 2009
+.\"      Date: 31 Mar 2010
 .\"    Manual: Netatalk 2.1
 .\"    Source: Netatalk 2.1
 .\"  Language: English
 .\"
-.TH "APPLEVOLUMES\&.DEFAU" "5" "23 Dec 2009" "Netatalk 2.1" "Netatalk 2.1"
+.TH "APPLEVOLUMES\&.DEFAU" "5" "31 Mar 2010" "Netatalk 2.1" "Netatalk 2.1"
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
@@ -19,7 +19,7 @@
 .\" * MAIN CONTENT STARTS HERE *
 .\" -----------------------------------------------------------------
 .SH "NAME"
-AppleVolumes.default \- Configuration file used by \fBafpd\fR(8) to determine the shares made available through Appletalk
+AppleVolumes.default \- Configuration file used by \fBafpd\fR(8) to determine the shares made available through AFP
 .SH "DESCRIPTION"
 .PP
 :ETCDIR:/AppleVolumes\&.default
@@ -32,9 +32,9 @@ path
 .PP
 The path name must be a fully qualified path name, or a path name using either the ~ shell shorthand or any of the substitution variables, which are listed below\&.
 .PP
-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 there are spaces in the name, it should be in quotes (i\&.e\&. "File Share")\&. The volume name may not exceed 27 characters in length, and cannot contain the
+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 there are spaces in the name, it should be in quotes (i\&.e\&. "File Share")\&. The volume name cannot contain the
 \':\'
-character\&.
+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
 .if n \{\
 .sp
 .\}
@@ -61,7 +61,7 @@ The possible options and their meanings are:
 .PP
 adouble:\fI[v1|v2|osx]\fR
 .RS 4
-Specify the format of the metadata files, which are used for saving Mac resource fork as well\&. Earlier versions used AppleDouble V1, the new default format is V2\&. Starting with Netatalk 2\&.0, the scheme MacOS X uses currently (10\&.3\&.x), is also supported
+Specify the format of the metadata files, which are used for saving Mac resource fork as well\&. Earlier versions used AppleDouble V1, the new default format is V2\&. Starting with Netatalk 2\&.0, the scheme MacOS X 10\&.3\&.x uses, is also supported\&.
 .if n \{\
 .sp
 .\}
@@ -74,11 +74,9 @@ Specify the format of the metadata files, which are used for saving Mac resource
 \fBNote\fR
 .ps -1
 .br
-Using
 \fBadouble:osx\fR
-is
-\fBnot\fR
-recommended for production use\&. Its only aim is to temporarely share eg\&. FAT32 formatted FireWire harddrives written on a Macintosh with afpd\&. Apple\'s metadata scheme lacks several essential features, so using it on the server\'s side will break both CNIDs and MacOS 9 compatibility
+\fBcannot\fR
+be treated normally any longer\&. Its only aim was to temporarely share eg\&. FAT32 formatted FireWire harddrives written on a Macintosh with afpd\&. Apple\'s metadata scheme lacks several essential features, so using it on the server\'s side will break both CNIDs and MacOS 9 compatibility\&. AppleDouble file of Mac OS X 10\&.6 is incompatible to V1 and V2\&.
 .sp .5v
 .RE
 .RE
@@ -117,6 +115,13 @@ dbpath:\fI[path]\fR
 Sets the database information to be stored in path\&. You have to specifiy a writable location, even if the volume is read only\&.
 .RE
 .PP
+cnidserver:\fI[fqdn|IP[:port]]\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:\fI[none|auto|sys|ad]\fR
 .RS 4
 Specify how Extended Attributes
@@ -147,7 +152,7 @@ Use filesystem Extended Attributes\&.
 ad
 .RS 4
 Use files in
-\fIAppleDouble\fR
+\fI\&.AppleDouble\fR
 directories\&.
 .RE
 .PP
@@ -230,7 +235,7 @@ password:\fI[password]\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:[mode]
+perm|fperm|dperm:\fI[mode]\fR
 .RS 4
 Add(or) with the client requested permissions:
 \fBperm\fR
@@ -254,6 +259,11 @@ is for directories only\&. Use with
 .\}
 .RE
 .PP
+umask:\fI[mode]\fR
+.RS 4
+set perm mask\&.
+.RE
+.PP
 preexec:\fI[command]\fR
 .RS 4
 command to be run when the volume is mounted, ignored for user defined volumes
@@ -383,8 +393,6 @@ $$
 prints dollar sign ($)
 .RE
 .PP
-When using variable substitution in the volume name, always keep in mind, not to exceed the 27 characters limit
-.PP
 \fBExample.\ \&Using variable substitution when defining volumes\fR
 .PP
 .if n \{\
@@ -552,6 +560,11 @@ Allows a volume to be declared as being a "dropbox\&." Note that netatalk must b
 \fIWarning\fR: This option is deprecated and might not work as expected\&.
 .RE
 .PP
+dropkludge
+.RS 4
+same as "dropbox"\&.
+.RE
+.PP
 mswindows
 .RS 4
 Forces filename restrictions imposed by MS WinXX\&.
@@ -620,7 +633,7 @@ don\'t stat volume path when enumerating volumes list, useful for automounting o
 .PP
 prodos
 .RS 4
-Provides compatibility with Apple II clients\&.
+Provides compatibility with Apple II clients\&. (legacy)
 .RE
 .RE
 .SH "SEE ALSO"