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