1 .\" This manpage has been automatically generated by docbook2man-spec
2 .\" from a DocBook document. docbook2man-spec can be found at:
3 .\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/>
4 .\" Please send any bug reports, improvements, comments, patches,
5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
6 .TH "SMB.CONF" "5" "21 November 2001" "" ""
8 smb.conf \- The configuration file for the Samba suite
11 The \fIsmb.conf\fR file is a configuration
12 file for the Samba suite. \fIsmb.conf\fR contains
13 runtime configuration information for the Samba programs. The
14 \fIsmb.conf\fR file is designed to be configured and
15 administered by the \fBswat(8)\fR
16 program. The complete description of the file format and
17 possible parameters held within are here for reference purposes.
20 The file consists of sections and parameters. A section
21 begins with the name of the section in square brackets and continues
22 until the next section begins. Sections contain parameters of the
27 The file is line-based - that is, each newline-terminated
28 line represents either a comment, a section name or a parameter.
30 Section and parameter names are not case sensitive.
32 Only the first equals sign in a parameter is significant.
33 Whitespace before or after the first equals sign is discarded.
34 Leading, trailing and internal whitespace in section and parameter
35 names is irrelevant. Leading and trailing whitespace in a parameter
36 value is discarded. Internal whitespace within a parameter value
39 Any line beginning with a semicolon (';') or a hash ('#')
40 character is ignored, as are lines containing only whitespace.
42 Any line ending in a '\\' is continued
43 on the next line in the customary UNIX fashion.
45 The values following the equals sign in parameters are all
46 either a string (no quotes needed) or a boolean, which may be given
47 as yes/no, 0/1 or true/false. Case is not significant in boolean
48 values, but is preserved in string values. Some items such as
49 create modes are numeric.
50 .SH "SECTION DESCRIPTIONS"
52 Each section in the configuration file (except for the
53 [global] section) describes a shared resource (known
54 as a "share"). The section name is the name of the
55 shared resource and the parameters within the section define
56 the shares attributes.
58 There are three special sections, [global],
59 [homes] and [printers], which are
60 described under \fBspecial sections\fR. The
61 following notes apply to ordinary section descriptions.
63 A share consists of a directory to which access is being
64 given plus a description of the access rights which are granted
65 to the user of the service. Some housekeeping options are
68 Sections are either file share services (used by the
69 client as an extension of their native file systems) or
70 printable services (used by the client to access print services
71 on the host running the server).
73 Sections may be designated \fBguest\fR services,
74 in which case no password is required to access them. A specified
75 UNIX \fBguest account\fR is used to define access
76 privileges in this case.
78 Sections other than guest services will require a password
79 to access them. The client provides the username. As older clients
80 only provide passwords and not usernames, you may specify a list
81 of usernames to check against the password using the "user ="
82 option in the share definition. For modern clients such as
83 Windows 95/98/ME/NT/2000, this should not be necessary.
85 Note that the access rights granted by the server are
86 masked by the access rights granted to the specified or guest
87 UNIX user by the host system. The server does not grant more
88 access than the host system grants.
90 The following sample section defines a file space share.
91 The user has write access to the path \fI/home/bar\fR.
92 The share is accessed via the share name "foo":
103 The following sample section defines a printable share.
104 The share is readonly, but printable. That is, the only write
105 access permitted is via calls to open, write to and close a
106 spool file. The \fBguest ok\fR parameter means
107 access will be permitted as the default guest user (specified
112 path = /usr/spool/public
120 .SH "SPECIAL SECTIONS"
121 .SS "THE GLOBAL SECTION"
123 parameters in this section apply to the server
124 as a whole, or are defaults for sections which do not
125 specifically define certain items. See the notes
126 under PARAMETERS for more information.
127 .SS "THE HOMES SECTION"
129 If a section called homes is included in the
130 configuration file, services connecting clients to their
131 home directories can be created on the fly by the server.
133 When the connection request is made, the existing
134 sections are scanned. If a match is found, it is used. If no
135 match is found, the requested section name is treated as a
136 user name and looked up in the local password file. If the
137 name exists and the correct password has been given, a share is
138 created by cloning the [homes] section.
140 Some modifications are then made to the newly
144 The share name is changed from homes to
145 the located username.
148 If no path was given, the path is set to
149 the user's home directory.
151 If you decide to use a \fBpath =\fR line
152 in your [homes] section then you may find it useful
153 to use the %S macro. For example :
156 \fBpath = /data/pchome/%S\fR
159 would be useful if you have different home directories
160 for your PCs than for UNIX access.
163 This is a fast and simple way to give a large number
164 of clients access to their home directories with a minimum
168 A similar process occurs if the requested section
169 name is "homes", except that the share name is not
170 changed to that of the requesting user. This method of using
171 the [homes] section works well if different users share
175 The [homes] section can specify all the parameters
176 a normal service section can specify, though some make more sense
177 than others. The following is a typical and suitable [homes]
189 An important point is that if guest access is specified
190 in the [homes] section, all home directories will be
191 visible to all clients \fBwithout a password\fR.
192 In the very unlikely event that this is actually desirable, it
193 would be wise to also specify \fBread only
197 Note that the \fBbrowseable\fR flag for
198 auto home directories will be inherited from the global browseable
199 flag, not the [homes] browseable flag. This is useful as
200 it means setting \fBbrowseable = no\fR in
201 the [homes] section will hide the [homes] share but make
202 any auto home directories visible.
204 .SS "THE PRINTERS SECTION"
206 This section works like [homes],
209 If a [printers] section occurs in the
210 configuration file, users are able to connect to any printer
211 specified in the local host's printcap file.
213 When a connection request is made, the existing sections
214 are scanned. If a match is found, it is used. If no match is found,
215 but a [homes] section exists, it is used as described
216 above. Otherwise, the requested section name is treated as a
217 printer name and the appropriate printcap file is scanned to see
218 if the requested section name is a valid printer share name. If
219 a match is found, a new printer share is created by cloning
220 the [printers] section.
222 A few modifications are then made to the newly created
226 The share name is set to the located printer
230 If no printer name was given, the printer name
231 is set to the located printer name
234 If the share does not permit guest access and
235 no username was given, the username is set to the located
238 Note that the [printers] service MUST be
239 printable - if you specify otherwise, the server will refuse
240 to load the configuration file.
243 Typically the path specified would be that of a
244 world-writeable spool directory with the sticky bit set on
245 it. A typical [printers] entry would look like
251 path = /usr/spool/public
258 All aliases given for a printer in the printcap file
259 are legitimate printer names as far as the server is concerned.
260 If your printing subsystem doesn't work like that, you will have
261 to set up a pseudo-printcap. This is a file consisting of one or
262 more lines like this:
266 alias|alias|alias|alias...
272 Each alias should be an acceptable printer name for
273 your printing subsystem. In the [global] section, specify
274 the new file as your printcap. The server will then only recognize
275 names found in your pseudo-printcap, which of course can contain
276 whatever aliases you like. The same technique could be used
277 simply to limit access to a subset of your local printers.
280 An alias, by the way, is defined as any component of the
281 first entry of a printcap record. Records are separated by newlines,
282 components (if there are more than one) are separated by vertical
286 NOTE: On SYSV systems which use lpstat to determine what
287 printers are defined on the system you may be able to use
288 "printcap name = lpstat" to automatically obtain a list
289 of printers. See the "printcap name" option
294 parameters define the specific attributes of sections.
296 Some parameters are specific to the [global] section
297 (e.g., \fBsecurity\fR). Some parameters are usable
298 in all sections (e.g., \fBcreate mode\fR). All others
299 are permissible only in normal sections. For the purposes of the
300 following descriptions the [homes] and [printers]
301 sections will be considered normal. The letter \fBG\fR
302 in parentheses indicates that a parameter is specific to the
303 [global] section. The letter \fBS\fR
304 indicates that a parameter can be specified in a service specific
305 section. Note that all \fBS\fR parameters can also be specified in
306 the [global] section - in which case they will define
307 the default behavior for all services.
309 parameters are arranged here in alphabetical order - this may
310 not create best bedfellows, but at least you can find them! Where
311 there are synonyms, the preferred synonym is described, others refer
312 to the preferred synonym.
313 .SH "VARIABLE SUBSTITUTIONS"
315 Many of the strings that are settable in the config file
316 can take substitutions. For example the option "path =
317 /tmp/%u" would be interpreted as "path =
318 /tmp/john" if the user connected with the username john.
320 These substitutions are mostly noted in the descriptions below,
321 but there are some general substitutions which apply whenever they
322 might be relevant. These are:
325 the name of the current service, if any.
328 the root directory of the current service,
332 user name of the current service, if any.
335 primary group name of %u.
338 session user name (the user name that the client
339 wanted, not necessarily the same as the one they got).
342 primary group name of %U.
345 the home directory of the user given
352 the Internet hostname that Samba is running
356 the NetBIOS name of the client machine
360 the NetBIOS name of the server. This allows you
361 to change your config based on what the client calls you. Your
362 server can have a "dual personality".
365 the Internet name of the client machine.
368 the name of your NIS home directory server.
369 This is obtained from your NIS auto.map entry. If you have
370 not compiled Samba with the \fB--with-automount\fR
371 option then this value will be the same as %L.
374 the path of the service's home directory,
375 obtained from your NIS auto.map entry. The NIS auto.map entry
376 is split up as "%N:%p".
379 the selected protocol level after
380 protocol negotiation. It can be one of CORE, COREPLUS,
381 LANMAN1, LANMAN2 or NT1.
384 The process id of the current server
388 the architecture of the remote
389 machine. Only some are recognized, and those may not be
390 100% reliable. It currently recognizes Samba, WfWg, Win95,
391 WinNT and Win2k. Anything else will be known as
392 "UNKNOWN". If it gets it wrong then sending a level
393 3 log to samba@samba.org
394 <URL:mailto:samba@samba.org> should allow it to be fixed.
397 The IP address of the client machine.
400 the current date and time.
402 \fB%$(\fIenvvar\fB)\fR
403 The value of the environment variable
406 There are some quite creative things that can be done
407 with these substitutions and other smb.conf options.
411 Samba supports "name mangling" so that DOS and
412 Windows clients can use files that don't conform to the 8.3 format.
413 It can also be set to adjust the case of 8.3 format filenames.
415 There are several options that control the way mangling is
416 performed, and they are grouped here rather than listed separately.
417 For the defaults look at the output of the testparm program.
419 All of these options can be set separately for each service
420 (or globally, of course).
424 \fBmangle case = yes/no\fR
425 controls if names that have characters that
426 aren't of the "default" case are mangled. For example,
427 if this is yes then a name like "Mail" would be mangled.
430 \fBcase sensitive = yes/no\fR
431 controls whether filenames are case sensitive. If
432 they aren't then Samba must do a filename search and match on passed
433 names. Default \fBno\fR.
435 \fBdefault case = upper/lower\fR
436 controls what the default case is for new
437 filenames. Default \fBlower\fR.
439 \fBpreserve case = yes/no\fR
440 controls if new files are created with the
441 case that the client passes, or if they are forced to be the
442 "default" case. Default \fByes\fR.
444 \fBshort preserve case = yes/no\fR
445 controls if new files which conform to 8.3 syntax,
446 that is all in upper case and of suitable length, are created
447 upper case, or if they are forced to be the "default"
448 case. This option can be use with "preserve case = yes"
449 to permit long filenames to retain their case, while short names
450 are lowercased. Default \fByes\fR.
452 By default, Samba 2.2 has the same semantics as a Windows
453 NT server, in that it is case insensitive but case preserving.
455 .SH "NOTE ABOUT USERNAME/PASSWORD VALIDATION"
457 There are a number of ways in which a user can connect
458 to a service. The server uses the following steps in determining
459 if it will allow a connection to a specified service. If all the
460 steps fail, then the connection request is rejected. However, if one of the
461 steps succeeds, then the following steps are not checked.
463 If the service is marked "guest only = yes" then
464 steps 1 to 5 are skipped.
466 If the client has passed a username/password
467 pair and that username/password pair is validated by the UNIX
468 system's password programs then the connection is made as that
469 username. Note that this includes the
470 \\\\server\\service%\fIusername\fR method of passing
473 If the client has previously registered a username
474 with the system and now supplies a correct password for that
475 username then the connection is allowed.
477 The client's NetBIOS name and any previously
478 used user names are checked against the supplied password, if
479 they match then the connection is allowed as the corresponding
482 If the client has previously validated a
483 username/password pair with the server and the client has passed
484 the validation token then that username is used.
486 If a "user = " field is given in the
487 \fIsmb.conf\fR file for the service and the client
488 has supplied a password, and that password matches (according to
489 the UNIX system's password checking) with one of the usernames
490 from the "user =" field then the connection is made as
491 the username in the "user =" line. If one
492 of the username in the "user =" list begins with a
493 \&'@' then that name expands to a list of names in
494 the group of the same name.
496 If the service is a guest service then a
497 connection is made as the username given in the "guest
498 account =" for the service, irrespective of the
500 .SH "COMPLETE LIST OF GLOBAL PARAMETERS"
502 Here is a list of all global parameters. See the section of
503 each parameter for details. Note that some are synonyms.
506 \fIabort shutdown script\fR
509 \fIadd printer command\fR
512 \fIadd share command\fR
515 \fIadd user script\fR
518 \fIadd machine script\fR
521 \fIallow trusted domains\fR
527 \fIannounce version\fR
533 \fIbind interfaces only\fR
539 \fIchange notify timeout\fR
542 \fIchange share command\fR
548 \fIclient code page\fR
551 \fIcode page directory\fR
563 \fIdebug hires timestamp\fR
569 \fIdebug timestamp\fR
581 \fIdefault service\fR
584 \fIdelete printer command\fR
587 \fIdelete share command\fR
590 \fIdelete user script\fR
596 \fIdisable spoolss\fR
602 \fIdomain admin group\fR
605 \fIdomain guest group\fR
614 \fIencrypt passwords\fR
617 \fIenhanced browsing\fR
620 \fIenumports command\fR
626 \fIhide local users\fR
629 \fIhide unreadable\fR
653 \fIlarge readwrite\fR
713 \fImachine password timeout\fR
737 \fImax smbd processes\fR
749 \fImessage command\fR
752 \fImin passwd length\fR
755 \fImin password length\fR
764 \fIname resolve order\fR
767 \fInetbios aliases\fR
779 \fInt pipe support\fR
788 \fIobey pam restrictions\fR
791 \fIoplock break wait time\fR
800 \fIpam password change\fR
809 \fIpasswd chat debug\fR
818 \fIpassword server\fR
821 \fIprefered master\fR
824 \fIpreferred master\fR
836 \fIprinter driver file\fR
851 \fIremote announce\fR
854 \fIremote browse sync\fR
857 \fIrestrict anonymous\fR
875 \fIshow add printer wizard\fR
878 \fIshutdown script\fR
881 \fIsmb passwd file\fR
890 \fIsource environment\fR
899 \fIssl CA certFile\fR
905 \fIssl client cert\fR
911 \fIssl compatibility\fR
917 \fIssl entropy bytes\fR
920 \fIssl entropy file\fR
926 \fIssl hosts resign\fR
929 \fIssl require clientcert\fR
932 \fIssl require servercert\fR
935 \fIssl server cert\fR
947 \fIstat cache size\fR
959 \fItemplate homedir\fR
974 \fItotal print jobs\fR
977 \fIunix password sync\fR
980 \fIupdate encrypted\fR
1004 \fIwinbind cache time\fR
1007 \fIwinbind enum users\fR
1010 \fIwinbind enum groups\fR
1016 \fIwinbind separator\fR
1038 .SH "COMPLETE LIST OF SERVICE PARAMETERS"
1040 Here is a list of all service parameters. See the section on
1041 each parameter for details. Note that some are synonyms.
1053 \fIblocking locks\fR
1062 \fIcase sensitive\fR
1083 \fIdelete readonly\fR
1086 \fIdelete veto files\fR
1095 \fIdirectory mask\fR
1098 \fIdirectory mode\fR
1101 \fIdirectory security mask\fR
1110 \fIdos filetime resolution\fR
1119 \fIfake directory create times\fR
1125 \fIfollow symlinks\fR
1128 \fIforce create mode\fR
1131 \fIforce directory mode\fR
1134 \fIforce directory security mode\fR
1140 \fIforce security mode\fR
1161 \fIhide dot files\fR
1176 \fIinherit permissions\fR
1182 \fIlevel2 oplocks\fR
1188 \fIlppause command\fR
1194 \fIlpresume command\fR
1227 \fImax connections\fR
1230 \fImax print jobs\fR
1233 \fImin print space\fR
1239 \fInt acl support\fR
1248 \fIoplock contention limit\fR
1290 \fIprinter driver\fR
1293 \fIprinter driver location\fR
1305 \fIqueuepause command\fR
1308 \fIqueueresume command\fR
1323 \fIroot preexec close\fR
1332 \fIshort preserve case\fR
1338 \fIstrict allocate\fR
1341 \fIstrict locking\fR
1350 \fIuse client driver\fR
1368 \fIveto oplock files\fR
1386 \fIwrite cache size\fR
1396 .SH "EXPLANATION OF EACH PARAMETER"
1398 \fBabort shutdown script (G)\fR
1399 \fBThis parameter only exists in the HEAD cvs branch\fR
1400 This a full path name to a script called by
1402 should stop a shutdown procedure issued by the \fIshutdown script\fR.
1404 This command will be run as user.
1406 Default: \fBNone\fR.
1408 Example: \fBabort shutdown script = /sbin/shutdown -c\fR
1410 \fBadd printer command (G)\fR
1411 With the introduction of MS-RPC based printing
1412 support for Windows NT/2000 clients in Samba 2.2, The MS Add
1413 Printer Wizard (APW) icon is now also available in the
1414 "Printers..." folder displayed a share listing. The APW
1415 allows for printers to be add remotely to a Samba or Windows
1416 NT/2000 print server.
1418 For a Samba host this means that the printer must be
1419 physically added to the underlying printing system. The \fIadd
1420 printer command\fR defines a script to be run which
1421 will perform the necessary operations for adding the printer
1422 to the print system and to add the appropriate service definition
1423 to the \fIsmb.conf\fR file in order that it can be
1424 shared by \fBsmbd(8)\fR
1427 The \fIadd printer command\fR is
1428 automatically invoked with the following parameter (in
1448 \fIWindows 9x driver location\fR
1451 All parameters are filled in from the PRINTER_INFO_2 structure sent
1452 by the Windows NT/2000 client with one exception. The "Windows 9x
1453 driver location" parameter is included for backwards compatibility
1454 only. The remaining fields in the structure are generated from answers
1455 to the APW questions.
1458 Once the \fIadd printer command\fR has
1459 been executed, \fBsmbd\fR will reparse the \fI smb.conf\fR to determine if the share defined by the APW
1460 exists. If the sharename is still invalid, then \fBsmbd
1461 \fRwill return an ACCESS_DENIED error to the client.
1464 See also \fI delete printer command\fR, \fIprinting\fR,
1472 Example: \fBaddprinter command = /usr/bin/addprinter
1475 \fBadd share command (G)\fR
1476 Samba 2.2.0 introduced the ability to dynamically
1477 add and delete shares via the Windows NT 4.0 Server Manager. The
1478 \fIadd share command\fR is used to define an
1479 external program or script which will add a new service definition
1480 to \fIsmb.conf\fR. In order to successfully
1481 execute the \fIadd share command\fR, \fBsmbd\fR
1482 requires that the administrator be connected using a root account (i.e.
1485 When executed, \fBsmbd\fR will automatically invoke the
1486 \fIadd share command\fR with four parameters.
1490 \fIconfigFile\fR - the location
1491 of the global \fIsmb.conf\fR file.
1494 \fIshareName\fR - the name of the new
1498 \fIpathName\fR - path to an **existing**
1502 \fIcomment\fR - comment string to associate
1506 This parameter is only used for add file shares. To add printer shares,
1507 see the \fIadd printer
1511 See also \fIchange share
1512 command\fR, \fIdelete share
1519 Example: \fBadd share command = /usr/local/bin/addshare\fR
1522 \fBadd machine script (G)\fR
1523 This is the full pathname to a script that will
1524 be run by smbd(8)when a machine is added
1525 to it's domain using the administrator username and password method.
1527 This option is only required when using sam back-ends tied to the
1528 Unix uid method of RID calculation such as smbpasswd. This option is only
1529 available in Samba 3.0.
1531 Default: \fBadd machine script = <empty string>
1533 Example: \fBadd machine script = /usr/sbin/adduser -n -g machines -c Machine -d /dev/null -s /bin/false %u
1535 \fBadd user script (G)\fR
1536 This is the full pathname to a script that will
1537 be run \fBAS ROOT\fR by smbd(8)
1538 under special circumstances described below.
1540 Normally, a Samba server requires that UNIX users are
1541 created for all users accessing files on this server. For sites
1542 that use Windows NT account databases as their primary user database
1543 creating these users and keeping the user list in sync with the
1544 Windows NT PDC is an onerous task. This option allows smbdto create the required UNIX users
1545 \fBON DEMAND\fR when a user accesses the Samba server.
1547 In order to use this option, smbd
1548 must be set to \fIsecurity = server\fR or \fI security = domain\fR and \fIadd user script\fR
1549 must be set to a full pathname for a script that will create a UNIX
1550 user given one argument of \fI%u\fR, which expands into
1551 the UNIX user name to create.
1553 When the Windows user attempts to access the Samba server,
1554 at login (session setup in the SMB protocol) time, smbdcontacts the \fIpassword server\fR and
1555 attempts to authenticate the given user with the given password. If the
1556 authentication succeeds then \fBsmbd\fR
1557 attempts to find a UNIX user in the UNIX password database to map the
1558 Windows user into. If this lookup fails, and \fIadd user script
1559 \fRis set then \fBsmbd\fR will
1560 call the specified script \fBAS ROOT\fR, expanding
1561 any \fI%u\fR argument to be the user name to create.
1563 If this script successfully creates the user then \fBsmbd
1564 \fRwill continue on as though the UNIX user
1565 already existed. In this way, UNIX users are dynamically created to
1566 match existing Windows NT accounts.
1568 See also \fI security\fR, \fIpassword server\fR,
1572 Default: \fBadd user script = <empty string>
1574 Example: \fBadd user script = /usr/local/samba/bin/add_user
1577 \fBadmin users (S)\fR
1578 This is a list of users who will be granted
1579 administrative privileges on the share. This means that they
1580 will do all file operations as the super-user (root).
1582 You should use this option very carefully, as any user in
1583 this list will be able to do anything they like on the share,
1584 irrespective of file permissions.
1586 Default: \fBno admin users\fR
1588 Example: \fBadmin users = jason\fR
1590 \fBallow hosts (S)\fR
1591 Synonym for \fIhosts allow\fR.
1593 \fBallow trusted domains (G)\fR
1594 This option only takes effect when the \fIsecurity\fR option is set to
1596 If it is set to no, then attempts to connect to a resource from
1597 a domain or workgroup other than the one which smbdis running
1598 in will fail, even if that domain is trusted by the remote server
1599 doing the authentication.
1601 This is useful if you only want your Samba server to
1602 serve resources to users in the domain it is a member of. As
1603 an example, suppose that there are two domains DOMA and DOMB. DOMB
1604 is trusted by DOMA, which contains the Samba server. Under normal
1605 circumstances, a user with an account in DOMB can then access the
1606 resources of a UNIX account with the same account name on the
1607 Samba server even if they do not have an account in DOMA. This
1608 can make implementing a security boundary difficult.
1610 Default: \fBallow trusted domains = yes\fR
1612 \fBannounce as (G)\fR
1613 This specifies what type of server
1615 will announce itself as, to a network neighborhood browse
1616 list. By default this is set to Windows NT. The valid options
1617 are : "NT Server" (which can also be written as "NT"),
1618 "NT Workstation", "Win95" or "WfW" meaning Windows NT Server,
1619 Windows NT Workstation, Windows 95 and Windows for Workgroups
1620 respectively. Do not change this parameter unless you have a
1621 specific need to stop Samba appearing as an NT server as this
1622 may prevent Samba servers from participating as browser servers
1625 Default: \fBannounce as = NT Server\fR
1627 Example: \fBannounce as = Win95\fR
1629 \fBannounce version (G)\fR
1630 This specifies the major and minor version numbers
1631 that nmbd will use when announcing itself as a server. The default
1632 is 4.2. Do not change this parameter unless you have a specific
1633 need to set a Samba server to be a downlevel server.
1635 Default: \fBannounce version = 4.5\fR
1637 Example: \fBannounce version = 2.0\fR
1639 \fBauto services (G)\fR
1640 This is a synonym for the \fIpreload\fR.
1643 This parameter lets you "turn off" a service. If
1644 \fIavailable = no\fR, then \fBALL\fR
1645 attempts to connect to the service will fail. Such failures are
1648 Default: \fBavailable = yes\fR
1650 \fBbind interfaces only (G)\fR
1651 This global parameter allows the Samba admin
1652 to limit what interfaces on a machine will serve SMB requests. If
1653 affects file service smbd(8)and
1654 name service nmbd(8)in slightly
1657 For name service it causes \fBnmbd\fR to bind
1658 to ports 137 and 138 on the interfaces listed in the interfaces parameter. \fBnmbd
1659 \fRalso binds to the "all addresses" interface (0.0.0.0)
1660 on ports 137 and 138 for the purposes of reading broadcast messages.
1661 If this option is not set then \fBnmbd\fR will service
1662 name requests on all of these sockets. If \fIbind interfaces
1663 only\fR is set then \fBnmbd\fR will check the
1664 source address of any packets coming in on the broadcast sockets
1665 and discard any that don't match the broadcast addresses of the
1666 interfaces in the \fIinterfaces\fR parameter list.
1667 As unicast packets are received on the other sockets it allows
1668 \fBnmbd\fR to refuse to serve names to machines that
1669 send packets that arrive through any interfaces not listed in the
1670 \fIinterfaces\fR list. IP Source address spoofing
1671 does defeat this simple check, however so it must not be used
1672 seriously as a security feature for \fBnmbd\fR.
1674 For file service it causes smbd(8)
1675 to bind only to the interface list given in the interfaces parameter. This restricts the networks that
1676 \fBsmbd\fR will serve to packets coming in those
1677 interfaces. Note that you should not use this parameter for machines
1678 that are serving PPP or other intermittent or non-broadcast network
1679 interfaces as it will not cope with non-permanent interfaces.
1681 If \fIbind interfaces only\fR is set then
1682 unless the network address \fB127.0.0.1\fR is added
1683 to the \fIinterfaces\fR parameter list \fBsmbpasswd(8)\fR
1684 and \fBswat(8)\fRmay
1685 not work as expected due to the reasons covered below.
1687 To change a users SMB password, the \fBsmbpasswd\fR
1688 by default connects to the \fBlocalhost - 127.0.0.1\fR
1689 address as an SMB client to issue the password change request. If
1690 \fIbind interfaces only\fR is set then unless the
1691 network address \fB127.0.0.1\fR is added to the
1692 \fIinterfaces\fR parameter list then \fB smbpasswd\fR will fail to connect in it's default mode.
1693 \fBsmbpasswd\fR can be forced to use the primary IP interface
1694 of the local host by using its \fI-r remote machine\fR
1695 parameter, with \fIremote machine\fR set
1696 to the IP name of the primary interface of the local host.
1698 The \fBswat\fR status page tries to connect with
1699 \fBsmbd\fR and \fBnmbd\fR at the address
1700 \fB127.0.0.1\fR to determine if they are running.
1701 Not adding \fB127.0.0.1\fR will cause \fB smbd\fR and \fBnmbd\fR to always show
1702 "not running" even if they really are. This can prevent \fB swat\fR from starting/stopping/restarting \fBsmbd\fR
1705 Default: \fBbind interfaces only = no\fR
1707 \fBblocking locks (S)\fR
1708 This parameter controls the behavior of smbd(8)when given a request by a client
1709 to obtain a byte range lock on a region of an open file, and the
1710 request has a time limit associated with it.
1712 If this parameter is set and the lock range requested
1713 cannot be immediately satisfied, Samba 2.2 will internally
1714 queue the lock request, and periodically attempt to obtain
1715 the lock until the timeout period expires.
1717 If this parameter is set to false, then
1718 Samba 2.2 will behave as previous versions of Samba would and
1719 will fail the lock request immediately if the lock range
1722 Default: \fBblocking locks = yes\fR
1725 See the \fI browseable\fR.
1727 \fBbrowse list (G)\fR
1728 This controls whether \fBsmbd(8)\fRwill serve a browse list to
1729 a client doing a \fBNetServerEnum\fR call. Normally
1730 set to true. You should never need to change
1733 Default: \fBbrowse list = yes\fR
1735 \fBbrowseable (S)\fR
1736 This controls whether this share is seen in
1737 the list of available shares in a net view and in the browse list.
1739 Default: \fBbrowseable = yes\fR
1741 \fBcase sensitive (S)\fR
1742 See the discussion in the section NAME MANGLING.
1744 Default: \fBcase sensitive = no\fR
1746 \fBcasesignames (S)\fR
1750 \fBchange notify timeout (G)\fR
1751 This SMB allows a client to tell a server to
1752 "watch" a particular directory for any changes and only reply to
1753 the SMB request when a change has occurred. Such constant scanning of
1754 a directory is expensive under UNIX, hence an \fBsmbd(8)\fRdaemon only performs such a scan
1755 on each requested directory once every \fIchange notify
1758 Default: \fBchange notify timeout = 60\fR
1760 Example: \fBchange notify timeout = 300\fR
1762 Would change the scan time to every 5 minutes.
1764 \fBchange share command (G)\fR
1765 Samba 2.2.0 introduced the ability to dynamically
1766 add and delete shares via the Windows NT 4.0 Server Manager. The
1767 \fIchange share command\fR is used to define an
1768 external program or script which will modify an existing service definition
1769 in \fIsmb.conf\fR. In order to successfully
1770 execute the \fIchange share command\fR, \fBsmbd\fR
1771 requires that the administrator be connected using a root account (i.e.
1774 When executed, \fBsmbd\fR will automatically invoke the
1775 \fIchange share command\fR with four parameters.
1779 \fIconfigFile\fR - the location
1780 of the global \fIsmb.conf\fR file.
1783 \fIshareName\fR - the name of the new
1787 \fIpathName\fR - path to an **existing**
1791 \fIcomment\fR - comment string to associate
1795 This parameter is only used modify existing file shares definitions. To modify
1796 printer shares, use the "Printers..." folder as seen when browsing the Samba host.
1799 See also \fIadd share
1800 command\fR, \fIdelete
1807 Example: \fBchange share command = /usr/local/bin/addshare\fR
1810 \fBcharacter set (G)\fR
1811 This allows smbdto map incoming filenames
1812 from a DOS Code page (see the client
1813 code page parameter) to several built in UNIX character sets.
1814 The built in code page translations are:
1818 ISO8859-1 : Western European
1819 UNIX character set. The parameter \fIclient code page\fR
1820 \fBMUST\fR be set to code page 850 if the
1821 \fIcharacter set\fR parameter is set to
1822 ISO8859-1 in order for the conversion to the
1823 UNIX character set to be done correctly.
1826 ISO8859-2 : Eastern European
1827 UNIX character set. The parameter \fIclient code page
1828 \fR\fBMUST\fR be set to code page 852 if
1829 the \fI character set\fR parameter is set
1830 to ISO8859-2 in order for the conversion
1831 to the UNIX character set to be done correctly.
1834 ISO8859-5 : Russian Cyrillic
1835 UNIX character set. The parameter \fIclient code page
1836 \fR\fBMUST\fR be set to code page
1837 866 if the \fIcharacter set \fR parameter is
1838 set to ISO8859-5 in order for the conversion
1839 to the UNIX character set to be done correctly.
1842 ISO8859-7 : Greek UNIX
1843 character set. The parameter \fIclient code page
1844 \fR\fBMUST\fR be set to code page
1845 737 if the \fIcharacter set\fR parameter is
1846 set to ISO8859-7 in order for the conversion
1847 to the UNIX character set to be done correctly.
1850 KOI8-R : Alternate mapping
1851 for Russian Cyrillic UNIX character set. The parameter
1852 \fIclient code page\fR \fBMUST\fR
1853 be set to code page 866 if the \fIcharacter set\fR
1854 parameter is set to KOI8-R in order for the
1855 conversion to the UNIX character set to be done correctly.
1858 \fBBUG\fR. These MSDOS code page to UNIX character
1859 set mappings should be dynamic, like the loading of MS DOS code pages,
1863 Normally this parameter is not set, meaning no filename
1864 translation is done.
1867 Default: \fBcharacter set = <empty string>\fR
1870 Example: \fBcharacter set = ISO8859-1\fR
1873 \fBclient code page (G)\fR
1874 This parameter specifies the DOS code page
1875 that the clients accessing Samba are using. To determine what code
1876 page a Windows or DOS client is using, open a DOS command prompt
1877 and type the command \fBchcp\fR. This will output
1878 the code page. The default for USA MS-DOS, Windows 95, and
1879 Windows NT releases is code page 437. The default for western
1880 European releases of the above operating systems is code page 850.
1882 This parameter tells smbd(8)
1883 which of the \fIcodepage.XXX
1884 \fRfiles to dynamically load on startup. These files,
1885 described more fully in the manual page \fBmake_smbcodepage(1)\fR, tell \fB smbd\fR how to map lower to upper case characters to provide
1886 the case insensitivity of filenames that Windows clients expect.
1888 Samba currently ships with the following code page files :
1892 Code Page 437 - MS-DOS Latin US
1895 Code Page 737 - Windows '95 Greek
1898 Code Page 850 - MS-DOS Latin 1
1901 Code Page 852 - MS-DOS Latin 2
1904 Code Page 861 - MS-DOS Icelandic
1907 Code Page 866 - MS-DOS Cyrillic
1910 Code Page 932 - MS-DOS Japanese SJIS
1913 Code Page 936 - MS-DOS Simplified Chinese
1916 Code Page 949 - MS-DOS Korean Hangul
1919 Code Page 950 - MS-DOS Traditional Chinese
1922 Thus this parameter may have any of the values 437, 737, 850, 852,
1923 861, 932, 936, 949, or 950. If you don't find the codepage you need,
1924 read the comments in one of the other codepage files and the
1925 \fBmake_smbcodepage(1)\fR man page and write one. Please
1926 remember to donate it back to the Samba user community.
1929 This parameter co-operates with the \fIvalid
1930 chars\fR parameter in determining what characters are
1931 valid in filenames and how capitalization is done. If you set both
1932 this parameter and the \fIvalid chars\fR parameter
1933 the \fIclient code page\fR parameter
1934 \fBMUST\fR be set before the \fIvalid
1935 chars\fR parameter in the \fIsmb.conf\fR
1936 file. The \fIvalid chars\fR string will then
1937 augment the character settings in the \fIclient code page\fR
1941 If not set, \fIclient code page\fR defaults
1946 chars\fR, \fIcode page directory\fR
1949 Default: \fBclient code page = 850\fR
1952 Example: \fBclient code page = 936\fR
1955 \fBcode page directory (G)\fR
1956 Define the location of the various client code page
1962 Default: \fBcode page directory = ${prefix}/lib/codepages
1964 Example: \fBcode page directory = /usr/share/samba/codepages
1966 \fBcoding system (G)\fR
1967 This parameter is used to determine how incoming
1968 Shift-JIS Japanese characters are mapped from the incoming \fIclient code page\fR
1969 used by the client, into file names in the UNIX filesystem.
1970 Only useful if \fIclient code page\fR is set to
1971 932 (Japanese Shift-JIS). The options are :
1975 SJIS - Shift-JIS. Does no
1976 conversion of the incoming filename.
1979 JIS8, J8BB, J8BH, J8@B,
1980 J8@J, J8@H - Convert from incoming Shift-JIS to eight
1981 bit JIS code with different shift-in, shift out codes.
1984 JIS7, J7BB, J7BH, J7@B, J7@J,
1985 J7@H - Convert from incoming Shift-JIS to seven bit
1986 JIS code with different shift-in, shift out codes.
1989 JUNET, JUBB, JUBH, JU@B, JU@J, JU@H
1990 - Convert from incoming Shift-JIS to JUNET code with different shift-in,
1994 EUC - Convert an incoming
1995 Shift-JIS character to EUC code.
1998 HEX - Convert an incoming
1999 Shift-JIS character to a 3 byte hex representation, i.e.
2003 CAP - Convert an incoming
2004 Shift-JIS character to the 3 byte hex representation used by
2005 the Columbia AppleTalk Program (CAP), i.e. :AB.
2006 This is used for compatibility between Samba and CAP.
2009 Default: \fBcoding system = <empty value>\fR
2013 This is a text field that is seen next to a share
2014 when a client does a queries the server, either via the network
2015 neighborhood or via \fBnet view\fR to list what shares
2018 If you want to set the string that is displayed next to the
2019 machine name then see the \fI server string\fR parameter.
2021 Default: \fBNo comment string\fR
2023 Example: \fBcomment = Fred's Files\fR
2025 \fBconfig file (G)\fR
2026 This allows you to override the config file
2027 to use, instead of the default (usually \fIsmb.conf\fR).
2028 There is a chicken and egg problem here as this option is set
2031 For this reason, if the name of the config file has changed
2032 when the parameters are loaded then it will reload them from
2033 the new config file.
2035 This option takes the usual substitutions, which can
2038 If the config file doesn't exist then it won't be loaded
2039 (allowing you to special case the config files of just a few
2042 Example: \fBconfig file = /usr/local/samba/lib/smb.conf.%m
2045 This parameter allows you to "clone" service
2046 entries. The specified service is simply duplicated under the
2047 current service's name. Any parameters specified in the current
2048 section will override those in the section being copied.
2050 This feature lets you set up a 'template' service and
2051 create similar services easily. Note that the service being
2052 copied must occur earlier in the configuration file than the
2053 service doing the copying.
2055 Default: \fBno value\fR
2057 Example: \fBcopy = otherservice\fR
2059 \fBcreate mask (S)\fR
2060 A synonym for this parameter is
2064 When a file is created, the necessary permissions are
2065 calculated according to the mapping from DOS modes to UNIX
2066 permissions, and the resulting UNIX mode is then bit-wise 'AND'ed
2067 with this parameter. This parameter may be thought of as a bit-wise
2068 MASK for the UNIX modes of a file. Any bit \fBnot\fR
2069 set here will be removed from the modes set on a file when it is
2072 The default value of this parameter removes the
2073 \&'group' and 'other' write and execute bits from the UNIX modes.
2075 Following this Samba will bit-wise 'OR' the UNIX mode created
2076 from this parameter with the value of the \fIforce create mode\fR
2077 parameter which is set to 000 by default.
2079 This parameter does not affect directory modes. See the
2080 parameter \fIdirectory mode
2083 See also the \fIforce
2084 create mode\fR parameter for forcing particular mode
2085 bits to be set on created files. See also the \fIdirectory mode\fR parameter for masking
2086 mode bits on created directories. See also the \fIinherit permissions\fR parameter.
2088 Note that this parameter does not apply to permissions
2089 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
2090 a mask on access control lists also, they need to set the \fIsecurity mask\fR.
2092 Default: \fBcreate mask = 0744\fR
2094 Example: \fBcreate mask = 0775\fR
2096 \fBcreate mode (S)\fR
2097 This is a synonym for \fI create mask\fR.
2100 The value of the parameter (a decimal integer)
2101 represents the number of minutes of inactivity before a connection
2102 is considered dead, and it is disconnected. The deadtime only takes
2103 effect if the number of open files is zero.
2105 This is useful to stop a server's resources being
2106 exhausted by a large number of inactive connections.
2108 Most clients have an auto-reconnect feature when a
2109 connection is broken so in most cases this parameter should be
2110 transparent to users.
2112 Using this parameter with a timeout of a few minutes
2113 is recommended for most systems.
2115 A deadtime of zero indicates that no auto-disconnection
2116 should be performed.
2118 Default: \fBdeadtime = 0\fR
2120 Example: \fBdeadtime = 15\fR
2122 \fBdebug hires timestamp (G)\fR
2123 Sometimes the timestamps in the log messages
2124 are needed with a resolution of higher that seconds, this
2125 boolean parameter adds microsecond resolution to the timestamp
2126 message header when turned on.
2128 Note that the parameter \fI debug timestamp\fR must be on for this to have an
2131 Default: \fBdebug hires timestamp = no\fR
2134 When using only one log file for more then one
2135 forked smbd-process there may be hard to follow which process
2136 outputs which message. This boolean parameter is adds the process-id
2137 to the timestamp message headers in the logfile when turned on.
2139 Note that the parameter \fI debug timestamp\fR must be on for this to have an
2142 Default: \fBdebug pid = no\fR
2144 \fBdebug timestamp (G)\fR
2145 Samba 2.2 debug log messages are timestamped
2146 by default. If you are running at a high \fIdebug level\fR these timestamps
2147 can be distracting. This boolean parameter allows timestamping
2150 Default: \fBdebug timestamp = yes\fR
2153 Samba is sometimes run as root and sometime
2154 run as the connected user, this boolean parameter inserts the
2155 current euid, egid, uid and gid to the timestamp message headers
2156 in the log file if turned on.
2158 Note that the parameter \fI debug timestamp\fR must be on for this to have an
2161 Default: \fBdebug uid = no\fR
2163 \fBdebuglevel (G)\fR
2164 Synonym for \fI log level\fR.
2167 A synonym for \fI default service\fR.
2169 \fBdefault case (S)\fR
2170 See the section on NAME MANGLING. Also note the \fIshort preserve case\fR parameter.
2172 Default: \fBdefault case = lower\fR
2174 \fBdefault service (G)\fR
2175 This parameter specifies the name of a service
2176 which will be connected to if the service actually requested cannot
2177 be found. Note that the square brackets are \fBNOT\fR
2178 given in the parameter value (see example below).
2180 There is no default value for this parameter. If this
2181 parameter is not given, attempting to connect to a nonexistent
2182 service results in an error.
2184 Typically the default service would be a \fIguest ok\fR, \fIread-only\fR service.
2186 Also note that the apparent service name will be changed
2187 to equal that of the requested service, this is very useful as it
2188 allows you to use macros like \fI%S\fR to make
2191 Note also that any "_" characters in the name of the service
2192 used in the default service will get mapped to a "/". This allows for
2200 default service = pub
2208 \fBdelete printer command (G)\fR
2209 With the introduction of MS-RPC based printer
2210 support for Windows NT/2000 clients in Samba 2.2, it is now
2211 possible to delete printer at run time by issuing the
2212 DeletePrinter() RPC call.
2214 For a Samba host this means that the printer must be
2215 physically deleted from underlying printing system. The \fI deleteprinter command\fR defines a script to be run which
2216 will perform the necessary operations for removing the printer
2217 from the print system and from \fIsmb.conf\fR.
2219 The \fIdelete printer command\fR is
2220 automatically called with only one parameter: \fI "printer name"\fR.
2222 Once the \fIdelete printer command\fR has
2223 been executed, \fBsmbd\fR will reparse the \fI smb.conf\fR to associated printer no longer exists.
2224 If the sharename is still valid, then \fBsmbd
2225 \fRwill return an ACCESS_DENIED error to the client.
2227 See also \fI add printer command\fR, \fIprinting\fR,
2233 Example: \fBdeleteprinter command = /usr/bin/removeprinter
2235 \fBdelete readonly (S)\fR
2236 This parameter allows readonly files to be deleted.
2237 This is not normal DOS semantics, but is allowed by UNIX.
2239 This option may be useful for running applications such
2240 as rcs, where UNIX file ownership prevents changing file
2241 permissions, and DOS semantics prevent deletion of a read only file.
2243 Default: \fBdelete readonly = no\fR
2245 \fBdelete share command (G)\fR
2246 Samba 2.2.0 introduced the ability to dynamically
2247 add and delete shares via the Windows NT 4.0 Server Manager. The
2248 \fIdelete share command\fR is used to define an
2249 external program or script which will remove an existing service
2250 definition from \fIsmb.conf\fR. In order to successfully
2251 execute the \fIdelete share command\fR, \fBsmbd\fR
2252 requires that the administrator be connected using a root account (i.e.
2255 When executed, \fBsmbd\fR will automatically invoke the
2256 \fIdelete share command\fR with two parameters.
2260 \fIconfigFile\fR - the location
2261 of the global \fIsmb.conf\fR file.
2264 \fIshareName\fR - the name of
2265 the existing service.
2268 This parameter is only used to remove file shares. To delete printer shares,
2269 see the \fIdelete printer
2273 See also \fIadd share
2274 command\fR, \fIchange
2281 Example: \fBdelete share command = /usr/local/bin/delshare\fR
2284 \fBdelete user script (G)\fR
2285 This is the full pathname to a script that will
2286 be run \fBAS ROOT\fR by \fBsmbd(8)\fRunder special circumstances
2289 Normally, a Samba server requires that UNIX users are
2290 created for all users accessing files on this server. For sites
2291 that use Windows NT account databases as their primary user database
2292 creating these users and keeping the user list in sync with the
2293 Windows NT PDC is an onerous task. This option allows \fB smbd\fR to delete the required UNIX users \fBON
2294 DEMAND\fR when a user accesses the Samba server and the
2295 Windows NT user no longer exists.
2297 In order to use this option, \fBsmbd\fR must be
2298 set to \fIsecurity = domain\fR and \fIdelete
2299 user script\fR must be set to a full pathname for a script
2300 that will delete a UNIX user given one argument of \fI%u
2301 \fR, which expands into the UNIX user name to delete.
2302 \fBNOTE\fR that this is different to the \fIadd user script\fR
2303 which will work with the \fIsecurity = server\fR option
2304 as well as \fIsecurity = domain\fR. The reason for this
2305 is only when Samba is a domain member does it get the information
2306 on an attempted user logon that a user no longer exists. In the
2307 \fIsecurity = server\fR mode a missing user
2308 is treated the same as an invalid password logon attempt. Deleting
2309 the user in this circumstance would not be a good idea.
2311 When the Windows user attempts to access the Samba server,
2312 at \fBlogin\fR (session setup in the SMB protocol)
2313 time, \fBsmbd\fR contacts the \fIpassword server\fR and attempts to authenticate
2314 the given user with the given password. If the authentication fails
2315 with the specific Domain error code meaning that the user no longer
2316 exists then \fBsmbd\fR attempts to find a UNIX user in
2317 the UNIX password database that matches the Windows user account. If
2318 this lookup succeeds, and \fIdelete user script\fR is
2319 set then \fBsmbd\fR will all the specified script
2320 \fBAS ROOT\fR, expanding any \fI%u\fR
2321 argument to be the user name to delete.
2323 This script should delete the given UNIX username. In this way,
2324 UNIX users are dynamically deleted to match existing Windows NT
2327 See also security = domain,
2328 \fIpassword server\fR
2329 , \fIadd user script\fR
2332 Default: \fBdelete user script = <empty string>
2334 Example: \fBdelete user script = /usr/local/samba/bin/del_user
2337 \fBdelete veto files (S)\fR
2338 This option is used when Samba is attempting to
2339 delete a directory that contains one or more vetoed directories
2340 (see the \fIveto files\fR
2341 option). If this option is set to false (the default) then if a vetoed
2342 directory contains any non-vetoed files or directories then the
2343 directory delete will fail. This is usually what you want.
2345 If this option is set to true, then Samba
2346 will attempt to recursively delete any files and directories within
2347 the vetoed directory. This can be useful for integration with file
2348 serving systems such as NetAtalk which create meta-files within
2349 directories you might normally veto DOS/Windows users from seeing
2350 (e.g. \fI.AppleDouble\fR)
2352 Setting \fBdelete veto files = yes\fR allows these
2353 directories to be transparently deleted when the parent directory
2354 is deleted (so long as the user has permissions to do so).
2356 See also the \fIveto
2359 Default: \fBdelete veto files = no\fR
2361 \fBdeny hosts (S)\fR
2362 Synonym for \fIhosts
2365 \fBdfree command (G)\fR
2366 The \fIdfree command\fR setting should
2367 only be used on systems where a problem occurs with the internal
2368 disk space calculations. This has been known to happen with Ultrix,
2369 but may occur with other operating systems. The symptom that was
2370 seen was an error of "Abort Retry Ignore" at the end of each
2373 This setting allows the replacement of the internal routines to
2374 calculate the total disk space and amount available with an external
2375 routine. The example below gives a possible script that might fulfill
2378 The external program will be passed a single parameter indicating
2379 a directory in the filesystem being queried. This will typically consist
2380 of the string \fI./\fR. The script should return two
2381 integers in ASCII. The first should be the total disk space in blocks,
2382 and the second should be the number of available blocks. An optional
2383 third return value can give the block size in bytes. The default
2384 blocksize is 1024 bytes.
2386 Note: Your script should \fBNOT\fR be setuid or
2387 setgid and should be owned by (and writeable only by) root!
2389 Default: \fBBy default internal routines for
2390 determining the disk capacity and remaining space will be used.
2392 Example: \fBdfree command = /usr/local/samba/bin/dfree
2394 Where the script dfree (which must be made executable) could be:
2400 df $1 | tail -1 | awk '{print $2" "$4}'
2405 or perhaps (on Sys V based systems):
2411 /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
2416 Note that you may have to replace the command names
2417 with full path names on some systems.
2423 \fBdirectory mask (S)\fR
2424 This parameter is the octal modes which are
2425 used when converting DOS modes to UNIX modes when creating UNIX
2428 When a directory is created, the necessary permissions are
2429 calculated according to the mapping from DOS modes to UNIX permissions,
2430 and the resulting UNIX mode is then bit-wise 'AND'ed with this
2431 parameter. This parameter may be thought of as a bit-wise MASK for
2432 the UNIX modes of a directory. Any bit \fBnot\fR set
2433 here will be removed from the modes set on a directory when it is
2436 The default value of this parameter removes the 'group'
2437 and 'other' write bits from the UNIX mode, allowing only the
2438 user who owns the directory to modify it.
2440 Following this Samba will bit-wise 'OR' the UNIX mode
2441 created from this parameter with the value of the \fIforce directory mode
2442 \fRparameter. This parameter is set to 000 by
2443 default (i.e. no extra mode bits are added).
2445 Note that this parameter does not apply to permissions
2446 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
2447 a mask on access control lists also, they need to set the \fIdirectory security mask\fR.
2450 directory mode\fR parameter to cause particular mode
2451 bits to always be set on created directories.
2453 See also the \fIcreate mode
2454 \fRparameter for masking mode bits on created files,
2455 and the \fIdirectory
2456 security mask\fR parameter.
2458 Also refer to the \fI inherit permissions\fR parameter.
2460 Default: \fBdirectory mask = 0755\fR
2462 Example: \fBdirectory mask = 0775\fR
2464 \fBdirectory mode (S)\fR
2465 Synonym for \fI directory mask\fR
2467 \fBdirectory security mask (S)\fR
2468 This parameter controls what UNIX permission bits
2469 can be modified when a Windows NT client is manipulating the UNIX
2470 permission on a directory using the native NT security dialog
2473 This parameter is applied as a mask (AND'ed with) to
2474 the changed permission bits, thus preventing any bits not in
2475 this mask from being modified. Essentially, zero bits in this
2476 mask may be treated as a set of bits the user is not allowed
2479 If not set explicitly this parameter is set to 0777
2480 meaning a user is allowed to modify all the user/group/world
2481 permissions on a directory.
2483 \fBNote\fR that users who can access the
2484 Samba server through other means can easily bypass this restriction,
2485 so it is primarily useful for standalone "appliance" systems.
2486 Administrators of most normal systems will probably want to leave
2487 it as the default of 0777.
2489 See also the \fI force directory security mode\fR, \fIsecurity mask\fR,
2490 \fIforce security mode
2493 Default: \fBdirectory security mask = 0777\fR
2495 Example: \fBdirectory security mask = 0700\fR
2497 \fBdisable spoolss (G)\fR
2498 Enabling this parameter will disables Samba's support
2499 for the SPOOLSS set of MS-RPC's and will yield identical behavior
2500 as Samba 2.0.x. Windows NT/2000 clients will downgrade to using
2501 Lanman style printing commands. Windows 9x/ME will be uneffected by
2502 the parameter. However, this will also disable the ability to upload
2503 printer drivers to a Samba server via the Windows NT Add Printer
2504 Wizard or by using the NT printer properties dialog window. It will
2505 also disable the capability of Windows NT/2000 clients to download
2506 print drivers from the Samba host upon demand.
2507 \fBBe very careful about enabling this parameter.\fR
2509 See also use client driver
2511 Default : \fBdisable spoolss = no\fR
2514 Specifies that nmbd(8)
2515 when acting as a WINS server and finding that a NetBIOS name has not
2516 been registered, should treat the NetBIOS name word-for-word as a DNS
2517 name and do a lookup with the DNS server for that name on behalf of
2518 the name-querying client.
2520 Note that the maximum length for a NetBIOS name is 15
2521 characters, so the DNS name (or DNS alias) can likewise only be
2522 15 characters, maximum.
2524 \fBnmbd\fR spawns a second copy of itself to do the
2525 DNS name lookup requests, as doing a name lookup is a blocking
2528 See also the parameter \fI wins support\fR.
2530 Default: \fBdns proxy = yes\fR
2532 \fBdomain admin group (G)\fR
2533 This parameter is intended as a temporary solution
2534 to enable users to be a member of the "Domain Admins" group when
2535 a Samba host is acting as a PDC. A complete solution will be provided
2536 by a system for mapping Windows NT/2000 groups onto UNIX groups.
2537 Please note that this parameter has a somewhat confusing name. It
2538 accepts a list of usernames and of group names in standard
2539 \fIsmb.conf\fR notation.
2542 guest group\fR, \fIdomain
2545 Default: \fBno domain administrators\fR
2547 Example: \fBdomain admin group = root @wheel\fR
2549 \fBdomain guest group (G)\fR
2550 This parameter is intended as a temporary solution
2551 to enable users to be a member of the "Domain Guests" group when
2552 a Samba host is acting as a PDC. A complete solution will be provided
2553 by a system for mapping Windows NT/2000 groups onto UNIX groups.
2554 Please note that this parameter has a somewhat confusing name. It
2555 accepts a list of usernames and of group names in standard
2556 \fIsmb.conf\fR notation.
2559 admin group\fR, \fIdomain
2562 Default: \fBno domain guests\fR
2564 Example: \fBdomain guest group = nobody @guest\fR
2566 \fBdomain logons (G)\fR
2567 If set to true, the Samba server will serve
2568 Windows 95/98 Domain logons for the \fIworkgroup\fR it is in. Samba 2.2 also
2569 has limited capability to act as a domain controller for Windows
2570 NT 4 Domains. For more details on setting up this feature see
2571 the Samba-PDC-HOWTO included in the \fIhtmldocs/\fR
2572 directory shipped with the source code.
2574 Default: \fBdomain logons = no\fR
2576 \fBdomain master (G)\fR
2577 Tell \fB nmbd(8)\fRto enable WAN-wide browse list
2578 collation. Setting this option causes \fBnmbd\fR to
2579 claim a special domain specific NetBIOS name that identifies
2580 it as a domain master browser for its given \fIworkgroup\fR. Local master browsers
2581 in the same \fIworkgroup\fR on broadcast-isolated
2582 subnets will give this \fBnmbd\fR their local browse lists,
2583 and then ask \fBsmbd(8)\fR
2584 for a complete copy of the browse list for the whole wide area
2585 network. Browser clients will then contact their local master browser,
2586 and will receive the domain-wide browse list, instead of just the list
2587 for their broadcast-isolated subnet.
2589 Note that Windows NT Primary Domain Controllers expect to be
2590 able to claim this \fIworkgroup\fR specific special
2591 NetBIOS name that identifies them as domain master browsers for
2592 that \fIworkgroup\fR by default (i.e. there is no
2593 way to prevent a Windows NT PDC from attempting to do this). This
2594 means that if this parameter is set and \fBnmbd\fR claims
2595 the special name for a \fIworkgroup\fR before a Windows
2596 NT PDC is able to do so then cross subnet browsing will behave
2597 strangely and may fail.
2599 If \fBdomain logons = yes\fR
2600 , then the default behavior is to enable the \fIdomain
2601 master\fR parameter. If \fIdomain logons\fR is
2602 not enabled (the default setting), then neither will \fIdomain
2603 master\fR be enabled by default.
2605 Default: \fBdomain master = auto\fR
2607 \fBdont descend (S)\fR
2608 There are certain directories on some systems
2609 (e.g., the \fI/proc\fR tree under Linux) that are either not
2610 of interest to clients or are infinitely deep (recursive). This
2611 parameter allows you to specify a comma-delimited list of directories
2612 that the server should always show as empty.
2614 Note that Samba can be very fussy about the exact format
2615 of the "dont descend" entries. For example you may need \fI ./proc\fR instead of just \fI/proc\fR.
2616 Experimentation is the best policy :-)
2618 Default: \fBnone (i.e., all directories are OK
2621 Example: \fBdont descend = /proc,/dev\fR
2623 \fBdos filemode (S)\fR
2624 The default behavior in Samba is to provide
2625 UNIX-like behavior where only the owner of a file/directory is
2626 able to change the permissions on it. However, this behavior
2627 is often confusing to DOS/Windows users. Enabling this parameter
2628 allows a user who has write access to the file (by whatever
2629 means) to modify the permissions on it. Note that a user
2630 belonging to the group owning the file will not be allowed to
2631 change permissions if the group is only granted read access.
2632 Ownership of the file/directory is not changed, only the permissions
2635 Default: \fBdos filemode = no\fR
2637 \fBdos filetime resolution (S)\fR
2638 Under the DOS and Windows FAT filesystem, the finest
2639 granularity on time resolution is two seconds. Setting this parameter
2640 for a share causes Samba to round the reported time down to the
2641 nearest two second boundary when a query call that requires one second
2642 resolution is made to \fBsmbd(8)\fR
2645 This option is mainly used as a compatibility option for Visual
2646 C++ when used against Samba shares. If oplocks are enabled on a
2647 share, Visual C++ uses two different time reading calls to check if a
2648 file has changed since it was last read. One of these calls uses a
2649 one-second granularity, the other uses a two second granularity. As
2650 the two second call rounds any odd second down, then if the file has a
2651 timestamp of an odd number of seconds then the two timestamps will not
2652 match and Visual C++ will keep reporting the file has changed. Setting
2653 this option causes the two timestamps to match, and Visual C++ is
2656 Default: \fBdos filetime resolution = no\fR
2658 \fBdos filetimes (S)\fR
2659 Under DOS and Windows, if a user can write to a
2660 file they can change the timestamp on it. Under POSIX semantics,
2661 only the owner of the file or root may change the timestamp. By
2662 default, Samba runs with POSIX semantics and refuses to change the
2663 timestamp on a file if the user \fBsmbd\fR is acting
2664 on behalf of is not the file owner. Setting this option to true allows DOS semantics and smbdwill change the file
2665 timestamp as DOS requires.
2667 Default: \fBdos filetimes = no\fR
2669 \fBencrypt passwords (G)\fR
2670 This boolean controls whether encrypted passwords
2671 will be negotiated with the client. Note that Windows NT 4.0 SP3 and
2672 above and also Windows 98 will by default expect encrypted passwords
2673 unless a registry entry is changed. To use encrypted passwords in
2674 Samba see the file ENCRYPTION.txt in the Samba documentation
2675 directory \fIdocs/\fR shipped with the source code.
2677 In order for encrypted passwords to work correctly
2678 \fBsmbd(8)\fRmust either
2679 have access to a local \fIsmbpasswd(5)
2680 \fRprogram for information on how to set up
2681 and maintain this file), or set the security = [server|domain] parameter which
2682 causes \fBsmbd\fR to authenticate against another
2685 Default: \fBencrypt passwords = no\fR
2687 \fBenhanced browsing (G)\fR
2688 This option enables a couple of enhancements to
2689 cross-subnet browse propagation that have been added in Samba
2690 but which are not standard in Microsoft implementations.
2692 The first enhancement to browse propagation consists of a regular
2693 wildcard query to a Samba WINS server for all Domain Master Browsers,
2694 followed by a browse synchronization with each of the returned
2695 DMBs. The second enhancement consists of a regular randomised browse
2696 synchronization with all currently known DMBs.
2698 You may wish to disable this option if you have a problem with empty
2699 workgroups not disappearing from browse lists. Due to the restrictions
2700 of the browse protocols these enhancements can cause a empty workgroup
2701 to stay around forever which can be annoying.
2703 In general you should leave this option enabled as it makes
2704 cross-subnet browse propagation much more reliable.
2706 Default: \fBenhanced browsing = yes\fR
2708 \fBenumports command (G)\fR
2709 The concept of a "port" is fairly foreign
2710 to UNIX hosts. Under Windows NT/2000 print servers, a port
2711 is associated with a port monitor and generally takes the form of
2712 a local port (i.e. LPT1:, COM1:, FILE:) or a remote port
2713 (i.e. LPD Port Monitor, etc...). By default, Samba has only one
2714 port defined--"Samba Printer Port". Under
2715 Windows NT/2000, all printers must have a valid port name.
2716 If you wish to have a list of ports displayed (\fBsmbd
2717 \fRdoes not use a port name for anything) other than
2718 the default "Samba Printer Port", you
2719 can define \fIenumports command\fR to point to
2720 a program which should generate a list of ports, one per line,
2721 to standard output. This listing will then be used in response
2722 to the level 1 and 2 EnumPorts() RPC.
2724 Default: \fBno enumports command\fR
2726 Example: \fBenumports command = /usr/bin/listports
2729 This is a synonym for \fIpreexec\fR.
2731 \fBfake directory create times (S)\fR
2732 NTFS and Windows VFAT file systems keep a create
2733 time for all files and directories. This is not the same as the
2734 ctime - status change time - that Unix keeps, so Samba by default
2735 reports the earliest of the various times Unix does keep. Setting
2736 this parameter for a share causes Samba to always report midnight
2737 1-1-1980 as the create time for directories.
2739 This option is mainly used as a compatibility option for
2740 Visual C++ when used against Samba shares. Visual C++ generated
2741 makefiles have the object directory as a dependency for each object
2742 file, and a make rule to create the directory. Also, when NMAKE
2743 compares timestamps it uses the creation time when examining a
2744 directory. Thus the object directory will be created if it does not
2745 exist, but once it does exist it will always have an earlier
2746 timestamp than the object files it contains.
2748 However, Unix time semantics mean that the create time
2749 reported by Samba will be updated whenever a file is created or
2750 or deleted in the directory. NMAKE finds all object files in
2751 the object directory. The timestamp of the last one built is then
2752 compared to the timestamp of the object directory. If the
2753 directory's timestamp if newer, then all object files
2754 will be rebuilt. Enabling this option
2755 ensures directories always predate their contents and an NMAKE build
2756 will proceed as expected.
2758 Default: \fBfake directory create times = no\fR
2760 \fBfake oplocks (S)\fR
2761 Oplocks are the way that SMB clients get permission
2762 from a server to locally cache file operations. If a server grants
2763 an oplock (opportunistic lock) then the client is free to assume
2764 that it is the only one accessing the file and it will aggressively
2765 cache file data. With some oplock types the client may even cache
2766 file open/close operations. This can give enormous performance benefits.
2768 When you set \fBfake oplocks = yes\fR, \fBsmbd(8)\fRwill
2769 always grant oplock requests no matter how many clients are using
2772 It is generally much better to use the real \fIoplocks\fR support rather
2773 than this parameter.
2775 If you enable this option on all read-only shares or
2776 shares that you know will only be accessed from one client at a
2777 time such as physically read-only media like CDROMs, you will see
2778 a big performance improvement on many operations. If you enable
2779 this option on shares where multiple clients may be accessing the
2780 files read-write at the same time you can get data corruption. Use
2781 this option carefully!
2783 Default: \fBfake oplocks = no\fR
2785 \fBfollow symlinks (S)\fR
2786 This parameter allows the Samba administrator
2787 to stop \fBsmbd(8)\fR
2788 from following symbolic links in a particular share. Setting this
2789 parameter to no prevents any file or directory
2790 that is a symbolic link from being followed (the user will get an
2791 error). This option is very useful to stop users from adding a
2792 symbolic link to \fI/etc/passwd\fR in their home
2793 directory for instance. However it will slow filename lookups
2796 This option is enabled (i.e. \fBsmbd\fR will
2797 follow symbolic links) by default.
2799 Default: \fBfollow symlinks = yes\fR
2801 \fBforce create mode (S)\fR
2802 This parameter specifies a set of UNIX mode bit
2803 permissions that will \fBalways\fR be set on a
2804 file created by Samba. This is done by bitwise 'OR'ing these bits onto
2805 the mode bits of a file that is being created or having its
2806 permissions changed. The default for this parameter is (in octal)
2807 000. The modes in this parameter are bitwise 'OR'ed onto the file
2808 mode after the mask set in the \fIcreate mask\fR
2809 parameter is applied.
2811 See also the parameter \fIcreate
2812 mask\fR for details on masking mode bits on files.
2814 See also the \fIinherit
2815 permissions\fR parameter.
2817 Default: \fBforce create mode = 000\fR
2819 Example: \fBforce create mode = 0755\fR
2821 would force all created files to have read and execute
2822 permissions set for 'group' and 'other' as well as the
2823 read/write/execute bits set for the 'user'.
2825 \fBforce directory mode (S)\fR
2826 This parameter specifies a set of UNIX mode bit
2827 permissions that will \fBalways\fR be set on a directory
2828 created by Samba. This is done by bitwise 'OR'ing these bits onto the
2829 mode bits of a directory that is being created. The default for this
2830 parameter is (in octal) 0000 which will not add any extra permission
2831 bits to a created directory. This operation is done after the mode
2832 mask in the parameter \fIdirectory mask\fR is
2835 See also the parameter \fI directory mask\fR for details on masking mode bits
2836 on created directories.
2838 See also the \fI inherit permissions\fR parameter.
2840 Default: \fBforce directory mode = 000\fR
2842 Example: \fBforce directory mode = 0755\fR
2844 would force all created directories to have read and execute
2845 permissions set for 'group' and 'other' as well as the
2846 read/write/execute bits set for the 'user'.
2848 \fBforce directory security mode (S)\fR
2849 This parameter controls what UNIX permission bits
2850 can be modified when a Windows NT client is manipulating the UNIX
2851 permission on a directory using the native NT security dialog box.
2853 This parameter is applied as a mask (OR'ed with) to the
2854 changed permission bits, thus forcing any bits in this mask that
2855 the user may have modified to be on. Essentially, one bits in this
2856 mask may be treated as a set of bits that, when modifying security
2857 on a directory, the user has always set to be 'on'.
2859 If not set explicitly this parameter is 000, which
2860 allows a user to modify all the user/group/world permissions on a
2861 directory without restrictions.
2863 \fBNote\fR that users who can access the
2864 Samba server through other means can easily bypass this restriction,
2865 so it is primarily useful for standalone "appliance" systems.
2866 Administrators of most normal systems will probably want to leave
2869 See also the \fI directory security mask\fR, \fIsecurity mask\fR,
2870 \fIforce security mode
2873 Default: \fBforce directory security mode = 0\fR
2875 Example: \fBforce directory security mode = 700\fR
2877 \fBforce group (S)\fR
2878 This specifies a UNIX group name that will be
2879 assigned as the default primary group for all users connecting
2880 to this service. This is useful for sharing files by ensuring
2881 that all access to files on service will use the named group for
2882 their permissions checking. Thus, by assigning permissions for this
2883 group to the files and directories within this service the Samba
2884 administrator can restrict or allow sharing of these files.
2886 In Samba 2.0.5 and above this parameter has extended
2887 functionality in the following way. If the group name listed here
2888 has a '+' character prepended to it then the current user accessing
2889 the share only has the primary group default assigned to this group
2890 if they are already assigned as a member of that group. This allows
2891 an administrator to decide that only users who are already in a
2892 particular group will create files with group ownership set to that
2893 group. This gives a finer granularity of ownership assignment. For
2894 example, the setting \fIforce group = +sys\fR means
2895 that only users who are already in group sys will have their default
2896 primary group assigned to sys when accessing this Samba share. All
2897 other users will retain their ordinary primary group.
2899 If the \fIforce user
2900 \fRparameter is also set the group specified in
2901 \fIforce group\fR will override the primary group
2902 set in \fIforce user\fR.
2907 Default: \fBno forced group\fR
2909 Example: \fBforce group = agroup\fR
2911 \fBforce security mode (S)\fR
2912 This parameter controls what UNIX permission
2913 bits can be modified when a Windows NT client is manipulating
2914 the UNIX permission on a file using the native NT security dialog
2917 This parameter is applied as a mask (OR'ed with) to the
2918 changed permission bits, thus forcing any bits in this mask that
2919 the user may have modified to be on. Essentially, one bits in this
2920 mask may be treated as a set of bits that, when modifying security
2921 on a file, the user has always set to be 'on'.
2923 If not set explicitly this parameter is set to 0,
2924 and allows a user to modify all the user/group/world permissions on a file,
2925 with no restrictions.
2927 \fBNote\fR that users who can access
2928 the Samba server through other means can easily bypass this restriction,
2929 so it is primarily useful for standalone "appliance" systems.
2930 Administrators of most normal systems will probably want to leave
2933 See also the \fI force directory security mode\fR,
2934 \fIdirectory security
2935 mask\fR, \fI security mask\fR parameters.
2937 Default: \fBforce security mode = 0\fR
2939 Example: \fBforce security mode = 700\fR
2941 \fBforce user (S)\fR
2942 This specifies a UNIX user name that will be
2943 assigned as the default user for all users connecting to this service.
2944 This is useful for sharing files. You should also use it carefully
2945 as using it incorrectly can cause security problems.
2947 This user name only gets used once a connection is established.
2948 Thus clients still need to connect as a valid user and supply a
2949 valid password. Once connected, all file operations will be performed
2950 as the "forced user", no matter what username the client connected
2951 as. This can be very useful.
2953 In Samba 2.0.5 and above this parameter also causes the
2954 primary group of the forced user to be used as the primary group
2955 for all file activity. Prior to 2.0.5 the primary group was left
2956 as the primary group of the connecting user (this was a bug).
2958 See also \fIforce group
2960 Default: \fBno forced user\fR
2962 Example: \fBforce user = auser\fR
2965 This parameter allows the administrator to
2966 configure the string that specifies the type of filesystem a share
2967 is using that is reported by \fBsmbd(8)
2968 \fRwhen a client queries the filesystem type
2969 for a share. The default type is NTFS for
2970 compatibility with Windows NT but this can be changed to other
2971 strings such as Samba or FAT
2974 Default: \fBfstype = NTFS\fR
2976 Example: \fBfstype = Samba\fR
2978 \fBgetwd cache (G)\fR
2979 This is a tuning option. When this is enabled a
2980 caching algorithm will be used to reduce the time taken for getwd()
2981 calls. This can have a significant impact on performance, especially
2982 when the \fIwide links\fR
2983 parameter is set to false.
2985 Default: \fBgetwd cache = yes\fR
2988 Synonym for \fIforce
2991 \fBguest account (S)\fR
2992 This is a username which will be used for access
2993 to services which are specified as \fI guest ok\fR (see below). Whatever privileges this
2994 user has will be available to any client connecting to the guest service.
2995 Typically this user will exist in the password file, but will not
2996 have a valid login. The user account "ftp" is often a good choice
2997 for this parameter. If a username is specified in a given service,
2998 the specified username overrides this one.
3000 One some systems the default guest account "nobody" may not
3001 be able to print. Use another account in this case. You should test
3002 this by trying to log in as your guest user (perhaps by using the
3003 \fBsu -\fR command) and trying to print using the
3004 system print command such as \fBlpr(1)\fR or \fB lp(1)\fR.
3006 Default: \fBspecified at compile time, usually
3009 Example: \fBguest account = ftp\fR
3012 If this parameter is yes for
3013 a service, then no password is required to connect to the service.
3014 Privileges will be those of the \fI guest account\fR.
3016 See the section below on \fI security\fR for more information about this option.
3018 Default: \fBguest ok = no\fR
3020 \fBguest only (S)\fR
3021 If this parameter is yes for
3022 a service, then only guest connections to the service are permitted.
3023 This parameter will have no effect if \fIguest ok\fR is not set for the service.
3025 See the section below on \fI security\fR for more information about this option.
3027 Default: \fBguest only = no\fR
3029 \fBhide dot files (S)\fR
3030 This is a boolean parameter that controls whether
3031 files starting with a dot appear as hidden files.
3033 Default: \fBhide dot files = yes\fR
3036 This is a list of files or directories that are not
3037 visible but are accessible. The DOS 'hidden' attribute is applied
3038 to any files or directories that match.
3040 Each entry in the list must be separated by a '/',
3041 which allows spaces to be included in the entry. '*'
3042 and '?' can be used to specify multiple files or directories
3043 as in DOS wildcards.
3045 Each entry must be a Unix path, not a DOS path and must
3046 not include the Unix directory separator '/'.
3048 Note that the case sensitivity option is applicable
3051 Setting this parameter will affect the performance of Samba,
3052 as it will be forced to check all files and directories for a match
3053 as they are scanned.
3056 dot files\fR, \fI veto files\fR and \fIcase sensitive\fR.
3058 Default: \fBno file are hidden\fR
3060 Example: \fBhide files =
3061 /.*/DesktopFolderDB/TrashFor%m/resource.frk/\fR
3063 The above example is based on files that the Macintosh
3064 SMB client (DAVE) available from
3065 Thursby <URL:http://www.thursby.com> creates for internal use, and also still hides
3066 all files beginning with a dot.
3068 \fBhide local users(G)\fR
3069 This parameter toggles the hiding of local UNIX
3070 users (root, wheel, floppy, etc) from remote clients.
3072 Default: \fBhide local users = no\fR
3074 \fBhide unreadable (S)\fR
3075 This parameter prevents clients from seeing the
3076 existance of files that cannot be read. Defaults to off.
3078 Default: \fBhide unreadable = no\fR
3080 \fBhomedir map (G)\fR
3082 \fRis true, and \fBsmbd(8)\fRis also acting
3083 as a Win95/98 \fIlogon server\fR then this parameter
3084 specifies the NIS (or YP) map from which the server for the user's
3085 home directory should be extracted. At present, only the Sun
3086 auto.home map format is understood. The form of the map is:
3088 \fBusername server:/some/file/system\fR
3090 and the program will extract the servername from before
3091 the first ':'. There should probably be a better parsing system
3092 that copes with different map formats and also Amd (another
3095 \fBNOTE :\fRA working NIS client is required on
3096 the system for this option to work.
3098 See also \fInis homedir\fR
3099 , \fIdomain logons\fR
3102 Default: \fBhomedir map = <empty string>\fR
3104 Example: \fBhomedir map = amd.homedir\fR
3106 \fBhost msdfs (G)\fR
3107 This boolean parameter is only available
3108 if Samba has been configured and compiled with the \fB --with-msdfs\fR option. If set to yes,
3109 Samba will act as a Dfs server, and allow Dfs-aware clients
3110 to browse Dfs trees hosted on the server.
3112 See also the \fI msdfs root\fR share level parameter. For
3113 more information on setting up a Dfs tree on Samba,
3114 refer to msdfs_setup.html.
3116 Default: \fBhost msdfs = no\fR
3118 \fBhosts allow (S)\fR
3119 A synonym for this parameter is \fIallow
3122 This parameter is a comma, space, or tab delimited
3123 set of hosts which are permitted to access a service.
3125 If specified in the [global] section then it will
3126 apply to all services, regardless of whether the individual
3127 service has a different setting.
3129 You can specify the hosts by name or IP number. For
3130 example, you could restrict access to only the hosts on a
3131 Class C subnet with something like \fBallow hosts = 150.203.5.
3132 \fR\&. The full syntax of the list is described in the man
3133 page \fIhosts_access(5)\fR. Note that this man
3134 page may not be present on your system, so a brief description will
3137 Note that the localhost address 127.0.0.1 will always
3138 be allowed access unless specifically denied by a \fIhosts deny\fR option.
3140 You can also specify hosts by network/netmask pairs and
3141 by netgroup names if your system supports netgroups. The
3142 \fBEXCEPT\fR keyword can also be used to limit a
3143 wildcard list. The following examples may provide some help:
3145 Example 1: allow all IPs in 150.203.*.*; except one
3147 \fBhosts allow = 150.203. EXCEPT 150.203.6.66\fR
3149 Example 2: allow hosts that match the given network/netmask
3151 \fBhosts allow = 150.203.15.0/255.255.255.0\fR
3153 Example 3: allow a couple of hosts
3155 \fBhosts allow = lapland, arvidsjaur\fR
3157 Example 4: allow only hosts in NIS netgroup "foonet", but
3158 deny access from one particular host
3160 \fBhosts allow = @foonet\fR
3162 \fBhosts deny = pirate\fR
3164 Note that access still requires suitable user-level passwords.
3166 See \fBtestparm(1)\fR
3167 for a way of testing your host access to see if it does
3170 Default: \fBnone (i.e., all hosts permitted access)
3172 Example: \fBallow hosts = 150.203.5. myhost.mynet.edu.au
3174 \fBhosts deny (S)\fR
3175 The opposite of \fIhosts allow\fR
3176 - hosts listed here are \fBNOT\fR permitted access to
3177 services unless the specific services have their own lists to override
3178 this one. Where the lists conflict, the \fIallow\fR
3179 list takes precedence.
3181 Default: \fBnone (i.e., no hosts specifically excluded)
3183 Example: \fBhosts deny = 150.203.4. badhost.mynet.edu.au
3185 \fBhosts equiv (G)\fR
3186 If this global parameter is a non-null string,
3187 it specifies the name of a file to read for the names of hosts
3188 and users who will be allowed access without specifying a password.
3190 This is not be confused with \fIhosts allow\fR which is about hosts
3191 access to services and is more useful for guest services. \fI hosts equiv\fR may be useful for NT clients which will
3192 not supply passwords to Samba.
3194 \fBNOTE :\fR The use of \fIhosts equiv
3195 \fRcan be a major security hole. This is because you are
3196 trusting the PC to supply the correct username. It is very easy to
3197 get a PC to supply a false username. I recommend that the
3198 \fIhosts equiv\fR option be only used if you really
3199 know what you are doing, or perhaps on a home network where you trust
3200 your spouse and kids. And only if you \fBreally\fR trust
3203 Default: \fBno host equivalences\fR
3205 Example: \fBhosts equiv = /etc/hosts.equiv\fR
3208 This allows you to include one config file
3209 inside another. The file is included literally, as though typed
3212 It takes the standard substitutions, except \fI%u
3213 \fR, \fI%P\fR and \fI%S\fR.
3215 Default: \fBno file included\fR
3217 Example: \fBinclude = /usr/local/samba/lib/admin_smb.conf
3219 \fBinherit permissions (S)\fR
3220 The permissions on new files and directories
3221 are normally governed by \fI create mask\fR, \fIdirectory mask\fR, \fIforce create mode\fR
3223 directory mode\fR but the boolean inherit
3224 permissions parameter overrides this.
3226 New directories inherit the mode of the parent directory,
3227 including bits such as setgid.
3229 New files inherit their read/write bits from the parent
3230 directory. Their execute bits continue to be determined by
3233 and \fImap system\fR
3236 Note that the setuid bit is \fBnever\fR set via
3237 inheritance (the code explicitly prohibits this).
3239 This can be particularly useful on large systems with
3240 many users, perhaps several thousand, to allow a single [homes]
3241 share to be used flexibly by each user.
3243 See also \fIcreate mask
3244 \fR, \fI directory mask\fR, \fIforce create mode\fR and \fIforce directory mode\fR
3247 Default: \fBinherit permissions = no\fR
3249 \fBinterfaces (G)\fR
3250 This option allows you to override the default
3251 network interfaces list that Samba will use for browsing, name
3252 registration and other NBT traffic. By default Samba will query
3253 the kernel for the list of all active interfaces and use any
3254 interfaces except 127.0.0.1 that are broadcast capable.
3256 The option takes a list of interface strings. Each string
3257 can be in any of the following forms:
3261 a network interface name (such as eth0).
3262 This may include shell-like wildcards so eth* will match
3263 any interface starting with the substring "eth"
3266 an IP address. In this case the netmask is
3267 determined from the list of interfaces obtained from the
3274 a broadcast/mask pair.
3277 The "mask" parameters can either be a bit length (such
3278 as 24 for a C class network) or a full netmask in dotted
3282 The "IP" parameters above can either be a full dotted
3283 decimal IP address or a hostname which will be looked up via
3284 the OS's normal hostname resolution mechanisms.
3287 For example, the following line:
3290 \fBinterfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0
3293 would configure three network interfaces corresponding
3294 to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10.
3295 The netmasks of the latter two interfaces would be set to 255.255.255.0.
3302 Default: \fBall active interfaces except 127.0.0.1
3303 that are broadcast capable\fR
3306 \fBinvalid users (S)\fR
3307 This is a list of users that should not be allowed
3308 to login to this service. This is really a \fBparanoid\fR
3309 check to absolutely ensure an improper setting does not breach
3312 A name starting with a '@' is interpreted as an NIS
3313 netgroup first (if your system supports NIS), and then as a UNIX
3314 group if the name was not found in the NIS netgroup database.
3316 A name starting with '+' is interpreted only
3317 by looking in the UNIX group database. A name starting with
3318 \&'&' is interpreted only by looking in the NIS netgroup database
3319 (this requires NIS to be working on your system). The characters
3320 \&'+' and '&' may be used at the start of the name in either order
3321 so the value \fI+&group\fR means check the
3322 UNIX group database, followed by the NIS netgroup database, and
3323 the value \fI&+group\fR means check the NIS
3324 netgroup database, followed by the UNIX group database (the
3325 same as the '@' prefix).
3327 The current servicename is substituted for \fI%S\fR.
3328 This is useful in the [homes] section.
3330 See also \fIvalid users
3333 Default: \fBno invalid users\fR
3335 Example: \fBinvalid users = root fred admin @wheel
3338 The value of the parameter (an integer) represents
3339 the number of seconds between \fIkeepalive\fR
3340 packets. If this parameter is zero, no keepalive packets will be
3341 sent. Keepalive packets, if sent, allow the server to tell whether
3342 a client is still present and responding.
3344 Keepalives should, in general, not be needed if the socket
3345 being used has the SO_KEEPALIVE attribute set on it (see \fIsocket options\fR).
3346 Basically you should only use this option if you strike difficulties.
3348 Default: \fBkeepalive = 300\fR
3350 Example: \fBkeepalive = 600\fR
3352 \fBkernel oplocks (G)\fR
3353 For UNIXes that support kernel based \fIoplocks\fR
3354 (currently only IRIX and the Linux 2.4 kernel), this parameter
3355 allows the use of them to be turned on or off.
3357 Kernel oplocks support allows Samba \fIoplocks
3358 \fRto be broken whenever a local UNIX process or NFS operation
3359 accesses a file that \fBsmbd(8)\fR
3360 has oplocked. This allows complete data consistency between
3361 SMB/CIFS, NFS and local file access (and is a \fBvery\fR
3364 This parameter defaults to on, but is translated
3365 to a no-op on systems that no not have the necessary kernel support.
3366 You should never need to touch this parameter.
3368 See also the \fIoplocks\fR
3369 and \fIlevel2 oplocks
3372 Default: \fBkernel oplocks = yes\fR
3374 \fBlanman auth (G)\fR
3375 This parameter determines whether or not smbdwill
3376 attempt to authenticate users using the LANMAN password hash.
3377 If disabled, only clients which support NT password hashes (e.g. Windows
3378 NT/2000 clients, smbclient, etc... but not Windows 95/98 or the MS DOS
3379 network client) will be able to connect to the Samba host.
3381 Default : \fBlanman auth = yes\fR
3383 \fBlarge readwrite (G)\fR
3384 This parameter determines whether or not smbd
3385 supports the new 64k streaming read and write varient SMB requests introduced
3386 with Windows 2000. Note that due to Windows 2000 client redirector bugs
3387 this requires Samba to be running on a 64-bit capable operating system such
3388 as IRIX, Solaris or a Linux 2.4 kernel. Can improve performance by 10% with
3389 Windows 2000 clients. Defaults to off. Not as tested as some other Samba
3392 Default : \fBlarge readwrite = no\fR
3394 \fBldap admin dn (G)\fR
3395 This parameter is only available if Samba has been
3396 configure to include the \fB--with-ldapsam\fR option
3397 at compile time. This option should be considered experimental and
3398 under active development.
3400 The \fIldap admin dn\fR defines the Distinguished
3401 Name (DN) name used by Samba to contact the ldap
3402 server when retreiving user account information. The \fIldap
3403 admin dn\fR is used in conjunction with the admin dn password
3404 stored in the \fIprivate/secrets.tdb\fR file. See the
3405 \fBsmbpasswd(8)\fRman
3406 page for more information on how to accmplish this.
3408 Default : \fBnone\fR
3410 \fBldap filter (G)\fR
3411 This parameter is only available if Samba has been
3412 configure to include the \fB--with-ldapsam\fR option
3413 at compile time. This option should be considered experimental and
3414 under active development.
3416 This parameter specifies the RFC 2254 compliant LDAP search filter.
3417 The default is to match the login name with the uid
3418 attribute for all entries matching the sambaAccount
3419 objectclass. Note that this filter should only return one entry.
3421 Default : \fBldap filter = (&(uid=%u)(objectclass=sambaAccount))\fR
3424 This parameter is only available if Samba has been
3425 configure to include the \fB--with-ldapsam\fR option
3426 at compile time. This option should be considered experimental and
3427 under active development.
3429 This option is used to control the tcp port number used to contact
3430 the \fIldap server\fR.
3431 The default is to use the stand LDAP port 389.
3433 Default : \fBldap port = 389\fR
3435 \fBldap server (G)\fR
3436 This parameter is only available if Samba has been
3437 configure to include the \fB--with-ldapsam\fR option
3438 at compile time. This option should be considered experimental and
3439 under active development.
3441 This parameter should contains the FQDN of the ldap directory
3442 server which should be queried to locate user account information.
3444 Default : \fBldap server = localhost\fR
3447 This parameter is only available if Samba has been
3448 configure to include the \fB--with-ldapsam\fR option
3449 at compile time. This option should be considered experimental and
3450 under active development.
3452 This option is used to define whether or not Samba should
3453 use SSL when connecting to the \fIldap
3454 server\fR. This is \fBNOT\fR related to
3455 Samba SSL support which is enabled by specifying the
3456 \fB--with-ssl\fR option to the \fIconfigure\fR
3457 script (see \fIssl\fR).
3459 The \fIldap ssl\fR can be set to one of three values:
3460 (a) \fBon\fR - Always use SSL when contacting the
3461 \fIldap server\fR, (b) \fBoff\fR -
3462 Never use SSL when querying the directory, or (c) \fBstart
3463 tls\fR - Use the LDAPv3 StartTLS extended operation
3464 (RFC2830) for communicating with the directory server.
3466 Default : \fBldap ssl = off\fR
3468 \fBldap suffix (G)\fR
3469 This parameter is only available if Samba has been
3470 configure to include the \fB--with-ldapsam\fR option
3471 at compile time. This option should be considered experimental and
3472 under active development.
3474 Default : \fBnone\fR
3476 \fBlevel2 oplocks (S)\fR
3477 This parameter controls whether Samba supports
3478 level2 (read-only) oplocks on a share.
3480 Level2, or read-only oplocks allow Windows NT clients
3481 that have an oplock on a file to downgrade from a read-write oplock
3482 to a read-only oplock once a second client opens the file (instead
3483 of releasing all oplocks on a second open, as in traditional,
3484 exclusive oplocks). This allows all openers of the file that
3485 support level2 oplocks to cache the file for read-ahead only (ie.
3486 they may not cache writes or lock requests) and increases performance
3487 for many accesses of files that are not commonly written (such as
3488 application .EXE files).
3490 Once one of the clients which have a read-only oplock
3491 writes to the file all clients are notified (no reply is needed
3492 or waited for) and told to break their oplocks to "none" and
3493 delete any read-ahead caches.
3495 It is recommended that this parameter be turned on
3496 to speed access to shared executables.
3498 For more discussions on level2 oplocks see the CIFS spec.
3500 Currently, if \fIkernel
3501 oplocks\fR are supported then level2 oplocks are
3502 not granted (even if this parameter is set to yes).
3503 Note also, the \fIoplocks\fR
3504 parameter must be set to true on this share in order for
3505 this parameter to have any effect.
3507 See also the \fIoplocks\fR
3508 and \fIkernel oplocks\fR
3511 Default: \fBlevel2 oplocks = yes\fR
3513 \fBlm announce (G)\fR
3514 This parameter determines if \fBnmbd(8)\fRwill produce Lanman announce
3515 broadcasts that are needed by OS/2 clients in order for them to see
3516 the Samba server in their browse list. This parameter can have three
3517 values, true, false, or
3518 auto. The default is auto.
3519 If set to false Samba will never produce these
3520 broadcasts. If set to true Samba will produce
3521 Lanman announce broadcasts at a frequency set by the parameter
3522 \fIlm interval\fR. If set to auto
3523 Samba will not send Lanman announce broadcasts by default but will
3524 listen for them. If it hears such a broadcast on the wire it will
3525 then start sending them at a frequency set by the parameter
3528 See also \fIlm interval
3531 Default: \fBlm announce = auto\fR
3533 Example: \fBlm announce = yes\fR
3535 \fBlm interval (G)\fR
3536 If Samba is set to produce Lanman announce
3537 broadcasts needed by OS/2 clients (see the \fIlm announce\fR parameter) then this
3538 parameter defines the frequency in seconds with which they will be
3539 made. If this is set to zero then no Lanman announcements will be
3540 made despite the setting of the \fIlm announce\fR
3546 Default: \fBlm interval = 60\fR
3548 Example: \fBlm interval = 120\fR
3550 \fBload printers (G)\fR
3551 A boolean variable that controls whether all
3552 printers in the printcap will be loaded for browsing by default.
3553 See the printers section for
3556 Default: \fBload printers = yes\fR
3558 \fBlocal master (G)\fR
3559 This option allows \fB nmbd(8)\fRto try and become a local master browser
3560 on a subnet. If set to false then \fB nmbd\fR will not attempt to become a local master browser
3561 on a subnet and will also lose in all browsing elections. By
3562 default this value is set to true. Setting this value to true doesn't
3563 mean that Samba will \fBbecome\fR the local master
3564 browser on a subnet, just that \fBnmbd\fR will \fB participate\fR in elections for local master browser.
3566 Setting this value to false will cause \fBnmbd\fR
3567 \fBnever\fR to become a local master browser.
3569 Default: \fBlocal master = yes\fR
3572 Synonym for \fI lock directory\fR.
3574 \fBlock directory (G)\fR
3575 This option specifies the directory where lock
3576 files will be placed. The lock files are used to implement the
3577 \fImax connections\fR
3580 Default: \fBlock directory = ${prefix}/var/locks\fR
3582 Example: \fBlock directory = /var/run/samba/locks\fR
3585 This controls whether or not locking will be
3586 performed by the server in response to lock requests from the
3589 If \fBlocking = no\fR, all lock and unlock
3590 requests will appear to succeed and all lock queries will report
3591 that the file in question is available for locking.
3593 If \fBlocking = yes\fR, real locking will be performed
3596 This option \fBmay\fR be useful for read-only
3597 filesystems which \fBmay\fR not need locking (such as
3598 CDROM drives), although setting this parameter of no
3599 is not really recommended even in this case.
3601 Be careful about disabling locking either globally or in a
3602 specific service, as lack of locking may result in data corruption.
3603 You should never need to set this parameter.
3605 Default: \fBlocking = yes\fR
3608 This option allows you to override the name
3609 of the Samba log file (also known as the debug file).
3611 This option takes the standard substitutions, allowing
3612 you to have separate log files for each user or machine.
3614 Example: \fBlog file = /usr/local/samba/var/log.%m
3617 The value of the parameter (an integer) allows
3618 the debug level (logging level) to be specified in the
3619 \fIsmb.conf\fR file. This is to give greater
3620 flexibility in the configuration of the system.
3622 The default will be the log level specified on
3623 the command line or level zero if none was specified.
3625 Example: \fBlog level = 3\fR
3627 \fBlogon drive (G)\fR
3628 This parameter specifies the local path to
3629 which the home directory will be connected (see \fIlogon home\fR)
3630 and is only used by NT Workstations.
3632 Note that this option is only useful if Samba is set up as a
3635 Default: \fBlogon drive = z:\fR
3637 Example: \fBlogon drive = h:\fR
3639 \fBlogon home (G)\fR
3640 This parameter specifies the home directory
3641 location when a Win95/98 or NT Workstation logs into a Samba PDC.
3644 C:\\> \fBNET USE H: /HOME\fR
3646 from a command prompt, for example.
3648 This option takes the standard substitutions, allowing
3649 you to have separate logon scripts for each user or machine.
3651 This parameter can be used with Win9X workstations to ensure
3652 that roaming profiles are stored in a subdirectory of the user's
3653 home directory. This is done in the following way:
3655 \fBlogon home = \\\\%N\\%U\\profile\fR
3657 This tells Samba to return the above string, with
3658 substitutions made when a client requests the info, generally
3659 in a NetUserGetInfo request. Win9X clients truncate the info to
3660 \\\\server\\share when a user does \fBnet use /home\fR
3661 but use the whole string when dealing with profiles.
3663 Note that in prior versions of Samba, the \fIlogon path\fR was returned rather than
3664 \fIlogon home\fR. This broke \fBnet use
3665 /home\fR but allowed profiles outside the home directory.
3666 The current implementation is correct, and can be used for
3667 profiles if you use the above trick.
3669 This option is only useful if Samba is set up as a logon
3672 Default: \fBlogon home = "\\\\%N\\%U"\fR
3674 Example: \fBlogon home = "\\\\remote_smb_server\\%U"\fR
3676 \fBlogon path (G)\fR
3677 This parameter specifies the home directory
3678 where roaming profiles (NTuser.dat etc files for Windows NT) are
3679 stored. Contrary to previous versions of these manual pages, it has
3680 nothing to do with Win 9X roaming profiles. To find out how to
3681 handle roaming profiles for Win 9X system, see the \fIlogon home\fR parameter.
3683 This option takes the standard substitutions, allowing you
3684 to have separate logon scripts for each user or machine. It also
3685 specifies the directory from which the "Application Data",
3686 (\fIdesktop\fR, \fIstart menu\fR,
3687 \fInetwork neighborhood\fR, \fIprograms\fR
3688 and other folders, and their contents, are loaded and displayed on
3689 your Windows NT client.
3691 The share and the path must be readable by the user for
3692 the preferences and directories to be loaded onto the Windows NT
3693 client. The share must be writeable when the user logs in for the first
3694 time, in order that the Windows NT client can create the NTuser.dat
3695 and other directories.
3697 Thereafter, the directories and any of the contents can,
3698 if required, be made read-only. It is not advisable that the
3699 NTuser.dat file be made read-only - rename it to NTuser.man to
3700 achieve the desired effect (a \fBMAN\fRdatory
3703 Windows clients can sometimes maintain a connection to
3704 the [homes] share, even though there is no user logged in.
3705 Therefore, it is vital that the logon path does not include a
3706 reference to the homes share (i.e. setting this parameter to
3707 \\%N\\%U\\profile_path will cause problems).
3709 This option takes the standard substitutions, allowing
3710 you to have separate logon scripts for each user or machine.
3712 Note that this option is only useful if Samba is set up
3715 Default: \fBlogon path = \\\\%N\\%U\\profile\fR
3717 Example: \fBlogon path = \\\\PROFILESERVER\\PROFILE\\%U\fR
3719 \fBlogon script (G)\fR
3720 This parameter specifies the batch file (.bat) or
3721 NT command file (.cmd) to be downloaded and run on a machine when
3722 a user successfully logs in. The file must contain the DOS
3723 style CR/LF line endings. Using a DOS-style editor to create the
3724 file is recommended.
3726 The script must be a relative path to the [netlogon]
3727 service. If the [netlogon] service specifies a \fIpath\fR of \fI/usr/local/samba/netlogon
3728 \fR, and \fBlogon script = STARTUP.BAT\fR, then
3729 the file that will be downloaded is:
3731 \fI/usr/local/samba/netlogon/STARTUP.BAT\fR
3733 The contents of the batch file are entirely your choice. A
3734 suggested command would be to add \fBNET TIME \\\\SERVER /SET
3735 /YES\fR, to force every machine to synchronize clocks with
3736 the same time server. Another use would be to add \fBNET USE
3737 U: \\\\SERVER\\UTILS\fR for commonly used utilities, or \fB NET USE Q: \\\\SERVER\\ISO9001_QA\fR for example.
3739 Note that it is particularly important not to allow write
3740 access to the [netlogon] share, or to grant users write permission
3741 on the batch files in a secure environment, as this would allow
3742 the batch files to be arbitrarily modified and security to be
3745 This option takes the standard substitutions, allowing you
3746 to have separate logon scripts for each user or machine.
3748 This option is only useful if Samba is set up as a logon
3751 Default: \fBno logon script defined\fR
3753 Example: \fBlogon script = scripts\\%U.bat\fR
3755 \fBlppause command (S)\fR
3756 This parameter specifies the command to be
3757 executed on the server host in order to stop printing or spooling
3758 a specific print job.
3760 This command should be a program or script which takes
3761 a printer name and job number to pause the print job. One way
3762 of implementing this is by using job priorities, where jobs
3763 having a too low priority won't be sent to the printer.
3765 If a \fI%p\fR is given then the printer name
3766 is put in its place. A \fI%j\fR is replaced with
3767 the job number (an integer). On HPUX (see \fIprinting=hpux
3768 \fR), if the \fI-p%p\fR option is added
3769 to the lpq command, the job will show up with the correct status, i.e.
3770 if the job priority is lower than the set fence priority it will
3771 have the PAUSED status, whereas if the priority is equal or higher it
3772 will have the SPOOLED or PRINTING status.
3774 Note that it is good practice to include the absolute path
3775 in the lppause command as the PATH may not be available to the server.
3777 See also the \fIprinting
3780 Default: Currently no default value is given to
3781 this string, unless the value of the \fIprinting\fR
3782 parameter is SYSV, in which case the default is :
3784 \fBlp -i %p-%j -H hold\fR
3786 or if the value of the \fIprinting\fR parameter
3787 is SOFTQ, then the default is:
3789 \fBqstat -s -j%j -h\fR
3791 Example for HPUX: \fBlppause command = /usr/bin/lpalt
3794 \fBlpq cache time (G)\fR
3795 This controls how long lpq info will be cached
3796 for to prevent the \fBlpq\fR command being called too
3797 often. A separate cache is kept for each variation of the \fB lpq\fR command used by the system, so if you use different
3798 \fBlpq\fR commands for different users then they won't
3799 share cache information.
3801 The cache files are stored in \fI/tmp/lpq.xxxx\fR
3802 where xxxx is a hash of the \fBlpq\fR command in use.
3804 The default is 10 seconds, meaning that the cached results
3805 of a previous identical \fBlpq\fR command will be used
3806 if the cached data is less than 10 seconds old. A large value may
3807 be advisable if your \fBlpq\fR command is very slow.
3809 A value of 0 will disable caching completely.
3811 See also the \fIprinting
3814 Default: \fBlpq cache time = 10\fR
3816 Example: \fBlpq cache time = 30\fR
3818 \fBlpq command (S)\fR
3819 This parameter specifies the command to be
3820 executed on the server host in order to obtain \fBlpq
3821 \fR-style printer status information.
3823 This command should be a program or script which
3824 takes a printer name as its only parameter and outputs printer
3827 Currently eight styles of printer status information
3828 are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX and SOFTQ.
3829 This covers most UNIX systems. You control which type is expected
3830 using the \fIprinting =\fR option.
3832 Some clients (notably Windows for Workgroups) may not
3833 correctly send the connection number for the printer they are
3834 requesting status information about. To get around this, the
3835 server reports on the first printer service connected to by the
3836 client. This only happens if the connection number sent is invalid.
3838 If a \fI%p\fR is given then the printer name
3839 is put in its place. Otherwise it is placed at the end of the
3842 Note that it is good practice to include the absolute path
3843 in the \fIlpq command\fR as the \fB$PATH
3844 \fRmay not be available to the server.
3846 See also the \fIprinting
3849 Default: \fBdepends on the setting of \fI printing\fB\fR
3851 Example: \fBlpq command = /usr/bin/lpq -P%p\fR
3853 \fBlpresume command (S)\fR
3854 This parameter specifies the command to be
3855 executed on the server host in order to restart or continue
3856 printing or spooling a specific print job.
3858 This command should be a program or script which takes
3859 a printer name and job number to resume the print job. See
3860 also the \fIlppause command
3863 If a \fI%p\fR is given then the printer name
3864 is put in its place. A \fI%j\fR is replaced with
3865 the job number (an integer).
3867 Note that it is good practice to include the absolute path
3868 in the \fIlpresume command\fR as the PATH may not
3869 be available to the server.
3871 See also the \fIprinting
3874 Default: Currently no default value is given
3875 to this string, unless the value of the \fIprinting\fR
3876 parameter is SYSV, in which case the default is :
3878 \fBlp -i %p-%j -H resume\fR
3880 or if the value of the \fIprinting\fR parameter
3881 is SOFTQ, then the default is:
3883 \fBqstat -s -j%j -r\fR
3885 Example for HPUX: \fBlpresume command = /usr/bin/lpalt
3888 \fBlprm command (S)\fR
3889 This parameter specifies the command to be
3890 executed on the server host in order to delete a print job.
3892 This command should be a program or script which takes
3893 a printer name and job number, and deletes the print job.
3895 If a \fI%p\fR is given then the printer name
3896 is put in its place. A \fI%j\fR is replaced with
3897 the job number (an integer).
3899 Note that it is good practice to include the absolute
3900 path in the \fIlprm command\fR as the PATH may not be
3901 available to the server.
3903 See also the \fIprinting
3906 Default: \fBdepends on the setting of \fIprinting
3908 Example 1: \fBlprm command = /usr/bin/lprm -P%p %j
3910 Example 2: \fBlprm command = /usr/bin/cancel %p-%j
3912 \fBmachine password timeout (G)\fR
3913 If a Samba server is a member of a Windows
3914 NT Domain (see the security = domain)
3915 parameter) then periodically a running smbd(8)process will try and change the MACHINE ACCOUNT
3916 PASSWORD stored in the TDB called \fIprivate/secrets.tdb
3917 \fR\&. This parameter specifies how often this password
3918 will be changed, in seconds. The default is one week (expressed in
3919 seconds), the same as a Windows NT Domain member server.
3921 See also \fBsmbpasswd(8)
3922 \fR, and the security = domain) parameter.
3924 Default: \fBmachine password timeout = 604800\fR
3926 \fBmagic output (S)\fR
3927 This parameter specifies the name of a file
3928 which will contain output created by a magic script (see the
3932 Warning: If two clients use the same \fImagic script
3933 \fRin the same directory the output file content
3936 Default: \fBmagic output = <magic script name>.out
3938 Example: \fBmagic output = myfile.txt\fR
3940 \fBmagic script (S)\fR
3941 This parameter specifies the name of a file which,
3942 if opened, will be executed by the server when the file is closed.
3943 This allows a UNIX script to be sent to the Samba host and
3944 executed on behalf of the connected user.
3946 Scripts executed in this way will be deleted upon
3947 completion assuming that the user has the appropriate level
3948 of privilege and the file permissions allow the deletion.
3950 If the script generates output, output will be sent to
3951 the file specified by the \fI magic output\fR parameter (see above).
3953 Note that some shells are unable to interpret scripts
3954 containing CR/LF instead of CR as
3955 the end-of-line marker. Magic scripts must be executable
3956 \fBas is\fR on the host, which for some hosts and
3957 some shells will require filtering at the DOS end.
3959 Magic scripts are \fBEXPERIMENTAL\fR and
3960 should \fBNOT\fR be relied upon.
3962 Default: \fBNone. Magic scripts disabled.\fR
3964 Example: \fBmagic script = user.csh\fR
3966 \fBmangle case (S)\fR
3967 See the section on NAME MANGLING
3969 Default: \fBmangle case = no\fR
3971 \fBmangled map (S)\fR
3972 This is for those who want to directly map UNIX
3973 file names which cannot be represented on Windows/DOS. The mangling
3974 of names is not always what is needed. In particular you may have
3975 documents with file extensions that differ between DOS and UNIX.
3976 For example, under UNIX it is common to use \fI.html\fR
3977 for HTML files, whereas under Windows/DOS \fI.htm\fR
3978 is more commonly used.
3980 So to map \fIhtml\fR to \fIhtm\fR
3983 \fBmangled map = (*.html *.htm)\fR
3985 One very useful case is to remove the annoying \fI;1
3986 \fRoff the ends of filenames on some CDROMs (only visible
3987 under some UNIXes). To do this use a map of (*;1 *;).
3989 Default: \fBno mangled map\fR
3991 Example: \fBmangled map = (*;1 *;)\fR
3993 \fBmangled names (S)\fR
3994 This controls whether non-DOS names under UNIX
3995 should be mapped to DOS-compatible names ("mangled") and made visible,
3996 or whether non-DOS names should simply be ignored.
3998 See the section on NAME MANGLING for details on how to control the mangling process.
4000 If mangling is used then the mangling algorithm is as follows:
4004 The first (up to) five alphanumeric characters
4005 before the rightmost dot of the filename are preserved, forced
4006 to upper case, and appear as the first (up to) five characters
4007 of the mangled name.
4010 A tilde "~" is appended to the first part of the mangled
4011 name, followed by a two-character unique sequence, based on the
4012 original root name (i.e., the original filename minus its final
4013 extension). The final extension is included in the hash calculation
4014 only if it contains any upper case characters or is longer than three
4017 Note that the character to use may be specified using
4018 the \fImangling char\fR
4019 option, if you don't like '~'.
4022 The first three alphanumeric characters of the final
4023 extension are preserved, forced to upper case and appear as the
4024 extension of the mangled name. The final extension is defined as that
4025 part of the original filename after the rightmost dot. If there are no
4026 dots in the filename, the mangled name will have no extension (except
4027 in the case of "hidden files" - see below).
4030 Files whose UNIX name begins with a dot will be
4031 presented as DOS hidden files. The mangled name will be created as
4032 for other filenames, but with the leading dot removed and "___" as
4033 its extension regardless of actual original extension (that's three
4037 The two-digit hash value consists of upper case
4038 alphanumeric characters.
4041 This algorithm can cause name collisions only if files
4042 in a directory share the same first five alphanumeric characters.
4043 The probability of such a clash is 1/1300.
4046 The name mangling (if enabled) allows a file to be
4047 copied between UNIX directories from Windows/DOS while retaining
4048 the long UNIX filename. UNIX files can be renamed to a new extension
4049 from Windows/DOS and will retain the same basename. Mangled names
4050 do not change between sessions.
4053 Default: \fBmangled names = yes\fR
4056 \fBmangled stack (G)\fR
4057 This parameter controls the number of mangled names
4058 that should be cached in the Samba server smbd(8).
4060 This stack is a list of recently mangled base names
4061 (extensions are only maintained if they are longer than 3 characters
4062 or contains upper case characters).
4064 The larger this value, the more likely it is that mangled
4065 names can be successfully converted to correct long UNIX names.
4066 However, large stack sizes will slow most directory accesses. Smaller
4067 stacks save memory in the server (each stack element costs 256 bytes).
4069 It is not possible to absolutely guarantee correct long
4070 filenames, so be prepared for some surprises!
4072 Default: \fBmangled stack = 50\fR
4074 Example: \fBmangled stack = 100\fR
4076 \fBmangling char (S)\fR
4077 This controls what character is used as
4078 the \fBmagic\fR character in name mangling. The default is a '~'
4079 but this may interfere with some software. Use this option to set
4080 it to whatever you prefer.
4082 Default: \fBmangling char = ~\fR
4084 Example: \fBmangling char = ^\fR
4086 \fBmap archive (S)\fR
4087 This controls whether the DOS archive attribute
4088 should be mapped to the UNIX owner execute bit. The DOS archive bit
4089 is set when a file has been modified since its last backup. One
4090 motivation for this option it to keep Samba/your PC from making
4091 any file it touches from becoming executable under UNIX. This can
4092 be quite annoying for shared source code, documents, etc...
4094 Note that this requires the \fIcreate mask\fR
4095 parameter to be set such that owner execute bit is not masked out
4096 (i.e. it must include 100). See the parameter \fIcreate mask\fR for details.
4098 Default: \fBmap archive = yes\fR
4100 \fBmap hidden (S)\fR
4101 This controls whether DOS style hidden files
4102 should be mapped to the UNIX world execute bit.
4104 Note that this requires the \fIcreate mask\fR
4105 to be set such that the world execute bit is not masked out (i.e.
4106 it must include 001). See the parameter \fIcreate mask\fR for details.
4108 Default: \fBmap hidden = no\fR
4110 \fBmap system (S)\fR
4111 This controls whether DOS style system files
4112 should be mapped to the UNIX group execute bit.
4114 Note that this requires the \fIcreate mask\fR
4115 to be set such that the group execute bit is not masked out (i.e.
4116 it must include 010). See the parameter \fIcreate mask\fR for details.
4118 Default: \fBmap system = no\fR
4120 \fBmap to guest (G)\fR
4121 This parameter is only useful in security modes other than \fIsecurity = share\fR
4122 - i.e. user, server,
4125 This parameter can take three different values, which tell
4126 smbd(8)what to do with user
4127 login requests that don't match a valid UNIX user in some way.
4129 The three settings are :
4133 Never - Means user login
4134 requests with an invalid password are rejected. This is the
4138 Bad User - Means user
4139 logins with an invalid password are rejected, unless the username
4140 does not exist, in which case it is treated as a guest login and
4141 mapped into the \fI guest account\fR.
4144 Bad Password - Means user logins
4145 with an invalid password are treated as a guest login and mapped
4146 into the guest account. Note that
4147 this can cause problems as it means that any user incorrectly typing
4148 their password will be silently logged on as "guest" - and
4149 will not know the reason they cannot access files they think
4150 they should - there will have been no message given to them
4151 that they got their password wrong. Helpdesk services will
4152 \fBhate\fR you if you set the \fImap to
4153 guest\fR parameter this way :-).
4156 Note that this parameter is needed to set up "Guest"
4157 share services when using \fIsecurity\fR modes other than
4158 share. This is because in these modes the name of the resource being
4159 requested is \fBnot\fR sent to the server until after
4160 the server has successfully authenticated the client so the server
4161 cannot make authentication decisions at the correct time (connection
4162 to the share) for "Guest" shares.
4165 For people familiar with the older Samba releases, this
4166 parameter maps to the old compile-time setting of the GUEST_SESSSETUP value in local.h.
4169 Default: \fBmap to guest = Never\fR
4172 Example: \fBmap to guest = Bad User\fR
4175 \fBmax connections (S)\fR
4176 This option allows the number of simultaneous
4177 connections to a service to be limited. If \fImax connections
4178 \fRis greater than 0 then connections will be refused if
4179 this number of connections to the service are already open. A value
4180 of zero mean an unlimited number of connections may be made.
4182 Record lock files are used to implement this feature. The
4183 lock files will be stored in the directory specified by the \fIlock directory\fR
4186 Default: \fBmax connections = 0\fR
4188 Example: \fBmax connections = 10\fR
4190 \fBmax disk size (G)\fR
4191 This option allows you to put an upper limit
4192 on the apparent size of disks. If you set this option to 100
4193 then all shares will appear to be not larger than 100 MB in
4196 Note that this option does not limit the amount of
4197 data you can put on the disk. In the above case you could still
4198 store much more than 100 MB on the disk, but if a client ever asks
4199 for the amount of free disk space or the total disk size then the
4200 result will be bounded by the amount specified in \fImax
4203 This option is primarily useful to work around bugs
4204 in some pieces of software that can't handle very large disks,
4205 particularly disks over 1GB in size.
4207 A \fImax disk size\fR of 0 means no limit.
4209 Default: \fBmax disk size = 0\fR
4211 Example: \fBmax disk size = 1000\fR
4213 \fBmax log size (G)\fR
4214 This option (an integer in kilobytes) specifies
4215 the max size the log file should grow to. Samba periodically checks
4216 the size and if it is exceeded it will rename the file, adding
4217 a \fI.old\fR extension.
4219 A size of 0 means no limit.
4221 Default: \fBmax log size = 5000\fR
4223 Example: \fBmax log size = 1000\fR
4226 This option controls the maximum number of
4227 outstanding simultaneous SMB operations that Samba tells the client
4228 it will allow. You should never need to set this parameter.
4230 Default: \fBmax mux = 50\fR
4232 \fBmax open files (G)\fR
4233 This parameter limits the maximum number of
4234 open files that one smbd(8)file
4235 serving process may have open for a client at any one time. The
4236 default for this parameter is set very high (10,000) as Samba uses
4237 only one bit per unopened file.
4239 The limit of the number of open files is usually set
4240 by the UNIX per-process file descriptor limit rather than
4241 this parameter so you should never need to touch this parameter.
4243 Default: \fBmax open files = 10000\fR
4245 \fBmax print jobs (S)\fR
4246 This parameter limits the maximum number of
4247 jobs allowable in a Samba printer queue at any given moment.
4248 If this number is exceeded, \fB smbd(8)\fRwill remote "Out of Space" to the client.
4252 Default: \fBmax print jobs = 1000\fR
4254 Example: \fBmax print jobs = 5000\fR
4256 \fBmax protocol (G)\fR
4257 The value of the parameter (a string) is the highest
4258 protocol level that will be supported by the server.
4260 Possible values are :
4264 CORE: Earliest version. No
4265 concept of user names.
4268 COREPLUS: Slight improvements on
4269 CORE for efficiency.
4272 LANMAN1: First \fB modern\fR version of the protocol. Long filename
4276 LANMAN2: Updates to Lanman1 protocol.
4279 NT1: Current up to date version of
4280 the protocol. Used by Windows NT. Known as CIFS.
4283 Normally this option should not be set as the automatic
4284 negotiation phase in the SMB protocol takes care of choosing
4285 the appropriate protocol.
4292 Default: \fBmax protocol = NT1\fR
4295 Example: \fBmax protocol = LANMAN1\fR
4298 \fBmax smbd processes (G)\fR
4299 This parameter limits the maximum number of
4301 processes concurrently running on a system and is intended
4302 as a stopgap to prevent degrading service to clients in the event
4303 that the server has insufficient resources to handle more than this
4304 number of connections. Remember that under normal operating
4305 conditions, each user will have an smbdassociated with him or her
4306 to handle connections to all shares from a given host.
4308 Default: \fBmax smbd processes = 0\fR ## no limit
4310 Example: \fBmax smbd processes = 1000\fR
4313 This option tells nmbd(8)
4314 what the default 'time to live' of NetBIOS names should be (in seconds)
4315 when \fBnmbd\fR is requesting a name using either a
4316 broadcast packet or from a WINS server. You should never need to
4317 change this parameter. The default is 3 days.
4319 Default: \fBmax ttl = 259200\fR
4321 \fBmax wins ttl (G)\fR
4322 This option tells nmbd(8)
4323 when acting as a WINS server ( \fIwins support = yes\fR) what the maximum
4324 \&'time to live' of NetBIOS names that \fBnmbd\fR
4325 will grant will be (in seconds). You should never need to change this
4326 parameter. The default is 6 days (518400 seconds).
4329 wins ttl\fR parameter.
4331 Default: \fBmax wins ttl = 518400\fR
4334 This option controls the maximum packet size
4335 that will be negotiated by Samba. The default is 65535, which
4336 is the maximum. In some cases you may find you get better performance
4337 with a smaller value. A value below 2048 is likely to cause problems.
4339 Default: \fBmax xmit = 65535\fR
4341 Example: \fBmax xmit = 8192\fR
4343 \fBmessage command (G)\fR
4344 This specifies what command to run when the
4345 server receives a WinPopup style message.
4347 This would normally be a command that would
4348 deliver the message somehow. How this is to be done is
4349 up to your imagination.
4353 \fBmessage command = csh -c 'xedit %s;rm %s' &\fR
4355 This delivers the message using \fBxedit\fR, then
4356 removes it afterwards. \fBNOTE THAT IT IS VERY IMPORTANT
4357 THAT THIS COMMAND RETURN IMMEDIATELY\fR. That's why I
4358 have the '&' on the end. If it doesn't return immediately then
4359 your PCs may freeze when sending messages (they should recover
4360 after 30 seconds, hopefully).
4362 All messages are delivered as the global guest user.
4363 The command takes the standard substitutions, although \fI %u\fR won't work (\fI%U\fR may be better
4366 Apart from the standard substitutions, some additional
4367 ones apply. In particular:
4371 \fI%s\fR = the filename containing
4375 \fI%t\fR = the destination that
4376 the message was sent to (probably the server name).
4379 \fI%f\fR = who the message
4383 You could make this command send mail, or whatever else
4384 takes your fancy. Please let us know of any really interesting
4388 Here's a way of sending the messages as mail to root:
4391 \fBmessage command = /bin/mail -s 'message from %f on
4392 %m' root < %s; rm %s\fR
4395 If you don't have a message command then the message
4396 won't be delivered and Samba will tell the sender there was
4397 an error. Unfortunately WfWg totally ignores the error code
4398 and carries on regardless, saying that the message was delivered.
4401 If you want to silently delete it then try:
4404 \fBmessage command = rm %s\fR
4407 Default: \fBno message command\fR
4410 Example: \fBmessage command = csh -c 'xedit %s;
4414 \fBmin passwd length (G)\fR
4415 Synonym for \fImin password length\fR.
4417 \fBmin password length (G)\fR
4418 This option sets the minimum length in characters
4419 of a plaintext password that \fBsmbd\fR will accept when performing
4420 UNIX password changing.
4423 password sync\fR, \fIpasswd program\fR and \fIpasswd chat debug\fR
4426 Default: \fBmin password length = 5\fR
4428 \fBmin print space (S)\fR
4429 This sets the minimum amount of free disk
4430 space that must be available before a user will be able to spool
4431 a print job. It is specified in kilobytes. The default is 0, which
4432 means a user can always spool a print job.
4434 See also the \fIprinting
4437 Default: \fBmin print space = 0\fR
4439 Example: \fBmin print space = 2000\fR
4441 \fBmin protocol (G)\fR
4442 The value of the parameter (a string) is the
4443 lowest SMB protocol dialect than Samba will support. Please refer
4444 to the \fImax protocol\fR
4445 parameter for a list of valid protocol names and a brief description
4446 of each. You may also wish to refer to the C source code in
4447 \fIsource/smbd/negprot.c\fR for a listing of known protocol
4448 dialects supported by clients.
4450 If you are viewing this parameter as a security measure, you should
4451 also refer to the \fIlanman
4452 auth\fR parameter. Otherwise, you should never need
4453 to change this parameter.
4455 Default : \fBmin protocol = CORE\fR
4457 Example : \fBmin protocol = NT1\fR # disable DOS
4460 \fBmin wins ttl (G)\fR
4461 This option tells nmbd(8)
4462 when acting as a WINS server (\fI wins support = yes\fR) what the minimum 'time to live'
4463 of NetBIOS names that \fBnmbd\fR will grant will be (in
4464 seconds). You should never need to change this parameter. The default
4465 is 6 hours (21600 seconds).
4467 Default: \fBmin wins ttl = 21600\fR
4469 \fBmsdfs root (S)\fR
4470 This boolean parameter is only available if
4471 Samba is configured and compiled with the \fB --with-msdfs\fR option. If set to yes,
4472 Samba treats the share as a Dfs root and allows clients to browse
4473 the distributed file system tree rooted at the share directory.
4474 Dfs links are specified in the share directory by symbolic
4475 links of the form \fImsdfs:serverA\\shareA,serverB\\shareB
4476 \fRand so on. For more information on setting up a Dfs tree
4477 on Samba, refer to msdfs_setup.html
4480 See also \fIhost msdfs
4482 Default: \fBmsdfs root = no\fR
4484 \fBname resolve order (G)\fR
4485 This option is used by the programs in the Samba
4486 suite to determine what naming services to use and in what order
4487 to resolve host names to IP addresses. The option takes a space
4488 separated string of name resolution options.
4490 The options are :"lmhosts", "host", "wins" and "bcast". They
4491 cause names to be resolved as follows :
4495 lmhosts : Lookup an IP
4496 address in the Samba lmhosts file. If the line in lmhosts has
4497 no name type attached to the NetBIOS name (see the lmhosts(5)for details) then
4498 any name type matches for lookup.
4501 host : Do a standard host
4502 name to IP address resolution, using the system \fI/etc/hosts
4503 \fR, NIS, or DNS lookups. This method of name resolution
4504 is operating system depended for instance on IRIX or Solaris this
4505 may be controlled by the \fI/etc/nsswitch.conf\fR
4506 file. Note that this method is only used if the NetBIOS name
4507 type being queried is the 0x20 (server) name type, otherwise
4511 wins : Query a name with
4512 the IP address listed in the \fI wins server\fR parameter. If no WINS server has
4513 been specified this method will be ignored.
4516 bcast : Do a broadcast on
4517 each of the known local interfaces listed in the \fIinterfaces\fR
4518 parameter. This is the least reliable of the name resolution
4519 methods as it depends on the target host being on a locally
4523 Default: \fBname resolve order = lmhosts host wins bcast
4526 Example: \fBname resolve order = lmhosts bcast host
4529 This will cause the local lmhosts file to be examined
4530 first, followed by a broadcast attempt, followed by a normal
4531 system hostname lookup.
4534 \fBnetbios aliases (G)\fR
4535 This is a list of NetBIOS names that nmbd(8)will advertise as additional
4536 names by which the Samba server is known. This allows one machine
4537 to appear in browse lists under multiple names. If a machine is
4538 acting as a browse server or logon server none
4539 of these names will be advertised as either browse server or logon
4540 servers, only the primary name of the machine will be advertised
4541 with these capabilities.
4546 Default: \fBempty string (no additional names)\fR
4548 Example: \fBnetbios aliases = TEST TEST1 TEST2\fR
4550 \fBnetbios name (G)\fR
4551 This sets the NetBIOS name by which a Samba
4552 server is known. By default it is the same as the first component
4553 of the host's DNS name. If a machine is a browse server or
4554 logon server this name (or the first component
4555 of the hosts DNS name) will be the name that these services are
4561 Default: \fBmachine DNS name\fR
4563 Example: \fBnetbios name = MYNAME\fR
4565 \fBnetbios scope (G)\fR
4566 This sets the NetBIOS scope that Samba will
4567 operate under. This should not be set unless every machine
4568 on your LAN also sets this value.
4570 \fBnis homedir (G)\fR
4571 Get the home share server from a NIS map. For
4572 UNIX systems that use an automounter, the user's home directory
4573 will often be mounted on a workstation on demand from a remote
4576 When the Samba logon server is not the actual home directory
4577 server, but is mounting the home directories via NFS then two
4578 network hops would be required to access the users home directory
4579 if the logon server told the client to use itself as the SMB server
4580 for home directories (one over SMB and one over NFS). This can
4583 This option allows Samba to return the home share as
4584 being on a different server to the logon server and as
4585 long as a Samba daemon is running on the home directory server,
4586 it will be mounted on the Samba client directly from the directory
4587 server. When Samba is returning the home share to the client, it
4588 will consult the NIS map specified in \fIhomedir map\fR and return the server
4591 Note that for this option to work there must be a working
4592 NIS system and the Samba server with this option must also
4595 Default: \fBnis homedir = no\fR
4597 \fBnt acl support (S)\fR
4598 This boolean parameter controls whether
4599 smbd(8)will attempt to map
4600 UNIX permissions into Windows NT access control lists.
4601 This parameter was formally a global parameter in releases
4604 Default: \fBnt acl support = yes\fR
4606 \fBnt pipe support (G)\fR
4607 This boolean parameter controls whether
4608 smbd(8)will allow Windows NT
4609 clients to connect to the NT SMB specific IPC$
4610 pipes. This is a developer debugging option and can be left
4613 Default: \fBnt pipe support = yes\fR
4615 \fBnt smb support (G)\fR
4616 This boolean parameter controls whether smbd(8)will negotiate NT specific SMB
4617 support with Windows NT clients. Although this is a developer
4618 debugging option and should be left alone, benchmarking has discovered
4619 that Windows NT clients give faster performance with this option
4620 set to no. This is still being investigated.
4621 If this option is set to no then Samba offers
4622 exactly the same SMB calls that versions prior to Samba 2.0 offered.
4623 This information may be of use if any users are having problems
4624 with NT SMB support.
4626 You should not need to ever disable this parameter.
4628 Default: \fBnt smb support = yes\fR
4630 \fBnull passwords (G)\fR
4631 Allow or disallow client access to accounts
4632 that have null passwords.
4634 See also smbpasswd (5).
4636 Default: \fBnull passwords = no\fR
4638 \fBobey pam restrictions (G)\fR
4639 When Samba 2.2 is configured to enable PAM support
4640 (i.e. --with-pam), this parameter will control whether or not Samba
4641 should obey PAM's account and session management directives. The
4642 default behavior is to use PAM for clear text authentication only
4643 and to ignore any account or session management. Note that Samba
4644 always ignores PAM for authentication in the case of \fIencrypt passwords = yes\fR
4645 \&. The reason is that PAM modules cannot support the challenge/response
4646 authentication mechanism needed in the presence of SMB password encryption.
4648 Default: \fBobey pam restrictions = no\fR
4651 This is a boolean option that controls whether
4652 connections with usernames not in the \fIuser\fR
4653 list will be allowed. By default this option is disabled so that a
4654 client can supply a username to be used by the server. Enabling
4655 this parameter will force the server to only user the login
4656 names from the \fIuser\fR list and is only really
4657 useful in shave level
4660 Note that this also means Samba won't try to deduce
4661 usernames from the service name. This can be annoying for
4662 the [homes] section. To get around this you could use \fBuser =
4663 %S\fR which means your \fIuser\fR list
4664 will be just the service name, which for home directories is the
4667 See also the \fIuser\fR
4670 Default: \fBonly user = no\fR
4672 \fBonly guest (S)\fR
4673 A synonym for \fI guest only\fR.
4675 \fBoplock break wait time (G)\fR
4676 This is a tuning parameter added due to bugs in
4677 both Windows 9x and WinNT. If Samba responds to a client too
4678 quickly when that client issues an SMB that can cause an oplock
4679 break request, then the network client can fail and not respond
4680 to the break request. This tuning parameter (which is set in milliseconds)
4681 is the amount of time Samba will wait before sending an oplock break
4682 request to such (broken) clients.
4684 \fBDO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
4685 AND UNDERSTOOD THE SAMBA OPLOCK CODE\fR.
4687 Default: \fBoplock break wait time = 0\fR
4689 \fBoplock contention limit (S)\fR
4690 This is a \fBvery\fR advanced
4691 smbd(8)tuning option to
4692 improve the efficiency of the granting of oplocks under multiple
4693 client contention for the same file.
4695 In brief it specifies a number, which causes smbdnot to
4696 grant an oplock even when requested if the approximate number of
4697 clients contending for an oplock on the same file goes over this
4698 limit. This causes \fBsmbd\fR to behave in a similar
4701 \fBDO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
4702 AND UNDERSTOOD THE SAMBA OPLOCK CODE\fR.
4704 Default: \fBoplock contention limit = 2\fR
4707 This boolean option tells \fBsmbd\fR whether to
4708 issue oplocks (opportunistic locks) to file open requests on this
4709 share. The oplock code can dramatically (approx. 30% or more) improve
4710 the speed of access to files on Samba servers. It allows the clients
4711 to aggressively cache files locally and you may want to disable this
4712 option for unreliable network environments (it is turned on by
4713 default in Windows NT Servers). For more information see the file
4714 \fISpeed.txt\fR in the Samba \fIdocs/\fR
4717 Oplocks may be selectively turned off on certain files with a
4718 share. See the \fI veto oplock files\fR parameter. On some systems
4719 oplocks are recognized by the underlying operating system. This
4720 allows data synchronization between all access to oplocked files,
4721 whether it be via Samba or NFS or a local UNIX process. See the
4722 \fIkernel oplocks\fR parameter for details.
4724 See also the \fIkernel
4725 oplocks\fR and \fI level2 oplocks\fR parameters.
4727 Default: \fBoplocks = yes\fR
4730 This integer value controls what level Samba
4731 advertises itself as for browse elections. The value of this
4732 parameter determines whether nmbd(8)
4733 has a chance of becoming a local master browser for the \fI WORKGROUP\fR in the local broadcast area.
4735 \fBNote :\fRBy default, Samba will win
4736 a local master browsing election over all Microsoft operating
4737 systems except a Windows NT 4.0/2000 Domain Controller. This
4738 means that a misconfigured Samba host can effectively isolate
4739 a subnet for browsing purposes. See \fIBROWSING.txt
4740 \fRin the Samba \fIdocs/\fR directory
4743 Default: \fBos level = 20\fR
4745 Example: \fBos level = 65 \fR
4747 \fBos2 driver map (G)\fR
4748 The parameter is used to define the absolute
4749 path to a file containing a mapping of Windows NT printer driver
4750 names to OS/2 printer driver names. The format is:
4752 <nt driver name> = <os2 driver
4755 For example, a valid entry using the HP LaserJet 5
4756 printer driver would appear as \fBHP LaserJet 5L = LASERJET.HP
4759 The need for the file is due to the printer driver namespace
4760 problem described in the Samba
4761 Printing HOWTO. For more details on OS/2 clients, please
4762 refer to the OS2-Client-HOWTO
4763 containing in the Samba documentation.
4765 Default: \fBos2 driver map = <empty string>
4767 \fBpam password change (G)\fR
4768 With the addition of better PAM support in Samba 2.2,
4769 this parameter, it is possible to use PAM's password change control
4770 flag for Samba. If enabled, then PAM will be used for password
4771 changes when requested by an SMB client instead of the program listed in
4772 \fIpasswd program\fR.
4773 It should be possible to enable this without changing your
4775 parameter for most setups.
4777 Default: \fBpam password change = no\fR
4779 \fBpanic action (G)\fR
4780 This is a Samba developer option that allows a
4781 system command to be called when either smbd(8)
4782 crashes. This is usually used to draw attention to the fact that
4785 Default: \fBpanic action = <empty string>\fR
4787 Example: \fBpanic action = "/bin/sleep 90000"\fR
4789 \fBpasswd chat (G)\fR
4790 This string controls the \fB"chat"\fR
4791 conversation that takes places between smbdand the local password changing
4792 program to change the user's password. The string describes a
4793 sequence of response-receive pairs that smbd(8)uses to determine what to send to the
4794 \fIpasswd program\fR
4795 and what to expect back. If the expected output is not
4796 received then the password is not changed.
4798 This chat sequence is often quite site specific, depending
4799 on what local methods are used for password control (such as NIS
4802 Note that this parameter only is only used if the \fIunix
4803 password sync\fR parameter is set to yes. This
4804 sequence is then called \fBAS ROOT\fR when the SMB password
4805 in the smbpasswd file is being changed, without access to the old
4806 password cleartext. This means that root must be able to reset the user's password
4807 without knowing the text of the previous password. In the presence of NIS/YP,
4808 this means that the passwd program must be
4809 executed on the NIS master.
4811 The string can contain the macro \fI%n\fR which is substituted
4812 for the new password. The chat sequence can also contain the standard
4813 macros \\n, \\r, \\t and \\s to give line-feed,
4814 carriage-return, tab and space. The chat sequence string can also contain
4815 a '*' which matches any sequence of characters.
4816 Double quotes can be used to collect strings with spaces
4817 in them into a single string.
4819 If the send string in any part of the chat sequence
4820 is a full stop ".", then no string is sent. Similarly,
4821 if the expect string is a full stop then no string is expected.
4824 password change\fR parameter is set to true, the chat pairs
4825 may be matched in any order, and success is determined by the PAM result,
4826 not any particular output. The \\n macro is ignored for PAM conversions.
4828 See also \fIunix password
4829 sync\fR, \fI passwd program\fR , \fIpasswd chat debug\fR and \fIpam password change\fR.
4831 Default: \fBpasswd chat = *new*password* %n\\n
4832 *new*password* %n\\n *changed*\fR
4834 Example: \fBpasswd chat = "*Enter OLD password*" %o\\n
4835 "*Enter NEW password*" %n\\n "*Reenter NEW password*" %n\\n "*Password
4838 \fBpasswd chat debug (G)\fR
4839 This boolean specifies if the passwd chat script
4840 parameter is run in \fBdebug\fR mode. In this mode the
4841 strings passed to and received from the passwd chat are printed
4842 in the smbd(8)log with a
4844 of 100. This is a dangerous option as it will allow plaintext passwords
4845 to be seen in the \fBsmbd\fR log. It is available to help
4846 Samba admins debug their \fIpasswd chat\fR scripts
4847 when calling the \fIpasswd program\fR and should
4848 be turned off after this has been done. This option has no effect if the
4849 \fIpam password change\fR
4850 paramter is set. This parameter is off by default.
4852 See also \fIpasswd chat\fR
4853 , \fIpam password change\fR
4854 , \fIpasswd program\fR
4857 Default: \fBpasswd chat debug = no\fR
4859 \fBpasswd program (G)\fR
4860 The name of a program that can be used to set
4861 UNIX user passwords. Any occurrences of \fI%u\fR
4862 will be replaced with the user name. The user name is checked for
4863 existence before calling the password changing program.
4865 Also note that many passwd programs insist in \fBreasonable
4866 \fRpasswords, such as a minimum length, or the inclusion
4867 of mixed case chars and digits. This can pose a problem as some clients
4868 (such as Windows for Workgroups) uppercase the password before sending
4871 \fBNote\fR that if the \fIunix
4872 password sync\fR parameter is set to true
4873 then this program is called \fBAS ROOT\fR
4874 before the SMB password in the smbpasswd(5)
4875 file is changed. If this UNIX password change fails, then
4876 \fBsmbd\fR will fail to change the SMB password also
4877 (this is by design).
4879 If the \fIunix password sync\fR parameter
4880 is set this parameter \fBMUST USE ABSOLUTE PATHS\fR
4881 for \fBALL\fR programs called, and must be examined
4882 for security implications. Note that by default \fIunix
4883 password sync\fR is set to false.
4888 Default: \fBpasswd program = /bin/passwd\fR
4890 Example: \fBpasswd program = /sbin/npasswd %u\fR
4892 \fBpassword level (G)\fR
4893 Some client/server combinations have difficulty
4894 with mixed-case passwords. One offending client is Windows for
4895 Workgroups, which for some reason forces passwords to upper
4896 case when using the LANMAN1 protocol, but leaves them alone when
4897 using COREPLUS! Another problem child is the Windows 95/98
4898 family of operating systems. These clients upper case clear
4899 text passwords even when NT LM 0.12 selected by the protocol
4900 negotiation request/response.
4902 This parameter defines the maximum number of characters
4903 that may be upper case in passwords.
4905 For example, say the password given was "FRED". If \fI password level\fR is set to 1, the following combinations
4906 would be tried if "FRED" failed:
4908 "Fred", "fred", "fRed", "frEd","freD"
4910 If \fIpassword level\fR was set to 2,
4911 the following combinations would also be tried:
4913 "FRed", "FrEd", "FreD", "fREd", "fReD", "frED", ..
4917 The higher value this parameter is set to the more likely
4918 it is that a mixed case password will be matched against a single
4919 case password. However, you should be aware that use of this
4920 parameter reduces security and increases the time taken to
4921 process a new connection.
4923 A value of zero will cause only two attempts to be
4924 made - the password as is and the password in all-lower case.
4926 Default: \fBpassword level = 0\fR
4928 Example: \fBpassword level = 4\fR
4930 \fBpassword server (G)\fR
4931 By specifying the name of another SMB server (such
4932 as a WinNT box) with this option, and using \fBsecurity = domain
4933 \fRor \fBsecurity = server\fR you can get Samba
4934 to do all its username/password validation via a remote server.
4936 This option sets the name of the password server to use.
4937 It must be a NetBIOS name, so if the machine's NetBIOS name is
4938 different from its Internet name then you may have to add its NetBIOS
4939 name to the lmhosts file which is stored in the same directory
4940 as the \fIsmb.conf\fR file.
4942 The name of the password server is looked up using the
4944 resolve order\fR and so may resolved
4945 by any method and order described in that parameter.
4947 The password server much be a machine capable of using
4948 the "LM1.2X002" or the "NT LM 0.12" protocol, and it must be in
4949 user level security mode.
4951 \fBNOTE:\fR Using a password server
4952 means your UNIX box (running Samba) is only as secure as your
4953 password server. \fBDO NOT CHOOSE A PASSWORD SERVER THAT
4954 YOU DON'T COMPLETELY TRUST\fR.
4956 Never point a Samba server at itself for password
4957 serving. This will cause a loop and could lock up your Samba
4960 The name of the password server takes the standard
4961 substitutions, but probably the only useful one is \fI%m
4962 \fR, which means the Samba server will use the incoming
4963 client as the password server. If you use this then you better
4964 trust your clients, and you had better restrict them with hosts allow!
4966 If the \fIsecurity\fR parameter is set to
4967 domain, then the list of machines in this
4968 option must be a list of Primary or Backup Domain controllers for the
4969 Domain or the character '*', as the Samba server is effectively
4970 in that domain, and will use cryptographically authenticated RPC calls
4971 to authenticate the user logging on. The advantage of using \fB security = domain\fR is that if you list several hosts in the
4972 \fIpassword server\fR option then \fBsmbd
4973 \fRwill try each in turn till it finds one that responds. This
4974 is useful in case your primary server goes down.
4976 If the \fIpassword server\fR option is set
4977 to the character '*', then Samba will attempt to auto-locate the
4978 Primary or Backup Domain controllers to authenticate against by
4979 doing a query for the name WORKGROUP<1C>
4980 and then contacting each server returned in the list of IP
4981 addresses from the name resolution source.
4983 If the \fIsecurity\fR parameter is
4984 set to server, then there are different
4985 restrictions that \fBsecurity = domain\fR doesn't
4990 You may list several password servers in
4991 the \fIpassword server\fR parameter, however if an
4992 \fBsmbd\fR makes a connection to a password server,
4993 and then the password server fails, no more users will be able
4994 to be authenticated from this \fBsmbd\fR. This is a
4995 restriction of the SMB/CIFS protocol when in \fBsecurity = server
4996 \fRmode and cannot be fixed in Samba.
4999 If you are using a Windows NT server as your
5000 password server then you will have to ensure that your users
5001 are able to login from the Samba server, as when in \fB security = server\fR mode the network logon will appear to
5002 come from there rather than from the users workstation.
5005 See also the \fIsecurity
5009 Default: \fBpassword server = <empty string>\fR
5012 Example: \fBpassword server = NT-PDC, NT-BDC1, NT-BDC2
5015 Example: \fBpassword server = *\fR
5019 This parameter specifies a directory to which
5020 the user of the service is to be given access. In the case of
5021 printable services, this is where print data will spool prior to
5022 being submitted to the host for printing.
5024 For a printable service offering guest access, the service
5025 should be readonly and the path should be world-writeable and
5026 have the sticky bit set. This is not mandatory of course, but
5027 you probably won't get the results you expect if you do
5030 Any occurrences of \fI%u\fR in the path
5031 will be replaced with the UNIX username that the client is using
5032 on this connection. Any occurrences of \fI%m\fR
5033 will be replaced by the NetBIOS name of the machine they are
5034 connecting from. These replacements are very useful for setting
5035 up pseudo home directories for users.
5037 Note that this path will be based on \fIroot dir\fR if one was specified.
5041 Example: \fBpath = /home/fred\fR
5043 \fBposix locking (S)\fR
5045 daemon maintains an database of file locks obtained by SMB clients.
5046 The default behavior is to map this internal database to POSIX
5047 locks. This means that file locks obtained by SMB clients are
5048 consistent with those seen by POSIX compliant applications accessing
5049 the files via a non-SMB method (e.g. NFS or local file access).
5050 You should never need to disable this parameter.
5052 Default: \fBposix locking = yes\fR
5055 This option specifies a command to be run
5056 whenever the service is disconnected. It takes the usual
5057 substitutions. The command may be run as the root on some
5060 An interesting example may be to unmount server
5063 \fBpostexec = /etc/umount /cdrom\fR
5065 See also \fIpreexec\fR
5068 Default: \fBnone (no command executed)\fR
5070 Example: \fBpostexec = echo \\"%u disconnected from %S
5071 from %m (%I)\\" >> /tmp/log\fR
5073 \fBpostscript (S)\fR
5074 This parameter forces a printer to interpret
5075 the print files as PostScript. This is done by adding a %!
5076 to the start of print output.
5078 This is most useful when you have lots of PCs that persist
5079 in putting a control-D at the start of print jobs, which then
5080 confuses your printer.
5082 Default: \fBpostscript = no\fR
5085 This option specifies a command to be run whenever
5086 the service is connected to. It takes the usual substitutions.
5088 An interesting example is to send the users a welcome
5089 message every time they log in. Maybe a message of the day? Here
5092 \fBpreexec = csh -c 'echo \\"Welcome to %S!\\" |
5093 /usr/local/samba/bin/smbclient -M %m -I %I' & \fR
5095 Of course, this could get annoying after a while :-)
5097 See also \fIpreexec close
5101 Default: \fBnone (no command executed)\fR
5103 Example: \fBpreexec = echo \\"%u connected to %S from %m
5104 (%I)\\" >> /tmp/log\fR
5106 \fBpreexec close (S)\fR
5107 This boolean option controls whether a non-zero
5108 return code from \fIpreexec
5109 \fRshould close the service being connected to.
5111 Default: \fBpreexec close = no\fR
5113 \fBpreferred master (G)\fR
5114 This boolean parameter controls if nmbd(8)is a preferred master browser
5117 If this is set to true, on startup, \fBnmbd\fR
5118 will force an election, and it will have a slight advantage in
5119 winning the election. It is recommended that this parameter is
5120 used in conjunction with \fB\fI domain master\fB = yes\fR, so that \fB nmbd\fR can guarantee becoming a domain master.
5122 Use this option with caution, because if there are several
5123 hosts (whether Samba servers, Windows 95 or NT) that are preferred
5124 master browsers on the same subnet, they will each periodically
5125 and continuously attempt to become the local master browser.
5126 This will result in unnecessary broadcast traffic and reduced browsing
5129 See also \fIos level\fR
5132 Default: \fBpreferred master = auto\fR
5134 \fBprefered master (G)\fR
5135 Synonym for \fI preferred master\fR for people who cannot spell :-).
5138 This is a list of services that you want to be
5139 automatically added to the browse lists. This is most useful
5140 for homes and printers services that would otherwise not be
5143 Note that if you just want all printers in your
5144 printcap file loaded then the \fIload printers\fR option is easier.
5146 Default: \fBno preloaded services\fR
5148 Example: \fBpreload = fred lp colorlp\fR
5150 \fBpreserve case (S)\fR
5151 This controls if new filenames are created
5152 with the case that the client passes, or if they are forced to
5153 be the \fIdefault case
5156 Default: \fBpreserve case = yes\fR
5158 See the section on NAME
5159 MANGLING for a fuller discussion.
5161 \fBprint command (S)\fR
5162 After a print job has finished spooling to
5163 a service, this command will be used via a \fBsystem()\fR
5164 call to process the spool file. Typically the command specified will
5165 submit the spool file to the host's printing subsystem, but there
5166 is no requirement that this be the case. The server will not remove
5167 the spool file, so whatever command you specify should remove the
5168 spool file when it has been processed, otherwise you will need to
5169 manually remove old spool files.
5171 The print command is simply a text string. It will be used
5172 verbatim, with two exceptions: All occurrences of \fI%s
5173 \fRand \fI%f\fR will be replaced by the
5174 appropriate spool file name, and all occurrences of \fI%p
5175 \fRwill be replaced by the appropriate printer name. The
5176 spool file name is generated automatically by the server. The
5177 \fI%J\fR macro can be used to access the job
5178 name as transmitted by the client.
5180 The print command \fBMUST\fR contain at least
5181 one occurrence of \fI%s\fR or \fI%f
5182 \fR- the \fI%p\fR is optional. At the time
5183 a job is submitted, if no printer name is supplied the \fI%p
5184 \fRwill be silently removed from the printer command.
5186 If specified in the [global] section, the print command given
5187 will be used for any printable service that does not have its own
5188 print command specified.
5190 If there is neither a specified print command for a
5191 printable service nor a global print command, spool files will
5192 be created but not processed and (most importantly) not removed.
5194 Note that printing may fail on some UNIXes from the
5195 nobody account. If this happens then create
5196 an alternative guest account that can print and set the \fIguest account\fR
5197 in the [global] section.
5199 You can form quite complex print commands by realizing
5200 that they are just passed to a shell. For example the following
5201 will log a print job, print the file, then remove it. Note that
5202 \&';' is the usual separator for command in shell scripts.
5204 \fBprint command = echo Printing %s >>
5205 /tmp/print.log; lpr -P %p %s; rm %s\fR
5207 You may have to vary this command considerably depending
5208 on how you normally print files on your system. The default for
5209 the parameter varies depending on the setting of the \fIprinting\fR parameter.
5211 Default: For \fBprinting = BSD, AIX, QNX, LPRNG
5214 \fBprint command = lpr -r -P%p %s\fR
5216 For \fBprinting = SYSV or HPUX :\fR
5218 \fBprint command = lp -c -d%p %s; rm %s\fR
5220 For \fBprinting = SOFTQ :\fR
5222 \fBprint command = lp -d%p -s %s; rm %s\fR
5224 Example: \fBprint command = /usr/local/samba/bin/myprintscript
5228 Synonym for \fIprintable\fR.
5231 If this parameter is yes, then
5232 clients may open, write to and submit spool files on the directory
5233 specified for the service.
5235 Note that a printable service will ALWAYS allow writing
5236 to the service path (user privileges permitting) via the spooling
5237 of print data. The \fIwriteable
5238 \fRparameter controls only non-printing access to
5241 Default: \fBprintable = no\fR
5244 Synonym for \fI printcap name\fR.
5246 \fBprintcap name (G)\fR
5247 This parameter may be used to override the
5248 compiled-in default printcap name used by the server (usually \fI /etc/printcap\fR). See the discussion of the [printers] section above for reasons
5249 why you might want to do this.
5251 On System V systems that use \fBlpstat\fR to
5252 list available printers you can use \fBprintcap name = lpstat
5253 \fRto automatically obtain lists of available printers. This
5254 is the default for systems that define SYSV at configure time in
5255 Samba (this includes most System V based systems). If \fI printcap name\fR is set to \fBlpstat\fR on
5256 these systems then Samba will launch \fBlpstat -v\fR and
5257 attempt to parse the output to obtain a printer list.
5259 A minimal printcap file would look something like this:
5272 where the '|' separates aliases of a printer. The fact
5273 that the second alias has a space in it gives a hint to Samba
5274 that it's a comment.
5276 \fBNOTE\fR: Under AIX the default printcap
5277 name is \fI/etc/qconfig\fR. Samba will assume the
5278 file is in AIX \fIqconfig\fR format if the string
5279 \fIqconfig\fR appears in the printcap filename.
5281 Default: \fBprintcap name = /etc/printcap\fR
5283 Example: \fBprintcap name = /etc/myprintcap\fR
5285 \fBprinter admin (S)\fR
5286 This is a list of users that can do anything to
5287 printers via the remote administration interfaces offered by MS-RPC
5288 (usually using a NT workstation). Note that the root user always
5291 Default: \fBprinter admin = <empty string>\fR
5293 Example: \fBprinter admin = admin, @staff\fR
5295 \fBprinter driver (S)\fR
5296 \fBNote :\fRThis is a deprecated
5297 parameter and will be removed in the next major release
5298 following version 2.2. Please see the instructions in
5299 the Samba 2.2. Printing
5300 HOWTOfor more information
5301 on the new method of loading printer drivers onto a Samba server.
5303 This option allows you to control the string
5304 that clients receive when they ask the server for the printer driver
5305 associated with a printer. If you are using Windows95 or Windows NT
5306 then you can use this to automate the setup of printers on your
5309 You need to set this parameter to the exact string (case
5310 sensitive) that describes the appropriate printer driver for your
5311 system. If you don't know the exact string to use then you should
5312 first try with no \fI printer driver\fR option set and the client will
5313 give you a list of printer drivers. The appropriate strings are
5314 shown in a scroll box after you have chosen the printer manufacturer.
5319 Example: \fBprinter driver = HP LaserJet 4L\fR
5321 \fBprinter driver file (G)\fR
5322 \fBNote :\fRThis is a deprecated
5323 parameter and will be removed in the next major release
5324 following version 2.2. Please see the instructions in
5325 the Samba 2.2. Printing
5326 HOWTOfor more information
5327 on the new method of loading printer drivers onto a Samba server.
5329 This parameter tells Samba where the printer driver
5330 definition file, used when serving drivers to Windows 95 clients, is
5331 to be found. If this is not set, the default is :
5333 \fISAMBA_INSTALL_DIRECTORY
5334 /lib/printers.def\fR
5336 This file is created from Windows 95 \fImsprint.inf
5337 \fRfiles found on the Windows 95 client system. For more
5338 details on setting up serving of printer drivers to Windows 95
5339 clients, see the outdated documentation file in the \fIdocs/\fR
5340 directory, \fIPRINTER_DRIVER.txt\fR.
5342 See also \fI printer driver location\fR.
5344 Default: \fBNone (set in compile).\fR
5346 Example: \fBprinter driver file =
5347 /usr/local/samba/printers/drivers.def\fR
5349 \fBprinter driver location (S)\fR
5350 \fBNote :\fRThis is a deprecated
5351 parameter and will be removed in the next major release
5352 following version 2.2. Please see the instructions in
5353 the Samba 2.2. Printing
5354 HOWTOfor more information
5355 on the new method of loading printer drivers onto a Samba server.
5357 This parameter tells clients of a particular printer
5358 share where to find the printer driver files for the automatic
5359 installation of drivers for Windows 95 machines. If Samba is set up
5360 to serve printer drivers to Windows 95 machines, this should be set to
5362 \fB\\\\MACHINE\\PRINTER$\fR
5364 Where MACHINE is the NetBIOS name of your Samba server,
5365 and PRINTER$ is a share you set up for serving printer driver
5366 files. For more details on setting this up see the outdated documentation
5367 file in the \fIdocs/\fR directory, \fI PRINTER_DRIVER.txt\fR.
5369 See also \fI printer driver file\fR.
5373 Example: \fBprinter driver location = \\\\MACHINE\\PRINTER$
5375 \fBprinter name (S)\fR
5376 This parameter specifies the name of the printer
5377 to which print jobs spooled through a printable service will be sent.
5379 If specified in the [global] section, the printer
5380 name given will be used for any printable service that does
5381 not have its own printer name specified.
5383 Default: \fBnone (but may be lp
5386 Example: \fBprinter name = laserwriter\fR
5389 Synonym for \fI printer name\fR.
5392 This parameters controls how printer status
5393 information is interpreted on your system. It also affects the
5394 default values for the \fIprint command\fR,
5395 \fIlpq command\fR, \fIlppause command
5396 \fR, \fIlpresume command\fR, and
5397 \fIlprm command\fR if specified in the
5400 Currently nine printing styles are supported. They are
5407 To see what the defaults are for the other print
5408 commands when using the various options use the testparm(1)program.
5410 This option can be set on a per printer basis
5412 See also the discussion in the [printers] section.
5415 Synonym for \fImax protocol\fR.
5418 Synonym for \fIguest
5421 \fBqueuepause command (S)\fR
5422 This parameter specifies the command to be
5423 executed on the server host in order to pause the printer queue.
5425 This command should be a program or script which takes
5426 a printer name as its only parameter and stops the printer queue,
5427 such that no longer jobs are submitted to the printer.
5429 This command is not supported by Windows for Workgroups,
5430 but can be issued from the Printers window under Windows 95
5433 If a \fI%p\fR is given then the printer name
5434 is put in its place. Otherwise it is placed at the end of the command.
5436 Note that it is good practice to include the absolute
5437 path in the command as the PATH may not be available to the
5440 Default: \fBdepends on the setting of \fIprinting
5442 Example: \fBqueuepause command = disable %p\fR
5444 \fBqueueresume command (S)\fR
5445 This parameter specifies the command to be
5446 executed on the server host in order to resume the printer queue. It
5447 is the command to undo the behavior that is caused by the
5448 previous parameter (\fI queuepause command\fR).
5450 This command should be a program or script which takes
5451 a printer name as its only parameter and resumes the printer queue,
5452 such that queued jobs are resubmitted to the printer.
5454 This command is not supported by Windows for Workgroups,
5455 but can be issued from the Printers window under Windows 95
5458 If a \fI%p\fR is given then the printer name
5459 is put in its place. Otherwise it is placed at the end of the
5462 Note that it is good practice to include the absolute
5463 path in the command as the PATH may not be available to the
5466 Default: \fBdepends on the setting of \fIprinting\fB\fR
5468 Example: \fBqueuepause command = enable %p
5471 This boolean parameter controls whether smbd(8)will support the "Read
5472 Block Multiplex" SMB. This is now rarely used and defaults to
5473 no. You should never need to set this
5476 Default: \fBread bmpx = no\fR
5479 This is a list of users that are given read-only
5480 access to a service. If the connecting user is in this list then
5481 they will not be given write access, no matter what the \fIwriteable\fR
5482 option is set to. The list can include group names using the
5483 syntax described in the \fI invalid users\fR parameter.
5485 See also the \fI write list\fR parameter and the \fIinvalid users\fR
5488 Default: \fBread list = <empty string>\fR
5490 Example: \fBread list = mary, @students\fR
5493 Note that this is an inverted synonym for \fIwriteable\fR.
5496 This parameter controls whether or not the server
5497 will support the raw read SMB requests when transferring data
5500 If enabled, raw reads allow reads of 65535 bytes in
5501 one packet. This typically provides a major performance benefit.
5503 However, some clients either negotiate the allowable
5504 block size incorrectly or are incapable of supporting larger block
5505 sizes, and for these clients you may need to disable raw reads.
5507 In general this parameter should be viewed as a system tuning
5508 tool and left severely alone. See also \fIwrite raw\fR.
5510 Default: \fBread raw = yes\fR
5513 The option \fIread size\fR
5514 affects the overlap of disk reads/writes with network reads/writes.
5515 If the amount of data being transferred in several of the SMB
5516 commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger
5517 than this value then the server begins writing the data before it
5518 has received the whole packet from the network, or in the case of
5519 SMBreadbraw, it begins writing to the network before all the data
5520 has been read from disk.
5522 This overlapping works best when the speeds of disk and
5523 network access are similar, having very little effect when the
5524 speed of one is much greater than the other.
5526 The default value is 16384, but very little experimentation
5527 has been done yet to determine the optimal value, and it is likely
5528 that the best value will vary greatly between systems anyway.
5529 A value over 65536 is pointless and will cause you to allocate
5530 memory unnecessarily.
5532 Default: \fBread size = 16384\fR
5534 Example: \fBread size = 8192\fR
5536 \fBremote announce (G)\fR
5537 This option allows you to setup nmbd(8)to periodically announce itself
5538 to arbitrary IP addresses with an arbitrary workgroup name.
5540 This is useful if you want your Samba server to appear
5541 in a remote workgroup for which the normal browse propagation
5542 rules don't work. The remote workgroup can be anywhere that you
5543 can send IP packets to.
5547 \fBremote announce = 192.168.2.255/SERVERS
5548 192.168.4.255/STAFF\fR
5550 the above line would cause \fBnmbd\fR to announce itself
5551 to the two given IP addresses using the given workgroup names.
5552 If you leave out the workgroup name then the one given in
5554 parameter is used instead.
5556 The IP addresses you choose would normally be the broadcast
5557 addresses of the remote networks, but can also be the IP addresses
5558 of known browse masters if your network config is that stable.
5560 See the documentation file \fIBROWSING.txt\fR
5561 in the \fIdocs/\fR directory.
5563 Default: \fBremote announce = <empty string>
5565 \fBremote browse sync (G)\fR
5566 This option allows you to setup nmbd(8)to periodically request
5567 synchronization of browse lists with the master browser of a Samba
5568 server that is on a remote segment. This option will allow you to
5569 gain browse lists for multiple workgroups across routed networks. This
5570 is done in a manner that does not work with any non-Samba servers.
5572 This is useful if you want your Samba server and all local
5573 clients to appear in a remote workgroup for which the normal browse
5574 propagation rules don't work. The remote workgroup can be anywhere
5575 that you can send IP packets to.
5579 \fBremote browse sync = 192.168.2.255 192.168.4.255
5581 the above line would cause \fBnmbd\fR to request
5582 the master browser on the specified subnets or addresses to
5583 synchronize their browse lists with the local server.
5585 The IP addresses you choose would normally be the broadcast
5586 addresses of the remote networks, but can also be the IP addresses
5587 of known browse masters if your network config is that stable. If
5588 a machine IP address is given Samba makes NO attempt to validate
5589 that the remote machine is available, is listening, nor that it
5590 is in fact the browse master on its segment.
5592 Default: \fBremote browse sync = <empty string>
5594 \fBrestrict anonymous (G)\fR
5595 This is a boolean parameter. If it is true, then
5596 anonymous access to the server will be restricted, namely in the
5597 case where the server is expecting the client to send a username,
5598 but it doesn't. Setting it to true will force these anonymous
5599 connections to be denied, and the client will be required to always
5600 supply a username and password when connecting. Use of this parameter
5601 is only recommended for homogeneous NT client environments.
5603 This parameter makes the use of macro expansions that rely
5604 on the username (%U, %G, etc) consistent. NT 4.0
5605 likes to use anonymous connections when refreshing the share list,
5606 and this is a way to work around that.
5608 When restrict anonymous is true, all anonymous connections
5609 are denied no matter what they are for. This can effect the ability
5610 of a machine to access the Samba Primary Domain Controller to revalidate
5611 its machine account after someone else has logged on the client
5612 interactively. The NT client will display a message saying that
5613 the machine's account in the domain doesn't exist or the password is
5614 bad. The best way to deal with this is to reboot NT client machines
5615 between interactive logons, using "Shutdown and Restart", rather
5616 than "Close all programs and logon as a different user".
5618 Default: \fBrestrict anonymous = no\fR
5621 Synonym for \fIroot directory"\fR.
5624 Synonym for \fIroot directory"\fR.
5626 \fBroot directory (G)\fR
5627 The server will \fBchroot()\fR (i.e.
5628 Change its root directory) to this directory on startup. This is
5629 not strictly necessary for secure operation. Even without it the
5630 server will deny access to files not in one of the service entries.
5631 It may also check for, and deny access to, soft links to other
5632 parts of the filesystem, or attempts to use ".." in file names
5633 to access other directories (depending on the setting of the \fIwide links\fR
5636 Adding a \fIroot directory\fR entry other
5637 than "/" adds an extra level of security, but at a price. It
5638 absolutely ensures that no access is given to files not in the
5639 sub-tree specified in the \fIroot directory\fR
5640 option, \fBincluding\fR some files needed for
5641 complete operation of the server. To maintain full operability
5642 of the server you will need to mirror some system files
5643 into the \fIroot directory\fR tree. In particular
5644 you will need to mirror \fI/etc/passwd\fR (or a
5645 subset of it), and any binaries or configuration files needed for
5646 printing (if required). The set of files that must be mirrored is
5647 operating system dependent.
5649 Default: \fBroot directory = /\fR
5651 Example: \fBroot directory = /homes/smb\fR
5653 \fBroot postexec (S)\fR
5654 This is the same as the \fIpostexec\fR
5655 parameter except that the command is run as root. This
5656 is useful for unmounting filesystems
5657 (such as CDROMs) after a connection is closed.
5659 See also \fI postexec\fR.
5661 Default: \fBroot postexec = <empty string>
5663 \fBroot preexec (S)\fR
5664 This is the same as the \fIpreexec\fR
5665 parameter except that the command is run as root. This
5666 is useful for mounting filesystems (such as CDROMs) when a
5667 connection is opened.
5669 See also \fI preexec\fR and \fIpreexec close\fR.
5671 Default: \fBroot preexec = <empty string>
5673 \fBroot preexec close (S)\fR
5674 This is the same as the \fIpreexec close
5675 \fRparameter except that the command is run as root.
5677 See also \fI preexec\fR and \fIpreexec close\fR.
5679 Default: \fBroot preexec close = no\fR
5682 This option affects how clients respond to
5683 Samba and is one of the most important settings in the \fI smb.conf\fR file.
5685 The option sets the "security mode bit" in replies to
5686 protocol negotiations with smbd(8)
5687 to turn share level security on or off. Clients decide
5688 based on this bit whether (and how) to transfer user and password
5689 information to the server.
5691 The default is \fBsecurity = user\fR, as this is
5692 the most common setting needed when talking to Windows 98 and
5695 The alternatives are \fBsecurity = share\fR,
5696 \fBsecurity = server\fR or \fBsecurity = domain
5699 In versions of Samba prior to 2.0.0, the default was
5700 \fBsecurity = share\fR mainly because that was
5701 the only option at one stage.
5703 There is a bug in WfWg that has relevance to this
5704 setting. When in user or server level security a WfWg client
5705 will totally ignore the password you type in the "connect
5706 drive" dialog box. This makes it very difficult (if not impossible)
5707 to connect to a Samba service as anyone except the user that
5708 you are logged into WfWg as.
5710 If your PCs use usernames that are the same as their
5711 usernames on the UNIX machine then you will want to use
5712 \fBsecurity = user\fR. If you mostly use usernames
5713 that don't exist on the UNIX box then use \fBsecurity =
5716 You should also use \fBsecurity = share\fR if you
5717 want to mainly setup shares without a password (guest shares). This
5718 is commonly used for a shared printer server. It is more difficult
5719 to setup guest shares with \fBsecurity = user\fR, see
5720 the \fImap to guest\fR
5721 parameter for details.
5723 It is possible to use \fBsmbd\fR in a \fB hybrid mode\fR where it is offers both user and share
5724 level security under different \fINetBIOS aliases\fR.
5726 The different settings will now be explained.
5730 When clients connect to a share level security server they
5731 need not log onto the server with a valid username and password before
5732 attempting to connect to a shared resource (although modern clients
5733 such as Windows 95/98 and Windows NT will send a logon request with
5734 a username but no password when talking to a \fBsecurity = share
5735 \fRserver). Instead, the clients send authentication information
5736 (passwords) on a per-share basis, at the time they attempt to connect
5739 Note that \fBsmbd\fR \fBALWAYS\fR
5740 uses a valid UNIX user to act on behalf of the client, even in
5741 \fBsecurity = share\fR level security.
5743 As clients are not required to send a username to the server
5744 in share level security, \fBsmbd\fR uses several
5745 techniques to determine the correct UNIX user to use on behalf
5748 A list of possible UNIX usernames to match with the given
5749 client password is constructed using the following methods :
5754 only\fR parameter is set, then all the other
5755 stages are missed and only the \fIguest account\fR username is checked.
5758 Is a username is sent with the share connection
5759 request, then this username (after mapping - see \fIusername map\fR),
5760 is added as a potential username.
5763 If the client did a previous \fBlogon
5764 \fRrequest (the SessionSetup SMB call) then the
5765 username sent in this SMB will be added as a potential username.
5768 The name of the service the client requested is
5769 added as a potential username.
5772 The NetBIOS name of the client is added to
5773 the list as a potential username.
5776 Any users on the \fI user\fR list are added as potential usernames.
5779 If the \fIguest only\fR parameter is
5780 not set, then this list is then tried with the supplied password.
5781 The first user for whom the password matches will be used as the
5785 If the \fIguest only\fR parameter is
5786 set, or no username can be determined then if the share is marked
5787 as available to the \fIguest account\fR, then this
5788 guest user will be used, otherwise access is denied.
5791 Note that it can be \fBvery\fR confusing
5792 in share-level security as to which UNIX username will eventually
5793 be used in granting access.
5796 See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
5802 This is the default security setting in Samba 2.2.
5803 With user-level security a client must first "log-on" with a
5804 valid username and password (which can be mapped using the \fIusername map\fR
5805 parameter). Encrypted passwords (see the \fIencrypted passwords\fR parameter) can also
5806 be used in this security mode. Parameters such as \fIuser\fR and \fIguest only\fR if set are then applied and
5807 may change the UNIX user to use on this connection, but only after
5808 the user has been successfully authenticated.
5811 \fBNote\fR that the name of the resource being
5812 requested is \fBnot\fR sent to the server until after
5813 the server has successfully authenticated the client. This is why
5814 guest shares don't work in user level security without allowing
5815 the server to automatically map unknown users into the \fIguest account\fR.
5816 See the \fImap to guest\fR
5817 parameter for details on doing this.
5820 See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
5823 \fBSECURITY = SERVER
5826 In this mode Samba will try to validate the username/password
5827 by passing it to another SMB server, such as an NT box. If this
5828 fails it will revert to \fBsecurity = user\fR, but note
5829 that if encrypted passwords have been negotiated then Samba cannot
5830 revert back to checking the UNIX password file, it must have a valid
5831 \fIsmbpasswd\fR file to check users against. See the
5832 documentation file in the \fIdocs/\fR directory
5833 \fIENCRYPTION.txt\fR for details on how to set this
5837 \fBNote\fR that from the client's point of
5838 view \fBsecurity = server\fR is the same as \fB security = user\fR. It only affects how the server deals
5839 with the authentication, it does not in any way affect what the
5843 \fBNote\fR that the name of the resource being
5844 requested is \fBnot\fR sent to the server until after
5845 the server has successfully authenticated the client. This is why
5846 guest shares don't work in user level security without allowing
5847 the server to automatically map unknown users into the \fIguest account\fR.
5848 See the \fImap to guest\fR
5849 parameter for details on doing this.
5852 See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
5855 See also the \fIpassword
5856 server\fR parameter and the \fIencrypted passwords\fR
5860 \fBSECURITY = DOMAIN
5863 This mode will only work correctly if smbpasswd(8)has been used to add this
5864 machine into a Windows NT Domain. It expects the \fIencrypted passwords\fR
5865 parameter to be set to true. In this
5866 mode Samba will try to validate the username/password by passing
5867 it to a Windows NT Primary or Backup Domain Controller, in exactly
5868 the same way that a Windows NT Server would do.
5871 \fBNote\fR that a valid UNIX user must still
5872 exist as well as the account on the Domain Controller to allow
5873 Samba to have a valid UNIX account to map file access to.
5876 \fBNote\fR that from the client's point
5877 of view \fBsecurity = domain\fR is the same as \fBsecurity = user
5878 \fR\&. It only affects how the server deals with the authentication,
5879 it does not in any way affect what the client sees.
5882 \fBNote\fR that the name of the resource being
5883 requested is \fBnot\fR sent to the server until after
5884 the server has successfully authenticated the client. This is why
5885 guest shares don't work in user level security without allowing
5886 the server to automatically map unknown users into the \fIguest account\fR.
5887 See the \fImap to guest\fR
5888 parameter for details on doing this.
5891 \fBBUG:\fR There is currently a bug in the
5892 implementation of \fBsecurity = domain\fR with respect
5893 to multi-byte character set usernames. The communication with a
5894 Domain Controller must be done in UNICODE and Samba currently
5895 does not widen multi-byte user names to UNICODE correctly, thus
5896 a multi-byte username will not be recognized correctly at the
5897 Domain Controller. This issue will be addressed in a future release.
5900 See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
5903 See also the \fIpassword
5904 server\fR parameter and the \fIencrypted passwords\fR
5908 Default: \fBsecurity = USER\fR
5911 Example: \fBsecurity = DOMAIN\fR
5914 \fBsecurity mask (S)\fR
5915 This parameter controls what UNIX permission
5916 bits can be modified when a Windows NT client is manipulating
5917 the UNIX permission on a file using the native NT security
5920 This parameter is applied as a mask (AND'ed with) to
5921 the changed permission bits, thus preventing any bits not in
5922 this mask from being modified. Essentially, zero bits in this
5923 mask may be treated as a set of bits the user is not allowed
5926 If not set explicitly this parameter is 0777, allowing
5927 a user to modify all the user/group/world permissions on a file.
5929 \fBNote\fR that users who can access the
5930 Samba server through other means can easily bypass this
5931 restriction, so it is primarily useful for standalone
5932 "appliance" systems. Administrators of most normal systems will
5933 probably want to leave it set to 0777.
5935 See also the \fIforce directory security mode\fR,
5937 security mask\fR, \fIforce security mode\fR parameters.
5939 Default: \fBsecurity mask = 0777\fR
5941 Example: \fBsecurity mask = 0770\fR
5943 \fBserver string (G)\fR
5944 This controls what string will show up in the
5945 printer comment box in print manager and next to the IPC connection
5946 in \fBnet view\fR. It can be any string that you wish
5947 to show to your users.
5949 It also sets what will appear in browse lists next
5950 to the machine name.
5952 A \fI%v\fR will be replaced with the Samba
5955 A \fI%h\fR will be replaced with the
5958 Default: \fBserver string = Samba %v\fR
5960 Example: \fBserver string = University of GNUs Samba
5963 \fBset directory (S)\fR
5964 If \fBset directory = no\fR, then
5965 users of the service may not use the setdir command to change
5968 The \fBsetdir\fR command is only implemented
5969 in the Digital Pathworks client. See the Pathworks documentation
5972 Default: \fBset directory = no\fR
5974 \fBshort preserve case (S)\fR
5975 This boolean parameter controls if new files
5976 which conform to 8.3 syntax, that is all in upper case and of
5977 suitable length, are created upper case, or if they are forced
5978 to be the \fIdefault case
5979 \fR\&. This option can be use with \fBpreserve case = yes\fR
5980 to permit long filenames to retain their case, while short
5983 See the section on NAME MANGLING.
5985 Default: \fBshort preserve case = yes\fR
5987 \fBshow add printer wizard (G)\fR
5988 With the introduction of MS-RPC based printing support
5989 for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will
5990 appear on Samba hosts in the share listing. Normally this folder will
5991 contain an icon for the MS Add Printer Wizard (APW). However, it is
5992 possible to disable this feature regardless of the level of privilege
5993 of the connected user.
5995 Under normal circumstances, the Windows NT/2000 client will
5996 open a handle on the printer server with OpenPrinterEx() asking for
5997 Administrator privileges. If the user does not have administrative
5998 access on the print server (i.e is not root or a member of the
5999 \fIprinter admin\fR group), the OpenPrinterEx()
6000 call fails and the client makes another open call with a request for
6001 a lower privilege level. This should succeed, however the APW
6002 icon will not be displayed.
6004 Disabling the \fIshow add printer wizard\fR
6005 parameter will always cause the OpenPrinterEx() on the server
6006 to fail. Thus the APW icon will never be displayed. \fB Note :\fRThis does not prevent the same user from having
6007 administrative privilege on an individual printer.
6009 See also \fIaddprinter
6010 command\fR, \fIdeleteprinter command\fR, \fIprinter admin\fR
6012 Default :\fBshow add printer wizard = yes\fR
6014 \fBshutdown script (G)\fR
6015 \fBThis parameter only exists in the HEAD cvs branch\fR
6016 This a full path name to a script called by
6018 should start a shutdown procedure.
6020 This command will be run as the user connected to the
6023 %m %t %r %f parameters are expanded
6025 \fI%m\fR will be substituted with the
6026 shutdown message sent to the server.
6028 \fI%t\fR will be substituted with the
6029 number of seconds to wait before effectively starting the
6032 \fI%r\fR will be substituted with the
6033 switch \fB-r\fR. It means reboot after shutdown
6036 \fI%f\fR will be substituted with the
6037 switch \fB-f\fR. It means force the shutdown
6038 even if applications do not respond for NT.
6040 Default: \fBNone\fR.
6042 Example: \fBabort shutdown script = /usr/local/samba/sbin/shutdown %m %t %r %f\fR
6044 Shutdown script example:
6053 /sbin/shutdown $3 $4 +$time $1 &
6057 Shutdown does not return so we need to launch it in background.
6059 See also \fIabort shutdown script\fR.
6061 \fBsmb passwd file (G)\fR
6062 This option sets the path to the encrypted
6063 smbpasswd file. By default the path to the smbpasswd file
6064 is compiled into Samba.
6066 Default: \fBsmb passwd file = ${prefix}/private/smbpasswd
6068 Example: \fBsmb passwd file = /etc/samba/smbpasswd
6070 \fBsocket address (G)\fR
6071 This option allows you to control what
6072 address Samba will listen for connections on. This is used to
6073 support multiple virtual interfaces on the one server, each
6074 with a different configuration.
6076 By default Samba will accept connections on any
6079 Example: \fBsocket address = 192.168.2.20\fR
6081 \fBsocket options (G)\fR
6082 This option allows you to set socket options
6083 to be used when talking with the client.
6085 Socket options are controls on the networking layer
6086 of the operating systems which allow the connection to be
6089 This option will typically be used to tune your Samba
6090 server for optimal performance for your local network. There is
6091 no way that Samba can know what the optimal parameters are for
6092 your net, so you must experiment and choose them yourself. We
6093 strongly suggest you read the appropriate documentation for your
6094 operating system first (perhaps \fBman setsockopt\fR
6097 You may find that on some systems Samba will say
6098 "Unknown socket option" when you supply an option. This means you
6099 either incorrectly typed it or you need to add an include file
6100 to includes.h for your OS. If the latter is the case please
6101 send the patch to samba@samba.org <URL:mailto:samba@samba.org>.
6103 Any of the supported socket options may be combined
6104 in any way you like, as long as your OS allows it.
6106 This is the list of socket options currently settable
6141 Those marked with a \fB'*'\fR take an integer
6142 argument. The others can optionally take a 1 or 0 argument to enable
6143 or disable the option, by default they will be enabled if you
6144 don't specify 1 or 0.
6147 To specify an argument use the syntax SOME_OPTION = VALUE
6148 for example \fBSO_SNDBUF = 8192\fR. Note that you must
6149 not have any spaces before or after the = sign.
6152 If you are on a local network then a sensible option
6156 \fBsocket options = IPTOS_LOWDELAY\fR
6159 If you have a local network then you could try:
6162 \fBsocket options = IPTOS_LOWDELAY TCP_NODELAY\fR
6165 If you are on a wide area network then perhaps try
6166 setting IPTOS_THROUGHPUT.
6169 Note that several of the options may cause your Samba
6170 server to fail completely. Use these options with caution!
6173 Default: \fBsocket options = TCP_NODELAY\fR
6176 Example: \fBsocket options = IPTOS_LOWDELAY\fR
6179 \fBsource environment (G)\fR
6180 This parameter causes Samba to set environment
6181 variables as per the content of the file named.
6183 If the value of this parameter starts with a "|" character
6184 then Samba will treat that value as a pipe command to open and
6185 will set the environment variables from the output of the pipe.
6187 The contents of the file or the output of the pipe should
6188 be formatted as the output of the standard Unix \fBenv(1)
6189 \fRcommand. This is of the form :
6191 Example environment entry:
6193 \fBSAMBA_NETBIOS_NAME = myhostname\fR
6195 Default: \fBNo default value\fR
6197 Examples: \fBsource environment = |/etc/smb.conf.sh
6199 Example: \fBsource environment =
6200 /usr/local/smb_env_vars\fR
6203 This variable is part of SSL-enabled Samba. This
6204 is only available if the SSL libraries have been compiled on your
6205 system and the configure option \fB--with-ssl\fR was
6206 given at configure time.
6208 This variable enables or disables the entire SSL mode. If
6209 it is set to no, the SSL-enabled Samba behaves
6210 exactly like the non-SSL Samba. If set to yes,
6211 it depends on the variables \fI ssl hosts\fR and \fIssl hosts resign\fR whether an SSL
6212 connection will be required.
6214 Default: \fBssl = no\fR
6216 \fBssl CA certDir (G)\fR
6217 This variable is part of SSL-enabled Samba. This
6218 is only available if the SSL libraries have been compiled on your
6219 system and the configure option \fB--with-ssl\fR was
6220 given at configure time.
6222 This variable defines where to look up the Certification
6223 Authorities. The given directory should contain one file for
6224 each CA that Samba will trust. The file name must be the hash
6225 value over the "Distinguished Name" of the CA. How this directory
6226 is set up is explained later in this document. All files within the
6227 directory that don't fit into this naming scheme are ignored. You
6228 don't need this variable if you don't verify client certificates.
6230 Default: \fBssl CA certDir = /usr/local/ssl/certs
6232 \fBssl CA certFile (G)\fR
6233 This variable is part of SSL-enabled Samba. This
6234 is only available if the SSL libraries have been compiled on your
6235 system and the configure option \fB--with-ssl\fR was
6236 given at configure time.
6238 This variable is a second way to define the trusted CAs.
6239 The certificates of the trusted CAs are collected in one big
6240 file and this variable points to the file. You will probably
6241 only use one of the two ways to define your CAs. The first choice is
6242 preferable if you have many CAs or want to be flexible, the second
6243 is preferable if you only have one CA and want to keep things
6244 simple (you won't need to create the hashed file names). You
6245 don't need this variable if you don't verify client certificates.
6247 Default: \fBssl CA certFile = /usr/local/ssl/certs/trustedCAs.pem
6249 \fBssl ciphers (G)\fR
6250 This variable is part of SSL-enabled Samba. This
6251 is only available if the SSL libraries have been compiled on your
6252 system and the configure option \fB--with-ssl\fR was
6253 given at configure time.
6255 This variable defines the ciphers that should be offered
6256 during SSL negotiation. You should not set this variable unless
6257 you know what you are doing.
6259 \fBssl client cert (G)\fR
6260 This variable is part of SSL-enabled Samba. This
6261 is only available if the SSL libraries have been compiled on your
6262 system and the configure option \fB--with-ssl\fR was
6263 given at configure time.
6265 The certificate in this file is used by \fBsmbclient(1)\fRif it exists. It's needed
6266 if the server requires a client certificate.
6268 Default: \fBssl client cert = /usr/local/ssl/certs/smbclient.pem
6270 \fBssl client key (G)\fR
6271 This variable is part of SSL-enabled Samba. This
6272 is only available if the SSL libraries have been compiled on your
6273 system and the configure option \fB--with-ssl\fR was
6274 given at configure time.
6276 This is the private key for \fBsmbclient(1)\fR. It's only needed if the
6277 client should have a certificate.
6279 Default: \fBssl client key = /usr/local/ssl/private/smbclient.pem
6281 \fBssl compatibility (G)\fR
6282 This variable is part of SSL-enabled Samba. This
6283 is only available if the SSL libraries have been compiled on your
6284 system and the configure option \fB--with-ssl\fR was
6285 given at configure time.
6287 This variable defines whether OpenSSL should be configured
6288 for bug compatibility with other SSL implementations. This is
6289 probably not desirable because currently no clients with SSL
6290 implementations other than OpenSSL exist.
6292 Default: \fBssl compatibility = no\fR
6294 \fBssl egd socket (G)\fR
6295 This variable is part of SSL-enabled Samba. This
6296 is only available if the SSL libraries have been compiled on your
6297 system and the configure option \fB--with-ssl\fR was
6298 given at configure time.
6300 This option is used to define the location of the communiation socket of
6301 an EGD or PRNGD daemon, from which entropy can be retrieved. This option
6302 can be used instead of or together with the \fIssl entropy file\fR
6303 directive. 255 bytes of entropy will be retrieved from the daemon.
6307 \fBssl entropy bytes (G)\fR
6308 This variable is part of SSL-enabled Samba. This
6309 is only available if the SSL libraries have been compiled on your
6310 system and the configure option \fB--with-ssl\fR was
6311 given at configure time.
6313 This parameter is used to define the number of bytes which should
6314 be read from the \fIssl entropy
6315 file\fR If a -1 is specified, the entire file will
6318 Default: \fBssl entropy bytes = 255\fR
6320 \fBssl entropy file (G)\fR
6321 This variable is part of SSL-enabled Samba. This
6322 is only available if the SSL libraries have been compiled on your
6323 system and the configure option \fB--with-ssl\fR was
6324 given at configure time.
6326 This parameter is used to specify a file from which processes will
6327 read "random bytes" on startup. In order to seed the internal pseudo
6328 random number generator, entropy must be provided. On system with a
6329 \fI/dev/urandom\fR device file, the processes
6330 will retrieve its entropy from the kernel. On systems without kernel
6331 entropy support, a file can be supplied that will be read on startup
6332 and that will be used to seed the PRNG.
6337 See \fI ssl hosts resign\fR.
6339 \fBssl hosts resign (G)\fR
6340 This variable is part of SSL-enabled Samba. This
6341 is only available if the SSL libraries have been compiled on your
6342 system and the configure option \fB--with-ssl\fR was
6343 given at configure time.
6345 These two variables define whether Samba will go
6346 into SSL mode or not. If none of them is defined, Samba will
6347 allow only SSL connections. If the \fIssl hosts\fR variable lists
6348 hosts (by IP-address, IP-address range, net group or name),
6349 only these hosts will be forced into SSL mode. If the \fI ssl hosts resign\fR variable lists hosts, only these
6350 hosts will \fBNOT\fR be forced into SSL mode. The syntax for these two
6351 variables is the same as for the \fI hosts allow\fR and \fIhosts deny\fR pair of variables, only
6352 that the subject of the decision is different: It's not the access
6353 right but whether SSL is used or not.
6355 The example below requires SSL connections from all hosts
6356 outside the local net (which is 192.168.*.*).
6358 Default: \fBssl hosts = <empty string>\fR
6360 \fBssl hosts resign = <empty string>\fR
6362 Example: \fBssl hosts resign = 192.168.\fR
6364 \fBssl require clientcert (G)\fR
6365 This variable is part of SSL-enabled Samba. This
6366 is only available if the SSL libraries have been compiled on your
6367 system and the configure option \fB--with-ssl\fR was
6368 given at configure time.
6370 If this variable is set to yes, the
6371 server will not tolerate connections from clients that don't
6372 have a valid certificate. The directory/file given in \fIssl CA certDir\fR
6373 and \fIssl CA certFile
6374 \fRwill be used to look up the CAs that issued
6375 the client's certificate. If the certificate can't be verified
6376 positively, the connection will be terminated. If this variable
6377 is set to no, clients don't need certificates.
6378 Contrary to web applications you really \fBshould\fR
6379 require client certificates. In the web environment the client's
6380 data is sensitive (credit card numbers) and the server must prove
6381 to be trustworthy. In a file server environment the server's data
6382 will be sensitive and the clients must prove to be trustworthy.
6384 Default: \fBssl require clientcert = no\fR
6386 \fBssl require servercert (G)\fR
6387 This variable is part of SSL-enabled Samba. This
6388 is only available if the SSL libraries have been compiled on your
6389 system and the configure option \fB--with-ssl\fR was
6390 given at configure time.
6392 If this variable is set to yes, the
6394 will request a certificate from the server. Same as
6396 clientcert\fR for the server.
6398 Default: \fBssl require servercert = no\fR
6400 \fBssl server cert (G)\fR
6401 This variable is part of SSL-enabled Samba. This
6402 is only available if the SSL libraries have been compiled on your
6403 system and the configure option \fB--with-ssl\fR was
6404 given at configure time.
6406 This is the file containing the server's certificate.
6407 The server \fBmust\fR have a certificate. The
6408 file may also contain the server's private key. See later for
6409 how certificates and private keys are created.
6411 Default: \fBssl server cert = <empty string>
6413 \fBssl server key (G)\fR
6414 This variable is part of SSL-enabled Samba. This
6415 is only available if the SSL libraries have been compiled on your
6416 system and the configure option \fB--with-ssl\fR was
6417 given at configure time.
6419 This file contains the private key of the server. If
6420 this variable is not defined, the key is looked up in the
6421 certificate file (it may be appended to the certificate).
6422 The server \fBmust\fR have a private key
6423 and the certificate \fBmust\fR
6424 match this private key.
6426 Default: \fBssl server key = <empty string>
6428 \fBssl version (G)\fR
6429 This variable is part of SSL-enabled Samba. This
6430 is only available if the SSL libraries have been compiled on your
6431 system and the configure option \fB--with-ssl\fR was
6432 given at configure time.
6434 This enumeration variable defines the versions of the
6435 SSL protocol that will be used. ssl2or3 allows
6436 dynamic negotiation of SSL v2 or v3, ssl2 results
6437 in SSL v2, ssl3 results in SSL v3 and
6438 tls1 results in TLS v1. TLS (Transport Layer
6439 Security) is the new standard for SSL.
6441 Default: \fBssl version = "ssl2or3"\fR
6443 \fBstat cache (G)\fR
6444 This parameter determines if smbd(8)will use a cache in order to
6445 speed up case insensitive name mappings. You should never need
6446 to change this parameter.
6448 Default: \fBstat cache = yes\fR
6450 \fBstat cache size (G)\fR
6451 This parameter determines the number of
6452 entries in the \fIstat cache\fR. You should
6453 never need to change this parameter.
6455 Default: \fBstat cache size = 50\fR
6458 This enables or disables logging of connections
6459 to a status file that smbstatus(1)
6462 With this disabled \fBsmbstatus\fR won't be able
6463 to tell you what connections are active. You should never need to
6464 change this parameter.
6466 Default: \fBstatus = yes\fR
6468 \fBstrict allocate (S)\fR
6469 This is a boolean that controls the handling of
6470 disk space allocation in the server. When this is set to yes
6471 the server will change from UNIX behaviour of not committing real
6472 disk storage blocks when a file is extended to the Windows behaviour
6473 of actually forcing the disk system to allocate real storage blocks
6474 when a file is created or extended to be a given size. In UNIX
6475 terminology this means that Samba will stop creating sparse files.
6476 This can be slow on some systems.
6478 When strict allocate is no the server does sparse
6479 disk block allocation when a file is extended.
6481 Setting this to yes can help Samba return
6482 out of quota messages on systems that are restricting the disk quota
6485 Default: \fBstrict allocate = no\fR
6487 \fBstrict locking (S)\fR
6488 This is a boolean that controls the handling of
6489 file locking in the server. When this is set to yes
6490 the server will check every read and write access for file locks, and
6491 deny access if locks exist. This can be slow on some systems.
6493 When strict locking is no the server does file
6494 lock checks only when the client explicitly asks for them.
6496 Well-behaved clients always ask for lock checks when it
6497 is important, so in the vast majority of cases \fBstrict
6498 locking = no\fR is preferable.
6500 Default: \fBstrict locking = no\fR
6502 \fBstrict sync (S)\fR
6503 Many Windows applications (including the Windows
6504 98 explorer shell) seem to confuse flushing buffer contents to
6505 disk with doing a sync to disk. Under UNIX, a sync call forces
6506 the process to be suspended until the kernel has ensured that
6507 all outstanding data in kernel disk buffers has been safely stored
6508 onto stable storage. This is very slow and should only be done
6509 rarely. Setting this parameter to no (the
6510 default) means that smbdignores the Windows applications requests for
6511 a sync call. There is only a possibility of losing data if the
6512 operating system itself that Samba is running on crashes, so there is
6513 little danger in this default setting. In addition, this fixes many
6514 performance problems that people have reported with the new Windows98
6515 explorer shell file copies.
6517 See also the \fIsync
6518 always>\fR parameter.
6520 Default: \fBstrict sync = no\fR
6523 This is a boolean that controls whether to
6524 strip trailing dots off UNIX filenames. This helps with some
6525 CDROMs that have filenames ending in a single dot.
6527 Default: \fBstrip dot = no\fR
6529 \fBsync always (S)\fR
6530 This is a boolean parameter that controls
6531 whether writes will always be written to stable storage before
6532 the write call returns. If this is false then the server will be
6533 guided by the client's request in each write call (clients can
6534 set a bit indicating that a particular write should be synchronous).
6535 If this is true then every write will be followed by a \fBfsync()
6536 \fRcall to ensure the data is written to disk. Note that
6537 the \fIstrict sync\fR parameter must be set to
6538 yes in order for this parameter to have
6541 See also the \fIstrict
6544 Default: \fBsync always = no\fR
6547 This parameter maps how Samba debug messages
6548 are logged onto the system syslog logging levels. Samba debug
6549 level zero maps onto syslog LOG_ERR, debug
6550 level one maps onto LOG_WARNING, debug level
6551 two maps onto LOG_NOTICE, debug level three
6552 maps onto LOG_INFO. All higher levels are mapped to LOG_DEBUG.
6554 This parameter sets the threshold for sending messages
6555 to syslog. Only messages with debug level less than this value
6556 will be sent to syslog.
6558 Default: \fBsyslog = 1\fR
6560 \fBsyslog only (G)\fR
6561 If this parameter is set then Samba debug
6562 messages are logged into the system syslog only, and not to
6563 the debug log files.
6565 Default: \fBsyslog only = no\fR
6567 \fBtemplate homedir (G)\fR
6568 When filling out the user information for a Windows NT
6569 user, the winbindd(8)daemon
6570 uses this parameter to fill in the home directory for that user.
6571 If the string \fI%D\fR is present it is substituted
6572 with the user's Windows NT domain name. If the string \fI%U
6573 \fRis present it is substituted with the user's Windows
6576 Default: \fBtemplate homedir = /home/%D/%U\fR
6578 \fBtemplate shell (G)\fR
6579 When filling out the user information for a Windows NT
6580 user, the winbindd(8)daemon
6581 uses this parameter to fill in the login shell for that user.
6583 Default: \fBtemplate shell = /bin/false\fR
6585 \fBtime offset (G)\fR
6586 This parameter is a setting in minutes to add
6587 to the normal GMT to local time conversion. This is useful if
6588 you are serving a lot of PCs that have incorrect daylight
6589 saving time handling.
6591 Default: \fBtime offset = 0\fR
6593 Example: \fBtime offset = 60\fR
6595 \fBtime server (G)\fR
6596 This parameter determines if
6597 nmbd(8)advertises itself as a time server to Windows
6600 Default: \fBtime server = no\fR
6602 \fBtimestamp logs (G)\fR
6603 Synonym for \fI debug timestamp\fR.
6605 \fBtotal print jobs (G)\fR
6606 This parameter accepts an integer value which defines
6607 a limit on the maximum number of print jobs that will be accepted
6608 system wide at any given time. If a print job is submitted
6609 by a client which will exceed this number, then smbdwill return an
6610 error indicating that no space is available on the server. The
6611 default value of 0 means that no such limit exists. This parameter
6612 can be used to prevent a server from exceeding its capacity and is
6613 designed as a printing throttle. See also
6614 \fImax print jobs\fR.
6616 Default: \fBtotal print jobs = 0\fR
6618 Example: \fBtotal print jobs = 5000\fR
6620 \fBunix password sync (G)\fR
6621 This boolean parameter controls whether Samba
6622 attempts to synchronize the UNIX password with the SMB password
6623 when the encrypted SMB password in the smbpasswd file is changed.
6624 If this is set to true the program specified in the \fIpasswd
6625 program\fRparameter is called \fBAS ROOT\fR -
6626 to allow the new UNIX password to be set without access to the
6627 old UNIX password (as the SMB password change code has no
6628 access to the old password cleartext, only the new).
6631 program\fR, \fI passwd chat\fR.
6633 Default: \fBunix password sync = no\fR
6635 \fBupdate encrypted (G)\fR
6636 This boolean parameter allows a user logging
6637 on with a plaintext password to have their encrypted (hashed)
6638 password in the smbpasswd file to be updated automatically as
6639 they log on. This option allows a site to migrate from plaintext
6640 password authentication (users authenticate with plaintext
6641 password over the wire, and are checked against a UNIX account
6642 database) to encrypted password authentication (the SMB
6643 challenge/response authentication mechanism) without forcing
6644 all users to re-enter their passwords via smbpasswd at the time the
6645 change is made. This is a convenience option to allow the change over
6646 to encrypted passwords to be made over a longer period. Once all users
6647 have encrypted representations of their passwords in the smbpasswd
6648 file this parameter should be set to no.
6650 In order for this parameter to work correctly the \fIencrypt passwords\fR
6651 parameter must be set to no when
6652 this parameter is set to yes.
6654 Note that even when this parameter is set a user
6655 authenticating to \fBsmbd\fR must still enter a valid
6656 password in order to connect correctly, and to update their hashed
6657 (smbpasswd) passwords.
6659 Default: \fBupdate encrypted = no\fR
6661 \fBuse client driver (S)\fR
6662 This parameter applies only to Windows NT/2000
6663 clients. It has no affect on Windows 95/98/ME clients. When
6664 serving a printer to Windows NT/2000 clients without first installing
6665 a valid printer driver on the Samba host, the client will be required
6666 to install a local printer driver. From this point on, the client
6667 will treat the print as a local printer and not a network printer
6668 connection. This is much the same behavior that will occur
6669 when \fBdisable spoolss = yes\fR.
6672 factor is that under normal circumstances, the NT/2000 client will
6673 attempt to open the network printer using MS-RPC. The problem is that
6674 because the client considers the printer to be local, it will attempt
6675 to issue the OpenPrinterEx() call requesting access rights associated
6676 with the logged on user. If the user possesses local administator rights
6677 but not root privilegde on the Samba host (often the case), the OpenPrinterEx()
6678 call will fail. The result is that the client will now display an "Access
6679 Denied; Unable to connect" message in the printer queue window (even though
6680 jobs may successfully be printed).
6682 If this parameter is enabled for a printer, then any attempt
6683 to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped
6684 to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx()
6685 call to succeed. \fBThis parameter MUST not be able enabled
6686 on a print share which has valid print driver installed on the Samba
6689 See also disable spoolss
6691 Default: \fBuse client driver = no\fR
6694 This global parameter determines if the tdb internals of Samba can
6695 depend on mmap working correctly on the running system. Samba requires a coherent
6696 mmap/read-write system memory cache. Currently only HPUX does not have such a
6697 coherent cache, and so this parameter is set to false by
6698 default on HPUX. On all other systems this parameter should be left alone. This
6699 parameter is provided to help the Samba developers track down problems with
6700 the tdb internal code.
6702 Default: \fBuse mmap = yes\fR
6704 \fBuse rhosts (G)\fR
6705 If this global parameter is true, it specifies
6706 that the UNIX user's \fI.rhosts\fR file in their home directory
6707 will be read to find the names of hosts and users who will be allowed
6708 access without specifying a password.
6710 \fBNOTE:\fR The use of \fIuse rhosts
6711 \fRcan be a major security hole. This is because you are
6712 trusting the PC to supply the correct username. It is very easy to
6713 get a PC to supply a false username. I recommend that the \fI use rhosts\fR option be only used if you really know what
6716 Default: \fBuse rhosts = no\fR
6719 Synonym for \fI username\fR.
6722 Synonym for \fI username\fR.
6725 Multiple users may be specified in a comma-delimited
6726 list, in which case the supplied password will be tested against
6727 each username in turn (left to right).
6729 The \fIusername\fR line is needed only when
6730 the PC is unable to supply its own username. This is the case
6731 for the COREPLUS protocol or where your users have different WfWg
6732 usernames to UNIX usernames. In both these cases you may also be
6733 better using the \\\\server\\share%user syntax instead.
6735 The \fIusername\fR line is not a great
6736 solution in many cases as it means Samba will try to validate
6737 the supplied password against each of the usernames in the
6738 \fIusername\fR line in turn. This is slow and
6739 a bad idea for lots of users in case of duplicate passwords.
6740 You may get timeouts or security breaches using this parameter
6743 Samba relies on the underlying UNIX security. This
6744 parameter does not restrict who can login, it just offers hints
6745 to the Samba server as to what usernames might correspond to the
6746 supplied password. Users can login as whoever they please and
6747 they will be able to do no more damage than if they started a
6748 telnet session. The daemon runs as the user that they log in as,
6749 so they cannot do anything that user cannot do.
6751 To restrict a service to a particular set of users you
6752 can use the \fIvalid users
6755 If any of the usernames begin with a '@' then the name
6756 will be looked up first in the NIS netgroups list (if Samba
6757 is compiled with netgroup support), followed by a lookup in
6758 the UNIX groups database and will expand to a list of all users
6759 in the group of that name.
6761 If any of the usernames begin with a '+' then the name
6762 will be looked up only in the UNIX groups database and will
6763 expand to a list of all users in the group of that name.
6765 If any of the usernames begin with a '&'then the name
6766 will be looked up only in the NIS netgroups database (if Samba
6767 is compiled with netgroup support) and will expand to a list
6768 of all users in the netgroup group of that name.
6770 Note that searching though a groups database can take
6771 quite some time, and some clients may time out during the
6774 See the section NOTE ABOUT
6775 USERNAME/PASSWORD VALIDATION for more information on how
6776 this parameter determines access to the services.
6778 Default: \fBThe guest account if a guest service,
6779 else <empty string>.\fR
6781 Examples:\fBusername = fred, mary, jack, jane,
6784 \fBusername level (G)\fR
6785 This option helps Samba to try and 'guess' at
6786 the real UNIX username, as many DOS clients send an all-uppercase
6787 username. By default Samba tries all lowercase, followed by the
6788 username with the first letter capitalized, and fails if the
6789 username is not found on the UNIX machine.
6791 If this parameter is set to non-zero the behavior changes.
6792 This parameter is a number that specifies the number of uppercase
6793 combinations to try while trying to determine the UNIX user name. The
6794 higher the number the more combinations will be tried, but the slower
6795 the discovery of usernames will be. Use this parameter when you have
6796 strange usernames on your UNIX machine, such as AstrangeUser
6799 Default: \fBusername level = 0\fR
6801 Example: \fBusername level = 5\fR
6803 \fBusername map (G)\fR
6804 This option allows you to specify a file containing
6805 a mapping of usernames from the clients to the server. This can be
6806 used for several purposes. The most common is to map usernames
6807 that users use on DOS or Windows machines to those that the UNIX
6808 box uses. The other is to map multiple users to a single username
6809 so that they can more easily share files.
6811 The map file is parsed line by line. Each line should
6812 contain a single UNIX username on the left then a '=' followed
6813 by a list of usernames on the right. The list of usernames on the
6814 right may contain names of the form @group in which case they
6815 will match any UNIX username in that group. The special client
6816 name '*' is a wildcard and matches any name. Each line of the
6817 map file may be up to 1023 characters long.
6819 The file is processed on each line by taking the
6820 supplied username and comparing it with each username on the right
6821 hand side of the '=' signs. If the supplied name matches any of
6822 the names on the right hand side then it is replaced with the name
6823 on the left. Processing then continues with the next line.
6825 If any line begins with a '#' or a ';' then it is
6828 If any line begins with an '!' then the processing
6829 will stop after that line if a mapping was done by the line.
6830 Otherwise mapping continues with every line being processed.
6831 Using '!' is most useful when you have a wildcard mapping line
6834 For example to map from the name admin
6835 or administrator to the UNIX name root you would use:
6837 \fBroot = admin administrator\fR
6839 Or to map anyone in the UNIX group system
6840 to the UNIX name sys you would use:
6844 You can have as many mappings as you like in a username
6847 If your system supports the NIS NETGROUP option then
6848 the netgroup database is checked before the \fI/etc/group
6849 \fRdatabase for matching groups.
6851 You can map Windows usernames that have spaces in them
6852 by using double quotes around the name. For example:
6854 \fBtridge = "Andrew Tridgell"\fR
6856 would map the windows username "Andrew Tridgell" to the
6857 unix username "tridge".
6859 The following example would map mary and fred to the
6860 unix user sys, and map the rest to guest. Note the use of the
6861 \&'!' to tell Samba to stop processing if it gets a match on
6872 Note that the remapping is applied to all occurrences
6873 of usernames. Thus if you connect to \\\\server\\fred and fred is remapped to mary then you
6874 will actually be connecting to \\\\server\\mary and will need to
6875 supply a password suitable for mary not
6876 fred. The only exception to this is the
6877 username passed to the \fI password server\fR (if you have one). The password
6878 server will receive whatever username the client supplies without
6881 Also note that no reverse mapping is done. The main effect
6882 this has is with printing. Users who have been mapped may have
6883 trouble deleting print jobs as PrintManager under WfWg will think
6884 they don't own the print job.
6886 Default: \fBno username map\fR
6888 Example: \fBusername map = /usr/local/samba/lib/users.map
6891 This boolean parameter is only available if
6892 Samba has been configured and compiled with the option \fB --with-utmp\fR. If set to true then Samba will attempt
6893 to add utmp or utmpx records (depending on the UNIX system) whenever a
6894 connection is made to a Samba server. Sites may use this to record the
6895 user connecting to a Samba share.
6897 See also the \fI utmp directory\fR parameter.
6899 Default: \fButmp = no\fR
6901 \fButmp directory(G)\fR
6902 This parameter is only available if Samba has
6903 been configured and compiled with the option \fB --with-utmp\fR. It specifies a directory pathname that is
6904 used to store the utmp or utmpx files (depending on the UNIX system) that
6905 record user connections to a Samba server. See also the \fIutmp\fR parameter. By default this is
6906 not set, meaning the system will use whatever utmp file the
6907 native system is set to use (usually
6908 \fI/var/run/utmp\fR on Linux).
6910 Default: \fBno utmp directory\fR
6912 \fBvalid chars (G)\fR
6913 The option allows you to specify additional
6914 characters that should be considered valid by the server in
6915 filenames. This is particularly useful for national character
6916 sets, such as adding u-umlaut or a-ring.
6918 The option takes a list of characters in either integer
6919 or character form with spaces between them. If you give two
6920 characters with a colon between them then it will be taken as
6921 an lowercase:uppercase pair.
6923 If you have an editor capable of entering the characters
6924 into the config file then it is probably easiest to use this
6925 method. Otherwise you can specify the characters in octal,
6926 decimal or hexadecimal form using the usual C notation.
6928 For example to add the single character 'Z' to the charset
6929 (which is a pointless thing to do as it's already there) you could
6930 do one of the following
6936 valid chars = 0132:0172
6941 The last two examples above actually add two characters,
6942 and alter the uppercase and lowercase mappings appropriately.
6944 Note that you \fBMUST\fR specify this parameter
6945 after the \fIclient code page\fR parameter if you
6946 have both set. If \fIclient code page\fR is set after
6947 the \fIvalid chars\fR parameter the \fIvalid
6948 chars\fR settings will be overwritten.
6950 See also the \fIclient
6951 code page\fR parameter.
6953 Default: \fBSamba defaults to using a reasonable set
6954 of valid characters for English systems\fR
6956 Example: \fBvalid chars = 0345:0305 0366:0326 0344:0304
6958 The above example allows filenames to have the Swedish
6961 \fBNOTE:\fR It is actually quite difficult to
6962 correctly produce a \fIvalid chars\fR line for
6963 a particular system. To automate the process tino@augsburg.net <URL:mailto:tino@augsburg.net> has written
6964 a package called \fBvalidchars\fR which will automatically
6965 produce a complete \fIvalid chars\fR line for
6966 a given client system. Look in the \fIexamples/validchars/
6967 \fRsubdirectory of your Samba source code distribution
6970 \fBvalid users (S)\fR
6971 This is a list of users that should be allowed
6972 to login to this service. Names starting with '@', '+' and '&'
6973 are interpreted using the same rules as described in the
6974 \fIinvalid users\fR parameter.
6976 If this is empty (the default) then any user can login.
6977 If a username is in both this list and the \fIinvalid
6978 users\fR list then access is denied for that user.
6980 The current servicename is substituted for \fI%S
6981 \fR\&. This is useful in the [homes] section.
6983 See also \fIinvalid users
6985 Default: \fBNo valid users list (anyone can login)
6987 Example: \fBvalid users = greg, @pcusers\fR
6990 This is a list of files and directories that
6991 are neither visible nor accessible. Each entry in the list must
6992 be separated by a '/', which allows spaces to be included
6993 in the entry. '*' and '?' can be used to specify multiple files
6994 or directories as in DOS wildcards.
6996 Each entry must be a unix path, not a DOS path and
6997 must \fBnot\fR include the unix directory
7000 Note that the \fIcase sensitive\fR option
7001 is applicable in vetoing files.
7003 One feature of the veto files parameter that it
7004 is important to be aware of is Samba's behaviour when
7005 trying to delete a directory. If a directory that is
7006 to be deleted contains nothing but veto files this
7007 deletion will \fBfail\fR unless you also set
7008 the \fIdelete veto files\fR parameter to
7011 Setting this parameter will affect the performance
7012 of Samba, as it will be forced to check all files and directories
7013 for a match as they are scanned.
7015 See also \fIhide files
7016 \fRand \fI case sensitive\fR.
7018 Default: \fBNo files or directories are vetoed.
7023 ; Veto any files containing the word Security,
7024 ; any ending in .tmp, and any directory containing the
7026 veto files = /*Security*/*.tmp/*root*/
7028 ; Veto the Apple specific files that a NetAtalk server
7030 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
7034 \fBveto oplock files (S)\fR
7035 This parameter is only valid when the \fIoplocks\fR
7036 parameter is turned on for a share. It allows the Samba administrator
7037 to selectively turn off the granting of oplocks on selected files that
7038 match a wildcarded list, similar to the wildcarded list used in the
7042 Default: \fBNo files are vetoed for oplock
7045 You might want to do this on files that you know will
7046 be heavily contended for by clients. A good example of this
7047 is in the NetBench SMB benchmark program, which causes heavy
7048 client contention for files ending in \fI.SEM\fR.
7049 To cause Samba not to grant oplocks on these files you would use
7050 the line (either in the [global] section or in the section for
7051 the particular NetBench share :
7053 Example: \fBveto oplock files = /*.SEM/
7055 \fBvfs object (S)\fR
7056 This parameter specifies a shared object file that
7057 is used for Samba VFS I/O operations. By default, normal
7058 disk I/O operations are used but these can be overloaded
7059 with a VFS object. The Samba VFS layer is new to Samba 2.2 and
7060 must be enabled at compile time with --with-vfs.
7062 Default : \fBno value\fR
7064 \fBvfs options (S)\fR
7065 This parameter allows parameters to be passed
7066 to the vfs layer at initialization time. The Samba VFS layer
7067 is new to Samba 2.2 and must be enabled at compile time
7068 with --with-vfs. See also \fI vfs object\fR.
7070 Default : \fBno value\fR
7073 This allows you to override the volume label
7074 returned for a share. Useful for CDROMs with installation programs
7075 that insist on a particular volume label.
7077 Default: \fBthe name of the share\fR
7079 \fBwide links (S)\fR
7080 This parameter controls whether or not links
7081 in the UNIX file system may be followed by the server. Links
7082 that point to areas within the directory tree exported by the
7083 server are always allowed; this parameter controls access only
7084 to areas that are outside the directory tree being exported.
7086 Note that setting this parameter can have a negative
7087 effect on your server performance due to the extra system calls
7088 that Samba has to do in order to perform the link checks.
7090 Default: \fBwide links = yes\fR
7092 \fBwinbind cache time\fR
7093 This parameter specifies the number of seconds the
7094 winbindd(8)daemon will cache
7095 user and group information before querying a Windows NT server
7098 Default: \fBwinbind cache type = 15\fR
7100 \fBwinbind enum users\fR
7101 On large installations using
7102 winbindd(8)it may be
7103 necessary to suppress the enumeration of users through the
7105 \fBgetpwent()\fR and
7106 \fBendpwent()\fR group of system calls. If
7107 the \fIwinbind enum users\fR parameter is
7108 false, calls to the \fBgetpwent\fR system call
7109 will not return any data.
7111 \fBWarning:\fR Turning off user
7112 enumeration may cause some programs to behave oddly. For
7113 example, the finger program relies on having access to the
7114 full user list when searching for matching
7117 Default: \fBwinbind enum users = yes \fR
7119 \fBwinbind enum groups\fR
7120 On large installations using
7121 winbindd(8)it may be
7122 necessary to suppress the enumeration of groups through the
7124 \fBgetgrent()\fR and
7125 \fBendgrent()\fR group of system calls. If
7126 the \fIwinbind enum groups\fR parameter is
7127 false, calls to the \fBgetgrent()\fR system
7128 call will not return any data.
7130 \fBWarning:\fR Turning off group
7131 enumeration may cause some programs to behave oddly.
7133 Default: \fBwinbind enum groups = yes \fR
7136 The winbind gid parameter specifies the range of group
7137 ids that are allocated by the winbindd(8)daemon. This range of group ids should have no
7138 existing local or NIS groups within it as strange conflicts can
7141 Default: \fBwinbind gid = <empty string>
7143 Example: \fBwinbind gid = 10000-20000\fR
7145 \fBwinbind separator\fR
7146 This parameter allows an admin to define the character
7147 used when listing a username of the form of \fIDOMAIN
7148 \fR\\\fIuser\fR. This parameter
7149 is only applicable when using the \fIpam_winbind.so\fR
7150 and \fInss_winbind.so\fR modules for UNIX services.
7152 Example: \fBwinbind separator = \\\fR
7154 Example: \fBwinbind separator = +\fR
7157 The winbind gid parameter specifies the range of group
7158 ids that are allocated by the winbindd(8)daemon. This range of ids should have no
7159 existing local or NIS users within it as strange conflicts can
7162 Default: \fBwinbind uid = <empty string>
7164 Example: \fBwinbind uid = 10000-20000\fR
7167 When Samba is running as a WINS server this
7168 allows you to call an external program for all changes to the
7169 WINS database. The primary use for this option is to allow the
7170 dynamic update of external name resolution databases such as
7173 The wins hook parameter specifies the name of a script
7174 or executable that will be called as follows:
7176 \fBwins_hook operation name nametype ttl IP_list
7180 The first argument is the operation and is one
7181 of "add", "delete", or "refresh". In most cases the operation can
7182 be ignored as the rest of the parameters provide sufficient
7183 information. Note that "refresh" may sometimes be called when the
7184 name has not previously been added, in that case it should be treated
7188 The second argument is the NetBIOS name. If the
7189 name is not a legal name then the wins hook is not called.
7190 Legal names contain only letters, digits, hyphens, underscores
7194 The third argument is the NetBIOS name
7195 type as a 2 digit hexadecimal number.
7198 The fourth argument is the TTL (time to live)
7199 for the name in seconds.
7202 The fifth and subsequent arguments are the IP
7203 addresses currently registered for that name. If this list is
7204 empty then the name should be deleted.
7207 An example script that calls the BIND dynamic DNS update
7208 program \fBnsupdate\fR is provided in the examples
7209 directory of the Samba source code.
7212 \fBwins proxy (G)\fR
7213 This is a boolean that controls if nmbd(8)will respond to broadcast name
7214 queries on behalf of other hosts. You may need to set this
7215 to yes for some older clients.
7217 Default: \fBwins proxy = no\fR
7219 \fBwins server (G)\fR
7220 This specifies the IP address (or DNS name: IP
7221 address for preference) of the WINS server that nmbd(8)should register with. If you have a WINS server on
7222 your network then you should set this to the WINS server's IP.
7224 You should point this at your WINS server if you have a
7225 multi-subnetted network.
7227 \fBNOTE\fR. You need to set up Samba to point
7228 to a WINS server if you have multiple subnets and wish cross-subnet
7229 browsing to work correctly.
7231 See the documentation file \fIBROWSING.txt\fR
7232 in the docs/ directory of your Samba source distribution.
7234 Default: \fBnot enabled\fR
7236 Example: \fBwins server = 192.9.200.1\fR
7238 \fBwins support (G)\fR
7239 This boolean controls if the
7240 nmbd(8)process in Samba will act as a WINS server. You should
7241 not set this to true unless you have a multi-subnetted network and
7242 you wish a particular \fBnmbd\fR to be your WINS server.
7243 Note that you should \fBNEVER\fR set this to true
7244 on more than one machine in your network.
7246 Default: \fBwins support = no\fR
7249 This controls what workgroup your server will
7250 appear to be in when queried by clients. Note that this parameter
7251 also controls the Domain name used with the \fBsecurity = domain\fR
7254 Default: \fBset at compile time to WORKGROUP\fR
7256 Example: \fBworkgroup = MYGROUP\fR
7259 Synonym for \fI writeable\fR for people who can't spell :-).
7261 \fBwrite cache size (S)\fR
7262 If this integer parameter is set to non-zero value,
7263 Samba will create an in-memory cache for each oplocked file
7264 (it does \fBnot\fR do this for
7265 non-oplocked files). All writes that the client does not request
7266 to be flushed directly to disk will be stored in this cache if possible.
7267 The cache is flushed onto disk when a write comes in whose offset
7268 would not fit into the cache or when the file is closed by the client.
7269 Reads for the file are also served from this cache if the data is stored
7272 This cache allows Samba to batch client writes into a more
7273 efficient write size for RAID disks (i.e. writes may be tuned to
7274 be the RAID stripe size) and can improve performance on systems
7275 where the disk subsystem is a bottleneck but there is free
7276 memory for userspace programs.
7278 The integer parameter specifies the size of this cache
7279 (per oplocked file) in bytes.
7281 Default: \fBwrite cache size = 0\fR
7283 Example: \fBwrite cache size = 262144\fR
7285 for a 256k cache size per file.
7287 \fBwrite list (S)\fR
7288 This is a list of users that are given read-write
7289 access to a service. If the connecting user is in this list then
7290 they will be given write access, no matter what the \fIwriteable\fR
7291 option is set to. The list can include group names using the
7294 Note that if a user is in both the read list and the
7295 write list then they will be given write access.
7297 See also the \fIread list
7300 Default: \fBwrite list = <empty string>
7302 Example: \fBwrite list = admin, root, @staff
7305 Synonym for \fI writeable\fR.
7308 This parameter controls whether or not the server
7309 will support raw write SMB's when transferring data from clients.
7310 You should never need to change this parameter.
7312 Default: \fBwrite raw = yes\fR
7315 An inverted synonym is \fIread only\fR.
7317 If this parameter is no, then users
7318 of a service may not create or modify files in the service's
7321 Note that a printable service (\fBprintable = yes\fR)
7322 will \fBALWAYS\fR allow writing to the directory
7323 (user privileges permitting), but only via spooling operations.
7325 Default: \fBwriteable = no\fR
7328 Although the configuration file permits service names
7329 to contain spaces, your client software may not. Spaces will
7330 be ignored in comparisons anyway, so it shouldn't be a
7331 problem - but be aware of the possibility.
7333 On a similar note, many clients - especially DOS clients -
7334 limit service names to eight characters. smbd(8)
7335 has no such limitation, but attempts to connect from such
7336 clients will fail if they truncate the service names. For this reason
7337 you should probably keep your service names down to eight characters
7340 Use of the [homes] and [printers] special sections make life
7341 for an administrator easy, but the various combinations of default
7342 attributes can be tricky. Take extreme care when designing these
7343 sections. In particular, ensure that the permissions on spool
7344 directories are correct.
7347 This man page is correct for version 2.2 of
7362 The original Samba software and related utilities
7363 were created by Andrew Tridgell. Samba is now developed
7364 by the Samba Team as an Open Source project similar
7365 to the way the Linux kernel is developed.
7367 The original Samba man pages were written by Karl Auer.
7368 The man page sources were converted to YODL format (another
7369 excellent piece of Open Source software, available at
7370 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0
7371 release by Jeremy Allison. The conversion to DocBook for
7372 Samba 2.2 was done by Gerald Carter