2 .\" Title: AppleVolumes.default
3 .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
6 .\" Manual: Netatalk 2.2
7 .\" Source: Netatalk 2.2
10 .TH "APPLEVOLUMES\&.DEFAU" "5" "30 Mar 2011" "Netatalk 2.2" "Netatalk 2.2"
11 .\" -----------------------------------------------------------------
12 .\" * set default formatting
13 .\" -----------------------------------------------------------------
14 .\" disable hyphenation
16 .\" disable justification (adjust text to left margin only)
18 .\" -----------------------------------------------------------------
19 .\" * MAIN CONTENT STARTS HERE *
20 .\" -----------------------------------------------------------------
22 AppleVolumes.default, AppleVolumes.system, AppleVolumes \- Configuration file used by \fBafpd\fR(8) to determine the shares made available through AFP and specify file name extension mappings\&.
24 .HP \w'\fB:ETCDIR:/AppleVolumes\&.default\fR\fB\fR\fB:ETCDIR:/AppleVolumes\&.system\fR\fB\fR\fB~/AppleVolumes\fR\fB\fR\fB~/\&.AppleVolumes\fR\fB\fR\fB~/applevolumes\fR\fB\fR\fB~/\&.applevolumes\fR\fB\fR\ 'u
25 \fB:ETCDIR:/AppleVolumes\&.default\fR\fB\fR
27 \fB:ETCDIR:/AppleVolumes\&.system\fR\fB\fR
29 \fB~/AppleVolumes\fR\fB\fR
31 \fB~/\&.AppleVolumes\fR\fB\fR
33 \fB~/applevolumes\fR\fB\fR
35 \fB~/\&.applevolumes\fR\fB\fR
39 :ETCDIR:/AppleVolumes\&.system
41 :ETCDIR:/AppleVolumes\&.default,
46 are the configuration files used by
48 to determine what portions of the file system will be shared via Apple Filing Protocol, as well as their behaviour\&.
50 Any line not prefixed with # is interpreted\&. Newline escaping is supported\&. The configuration lines are composed like:
53 \fI[ volume name ] [ options ]\fR
56 \fI[ type [ creator ] ]\fR
58 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\&.
60 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
62 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
68 .nr an-no-space-flag 1
76 Each volume has to be configured on a
78 line\&. Though newline escaping is supported\&.
82 The leading\-dot lines specify file name extension mappings\&. The extension \'\&.\' sets the default creator and type for otherwise untyped Unix files\&.
88 .nr an-no-space-flag 1
96 File name extension mapping is useful for Mac OS 9 and earlier\&. But it should not use for Mac OS X\&.
100 It is possible to specify default options for all volumes with a
101 \fI:DEFAULT: \fRline preceeding these volume definitions:
103 \fBExample.\ \&:DEFAULT: configuration line\fR
109 :DEFAULT: options:upriv,usedots dbpath:/var/dbd/AppleDB/$v dperm:0775 fperm:0664
115 The possible options and their meanings are:
117 adouble:\fI[v1|v2|osx]\fR
119 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\&.
125 .nr an-no-space-flag 1
134 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\&.
139 volsizelimit:\fIsize in MiB\fR
141 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\&.
144 allow:\fI[users/groups]\fR
146 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
149 deny:\fI[users/groups]\fR
151 The deny option specifies users and groups who are not allowed access to the share\&. It follows the same format as the allow option\&.
154 allowed_hosts:\fI[IP host address/IP netmask bits[, \&.\&.\&. ]]\fR
156 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\&.
158 Example: allowed_hosts:10\&.1\&.0\&.0/16,10\&.2\&.1\&.100,2001:0db8:1234::/48
161 denied_hosts:\fI[IP host address/IP netmask bits[, \&.\&.\&.]]\fR
163 Listed hosts and nets are rejected, all others are allowed\&.
165 Example: denied_hosts: 192\&.168\&.100/24,10\&.1\&.1\&.1,2001:db8::1428:57ab
168 cnidscheme:\fI[backend]\fR
170 set the CNID backend to be used for the volume, default is [:DEFAULT_CNID_SCHEME:] available schemes: [:COMPILED_BACKENDS:]
175 Sets the database information to be stored in path\&. You have to specifiy a writable location, even if the volume is read only\&.
178 cnidserver:\fI[fqdn|IP[:port]]\fR
180 Query this servername or IP address (default:\fIlocalhost\fR) and port (default:
181 \fI4700\fR) for CNIDs\&. Only used with CNID backend "\fIdbd\fR"\&. This option here overrides any setting from
182 afpd\&.conf:\fBcnidserver\fR\&.
185 ea:\fI[none|auto|sys|ad]\fR
187 Specify how Extended Attributes
196 (by setting an EA on the shared directory itself), fallback to
197 \fBad\fR\&. Requires writeable volume for perfoming test\&.
202 \fBnone\fR\&. Use explicit
204 for read\-only volumes where appropiate\&.
209 Use filesystem Extended Attributes\&.
221 No Extended Attributes support\&.
225 maccharset:\fI[charset]\fR
227 specifies the mac client codepage for this Volume, e\&.g\&. "MAC_ROMAN", "MAC_CYRILLIC"\&. If not specified the setting from
229 is inherited\&. This setting is only required if you need volumes, where the mac codepage differs from the one globally set in
233 options:\fI[option]\fR
235 This allows multiple options to be specified in a comma delimited format\&. The available options are:
239 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\&.
244 Enable Time Machine suport for this volume\&.
250 \fBusedots\fR: make dot files invisible\&.
255 Limit disk size reporting to 2GB\&. This can be used for older Macintoshes using newer Appleshare clients\&.
260 a non\-zero return code from preexec close the volume being immediately, preventing clients to mount/see the volume in question\&.
265 Specifies the share as being read only for all users\&. The \&.AppleDB directory has to be writeable, you can use the
267 option to relocate it\&. Overwrites
275 a non\-zero return code from root_preexec closes the volume immediately, preventing clients to mount/see the volume in question\&.
280 use AFP3 unix privileges\&. Become familiar with the new "unix privileges" AFP permissions concepts in MacOS X before using this option\&. See also:
281 \fBperm|fperm|dperm\fR\&.
286 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
287 \fBinvisibledots\fR\&.
291 password:\fI[password]\fR
293 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)\&.
296 perm|fperm|dperm:\fI[mode]\fR
298 Add(or) with the client requested permissions:
300 affects files and directories,
304 is for directories only\&. Use with
305 \fBoptions:upriv\fR\&.
307 \fBExample.\ \&Volume for a collaborative workgroup\fR
313 /path/to/volume "Workgroup" options:upriv dperm:0770 fperm:0660
322 set perm mask\&. Use with
323 \fBoptions:upriv\fR\&.
326 preexec:\fI[command]\fR
328 command to be run when the volume is mounted, ignored for user defined volumes
331 postexec:\fI[command]\fR
333 command to be run when the volume is closed, ignored for user defined volumes
336 root_preexec:\fI[command]\fR
338 command to be run as root when the volume is mounted, ignored for user defined volumes
341 root_postexec:\fI[command]\fR
343 command to be run as root when the volume is closed, ignored for user defined volumes
346 rolist:[\fBusers/groups\fR]
348 Allows certain users and groups to have read\-only access to a share\&. This follows the allow option format\&.
351 rwlist:\fI[users/groups]\fR
353 Allows certain users and groups to have read/write access to a share\&. This follows the allow option format\&.
356 veto:\fI[vetoed names]\fR
358 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/"\&.
361 volcharset:\fI[charset]\fR
363 specifies the volume codepage, e\&.g\&. "UTF8", "UTF8\-MAC", "ISO\-8859\-15"\&. Defaults to "UTF8"\&.
365 .SH "VARIABLE SUBSTITUTIONS"
367 You can use variables in both volume path and volume name\&.
377 if you specify an unknown variable, it will not get converted\&.
388 if you specify a known variable, but that variable doesn\'t have a value, it will get ignored\&.
391 The variables which can be used for substitutions are:
400 client\'s ip or appletalk address
405 volume pathname on server
410 full name (contents of the gecos field in the passwd file)
425 client\'s ip, without port
430 server name (this can be the hostname)
435 user name (if guest, it is the user that guest is running as)
440 volume name (either ADEID_NAME or basename of path)
445 appletalk zone (may not exist)
450 prints dollar sign ($)
453 \fBExample.\ \&Using variable substitution when defining volumes\fR
459 /home/groups/$g "Groupdir for $g"
460 ~ "$f is the best one"
466 We define "groupdirs" for each primary group and use a personalized server name for homedir shares\&.
469 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
471 folder in the volume root\&.
475 "Concurrent database", backend is based on Sleepycat\'s Berkely DB\&. With this backend several
477 deamons access the CNID database directly\&. Berkeley DB locking is used to synchronize access, if more than one
479 process is active for a volume\&. The drawback is, that the crash of a single
481 process might corrupt the database\&.
486 Access to the CNID database is restricted to the
490 processes communicate with the daemon for database reads and updates\&. If built with Berkeley DB transactions the probability for database corruption is practically zero, but performance can be slower than with
496 This backend is an exception, in terms of ID persistency\&. ID\'s are only valid for the current session\&. This is basically what
498 did in the 1\&.5 (and 1\&.6) versions\&. This backend is still available, as it is useful for e\&.g\&. sharing cdroms\&.
502 recommended to use this backend for volumes anymore, as
504 now relies heavily on a persistent ID database\&. Aliases will likely not work and filename mangling is not supported\&.
508 \fB\&./configure \-\-help\fR
509 might show that there are other CNID backends available, be warned those are likely broken or mainly used for testing\&. Don\'t use them unless you know what you\'re doing, they may be removed without further notice from future versions\&.
510 .SH "CHARSET OPTIONS"
512 With OS X Apple introduced the AFP3 protocol\&. One of the most important changes was that AFP3 uses unicode names encoded as UTF\-8 decomposed\&. Previous AFP/OS versions used codepages, like MacRoman, MacCentralEurope, etc\&.
515 needs a way to preserve extended macintosh characters, or characters illegal in unix filenames, when saving files on a unix filesystem\&. Earlier versions used the the so called CAP encoding\&. An extended character (>0x7F) would be converted to a :xx sequence, e\&.g\&. the Apple Logo (MacRoman: 0XF0) was saved as
516 :f0\&. Some special characters will be converted as to :xx notation as well\&. \'/\' will be encoded to
519 is not specified, a leading dot \'\&.\' will be encoded as
522 This version now uses UTF\-8 as the default encoding for names\&. Special characters, like \'/\' and a leading \'\&.\' will still be CAP style encoded \&.
526 option will allow you to select another volume encoding\&. E\&.g\&. for western users another useful setting could be \-volcharset ISO\-8859\-15\&.
530 provided charset\&. If a character cannot be converted from the mac codepage to the selected volcharset, afpd will save it as a CAP encoded character\&. For AFP3 clients,
532 will convert the UTF\-8
535 first\&. If this conversion fails, you\'ll receive a \-50 error on the mac\&.
537 \fINote\fR: Whenever you can, please stick with the default UTF\-8 volume format\&.
538 .SH "COMPATIBILITY WITH EARLIER VERSIONS"
540 To use a volume created with an earlier
542 version, you\'ll have to specify the following options:
544 \fBExample.\ \&use a 1.x style volume\fR
550 /path/to/volume "Volname" adouble:v1 volcharset:ASCII
556 In case you used an NLS you could try using a compatible iconv charset for
557 \fB\-volcharset\fR\&.
559 \fBExample.\ \&use a 1.x style volume, created with maccode.iso8859-1\fR
565 /path/to/volume "Volname" adouble:v1 volcharset:ISO\-8859\-1
571 You should consider converting old style volumes to the new UTF\-8/AD2 format\&. The safest way to do this, is to create a new volume with the default options and copy the files between this volumes with a mac\&.
573 \fINote\fR: Using above example options will allow you to downgrade to 1\&.x netatalk again\&.
575 \fINote\fR: Some 1\&.x NLS files used non standard mappings, e\&.g\&.
576 maccode\&.iso8859\-1\&.adapted\&. Three 1\&.x CAP double\-byte maccharsets are incompatible to netatalk 2\&.x; "MAC_CHINESE_TRAD", "MAC_JAPANESE" and "MAC_KOREAN"\&. These are not supported anymore\&. You\'ll have to copy the contents of those volumes files to a Mac and then back to the netatalk server, preferably to an UTF\-8 volume\&.
577 .SH "ADVANCED OPTIONS"
579 The following options should only be used after serious consideration\&. Be sure you fully understood the, sometimes complex, consequences, before using them\&.
581 casefold:\fB[option]\fR
583 The casefold option handles, if the case of filenames should be changed\&. The available options are:
586 \- Lowercases names in both directions\&.
589 \- Uppercases names in both directions\&.
592 \- Client sees lowercase, server sees uppercase\&.
595 \- Client sees uppercase, server sees lowercase\&.
598 options:[\fBoption\fR]
600 This allows multiple options to be specified in a comma delimited format\&. The available options are:
604 The underlying filesystem is case insensitive (only tested with JFS in OS2 mode)\&.
609 Enables crlf translation for TEXT files, automatically converting macintosh line breaks into Unix ones\&. Use of this option might be dangerous since some older programs store binary data files as type "TEXT" when saving and switch the filetype in a second step\&.
611 will potentially destroy such files when "erroneously" changing bytes in order to do line break translation\&.
616 Allows a volume to be declared as being a "dropbox\&." Note that netatalk must be compiled with dropkludge support for this to function\&.
617 \fIWarning\fR: This option is deprecated and might not work as expected\&.
627 Forces filename restrictions imposed by MS WinXX\&.
628 \fIWarning\fR: This is
630 recommened for volumes mainly used by Macs\&. Please make sure you fully understand this option before using it\&.
636 .nr an-no-space-flag 1
643 This option breaks direct saving to netatalk volumes from some applications, i\&.e\&. OfficeX\&.
652 to not create \&.AppleDouble directories unless macintosh metadata needs to be written\&. This option is only useful if you want to share files mostly used NOT by macs, causing
654 to not automatically create \&.AppleDouble subdirs containing AD header files in every directory it enters (which will it do by default)\&.
656 In case, you save or change files from mac clients, AD metadata files have to be written even in case you set this option\&. So you can\'t avoid the creation of \&.AppleDouble directories and its contents when you give macs write access to a share and they make use of it\&.
667 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\&.
672 always use 0 for device number, helps when the device number is not constant across a reboot, cluster, \&.\&.\&.
677 don\'t advertise createfileid, resolveid, deleteid calls\&.
682 Disables :hex translations for anything except dot files\&. This option makes the
683 \'/\' character illegal\&.
688 don\'t stat volume path when enumerating volumes list, useful for automounting or volumes created by a preexec script\&.
693 Provides compatibility with Apple II clients\&. (legacy)
696 .SH "FILE NAME EXTENSION MAPPINGS"
698 \fBExample.\ \&Extension is jpg. Type is "JPEG". Creator is "ogle".\fR
710 \fBExample.\ \&Extension is lzh. Type is "LHA ". Creator is not defined.\fR