]> arthur.barton.de Git - netatalk.git/blob - config/AppleVolumes.default.tmpl
document the cnidscheme: parameter
[netatalk.git] / config / AppleVolumes.default.tmpl
1 # This file looks empty when viewed with "vi".  In fact, there is one
2 # '~', so users with no AppleVolumes file in their home directory get
3 # their home directory by default.
4
5 # volume format:
6 # :DEFAULT: [all of the default options except volume name]
7 # path [name] [casefold:x] [options:z,l,j] \
8 #   [allow:a,@b,c,d] [deny:a,@b,c,d] [dbpath:path] [password:p] \
9 #   [rwlist:a,@b,c,d] [rolist:a,@b,c,d] [limitsize:value in bytes]\
10 #   [preexec:cmd] [root_preexec:cmd] [postexec:cmd]  [root_postexec:cmd] 
11 #
12 #
13 # name:      volume name. it can't include the ':' character and is limited
14 #            to 27 characters in length.
15 #
16 # variable substitutions:
17 # you can use variables for both <path> and <name> now. here are the
18 # rules:
19 #     1) if you specify an unknown variable, it will not get converted. 
20 #     2) if you specify a known variable, but that variable doesn't have
21 #        a value, it will get ignored.
22 #
23 # the variables:
24 # $b   -> basename of path
25 # $c   -> client's ip or appletalk address
26 # $d   -> volume pathname on server    
27 # $f   -> full name (whatever's in the gecos field)
28 # $g   -> group
29 # $h   -> hostname 
30 # $s   -> server name (can be the hostname)
31 # $u   -> username (if guest, it's whatever user guest is running as)
32 # $v   -> volume name (either ADEID_NAME or basename of path)
33 # $z   -> zone (may not exist)
34 # $$   -> $
35 #
36 # casefold options [syntax: casefold:option]:
37 # tolower    -> lowercases names in both directions
38 # toupper    -> uppercases names in both directions
39 # xlatelower -> client sees lowercase, server sees uppercase
40 # xlateupper -> client sees uppercase, server sees lowercase
41 #
42 # allow/deny/rwlist/rolist format [syntax: allow:user1,@group]:
43 # user1,@group,user2  -> allows/denies access from listed users/groups
44 #                        rwlist/rolist control whether or not the
45 #                        volume is ro for those users.
46 # preexec             -> command to be run when the volume is mounted,
47 #                        ignore for user defined volumes
48 # root_preexec        -> command to be run as root when the volume is mounted,
49 #                        ignore for user defined volumes
50 # postexec             -> command to be run when the volume is closed,
51 #                        ignore for user defined volumes
52 # root_postexec        -> command to be run as root when the volume is closed,
53 #                        ignore for user defined volumes
54 #
55 # codepage options [syntax: options:charsetname]
56 # volcharset           -> specifies the charset to be used as the volume codepage
57 #                         e.g. "UTF8", "UTF8-MAC", "ISO-8859-15"
58 # maccharset           -> specifies the charset to be used as the mac client codepage
59 #                         e.g. "MAC_ROMAN", "MAC_CYRILLIC"
60 #
61 # miscellaneous options [syntax: options:option1,option2]:
62 # prodos              -> make compatible with appleII clients.
63 # crlf                -> enable crlf translation for TEXT files.
64 # noadouble           -> don't create .AppleDouble unless a resource
65 #                        fork needs to be created.
66 # ro                  -> mount the volume as read-only.
67 # mswindows           -> enforce filename restrictions imposed by MS
68 #                        Windows. this will also invoke a default
69 #                        codepage (iso8859-1) if one isn't already 
70 #                        specified.
71 # nohex               -> don't do :hex translations for anything
72 #                        except dot files. specify usedots as well if
73 #                        you want that turned off. note: this option
74 #                        makes the / character illegal.
75 # usedots             -> don't do :hex translation for dot files. note: when 
76 #                        this option gets set, certain file names
77 #                        become illegal. these are .Parent and
78 #                        anything that starts with .Apple. also, dot
79 #                        files created on the unix side are marked
80 #                        invisible. 
81 # limitsize           -> limit disk size reporting to 2GB. this is
82 #                        here for older macintoshes using newer
83 #                        appleshare clients. yucko.
84 # nofileid            -> don't advertise createfileid, resolveid, deleteid 
85 #                        calls
86 # root_preexec_close  -> a non-zero return code from root_preexec close the 
87 #                        volume being mounted.
88 # preexec_close       -> a non-zero return code from preexec close the 
89 #                        volume being mounted.
90 # nostat              -> don't stat volume path when enumerating volumes list
91 # upriv               -> use unix privilege.  
92 #
93 #
94 # dbpath:path         -> store the database stuff in the following path.
95 # password:password   -> set a volume password (8 characters max)
96 # cnidscheme:scheme   -> set the cnid scheme for the volume, default is [:DEFAULT_CNID_SCHEME:]
97 #                        available schemes: [:COMPILED_BACKENDS:]
98 #
99 # The "~" below indicates that Home directories are visible by default.
100 # If you do not wish to have people accessing their Home directories,
101 # please put a pound sign in front of the tilde or delete it.
102 ~