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 #
   6 # volume format:
   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]] \
  14 #   ... more, see below ...
  15 #
  16 # name:      volume name. it can't include the ':' character
  17 #
  18
  19 #
  20 # variable substitutions:
  21 # you can use variables for both <path> and <name> now. here are the
  22 # rules:
  23 #     1) if you specify an unknown variable, it will not get converted.
  24 #     2) if you specify a known variable, but that variable doesn't have
  25 #        a value, it will get ignored.
  26 #
  27 # the variables:
  28 # $b   -> basename of path
  29 # $c   -> client's ip or appletalk address
  30 # $d   -> volume pathname on server
  31 # $f   -> full name (whatever's in the gecos field)
  32 # $g   -> group
  33 # $h   -> hostname
  34 # $i   -> client ip without tcp port or appletalk network
  35 # $s   -> server name (can be the hostname)
  36 # $u   -> username (if guest, it's whatever user guest is running as)
  37 # $v   -> volume name (either ADEID_NAME or basename of path)
  38 # $z   -> zone (may not exist)
  39 # $$   -> $
  40 #
  41
  42 #
  43 # casefold options [syntax: casefold:option]:
  44 # tolower    -> lowercases names in both directions
  45 # toupper    -> uppercases names in both directions
  46 # xlatelower -> client sees lowercase, server sees uppercase
  47 # xlateupper -> client sees uppercase, server sees lowercase
  48 #
  49 # allow/deny/rwlist/rolist format [syntax: allow:user1,@group]:
  50 # user1,@group,user2  -> allows/denies access from listed users/groups
  51 #                        rwlist/rolist control whether or not the
  52 #                        volume is ro for those users.
  53 # allowed_hosts       -> Only listed hosts and networks are allowed,
  54 #                        all others are rejected. Example:
  55 #                        allowed_hosts:10.1.0.0/16,10.2.1.100
  56 # denied_hosts        -> Listed hosts and nets are rejected,
  57 #                        all others are allowed. Example:
  58 #                        denied_hosts: 192.168.100/24,10.1.1.1
  59 # preexec             -> command to be run when the volume is mounted,
  60 #                        ignore for user defined volumes
  61 # root_preexec        -> command to be run as root when the volume is mounted,
  62 #                        ignore for user defined volumes
  63 # postexec            -> command to be run when the volume is closed,
  64 #                        ignore for user defined volumes
  65 # root_postexec       -> command to be run as root when the volume is closed,
  66 #                        ignore for user defined volumes
  67 # veto                -> hide files and directories,where the path matches
  68 #                        one of the "/" delimited vetoed names. Matches are
  69 #                        partial, e.g. path is /abc/def/file and veto:/abc/
  70 #                        will hide the file.
  71 # adouble             -> specify the format of the metadata files.
  72 #                        default is "v2". netatalk 1.x used "v1".
  73 #                        "osx" cannot be treated normally any longer.
  74
  75
  76 #
  77 # codepage options [syntax: options:charsetname]
  78 # volcharset          -> specifies the charset to be used
  79 #                        as the volume codepage
  80 #                        e.g. "UTF8", "UTF8-MAC", "ISO-8859-15"
  81 # maccharset          -> specifies the charset to be used
  82 #                        as the mac client codepage
  83 #                        e.g. "MAC_ROMAN", "MAC_CYRILLIC"
  84 #
  85 # perm                -> default permission value
  86 #                        OR with the client requested perm
  87 # dperm               -> default permission value for directories
  88 #                        OR with the client requested perm
  89 # fperm               -> default permission value for files
  90 #                        OR with the client requested perm
  91 # umask               -> set perm mask
  92 # dbpath:path         -> store the database stuff in the following path.
  93 # cnidserver:server[:port]
  94 #                     -> Query this servername or IP address (default:localhost)
  95 #                        and port (default: 4700) for CNIDs. Only used with
  96 #                        CNID backend "dbd". This option here overrides any
  97 #                        setting from afpd.conf:cnidserver.
  98 # password:password   -> set a volume password (8 characters max)
  99 # cnidscheme:scheme   -> set the cnid scheme for the volume,
 100 #                        default is [:DEFAULT_CNID_SCHEME:]
 101 #                        available schemes: [:COMPILED_BACKENDS:]
 102 # ea                  -> none|auto|sys|ad
 103 #                        Specify how Extended Attributes are stores. default
 104 #                        is auto.
 105 #                        auto: try "sys" (by setting an EA on the shared
 106 #                              directory itself), fallback to "ad".  Requires
 107 #                              writable volume for performing the test.
 108 #                              Note: options:ro overwrites "auto" with "none."
 109 #                        sys:  Use filesystem EAs
 110 #                        ad:   Use files in AppleDouble directories
 111 #                        none: No EA support
 112 #
 113
 114 #
 115 # miscellaneous options [syntax: options:option1,option2]:
 116 # tm                  -> enable TimeMachine support
 117 # prodos              -> make compatible with appleII clients.
 118 # crlf                -> enable crlf translation for TEXT files.
 119 # noadouble           -> don't create .AppleDouble unless a resource
 120 #                        fork needs to be created.
 121 # ro                  -> mount the volume as read-only.
 122 # mswindows           -> enforce filename restrictions imposed by MS
 123 #                        Windows. this will also invoke a default
 124 #                        codepage (iso8859-1) if one isn't already
 125 #                        specified.
 126 # nohex               -> don't do :hex translations for anything
 127 #                        except dot files. specify usedots as well if
 128 #                        you want that turned off. note: this option
 129 #                         makes the / character illegal.
 130 # usedots             -> don't do :hex translation for dot files. note: when
 131 #                        this option gets set, certain file names
 132 #                        become illegal. these are .Parent and
 133 #                        anything that starts with .Apple.
 134 # invisibledots       -> don't do :hex translation for dot files. note: when
 135 #                        this option gets set, certain file names
 136 #                        become illegal. these are .Parent and
 137 #                        anything that starts with .Apple. also, dot
 138 #                        files created on the unix side are marked invisible.
 139 # limitsize           -> limit disk size reporting to 2GB. this is
 140 #                        here for older macintoshes using newer
 141 #                        appleshare clients. yucko.
 142 # nofileid            -> don't advertise createfileid, resolveid, deleteid
 143 #                        calls
 144 # root_preexec_close  -> a non-zero return code from root_preexec close the
 145 #                        volume being mounted.
 146 # preexec_close       -> a non-zero return code from preexec close the
 147 #                        volume being mounted.
 148 # nostat              -> don't stat volume path when enumerating volumes list
 149 # upriv               -> use unix privilege.
 150 # illegalseq          -> encode illegal sequence in filename asis,
 151 #                        ex "\217-", which is not a valid SHIFT-JIS char,
 152 #                        is encoded  as U\217 -
 153 # acls                -> Enable ACLs on this volume. Requires a NFSv4 ACLs
 154 #                        compatible filesystem (e.g. ZFS) and an ACL API
 155 #                        compatible to *Solaris. In other words: this requires
 156 #                        Solaris, Opensolaris or a derived distribution.
 157 # nocnidcache         -> Don't store and read CNID to/from AppleDouble file.
 158 #                        This should not be used as it also prevents a CNID
 159 #                        database rebuild with `dbd`!
 160 # caseinsensitive     -> The underlying FS is case insensitive (only
 161 #                        test with JFS in OS2 mode)
 162 # dropbox             -> Allows a volume to be declared as being a "dropbox."
 163 #                        Note that netatalk must be compiled with dropkludge
 164 #                        support for this to function. Warning: This option
 165 #                        is deprecated and might not work as expected.
 166 # nodev               -> always use 0 for device number, helps when the
 167 #                        device number is not constant across a reboot,
 168 #                        cluster, ...
 169 #
 170
 171 # The "~" below indicates that Home directories are visible by default.
 172 # If you do not wish to have people accessing their Home directories,
 173 # please put a pound sign in front of the tilde or delete it.
 174 ~
 175
 176 # End of File