1 .TH "smb\&.conf " "5" "23 Oct 1998" "Samba" "SAMBA"
4 smb\&.conf \- The configuration file for the Samba suite
8 \fBsmb\&.conf\fP The \fBsmb\&.conf\fP file is a configuration file for the
9 Samba suite\&. \fBsmb\&.conf\fP contains runtime configuration information
10 for the Samba programs\&. The \fBsmb\&.conf\fP file is designed to be
11 configured and administered by the \fBswat (8)\fP
12 program\&. The complete description of the file format and possible
13 parameters held within are here for reference purposes\&.
17 The file consists of sections and parameters\&. A section begins with
18 the name of the section in square brackets and continues until the
19 next section begins\&. Sections contain parameters of the form
21 \f(CW\'name = value\'\fP
23 The file is line-based - that is, each newline-terminated line
24 represents either a comment, a section name or a parameter\&.
26 Section and parameter names are not case sensitive\&.
28 Only the first equals sign in a parameter is significant\&. Whitespace
29 before or after the first equals sign is discarded\&. Leading, trailing
30 and internal whitespace in section and parameter names is
31 irrelevant\&. Leading and trailing whitespace in a parameter value is
32 discarded\&. Internal whitespace within a parameter value is retained
35 Any line beginning with a semicolon (\';\') or a hash (\'#\') character is
36 ignored, as are lines containing only whitespace\&.
38 Any line ending in a \f(CW\'\e\'\fP is "continued" on the next line in the
39 customary UNIX fashion\&.
41 The values following the equals sign in parameters are all either a
42 string (no quotes needed) or a boolean, which may be given as yes/no,
43 0/1 or true/false\&. Case is not significant in boolean values, but is
44 preserved in string values\&. Some items such as create modes are
47 .SH "SECTION DESCRIPTIONS"
49 Each section in the configuration file (except for the
50 \fB[global]\fP section) describes a shared resource (known
51 as a \fI"share"\fP)\&. The section name is the name of the shared resource
52 and the parameters within the section define the shares attributes\&.
54 There are three special sections, \fB[global]\fP,
55 \fB[homes]\fP and \fB[printers]\fP, which are
56 described under \fB\'special sections\'\fP\&. The
57 following notes apply to ordinary section descriptions\&.
59 A share consists of a directory to which access is being given plus
60 a description of the access rights which are granted to the user of
61 the service\&. Some housekeeping options are also specifiable\&.
63 Sections are either filespace services (used by the client as an
64 extension of their native file systems) or printable services (used by
65 the client to access print services on the host running the server)\&.
67 Sections may be designated \fBguest\fP services, in which
68 case no password is required to access them\&. A specified UNIX
69 \fBguest account\fP is used to define access
70 privileges in this case\&.
72 Sections other than guest services will require a password to access
73 them\&. The client provides the username\&. As older clients only provide
74 passwords and not usernames, you may specify a list of usernames to
75 check against the password using the \fB"user="\fP option in
76 the share definition\&. For modern clients such as Windows 95/98 and
77 Windows NT, this should not be necessary\&.
79 Note that the access rights granted by the server are masked by the
80 access rights granted to the specified or guest UNIX user by the host
81 system\&. The server does not grant more access than the host system
84 The following sample section defines a file space share\&. The user has
85 write access to the path \f(CW/home/bar\fP\&. The share is accessed via
102 The following sample section defines a printable share\&. The share
103 is readonly, but printable\&. That is, the only write access permitted
104 is via calls to open, write to and close a spool file\&. The
105 \fB\'guest ok\'\fP parameter means access will be permitted
106 as the default guest user (specified elsewhere):
113 path = /usr/spool/public
122 .SH "SPECIAL SECTIONS"
125 .IP "\fBThe [global] section\fP"
127 Parameters in this section apply to the server as a whole, or are
128 defaults for sections which do not specifically define certain
129 items\&. See the notes under \fB\'PARAMETERS\'\fP for more
132 .IP "\fBThe [homes] section\fP"
134 If a section called \f(CW\'homes\'\fP is included in the configuration file,
135 services connecting clients to their home directories can be created
136 on the fly by the server\&.
138 When the connection request is made, the existing sections are
139 scanned\&. If a match is found, it is used\&. If no match is found, the
140 requested section name is treated as a user name and looked up in the
141 local password file\&. If the name exists and the correct password has
142 been given, a share is created by cloning the [homes] section\&.
144 Some modifications are then made to the newly created share:
148 The share name is changed from \f(CW\'homes\'\fP to the located
152 If no path was given, the path is set to the user\'s home
156 If you decide to use a \fBpath=\fP line in your [homes]
157 section then you may find it useful to use the \fB%S\fP
158 macro\&. For example :
160 \f(CWpath=/data/pchome/%S\fP
162 would be useful if you have different home directories for your PCs
163 than for UNIX access\&.
165 This is a fast and simple way to give a large number of clients access
166 to their home directories with a minimum of fuss\&.
168 A similar process occurs if the requested section name is \f(CW"homes"\fP,
169 except that the share name is not changed to that of the requesting
170 user\&. This method of using the [homes] section works well if different
171 users share a client PC\&.
173 The [homes] section can specify all the parameters a normal service
174 section can specify, though some make more sense than others\&. The
175 following is a typical and suitable [homes] section:
188 An important point is that if guest access is specified in the [homes]
189 section, all home directories will be visible to all clients
190 \fBwithout a password\fP\&. In the very unlikely event that this is
191 actually desirable, it would be wise to also specify \fBread only
194 Note that the \fBbrowseable\fP flag for auto home
195 directories will be inherited from the global browseable flag, not the
196 [homes] browseable flag\&. This is useful as it means setting
197 browseable=no in the [homes] section will hide the [homes] share but
198 make any auto home directories visible\&.
200 .IP "\fBThe [printers] section\fP"
202 This section works like \fB[homes]\fP, but for printers\&.
204 If a [printers] section occurs in the configuration file, users are
205 able to connect to any printer specified in the local host\'s printcap
208 When a connection request is made, the existing sections are
209 scanned\&. If a match is found, it is used\&. If no match is found, but a
210 \fB[homes]\fP section exists, it is used as described
211 above\&. Otherwise, the requested section name is treated as a printer
212 name and the appropriate printcap file is scanned to see if the
213 requested section name is a valid printer share name\&. If a match is
214 found, a new printer share is created by cloning the [printers]
217 A few modifications are then made to the newly created share:
221 The share name is set to the located printer name
224 If no printer name was given, the printer name is set to the
228 If the share does not permit guest access and no username was
229 given, the username is set to the located printer name\&.
232 Note that the [printers] service MUST be printable - if you specify
233 otherwise, the server will refuse to load the configuration file\&.
235 Typically the path specified would be that of a world-writeable spool
236 directory with the sticky bit set on it\&. A typical [printers] entry
237 would look like this:
244 path = /usr/spool/public
253 All aliases given for a printer in the printcap file are legitimate
254 printer names as far as the server is concerned\&. If your printing
255 subsystem doesn\'t work like that, you will have to set up a
256 pseudo-printcap\&. This is a file consisting of one or more lines like
262 alias|alias|alias|alias\&.\&.\&.
267 Each alias should be an acceptable printer name for your printing
268 subsystem\&. In the \fB[global]\fP section, specify the new
269 file as your printcap\&. The server will then only recognize names
270 found in your pseudo-printcap, which of course can contain whatever
271 aliases you like\&. The same technique could be used simply to limit
272 access to a subset of your local printers\&.
274 An alias, by the way, is defined as any component of the first entry
275 of a printcap record\&. Records are separated by newlines, components
276 (if there are more than one) are separated by vertical bar symbols
279 NOTE: On SYSV systems which use lpstat to determine what printers are
280 defined on the system you may be able to use \fB"printcap name =
281 lpstat"\fP to automatically obtain a list of
282 printers\&. See the \fB"printcap name"\fP option for
288 Parameters define the specific attributes of sections\&.
290 Some parameters are specific to the \fB[global]\fP section
291 (e\&.g\&., \fBsecurity\fP)\&. Some parameters are usable in
292 all sections (e\&.g\&., \fBcreate mode\fP)\&. All others are
293 permissible only in normal sections\&. For the purposes of the following
294 descriptions the \fB[homes]\fP and
295 \fB[printers]\fP sections will be considered normal\&.
296 The letter \f(CW\'G\'\fP in parentheses indicates that a parameter is
297 specific to the \fB[global]\fP section\&. The letter \f(CW\'S\'\fP
298 indicates that a parameter can be specified in a service specific
299 section\&. Note that all \f(CW\'S\'\fP parameters can also be specified in the
300 \fB[global]\fP section - in which case they will define
301 the default behavior for all services\&.
303 Parameters are arranged here in alphabetical order - this may not
304 create best bedfellows, but at least you can find them! Where there
305 are synonyms, the preferred synonym is described, others refer to the
308 .SH "VARIABLE SUBSTITUTIONS"
310 Many of the strings that are settable in the config file can take
311 substitutions\&. For example the option \fB\f(CW"path =
312 /tmp/%u"\fP\fP would be interpreted as \f(CW"path = /tmp/john"\fP if
313 the user connected with the username john\&.
315 These substitutions are mostly noted in the descriptions below, but
316 there are some general substitutions which apply whenever they might
317 be relevant\&. These are:
321 \fB%S\fP = the name of the current service, if any\&.
324 \fB%P\fP = the root directory of the current service, if any\&.
327 \fB%u\fP = user name of the current service, if any\&.
330 \fB%g\fP = primary group name of \fB%u\fP\&.
333 \fB%U\fP = session user name (the user name that
334 the client wanted, not necessarily the same as the one they got)\&.
337 \fB%G\fP = primary group name of \fB%U\fP\&.
340 \fB%H\fP = the home directory of the user given by \fB%u\fP\&.
343 \fB%v\fP = the Samba version\&.
346 \fB%h\fP = the internet hostname that Samba is running on\&.
349 \fB%m\fP = the NetBIOS name of the client machine (very useful)\&.
352 \fB%L\fP = the NetBIOS name of the server\&. This allows you to change your
353 config based on what the client calls you\&. Your server can have a "dual
357 \fB%M\fP = the internet name of the client machine\&.
360 \fB%N\fP = the name of your NIS home directory server\&. This is
361 obtained from your NIS auto\&.map entry\&. If you have not compiled Samba
362 with the \fB--with-automount\fP option then this value will be the same
366 \fB%p\fP = the path of the service\'s home directory, obtained from your NIS
367 auto\&.map entry\&. The NIS auto\&.map entry is split up as "%N:%p"\&.
370 \fB%R\fP = the selected protocol level after protocol
371 negotiation\&. It can be one of CORE, COREPLUS, LANMAN1, LANMAN2 or NT1\&.
374 \fB%d\fP = The process id of the current server process\&.
377 \fB%a\fP = the architecture of the remote
378 machine\&. Only some are recognized, and those may not be 100%
379 reliable\&. It currently recognizes Samba, WfWg, WinNT and
380 Win95\&. Anything else will be known as "UNKNOWN"\&. If it gets it wrong
381 then sending a level 3 log to \fIsamba-bugs@samba\&.anu\&.edu\&.au\fP
382 should allow it to be fixed\&.
385 \fB%I\fP = The IP address of the client machine\&.
388 \fB%T\fP = the current date and time\&.
391 There are some quite creative things that can be done with these
392 substitutions and other smb\&.conf options\&.
396 Samba supports \fI"name mangling"\fP so that DOS and Windows clients can
397 use files that don\'t conform to the 8\&.3 format\&. It can also be set to
398 adjust the case of 8\&.3 format filenames\&.
400 There are several options that control the way mangling is performed,
401 and they are grouped here rather than listed separately\&. For the
402 defaults look at the output of the testparm program\&.
404 All of these options can be set separately for each service (or
405 globally, of course)\&.
409 \fB"mangle case = yes/no"\fP controls if names that have characters that
410 aren\'t of the "default" case are mangled\&. For example, if this is yes
411 then a name like \f(CW"Mail"\fP would be mangled\&. Default \fIno\fP\&.
413 \fB"case sensitive = yes/no"\fP controls whether filenames are case
414 sensitive\&. If they aren\'t then Samba must do a filename search and
415 match on passed names\&. Default \fIno\fP\&.
417 \fB"default case = upper/lower"\fP controls what the default case is for new
418 filenames\&. Default \fIlower\fP\&.
420 \fB"preserve case = yes/no"\fP controls if new files are created with the
421 case that the client passes, or if they are forced to be the \f(CW"default"\fP
422 case\&. Default \fIYes\fP\&.
425 \fB"short preserve case = yes/no"\fP controls if new files which conform
426 to 8\&.3 syntax, that is all in upper case and of suitable length, are
427 created upper case, or if they are forced to be the \f(CW"default"\fP
428 case\&. This option can be use with \fB"preserve case =
429 yes"\fP to permit long filenames to retain their
430 case, while short names are lowered\&. Default \fIYes\fP\&.
432 By default, Samba 2\&.0 has the same semantics as a Windows NT
433 server, in that it is case insensitive but case preserving\&.
435 .SH "NOTE ABOUT USERNAME/PASSWORD VALIDATION"
437 There are a number of ways in which a user can connect to a
438 service\&. The server follows the following steps in determining if it
439 will allow a connection to a specified service\&. If all the steps fail
440 then the connection request is rejected\&. If one of the steps pass then
441 the following steps are not checked\&.
443 If the service is marked \fB"guest only = yes"\fP then
444 steps 1 to 5 are skipped\&.
448 Step 1: If the client has passed a username/password pair and
449 that username/password pair is validated by the UNIX system\'s password
450 programs then the connection is made as that username\&. Note that this
451 includes the \f(CW\e\eserver\eservice%username\fP method of passing a
455 Step 2: If the client has previously registered a username with
456 the system and now supplies a correct password for that username then
457 the connection is allowed\&.
460 Step 3: The client\'s netbios name and any previously used user
461 names are checked against the supplied password, if they match then
462 the connection is allowed as the corresponding user\&.
465 Step 4: If the client has previously validated a
466 username/password pair with the server and the client has passed the
467 validation token then that username is used\&. This step is skipped if
468 \fB"revalidate = yes"\fP for this service\&.
471 Step 5: If a \fB"user = "\fP field is given in the
472 smb\&.conf file for the service and the client has supplied a password,
473 and that password matches (according to the UNIX system\'s password
474 checking) with one of the usernames from the \fBuser=\fP
475 field then the connection is made as the username in the
476 \fB"user="\fP line\&. If one of the username in the
477 \fBuser=\fP list begins with a \f(CW\'@\'\fP then that name
478 expands to a list of names in the group of the same name\&.
481 Step 6: If the service is a guest service then a connection is
482 made as the username given in the \fB"guest account
483 ="\fP for the service, irrespective of the supplied
487 .SH "COMPLETE LIST OF GLOBAL PARAMETERS"
489 Here is a list of all global parameters\&. See the section of each
490 parameter for details\&. Note that some are synonyms\&.
497 \fBannounce version\fP
503 \fBbind interfaces only\fP
509 \fBchange notify timeout\fP
515 \fBclient code page\fP
527 \fBdebug timestamp\fP
536 \fBdefault service\fP
545 \fBdomain admin group\fP
548 \fBdomain admin users\fP
551 \fBdomain controller\fP
557 \fBdomain guest group\fP
560 \fBdomain guest users\fP
569 \fBencrypt passwords\fP
599 \fBldap root passwd\fP
647 \fBmachine password timeout\fP
677 \fBmessage command\fP
683 \fBname resolve order\fP
686 \fBnetbios aliases\fP
695 \fBnt pipe support\fP
704 \fBole locking compatibility\fP
719 \fBpasswd chat debug\fP
728 \fBpassword server\fP
731 \fBprefered master\fP
734 \fBpreferred master\fP
746 \fBprinter driver file\fP
755 \fBread prediction\fP
764 \fBremote announce\fP
767 \fBremote browse sync\fP
785 \fBshared mem size\fP
788 \fBsmb passwd file\fP
806 \fBssl CA certFile\fP
812 \fBssl client cert\fP
818 \fBssl compatibility\fP
824 \fBssl hosts resign\fP
827 \fBssl require clientcert\fP
830 \fBssl require servercert\fP
833 \fBssl server cert\fP
845 \fBstat cache size\fP
866 \fBunix password sync\fP
872 \fBupdate encrypted\fP
902 .SH "COMPLETE LIST OF SERVICE PARAMETERS"
904 Here is a list of all service parameters\&. See the section of each
905 parameter for details\&. Note that some are synonyms\&.
915 \fBalternate permissions\fP
951 \fBdelete readonly\fP
954 \fBdelete veto files\fP
972 \fBdos filetime resolution\fP
981 \fBfake directory create times\fP
987 \fBfollow symlinks\fP
990 \fBforce create mode\fP
993 \fBforce directory mode\fP
1017 \fBhide dot files\fP
1038 \fBlppause command\fP
1044 \fBlpresume command\fP
1080 \fBmax connections\fP
1083 \fBmin print space\fP
1122 \fBprinter driver\fP
1125 \fBprinter driver location\fP
1137 \fBqueuepause command\fP
1140 \fBqueueresume command\fP
1164 \fBshort preserve case\fP
1170 \fBstrict locking\fP
1194 \fBveto oplock files\fP
1215 .SH "EXPLANATION OF EACH PARAMETER"
1218 .IP "\fBadmin users (S)\fP"
1220 This is a list of users who will be granted administrative privileges
1221 on the share\&. This means that they will do all file operations as the
1222 super-user (root)\&.
1224 You should use this option very carefully, as any user in this list
1225 will be able to do anything they like on the share, irrespective of
1230 \f(CW no admin users\fP
1234 \f(CW admin users = jason\fP
1236 .IP "\fBallow hosts (S)\fP"
1238 A synonym for this parameter is \fB\'hosts allow\'\fP
1240 This parameter is a comma, space, or tab delimited set of hosts which
1241 are permitted to access a service\&.
1243 If specified in the \fB[global]\fP section then it will
1244 apply to all services, regardless of whether the individual service
1245 has a different setting\&.
1247 You can specify the hosts by name or IP number\&. For example, you could
1248 restrict access to only the hosts on a Class C subnet with something
1249 like \f(CW"allow hosts = 150\&.203\&.5\&."\fP\&. The full syntax of the list is
1250 described in the man page \fBhosts_access (5)\fP\&. Note that this man
1251 page may not be present on your system, so a brief description will
1252 be given here also\&.
1254 \fINOTE:\fP IF you wish to allow the \fBsmbpasswd
1255 (8)\fP program to be run by local users to change
1256 their Samba passwords using the local \fBsmbd (8)\fP
1257 daemon, then you \fIMUST\fP ensure that the localhost is listed in your
1258 \fBallow hosts\fP list, as \fBsmbpasswd (8)\fP runs
1259 in client-server mode and is seen by the local
1260 \fBsmbd\fP process as just another client\&.
1262 You can also specify hosts by network/netmask pairs and by netgroup
1263 names if your system supports netgroups\&. The \fIEXCEPT\fP keyword can also
1264 be used to limit a wildcard list\&. The following examples may provide
1267 \fBExample 1\fP: allow localhost and all IPs in 150\&.203\&.*\&.* except one
1269 \f(CW hosts allow = localhost, 150\&.203\&. EXCEPT 150\&.203\&.6\&.66\fP
1271 \fBExample 2\fP: allow localhost and hosts that match the given network/netmask
1273 \f(CW hosts allow = localhost, 150\&.203\&.15\&.0/255\&.255\&.255\&.0\fP
1275 \fBExample 3\fP: allow a localhost plus a couple of hosts
1277 \f(CW hosts allow = localhost, lapland, arvidsjaur\fP
1279 \fBExample 4\fP: allow only hosts in NIS netgroup "foonet" or localhost, but
1280 deny access from one particular host
1282 \f(CW hosts allow = @foonet, localhost\fP
1283 \f(CW hosts deny = pirate\fP
1285 Note that access still requires suitable user-level passwords\&.
1287 See \fBtestparm (1)\fP for a way of testing your
1288 host access to see if it does what you expect\&.
1291 \f(CW none (i\&.e\&., all hosts permitted access)\fP
1294 \f(CW allow hosts = 150\&.203\&.5\&. localhost myhost\&.mynet\&.edu\&.au\fP
1296 .IP "\fBalternate permissions (S)\fP"
1298 This is a deprecated parameter\&. It no longer has any effect in Samba2\&.0\&.
1299 In previous versions of Samba it affected the way the DOS "read only"
1300 attribute was mapped for a file\&. In Samba2\&.0 a file is marked "read only"
1301 if the UNIX file does not have the \'w\' bit set for the owner of the file,
1302 regardless if the owner of the file is the currently logged on user or not\&.
1304 .IP "\fBannounce as (G)\fP"
1306 This specifies what type of server \fBnmbd\fP will
1307 announce itself as, to a network neighborhood browse list\&. By default
1308 this is set to Windows NT\&. The valid options are : "NT", "Win95" or
1309 "WfW" meaning Windows NT, Windows 95 and Windows for Workgroups
1310 respectively\&. Do not change this parameter unless you have a specific
1311 need to stop Samba appearing as an NT server as this may prevent Samba
1312 servers from participating as browser servers correctly\&.
1315 \f(CW announce as = NT\fP
1318 \f(CW announce as = Win95\fP
1320 .IP "\fBannounce version (G)\fP"
1322 This specifies the major and minor version numbers that nmbd will use
1323 when announcing itself as a server\&. The default is 4\&.2\&. Do not change
1324 this parameter unless you have a specific need to set a Samba server
1325 to be a downlevel server\&.
1328 \f(CW announce version = 4\&.2\fP
1331 \f(CW announce version = 2\&.0\fP
1333 .IP "\fBauto services (G)\fP"
1335 This is a list of services that you want to be automatically added to
1336 the browse lists\&. This is most useful for homes and printers services
1337 that would otherwise not be visible\&.
1339 Note that if you just want all printers in your printcap file loaded
1340 then the \fB"load printers"\fP option is easier\&.
1343 \f(CW no auto services\fP
1346 \f(CW auto services = fred lp colorlp\fP
1348 .IP "\fBavailable (S)\fP"
1350 This parameter lets you \fI\'turn off\'\fP a service\&. If \f(CW\'available = no\'\fP,
1351 then \fIALL\fP attempts to connect to the service will fail\&. Such failures
1355 \f(CW available = yes\fP
1358 \f(CW available = no\fP
1360 .IP "\fBbind interfaces only (G)\fP"
1362 This global parameter allows the Samba admin to limit what interfaces
1363 on a machine will serve smb requests\&. If affects file service
1364 \fBsmbd\fP and name service \fBnmbd\fP
1365 in slightly different ways\&.
1367 For name service it causes \fBnmbd\fP to bind to ports
1368 137 and 138 on the interfaces listed in the
1369 \fB\'interfaces\'\fP
1370 parameter\&. \fBnmbd\fP also binds to the \'all
1371 addresses\' interface (0\&.0\&.0\&.0) on ports 137 and 138 for the purposes
1372 of reading broadcast messages\&. If this option is not set then
1373 \fBnmbd\fP will service name requests on all of these
1374 sockets\&. If \fB"bind interfaces only"\fP is set then
1375 \fBnmbd\fP will check the source address of any
1376 packets coming in on the broadcast sockets and discard any that don\'t
1377 match the broadcast addresses of the interfaces in the
1378 \fB\'interfaces\'\fP parameter list\&. As unicast packets
1379 are received on the other sockets it allows \fBnmbd\fP
1380 to refuse to serve names to machines that send packets that arrive
1381 through any interfaces not listed in the
1382 \fB"interfaces"\fP list\&. IP Source address spoofing
1383 does defeat this simple check, however so it must not be used
1384 seriously as a security feature for \fBnmbd\fP\&.
1386 For file service it causes \fBsmbd\fP to bind only to
1387 the interface list given in the \fB\'interfaces\'\fP
1388 parameter\&. This restricts the networks that \fBsmbd\fP
1389 will serve to packets coming in those interfaces\&. Note that you
1390 should not use this parameter for machines that are serving PPP or
1391 other intermittent or non-broadcast network interfaces as it will not
1392 cope with non-permanent interfaces\&.
1394 In addition, to change a users SMB password, the
1395 \fBsmbpasswd\fP by default connects to the
1396 \fI"localhost" - 127\&.0\&.0\&.1\fP address as an SMB client to issue the
1397 password change request\&. If \fB"bind interfaces only"\fP is set then
1398 unless the network address \fI127\&.0\&.0\&.1\fP is added to the
1399 \fB\'interfaces\'\fP parameter list then
1400 \fBsmbpasswd\fP will fail to connect in it\'s
1401 default mode\&. \fBsmbpasswd\fP can be forced to
1402 use the primary IP interface of the local host by using its
1403 \fB"-r remote machine"\fP parameter, with
1404 \fB"remote machine"\fP set to the IP name of the primary interface
1405 of the local host\&.
1408 \f(CW bind interfaces only = False\fP
1411 \f(CW bind interfaces only = True\fP
1413 .IP "\fBblocking locks (S)\fP"
1415 This parameter controls the behavior of \fBsmbd\fP when
1416 given a request by a client to obtain a byte range lock on a region
1417 of an open file, and the request has a time limit associated with it\&.
1419 If this parameter is set and the lock range requested cannot be
1420 immediately satisfied, Samba 2\&.0 will internally queue the lock
1421 request, and periodically attempt to obtain the lock until the
1422 timeout period expires\&.
1424 If this parameter is set to "False", then Samba 2\&.0 will behave
1425 as previous versions of Samba would and will fail the lock
1426 request immediately if the lock range cannot be obtained\&.
1428 This parameter can be set per share\&.
1431 \f(CW blocking locks = True\fP
1434 \f(CW blocking locks = False\fP
1436 .IP "\fBbrowseable (S)\fP"
1438 Synonym for \fBbrowseable\fP\&.
1440 .IP "\fBbrowse list(G)\fP"
1442 This controls whether \fBsmbd\fP will serve a browse
1443 list to a client doing a NetServerEnum call\&. Normally set to true\&. You
1444 should never need to change this\&.
1447 \f(CW browse list = Yes\fP
1449 .IP "\fBbrowseable\fP"
1451 This controls whether this share is seen in the list of available
1452 shares in a net view and in the browse list\&.
1455 \f(CW browseable = Yes\fP
1458 \f(CW browseable = No\fP
1460 .IP "\fBcase sensitive (G)\fP"
1462 See the discussion in the section \fBNAME MANGLING\fP\&.
1464 .IP "\fBcasesignames (G)\fP"
1466 Synonym for \fB"case sensitive"\fP\&.
1468 .IP "\fBchange notify timeout (G)\fP"
1470 One of the new NT SMB requests that Samba 2\&.0 supports is the
1471 "ChangeNotify" requests\&. This SMB allows a client to tell a server to
1472 \fI"watch"\fP a particular directory for any changes and only reply to
1473 the SMB request when a change has occurred\&. Such constant scanning of
1474 a directory is expensive under UNIX, hence an
1475 \fBsmbd\fP daemon only performs such a scan on each
1476 requested directory once every \fBchange notify timeout\fP seconds\&.
1478 \fBchange notify timeout\fP is specified in units of seconds\&.
1481 \f(CW change notify timeout = 60\fP
1484 \f(CW change notify timeout = 300\fP
1486 Would change the scan time to every 5 minutes\&.
1488 .IP "\fBcharacter set (G)\fP"
1490 This allows a smbd to map incoming filenames from a DOS Code page (see
1491 the \fBclient code page\fP parameter) to several
1492 built in UNIX character sets\&. The built in code page translations are:
1496 \fBISO8859-1\fP Western European UNIX character set\&. The parameter
1497 \fBclient code page\fP \fIMUST\fP be set to code
1498 page 850 if the \fBcharacter set\fP parameter is set to iso8859-1
1499 in order for the conversion to the UNIX character set to be done
1503 \fBISO8859-2\fP Eastern European UNIX character set\&. The parameter
1504 \fBclient code page\fP \fIMUST\fP be set to code
1505 page 852 if the \fBcharacter set\fP parameter is set to ISO8859-2
1506 in order for the conversion to the UNIX character set to be done
1510 \fBISO8859-5\fP Russian Cyrillic UNIX character set\&. The parameter
1511 \fBclient code page\fP \fIMUST\fP be set to code
1512 page 866 if the \fBcharacter set\fP parameter is set to ISO8859-2
1513 in order for the conversion to the UNIX character set to be done
1517 \fBKOI8-R\fP Alternate mapping for Russian Cyrillic UNIX
1518 character set\&. The parameter \fBclient code
1519 page\fP \fIMUST\fP be set to code page 866 if the
1520 \fBcharacter set\fP parameter is set to KOI8-R in order for the
1521 conversion to the UNIX character set to be done correctly\&.
1524 \fIBUG\fP\&. These MSDOS code page to UNIX character set mappings should
1525 be dynamic, like the loading of MS DOS code pages, not static\&.
1527 See also \fBclient code page\fP\&. Normally this
1528 parameter is not set, meaning no filename translation is done\&.
1531 \f(CW character set = <empty string>\fP
1534 \f(CW character set = ISO8859-1\fP
1536 .IP "\fBclient code page (G)\fP"
1538 This parameter specifies the DOS code page that the clients accessing
1539 Samba are using\&. To determine what code page a Windows or DOS client
1540 is using, open a DOS command prompt and type the command "chcp"\&. This
1541 will output the code page\&. The default for USA MS-DOS, Windows 95, and
1542 Windows NT releases is code page 437\&. The default for western european
1543 releases of the above operating systems is code page 850\&.
1545 This parameter tells \fBsmbd\fP which of the
1546 \f(CWcodepage\&.XXX\fP files to dynamically load on startup\&. These files,
1547 described more fully in the manual page \fBmake_smbcodepage
1548 (1)\fP, tell \fBsmbd\fP how
1549 to map lower to upper case characters to provide the case insensitivity
1550 of filenames that Windows clients expect\&.
1552 Samba currently ships with the following code page files :
1556 \fBCode Page 437 - MS-DOS Latin US\fP
1559 \fBCode Page 737 - Windows \'95 Greek\fP
1562 \fBCode Page 850 - MS-DOS Latin 1\fP
1565 \fBCode Page 852 - MS-DOS Latin 2\fP
1568 \fBCode Page 861 - MS-DOS Icelandic\fP
1571 \fBCode Page 866 - MS-DOS Cyrillic\fP
1574 \fBCode Page 932 - MS-DOS Japanese SJIS\fP
1577 \fBCode Page 936 - MS-DOS Simplified Chinese\fP
1580 \fBCode Page 949 - MS-DOS Korean Hangul\fP
1583 \fBCode Page 950 - MS-DOS Traditional Chinese\fP
1586 Thus this parameter may have any of the values 437, 737, 850, 852,
1587 861, 932, 936, 949, or 950\&. If you don\'t find the codepage you need,
1588 read the comments in one of the other codepage files and the
1589 \fBmake_smbcodepage (1)\fP man page and
1590 write one\&. Please remember to donate it back to the Samba user
1593 This parameter co-operates with the \fB"valid
1594 chars"\fP parameter in determining what characters are
1595 valid in filenames and how capitalization is done\&. If you set both
1596 this parameter and the \fB"valid chars"\fP parameter
1597 the \fB"client code page"\fP parameter \fIMUST\fP be set before the
1598 \fB"valid chars"\fP parameter in the \fBsmb\&.conf\fP
1599 file\&. The \fB"valid chars"\fP string will then augment
1600 the character settings in the "client code page" parameter\&.
1602 If not set, \fB"client code page"\fP defaults to 850\&.
1604 See also : \fB"valid chars"\fP
1607 \f(CW client code page = 850\fP
1610 \f(CW client code page = 936\fP
1612 .IP "\fBcodingsystem (G)\fP"
1614 This parameter is used to determine how incoming Shift-JIS Japanese
1615 characters are mapped from the incoming \fB"client code
1616 page"\fP used by the client, into file names in the
1617 UNIX filesystem\&. Only useful if \fB"client code
1618 page"\fP is set to 932 (Japanese Shift-JIS)\&.
1624 \fBSJIS\fP Shift-JIS\&. Does no conversion of the incoming filename\&.
1627 \fBJIS8, J8BB, J8BH, J8@B, J8@J, J8@H \fP Convert from incoming
1628 Shift-JIS to eight bit JIS code with different shift-in, shift out
1632 \fBJIS7, J7BB, J7BH, J7@B, J7@J, J7@H \fP Convert from incoming
1633 Shift-JIS to seven bit JIS code with different shift-in, shift out
1637 \fBJUNET, JUBB, JUBH, JU@B, JU@J, JU@H \fP Convert from incoming
1638 Shift-JIS to JUNET code with different shift-in, shift out codes\&.
1641 \fBEUC\fP Convert an incoming Shift-JIS character to EUC code\&.
1644 \fBHEX\fP Convert an incoming Shift-JIS character to a 3 byte hex
1645 representation, i\&.e\&. \f(CW:AB\fP\&.
1648 \fBCAP\fP Convert an incoming Shift-JIS character to the 3 byte hex
1649 representation used by the Columbia AppleTalk Program (CAP),
1650 i\&.e\&. \f(CW:AB\fP\&. This is used for compatibility between Samba and CAP\&.
1653 .IP "\fBcomment (S)\fP"
1655 This is a text field that is seen next to a share when a client does a
1656 queries the server, either via the network neighborhood or via "net
1657 view" to list what shares are available\&.
1659 If you want to set the string that is displayed next to the machine
1660 name then see the server string command\&.
1663 \f(CW No comment string\fP
1666 \f(CW comment = Fred\'s Files\fP
1668 .IP "\fBconfig file (G)\fP"
1670 This allows you to override the config file to use, instead of the
1671 default (usually \fBsmb\&.conf\fP)\&. There is a chicken and egg problem
1672 here as this option is set in the config file!
1674 For this reason, if the name of the config file has changed when the
1675 parameters are loaded then it will reload them from the new config
1678 This option takes the usual substitutions, which can be very useful\&.
1680 If the config file doesn\'t exist then it won\'t be loaded (allowing you
1681 to special case the config files of just a few clients)\&.
1684 \f(CW config file = /usr/local/samba/lib/smb\&.conf\&.%m\fP
1686 .IP "\fBcopy (S)\fP"
1688 This parameter allows you to \fI\'clone\'\fP service entries\&. The specified
1689 service is simply duplicated under the current service\'s name\&. Any
1690 parameters specified in the current section will override those in the
1691 section being copied\&.
1693 This feature lets you set up a \'template\' service and create similar
1694 services easily\&. Note that the service being copied must occur earlier
1695 in the configuration file than the service doing the copying\&.
1701 \f(CW copy = otherservice\fP
1703 .IP "\fBcreate mask (S)\fP"
1705 A synonym for this parameter is \fB\'create mode\'\fP\&.
1707 When a file is created, the necessary permissions are calculated
1708 according to the mapping from DOS modes to UNIX permissions, and the
1709 resulting UNIX mode is then bit-wise \'AND\'ed with this parameter\&.
1710 This parameter may be thought of as a bit-wise MASK for the UNIX modes
1711 of a file\&. Any bit \fI*not*\fP set here will be removed from the modes set
1712 on a file when it is created\&.
1714 The default value of this parameter removes the \'group\' and \'other\'
1715 write and execute bits from the UNIX modes\&.
1717 Following this Samba will bit-wise \'OR\' the UNIX mode created from
1718 this parameter with the value of the "force create mode" parameter
1719 which is set to 000 by default\&.
1721 This parameter does not affect directory modes\&. See the parameter
1722 \fB\'directory mode\'\fP for details\&.
1724 See also the \fB"force create mode"\fP parameter
1725 for forcing particular mode bits to be set on created files\&. See also
1726 the \fB"directory mode"\fP parameter for masking
1727 mode bits on created directories\&.
1730 \f(CW create mask = 0744\fP
1733 \f(CW create mask = 0775\fP
1735 .IP "\fBcreate mode (S)\fP"
1737 This is a synonym for \fBcreate mask\fP\&.
1739 .IP "\fBdeadtime (G)\fP"
1741 The value of the parameter (a decimal integer) represents the number
1742 of minutes of inactivity before a connection is considered dead, and
1743 it is disconnected\&. The deadtime only takes effect if the number of
1744 open files is zero\&.
1746 This is useful to stop a server\'s resources being exhausted by a large
1747 number of inactive connections\&.
1749 Most clients have an auto-reconnect feature when a connection is
1750 broken so in most cases this parameter should be transparent to users\&.
1752 Using this parameter with a timeout of a few minutes is recommended
1755 A deadtime of zero indicates that no auto-disconnection should be
1759 \f(CW deadtime = 0\fP
1762 \f(CW deadtime = 15\fP
1764 .IP "\fBdebug timestamp (G)\fP"
1766 Samba2\&.0 debug log messages are timestamped by default\&. If you are
1767 running at a high \fB"debug level"\fP these timestamps
1768 can be distracting\&. This boolean parameter allows them to be turned
1772 \f(CW debug timestamp = Yes\fP
1775 \f(CW debug timestamp = No\fP
1777 .IP "\fBdebug level (G)\fP"
1779 The value of the parameter (an integer) allows the debug level
1780 (logging level) to be specified in the \fBsmb\&.conf\fP file\&. This is to
1781 give greater flexibility in the configuration of the system\&.
1783 The default will be the debug level specified on the command line
1784 or level zero if none was specified\&.
1787 \f(CW debug level = 3\fP
1789 .IP "\fBdefault (G)\fP"
1791 A synonym for \fBdefault service\fP\&.
1793 .IP "\fBdefault case (S)\fP"
1795 See the section on \fB"NAME MANGLING"\fP\&. Also note
1796 the \fB"short preserve case"\fP parameter\&.
1798 .IP "\fBdefault service (G)\fP"
1800 This parameter specifies the name of a service which will be connected
1801 to if the service actually requested cannot be found\&. Note that the
1802 square brackets are \fINOT\fP given in the parameter value (see example
1805 There is no default value for this parameter\&. If this parameter is not
1806 given, attempting to connect to a nonexistent service results in an
1809 Typically the default service would be a \fBguest ok\fP,
1810 \fBread-only\fP service\&.
1812 Also note that the apparent service name will be changed to equal that
1813 of the requested service, this is very useful as it allows you to use
1814 macros like \fB%S\fP to make a wildcard service\&.
1816 Note also that any \f(CW\'_\'\fP characters in the name of the service used
1817 in the default service will get mapped to a \f(CW\'/\'\fP\&. This allows for
1818 interesting things\&.
1825 default service = pub
1834 .IP "\fBdelete readonly (S)\fP"
1836 This parameter allows readonly files to be deleted\&. This is not
1837 normal DOS semantics, but is allowed by UNIX\&.
1839 This option may be useful for running applications such as rcs, where
1840 UNIX file ownership prevents changing file permissions, and DOS
1841 semantics prevent deletion of a read only file\&.
1844 \f(CW delete readonly = No\fP
1847 \f(CW delete readonly = Yes\fP
1849 .IP "\fBdelete veto files (S)\fP"
1851 This option is used when Samba is attempting to delete a directory
1852 that contains one or more vetoed directories (see the \fB\'veto
1853 files\'\fP option)\&. If this option is set to False (the
1854 default) then if a vetoed directory contains any non-vetoed files or
1855 directories then the directory delete will fail\&. This is usually what
1858 If this option is set to True, then Samba will attempt to recursively
1859 delete any files and directories within the vetoed directory\&. This can
1860 be useful for integration with file serving systems such as \fBNetAtalk\fP,
1861 which create meta-files within directories you might normally veto
1862 DOS/Windows users from seeing (e\&.g\&. \f(CW\&.AppleDouble\fP)
1864 Setting \f(CW\'delete veto files = True\'\fP allows these directories to be
1865 transparently deleted when the parent directory is deleted (so long
1866 as the user has permissions to do so)\&.
1868 See also the \fBveto files\fP parameter\&.
1871 \f(CW delete veto files = False\fP
1874 \f(CW delete veto files = True\fP
1876 .IP "\fBdeny hosts (S)\fP"
1878 The opposite of \fB\'allow hosts\'\fP - hosts listed
1879 here are \fINOT\fP permitted access to services unless the specific
1880 services have their own lists to override this one\&. Where the lists
1881 conflict, the \fB\'allow\'\fP list takes precedence\&.
1884 \f(CW none (i\&.e\&., no hosts specifically excluded)\fP
1887 \f(CW deny hosts = 150\&.203\&.4\&. badhost\&.mynet\&.edu\&.au\fP
1889 .IP "\fBdfree command (G)\fP"
1891 The dfree command setting should only be used on systems where a
1892 problem occurs with the internal disk space calculations\&. This has
1893 been known to happen with Ultrix, but may occur with other operating
1894 systems\&. The symptom that was seen was an error of "Abort Retry
1895 Ignore" at the end of each directory listing\&.
1897 This setting allows the replacement of the internal routines to
1898 calculate the total disk space and amount available with an external
1899 routine\&. The example below gives a possible script that might fulfill
1902 The external program will be passed a single parameter indicating a
1903 directory in the filesystem being queried\&. This will typically consist
1904 of the string \f(CW"\&./"\fP\&. The script should return two integers in
1905 ascii\&. The first should be the total disk space in blocks, and the
1906 second should be the number of available blocks\&. An optional third
1907 return value can give the block size in bytes\&. The default blocksize
1910 Note: Your script should \fINOT\fP be setuid or setgid and should be
1911 owned by (and writeable only by) root!
1914 \f(CW By default internal routines for determining the disk capacity
1915 and remaining space will be used\&.\fP
1918 \f(CW dfree command = /usr/local/samba/bin/dfree\fP
1920 Where the script dfree (which must be made executable) could be:
1927 df $1 | tail -1 | awk \'{print $2" "$4}\'
1933 or perhaps (on Sys V based systems):
1940 /usr/bin/df -k $1 | tail -1 | awk \'{print $3" "$5}\'
1946 Note that you may have to replace the command names with full
1947 path names on some systems\&.
1949 .IP "\fBdirectory (S)\fP"
1951 Synonym for \fBpath\fP\&.
1953 .IP "\fBdirectory mask (S)\fP"
1955 This parameter is the octal modes which are used when converting DOS
1956 modes to UNIX modes when creating UNIX directories\&.
1958 When a directory is created, the necessary permissions are calculated
1959 according to the mapping from DOS modes to UNIX permissions, and the
1960 resulting UNIX mode is then bit-wise \'AND\'ed with this parameter\&.
1961 This parameter may be thought of as a bit-wise MASK for the UNIX modes
1962 of a directory\&. Any bit \fI*not*\fP set here will be removed from the
1963 modes set on a directory when it is created\&.
1965 The default value of this parameter removes the \'group\' and \'other\'
1966 write bits from the UNIX mode, allowing only the user who owns the
1967 directory to modify it\&.
1969 Following this Samba will bit-wise \'OR\' the UNIX mode created from
1970 this parameter with the value of the "force directory mode"
1971 parameter\&. This parameter is set to 000 by default (i\&.e\&. no extra mode
1974 See the \fB"force directory mode"\fP parameter
1975 to cause particular mode bits to always be set on created directories\&.
1977 See also the \fB"create mode"\fP parameter for masking
1978 mode bits on created files\&.
1981 \f(CW directory mask = 0755\fP
1984 \f(CW directory mask = 0775\fP
1986 .IP "\fBdirectory mode (S)\fP"
1988 Synonym for \fBdirectory mask\fP\&.
1990 .IP "\fBdns proxy (G)\fP"
1992 Specifies that \fBnmbd\fP when acting as a WINS
1993 server and finding that a NetBIOS name has not been registered, should
1994 treat the NetBIOS name word-for-word as a DNS name and do a lookup
1995 with the DNS server for that name on behalf of the name-querying
1998 Note that the maximum length for a NetBIOS name is 15 characters, so
1999 the DNS name (or DNS alias) can likewise only be 15 characters,
2002 \fBnmbd\fP spawns a second copy of itself to do the
2003 DNS name lookup requests, as doing a name lookup is a blocking action\&.
2005 See also the parameter \fBwins support\fP\&.
2008 \f(CW dns proxy = yes\fP
2010 \fBdomain admin group (G)\fP
2012 This is an \fBEXPERIMENTAL\fP parameter that is part of the unfinished
2013 Samba NT Domain Controller Code\&. It may be removed in a later release\&.
2014 To work with the latest code builds that may have more support for
2015 Samba NT Domain Controller functionality please subscribe to the
2016 mailing list \fBSamba-ntdom\fP available by sending email to
2017 \fIlistproc@samba\&.anu\&.edu\&.au\fP
2019 .IP "\fBdomain admin users (G)\fP"
2021 This is an \fBEXPERIMENTAL\fP parameter that is part of the unfinished
2022 Samba NT Domain Controller Code\&. It may be removed in a later release\&.
2023 To work with the latest code builds that may have more support for
2024 Samba NT Domain Controller functionality please subscribe to the
2025 mailing list \fBSamba-ntdom\fP available by sending email to
2026 \fIlistproc@samba\&.anu\&.edu\&.au\fP
2028 .IP "\fBdomain controller (G)\fP"
2030 This is a \fBDEPRECATED\fP parameter\&. It is currently not used within
2031 the Samba source and should be removed from all current smb\&.conf
2032 files\&. It is left behind for compatibility reasons\&.
2034 .IP "\fBdomain groups (G)\fP"
2036 This is an \fBEXPERIMENTAL\fP parameter that is part of the unfinished
2037 Samba NT Domain Controller Code\&. It may be removed in a later release\&.
2038 To work with the latest code builds that may have more support for
2039 Samba NT Domain Controller functionality please subscribe to the
2040 mailing list \fBSamba-ntdom\fP available by sending email to
2041 \fIlistproc@samba\&.anu\&.edu\&.au\fP
2043 .IP "\fBdomain guest group (G)\fP"
2045 This is an \fBEXPERIMENTAL\fP parameter that is part of the unfinished
2046 Samba NT Domain Controller Code\&. It may be removed in a later release\&.
2047 To work with the latest code builds that may have more support for
2048 Samba NT Domain Controller functionality please subscribe to the
2049 mailing list \fBSamba-ntdom\fP available by sending email to
2050 \fIlistproc@samba\&.anu\&.edu\&.au\fP
2052 .IP "\fBdomain guest users (G)\fP"
2054 This is an \fBEXPERIMENTAL\fP parameter that is part of the unfinished
2055 Samba NT Domain Controller Code\&. It may be removed in a later release\&.
2056 To work with the latest code builds that may have more support for
2057 Samba NT Domain Controller functionality please subscribe to the
2058 mailing list \fBSamba-ntdom\fP available by sending email to
2059 \fIlistproc@samba\&.anu\&.edu\&.au\fP
2061 .IP "\fBdomain logons (G)\fP"
2063 If set to true, the Samba server will serve Windows 95/98 Domain
2064 logons for the \fBworkgroup\fP it is in\&. For more
2065 details on setting up this feature see the file DOMAINS\&.txt in the
2066 Samba documentation directory \f(CWdocs/\fP shipped with the source code\&.
2068 Note that Win95/98 Domain logons are \fINOT\fP the same as Windows
2069 NT Domain logons\&. NT Domain logons require a Primary Domain Controller
2070 (PDC) for the Domain\&. It is intended that in a future release Samba
2071 will be able to provide this functionality for Windows NT clients
2075 \f(CW domain logons = no\fP
2077 .IP "\fBdomain master (G)\fP"
2079 Tell \fBnmbd\fP to enable WAN-wide browse list
2080 collation\&. Setting this option causes \fBnmbd\fP to
2081 claim a special domain specific NetBIOS name that identifies it as a
2082 domain master browser for its given
2083 \fBworkgroup\fP\&. Local master browsers in the same
2084 \fBworkgroup\fP on broadcast-isolated subnets will give
2085 this \fBnmbd\fP their local browse lists, and then
2086 ask \fBsmbd\fP for a complete copy of the browse list
2087 for the whole wide area network\&. Browser clients will then contact
2088 their local master browser, and will receive the domain-wide browse
2089 list, instead of just the list for their broadcast-isolated subnet\&.
2091 Note that Windows NT Primary Domain Controllers expect to be able to
2092 claim this \fBworkgroup\fP specific special NetBIOS
2093 name that identifies them as domain master browsers for that
2094 \fBworkgroup\fP by default (i\&.e\&. there is no way to
2095 prevent a Windows NT PDC from attempting to do this)\&. This means that
2096 if this parameter is set and \fBnmbd\fP claims the
2097 special name for a \fBworkgroup\fP before a Windows NT
2098 PDC is able to do so then cross subnet browsing will behave strangely
2102 \f(CW domain master = no\fP
2104 .IP "\fBdont descend (S)\fP"
2106 There are certain directories on some systems (e\&.g\&., the \f(CW/proc\fP tree
2107 under Linux) that are either not of interest to clients or are
2108 infinitely deep (recursive)\&. This parameter allows you to specify a
2109 comma-delimited list of directories that the server should always show
2112 Note that Samba can be very fussy about the exact format of the "dont
2113 descend" entries\&. For example you may need \f(CW"\&./proc"\fP instead of
2114 just \f(CW"/proc"\fP\&. Experimentation is the best policy :-)
2117 \f(CW none (i\&.e\&., all directories are OK to descend)\fP
2120 \f(CW dont descend = /proc,/dev\fP
2122 .IP "\fBdos filetime resolution (S)\fP"
2124 Under the DOS and Windows FAT filesystem, the finest granularity on
2125 time resolution is two seconds\&. Setting this parameter for a share
2126 causes Samba to round the reported time down to the nearest two second
2127 boundary when a query call that requires one second resolution is made
2130 This option is mainly used as a compatibility option for Visual C++
2131 when used against Samba shares\&. If oplocks are enabled on a share,
2132 Visual C++ uses two different time reading calls to check if a file
2133 has changed since it was last read\&. One of these calls uses a
2134 one-second granularity, the other uses a two second granularity\&. As
2135 the two second call rounds any odd second down, then if the file has a
2136 timestamp of an odd number of seconds then the two timestamps will not
2137 match and Visual C++ will keep reporting the file has changed\&. Setting
2138 this option causes the two timestamps to match, and Visual C++ is
2142 \f(CW dos filetime resolution = False\fP
2145 \f(CW dos filetime resolution = True\fP
2147 .IP "\fBdos filetimes (S)\fP"
2149 Under DOS and Windows, if a user can write to a file they can change
2150 the timestamp on it\&. Under POSIX semantics, only the owner of the file
2151 or root may change the timestamp\&. By default, Samba runs with POSIX
2152 semantics and refuses to change the timestamp on a file if the user
2153 smbd is acting on behalf of is not the file owner\&. Setting this option
2154 to True allows DOS semantics and smbd will change the file timestamp as
2158 \f(CW dos filetimes = False\fP
2161 \f(CW dos filetimes = True\fP
2163 .IP "\fBencrypt passwords (G)\fP"
2165 This boolean controls whether encrypted passwords will be negotiated
2166 with the client\&. Note that Windows NT 4\&.0 SP3 and above and also
2167 Windows 98 will by default expect encrypted passwords unless a
2168 registry entry is changed\&. To use encrypted passwords in Samba see the
2169 file ENCRYPTION\&.txt in the Samba documentation directory \f(CWdocs/\fP
2170 shipped with the source code\&.
2172 In order for encrypted passwords to work correctly
2173 \fBsmbd\fP must either have access to a local
2174 \fBsmbpasswd (5)\fP file (see the
2175 \fBsmbpasswd (8)\fP program for information on
2176 how to set up and maintain this file), or set the
2177 \fBsecurity=\fP parameter to either
2179 \fB"domain"\fP which causes
2180 \fBsmbd\fP to authenticate against another server\&.
2182 .IP "\fBexec (S)\fP"
2184 This is a synonym for \fBpreexec\fP\&.
2186 .IP "\fBfake directory create times (S)\fP"
2188 NTFS and Windows VFAT file systems keep a create time for all files
2189 and directories\&. This is not the same as the ctime - status change
2190 time - that Unix keeps, so Samba by default reports the earliest of
2191 the various times Unix does keep\&. Setting this parameter for a share
2192 causes Samba to always report midnight 1-1-1980 as the create time for
2195 This option is mainly used as a compatibility option for Visual C++
2196 when used against Samba shares\&. Visual C++ generated makefiles have
2197 the object directory as a dependency for each object file, and a make
2198 rule to create the directory\&. Also, when NMAKE compares timestamps it
2199 uses the creation time when examining a directory\&. Thus the object
2200 directory will be created if it does not exist, but once it does exist
2201 it will always have an earlier timestamp than the object files it
2204 However, Unix time semantics mean that the create time reported by
2205 Samba will be updated whenever a file is created or deleted in the
2206 directory\&. NMAKE therefore finds all object files in the object
2207 directory bar the last one built are out of date compared to the
2208 directory and rebuilds them\&. Enabling this option ensures directories
2209 always predate their contents and an NMAKE build will proceed as
2213 \f(CW fake directory create times = False\fP
2216 \f(CW fake directory create times = True\fP
2218 .IP "\fBfake oplocks (S)\fP"
2220 Oplocks are the way that SMB clients get permission from a server to
2221 locally cache file operations\&. If a server grants an oplock
2222 (opportunistic lock) then the client is free to assume that it is the
2223 only one accessing the file and it will aggressively cache file
2224 data\&. With some oplock types the client may even cache file open/close
2225 operations\&. This can give enormous performance benefits\&.
2227 When you set \f(CW"fake oplocks = yes"\fP \fBsmbd\fP will
2228 always grant oplock requests no matter how many clients are using the
2231 It is generally much better to use the real \fBoplocks\fP
2232 support rather than this parameter\&.
2234 If you enable this option on all read-only shares or shares that you
2235 know will only be accessed from one client at a time such as
2236 physically read-only media like CDROMs, you will see a big performance
2237 improvement on many operations\&. If you enable this option on shares
2238 where multiple clients may be accessing the files read-write at the
2239 same time you can get data corruption\&. Use this option carefully!
2241 This option is disabled by default\&.
2243 .IP "\fBfollow symlinks (S)\fP"
2245 This parameter allows the Samba administrator to stop
2246 \fBsmbd\fP from following symbolic links in a
2247 particular share\&. Setting this parameter to \fI"No"\fP prevents any file
2248 or directory that is a symbolic link from being followed (the user
2249 will get an error)\&. This option is very useful to stop users from
2250 adding a symbolic link to \f(CW/etc/passwd\fP in their home directory for
2251 instance\&. However it will slow filename lookups down slightly\&.
2253 This option is enabled (i\&.e\&. \fBsmbd\fP will follow
2254 symbolic links) by default\&.
2256 .IP "\fBforce create mode (S)\fP"
2258 This parameter specifies a set of UNIX mode bit permissions that will
2259 \fI*always*\fP be set on a file created by Samba\&. This is done by
2260 bitwise \'OR\'ing these bits onto the mode bits of a file that is being
2261 created\&. The default for this parameter is (in octal) 000\&. The modes
2262 in this parameter are bitwise \'OR\'ed onto the file mode after the mask
2263 set in the \fB"create mask"\fP parameter is applied\&.
2265 See also the parameter \fB"create mask"\fP for details
2266 on masking mode bits on created files\&.
2269 \f(CW force create mode = 000\fP
2272 \f(CW force create mode = 0755\fP
2274 would force all created files to have read and execute permissions set
2275 for \'group\' and \'other\' as well as the read/write/execute bits set for
2278 .IP "\fBforce directory mode (S)\fP"
2280 This parameter specifies a set of UNIX mode bit permissions that will
2281 \fI*always*\fP be set on a directory created by Samba\&. This is done by
2282 bitwise \'OR\'ing these bits onto the mode bits of a directory that is
2283 being created\&. The default for this parameter is (in octal) 0000 which
2284 will not add any extra permission bits to a created directory\&. This
2285 operation is done after the mode mask in the parameter
2286 \fB"directory mask"\fP is applied\&.
2288 See also the parameter \fB"directory mask"\fP for
2289 details on masking mode bits on created directories\&.
2292 \f(CW force directory mode = 000\fP
2295 \f(CW force directory mode = 0755\fP
2297 would force all created directories to have read and execute
2298 permissions set for \'group\' and \'other\' as well as the
2299 read/write/execute bits set for the \'user\'\&.
2301 .IP "\fBforce group (S)\fP"
2303 This specifies a UNIX group name that will be assigned as the default
2304 primary group for all users connecting to this service\&. This is useful
2305 for sharing files by ensuring that all access to files on service will
2306 use the named group for their permissions checking\&. Thus, by assigning
2307 permissions for this group to the files and directories within this
2308 service the Samba administrator can restrict or allow sharing of these
2312 \f(CW no forced group\fP
2315 \f(CW force group = agroup\fP
2317 .IP "\fBforce user (S)\fP"
2319 This specifies a UNIX user name that will be assigned as the default
2320 user for all users connecting to this service\&. This is useful for
2321 sharing files\&. You should also use it carefully as using it
2322 incorrectly can cause security problems\&.
2324 This user name only gets used once a connection is established\&. Thus
2325 clients still need to connect as a valid user and supply a valid
2326 password\&. Once connected, all file operations will be performed as the
2327 \f(CW"forced user"\fP, no matter what username the client connected as\&.
2329 This can be very useful\&.
2332 \f(CW no forced user\fP
2335 \f(CW force user = auser\fP
2337 .IP "\fBfstype (S)\fP"
2339 This parameter allows the administrator to configure the string that
2340 specifies the type of filesystem a share is using that is reported by
2341 \fBsmbd\fP when a client queries the filesystem type
2342 for a share\&. The default type is \fB"NTFS"\fP for compatibility with
2343 Windows NT but this can be changed to other strings such as "Samba" or
2344 "FAT" if required\&.
2347 \f(CW fstype = NTFS\fP
2350 \f(CW fstype = Samba\fP
2352 .IP "\fBgetwd cache (G)\fP"
2354 This is a tuning option\&. When this is enabled a caching algorithm
2355 will be used to reduce the time taken for getwd() calls\&. This can have
2356 a significant impact on performance, especially when the
2357 \fBwidelinks\fP parameter is set to False\&.
2360 \f(CW getwd cache = No\fP
2363 \f(CW getwd cache = Yes\fP
2365 .IP "\fBgroup (S)\fP"
2367 Synonym for \fB"force group"\fP\&.
2369 .IP "\fBguest account (S)\fP"
2371 This is a username which will be used for access to services which are
2372 specified as \fB\'guest ok\'\fP (see below)\&. Whatever
2373 privileges this user has will be available to any client connecting to
2374 the guest service\&. Typically this user will exist in the password
2375 file, but will not have a valid login\&. The user account \fB"ftp"\fP is
2376 often a good choice for this parameter\&. If a username is specified in
2377 a given service, the specified username overrides this one\&.
2379 One some systems the default guest account "nobody" may not be able to
2380 print\&. Use another account in this case\&. You should test this by
2381 trying to log in as your guest user (perhaps by using the \f(CW"su -"\fP
2382 command) and trying to print using the system print command such as
2383 \fBlpr (1)\fP or \fBlp (1)\fP\&.
2386 \f(CW specified at compile time, usually "nobody"\fP
2389 \f(CW guest account = ftp\fP
2391 .IP "\fBguest ok (S)\fP"
2393 If this parameter is \fI\'yes\'\fP for a service, then no password is
2394 required to connect to the service\&. Privileges will be those of the
2395 \fBguest account\fP\&.
2397 See the section below on \fBsecurity\fP for more
2398 information about this option\&.
2401 \f(CW guest ok = no\fP
2404 \f(CW guest ok = yes\fP
2406 .IP "\fBguest only (S)\fP"
2408 If this parameter is \fI\'yes\'\fP for a service, then only guest
2409 connections to the service are permitted\&. This parameter will have no
2410 affect if \fB"guest ok"\fP or \fB"public"\fP
2411 is not set for the service\&.
2413 See the section below on \fBsecurity\fP for more
2414 information about this option\&.
2417 \f(CW guest only = no\fP
2420 \f(CW guest only = yes\fP
2422 .IP "\fBhide dot files (S)\fP"
2424 This is a boolean parameter that controls whether files starting with
2425 a dot appear as hidden files\&.
2428 \f(CW hide dot files = yes\fP
2431 \f(CW hide dot files = no\fP
2433 .IP "\fBhide files(S)\fP"
2435 This is a list of files or directories that are not visible but are
2436 accessible\&. The DOS \'hidden\' attribute is applied to any files or
2437 directories that match\&.
2439 Each entry in the list must be separated by a \f(CW\'/\'\fP, which allows
2440 spaces to be included in the entry\&. \f(CW\'*\'\fP and \f(CW\'?\'\fP can be used
2441 to specify multiple files or directories as in DOS wildcards\&.
2443 Each entry must be a Unix path, not a DOS path and must not include the
2444 Unix directory separator \f(CW\'/\'\fP\&.
2446 Note that the case sensitivity option is applicable in hiding files\&.
2448 Setting this parameter will affect the performance of Samba, as it
2449 will be forced to check all files and directories for a match as they
2452 See also \fB"hide dot files"\fP, \fB"veto
2453 files"\fP and \fB"case sensitive"\fP\&.
2460 No files or directories are hidden by this option (dot files are
2461 hidden by default because of the "hide dot files" option)\&.
2468 \f(CW hide files = /\&.*/DesktopFolderDB/TrashFor%m/resource\&.frk/\fP
2470 The above example is based on files that the Macintosh SMB client
2471 (DAVE) available from \fBThursby\fP creates for
2472 internal use, and also still hides all files beginning with a dot\&.
2474 .IP "\fBhomedir map (G)\fP"
2476 If \fB"nis homedir"\fP is true, and
2477 \fBsmbd\fP is also acting as a Win95/98 \fBlogon
2478 server\fP then this parameter specifies the NIS (or YP)
2479 map from which the server for the user\'s home directory should be
2480 extracted\&. At present, only the Sun auto\&.home map format is
2481 understood\&. The form of the map is:
2483 \f(CWusername server:/some/file/system\fP
2485 and the program will extract the servername from before the first
2486 \f(CW\':\'\fP\&. There should probably be a better parsing system that copes
2487 with different map formats and also Amd (another automounter) maps\&.
2489 NB: A working NIS is required on the system for this option to work\&.
2491 See also \fB"nis homedir"\fP, \fBdomain
2495 \f(CW homedir map = auto\&.home\fP
2498 \f(CW homedir map = amd\&.homedir\fP
2500 .IP "\fBhosts allow (S)\fP"
2502 Synonym for \fBallow hosts\fP\&.
2504 .IP "\fBhosts deny (S)\fP"
2506 Synonym for \fBdenyhosts\fP\&.
2508 .IP "\fBhosts equiv (G)\fP"
2510 If this global parameter is a non-null string, it specifies the name
2511 of a file to read for the names of hosts and users who will be allowed
2512 access without specifying a password\&.
2514 This is not be confused with \fBallow hosts\fP which
2515 is about hosts access to services and is more useful for guest
2516 services\&. \fBhosts equiv\fP may be useful for NT clients which will not
2517 supply passwords to samba\&.
2519 NOTE: The use of \fBhosts equiv\fP can be a major security hole\&. This is
2520 because you are trusting the PC to supply the correct username\&. It is
2521 very easy to get a PC to supply a false username\&. I recommend that the
2522 \fBhosts equiv\fP option be only used if you really know what you are
2523 doing, or perhaps on a home network where you trust your spouse and
2524 kids\&. And only if you \fIreally\fP trust them :-)\&.
2527 \f(CW No host equivalences\fP
2530 \f(CW hosts equiv = /etc/hosts\&.equiv\fP
2532 .IP "\fBinclude (G)\fP"
2534 This allows you to include one config file inside another\&. The file
2535 is included literally, as though typed in place\&.
2537 It takes the standard substitutions, except \fB%u\fP,
2538 \fB%P\fP and \fB%S\fP\&.
2540 .IP "\fBinterfaces (G)\fP"
2542 This option allows you to setup multiple network interfaces, so that
2543 Samba can properly handle browsing on all interfaces\&.
2545 The option takes a list of ip/netmask pairs\&. The netmask may either be
2546 a bitmask, or a bitlength\&.
2548 For example, the following line:
2550 \f(CWinterfaces = 192\&.168\&.2\&.10/24 192\&.168\&.3\&.10/24\fP
2552 would configure two network interfaces with IP addresses 192\&.168\&.2\&.10
2553 and 192\&.168\&.3\&.10\&. The netmasks of both interfaces would be set to
2554 255\&.255\&.255\&.0\&.
2556 You could produce an equivalent result by using:
2558 \f(CWinterfaces = 192\&.168\&.2\&.10/255\&.255\&.255\&.0 192\&.168\&.3\&.10/255\&.255\&.255\&.0\fP
2560 if you prefer that format\&.
2562 If this option is not set then Samba will attempt to find a primary
2563 interface, but won\'t attempt to configure more than one interface\&.
2565 See also \fB"bind interfaces only"\fP\&.
2567 .IP "\fBinvalid users (S)\fP"
2569 This is a list of users that should not be allowed to login to this
2570 service\&. This is really a \fI"paranoid"\fP check to absolutely ensure an
2571 improper setting does not breach your security\&.
2573 A name starting with a \f(CW\'@\'\fP is interpreted as an NIS netgroup first
2574 (if your system supports NIS), and then as a UNIX group if the name
2575 was not found in the NIS netgroup database\&.
2577 A name starting with \f(CW\'+\'\fP is interpreted only by looking in the
2578 UNIX group database\&. A name starting with \f(CW\'&\'\fP is interpreted only
2579 by looking in the NIS netgroup database (this requires NIS to be
2580 working on your system)\&. The characters \f(CW\'+\'\fP and \f(CW\'&\'\fP may be
2581 used at the start of the name in either order so the value
2582 \f(CW"+&group"\fP means check the UNIX group database, followed by the NIS
2583 netgroup database, and the value \f(CW"&+group"\fP means check the NIS
2584 netgroup database, followed by the UNIX group database (the same as
2585 the \f(CW\'@\'\fP prefix)\&.
2587 The current servicename is substituted for
2588 \fB%S\fP\&. This is useful in the \fB[homes]\fP
2591 See also \fB"valid users"\fP\&.
2594 \f(CW No invalid users\fP
2597 \f(CW invalid users = root fred admin @wheel\fP
2599 .IP "\fBkeepalive (G)\fP"
2601 The value of the parameter (an integer) represents the number of
2602 seconds between \fB\'keepalive\'\fP packets\&. If this parameter is zero, no
2603 keepalive packets will be sent\&. Keepalive packets, if sent, allow the
2604 server to tell whether a client is still present and responding\&.
2606 Keepalives should, in general, not be needed if the socket being used
2607 has the SO_KEEPALIVE attribute set on it (see \fB"socket
2608 options"\fP)\&. Basically you should only use this option
2609 if you strike difficulties\&.
2612 \f(CW keep alive = 0\fP
2615 \f(CW keep alive = 60\fP
2617 .IP "\fBkernel oplocks (G)\fP"
2619 For UNIXs that support kernel based \fBoplocks\fP
2620 (currently only IRIX but hopefully also Linux and FreeBSD soon) this
2621 parameter allows the use of them to be turned on or off\&.
2623 Kernel oplocks support allows Samba \fBoplocks\fP to be
2624 broken whenever a local UNIX process or NFS operation accesses a file
2625 that \fBsmbd\fP has oplocked\&. This allows complete
2626 data consistency between SMB/CIFS, NFS and local file access (and is a
2627 \fIvery\fP cool feature :-)\&.
2629 This parameter defaults to \fI"On"\fP on systems that have the support,
2630 and \fI"off"\fP on systems that don\'t\&. You should never need to touch
2633 .IP "\fBldap filter (G)\fP"
2635 This parameter is part of the \fIEXPERIMENTAL\fP Samba support for a
2636 password database stored on an LDAP server back-end\&. These options
2637 are only available if your version of Samba was configured with
2638 the \fB--with-ldap\fP option\&.
2640 This parameter specifies an LDAP search filter used to search for a
2641 user name in the LDAP database\&. It must contain the string
2642 \fB%u\fP which will be replaced with the user being
2646 \f(CW empty string\&.\fP
2648 .IP "\fBldap port (G)\fP"
2650 This parameter is part of the \fIEXPERIMENTAL\fP Samba support for a
2651 password database stored on an LDAP server back-end\&. These options
2652 are only available if your version of Samba was configured with
2653 the \fB--with-ldap\fP option\&.
2655 This parameter specifies the TCP port number to use to contact
2656 the LDAP server on\&.
2659 \f(CW ldap port = 389\&.\fP
2661 .IP "\fBldap root (G)\fP"
2663 This parameter is part of the \fIEXPERIMENTAL\fP Samba support for a
2664 password database stored on an LDAP server back-end\&. These options
2665 are only available if your version of Samba was configured with
2666 the \fB--with-ldap\fP option\&.
2668 This parameter specifies the entity to bind to the LDAP server
2669 as (essentially the LDAP username) in order to be able to perform
2670 queries and modifications on the LDAP database\&.
2672 See also \fBldap root passwd\fP\&.
2675 \f(CW empty string (no user defined)\fP
2677 .IP "\fBldap root passwd (G)\fP"
2679 This parameter is part of the \fIEXPERIMENTAL\fP Samba support for a
2680 password database stored on an LDAP server back-end\&. These options
2681 are only available if your version of Samba was configured with
2682 the \fB--with-ldap\fP option\&.
2684 This parameter specifies the password for the entity to bind to the
2685 LDAP server as (the password for this LDAP username) in order to be
2686 able to perform queries and modifications on the LDAP database\&.
2688 \fIBUGS:\fP This parameter should \fINOT\fP be a readable parameter
2689 in the \fBsmb\&.conf\fP file and will be removed once a correct
2690 storage place is found\&.
2692 See also \fBldap root\fP\&.
2695 \f(CW empty string\&.\fP
2697 .IP "\fBldap server (G)\fP"
2699 This parameter is part of the \fIEXPERIMENTAL\fP Samba support for a
2700 password database stored on an LDAP server back-end\&. These options
2701 are only available if your version of Samba was configured with
2702 the \fB--with-ldap\fP option\&.
2704 This parameter specifies the DNS name of the LDAP server to use
2705 for SMB/CIFS authentication purposes\&.
2708 \f(CW ldap server = localhost\fP
2710 .IP "\fBldap suffix (G)\fP"
2712 This parameter is part of the \fIEXPERIMENTAL\fP Samba support for a
2713 password database stored on an LDAP server back-end\&. These options
2714 are only available if your version of Samba was configured with
2715 the \fB--with-ldap\fP option\&.
2717 This parameter specifies the \f(CW"dn"\fP or LDAP \fI"distinguished name"\fP
2718 that tells \fBsmbd\fP to start from when searching
2719 for an entry in the LDAP password database\&.
2722 \f(CW empty string\&.\fP
2724 .IP "\fBlm announce (G)\fP"
2726 This parameter determines if \fBnmbd\fP will produce
2727 Lanman announce broadcasts that are needed by \fBOS/2\fP clients in order
2728 for them to see the Samba server in their browse list\&. This parameter
2729 can have three values, \f(CW"true"\fP, \f(CW"false"\fP, or \f(CW"auto"\fP\&. The
2730 default is \f(CW"auto"\fP\&. If set to \f(CW"false"\fP Samba will never produce
2731 these broadcasts\&. If set to \f(CW"true"\fP Samba will produce Lanman
2732 announce broadcasts at a frequency set by the parameter \fB"lm
2733 interval"\fP\&. If set to \f(CW"auto"\fP Samba will not send Lanman
2734 announce broadcasts by default but will listen for them\&. If it hears
2735 such a broadcast on the wire it will then start sending them at a
2736 frequency set by the parameter \fB"lm interval"\fP\&.
2738 See also \fB"lm interval"\fP\&.
2741 \f(CW lm announce = auto\fP
2744 \f(CW lm announce = true\fP
2746 .IP "\fBlm interval (G)\fP"
2748 If Samba is set to produce Lanman announce broadcasts needed by
2749 \fBOS/2\fP clients (see the \fB"lm announce"\fP
2750 parameter) then this parameter defines the frequency in seconds with
2751 which they will be made\&. If this is set to zero then no Lanman
2752 announcements will be made despite the setting of the \fB"lm
2753 announce"\fP parameter\&.
2755 See also \fB"lm announce"\fP\&.
2758 \f(CW lm interval = 60\fP
2761 \f(CW lm interval = 120\fP
2763 .IP "\fBload printers (G)\fP"
2765 A boolean variable that controls whether all printers in the printcap
2766 will be loaded for browsing by default\&. See the
2767 \fB"printers"\fP section for more details\&.
2770 \f(CW load printers = yes\fP
2773 \f(CW load printers = no\fP
2775 .IP "\fBlocal master (G)\fP"
2777 This option allows \fBnmbd\fP to try and become a
2778 local master browser on a subnet\&. If set to False then
2779 \fBnmbd\fP will not attempt to become a local master
2780 browser on a subnet and will also lose in all browsing elections\&. By
2781 default this value is set to true\&. Setting this value to true doesn\'t
2782 mean that Samba will \fIbecome\fP the local master browser on a subnet,
2783 just that \fBnmbd\fP will \fIparticipate\fP in
2784 elections for local master browser\&.
2786 Setting this value to False will cause \fBnmbd\fP
2787 \fInever\fP to become a local master browser\&.
2790 \f(CW local master = yes\fP
2792 .IP "\fBlock dir (G)\fP"
2794 Synonym for \fB"lock directory"\fP\&.
2796 .IP "\fBlock directory (G)\fP"
2798 This option specifies the directory where lock files will be placed\&.
2799 The lock files are used to implement the \fB"max
2800 connections"\fP option\&.
2803 \f(CW lock directory = /tmp/samba\fP
2806 \f(CW lock directory = /usr/local/samba/var/locks\fP
2808 .IP "\fBlocking (S)\fP"
2810 This controls whether or not locking will be performed by the server
2811 in response to lock requests from the client\&.
2813 If \f(CW"locking = no"\fP, all lock and unlock requests will appear to
2814 succeed and all lock queries will indicate that the queried lock is
2817 If \f(CW"locking = yes"\fP, real locking will be performed by the server\&.
2819 This option \fImay\fP be useful for read-only filesystems which \fImay\fP
2820 not need locking (such as cdrom drives), although setting this
2821 parameter of \f(CW"no"\fP is not really recommended even in this case\&.
2823 Be careful about disabling locking either globally or in a specific
2824 service, as lack of locking may result in data corruption\&. You should
2825 never need to set this parameter\&.
2828 \f(CW locking = yes\fP
2831 \f(CW locking = no\fP
2833 .IP "\fBlog file (G)\fP"
2835 This options allows you to override the name of the Samba log file
2836 (also known as the debug file)\&.
2838 This option takes the standard substitutions, allowing you to have
2839 separate log files for each user or machine\&.
2842 \f(CW log file = /usr/local/samba/var/log\&.%m\fP
2844 .IP "\fBlog level (G)\fP"
2846 Synonym for \fB"debug level"\fP\&.
2848 .IP "\fBlogon drive (G)\fP"
2850 This parameter specifies the local path to which the home directory
2851 will be connected (see \fB"logon home"\fP) and is only
2852 used by NT Workstations\&.
2854 Note that this option is only useful if Samba is set up as a
2855 \fBlogon server\fP\&.
2858 \f(CW logon drive = h:\fP
2860 .IP "\fBlogon home (G)\fP"
2862 This parameter specifies the home directory location when a Win95/98 or
2863 NT Workstation logs into a Samba PDC\&. It allows you to do
2865 \f(CW"NET USE H: /HOME"\fP
2867 from a command prompt, for example\&.
2869 This option takes the standard substitutions, allowing you to have
2870 separate logon scripts for each user or machine\&.
2872 Note that this option is only useful if Samba is set up as a
2873 \fBlogon server\fP\&.
2876 \f(CW logon home = "\e\eremote_smb_server\e%U"\fP
2879 \f(CW logon home = "\e\e%N\e%U"\fP
2881 .IP "\fBlogon path (G)\fP"
2883 This parameter specifies the home directory where roaming profiles
2884 (USER\&.DAT / USER\&.MAN files for Windows 95/98) are stored\&.
2886 This option takes the standard substitutions, allowing you to have
2887 separate logon scripts for each user or machine\&. It also specifies
2888 the directory from which the \f(CW"desktop"\fP, \f(CW"start menu"\fP,
2889 \f(CW"network neighborhood"\fP and \f(CW"programs"\fP folders, and their
2890 contents, are loaded and displayed on your Windows 95/98 client\&.
2892 The share and the path must be readable by the user for the
2893 preferences and directories to be loaded onto the Windows 95/98
2894 client\&. The share must be writeable when the logs in for the first
2895 time, in order that the Windows 95/98 client can create the user\&.dat
2896 and other directories\&.
2898 Thereafter, the directories and any of the contents can, if required, be
2899 made read-only\&. It is not advisable that the USER\&.DAT file be made
2900 read-only - rename it to USER\&.MAN to achieve the desired effect (a
2901 \fIMAN\fPdatory profile)\&.
2903 Windows clients can sometimes maintain a connection to the [homes]
2904 share, even though there is no user logged in\&. Therefore, it is vital
2905 that the logon path does not include a reference to the homes share
2906 (i\&.e\&. setting this parameter to \f(CW\e\e%N\eHOMES\eprofile_path\fP will cause
2909 This option takes the standard substitutions, allowing you to have
2910 separate logon scripts for each user or machine\&.
2912 Note that this option is only useful if Samba is set up as a
2913 \fBlogon server\fP\&.
2916 \f(CW logon path = \e\e%N\e%U\eprofile\fP
2919 \f(CW logon path = \e\ePROFILESERVER\eHOME_DIR\e%U\ePROFILE\fP
2921 .IP "\fBlogon script (G)\fP"
2923 This parameter specifies the batch file (\&.bat) or NT command file
2924 (\&.cmd) to be downloaded and run on a machine when a user successfully
2925 logs in\&. The file must contain the DOS style cr/lf line endings\&.
2926 Using a DOS-style editor to create the file is recommended\&.
2928 The script must be a relative path to the \f(CW[netlogon]\fP service\&. If
2929 the \f(CW[netlogon]\fP service specifies a \fBpath\fP of
2930 /usr/local/samba/netlogon, and logon script = STARTUP\&.BAT, then the
2931 file that will be downloaded is:
2933 \f(CW/usr/local/samba/netlogon/STARTUP\&.BAT\fP
2935 The contents of the batch file is entirely your choice\&. A suggested
2936 command would be to add \f(CWNET TIME \e\eSERVER /SET /YES\fP, to force every
2937 machine to synchronize clocks with the same time server\&. Another use
2938 would be to add \f(CWNET USE U: \e\eSERVER\eUTILS\fP for commonly used
2939 utilities, or \f(CWNET USE Q: \e\eSERVER\eISO9001_QA\fP for example\&.
2941 Note that it is particularly important not to allow write access to
2942 the \f(CW[netlogon]\fP share, or to grant users write permission on the
2943 batch files in a secure environment, as this would allow the batch
2944 files to be arbitrarily modified and security to be breached\&.
2946 This option takes the standard substitutions, allowing you to have
2947 separate logon scripts for each user or machine\&.
2949 Note that this option is only useful if Samba is set up as a
2950 \fBlogon server\fP\&.
2953 \f(CW logon script = scripts\e%U\&.bat\fP
2955 .IP "\fBlppause command (S)\fP"
2957 This parameter specifies the command to be executed on the server host
2958 in order to stop printing or spooling a specific print job\&.
2960 This command should be a program or script which takes a printer name
2961 and job number to pause the print job\&. One way of implementing this is
2962 by using job priorities, where jobs having a too low priority won\'t be
2963 sent to the printer\&.
2965 If a \f(CW"%p"\fP is given then the printername is put in its place\&. A
2966 \f(CW"%j"\fP is replaced with the job number (an integer)\&. On HPUX (see
2967 \fBprinting=hpux\fP), if the \f(CW"-p%p"\fP option is added
2968 to the lpq command, the job will show up with the correct status,
2969 i\&.e\&. if the job priority is lower than the set fence priority it will
2970 have the PAUSED status, whereas if the priority is equal or higher it
2971 will have the SPOOLED or PRINTING status\&.
2973 Note that it is good practice to include the absolute path in the
2974 lppause command as the PATH may not be available to the server\&.
2976 See also the \fB"printing"\fP parameter\&.
2979 Currently no default value is given to this string, unless the
2980 value of the \fB"printing"\fP parameter is \f(CWSYSV\fP, in
2981 which case the default is :
2983 \f(CW lp -i %p-%j -H hold\fP
2985 or if the value of the \fB"printing"\fP parameter is \f(CWsoftq\fP,
2986 then the default is:
2988 \f(CW qstat -s -j%j -h\fP
2990 \fBExample for HPUX:\fP
2991 lppause command = /usr/bin/lpalt %p-%j -p0
2993 .IP "\fBlpq cache time (G)\fP"
2995 This controls how long lpq info will be cached for to prevent the
2996 \fBlpq\fP command being called too often\&. A separate cache is kept for
2997 each variation of the \fBlpq\fP command used by the system, so if you
2998 use different \fBlpq\fP commands for different users then they won\'t
2999 share cache information\&.
3001 The cache files are stored in \f(CW/tmp/lpq\&.xxxx\fP where xxxx is a hash of
3002 the \fBlpq\fP command in use\&.
3004 The default is 10 seconds, meaning that the cached results of a
3005 previous identical \fBlpq\fP command will be used if the cached data is
3006 less than 10 seconds old\&. A large value may be advisable if your
3007 \fBlpq\fP command is very slow\&.
3009 A value of 0 will disable caching completely\&.
3011 See also the \fB"printing"\fP parameter\&.
3014 \f(CW lpq cache time = 10\fP
3017 \f(CW lpq cache time = 30\fP
3019 .IP "\fBlpq command (S)\fP"
3021 This parameter specifies the command to be executed on the server host
3022 in order to obtain \f(CW"lpq"\fP-style printer status information\&.
3024 This command should be a program or script which takes a printer name
3025 as its only parameter and outputs printer status information\&.
3027 Currently eight styles of printer status information are supported;
3028 BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX and SOFTQ\&. This covers most UNIX
3029 systems\&. You control which type is expected using the
3030 \fB"printing ="\fP option\&.
3032 Some clients (notably Windows for Workgroups) may not correctly send
3033 the connection number for the printer they are requesting status
3034 information about\&. To get around this, the server reports on the first
3035 printer service connected to by the client\&. This only happens if the
3036 connection number sent is invalid\&.
3038 If a \f(CW%p\fP is given then the printername is put in its place\&. Otherwise
3039 it is placed at the end of the command\&.
3041 Note that it is good practice to include the absolute path in the \fBlpq
3042 command\fP as the PATH may not be available to the server\&.
3044 See also the \fB"printing"\fP parameter\&.
3047 \f(CW depends on the setting of printing =\fP
3050 \f(CW lpq command = /usr/bin/lpq %p\fP
3052 .IP "\fBlpresume command (S)\fP"
3054 This parameter specifies the command to be executed on the server host
3055 in order to restart or continue printing or spooling a specific print
3058 This command should be a program or script which takes a printer name
3059 and job number to resume the print job\&. See also the \fB"lppause
3060 command"\fP parameter\&.
3062 If a \f(CW%p\fP is given then the printername is put in its place\&. A
3063 \f(CW%j\fP is replaced with the job number (an integer)\&.
3065 Note that it is good practice to include the absolute path in the \fBlpresume
3066 command\fP as the PATH may not be available to the server\&.
3068 See also the \fB"printing"\fP parameter\&.
3072 Currently no default value is given to this string, unless the
3073 value of the \fB"printing"\fP parameter is \f(CWSYSV\fP, in
3074 which case the default is :
3076 \f(CW lp -i %p-%j -H resume\fP
3078 or if the value of the \fB"printing"\fP parameter is \f(CWsoftq\fP,
3079 then the default is:
3081 \f(CW qstat -s -j%j -r\fP
3083 \fBExample for HPUX:\fP
3084 \f(CW lpresume command = /usr/bin/lpalt %p-%j -p2\fP
3086 .IP "\fBlprm command (S)\fP"
3088 This parameter specifies the command to be executed on the server host
3089 in order to delete a print job\&.
3091 This command should be a program or script which takes a printer name
3092 and job number, and deletes the print job\&.
3094 If a \f(CW%p\fP is given then the printername is put in its place\&. A
3095 \f(CW%j\fP is replaced with the job number (an integer)\&.
3097 Note that it is good practice to include the absolute path in the
3098 \fBlprm command\fP as the PATH may not be available to the server\&.
3100 See also the \fB"printing"\fP parameter\&.
3103 \f(CW depends on the setting of "printing ="\fP
3106 \f(CW lprm command = /usr/bin/lprm -P%p %j\fP
3109 \f(CW lprm command = /usr/bin/cancel %p-%j\fP
3111 .IP "\fBmachine password timeout (G)\fP"
3113 If a Samba server is a member of an Windows NT Domain (see the
3114 \fB"security=domain"\fP) parameter) then
3115 periodically a running \fBsmbd\fP process will try and
3116 change the \fBMACHINE ACCOUNT PASWORD\fP stored in the file called
3117 \f(CW<Domain>\&.<Machine>\&.mac\fP where \f(CW<Domain>\fP is the name of the
3118 Domain we are a member of and \f(CW<Machine>\fP is the primary
3119 \fB"NetBIOS name"\fP of the machine
3120 \fBsmbd\fP is running on\&. This parameter specifies how
3121 often this password will be changed, in seconds\&. The default is one
3122 week (expressed in seconds), the same as a Windows NT Domain member
3125 See also \fBsmbpasswd (8)\fP, and the
3126 \fB"security=domain"\fP) parameter\&.
3129 \f(CW machine password timeout = 604800\fP
3131 .IP "\fBmagic output (S)\fP"
3133 This parameter specifies the name of a file which will contain output
3134 created by a magic script (see the \fB"magic
3135 script"\fP parameter below)\&.
3137 Warning: If two clients use the same \fB"magic
3138 script"\fP in the same directory the output file content
3142 \f(CW magic output = <magic script name>\&.out\fP
3145 \f(CW magic output = myfile\&.txt\fP
3147 .IP "\fBmagic script (S)\fP"
3149 This parameter specifies the name of a file which, if opened, will be
3150 executed by the server when the file is closed\&. This allows a UNIX
3151 script to be sent to the Samba host and executed on behalf of the
3154 Scripts executed in this way will be deleted upon completion,
3155 permissions permitting\&.
3157 If the script generates output, output will be sent to the file
3158 specified by the \fB"magic output"\fP parameter (see
3161 Note that some shells are unable to interpret scripts containing
3162 carriage-return-linefeed instead of linefeed as the end-of-line
3163 marker\&. Magic scripts must be executable \fI"as is"\fP on the host,
3164 which for some hosts and some shells will require filtering at the DOS
3167 Magic scripts are \fIEXPERIMENTAL\fP and should \fINOT\fP be relied upon\&.
3170 \f(CW None\&. Magic scripts disabled\&.\fP
3173 \f(CW magic script = user\&.csh\fP
3175 .IP "\fBmangle case (S)\fP"
3177 See the section on \fB"NAME MANGLING"\fP\&.
3179 .IP "\fBmangled map (S)\fP"
3181 This is for those who want to directly map UNIX file names which can
3182 not be represented on Windows/DOS\&. The mangling of names is not always
3183 what is needed\&. In particular you may have documents with file
3184 extensions that differ between DOS and UNIX\&. For example, under UNIX
3185 it is common to use \f(CW"\&.html"\fP for HTML files, whereas under
3186 Windows/DOS \f(CW"\&.htm"\fP is more commonly used\&.
3188 So to map \f(CW"html"\fP to \f(CW"htm"\fP you would use:
3190 \f(CW mangled map = (*\&.html *\&.htm)\fP
3192 One very useful case is to remove the annoying \f(CW";1"\fP off the ends
3193 of filenames on some CDROMS (only visible under some UNIXs)\&. To do
3194 this use a map of (*;1 *)\&.
3197 \f(CW no mangled map\fP
3200 \f(CW mangled map = (*;1 *)\fP
3202 .IP "\fBmangled names (S)\fP"
3204 This controls whether non-DOS names under UNIX should be mapped to
3205 DOS-compatible names ("mangled") and made visible, or whether non-DOS
3206 names should simply be ignored\&.
3208 See the section on \fB"NAME MANGLING"\fP for details
3209 on how to control the mangling process\&.
3211 If mangling is used then the mangling algorithm is as follows:
3215 The first (up to) five alphanumeric characters before the
3216 rightmost dot of the filename are preserved, forced to upper case, and
3217 appear as the first (up to) five characters of the mangled name\&.
3220 A tilde \f(CW"~"\fP is appended to the first part of the mangled
3221 name, followed by a two-character unique sequence, based on the
3222 original root name (i\&.e\&., the original filename minus its final
3223 extension)\&. The final extension is included in the hash calculation
3224 only if it contains any upper case characters or is longer than three
3227 Note that the character to use may be specified using the
3228 \fB"mangling char"\fP option, if you don\'t like
3232 The first three alphanumeric characters of the final extension
3233 are preserved, forced to upper case and appear as the extension of the
3234 mangled name\&. The final extension is defined as that part of the
3235 original filename after the rightmost dot\&. If there are no dots in the
3236 filename, the mangled name will have no extension (except in the case
3237 of \fB"hidden files"\fP - see below)\&.
3240 Files whose UNIX name begins with a dot will be presented as DOS
3241 hidden files\&. The mangled name will be created as for other filenames,
3242 but with the leading dot removed and \f(CW"___"\fP as its extension regardless
3243 of actual original extension (that\'s three underscores)\&.
3246 The two-digit hash value consists of upper case alphanumeric
3249 This algorithm can cause name collisions only if files in a directory
3250 share the same first five alphanumeric characters\&. The probability of
3251 such a clash is 1/1300\&.
3253 The name mangling (if enabled) allows a file to be copied between UNIX
3254 directories from Windows/DOS while retaining the long UNIX
3255 filename\&. UNIX files can be renamed to a new extension from
3256 Windows/DOS and will retain the same basename\&. Mangled names do not
3257 change between sessions\&.
3260 \f(CW mangled names = yes\fP
3263 \f(CW mangled names = no\fP
3265 .IP "\fBmangling char (S)\fP"
3267 This controls what character is used as the \fI"magic"\fP character in
3268 \fBname mangling\fP\&. The default is a \f(CW\'~\'\fP but
3269 this may interfere with some software\&. Use this option to set it to
3270 whatever you prefer\&.
3273 \f(CW mangling char = ~\fP
3276 \f(CW mangling char = ^\fP
3278 .IP "\fBmangled stack (G)\fP"
3280 This parameter controls the number of mangled names that should be
3281 cached in the Samba server \fBsmbd\fP\&.
3283 This stack is a list of recently mangled base names (extensions are
3284 only maintained if they are longer than 3 characters or contains upper
3287 The larger this value, the more likely it is that mangled names can be
3288 successfully converted to correct long UNIX names\&. However, large
3289 stack sizes will slow most directory access\&. Smaller stacks save
3290 memory in the server (each stack element costs 256 bytes)\&.
3292 It is not possible to absolutely guarantee correct long file names, so
3293 be prepared for some surprises!
3296 \f(CW mangled stack = 50\fP
3299 \f(CW mangled stack = 100\fP
3301 .IP "\fBmap archive (S)\fP"
3303 This controls whether the DOS archive attribute should be mapped to
3304 the UNIX owner execute bit\&. The DOS archive bit is set when a file
3305 has been modified since its last backup\&. One motivation for this
3306 option it to keep Samba/your PC from making any file it touches from
3307 becoming executable under UNIX\&. This can be quite annoying for shared
3308 source code, documents, etc\&.\&.\&.
3310 Note that this requires the \fB"create mask"\fP
3311 parameter to be set such that owner execute bit is not masked out
3312 (i\&.e\&. it must include 100)\&. See the parameter \fB"create
3313 mask"\fP for details\&.
3316 \f(CW map archive = yes\fP
3319 \f(CW map archive = no\fP
3321 .IP "\fBmap hidden (S)\fP"
3323 This controls whether DOS style hidden files should be mapped to the
3324 UNIX world execute bit\&.
3326 Note that this requires the \fB"create mask"\fP to be
3327 set such that the world execute bit is not masked out (i\&.e\&. it must
3328 include 001)\&. See the parameter \fB"create mask"\fP
3332 \f(CW map hidden = no\fP
3335 \f(CW map hidden = yes\fP
3337 .IP "\fBmap system (S)\fP"
3339 This controls whether DOS style system files should be mapped to the
3340 UNIX group execute bit\&.
3342 Note that this requires the \fB"create mask"\fP to be
3343 set such that the group execute bit is not masked out (i\&.e\&. it must
3344 include 010)\&. See the parameter \fB"create mask"\fP
3348 \f(CW map system = no\fP
3351 \f(CW map system = yes\fP
3353 .IP "\fBmap to guest (G)\fP"
3355 This parameter is only useful in \fBsecurity\fP modes
3356 other than \fB"security=share"\fP - i\&.e\&. user,
3357 server, and domain\&.
3359 This parameter can take three different values, which tell
3360 \fBsmbd\fP what to do with user login requests that
3361 don\'t match a valid UNIX user in some way\&.
3363 The three settings are :
3367 \fB"Never"\fP - Means user login requests with an invalid password
3368 are rejected\&. This is the default\&.
3371 \fB"Bad User"\fP - Means user logins with an invalid password are
3372 rejected, unless the username does not exist, in which case it is
3373 treated as a guest login and mapped into the \fB"guest
3377 \fB"Bad Password"\fP - Means user logins with an invalid
3378 password are treated as a guest login and mapped into the
3379 \fB"guest account"\fP\&. Note that this can
3380 cause problems as it means that any user incorrectly typing their
3381 password will be silently logged on a \fB"guest"\fP - and
3382 will not know the reason they cannot access files they think
3383 they should - there will have been no message given to them
3384 that they got their password wrong\&. Helpdesk services will
3385 \fI*hate*\fP you if you set the \fB"map to guest"\fP parameter
3389 Note that this parameter is needed to set up \fB"Guest"\fP share
3390 services when using \fBsecurity\fP modes other than
3391 share\&. This is because in these modes the name of the resource being
3392 requested is \fI*not*\fP sent to the server until after the server has
3393 successfully authenticated the client so the server cannot make
3394 authentication decisions at the correct time (connection to the
3395 share) for \fB"Guest"\fP shares\&.
3397 For people familiar with the older Samba releases, this parameter
3398 maps to the old compile-time setting of the GUEST_SESSSETUP value
3402 \f(CW map to guest = Never\fP
3404 \f(CW map to guest = Bad User\fP
3406 .IP "\fBmax connections (S)\fP"
3408 This option allows the number of simultaneous connections to a service
3409 to be limited\&. If \fB"max connections"\fP is greater than 0 then
3410 connections will be refused if this number of connections to the
3411 service are already open\&. A value of zero mean an unlimited number of
3412 connections may be made\&.
3414 Record lock files are used to implement this feature\&. The lock files
3415 will be stored in the directory specified by the \fB"lock
3416 directory"\fP option\&.
3419 \f(CW max connections = 0\fP
3422 \f(CW max connections = 10\fP
3424 .IP "\fBmax disk size (G)\fP"
3426 This option allows you to put an upper limit on the apparent size of
3427 disks\&. If you set this option to 100 then all shares will appear to be
3428 not larger than 100 MB in size\&.
3430 Note that this option does not limit the amount of data you can put on
3431 the disk\&. In the above case you could still store much more than 100
3432 MB on the disk, but if a client ever asks for the amount of free disk
3433 space or the total disk size then the result will be bounded by the
3434 amount specified in \fB"max disk size"\fP\&.
3436 This option is primarily useful to work around bugs in some pieces of
3437 software that can\'t handle very large disks, particularly disks over
3440 A \fB"max disk size"\fP of 0 means no limit\&.
3443 \f(CW max disk size = 0\fP
3446 \f(CW max disk size = 1000\fP
3448 .IP "\fBmax log size (G)\fP"
3450 This option (an integer in kilobytes) specifies the max size the log
3451 file should grow to\&. Samba periodically checks the size and if it is
3452 exceeded it will rename the file, adding a \f(CW"\&.old"\fP extension\&.
3454 A size of 0 means no limit\&.
3457 \f(CW max log size = 5000\fP
3460 \f(CW max log size = 1000\fP
3462 .IP "\fBmax mux (G)\fP"
3464 This option controls the maximum number of outstanding simultaneous
3465 SMB operations that samba tells the client it will allow\&. You should
3466 never need to set this parameter\&.
3469 \f(CW max mux = 50\fP
3471 .IP "\fBmaxopenfiles (G)\fP"
3473 This parameter limits the maximum number of open files that one
3474 \fBsmbd\fP file serving process may have open for
3475 a client at any one time\&. The default for this parameter is set
3476 very high (10,000) as Samba uses only one bit per unopened file\&.
3478 The limit of the number of open files is usually set by the
3479 UNIX per-process file descriptor limit rather than this parameter
3480 so you should never need to touch this parameter\&.
3483 \f(CW max open files = 10000\fP
3485 .IP "\fBmax packet (G)\fP"
3487 Synonym for (packetsize)\&.
3489 .IP "\fBmax ttl (G)\fP"
3491 This option tells \fBnmbd\fP what the default \'time
3492 to live\' of NetBIOS names should be (in seconds) when
3493 \fBnmbd\fP is requesting a name using either a
3494 broadcast packet or from a WINS server\&. You should never need to
3495 change this parameter\&. The default is 3 days\&.
3498 \f(CW max ttl = 259200\fP
3500 .IP "\fBmax wins ttl (G)\fP"
3502 This option tells \fBnmbd\fP when acting as a WINS
3503 server \fB(wins support =true)\fP what the maximum
3504 \'time to live\' of NetBIOS names that \fBnmbd\fP will
3505 grant will be (in seconds)\&. You should never need to change this
3506 parameter\&. The default is 6 days (518400 seconds)\&.
3508 See also the \fB"min wins ttl"\fP parameter\&.
3511 \f(CW max wins ttl = 518400\fP
3513 .IP "\fBmax xmit (G)\fP"
3515 This option controls the maximum packet size that will be negotiated
3516 by Samba\&. The default is 65535, which is the maximum\&. In some cases
3517 you may find you get better performance with a smaller value\&. A value
3518 below 2048 is likely to cause problems\&.
3521 \f(CW max xmit = 65535\fP
3524 \f(CW max xmit = 8192\fP
3526 .IP "\fBmessage command (G)\fP"
3528 This specifies what command to run when the server receives a WinPopup
3531 This would normally be a command that would deliver the message
3532 somehow\&. How this is to be done is up to your imagination\&.
3536 \f(CW message command = csh -c \'xedit %s;rm %s\' &\fP
3538 This delivers the message using \fBxedit\fP, then removes it
3539 afterwards\&. \fINOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN
3540 IMMEDIATELY\fP\&. That\'s why I have the \f(CW\'&\'\fP on the end\&. If it doesn\'t
3541 return immediately then your PCs may freeze when sending messages
3542 (they should recover after 30secs, hopefully)\&.
3544 All messages are delivered as the global guest user\&. The command takes
3545 the standard substitutions, although \fB%u\fP won\'t work
3546 (\fB%U\fP may be better in this case)\&.
3548 Apart from the standard substitutions, some additional ones apply\&. In
3553 \f(CW"%s"\fP = the filename containing the message\&.
3556 \f(CW"%t"\fP = the destination that the message was sent to (probably the server
3560 \f(CW"%f"\fP = who the message is from\&.
3563 You could make this command send mail, or whatever else takes your
3564 fancy\&. Please let us know of any really interesting ideas you have\&.
3566 Here\'s a way of sending the messages as mail to root:
3568 \f(CWmessage command = /bin/mail -s \'message from %f on %m\' root < %s; rm %s\fP
3570 If you don\'t have a message command then the message won\'t be
3571 delivered and Samba will tell the sender there was an
3572 error\&. Unfortunately WfWg totally ignores the error code and carries
3573 on regardless, saying that the message was delivered\&.
3575 If you want to silently delete it then try:
3577 \f(CW"message command = rm %s"\fP\&.
3579 For the really adventurous, try something like this:
3581 \f(CWmessage command = csh -c \'csh < %s |& /usr/local/samba/bin/smbclient -M %m; rm %s\' &\fP
3583 this would execute the command as a script on the server, then give
3584 them the result in a WinPopup message\&. Note that this could cause a
3585 loop if you send a message from the server using smbclient! You better
3586 wrap the above in a script that checks for this :-)
3589 \f(CW no message command\fP
3592 \f(CW message command = csh -c \'xedit %s;rm %s\' &\fP
3594 .IP "\fBmin print space (S)\fP"
3596 This sets the minimum amount of free disk space that must be available
3597 before a user will be able to spool a print job\&. It is specified in
3598 kilobytes\&. The default is 0, which means a user can always spool a print
3601 See also the \fBprinting\fP parameter\&.
3604 \f(CW min print space = 0\fP
3607 \f(CW min print space = 2000\fP
3609 .IP "\fBmin wins ttl (G)\fP"
3611 This option tells \fBnmbd\fP when acting as a WINS
3612 server \fB(wins support = true)\fP what the minimum
3613 \'time to live\' of NetBIOS names that \fBnmbd\fP will
3614 grant will be (in seconds)\&. You should never need to change this
3615 parameter\&. The default is 6 hours (21600 seconds)\&.
3618 \f(CW min wins ttl = 21600\fP
3620 .IP "\fBname resolve order (G)\fP"
3622 This option is used by the programs in the Samba suite to determine
3623 what naming services and in what order to resolve host names to IP
3624 addresses\&. The option takes a space separated string of different name
3625 resolution options\&.
3627 The options are :"lmhosts", "host", "wins" and "bcast"\&. They cause
3628 names to be resolved as follows :
3632 \fBlmhosts\fP : Lookup an IP address in the Samba lmhosts file\&.
3635 \fBhost\fP : Do a standard host name to IP address resolution,
3636 using the system /etc/hosts, NIS, or DNS lookups\&. This method of name
3637 resolution is operating system depended for instance on IRIX or
3638 Solaris this may be controlled by the \fI/etc/nsswitch\&.conf\fP file)\&.
3641 \fBwins\fP : Query a name with the IP address listed in the
3642 \fBwins server\fP parameter\&. If no WINS server has
3643 been specified this method will be ignored\&.
3646 \fBbcast\fP : Do a broadcast on each of the known local interfaces
3647 listed in the \fBinterfaces\fP parameter\&. This is the
3648 least reliable of the name resolution methods as it depends on the
3649 target host being on a locally connected subnet\&.
3653 \f(CW name resolve order = lmhosts host wins bcast\fP
3656 \f(CW name resolve order = lmhosts bcast host\fP
3658 This will cause the local lmhosts file to be examined first, followed
3659 by a broadcast attempt, followed by a normal system hostname lookup\&.
3661 .IP "\fBnetbios aliases (G)\fP"
3663 This is a list of NetBIOS names that \fBnmbd\fP will
3664 advertise as additional names by which the Samba server is known\&. This
3665 allows one machine to appear in browse lists under multiple names\&. If
3666 a machine is acting as a \fBbrowse server\fP or
3667 \fBlogon server\fP none of these names will be
3668 advertised as either browse server or logon servers, only the primary
3669 name of the machine will be advertised with these capabilities\&.
3671 See also \fB"netbios name"\fP\&.
3674 \f(CW empty string (no additional names)\fP
3677 \f(CW netbios aliases = TEST TEST1 TEST2\fP
3679 .IP "\fBnetbios name (G)\fP"
3681 This sets the NetBIOS name by which a Samba server is known\&. By
3682 default it is the same as the first component of the host\'s DNS name\&.
3683 If a machine is a \fBbrowse server\fP or
3684 \fBlogon server\fP this name (or the first component
3685 of the hosts DNS name) will be the name that these services are
3688 See also \fB"netbios aliases"\fP\&.
3691 \f(CW Machine DNS name\&.\fP
3694 \f(CW netbios name = MYNAME\fP
3696 .IP "\fBnis homedir (G)\fP"
3698 Get the home share server from a NIS map\&. For UNIX systems that use an
3699 automounter, the user\'s home directory will often be mounted on a
3700 workstation on demand from a remote server\&.
3702 When the Samba logon server is not the actual home directory server,
3703 but is mounting the home directories via NFS then two network hops
3704 would be required to access the users home directory if the logon
3705 server told the client to use itself as the SMB server for home
3706 directories (one over SMB and one over NFS)\&. This can be very
3709 This option allows Samba to return the home share as being on a
3710 different server to the logon server and as long as a Samba daemon is
3711 running on the home directory server, it will be mounted on the Samba
3712 client directly from the directory server\&. When Samba is returning the
3713 home share to the client, it will consult the NIS map specified in
3714 \fB"homedir map"\fP and return the server listed
3717 Note that for this option to work there must be a working NIS
3718 system and the Samba server with this option must also be a
3719 \fBlogon server\fP\&.
3722 \f(CW nis homedir = false\fP
3725 \f(CW nis homedir = true\fP
3727 .IP "\fBnt pipe support (G)\fP"
3729 This boolean parameter controls whether \fBsmbd\fP
3730 will allow Windows NT clients to connect to the NT SMB specific
3731 \f(CWIPC$\fP pipes\&. This is a developer debugging option and can be left
3735 \f(CW nt pipe support = yes\fP
3737 .IP "\fBnt smb support (G)\fP"
3739 This boolean parameter controls whether \fBsmbd\fP
3740 will negotiate NT specific SMB support with Windows NT
3741 clients\&. Although this is a developer debugging option and should be
3742 left alone, benchmarking has discovered that Windows NT clients give
3743 faster performance with this option set to \f(CW"no"\fP\&. This is still
3744 being investigated\&. If this option is set to \f(CW"no"\fP then Samba
3745 offers exactly the same SMB calls that versions prior to Samba2\&.0
3746 offered\&. This information may be of use if any users are having
3747 problems with NT SMB support\&.
3750 \f(CW nt support = yes\fP
3752 .IP "\fBnull passwords (G)\fP"
3754 Allow or disallow client access to accounts that have null passwords\&.
3756 See also \fBsmbpasswd (5)\fP\&.
3759 \f(CW null passwords = no\fP
3762 \f(CW null passwords = yes\fP
3764 .IP "\fBole locking compatibility (G)\fP"
3766 This parameter allows an administrator to turn off the byte range lock
3767 manipulation that is done within Samba to give compatibility for OLE
3768 applications\&. Windows OLE applications use byte range locking as a
3769 form of inter-process communication, by locking ranges of bytes around
3770 the 2^32 region of a file range\&. This can cause certain UNIX lock
3771 managers to crash or otherwise cause problems\&. Setting this parameter
3772 to \f(CW"no"\fP means you trust your UNIX lock manager to handle such cases
3776 \f(CW ole locking compatibility = yes\fP
3779 \f(CW ole locking compatibility = no\fP
3781 .IP "\fBonly guest (S)\fP"
3783 A synonym for \fB"guest only"\fP\&.
3785 .IP "\fBonly user (S)\fP"
3787 This is a boolean option that controls whether connections with
3788 usernames not in the \fBuser=\fP list will be allowed\&. By
3789 default this option is disabled so a client can supply a username to
3790 be used by the server\&.
3792 Note that this also means Samba won\'t try to deduce usernames from the
3793 service name\&. This can be annoying for the \fB[homes]\fP
3794 section\&. To get around this you could use "\fBuser\fP =
3795 \fB%S\fP" which means your \fB"user"\fP list
3796 will be just the service name, which for home directories is the name
3799 See also the \fBuser\fP parameter\&.
3802 \f(CW only user = False\fP
3805 \f(CW only user = True\fP
3807 .IP "\fBoplocks (S)\fP"
3809 This boolean option tells smbd whether to issue oplocks (opportunistic
3810 locks) to file open requests on this share\&. The oplock code can
3811 dramatically (approx\&. 30% or more) improve the speed of access to files
3812 on Samba servers\&. It allows the clients to aggressively cache files
3813 locally and you may want to disable this option for unreliable network
3814 environments (it is turned on by default in Windows NT Servers)\&. For
3815 more information see the file Speed\&.txt in the Samba docs/ directory\&.
3817 Oplocks may be selectively turned off on certain files on a per share basis\&.
3818 See the \'veto oplock files\' parameter\&. On some systems oplocks are recognized
3819 by the underlying operating system\&. This allows data synchronization between
3820 all access to oplocked files, whether it be via Samba or NFS or a local
3821 UNIX process\&. See the \fBkernel oplocks\fP parameter
3825 \f(CW oplocks = True\fP
3828 \f(CW oplocks = False\fP
3830 .IP "\fBos level (G)\fP"
3832 This integer value controls what level Samba advertises itself as for
3833 browse elections\&. The value of this parameter determines whether
3834 \fBnmbd\fP has a chance of becoming a local master
3835 browser for the \fBWORKGROUP\fP in the local broadcast
3836 area\&. The default is zero, which means \fBnmbd\fP will
3837 lose elections to Windows machines\&. See BROWSING\&.txt in the Samba
3838 docs/ directory for details\&.
3841 \f(CW os level = 0\fP
3844 \f(CW os level = 65 ; This will win against any NT Server\fP
3846 .IP "\fBpacket size (G)\fP"
3848 This is a deprecated parameter that how no effect on the current
3849 Samba code\&. It is left in the parameter list to prevent breaking
3850 old \fBsmb\&.conf\fP files\&.
3852 .IP "\fBpanic action (G)\fP"
3854 This is a Samba developer option that allows a system command to be
3855 called when either \fBsmbd\fP or
3856 \fBnmbd\fP crashes\&. This is usually used to draw
3857 attention to the fact that a problem occurred\&.
3860 \f(CW panic action = <empty string>\fP
3862 .IP "\fBpasswd chat (G)\fP"
3864 This string controls the \fI"chat"\fP conversation that takes places
3865 between \fBsmbd\fP and the local password changing
3866 program to change the users password\&. The string describes a sequence
3867 of response-receive pairs that \fBsmbd\fP uses to
3868 determine what to send to the \fBpasswd\fP program
3869 and what to expect back\&. If the expected output is not received then
3870 the password is not changed\&.
3872 This chat sequence is often quite site specific, depending on what
3873 local methods are used for password control (such as NIS etc)\&.
3875 The string can contain the macros \f(CW"%o"\fP and \f(CW"%n"\fP which are
3876 substituted for the old and new passwords respectively\&. It can also
3877 contain the standard macros \f(CW"\en"\fP, \f(CW"\er"\fP, \f(CW"\et"\fP and \f(CW"\es"\fP
3878 to give line-feed, carriage-return, tab and space\&.
3880 The string can also contain a \f(CW\'*\'\fP which matches any sequence of
3883 Double quotes can be used to collect strings with spaces in them into
3886 If the send string in any part of the chat sequence is a fullstop
3887 \f(CW"\&."\fP then no string is sent\&. Similarly, is the expect string is a
3888 fullstop then no string is expected\&.
3890 Note that if the \fB"unix password sync"\fP
3891 parameter is set to true, then this sequence is called \fI*AS ROOT*\fP
3892 when the SMB password in the smbpasswd file is being changed, without
3893 access to the old password cleartext\&. In this case the old password
3894 cleartext is set to \f(CW""\fP (the empty string)\&.
3896 See also \fB"unix password sync"\fP,
3897 \fB"passwd program"\fP and \fB"passwd chat
3904 passwd chat = "*Enter OLD password*" %o\en "*Enter NEW password*" %n\en "*Reenter NEW password*" %n\en "*Password changed*"
3914 passwd chat = *old*password* %o\en *new*password* %n\en *new*password* %n\en *changed*
3919 .IP "\fBpasswd chat debug (G)\fP"
3921 This boolean specifies if the passwd chat script parameter is run in
3922 \f(CW"debug"\fP mode\&. In this mode the strings passed to and received from
3923 the passwd chat are printed in the \fBsmbd\fP log with
3924 a \fB"debug level"\fP of 100\&. This is a dangerous
3925 option as it will allow plaintext passwords to be seen in the
3926 \fBsmbd\fP log\&. It is available to help Samba admins
3927 debug their \fB"passwd chat"\fP scripts when calling
3928 the \fB"passwd program"\fP and should be turned off
3929 after this has been done\&. This parameter is off by default\&.
3931 See also \fB"passwd chat"\fP, \fB"passwd
3935 \f(CW passwd chat debug = True\fP
3938 \f(CW passwd chat debug = False\fP
3940 .IP "\fBpasswd program (G)\fP"
3942 The name of a program that can be used to set UNIX user passwords\&.
3943 Any occurrences of \fB%u\fP will be replaced with the
3944 user name\&. The user name is checked for existence before calling the
3945 password changing program\&.
3947 Also note that many passwd programs insist in \fI"reasonable"\fP
3948 passwords, such as a minimum length, or the inclusion of mixed case
3949 chars and digits\&. This can pose a problem as some clients (such as
3950 Windows for Workgroups) uppercase the password before sending it\&.
3952 \fINote\fP that if the \fB"unix password sync"\fP
3953 parameter is set to \f(CW"True"\fP then this program is called \fI*AS
3954 ROOT*\fP before the SMB password in the
3955 \fBsmbpasswd\fP file is changed\&. If this UNIX
3956 password change fails, then \fBsmbd\fP will fail to
3957 change the SMB password also (this is by design)\&.
3959 If the \fB"unix password sync"\fP parameter is
3960 set this parameter \fIMUST USE ABSOLUTE PATHS\fP for \fIALL\fP programs
3961 called, and must be examined for security implications\&. Note that by
3962 default \fB"unix password sync"\fP is set to
3965 See also \fB"unix password sync"\fP\&.
3968 \f(CW passwd program = /bin/passwd\fP
3971 \f(CW passwd program = /sbin/passwd %u\fP
3973 .IP "\fBpassword level (G)\fP"
3975 Some client/server combinations have difficulty with mixed-case
3976 passwords\&. One offending client is Windows for Workgroups, which for
3977 some reason forces passwords to upper case when using the LANMAN1
3978 protocol, but leaves them alone when using COREPLUS!
3980 This parameter defines the maximum number of characters that may be
3981 upper case in passwords\&.
3983 For example, say the password given was \f(CW"FRED"\fP\&. If \fBpassword
3984 level\fP is set to 1, the following combinations would be tried if
3985 \f(CW"FRED"\fP failed:
3987 \f(CW"Fred"\fP, \f(CW"fred"\fP, \f(CW"fRed"\fP, \f(CW"frEd"\fP, \f(CW"freD"\fP
3989 If \fBpassword level\fP was set to 2, the following combinations would
3992 \f(CW"FRed"\fP, \f(CW"FrEd"\fP, \f(CW"FreD"\fP, \f(CW"fREd"\fP, \f(CW"fReD"\fP,
3993 \f(CW"frED"\fP, \f(CW\&.\&.\fP
3997 The higher value this parameter is set to the more likely it is that a
3998 mixed case password will be matched against a single case
3999 password\&. However, you should be aware that use of this parameter
4000 reduces security and increases the time taken to process a new
4003 A value of zero will cause only two attempts to be made - the password
4004 as is and the password in all-lower case\&.
4007 \f(CW password level = 0\fP
4010 \f(CW password level = 4\fP
4012 .IP "\fBpassword server (G)\fP"
4014 By specifying the name of another SMB server (such as a WinNT box)
4015 with this option, and using \fB"security = domain"\fP or
4016 \fB"security = server"\fP you can get Samba to do all
4017 its username/password validation via a remote server\&.
4019 This options sets the name of the password server to use\&. It must be a
4020 NetBIOS name, so if the machine\'s NetBIOS name is different from its
4021 internet name then you may have to add its NetBIOS name to the lmhosts
4022 file which is stored in the same directory as the \fBsmb\&.conf\fP file\&.
4024 The name of the password server is looked up using the parameter
4025 \fB"name resolve order="\fP and so may resolved
4026 by any method and order described in that parameter\&.
4028 The password server much be a machine capable of using the "LM1\&.2X002"
4029 or the "LM NT 0\&.12" protocol, and it must be in user level security
4032 NOTE: Using a password server means your UNIX box (running Samba) is
4033 only as secure as your password server\&. \fIDO NOT CHOOSE A PASSWORD
4034 SERVER THAT YOU DON\'T COMPLETELY TRUST\fP\&.
4036 Never point a Samba server at itself for password serving\&. This will
4037 cause a loop and could lock up your Samba server!
4039 The name of the password server takes the standard substitutions, but
4040 probably the only useful one is \fB%m\fP, which means
4041 the Samba server will use the incoming client as the password
4042 server\&. If you use this then you better trust your clients, and you
4043 better restrict them with hosts allow!
4045 If the \fB"security"\fP parameter is set to
4046 \fB"domain"\fP, then the list of machines in this option must be a list
4047 of Primary or Backup Domain controllers for the
4048 \fBDomain\fP, as the Samba server is cryptographicly
4049 in that domain, and will use cryptographicly authenticated RPC calls
4050 to authenticate the user logging on\&. The advantage of using
4051 \fB"security=domain"\fP is that if you list
4052 several hosts in the \fB"password server"\fP option then
4053 \fBsmbd\fP will try each in turn till it finds one
4054 that responds\&. This is useful in case your primary server goes down\&.
4056 If the \fB"security"\fP parameter is set to
4057 \fB"server"\fP, then there are different
4058 restrictions that \fB"security=domain"\fP
4059 doesn\'t suffer from:
4063 You may list several password servers in the \fB"password server"\fP
4064 parameter, however if an \fBsmbd\fP makes a connection
4065 to a password server, and then the password server fails, no more
4066 users will be able to be authenticated from this
4067 \fBsmbd\fP\&. This is a restriction of the SMB/CIFS
4068 protocol when in \fB"security=server"\fP mode
4069 and cannot be fixed in Samba\&.
4072 If you are using a Windows NT server as your password server then
4073 you will have to ensure that your users are able to login from the
4074 Samba server, as when in
4075 \fB"security=server"\fP mode the network
4076 logon will appear to come from there rather than from the users
4080 See also the \fB"security"\fP parameter\&.
4083 \f(CW password server = <empty string>\fP
4086 \f(CW password server = NT-PDC, NT-BDC1, NT-BDC2\fP
4088 .IP "\fBpath (S)\fP"
4090 This parameter specifies a directory to which the user of the service
4091 is to be given access\&. In the case of printable services, this is
4092 where print data will spool prior to being submitted to the host for
4095 For a printable service offering guest access, the service should be
4096 readonly and the path should be world-writeable and have the sticky bit
4097 set\&. This is not mandatory of course, but you probably won\'t get the
4098 results you expect if you do otherwise\&.
4100 Any occurrences of \fB%u\fP in the path will be replaced
4101 with the UNIX username that the client is using on this
4102 connection\&. Any occurrences of \fB%m\fP will be replaced
4103 by the NetBIOS name of the machine they are connecting from\&. These
4104 replacements are very useful for setting up pseudo home directories
4107 Note that this path will be based on \fB"root dir"\fP if
4108 one was specified\&.
4114 \f(CW path = /home/fred\fP
4116 .IP "\fBpostexec (S)\fP"
4118 This option specifies a command to be run whenever the service is
4119 disconnected\&. It takes the usual substitutions\&. The command may be run
4120 as the root on some systems\&.
4122 An interesting example may be do unmount server resources:
4124 \f(CWpostexec = /etc/umount /cdrom\fP
4126 See also \fBpreexec\fP\&.
4129 \f(CW none (no command executed)\fP
4132 \f(CW postexec = echo "%u disconnected from %S from %m (%I)" >> /tmp/log\fP
4134 .IP "\fBpostscript (S)\fP"
4136 This parameter forces a printer to interpret the print files as
4137 postscript\&. This is done by adding a \f(CW%!\fP to the start of print output\&.
4139 This is most useful when you have lots of PCs that persist in putting
4140 a control-D at the start of print jobs, which then confuses your
4144 \f(CW postscript = False\fP
4147 \f(CW postscript = True\fP
4149 .IP "\fBpreexec (S)\fP"
4151 This option specifies a command to be run whenever the service is
4152 connected to\&. It takes the usual substitutions\&.
4154 An interesting example is to send the users a welcome message every
4155 time they log in\&. Maybe a message of the day? Here is an example:
4161 preexec = csh -c \'echo \e"Welcome to %S!\e" | /usr/local/samba/bin/smbclient -M %m -I %I\' &
4167 Of course, this could get annoying after a while :-)
4169 See also \fBpostexec\fP\&.
4172 \f(CW none (no command executed)\fP
4175 \f(CW preexec = echo \e"%u connected to %S from %m (%I)\e" >> /tmp/log\fP
4177 .IP "\fBpreferred master (G)\fP"
4179 This boolean parameter controls if \fBnmbd\fP is a
4180 preferred master browser for its workgroup\&.
4182 If this is set to true, on startup, \fBnmbd\fP will
4183 force an election, and it will have a slight advantage in winning the
4184 election\&. It is recommended that this parameter is used in
4185 conjunction with \fB"domain master = yes"\fP, so
4186 that \fBnmbd\fP can guarantee becoming a domain
4189 Use this option with caution, because if there are several hosts
4190 (whether Samba servers, Windows 95 or NT) that are preferred master
4191 browsers on the same subnet, they will each periodically and
4192 continuously attempt to become the local master browser\&. This will
4193 result in unnecessary broadcast traffic and reduced browsing
4196 See also \fBos level\fP\&.
4199 \f(CW preferred master = no\fP
4202 \f(CW preferred master = yes\fP
4204 .IP "\fBprefered master (G)\fP"
4206 Synonym for \fB"preferred master"\fP for people
4207 who cannot spell :-)\&.
4210 Synonym for \fB"auto services"\fP\&.
4212 .IP "\fBpreserve case (S)\fP"
4214 This controls if new filenames are created with the case that the
4215 client passes, or if they are forced to be the \f(CW"default"\fP case\&.
4218 \f(CW preserve case = yes\fP
4220 See the section on \fB"NAME MANGLING"\fP for a
4221 fuller discussion\&.
4223 .IP "\fBprint command (S)\fP"
4225 After a print job has finished spooling to a service, this command
4226 will be used via a \f(CWsystem()\fP call to process the spool
4227 file\&. Typically the command specified will submit the spool file to
4228 the host\'s printing subsystem, but there is no requirement that this
4229 be the case\&. The server will not remove the spool file, so whatever
4230 command you specify should remove the spool file when it has been
4231 processed, otherwise you will need to manually remove old spool files\&.
4233 The print command is simply a text string\&. It will be used verbatim,
4234 with two exceptions: All occurrences of \f(CW"%s"\fP will be replaced by
4235 the appropriate spool file name, and all occurrences of \f(CW"%p"\fP will
4236 be replaced by the appropriate printer name\&. The spool file name is
4237 generated automatically by the server, the printer name is discussed
4240 The full path name will be used for the filename if \f(CW"%s"\fP is not
4241 preceded by a \f(CW\'/\'\fP\&. If you don\'t like this (it can stuff up some
4242 lpq output) then use \f(CW"%f"\fP instead\&. Any occurrences of \f(CW"%f"\fP get
4243 replaced by the spool filename without the full path at the front\&.
4245 The print command \fIMUST\fP contain at least one occurrence of \f(CW"%s"\fP
4246 or \f(CW"%f"\fP - the \f(CW"%p"\fP is optional\&. At the time a job is
4247 submitted, if no printer name is supplied the \f(CW"%p"\fP will be
4248 silently removed from the printer command\&.
4250 If specified in the \fB"[global]"\fP section, the print
4251 command given will be used for any printable service that does not
4252 have its own print command specified\&.
4254 If there is neither a specified print command for a printable service
4255 nor a global print command, spool files will be created but not
4256 processed and (most importantly) not removed\&.
4258 Note that printing may fail on some UNIXs from the \f(CW"nobody"\fP
4259 account\&. If this happens then create an alternative guest account that
4260 can print and set the \fB"guest account"\fP in the
4261 \fB"[global]"\fP section\&.
4263 You can form quite complex print commands by realizing that they are
4264 just passed to a shell\&. For example the following will log a print
4265 job, print the file, then remove it\&. Note that \f(CW\';\'\fP is the usual
4266 separator for command in shell scripts\&.
4268 \f(CWprint command = echo Printing %s >> /tmp/print\&.log; lpr -P %p %s; rm %s\fP
4270 You may have to vary this command considerably depending on how you
4271 normally print files on your system\&. The default for the parameter
4272 varies depending on the setting of the \fB"printing="\fP
4276 For \fB"printing="\fP BSD, AIX, QNX, LPRNG or PLP :
4277 \f(CW print command = lpr -r -P%p %s\fP
4279 For \fB"printing="\fP SYS or HPUX :
4280 \f(CW print command = lp -c -d%p %s; rm %s\fP
4282 For \fB"printing="\fP SOFTQ :
4283 \f(CW print command = lp -d%p -s %s; rm %s\fP
4286 \f(CW print command = /usr/local/samba/bin/myprintscript %p %s\fP
4288 .IP "\fBprint ok (S)\fP"
4290 Synonym for \fBprintable\fP\&.
4292 .IP "\fBprintable (S)\fP"
4294 If this parameter is \f(CW"yes"\fP, then clients may open, write to and
4295 submit spool files on the directory specified for the service\&.
4297 Note that a printable service will ALWAYS allow writing to the service
4298 path (user privileges permitting) via the spooling of print data\&. The
4299 \fB"read only"\fP parameter controls only non-printing
4300 access to the resource\&.
4303 \f(CW printable = no\fP
4306 \f(CW printable = yes\fP
4308 .IP "\fBprintcap (G)\fP"
4310 Synonym for \fBprintcapname\fP\&.
4312 .IP "\fBprintcap name (G)\fP"
4314 This parameter may be used to override the compiled-in default
4315 printcap name used by the server (usually /etc/printcap)\&. See the
4316 discussion of the \fB[printers]\fP section above for
4317 reasons why you might want to do this\&.
4319 On System V systems that use \fBlpstat\fP to list available printers you
4320 can use \f(CW"printcap name = lpstat"\fP to automatically obtain lists of
4321 available printers\&. This is the default for systems that define SYSV
4322 at configure time in Samba (this includes most System V based
4323 systems)\&. If \fB"printcap name"\fP is set to \fBlpstat\fP on these systems
4324 then Samba will launch \f(CW"lpstat -v"\fP and attempt to parse the output
4325 to obtain a printer list\&.
4327 A minimal printcap file would look something like this:
4343 where the \f(CW\'|\'\fP separates aliases of a printer\&. The fact that the
4344 second alias has a space in it gives a hint to Samba that it\'s a
4347 \fINOTE\fP: Under AIX the default printcap name is
4348 \f(CW"/etc/qconfig"\fP\&. Samba will assume the file is in AIX \f(CW"qconfig"\fP
4349 format if the string \f(CW"/qconfig"\fP appears in the printcap filename\&.
4352 \f(CW printcap name = /etc/printcap\fP
4355 \f(CW printcap name = /etc/myprintcap\fP
4357 .IP "\fBprinter (S)\fP"
4359 This parameter specifies the name of the printer to which print jobs
4360 spooled through a printable service will be sent\&.
4362 If specified in the \fB[global]\fP section, the printer
4363 name given will be used for any printable service that does not have
4364 its own printer name specified\&.
4367 none (but may be \f(CW"lp"\fP on many systems)
4370 printer name = laserwriter
4372 .IP "\fBprinter driver (S)\fP"
4374 This option allows you to control the string that clients receive when
4375 they ask the server for the printer driver associated with a
4376 printer\&. If you are using Windows95 or WindowsNT then you can use this
4377 to automate the setup of printers on your system\&.
4379 You need to set this parameter to the exact string (case sensitive)
4380 that describes the appropriate printer driver for your system\&. If you
4381 don\'t know the exact string to use then you should first try with no
4382 \fB"printer driver"\fP option set and the client will give you a list of
4383 printer drivers\&. The appropriate strings are shown in a scrollbox
4384 after you have chosen the printer manufacturer\&.
4386 See also \fB"printer driver file"\fP\&.
4389 printer driver = HP LaserJet 4L
4391 .IP "\fBprinter driver file (G)\fP"
4393 This parameter tells Samba where the printer driver definition file,
4394 used when serving drivers to Windows 95 clients, is to be found\&. If
4395 this is not set, the default is :
4397 \f(CWSAMBA_INSTALL_DIRECTORY/lib/printers\&.def\fP
4399 This file is created from Windows 95 \f(CW"msprint\&.def"\fP files found on
4400 the Windows 95 client system\&. For more details on setting up serving
4401 of printer drivers to Windows 95 clients, see the documentation file
4402 in the docs/ directory, PRINTER_DRIVER\&.txt\&.
4405 \f(CW None (set in compile)\&.\fP
4408 \f(CW printer driver file = /usr/local/samba/printers/drivers\&.def\fP
4410 See also \fB"printer driver location"\fP\&.
4412 .IP "\fBprinter driver location (S)\fP"
4414 This parameter tells clients of a particular printer share where to
4415 find the printer driver files for the automatic installation of
4416 drivers for Windows 95 machines\&. If Samba is set up to serve printer
4417 drivers to Windows 95 machines, this should be set to
4419 \f(CW\e\eMACHINE\eaPRINTER$\fP
4421 Where MACHINE is the NetBIOS name of your Samba server, and PRINTER$
4422 is a share you set up for serving printer driver files\&. For more
4423 details on setting this up see the documentation file in the docs/
4424 directory, PRINTER_DRIVER\&.txt\&.
4430 \f(CW printer driver location = \e\eMACHINE\ePRINTER$\fP
4432 See also \fB"printer driver file"\fP\&.
4434 .IP "\fBprinter name (S)\fP"
4436 Synonym for \fBprinter\fP\&.
4438 .IP "\fBprinting (S)\fP"
4440 This parameters controls how printer status information is interpreted
4441 on your system, and also affects the default values for the
4442 \fB"print command"\fP, \fB"lpq
4443 command"\fP \fB"lppause command"\fP,
4444 \fB"lpresume command"\fP, and \fB"lprm
4447 Currently eight printing styles are supported\&. They are
4448 \fB"printing=BSD"\fP, \fB"printing=AIX"\fP, \fB"printing=LPRNG"\fP,
4449 \fB"printing=PLP"\fP,
4450 \fB"printing=SYSV"\fP,\fB"printing="HPUX"\fP,\fB"printing=QNX"\fP and
4451 \fB"printing=SOFTQ"\fP\&.
4453 To see what the defaults are for the other print commands when using
4454 these three options use the \fB"testparm"\fP program\&.
4456 This option can be set on a per printer basis
4458 See also the discussion in the \fB[printers]\fP section\&.
4460 .IP "\fBprotocol (G)\fP"
4462 The value of the parameter (a string) is the highest protocol level
4463 that will be supported by the server\&.
4465 Possible values are :
4469 CORE: Earliest version\&. No concept of user names\&.
4472 COREPLUS: Slight improvements on CORE for efficiency\&.
4475 LANMAN1: First \fI"modern"\fP version of the protocol\&. Long
4479 LANMAN2: Updates to Lanman1 protocol\&.
4482 NT1: Current up to date version of the protocol\&. Used by Windows
4483 NT\&. Known as CIFS\&.
4486 Normally this option should not be set as the automatic negotiation
4487 phase in the SMB protocol takes care of choosing the appropriate
4491 \f(CW protocol = NT1\fP
4494 \f(CW protocol = LANMAN1\fP
4496 .IP "\fBpublic (S)\fP"
4498 Synonym for \fB"guest ok"\fP\&.
4500 .IP "\fBqueuepause command (S)\fP"
4502 This parameter specifies the command to be executed on the server host
4503 in order to pause the printerqueue\&.
4505 This command should be a program or script which takes a printer name
4506 as its only parameter and stops the printerqueue, such that no longer
4507 jobs are submitted to the printer\&.
4509 This command is not supported by Windows for Workgroups, but can be
4510 issued from the Printer\'s window under Windows 95 & NT\&.
4512 If a \f(CW"%p"\fP is given then the printername is put in its
4513 place\&. Otherwise it is placed at the end of the command\&.
4515 Note that it is good practice to include the absolute path in the
4516 command as the PATH may not be available to the server\&.
4519 \f(CW depends on the setting of "printing ="\fP
4522 \f(CW queuepause command = disable %p\fP
4524 .IP "\fBqueueresume command (S)\fP"
4526 This parameter specifies the command to be executed on the server host
4527 in order to resume the printerqueue\&. It is the command to undo the
4528 behavior that is caused by the previous parameter
4529 (\fB"queuepause command\fP)\&.
4531 This command should be a program or script which takes a printer name
4532 as its only parameter and resumes the printerqueue, such that queued
4533 jobs are resubmitted to the printer\&.
4535 This command is not supported by Windows for Workgroups, but can be
4536 issued from the Printer\'s window under Windows 95 & NT\&.
4538 If a \f(CW"%p"\fP is given then the printername is put in its
4539 place\&. Otherwise it is placed at the end of the command\&.
4541 Note that it is good practice to include the absolute path in the
4542 command as the PATH may not be available to the server\&.
4545 \f(CW depends on the setting of "printing ="\fP
4548 \f(CW queuepause command = enable %p\fP
4550 .IP "\fBread bmpx (G)\fP"
4552 This boolean parameter controls whether \fBsmbd\fP
4553 will support the "Read Block Multiplex" SMB\&. This is now rarely used
4554 and defaults to off\&. You should never need to set this parameter\&.
4559 .IP "\fBread list (S)\fP"
4561 This is a list of users that are given read-only access to a
4562 service\&. If the connecting user is in this list then they will not be
4563 given write access, no matter what the \fB"read only"\fP
4564 option is set to\&. The list can include group names using the syntax
4565 described in the \fB"invalid users"\fP parameter\&.
4567 See also the \fB"write list"\fP parameter and
4568 the \fB"invalid users"\fP parameter\&.
4571 \f(CW read list = <empty string>\fP
4574 \f(CW read list = mary, @students\fP
4576 .IP "\fBread only (S)\fP"
4578 Note that this is an inverted synonym for
4579 \fB"writeable"\fP and \fB"write ok"\fP\&.
4581 See also \fB"writeable"\fP and \fB"write
4584 .IP "\fBread prediction (G)\fP"
4586 \fINOTE\fP: This code is currently disabled in Samba2\&.0 and
4587 may be removed at a later date\&. Hence this parameter has
4590 This options enables or disables the read prediction code used to
4591 speed up reads from the server\&. When enabled the server will try to
4592 pre-read data from the last accessed file that was opened read-only
4593 while waiting for packets\&.
4596 \f(CW read prediction = False\fP
4598 .IP "\fBread raw (G)\fP"
4600 This parameter controls whether or not the server will support the raw
4601 read SMB requests when transferring data to clients\&.
4603 If enabled, raw reads allow reads of 65535 bytes in one packet\&. This
4604 typically provides a major performance benefit\&.
4606 However, some clients either negotiate the allowable block size
4607 incorrectly or are incapable of supporting larger block sizes, and for
4608 these clients you may need to disable raw reads\&.
4610 In general this parameter should be viewed as a system tuning tool and left
4611 severely alone\&. See also \fB"write raw"\fP\&.
4614 \f(CW read raw = yes\fP
4616 .IP "\fBread size (G)\fP"
4618 The option \fB"read size"\fP affects the overlap of disk reads/writes
4619 with network reads/writes\&. If the amount of data being transferred in
4620 several of the SMB commands (currently SMBwrite, SMBwriteX and
4621 SMBreadbraw) is larger than this value then the server begins writing
4622 the data before it has received the whole packet from the network, or
4623 in the case of SMBreadbraw, it begins writing to the network before
4624 all the data has been read from disk\&.
4626 This overlapping works best when the speeds of disk and network access
4627 are similar, having very little effect when the speed of one is much
4628 greater than the other\&.
4630 The default value is 2048, but very little experimentation has been
4631 done yet to determine the optimal value, and it is likely that the
4632 best value will vary greatly between systems anyway\&. A value over
4633 65536 is pointless and will cause you to allocate memory
4637 \f(CW read size = 2048\fP
4640 \f(CW read size = 8192\fP
4642 .IP "\fBremote announce (G)\fP"
4644 This option allows you to setup \fBnmbd\fP to
4645 periodically announce itself to arbitrary IP addresses with an
4646 arbitrary workgroup name\&.
4648 This is useful if you want your Samba server to appear in a remote
4649 workgroup for which the normal browse propagation rules don\'t
4650 work\&. The remote workgroup can be anywhere that you can send IP
4655 \f(CW remote announce = 192\&.168\&.2\&.255/SERVERS 192\&.168\&.4\&.255/STAFF\fP
4657 the above line would cause nmbd to announce itself to the two given IP
4658 addresses using the given workgroup names\&. If you leave out the
4659 workgroup name then the one given in the
4660 \fB"workgroup"\fP parameter is used instead\&.
4662 The IP addresses you choose would normally be the broadcast addresses
4663 of the remote networks, but can also be the IP addresses of known
4664 browse masters if your network config is that stable\&.
4666 See the documentation file BROWSING\&.txt in the docs/ directory\&.
4669 \f(CW remote announce = <empty string>\fP
4672 \f(CW remote announce = 192\&.168\&.2\&.255/SERVERS 192\&.168\&.4\&.255/STAFF\fP
4674 .IP "\fBremote browse sync (G)\fP"
4676 This option allows you to setup \fBnmbd\fP to
4677 periodically request synchronization of browse lists with the master
4678 browser of a samba server that is on a remote segment\&. This option
4679 will allow you to gain browse lists for multiple workgroups across
4680 routed networks\&. This is done in a manner that does not work with any
4681 non-samba servers\&.
4683 This is useful if you want your Samba server and all local clients to
4684 appear in a remote workgroup for which the normal browse propagation
4685 rules don\'t work\&. The remote workgroup can be anywhere that you can
4686 send IP packets to\&.
4690 \f(CW remote browse sync = 192\&.168\&.2\&.255 192\&.168\&.4\&.255\fP
4692 the above line would cause \fBnmbd\fP to request the
4693 master browser on the specified subnets or addresses to synchronize
4694 their browse lists with the local server\&.
4696 The IP addresses you choose would normally be the broadcast addresses
4697 of the remote networks, but can also be the IP addresses of known
4698 browse masters if your network config is that stable\&. If a machine IP
4699 address is given Samba makes NO attempt to validate that the remote
4700 machine is available, is listening, nor that it is in fact the browse
4701 master on it\'s segment\&.
4704 \f(CW remote browse sync = <empty string>\fP
4707 \f(CW remote browse sync = 192\&.168\&.2\&.255 192\&.168\&.4\&.255\fP
4709 .IP "\fBrevalidate (S)\fP"
4711 Note that this option only works with
4712 \fB"security=share"\fP and will be ignored if
4713 this is not the case\&.
4715 This option controls whether Samba will allow a previously validated
4716 username/password pair to be used to attach to a share\&. Thus if you
4717 connect to \f(CW\e\eserver\eshare1\fP then to \f(CW\e\eserver\eshare2\fP it won\'t
4718 automatically allow the client to request connection to the second
4719 share as the same username as the first without a password\&.
4721 If \fB"revalidate"\fP is \f(CW"True"\fP then the client will be denied
4722 automatic access as the same username\&.
4725 \f(CW revalidate = False\fP
4728 \f(CW revalidate = True\fP
4730 .IP "\fBroot (G)\fP"
4732 Synonym for \fB"root directory"\fP\&.
4734 .IP "\fBroot dir (G)\fP"
4736 Synonym for \fB"root directory"\fP\&.
4738 .IP "\fBroot directory (G)\fP"
4740 The server will \f(CW"chroot()"\fP (i\&.e\&. Change it\'s root directory) to
4741 this directory on startup\&. This is not strictly necessary for secure
4742 operation\&. Even without it the server will deny access to files not in
4743 one of the service entries\&. It may also check for, and deny access to,
4744 soft links to other parts of the filesystem, or attempts to use
4745 \f(CW"\&.\&."\fP in file names to access other directories (depending on the
4746 setting of the \fB"wide links"\fP parameter)\&.
4748 Adding a \fB"root directory"\fP entry other than \f(CW"/"\fP adds an extra
4749 level of security, but at a price\&. It absolutely ensures that no
4750 access is given to files not in the sub-tree specified in the \fB"root
4751 directory"\fP option, \fI*including*\fP some files needed for complete
4752 operation of the server\&. To maintain full operability of the server
4753 you will need to mirror some system files into the \fB"root
4754 directory"\fP tree\&. In particular you will need to mirror /etc/passwd
4755 (or a subset of it), and any binaries or configuration files needed
4756 for printing (if required)\&. The set of files that must be mirrored is
4757 operating system dependent\&.
4760 \f(CW root directory = /\fP
4763 \f(CW root directory = /homes/smb\fP
4765 .IP "\fBroot postexec (S)\fP"
4767 This is the same as the \fB"postexec"\fP parameter
4768 except that the command is run as root\&. This is useful for unmounting
4769 filesystems (such as cdroms) after a connection is closed\&.
4771 See also \fB"postexec"\fP\&.
4773 .IP "\fBroot preexec (S)\fP"
4775 This is the same as the \fB"preexec"\fP parameter except
4776 that the command is run as root\&. This is useful for mounting
4777 filesystems (such as cdroms) before a connection is finalized\&.
4779 See also \fB"preexec"\fP\&.
4781 .IP "\fBsecurity (G)\fP"
4783 This option affects how clients respond to Samba and is one of the most
4784 important settings in the \fBsmb\&.conf\fP file\&.
4786 The option sets the \f(CW"security mode bit"\fP in replies to protocol
4787 negotiations with \fBsmbd\fP to turn share level
4788 security on or off\&. Clients decide based on this bit whether (and how)
4789 to transfer user and password information to the server\&.
4791 The default is "security=user", as this is
4792 the most common setting needed when talking to Windows 98 and Windows
4795 The alternatives are \fB"security = share"\fP,
4796 \fB"security = server"\fP or
4797 \fB"security=domain"\fP\&.
4799 \fI*****NOTE THAT THIS DEFAULT IS DIFFERENT IN SAMBA2\&.0 THAN FOR
4800 PREVIOUS VERSIONS OF SAMBA *******\fP\&.
4802 In previous versions of Samba the default was
4803 \fB"security=share"\fP mainly because that was
4804 the only option at one stage\&.
4806 There is a bug in WfWg that has relevance to this setting\&. When in
4807 user or server level security a WfWg client will totally ignore the
4808 password you type in the "connect drive" dialog box\&. This makes it
4809 very difficult (if not impossible) to connect to a Samba service as
4810 anyone except the user that you are logged into WfWg as\&.
4812 If your PCs use usernames that are the same as their usernames on the
4813 UNIX machine then you will want to use \fB"security = user"\fP\&. If you
4814 mostly use usernames that don\'t exist on the UNIX box then use
4815 \fB"security = share"\fP\&.
4817 You should also use \fBsecurity=share\fP if
4818 you want to mainly setup shares without a password (guest
4819 shares)\&. This is commonly used for a shared printer server\&. It is more
4820 difficult to setup guest shares with
4821 \fBsecurity=user\fP, see the \fB"map to
4822 guest"\fPparameter for details\&.
4824 It is possible to use \fBsmbd\fP in a \fI"hybrid
4825 mode"\fP where it is offers both user and share level security under
4826 different \fBNetBIOS aliases\fP\&. See the
4827 \fBNetBIOS aliases\fP and the
4828 \fBinclude\fP parameters for more information\&.
4830 The different settings will now be explained\&.
4833 .IP "\fB"security=share"\fP"
4834 When clients connect to a share level
4835 security server then need not log onto the server with a valid
4836 username and password before attempting to connect to a shared
4837 resource (although modern clients such as Windows 95/98 and Windows NT
4838 will send a logon request with a username but no password when talking
4839 to a \fBsecurity=share\fP server)\&. Instead, the clients send
4840 authentication information (passwords) on a per-share basis, at the
4841 time they attempt to connect to that share\&.
4843 Note that \fBsmbd\fP \fI*ALWAYS*\fP uses a valid UNIX
4844 user to act on behalf of the client, even in \fB"security=share"\fP
4847 As clients are not required to send a username to the server
4848 in share level security, \fBsmbd\fP uses several
4849 techniques to determine the correct UNIX user to use on behalf
4852 A list of possible UNIX usernames to match with the given
4853 client password is constructed using the following methods :
4857 If the \fB"guest only"\fP parameter is set, then
4858 all the other stages are missed and only the \fB"guest
4859 account"\fP username is checked\&.
4862 Is a username is sent with the share connection request, then
4863 this username (after mapping - see \fB"username
4864 map"\fP), is added as a potential username\&.
4867 If the client did a previous \fI"logon"\fP request (the
4868 SessionSetup SMB call) then the username sent in this SMB
4869 will be added as a potential username\&.
4872 The name of the service the client requested is added
4873 as a potential username\&.
4876 The NetBIOS name of the client is added to the list as a
4877 potential username\&.
4880 Any users on the \fB"user"\fP list are added
4881 as potential usernames\&.
4884 If the \fB"guest only"\fP parameter is not set, then
4885 this list is then tried with the supplied password\&. The first user for
4886 whom the password matches will be used as the UNIX user\&.
4888 If the \fB"guest only"\fP parameter is set, or no
4889 username can be determined then if the share is marked as available to
4890 the \fB"guest account"\fP, then this guest user will
4891 be used, otherwise access is denied\&.
4893 Note that it can be \fI*very*\fP confusing in share-level security as to
4894 which UNIX username will eventually be used in granting access\&.
4896 See also the section \fB"NOTE ABOUT USERNAME/PASSWORD
4899 .IP "\fB"security=user"\fP"
4901 This is the default security setting in Samba2\&.0\&. With user-level
4902 security a client must first \f(CW"log-on"\fP with a valid username and
4903 password (which can be mapped using the \fB"username
4904 map"\fP parameter)\&. Encrypted passwords (see the
4905 \fB"encrypted passwords"\fP parameter) can also
4906 be used in this security mode\&. Parameters such as
4907 \fB"user"\fP and \fB"guest only"\fP, if set
4908 are then applied and may change the UNIX user to use on this
4909 connection, but only after the user has been successfully
4912 \fINote\fP that the name of the resource being requested is
4913 \fI*not*\fP sent to the server until after the server has successfully
4914 authenticated the client\&. This is why guest shares don\'t work in user
4915 level security without allowing the server to automatically map unknown
4916 users into the \fB"guest account"\fP\&. See the
4917 \fB"map to guest"\fP parameter for details on
4920 See also the section \fB"NOTE ABOUT USERNAME/PASSWORD
4923 .IP "\fB"security=server"\fP"
4925 In this mode Samba will try to validate the username/password by
4926 passing it to another SMB server, such as an NT box\&. If this fails it
4927 will revert to \fB"security = user"\fP, but note that if encrypted
4928 passwords have been negotiated then Samba cannot revert back to
4929 checking the UNIX password file, it must have a valid smbpasswd file
4930 to check users against\&. See the documentation file in the docs/
4931 directory ENCRYPTION\&.txt for details on how to set this up\&.
4933 \fINote\fP that from the clients point of view \fB"security=server"\fP is
4934 the same as \fB"security=user"\fP\&. It only
4935 affects how the server deals with the authentication, it does not in
4936 any way affect what the client sees\&.
4938 \fINote\fP that the name of the resource being requested is
4939 \fI*not*\fP sent to the server until after the server has successfully
4940 authenticated the client\&. This is why guest shares don\'t work in server
4941 level security without allowing the server to automatically map unknown
4942 users into the \fB"guest account"\fP\&. See the
4943 \fB"map to guest"\fP parameter for details on
4946 See also the section \fB"NOTE ABOUT USERNAME/PASSWORD
4949 See also the \fB"password server"\fP parameter\&.
4950 and the \fB"encrypted passwords"\fP parameter\&.
4952 .IP "\fB"security=domain"\fP"
4954 This mode will only work correctly if
4955 \fBsmbpasswd\fP has been used to add this machine
4956 into a Windows NT Domain\&. It expects the \fB"encrypted
4957 passwords"\fP parameter to be set to \f(CW"true"\fP\&. In
4958 this mode Samba will try to validate the username/password by passing
4959 it to a Windows NT Primary or Backup Domain Controller, in exactly the
4960 same way that a Windows NT Server would do\&.
4962 \fINote\fP that a valid UNIX user must still exist as well as the
4963 account on the Domain Controller to allow Samba to have a valid
4964 UNIX account to map file access to\&.
4966 \fINote\fP that from the clients point of view \fB"security=domain"\fP is
4967 the same as \fB"security=user"\fP\&. It only
4968 affects how the server deals with the authentication, it does not in
4969 any way affect what the client sees\&.
4971 \fINote\fP that the name of the resource being requested is
4972 \fI*not*\fP sent to the server until after the server has successfully
4973 authenticated the client\&. This is why guest shares don\'t work in domain
4974 level security without allowing the server to automatically map unknown
4975 users into the \fB"guest account"\fP\&. See the
4976 \fB"map to guest"\fP parameter for details on
4979 e,(BUG:) There is currently a bug in the implementation of
4980 \fB"security=domain\fP with respect to multi-byte character
4981 set usernames\&. The communication with a Domain Controller
4982 must be done in UNICODE and Samba currently does not widen
4983 multi-byte user names to UNICODE correctly, thus a multi-byte
4984 username will not be recognized correctly at the Domain Controller\&.
4985 This issue will be addressed in a future release\&.
4987 See also the section \fB"NOTE ABOUT USERNAME/PASSWORD
4990 See also the \fB"password server"\fP parameter\&.
4991 and the \fB"encrypted passwords"\fP parameter\&.
4995 \f(CW security = USER\fP
4998 \f(CW security = DOMAIN\fP
5000 .IP "\fBserver string (G)\fP"
5002 This controls what string will show up in the printer comment box in
5003 print manager and next to the IPC connection in \f(CW"net view"\fP\&. It can be
5004 any string that you wish to show to your users\&.
5006 It also sets what will appear in browse lists next to the machine
5009 A \f(CW"%v"\fP will be replaced with the Samba version number\&.
5011 A \f(CW"%h"\fP will be replaced with the hostname\&.
5014 \f(CW server string = Samba %v\fP
5017 \f(CW server string = University of GNUs Samba Server\fP
5019 .IP "\fBset directory (S)\fP"
5021 If \f(CW"set directory = no"\fP, then users of the service may not use the
5022 setdir command to change directory\&.
5024 The setdir command is only implemented in the Digital Pathworks
5025 client\&. See the Pathworks documentation for details\&.
5028 \f(CW set directory = no\fP
5031 \f(CW set directory = yes\fP
5033 .IP "\fBshare modes (S)\fP"
5035 This enables or disables the honoring of the \f(CW"share modes"\fP during a
5036 file open\&. These modes are used by clients to gain exclusive read or
5037 write access to a file\&.
5039 These open modes are not directly supported by UNIX, so they are
5040 simulated using shared memory, or lock files if your UNIX doesn\'t
5041 support shared memory (almost all do)\&.
5043 The share modes that are enabled by this option are DENY_DOS,
5044 DENY_ALL, DENY_READ, DENY_WRITE, DENY_NONE and DENY_FCB\&.
5046 This option gives full share compatibility and enabled by default\&.
5048 You should \fI*NEVER*\fP turn this parameter off as many Windows
5049 applications will break if you do so\&.
5052 \f(CW share modes = yes\fP
5054 .IP "\fBshared mem size (G)\fP"
5056 It specifies the size of the shared memory (in bytes) to use between
5057 \fBsmbd\fP processes\&. This parameter defaults to one
5058 megabyte of shared memory\&. It is possible that if you have a large
5059 server with many files open simultaneously that you may need to
5060 increase this parameter\&. Signs that this parameter is set too low are
5061 users reporting strange problems trying to save files (locking errors)
5062 and error messages in the smbd log looking like \f(CW"ERROR
5063 smb_shm_alloc : alloc of XX bytes failed"\fP\&.
5066 \f(CW shared mem size = 1048576\fP
5069 \f(CW shared mem size = 5242880 ; Set to 5mb for a large number of files\&.\fP
5071 .IP "\fBshort preserve case (G)\fP"
5073 This boolean parameter controls if new files which conform to 8\&.3
5074 syntax, that is all in upper case and of suitable length, are created
5075 upper case, or if they are forced to be the \f(CW"default"\fP case\&. This
5076 option can be use with \fB"preserve case
5077 =yes"\fP to permit long filenames to retain their
5078 case, while short names are lowered\&. Default \fIYes\fP\&.
5080 See the section on \fBNAME MANGLING\fP\&.
5083 \f(CW short preserve case = yes\fP
5085 .IP "\fBsmb passwd file (G)\fP"
5087 This option sets the path to the encrypted smbpasswd file\&. By default
5088 the path to the smbpasswd file is compiled into Samba\&.
5091 \f(CW smb passwd file= <compiled default>\fP
5094 \f(CW smb passwd file = /usr/samba/private/smbpasswd\fP
5096 .IP "\fBsmbrun (G)\fP"
5098 This sets the full path to the \fBsmbrun\fP binary\&. This defaults to the
5099 value in the Makefile\&.
5101 You must get this path right for many services to work correctly\&.
5103 You should not need to change this parameter so long as Samba
5104 is installed correctly\&.
5107 \f(CW smbrun=<compiled default>\fP
5110 \f(CW smbrun = /usr/local/samba/bin/smbrun\fP
5112 .IP "\fBsocket address (G)\fP"
5114 This option allows you to control what address Samba will listen for
5115 connections on\&. This is used to support multiple virtual interfaces on
5116 the one server, each with a different configuration\&.
5118 By default samba will accept connections on any address\&.
5121 \f(CW socket address = 192\&.168\&.2\&.20\fP
5123 .IP "\fBsocket options (G)\fP"
5125 This option allows you to set socket options to be used when talking
5128 Socket options are controls on the networking layer of the operating
5129 systems which allow the connection to be tuned\&.
5131 This option will typically be used to tune your Samba server for
5132 optimal performance for your local network\&. There is no way that Samba
5133 can know what the optimal parameters are for your net, so you must
5134 experiment and choose them yourself\&. We strongly suggest you read the
5135 appropriate documentation for your operating system first (perhaps
5136 \fB"man setsockopt"\fP will help)\&.
5138 You may find that on some systems Samba will say "Unknown socket
5139 option" when you supply an option\&. This means you either incorrectly
5140 typed it or you need to add an include file to includes\&.h for your OS\&.
5141 If the latter is the case please send the patch to
5142 \fIsamba-bugs@samba\&.anu\&.edu\&.au\fP\&.
5144 Any of the supported socket options may be combined in any way you
5145 like, as long as your OS allows it\&.
5147 This is the list of socket options currently settable using this
5182 Those marked with a \f(CW*\fP take an integer argument\&. The others can
5183 optionally take a 1 or 0 argument to enable or disable the option, by
5184 default they will be enabled if you don\'t specify 1 or 0\&.
5186 To specify an argument use the syntax SOME_OPTION=VALUE for example
5187 \f(CWSO_SNDBUF=8192\fP\&. Note that you must not have any spaces before or after
5190 If you are on a local network then a sensible option might be
5192 \f(CWsocket options = IPTOS_LOWDELAY\fP
5194 If you have a local network then you could try:
5196 \f(CWsocket options = IPTOS_LOWDELAY TCP_NODELAY\fP
5198 If you are on a wide area network then perhaps try setting
5201 Note that several of the options may cause your Samba server to fail
5202 completely\&. Use these options with caution!
5205 \f(CW socket options = TCP_NODELAY\fP
5208 \f(CW socket options = IPTOS_LOWDELAY\fP
5212 This variable is part of SSL-enabled Samba\&. This is only available if
5213 the SSL libraries have been compiled on your system and the configure
5214 option \f(CW"--with-ssl"\fP was given at configure time\&.
5216 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5217 enabled by default in any current binary version of Samba\&.
5219 This variable enables or disables the entire SSL mode\&. If it is set to
5220 "no", the SSL enabled samba behaves exactly like the non-SSL samba\&. If
5221 set to "yes", it depends on the variables \fB"ssl
5222 hosts"\fP and \fB"ssl hosts resign"\fP
5223 whether an SSL connection will be required\&.
5230 .IP "\fBssl CA certDir (G)\fP"
5232 This variable is part of SSL-enabled Samba\&. This is only available if
5233 the SSL libraries have been compiled on your system and the configure
5234 option \f(CW"--with-ssl"\fP was given at configure time\&.
5236 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5237 enabled by default in any current binary version of Samba\&.
5239 This variable defines where to look up the Certification
5240 Authorities\&. The given directory should contain one file for each CA
5241 that samba will trust\&. The file name must be the hash value over the
5242 "Distinguished Name" of the CA\&. How this directory is set up is
5243 explained later in this document\&. All files within the directory that
5244 don\'t fit into this naming scheme are ignored\&. You don\'t need this
5245 variable if you don\'t verify client certificates\&.
5248 \f(CW ssl CA certDir = /usr/local/ssl/certs\fP
5250 .IP "\fBssl CA certFile (G)\fP"
5252 This variable is part of SSL-enabled Samba\&. This is only available if
5253 the SSL libraries have been compiled on your system and the configure
5254 option \f(CW"--with-ssl"\fP was given at configure time\&.
5256 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5257 enabled by default in any current binary version of Samba\&.
5259 This variable is a second way to define the trusted CAs\&. The
5260 certificates of the trusted CAs are collected in one big file and this
5261 variable points to the file\&. You will probably only use one of the two
5262 ways to define your CAs\&. The first choice is preferable if you have
5263 many CAs or want to be flexible, the second is preferable if you only
5264 have one CA and want to keep things simple (you won\'t need to create
5265 the hashed file names)\&. You don\'t need this variable if you don\'t
5266 verify client certificates\&.
5269 \f(CW ssl CA certFile = /usr/local/ssl/certs/trustedCAs\&.pem\fP
5271 .IP "\fBssl ciphers (G)\fP"
5273 This variable is part of SSL-enabled Samba\&. This is only available if
5274 the SSL libraries have been compiled on your system and the configure
5275 option \f(CW"--with-ssl"\fP was given at configure time\&.
5277 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5278 enabled by default in any current binary version of Samba\&.
5280 This variable defines the ciphers that should be offered during SSL
5281 negotiation\&. You should not set this variable unless you know what you
5284 .IP "\fBssl client cert (G)\fP"
5286 This variable is part of SSL-enabled Samba\&. This is only available if
5287 the SSL libraries have been compiled on your system and the configure
5288 option \f(CW"--with-ssl"\fP was given at configure time\&.
5290 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5291 enabled by default in any current binary version of Samba\&.
5293 The certificate in this file is used by
5294 \fBsmbclient\fP if it exists\&. It\'s needed if the
5295 server requires a client certificate\&.
5298 \f(CW ssl client cert = /usr/local/ssl/certs/smbclient\&.pem\fP
5300 .IP "\fBssl client key (G)\fP"
5302 This variable is part of SSL-enabled Samba\&. This is only available if
5303 the SSL libraries have been compiled on your system and the configure
5304 option \f(CW"--with-ssl"\fP was given at configure time\&.
5306 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5307 enabled by default in any current binary version of Samba\&.
5309 This is the private key for \fBsmbclient\fP\&. It\'s
5310 only needed if the client should have a certificate\&.
5313 \f(CW ssl client key = /usr/local/ssl/private/smbclient\&.pem\fP
5315 .IP "\fBssl compatibility (G)\fP"
5317 This variable is part of SSL-enabled Samba\&. This is only available if
5318 the SSL libraries have been compiled on your system and the configure
5319 option \f(CW"--with-ssl"\fP was given at configure time\&.
5321 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5322 enabled by default in any current binary version of Samba\&.
5324 This variable defines whether SSLeay should be configured for bug
5325 compatibility with other SSL implementations\&. This is probably not
5326 desirable because currently no clients with SSL implementations other
5327 than SSLeay exist\&.
5330 \f(CW ssl compatibility = no\fP
5332 .IP "\fBssl hosts (G)\fP"
5334 See \fB"ssl hosts resign"\fP\&.
5336 .IP "\fBssl hosts resign (G)\fP"
5338 This variable is part of SSL-enabled Samba\&. This is only available if
5339 the SSL libraries have been compiled on your system and the configure
5340 option \f(CW"--with-ssl"\fP was given at configure time\&.
5342 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5343 enabled by default in any current binary version of Samba\&.
5345 These two variables define whether samba will go into SSL mode or
5346 not\&. If none of them is defined, samba will allow only SSL
5347 connections\&. If the \fB"ssl hosts"\fP variable lists
5348 hosts (by IP-address, IP-address range, net group or name), only these
5349 hosts will be forced into SSL mode\&. If the \fB"ssl hosts resign"\fP
5350 variable lists hosts, only these hosts will NOT be forced into SSL
5351 mode\&. The syntax for these two variables is the same as for the
5352 \fB"hosts allow"\fP and \fB"hosts
5353 deny"\fP pair of variables, only that the subject of the
5354 decision is different: It\'s not the access right but whether SSL is
5355 used or not\&. See the \fB"allow hosts"\fP parameter for
5356 details\&. The example below requires SSL connections from all hosts
5357 outside the local net (which is 192\&.168\&.*\&.*)\&.
5360 \f(CW ssl hosts = <empty string>\fP
5361 \f(CW ssl hosts resign = <empty string>\fP
5364 \f(CW ssl hosts resign = 192\&.168\&.\fP
5366 .IP "\fBssl require clientcert (G)\fP"
5368 This variable is part of SSL-enabled Samba\&. This is only available if
5369 the SSL libraries have been compiled on your system and the configure
5370 option \f(CW"--with-ssl"\fP was given at configure time\&.
5372 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5373 enabled by default in any current binary version of Samba\&.
5375 If this variable is set to \f(CW"yes"\fP, the server will not tolerate
5376 connections from clients that don\'t have a valid certificate\&. The
5377 directory/file given in \fB"ssl CA certDir"\fP and
5378 \fB"ssl CA certFile"\fP will be used to look up the
5379 CAs that issued the client\'s certificate\&. If the certificate can\'t be
5380 verified positively, the connection will be terminated\&. If this
5381 variable is set to \f(CW"no"\fP, clients don\'t need certificates\&. Contrary
5382 to web applications you really \fI*should*\fP require client
5383 certificates\&. In the web environment the client\'s data is sensitive
5384 (credit card numbers) and the server must prove to be trustworthy\&. In
5385 a file server environment the server\'s data will be sensitive and the
5386 clients must prove to be trustworthy\&.
5389 \f(CW ssl require clientcert = no\fP
5391 .IP "\fBssl require servercert (G)\fP"
5393 This variable is part of SSL-enabled Samba\&. This is only available if
5394 the SSL libraries have been compiled on your system and the configure
5395 option \f(CW"--with-ssl"\fP was given at configure time\&.
5397 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5398 enabled by default in any current binary version of Samba\&.
5400 If this variable is set to \f(CW"yes"\fP, the
5401 \fBsmbclient\fP will request a certificate from
5402 the server\&. Same as \fB"ssl require
5403 clientcert"\fP for the server\&.
5406 \f(CW ssl require servercert = no\fP
5408 .IP "\fBssl server cert (G)\fP"
5410 This variable is part of SSL-enabled Samba\&. This is only available if
5411 the SSL libraries have been compiled on your system and the configure
5412 option \f(CW"--with-ssl"\fP was given at configure time\&.
5414 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5415 enabled by default in any current binary version of Samba\&.
5417 This is the file containing the server\'s certificate\&. The server _must_
5418 have a certificate\&. The file may also contain the server\'s private key\&.
5419 See later for how certificates and private keys are created\&.
5422 \f(CW ssl server cert = <empty string>\fP
5424 .IP "\fBssl server key (G)\fP"
5426 This variable is part of SSL-enabled Samba\&. This is only available if
5427 the SSL libraries have been compiled on your system and the configure
5428 option \f(CW"--with-ssl"\fP was given at configure time\&.
5430 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5431 enabled by default in any current binary version of Samba\&.
5433 This file contains the private key of the server\&. If this variable is
5434 not defined, the key is looked up in the certificate file (it may be
5435 appended to the certificate)\&. The server \fI*must*\fP have a private key
5436 and the certificate \fI*must*\fP match this private key\&.
5439 \f(CW ssl server key = <empty string>\fP
5441 .IP "\fBssl version (G)\fP"
5443 This variable is part of SSL-enabled Samba\&. This is only available if
5444 the SSL libraries have been compiled on your system and the configure
5445 option \f(CW"--with-ssl"\fP was given at configure time\&.
5447 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5448 enabled by default in any current binary version of Samba\&.
5450 This enumeration variable defines the versions of the SSL protocol
5451 that will be used\&. \f(CW"ssl2or3"\fP allows dynamic negotiation of SSL v2
5452 or v3, \f(CW"ssl2"\fP results in SSL v2, \f(CW"ssl3"\fP results in SSL v3 and
5453 "tls1" results in TLS v1\&. TLS (Transport Layer Security) is the
5454 (proposed?) new standard for SSL\&.
5457 \f(CW ssl version = "ssl2or3"\fP
5459 .IP "\fBstat cache (G)\fP"
5461 This parameter determines if \fBsmbd\fP will use a
5462 cache in order to speed up case insensitive name mappings\&. You should
5463 never need to change this parameter\&.
5466 \f(CW stat cache = yes\fP
5468 .IP "\fBstat cache size (G)\fP"
5470 This parameter determines the number of entries in the \fBstat
5471 cache\fP\&. You should never need to change this parameter\&.
5474 \f(CW stat cache size = 50\fP
5476 .IP "\fBstatus (G)\fP"
5478 This enables or disables logging of connections to a status file that
5479 \fBsmbstatus\fP can read\&.
5481 With this disabled \fBsmbstatus\fP won\'t be able
5482 to tell you what connections are active\&. You should never need to
5483 change this parameter\&.
5488 .IP "\fBstrict locking (S)\fP"
5490 This is a boolean that controls the handling of file locking in the
5491 server\&. When this is set to \f(CW"yes"\fP the server will check every read and
5492 write access for file locks, and deny access if locks exist\&. This can
5493 be slow on some systems\&.
5495 When strict locking is \f(CW"no"\fP the server does file lock checks only
5496 when the client explicitly asks for them\&.
5498 Well behaved clients always ask for lock checks when it is important,
5499 so in the vast majority of cases \fB"strict locking = no"\fP is
5503 \f(CW strict locking = no\fP
5506 \f(CW strict locking = yes\fP
5508 .IP "\fBstrict sync (S)\fP"
5510 Many Windows applications (including the Windows 98 explorer shell)
5511 seem to confuse flushing buffer contents to disk with doing a sync to
5512 disk\&. Under UNIX, a sync call forces the process to be suspended until
5513 the kernel has ensured that all outstanding data in kernel disk
5514 buffers has been safely stored onto stable storage\&. This is very slow
5515 and should only be done rarely\&. Setting this parameter to "no" (the
5516 default) means that smbd ignores the Windows applications requests for
5517 a sync call\&. There is only a possibility of losing data if the
5518 operating system itself that Samba is running on crashes, so there is
5519 little danger in this default setting\&. In addition, this fixes many
5520 performance problems that people have reported with the new Windows98
5521 explorer shell file copies\&.
5523 See also the \fB"sync always"\fP parameter\&.
5526 \f(CW strict sync = no\fP
5529 \f(CW strict sync = yes\fP
5531 .IP "\fBstrip dot (G)\fP"
5533 This is a boolean that controls whether to strip trailing dots off
5534 UNIX filenames\&. This helps with some CDROMs that have filenames ending
5538 \f(CW strip dot = no\fP
5541 \f(CW strip dot = yes\fP
5543 .IP "\fBsync always (S)\fP"
5545 This is a boolean parameter that controls whether writes will always
5546 be written to stable storage before the write call returns\&. If this is
5547 false then the server will be guided by the client\'s request in each
5548 write call (clients can set a bit indicating that a particular write
5549 should be synchronous)\&. If this is true then every write will be
5550 followed by a fsync() call to ensure the data is written to disk\&.
5551 Note that the \fB"strict sync"\fP parameter must be
5552 set to \f(CW"yes"\fP in order for this parameter to have any affect\&.
5554 See also the \fB"strict sync"\fP parameter\&.
5557 \f(CW sync always = no\fP
5560 \f(CW sync always = yes\fP
5562 .IP "\fBsyslog (G)\fP"
5564 This parameter maps how Samba debug messages are logged onto the
5565 system syslog logging levels\&. Samba debug level zero maps onto syslog
5566 LOG_ERR, debug level one maps onto LOG_WARNING, debug level two maps
5567 to LOG_NOTICE, debug level three maps onto LOG_INFO\&. The parameter
5568 sets the threshold for doing the mapping, all Samba debug messages
5569 above this threshold are mapped to syslog LOG_DEBUG messages\&.
5574 .IP "\fBsyslog only (G)\fP"
5576 If this parameter is set then Samba debug messages are logged into the
5577 system syslog only, and not to the debug log files\&.
5580 \f(CW syslog only = no\fP
5582 .IP "\fBtime offset (G)\fP"
5584 This parameter is a setting in minutes to add to the normal GMT to
5585 local time conversion\&. This is useful if you are serving a lot of PCs
5586 that have incorrect daylight saving time handling\&.
5589 \f(CW time offset = 0\fP
5592 \f(CW time offset = 60\fP
5595 .IP "\fBtime server (G)\fP"
5597 This parameter determines if \fBnmbd\fP advertises
5598 itself as a time server to Windows clients\&. The default is False\&.
5601 \f(CW time server = False\fP
5604 \f(CW time server = True\fP
5606 .IP "\fBtimestamp logs (G)\fP"
5608 Samba2\&.0 will a timestamps to all log entries by default\&. This
5609 can be distracting if you are attempting to debug a problem\&. This
5610 parameter allows the timestamping to be turned off\&.
5613 \f(CW timestamp logs = True\fP
5616 \f(CW timestamp logs = False\fP
5618 .IP "\fBunix password sync (G)\fP"
5620 This boolean parameter controls whether Samba attempts to synchronize
5621 the UNIX password with the SMB password when the encrypted SMB
5622 password in the smbpasswd file is changed\&. If this is set to true the
5623 program specified in the \fB"passwd program"\fP
5624 parameter is called \fI*AS ROOT*\fP - to allow the new UNIX password to be
5625 set without access to the old UNIX password (as the SMB password has
5626 change code has no access to the old password cleartext, only the
5627 new)\&. By default this is set to \f(CW"false"\fP\&.
5629 See also \fB"passwd program"\fP, \fB"passwd
5633 \f(CW unix password sync = False\fP
5636 \f(CW unix password sync = True\fP
5638 .IP "\fBunix realname (G)\fP"
5640 This boolean parameter when set causes samba to supply the real name
5641 field from the unix password file to the client\&. This is useful for
5642 setting up mail clients and WWW browsers on systems used by more than
5646 \f(CW unix realname = no\fP
5649 \f(CW unix realname = yes\fP
5651 .IP "\fBupdate encrypted (G)\fP"
5653 This boolean parameter allows a user logging on with a plaintext
5654 password to have their encrypted (hashed) password in the smbpasswd
5655 file to be updated automatically as they log on\&. This option allows a
5656 site to migrate from plaintext password authentication (users
5657 authenticate with plaintext password over the wire, and are checked
5658 against a UNIX account database) to encrypted password authentication
5659 (the SMB challenge/response authentication mechanism) without forcing
5660 all users to re-enter their passwords via smbpasswd at the time the
5661 change is made\&. This is a convenience option to allow the change over
5662 to encrypted passwords to be made over a longer period\&. Once all users
5663 have encrypted representations of their passwords in the smbpasswd
5664 file this parameter should be set to \f(CW"off"\fP\&.
5666 In order for this parameter to work correctly the \fB"encrypt
5667 passwords"\fP parameter must be set to \f(CW"no"\fP when
5668 this parameter is set to \f(CW"yes"\fP\&.
5670 Note that even when this parameter is set a user authenticating to
5671 smbd must still enter a valid password in order to connect correctly,
5672 and to update their hashed (smbpasswd) passwords\&.
5675 \f(CW update encrypted = no\fP
5678 \f(CW update encrypted = yes\fP
5680 .IP "\fBuse rhosts (G)\fP"
5682 If this global parameter is a true, it specifies that the UNIX users
5683 \f(CW"\&.rhosts"\fP file in their home directory will be read to find the
5684 names of hosts and users who will be allowed access without specifying
5687 NOTE: The use of \fBuse rhosts\fP can be a major security hole\&. This is
5688 because you are trusting the PC to supply the correct username\&. It is
5689 very easy to get a PC to supply a false username\&. I recommend that the
5690 \fBuse rhosts\fP option be only used if you really know what you are
5694 \f(CW use rhosts = no\fP
5697 \f(CW use rhosts = yes\fP
5699 .IP "\fBuser (S)\fP"
5701 Synonym for \fB"username"\fP\&.
5703 .IP "\fBusers (S)\fP"
5705 Synonym for \fB"username"\fP\&.
5707 .IP "\fBusername (S)\fP"
5709 Multiple users may be specified in a comma-delimited list, in which
5710 case the supplied password will be tested against each username in
5711 turn (left to right)\&.
5713 The \fBusername=\fP line is needed only when the PC is unable to supply
5714 its own username\&. This is the case for the COREPLUS protocol or where
5715 your users have different WfWg usernames to UNIX usernames\&. In both
5716 these cases you may also be better using the \f(CW\e\eserver\eshare%user\fP
5719 The \fBusername=\fP line is not a great solution in many cases as it
5720 means Samba will try to validate the supplied password against each of
5721 the usernames in the username= line in turn\&. This is slow and a bad
5722 idea for lots of users in case of duplicate passwords\&. You may get
5723 timeouts or security breaches using this parameter unwisely\&.
5725 Samba relies on the underlying UNIX security\&. This parameter does not
5726 restrict who can login, it just offers hints to the Samba server as to
5727 what usernames might correspond to the supplied password\&. Users can
5728 login as whoever they please and they will be able to do no more
5729 damage than if they started a telnet session\&. The daemon runs as the
5730 user that they log in as, so they cannot do anything that user cannot
5733 To restrict a service to a particular set of users you can use the
5734 \fB"valid users="\fP parameter\&.
5736 If any of the usernames begin with a \f(CW\'@\'\fP then the name will be
5737 looked up first in the yp netgroups list (if Samba is compiled with
5738 netgroup support), followed by a lookup in the UNIX groups database
5739 and will expand to a list of all users in the group of that name\&.
5741 If any of the usernames begin with a \f(CW\'+\'\fP then the name will be
5742 looked up only in the UNIX groups database and will expand to a list
5743 of all users in the group of that name\&.
5745 If any of the usernames begin with a \f(CW\'&\'\fP then the name will be
5746 looked up only in the yp netgroups database (if Samba is compiled with
5747 netgroup support) and will expand to a list of all users in the
5748 netgroup group of that name\&.
5750 Note that searching though a groups database can take quite some time,
5751 and some clients may time out during the search\&.
5753 See the section \fB"NOTE ABOUT USERNAME/PASSWORD
5754 VALIDATION"\fP for more
5755 information on how this parameter determines access to the services\&.
5758 \f(CW The guest account if a guest service, else the name of the service\&.\fP
5766 username = fred, mary, jack, jane, @users, @pcgroup
5772 .IP "\fBusername level (G)\fP"
5774 This option helps Samba to try and \'guess\' at the real UNIX username,
5775 as many DOS clients send an all-uppercase username\&. By default Samba
5776 tries all lowercase, followed by the username with the first letter
5777 capitalized, and fails if the username is not found on the UNIX
5780 If this parameter is set to non-zero the behavior changes\&. This
5781 parameter is a number that specifies the number of uppercase
5782 combinations to try whilst trying to determine the UNIX user name\&. The
5783 higher the number the more combinations will be tried, but the slower
5784 the discovery of usernames will be\&. Use this parameter when you have
5785 strange usernames on your UNIX machine, such as \f(CW"AstrangeUser"\fP\&.
5788 \f(CW username level = 0\fP
5791 \f(CW username level = 5\fP
5793 .IP "\fBusername map (G)\fP"
5795 This option allows you to specify a file containing a mapping of
5796 usernames from the clients to the server\&. This can be used for several
5797 purposes\&. The most common is to map usernames that users use on DOS or
5798 Windows machines to those that the UNIX box uses\&. The other is to map
5799 multiple users to a single username so that they can more easily share
5802 The map file is parsed line by line\&. Each line should contain a single
5803 UNIX username on the left then a \f(CW\'=\'\fP followed by a list of
5804 usernames on the right\&. The list of usernames on the right may contain
5805 names of the form @group in which case they will match any UNIX
5806 username in that group\&. The special client name \f(CW\'*\'\fP is a wildcard
5807 and matches any name\&. Each line of the map file may be up to 1023
5810 The file is processed on each line by taking the supplied username and
5811 comparing it with each username on the right hand side of the \f(CW\'=\'\fP
5812 signs\&. If the supplied name matches any of the names on the right hand
5813 side then it is replaced with the name on the left\&. Processing then
5814 continues with the next line\&.
5816 If any line begins with a \f(CW\'#\'\fP or a \f(CW\';\'\fP then it is ignored
5818 If any line begins with an \f(CW\'!\'\fP then the processing will stop after
5819 that line if a mapping was done by the line\&. Otherwise mapping
5820 continues with every line being processed\&. Using \f(CW\'!\'\fP is most
5821 useful when you have a wildcard mapping line later in the file\&.
5823 For example to map from the name \f(CW"admin"\fP or \f(CW"administrator"\fP to
5824 the UNIX name \f(CW"root"\fP you would use:
5826 \f(CW root = admin administrator\fP
5828 Or to map anyone in the UNIX group \f(CW"system"\fP to the UNIX name
5829 \f(CW"sys"\fP you would use:
5831 \f(CW sys = @system\fP
5833 You can have as many mappings as you like in a username map file\&.
5835 If your system supports the NIS NETGROUP option then the netgroup
5836 database is checked before the \f(CW/etc/group\fP database for matching
5839 You can map Windows usernames that have spaces in them by using double
5840 quotes around the name\&. For example:
5842 \f(CW tridge = "Andrew Tridgell"\fP
5844 would map the windows username \f(CW"Andrew Tridgell"\fP to the unix
5847 The following example would map mary and fred to the unix user sys,
5848 and map the rest to guest\&. Note the use of the \f(CW\'!\'\fP to tell Samba
5849 to stop processing if it gets a match on that line\&.
5862 Note that the remapping is applied to all occurrences of
5863 usernames\&. Thus if you connect to \f(CW"\e\eserver\efred"\fP and \f(CW"fred"\fP
5864 is remapped to \f(CW"mary"\fP then you will actually be connecting to
5865 \f(CW"\e\eserver\emary"\fP and will need to supply a password suitable for
5866 \f(CW"mary"\fP not \f(CW"fred"\fP\&. The only exception to this is the username
5867 passed to the \fB"password server"\fP (if you have
5868 one)\&. The password server will receive whatever username the client
5869 supplies without modification\&.
5871 Also note that no reverse mapping is done\&. The main effect this has is
5872 with printing\&. Users who have been mapped may have trouble deleting
5873 print jobs as PrintManager under WfWg will think they don\'t own the
5877 \f(CW no username map\fP
5880 \f(CW username map = /usr/local/samba/lib/users\&.map\fP
5882 .IP "\fBvalid chars (S)\fP"
5884 The option allows you to specify additional characters that should be
5885 considered valid by the server in filenames\&. This is particularly
5886 useful for national character sets, such as adding u-umlaut or a-ring\&.
5888 The option takes a list of characters in either integer or character
5889 form with spaces between them\&. If you give two characters with a colon
5890 between them then it will be taken as an lowercase:uppercase pair\&.
5892 If you have an editor capable of entering the characters into the
5893 config file then it is probably easiest to use this method\&. Otherwise
5894 you can specify the characters in octal, decimal or hexadecimal form
5895 using the usual C notation\&.
5897 For example to add the single character \f(CW\'Z\'\fP to the charset (which
5898 is a pointless thing to do as it\'s already there) you could do one of
5907 valid chars = 0132:0172
5913 The last two examples above actually add two characters, and alter the
5914 uppercase and lowercase mappings appropriately\&.
5916 Note that you MUST specify this parameter after the \fB"client
5917 code page"\fP parameter if you have both set\&. If
5918 \fB"client code page"\fP is set after the
5919 \fB"valid chars"\fP parameter the \fB"valid chars"\fP settings will be
5922 See also the \fB"client code page"\fP parameter\&.
5929 Samba defaults to using a reasonable set of valid characters
5937 \f(CW valid chars = 0345:0305 0366:0326 0344:0304\fP
5939 The above example allows filenames to have the Swedish characters in
5942 NOTE: It is actually quite difficult to correctly produce a \fB"valid
5943 chars"\fP line for a particular system\&. To automate the process
5944 \fItino@augsburg\&.net\fP has written a package called \fB"validchars"\fP
5945 which will automatically produce a complete \fB"valid chars"\fP line for
5946 a given client system\&. Look in the examples/validchars/ subdirectory
5947 of your Samba source code distribution for this package\&.
5949 .IP "\fBvalid users (S)\fP"
5951 This is a list of users that should be allowed to login to this
5952 service\&. Names starting with \f(CW\'@\'\fP, \f(CW\'+\'\fP and \f(CW\'&\'\fP are
5953 interpreted using the same rules as described in the \fB"invalid
5954 users"\fP parameter\&.
5956 If this is empty (the default) then any user can login\&. If a username
5957 is in both this list and the \fB"invalid users"\fP
5958 list then access is denied for that user\&.
5960 The current servicename is substituted for
5961 \fB"%S"\fP\&. This is useful in the
5962 \fB[homes]\fP section\&.
5964 See also \fB"invalid users"\fP\&.
5967 \f(CW No valid users list\&. (anyone can login)\fP
5970 \f(CW valid users = greg, @pcusers\fP
5972 .IP "\fBveto files(S)\fP"
5974 This is a list of files and directories that are neither visible nor
5975 accessible\&. Each entry in the list must be separated by a \f(CW\'/\'\fP,
5976 which allows spaces to be included in the entry\&. \f(CW\'*\'\fP and \f(CW\'?\'\fP
5977 can be used to specify multiple files or directories as in DOS
5980 Each entry must be a unix path, not a DOS path and must \fI*not*\fP include the
5981 unix directory separator \f(CW\'/\'\fP\&.
5983 Note that the \fB"case sensitive"\fP option is
5984 applicable in vetoing files\&.
5986 One feature of the veto files parameter that it is important to be
5987 aware of, is that if a directory contains nothing but files that match
5988 the veto files parameter (which means that Windows/DOS clients cannot
5989 ever see them) is deleted, the veto files within that directory *are
5990 automatically deleted* along with it, if the user has UNIX permissions
5993 Setting this parameter will affect the performance of Samba, as it
5994 will be forced to check all files and directories for a match as they
5997 See also \fB"hide files"\fP and \fB"case
6001 \f(CW No files or directories are vetoed\&.\fP
6012 Veto any files containing the word Security,
6013 any ending in \&.tmp, and any directory containing the
6016 veto files = /*Security*/*\&.tmp/*root*/
6028 Veto the Apple specific files that a NetAtalk server
6031 veto files = /\&.AppleDouble/\&.bin/\&.AppleDesktop/Network Trash Folder/
6037 .IP "\fBveto oplock files (S)\fP"
6039 This parameter is only valid when the \fB"oplocks"\fP
6040 parameter is turned on for a share\&. It allows the Samba administrator
6041 to selectively turn off the granting of oplocks on selected files that
6042 match a wildcarded list, similar to the wildcarded list used in the
6043 \fB"veto files"\fP parameter\&.
6046 \f(CW No files are vetoed for oplock grants\&.\fP
6050 You might want to do this on files that you know will be heavily
6051 contended for by clients\&. A good example of this is in the NetBench
6052 SMB benchmark program, which causes heavy client contention for files
6053 ending in \f(CW"\&.SEM"\fP\&. To cause Samba not to grant oplocks on these
6054 files you would use the line (either in the \fB[global]\fP
6055 section or in the section for the particular NetBench share :
6057 \f(CW veto oplock files = /*\&.SEM/\fP
6059 .IP "\fBvolume (S)\fP"
6061 This allows you to override the volume label returned for a
6062 share\&. Useful for CDROMs with installation programs that insist on a
6063 particular volume label\&.
6065 The default is the name of the share\&.
6067 .IP "\fBwide links (S)\fP"
6069 This parameter controls whether or not links in the UNIX file system
6070 may be followed by the server\&. Links that point to areas within the
6071 directory tree exported by the server are always allowed; this
6072 parameter controls access only to areas that are outside the directory
6073 tree being exported\&.
6076 \f(CW wide links = yes\fP
6079 \f(CW wide links = no\fP
6081 .IP "\fBwins proxy (G)\fP"
6083 This is a boolean that controls if \fBnmbd\fP will
6084 respond to broadcast name queries on behalf of other hosts\&. You may
6085 need to set this to \f(CW"yes"\fP for some older clients\&.
6088 \f(CW wins proxy = no\fP
6090 .IP "\fBwins server (G)\fP"
6092 This specifies the DNS name (or IP address) of the WINS server that
6093 \fBnmbd\fP should register with\&. If you have a WINS
6094 server on your network then you should set this to the WINS servers
6097 You should point this at your WINS server if you have a
6098 multi-subnetted network\&.
6100 \fINOTE\fP\&. You need to set up Samba to point to a WINS server if you
6101 have multiple subnets and wish cross-subnet browsing to work correctly\&.
6103 See the documentation file BROWSING\&.txt in the docs/ directory of your
6104 Samba source distribution\&.
6107 \f(CW wins server = \fP
6110 \f(CW wins server = 192\&.9\&.200\&.1\fP
6112 .IP "\fBwins support (G)\fP"
6114 This boolean controls if the \fBnmbd\fP process in
6115 Samba will act as a WINS server\&. You should not set this to true
6116 unless you have a multi-subnetted network and you wish a particular
6117 \fBnmbd\fP to be your WINS server\&. Note that you
6118 should \fI*NEVER*\fP set this to true on more than one machine in your
6122 \f(CW wins support = no\fP
6124 .IP "\fBworkgroup (G)\fP"
6126 This controls what workgroup your server will appear to be in when
6127 queried by clients\&. Note that this parameter also controls the Domain
6128 name used with the \fB"security=domain"\fP
6132 \f(CW set at compile time to WORKGROUP\fP
6137 .IP "\fBwritable (S)\fP"
6139 Synonym for \fB"writeable"\fP for people who can\'t spell :-)\&.
6141 .IP "\fBwrite list (S)\fP"
6143 This is a list of users that are given read-write access to a
6144 service\&. If the connecting user is in this list then they will be
6145 given write access, no matter what the \fB"read only"\fP
6146 option is set to\&. The list can include group names using the @group
6149 Note that if a user is in both the read list and the write list then
6150 they will be given write access\&.
6152 See also the \fB"read list"\fP option\&.
6155 \f(CW write list = <empty string>\fP
6158 \f(CW write list = admin, root, @staff\fP
6160 .IP "\fBwrite ok (S)\fP"
6162 Synonym for \fBwriteable\fP\&.
6164 .IP "\fBwrite raw (G)\fP"
6166 This parameter controls whether or not the server will support raw
6167 writes SMB\'s when transferring data from clients\&. You should never
6168 need to change this parameter\&.
6171 \f(CW write raw = yes\fP
6173 .IP "\fBwriteable\fP"
6175 An inverted synonym is \fB"read only"\fP\&.
6177 If this parameter is \f(CW"no"\fP, then users of a service may not create
6178 or modify files in the service\'s directory\&.
6180 Note that a printable service \fB("printable = yes")\fP
6181 will \fI*ALWAYS*\fP allow writing to the directory (user privileges
6182 permitting), but only via spooling operations\&.
6185 \f(CW writeable = no\fP
6202 Although the configuration file permits service names to contain
6203 spaces, your client software may not\&. Spaces will be ignored in
6204 comparisons anyway, so it shouldn\'t be a problem - but be aware of the
6207 On a similar note, many clients - especially DOS clients - limit
6208 service names to eight characters\&. \fBSmbd\fP has no
6209 such limitation, but attempts to connect from such clients will fail
6210 if they truncate the service names\&. For this reason you should
6211 probably keep your service names down to eight characters in length\&.
6213 Use of the \fB[homes]\fP and \fB[printers]\fP
6214 special sections make life for an administrator easy, but the various
6215 combinations of default attributes can be tricky\&. Take extreme care
6216 when designing these sections\&. In particular, ensure that the
6217 permissions on spool directories are correct\&.
6221 This man page is correct for version 2\&.0 of the Samba suite\&.
6225 \fBsmbd (8)\fP, \fBsmbclient (1)\fP,
6226 \fBnmbd (8)\fP, \fBtestparm (1)\fP,
6227 \fBtestprns (1)\fP, \fBSamba\fP,
6228 \fBnmblookup (1)\fP, \fBsmbpasswd (5)\fP,
6229 \fBsmbpasswd (8)\fP\&.
6233 The original Samba software and related utilities were created by
6234 Andrew Tridgell \fIsamba-bugs@samba\&.anu\&.edu\&.au\fP\&. Samba is now developed
6235 by the Samba Team as an Open Source project similar to the way the
6236 Linux kernel is developed\&.
6238 The original Samba man pages were written by Karl Auer\&. The man page
6239 sources were converted to YODL format (another excellent piece of Open
6240 Source software, available at
6241 \fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP)
6242 and updated for the Samba2\&.0 release by Jeremy Allison\&.
6243 \fIsamba-bugs@samba\&.anu\&.edu\&.au\fP\&.
6245 See \fBsamba (7)\fP to find out how to get a full
6246 list of contributors and details on how to submit bug reports,
git.samba.org / samba.git / blob