.\" 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: 02 Octobre 2009
+.\" Date: 31 Mar 2010
.\" Manual: Netatalk 2.1
.\" Source: Netatalk 2.1
.\" Language: English
.\"
-.TH "APPLEVOLUMES\&.DEFAU" "5" "02 Octobre 2009" "Netatalk 2.1" "Netatalk 2.1"
+.TH "APPLEVOLUMES\&.DEFAU" "5" "31 Mar 2010" "Netatalk 2.1" "Netatalk 2.1"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.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
.\}
.sp .5v
.RE
.PP
+It is possible to specify default options for all volumes with a
+\fI:DEFAULT: \fRline preceeding these volume definitions:.PP \fBExample.\ \&:DEFAULT: configuration line\fR .PP :DEFAULT: options:upriv,usedots dbpath:/var/dbd/AppleDB/$v dperm:0775 fperm:0664
+.PP
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
.\}
\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
The deny option specifies users and groups who are not allowed access to the share\&. It follows the same format as the allow option\&.
.RE
.PP
-allowed_hosts:\fI[IPv4 host address/IPv4 netmask bits[, \&.\&.\&. ]]\fR
+allowed_hosts:\fI[IP host address/IP netmask bits[, \&.\&.\&. ]]\fR
.RS 4
-Only listed hosts and networks are allowed, all others are rejected\&. Example: allowed_hosts:10\&.1\&.0\&.0/16,10\&.2\&.1\&.100
+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
.RE
.PP
-denied_hosts:\fI[IPv4 host address/IPv4 netmask bits[, \&.\&.\&.]]\fR
+denied_hosts:\fI[IP host address/IP netmask bits[, \&.\&.\&.]]\fR
.RS 4
-Listed hosts and nets are rejected, all others are allowed\&. Example: denied_hosts: 192\&.168\&.100/24,10\&.1\&.1\&.1
+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
.RE
.PP
cnidscheme:\fI[backend]\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
-ea:\fI[sys|ad]\fR
+cnidserver:\fI[fqdn|IP[:port]]\fR
.RS 4
-Specify the format of the metadata files which are used for saving Extended Attributes\&.
+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
+are stored\&.
+\fBauto\fR
+is the default\&.
+.PP
+auto
+.RS 4
+Try
\fBsys\fR
-is the default and stores the EAs in native filesystem Extended Attributes\&.
-\fBad\fR
-uses ordinary files inside the \&.AppleDouble directories\&.
+(by setting an EA on the shared directory itself), fallback to
+\fBad\fR\&. Requires writeable volume for perfoming test\&.
+\fBoptions:ro\fR
+overwrites
+\fBauto\fR
+with
+\fBnone\fR\&. Use explicit
+\fBea:sys|ad\fR
+for read\-only volumes where appropiate\&.
+.RE
+.PP
+sys
+.RS 4
+Use filesystem Extended Attributes\&.
+.RE
+.PP
+ad
+.RS 4
+Use files in
+\fI\&.AppleDouble\fR
+directories\&.
+.RE
+.PP
+none
+.RS 4
+No Extended Attributes support\&.
+.RE
.RE
.PP
maccharset:\fI[charset]\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\&.
+option to relocate it\&. Overwrites
+\fBea:auto\fR
+with
+\fBea:none\fR
.RE
.PP
root_preexec_close
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
.\}
.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
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 \{\
.RS 4
This allows multiple options to be specified in a comma delimited format\&. The available options are:
.PP
-nocnidcache
+caseinsensitive
.RS 4
-If set
-\fBafpd\fR
-doesn\'t store the ID information in AppleDouble V2 header files\&. As these IDs are used for caching and as a database backup, this option normally shouldn\'t be set\&.
+The underlying filesystem is case insensitive (only tested with JFS in OS2 mode)\&.
.RE
.PP
crlf
\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\&.
whenever possible\&.
.RE
.PP
+nocnidcache
+.RS 4
+If set
+\fBafpd\fR
+doesn\'t store the ID information in AppleDouble V2 header files\&. As these IDs are used for caching and as a database backup, this option normally shouldn\'t be set\&.
+.RE
+.PP
nodev
.RS 4
always use 0 for device number, helps when the device number is not constant across a reboot, cluster, \&.\&.\&.
.PP
prodos
.RS 4
-Provides compatibility with Apple II clients\&.
+Provides compatibility with Apple II clients\&. (legacy)
.RE
.RE
.SH "SEE ALSO"
.PP
\fBafpd.conf\fR(5),
-\fBafpd\fR(8)
+\fBafpd\fR(8),
+\fBafp_ldap.conf\fR(5),
+\fBafp_acls\fR(8)
projects / netatalk.git / blobdiff