1 mailto(samba-bugs@samba.anu.edu.au)
3 manpage(smb.conf)(5)(23 Oct 1998)(Samba)(SAMBA)
6 manpagename(smb.conf)(The configuration file for the Samba suite)
11 bf(smb.conf) The bf(smb.conf) file is a configuration file for the
12 Samba suite. bf(smb.conf) contains runtime configuration information
13 for the Samba programs. The bf(smb.conf) file is designed to be
14 configured and administered by the url(bf(swat (8)))(swat.8.html)
15 program. The complete description of the file format and possible
16 parameters held within are here for reference purposes.
19 manpagesection(FILE FORMAT)
21 The file consists of sections and parameters. A section begins with
22 the name of the section in square brackets and continues until the
23 next section begins. Sections contain parameters of the form
27 The file is line-based - that is, each newline-terminated line
28 represents either a comment, a section name or a parameter.
30 Section and parameter names are not case sensitive.
32 Only the first equals sign in a parameter is significant. Whitespace
33 before or after the first equals sign is discarded. Leading, trailing
34 and internal whitespace in section and parameter names is
35 irrelevant. Leading and trailing whitespace in a parameter value is
36 discarded. Internal whitespace within a parameter value is retained
39 Any line beginning with a semicolon (';') or a hash ('#') character is
40 ignored, as are lines containing only whitespace.
42 Any line ending in a tt('\') is "continued" on the next line in the
43 customary UNIX fashion.
45 The values following the equals sign in parameters are all either a
46 string (no quotes needed) or a boolean, which may be given as yes/no,
47 0/1 or true/false. Case is not significant in boolean values, but is
48 preserved in string values. Some items such as create modes are
51 label(SERVICEDESCRIPTIONS)
52 manpagesection(SERVICE DESCRIPTIONS)
54 Each section in the configuration file describes a service. The
55 section name is the service name and the parameters within the section
56 define the service's attributes.
58 There are three special sections, link(bf([global]))(global),
59 link(bf([homes]))(homes) and link(bf([printers]))(printers), which are
60 described under link(bf('special sections'))(specialsections). The
61 following notes apply to ordinary service descriptions.
63 A service consists of a directory to which access is being given plus
64 a description of the access rights which are granted to the user of
65 the service. Some housekeeping options are also specifiable.
67 Services are either filespace services (used by the client as an
68 extension of their native file systems) or printable services (used by
69 the client to access print services on the host running the server).
71 Services may be guest services, in which case no password is required
72 to access them. A specified UNIX guest account is used to define
73 access privileges in this case.
75 Services other than guest services will require a password to access
76 them. The client provides the username. As older clients only provide
77 passwords and not usernames, you may specify a list of usernames to
78 check against the password using the link(bf("user="))(user) option in
79 the service definition. For modern clients such as Windows 95/98 and
80 Windows NT, this should not be neccessary.
82 Note that the access rights granted by the server are masked by the
83 access rights granted to the specified or guest UNIX user by the host
84 system. The server does not grant more access than the host system
87 The following sample section defines a file space service. The user
88 has write access to the path tt(/home/bar). The service is accessed via
89 the service name "foo":
99 The following sample section defines a printable service. The service
100 is readonly, but printable. That is, the only write access permitted
101 is via calls to open, write to and close a spool file. The
102 link(bf('guest ok'))(guestok) parameter means access will be permitted
103 as the default guest user (specified elsewhere):
107 path = /usr/spool/public
113 label(SPECIALSECTIONS)
114 manpagesection(SPECIAL SECTIONS)
119 dit(bf(The [global] section))
121 Parameters in this section apply to the server as a whole, or are
122 defaults for services which do not specifically define certain
123 items. See the notes under link(bf('Parameters'))(Parameters) for more
127 dit(bf(The [homes] section))
129 If a section called tt('homes') is included in the configuration file,
130 services connecting clients to their home directories can be created
131 on the fly by the server.
133 When the connection request is made, the existing services are
134 scanned. If a match is found, it is used. If no match is found, the
135 requested service name is treated as a user name and looked up in the
136 local passwords file. If the name exists and the correct password has
137 been given, a service is created by cloning the [homes] section.
139 Some modifications are then made to the newly created section:
143 it() The service name is changed from tt('homes') to the located
146 it() If no path was given, the path is set to the user's home
151 If you decide to use a link(bf(path=))(path) line in your [homes]
152 section then you may find it useful to use the link(bf(%S))(percentS)
155 tt(path=/data/pchome/%S)
157 would be useful if you have different home directories for your PCs
158 than for UNIX access.
160 This is a fast and simple way to give a large number of clients access
161 to their home directories with a minimum of fuss.
163 A similar process occurs if the requested service name is tt("homes"),
164 except that the service name is not changed to that of the requesting
165 user. This method of using the [homes] section works well if different
166 users share a client PC.
168 The [homes] section can specify all the parameters a normal service
169 section can specify, though some make more sense than others. The
170 following is a typical and suitable [homes] section:
177 An important point is that if guest access is specified in the [homes]
178 section, all home directories will be visible to all clients
179 bf(without a password). In the very unlikely event that this is
180 actually desirable, it would be wise to also specify link(bf(read only
183 Note that the link(bf(browseable))(browseable) flag for auto home
184 directories will be inherited from the global browseable flag, not the
185 [homes] browseable flag. This is useful as it means setting
186 browseable=no in the [homes] section will hide the [homes] service but
187 make any auto home directories visible.
190 dit(bf(The [printers] section))
192 This section works like link(bf([homes]))(homes), but for printers.
194 If a [printers] section occurs in the configuration file, users are
195 able to connect to any printer specified in the local host's printcap
198 When a connection request is made, the existing services are
199 scanned. If a match is found, it is used. If no match is found, but a
200 link(bf([homes]))(homes) section exists, it is used as described
201 above. Otherwise, the requested service name is treated as a printer
202 name and the appropriate printcap file is scanned to see if the
203 requested service name is a valid printer name. If a match is found, a
204 new service is created by cloning the [printers] section.
206 A few modifications are then made to the newly created section:
210 it() The service name is set to the located printer name
212 it() If no printer name was given, the printer name is set to the
215 it() If the service does not permit guest access and no username was
216 given, the username is set to the located printer name.
220 Note that the [printers] service MUST be printable - if you specify
221 otherwise, the server will refuse to load the configuration file.
223 Typically the path specified would be that of a world-writable spool
224 directory with the sticky bit set on it. A typical [printers] entry
225 would look like this:
229 path = /usr/spool/public
235 All aliases given for a printer in the printcap file are legitimate
236 printer names as far as the server is concerned. If your printing
237 subsystem doesn't work like that, you will have to set up a
238 pseudo-printcap. This is a file consisting of one or more lines like
241 verb( alias|alias|alias|alias... )
243 Each alias should be an acceptable printer name for your printing
244 subsystem. In the link(bf([global]))(global) section, specify the new
245 file as your printcap. The server will then only recognise names
246 found in your pseudo-printcap, which of course can contain whatever
247 aliases you like. The same technique could be used simply to limit
248 access to a subset of your local printers.
250 An alias, by the way, is defined as any component of the first entry
251 of a printcap record. Records are separated by newlines, components
252 (if there are more than one) are separated by vertical bar symbols
255 NOTE: On SYSV systems which use lpstat to determine what printers are
256 defined on the system you may be able to use link(bf("printcap name =
257 lpstat"))(printcapname) to automatically obtain a list of
258 printers. See the link(bf("printcap name"))(printcapname) option for
264 manpagesection(PARAMETERS)
266 Parameters define the specific attributes of services.
268 Some parameters are specific to the link(bf([global]))(global) section
269 (eg., link(bf(security))(security)). Some parameters are usable in
270 all sections (eg., link(bf(create mode))(createmode)). All others are
271 permissible only in normal sections. For the purposes of the following
272 descriptions the link(bf([homes]))(homes) and
273 link(bf([printers]))(printers) sections will be considered normal.
274 The letter tt('G') in parentheses indicates that a parameter is
275 specific to the link(bf([global]))(global) section. The letter tt('S')
276 indicates that a parameter can be specified in a service specific
277 section. Note that all tt('S') parameters can also be specified in the
278 link(bf([global]))(global) section - in which case they will define
279 the default behaviour for all services.
281 Parameters are arranged here in alphabetical order - this may not
282 create best bedfellows, but at least you can find them! Where there
283 are synonyms, the preferred synonym is described, others refer to the
286 label(VARIABLESUBSTITUTIONS)
287 manpagesection(VARIABLE SUBSTITUTIONS)
289 Many of the strings that are settable in the config file can take
290 substitutions. For example the option link(bf(tt("path =
291 /tmp/%u")))(path) would be interpreted as tt("path = /tmp/john") if
292 the user connected with the username john.
294 These substitutions are mostly noted in the descriptions below, but
295 there are some general substitutions which apply whenever they might
296 be relevant. These are:
301 dit(bf(%S)) = the name of the current service, if any.
304 dit(bf(%P)) = the root directory of the current service, if any.
307 dit(bf(%u)) = user name of the current service, if any.
310 dit(bf(%g)) = primary group name of link(bf(%u))(percentu).
313 dit(bf(%U)) = session user name (the user name that
314 the client wanted, not necessarily the same as the one they got).
317 dit(bf(%G)) = primary group name of link(bf(%U))(percentU).
320 dit(bf(%H)) = the home directory of the user given by link(bf(%u))(percentu).
323 dit(bf(%v)) = the Samba version.
326 dit(bf(%h)) = the internet hostname that Samba is running on.
329 dit(bf(%m)) = the netbios name of the client machine (very useful).
332 %L = the netbios name of the server. This allows you to change your
333 config based on what the client calls you. Your server can have a "dual
337 dit(bf(%M)) = the internet name of the client machine.
340 dit(bf(%N)) = the name of your NIS home directory server. This is
341 obtained from your NIS auto.map entry. If you have not compiled Samba
342 with the bf(--with-automount) option then this value will be the same
343 as link(bf(%L))(percentL).
346 dit(bf(%p)) = the path of the service's home directory, obtained from your NIS
347 auto.map entry. The NIS auto.map entry is split up as "%N:%p".
350 dit(bf(%R)) = the selected protocol level after protocol
351 negotiation. It can be one of CORE, COREPLUS, LANMAN1, LANMAN2 or NT1.
354 dit(bf(%d) = The process id of the current server process.
357 dit(bf(%a)) = the architecture of the remote machine. Only some are recognised,
358 and those may not be 100% reliable. It currently recognises Samba,
359 WfWg, WinNT and Win95. Anything else will be known as "UNKNOWN". If it
360 gets it wrong then sending a level 3 log to
361 email(samba-bugs@samba.anu.edu.au) should allow it to be fixed.
364 dit(bf(%I)) = The IP address of the client machine.
367 dit(bf(%T)) = the current date and time.
371 There are some quite creative things that can be done with these
372 substitutions and other smb.conf options.
375 manpagesection(NAME MANGLING)
377 Samba supports em("name mangling") so that DOS and Windows clients can
378 use files that don't conform to the 8.3 format. It can also be set to
379 adjust the case of 8.3 format filenames.
381 There are several options that control the way mangling is performed,
382 and they are grouped here rather than listed separately. For the
383 defaults look at the output of the testparm program.
385 All of these options can be set separately for each service (or
386 globally, of course).
390 "mangle case = yes/no" controls if names that have characters that
391 aren't of the "default" case are mangled. For example, if this is yes
392 then a name like "Mail" would be mangled. Default no.
394 "case sensitive = yes/no" controls whether filenames are case
395 sensitive. If they aren't then Samba must do a filename search and
396 match on passed names. Default no.
398 "default case = upper/lower" controls what the default case is for new
399 filenames. Default lower.
401 "preserve case = yes/no" controls if new files are created with the
402 case that the client passes, or if they are forced to be the "default"
405 "short preserve case = yes/no" controls if new files which conform to 8.3
406 syntax, that is all in upper case and of suitable length, are created
407 upper case, or if they are forced to be the "default" case. This option can
408 be use with "preserve case = yes" to permit long filenames to retain their
409 case, while short names are lowered. Default no.
411 .SS COMPLETE LIST OF GLOBAL PARAMETERS
413 Here is a list of all global parameters. See the section of each
414 parameter for details. Note that some are synonyms.
518 networkstation user login
524 ole locking compatibility
620 .SS COMPLETE LIST OF SERVICE PARAMETERS
622 Here is a list of all service parameters. See the section of each
623 parameter for details. Note that some are synonyms.
629 alternate permissions
665 dos filetime resolution
669 fake directory create times
745 printer driver location
809 .SS EXPLANATION OF EACH PARAMETER
814 This is a list of users who will be granted administrative privileges
815 on the share. This means that they will do all file operations as the
818 You should use this option very carefully, as any user in this list
819 will be able to do anything they like on the share, irrespective of
830 This specifies what type of server nmbd will announce itself as in
831 browse lists. By default this is set to Windows NT. The valid options
832 are "NT", "Win95" or "WfW" meaining Windows NT, Windows 95 and
833 Windows for Workgroups respectively. Do not change this parameter
834 unless you have a specific need to stop Samba appearing as an NT
835 server as this may prevent Samba servers from participating as
836 browser servers correctly.
844 .SS announce version (G)
846 This specifies the major and minor version numbers that nmbd
847 will use when announcing itself as a server. The default is 4.2.
848 Do not change this parameter unless you have a specific need to
849 set a Samba server to be a downlevel server.
852 announce version = 4.2
855 announce version = 2.0
857 .SS auto services (G)
858 This is a list of services that you want to be automatically added to
859 the browse lists. This is most useful for homes and printers services
860 that would otherwise not be visible.
862 Note that if you just want all printers in your printcap file loaded
863 then the "load printers" option is easier.
869 auto services = fred lp colorlp
872 A synonym for this parameter is 'hosts allow'.
874 This parameter is a comma delimited set of hosts which are permitted to access
877 If specified in the [global] section then it will apply to all
878 services, regardless of whether the individual service has a different
881 You can specify the hosts by name or IP number. For example, you could
882 restrict access to only the hosts on a Class C subnet with something like
883 "allow hosts = 150.203.5.". The full syntax of the list is described in
885 .BR hosts_access (5).
887 You can also specify hosts by network/netmask pairs and by netgroup
888 names if your system supports netgroups. The EXCEPT keyword can also
889 be used to limit a wildcard list. The following examples may provide
892 Example 1: allow all IPs in 150.203.*.* except one
894 hosts allow = 150.203. EXCEPT 150.203.6.66
896 Example 2: allow hosts that match the given network/netmask
898 hosts allow = 150.203.15.0/255.255.255.0
900 Example 3: allow a couple of hosts
902 hosts allow = lapland, arvidsjaur
904 Example 4: allow only hosts in netgroup "foonet" or localhost, but
905 deny access from one particular host
907 hosts allow = @foonet, localhost
910 Note that access still requires suitable user-level passwords.
914 for a way of testing your host access to see if it
915 does what you expect.
918 none (i.e., all hosts permitted access)
921 allow hosts = 150.203.5. myhost.mynet.edu.au
923 .SS alternate permissions (S)
925 This option affects the way the "read only" DOS attribute is produced
926 for UNIX files. If this is false then the read only bit is set for
927 files on writeable shares which the user cannot write to.
929 If this is true then it is set for files whos user write bit is not set.
931 The latter behaviour is useful for when users copy files from each
932 others directories, and use a file manager that preserves
933 permissions. Without this option they may get annoyed as all copied
934 files will have the "read only" bit set.
937 alternate permissions = no
940 alternate permissions = yes
943 This parameter lets you 'turn off' a service. If 'available = no', then
944 ALL attempts to connect to the service will fail. Such failures are logged.
952 .SS bind interfaces only (G)
953 This global parameter (new for 1.9.18) allows the Samba admin to limit
954 what interfaces on a machine will serve smb requests. If affects file service
955 (smbd) and name service (nmbd) in slightly different ways.
957 For name service it causes nmbd to bind to ports 137 and 138 on
958 the interfaces listed in the 'interfaces' parameter. nmbd also binds
959 to the 'all addresses' interface (0.0.0.0) on ports 137 and 138
960 for the purposes of reading broadcast messages. If this option is
961 not set then nmbd will service name requests on all of these
962 sockets. If "bind interfaces only" is set then nmbd will check
963 the source address of any packets coming in on the broadcast
964 sockets and discard any that don't match the broadcast addresses
965 of the interfaces in the 'interfaces' parameter list. As unicast
966 packets are received on the other sockets it allows nmbd to
967 refuse to serve names to machines that send packets that arrive
968 through any interfaces not listed in the 'interfaces' list.
969 IP Source address spoofing does defeat this simple check, however
970 so it must not be used seriously as a security feature for nmbd.
972 For file service it causes smbd to bind only to the interface
973 list given in the 'interfaces' parameter. This restricts the
974 networks that smbd will serve to packets coming in those interfaces.
975 Note that you should not use this parameter for machines that
976 are serving ppp or other intermittant or non-broadcast network
977 interfaces as it will not cope with non-permanent interfaces.
980 bind interfaces only = False
983 bind interfaces only = True
986 This controls whether this share is seen in the list of available
987 shares in a net view and in the browse list.
995 This controls whether the smbd will serve a browse list to a client
996 doing a NetServerEnum call. Normally set to true. You should never
1002 .SS case sensitive (G)
1003 See the discussion on NAME MANGLING.
1005 .SS case sig names (G)
1006 See "case sensitive"
1008 .SS character set (G)
1009 This allows a smbd to map incoming characters from a DOS 850 Code page
1010 to either a Western European (ISO8859-1) or Easter European (ISO8859-2)
1011 code page. Normally not set, meaning no filename translation is done.
1019 character set = iso8859-1
1021 .SS client code page (G)
1022 Currently (Samba 1.9.17 and above) this may be set to one of two
1023 values, 850 or 437. It specifies the base DOS code page that the
1024 clients accessing Samba are using. To determine this, open a DOS
1025 command prompt and type the command "chcp". This will output the
1026 code page. The default for USA MS-DOS, Windows 95, and Windows NT
1027 releases is code page 437. The default for western european
1028 releases of the above operating systems is code page 850.
1030 This parameter co-operates with the "valid chars" parameter in
1031 determining what characters are valid in filenames and how
1032 capitalization is done. It has been added as a convenience for
1033 clients whose code page is either 437 or 850 so a convoluted
1034 "valid chars" string does not have to be determined. If you
1035 set both this parameter and the "valid chars" parameter the
1036 "client code page" parameter MUST be set before the "valid chars"
1037 in the smb.conf file. The "valid chars" string will then augment
1038 the character settings in the "client code page" parameter.
1040 If "client code page" is set to a value other than 850 or 437
1041 it will default to 850.
1043 See also : "valid chars".
1047 client code page = 850
1051 client code page = 437
1054 This is a text field that is seen next to a share when a client does a
1055 net view to list what shares are available.
1057 If you want to set the string that is displayed next to the machine
1058 name then see the server string command.
1064 comment = Fred's Files
1068 This allows you to override the config file to use, instead of the
1069 default (usually smb.conf). There is a chicken and egg problem here as
1070 this option is set in the config file!
1072 For this reason, if the name of the config file has changed when the
1073 parameters are loaded then it will reload them from the new config
1076 This option takes the usual substitutions, which can be very useful.
1078 If the config file doesn't exist then it won't be loaded (allowing
1079 you to special case the config files of just a few clients).
1082 config file = /usr/local/samba/lib/smb.conf.%m
1085 This parameter allows you to 'clone' service entries. The specified
1086 service is simply duplicated under the current service's name. Any
1087 parameters specified in the current section will override those in the
1088 section being copied.
1090 This feature lets you set up a 'template' service and create similar
1091 services easily. Note that the service being copied must occur earlier
1092 in the configuration file than the service doing the copying.
1100 A synonym for this parameter is 'create mode'.
1102 When a file is created, the neccessary permissions are calculated
1103 according to the mapping from DOS modes to UNIX permissions, and
1104 the resulting UNIX mode is then bit-wise 'AND'ed with this parameter.
1105 This parameter may be thought of as a bit-wise MASK for the UNIX
1106 modes of a file. Any bit *not* set here will be removed from the
1107 modes set on a file when it is created.
1109 The default value of this parameter removes the 'group' and 'other'
1110 write and execute bits from the UNIX modes.
1112 Following this Samba will bit-wise 'OR' the UNIX mode created from
1113 this parameter with the value of the "force create mode" parameter
1114 which is set to 000 by default.
1116 For Samba 1.9.17 and above this parameter no longer affects directory
1117 modes. See the parameter 'directory mode' for details.
1119 See also the "force create mode" parameter for forcing particular
1120 mode bits to be set on created files.
1121 See also the "directory mode" parameter for masking mode bits on created
1134 The value of the parameter (a decimal integer) represents the number of
1135 minutes of inactivity before a connection is considered dead, and it
1136 is disconnected. The deadtime only takes effect if the number of open files
1139 This is useful to stop a server's resources being exhausted by a large
1140 number of inactive connections.
1142 Most clients have an auto-reconnect feature when a connection is broken so
1143 in most cases this parameter should be transparent to users.
1145 Using this parameter with a timeout of a few minutes is recommended
1148 A deadtime of zero indicates that no auto-disconnection should be performed.
1156 The value of the parameter (an integer) allows the debug level
1157 (logging level) to be specified in the
1159 file. This is to give
1160 greater flexibility in the configuration of the system.
1162 The default will be the debug level specified on the command line.
1169 .SS default case (S)
1171 See the section on "NAME MANGLING" Also note the addition of "short
1174 .SS default service (G)
1175 A synonym for this parameter is 'default'.
1177 This parameter specifies the name of a service which will be connected to
1178 if the service actually requested cannot be found. Note that the square
1179 brackets are NOT given in the parameter value (see example below).
1181 There is no default value for this parameter. If this parameter is not given,
1182 attempting to connect to a nonexistent service results in an error.
1184 Typically the default service would be a public, read-only service.
1186 Also note that as of 1.9.14 the apparent service name will be changed to
1187 equal that of the requested service, this is very useful as it allows
1188 you to use macros like %S to make a wildcard service.
1190 Note also that any _ characters in the name of the service used in the
1191 default service will get mapped to a /. This allows for interesting
1196 default service = pub
1202 .SS delete readonly (S)
1203 This parameter allows readonly files to be deleted. This is not normal DOS
1204 semantics, but is allowed by UNIX.
1206 This option may be useful for running applications such as rcs, where UNIX
1207 file ownership prevents changing file permissions, and DOS semantics prevent
1208 deletion of a read only file.
1211 delete readonly = No
1214 delete readonly = Yes
1216 A synonym for this parameter is 'hosts deny'.
1218 The opposite of 'allow hosts' - hosts listed here are NOT permitted
1219 access to services unless the specific services have their own lists to
1220 override this one. Where the lists conflict, the 'allow' list takes precedence.
1223 none (i.e., no hosts specifically excluded)
1226 deny hosts = 150.203.4. badhost.mynet.edu.au
1228 .SS delete veto files (S)
1230 This option is used when Samba is attempting to delete a directory
1231 that contains one or more vetoed directories (see the 'veto files' option).
1232 If this option is set to False (the default) then if a vetoed directory
1233 contains any non-vetoed files or directories then the directory delete
1234 will fail. This is usually what you want.
1236 If this option is set to True, then Samba will attempt
1237 to recursively delete any files and directories within the vetoed
1238 directory. This can be useful for integration with file serving
1239 systems such as Netatalk, which create meta-files within directories
1240 you might normally veto DOS/Windows users from seeing (eg. .AppleDouble)
1242 Setting 'delete veto files = True' allows these directories to be
1243 transparently deleted when the parent directory is deleted (so long
1244 as the user has permissions to do so).
1247 delete veto files = False
1250 delete veto files = True
1255 .SS dfree command (G)
1256 The dfree command setting should only be used on systems where a
1257 problem occurs with the internal disk space calculations. This has
1258 been known to happen with Ultrix, but may occur with other operating
1259 systems. The symptom that was seen was an error of "Abort Retry
1260 Ignore" at the end of each directory listing.
1262 This setting allows the replacement of the internal routines to
1263 calculate the total disk space and amount available with an external
1264 routine. The example below gives a possible script that might fulfill
1267 The external program will be passed a single parameter indicating a
1268 directory in the filesystem being queried. This will typically consist
1269 of the string "./". The script should return two integers in ascii. The
1270 first should be the total disk space in blocks, and the second should
1271 be the number of available blocks. An optional third return value
1272 can give the block size in bytes. The default blocksize is 1024 bytes.
1274 Note: Your script should NOT be setuid or setgid and should be owned by
1275 (and writable only by) root!
1278 By default internal routines for determining the disk capacity
1279 and remaining space will be used.
1282 dfree command = /usr/local/samba/bin/dfree
1284 Where the script dfree (which must be made executable) could be
1288 df $1 | tail -1 | awk '{print $2" "$4}'
1291 or perhaps (on Sys V)
1295 /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
1298 Note that you may have to replace the command names with full
1299 path names on some systems.
1304 .SS directory mask (S)
1305 A synonym for this parameter is 'directory mode'.
1307 This parameter is the octal modes which are used when converting DOS modes
1308 to UNIX modes when creating UNIX directories.
1310 When a directory is created, the neccessary permissions are calculated
1311 according to the mapping from DOS modes to UNIX permissions, and
1312 the resulting UNIX mode is then bit-wise 'AND'ed with this parameter.
1313 This parameter may be thought of as a bit-wise MASK for the UNIX
1314 modes of a directory. Any bit *not* set here will be removed from the
1315 modes set on a directory when it is created.
1317 The default value of this parameter removes the 'group' and 'other'
1318 write bits from the UNIX mode, allowing only the user who owns the
1319 directory to modify it.
1321 Following this Samba will bit-wise 'OR' the UNIX mode created from
1322 this parameter with the value of the "force directory mode" parameter.
1323 This parameter is set to 000 by default (ie. no extra mode bits are added).
1325 See the "force directory mode" parameter to cause particular mode
1326 bits to always be set on created directories.
1328 See also the "create mode" parameter for masking mode bits on created
1332 directory mask = 0755
1335 directory mask = 0775
1337 .SS directory mode (S)
1343 Specifies that nmbd should (as a WINS server), on finding that a NetBIOS
1344 name has not been registered, treat the NetBIOS name word-for-word as
1347 Note that the maximum length for a NetBIOS name is 15
1348 characters, so the DNS name (or DNS alias) can likewise only be 15
1349 characters, maximum.
1351 Note also that nmbd will block completely until the DNS name is resolved.
1352 This will result in temporary loss of browsing and WINS services.
1353 Enable this option only if you are certain that DNS resolution is fast,
1354 or you can live with the consequences of periodic pauses in nmbd service.
1359 .SS domain controller (G)
1361 The meaning of this parameter changed from a string to a boolean (yes/no)
1362 value. It is currently not used within the Samba source and should be removed
1363 from all current smb.conf files. It is left behind for compatibility reasons.
1366 domain controller = no
1368 .SS domain logons (G)
1370 If set to true, the Samba server will serve Windows 95 domain logons
1371 for the workgroup it is in. For more details on setting up this feature
1372 see the file DOMAINS.txt in the Samba source documentation directory.
1377 .SS domain master (G)
1379 Enable WAN-wide browse list collation. Local master browsers on
1380 broadcast-isolated subnets will give samba their local browse lists, and
1381 ask for a complete copy of the browse list for the whole wide area network.
1382 Browser clients will then contact their local master browser, and will
1383 receive the domain-wide browse list, instead of just the list for their
1384 broadcast-isolated subnet.
1389 .SS dont descend (S)
1390 There are certain directories on some systems (eg., the /proc tree under
1391 Linux) that are either not of interest to clients or are infinitely deep
1392 (recursive). This parameter allows you to specify a comma-delimited list
1393 of directories that the server should always show as empty.
1395 Note that Samba can be very fussy about the exact format of the "dont
1396 descend" entries. For example you may need "./proc" instead of just
1397 "/proc". Experimentation is the best policy :-)
1400 none (i.e., all directories are OK to descend)
1403 dont descend = /proc,/dev
1405 .SS dos filetimes (S)
1406 Under DOS and Windows, if a user can write to a file they can change
1407 the timestamp on it. Under POSIX semantics, only the owner of the file
1408 or root may change the timestamp. By default, Samba runs with POSIX
1409 semantics and refuses to change the timestamp on a file if the user
1410 smbd is acting on behalf of is not the file owner. Setting this option
1411 to True allows DOS semantics and smbd will change the file timstamp as
1412 DOS requires. This is a correct implementation of a previous compile-time
1413 options (UTIME_WORKAROUND) which was broken and is now removed.
1416 dos filetimes = False
1419 dos filetimes = True
1421 .SS dos filetime resolution (S)
1422 Under the DOS and Windows FAT filesystem, the finest granulatity on
1423 time resolution is two seconds. Setting this parameter for a share
1424 causes Samba to round the reported time down to the nearest two
1425 second boundary when a query call that requires one second resolution
1428 This option is mainly used as a compatibility option for Visual C++
1429 when used against Samba shares. If oplocks are enabled on a share,
1430 Visual C++ uses two different time reading calls to check if a file
1431 has changed since it was last read. One of these calls uses a one-second
1432 granularity, the other uses a two second granularity. As the two second
1433 call rounds any odd second down, then if the file has a timestamp of an
1434 odd number of seconds then the two timestamps will not match and Visual
1435 C++ will keep reporting the file has changed. Setting this option causes
1436 the two timestamps to match, and Visual C++ is happy.
1439 dos filetime resolution = False
1442 dos filetime resolution = True
1444 .SS encrypt passwords (G)
1446 This boolean controls whether encrypted passwords will be negotiated
1447 with the client. Note that Windows NT 4.0 SP3 and above will by default
1448 expect encrypted passwords unless a registry entry is changed. To use
1449 encrypted passwords in Samba see the file docs/ENCRYPTION.txt.
1453 This is an alias for preexec
1455 .SS fake directory create times (S)
1456 NTFS and Windows VFAT file systems keep a create time for all files
1457 and directories. This is not the same as the ctime - status change
1458 time - that Unix keeps, so Samba by default reports the earliest
1459 of the various times Unix does keep. Setting this parameter for a
1460 share causes Samba to always report midnight 1-1-1980 as
1461 the create time for directories.
1463 This option is mainly used as a compatibility option for Visual C++
1464 when used against Samba shares. Visual C++ generated makefiles
1465 have the object directory as a dependency for each object file,
1466 and a make rule to create the directory. Also, when NMAKE
1467 compares timestamps it uses the creation time when examining
1468 a directory. Thus the object directory will be created if it does
1469 not exist, but once it does exist it will always have an earlier
1470 timestamp than the object files it contains.
1472 However, Unix time semantics mean that the create time reported
1473 by Samba will be updated whenever a file is created or deleted
1474 in the directory. NMAKE therefore finds all object files in the
1475 object directory bar the last one built are out of date compared
1476 to the directory and rebuilds them. Enabling this option ensures
1477 directories always predate their contents and an NMAKE build will
1478 proceed as expected.
1481 fake directory create times = False
1484 fake directory create times = True
1486 .SS fake oplocks (S)
1488 Oplocks are the way that SMB clients get permission from a server to
1489 locally cache file operations. If a server grants an oplock
1490 (opportunistic lock) then the client is free to assume that it is the
1491 only one accessing the file and it will aggressively cache file
1492 data. With some oplock types the client may even cache file open/close
1493 operations. This can give enormous performance benefits.
1495 When you set "fake oplocks = yes" Samba will always grant oplock
1496 requests no matter how many clients are using the file.
1498 By enabling this option on all read-only shares or shares that you know
1499 will only be accessed from one client at a time you will see a big
1500 performance improvement on many operations. If you enable this option
1501 on shares where multiple clients may be accessing the files read-write
1502 at the same time you can get data corruption. Use this option
1505 It is generally much better to use the real oplock support except for
1506 physically read-only media such as CDROMs.
1508 This option is disabled by default.
1510 .SS follow symlinks (S)
1512 This parameter allows the Samba administrator to stop smbd from
1513 following symbolic links in a particular share. Setting this
1514 parameter to "No" prevents any file or directory that is a
1515 symbolic link from being followed (the user will get an error).
1516 This option is very useful to stop users from adding a symbolic
1517 link to /etc/pasword in their home directory for instance.
1518 However it will slow filename lookups down slightly.
1520 This option is enabled (ie. smbd will follow symbolic links)
1523 .SS force create mode (S)
1524 This parameter specifies a set of UNIX mode bit permissions that
1525 will *always* be set on a file created by Samba. This is done
1526 by bitwise 'OR'ing these bits onto the mode bits of a file that
1527 is being created. The default for this parameter is (in octel)
1528 000. The modes in this parameter are bitwise 'OR'ed onto the
1529 file mode after the mask set in the "create mask" parameter
1532 See also the parameter "create mask" for details on masking mode
1533 bits on created files.
1536 force create mode = 000
1539 force create mode = 0755
1541 would force all created files to have read and execute permissions
1542 set for 'group' and 'other' as well as the read/write/execute bits
1545 .SS force directory mode (S)
1546 This parameter specifies a set of UNIX mode bit permissions that
1547 will *always* be set on a directory created by Samba. This is done
1548 by bitwise 'OR'ing these bits onto the mode bits of a directory that
1549 is being created. The default for this parameter is (in octel)
1550 0000 which will not add any extra permission bits to a created
1551 directory. This operation is done after the mode mask in the parameter
1552 "directory mask" is applied.
1554 See also the parameter "directory mask" for details on masking mode
1555 bits on created directories.
1558 force directory mode = 000
1561 force directory mode = 0755
1563 would force all created directories to have read and execute permissions
1564 set for 'group' and 'other' as well as the read/write/execute bits
1568 This specifies a group name that all connections to this service
1569 should be made as. This may be useful for sharing files.
1575 force group = agroup
1578 This specifies a user name that all connections to this service
1579 should be made as. This may be useful for sharing files. You should
1580 also use it carefully as using it incorrectly can cause security
1583 This user name only gets used once a connection is established. Thus
1584 clients still need to connect as a valid user and supply a valid
1585 password. Once connected, all file operations will be performed as the
1586 "forced user", not matter what username the client connected as.
1595 This is a tuning option. When this is enabled a cacheing algorithm will
1596 be used to reduce the time taken for getwd() calls. This can have a
1597 significant impact on performance, especially when widelinks is False.
1606 This is an alias for "force group" and is only kept for compatibility
1607 with old versions of Samba. It may be removed in future versions.
1609 .SS guest account (S)
1610 This is a username which will be used for access to services which are
1611 specified as 'guest ok' (see below). Whatever privileges this user has
1612 will be available to any client connecting to the guest
1613 service. Typically this user will exist in the password file, but will
1614 not have a valid login. If a username is specified in a given service,
1615 the specified username overrides this one.
1617 One some systems the account "nobody" may not be able to print. Use
1618 another account in this case. You should test this by trying to log in
1619 as your guest user (perhaps by using the "su \-" command) and trying to
1623 Note that as of version 1.9 of Samba this option may be set
1624 differently for each service.
1627 specified at compile time
1630 guest account = nobody
1635 If this parameter is 'yes' for a service, then only guest connections to the
1636 service are permitted. This parameter will have no affect if "guest ok" or
1637 "public" is not set for the service.
1639 See the section below on user/password validation for more information about
1647 .SS hide dot files (S)
1648 This is a boolean parameter that controls whether files starting with
1649 a dot appear as hidden files.
1652 hide dot files = yes
1659 This is a list of files or directories that are not visible but are
1660 accessible. The DOS 'hidden' attribute is applied to any files or
1661 directories that match.
1663 Each entry in the list must be separated by a "/", which allows spaces
1664 to be included in the entry. '*' and '?' can be used to specify multiple
1665 files or directories as in DOS wildcards.
1667 Each entry must be a unix path, not a DOS path and must not include the
1668 unix directory separator "/".
1670 Note that the case sensitivity option is applicable in hiding files.
1672 Setting this parameter will affect the performance of Samba, as
1673 it will be forced to check all files and directories for a match
1674 as they are scanned.
1676 See also "hide dot files", "veto files" and "case sensitive"
1679 No files or directories are hidden by this option (dot files are
1680 hidden by default because of the "hide dot files" option).
1683 hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
1685 The above example is based on files that the Macintosh client (DAVE)
1686 creates for internal use, and also still hides all files beginning with
1690 If "nis homedir" is true, this parameter specifies the NIS (or YP) map
1691 from which the server for the user's home directory should be extracted.
1692 At present, only the Sun auto.home map format is understood. The form of
1695 username server:/some/file/system
1697 and the program will extract the servername from before the first ':'.
1698 There should probably be a better parsing system that copes with different
1699 map formats and also Amd (another automounter) maps.
1701 NB: The -DNETGROUP option is required in the Makefile for option to work
1702 and on some architectures the line -lrpcsvc needs to be added to the
1703 LIBSM variable. This is required for Solaris 2, FreeBSD and HPUX.
1705 See also "nis homedir"
1708 homedir map = auto.home
1711 homedir map = amd.homedir
1720 If this global parameter is a non-null string, it specifies the name of
1721 a file to read for the names of hosts and users who will be allowed access
1722 without specifying a password.
1724 This is not be confused with
1726 which is about hosts access to services and is more useful for guest services.
1728 may be useful for NT clients which will not supply passwords to samba.
1730 NOTE: The use of hosts.equiv can be a major security hole. This is
1731 because you are trusting the PC to supply the correct username. It is
1732 very easy to get a PC to supply a false username. I recommend that the
1733 hosts.equiv option be only used if you really know what you are doing,
1734 or perhaps on a home network where you trust your wife and kids :-)
1737 No host equivalences
1740 hosts equiv = /etc/hosts.equiv
1744 This allows you to include one config file inside another. The file is
1745 included literally, as though typed in place.
1747 It takes the standard substitutions, except %u, %P and %S
1751 This option allows you to setup multiple network interfaces, so that
1752 Samba can properly handle browsing on all interfaces.
1754 The option takes a list of ip/netmask pairs. The netmask may either be
1755 a bitmask, or a bitlength.
1757 For example, the following line:
1759 interfaces = 192.168.2.10/24 192.168.3.10/24
1761 would configure two network interfaces with IP addresses 192.168.2.10
1762 and 192.168.3.10. The netmasks of both interfaces would be set to
1765 You could produce an equivalent result by using:
1767 interfaces = 192.168.2.10/255.255.255.0 192.168.3.10/255.255.255.0
1769 if you prefer that format.
1771 If this option is not set then Samba will attempt to find a primary
1772 interface, but won't attempt to configure more than one interface.
1774 .SS invalid users (S)
1775 This is a list of users that should not be allowed to login to this
1776 service. This is really a "paranoid" check to absolutely ensure an
1777 improper setting does not breach your security.
1779 A name starting with @ is interpreted as a yp netgroup first (if this
1780 has been compiled into Samba), and then as a UNIX group if the name
1781 was not found in the yp netgroup database.
1783 A name starting with + is interpreted only by looking in the UNIX
1784 group database. A name starting with & is interpreted only by looking
1785 in the yp netgroup database (this has no effect if Samba is compiled
1786 without netgroup support).
1788 The current servicename is substituted for %S. This is useful in the
1791 See also "valid users"
1797 invalid users = root fred admin @wheel
1800 The value of the parameter (an integer) represents the number of seconds
1801 between 'keepalive' packets. If this parameter is zero, no keepalive packets
1802 will be sent. Keepalive packets, if sent, allow the server to tell whether a
1803 client is still present and responding.
1805 Keepalives should, in general, not be needed if the socket being used
1806 has the SO_KEEPALIVE attribute set on it (see "socket
1807 options"). Basically you should only use this option if you strike
1818 This parameter determines if Samba will produce Lanman announce
1819 broadcasts that are needed by OS/2 clients in order for them to
1820 see the Samba server in their browse list. This parameter can
1821 have three values, true, false, or auto. The default is auto.
1822 If set to False Samba will never produce these broadcasts. If
1823 set to true Samba will produce Lanman announce broadcasts at
1824 a frequency set by the parameter 'lm interval'. If set to auto
1825 Samba will not send Lanman announce broadcasts by default but
1826 will listen for them. If it hears such a broadcast on the wire
1827 it will then start sending them at a frequency set by the parameter
1830 See also "lm interval".
1840 If Samba is set to produce Lanman announce broadcasts needed
1841 by OS/2 clients (see the "lm announce" parameter) this parameter
1842 defines the frequency in seconds with which they will be made.
1843 If this is set to zero then no Lanman announcements will be
1844 made despite the setting of the "lm announce" parameter.
1846 See also "lm announce".
1854 .SS load printers (G)
1855 A boolean variable that controls whether all printers in the printcap
1856 will be loaded for browsing by default.
1864 .SS local master (G)
1865 This option allows the nmbd to become a local master browser on a
1866 subnet. If set to False then nmbd will not attempt to become a local
1867 master browser on a subnet and will also lose in all browsing elections.
1868 By default this value is set to true. Setting this value to true doesn't
1869 mean that Samba will become the local master browser on a subnet, just
1870 that the nmbd will participate in elections for local master browser.
1875 .SS lock directory (G)
1876 This option specifies the directory where lock files will be placed.
1877 The lock files are used to implement the "max connections" option.
1880 lock directory = /tmp/samba
1883 lock directory = /usr/local/samba/var/locks
1886 This controls whether or not locking will be performed by the server in
1887 response to lock requests from the client.
1889 If "locking = no", all lock and unlock requests will appear to succeed and
1890 all lock queries will indicate that the queried lock is clear.
1892 If "locking = yes", real locking will be performed by the server.
1894 This option may be particularly useful for read-only filesystems which
1895 do not need locking (such as cdrom drives).
1897 Be careful about disabling locking either globally or in a specific
1898 service, as lack of locking may result in data corruption.
1908 This options allows you to override the name of the Samba log file
1909 (also known as the debug file).
1911 This option takes the standard substitutions, allowing you to have
1912 separate log files for each user or machine.
1915 log file = /usr/local/samba/var/log.%m
1922 This parameter specifies the local path to which the home directory
1923 will be connected (see "logon home") and is only used by NT Workstations.
1930 This parameter specifies the home directory location when a Win95 or
1931 NT Workstation logs into a Samba PDC. It allows you to do "NET USE
1932 H: /HOME" from a command prompt, for example.
1935 This option takes the standard substitutions, allowing you to have
1936 separate logon scripts for each user or machine.
1939 logon home = "\\\\remote_smb_server\\%U"
1942 logon home = "\\\\%N\\%U"
1946 This parameter specifies the home directory where roaming profiles
1947 (USER.DAT / USER.MAN files for Windows 95) are stored.
1949 This option takes the standard substitutions, allowing you to have
1950 separate logon scripts for each user or machine. It also specifies
1951 the directory from which the "desktop", "start menu", "nethood" and
1952 "programs" folders, and their contents, are loaded and displayed
1953 on your Windows 95 client.
1955 The share and the path must be readable by the user for the preferences
1956 and directories to be loaded onto the Windows 95 client. The share
1957 must be writeable when the logs in for the first time, in order that
1958 the Windows 95 client can create the user.dat and other directories.
1960 Thereafter, the directories and any of contents can, if required,
1961 be made read-only. It is not adviseable that the USER.DAT file be made
1962 read-only - rename it to USER.MAN to achieve the desired effect
1963 (a MANdatory profile).
1965 Windows clients can sometimes maintain a connection to the [homes]
1966 share, even though there is no user logged in. Therefore, it is
1967 vital that the logon path does not include a reference to the
1968 homes share (i.e \\\\%N\\HOMES\profile_path will cause problems).
1971 This option takes the standard substitutions, allowing you to have
1972 separate logon scripts for each user or machine.
1975 logon path = \\\\%N\\%U\\profile
1978 logon path = \\\\PROFILESERVER\\HOME_DIR\\%U\\PROFILE
1980 .SS logon script (G)
1982 This parameter specifies the batch file (.bat) or NT command file (.cmd)
1983 to be downloaded and run on a machine when a user successfully logs in.
1984 The file must contain the DOS style cr/lf line endings. Using a DOS-style
1985 editor to create the file is recommended.
1987 The script must be a relative path to the [netlogon] service. If the
1988 [netlogon] service specifies a path of /usr/local/samba/netlogon, and
1989 logon script = STARTUP.BAT, then file that will be downloaded is:
1991 .B /usr/local/samba/netlogon/STARTUP.BAT
1993 The contents of the batch file is entirely your choice. A suggested
1994 command would be to add NET TIME \\\\SERVER /SET /YES, to force every
1995 machine to synchronise clocks with the same time server. Another use
1996 would be to add NET USE U: \\\\SERVER\\UTILS for commonly used utilities,
1997 or NET USE Q: \\\\SERVER\\ISO9001_QA.
1999 Note that it is particularly important not to allow write access to
2000 the [netlogon] share, or to grant users write permission on the
2001 batch files in a secure environment, as this would allow the batch
2002 files to be arbitrarily modified.
2005 This option takes the standard substitutions, allowing you to have
2006 separate logon scripts for each user or machine.
2009 logon script = scripts\\%U.bat
2011 .SS lppause command (S)
2012 This parameter specifies the command to be executed on the server host in
2013 order to stop printing or spooling a specific print job.
2015 This command should be a program or script which takes a printer name and
2016 job number to pause the print job. Currently I don't know of any print
2017 spooler system that can do this with a simple option, except for the PPR
2018 system from Trinity College (ppr\-dist.trincoll.edu/pub/ppr). One way
2019 of implementing this is by using job priorities, where jobs having a too
2020 low priority won't be sent to the printer. See also the
2024 If a %p is given then the printername is put in its place. A %j is
2025 replaced with the job number (an integer).
2026 On HPUX (see printing=hpux), if the -p%p option is added to the lpq
2027 command, the job will show up with the correct status, i.e. if the job
2028 priority is lower than the set fence priority it will have the PAUSED
2029 status, whereas if the priority is equal or higher it will have the
2030 SPOOLED or PRINTING status.
2032 Note that it is good practice to include the absolute path in the lppause
2033 command as the PATH may not be available to the server.
2036 Currently no default value is given to this string
2038 .B Example for HPUX:
2039 lppause command = /usr/bin/lpalt %p-%j -p0
2041 .SS lpq cache time (G)
2043 This controls how long lpq info will be cached for to prevent the lpq
2044 command being called too often. A separate cache is kept for each
2045 variation of the lpq command used by the system, so if you use
2046 different lpq commands for different users then they won't share cache
2049 The cache files are stored in /tmp/lpq.xxxx where xxxx is a hash
2050 of the lpq command in use.
2052 The default is 10 seconds, meaning that the cached results of a
2053 previous identical lpq command will be used if the cached data is less
2054 than 10 seconds old. A large value may be advisable if your lpq
2055 command is very slow.
2057 A value of 0 will disable cacheing completely.
2066 This parameter specifies the command to be executed on the server host in
2067 order to obtain "lpq"-style printer status information.
2069 This command should be a program or script which takes a printer name
2070 as its only parameter and outputs printer status information.
2072 Currently six styles of printer status information are supported; BSD,
2073 SYSV, AIX, HPUX, QNX, LPRNG and PLP. This covers most UNIX systems. You
2074 control which type is expected using the "printing =" option.
2076 Some clients (notably Windows for Workgroups) may not correctly send the
2077 connection number for the printer they are requesting status information
2078 about. To get around this, the server reports on the first printer service
2079 connected to by the client. This only happens if the connection number sent
2082 If a %p is given then the printername is put in its place. Otherwise
2083 it is placed at the end of the command.
2085 Note that it is good practice to include the absolute path in the lpq
2086 command as the PATH may not be available to the server.
2089 depends on the setting of "printing ="
2092 lpq command = /usr/bin/lpq %p
2094 .SS lpresume command (S)
2095 This parameter specifies the command to be executed on the server host in
2096 order to restart or continue printing or spooling a specific print job.
2098 This command should be a program or script which takes a printer name and
2099 job number to resume the print job. See also the lppause command.
2101 If a %p is given then the printername is put in its place. A %j is
2102 replaced with the job number (an integer).
2104 Note that it is good practice to include the absolute path in the lpresume
2105 command as the PATH may not be available to the server.
2108 Currently no default value is given to this string
2110 .B Example for HPUX:
2111 lpresume command = /usr/bin/lpalt %p-%j -p2
2113 .SS lprm command (S)
2114 This parameter specifies the command to be executed on the server host in
2115 order to delete a print job.
2117 This command should be a program or script which takes a printer name
2118 and job number, and deletes the print job.
2120 Currently seven styles of printer control are supported; BSD, SYSV, AIX
2121 HPUX, QNX, LPRNG and PLP. This covers most UNIX systems. You control
2122 which type is expected using the "printing =" option.
2124 If a %p is given then the printername is put in its place. A %j is
2125 replaced with the job number (an integer).
2127 Note that it is good practice to include the absolute path in the lprm
2128 command as the PATH may not be available to the server.
2131 depends on the setting of "printing ="
2134 lprm command = /usr/bin/lprm -P%p %j
2137 lprm command = /usr/bin/cancel %p-%j
2139 .SS magic output (S)
2140 This parameter specifies the name of a file which will contain output
2141 created by a magic script (see
2145 Warning: If two clients use the same magic script in the same directory the
2146 output file content is undefined.
2148 magic output = <magic script name>.out
2151 magic output = myfile.txt
2152 .SS magic script (S)
2153 This parameter specifies the name of a file which, if opened, will be
2154 executed by the server when the file is closed. This allows a UNIX script
2155 to be sent to the Samba host and executed on behalf of the connected user.
2157 Scripts executed in this way will be deleted upon completion, permissions
2160 If the script generates output, output will be sent to the file specified by
2163 parameter (see above).
2165 Note that some shells are unable to interpret scripts containing
2166 carriage-return-linefeed instead of linefeed as the end-of-line
2167 marker. Magic scripts must be executable "as is" on the host, which
2168 for some hosts and some shells will require filtering at the DOS end.
2170 Magic scripts are EXPERIMENTAL and should NOT be relied upon.
2173 None. Magic scripts disabled.
2176 magic script = user.csh
2180 See the section on "NAME MANGLING"
2183 This is for those who want to directly map UNIX file names which are
2184 not representable on DOS. The mangling of names is not always what is
2185 needed. In particular you may have documents with file extensions
2186 that differ between DOS and UNIX. For example, under UNIX it is common
2187 to use .html for HTML files, whereas under DOS .htm is more commonly
2190 So to map 'html' to 'htm' you put:
2192 mangled map = (*.html *.htm)
2194 One very useful case is to remove the annoying ;1 off the ends of
2195 filenames on some CDROMS (only visible under some UNIXes). To do this
2196 use a map of (*;1 *)
2202 mangled map = (*;1 *)
2204 .SS mangled names (S)
2205 This controls whether non-DOS names under UNIX should be mapped to
2206 DOS-compatible names ("mangled") and made visible, or whether non-DOS names
2207 should simply be ignored.
2209 See the section on "NAME MANGLING" for details on how to control the
2212 If mangling is used then the mangling algorithm is as follows:
2214 - the first (up to) five alphanumeric characters before the rightmost dot of
2215 the filename are preserved, forced to upper case, and appear as the first (up
2216 to) five characters of the mangled name.
2218 - a tilde ("~") is appended to the first part of the mangled name, followed
2219 by a two-character unique sequence, based on the original root name
2220 (i.e., the original filename minus its final extension). The final
2221 extension is included in the hash calculation only if it contains any upper
2222 case characters or is longer than three characters.
2224 Note that the character to use may be specified using the "mangling
2225 char" option, if you don't like ~.
2227 - the first three alphanumeric characters of the final extension are preserved,
2228 forced to upper case and appear as the extension of the mangled name. The
2229 final extension is defined as that part of the original filename after the
2230 rightmost dot. If there are no dots in the filename, the mangled name will
2231 have no extension (except in the case of hidden files - see below).
2233 - files whose UNIX name begins with a dot will be presented as DOS hidden
2234 files. The mangled name will be created as for other filenames, but with the
2235 leading dot removed and "___" as its extension regardless of actual original
2236 extension (that's three underscores).
2239 The two-digit hash value consists of upper case alphanumeric characters.
2241 This algorithm can cause name collisions only if files in a directory share
2242 the same first five alphanumeric characters. The probability of such a clash
2245 The name mangling (if enabled) allows a file to be copied between UNIX
2246 directories from DOS while retaining the long UNIX filename. UNIX files can
2247 be renamed to a new extension from DOS and will retain the same basename.
2248 Mangled names do not change between sessions.
2255 .SS mangling char (S)
2256 This controls what character is used as the "magic" character in name
2257 mangling. The default is a ~ but this may interfere with some
2258 software. Use this option to set it to whatever you prefer.
2266 .SS mangled stack (G)
2267 This parameter controls the number of mangled names that should be cached in
2270 This stack is a list of recently mangled base names (extensions are only
2271 maintained if they are longer than 3 characters or contains upper case
2274 The larger this value, the more likely it is that mangled names can be
2275 successfully converted to correct long UNIX names. However, large stack
2276 sizes will slow most directory access. Smaller stacks save memory in the
2277 server (each stack element costs 256 bytes).
2279 It is not possible to absolutely guarantee correct long file names, so
2280 be prepared for some surprises!
2289 This controls whether the DOS archive attribute should be mapped to the
2290 UNIX owner execute bit. The DOS archive bit is set when a file has been modified
2291 since its last backup. One motivation for this option it to keep Samba/your
2292 PC from making any file it touches from becoming executable under UNIX.
2293 This can be quite annoying for shared source code, documents, etc...
2295 Note that this requires the 'create mask' to be set such that owner
2296 execute bit is not masked out (ie. it must include 100). See the
2297 parameter "create mask" for details.
2306 This controls whether DOS style hidden files should be mapped to the
2307 UNIX world execute bit.
2309 Note that this requires the 'create mask' to be set such that the world
2310 execute bit is not masked out (ie. it must include 001).
2311 See the parameter "create mask" for details.
2319 This controls whether DOS style system files should be mapped to the
2320 UNIX group execute bit.
2322 Note that this requires the 'create mask' to be set such that the group
2323 execute bit is not masked out (ie. it must include 010). See the parameter
2324 "create mask" for details.
2331 .SS max connections (S)
2332 This option allows the number of simultaneous connections to a
2333 service to be limited. If "max connections" is greater than 0 then
2334 connections will be refused if this number of connections to the
2335 service are already open. A value of zero mean an unlimited number of
2336 connections may be made.
2338 Record lock files are used to implement this feature. The lock files
2339 will be stored in the directory specified by the "lock directory" option.
2345 max connections = 10
2347 .SS max disk size (G)
2348 This option allows you to put an upper limit on the apparent size of
2349 disks. If you set this option to 100 then all shares will appear to be
2350 not larger than 100 MB in size.
2352 Note that this option does not limit the amount of data you can put on
2353 the disk. In the above case you could still store much more than 100
2354 MB on the disk, but if a client ever asks for the amount of free disk
2355 space or the total disk size then the result will be bounded by the
2356 amount specified in "max disk size".
2358 This option is primarily useful to work around bugs in some pieces of
2359 software that can't handle very large disks, particularly disks over
2362 A "max disk size" of 0 means no limit.
2368 max disk size = 1000
2370 .SS max log size (G)
2372 This option (an integer in kilobytes) specifies the max size the log
2373 file should grow to. Samba periodically checks the size and if it is
2374 exceeded it will rename the file, adding a .old extension.
2376 A size of 0 means no limit.
2386 This option controls the maximum number of outstanding simultaneous SMB
2387 operations that samba tells the client it will allow. You should never need
2388 to set this parameter.
2395 A synonym for this parameter is 'packet size'.
2399 This option tells nmbd what the default 'time to live' of NetBIOS
2400 names should be (in seconds) when nmbd is requesting a name using
2401 either a broadcast or from a WINS server. You should never need to
2402 change this parameter.
2407 .SS max wins ttl (G)
2409 This option tells nmbd when acting as a WINS server (wins support = true)
2410 what the maximum 'time to live' of NetBIOS names that nmbd will grant will
2411 be (in seconds). You should never need to change this parameter.
2412 The default is 3 days (259200 seconds).
2415 max wins ttl = 259200
2419 This option controls the maximum packet size that will be negotiated
2420 by Samba. The default is 65535, which is the maximum. In some cases
2421 you may find you get better performance with a smaller value. A value
2422 below 2048 is likely to cause problems.
2430 .SS message command (G)
2432 This specifies what command to run when the server receives a WinPopup
2435 This would normally be a command that would deliver the message
2436 somehow. How this is to be done is up to your imagination.
2440 message command = csh -c 'xedit %s;rm %s' &
2442 This delivers the message using xedit, then removes it
2443 afterwards. NOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN
2444 IMMEDIATELY. That's why I have the & on the end. If it doesn't return
2445 immediately then your PCs may freeze when sending messages (they
2446 should recover after 30secs, hopefully).
2448 All messages are delivered as the global guest user. The command takes
2449 the standard substitutions, although %u won't work (%U may be better
2452 Apart from the standard substitutions, some additional ones apply. In
2455 %s = the filename containing the message
2457 %t = the destination that the message was sent to (probably the server
2460 %f = who the message is from
2462 You could make this command send mail, or whatever else takes your
2463 fancy. Please let me know of any really interesting ideas you have.
2465 Here's a way of sending the messages as mail to root:
2467 message command = /bin/mail -s 'message from %f on %m' root < %s; rm %s
2469 If you don't have a message command then the message won't be
2470 delivered and Samba will tell the sender there was an
2471 error. Unfortunately WfWg totally ignores the error code and carries
2472 on regardless, saying that the message was delivered.
2474 If you want to silently delete it then try "message command = rm %s".
2476 For the really adventurous, try something like this:
2478 message command = csh -c 'csh < %s |& /usr/local/samba/bin/smbclient \e
2481 this would execute the command as a script on the server, then give
2482 them the result in a WinPopup message. Note that this could cause a
2483 loop if you send a message from the server using smbclient! You better
2484 wrap the above in a script that checks for this :-)
2490 message command = csh -c 'xedit %s;rm %s' &
2492 .SS min print space (S)
2494 This sets the minimum amount of free disk space that must be available
2495 before a user will be able to spool a print job. It is specified in
2496 kilobytes. The default is 0, which means no limit.
2502 min print space = 2000
2504 .SS min wins ttl (G)
2506 This option tells nmbd when acting as a WINS server (wins support = true)
2507 what the minimum 'time to live' of NetBIOS names that nmbd will grant will
2508 be (in seconds). You should never need to change this parameter.
2509 The default is 6 hours (21600 seconds).
2512 min wins ttl = 21600
2514 .SS name resolve order (G)
2516 This option is used by the programs smbd, nmbd and smbclient to determine
2517 what naming services and in what order to resolve host names to IP addresses.
2518 This option is most useful in smbclient. The option takes a space separated
2519 string of different name resolution options. These are "lmhosts", "host",
2520 "wins" and "bcast". They cause names to be resolved as follows :
2522 lmhosts : Lookup an IP address in the Samba lmhosts file.
2523 host : Do a standard host name to IP address resolution, using the
2524 system /etc/hosts, NIS, or DNS lookups. This method of name
2525 resolution is operating system depended (for instance on Solaris
2526 this may be controlled by the /etc/nsswitch.conf file).
2527 wins : Query a name with the IP address listed in the "wins server ="
2528 parameter. If no WINS server has been specified this method will
2530 bcast : Do a broadcast on each of the known local interfaces listed in
2531 the "interfaces =" parameter. This is the least reliable of the
2532 name resolution methods as it depends on the target host being
2533 on a locally connected subnet.
2535 The default order is lmhosts, host, wins, bcast and these name resolution
2536 methods will be attempted in this order.
2538 This option was first introduced in Samba 1.9.18p4.
2541 name resolve order = lmhosts host wins bcast
2544 name resolve order = lmhosts bcast host
2546 This will cause the local lmhosts file to be examined first, followed
2547 by a broadcast attempt, followed by a normal system hostname lookup.
2549 .SS netbios aliases (G)
2551 This is a list of names that nmbd will advertise as additional
2552 names by which the Samba server is known. This allows one machine
2553 to appear in browse lists under multiple names. If a machine is
2554 acting as a browse server or logon server none of these names
2555 will be advertised as either browse server or logon servers, only
2556 the primary name of the machine will be advertised with these
2559 See also 'netbios name'.
2562 netbios aliases = TEST TEST1 TEST2
2564 .SS netbios name (G)
2566 This sets the NetBIOS name by which a Samba server is known. By
2567 default it is the same as the first component of the host's DNS name.
2568 If a machine is a browse server or logon server this name (or the
2569 first component of the hosts DNS name) will be the name that these
2570 services are advertised under.
2572 See also 'netbios aliases'.
2575 netbios name = MYNAME
2578 Get the home share server from a NIS (or YP) map. For unix systems that
2579 use an automounter, the user's home directory will often be mounted on
2580 a workstation on demand from a remote server. When the Samba logon server
2581 is not the actual home directory server, two network hops are required
2582 to access the home directory and this can be very slow especially with
2583 writing via Samba to an NFS mounted directory. This option allows samba
2584 to return the home share as being on a different server to the logon
2585 server and as long as a samba daemon is running on the home directory
2586 server, it will be mounted on the Samba client directly from the directory
2587 server. When Samba is returning the home share to the client, it will
2588 consult the NIS (or YP) map specified in "homedir map" and return the
2589 server listed there.
2597 .SS networkstation user login (G)
2598 This global parameter (new for 1.9.18p3) affects server level security.
2599 With this set (recommended) samba will do a full NetWkstaUserLogon to
2600 confirm that the client really should have login rights. This can cause
2601 problems with machines in trust relationships in which case you can
2602 disable it here, but be warned, we have heard that some NT machines
2603 will then allow anyone in with any password! Make sure you test it.
2605 In Samba 1.9.18p5 this parameter is of limited use, as smbd now
2606 explicitly tests for this NT bug and will refuse to use a password
2607 server that has the problem. The parameter now defaults to off,
2608 and it should not be neccessary to set this parameter to on. It will
2609 be removed in a future Samba release.
2612 networkstation user login = no
2615 networkstation user login = yes
2617 .SS null passwords (G)
2618 Allow or disallow access to accounts that have null passwords.
2624 null passwords = yes
2626 .SS ole locking compatibility (G)
2628 This parameter allows an administrator to turn off the byte range
2629 lock manipulation that is done within Samba to give compatibility
2630 for OLE applications. Windows OLE applications use byte range locking
2631 as a form of inter-process communication, by locking ranges of bytes
2632 around the 2^32 region of a file range. This can cause certain UNIX
2633 lock managers to crash or otherwise cause problems. Setting this
2634 parameter to "no" means you trust your UNIX lock manager to handle
2635 such cases correctly.
2638 ole locking compatibility = yes
2641 ole locking compatibility = no
2645 A synonym for this command is 'guest only'.
2648 This is a boolean option that controls whether connections with
2649 usernames not in the user= list will be allowed. By default this
2650 option is disabled so a client can supply a username to be used by
2653 Note that this also means Samba won't try to deduce usernames from the
2654 service name. This can be annoying for the [homes] section. To get
2655 around this you could use "user = %S" which means your "user" list
2656 will be just the service name, which for home directories is the name
2666 This boolean option tells smbd whether to issue oplocks (opportunistic
2667 locks) to file open requests on this share. The oplock code was introduced in
2668 Samba 1.9.18 and can dramatically (approx 30% or more) improve the speed
2669 of access to files on Samba servers. It allows the clients to agressively
2670 cache files locally and you may want to disable this option for unreliable
2671 network environments (it is turned on by default in Windows NT Servers).
2672 For more information see the file Speed.txt in the Samba docs/ directory.
2674 Oplocks may be selectively turned off on certain files on a per share basis.
2675 See the 'veto oplock files' parameter.
2685 This integer value controls what level Samba advertises itself as for
2686 browse elections. See BROWSING.txt for details.
2689 The maximum transmit packet size during a raw read. This option is no
2690 longer implemented as of version 1.7.00, and is kept only so old
2691 configuration files do not become invalid.
2694 This string controls the "chat" conversation that takes places
2695 between smbd and the local password changing program to change the
2696 users password. The string describes a sequence of response-receive
2697 pairs that smbd uses to determine what to send to the passwd program
2698 and what to expect back. If the expected output is not received then
2699 the password is not changed.
2701 This chat sequence is often quite site specific, depending on what
2702 local methods are used for password control (such as NIS+ etc).
2704 The string can contain the macros %o and %n which are substituted for
2705 the old and new passwords respectively. It can also contain the
2706 standard macros \en \er \et and \es to give line-feed, carriage-return,
2709 The string can also contain a * which matches any sequence of
2712 Double quotes can be used to collect strings with spaces in them into
2715 If the send string in any part of the chat sequence is a fullstop "."
2716 then no string is sent. Similarly, is the expect string is a fullstop
2717 then no string is expected.
2719 Note that if the 'unix password sync' parameter is set to true,
2720 then this sequence is called *AS ROOT* when the SMB password in the
2721 smbpasswd file is being changed, without access to the old password
2722 cleartext. In this case the old password cleartext is set to ""
2725 See also 'unix password sync' and 'passwd chat debug'
2728 passwd chat = "*Enter OLD password*" %o\en "*Enter NEW password*" %n\en \e
2729 "*Reenter NEW password*" %n\en "*Password changed*"
2733 passwd chat = *old*password* %o\en *new*password* %n\en *new*password* %n\en *changed*
2735 .SS passwd chat debug (G)
2737 This boolean specifies if the passwd chat script parameter is run
2738 in 'debug' mode. In this mode the strings passed to and received
2739 from the passwd chat are printed in the smbd log with a debug level
2740 of 100. This is a dangerous option as it will allow plaintext passwords
2741 to be seen in the smbd log. It is available to help Samba admins
2742 debug their passwd chat scripts and should be turned off after
2743 this has been done. This parameter is off by default.
2746 passwd chat debug = True
2749 passwd chat debug = False
2751 .SS passwd program (G)
2752 The name of a program that can be used to set user passwords.
2754 This is only available if you have enabled remote password changing at
2755 compile time (see the comments in the Makefile for details). Any occurrences
2756 of %u will be replaced with the user name. The user name is checked
2757 for existance before calling the password changing program.
2759 Also note that many passwd programs insist in "reasonable" passwords,
2760 such as a minimum length, or the inclusion of mixed case chars and
2761 digits. This can pose a problem as some clients (such as Windows for
2762 Workgroups) uppercase the password before sending it.
2764 Note that if the 'unix password sync' parameter is set to true,
2765 then this sequence is called *AS ROOT* when the SMB password in the
2766 smbpasswd file is being changed. If the 'unix passwd sync' parameter
2767 is set this parameter MUST USE ABSOLUTE PATHS for ALL programs called,
2768 and must be examined for security implications. Note that by default
2769 'unix password sync' is set to False.
2771 See also 'unix password sync'
2774 passwd program = /bin/passwd
2777 passwd program = /sbin/passwd %u
2779 .SS password level (G)
2780 Some client/server combinations have difficulty with mixed-case passwords.
2781 One offending client is Windows for Workgroups, which for some reason forces
2782 passwords to upper case when using the LANMAN1 protocol, but leaves them alone
2783 when using COREPLUS!
2785 This parameter defines the maximum number of characters that may be upper case
2788 For example, say the password given was "FRED". If
2790 is set to 1 (one), the following combinations would be tried if "FRED" failed:
2791 "Fred", "fred", "fRed", "frEd", "freD". If
2792 .B password level was set to 2 (two), the following combinations would also be
2793 tried: "FRed", "FrEd", "FreD", "fREd", "fReD", "frED". And so on.
2795 The higher value this parameter is set to the more likely it is that a mixed
2796 case password will be matched against a single case password. However, you
2797 should be aware that use of this parameter reduces security and increases the
2798 time taken to process a new connection.
2800 A value of zero will cause only two attempts to be made - the password as is
2801 and the password in all-lower case.
2803 If you find the connections are taking too long with this option then
2804 you probably have a slow crypt() routine. Samba now comes with a fast
2805 "ufc crypt" that you can select in the Makefile. You should also make
2806 sure the PASSWORD_LENGTH option is correct for your system in local.h
2807 and includes.h. On most systems only the first 8 chars of a password
2808 are significant so PASSWORD_LENGTH should be 8, but on some longer
2809 passwords are significant. The includes.h file tries to select the
2810 right length for your system.
2818 .SS password server (G)
2820 By specifying the name of another SMB server (such as a WinNT box)
2821 with this option, and using "security = server" you can get Samba to
2822 do all its username/password validation via a remote server.
2824 This options sets the name of the password server to use. It must be a
2825 netbios name, so if the machine's netbios name is different from its
2826 internet name then you may have to add its netbios name to
2829 Note that with Samba 1.9.18p4 and above the name of the password
2830 server is looked up using the parameter "name resolve order=" and
2831 so may resolved by any method and order described in that parameter.
2833 The password server much be a machine capable of using the "LM1.2X002"
2834 or the "LM NT 0.12" protocol, and it must be in user level security
2837 NOTE: Using a password server means your UNIX box (running Samba) is
2838 only as secure as your password server. DO NOT CHOOSE A PASSWORD
2839 SERVER THAT YOU DON'T COMPLETELY TRUST.
2841 Never point a Samba server at itself for password serving. This will
2842 cause a loop and could lock up your Samba server!
2844 The name of the password server takes the standard substitutions, but
2845 probably the only useful one is %m, which means the Samba server will
2846 use the incoming client as the password server. If you use this then
2847 you better trust your clients, and you better restrict them with hosts
2850 If you list several hosts in the "password server" option then smbd
2851 will try each in turn till it finds one that responds. This is useful
2852 in case your primary server goes down.
2854 If you are using a WindowsNT server as your password server then you
2855 will have to ensure that your users are able to login from the Samba
2856 server, as the network logon will appear to come from there rather
2857 than from the users workstation.
2860 A synonym for this parameter is 'directory'.
2862 This parameter specifies a directory to which the user of the service is to
2863 be given access. In the case of printable services, this is where print data
2864 will spool prior to being submitted to the host for printing.
2866 For a printable service offering guest access, the service should be readonly
2867 and the path should be world-writable and have the sticky bit set. This is not
2868 mandatory of course, but you probably won't get the results you expect if you
2871 Any occurrences of %u in the path will be replaced with the username
2872 that the client is connecting as. Any occurrences of %m will be
2873 replaced by the name of the machine they are connecting from. These
2874 replacements are very useful for setting up pseudo home directories
2877 Note that this path will be based on 'root dir' if one was specified.
2886 This option specifies a command to be run whenever the service is
2887 disconnected. It takes the usual substitutions. The command may be run
2888 as the root on some systems.
2890 An interesting example may be do unmount server resources:
2892 postexec = /etc/umount /cdrom
2897 none (no command executed)
2900 postexec = echo \e"%u disconnected from %S from %m (%I)\e" >> /tmp/log
2903 This parameter forces a printer to interpret the print files as
2904 postscript. This is done by adding a %! to the start of print output.
2906 This is most useful when you have lots of PCs that persist in putting
2907 a control-D at the start of print jobs, which then confuses your
2918 This option specifies a command to be run whenever the service is
2919 connected to. It takes the usual substitutions.
2921 An interesting example is to send the users a welcome message every
2922 time they log in. Maybe a message of the day? Here is an example:
2924 preexec = csh -c 'echo \e"Welcome to %S!\e" | \e
2925 /usr/local/samba/bin/smbclient -M %m -I %I' &
2927 Of course, this could get annoying after a while :-)
2932 none (no command executed)
2935 preexec = echo \e"%u connected to %S from %m (%I)\e" >> /tmp/log
2937 .SS preferred master (G)
2938 This boolean parameter controls if Samba is a preferred master browser
2940 If this is set to true, on startup, samba will force an election,
2941 and it will have a slight advantage in winning the election.
2942 It is recommended that this parameter is used in conjunction
2943 with domain master = yes, so that samba can guarantee becoming
2946 Use this option with caution, because if there are several hosts
2947 (whether samba servers, Windows 95 or NT) that are preferred master
2948 browsers on the same subnet, they will each periodically and continuously
2949 attempt to become the local master browser. This will result in
2950 unnecessary broadcast traffic and reduced browsing capabilities.
2956 preferred master = no
2959 This is an alias for "auto services"
2961 .SS preserve case (S)
2963 This controls if new filenames are created with the case that the
2964 client passes, or if they are forced to be the "default" case.
2969 See the section on "NAME MANGLING" for a fuller discussion.
2971 .SS print command (S)
2972 After a print job has finished spooling to a service, this command will be
2973 used via a system() call to process the spool file. Typically the command
2974 specified will submit the spool file to the host's printing subsystem, but
2975 there is no requirement that this be the case. The server will not remove the
2976 spool file, so whatever command you specify should remove the spool file when
2977 it has been processed, otherwise you will need to manually remove old spool
2980 The print command is simply a text string. It will be used verbatim,
2981 with two exceptions: All occurrences of "%s" will be replaced by the
2982 appropriate spool file name, and all occurrences of "%p" will be
2983 replaced by the appropriate printer name. The spool file name is
2984 generated automatically by the server, the printer name is discussed
2987 The full path name will be used for the filename if %s is not preceded
2988 by a /. If you don't like this (it can stuff up some lpq output) then
2989 use %f instead. Any occurrences of %f get replaced by the spool
2990 filename without the full path at the front.
2992 The print command MUST contain at least one occurrence of "%s" or %f -
2993 the "%p" is optional. At the time a job is submitted, if no printer
2994 name is supplied the "%p" will be silently removed from the printer
2997 If specified in the [global] section, the print command given will be used
2998 for any printable service that does not have its own print command specified.
3000 If there is neither a specified print command for a printable service nor a
3001 global print command, spool files will be created but not processed and (most
3002 importantly) not removed.
3004 Note that printing may fail on some UNIXes from the "nobody"
3005 account. If this happens then create an alternative guest account that
3006 can print and set the "guest account" in the [global] section.
3008 You can form quite complex print commands by realising that they are
3009 just passed to a shell. For example the following will log a print
3010 job, print the file, then remove it. Note that ; is the usual
3011 separator for command in shell scripts.
3013 print command = echo Printing %s >> /tmp/print.log; lpr -P %p %s; rm %s
3015 You may have to vary this command considerably depending on how you
3016 normally print files on your system.
3019 print command = lpr -r -P %p %s
3022 print command = /usr/local/samba/bin/myprintscript %p %s
3027 A synonym for this parameter is 'print ok'.
3029 If this parameter is 'yes', then clients may open, write to and submit spool
3030 files on the directory specified for the service.
3032 Note that a printable service will ALWAYS allow writing to the service path
3033 (user privileges permitting) via the spooling of print data. The 'read only'
3034 parameter controls only non-printing access to the resource.
3042 .SS printcap name (G)
3043 This parameter may be used to override the compiled-in default printcap
3044 name used by the server (usually /etc/printcap). See the discussion of the
3045 [printers] section above for reasons why you might want to do this.
3047 On SystemV systems that use lpstat to list available printers you
3048 can use "printcap name = lpstat" to automatically obtain lists of
3049 available printers. This is the default for systems that define
3050 SYSV at compile time in Samba (this includes most SystemV based
3051 systems). If "printcap name" is set to lpstat on these systems then
3052 Samba will launch "lpstat -v" and attempt to parse the output to
3053 obtain a printer list.
3055 A minimal printcap file would look something like this:
3067 where the | separates aliases of a printer. The fact that the second
3068 alias has a space in it gives a hint to Samba that it's a comment.
3070 NOTE: Under AIX the default printcap name is "/etc/qconfig". Samba
3071 will assume the file is in AIX "qconfig" format if the string
3072 "/qconfig" appears in the printcap filename.
3075 printcap name = /etc/printcap
3078 printcap name = /etc/myprintcap
3081 A synonym for this parameter is 'printer name'.
3083 This parameter specifies the name of the printer to which print jobs spooled
3084 through a printable service will be sent.
3086 If specified in the [global] section, the printer name given will be used
3087 for any printable service that does not have its own printer name specified.
3090 none (but may be 'lp' on many systems)
3093 printer name = laserwriter
3095 .SS printer driver (S)
3096 This option allows you to control the string that clients receive when
3097 they ask the server for the printer driver associated with a
3098 printer. If you are using Windows95 or WindowsNT then you can use this
3099 to automate the setup of printers on your system.
3101 You need to set this parameter to the exact string (case sensitive)
3102 that describes the appropriate printer driver for your system.
3103 If you don't know the exact string to use then you should first try
3104 with no "printer driver" option set and the client will give you a
3105 list of printer drivers. The appropriate strings are shown in a
3106 scrollbox after you have chosen the printer manufacturer.
3109 printer driver = HP LaserJet 4L
3111 .SS printer name (S)
3115 .SS printer driver file (G)
3116 This parameter tells Samba where the printer driver definition file,
3117 used when serving drivers to Windows 95 clients, is to be found. If
3118 this is not set, the default is :
3120 SAMBA_INSTALL_DIRECTORY/lib/printers.def
3122 This file is created from Windows 95 'msprint.def' files found on the
3123 Windows 95 client system. For more details on setting up serving of
3124 printer drivers to Windows 95 clients, see the documentation file
3125 docs/PRINTER_DRIVER.txt.
3128 None (set in compile).
3131 printer driver file = /usr/local/samba/printers/drivers.def
3134 .B printer driver location
3136 .SS printer driver location (S)
3137 This parameter tells clients of a particular printer share where
3138 to find the printer driver files for the automatic installation
3139 of drivers for Windows 95 machines. If Samba is set up to serve
3140 printer drivers to Windows 95 machines, this should be set to
3142 \e\eMACHINE\ePRINTER$
3144 Where MACHINE is the NetBIOS name of your Samba server, and PRINTER$
3145 is a share you set up for serving printer driver files. For more
3146 details on setting this up see the documentation file
3147 docs/PRINTER_DRIVER.txt.
3153 printer driver location = \e\eMACHINE\ePRINTER$
3156 .B printer driver file
3160 This parameters controls how printer status information is interpreted
3161 on your system, and also affects the default values for the "print
3162 command", "lpq command" and "lprm command".
3164 Currently six printing styles are supported. They are "printing =
3165 bsd", "printing = sysv", "printing = hpux", "printing = aix",
3166 "printing = qnx" and "printing = plp".
3168 To see what the defaults are for the other print commands when using
3169 these three options use the "testparm" program.
3171 As of version 1.9.18 of Samba this option can be set on a per printer basis
3174 The value of the parameter (a string) is the highest protocol level that will
3175 be supported by the server.
3177 Possible values are CORE, COREPLUS, LANMAN1, LANMAN2 and NT1. The relative
3178 merits of each are discussed in the README file.
3180 Normally this option should not be set as the automatic negotiation
3181 phase in the SMB protocol takes care of choosing the appropriate protocol.
3190 A synonym for this parameter is 'guest ok'.
3192 If this parameter is 'yes' for a service, then no password is required
3193 to connect to the service. Privileges will be those of the guest
3196 See the section below on user/password validation for more information about
3205 .SS queuepause command (S)
3206 This parameter specifies the command to be executed on the server host in
3207 order to pause the printerqueue.
3209 This command should be a program or script which takes a printer name
3210 as its only parameter and stops the printerqueue, such that no longer
3211 jobs are submitted to the printer.
3213 This command is not supported by Windows for Workgroups, but can be
3214 issued from the Printer's window under Windows 95 & NT.
3216 If a %p is given then the printername is put in its place. Otherwise
3217 it is placed at the end of the command.
3219 Note that it is good practice to include the absolute path in the
3220 command as the PATH may not be available to the server.
3223 depends on the setting of "printing ="
3226 queuepause command = disable %p
3228 .SS queueresume command (S)
3229 This parameter specifies the command to be executed on the server host in
3230 order to resume the printerqueue. It is the command to undo the behaviour
3231 that is caused by the previous parameter (queuepause command).
3233 This command should be a program or script which takes a printer name
3234 as its only parameter and resumes the printerqueue, such that queued
3235 jobs are resubmitted to the printer.
3237 This command is not supported by Windows for Workgroups, but can be
3238 issued from the Printer's window under Windows 95 & NT.
3240 If a %p is given then the printername is put in its place. Otherwise
3241 it is placed at the end of the command.
3243 Note that it is good practice to include the absolute path in the
3244 command as the PATH may not be available to the server.
3247 depends on the setting of "printing ="
3250 queuepause command = enable %p
3253 This is a list of users that are given read-only access to a
3254 service. If the connecting user is in this list then they will
3255 not be given write access, no matter what the "read only" option
3256 is set to. The list can include group names using the @group syntax.
3258 See also the "write list" option
3264 read list = mary, @students
3271 Note that this is an inverted synonym for writable and write ok.
3272 .SS read prediction (G)
3273 This options enables or disables the read prediction code used to
3274 speed up reads from the server. When enabled the server will try to
3275 pre-read data from the last accessed file that was opened read-only
3276 while waiting for packets.
3279 read prediction = False
3282 read prediction = True
3284 This parameter controls whether or not the server will support raw reads when
3285 transferring data to clients.
3287 If enabled, raw reads allow reads of 65535 bytes in one packet. This
3288 typically provides a major performance benefit.
3290 However, some clients either negotiate the allowable block size incorrectly
3291 or are incapable of supporting larger block sizes, and for these clients you
3292 may need to disable raw reads.
3294 In general this parameter should be viewed as a system tuning tool and left
3295 severely alone. See also
3305 The option "read size" affects the overlap of disk reads/writes with
3306 network reads/writes. If the amount of data being transferred in
3307 several of the SMB commands (currently SMBwrite, SMBwriteX and
3308 SMBreadbraw) is larger than this value then the server begins writing
3309 the data before it has received the whole packet from the network, or
3310 in the case of SMBreadbraw, it begins writing to the network before
3311 all the data has been read from disk.
3313 This overlapping works best when the speeds of disk and network access
3314 are similar, having very little effect when the speed of one is much
3315 greater than the other.
3317 The default value is 2048, but very little experimentation has been
3318 done yet to determine the optimal value, and it is likely that the best
3319 value will vary greatly between systems anyway. A value over 65536 is
3320 pointless and will cause you to allocate memory unnecessarily.
3328 .SS remote announce (G)
3330 This option allows you to setup nmbd to periodically announce itself
3331 to arbitrary IP addresses with an arbitrary workgroup name.
3333 This is useful if you want your Samba server to appear in a remote
3334 workgroup for which the normal browse propagation rules don't
3335 work. The remote workgroup can be anywhere that you can send IP
3340 remote announce = 192.168.2.255/SERVERS 192.168.4.255/STAFF
3342 the above line would cause nmbd to announce itself to the two given IP
3343 addresses using the given workgroup names. If you leave out the
3344 workgroup name then the one given in the "workgroup" option is used
3347 The IP addresses you choose would normally be the broadcast addresses
3348 of the remote networks, but can also be the IP addresses of known
3349 browse masters if your network config is that stable.
3351 This option replaces similar functionality from the nmbd lmhosts file.
3353 .SS remote browse sync (G)
3355 This option allows you to setup nmbd to periodically request synchronisation
3356 of browse lists with the master browser of a samba server that is on a remote
3357 segment. This option will allow you to gain browse lists for multiple
3358 workgroups across routed networks. This is done in a manner that does not work
3359 with any non-samba servers.
3361 This is useful if you want your Samba server and all local clients
3362 to appear in a remote workgroup for which the normal browse propagation
3363 rules don't work. The remote workgroup can be anywhere that you can send IP
3368 remote browse sync = 192.168.2.255 192.168.4.255
3370 the above line would cause nmbd to request the master browser on the
3371 specified subnets or addresses to synchronise their browse lists with
3374 The IP addresses you choose would normally be the broadcast addresses
3375 of the remote networks, but can also be the IP addresses of known
3376 browse masters if your network config is that stable. If a machine IP
3377 address is given Samba makes NO attempt to validate that the remote
3378 machine is available, is listening, nor that it is in fact the browse
3379 master on it's segment.
3384 This option controls whether Samba will allow a previously validated
3385 username/password pair to be used to attach to a share. Thus if you
3386 connect to \e\eserver\eshare1 then to \e\eserver\eshare2 it won't
3387 automatically allow the client to request connection to the second
3388 share as the same username as the first without a password.
3390 Note that this option only works with security=share and will
3391 be ignored if this is not the case.
3393 If "revalidate" is True then the client will be denied automatic
3394 access as the same username.
3408 .SS root directory (G)
3409 Synonyms for this parameter are 'root dir' and 'root'.
3411 The server will chroot() to this directory on startup. This is not
3412 strictly necessary for secure operation. Even without it the server
3413 will deny access to files not in one of the service entries. It may
3414 also check for, and deny access to, soft links to other parts of the
3415 filesystem, or attempts to use .. in file names to access other
3416 directories (depending on the setting of the "wide links" parameter).
3418 Adding a "root dir" entry other than "/" adds an extra level of security,
3419 but at a price. It absolutely ensures that no access is given to files not
3420 in the sub-tree specified in the "root dir" option, *including* some files
3421 needed for complete operation of the server. To maintain full operability
3422 of the server you will need to mirror some system files into the "root dir"
3423 tree. In particular you will need to mirror /etc/passwd (or a subset of it),
3424 and any binaries or configuration files needed for printing (if required).
3425 The set of files that must be mirrored is operating system dependent.
3431 root directory = /homes/smb
3432 .SS root postexec (S)
3434 This is the same as postexec except that the command is run as
3435 root. This is useful for unmounting filesystems (such as cdroms) after
3436 a connection is closed.
3438 .SS root preexec (S)
3440 This is the same as preexec except that the command is run as
3441 root. This is useful for mounting filesystems (such as cdroms) before
3442 a connection is finalised.
3445 This option affects how clients respond to Samba.
3447 The option sets the "security mode bit" in replies to protocol negotiations
3448 to turn share level security on or off. Clients decide based on this bit
3449 whether (and how) to transfer user and password information to the server.
3451 The default is "security=SHARE", mainly because that was the only
3452 option at one stage.
3454 The alternatives are "security = user" or "security = server".
3456 If your PCs use usernames that are the same as their usernames on the
3457 UNIX machine then you will want to use "security = user". If you
3458 mostly use usernames that don't exist on the UNIX box then use
3461 There is a bug in WfWg that may affect your decision. When in user
3462 level security a WfWg client will totally ignore the password you type
3463 in the "connect drive" dialog box. This makes it very difficult (if
3464 not impossible) to connect to a Samba service as anyone except the
3465 user that you are logged into WfWg as.
3467 If you use "security = server" then Samba will try to validate the
3468 username/password by passing it to another SMB server, such as an NT
3469 box. If this fails it will revert to "security = USER", but note that
3470 if encrypted passwords have been negotiated then Samba cannot revert
3471 back to checking the UNIX password file, it must have a valid
3472 smbpasswd file to check users against. See the documentation
3473 docs/ENCRYPTION.txt for details on how to set this up.
3475 See the "password server" option for more details.
3482 .SS server string (G)
3483 This controls what string will show up in the printer comment box in
3484 print manager and next to the IPC connection in "net view". It can be
3485 any string that you wish to show to your users.
3487 It also sets what will appear in browse lists next to the machine name.
3489 A %v will be replaced with the Samba version number.
3491 A %h will be replaced with the hostname.
3494 server string = Samba %v
3497 server string = University of GNUs Samba Server
3499 .SS set directory (S)
3500 If 'set directory = no', then users of the service may not use the setdir
3501 command to change directory.
3503 The setdir command is only implemented in the Digital Pathworks client. See the
3504 Pathworks documentation for details.
3512 .SS shared file entries (G)
3513 This parameter has been removed (as of Samba 1.9.18 and above). The new
3514 System V shared memory code prohibits the user from allocating the
3515 share hash bucket size directly.
3517 .SS shared mem size (G)
3518 This parameter is only useful when Samba has been compiled with FAST_SHARE_MODES.
3519 It specifies the size of the shared memory (in bytes) to use between smbd
3520 processes. You should never change this parameter unless you have studied
3521 the source and know what you are doing. This parameter defaults to 1024
3522 multiplied by the setting of the maximum number of open files in the
3523 file local.h in the Samba source code. MAX_OPEN_FILES is normally set
3524 to 100, so this parameter defaults to 102400 bytes.
3527 shared mem size = 102400
3529 .SS smb passwd file (G)
3530 This option sets the path to the encrypted smbpasswd file. This is a *VERY
3531 DANGEROUS OPTION* if the smb.conf is user writable. By default the path
3532 to the smbpasswd file is compiled into Samba.
3535 This sets the full path to the smbrun binary. This defaults to the
3536 value in the Makefile.
3538 You must get this path right for many services to work correctly.
3544 smbrun = /usr/local/samba/bin/smbrun
3548 This enables or disables the honouring of the "share modes" during a
3549 file open. These modes are used by clients to gain exclusive read or
3550 write access to a file.
3552 These open modes are not directly supported by UNIX, so they are
3553 simulated using lock files in the "lock directory". The "lock
3554 directory" specified in smb.conf must be readable by all users.
3556 The share modes that are enabled by this option are DENY_DOS,
3557 DENY_ALL, DENY_READ, DENY_WRITE, DENY_NONE and DENY_FCB.
3559 Enabling this option gives full share compatibility but may cost a bit
3560 of processing time on the UNIX server. They are enabled by default.
3568 .SS short preserve case (S)
3570 This controls if new short filenames are created with the case that
3571 the client passes, or if they are forced to be the "default" case.
3574 short preserve case = no
3576 See the section on "NAME MANGLING" for a fuller discussion.
3578 .SS socket address (G)
3580 This option allows you to control what address Samba will listen for
3581 connections on. This is used to support multiple virtual interfaces on
3582 the one server, each with a different configuration.
3584 By default samba will accept connections on any address.
3587 socket address = 192.168.2.20
3589 .SS socket options (G)
3590 This option (which can also be invoked with the -O command line
3591 option) allows you to set socket options to be used when talking with
3594 Socket options are controls on the networking layer of the operating
3595 systems which allow the connection to be tuned.
3597 This option will typically be used to tune your Samba server for
3598 optimal performance for your local network. There is no way that Samba
3599 can know what the optimal parameters are for your net, so you must
3600 experiment and choose them yourself. I strongly suggest you read the
3601 appropriate documentation for your operating system first (perhaps
3602 "man setsockopt" will help).
3604 You may find that on some systems Samba will say "Unknown socket
3605 option" when you supply an option. This means you either mis-typed it
3606 or you need to add an include file to includes.h for your OS. If the
3607 latter is the case please send the patch to me
3608 (samba-bugs@samba.anu.edu.au).
3610 Any of the supported socket options may be combined in any way you
3611 like, as long as your OS allows it.
3613 This is the list of socket options currently settable using this
3636 Those marked with a * take an integer argument. The others can
3637 optionally take a 1 or 0 argument to enable or disable the option, by
3638 default they will be enabled if you don't specify 1 or 0.
3640 To specify an argument use the syntax SOME_OPTION=VALUE for example
3641 SO_SNDBUF=8192. Note that you must not have any spaces before or after
3644 If you are on a local network then a sensible option might be
3646 socket options = IPTOS_LOWDELAY
3648 If you have an almost unloaded local network and you don't mind a lot
3649 of extra CPU usage in the server then you could try
3651 socket options = IPTOS_LOWDELAY TCP_NODELAY
3653 If you are on a wide area network then perhaps try setting
3656 Note that several of the options may cause your Samba server to fail
3657 completely. Use these options with caution!
3663 socket options = IPTOS_LOWDELAY
3669 This enables or disables logging of connections to a status file that
3675 won't be able to tell you what
3676 connections are active.
3684 .SS strict locking (S)
3685 This is a boolean that controls the handling of file locking in the
3686 server. When this is set to yes the server will check every read and
3687 write access for file locks, and deny access if locks exist. This can
3688 be slow on some systems.
3690 When strict locking is "no" the server does file lock checks only when
3691 the client explicitly asks for them.
3693 Well behaved clients always ask for lock checks when it is important,
3694 so in the vast majority of cases "strict locking = no" is preferable.
3700 strict locking = yes
3703 Many Windows applications (including the Windows 98 explorer
3704 shell) seem to confuse flushing buffer contents to disk with
3705 doing a sync to disk. Under UNIX, a sync call forces the process
3706 to be suspended until the kernel has ensured that all outstanding
3707 data in kernel disk buffers has been safely stored onto stable
3708 storate. This is very slow and should only be done rarely. Setting
3709 this parameter to "no" (the default) means that smbd ignores the
3710 Windows applications requests for a sync call. There is only a
3711 possibility of losing data if the operating system itself that
3712 Samba is running on crashes, so there is little danger in this
3713 default setting. In addition, this fixes many performace problems
3714 that people have reported with the new Windows98 explorer shell
3717 See also the "sync always" parameter.
3727 This is a boolean that controls whether to strip trailing dots off
3728 UNIX filenames. This helps with some CDROMs that have filenames ending in a
3738 This parameter maps how Samba debug messages are logged onto the
3739 system syslog logging levels. Samba debug level zero maps onto
3740 syslog LOG_ERR, debug level one maps onto LOG_WARNING, debug
3741 level two maps to LOG_NOTICE, debug level three maps onto LOG_INFO.
3742 The paramter sets the threshold for doing the mapping, all Samba
3743 debug messages above this threashold are mapped to syslog LOG_DEBUG
3751 If this parameter is set then Samba debug messages are logged into
3752 the system syslog only, and not to the debug log files.
3759 This is a boolean parameter that controls whether writes will always
3760 be written to stable storage before the write call returns. If this is
3761 false then the server will be guided by the client's request in each
3762 write call (clients can set a bit indicating that a particular write
3763 should be synchronous). If this is true then every write will be
3764 followed by a fsync() call to ensure the data is written to disk.
3765 Note that the "strict sync" parameter must be set to "yes" in
3766 order for this parameter to have any affect.
3768 See also the "strict sync" parameter.
3777 This parameter is a setting in minutes to add to the normal GMT to
3778 local time conversion. This is useful if you are serving a lot of PCs
3779 that have incorrect daylight saving time handling.
3788 This parameter determines if nmbd advertises itself as a time server
3789 to Windows clients. The default is False.
3797 .SS unix password sync (G)
3798 This boolean parameter controlls whether Samba attempts to synchronise
3799 the UNIX password with the SMB password when the encrypted SMB password
3800 in the smbpasswd file is changed. If this is set to true the 'passwd program'
3801 program is called *AS ROOT* - to allow the new UNIX password to be set
3802 without access to the old UNIX password (as the SMB password has change
3803 code has no access to the old password cleartext, only the new). By
3804 default this is set to false.
3806 See also 'passwd program', 'passwd chat'
3809 unix password sync = False
3812 unix password sync = True
3814 .SS unix realname (G)
3815 This boolean parameter when set causes samba to supply the real name field
3816 from the unix password file to the client. This is useful for setting up
3817 mail clients and WWW browsers on systems used by more than one person.
3825 .SS update encrypted (G)
3826 This boolean parameter allows a user logging on with a plaintext
3827 password to have their encrypted (hashed) password in the smbpasswd
3828 file to be updated automatically as they log on. This option allows
3829 a site to migrate from plaintext password authentication (users
3830 authenticate with plaintext password over the wire, and are checked
3831 against a UNIX account database) to encrypted password authentication
3832 (the SMB challenge/response authentication mechanism) without forcing
3833 all users to re-enter their passwords via smbpasswd at the time the change
3834 is made. This is a convenience option to allow the change over to
3835 encrypted passwords to be made over a longer period. Once all users
3836 have encrypted representations of their passwords in the smbpasswd
3837 file this parameter should be set to "off".
3839 In order for this parameter to work correctly the "encrypt passwords"
3840 must be set to "no" when this parameter is set to "yes".
3842 Note that even when this parameter is set a user authenticating to
3843 smbd must still enter a valid password in order to connect correctly,
3844 and to update their hashed (smbpasswd) passwords.
3847 update encrypted = no
3850 update encrypted = yes
3856 A synonym for this parameter is 'user'.
3858 Multiple users may be specified in a comma-delimited list, in which case the
3859 supplied password will be tested against each username in turn (left to right).
3861 The username= line is needed only when the PC is unable to supply its own
3862 username. This is the case for the coreplus protocol or where your
3863 users have different WfWg usernames to UNIX usernames. In both these
3864 cases you may also be better using the \e\eserver\eshare%user syntax
3867 The username= line is not a great solution in many cases as it means Samba
3868 will try to validate the supplied password against each of the
3869 usernames in the username= line in turn. This is slow and a bad idea for
3870 lots of users in case of duplicate passwords. You may get timeouts or
3871 security breaches using this parameter unwisely.
3873 Samba relies on the underlying UNIX security. This parameter does not
3874 restrict who can login, it just offers hints to the Samba server as to
3875 what usernames might correspond to the supplied password. Users can
3876 login as whoever they please and they will be able to do no more
3877 damage than if they started a telnet session. The daemon runs as the
3878 user that they log in as, so they cannot do anything that user cannot
3881 To restrict a service to a particular set of users you can use the
3882 "valid users=" line.
3884 If any of the usernames begin with a @ then the name will be looked up
3885 first in the yp netgroups list (if Samba is compiled with netgroup support),
3886 followed by a lookup in the UNIX groups database and will expand to a list of
3887 all users in the group of that name.
3889 If any of the usernames begin with a + then the name will be looked up only
3890 in the UNIX groups database and will expand to a list of all users in the
3893 If any of the usernames begin with a & then the name will be looked up only
3894 in the yp netgroups database (if Samba is compiled with netgroup support) and
3895 will expand to a list of all users in the netgroup group of that name.
3897 Note that searching though a groups database can take quite
3898 some time, and some clients may time out during the search.
3900 See the section below on username/password validation for more information
3901 on how this parameter determines access to the services.
3904 The guest account if a guest service, else the name of the service.
3908 username = fred, mary, jack, jane, @users, @pcgroup
3910 .SS username level (G)
3912 This option helps Samba to try and 'guess' at the real UNIX username,
3913 as many DOS clients send an all-uppercase username. By default Samba
3914 tries all lowercase, followed by the username with the first letter
3915 capitalized, and fails if the username is not found on the UNIX machine.
3917 If this parameter is set to non-zero the behaviour changes. This
3918 parameter is a number that specifies the number of uppercase combinations
3919 to try whilst trying to determine the UNIX user name. The higher the number
3920 the more combinations will be tried, but the slower the discovery
3921 of usernames will be. Use this parameter when you have strange
3922 usernames on your UNIX machine, such as 'AstrangeUser'.
3930 .SS username map (G)
3932 This option allows you to to specify a file containing a mapping of
3933 usernames from the clients to the server. This can be used for several
3934 purposes. The most common is to map usernames that users use on DOS or
3935 Windows machines to those that the UNIX box uses. The other is to map
3936 multiple users to a single username so that they can more easily share
3939 The map file is parsed line by line. Each line should contain a single
3940 UNIX username on the left then a '=' followed by a list of usernames
3941 on the right. The list of usernames on the right may contain names of
3942 the form @group in which case they will match any UNIX username in
3943 that group. The special client name '*' is a wildcard and matches any
3944 name. Each line of the map file may be up to 1023 characters long.
3946 The file is processed on each line by taking the supplied username and
3947 comparing it with each username on the right hand side of the '='
3948 signs. If the supplied name matches any of the names on the right
3949 hand side then it is replaced with the name on the left. Processing
3950 then continues with the next line.
3952 If any line begins with a '#' or a ';' then it is ignored
3954 If any line begins with an ! then the processing will stop after that
3955 line if a mapping was done by the line. Otherwise mapping continues
3956 with every line being processed. Using ! is most useful when you have
3957 a wildcard mapping line later in the file.
3959 For example to map from the name "admin" or "administrator" to the UNIX
3960 name "root" you would use
3962 root = admin administrator
3964 Or to map anyone in the UNIX group "system" to the UNIX name "sys" you
3969 You can have as many mappings as you like in a username map file.
3971 If Samba has been compiled with the -DNETGROUP compile option
3972 then the netgroup database is checked before the /etc/group
3973 database for matching groups.
3975 You can map Windows usernames that have spaces in them by using double
3976 quotes around the name. For example:
3978 tridge = "Andrew Tridgell"
3980 would map the windows username "Andrew Tridgell" to the unix username
3983 The following example would map mary and fred to the unix user sys,
3984 and map the rest to guest. Note the use of the ! to tell Samba to stop
3985 processing if it gets a match on that line.
3991 Note that the remapping is applied to all occurrences of
3992 usernames. Thus if you connect to "\e\eserver\efred" and "fred" is
3993 remapped to "mary" then you will actually be connecting to
3994 "\e\eserver\emary" and will need to supply a password suitable for
3995 "mary" not "fred". The only exception to this is the username passed
3996 to the "password server" (if you have one). The password server will
3997 receive whatever username the client supplies without modification.
3999 Also note that no reverse mapping is done. The main effect this has is
4000 with printing. Users who have been mapped may have trouble deleting
4001 print jobs as PrintManager under WfWg will think they don't own the
4008 username map = /usr/local/samba/lib/users.map
4012 The option allows you to specify additional characters that should be
4013 considered valid by the server in filenames. This is particularly
4014 useful for national character sets, such as adding u-umlaut or a-ring.
4016 The option takes a list of characters in either integer or character
4017 form with spaces between them. If you give two characters with a colon
4018 between them then it will be taken as an lowercase:uppercase pair.
4020 If you have an editor capable of entering the characters into the
4021 config file then it is probably easiest to use this method. Otherwise
4022 you can specify the characters in octal, decimal or hexadecimal form
4023 using the usual C notation.
4025 For example to add the single character 'Z' to the charset (which is a
4026 pointless thing to do as it's already there) you could do one of the
4031 valid chars = 0132:0172
4033 The last two examples above actually add two characters, and alter
4034 the uppercase and lowercase mappings appropriately.
4036 Note that you MUST specify this parameter after the "client code page"
4037 parameter if you have both set. If "client code page" is set after
4038 the "valid chars" parameter the "valid chars" settings will be
4041 See also the "client code page" parameter.
4045 Samba defaults to using a reasonable set of valid characters
4050 valid chars = 0345:0305 0366:0326 0344:0304
4052 The above example allows filenames to have the swedish characters in
4055 NOTE: It is actually quite difficult to correctly produce a "valid
4056 chars" line for a particular system. To automate the process
4057 tino@augsburg.net has written a package called "validchars" which will
4058 automatically produce a complete "valid chars" line for a given client
4059 system. Look in the examples subdirectory for this package.
4062 This is a list of users that should be allowed to login to this
4063 service. A name starting with @ is interpreted as a UNIX group.
4065 If this is empty (the default) then any user can login. If a username
4066 is in both this list and the "invalid users" list then access is
4067 denied for that user.
4069 The current servicename is substituted for %S. This is useful in the
4072 See also "invalid users"
4075 No valid users list. (anyone can login)
4078 valid users = greg, @pcusers
4082 This is a list of files and directories that are neither visible nor
4083 accessible. Each entry in the list must be separated by a "/", which
4084 allows spaces to be included in the entry. '*' and '?' can be used to
4085 specify multiple files or directories as in DOS wildcards.
4087 Each entry must be a unix path, not a DOS path and must not include the
4088 unix directory separator "/".
4090 Note that the case sensitivity option is applicable in vetoing files.
4092 One feature of the veto files parameter that it is important to be
4093 aware of, is that if a directory contains nothing but files that
4094 match the veto files parameter (which means that Windows/DOS clients
4095 cannot ever see them) is deleted, the veto files within that directory
4096 *are automatically deleted* along with it, if the user has UNIX permissions
4099 Setting this parameter will affect the performance of Samba, as
4100 it will be forced to check all files and directories for a match
4101 as they are scanned.
4103 See also "hide files" and "case sensitive"
4106 No files or directories are vetoed.
4110 Veto any files containing the word Security,
4111 any ending in .tmp, and any directory containing the
4114 veto files = /*Security*/*.tmp/*root*/
4117 Veto the Apple specific files that a NetAtalk server
4120 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
4122 .SS veto oplock files (S)
4123 This parameter is only valid when the 'oplocks' parameter is turned on
4124 for a share. It allows the Samba administrator to selectively turn off
4125 the granting of oplocks on selected files that match a wildcarded list,
4126 similar to the wildcarded list used in the 'veto files' parameter.
4129 No files are vetoed for oplock grants.
4132 You might want to do this on files that you know will be heavily
4133 contended for by clients. A good example of this is in the NetBench
4134 SMB benchmark program, which causes heavy client contention for files
4135 ending in .SEM. To cause Samba not to grant oplocks on these files
4136 you would use the line (either in the [global] section or in the section
4137 for the particular NetBench share :
4139 veto oplock files = /*.SEM/
4142 This allows you to override the volume label returned for a
4143 share. Useful for CDROMs with installation programs that insist on a
4144 particular volume label.
4146 The default is the name of the share
4149 This parameter controls whether or not links in the UNIX file system may be
4150 followed by the server. Links that point to areas within the directory tree
4151 exported by the server are always allowed; this parameter controls access
4152 only to areas that are outside the directory tree being exported.
4162 This is a boolean that controls if nmbd will respond to broadcast name
4163 queries on behalf of other hosts. You may need to set this to no for
4170 This specifies the DNS name (or IP address) of the WINS server that Samba
4171 should register with. If you have a WINS server on your network then you
4172 should set this to the WINS servers name.
4174 You should point this at your WINS server if you have a multi-subnetted
4179 .SS wins support (G)
4181 This boolean controls if the nmbd process in Samba will act as a WINS server.
4182 You should not set this to true unless you have a multi-subnetted network and
4183 you wish a particular nmbd to be your WINS server. Note that you
4184 should *NEVER* set this to true on more than one machine in your
4192 This controls what workgroup your server will appear to be in when
4202 A synonym for this parameter is 'write ok'. An inverted synonym is 'read only'.
4204 If this parameter is 'no', then users of a service may not create or modify
4205 files in the service's directory.
4207 Note that a printable service ('printable = yes') will ALWAYS allow
4208 writing to the directory (user privileges permitting), but only via
4209 spooling operations.
4219 This is a list of users that are given read-write access to a
4220 service. If the connecting user is in this list then they will be
4221 given write access, no matter what the "read only" option is set
4222 to. The list can include group names using the @group syntax.
4224 Note that if a user is in both the read list and the write list then
4225 they will be given write access.
4227 See also the "read list" option
4233 write list = admin, root, @staff
4241 This parameter controls whether or not the server will support raw writes when
4242 transferring data from clients.
4250 .SH NOTE ABOUT USERNAME/PASSWORD VALIDATION
4251 There are a number of ways in which a user can connect to a
4252 service. The server follows the following steps in determining if it
4253 will allow a connection to a specified service. If all the steps fail
4254 then the connection request is rejected. If one of the steps pass then
4255 the following steps are not checked.
4257 If the service is marked "guest only = yes" then steps 1 to 5 are skipped
4259 Step 1: If the client has passed a username/password pair and that
4260 username/password pair is validated by the UNIX system's password
4261 programs then the connection is made as that username. Note that this
4262 includes the \e\eserver\eservice%username method of passing a username.
4264 Step 2: If the client has previously registered a username with the
4265 system and now supplies a correct password for that username then the
4266 connection is allowed.
4268 Step 3: The client's netbios name and any previously used user names
4269 are checked against the supplied password, if they match then the
4270 connection is allowed as the corresponding user.
4272 Step 4: If the client has previously validated a username/password
4273 pair with the server and the client has passed the validation token
4274 then that username is used. This step is skipped if "revalidate = yes"
4277 Step 5: If a "user = " field is given in the smb.conf file for the
4278 service and the client has supplied a password, and that password
4279 matches (according to the UNIX system's password checking) with one of
4280 the usernames from the user= field then the connection is made as the
4281 username in the "user=" line. If one of the username in the user= list
4282 begins with a @ then that name expands to a list of names in the group
4285 Step 6: If the service is a guest service then a connection is made as
4286 the username given in the "guest account =" for the service,
4287 irrespective of the supplied password.
4289 Although the configuration file permits service names to contain spaces,
4290 your client software may not. Spaces will be ignored in comparisons anyway,
4291 so it shouldn't be a problem - but be aware of the possibility.
4293 On a similar note, many clients - especially DOS clients - limit service
4294 names to eight characters. Smbd has no such limitation, but attempts
4295 to connect from such clients will fail if they truncate the service names.
4296 For this reason you should probably keep your service names down to eight
4297 characters in length.
4299 Use of the [homes] and [printers] special sections make life for an
4300 administrator easy, but the various combinations of default attributes can be
4301 tricky. Take extreme care when designing these sections. In particular,
4302 ensure that the permissions on spool directories are correct.
4304 This man page is (mostly) correct for version 1.9.18 of the Samba suite, plus some
4305 of the recent patches to it. These notes will necessarily lag behind
4306 development of the software, so it is possible that your version of
4307 the server has extensions or parameter semantics that differ from or are not
4308 covered by this man page. Please notify these to the address below for
4311 Prior to version 1.5.21 of the Samba suite, the configuration file was
4312 radically different (more primitive). If you are using a version earlier than
4313 1.8.05, it is STRONGLY recommended that you upgrade.
4318 .SH ENVIRONMENT VARIABLES
4327 .BR hosts_access (5)
4329 [This section under construction]
4331 Most diagnostics issued by the server are logged in a specified log file. The
4332 log file name is specified at compile time, but may be overridden on the
4333 smbd command line (see
4336 The number and nature of diagnostics available depends on the debug level used
4337 by the server. If you have problems, set the debug level to 3 and peruse the
4340 Most messages are reasonably self-explanatory. Unfortunately, at time of
4341 creation of this man page the source code is still too fluid to warrant
4342 describing each and every diagnostic. At this stage your best bet is still
4343 to grep the source code and inspect the conditions that gave rise to the
4344 diagnostics you are seeing.
4348 Please send bug reports, comments and so on to:
4351 .B samba-bugs@samba.anu.edu.au (Andrew Tridgell)
4354 or to the mailing list:
4357 .B samba@listproc.anu.edu.au
4360 You may also like to subscribe to the announcement channel:
4363 .B samba-announce@listproc.anu.edu.au
4366 To subscribe to these lists send a message to
4367 listproc@listproc.anu.edu.au with a body of "subscribe samba Your
4368 Name" or "subscribe samba-announce Your Name".
4370 Errors or suggestions for improvements to the Samba man pages should be
4374 .B samba-bugs@samba.anu.edu.au (Andrew Tridgell)