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.
7 # :DEFAULT: [all of the default options except volume name]
8 # path [name] [casefold:x] [options:z,l,j] \
9 # [allow:a,@b,c,d] [deny:a,@b,c,d] [dbpath:path] [password:p] \
10 # [rwlist:a,@b,c,d] [rolist:a,@b,c,d] [limitsize:value in bytes] \
11 # [preexec:cmd] [root_preexec:cmd] [postexec:cmd] [root_postexec:cmd] \
12 # [allowed_hosts:IPv4 address[/IPv4 netmask bits]] \
13 # [denied_hosts:IPv4 address[/IPv4 netmask bits]] \
15 # name: volume name. it can't include the ':' character
19 # variable substitutions:
20 # you can use variables for both <path> and <name> now. here are the
22 # 1) if you specify an unknown variable, it will not get converted.
23 # 2) if you specify a known variable, but that variable doesn't have
24 # a value, it will get ignored.
27 # $b -> basename of path
28 # $c -> client's ip or appletalk address
29 # $d -> volume pathname on server
30 # $f -> full name (whatever's in the gecos field)
33 # $i -> client ip without tcp port or appletalk network
34 # $s -> server name (can be the hostname)
35 # $u -> username (if guest, it's whatever user guest is running as)
36 # $v -> volume name (either ADEID_NAME or basename of path)
37 # $z -> zone (may not exist)
40 # casefold options [syntax: casefold:option]:
41 # tolower -> lowercases names in both directions
42 # toupper -> uppercases names in both directions
43 # xlatelower -> client sees lowercase, server sees uppercase
44 # xlateupper -> client sees uppercase, server sees lowercase
46 # allow/deny/rwlist/rolist format [syntax: allow:user1,@group]:
47 # user1,@group,user2 -> allows/denies access from listed users/groups
48 # rwlist/rolist control whether or not the
49 # volume is ro for those users.
50 # allowed_hosts -> Only listed hosts and networks are allowed,
51 # all others are rejected. Example:
52 # allowed_hosts:10.1.0.0/16,10.2.1.100
53 # denied_hosts -> Listed hosts and nets are rejected,
54 # all others are allowed. Example:
55 # denied_hosts: 192.168.100/24,10.1.1.1
56 # preexec -> command to be run when the volume is mounted,
57 # ignore for user defined volumes
58 # root_preexec -> command to be run as root when the volume is mounted,
59 # ignore for user defined volumes
60 # postexec -> command to be run when the volume is closed,
61 # ignore for user defined volumes
62 # root_postexec -> command to be run as root when the volume is closed,
63 # ignore for user defined volumes
65 # codepage options [syntax: options:charsetname]
66 # volcharset -> specifies the charset to be used
67 # as the volume codepage
68 # e.g. "UTF8", "UTF8-MAC", "ISO-8859-15"
69 # maccharset -> specifies the charset to be used
70 # as the mac client codepage
71 # e.g. "MAC_ROMAN", "MAC_CYRILLIC"
73 # perm -> default permission value
74 # OR with the client requested perm
75 # dperm -> default permission value for directories
76 # OR with the client requested perm
77 # fperm -> default permission value for files
78 # OR with the client requested perm
80 # dbpath:path -> store the database stuff in the following path.
81 # password:password -> set a volume password (8 characters max)
82 # cnidscheme:scheme -> set the cnid scheme for the volume,
83 # default is [:DEFAULT_CNID_SCHEME:]
84 # available schemes: [:COMPILED_BACKENDS:]
85 # ea -> none|auto|sys|ad
86 # Specify how Extended Attributes are stores. default
88 # auto: try "sys" (by setting an EA on the shared
89 # directory itself), fallback to "ad". Requires
90 # writable volume for performing the test.
91 # Note: options:ro overwrites "auto" with "none."
92 # sys: Use filesystem EAs
93 # ad: Use files in AppleDouble directories
97 # miscellaneous options [syntax: options:option1,option2]:
98 # tm -> enable TimeMachine support
99 # prodos -> make compatible with appleII clients.
100 # crlf -> enable crlf translation for TEXT files.
101 # noadouble -> don't create .AppleDouble unless a resource
102 # fork needs to be created.
103 # ro -> mount the volume as read-only.
104 # mswindows -> enforce filename restrictions imposed by MS
105 # Windows. this will also invoke a default
106 # codepage (iso8859-1) if one isn't already
108 # nohex -> don't do :hex translations for anything
109 # except dot files. specify usedots as well if
110 # you want that turned off. note: this option
111 # makes the / character illegal.
112 # usedots -> don't do :hex translation for dot files. note: when
113 # this option gets set, certain file names
114 # become illegal. these are .Parent and
115 # anything that starts with .Apple.
116 # invisibledots -> don't do :hex translation for dot files. note: when
117 # this option gets set, certain file names
118 # become illegal. these are .Parent and
119 # anything that starts with .Apple. also, dot
120 # files created on the unix side are marked invisible.
121 # limitsize -> limit disk size reporting to 2GB. this is
122 # here for older macintoshes using newer
123 # appleshare clients. yucko.
124 # nofileid -> don't advertise createfileid, resolveid, deleteid
126 # root_preexec_close -> a non-zero return code from root_preexec close the
127 # volume being mounted.
128 # preexec_close -> a non-zero return code from preexec close the
129 # volume being mounted.
130 # nostat -> don't stat volume path when enumerating volumes list
131 # upriv -> use unix privilege.
132 # illegalseq -> encode illegal sequence in filename asis,
133 # ex "\217-", which is not a valid SHIFT-JIS char,
134 # is encoded as U\217 -
135 # acls -> Enable ACLs on this volume. Requires a NFSv4 ACLs
136 # compatible filesystem (e.g. ZFS) and an ACL API
137 # compatible to *Solaris. In other words: this requires
138 # Solaris, Opensolaris or a derived distribution.
139 # nocnidcache -> Don't store and read CNID to/from AppleDouble file.
140 # This should not be used as it also prevents a CNID
141 # database rebuild with `dbd`!
142 # caseinsensitive -> The underlying FS is case insensitive (only
143 # test with JFS in OS2 mode)
146 # The "~" below indicates that Home directories are visible by default.
147 # If you do not wish to have people accessing their Home directories,
148 # please put a pound sign in front of the tilde or delete it.