man/man5/AppleVolumes.default.5.tmpl

   1 .\" $Id: AppleVolumes.default.5.tmpl,v 1.2.14.1 2003-11-30 22:07:36 rlewczuk Exp $
   2 .TH AppleVolumes.default 5 "20 September 2000" "netatalk 1.5"
   3 .UC 4
   4 .SH NAME
   5 AppleVolumes.default \- Configuration file used by \fBafpd\fR(8)
   6 to determine the shares made available through Appletalk
   7
   8 .SH DESCRIPTION
   9 \fB:ETCDIR:/AppleVolumes.default\fR is the configuration file used
  10 by afpd to determine what portions of the file system will be shared via
  11 Appletalk, as well as their behaviors.
  12
  13 Any line not prefixed with \fB#\fR is interpreted. The configuration lines
  14 are composed like:
  15
  16 .RS
  17 .sp
  18 .I path
  19 .B [
  20 .I chooser name
  21 .B ] [
  22 .I options
  23 .B ]
  24
  25 .sp
  26 .RE
  27 The path name must be a fully qualified path name, or a path name using
  28 either the \fB~\fR shell shorthand or any of the substitution variables,
  29 which are listed below.
  30
  31 The chooser name is the name that appears in the Chooser on Macintoshes
  32 to represent the appropriate share. If there are spaces in the name, it
  33 should be in quotes (i.e. \fB"File Share"\fR). The chooser name may not
  34 exceed 27 characters in length, and cannot contain the \fB:\fR character.
  35
  36 The possible options and their meanings are:
  37
  38 .TP
  39 .B allow:[users/groups]
  40 The allow option allows the users and groups that access a share to
  41 be specified. Users and groups are specified, delimited by commas. Groups
  42 are designated by a \fB@\fR prefix.
  43
  44 \fIExample:\fR \fBallow:user1,user2,@group\fR
  45
  46 .TP
  47 .B casefold:[option]
  48 The casefold option handles how casenames should be mangled. The available
  49 options are:
  50
  51 \fBtolower\fR - Lowercases names in both directions.
  52
  53 \fBtoupper\fR - Uppercases names in both directions.
  54
  55 \fBxlatelower\fR - Client sees lowercase, server sees uppercase.
  56
  57 \fBxlateupper\fR - Client sees uppercase, server sees lowercase.
  58
  59 .TP
  60 .B cnidscheme:[scheme]
  61 Set the CNID database backend for the volume, default is [:DEFAULT_CNID_SCHEME:],
  62 available backends are [:COMPLETED_BACKENDS:].
  63
  64 .TP
  65 .B codepage:[nls file]
  66 The codepage option loads a specific codepage from the nls directory.
  67
  68 .TP
  69 .B dbpath:[path]
  70 Sets the database information to be stored in \fBpath\fR.
  71
  72 .TP
  73 .B deny:[users/groups]
  74 The deny option specifies users and groups who are not allowed access
  75 to the share. It follows the same format as the \fBallow\fR option.
  76
  77 .TP
  78 .B options:[option]
  79 This allows multiple options to be specified in a comma delimited format.
  80 The available options are:
  81
  82 \fBcrlf\fR - Enables crlf translation for TEXT files.
  83
  84 \fBdropbox\fR - Allows a volume to be declared as being a "dropbox." Note
  85 that netatalk must be compiled with dropkludge support for this to
  86 function.
  87
  88 \fBlimitsize\fR - Hack for older Macintoshes using newer Appleshare
  89 clients to limit the disk size reporting to 2 GB.
  90
  91 \fBmswindows\fR - Forces filename restrictions imposed by MS WinXX, and
  92 invokes the MS default codepage (iso8859-1) if one is not already
  93 specified.
  94
  95 \fBnoadouble\fR - Forces afpd to not create .AppleDouble unless a resource
  96 fork needs to be created.
  97
  98 \fBnofileid\fR - Don't advertise createfileid, resolveid and deleteid calls.
  99
 100 \fBnohex\fR - Disables :hex translations for anything except dot files.
 101 This option makes the \fB/\fR character illegal.
 102
 103 \fBnostat\fR - Don't stat volume path when enumerating volumes list.
 104
 105 \fBpreexec_close\fR - A non-zero return code from preexec close
 106 the volume being mounted.
 107
 108 \fBprodos\fR - Provides compatibility with Apple II clients.
 109
 110 \fBro\fR - Specifies the share as being read only for all users.
 111
 112 \fBroot_preexec_close\fR - A non-zero return code from root_preexec close
 113 the volume being mounted.
 114
 115 \fBusedots\fR - Don't do :hex translation for dot files. This makes all
 116 files such as .Parent, .Apple* illegal. Dot files created on the server
 117 side will be invisible to the client.
 118
 119 \fBupriv\fR - Use UNIX privilege (AFP3x).
 120
 121 .TP
 122 .B password:[password]
 123 This option allows you to set a volume password, which can be a maximum
 124 of 8 characters long.
 125
 126 .TP
 127 .B postexec:[command]
 128 Command to be run when the volume is closed, ignore for user defined volumes.
 129
 130 .TP
 131 .B preexec:[command]
 132 Command to be run when the volume is mounted, ignore for user defined volumes.
 133
 134 .TP
 135 .B rolist:[users/groups]
 136 Allows certain users and groups to have read-only access to a share.
 137 This follows the \fBallow\fR option format.
 138
 139 .TP
 140 .B root_postexec:[command]
 141 Command to be run as root when the volume is closed, ignore for user defined volumes.
 142
 143 .TP
 144 .B root_preexec:[command]
 145 Command to be run as root when the volume is opened, ignore for user defined volumes.
 146
 147 .TP
 148 .B rwlist:[users/groups]
 149 Allows certain users and groups to have read/write access to a share.
 150 This follows the \fBallow\fR option format.
 151
 152 .P
 153 The variables which can be used for subsitutions are:
 154
 155 .TP
 156 .B $b
 157 basename of path
 158
 159 .TP
 160 .B $c
 161 client's ip or appletalk address
 162
 163 .TP
 164 .B $d
 165 volume pathname on server
 166
 167 .TP
 168 .B $f
 169 full name (contents of the gecos field in the passwd file)
 170
 171 .TP
 172 .B $g
 173 group name
 174
 175 .TP
 176 .B $h
 177 hostname
 178
 179 .TP
 180 .B $i
 181 client IP without tcp port or appletalk network
 182
 183 .TP
 184 .B $s
 185 server name (this can be the hostname)
 186
 187 .TP
 188 .B $u
 189 user name (if guest, it is the user that guest is running as)
 190
 191 .TP
 192 .B $v
 193 volume name (either ADEID_NAME or basename of path)
 194
 195 .TP
 196 .B $z
 197 appletalk zone (may not exist)
 198
 199 .TP
 200 .B $$
 201 prints dollar sign (\fb$\fR)
 202
 203 .SH SEE ALSO
 204 afpd(8)