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" "08 May 2002" "" ""
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".
364 Note that this paramater is not available when Samba listens
365 on port 445, as clients no longer send this information
368 the Internet name of the client machine.
371 the name of your NIS home directory server.
372 This is obtained from your NIS auto.map entry. If you have
373 not compiled Samba with the \fB--with-automount\fR
374 option then this value will be the same as %L.
377 the path of the service's home directory,
378 obtained from your NIS auto.map entry. The NIS auto.map entry
379 is split up as "%N:%p".
382 the selected protocol level after
383 protocol negotiation. It can be one of CORE, COREPLUS,
384 LANMAN1, LANMAN2 or NT1.
387 The process id of the current server
391 the architecture of the remote
392 machine. Only some are recognized, and those may not be
393 100% reliable. It currently recognizes Samba, WfWg, Win95,
394 WinNT and Win2k. Anything else will be known as
395 "UNKNOWN". If it gets it wrong then sending a level
396 3 log to samba@samba.org
397 <URL:mailto:samba@samba.org> should allow it to be fixed.
400 The IP address of the client machine.
403 the current date and time.
405 \fB%$(\fIenvvar\fB)\fR
406 The value of the environment variable
409 There are some quite creative things that can be done
410 with these substitutions and other smb.conf options.
414 Samba supports "name mangling" so that DOS and
415 Windows clients can use files that don't conform to the 8.3 format.
416 It can also be set to adjust the case of 8.3 format filenames.
418 There are several options that control the way mangling is
419 performed, and they are grouped here rather than listed separately.
420 For the defaults look at the output of the testparm program.
422 All of these options can be set separately for each service
423 (or globally, of course).
427 \fBmangle case = yes/no\fR
428 controls if names that have characters that
429 aren't of the "default" case are mangled. For example,
430 if this is yes then a name like "Mail" would be mangled.
433 \fBcase sensitive = yes/no\fR
434 controls whether filenames are case sensitive. If
435 they aren't then Samba must do a filename search and match on passed
436 names. Default \fBno\fR.
438 \fBdefault case = upper/lower\fR
439 controls what the default case is for new
440 filenames. Default \fBlower\fR.
442 \fBpreserve case = yes/no\fR
443 controls if new files are created with the
444 case that the client passes, or if they are forced to be the
445 "default" case. Default \fByes\fR.
447 \fBshort preserve case = yes/no\fR
448 controls if new files which conform to 8.3 syntax,
449 that is all in upper case and of suitable length, are created
450 upper case, or if they are forced to be the "default"
451 case. This option can be use with "preserve case = yes"
452 to permit long filenames to retain their case, while short names
453 are lowercased. Default \fByes\fR.
455 By default, Samba 2.2 has the same semantics as a Windows
456 NT server, in that it is case insensitive but case preserving.
458 .SH "NOTE ABOUT USERNAME/PASSWORD VALIDATION"
460 There are a number of ways in which a user can connect
461 to a service. The server uses the following steps in determining
462 if it will allow a connection to a specified service. If all the
463 steps fail, then the connection request is rejected. However, if one of the
464 steps succeeds, then the following steps are not checked.
466 If the service is marked "guest only = yes" and the
467 server is running with share-level security ("security = share")
468 then steps 1 to 5 are skipped.
470 If the client has passed a username/password
471 pair and that username/password pair is validated by the UNIX
472 system's password programs then the connection is made as that
473 username. Note that this includes the
474 \\\\server\\service%\fIusername\fR method of passing
477 If the client has previously registered a username
478 with the system and now supplies a correct password for that
479 username then the connection is allowed.
481 The client's NetBIOS name and any previously
482 used user names are checked against the supplied password, if
483 they match then the connection is allowed as the corresponding
486 If the client has previously validated a
487 username/password pair with the server and the client has passed
488 the validation token then that username is used.
490 If a "user = " field is given in the
491 \fIsmb.conf\fR file for the service and the client
492 has supplied a password, and that password matches (according to
493 the UNIX system's password checking) with one of the usernames
494 from the "user =" field then the connection is made as
495 the username in the "user =" line. If one
496 of the username in the "user =" list begins with a
497 \&'@' then that name expands to a list of names in
498 the group of the same name.
500 If the service is a guest service then a
501 connection is made as the username given in the "guest
502 account =" for the service, irrespective of the
504 .SH "COMPLETE LIST OF GLOBAL PARAMETERS"
506 Here is a list of all global parameters. See the section of
507 each parameter for details. Note that some are synonyms.
510 \fIabort shutdown script\fR
513 \fIadd printer command\fR
516 \fIadd share command\fR
519 \fIadd user script\fR
522 \fIadd machine script\fR
525 \fIalgorithmic rid base\fR
528 \fIallow trusted domains\fR
534 \fIannounce version\fR
543 \fIbind interfaces only\fR
549 \fIchange notify timeout\fR
552 \fIchange share command\fR
561 \fIdebug hires timestamp\fR
567 \fIdebug timestamp\fR
579 \fIdefault service\fR
582 \fIdelete printer command\fR
585 \fIdelete share command\fR
588 \fIdelete user script\fR
594 \fIdisable spoolss\fR
600 \fIdomain admin group\fR
603 \fIdomain guest group\fR
612 \fIencrypt passwords\fR
615 \fIenhanced browsing\fR
618 \fIenumports command\fR
624 \fIhide local users\fR
627 \fIhide unreadable\fR
651 \fIlarge readwrite\fR
690 \fIlock spin count\fR
720 \fImachine password timeout\fR
744 \fImax smbd processes\fR
756 \fImessage command\fR
759 \fImin passwd length\fR
762 \fImin password length\fR
771 \fIname resolve order\fR
774 \fInetbios aliases\fR
786 \fInon unix account range\fR
789 \fInt pipe support\fR
792 \fInt status support\fR
798 \fIobey pam restrictions\fR
801 \fIoplock break wait time\fR
810 \fIpam password change\fR
822 \fIpasswd chat debug\fR
831 \fIpassword server\fR
834 \fIprefered master\fR
837 \fIpreferred master\fR
849 \fIprinter driver file\fR
867 \fIremote announce\fR
870 \fIremote browse sync\fR
873 \fIrestrict anonymous\fR
891 \fIshow add printer wizard\fR
894 \fIshutdown script\fR
897 \fIsmb passwd file\fR
906 \fIsource environment\fR
915 \fIssl CA certFile\fR
921 \fIssl client cert\fR
927 \fIssl compatibility\fR
933 \fIssl entropy bytes\fR
936 \fIssl entropy file\fR
942 \fIssl hosts resign\fR
945 \fIssl require clientcert\fR
948 \fIssl require servercert\fR
951 \fIssl server cert\fR
963 \fIstat cache size\fR
975 \fItemplate homedir\fR
990 \fItotal print jobs\fR
993 \fIunix extensions\fR
996 \fIunix password sync\fR
999 \fIupdate encrypted\fR
1008 \fIusername level\fR
1017 \fIutmp directory\fR
1020 \fIwinbind cache time\fR
1023 \fIwinbind enum users\fR
1026 \fIwinbind enum groups\fR
1032 \fIwinbind separator\fR
1038 \fIwinbind use default domain\fR
1057 .SH "COMPLETE LIST OF SERVICE PARAMETERS"
1059 Here is a list of all service parameters. See the section on
1060 each parameter for details. Note that some are synonyms.
1072 \fIblocking locks\fR
1081 \fIcase sensitive\fR
1105 \fIdefault devmode\fR
1108 \fIdelete readonly\fR
1111 \fIdelete veto files\fR
1120 \fIdirectory mask\fR
1123 \fIdirectory mode\fR
1126 \fIdirectory security mask\fR
1135 \fIdos filetime resolution\fR
1144 \fIfake directory create times\fR
1150 \fIfollow symlinks\fR
1153 \fIforce create mode\fR
1156 \fIforce directory mode\fR
1159 \fIforce directory security mode\fR
1165 \fIforce security mode\fR
1186 \fIhide dot files\fR
1204 \fIinherit permissions\fR
1210 \fIlevel2 oplocks\fR
1216 \fIlppause command\fR
1222 \fIlpresume command\fR
1255 \fImax connections\fR
1258 \fImax print jobs\fR
1261 \fImin print space\fR
1267 \fInt acl support\fR
1276 \fIoplock contention limit\fR
1318 \fIprinter driver\fR
1321 \fIprinter driver location\fR
1333 \fIqueuepause command\fR
1336 \fIqueueresume command\fR
1351 \fIroot preexec close\fR
1363 \fIshort preserve case\fR
1369 \fIstrict allocate\fR
1372 \fIstrict locking\fR
1381 \fIuse client driver\fR
1399 \fIveto oplock files\fR
1417 \fIwrite cache size\fR
1427 .SH "EXPLANATION OF EACH PARAMETER"
1429 \fBabort shutdown script (G)\fR
1430 \fBThis parameter only exists in the HEAD cvs branch\fR
1431 This a full path name to a script called by
1433 should stop a shutdown procedure issued by the \fIshutdown script\fR.
1435 This command will be run as user.
1437 Default: \fBNone\fR.
1439 Example: \fBabort shutdown script = /sbin/shutdown -c\fR
1441 \fBadd printer command (G)\fR
1442 With the introduction of MS-RPC based printing
1443 support for Windows NT/2000 clients in Samba 2.2, The MS Add
1444 Printer Wizard (APW) icon is now also available in the
1445 "Printers..." folder displayed a share listing. The APW
1446 allows for printers to be add remotely to a Samba or Windows
1447 NT/2000 print server.
1449 For a Samba host this means that the printer must be
1450 physically added to the underlying printing system. The \fIadd
1451 printer command\fR defines a script to be run which
1452 will perform the necessary operations for adding the printer
1453 to the print system and to add the appropriate service definition
1454 to the \fIsmb.conf\fR file in order that it can be
1455 shared by \fBsmbd(8)\fR
1458 The \fIadd printer command\fR is
1459 automatically invoked with the following parameter (in
1479 \fIWindows 9x driver location\fR
1482 All parameters are filled in from the PRINTER_INFO_2 structure sent
1483 by the Windows NT/2000 client with one exception. The "Windows 9x
1484 driver location" parameter is included for backwards compatibility
1485 only. The remaining fields in the structure are generated from answers
1486 to the APW questions.
1489 Once the \fIadd printer command\fR has
1490 been executed, \fBsmbd\fR will reparse the \fI smb.conf\fR to determine if the share defined by the APW
1491 exists. If the sharename is still invalid, then \fBsmbd
1492 \fRwill return an ACCESS_DENIED error to the client.
1495 See also \fI delete printer command\fR, \fIprinting\fR,
1503 Example: \fBaddprinter command = /usr/bin/addprinter
1506 \fBadd share command (G)\fR
1507 Samba 2.2.0 introduced the ability to dynamically
1508 add and delete shares via the Windows NT 4.0 Server Manager. The
1509 \fIadd share command\fR is used to define an
1510 external program or script which will add a new service definition
1511 to \fIsmb.conf\fR. In order to successfully
1512 execute the \fIadd share command\fR, \fBsmbd\fR
1513 requires that the administrator be connected using a root account (i.e.
1516 When executed, \fBsmbd\fR will automatically invoke the
1517 \fIadd share command\fR with four parameters.
1521 \fIconfigFile\fR - the location
1522 of the global \fIsmb.conf\fR file.
1525 \fIshareName\fR - the name of the new
1529 \fIpathName\fR - path to an **existing**
1533 \fIcomment\fR - comment string to associate
1537 This parameter is only used for add file shares. To add printer shares,
1538 see the \fIadd printer
1542 See also \fIchange share
1543 command\fR, \fIdelete share
1550 Example: \fBadd share command = /usr/local/bin/addshare\fR
1553 \fBadd machine script (G)\fR
1554 This is the full pathname to a script that will
1555 be run by smbd(8)when a machine is added
1556 to it's domain using the administrator username and password method.
1558 This option is only required when using sam back-ends tied to the
1559 Unix uid method of RID calculation such as smbpasswd. This option is only
1560 available in Samba 3.0.
1562 Default: \fBadd machine script = <empty string>
1564 Example: \fBadd machine script = /usr/sbin/adduser -n -g machines -c Machine -d /dev/null -s /bin/false %u
1566 \fBadd user script (G)\fR
1567 This is the full pathname to a script that will
1568 be run \fBAS ROOT\fR by smbd(8)
1569 under special circumstances described below.
1571 Normally, a Samba server requires that UNIX users are
1572 created for all users accessing files on this server. For sites
1573 that use Windows NT account databases as their primary user database
1574 creating these users and keeping the user list in sync with the
1575 Windows NT PDC is an onerous task. This option allows smbdto create the required UNIX users
1576 \fBON DEMAND\fR when a user accesses the Samba server.
1578 In order to use this option, smbd
1579 must \fBNOT\fR be set to \fIsecurity = share\fR
1580 and \fIadd user script\fR
1581 must be set to a full pathname for a script that will create a UNIX
1582 user given one argument of \fI%u\fR, which expands into
1583 the UNIX user name to create.
1585 When the Windows user attempts to access the Samba server,
1586 at login (session setup in the SMB protocol) time, smbdcontacts the \fIpassword server\fR and
1587 attempts to authenticate the given user with the given password. If the
1588 authentication succeeds then \fBsmbd\fR
1589 attempts to find a UNIX user in the UNIX password database to map the
1590 Windows user into. If this lookup fails, and \fIadd user script
1591 \fRis set then \fBsmbd\fR will
1592 call the specified script \fBAS ROOT\fR, expanding
1593 any \fI%u\fR argument to be the user name to create.
1595 If this script successfully creates the user then \fBsmbd
1596 \fRwill continue on as though the UNIX user
1597 already existed. In this way, UNIX users are dynamically created to
1598 match existing Windows NT accounts.
1600 See also \fI security\fR, \fIpassword server\fR,
1604 Default: \fBadd user script = <empty string>
1606 Example: \fBadd user script = /usr/local/samba/bin/add_user
1609 \fBadmin users (S)\fR
1610 This is a list of users who will be granted
1611 administrative privileges on the share. This means that they
1612 will do all file operations as the super-user (root).
1614 You should use this option very carefully, as any user in
1615 this list will be able to do anything they like on the share,
1616 irrespective of file permissions.
1618 Default: \fBno admin users\fR
1620 Example: \fBadmin users = jason\fR
1622 \fBallow hosts (S)\fR
1623 Synonym for \fIhosts allow\fR.
1625 \fBalgorithmic rid base (G)\fR
1626 This determines how Samba will use its
1627 algorithmic mapping from uids/gid to the RIDs needed to construct
1628 NT Security Identifiers.
1630 Setting this option to a larger value could be useful to sites
1631 transitioning from WinNT and Win2k, as existing user and
1632 group rids would otherwise clash with sytem users etc.
1634 All UIDs and GIDs must be able to be resolved into SIDs for
1635 the correct operation of ACLs on the server. As such the algorithmic
1636 mapping can't be 'turned off', but pushing it 'out of the way' should
1637 resolve the issues. Users and groups can then be assigned 'low' RIDs
1638 in arbitary-rid supporting backends.
1640 Default: \fBalgorithmic rid base = 1000\fR
1642 Example: \fBalgorithmic rid base = 100000\fR
1644 \fBallow trusted domains (G)\fR
1645 This option only takes effect when the \fIsecurity\fR option is set to
1647 If it is set to no, then attempts to connect to a resource from
1648 a domain or workgroup other than the one which smbdis running
1649 in will fail, even if that domain is trusted by the remote server
1650 doing the authentication.
1652 This is useful if you only want your Samba server to
1653 serve resources to users in the domain it is a member of. As
1654 an example, suppose that there are two domains DOMA and DOMB. DOMB
1655 is trusted by DOMA, which contains the Samba server. Under normal
1656 circumstances, a user with an account in DOMB can then access the
1657 resources of a UNIX account with the same account name on the
1658 Samba server even if they do not have an account in DOMA. This
1659 can make implementing a security boundary difficult.
1661 Default: \fBallow trusted domains = yes\fR
1663 \fBannounce as (G)\fR
1664 This specifies what type of server
1666 will announce itself as, to a network neighborhood browse
1667 list. By default this is set to Windows NT. The valid options
1668 are : "NT Server" (which can also be written as "NT"),
1669 "NT Workstation", "Win95" or "WfW" meaning Windows NT Server,
1670 Windows NT Workstation, Windows 95 and Windows for Workgroups
1671 respectively. Do not change this parameter unless you have a
1672 specific need to stop Samba appearing as an NT server as this
1673 may prevent Samba servers from participating as browser servers
1676 Default: \fBannounce as = NT Server\fR
1678 Example: \fBannounce as = Win95\fR
1680 \fBannounce version (G)\fR
1681 This specifies the major and minor version numbers
1682 that nmbd will use when announcing itself as a server. The default
1683 is 4.2. Do not change this parameter unless you have a specific
1684 need to set a Samba server to be a downlevel server.
1686 Default: \fBannounce version = 4.5\fR
1688 Example: \fBannounce version = 2.0\fR
1690 \fBauto services (G)\fR
1691 This is a synonym for the \fIpreload\fR.
1693 \fBauth methods (G)\fR
1694 This option allows the administrator to chose what
1695 authentication methods \fBsmbd\fR will use when authenticating
1696 a user. This option defaults to sensible values based on \fI security\fR.
1697 Each entry in the list attempts to authenticate the user in turn, until
1698 the user authenticates. In practice only one method will ever actually
1699 be able to complete the authentication.
1701 Default: \fBauth methods = <empty string>\fR
1703 Example: \fBauth methods = guest sam ntdomain\fR
1706 This parameter lets you "turn off" a service. If
1707 \fIavailable = no\fR, then \fBALL\fR
1708 attempts to connect to the service will fail. Such failures are
1711 Default: \fBavailable = yes\fR
1713 \fBbind interfaces only (G)\fR
1714 This global parameter allows the Samba admin
1715 to limit what interfaces on a machine will serve SMB requests. If
1716 affects file service smbd(8)and
1717 name service nmbd(8)in slightly
1720 For name service it causes \fBnmbd\fR to bind
1721 to ports 137 and 138 on the interfaces listed in the interfaces parameter. \fBnmbd
1722 \fRalso binds to the "all addresses" interface (0.0.0.0)
1723 on ports 137 and 138 for the purposes of reading broadcast messages.
1724 If this option is not set then \fBnmbd\fR will service
1725 name requests on all of these sockets. If \fIbind interfaces
1726 only\fR is set then \fBnmbd\fR will check the
1727 source address of any packets coming in on the broadcast sockets
1728 and discard any that don't match the broadcast addresses of the
1729 interfaces in the \fIinterfaces\fR parameter list.
1730 As unicast packets are received on the other sockets it allows
1731 \fBnmbd\fR to refuse to serve names to machines that
1732 send packets that arrive through any interfaces not listed in the
1733 \fIinterfaces\fR list. IP Source address spoofing
1734 does defeat this simple check, however so it must not be used
1735 seriously as a security feature for \fBnmbd\fR.
1737 For file service it causes smbd(8)
1738 to bind only to the interface list given in the interfaces parameter. This restricts the networks that
1739 \fBsmbd\fR will serve to packets coming in those
1740 interfaces. Note that you should not use this parameter for machines
1741 that are serving PPP or other intermittent or non-broadcast network
1742 interfaces as it will not cope with non-permanent interfaces.
1744 If \fIbind interfaces only\fR is set then
1745 unless the network address \fB127.0.0.1\fR is added
1746 to the \fIinterfaces\fR parameter list \fBsmbpasswd(8)\fR
1747 and \fBswat(8)\fRmay
1748 not work as expected due to the reasons covered below.
1750 To change a users SMB password, the \fBsmbpasswd\fR
1751 by default connects to the \fBlocalhost - 127.0.0.1\fR
1752 address as an SMB client to issue the password change request. If
1753 \fIbind interfaces only\fR is set then unless the
1754 network address \fB127.0.0.1\fR is added to the
1755 \fIinterfaces\fR parameter list then \fB smbpasswd\fR will fail to connect in it's default mode.
1756 \fBsmbpasswd\fR can be forced to use the primary IP interface
1757 of the local host by using its \fI-r remote machine\fR
1758 parameter, with \fIremote machine\fR set
1759 to the IP name of the primary interface of the local host.
1761 The \fBswat\fR status page tries to connect with
1762 \fBsmbd\fR and \fBnmbd\fR at the address
1763 \fB127.0.0.1\fR to determine if they are running.
1764 Not adding \fB127.0.0.1\fR will cause \fB smbd\fR and \fBnmbd\fR to always show
1765 "not running" even if they really are. This can prevent \fB swat\fR from starting/stopping/restarting \fBsmbd\fR
1768 Default: \fBbind interfaces only = no\fR
1770 \fBblocking locks (S)\fR
1771 This parameter controls the behavior of smbd(8)when given a request by a client
1772 to obtain a byte range lock on a region of an open file, and the
1773 request has a time limit associated with it.
1775 If this parameter is set and the lock range requested
1776 cannot be immediately satisfied, Samba 2.2 will internally
1777 queue the lock request, and periodically attempt to obtain
1778 the lock until the timeout period expires.
1780 If this parameter is set to false, then
1781 Samba 2.2 will behave as previous versions of Samba would and
1782 will fail the lock request immediately if the lock range
1785 Default: \fBblocking locks = yes\fR
1788 See the \fI browseable\fR.
1790 \fBbrowse list (G)\fR
1791 This controls whether \fBsmbd(8)\fRwill serve a browse list to
1792 a client doing a \fBNetServerEnum\fR call. Normally
1793 set to true. You should never need to change
1796 Default: \fBbrowse list = yes\fR
1798 \fBbrowseable (S)\fR
1799 This controls whether this share is seen in
1800 the list of available shares in a net view and in the browse list.
1802 Default: \fBbrowseable = yes\fR
1804 \fBcase sensitive (S)\fR
1805 See the discussion in the section NAME MANGLING.
1807 Default: \fBcase sensitive = no\fR
1809 \fBcasesignames (S)\fR
1813 \fBchange notify timeout (G)\fR
1814 This SMB allows a client to tell a server to
1815 "watch" a particular directory for any changes and only reply to
1816 the SMB request when a change has occurred. Such constant scanning of
1817 a directory is expensive under UNIX, hence an \fBsmbd(8)\fRdaemon only performs such a scan
1818 on each requested directory once every \fIchange notify
1821 Default: \fBchange notify timeout = 60\fR
1823 Example: \fBchange notify timeout = 300\fR
1825 Would change the scan time to every 5 minutes.
1827 \fBchange share command (G)\fR
1828 Samba 2.2.0 introduced the ability to dynamically
1829 add and delete shares via the Windows NT 4.0 Server Manager. The
1830 \fIchange share command\fR is used to define an
1831 external program or script which will modify an existing service definition
1832 in \fIsmb.conf\fR. In order to successfully
1833 execute the \fIchange share command\fR, \fBsmbd\fR
1834 requires that the administrator be connected using a root account (i.e.
1837 When executed, \fBsmbd\fR will automatically invoke the
1838 \fIchange share command\fR with four parameters.
1842 \fIconfigFile\fR - the location
1843 of the global \fIsmb.conf\fR file.
1846 \fIshareName\fR - the name of the new
1850 \fIpathName\fR - path to an **existing**
1854 \fIcomment\fR - comment string to associate
1858 This parameter is only used modify existing file shares definitions. To modify
1859 printer shares, use the "Printers..." folder as seen when browsing the Samba host.
1862 See also \fIadd share
1863 command\fR, \fIdelete
1870 Example: \fBchange share command = /usr/local/bin/addshare\fR
1874 This is a text field that is seen next to a share
1875 when a client does a queries the server, either via the network
1876 neighborhood or via \fBnet view\fR to list what shares
1879 If you want to set the string that is displayed next to the
1880 machine name then see the \fI server string\fR parameter.
1882 Default: \fBNo comment string\fR
1884 Example: \fBcomment = Fred's Files\fR
1886 \fBconfig file (G)\fR
1887 This allows you to override the config file
1888 to use, instead of the default (usually \fIsmb.conf\fR).
1889 There is a chicken and egg problem here as this option is set
1892 For this reason, if the name of the config file has changed
1893 when the parameters are loaded then it will reload them from
1894 the new config file.
1896 This option takes the usual substitutions, which can
1899 If the config file doesn't exist then it won't be loaded
1900 (allowing you to special case the config files of just a few
1903 Example: \fBconfig file = /usr/local/samba/lib/smb.conf.%m
1906 This parameter allows you to "clone" service
1907 entries. The specified service is simply duplicated under the
1908 current service's name. Any parameters specified in the current
1909 section will override those in the section being copied.
1911 This feature lets you set up a 'template' service and
1912 create similar services easily. Note that the service being
1913 copied must occur earlier in the configuration file than the
1914 service doing the copying.
1916 Default: \fBno value\fR
1918 Example: \fBcopy = otherservice\fR
1920 \fBcreate mask (S)\fR
1921 A synonym for this parameter is
1925 When a file is created, the necessary permissions are
1926 calculated according to the mapping from DOS modes to UNIX
1927 permissions, and the resulting UNIX mode is then bit-wise 'AND'ed
1928 with this parameter. This parameter may be thought of as a bit-wise
1929 MASK for the UNIX modes of a file. Any bit \fBnot\fR
1930 set here will be removed from the modes set on a file when it is
1933 The default value of this parameter removes the
1934 \&'group' and 'other' write and execute bits from the UNIX modes.
1936 Following this Samba will bit-wise 'OR' the UNIX mode created
1937 from this parameter with the value of the \fIforce create mode\fR
1938 parameter which is set to 000 by default.
1940 This parameter does not affect directory modes. See the
1941 parameter \fIdirectory mode
1944 See also the \fIforce
1945 create mode\fR parameter for forcing particular mode
1946 bits to be set on created files. See also the \fIdirectory mode\fR parameter for masking
1947 mode bits on created directories. See also the \fIinherit permissions\fR parameter.
1949 Note that this parameter does not apply to permissions
1950 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
1951 a mask on access control lists also, they need to set the \fIsecurity mask\fR.
1953 Default: \fBcreate mask = 0744\fR
1955 Example: \fBcreate mask = 0775\fR
1957 \fBcreate mode (S)\fR
1958 This is a synonym for \fI create mask\fR.
1960 \fBcsc policy (S)\fR
1961 This stands for \fBclient-side caching
1962 policy\fR, and specifies how clients capable of offline
1963 caching will cache the files in the share. The valid values
1964 are: manual, documents, programs, disable.
1966 These values correspond to those used on Windows
1969 For example, shares containing roaming profiles can have
1970 offline caching disabled using \fBcsc policy = disable
1973 Default: \fBcsc policy = manual\fR
1975 Example: \fBcsc policy = programs\fR
1978 The value of the parameter (a decimal integer)
1979 represents the number of minutes of inactivity before a connection
1980 is considered dead, and it is disconnected. The deadtime only takes
1981 effect if the number of open files is zero.
1983 This is useful to stop a server's resources being
1984 exhausted by a large number of inactive connections.
1986 Most clients have an auto-reconnect feature when a
1987 connection is broken so in most cases this parameter should be
1988 transparent to users.
1990 Using this parameter with a timeout of a few minutes
1991 is recommended for most systems.
1993 A deadtime of zero indicates that no auto-disconnection
1994 should be performed.
1996 Default: \fBdeadtime = 0\fR
1998 Example: \fBdeadtime = 15\fR
2000 \fBdebug hires timestamp (G)\fR
2001 Sometimes the timestamps in the log messages
2002 are needed with a resolution of higher that seconds, this
2003 boolean parameter adds microsecond resolution to the timestamp
2004 message header when turned on.
2006 Note that the parameter \fI debug timestamp\fR must be on for this to have an
2009 Default: \fBdebug hires timestamp = no\fR
2012 When using only one log file for more then one
2013 forked smbd-process there may be hard to follow which process
2014 outputs which message. This boolean parameter is adds the process-id
2015 to the timestamp message headers in the logfile when turned on.
2017 Note that the parameter \fI debug timestamp\fR must be on for this to have an
2020 Default: \fBdebug pid = no\fR
2022 \fBdebug timestamp (G)\fR
2023 Samba 2.2 debug log messages are timestamped
2024 by default. If you are running at a high \fIdebug level\fR these timestamps
2025 can be distracting. This boolean parameter allows timestamping
2028 Default: \fBdebug timestamp = yes\fR
2031 Samba is sometimes run as root and sometime
2032 run as the connected user, this boolean parameter inserts the
2033 current euid, egid, uid and gid to the timestamp message headers
2034 in the log file if turned on.
2036 Note that the parameter \fI debug timestamp\fR must be on for this to have an
2039 Default: \fBdebug uid = no\fR
2041 \fBdebuglevel (G)\fR
2042 Synonym for \fI log level\fR.
2045 A synonym for \fI default service\fR.
2047 \fBdefault case (S)\fR
2048 See the section on NAME MANGLING. Also note the \fIshort preserve case\fR parameter.
2050 Default: \fBdefault case = lower\fR
2052 \fBdefault devmode (S)\fR
2053 This parameter is only applicable to printable services. When smbd is serving
2054 Printer Drivers to Windows NT/2k/XP clients, each printer on the Samba
2055 server has a Device Mode which defines things such as paper size and
2056 orientation and duplex settings. The device mode can only correctly be
2057 generated by the printer driver itself (which can only be executed on a
2058 Win32 platform). Because smbd is unable to execute the driver code
2059 to generate the device mode, the default behavior is to set this field
2062 Most problems with serving printer drivers to Windows NT/2k/XP clients
2063 can be traced to a problem with the generated device mode. Certain drivers
2064 will do things such as crashing the client's Explorer.exe with a NULL devmode.
2065 However, other printer drivers can cause the client's spooler service
2066 (spoolsv.exe) to die if the devmode was not created by the driver itself
2067 (i.e. smbd generates a default devmode).
2069 This parameter should be used with care and tested with the printer
2070 driver in question. It is better to leave the device mode to NULL
2071 and let the Windows client set the correct values. Because drivers do not
2072 do this all the time, setting \fBdefault devmode = yes\fR
2073 will instruct smbd to generate a default one.
2075 For more information on Windows NT/2k printing and Device Modes,
2076 see the MSDN documentation <URL:http://msdn.microsoft.com/>.
2078 Default: \fBdefault devmode = no\fR
2080 \fBdefault service (G)\fR
2081 This parameter specifies the name of a service
2082 which will be connected to if the service actually requested cannot
2083 be found. Note that the square brackets are \fBNOT\fR
2084 given in the parameter value (see example below).
2086 There is no default value for this parameter. If this
2087 parameter is not given, attempting to connect to a nonexistent
2088 service results in an error.
2090 Typically the default service would be a \fIguest ok\fR, \fIread-only\fR service.
2092 Also note that the apparent service name will be changed
2093 to equal that of the requested service, this is very useful as it
2094 allows you to use macros like \fI%S\fR to make
2097 Note also that any "_" characters in the name of the service
2098 used in the default service will get mapped to a "/". This allows for
2106 default service = pub
2114 \fBdelete printer command (G)\fR
2115 With the introduction of MS-RPC based printer
2116 support for Windows NT/2000 clients in Samba 2.2, it is now
2117 possible to delete printer at run time by issuing the
2118 DeletePrinter() RPC call.
2120 For a Samba host this means that the printer must be
2121 physically deleted from underlying printing system. The \fI deleteprinter command\fR defines a script to be run which
2122 will perform the necessary operations for removing the printer
2123 from the print system and from \fIsmb.conf\fR.
2125 The \fIdelete printer command\fR is
2126 automatically called with only one parameter: \fI "printer name"\fR.
2128 Once the \fIdelete printer command\fR has
2129 been executed, \fBsmbd\fR will reparse the \fI smb.conf\fR to associated printer no longer exists.
2130 If the sharename is still valid, then \fBsmbd
2131 \fRwill return an ACCESS_DENIED error to the client.
2133 See also \fI add printer command\fR, \fIprinting\fR,
2139 Example: \fBdeleteprinter command = /usr/bin/removeprinter
2141 \fBdelete readonly (S)\fR
2142 This parameter allows readonly files to be deleted.
2143 This is not normal DOS semantics, but is allowed by UNIX.
2145 This option may be useful for running applications such
2146 as rcs, where UNIX file ownership prevents changing file
2147 permissions, and DOS semantics prevent deletion of a read only file.
2149 Default: \fBdelete readonly = no\fR
2151 \fBdelete share command (G)\fR
2152 Samba 2.2.0 introduced the ability to dynamically
2153 add and delete shares via the Windows NT 4.0 Server Manager. The
2154 \fIdelete share command\fR is used to define an
2155 external program or script which will remove an existing service
2156 definition from \fIsmb.conf\fR. In order to successfully
2157 execute the \fIdelete share command\fR, \fBsmbd\fR
2158 requires that the administrator be connected using a root account (i.e.
2161 When executed, \fBsmbd\fR will automatically invoke the
2162 \fIdelete share command\fR with two parameters.
2166 \fIconfigFile\fR - the location
2167 of the global \fIsmb.conf\fR file.
2170 \fIshareName\fR - the name of
2171 the existing service.
2174 This parameter is only used to remove file shares. To delete printer shares,
2175 see the \fIdelete printer
2179 See also \fIadd share
2180 command\fR, \fIchange
2187 Example: \fBdelete share command = /usr/local/bin/delshare\fR
2190 \fBdelete user script (G)\fR
2191 This is the full pathname to a script that will
2192 be run \fBAS ROOT\fR by \fBsmbd(8)\fRunder special circumstances
2195 Normally, a Samba server requires that UNIX users are
2196 created for all users accessing files on this server. For sites
2197 that use Windows NT account databases as their primary user database
2198 creating these users and keeping the user list in sync with the
2199 Windows NT PDC is an onerous task. This option allows \fB smbd\fR to delete the required UNIX users \fBON
2200 DEMAND\fR when a user accesses the Samba server and the
2201 Windows NT user no longer exists.
2203 In order to use this option, \fBsmbd\fR must be
2204 set to \fIsecurity = domain\fR or \fIsecurity =
2205 user\fR and \fIdelete user script\fR
2206 must be set to a full pathname for a script
2207 that will delete a UNIX user given one argument of \fI%u\fR,
2208 which expands into the UNIX user name to delete.
2210 When the Windows user attempts to access the Samba server,
2211 at \fBlogin\fR (session setup in the SMB protocol)
2212 time, \fBsmbd\fR contacts the \fIpassword server\fR and attempts to authenticate
2213 the given user with the given password. If the authentication fails
2214 with the specific Domain error code meaning that the user no longer
2215 exists then \fBsmbd\fR attempts to find a UNIX user in
2216 the UNIX password database that matches the Windows user account. If
2217 this lookup succeeds, and \fIdelete user script\fR is
2218 set then \fBsmbd\fR will all the specified script
2219 \fBAS ROOT\fR, expanding any \fI%u\fR
2220 argument to be the user name to delete.
2222 This script should delete the given UNIX username. In this way,
2223 UNIX users are dynamically deleted to match existing Windows NT
2226 See also security = domain,
2227 \fIpassword server\fR
2228 , \fIadd user script\fR
2231 Default: \fBdelete user script = <empty string>
2233 Example: \fBdelete user script = /usr/local/samba/bin/del_user
2236 \fBdelete veto files (S)\fR
2237 This option is used when Samba is attempting to
2238 delete a directory that contains one or more vetoed directories
2239 (see the \fIveto files\fR
2240 option). If this option is set to false (the default) then if a vetoed
2241 directory contains any non-vetoed files or directories then the
2242 directory delete will fail. This is usually what you want.
2244 If this option is set to true, then Samba
2245 will attempt to recursively delete any files and directories within
2246 the vetoed directory. This can be useful for integration with file
2247 serving systems such as NetAtalk which create meta-files within
2248 directories you might normally veto DOS/Windows users from seeing
2249 (e.g. \fI.AppleDouble\fR)
2251 Setting \fBdelete veto files = yes\fR allows these
2252 directories to be transparently deleted when the parent directory
2253 is deleted (so long as the user has permissions to do so).
2255 See also the \fIveto
2258 Default: \fBdelete veto files = no\fR
2260 \fBdeny hosts (S)\fR
2261 Synonym for \fIhosts
2264 \fBdfree command (G)\fR
2265 The \fIdfree command\fR setting should
2266 only be used on systems where a problem occurs with the internal
2267 disk space calculations. This has been known to happen with Ultrix,
2268 but may occur with other operating systems. The symptom that was
2269 seen was an error of "Abort Retry Ignore" at the end of each
2272 This setting allows the replacement of the internal routines to
2273 calculate the total disk space and amount available with an external
2274 routine. The example below gives a possible script that might fulfill
2277 The external program will be passed a single parameter indicating
2278 a directory in the filesystem being queried. This will typically consist
2279 of the string \fI./\fR. The script should return two
2280 integers in ASCII. The first should be the total disk space in blocks,
2281 and the second should be the number of available blocks. An optional
2282 third return value can give the block size in bytes. The default
2283 blocksize is 1024 bytes.
2285 Note: Your script should \fBNOT\fR be setuid or
2286 setgid and should be owned by (and writeable only by) root!
2288 Default: \fBBy default internal routines for
2289 determining the disk capacity and remaining space will be used.
2291 Example: \fBdfree command = /usr/local/samba/bin/dfree
2293 Where the script dfree (which must be made executable) could be:
2299 df $1 | tail -1 | awk '{print $2" "$4}'
2304 or perhaps (on Sys V based systems):
2310 /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
2315 Note that you may have to replace the command names
2316 with full path names on some systems.
2322 \fBdirectory mask (S)\fR
2323 This parameter is the octal modes which are
2324 used when converting DOS modes to UNIX modes when creating UNIX
2327 When a directory is created, the necessary permissions are
2328 calculated according to the mapping from DOS modes to UNIX permissions,
2329 and the resulting UNIX mode is then bit-wise 'AND'ed with this
2330 parameter. This parameter may be thought of as a bit-wise MASK for
2331 the UNIX modes of a directory. Any bit \fBnot\fR set
2332 here will be removed from the modes set on a directory when it is
2335 The default value of this parameter removes the 'group'
2336 and 'other' write bits from the UNIX mode, allowing only the
2337 user who owns the directory to modify it.
2339 Following this Samba will bit-wise 'OR' the UNIX mode
2340 created from this parameter with the value of the \fIforce directory mode
2341 \fRparameter. This parameter is set to 000 by
2342 default (i.e. no extra mode bits are added).
2344 Note that this parameter does not apply to permissions
2345 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
2346 a mask on access control lists also, they need to set the \fIdirectory security mask\fR.
2349 directory mode\fR parameter to cause particular mode
2350 bits to always be set on created directories.
2352 See also the \fIcreate mode
2353 \fRparameter for masking mode bits on created files,
2354 and the \fIdirectory
2355 security mask\fR parameter.
2357 Also refer to the \fI inherit permissions\fR parameter.
2359 Default: \fBdirectory mask = 0755\fR
2361 Example: \fBdirectory mask = 0775\fR
2363 \fBdirectory mode (S)\fR
2364 Synonym for \fI directory mask\fR
2366 \fBdirectory security mask (S)\fR
2367 This parameter controls what UNIX permission bits
2368 can be modified when a Windows NT client is manipulating the UNIX
2369 permission on a directory using the native NT security dialog
2372 This parameter is applied as a mask (AND'ed with) to
2373 the changed permission bits, thus preventing any bits not in
2374 this mask from being modified. Essentially, zero bits in this
2375 mask may be treated as a set of bits the user is not allowed
2378 If not set explicitly this parameter is set to 0777
2379 meaning a user is allowed to modify all the user/group/world
2380 permissions on a directory.
2382 \fBNote\fR that users who can access the
2383 Samba server through other means can easily bypass this restriction,
2384 so it is primarily useful for standalone "appliance" systems.
2385 Administrators of most normal systems will probably want to leave
2386 it as the default of 0777.
2388 See also the \fI force directory security mode\fR, \fIsecurity mask\fR,
2389 \fIforce security mode
2392 Default: \fBdirectory security mask = 0777\fR
2394 Example: \fBdirectory security mask = 0700\fR
2396 \fBdisable spoolss (G)\fR
2397 Enabling this parameter will disables Samba's support
2398 for the SPOOLSS set of MS-RPC's and will yield identical behavior
2399 as Samba 2.0.x. Windows NT/2000 clients will downgrade to using
2400 Lanman style printing commands. Windows 9x/ME will be uneffected by
2401 the parameter. However, this will also disable the ability to upload
2402 printer drivers to a Samba server via the Windows NT Add Printer
2403 Wizard or by using the NT printer properties dialog window. It will
2404 also disable the capability of Windows NT/2000 clients to download
2405 print drivers from the Samba host upon demand.
2406 \fBBe very careful about enabling this parameter.\fR
2408 See also use client driver
2410 Default : \fBdisable spoolss = no\fR
2413 Specifies that nmbd(8)
2414 when acting as a WINS server and finding that a NetBIOS name has not
2415 been registered, should treat the NetBIOS name word-for-word as a DNS
2416 name and do a lookup with the DNS server for that name on behalf of
2417 the name-querying client.
2419 Note that the maximum length for a NetBIOS name is 15
2420 characters, so the DNS name (or DNS alias) can likewise only be
2421 15 characters, maximum.
2423 \fBnmbd\fR spawns a second copy of itself to do the
2424 DNS name lookup requests, as doing a name lookup is a blocking
2427 See also the parameter \fI wins support\fR.
2429 Default: \fBdns proxy = yes\fR
2431 \fBdomain admin group (G)\fR
2432 This parameter is intended as a temporary solution
2433 to enable users to be a member of the "Domain Admins" group when
2434 a Samba host is acting as a PDC. A complete solution will be provided
2435 by a system for mapping Windows NT/2000 groups onto UNIX groups.
2436 Please note that this parameter has a somewhat confusing name. It
2437 accepts a list of usernames and of group names in standard
2438 \fIsmb.conf\fR notation.
2441 guest group\fR, \fIdomain
2444 Default: \fBno domain administrators\fR
2446 Example: \fBdomain admin group = root @wheel\fR
2448 \fBdomain guest group (G)\fR
2449 This parameter is intended as a temporary solution
2450 to enable users to be a member of the "Domain Guests" group when
2451 a Samba host is acting as a PDC. A complete solution will be provided
2452 by a system for mapping Windows NT/2000 groups onto UNIX groups.
2453 Please note that this parameter has a somewhat confusing name. It
2454 accepts a list of usernames and of group names in standard
2455 \fIsmb.conf\fR notation.
2458 admin group\fR, \fIdomain
2461 Default: \fBno domain guests\fR
2463 Example: \fBdomain guest group = nobody @guest\fR
2465 \fBdomain logons (G)\fR
2466 If set to true, the Samba server will serve
2467 Windows 95/98 Domain logons for the \fIworkgroup\fR it is in. Samba 2.2 also
2468 has limited capability to act as a domain controller for Windows
2469 NT 4 Domains. For more details on setting up this feature see
2470 the Samba-PDC-HOWTO included in the \fIhtmldocs/\fR
2471 directory shipped with the source code.
2473 Default: \fBdomain logons = no\fR
2475 \fBdomain master (G)\fR
2476 Tell \fB nmbd(8)\fRto enable WAN-wide browse list
2477 collation. Setting this option causes \fBnmbd\fR to
2478 claim a special domain specific NetBIOS name that identifies
2479 it as a domain master browser for its given \fIworkgroup\fR. Local master browsers
2480 in the same \fIworkgroup\fR on broadcast-isolated
2481 subnets will give this \fBnmbd\fR their local browse lists,
2482 and then ask \fBsmbd(8)\fR
2483 for a complete copy of the browse list for the whole wide area
2484 network. Browser clients will then contact their local master browser,
2485 and will receive the domain-wide browse list, instead of just the list
2486 for their broadcast-isolated subnet.
2488 Note that Windows NT Primary Domain Controllers expect to be
2489 able to claim this \fIworkgroup\fR specific special
2490 NetBIOS name that identifies them as domain master browsers for
2491 that \fIworkgroup\fR by default (i.e. there is no
2492 way to prevent a Windows NT PDC from attempting to do this). This
2493 means that if this parameter is set and \fBnmbd\fR claims
2494 the special name for a \fIworkgroup\fR before a Windows
2495 NT PDC is able to do so then cross subnet browsing will behave
2496 strangely and may fail.
2498 If \fBdomain logons = yes\fR
2499 , then the default behavior is to enable the \fIdomain
2500 master\fR parameter. If \fIdomain logons\fR is
2501 not enabled (the default setting), then neither will \fIdomain
2502 master\fR be enabled by default.
2504 Default: \fBdomain master = auto\fR
2506 \fBdont descend (S)\fR
2507 There are certain directories on some systems
2508 (e.g., the \fI/proc\fR tree under Linux) that are either not
2509 of interest to clients or are infinitely deep (recursive). This
2510 parameter allows you to specify a comma-delimited list of directories
2511 that the server should always show as empty.
2513 Note that Samba can be very fussy about the exact format
2514 of the "dont descend" entries. For example you may need \fI ./proc\fR instead of just \fI/proc\fR.
2515 Experimentation is the best policy :-)
2517 Default: \fBnone (i.e., all directories are OK
2520 Example: \fBdont descend = /proc,/dev\fR
2522 \fBdos filemode (S)\fR
2523 The default behavior in Samba is to provide
2524 UNIX-like behavior where only the owner of a file/directory is
2525 able to change the permissions on it. However, this behavior
2526 is often confusing to DOS/Windows users. Enabling this parameter
2527 allows a user who has write access to the file (by whatever
2528 means) to modify the permissions on it. Note that a user
2529 belonging to the group owning the file will not be allowed to
2530 change permissions if the group is only granted read access.
2531 Ownership of the file/directory is not changed, only the permissions
2534 Default: \fBdos filemode = no\fR
2536 \fBdos filetime resolution (S)\fR
2537 Under the DOS and Windows FAT filesystem, the finest
2538 granularity on time resolution is two seconds. Setting this parameter
2539 for a share causes Samba to round the reported time down to the
2540 nearest two second boundary when a query call that requires one second
2541 resolution is made to \fBsmbd(8)\fR
2544 This option is mainly used as a compatibility option for Visual
2545 C++ when used against Samba shares. If oplocks are enabled on a
2546 share, Visual C++ uses two different time reading calls to check if a
2547 file has changed since it was last read. One of these calls uses a
2548 one-second granularity, the other uses a two second granularity. As
2549 the two second call rounds any odd second down, then if the file has a
2550 timestamp of an odd number of seconds then the two timestamps will not
2551 match and Visual C++ will keep reporting the file has changed. Setting
2552 this option causes the two timestamps to match, and Visual C++ is
2555 Default: \fBdos filetime resolution = no\fR
2557 \fBdos filetimes (S)\fR
2558 Under DOS and Windows, if a user can write to a
2559 file they can change the timestamp on it. Under POSIX semantics,
2560 only the owner of the file or root may change the timestamp. By
2561 default, Samba runs with POSIX semantics and refuses to change the
2562 timestamp on a file if the user \fBsmbd\fR is acting
2563 on behalf of is not the file owner. Setting this option to true allows DOS semantics and smbdwill change the file
2564 timestamp as DOS requires.
2566 Default: \fBdos filetimes = no\fR
2568 \fBencrypt passwords (G)\fR
2569 This boolean controls whether encrypted passwords
2570 will be negotiated with the client. Note that Windows NT 4.0 SP3 and
2571 above and also Windows 98 will by default expect encrypted passwords
2572 unless a registry entry is changed. To use encrypted passwords in
2573 Samba see the file ENCRYPTION.txt in the Samba documentation
2574 directory \fIdocs/\fR shipped with the source code.
2576 In order for encrypted passwords to work correctly
2577 \fBsmbd(8)\fRmust either
2578 have access to a local \fIsmbpasswd(5)
2579 \fRprogram for information on how to set up
2580 and maintain this file), or set the security = [server|domain|ads] parameter which
2581 causes \fBsmbd\fR to authenticate against another
2584 Default: \fBencrypt passwords = yes\fR
2586 \fBenhanced browsing (G)\fR
2587 This option enables a couple of enhancements to
2588 cross-subnet browse propagation that have been added in Samba
2589 but which are not standard in Microsoft implementations.
2591 The first enhancement to browse propagation consists of a regular
2592 wildcard query to a Samba WINS server for all Domain Master Browsers,
2593 followed by a browse synchronization with each of the returned
2594 DMBs. The second enhancement consists of a regular randomised browse
2595 synchronization with all currently known DMBs.
2597 You may wish to disable this option if you have a problem with empty
2598 workgroups not disappearing from browse lists. Due to the restrictions
2599 of the browse protocols these enhancements can cause a empty workgroup
2600 to stay around forever which can be annoying.
2602 In general you should leave this option enabled as it makes
2603 cross-subnet browse propagation much more reliable.
2605 Default: \fBenhanced browsing = yes\fR
2607 \fBenumports command (G)\fR
2608 The concept of a "port" is fairly foreign
2609 to UNIX hosts. Under Windows NT/2000 print servers, a port
2610 is associated with a port monitor and generally takes the form of
2611 a local port (i.e. LPT1:, COM1:, FILE:) or a remote port
2612 (i.e. LPD Port Monitor, etc...). By default, Samba has only one
2613 port defined--"Samba Printer Port". Under
2614 Windows NT/2000, all printers must have a valid port name.
2615 If you wish to have a list of ports displayed (\fBsmbd
2616 \fRdoes not use a port name for anything) other than
2617 the default "Samba Printer Port", you
2618 can define \fIenumports command\fR to point to
2619 a program which should generate a list of ports, one per line,
2620 to standard output. This listing will then be used in response
2621 to the level 1 and 2 EnumPorts() RPC.
2623 Default: \fBno enumports command\fR
2625 Example: \fBenumports command = /usr/bin/listports
2628 This is a synonym for \fIpreexec\fR.
2630 \fBfake directory create times (S)\fR
2631 NTFS and Windows VFAT file systems keep a create
2632 time for all files and directories. This is not the same as the
2633 ctime - status change time - that Unix keeps, so Samba by default
2634 reports the earliest of the various times Unix does keep. Setting
2635 this parameter for a share causes Samba to always report midnight
2636 1-1-1980 as the create time for directories.
2638 This option is mainly used as a compatibility option for
2639 Visual C++ when used against Samba shares. Visual C++ generated
2640 makefiles have the object directory as a dependency for each object
2641 file, and a make rule to create the directory. Also, when NMAKE
2642 compares timestamps it uses the creation time when examining a
2643 directory. Thus the object directory will be created if it does not
2644 exist, but once it does exist it will always have an earlier
2645 timestamp than the object files it contains.
2647 However, Unix time semantics mean that the create time
2648 reported by Samba will be updated whenever a file is created or
2649 or deleted in the directory. NMAKE finds all object files in
2650 the object directory. The timestamp of the last one built is then
2651 compared to the timestamp of the object directory. If the
2652 directory's timestamp if newer, then all object files
2653 will be rebuilt. Enabling this option
2654 ensures directories always predate their contents and an NMAKE build
2655 will proceed as expected.
2657 Default: \fBfake directory create times = no\fR
2659 \fBfake oplocks (S)\fR
2660 Oplocks are the way that SMB clients get permission
2661 from a server to locally cache file operations. If a server grants
2662 an oplock (opportunistic lock) then the client is free to assume
2663 that it is the only one accessing the file and it will aggressively
2664 cache file data. With some oplock types the client may even cache
2665 file open/close operations. This can give enormous performance benefits.
2667 When you set \fBfake oplocks = yes\fR, \fBsmbd(8)\fRwill
2668 always grant oplock requests no matter how many clients are using
2671 It is generally much better to use the real \fIoplocks\fR support rather
2672 than this parameter.
2674 If you enable this option on all read-only shares or
2675 shares that you know will only be accessed from one client at a
2676 time such as physically read-only media like CDROMs, you will see
2677 a big performance improvement on many operations. If you enable
2678 this option on shares where multiple clients may be accessing the
2679 files read-write at the same time you can get data corruption. Use
2680 this option carefully!
2682 Default: \fBfake oplocks = no\fR
2684 \fBfollow symlinks (S)\fR
2685 This parameter allows the Samba administrator
2686 to stop \fBsmbd(8)\fR
2687 from following symbolic links in a particular share. Setting this
2688 parameter to no prevents any file or directory
2689 that is a symbolic link from being followed (the user will get an
2690 error). This option is very useful to stop users from adding a
2691 symbolic link to \fI/etc/passwd\fR in their home
2692 directory for instance. However it will slow filename lookups
2695 This option is enabled (i.e. \fBsmbd\fR will
2696 follow symbolic links) by default.
2698 Default: \fBfollow symlinks = yes\fR
2700 \fBforce create mode (S)\fR
2701 This parameter specifies a set of UNIX mode bit
2702 permissions that will \fBalways\fR be set on a
2703 file created by Samba. This is done by bitwise 'OR'ing these bits onto
2704 the mode bits of a file that is being created or having its
2705 permissions changed. The default for this parameter is (in octal)
2706 000. The modes in this parameter are bitwise 'OR'ed onto the file
2707 mode after the mask set in the \fIcreate mask\fR
2708 parameter is applied.
2710 See also the parameter \fIcreate
2711 mask\fR for details on masking mode bits on files.
2713 See also the \fIinherit
2714 permissions\fR parameter.
2716 Default: \fBforce create mode = 000\fR
2718 Example: \fBforce create mode = 0755\fR
2720 would force all created files to have read and execute
2721 permissions set for 'group' and 'other' as well as the
2722 read/write/execute bits set for the 'user'.
2724 \fBforce directory mode (S)\fR
2725 This parameter specifies a set of UNIX mode bit
2726 permissions that will \fBalways\fR be set on a directory
2727 created by Samba. This is done by bitwise 'OR'ing these bits onto the
2728 mode bits of a directory that is being created. The default for this
2729 parameter is (in octal) 0000 which will not add any extra permission
2730 bits to a created directory. This operation is done after the mode
2731 mask in the parameter \fIdirectory mask\fR is
2734 See also the parameter \fI directory mask\fR for details on masking mode bits
2735 on created directories.
2737 See also the \fI inherit permissions\fR parameter.
2739 Default: \fBforce directory mode = 000\fR
2741 Example: \fBforce directory mode = 0755\fR
2743 would force all created directories to have read and execute
2744 permissions set for 'group' and 'other' as well as the
2745 read/write/execute bits set for the 'user'.
2747 \fBforce directory security mode (S)\fR
2748 This parameter controls what UNIX permission bits
2749 can be modified when a Windows NT client is manipulating the UNIX
2750 permission on a directory using the native NT security dialog box.
2752 This parameter is applied as a mask (OR'ed with) to the
2753 changed permission bits, thus forcing any bits in this mask that
2754 the user may have modified to be on. Essentially, one bits in this
2755 mask may be treated as a set of bits that, when modifying security
2756 on a directory, the user has always set to be 'on'.
2758 If not set explicitly this parameter is 000, which
2759 allows a user to modify all the user/group/world permissions on a
2760 directory without restrictions.
2762 \fBNote\fR that users who can access the
2763 Samba server through other means can easily bypass this restriction,
2764 so it is primarily useful for standalone "appliance" systems.
2765 Administrators of most normal systems will probably want to leave
2768 See also the \fI directory security mask\fR, \fIsecurity mask\fR,
2769 \fIforce security mode
2772 Default: \fBforce directory security mode = 0\fR
2774 Example: \fBforce directory security mode = 700\fR
2776 \fBforce group (S)\fR
2777 This specifies a UNIX group name that will be
2778 assigned as the default primary group for all users connecting
2779 to this service. This is useful for sharing files by ensuring
2780 that all access to files on service will use the named group for
2781 their permissions checking. Thus, by assigning permissions for this
2782 group to the files and directories within this service the Samba
2783 administrator can restrict or allow sharing of these files.
2785 In Samba 2.0.5 and above this parameter has extended
2786 functionality in the following way. If the group name listed here
2787 has a '+' character prepended to it then the current user accessing
2788 the share only has the primary group default assigned to this group
2789 if they are already assigned as a member of that group. This allows
2790 an administrator to decide that only users who are already in a
2791 particular group will create files with group ownership set to that
2792 group. This gives a finer granularity of ownership assignment. For
2793 example, the setting \fIforce group = +sys\fR means
2794 that only users who are already in group sys will have their default
2795 primary group assigned to sys when accessing this Samba share. All
2796 other users will retain their ordinary primary group.
2798 If the \fIforce user
2799 \fRparameter is also set the group specified in
2800 \fIforce group\fR will override the primary group
2801 set in \fIforce user\fR.
2806 Default: \fBno forced group\fR
2808 Example: \fBforce group = agroup\fR
2810 \fBforce security mode (S)\fR
2811 This parameter controls what UNIX permission
2812 bits can be modified when a Windows NT client is manipulating
2813 the UNIX permission on a file using the native NT security dialog
2816 This parameter is applied as a mask (OR'ed with) to the
2817 changed permission bits, thus forcing any bits in this mask that
2818 the user may have modified to be on. Essentially, one bits in this
2819 mask may be treated as a set of bits that, when modifying security
2820 on a file, the user has always set to be 'on'.
2822 If not set explicitly this parameter is set to 0,
2823 and allows a user to modify all the user/group/world permissions on a file,
2824 with no restrictions.
2826 \fBNote\fR that users who can access
2827 the Samba server through other means can easily bypass this restriction,
2828 so it is primarily useful for standalone "appliance" systems.
2829 Administrators of most normal systems will probably want to leave
2832 See also the \fI force directory security mode\fR,
2833 \fIdirectory security
2834 mask\fR, \fI security mask\fR parameters.
2836 Default: \fBforce security mode = 0\fR
2838 Example: \fBforce security mode = 700\fR
2840 \fBforce user (S)\fR
2841 This specifies a UNIX user name that will be
2842 assigned as the default user for all users connecting to this service.
2843 This is useful for sharing files. You should also use it carefully
2844 as using it incorrectly can cause security problems.
2846 This user name only gets used once a connection is established.
2847 Thus clients still need to connect as a valid user and supply a
2848 valid password. Once connected, all file operations will be performed
2849 as the "forced user", no matter what username the client connected
2850 as. This can be very useful.
2852 In Samba 2.0.5 and above this parameter also causes the
2853 primary group of the forced user to be used as the primary group
2854 for all file activity. Prior to 2.0.5 the primary group was left
2855 as the primary group of the connecting user (this was a bug).
2857 See also \fIforce group
2859 Default: \fBno forced user\fR
2861 Example: \fBforce user = auser\fR
2864 This parameter allows the administrator to
2865 configure the string that specifies the type of filesystem a share
2866 is using that is reported by \fBsmbd(8)
2867 \fRwhen a client queries the filesystem type
2868 for a share. The default type is NTFS for
2869 compatibility with Windows NT but this can be changed to other
2870 strings such as Samba or FAT
2873 Default: \fBfstype = NTFS\fR
2875 Example: \fBfstype = Samba\fR
2877 \fBgetwd cache (G)\fR
2878 This is a tuning option. When this is enabled a
2879 caching algorithm will be used to reduce the time taken for getwd()
2880 calls. This can have a significant impact on performance, especially
2881 when the \fIwide links\fR
2882 parameter is set to false.
2884 Default: \fBgetwd cache = yes\fR
2887 Synonym for \fIforce
2890 \fBguest account (S)\fR
2891 This is a username which will be used for access
2892 to services which are specified as \fI guest ok\fR (see below). Whatever privileges this
2893 user has will be available to any client connecting to the guest service.
2894 Typically this user will exist in the password file, but will not
2895 have a valid login. The user account "ftp" is often a good choice
2896 for this parameter. If a username is specified in a given service,
2897 the specified username overrides this one.
2899 One some systems the default guest account "nobody" may not
2900 be able to print. Use another account in this case. You should test
2901 this by trying to log in as your guest user (perhaps by using the
2902 \fBsu -\fR command) and trying to print using the
2903 system print command such as \fBlpr(1)\fR or \fB lp(1)\fR.
2905 Default: \fBspecified at compile time, usually
2908 Example: \fBguest account = ftp\fR
2911 If this parameter is yes for
2912 a service, then no password is required to connect to the service.
2913 Privileges will be those of the \fI guest account\fR.
2915 See the section below on \fI security\fR for more information about this option.
2917 Default: \fBguest ok = no\fR
2919 \fBguest only (S)\fR
2920 If this parameter is yes for
2921 a service, then only guest connections to the service are permitted.
2922 This parameter will have no effect if \fIguest ok\fR is not set for the service.
2924 See the section below on \fI security\fR for more information about this option.
2926 Default: \fBguest only = no\fR
2928 \fBhide dot files (S)\fR
2929 This is a boolean parameter that controls whether
2930 files starting with a dot appear as hidden files.
2932 Default: \fBhide dot files = yes\fR
2935 This is a list of files or directories that are not
2936 visible but are accessible. The DOS 'hidden' attribute is applied
2937 to any files or directories that match.
2939 Each entry in the list must be separated by a '/',
2940 which allows spaces to be included in the entry. '*'
2941 and '?' can be used to specify multiple files or directories
2942 as in DOS wildcards.
2944 Each entry must be a Unix path, not a DOS path and must
2945 not include the Unix directory separator '/'.
2947 Note that the case sensitivity option is applicable
2950 Setting this parameter will affect the performance of Samba,
2951 as it will be forced to check all files and directories for a match
2952 as they are scanned.
2955 dot files\fR, \fI veto files\fR and \fIcase sensitive\fR.
2957 Default: \fBno file are hidden\fR
2959 Example: \fBhide files =
2960 /.*/DesktopFolderDB/TrashFor%m/resource.frk/\fR
2962 The above example is based on files that the Macintosh
2963 SMB client (DAVE) available from
2964 Thursby <URL:http://www.thursby.com> creates for internal use, and also still hides
2965 all files beginning with a dot.
2967 \fBhide local users(G)\fR
2968 This parameter toggles the hiding of local UNIX
2969 users (root, wheel, floppy, etc) from remote clients.
2971 Default: \fBhide local users = no\fR
2973 \fBhide unreadable (S)\fR
2974 This parameter prevents clients from seeing the
2975 existance of files that cannot be read. Defaults to off.
2977 Default: \fBhide unreadable = no\fR
2979 \fBhomedir map (G)\fR
2981 \fRis true, and \fBsmbd(8)\fRis also acting
2982 as a Win95/98 \fIlogon server\fR then this parameter
2983 specifies the NIS (or YP) map from which the server for the user's
2984 home directory should be extracted. At present, only the Sun
2985 auto.home map format is understood. The form of the map is:
2987 \fBusername server:/some/file/system\fR
2989 and the program will extract the servername from before
2990 the first ':'. There should probably be a better parsing system
2991 that copes with different map formats and also Amd (another
2994 \fBNOTE :\fRA working NIS client is required on
2995 the system for this option to work.
2997 See also \fInis homedir\fR
2998 , \fIdomain logons\fR
3001 Default: \fBhomedir map = <empty string>\fR
3003 Example: \fBhomedir map = amd.homedir\fR
3005 \fBhost msdfs (G)\fR
3006 This boolean parameter is only available
3007 if Samba has been configured and compiled with the \fB --with-msdfs\fR option. If set to yes,
3008 Samba will act as a Dfs server, and allow Dfs-aware clients
3009 to browse Dfs trees hosted on the server.
3011 See also the \fI msdfs root\fR share level parameter. For
3012 more information on setting up a Dfs tree on Samba,
3013 refer to msdfs_setup.html.
3015 Default: \fBhost msdfs = no\fR
3017 \fBhosts allow (S)\fR
3018 A synonym for this parameter is \fIallow
3021 This parameter is a comma, space, or tab delimited
3022 set of hosts which are permitted to access a service.
3024 If specified in the [global] section then it will
3025 apply to all services, regardless of whether the individual
3026 service has a different setting.
3028 You can specify the hosts by name or IP number. For
3029 example, you could restrict access to only the hosts on a
3030 Class C subnet with something like \fBallow hosts = 150.203.5.
3031 \fR\&. The full syntax of the list is described in the man
3032 page \fIhosts_access(5)\fR. Note that this man
3033 page may not be present on your system, so a brief description will
3036 Note that the localhost address 127.0.0.1 will always
3037 be allowed access unless specifically denied by a \fIhosts deny\fR option.
3039 You can also specify hosts by network/netmask pairs and
3040 by netgroup names if your system supports netgroups. The
3041 \fBEXCEPT\fR keyword can also be used to limit a
3042 wildcard list. The following examples may provide some help:
3044 Example 1: allow all IPs in 150.203.*.*; except one
3046 \fBhosts allow = 150.203. EXCEPT 150.203.6.66\fR
3048 Example 2: allow hosts that match the given network/netmask
3050 \fBhosts allow = 150.203.15.0/255.255.255.0\fR
3052 Example 3: allow a couple of hosts
3054 \fBhosts allow = lapland, arvidsjaur\fR
3056 Example 4: allow only hosts in NIS netgroup "foonet", but
3057 deny access from one particular host
3059 \fBhosts allow = @foonet\fR
3061 \fBhosts deny = pirate\fR
3063 Note that access still requires suitable user-level passwords.
3065 See \fBtestparm(1)\fR
3066 for a way of testing your host access to see if it does
3069 Default: \fBnone (i.e., all hosts permitted access)
3071 Example: \fBallow hosts = 150.203.5. myhost.mynet.edu.au
3073 \fBhosts deny (S)\fR
3074 The opposite of \fIhosts allow\fR
3075 - hosts listed here are \fBNOT\fR permitted access to
3076 services unless the specific services have their own lists to override
3077 this one. Where the lists conflict, the \fIallow\fR
3078 list takes precedence.
3080 Default: \fBnone (i.e., no hosts specifically excluded)
3082 Example: \fBhosts deny = 150.203.4. badhost.mynet.edu.au
3084 \fBhosts equiv (G)\fR
3085 If this global parameter is a non-null string,
3086 it specifies the name of a file to read for the names of hosts
3087 and users who will be allowed access without specifying a password.
3089 This is not be confused with \fIhosts allow\fR which is about hosts
3090 access to services and is more useful for guest services. \fI hosts equiv\fR may be useful for NT clients which will
3091 not supply passwords to Samba.
3093 \fBNOTE :\fR The use of \fIhosts equiv
3094 \fRcan be a major security hole. This is because you are
3095 trusting the PC to supply the correct username. It is very easy to
3096 get a PC to supply a false username. I recommend that the
3097 \fIhosts equiv\fR option be only used if you really
3098 know what you are doing, or perhaps on a home network where you trust
3099 your spouse and kids. And only if you \fBreally\fR trust
3102 Default: \fBno host equivalences\fR
3104 Example: \fBhosts equiv = /etc/hosts.equiv\fR
3107 This allows you to include one config file
3108 inside another. The file is included literally, as though typed
3111 It takes the standard substitutions, except \fI%u
3112 \fR, \fI%P\fR and \fI%S\fR.
3114 Default: \fBno file included\fR
3116 Example: \fBinclude = /usr/local/samba/lib/admin_smb.conf
3118 \fBinherit acls (S)\fR
3119 This parameter can be used to ensure
3120 that if default acls exist on parent directories,
3121 they are always honored when creating a subdirectory.
3122 The default behavior is to use the mode specified
3123 when creating the directory. Enabling this option
3124 sets the mode to 0777, thus guaranteeing that
3125 default directory acls are propagated.
3127 Default: \fBinherit acls = no\fR
3129 \fBinherit permissions (S)\fR
3130 The permissions on new files and directories
3131 are normally governed by \fI create mask\fR, \fIdirectory mask\fR, \fIforce create mode\fR
3133 directory mode\fR but the boolean inherit
3134 permissions parameter overrides this.
3136 New directories inherit the mode of the parent directory,
3137 including bits such as setgid.
3139 New files inherit their read/write bits from the parent
3140 directory. Their execute bits continue to be determined by
3143 and \fImap system\fR
3146 Note that the setuid bit is \fBnever\fR set via
3147 inheritance (the code explicitly prohibits this).
3149 This can be particularly useful on large systems with
3150 many users, perhaps several thousand, to allow a single [homes]
3151 share to be used flexibly by each user.
3153 See also \fIcreate mask
3154 \fR, \fI directory mask\fR, \fIforce create mode\fR and \fIforce directory mode\fR
3157 Default: \fBinherit permissions = no\fR
3159 \fBinterfaces (G)\fR
3160 This option allows you to override the default
3161 network interfaces list that Samba will use for browsing, name
3162 registration and other NBT traffic. By default Samba will query
3163 the kernel for the list of all active interfaces and use any
3164 interfaces except 127.0.0.1 that are broadcast capable.
3166 The option takes a list of interface strings. Each string
3167 can be in any of the following forms:
3171 a network interface name (such as eth0).
3172 This may include shell-like wildcards so eth* will match
3173 any interface starting with the substring "eth"
3176 an IP address. In this case the netmask is
3177 determined from the list of interfaces obtained from the
3184 a broadcast/mask pair.
3187 The "mask" parameters can either be a bit length (such
3188 as 24 for a C class network) or a full netmask in dotted
3192 The "IP" parameters above can either be a full dotted
3193 decimal IP address or a hostname which will be looked up via
3194 the OS's normal hostname resolution mechanisms.
3197 For example, the following line:
3200 \fBinterfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0
3203 would configure three network interfaces corresponding
3204 to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10.
3205 The netmasks of the latter two interfaces would be set to 255.255.255.0.
3212 Default: \fBall active interfaces except 127.0.0.1
3213 that are broadcast capable\fR
3216 \fBinvalid users (S)\fR
3217 This is a list of users that should not be allowed
3218 to login to this service. This is really a \fBparanoid\fR
3219 check to absolutely ensure an improper setting does not breach
3222 A name starting with a '@' is interpreted as an NIS
3223 netgroup first (if your system supports NIS), and then as a UNIX
3224 group if the name was not found in the NIS netgroup database.
3226 A name starting with '+' is interpreted only
3227 by looking in the UNIX group database. A name starting with
3228 \&'&' is interpreted only by looking in the NIS netgroup database
3229 (this requires NIS to be working on your system). The characters
3230 \&'+' and '&' may be used at the start of the name in either order
3231 so the value \fI+&group\fR means check the
3232 UNIX group database, followed by the NIS netgroup database, and
3233 the value \fI&+group\fR means check the NIS
3234 netgroup database, followed by the UNIX group database (the
3235 same as the '@' prefix).
3237 The current servicename is substituted for \fI%S\fR.
3238 This is useful in the [homes] section.
3240 See also \fIvalid users
3243 Default: \fBno invalid users\fR
3245 Example: \fBinvalid users = root fred admin @wheel
3248 The value of the parameter (an integer) represents
3249 the number of seconds between \fIkeepalive\fR
3250 packets. If this parameter is zero, no keepalive packets will be
3251 sent. Keepalive packets, if sent, allow the server to tell whether
3252 a client is still present and responding.
3254 Keepalives should, in general, not be needed if the socket
3255 being used has the SO_KEEPALIVE attribute set on it (see \fIsocket options\fR).
3256 Basically you should only use this option if you strike difficulties.
3258 Default: \fBkeepalive = 300\fR
3260 Example: \fBkeepalive = 600\fR
3262 \fBkernel oplocks (G)\fR
3263 For UNIXes that support kernel based \fIoplocks\fR
3264 (currently only IRIX and the Linux 2.4 kernel), this parameter
3265 allows the use of them to be turned on or off.
3267 Kernel oplocks support allows Samba \fIoplocks
3268 \fRto be broken whenever a local UNIX process or NFS operation
3269 accesses a file that \fBsmbd(8)\fR
3270 has oplocked. This allows complete data consistency between
3271 SMB/CIFS, NFS and local file access (and is a \fBvery\fR
3274 This parameter defaults to on, but is translated
3275 to a no-op on systems that no not have the necessary kernel support.
3276 You should never need to touch this parameter.
3278 See also the \fIoplocks\fR
3279 and \fIlevel2 oplocks
3282 Default: \fBkernel oplocks = yes\fR
3284 \fBlanman auth (G)\fR
3285 This parameter determines whether or not smbdwill
3286 attempt to authenticate users using the LANMAN password hash.
3287 If disabled, only clients which support NT password hashes (e.g. Windows
3288 NT/2000 clients, smbclient, etc... but not Windows 95/98 or the MS DOS
3289 network client) will be able to connect to the Samba host.
3291 Default : \fBlanman auth = yes\fR
3293 \fBlarge readwrite (G)\fR
3294 This parameter determines whether or not smbd
3295 supports the new 64k streaming read and write varient SMB requests introduced
3296 with Windows 2000. Note that due to Windows 2000 client redirector bugs
3297 this requires Samba to be running on a 64-bit capable operating system such
3298 as IRIX, Solaris or a Linux 2.4 kernel. Can improve performance by 10% with
3299 Windows 2000 clients. Defaults to on. Not as tested as some other Samba
3302 Default : \fBlarge readwrite = yes\fR
3304 \fBldap admin dn (G)\fR
3305 This parameter is only available if Samba has been
3306 configure to include the \fB--with-ldapsam\fR option
3307 at compile time. This option should be considered experimental and
3308 under active development.
3310 The \fIldap admin dn\fR defines the Distinguished
3311 Name (DN) name used by Samba to contact the ldap
3312 server when retreiving user account information. The \fIldap
3313 admin dn\fR is used in conjunction with the admin dn password
3314 stored in the \fIprivate/secrets.tdb\fR file. See the
3315 \fBsmbpasswd(8)\fRman
3316 page for more information on how to accmplish this.
3318 Default : \fBnone\fR
3320 \fBldap filter (G)\fR
3321 This parameter is only available if Samba has been
3322 configure to include the \fB--with-ldapsam\fR option
3323 at compile time. This option should be considered experimental and
3324 under active development.
3326 This parameter specifies the RFC 2254 compliant LDAP search filter.
3327 The default is to match the login name with the uid
3328 attribute for all entries matching the sambaAccount
3329 objectclass. Note that this filter should only return one entry.
3331 Default : \fBldap filter = (&(uid=%u)(objectclass=sambaAccount))\fR
3334 This parameter is only available if Samba has been
3335 configure to include the \fB--with-ldapsam\fR option
3336 at compile time. This option should be considered experimental and
3337 under active development.
3339 This option is used to control the tcp port number used to contact
3340 the \fIldap server\fR.
3341 The default is to use the stand LDAPS port 636.
3345 Default : \fBldap port = 636\fR
3347 \fBldap server (G)\fR
3348 This parameter is only available if Samba has been
3349 configure to include the \fB--with-ldapsam\fR option
3350 at compile time. This option should be considered experimental and
3351 under active development.
3353 This parameter should contains the FQDN of the ldap directory
3354 server which should be queried to locate user account information.
3356 Default : \fBldap server = localhost\fR
3359 This parameter is only available if Samba has been
3360 configure to include the \fB--with-ldapsam\fR option
3361 at compile time. This option should be considered experimental and
3362 under active development.
3364 This option is used to define whether or not Samba should
3365 use SSL when connecting to the \fIldap
3366 server\fR. This is \fBNOT\fR related to
3367 Samba SSL support which is enabled by specifying the
3368 \fB--with-ssl\fR option to the \fIconfigure\fR
3369 script (see \fIssl\fR).
3371 The \fIldap ssl\fR can be set to one of three values:
3372 (a) on - Always use SSL when contacting the
3373 \fIldap server\fR, (b) off -
3374 Never use SSL when querying the directory, or (c) start_tls
3375 - Use the LDAPv3 StartTLS extended operation
3376 (RFC2830) for communicating with the directory server.
3378 Default : \fBldap ssl = on\fR
3380 \fBldap suffix (G)\fR
3381 This parameter is only available if Samba has been
3382 configure to include the \fB--with-ldapsam\fR option
3383 at compile time. This option should be considered experimental and
3384 under active development.
3386 Default : \fBnone\fR
3388 \fBlevel2 oplocks (S)\fR
3389 This parameter controls whether Samba supports
3390 level2 (read-only) oplocks on a share.
3392 Level2, or read-only oplocks allow Windows NT clients
3393 that have an oplock on a file to downgrade from a read-write oplock
3394 to a read-only oplock once a second client opens the file (instead
3395 of releasing all oplocks on a second open, as in traditional,
3396 exclusive oplocks). This allows all openers of the file that
3397 support level2 oplocks to cache the file for read-ahead only (ie.
3398 they may not cache writes or lock requests) and increases performance
3399 for many accesses of files that are not commonly written (such as
3400 application .EXE files).
3402 Once one of the clients which have a read-only oplock
3403 writes to the file all clients are notified (no reply is needed
3404 or waited for) and told to break their oplocks to "none" and
3405 delete any read-ahead caches.
3407 It is recommended that this parameter be turned on
3408 to speed access to shared executables.
3410 For more discussions on level2 oplocks see the CIFS spec.
3412 Currently, if \fIkernel
3413 oplocks\fR are supported then level2 oplocks are
3414 not granted (even if this parameter is set to yes).
3415 Note also, the \fIoplocks\fR
3416 parameter must be set to true on this share in order for
3417 this parameter to have any effect.
3419 See also the \fIoplocks\fR
3420 and \fIkernel oplocks\fR
3423 Default: \fBlevel2 oplocks = yes\fR
3425 \fBlm announce (G)\fR
3426 This parameter determines if \fBnmbd(8)\fRwill produce Lanman announce
3427 broadcasts that are needed by OS/2 clients in order for them to see
3428 the Samba server in their browse list. This parameter can have three
3429 values, true, false, or
3430 auto. The default is auto.
3431 If set to false Samba will never produce these
3432 broadcasts. If set to true Samba will produce
3433 Lanman announce broadcasts at a frequency set by the parameter
3434 \fIlm interval\fR. If set to auto
3435 Samba will not send Lanman announce broadcasts by default but will
3436 listen for them. If it hears such a broadcast on the wire it will
3437 then start sending them at a frequency set by the parameter
3440 See also \fIlm interval
3443 Default: \fBlm announce = auto\fR
3445 Example: \fBlm announce = yes\fR
3447 \fBlm interval (G)\fR
3448 If Samba is set to produce Lanman announce
3449 broadcasts needed by OS/2 clients (see the \fIlm announce\fR parameter) then this
3450 parameter defines the frequency in seconds with which they will be
3451 made. If this is set to zero then no Lanman announcements will be
3452 made despite the setting of the \fIlm announce\fR
3458 Default: \fBlm interval = 60\fR
3460 Example: \fBlm interval = 120\fR
3462 \fBload printers (G)\fR
3463 A boolean variable that controls whether all
3464 printers in the printcap will be loaded for browsing by default.
3465 See the printers section for
3468 Default: \fBload printers = yes\fR
3470 \fBlocal master (G)\fR
3471 This option allows \fB nmbd(8)\fRto try and become a local master browser
3472 on a subnet. If set to false then \fB nmbd\fR will not attempt to become a local master browser
3473 on a subnet and will also lose in all browsing elections. By
3474 default this value is set to true. Setting this value to true doesn't
3475 mean that Samba will \fBbecome\fR the local master
3476 browser on a subnet, just that \fBnmbd\fR will \fB participate\fR in elections for local master browser.
3478 Setting this value to false will cause \fBnmbd\fR
3479 \fBnever\fR to become a local master browser.
3481 Default: \fBlocal master = yes\fR
3484 Synonym for \fI lock directory\fR.
3486 \fBlock directory (G)\fR
3487 This option specifies the directory where lock
3488 files will be placed. The lock files are used to implement the
3489 \fImax connections\fR
3492 Default: \fBlock directory = ${prefix}/var/locks\fR
3494 Example: \fBlock directory = /var/run/samba/locks\fR
3496 \fBlock spin count (G)\fR
3497 This parameter controls the number of times
3498 that smbd should attempt to gain a byte range lock on the
3499 behalf of a client request. Experiments have shown that
3500 Windows 2k servers do not reply with a failure if the lock
3501 could not be immediately granted, but try a few more times
3502 in case the lock could later be aquired. This behavior
3503 is used to support PC database formats such as MS Access
3506 Default: \fBlock spin count = 2\fR
3508 \fBlock spin time (G)\fR
3509 The time in microseconds that smbd should
3510 pause before attempting to gain a failed lock. See
3512 count\fR for more details.
3514 Default: \fBlock spin time = 10\fR
3517 This controls whether or not locking will be
3518 performed by the server in response to lock requests from the
3521 If \fBlocking = no\fR, all lock and unlock
3522 requests will appear to succeed and all lock queries will report
3523 that the file in question is available for locking.
3525 If \fBlocking = yes\fR, real locking will be performed
3528 This option \fBmay\fR be useful for read-only
3529 filesystems which \fBmay\fR not need locking (such as
3530 CDROM drives), although setting this parameter of no
3531 is not really recommended even in this case.
3533 Be careful about disabling locking either globally or in a
3534 specific service, as lack of locking may result in data corruption.
3535 You should never need to set this parameter.
3537 Default: \fBlocking = yes\fR
3540 This option allows you to override the name
3541 of the Samba log file (also known as the debug file).
3543 This option takes the standard substitutions, allowing
3544 you to have separate log files for each user or machine.
3546 Example: \fBlog file = /usr/local/samba/var/log.%m
3549 The value of the parameter (an integer) allows
3550 the debug level (logging level) to be specified in the
3551 \fIsmb.conf\fR file. This is to give greater
3552 flexibility in the configuration of the system.
3554 The default will be the log level specified on
3555 the command line or level zero if none was specified.
3557 Example: \fBlog level = 3\fR
3559 \fBlogon drive (G)\fR
3560 This parameter specifies the local path to
3561 which the home directory will be connected (see \fIlogon home\fR)
3562 and is only used by NT Workstations.
3564 Note that this option is only useful if Samba is set up as a
3567 Default: \fBlogon drive = z:\fR
3569 Example: \fBlogon drive = h:\fR
3571 \fBlogon home (G)\fR
3572 This parameter specifies the home directory
3573 location when a Win95/98 or NT Workstation logs into a Samba PDC.
3576 C:\\> \fBNET USE H: /HOME\fR
3578 from a command prompt, for example.
3580 This option takes the standard substitutions, allowing
3581 you to have separate logon scripts for each user or machine.
3583 This parameter can be used with Win9X workstations to ensure
3584 that roaming profiles are stored in a subdirectory of the user's
3585 home directory. This is done in the following way:
3587 \fBlogon home = \\\\%N\\%U\\profile\fR
3589 This tells Samba to return the above string, with
3590 substitutions made when a client requests the info, generally
3591 in a NetUserGetInfo request. Win9X clients truncate the info to
3592 \\\\server\\share when a user does \fBnet use /home\fR
3593 but use the whole string when dealing with profiles.
3595 Note that in prior versions of Samba, the \fIlogon path\fR was returned rather than
3596 \fIlogon home\fR. This broke \fBnet use
3597 /home\fR but allowed profiles outside the home directory.
3598 The current implementation is correct, and can be used for
3599 profiles if you use the above trick.
3601 This option is only useful if Samba is set up as a logon
3604 Default: \fBlogon home = "\\\\%N\\%U"\fR
3606 Example: \fBlogon home = "\\\\remote_smb_server\\%U"\fR
3608 \fBlogon path (G)\fR
3609 This parameter specifies the home directory
3610 where roaming profiles (NTuser.dat etc files for Windows NT) are
3611 stored. Contrary to previous versions of these manual pages, it has
3612 nothing to do with Win 9X roaming profiles. To find out how to
3613 handle roaming profiles for Win 9X system, see the \fIlogon home\fR parameter.
3615 This option takes the standard substitutions, allowing you
3616 to have separate logon scripts for each user or machine. It also
3617 specifies the directory from which the "Application Data",
3618 (\fIdesktop\fR, \fIstart menu\fR,
3619 \fInetwork neighborhood\fR, \fIprograms\fR
3620 and other folders, and their contents, are loaded and displayed on
3621 your Windows NT client.
3623 The share and the path must be readable by the user for
3624 the preferences and directories to be loaded onto the Windows NT
3625 client. The share must be writeable when the user logs in for the first
3626 time, in order that the Windows NT client can create the NTuser.dat
3627 and other directories.
3629 Thereafter, the directories and any of the contents can,
3630 if required, be made read-only. It is not advisable that the
3631 NTuser.dat file be made read-only - rename it to NTuser.man to
3632 achieve the desired effect (a \fBMAN\fRdatory
3635 Windows clients can sometimes maintain a connection to
3636 the [homes] share, even though there is no user logged in.
3637 Therefore, it is vital that the logon path does not include a
3638 reference to the homes share (i.e. setting this parameter to
3639 \\%N\\%U\\profile_path will cause problems).
3641 This option takes the standard substitutions, allowing
3642 you to have separate logon scripts for each user or machine.
3644 Note that this option is only useful if Samba is set up
3647 Default: \fBlogon path = \\\\%N\\%U\\profile\fR
3649 Example: \fBlogon path = \\\\PROFILESERVER\\PROFILE\\%U\fR
3651 \fBlogon script (G)\fR
3652 This parameter specifies the batch file (.bat) or
3653 NT command file (.cmd) to be downloaded and run on a machine when
3654 a user successfully logs in. The file must contain the DOS
3655 style CR/LF line endings. Using a DOS-style editor to create the
3656 file is recommended.
3658 The script must be a relative path to the [netlogon]
3659 service. If the [netlogon] service specifies a \fIpath\fR of \fI/usr/local/samba/netlogon
3660 \fR, and \fBlogon script = STARTUP.BAT\fR, then
3661 the file that will be downloaded is:
3663 \fI/usr/local/samba/netlogon/STARTUP.BAT\fR
3665 The contents of the batch file are entirely your choice. A
3666 suggested command would be to add \fBNET TIME \\\\SERVER /SET
3667 /YES\fR, to force every machine to synchronize clocks with
3668 the same time server. Another use would be to add \fBNET USE
3669 U: \\\\SERVER\\UTILS\fR for commonly used utilities, or \fB NET USE Q: \\\\SERVER\\ISO9001_QA\fR for example.
3671 Note that it is particularly important not to allow write
3672 access to the [netlogon] share, or to grant users write permission
3673 on the batch files in a secure environment, as this would allow
3674 the batch files to be arbitrarily modified and security to be
3677 This option takes the standard substitutions, allowing you
3678 to have separate logon scripts for each user or machine.
3680 This option is only useful if Samba is set up as a logon
3683 Default: \fBno logon script defined\fR
3685 Example: \fBlogon script = scripts\\%U.bat\fR
3687 \fBlppause command (S)\fR
3688 This parameter specifies the command to be
3689 executed on the server host in order to stop printing or spooling
3690 a specific print job.
3692 This command should be a program or script which takes
3693 a printer name and job number to pause the print job. One way
3694 of implementing this is by using job priorities, where jobs
3695 having a too low priority won't be sent to the printer.
3697 If a \fI%p\fR is given then the printer name
3698 is put in its place. A \fI%j\fR is replaced with
3699 the job number (an integer). On HPUX (see \fIprinting=hpux
3700 \fR), if the \fI-p%p\fR option is added
3701 to the lpq command, the job will show up with the correct status, i.e.
3702 if the job priority is lower than the set fence priority it will
3703 have the PAUSED status, whereas if the priority is equal or higher it
3704 will have the SPOOLED or PRINTING status.
3706 Note that it is good practice to include the absolute path
3707 in the lppause command as the PATH may not be available to the server.
3709 See also the \fIprinting
3712 Default: Currently no default value is given to
3713 this string, unless the value of the \fIprinting\fR
3714 parameter is SYSV, in which case the default is :
3716 \fBlp -i %p-%j -H hold\fR
3718 or if the value of the \fIprinting\fR parameter
3719 is SOFTQ, then the default is:
3721 \fBqstat -s -j%j -h\fR
3723 Example for HPUX: \fBlppause command = /usr/bin/lpalt
3726 \fBlpq cache time (G)\fR
3727 This controls how long lpq info will be cached
3728 for to prevent the \fBlpq\fR command being called too
3729 often. A separate cache is kept for each variation of the \fB lpq\fR command used by the system, so if you use different
3730 \fBlpq\fR commands for different users then they won't
3731 share cache information.
3733 The cache files are stored in \fI/tmp/lpq.xxxx\fR
3734 where xxxx is a hash of the \fBlpq\fR command in use.
3736 The default is 10 seconds, meaning that the cached results
3737 of a previous identical \fBlpq\fR command will be used
3738 if the cached data is less than 10 seconds old. A large value may
3739 be advisable if your \fBlpq\fR command is very slow.
3741 A value of 0 will disable caching completely.
3743 See also the \fIprinting
3746 Default: \fBlpq cache time = 10\fR
3748 Example: \fBlpq cache time = 30\fR
3750 \fBlpq command (S)\fR
3751 This parameter specifies the command to be
3752 executed on the server host in order to obtain \fBlpq
3753 \fR-style printer status information.
3755 This command should be a program or script which
3756 takes a printer name as its only parameter and outputs printer
3759 Currently nine styles of printer status information
3760 are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ.
3761 This covers most UNIX systems. You control which type is expected
3762 using the \fIprinting =\fR option.
3764 Some clients (notably Windows for Workgroups) may not
3765 correctly send the connection number for the printer they are
3766 requesting status information about. To get around this, the
3767 server reports on the first printer service connected to by the
3768 client. This only happens if the connection number sent is invalid.
3770 If a \fI%p\fR is given then the printer name
3771 is put in its place. Otherwise it is placed at the end of the
3774 Note that it is good practice to include the absolute path
3775 in the \fIlpq command\fR as the \fB$PATH
3776 \fRmay not be available to the server. When compiled with
3777 the CUPS libraries, no \fIlpq command\fR is
3778 needed because smbd will make a library call to obtain the
3779 print queue listing.
3781 See also the \fIprinting
3784 Default: \fBdepends on the setting of \fI printing\fB\fR
3786 Example: \fBlpq command = /usr/bin/lpq -P%p\fR
3788 \fBlpresume command (S)\fR
3789 This parameter specifies the command to be
3790 executed on the server host in order to restart or continue
3791 printing or spooling a specific print job.
3793 This command should be a program or script which takes
3794 a printer name and job number to resume the print job. See
3795 also the \fIlppause command
3798 If a \fI%p\fR is given then the printer name
3799 is put in its place. A \fI%j\fR is replaced with
3800 the job number (an integer).
3802 Note that it is good practice to include the absolute path
3803 in the \fIlpresume command\fR as the PATH may not
3804 be available to the server.
3806 See also the \fIprinting
3809 Default: Currently no default value is given
3810 to this string, unless the value of the \fIprinting\fR
3811 parameter is SYSV, in which case the default is :
3813 \fBlp -i %p-%j -H resume\fR
3815 or if the value of the \fIprinting\fR parameter
3816 is SOFTQ, then the default is:
3818 \fBqstat -s -j%j -r\fR
3820 Example for HPUX: \fBlpresume command = /usr/bin/lpalt
3823 \fBlprm command (S)\fR
3824 This parameter specifies the command to be
3825 executed on the server host in order to delete a print job.
3827 This command should be a program or script which takes
3828 a printer name and job number, and deletes the print job.
3830 If a \fI%p\fR is given then the printer name
3831 is put in its place. A \fI%j\fR is replaced with
3832 the job number (an integer).
3834 Note that it is good practice to include the absolute
3835 path in the \fIlprm command\fR as the PATH may not be
3836 available to the server.
3838 See also the \fIprinting
3841 Default: \fBdepends on the setting of \fIprinting
3843 Example 1: \fBlprm command = /usr/bin/lprm -P%p %j
3845 Example 2: \fBlprm command = /usr/bin/cancel %p-%j
3847 \fBmachine password timeout (G)\fR
3848 If a Samba server is a member of a Windows
3849 NT Domain (see the security = domain)
3850 parameter) then periodically a running smbd(8)process will try and change the MACHINE ACCOUNT
3851 PASSWORD stored in the TDB called \fIprivate/secrets.tdb
3852 \fR\&. This parameter specifies how often this password
3853 will be changed, in seconds. The default is one week (expressed in
3854 seconds), the same as a Windows NT Domain member server.
3856 See also \fBsmbpasswd(8)
3857 \fR, and the security = domain) parameter.
3859 Default: \fBmachine password timeout = 604800\fR
3861 \fBmagic output (S)\fR
3862 This parameter specifies the name of a file
3863 which will contain output created by a magic script (see the
3867 Warning: If two clients use the same \fImagic script
3868 \fRin the same directory the output file content
3871 Default: \fBmagic output = <magic script name>.out
3873 Example: \fBmagic output = myfile.txt\fR
3875 \fBmagic script (S)\fR
3876 This parameter specifies the name of a file which,
3877 if opened, will be executed by the server when the file is closed.
3878 This allows a UNIX script to be sent to the Samba host and
3879 executed on behalf of the connected user.
3881 Scripts executed in this way will be deleted upon
3882 completion assuming that the user has the appropriate level
3883 of privilege and the file permissions allow the deletion.
3885 If the script generates output, output will be sent to
3886 the file specified by the \fI magic output\fR parameter (see above).
3888 Note that some shells are unable to interpret scripts
3889 containing CR/LF instead of CR as
3890 the end-of-line marker. Magic scripts must be executable
3891 \fBas is\fR on the host, which for some hosts and
3892 some shells will require filtering at the DOS end.
3894 Magic scripts are \fBEXPERIMENTAL\fR and
3895 should \fBNOT\fR be relied upon.
3897 Default: \fBNone. Magic scripts disabled.\fR
3899 Example: \fBmagic script = user.csh\fR
3901 \fBmangle case (S)\fR
3902 See the section on NAME MANGLING
3904 Default: \fBmangle case = no\fR
3906 \fBmangled map (S)\fR
3907 This is for those who want to directly map UNIX
3908 file names which cannot be represented on Windows/DOS. The mangling
3909 of names is not always what is needed. In particular you may have
3910 documents with file extensions that differ between DOS and UNIX.
3911 For example, under UNIX it is common to use \fI.html\fR
3912 for HTML files, whereas under Windows/DOS \fI.htm\fR
3913 is more commonly used.
3915 So to map \fIhtml\fR to \fIhtm\fR
3918 \fBmangled map = (*.html *.htm)\fR
3920 One very useful case is to remove the annoying \fI;1
3921 \fRoff the ends of filenames on some CDROMs (only visible
3922 under some UNIXes). To do this use a map of (*;1 *;).
3924 Default: \fBno mangled map\fR
3926 Example: \fBmangled map = (*;1 *;)\fR
3928 \fBmangled names (S)\fR
3929 This controls whether non-DOS names under UNIX
3930 should be mapped to DOS-compatible names ("mangled") and made visible,
3931 or whether non-DOS names should simply be ignored.
3933 See the section on NAME MANGLING for details on how to control the mangling process.
3935 If mangling is used then the mangling algorithm is as follows:
3939 The first (up to) five alphanumeric characters
3940 before the rightmost dot of the filename are preserved, forced
3941 to upper case, and appear as the first (up to) five characters
3942 of the mangled name.
3945 A tilde "~" is appended to the first part of the mangled
3946 name, followed by a two-character unique sequence, based on the
3947 original root name (i.e., the original filename minus its final
3948 extension). The final extension is included in the hash calculation
3949 only if it contains any upper case characters or is longer than three
3952 Note that the character to use may be specified using
3953 the \fImangling char\fR
3954 option, if you don't like '~'.
3957 The first three alphanumeric characters of the final
3958 extension are preserved, forced to upper case and appear as the
3959 extension of the mangled name. The final extension is defined as that
3960 part of the original filename after the rightmost dot. If there are no
3961 dots in the filename, the mangled name will have no extension (except
3962 in the case of "hidden files" - see below).
3965 Files whose UNIX name begins with a dot will be
3966 presented as DOS hidden files. The mangled name will be created as
3967 for other filenames, but with the leading dot removed and "___" as
3968 its extension regardless of actual original extension (that's three
3972 The two-digit hash value consists of upper case
3973 alphanumeric characters.
3976 This algorithm can cause name collisions only if files
3977 in a directory share the same first five alphanumeric characters.
3978 The probability of such a clash is 1/1300.
3981 The name mangling (if enabled) allows a file to be
3982 copied between UNIX directories from Windows/DOS while retaining
3983 the long UNIX filename. UNIX files can be renamed to a new extension
3984 from Windows/DOS and will retain the same basename. Mangled names
3985 do not change between sessions.
3988 Default: \fBmangled names = yes\fR
3991 \fBmangled stack (G)\fR
3992 This parameter controls the number of mangled names
3993 that should be cached in the Samba server smbd(8).
3995 This stack is a list of recently mangled base names
3996 (extensions are only maintained if they are longer than 3 characters
3997 or contains upper case characters).
3999 The larger this value, the more likely it is that mangled
4000 names can be successfully converted to correct long UNIX names.
4001 However, large stack sizes will slow most directory accesses. Smaller
4002 stacks save memory in the server (each stack element costs 256 bytes).
4004 It is not possible to absolutely guarantee correct long
4005 filenames, so be prepared for some surprises!
4007 Default: \fBmangled stack = 50\fR
4009 Example: \fBmangled stack = 100\fR
4011 \fBmangling char (S)\fR
4012 This controls what character is used as
4013 the \fBmagic\fR character in name mangling. The default is a '~'
4014 but this may interfere with some software. Use this option to set
4015 it to whatever you prefer.
4017 Default: \fBmangling char = ~\fR
4019 Example: \fBmangling char = ^\fR
4021 \fBmap archive (S)\fR
4022 This controls whether the DOS archive attribute
4023 should be mapped to the UNIX owner execute bit. The DOS archive bit
4024 is set when a file has been modified since its last backup. One
4025 motivation for this option it to keep Samba/your PC from making
4026 any file it touches from becoming executable under UNIX. This can
4027 be quite annoying for shared source code, documents, etc...
4029 Note that this requires the \fIcreate mask\fR
4030 parameter to be set such that owner execute bit is not masked out
4031 (i.e. it must include 100). See the parameter \fIcreate mask\fR for details.
4033 Default: \fBmap archive = yes\fR
4035 \fBmap hidden (S)\fR
4036 This controls whether DOS style hidden files
4037 should be mapped to the UNIX world execute bit.
4039 Note that this requires the \fIcreate mask\fR
4040 to be set such that the world execute bit is not masked out (i.e.
4041 it must include 001). See the parameter \fIcreate mask\fR for details.
4043 Default: \fBmap hidden = no\fR
4045 \fBmap system (S)\fR
4046 This controls whether DOS style system files
4047 should be mapped to the UNIX group execute bit.
4049 Note that this requires the \fIcreate mask\fR
4050 to be set such that the group execute bit is not masked out (i.e.
4051 it must include 010). See the parameter \fIcreate mask\fR for details.
4053 Default: \fBmap system = no\fR
4055 \fBmap to guest (G)\fR
4056 This parameter is only useful in security modes other than \fIsecurity = share\fR
4057 - i.e. user, server,
4060 This parameter can take three different values, which tell
4061 smbd(8)what to do with user
4062 login requests that don't match a valid UNIX user in some way.
4064 The three settings are :
4068 Never - Means user login
4069 requests with an invalid password are rejected. This is the
4073 Bad User - Means user
4074 logins with an invalid password are rejected, unless the username
4075 does not exist, in which case it is treated as a guest login and
4076 mapped into the \fI guest account\fR.
4079 Bad Password - Means user logins
4080 with an invalid password are treated as a guest login and mapped
4081 into the guest account. Note that
4082 this can cause problems as it means that any user incorrectly typing
4083 their password will be silently logged on as "guest" - and
4084 will not know the reason they cannot access files they think
4085 they should - there will have been no message given to them
4086 that they got their password wrong. Helpdesk services will
4087 \fBhate\fR you if you set the \fImap to
4088 guest\fR parameter this way :-).
4091 Note that this parameter is needed to set up "Guest"
4092 share services when using \fIsecurity\fR modes other than
4093 share. This is because in these modes the name of the resource being
4094 requested is \fBnot\fR sent to the server until after
4095 the server has successfully authenticated the client so the server
4096 cannot make authentication decisions at the correct time (connection
4097 to the share) for "Guest" shares.
4100 For people familiar with the older Samba releases, this
4101 parameter maps to the old compile-time setting of the GUEST_SESSSETUP value in local.h.
4104 Default: \fBmap to guest = Never\fR
4107 Example: \fBmap to guest = Bad User\fR
4110 \fBmax connections (S)\fR
4111 This option allows the number of simultaneous
4112 connections to a service to be limited. If \fImax connections
4113 \fRis greater than 0 then connections will be refused if
4114 this number of connections to the service are already open. A value
4115 of zero mean an unlimited number of connections may be made.
4117 Record lock files are used to implement this feature. The
4118 lock files will be stored in the directory specified by the \fIlock directory\fR
4121 Default: \fBmax connections = 0\fR
4123 Example: \fBmax connections = 10\fR
4125 \fBmax disk size (G)\fR
4126 This option allows you to put an upper limit
4127 on the apparent size of disks. If you set this option to 100
4128 then all shares will appear to be not larger than 100 MB in
4131 Note that this option does not limit the amount of
4132 data you can put on the disk. In the above case you could still
4133 store much more than 100 MB on the disk, but if a client ever asks
4134 for the amount of free disk space or the total disk size then the
4135 result will be bounded by the amount specified in \fImax
4138 This option is primarily useful to work around bugs
4139 in some pieces of software that can't handle very large disks,
4140 particularly disks over 1GB in size.
4142 A \fImax disk size\fR of 0 means no limit.
4144 Default: \fBmax disk size = 0\fR
4146 Example: \fBmax disk size = 1000\fR
4148 \fBmax log size (G)\fR
4149 This option (an integer in kilobytes) specifies
4150 the max size the log file should grow to. Samba periodically checks
4151 the size and if it is exceeded it will rename the file, adding
4152 a \fI.old\fR extension.
4154 A size of 0 means no limit.
4156 Default: \fBmax log size = 5000\fR
4158 Example: \fBmax log size = 1000\fR
4161 This option controls the maximum number of
4162 outstanding simultaneous SMB operations that Samba tells the client
4163 it will allow. You should never need to set this parameter.
4165 Default: \fBmax mux = 50\fR
4167 \fBmax open files (G)\fR
4168 This parameter limits the maximum number of
4169 open files that one smbd(8)file
4170 serving process may have open for a client at any one time. The
4171 default for this parameter is set very high (10,000) as Samba uses
4172 only one bit per unopened file.
4174 The limit of the number of open files is usually set
4175 by the UNIX per-process file descriptor limit rather than
4176 this parameter so you should never need to touch this parameter.
4178 Default: \fBmax open files = 10000\fR
4180 \fBmax print jobs (S)\fR
4181 This parameter limits the maximum number of
4182 jobs allowable in a Samba printer queue at any given moment.
4183 If this number is exceeded, \fB smbd(8)\fRwill remote "Out of Space" to the client.
4187 Default: \fBmax print jobs = 1000\fR
4189 Example: \fBmax print jobs = 5000\fR
4191 \fBmax protocol (G)\fR
4192 The value of the parameter (a string) is the highest
4193 protocol level that will be supported by the server.
4195 Possible values are :
4199 CORE: Earliest version. No
4200 concept of user names.
4203 COREPLUS: Slight improvements on
4204 CORE for efficiency.
4207 LANMAN1: First \fB modern\fR version of the protocol. Long filename
4211 LANMAN2: Updates to Lanman1 protocol.
4214 NT1: Current up to date version of
4215 the protocol. Used by Windows NT. Known as CIFS.
4218 Normally this option should not be set as the automatic
4219 negotiation phase in the SMB protocol takes care of choosing
4220 the appropriate protocol.
4227 Default: \fBmax protocol = NT1\fR
4230 Example: \fBmax protocol = LANMAN1\fR
4233 \fBmax smbd processes (G)\fR
4234 This parameter limits the maximum number of
4236 processes concurrently running on a system and is intended
4237 as a stopgap to prevent degrading service to clients in the event
4238 that the server has insufficient resources to handle more than this
4239 number of connections. Remember that under normal operating
4240 conditions, each user will have an smbdassociated with him or her
4241 to handle connections to all shares from a given host.
4243 Default: \fBmax smbd processes = 0\fR ## no limit
4245 Example: \fBmax smbd processes = 1000\fR
4248 This option tells nmbd(8)
4249 what the default 'time to live' of NetBIOS names should be (in seconds)
4250 when \fBnmbd\fR is requesting a name using either a
4251 broadcast packet or from a WINS server. You should never need to
4252 change this parameter. The default is 3 days.
4254 Default: \fBmax ttl = 259200\fR
4256 \fBmax wins ttl (G)\fR
4257 This option tells nmbd(8)
4258 when acting as a WINS server ( \fIwins support = yes\fR) what the maximum
4259 \&'time to live' of NetBIOS names that \fBnmbd\fR
4260 will grant will be (in seconds). You should never need to change this
4261 parameter. The default is 6 days (518400 seconds).
4264 wins ttl\fR parameter.
4266 Default: \fBmax wins ttl = 518400\fR
4269 This option controls the maximum packet size
4270 that will be negotiated by Samba. The default is 65535, which
4271 is the maximum. In some cases you may find you get better performance
4272 with a smaller value. A value below 2048 is likely to cause problems.
4274 Default: \fBmax xmit = 65535\fR
4276 Example: \fBmax xmit = 8192\fR
4278 \fBmessage command (G)\fR
4279 This specifies what command to run when the
4280 server receives a WinPopup style message.
4282 This would normally be a command that would
4283 deliver the message somehow. How this is to be done is
4284 up to your imagination.
4288 \fBmessage command = csh -c 'xedit %s;rm %s' &\fR
4290 This delivers the message using \fBxedit\fR, then
4291 removes it afterwards. \fBNOTE THAT IT IS VERY IMPORTANT
4292 THAT THIS COMMAND RETURN IMMEDIATELY\fR. That's why I
4293 have the '&' on the end. If it doesn't return immediately then
4294 your PCs may freeze when sending messages (they should recover
4295 after 30 seconds, hopefully).
4297 All messages are delivered as the global guest user.
4298 The command takes the standard substitutions, although \fI %u\fR won't work (\fI%U\fR may be better
4301 Apart from the standard substitutions, some additional
4302 ones apply. In particular:
4306 \fI%s\fR = the filename containing
4310 \fI%t\fR = the destination that
4311 the message was sent to (probably the server name).
4314 \fI%f\fR = who the message
4318 You could make this command send mail, or whatever else
4319 takes your fancy. Please let us know of any really interesting
4323 Here's a way of sending the messages as mail to root:
4326 \fBmessage command = /bin/mail -s 'message from %f on
4327 %m' root < %s; rm %s\fR
4330 If you don't have a message command then the message
4331 won't be delivered and Samba will tell the sender there was
4332 an error. Unfortunately WfWg totally ignores the error code
4333 and carries on regardless, saying that the message was delivered.
4336 If you want to silently delete it then try:
4339 \fBmessage command = rm %s\fR
4342 Default: \fBno message command\fR
4345 Example: \fBmessage command = csh -c 'xedit %s;
4349 \fBmin passwd length (G)\fR
4350 Synonym for \fImin password length\fR.
4352 \fBmin password length (G)\fR
4353 This option sets the minimum length in characters
4354 of a plaintext password that \fBsmbd\fR will accept when performing
4355 UNIX password changing.
4358 password sync\fR, \fIpasswd program\fR and \fIpasswd chat debug\fR
4361 Default: \fBmin password length = 5\fR
4363 \fBmin print space (S)\fR
4364 This sets the minimum amount of free disk
4365 space that must be available before a user will be able to spool
4366 a print job. It is specified in kilobytes. The default is 0, which
4367 means a user can always spool a print job.
4369 See also the \fIprinting
4372 Default: \fBmin print space = 0\fR
4374 Example: \fBmin print space = 2000\fR
4376 \fBmin protocol (G)\fR
4377 The value of the parameter (a string) is the
4378 lowest SMB protocol dialect than Samba will support. Please refer
4379 to the \fImax protocol\fR
4380 parameter for a list of valid protocol names and a brief description
4381 of each. You may also wish to refer to the C source code in
4382 \fIsource/smbd/negprot.c\fR for a listing of known protocol
4383 dialects supported by clients.
4385 If you are viewing this parameter as a security measure, you should
4386 also refer to the \fIlanman
4387 auth\fR parameter. Otherwise, you should never need
4388 to change this parameter.
4390 Default : \fBmin protocol = CORE\fR
4392 Example : \fBmin protocol = NT1\fR # disable DOS
4395 \fBmin wins ttl (G)\fR
4396 This option tells nmbd(8)
4397 when acting as a WINS server (\fI wins support = yes\fR) what the minimum 'time to live'
4398 of NetBIOS names that \fBnmbd\fR will grant will be (in
4399 seconds). You should never need to change this parameter. The default
4400 is 6 hours (21600 seconds).
4402 Default: \fBmin wins ttl = 21600\fR
4404 \fBmsdfs root (S)\fR
4405 This boolean parameter is only available if
4406 Samba is configured and compiled with the \fB --with-msdfs\fR option. If set to yes,
4407 Samba treats the share as a Dfs root and allows clients to browse
4408 the distributed file system tree rooted at the share directory.
4409 Dfs links are specified in the share directory by symbolic
4410 links of the form \fImsdfs:serverA\\shareA,serverB\\shareB
4411 \fRand so on. For more information on setting up a Dfs tree
4412 on Samba, refer to msdfs_setup.html
4415 See also \fIhost msdfs
4417 Default: \fBmsdfs root = no\fR
4419 \fBname resolve order (G)\fR
4420 This option is used by the programs in the Samba
4421 suite to determine what naming services to use and in what order
4422 to resolve host names to IP addresses. The option takes a space
4423 separated string of name resolution options.
4425 The options are :"lmhosts", "host", "wins" and "bcast". They
4426 cause names to be resolved as follows :
4430 lmhosts : Lookup an IP
4431 address in the Samba lmhosts file. If the line in lmhosts has
4432 no name type attached to the NetBIOS name (see the lmhosts(5)for details) then
4433 any name type matches for lookup.
4436 host : Do a standard host
4437 name to IP address resolution, using the system \fI/etc/hosts
4438 \fR, NIS, or DNS lookups. This method of name resolution
4439 is operating system depended for instance on IRIX or Solaris this
4440 may be controlled by the \fI/etc/nsswitch.conf\fR
4441 file. Note that this method is only used if the NetBIOS name
4442 type being queried is the 0x20 (server) name type, otherwise
4446 wins : Query a name with
4447 the IP address listed in the \fI wins server\fR parameter. If no WINS server has
4448 been specified this method will be ignored.
4451 bcast : Do a broadcast on
4452 each of the known local interfaces listed in the \fIinterfaces\fR
4453 parameter. This is the least reliable of the name resolution
4454 methods as it depends on the target host being on a locally
4458 Default: \fBname resolve order = lmhosts host wins bcast
4461 Example: \fBname resolve order = lmhosts bcast host
4464 This will cause the local lmhosts file to be examined
4465 first, followed by a broadcast attempt, followed by a normal
4466 system hostname lookup.
4469 \fBnetbios aliases (G)\fR
4470 This is a list of NetBIOS names that nmbd(8)will advertise as additional
4471 names by which the Samba server is known. This allows one machine
4472 to appear in browse lists under multiple names. If a machine is
4473 acting as a browse server or logon server none
4474 of these names will be advertised as either browse server or logon
4475 servers, only the primary name of the machine will be advertised
4476 with these capabilities.
4481 Default: \fBempty string (no additional names)\fR
4483 Example: \fBnetbios aliases = TEST TEST1 TEST2\fR
4485 \fBnetbios name (G)\fR
4486 This sets the NetBIOS name by which a Samba
4487 server is known. By default it is the same as the first component
4488 of the host's DNS name. If a machine is a browse server or
4489 logon server this name (or the first component
4490 of the hosts DNS name) will be the name that these services are
4496 Default: \fBmachine DNS name\fR
4498 Example: \fBnetbios name = MYNAME\fR
4500 \fBnetbios scope (G)\fR
4501 This sets the NetBIOS scope that Samba will
4502 operate under. This should not be set unless every machine
4503 on your LAN also sets this value.
4505 \fBnis homedir (G)\fR
4506 Get the home share server from a NIS map. For
4507 UNIX systems that use an automounter, the user's home directory
4508 will often be mounted on a workstation on demand from a remote
4511 When the Samba logon server is not the actual home directory
4512 server, but is mounting the home directories via NFS then two
4513 network hops would be required to access the users home directory
4514 if the logon server told the client to use itself as the SMB server
4515 for home directories (one over SMB and one over NFS). This can
4518 This option allows Samba to return the home share as
4519 being on a different server to the logon server and as
4520 long as a Samba daemon is running on the home directory server,
4521 it will be mounted on the Samba client directly from the directory
4522 server. When Samba is returning the home share to the client, it
4523 will consult the NIS map specified in \fIhomedir map\fR and return the server
4526 Note that for this option to work there must be a working
4527 NIS system and the Samba server with this option must also
4530 Default: \fBnis homedir = no\fR
4532 \fBnon unix account range (G)\fR
4533 The non unix account range parameter specifies
4534 the range of 'user ids' that are allocated by the various 'non unix
4535 account' passdb backends. These backends allow
4536 the storage of passwords for users who don't exist in /etc/passwd.
4537 This is most often used for machine account creation.
4538 This range of ids should have no existing local or NIS users within
4539 it as strange conflicts can occur otherwise.
4541 NOTE: These userids never appear on the system and Samba will never
4542 \&'become' these users. They are used only to ensure that the algorithmic
4543 RID mapping does not conflict with normal users.
4545 Default: \fBnon unix account range = <empty string>
4547 Example: \fBnon unix account range = 10000-20000\fR
4549 \fBnt acl support (S)\fR
4550 This boolean parameter controls whether
4551 smbd(8)will attempt to map
4552 UNIX permissions into Windows NT access control lists.
4553 This parameter was formally a global parameter in releases
4556 Default: \fBnt acl support = yes\fR
4558 \fBnt pipe support (G)\fR
4559 This boolean parameter controls whether
4560 smbd(8)will allow Windows NT
4561 clients to connect to the NT SMB specific IPC$
4562 pipes. This is a developer debugging option and can be left
4565 Default: \fBnt pipe support = yes\fR
4567 \fBnt status support (G)\fR
4568 This boolean parameter controls whether smbd(8)will negotiate NT specific status
4569 support with Windows NT/2k/XP clients. This is a developer
4570 debugging option and should be left alone.
4571 If this option is set to no then Samba offers
4572 exactly the same DOS error codes that versions prior to Samba 2.2.3
4575 You should not need to ever disable this parameter.
4577 Default: \fBnt status support = yes\fR
4579 \fBnull passwords (G)\fR
4580 Allow or disallow client access to accounts
4581 that have null passwords.
4583 See also smbpasswd (5).
4585 Default: \fBnull passwords = no\fR
4587 \fBobey pam restrictions (G)\fR
4588 When Samba 2.2 is configured to enable PAM support
4589 (i.e. --with-pam), this parameter will control whether or not Samba
4590 should obey PAM's account and session management directives. The
4591 default behavior is to use PAM for clear text authentication only
4592 and to ignore any account or session management. Note that Samba
4593 always ignores PAM for authentication in the case of \fIencrypt passwords = yes\fR
4594 \&. The reason is that PAM modules cannot support the challenge/response
4595 authentication mechanism needed in the presence of SMB password encryption.
4597 Default: \fBobey pam restrictions = no\fR
4600 This is a boolean option that controls whether
4601 connections with usernames not in the \fIuser\fR
4602 list will be allowed. By default this option is disabled so that a
4603 client can supply a username to be used by the server. Enabling
4604 this parameter will force the server to only user the login
4605 names from the \fIuser\fR list and is only really
4606 useful in shave level
4609 Note that this also means Samba won't try to deduce
4610 usernames from the service name. This can be annoying for
4611 the [homes] section. To get around this you could use \fBuser =
4612 %S\fR which means your \fIuser\fR list
4613 will be just the service name, which for home directories is the
4616 See also the \fIuser\fR
4619 Default: \fBonly user = no\fR
4621 \fBonly guest (S)\fR
4622 A synonym for \fI guest only\fR.
4624 \fBoplock break wait time (G)\fR
4625 This is a tuning parameter added due to bugs in
4626 both Windows 9x and WinNT. If Samba responds to a client too
4627 quickly when that client issues an SMB that can cause an oplock
4628 break request, then the network client can fail and not respond
4629 to the break request. This tuning parameter (which is set in milliseconds)
4630 is the amount of time Samba will wait before sending an oplock break
4631 request to such (broken) clients.
4633 \fBDO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
4634 AND UNDERSTOOD THE SAMBA OPLOCK CODE\fR.
4636 Default: \fBoplock break wait time = 0\fR
4638 \fBoplock contention limit (S)\fR
4639 This is a \fBvery\fR advanced
4640 smbd(8)tuning option to
4641 improve the efficiency of the granting of oplocks under multiple
4642 client contention for the same file.
4644 In brief it specifies a number, which causes smbdnot to
4645 grant an oplock even when requested if the approximate number of
4646 clients contending for an oplock on the same file goes over this
4647 limit. This causes \fBsmbd\fR to behave in a similar
4650 \fBDO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
4651 AND UNDERSTOOD THE SAMBA OPLOCK CODE\fR.
4653 Default: \fBoplock contention limit = 2\fR
4656 This boolean option tells \fBsmbd\fR whether to
4657 issue oplocks (opportunistic locks) to file open requests on this
4658 share. The oplock code can dramatically (approx. 30% or more) improve
4659 the speed of access to files on Samba servers. It allows the clients
4660 to aggressively cache files locally and you may want to disable this
4661 option for unreliable network environments (it is turned on by
4662 default in Windows NT Servers). For more information see the file
4663 \fISpeed.txt\fR in the Samba \fIdocs/\fR
4666 Oplocks may be selectively turned off on certain files with a
4667 share. See the \fI veto oplock files\fR parameter. On some systems
4668 oplocks are recognized by the underlying operating system. This
4669 allows data synchronization between all access to oplocked files,
4670 whether it be via Samba or NFS or a local UNIX process. See the
4671 \fIkernel oplocks\fR parameter for details.
4673 See also the \fIkernel
4674 oplocks\fR and \fI level2 oplocks\fR parameters.
4676 Default: \fBoplocks = yes\fR
4679 This integer value controls what level Samba
4680 advertises itself as for browse elections. The value of this
4681 parameter determines whether nmbd(8)
4682 has a chance of becoming a local master browser for the \fI WORKGROUP\fR in the local broadcast area.
4684 \fBNote :\fRBy default, Samba will win
4685 a local master browsing election over all Microsoft operating
4686 systems except a Windows NT 4.0/2000 Domain Controller. This
4687 means that a misconfigured Samba host can effectively isolate
4688 a subnet for browsing purposes. See \fIBROWSING.txt
4689 \fRin the Samba \fIdocs/\fR directory
4692 Default: \fBos level = 20\fR
4694 Example: \fBos level = 65 \fR
4696 \fBos2 driver map (G)\fR
4697 The parameter is used to define the absolute
4698 path to a file containing a mapping of Windows NT printer driver
4699 names to OS/2 printer driver names. The format is:
4701 <nt driver name> = <os2 driver
4704 For example, a valid entry using the HP LaserJet 5
4705 printer driver would appear as \fBHP LaserJet 5L = LASERJET.HP
4708 The need for the file is due to the printer driver namespace
4709 problem described in the Samba
4710 Printing HOWTO. For more details on OS/2 clients, please
4711 refer to the OS2-Client-HOWTO
4712 containing in the Samba documentation.
4714 Default: \fBos2 driver map = <empty string>
4716 \fBpam password change (G)\fR
4717 With the addition of better PAM support in Samba 2.2,
4718 this parameter, it is possible to use PAM's password change control
4719 flag for Samba. If enabled, then PAM will be used for password
4720 changes when requested by an SMB client instead of the program listed in
4721 \fIpasswd program\fR.
4722 It should be possible to enable this without changing your
4724 parameter for most setups.
4726 Default: \fBpam password change = no\fR
4728 \fBpanic action (G)\fR
4729 This is a Samba developer option that allows a
4730 system command to be called when either smbd(8)
4731 crashes. This is usually used to draw attention to the fact that
4734 Default: \fBpanic action = <empty string>\fR
4736 Example: \fBpanic action = "/bin/sleep 90000"\fR
4738 \fBpassdb backend (G)\fR
4739 This option allows the administrator to chose which backends to retrieve and store passwords with. This allows (for example) both
4740 smbpasswd and tdbsam to be used without a recompile.
4741 Multiple backends can be specified, seperated by spaces. The backends will be searched in the order they are specified. New users are always added to the first backend specified.
4742 Experimental backends must still be selected
4743 (eg --with-tdbsam) at configure time.
4745 This paramater is in two parts, the backend's name, and a 'location'
4746 string that has meaning only to that particular backed. These are separated
4749 Available backends can include:
4753 \fBsmbpasswd\fR - The default smbpasswd
4754 backend. Takes a path to the smbpasswd file as an optional argument.
4757 \fBsmbpasswd_nua\fR - The smbpasswd
4758 backend, but with support for 'not unix accounts'.
4759 Takes a path to the smbpasswd file as an optional argument.
4761 See also \fInon unix account range\fR
4764 \fBtdbsam\fR - The TDB based password storage
4765 backend. Takes a path to the TDB as an optional argument (defaults to passdb.tdb
4766 in the \fIprivate dir\fR directory.
4769 \fBtdbsam_nua\fR - The TDB based password storage
4770 backend, with non unix account support. Takes a path to the TDB as an optional argument (defaults to passdb.tdb
4771 in the \fIprivate dir\fR directory.
4773 See also \fInon unix account range\fR
4776 \fBldapsam\fR - The LDAP based passdb
4777 backend. Takes an LDAP URL as an optional argument (defaults to
4778 \fBldap://localhost\fR)
4781 \fBldapsam_nua\fR - The LDAP based passdb
4782 backend, with non unix account support. Takes an LDAP URL as an optional argument (defaults to
4783 \fBldap://localhost\fR)
4785 See also \fInon unix account range\fR
4788 \fBplugin\fR - Allows Samba to load an
4789 arbitary passdb backend from the .so specified as a compulsary argument.
4791 Any characters after the (optional) second : are passed to the plugin
4792 for its own processing
4796 Default: \fBpassdb backend = smbpasswd\fR
4798 Example: \fBpassdb backend = tdbsam:/etc/samba/private/passdb.tdb smbpasswd:/etc/samba/smbpasswd\fR
4800 Example: \fBpassdb backend = ldapsam_nua:ldaps://ldap.example.com\fR
4802 Example: \fBpassdb backend = plugin:/usr/local/samba/lib/my_passdb.so:my_plugin_args tdbsam:/etc/samba/private/passdb.tdb\fR
4804 \fBpasswd chat (G)\fR
4805 This string controls the \fB"chat"\fR
4806 conversation that takes places between smbdand the local password changing
4807 program to change the user's password. The string describes a
4808 sequence of response-receive pairs that smbd(8)uses to determine what to send to the
4809 \fIpasswd program\fR
4810 and what to expect back. If the expected output is not
4811 received then the password is not changed.
4813 This chat sequence is often quite site specific, depending
4814 on what local methods are used for password control (such as NIS
4817 Note that this parameter only is only used if the \fIunix
4818 password sync\fR parameter is set to yes. This
4819 sequence is then called \fBAS ROOT\fR when the SMB password
4820 in the smbpasswd file is being changed, without access to the old
4821 password cleartext. This means that root must be able to reset the user's password
4822 without knowing the text of the previous password. In the presence of NIS/YP,
4823 this means that the passwd program must be
4824 executed on the NIS master.
4826 The string can contain the macro \fI%n\fR which is substituted
4827 for the new password. The chat sequence can also contain the standard
4828 macros \\n, \\r, \\t and \\s to give line-feed,
4829 carriage-return, tab and space. The chat sequence string can also contain
4830 a '*' which matches any sequence of characters.
4831 Double quotes can be used to collect strings with spaces
4832 in them into a single string.
4834 If the send string in any part of the chat sequence
4835 is a full stop ".", then no string is sent. Similarly,
4836 if the expect string is a full stop then no string is expected.
4839 password change\fR parameter is set to true, the chat pairs
4840 may be matched in any order, and success is determined by the PAM result,
4841 not any particular output. The \\n macro is ignored for PAM conversions.
4843 See also \fIunix password
4844 sync\fR, \fI passwd program\fR , \fIpasswd chat debug\fR and \fIpam password change\fR.
4846 Default: \fBpasswd chat = *new*password* %n\\n
4847 *new*password* %n\\n *changed*\fR
4849 Example: \fBpasswd chat = "*Enter OLD password*" %o\\n
4850 "*Enter NEW password*" %n\\n "*Reenter NEW password*" %n\\n "*Password
4853 \fBpasswd chat debug (G)\fR
4854 This boolean specifies if the passwd chat script
4855 parameter is run in \fBdebug\fR mode. In this mode the
4856 strings passed to and received from the passwd chat are printed
4857 in the smbd(8)log with a
4859 of 100. This is a dangerous option as it will allow plaintext passwords
4860 to be seen in the \fBsmbd\fR log. It is available to help
4861 Samba admins debug their \fIpasswd chat\fR scripts
4862 when calling the \fIpasswd program\fR and should
4863 be turned off after this has been done. This option has no effect if the
4864 \fIpam password change\fR
4865 paramter is set. This parameter is off by default.
4867 See also \fIpasswd chat\fR
4868 , \fIpam password change\fR
4869 , \fIpasswd program\fR
4872 Default: \fBpasswd chat debug = no\fR
4874 \fBpasswd program (G)\fR
4875 The name of a program that can be used to set
4876 UNIX user passwords. Any occurrences of \fI%u\fR
4877 will be replaced with the user name. The user name is checked for
4878 existence before calling the password changing program.
4880 Also note that many passwd programs insist in \fBreasonable
4881 \fRpasswords, such as a minimum length, or the inclusion
4882 of mixed case chars and digits. This can pose a problem as some clients
4883 (such as Windows for Workgroups) uppercase the password before sending
4886 \fBNote\fR that if the \fIunix
4887 password sync\fR parameter is set to true
4888 then this program is called \fBAS ROOT\fR
4889 before the SMB password in the smbpasswd(5)
4890 file is changed. If this UNIX password change fails, then
4891 \fBsmbd\fR will fail to change the SMB password also
4892 (this is by design).
4894 If the \fIunix password sync\fR parameter
4895 is set this parameter \fBMUST USE ABSOLUTE PATHS\fR
4896 for \fBALL\fR programs called, and must be examined
4897 for security implications. Note that by default \fIunix
4898 password sync\fR is set to false.
4903 Default: \fBpasswd program = /bin/passwd\fR
4905 Example: \fBpasswd program = /sbin/npasswd %u\fR
4907 \fBpassword level (G)\fR
4908 Some client/server combinations have difficulty
4909 with mixed-case passwords. One offending client is Windows for
4910 Workgroups, which for some reason forces passwords to upper
4911 case when using the LANMAN1 protocol, but leaves them alone when
4912 using COREPLUS! Another problem child is the Windows 95/98
4913 family of operating systems. These clients upper case clear
4914 text passwords even when NT LM 0.12 selected by the protocol
4915 negotiation request/response.
4917 This parameter defines the maximum number of characters
4918 that may be upper case in passwords.
4920 For example, say the password given was "FRED". If \fI password level\fR is set to 1, the following combinations
4921 would be tried if "FRED" failed:
4923 "Fred", "fred", "fRed", "frEd","freD"
4925 If \fIpassword level\fR was set to 2,
4926 the following combinations would also be tried:
4928 "FRed", "FrEd", "FreD", "fREd", "fReD", "frED", ..
4932 The higher value this parameter is set to the more likely
4933 it is that a mixed case password will be matched against a single
4934 case password. However, you should be aware that use of this
4935 parameter reduces security and increases the time taken to
4936 process a new connection.
4938 A value of zero will cause only two attempts to be
4939 made - the password as is and the password in all-lower case.
4941 Default: \fBpassword level = 0\fR
4943 Example: \fBpassword level = 4\fR
4945 \fBpassword server (G)\fR
4946 By specifying the name of another SMB server (such
4947 as a WinNT box) with this option, and using \fBsecurity = domain
4948 \fRor \fBsecurity = server\fR you can get Samba
4949 to do all its username/password validation via a remote server.
4951 This option sets the name of the password server to use.
4952 It must be a NetBIOS name, so if the machine's NetBIOS name is
4953 different from its Internet name then you may have to add its NetBIOS
4954 name to the lmhosts file which is stored in the same directory
4955 as the \fIsmb.conf\fR file.
4957 The name of the password server is looked up using the
4959 resolve order\fR and so may resolved
4960 by any method and order described in that parameter.
4962 The password server much be a machine capable of using
4963 the "LM1.2X002" or the "NT LM 0.12" protocol, and it must be in
4964 user level security mode.
4966 \fBNOTE:\fR Using a password server
4967 means your UNIX box (running Samba) is only as secure as your
4968 password server. \fBDO NOT CHOOSE A PASSWORD SERVER THAT
4969 YOU DON'T COMPLETELY TRUST\fR.
4971 Never point a Samba server at itself for password
4972 serving. This will cause a loop and could lock up your Samba
4975 The name of the password server takes the standard
4976 substitutions, but probably the only useful one is \fI%m
4977 \fR, which means the Samba server will use the incoming
4978 client as the password server. If you use this then you better
4979 trust your clients, and you had better restrict them with hosts allow!
4981 If the \fIsecurity\fR parameter is set to
4982 domain, then the list of machines in this
4983 option must be a list of Primary or Backup Domain controllers for the
4984 Domain or the character '*', as the Samba server is effectively
4985 in that domain, and will use cryptographically authenticated RPC calls
4986 to authenticate the user logging on. The advantage of using \fB security = domain\fR is that if you list several hosts in the
4987 \fIpassword server\fR option then \fBsmbd
4988 \fRwill try each in turn till it finds one that responds. This
4989 is useful in case your primary server goes down.
4991 If the \fIpassword server\fR option is set
4992 to the character '*', then Samba will attempt to auto-locate the
4993 Primary or Backup Domain controllers to authenticate against by
4994 doing a query for the name WORKGROUP<1C>
4995 and then contacting each server returned in the list of IP
4996 addresses from the name resolution source.
4998 If the \fIsecurity\fR parameter is
4999 set to server, then there are different
5000 restrictions that \fBsecurity = domain\fR doesn't
5005 You may list several password servers in
5006 the \fIpassword server\fR parameter, however if an
5007 \fBsmbd\fR makes a connection to a password server,
5008 and then the password server fails, no more users will be able
5009 to be authenticated from this \fBsmbd\fR. This is a
5010 restriction of the SMB/CIFS protocol when in \fBsecurity = server
5011 \fRmode and cannot be fixed in Samba.
5014 If you are using a Windows NT server as your
5015 password server then you will have to ensure that your users
5016 are able to login from the Samba server, as when in \fB security = server\fR mode the network logon will appear to
5017 come from there rather than from the users workstation.
5020 See also the \fIsecurity
5024 Default: \fBpassword server = <empty string>\fR
5027 Example: \fBpassword server = NT-PDC, NT-BDC1, NT-BDC2
5030 Example: \fBpassword server = *\fR
5034 This parameter specifies a directory to which
5035 the user of the service is to be given access. In the case of
5036 printable services, this is where print data will spool prior to
5037 being submitted to the host for printing.
5039 For a printable service offering guest access, the service
5040 should be readonly and the path should be world-writeable and
5041 have the sticky bit set. This is not mandatory of course, but
5042 you probably won't get the results you expect if you do
5045 Any occurrences of \fI%u\fR in the path
5046 will be replaced with the UNIX username that the client is using
5047 on this connection. Any occurrences of \fI%m\fR
5048 will be replaced by the NetBIOS name of the machine they are
5049 connecting from. These replacements are very useful for setting
5050 up pseudo home directories for users.
5052 Note that this path will be based on \fIroot dir\fR if one was specified.
5056 Example: \fBpath = /home/fred\fR
5058 \fBpid directory (G)\fR
5059 This option specifies the directory where pid
5060 files will be placed.
5062 Default: \fBpid directory = ${prefix}/var/locks\fR
5064 Example: \fBpid directory = /var/run/\fR
5066 \fBposix locking (S)\fR
5068 daemon maintains an database of file locks obtained by SMB clients.
5069 The default behavior is to map this internal database to POSIX
5070 locks. This means that file locks obtained by SMB clients are
5071 consistent with those seen by POSIX compliant applications accessing
5072 the files via a non-SMB method (e.g. NFS or local file access).
5073 You should never need to disable this parameter.
5075 Default: \fBposix locking = yes\fR
5078 This option specifies a command to be run
5079 whenever the service is disconnected. It takes the usual
5080 substitutions. The command may be run as the root on some
5083 An interesting example may be to unmount server
5086 \fBpostexec = /etc/umount /cdrom\fR
5088 See also \fIpreexec\fR
5091 Default: \fBnone (no command executed)\fR
5093 Example: \fBpostexec = echo \\"%u disconnected from %S
5094 from %m (%I)\\" >> /tmp/log\fR
5096 \fBpostscript (S)\fR
5097 This parameter forces a printer to interpret
5098 the print files as PostScript. This is done by adding a %!
5099 to the start of print output.
5101 This is most useful when you have lots of PCs that persist
5102 in putting a control-D at the start of print jobs, which then
5103 confuses your printer.
5105 Default: \fBpostscript = no\fR
5108 This option specifies a command to be run whenever
5109 the service is connected to. It takes the usual substitutions.
5111 An interesting example is to send the users a welcome
5112 message every time they log in. Maybe a message of the day? Here
5115 \fBpreexec = csh -c 'echo \\"Welcome to %S!\\" |
5116 /usr/local/samba/bin/smbclient -M %m -I %I' & \fR
5118 Of course, this could get annoying after a while :-)
5120 See also \fIpreexec close
5124 Default: \fBnone (no command executed)\fR
5126 Example: \fBpreexec = echo \\"%u connected to %S from %m
5127 (%I)\\" >> /tmp/log\fR
5129 \fBpreexec close (S)\fR
5130 This boolean option controls whether a non-zero
5131 return code from \fIpreexec
5132 \fRshould close the service being connected to.
5134 Default: \fBpreexec close = no\fR
5136 \fBpreferred master (G)\fR
5137 This boolean parameter controls if nmbd(8)is a preferred master browser
5140 If this is set to true, on startup, \fBnmbd\fR
5141 will force an election, and it will have a slight advantage in
5142 winning the election. It is recommended that this parameter is
5143 used in conjunction with \fB\fI domain master\fB = yes\fR, so that \fB nmbd\fR can guarantee becoming a domain master.
5145 Use this option with caution, because if there are several
5146 hosts (whether Samba servers, Windows 95 or NT) that are preferred
5147 master browsers on the same subnet, they will each periodically
5148 and continuously attempt to become the local master browser.
5149 This will result in unnecessary broadcast traffic and reduced browsing
5152 See also \fIos level\fR
5155 Default: \fBpreferred master = auto\fR
5157 \fBprefered master (G)\fR
5158 Synonym for \fI preferred master\fR for people who cannot spell :-).
5161 This is a list of services that you want to be
5162 automatically added to the browse lists. This is most useful
5163 for homes and printers services that would otherwise not be
5166 Note that if you just want all printers in your
5167 printcap file loaded then the \fIload printers\fR option is easier.
5169 Default: \fBno preloaded services\fR
5171 Example: \fBpreload = fred lp colorlp\fR
5173 \fBpreserve case (S)\fR
5174 This controls if new filenames are created
5175 with the case that the client passes, or if they are forced to
5176 be the \fIdefault case
5179 Default: \fBpreserve case = yes\fR
5181 See the section on NAME
5182 MANGLING for a fuller discussion.
5184 \fBprint command (S)\fR
5185 After a print job has finished spooling to
5186 a service, this command will be used via a \fBsystem()\fR
5187 call to process the spool file. Typically the command specified will
5188 submit the spool file to the host's printing subsystem, but there
5189 is no requirement that this be the case. The server will not remove
5190 the spool file, so whatever command you specify should remove the
5191 spool file when it has been processed, otherwise you will need to
5192 manually remove old spool files.
5194 The print command is simply a text string. It will be used
5195 verbatim after macro substitutions have been made:
5197 s, %p - the path to the spool
5200 %p - the appropriate printer
5204 name as transmitted by the client.
5206 %c - The number of printed pages
5207 of the spooled job (if known).
5209 %z - the size of the spooled
5210 print job (in bytes)
5212 The print command \fBMUST\fR contain at least
5213 one occurrence of \fI%s\fR or \fI%f
5214 \fR- the \fI%p\fR is optional. At the time
5215 a job is submitted, if no printer name is supplied the \fI%p
5216 \fRwill be silently removed from the printer command.
5218 If specified in the [global] section, the print command given
5219 will be used for any printable service that does not have its own
5220 print command specified.
5222 If there is neither a specified print command for a
5223 printable service nor a global print command, spool files will
5224 be created but not processed and (most importantly) not removed.
5226 Note that printing may fail on some UNIXes from the
5227 nobody account. If this happens then create
5228 an alternative guest account that can print and set the \fIguest account\fR
5229 in the [global] section.
5231 You can form quite complex print commands by realizing
5232 that they are just passed to a shell. For example the following
5233 will log a print job, print the file, then remove it. Note that
5234 \&';' is the usual separator for command in shell scripts.
5236 \fBprint command = echo Printing %s >>
5237 /tmp/print.log; lpr -P %p %s; rm %s\fR
5239 You may have to vary this command considerably depending
5240 on how you normally print files on your system. The default for
5241 the parameter varies depending on the setting of the \fIprinting\fR parameter.
5243 Default: For \fBprinting = BSD, AIX, QNX, LPRNG
5246 \fBprint command = lpr -r -P%p %s\fR
5248 For \fBprinting = SYSV or HPUX :\fR
5250 \fBprint command = lp -c -d%p %s; rm %s\fR
5252 For \fBprinting = SOFTQ :\fR
5254 \fBprint command = lp -d%p -s %s; rm %s\fR
5256 For printing = CUPS : If SAMBA is compiled against
5257 libcups, then printcap = cups
5258 uses the CUPS API to
5259 submit jobs, etc. Otherwise it maps to the System V
5260 commands with the -oraw option for printing, i.e. it
5261 uses \fBlp -c -d%p -oraw; rm %s\fR.
5262 With \fBprinting = cups\fR,
5263 and if SAMBA is compiled against libcups, any manually
5264 set print command will be ignored.
5266 Example: \fBprint command = /usr/local/samba/bin/myprintscript
5270 Synonym for \fIprintable\fR.
5273 If this parameter is yes, then
5274 clients may open, write to and submit spool files on the directory
5275 specified for the service.
5277 Note that a printable service will ALWAYS allow writing
5278 to the service path (user privileges permitting) via the spooling
5279 of print data. The \fIwriteable
5280 \fRparameter controls only non-printing access to
5283 Default: \fBprintable = no\fR
5286 Synonym for \fI printcap name\fR.
5288 \fBprintcap name (G)\fR
5289 This parameter may be used to override the
5290 compiled-in default printcap name used by the server (usually \fI /etc/printcap\fR). See the discussion of the [printers] section above for reasons
5291 why you might want to do this.
5293 To use the CUPS printing interface set \fBprintcap name = cups
5294 \fR\&. This should be supplemented by an addtional setting
5295 printing = cups in the [global]
5296 section. \fBprintcap name = cups\fR will use the
5297 "dummy" printcap created by CUPS, as specified in your CUPS
5300 On System V systems that use \fBlpstat\fR to
5301 list available printers you can use \fBprintcap name = lpstat
5302 \fRto automatically obtain lists of available printers. This
5303 is the default for systems that define SYSV at configure time in
5304 Samba (this includes most System V based systems). If \fI printcap name\fR is set to \fBlpstat\fR on
5305 these systems then Samba will launch \fBlpstat -v\fR and
5306 attempt to parse the output to obtain a printer list.
5308 A minimal printcap file would look something like this:
5321 where the '|' separates aliases of a printer. The fact
5322 that the second alias has a space in it gives a hint to Samba
5323 that it's a comment.
5325 \fBNOTE\fR: Under AIX the default printcap
5326 name is \fI/etc/qconfig\fR. Samba will assume the
5327 file is in AIX \fIqconfig\fR format if the string
5328 \fIqconfig\fR appears in the printcap filename.
5330 Default: \fBprintcap name = /etc/printcap\fR
5332 Example: \fBprintcap name = /etc/myprintcap\fR
5334 \fBprinter admin (S)\fR
5335 This is a list of users that can do anything to
5336 printers via the remote administration interfaces offered by MS-RPC
5337 (usually using a NT workstation). Note that the root user always
5340 Default: \fBprinter admin = <empty string>\fR
5342 Example: \fBprinter admin = admin, @staff\fR
5344 \fBprinter driver (S)\fR
5345 \fBNote :\fRThis is a deprecated
5346 parameter and will be removed in the next major release
5347 following version 2.2. Please see the instructions in
5348 the Samba 2.2. Printing
5349 HOWTOfor more information
5350 on the new method of loading printer drivers onto a Samba server.
5352 This option allows you to control the string
5353 that clients receive when they ask the server for the printer driver
5354 associated with a printer. If you are using Windows95 or Windows NT
5355 then you can use this to automate the setup of printers on your
5358 You need to set this parameter to the exact string (case
5359 sensitive) that describes the appropriate printer driver for your
5360 system. If you don't know the exact string to use then you should
5361 first try with no \fI printer driver\fR option set and the client will
5362 give you a list of printer drivers. The appropriate strings are
5363 shown in a scroll box after you have chosen the printer manufacturer.
5368 Example: \fBprinter driver = HP LaserJet 4L\fR
5370 \fBprinter driver file (G)\fR
5371 \fBNote :\fRThis is a deprecated
5372 parameter and will be removed in the next major release
5373 following version 2.2. Please see the instructions in
5374 the Samba 2.2. Printing
5375 HOWTOfor more information
5376 on the new method of loading printer drivers onto a Samba server.
5378 This parameter tells Samba where the printer driver
5379 definition file, used when serving drivers to Windows 95 clients, is
5380 to be found. If this is not set, the default is :
5382 \fISAMBA_INSTALL_DIRECTORY
5383 /lib/printers.def\fR
5385 This file is created from Windows 95 \fImsprint.inf
5386 \fRfiles found on the Windows 95 client system. For more
5387 details on setting up serving of printer drivers to Windows 95
5388 clients, see the outdated documentation file in the \fIdocs/\fR
5389 directory, \fIPRINTER_DRIVER.txt\fR.
5391 See also \fI printer driver location\fR.
5393 Default: \fBNone (set in compile).\fR
5395 Example: \fBprinter driver file =
5396 /usr/local/samba/printers/drivers.def\fR
5398 \fBprinter driver location (S)\fR
5399 \fBNote :\fRThis is a deprecated
5400 parameter and will be removed in the next major release
5401 following version 2.2. Please see the instructions in
5402 the Samba 2.2. Printing
5403 HOWTOfor more information
5404 on the new method of loading printer drivers onto a Samba server.
5406 This parameter tells clients of a particular printer
5407 share where to find the printer driver files for the automatic
5408 installation of drivers for Windows 95 machines. If Samba is set up
5409 to serve printer drivers to Windows 95 machines, this should be set to
5411 \fB\\\\MACHINE\\PRINTER$\fR
5413 Where MACHINE is the NetBIOS name of your Samba server,
5414 and PRINTER$ is a share you set up for serving printer driver
5415 files. For more details on setting this up see the outdated documentation
5416 file in the \fIdocs/\fR directory, \fI PRINTER_DRIVER.txt\fR.
5418 See also \fI printer driver file\fR.
5422 Example: \fBprinter driver location = \\\\MACHINE\\PRINTER$
5424 \fBprinter name (S)\fR
5425 This parameter specifies the name of the printer
5426 to which print jobs spooled through a printable service will be sent.
5428 If specified in the [global] section, the printer
5429 name given will be used for any printable service that does
5430 not have its own printer name specified.
5432 Default: \fBnone (but may be lp
5435 Example: \fBprinter name = laserwriter\fR
5438 Synonym for \fI printer name\fR.
5441 This parameters controls how printer status
5442 information is interpreted on your system. It also affects the
5443 default values for the \fIprint command\fR,
5444 \fIlpq command\fR, \fIlppause command
5445 \fR, \fIlpresume command\fR, and
5446 \fIlprm command\fR if specified in the
5449 Currently nine printing styles are supported. They are
5456 To see what the defaults are for the other print
5457 commands when using the various options use the testparm(1)program.
5459 This option can be set on a per printer basis
5461 See also the discussion in the [printers] section.
5463 \fBprivate dir (G)\fR
5464 This parameters defines the directory
5465 smbd will use for storing such files as \fIsmbpasswd\fR
5466 and \fIsecrets.tdb\fR.
5468 Default :\fBprivate dir = ${prefix}/private\fR
5471 Synonym for \fImax protocol\fR.
5474 Synonym for \fIguest
5477 \fBqueuepause command (S)\fR
5478 This parameter specifies the command to be
5479 executed on the server host in order to pause the printer queue.
5481 This command should be a program or script which takes
5482 a printer name as its only parameter and stops the printer queue,
5483 such that no longer jobs are submitted to the printer.
5485 This command is not supported by Windows for Workgroups,
5486 but can be issued from the Printers window under Windows 95
5489 If a \fI%p\fR is given then the printer name
5490 is put in its place. Otherwise it is placed at the end of the command.
5492 Note that it is good practice to include the absolute
5493 path in the command as the PATH may not be available to the
5496 Default: \fBdepends on the setting of \fIprinting
5498 Example: \fBqueuepause command = disable %p\fR
5500 \fBqueueresume command (S)\fR
5501 This parameter specifies the command to be
5502 executed on the server host in order to resume the printer queue. It
5503 is the command to undo the behavior that is caused by the
5504 previous parameter (\fI queuepause command\fR).
5506 This command should be a program or script which takes
5507 a printer name as its only parameter and resumes the printer queue,
5508 such that queued jobs are resubmitted to the printer.
5510 This command is not supported by Windows for Workgroups,
5511 but can be issued from the Printers window under Windows 95
5514 If a \fI%p\fR is given then the printer name
5515 is put in its place. Otherwise it is placed at the end of the
5518 Note that it is good practice to include the absolute
5519 path in the command as the PATH may not be available to the
5522 Default: \fBdepends on the setting of \fIprinting\fB\fR
5524 Example: \fBqueuepause command = enable %p
5527 This boolean parameter controls whether smbd(8)will support the "Read
5528 Block Multiplex" SMB. This is now rarely used and defaults to
5529 no. You should never need to set this
5532 Default: \fBread bmpx = no\fR
5535 This is a list of users that are given read-only
5536 access to a service. If the connecting user is in this list then
5537 they will not be given write access, no matter what the \fIwriteable\fR
5538 option is set to. The list can include group names using the
5539 syntax described in the \fI invalid users\fR parameter.
5541 See also the \fI write list\fR parameter and the \fIinvalid users\fR
5544 Default: \fBread list = <empty string>\fR
5546 Example: \fBread list = mary, @students\fR
5549 Note that this is an inverted synonym for \fIwriteable\fR.
5552 This parameter controls whether or not the server
5553 will support the raw read SMB requests when transferring data
5556 If enabled, raw reads allow reads of 65535 bytes in
5557 one packet. This typically provides a major performance benefit.
5559 However, some clients either negotiate the allowable
5560 block size incorrectly or are incapable of supporting larger block
5561 sizes, and for these clients you may need to disable raw reads.
5563 In general this parameter should be viewed as a system tuning
5564 tool and left severely alone. See also \fIwrite raw\fR.
5566 Default: \fBread raw = yes\fR
5569 The option \fIread size\fR
5570 affects the overlap of disk reads/writes with network reads/writes.
5571 If the amount of data being transferred in several of the SMB
5572 commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger
5573 than this value then the server begins writing the data before it
5574 has received the whole packet from the network, or in the case of
5575 SMBreadbraw, it begins writing to the network before all the data
5576 has been read from disk.
5578 This overlapping works best when the speeds of disk and
5579 network access are similar, having very little effect when the
5580 speed of one is much greater than the other.
5582 The default value is 16384, but very little experimentation
5583 has been done yet to determine the optimal value, and it is likely
5584 that the best value will vary greatly between systems anyway.
5585 A value over 65536 is pointless and will cause you to allocate
5586 memory unnecessarily.
5588 Default: \fBread size = 16384\fR
5590 Example: \fBread size = 8192\fR
5592 \fBremote announce (G)\fR
5593 This option allows you to setup nmbd(8)to periodically announce itself
5594 to arbitrary IP addresses with an arbitrary workgroup name.
5596 This is useful if you want your Samba server to appear
5597 in a remote workgroup for which the normal browse propagation
5598 rules don't work. The remote workgroup can be anywhere that you
5599 can send IP packets to.
5603 \fBremote announce = 192.168.2.255/SERVERS
5604 192.168.4.255/STAFF\fR
5606 the above line would cause \fBnmbd\fR to announce itself
5607 to the two given IP addresses using the given workgroup names.
5608 If you leave out the workgroup name then the one given in
5610 parameter is used instead.
5612 The IP addresses you choose would normally be the broadcast
5613 addresses of the remote networks, but can also be the IP addresses
5614 of known browse masters if your network config is that stable.
5616 See the documentation file \fIBROWSING.txt\fR
5617 in the \fIdocs/\fR directory.
5619 Default: \fBremote announce = <empty string>
5621 \fBremote browse sync (G)\fR
5622 This option allows you to setup nmbd(8)to periodically request
5623 synchronization of browse lists with the master browser of a Samba
5624 server that is on a remote segment. This option will allow you to
5625 gain browse lists for multiple workgroups across routed networks. This
5626 is done in a manner that does not work with any non-Samba servers.
5628 This is useful if you want your Samba server and all local
5629 clients to appear in a remote workgroup for which the normal browse
5630 propagation rules don't work. The remote workgroup can be anywhere
5631 that you can send IP packets to.
5635 \fBremote browse sync = 192.168.2.255 192.168.4.255
5637 the above line would cause \fBnmbd\fR to request
5638 the master browser on the specified subnets or addresses to
5639 synchronize their browse lists with the local server.
5641 The IP addresses you choose would normally be the broadcast
5642 addresses of the remote networks, but can also be the IP addresses
5643 of known browse masters if your network config is that stable. If
5644 a machine IP address is given Samba makes NO attempt to validate
5645 that the remote machine is available, is listening, nor that it
5646 is in fact the browse master on its segment.
5648 Default: \fBremote browse sync = <empty string>
5650 \fBrestrict anonymous (G)\fR
5651 This is a boolean parameter. If it is true, then
5652 anonymous access to the server will be restricted, namely in the
5653 case where the server is expecting the client to send a username,
5654 but it doesn't. Setting it to true will force these anonymous
5655 connections to be denied, and the client will be required to always
5656 supply a username and password when connecting. Use of this parameter
5657 is only recommended for homogeneous NT client environments.
5659 This parameter makes the use of macro expansions that rely
5660 on the username (%U, %G, etc) consistent. NT 4.0
5661 likes to use anonymous connections when refreshing the share list,
5662 and this is a way to work around that.
5664 When restrict anonymous is true, all anonymous connections
5665 are denied no matter what they are for. This can effect the ability
5666 of a machine to access the Samba Primary Domain Controller to revalidate
5667 its machine account after someone else has logged on the client
5668 interactively. The NT client will display a message saying that
5669 the machine's account in the domain doesn't exist or the password is
5670 bad. The best way to deal with this is to reboot NT client machines
5671 between interactive logons, using "Shutdown and Restart", rather
5672 than "Close all programs and logon as a different user".
5674 Default: \fBrestrict anonymous = no\fR
5677 Synonym for \fIroot directory"\fR.
5680 Synonym for \fIroot directory"\fR.
5682 \fBroot directory (G)\fR
5683 The server will \fBchroot()\fR (i.e.
5684 Change its root directory) to this directory on startup. This is
5685 not strictly necessary for secure operation. Even without it the
5686 server will deny access to files not in one of the service entries.
5687 It may also check for, and deny access to, soft links to other
5688 parts of the filesystem, or attempts to use ".." in file names
5689 to access other directories (depending on the setting of the \fIwide links\fR
5692 Adding a \fIroot directory\fR entry other
5693 than "/" adds an extra level of security, but at a price. It
5694 absolutely ensures that no access is given to files not in the
5695 sub-tree specified in the \fIroot directory\fR
5696 option, \fBincluding\fR some files needed for
5697 complete operation of the server. To maintain full operability
5698 of the server you will need to mirror some system files
5699 into the \fIroot directory\fR tree. In particular
5700 you will need to mirror \fI/etc/passwd\fR (or a
5701 subset of it), and any binaries or configuration files needed for
5702 printing (if required). The set of files that must be mirrored is
5703 operating system dependent.
5705 Default: \fBroot directory = /\fR
5707 Example: \fBroot directory = /homes/smb\fR
5709 \fBroot postexec (S)\fR
5710 This is the same as the \fIpostexec\fR
5711 parameter except that the command is run as root. This
5712 is useful for unmounting filesystems
5713 (such as CDROMs) after a connection is closed.
5715 See also \fI postexec\fR.
5717 Default: \fBroot postexec = <empty string>
5719 \fBroot preexec (S)\fR
5720 This is the same as the \fIpreexec\fR
5721 parameter except that the command is run as root. This
5722 is useful for mounting filesystems (such as CDROMs) when a
5723 connection is opened.
5725 See also \fI preexec\fR and \fIpreexec close\fR.
5727 Default: \fBroot preexec = <empty string>
5729 \fBroot preexec close (S)\fR
5730 This is the same as the \fIpreexec close
5731 \fRparameter except that the command is run as root.
5733 See also \fI preexec\fR and \fIpreexec close\fR.
5735 Default: \fBroot preexec close = no\fR
5738 This option affects how clients respond to
5739 Samba and is one of the most important settings in the \fI smb.conf\fR file.
5741 The option sets the "security mode bit" in replies to
5742 protocol negotiations with smbd(8)
5743 to turn share level security on or off. Clients decide
5744 based on this bit whether (and how) to transfer user and password
5745 information to the server.
5747 The default is \fBsecurity = user\fR, as this is
5748 the most common setting needed when talking to Windows 98 and
5751 The alternatives are \fBsecurity = share\fR,
5752 \fBsecurity = server\fR or \fBsecurity = domain
5755 In versions of Samba prior to 2.0.0, the default was
5756 \fBsecurity = share\fR mainly because that was
5757 the only option at one stage.
5759 There is a bug in WfWg that has relevance to this
5760 setting. When in user or server level security a WfWg client
5761 will totally ignore the password you type in the "connect
5762 drive" dialog box. This makes it very difficult (if not impossible)
5763 to connect to a Samba service as anyone except the user that
5764 you are logged into WfWg as.
5766 If your PCs use usernames that are the same as their
5767 usernames on the UNIX machine then you will want to use
5768 \fBsecurity = user\fR. If you mostly use usernames
5769 that don't exist on the UNIX box then use \fBsecurity =
5772 You should also use \fBsecurity = share\fR if you
5773 want to mainly setup shares without a password (guest shares). This
5774 is commonly used for a shared printer server. It is more difficult
5775 to setup guest shares with \fBsecurity = user\fR, see
5776 the \fImap to guest\fR
5777 parameter for details.
5779 It is possible to use \fBsmbd\fR in a \fB hybrid mode\fR where it is offers both user and share
5780 level security under different \fINetBIOS aliases\fR.
5782 The different settings will now be explained.
5786 When clients connect to a share level security server they
5787 need not log onto the server with a valid username and password before
5788 attempting to connect to a shared resource (although modern clients
5789 such as Windows 95/98 and Windows NT will send a logon request with
5790 a username but no password when talking to a \fBsecurity = share
5791 \fRserver). Instead, the clients send authentication information
5792 (passwords) on a per-share basis, at the time they attempt to connect
5795 Note that \fBsmbd\fR \fBALWAYS\fR
5796 uses a valid UNIX user to act on behalf of the client, even in
5797 \fBsecurity = share\fR level security.
5799 As clients are not required to send a username to the server
5800 in share level security, \fBsmbd\fR uses several
5801 techniques to determine the correct UNIX user to use on behalf
5804 A list of possible UNIX usernames to match with the given
5805 client password is constructed using the following methods :
5810 only\fR parameter is set, then all the other
5811 stages are missed and only the \fIguest account\fR username is checked.
5814 Is a username is sent with the share connection
5815 request, then this username (after mapping - see \fIusername map\fR),
5816 is added as a potential username.
5819 If the client did a previous \fBlogon
5820 \fRrequest (the SessionSetup SMB call) then the
5821 username sent in this SMB will be added as a potential username.
5824 The name of the service the client requested is
5825 added as a potential username.
5828 The NetBIOS name of the client is added to
5829 the list as a potential username.
5832 Any users on the \fI user\fR list are added as potential usernames.
5835 If the \fIguest only\fR parameter is
5836 not set, then this list is then tried with the supplied password.
5837 The first user for whom the password matches will be used as the
5841 If the \fIguest only\fR parameter is
5842 set, or no username can be determined then if the share is marked
5843 as available to the \fIguest account\fR, then this
5844 guest user will be used, otherwise access is denied.
5847 Note that it can be \fBvery\fR confusing
5848 in share-level security as to which UNIX username will eventually
5849 be used in granting access.
5852 See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
5858 This is the default security setting in Samba 2.2.
5859 With user-level security a client must first "log-on" with a
5860 valid username and password (which can be mapped using the \fIusername map\fR
5861 parameter). Encrypted passwords (see the \fIencrypted passwords\fR parameter) can also
5862 be used in this security mode. Parameters such as \fIuser\fR and \fIguest only\fR if set are then applied and
5863 may change the UNIX user to use on this connection, but only after
5864 the user has been successfully authenticated.
5867 \fBNote\fR that the name of the resource being
5868 requested is \fBnot\fR sent to the server until after
5869 the server has successfully authenticated the client. This is why
5870 guest shares don't work in user level security without allowing
5871 the server to automatically map unknown users into the \fIguest account\fR.
5872 See the \fImap to guest\fR
5873 parameter for details on doing this.
5876 See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
5879 \fBSECURITY = SERVER
5882 In this mode Samba will try to validate the username/password
5883 by passing it to another SMB server, such as an NT box. If this
5884 fails it will revert to \fBsecurity = user\fR, but note
5885 that if encrypted passwords have been negotiated then Samba cannot
5886 revert back to checking the UNIX password file, it must have a valid
5887 \fIsmbpasswd\fR file to check users against. See the
5888 documentation file in the \fIdocs/\fR directory
5889 \fIENCRYPTION.txt\fR for details on how to set this
5893 \fBNote\fR that from the client's point of
5894 view \fBsecurity = server\fR is the same as \fB security = user\fR. It only affects how the server deals
5895 with the authentication, it does not in any way affect what the
5899 \fBNote\fR that the name of the resource being
5900 requested is \fBnot\fR sent to the server until after
5901 the server has successfully authenticated the client. This is why
5902 guest shares don't work in user level security without allowing
5903 the server to automatically map unknown users into the \fIguest account\fR.
5904 See the \fImap to guest\fR
5905 parameter for details on doing this.
5908 See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
5911 See also the \fIpassword
5912 server\fR parameter and the \fIencrypted passwords\fR
5916 \fBSECURITY = DOMAIN
5919 This mode will only work correctly if smbpasswd(8)has been used to add this
5920 machine into a Windows NT Domain. It expects the \fIencrypted passwords\fR
5921 parameter to be set to true. In this
5922 mode Samba will try to validate the username/password by passing
5923 it to a Windows NT Primary or Backup Domain Controller, in exactly
5924 the same way that a Windows NT Server would do.
5927 \fBNote\fR that a valid UNIX user must still
5928 exist as well as the account on the Domain Controller to allow
5929 Samba to have a valid UNIX account to map file access to.
5932 \fBNote\fR that from the client's point
5933 of view \fBsecurity = domain\fR is the same as \fBsecurity = user
5934 \fR\&. It only affects how the server deals with the authentication,
5935 it does not in any way affect what the client sees.
5938 \fBNote\fR that the name of the resource being
5939 requested is \fBnot\fR sent to the server until after
5940 the server has successfully authenticated the client. This is why
5941 guest shares don't work in user level security without allowing
5942 the server to automatically map unknown users into the \fIguest account\fR.
5943 See the \fImap to guest\fR
5944 parameter for details on doing this.
5947 \fBBUG:\fR There is currently a bug in the
5948 implementation of \fBsecurity = domain\fR with respect
5949 to multi-byte character set usernames. The communication with a
5950 Domain Controller must be done in UNICODE and Samba currently
5951 does not widen multi-byte user names to UNICODE correctly, thus
5952 a multi-byte username will not be recognized correctly at the
5953 Domain Controller. This issue will be addressed in a future release.
5956 See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
5959 See also the \fIpassword
5960 server\fR parameter and the \fIencrypted passwords\fR
5964 Default: \fBsecurity = USER\fR
5967 Example: \fBsecurity = DOMAIN\fR
5970 \fBsecurity mask (S)\fR
5971 This parameter controls what UNIX permission
5972 bits can be modified when a Windows NT client is manipulating
5973 the UNIX permission on a file using the native NT security
5976 This parameter is applied as a mask (AND'ed with) to
5977 the changed permission bits, thus preventing any bits not in
5978 this mask from being modified. Essentially, zero bits in this
5979 mask may be treated as a set of bits the user is not allowed
5982 If not set explicitly this parameter is 0777, allowing
5983 a user to modify all the user/group/world permissions on a file.
5985 \fBNote\fR that users who can access the
5986 Samba server through other means can easily bypass this
5987 restriction, so it is primarily useful for standalone
5988 "appliance" systems. Administrators of most normal systems will
5989 probably want to leave it set to 0777.
5991 See also the \fIforce directory security mode\fR,
5993 security mask\fR, \fIforce security mode\fR parameters.
5995 Default: \fBsecurity mask = 0777\fR
5997 Example: \fBsecurity mask = 0770\fR
5999 \fBserver string (G)\fR
6000 This controls what string will show up in the
6001 printer comment box in print manager and next to the IPC connection
6002 in \fBnet view\fR. It can be any string that you wish
6003 to show to your users.
6005 It also sets what will appear in browse lists next
6006 to the machine name.
6008 A \fI%v\fR will be replaced with the Samba
6011 A \fI%h\fR will be replaced with the
6014 Default: \fBserver string = Samba %v\fR
6016 Example: \fBserver string = University of GNUs Samba
6019 \fBset directory (S)\fR
6020 If \fBset directory = no\fR, then
6021 users of the service may not use the setdir command to change
6024 The \fBsetdir\fR command is only implemented
6025 in the Digital Pathworks client. See the Pathworks documentation
6028 Default: \fBset directory = no\fR
6030 \fBshare modes (S)\fR
6031 This enables or disables the honoring of
6032 the \fIshare modes\fR during a file open. These
6033 modes are used by clients to gain exclusive read or write access
6036 These open modes are not directly supported by UNIX, so
6037 they are simulated using shared memory, or lock files if your
6038 UNIX doesn't support shared memory (almost all do).
6040 The share modes that are enabled by this option are
6042 DENY_READ, DENY_WRITE,
6043 DENY_NONE and DENY_FCB.
6045 This option gives full share compatibility and enabled
6048 You should \fBNEVER\fR turn this parameter
6049 off as many Windows applications will break if you do so.
6051 Default: \fBshare modes = yes\fR
6053 \fBshort preserve case (S)\fR
6054 This boolean parameter controls if new files
6055 which conform to 8.3 syntax, that is all in upper case and of
6056 suitable length, are created upper case, or if they are forced
6057 to be the \fIdefault case
6058 \fR\&. This option can be use with \fBpreserve case = yes\fR
6059 to permit long filenames to retain their case, while short
6062 See the section on NAME MANGLING.
6064 Default: \fBshort preserve case = yes\fR
6066 \fBshow add printer wizard (G)\fR
6067 With the introduction of MS-RPC based printing support
6068 for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will
6069 appear on Samba hosts in the share listing. Normally this folder will
6070 contain an icon for the MS Add Printer Wizard (APW). However, it is
6071 possible to disable this feature regardless of the level of privilege
6072 of the connected user.
6074 Under normal circumstances, the Windows NT/2000 client will
6075 open a handle on the printer server with OpenPrinterEx() asking for
6076 Administrator privileges. If the user does not have administrative
6077 access on the print server (i.e is not root or a member of the
6078 \fIprinter admin\fR group), the OpenPrinterEx()
6079 call fails and the client makes another open call with a request for
6080 a lower privilege level. This should succeed, however the APW
6081 icon will not be displayed.
6083 Disabling the \fIshow add printer wizard\fR
6084 parameter will always cause the OpenPrinterEx() on the server
6085 to fail. Thus the APW icon will never be displayed. \fB Note :\fRThis does not prevent the same user from having
6086 administrative privilege on an individual printer.
6088 See also \fIaddprinter
6089 command\fR, \fIdeleteprinter command\fR, \fIprinter admin\fR
6091 Default :\fBshow add printer wizard = yes\fR
6093 \fBshutdown script (G)\fR
6094 \fBThis parameter only exists in the HEAD cvs branch\fR
6095 This a full path name to a script called by
6097 should start a shutdown procedure.
6099 This command will be run as the user connected to the
6102 %m %t %r %f parameters are expanded
6104 \fI%m\fR will be substituted with the
6105 shutdown message sent to the server.
6107 \fI%t\fR will be substituted with the
6108 number of seconds to wait before effectively starting the
6111 \fI%r\fR will be substituted with the
6112 switch \fB-r\fR. It means reboot after shutdown
6115 \fI%f\fR will be substituted with the
6116 switch \fB-f\fR. It means force the shutdown
6117 even if applications do not respond for NT.
6119 Default: \fBNone\fR.
6121 Example: \fBabort shutdown script = /usr/local/samba/sbin/shutdown %m %t %r %f\fR
6123 Shutdown script example:
6132 /sbin/shutdown $3 $4 +$time $1 &
6136 Shutdown does not return so we need to launch it in background.
6138 See also \fIabort shutdown script\fR.
6140 \fBsmb passwd file (G)\fR
6141 This option sets the path to the encrypted
6142 smbpasswd file. By default the path to the smbpasswd file
6143 is compiled into Samba.
6145 Default: \fBsmb passwd file = ${prefix}/private/smbpasswd
6147 Example: \fBsmb passwd file = /etc/samba/smbpasswd
6149 \fBsocket address (G)\fR
6150 This option allows you to control what
6151 address Samba will listen for connections on. This is used to
6152 support multiple virtual interfaces on the one server, each
6153 with a different configuration.
6155 By default Samba will accept connections on any
6158 Example: \fBsocket address = 192.168.2.20\fR
6160 \fBsocket options (G)\fR
6161 This option allows you to set socket options
6162 to be used when talking with the client.
6164 Socket options are controls on the networking layer
6165 of the operating systems which allow the connection to be
6168 This option will typically be used to tune your Samba
6169 server for optimal performance for your local network. There is
6170 no way that Samba can know what the optimal parameters are for
6171 your net, so you must experiment and choose them yourself. We
6172 strongly suggest you read the appropriate documentation for your
6173 operating system first (perhaps \fBman setsockopt\fR
6176 You may find that on some systems Samba will say
6177 "Unknown socket option" when you supply an option. This means you
6178 either incorrectly typed it or you need to add an include file
6179 to includes.h for your OS. If the latter is the case please
6180 send the patch to samba@samba.org <URL:mailto:samba@samba.org>.
6182 Any of the supported socket options may be combined
6183 in any way you like, as long as your OS allows it.
6185 This is the list of socket options currently settable
6220 Those marked with a \fB'*'\fR take an integer
6221 argument. The others can optionally take a 1 or 0 argument to enable
6222 or disable the option, by default they will be enabled if you
6223 don't specify 1 or 0.
6226 To specify an argument use the syntax SOME_OPTION = VALUE
6227 for example \fBSO_SNDBUF = 8192\fR. Note that you must
6228 not have any spaces before or after the = sign.
6231 If you are on a local network then a sensible option
6235 \fBsocket options = IPTOS_LOWDELAY\fR
6238 If you have a local network then you could try:
6241 \fBsocket options = IPTOS_LOWDELAY TCP_NODELAY\fR
6244 If you are on a wide area network then perhaps try
6245 setting IPTOS_THROUGHPUT.
6248 Note that several of the options may cause your Samba
6249 server to fail completely. Use these options with caution!
6252 Default: \fBsocket options = TCP_NODELAY\fR
6255 Example: \fBsocket options = IPTOS_LOWDELAY\fR
6258 \fBsource environment (G)\fR
6259 This parameter causes Samba to set environment
6260 variables as per the content of the file named.
6262 If the value of this parameter starts with a "|" character
6263 then Samba will treat that value as a pipe command to open and
6264 will set the environment variables from the output of the pipe.
6266 The contents of the file or the output of the pipe should
6267 be formatted as the output of the standard Unix \fBenv(1)
6268 \fRcommand. This is of the form :
6270 Example environment entry:
6272 \fBSAMBA_NETBIOS_NAME = myhostname\fR
6274 Default: \fBNo default value\fR
6276 Examples: \fBsource environment = |/etc/smb.conf.sh
6278 Example: \fBsource environment =
6279 /usr/local/smb_env_vars\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 enables or disables the entire SSL mode. If
6288 it is set to no, the SSL-enabled Samba behaves
6289 exactly like the non-SSL Samba. If set to yes,
6290 it depends on the variables \fI ssl hosts\fR and \fIssl hosts resign\fR whether an SSL
6291 connection will be required.
6293 Default: \fBssl = no\fR
6295 \fBssl CA certDir (G)\fR
6296 This variable is part of SSL-enabled Samba. This
6297 is only available if the SSL libraries have been compiled on your
6298 system and the configure option \fB--with-ssl\fR was
6299 given at configure time.
6301 This variable defines where to look up the Certification
6302 Authorities. The given directory should contain one file for
6303 each CA that Samba will trust. The file name must be the hash
6304 value over the "Distinguished Name" of the CA. How this directory
6305 is set up is explained later in this document. All files within the
6306 directory that don't fit into this naming scheme are ignored. You
6307 don't need this variable if you don't verify client certificates.
6309 Default: \fBssl CA certDir = /usr/local/ssl/certs
6311 \fBssl CA certFile (G)\fR
6312 This variable is part of SSL-enabled Samba. This
6313 is only available if the SSL libraries have been compiled on your
6314 system and the configure option \fB--with-ssl\fR was
6315 given at configure time.
6317 This variable is a second way to define the trusted CAs.
6318 The certificates of the trusted CAs are collected in one big
6319 file and this variable points to the file. You will probably
6320 only use one of the two ways to define your CAs. The first choice is
6321 preferable if you have many CAs or want to be flexible, the second
6322 is preferable if you only have one CA and want to keep things
6323 simple (you won't need to create the hashed file names). You
6324 don't need this variable if you don't verify client certificates.
6326 Default: \fBssl CA certFile = /usr/local/ssl/certs/trustedCAs.pem
6328 \fBssl ciphers (G)\fR
6329 This variable is part of SSL-enabled Samba. This
6330 is only available if the SSL libraries have been compiled on your
6331 system and the configure option \fB--with-ssl\fR was
6332 given at configure time.
6334 This variable defines the ciphers that should be offered
6335 during SSL negotiation. You should not set this variable unless
6336 you know what you are doing.
6338 \fBssl client cert (G)\fR
6339 This variable is part of SSL-enabled Samba. This
6340 is only available if the SSL libraries have been compiled on your
6341 system and the configure option \fB--with-ssl\fR was
6342 given at configure time.
6344 The certificate in this file is used by \fBsmbclient(1)\fRif it exists. It's needed
6345 if the server requires a client certificate.
6347 Default: \fBssl client cert = /usr/local/ssl/certs/smbclient.pem
6349 \fBssl client key (G)\fR
6350 This variable is part of SSL-enabled Samba. This
6351 is only available if the SSL libraries have been compiled on your
6352 system and the configure option \fB--with-ssl\fR was
6353 given at configure time.
6355 This is the private key for \fBsmbclient(1)\fR. It's only needed if the
6356 client should have a certificate.
6358 Default: \fBssl client key = /usr/local/ssl/private/smbclient.pem
6360 \fBssl compatibility (G)\fR
6361 This variable is part of SSL-enabled Samba. This
6362 is only available if the SSL libraries have been compiled on your
6363 system and the configure option \fB--with-ssl\fR was
6364 given at configure time.
6366 This variable defines whether OpenSSL should be configured
6367 for bug compatibility with other SSL implementations. This is
6368 probably not desirable because currently no clients with SSL
6369 implementations other than OpenSSL exist.
6371 Default: \fBssl compatibility = no\fR
6373 \fBssl egd socket (G)\fR
6374 This variable is part of SSL-enabled Samba. This
6375 is only available if the SSL libraries have been compiled on your
6376 system and the configure option \fB--with-ssl\fR was
6377 given at configure time.
6379 This option is used to define the location of the communiation socket of
6380 an EGD or PRNGD daemon, from which entropy can be retrieved. This option
6381 can be used instead of or together with the \fIssl entropy file\fR
6382 directive. 255 bytes of entropy will be retrieved from the daemon.
6386 \fBssl entropy bytes (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 This parameter is used to define the number of bytes which should
6393 be read from the \fIssl entropy
6394 file\fR If a -1 is specified, the entire file will
6397 Default: \fBssl entropy bytes = 255\fR
6399 \fBssl entropy file (G)\fR
6400 This variable is part of SSL-enabled Samba. This
6401 is only available if the SSL libraries have been compiled on your
6402 system and the configure option \fB--with-ssl\fR was
6403 given at configure time.
6405 This parameter is used to specify a file from which processes will
6406 read "random bytes" on startup. In order to seed the internal pseudo
6407 random number generator, entropy must be provided. On system with a
6408 \fI/dev/urandom\fR device file, the processes
6409 will retrieve its entropy from the kernel. On systems without kernel
6410 entropy support, a file can be supplied that will be read on startup
6411 and that will be used to seed the PRNG.
6416 See \fI ssl hosts resign\fR.
6418 \fBssl hosts resign (G)\fR
6419 This variable is part of SSL-enabled Samba. This
6420 is only available if the SSL libraries have been compiled on your
6421 system and the configure option \fB--with-ssl\fR was
6422 given at configure time.
6424 These two variables define whether Samba will go
6425 into SSL mode or not. If none of them is defined, Samba will
6426 allow only SSL connections. If the \fIssl hosts\fR variable lists
6427 hosts (by IP-address, IP-address range, net group or name),
6428 only these hosts will be forced into SSL mode. If the \fI ssl hosts resign\fR variable lists hosts, only these
6429 hosts will \fBNOT\fR be forced into SSL mode. The syntax for these two
6430 variables is the same as for the \fI hosts allow\fR and \fIhosts deny\fR pair of variables, only
6431 that the subject of the decision is different: It's not the access
6432 right but whether SSL is used or not.
6434 The example below requires SSL connections from all hosts
6435 outside the local net (which is 192.168.*.*).
6437 Default: \fBssl hosts = <empty string>\fR
6439 \fBssl hosts resign = <empty string>\fR
6441 Example: \fBssl hosts resign = 192.168.\fR
6443 \fBssl require clientcert (G)\fR
6444 This variable is part of SSL-enabled Samba. This
6445 is only available if the SSL libraries have been compiled on your
6446 system and the configure option \fB--with-ssl\fR was
6447 given at configure time.
6449 If this variable is set to yes, the
6450 server will not tolerate connections from clients that don't
6451 have a valid certificate. The directory/file given in \fIssl CA certDir\fR
6452 and \fIssl CA certFile
6453 \fRwill be used to look up the CAs that issued
6454 the client's certificate. If the certificate can't be verified
6455 positively, the connection will be terminated. If this variable
6456 is set to no, clients don't need certificates.
6457 Contrary to web applications you really \fBshould\fR
6458 require client certificates. In the web environment the client's
6459 data is sensitive (credit card numbers) and the server must prove
6460 to be trustworthy. In a file server environment the server's data
6461 will be sensitive and the clients must prove to be trustworthy.
6463 Default: \fBssl require clientcert = no\fR
6465 \fBssl require servercert (G)\fR
6466 This variable is part of SSL-enabled Samba. This
6467 is only available if the SSL libraries have been compiled on your
6468 system and the configure option \fB--with-ssl\fR was
6469 given at configure time.
6471 If this variable is set to yes, the
6473 will request a certificate from the server. Same as
6475 clientcert\fR for the server.
6477 Default: \fBssl require servercert = no\fR
6479 \fBssl server cert (G)\fR
6480 This variable is part of SSL-enabled Samba. This
6481 is only available if the SSL libraries have been compiled on your
6482 system and the configure option \fB--with-ssl\fR was
6483 given at configure time.
6485 This is the file containing the server's certificate.
6486 The server \fBmust\fR have a certificate. The
6487 file may also contain the server's private key. See later for
6488 how certificates and private keys are created.
6490 Default: \fBssl server cert = <empty string>
6492 \fBssl server key (G)\fR
6493 This variable is part of SSL-enabled Samba. This
6494 is only available if the SSL libraries have been compiled on your
6495 system and the configure option \fB--with-ssl\fR was
6496 given at configure time.
6498 This file contains the private key of the server. If
6499 this variable is not defined, the key is looked up in the
6500 certificate file (it may be appended to the certificate).
6501 The server \fBmust\fR have a private key
6502 and the certificate \fBmust\fR
6503 match this private key.
6505 Default: \fBssl server key = <empty string>
6507 \fBssl version (G)\fR
6508 This variable is part of SSL-enabled Samba. This
6509 is only available if the SSL libraries have been compiled on your
6510 system and the configure option \fB--with-ssl\fR was
6511 given at configure time.
6513 This enumeration variable defines the versions of the
6514 SSL protocol that will be used. ssl2or3 allows
6515 dynamic negotiation of SSL v2 or v3, ssl2 results
6516 in SSL v2, ssl3 results in SSL v3 and
6517 tls1 results in TLS v1. TLS (Transport Layer
6518 Security) is the new standard for SSL.
6520 Default: \fBssl version = "ssl2or3"\fR
6522 \fBstat cache (G)\fR
6523 This parameter determines if smbd(8)will use a cache in order to
6524 speed up case insensitive name mappings. You should never need
6525 to change this parameter.
6527 Default: \fBstat cache = yes\fR
6529 \fBstat cache size (G)\fR
6530 This parameter determines the number of
6531 entries in the \fIstat cache\fR. You should
6532 never need to change this parameter.
6534 Default: \fBstat cache size = 50\fR
6537 This enables or disables logging of connections
6538 to a status file that smbstatus(1)
6541 With this disabled \fBsmbstatus\fR won't be able
6542 to tell you what connections are active. You should never need to
6543 change this parameter.
6545 Default: \fBstatus = yes\fR
6547 \fBstrict allocate (S)\fR
6548 This is a boolean that controls the handling of
6549 disk space allocation in the server. When this is set to yes
6550 the server will change from UNIX behaviour of not committing real
6551 disk storage blocks when a file is extended to the Windows behaviour
6552 of actually forcing the disk system to allocate real storage blocks
6553 when a file is created or extended to be a given size. In UNIX
6554 terminology this means that Samba will stop creating sparse files.
6555 This can be slow on some systems.
6557 When strict allocate is no the server does sparse
6558 disk block allocation when a file is extended.
6560 Setting this to yes can help Samba return
6561 out of quota messages on systems that are restricting the disk quota
6564 Default: \fBstrict allocate = no\fR
6566 \fBstrict locking (S)\fR
6567 This is a boolean that controls the handling of
6568 file locking in the server. When this is set to yes
6569 the server will check every read and write access for file locks, and
6570 deny access if locks exist. This can be slow on some systems.
6572 When strict locking is no the server does file
6573 lock checks only when the client explicitly asks for them.
6575 Well-behaved clients always ask for lock checks when it
6576 is important, so in the vast majority of cases \fBstrict
6577 locking = no\fR is preferable.
6579 Default: \fBstrict locking = no\fR
6581 \fBstrict sync (S)\fR
6582 Many Windows applications (including the Windows
6583 98 explorer shell) seem to confuse flushing buffer contents to
6584 disk with doing a sync to disk. Under UNIX, a sync call forces
6585 the process to be suspended until the kernel has ensured that
6586 all outstanding data in kernel disk buffers has been safely stored
6587 onto stable storage. This is very slow and should only be done
6588 rarely. Setting this parameter to no (the
6589 default) means that smbdignores the Windows applications requests for
6590 a sync call. There is only a possibility of losing data if the
6591 operating system itself that Samba is running on crashes, so there is
6592 little danger in this default setting. In addition, this fixes many
6593 performance problems that people have reported with the new Windows98
6594 explorer shell file copies.
6596 See also the \fIsync
6597 always>\fR parameter.
6599 Default: \fBstrict sync = no\fR
6602 This is a boolean that controls whether to
6603 strip trailing dots off UNIX filenames. This helps with some
6604 CDROMs that have filenames ending in a single dot.
6606 Default: \fBstrip dot = no\fR
6608 \fBsync always (S)\fR
6609 This is a boolean parameter that controls
6610 whether writes will always be written to stable storage before
6611 the write call returns. If this is false then the server will be
6612 guided by the client's request in each write call (clients can
6613 set a bit indicating that a particular write should be synchronous).
6614 If this is true then every write will be followed by a \fBfsync()
6615 \fRcall to ensure the data is written to disk. Note that
6616 the \fIstrict sync\fR parameter must be set to
6617 yes in order for this parameter to have
6620 See also the \fIstrict
6623 Default: \fBsync always = no\fR
6626 This parameter maps how Samba debug messages
6627 are logged onto the system syslog logging levels. Samba debug
6628 level zero maps onto syslog LOG_ERR, debug
6629 level one maps onto LOG_WARNING, debug level
6630 two maps onto LOG_NOTICE, debug level three
6631 maps onto LOG_INFO. All higher levels are mapped to LOG_DEBUG.
6633 This parameter sets the threshold for sending messages
6634 to syslog. Only messages with debug level less than this value
6635 will be sent to syslog.
6637 Default: \fBsyslog = 1\fR
6639 \fBsyslog only (G)\fR
6640 If this parameter is set then Samba debug
6641 messages are logged into the system syslog only, and not to
6642 the debug log files.
6644 Default: \fBsyslog only = no\fR
6646 \fBtemplate homedir (G)\fR
6647 When filling out the user information for a Windows NT
6648 user, the winbindd(8)daemon
6649 uses this parameter to fill in the home directory for that user.
6650 If the string \fI%D\fR is present it is substituted
6651 with the user's Windows NT domain name. If the string \fI%U
6652 \fRis present it is substituted with the user's Windows
6655 Default: \fBtemplate homedir = /home/%D/%U\fR
6657 \fBtemplate shell (G)\fR
6658 When filling out the user information for a Windows NT
6659 user, the winbindd(8)daemon
6660 uses this parameter to fill in the login shell for that user.
6662 Default: \fBtemplate shell = /bin/false\fR
6664 \fBtime offset (G)\fR
6665 This parameter is a setting in minutes to add
6666 to the normal GMT to local time conversion. This is useful if
6667 you are serving a lot of PCs that have incorrect daylight
6668 saving time handling.
6670 Default: \fBtime offset = 0\fR
6672 Example: \fBtime offset = 60\fR
6674 \fBtime server (G)\fR
6675 This parameter determines if
6676 nmbd(8)advertises itself as a time server to Windows
6679 Default: \fBtime server = no\fR
6681 \fBtimestamp logs (G)\fR
6682 Synonym for \fI debug timestamp\fR.
6684 \fBtotal print jobs (G)\fR
6685 This parameter accepts an integer value which defines
6686 a limit on the maximum number of print jobs that will be accepted
6687 system wide at any given time. If a print job is submitted
6688 by a client which will exceed this number, then smbdwill return an
6689 error indicating that no space is available on the server. The
6690 default value of 0 means that no such limit exists. This parameter
6691 can be used to prevent a server from exceeding its capacity and is
6692 designed as a printing throttle. See also
6693 \fImax print jobs\fR.
6695 Default: \fBtotal print jobs = 0\fR
6697 Example: \fBtotal print jobs = 5000\fR
6699 \fBunix extensions(G)\fR
6700 This boolean parameter controls whether Samba
6701 implments the CIFS UNIX extensions, as defined by HP. These
6702 extensions enable CIFS to server UNIX clients to UNIX servers
6703 better, and allow such things as symbolic links, hard links etc.
6704 These extensions require a similarly enabled client, and are of
6705 no current use to Windows clients.
6707 Default: \fBunix extensions = no\fR
6709 \fBunix password sync (G)\fR
6710 This boolean parameter controls whether Samba
6711 attempts to synchronize the UNIX password with the SMB password
6712 when the encrypted SMB password in the smbpasswd file is changed.
6713 If this is set to true the program specified in the \fIpasswd
6714 program\fRparameter is called \fBAS ROOT\fR -
6715 to allow the new UNIX password to be set without access to the
6716 old UNIX password (as the SMB password change code has no
6717 access to the old password cleartext, only the new).
6720 program\fR, \fI passwd chat\fR.
6722 Default: \fBunix password sync = no\fR
6724 \fBupdate encrypted (G)\fR
6725 This boolean parameter allows a user logging
6726 on with a plaintext password to have their encrypted (hashed)
6727 password in the smbpasswd file to be updated automatically as
6728 they log on. This option allows a site to migrate from plaintext
6729 password authentication (users authenticate with plaintext
6730 password over the wire, and are checked against a UNIX account
6731 database) to encrypted password authentication (the SMB
6732 challenge/response authentication mechanism) without forcing
6733 all users to re-enter their passwords via smbpasswd at the time the
6734 change is made. This is a convenience option to allow the change over
6735 to encrypted passwords to be made over a longer period. Once all users
6736 have encrypted representations of their passwords in the smbpasswd
6737 file this parameter should be set to no.
6739 In order for this parameter to work correctly the \fIencrypt passwords\fR
6740 parameter must be set to no when
6741 this parameter is set to yes.
6743 Note that even when this parameter is set a user
6744 authenticating to \fBsmbd\fR must still enter a valid
6745 password in order to connect correctly, and to update their hashed
6746 (smbpasswd) passwords.
6748 Default: \fBupdate encrypted = no\fR
6750 \fBuse client driver (S)\fR
6751 This parameter applies only to Windows NT/2000
6752 clients. It has no affect on Windows 95/98/ME clients. When
6753 serving a printer to Windows NT/2000 clients without first installing
6754 a valid printer driver on the Samba host, the client will be required
6755 to install a local printer driver. From this point on, the client
6756 will treat the print as a local printer and not a network printer
6757 connection. This is much the same behavior that will occur
6758 when \fBdisable spoolss = yes\fR.
6761 factor is that under normal circumstances, the NT/2000 client will
6762 attempt to open the network printer using MS-RPC. The problem is that
6763 because the client considers the printer to be local, it will attempt
6764 to issue the OpenPrinterEx() call requesting access rights associated
6765 with the logged on user. If the user possesses local administator rights
6766 but not root privilegde on the Samba host (often the case), the OpenPrinterEx()
6767 call will fail. The result is that the client will now display an "Access
6768 Denied; Unable to connect" message in the printer queue window (even though
6769 jobs may successfully be printed).
6771 If this parameter is enabled for a printer, then any attempt
6772 to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped
6773 to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx()
6774 call to succeed. \fBThis parameter MUST not be able enabled
6775 on a print share which has valid print driver installed on the Samba
6778 See also disable spoolss
6780 Default: \fBuse client driver = no\fR
6783 This global parameter determines if the tdb internals of Samba can
6784 depend on mmap working correctly on the running system. Samba requires a coherent
6785 mmap/read-write system memory cache. Currently only HPUX does not have such a
6786 coherent cache, and so this parameter is set to false by
6787 default on HPUX. On all other systems this parameter should be left alone. This
6788 parameter is provided to help the Samba developers track down problems with
6789 the tdb internal code.
6791 Default: \fBuse mmap = yes\fR
6793 \fBuse rhosts (G)\fR
6794 If this global parameter is true, it specifies
6795 that the UNIX user's \fI.rhosts\fR file in their home directory
6796 will be read to find the names of hosts and users who will be allowed
6797 access without specifying a password.
6799 \fBNOTE:\fR The use of \fIuse rhosts
6800 \fRcan be a major security hole. This is because you are
6801 trusting the PC to supply the correct username. It is very easy to
6802 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
6805 Default: \fBuse rhosts = no\fR
6808 Synonym for \fI username\fR.
6811 Synonym for \fI username\fR.
6814 Multiple users may be specified in a comma-delimited
6815 list, in which case the supplied password will be tested against
6816 each username in turn (left to right).
6818 The \fIusername\fR line is needed only when
6819 the PC is unable to supply its own username. This is the case
6820 for the COREPLUS protocol or where your users have different WfWg
6821 usernames to UNIX usernames. In both these cases you may also be
6822 better using the \\\\server\\share%user syntax instead.
6824 The \fIusername\fR line is not a great
6825 solution in many cases as it means Samba will try to validate
6826 the supplied password against each of the usernames in the
6827 \fIusername\fR line in turn. This is slow and
6828 a bad idea for lots of users in case of duplicate passwords.
6829 You may get timeouts or security breaches using this parameter
6832 Samba relies on the underlying UNIX security. This
6833 parameter does not restrict who can login, it just offers hints
6834 to the Samba server as to what usernames might correspond to the
6835 supplied password. Users can login as whoever they please and
6836 they will be able to do no more damage than if they started a
6837 telnet session. The daemon runs as the user that they log in as,
6838 so they cannot do anything that user cannot do.
6840 To restrict a service to a particular set of users you
6841 can use the \fIvalid users
6844 If any of the usernames begin with a '@' then the name
6845 will be looked up first in the NIS netgroups list (if Samba
6846 is compiled with netgroup support), followed by a lookup in
6847 the UNIX groups database and will expand to a list of all users
6848 in the group of that name.
6850 If any of the usernames begin with a '+' then the name
6851 will be looked up only in the UNIX groups database and will
6852 expand to a list of all users in the group of that name.
6854 If any of the usernames begin with a '&'then the name
6855 will be looked up only in the NIS netgroups database (if Samba
6856 is compiled with netgroup support) and will expand to a list
6857 of all users in the netgroup group of that name.
6859 Note that searching though a groups database can take
6860 quite some time, and some clients may time out during the
6863 See the section NOTE ABOUT
6864 USERNAME/PASSWORD VALIDATION for more information on how
6865 this parameter determines access to the services.
6867 Default: \fBThe guest account if a guest service,
6868 else <empty string>.\fR
6870 Examples:\fBusername = fred, mary, jack, jane,
6873 \fBusername level (G)\fR
6874 This option helps Samba to try and 'guess' at
6875 the real UNIX username, as many DOS clients send an all-uppercase
6876 username. By default Samba tries all lowercase, followed by the
6877 username with the first letter capitalized, and fails if the
6878 username is not found on the UNIX machine.
6880 If this parameter is set to non-zero the behavior changes.
6881 This parameter is a number that specifies the number of uppercase
6882 combinations to try while trying to determine the UNIX user name. The
6883 higher the number the more combinations will be tried, but the slower
6884 the discovery of usernames will be. Use this parameter when you have
6885 strange usernames on your UNIX machine, such as AstrangeUser
6888 Default: \fBusername level = 0\fR
6890 Example: \fBusername level = 5\fR
6892 \fBusername map (G)\fR
6893 This option allows you to specify a file containing
6894 a mapping of usernames from the clients to the server. This can be
6895 used for several purposes. The most common is to map usernames
6896 that users use on DOS or Windows machines to those that the UNIX
6897 box uses. The other is to map multiple users to a single username
6898 so that they can more easily share files.
6900 The map file is parsed line by line. Each line should
6901 contain a single UNIX username on the left then a '=' followed
6902 by a list of usernames on the right. The list of usernames on the
6903 right may contain names of the form @group in which case they
6904 will match any UNIX username in that group. The special client
6905 name '*' is a wildcard and matches any name. Each line of the
6906 map file may be up to 1023 characters long.
6908 The file is processed on each line by taking the
6909 supplied username and comparing it with each username on the right
6910 hand side of the '=' signs. If the supplied name matches any of
6911 the names on the right hand side then it is replaced with the name
6912 on the left. Processing then continues with the next line.
6914 If any line begins with a '#' or a ';' then it is
6917 If any line begins with an '!' then the processing
6918 will stop after that line if a mapping was done by the line.
6919 Otherwise mapping continues with every line being processed.
6920 Using '!' is most useful when you have a wildcard mapping line
6923 For example to map from the name admin
6924 or administrator to the UNIX name root you would use:
6926 \fBroot = admin administrator\fR
6928 Or to map anyone in the UNIX group system
6929 to the UNIX name sys you would use:
6933 You can have as many mappings as you like in a username
6936 If your system supports the NIS NETGROUP option then
6937 the netgroup database is checked before the \fI/etc/group
6938 \fRdatabase for matching groups.
6940 You can map Windows usernames that have spaces in them
6941 by using double quotes around the name. For example:
6943 \fBtridge = "Andrew Tridgell"\fR
6945 would map the windows username "Andrew Tridgell" to the
6946 unix username "tridge".
6948 The following example would map mary and fred to the
6949 unix user sys, and map the rest to guest. Note the use of the
6950 \&'!' to tell Samba to stop processing if it gets a match on
6961 Note that the remapping is applied to all occurrences
6962 of usernames. Thus if you connect to \\\\server\\fred and fred is remapped to mary then you
6963 will actually be connecting to \\\\server\\mary and will need to
6964 supply a password suitable for mary not
6965 fred. The only exception to this is the
6966 username passed to the \fI password server\fR (if you have one). The password
6967 server will receive whatever username the client supplies without
6970 Also note that no reverse mapping is done. The main effect
6971 this has is with printing. Users who have been mapped may have
6972 trouble deleting print jobs as PrintManager under WfWg will think
6973 they don't own the print job.
6975 Default: \fBno username map\fR
6977 Example: \fBusername map = /usr/local/samba/lib/users.map
6980 This boolean parameter is only available if
6981 Samba has been configured and compiled with the option \fB --with-utmp\fR. If set to true then Samba will attempt
6982 to add utmp or utmpx records (depending on the UNIX system) whenever a
6983 connection is made to a Samba server. Sites may use this to record the
6984 user connecting to a Samba share.
6986 See also the \fI utmp directory\fR parameter.
6988 Default: \fButmp = no\fR
6990 \fButmp directory(G)\fR
6991 This parameter is only available if Samba has
6992 been configured and compiled with the option \fB --with-utmp\fR. It specifies a directory pathname that is
6993 used to store the utmp or utmpx files (depending on the UNIX system) that
6994 record user connections to a Samba server. See also the \fIutmp\fR parameter. By default this is
6995 not set, meaning the system will use whatever utmp file the
6996 native system is set to use (usually
6997 \fI/var/run/utmp\fR on Linux).
6999 Default: \fBno utmp directory\fR
7001 \fBvalid users (S)\fR
7002 This is a list of users that should be allowed
7003 to login to this service. Names starting with '@', '+' and '&'
7004 are interpreted using the same rules as described in the
7005 \fIinvalid users\fR parameter.
7007 If this is empty (the default) then any user can login.
7008 If a username is in both this list and the \fIinvalid
7009 users\fR list then access is denied for that user.
7011 The current servicename is substituted for \fI%S
7012 \fR\&. This is useful in the [homes] section.
7014 See also \fIinvalid users
7016 Default: \fBNo valid users list (anyone can login)
7018 Example: \fBvalid users = greg, @pcusers\fR
7021 This is a list of files and directories that
7022 are neither visible nor accessible. Each entry in the list must
7023 be separated by a '/', which allows spaces to be included
7024 in the entry. '*' and '?' can be used to specify multiple files
7025 or directories as in DOS wildcards.
7027 Each entry must be a unix path, not a DOS path and
7028 must \fBnot\fR include the unix directory
7031 Note that the \fIcase sensitive\fR option
7032 is applicable in vetoing files.
7034 One feature of the veto files parameter that it
7035 is important to be aware of is Samba's behaviour when
7036 trying to delete a directory. If a directory that is
7037 to be deleted contains nothing but veto files this
7038 deletion will \fBfail\fR unless you also set
7039 the \fIdelete veto files\fR parameter to
7042 Setting this parameter will affect the performance
7043 of Samba, as it will be forced to check all files and directories
7044 for a match as they are scanned.
7046 See also \fIhide files
7047 \fRand \fI case sensitive\fR.
7049 Default: \fBNo files or directories are vetoed.
7054 ; Veto any files containing the word Security,
7055 ; any ending in .tmp, and any directory containing the
7057 veto files = /*Security*/*.tmp/*root*/
7059 ; Veto the Apple specific files that a NetAtalk server
7061 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
7065 \fBveto oplock files (S)\fR
7066 This parameter is only valid when the \fIoplocks\fR
7067 parameter is turned on for a share. It allows the Samba administrator
7068 to selectively turn off the granting of oplocks on selected files that
7069 match a wildcarded list, similar to the wildcarded list used in the
7073 Default: \fBNo files are vetoed for oplock
7076 You might want to do this on files that you know will
7077 be heavily contended for by clients. A good example of this
7078 is in the NetBench SMB benchmark program, which causes heavy
7079 client contention for files ending in \fI.SEM\fR.
7080 To cause Samba not to grant oplocks on these files you would use
7081 the line (either in the [global] section or in the section for
7082 the particular NetBench share :
7084 Example: \fBveto oplock files = /*.SEM/
7086 \fBvfs object (S)\fR
7087 This parameter specifies a shared object file that
7088 is used for Samba VFS I/O operations. By default, normal
7089 disk I/O operations are used but these can be overloaded
7090 with a VFS object. The Samba VFS layer is new to Samba 2.2 and
7091 must be enabled at compile time with --with-vfs.
7093 Default : \fBno value\fR
7095 \fBvfs options (S)\fR
7096 This parameter allows parameters to be passed
7097 to the vfs layer at initialization time. The Samba VFS layer
7098 is new to Samba 2.2 and must be enabled at compile time
7099 with --with-vfs. See also \fI vfs object\fR.
7101 Default : \fBno value\fR
7104 This allows you to override the volume label
7105 returned for a share. Useful for CDROMs with installation programs
7106 that insist on a particular volume label.
7108 Default: \fBthe name of the share\fR
7110 \fBwide links (S)\fR
7111 This parameter controls whether or not links
7112 in the UNIX file system may be followed by the server. Links
7113 that point to areas within the directory tree exported by the
7114 server are always allowed; this parameter controls access only
7115 to areas that are outside the directory tree being exported.
7117 Note that setting this parameter can have a negative
7118 effect on your server performance due to the extra system calls
7119 that Samba has to do in order to perform the link checks.
7121 Default: \fBwide links = yes\fR
7123 \fBwinbind cache time (G)\fR
7124 This parameter specifies the number of seconds the
7125 winbindd(8)daemon will cache
7126 user and group information before querying a Windows NT server
7129 Default: \fBwinbind cache type = 15\fR
7131 \fBwinbind enum users (G)\fR
7132 On large installations using
7133 winbindd(8)it may be
7134 necessary to suppress the enumeration of users through the
7136 \fBgetpwent()\fR and
7137 \fBendpwent()\fR group of system calls. If
7138 the \fIwinbind enum users\fR parameter is
7139 false, calls to the \fBgetpwent\fR system call
7140 will not return any data.
7142 \fBWarning:\fR Turning off user
7143 enumeration may cause some programs to behave oddly. For
7144 example, the finger program relies on having access to the
7145 full user list when searching for matching
7148 Default: \fBwinbind enum users = yes \fR
7150 \fBwinbind enum groups (G)\fR
7151 On large installations using
7152 winbindd(8)it may be
7153 necessary to suppress the enumeration of groups through the
7155 \fBgetgrent()\fR and
7156 \fBendgrent()\fR group of system calls. If
7157 the \fIwinbind enum groups\fR parameter is
7158 false, calls to the \fBgetgrent()\fR system
7159 call will not return any data.
7161 \fBWarning:\fR Turning off group
7162 enumeration may cause some programs to behave oddly.
7164 Default: \fBwinbind enum groups = yes \fR
7166 \fBwinbind gid (G)\fR
7167 The winbind gid parameter specifies the range of group
7168 ids that are allocated by the winbindd(8)daemon. This range of group ids should have no
7169 existing local or NIS groups within it as strange conflicts can
7172 Default: \fBwinbind gid = <empty string>
7174 Example: \fBwinbind gid = 10000-20000\fR
7176 \fBwinbind separator (G)\fR
7177 This parameter allows an admin to define the character
7178 used when listing a username of the form of \fIDOMAIN
7179 \fR\\\fIuser\fR. This parameter
7180 is only applicable when using the \fIpam_winbind.so\fR
7181 and \fInss_winbind.so\fR modules for UNIX services.
7183 Please note that setting this parameter to + causes problems
7184 with group membership at least on glibc systems, as the character +
7185 is used as a special character for NIS in /etc/group.
7187 Default: \fBwinbind separator = '\\'\fR
7189 Example: \fBwinbind separator = +\fR
7191 \fBwinbind uid (G)\fR
7192 The winbind gid parameter specifies the range of group
7193 ids that are allocated by the winbindd(8)daemon. This range of ids should have no
7194 existing local or NIS users within it as strange conflicts can
7197 Default: \fBwinbind uid = <empty string>
7199 Example: \fBwinbind uid = 10000-20000\fR
7201 \fBwinbind use default domain\fR
7203 \fBwinbind use default domain\fR
7204 This parameter specifies whether the winbindd(8)
7205 daemon should operate on users without domain component in their username.
7206 Users without a domain component are treated as is part of the winbindd server's
7207 own domain. While this does not benifit Windows users, it makes SSH, FTP and e-mail
7208 function in a way much closer to the way they would in a native unix system.
7210 Default: \fBwinbind use default domain = <falseg>
7212 Example: \fBwinbind use default domain = true\fR
7215 When Samba is running as a WINS server this
7216 allows you to call an external program for all changes to the
7217 WINS database. The primary use for this option is to allow the
7218 dynamic update of external name resolution databases such as
7221 The wins hook parameter specifies the name of a script
7222 or executable that will be called as follows:
7224 \fBwins_hook operation name nametype ttl IP_list
7228 The first argument is the operation and is one
7229 of "add", "delete", or "refresh". In most cases the operation can
7230 be ignored as the rest of the parameters provide sufficient
7231 information. Note that "refresh" may sometimes be called when the
7232 name has not previously been added, in that case it should be treated
7236 The second argument is the NetBIOS name. If the
7237 name is not a legal name then the wins hook is not called.
7238 Legal names contain only letters, digits, hyphens, underscores
7242 The third argument is the NetBIOS name
7243 type as a 2 digit hexadecimal number.
7246 The fourth argument is the TTL (time to live)
7247 for the name in seconds.
7250 The fifth and subsequent arguments are the IP
7251 addresses currently registered for that name. If this list is
7252 empty then the name should be deleted.
7255 An example script that calls the BIND dynamic DNS update
7256 program \fBnsupdate\fR is provided in the examples
7257 directory of the Samba source code.
7260 \fBwins proxy (G)\fR
7261 This is a boolean that controls if nmbd(8)will respond to broadcast name
7262 queries on behalf of other hosts. You may need to set this
7263 to yes for some older clients.
7265 Default: \fBwins proxy = no\fR
7267 \fBwins server (G)\fR
7268 This specifies the IP address (or DNS name: IP
7269 address for preference) of the WINS server that nmbd(8)should register with. If you have a WINS server on
7270 your network then you should set this to the WINS server's IP.
7272 You should point this at your WINS server if you have a
7273 multi-subnetted network.
7275 \fBNOTE\fR. You need to set up Samba to point
7276 to a WINS server if you have multiple subnets and wish cross-subnet
7277 browsing to work correctly.
7279 See the documentation file \fIBROWSING.txt\fR
7280 in the docs/ directory of your Samba source distribution.
7282 Default: \fBnot enabled\fR
7284 Example: \fBwins server = 192.9.200.1\fR
7286 \fBwins support (G)\fR
7287 This boolean controls if the
7288 nmbd(8)process in Samba will act as a WINS server. You should
7289 not set this to true unless you have a multi-subnetted network and
7290 you wish a particular \fBnmbd\fR to be your WINS server.
7291 Note that you should \fBNEVER\fR set this to true
7292 on more than one machine in your network.
7294 Default: \fBwins support = no\fR
7297 This controls what workgroup your server will
7298 appear to be in when queried by clients. Note that this parameter
7299 also controls the Domain name used with the \fBsecurity = domain\fR
7302 Default: \fBset at compile time to WORKGROUP\fR
7304 Example: \fBworkgroup = MYGROUP\fR
7307 Synonym for \fI writeable\fR for people who can't spell :-).
7309 \fBwrite cache size (S)\fR
7310 If this integer parameter is set to non-zero value,
7311 Samba will create an in-memory cache for each oplocked file
7312 (it does \fBnot\fR do this for
7313 non-oplocked files). All writes that the client does not request
7314 to be flushed directly to disk will be stored in this cache if possible.
7315 The cache is flushed onto disk when a write comes in whose offset
7316 would not fit into the cache or when the file is closed by the client.
7317 Reads for the file are also served from this cache if the data is stored
7320 This cache allows Samba to batch client writes into a more
7321 efficient write size for RAID disks (i.e. writes may be tuned to
7322 be the RAID stripe size) and can improve performance on systems
7323 where the disk subsystem is a bottleneck but there is free
7324 memory for userspace programs.
7326 The integer parameter specifies the size of this cache
7327 (per oplocked file) in bytes.
7329 Default: \fBwrite cache size = 0\fR
7331 Example: \fBwrite cache size = 262144\fR
7333 for a 256k cache size per file.
7335 \fBwrite list (S)\fR
7336 This is a list of users that are given read-write
7337 access to a service. If the connecting user is in this list then
7338 they will be given write access, no matter what the \fIwriteable\fR
7339 option is set to. The list can include group names using the
7342 Note that if a user is in both the read list and the
7343 write list then they will be given write access.
7345 See also the \fIread list
7348 Default: \fBwrite list = <empty string>
7350 Example: \fBwrite list = admin, root, @staff
7353 Synonym for \fI writeable\fR.
7356 This parameter controls whether or not the server
7357 will support raw write SMB's when transferring data from clients.
7358 You should never need to change this parameter.
7360 Default: \fBwrite raw = yes\fR
7363 An inverted synonym is \fIread only\fR.
7365 If this parameter is no, then users
7366 of a service may not create or modify files in the service's
7369 Note that a printable service (\fBprintable = yes\fR)
7370 will \fBALWAYS\fR allow writing to the directory
7371 (user privileges permitting), but only via spooling operations.
7373 Default: \fBwriteable = no\fR
7376 Although the configuration file permits service names
7377 to contain spaces, your client software may not. Spaces will
7378 be ignored in comparisons anyway, so it shouldn't be a
7379 problem - but be aware of the possibility.
7381 On a similar note, many clients - especially DOS clients -
7382 limit service names to eight characters. smbd(8)
7383 has no such limitation, but attempts to connect from such
7384 clients will fail if they truncate the service names. For this reason
7385 you should probably keep your service names down to eight characters
7388 Use of the [homes] and [printers] special sections make life
7389 for an administrator easy, but the various combinations of default
7390 attributes can be tricky. Take extreme care when designing these
7391 sections. In particular, ensure that the permissions on spool
7392 directories are correct.
7395 This man page is correct for version 2.2 of
7410 The original Samba software and related utilities
7411 were created by Andrew Tridgell. Samba is now developed
7412 by the Samba Team as an Open Source project similar
7413 to the way the Linux kernel is developed.
7415 The original Samba man pages were written by Karl Auer.
7416 The man page sources were converted to YODL format (another
7417 excellent piece of Open Source software, available at
7418 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0
7419 release by Jeremy Allison. The conversion to DocBook for
7420 Samba 2.2 was done by Gerald Carter