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