man/man5/AppleVolumes.default.5.tmpl

   1 .\" $Id: AppleVolumes.default.5.tmpl,v 1.2 2001-02-28 16:53:24 rufustfirefly 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 codepage:[nls file]
  61 The codepage option loads a specific codepage from the nls directory.
  62
  63 .TP
  64 .B dbpath:[path]
  65 Sets the database information to be stored in \fBpath\fR.
  66
  67 .TP
  68 .B deny:[users/groups]
  69 The deny option specifies users and groups who are not allowed access
  70 to the share. It follows the same format as the \fBallow\fR option.
  71
  72 .TP
  73 .B options:[option]
  74 This allows multiple options to be specified in a comma delimited format.
  75 The available options are:
  76
  77 \fBcrlf\fR - Enables crlf translation for TEXT files.
  78
  79 \fBdropbox\fR - Allows a volume to be declared as being a "dropbox." Note
  80 that netatalk must be compiled with dropkludge support for this to
  81 function.
  82
  83 \fBlimitsize\fR - Hack for older Macintoshes using newer Appleshare
  84 clients to limit the disk size reporting to 2 GB.
  85
  86 \fBmswindows\fR - Forces filename restrictions imposed by MS WinXX, and
  87 invokes the MS default codepage (iso8859-1) if one is not already
  88 specified.
  89
  90 \fBnoadouble\fR - Forces afpd to not create .AppleDouble unless a resource
  91 fork needs to be created.
  92
  93 \fBnohex\fR - Disables :hex translations for anything except dot files.
  94 This option makes the \fB/\fR character illegal.
  95
  96 \fBprodos\fR - Provides compatibility with Apple II clients.
  97
  98 \fBro\fR - Specifies the share as being read only for all users.
  99
 100 \fBusedots\fR - Don't do :hex translation for dot files. This makes all
 101 files such as .Parent, .Apple* illegal. Dot files created on the server
 102 side will be invisible to the client.
 103
 104 .TP
 105 .B password:[password]
 106 This option allows you to set a volume password, which can be a maximum
 107 of 8 characters long.
 108
 109 .TP
 110 .B rolist:[users/groups]
 111 Allows certain users and groups to have read-only access to a share.
 112 This follows the \fBallow\fR option format.
 113
 114 .TP
 115 .B rwlist:[users/groups]
 116 Allows certain users and groups to have read/write access to a share.
 117 This follows the \fBallow\fR option format.
 118
 119 .P
 120 The variables which can be used for subsitutions are:
 121
 122 .TP
 123 .B $c
 124 client's ip or appletalk address
 125
 126 .TP
 127 .B $f
 128 full name (contents of the gecos field in the passwd file)
 129
 130 .TP
 131 .B $g
 132 group name
 133
 134 .TP
 135 .B $h
 136 hostname
 137
 138 .TP
 139 .B $s
 140 server name (this can be the hostname)
 141
 142 .TP
 143 .B $u
 144 user name (if guest, it is the user that guest is running as)
 145
 146 .TP
 147 .B $v
 148 volume name (either ADEID_NAME or basename of path)
 149
 150 .TP
 151 .B $z
 152 appletalk zone (may not exist)
 153
 154 .TP
 155 .B $$
 156 prints dollar sign (\fb$\fR)
 157
 158 .SH SEE ALSO
 159 afpd(8)