man/man5/afpd.conf.5.tmpl

   1 .\" $Id: afpd.conf.5.tmpl,v 1.1 2000-09-28 16:49:47 rufustfirefly Exp $
   2 .TH afpd.conf 5 "28 September 2000" "netatalk 1.5"
   3 .UC 4
   4 .SH NAME
   5 afpd.conf \- Configuration file used by \fBafpd\fR(8)
   6 to determine the setup of its file sharing services
   7
   8 .SH DESCRIPTION
   9 \fB:ETCDIR:/afpd.conf\fR is the configuration file used
  10 by afpd to determine the behavior and configuration of the different
  11 virtual file servers that it provides.
  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 server name
  19 .B [
  20 .I options
  21 .B ]
  22
  23 .sp
  24 .RE
  25 If a \fB-\fR is used instead of a server name, the default server is
  26 specified. Server names must be quoted if they contain spaces.
  27
  28 The path name must be a fully qualified path name, or a path name using
  29 either the \fB~\fR shell shorthand or any of the substitution variables,
  30 which are listed below.
  31
  32 The possible options and their meanings are:
  33
  34 .TP
  35 .I AppleVolumes Files
  36
  37 .TP
  38 .B -defaultvol [path]
  39 Specifies path to AppleVolumes.default file (default is
  40 \fB:RESDIR:/AppleVolumes.default\fR).
  41
  42 .TP
  43 .B -nlspath [path]
  44 Specifies the path to the code pages (default is \fB:RESDIR:/nls\fR).
  45
  46 .TP
  47 .B -systemvol [path]
  48 Specifies path to AppleVolumes.system file (default is
  49 \fB:RESDIR:/AppleVolumes.system\fR).
  50
  51 .TP
  52 .B -[no]uservol
  53 Enables or disables reading of the users' individual volumes file
  54 entirely.
  55
  56 .TP
  57 .B -[no]uservolfirst
  58 Enables or disables reading of the users' individual volumes file
  59 before processing the global \fBAppleVolumes.default\fR file.
  60
  61 .TP
  62 .I Authentication Methods
  63
  64 .TP
  65 .B -uamlist [uams list]
  66 Comma separated list of UAMs. (The default is
  67 \fBuams_guest.so,uams_passwd.so,uams_dhx_passwd.so\fR).
  68 The most commonly used UAMs are:
  69
  70 \fBuams_dhx_passwd.so or uams_dhx_pam.so\fR - allows logins
  71 using Diffie-Hellman eXchange (DHX)
  72
  73 \fBuams_guest.so\fR - allows guest logins
  74
  75 \fBuams_passwd.so or uams_pam.so\fR - allows logins with clear
  76 text passwords
  77
  78 \fBuams_randum.so\fR - allows Random Number and Two-Way Random
  79 Number Exchange for authentication (requires \fB:RESDIR:/afppaswd\fR
  80 file)
  81
  82 .TP
  83 .B -uampath [path]
  84 Sets the default path for UAMs for this server (default is
  85 :RESDIR:/uams).
  86
  87 .TP
  88 .I Password Options
  89
  90 .TP
  91 .B -loginmaxmail [number]
  92 Sets the maximum number of failed logins, if supported by the UAM
  93
  94 .TP
  95 .B -passwdfile [path]
  96 Sets the path to the Randnum passwd file for this server (default is
  97 \fB:ETCDIR:/afppasswd\fR).
  98
  99 .TP
 100 .B -passwdminlen [number]
 101 Sets the minimum password length, if supported by the UAM
 102
 103 .TP
 104 .B -[no]savepassword
 105 Enables or disables the ability of clients to save passwords locally
 106
 107 .TP
 108 .B -[no]setpassword
 109 Enables or disables the ability of clients to change their passwords
 110
 111
 112 .TP
 113 .I Transport Protocols
 114
 115 .TP
 116 .B -[no]ddp
 117 Enables or disables AFP-over-Appletalk. If \fB-proxy\fR is specified, you must
 118 instead use \fB-uamlist ""\fR to prevent DDP connections from working.
 119
 120 .TP
 121 .B -[no]tcp
 122 Enables or disables AFP-over-TCP
 123
 124 .TP
 125 .I Transport Options
 126
 127 .TP
 128 .B -admingroup [group]
 129 Allows users of a certain group to be seen as the superuser when they
 130 log in. This option is disabled, by default.
 131
 132 .TP
 133 .B -ddpaddr [ddp address]
 134 Specifies the DDP address of the server. The default is to auto-assign an
 135 address (0.0). This is only useful if you are running on a multihomed host.
 136
 137 .TP
 138 .B -fqdn [name:port]
 139 Specifies a fully-qualified domain name, with an optional port. This is
 140 discarded if the server cannot resolve it. This option is not honored by
 141 AppleShare clients <= 3.8.3. This option is disabled by default.
 142
 143 .TP
 144 .B -ipaddr [ip address]
 145 Specifies the IP that the server should respond to (the default is the
 146 first IP address of the system). This option also allows one machine to
 147 advertise TCP/IP for another machine.
 148
 149 .TP
 150 .B -port [port number]
 151 Allows a different TCP port to be specified for AFP-over-TCP. The default
 152 is 548.
 153
 154 .TP
 155 .B -proxy
 156 Runs an AppleTalk proxy server for the specified AFP-over-TCP server. If
 157 the address and port aren't given, then the first IP address of the system
 158 and port 548 will be used. If you don't want the proxy server to act as a
 159 DDP server as well, set \fB-uamlist ""\fR.
 160
 161 .TP
 162 .B -server_quantum [number]
 163 This specifoes the DSI server quantum. The minimum value is 1 MB. The
 164 maximum value is 0xFFFFFFFFF. If you specify a value that is out of
 165 range, the default value will be set (which is the minimum).
 166
 167 .TP
 168 .I Miscellaneous Options
 169
 170 .TP
 171 .B -guestname [name]
 172 Specifies the user that guests should use (default is \fB"nobody"\fR). The
 173 name should be quoted.
 174
 175 .TP
 176 .B -icon
 177 Use the platform-specific icon
 178
 179 .TP
 180 .B -loginmsg [message]
 181 Sets a message to be displayed when clients logon to the server. The
 182 message should be quoted.
 183
 184 .TP
 185 .B -nodebug
 186 Disables debugging
 187
 188 .TP
 189 .B -tickleval [number]
 190 Sets the tickle timeout interval (in seconds).
 191
 192 .SH SEE ALSO
 193 afpd(8), AppleVolumes.default(5)