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" "04 May 2001" "" ""
8 smb.conf \- The configuration file for the Samba suite
11 The \fIsmb.conf\fR file is a configuration
12 file for the Samba suite. \fIsmb.conf\fR contains
13 runtime configuration information for the Samba programs. The
14 \fIsmb.conf\fR file is designed to be configured and
15 administered by the \fBswat(8)\fR
16 program. The complete description of the file format and
17 possible parameters held within are here for reference purposes.
20 The file consists of sections and parameters. A section
21 begins with the name of the section in square brackets and continues
22 until the next section begins. Sections contain parameters of the
27 The file is line-based - that is, each newline-terminated
28 line represents either a comment, a section name or a parameter.
30 Section and parameter names are not case sensitive.
32 Only the first equals sign in a parameter is significant.
33 Whitespace before or after the first equals sign is discarded.
34 Leading, trailing and internal whitespace in section and parameter
35 names is irrelevant. Leading and trailing whitespace in a parameter
36 value is discarded. Internal whitespace within a parameter value
39 Any line beginning with a semicolon (';') or a hash ('#')
40 character is ignored, as are lines containing only whitespace.
42 Any line ending in a '\\' is continued
43 on the next line in the customary UNIX fashion.
45 The values following the equals sign in parameters are all
46 either a string (no quotes needed) or a boolean, which may be given
47 as yes/no, 0/1 or true/false. Case is not significant in boolean
48 values, but is preserved in string values. Some items such as
49 create modes are numeric.
50 .SH "SECTION DESCRIPTIONS"
52 Each section in the configuration file (except for the
53 [global] section) describes a shared resource (known
54 as a "share"). The section name is the name of the
55 shared resource and the parameters within the section define
56 the shares attributes.
58 There are three special sections, [global],
59 [homes] and [printers], which are
60 described under \fBspecial sections\fR. The
61 following notes apply to ordinary section descriptions.
63 A share consists of a directory to which access is being
64 given plus a description of the access rights which are granted
65 to the user of the service. Some housekeeping options are
68 Sections are either file share services (used by the
69 client as an extension of their native file systems) or
70 printable services (used by the client to access print services
71 on the host running the server).
73 Sections may be designated \fBguest\fR services,
74 in which case no password is required to access them. A specified
75 UNIX \fBguest account\fR is used to define access
76 privileges in this case.
78 Sections other than guest services will require a password
79 to access them. The client provides the username. As older clients
80 only provide passwords and not usernames, you may specify a list
81 of usernames to check against the password using the "user="
82 option in the share definition. For modern clients such as
83 Windows 95/98/ME/NT/2000, this should not be necessary.
85 Note that the access rights granted by the server are
86 masked by the access rights granted to the specified or guest
87 UNIX user by the host system. The server does not grant more
88 access than the host system grants.
90 The following sample section defines a file space share.
91 The user has write access to the path \fI/home/bar\fR.
92 The share is accessed via the share name "foo":
103 The following sample section defines a printable share.
104 The share is readonly, but printable. That is, the only write
105 access permitted is via calls to open, write to and close a
106 spool file. The \fBguest ok\fR parameter means
107 access will be permitted as the default guest user (specified
112 path = /usr/spool/public
120 .SH "SPECIAL SECTIONS"
121 .SS "THE GLOBAL SECTION"
123 parameters in this section apply to the server
124 as a whole, or are defaults for sections which do not
125 specifically define certain items. See the notes
126 under PARAMETERS for more information.
127 .SS "THE HOMES SECTION"
129 If a section called homes is included in the
130 configuration file, services connecting clients to their
131 home directories can be created on the fly by the server.
133 When the connection request is made, the existing
134 sections are scanned. If a match is found, it is used. If no
135 match is found, the requested section name is treated as a
136 user name and looked up in the local password file. If the
137 name exists and the correct password has been given, a share is
138 created by cloning the [homes] section.
140 Some modifications are then made to the newly
144 The share name is changed from homes to
145 the located username.
148 If no path was given, the path is set to
149 the user's home directory.
151 If you decide to use a \fBpath=\fR line
152 in your [homes] section then you may find it useful
153 to use the %S macro. For example :
156 \fBpath=/data/pchome/%S\fR
159 would be useful if you have different home directories
160 for your PCs than for UNIX access.
163 This is a fast and simple way to give a large number
164 of clients access to their home directories with a minimum
168 A similar process occurs if the requested section
169 name is "homes", except that the share name is not
170 changed to that of the requesting user. This method of using
171 the [homes] section works well if different users share
175 The [homes] section can specify all the parameters
176 a normal service section can specify, though some make more sense
177 than others. The following is a typical and suitable [homes]
189 An important point is that if guest access is specified
190 in the [homes] section, all home directories will be
191 visible to all clients \fBwithout a password\fR.
192 In the very unlikely event that this is actually desirable, it
193 would be wise to also specify \fBread only
197 Note that the \fBbrowseable\fR flag for
198 auto home directories will be inherited from the global browseable
199 flag, not the [homes] browseable flag. This is useful as
200 it means setting browseable=no in the [homes] section
201 will hide the [homes] share but make any auto home
204 .SS "THE PRINTERS SECTION"
206 This section works like [homes],
209 If a [printers] section occurs in the
210 configuration file, users are able to connect to any printer
211 specified in the local host's printcap file.
213 When a connection request is made, the existing sections
214 are scanned. If a match is found, it is used. If no match is found,
215 but a [homes] section exists, it is used as described
216 above. Otherwise, the requested section name is treated as a
217 printer name and the appropriate printcap file is scanned to see
218 if the requested section name is a valid printer share name. If
219 a match is found, a new printer share is created by cloning
220 the [printers] section.
222 A few modifications are then made to the newly created
226 The share name is set to the located printer
230 If no printer name was given, the printer name
231 is set to the located printer name
234 If the share does not permit guest access and
235 no username was given, the username is set to the located
238 Note that the [printers] service MUST be
239 printable - if you specify otherwise, the server will refuse
240 to load the configuration file.
243 Typically the path specified would be that of a
244 world-writeable spool directory with the sticky bit set on
245 it. A typical [printers] entry would look like
251 path = /usr/spool/public
258 All aliases given for a printer in the printcap file
259 are legitimate printer names as far as the server is concerned.
260 If your printing subsystem doesn't work like that, you will have
261 to set up a pseudo-printcap. This is a file consisting of one or
262 more lines like this:
266 alias|alias|alias|alias...
272 Each alias should be an acceptable printer name for
273 your printing subsystem. In the [global] section, specify
274 the new file as your printcap. The server will then only recognize
275 names found in your pseudo-printcap, which of course can contain
276 whatever aliases you like. The same technique could be used
277 simply to limit access to a subset of your local printers.
280 An alias, by the way, is defined as any component of the
281 first entry of a printcap record. Records are separated by newlines,
282 components (if there are more than one) are separated by vertical
286 NOTE: On SYSV systems which use lpstat to determine what
287 printers are defined on the system you may be able to use
288 "printcap name = lpstat" to automatically obtain a list
289 of printers. See the "printcap name" option
294 parameters define the specific attributes of sections.
296 Some parameters are specific to the [global] section
297 (e.g., \fBsecurity\fR). Some parameters are usable
298 in all sections (e.g., \fBcreate mode\fR). All others
299 are permissible only in normal sections. For the purposes of the
300 following descriptions the [homes] and [printers]
301 sections will be considered normal. The letter \fBG\fR
302 in parentheses indicates that a parameter is specific to the
303 [global] section. The letter \fBS\fR
304 indicates that a parameter can be specified in a service specific
305 section. Note that all \fBS\fR parameters can also be specified in
306 the [global] section - in which case they will define
307 the default behavior for all services.
309 parameters are arranged here in alphabetical order - this may
310 not create best bedfellows, but at least you can find them! Where
311 there are synonyms, the preferred synonym is described, others refer
312 to the preferred synonym.
313 .SH "VARIABLE SUBSTITUTIONS"
315 Many of the strings that are settable in the config file
316 can take substitutions. For example the option "path =
317 /tmp/%u" would be interpreted as "path =
318 /tmp/john" if the user connected with the username john.
320 These substitutions are mostly noted in the descriptions below,
321 but there are some general substitutions which apply whenever they
322 might be relevant. These are:
325 the name of the current service, if any.
328 the root directory of the current service,
332 user name of the current service, if any.
335 primary group name of %u.
338 session user name (the user name that the client
339 wanted, not necessarily the same as the one they got).
342 primary group name of %U.
345 the home directory of the user given
352 the Internet hostname that Samba is running
356 the NetBIOS name of the client machine
360 the NetBIOS name of the server. This allows you
361 to change your config based on what the client calls you. Your
362 server can have a "dual personality".
365 the Internet name of the client machine.
368 the name of your NIS home directory server.
369 This is obtained from your NIS auto.map entry. If you have
370 not compiled Samba with the \fB--with-automount\fR
371 option then this value will be the same as %.
374 the path of the service's home directory,
375 obtained from your NIS auto.map entry. The NIS auto.map entry
376 is split up as "%N:%p".
379 the selected protocol level after
380 protocol negotiation. It can be one of CORE, COREPLUS,
381 LANMAN1, LANMAN2 or NT1.
384 The process id of the current server
388 the architecture of the remote
389 machine. Only some are recognized, and those may not be
390 100% reliable. It currently recognizes Samba, WfWg,
391 WinNT and Win95. Anything else will be known as
392 "UNKNOWN". If it gets it wrong then sending a level
393 3 log to samba@samba.org
394 <URL:mailto:samba@samba.org> should allow it to be fixed.
397 The IP address of the client machine.
400 the current date and time.
402 \fB%$(\fIenvvar\fB)\fR
403 The value of the environment variable
406 There are some quite creative things that can be done
407 with these substitutions and other smb.conf options.
411 Samba supports "name mangling" so that DOS and
412 Windows clients can use files that don't conform to the 8.3 format.
413 It can also be set to adjust the case of 8.3 format filenames.
415 There are several options that control the way mangling is
416 performed, and they are grouped here rather than listed separately.
417 For the defaults look at the output of the testparm program.
419 All of these options can be set separately for each service
420 (or globally, of course).
424 \fBmangle case= yes/no\fR
425 controls if names that have characters that
426 aren't of the "default" case are mangled. For example,
427 if this is yes then a name like "Mail" would be mangled.
430 \fBcase sensitive = yes/no\fR
431 controls whether filenames are case sensitive. If
432 they aren't then Samba must do a filename search and match on passed
433 names. Default \fBno\fR.
435 \fBdefault case = upper/lower\fR
436 controls what the default case is for new
437 filenames. Default \fBlower\fR.
439 \fBpreserve case = yes/no\fR
440 controls if new files are created with the
441 case that the client passes, or if they are forced to be the
442 "default" case. Default \fByes\fR.
444 \fBshort preserve case = yes/no\fR
445 controls if new files which conform to 8.3 syntax,
446 that is all in upper case and of suitable length, are created
447 upper case, or if they are forced to be the "default"
448 case. This option can be use with "preserve case = yes"
449 to permit long filenames to retain their case, while short names
450 are lowered. Default \fByes\fR.
452 By default, Samba 2.2 has the same semantics as a Windows
453 NT server, in that it is case insensitive but case preserving.
455 .SH "NOTE ABOUT USERNAME/PASSWORD VALIDATION"
457 There are a number of ways in which a user can connect
458 to a service. The server uses the following steps in determining
459 if it will allow a connection to a specified service. If all the
460 steps fail, then the connection request is rejected. However, if one of the
461 steps succeeds, then the following steps are not checked.
463 If the service is marked "guest only = yes" then
464 steps 1 to 5 are skipped.
466 If the client has passed a username/password
467 pair and that username/password pair is validated by the UNIX
468 system's password programs then the connection is made as that
469 username. Note that this includes the
470 \\\\server\\service%\fIusername\fR method of passing
473 If the client has previously registered a username
474 with the system and now supplies a correct password for that
475 username then the connection is allowed.
477 The client's netbios name and any previously
478 used user names are checked against the supplied password, if
479 they match then the connection is allowed as the corresponding
482 If the client has previously validated a
483 username/password pair with the server and the client has passed
484 the validation token then that username is used.
486 If a "user = " field is given in the
487 \fIsmb.conf\fR file for the service and the client
488 has supplied a password, and that password matches (according to
489 the UNIX system's password checking) with one of the usernames
490 from the "user=" field then the connection is made as
491 the username in the "user=" line. If one
492 of the username in the "user=" list begins with a
493 \&'@' then that name expands to a list of names in
494 the group of the same name.
496 If the service is a guest service then a
497 connection is made as the username given in the "guest
498 account =" for the service, irrespective of the
500 .SH "COMPLETE LIST OF GLOBAL PARAMETERS"
502 Here is a list of all global parameters. See the section of
503 each parameter for details. Note that some are synonyms.
506 \fIadd printer command\fR
509 \fIadd share command\fR
512 \fIadd user script\fR
515 \fIallow trusted domains\fR
521 \fIannounce version\fR
527 \fIbind interfaces only\fR
533 \fIchange notify timeout\fR
536 \fIchange share command\fR
542 \fIclient code page\fR
545 \fIcode page directory\fR
557 \fIdebug hires timestamp\fR
563 \fIdebug timestamp\fR
575 \fIdefault service\fR
578 \fIdelete printer command\fR
581 \fIdelete share command\fR
584 \fIdelete user script\fR
593 \fIdomain admin group\fR
596 \fIdomain admin users\fR
602 \fIdomain guest group\fR
605 \fIdomain guest users\fR
614 \fIencrypt passwords\fR
617 \fIenhanced browsing\fR
620 \fIenumports command\fR
626 \fIhide local users\fR
689 \fImachine password timeout\fR
713 \fImax smbd processes\fR
725 \fImessage command\fR
728 \fImin passwd length\fR
731 \fImin password length\fR
740 \fIname resolve order\fR
743 \fInetbios aliases\fR
758 \fInt pipe support\fR
767 \fIobey pam restrictions\fR
770 \fIoplock break wait time\fR
779 \fIpam password change\fR
788 \fIpasswd chat debug\fR
797 \fIpassword server\fR
800 \fIprefered master\fR
803 \fIpreferred master\fR
815 \fIprinter driver file\fR
830 \fIremote announce\fR
833 \fIremote browse sync\fR
836 \fIrestrict anonymous\fR
854 \fIshow add printer wizard\fR
857 \fIsmb passwd file\fR
866 \fIsource environment\fR
875 \fIssl CA certFile\fR
881 \fIssl client cert\fR
887 \fIssl compatibility\fR
893 \fIssl hosts resign\fR
896 \fIssl require clientcert\fR
899 \fIssl require servercert\fR
902 \fIssl server cert\fR
914 \fIstat cache size\fR
926 \fItemplate homedir\fR
941 \fItotal print jobs\fR
944 \fIunix password sync\fR
947 \fIupdate encrypted\fR
965 \fIwinbind cache time\fR
971 \fIwinbind separator\fR
993 .SH "COMPLETE LIST OF SERVICE PARAMETERS"
995 Here is a list of all service parameters. See the section on
996 each parameter for details. Note that some are synonyms.
1008 \fIblocking locks\fR
1017 \fIcase sensitive\fR
1038 \fIdelete readonly\fR
1041 \fIdelete veto files\fR
1050 \fIdirectory mask\fR
1053 \fIdirectory mode\fR
1056 \fIdirectory security mask\fR
1065 \fIdos filetime resolution\fR
1074 \fIfake directory create times\fR
1080 \fIfollow symlinks\fR
1083 \fIforce create mode\fR
1086 \fIforce directory mode\fR
1089 \fIforce directory security mode\fR
1095 \fIforce security mode\fR
1116 \fIhide dot files\fR
1131 \fIinherit permissions\fR
1137 \fIlevel2 oplocks\fR
1143 \fIlppause command\fR
1149 \fIlpresume command\fR
1182 \fImax connections\fR
1185 \fImax print jobs\fR
1188 \fImin print space\fR
1200 \fIoplock contention limit\fR
1242 \fIprinter driver\fR
1245 \fIprinter driver location\fR
1257 \fIqueuepause command\fR
1260 \fIqueueresume command\fR
1269 \fIrestrict acl with mask\fR
1278 \fIroot preexec close\fR
1290 \fIshort preserve case\fR
1296 \fIstrict locking\fR
1323 \fIveto oplock files\fR
1341 \fIwrite cache size\fR
1351 .SH "EXPLANATION OF EACH PARAMETER"
1353 \fBadd printer command (G)\fR
1354 With the introduction of MS-RPC based printing
1355 support for Windows NT/2000 clients in Samba 2.2, The MS Add
1356 Printer Wizard (APW) icon is now also available in the
1357 "Printers..." folder displayed a share listing. The APW
1358 allows for printers to be add remotely to a Samba or Windows
1359 NT/2000 print server.
1361 For a Samba host this means that the printer must be
1362 physically added to underlying printing system. The \fIadd
1363 printer command\fR defines a script to be run which
1364 will perform the necessary operations for adding the printer
1365 to the print system and to add the appropriate service definition
1366 to the \fIsmb.conf\fR file in order that it can be
1367 shared by \fBsmbd(8)\fR
1370 The \fIadd printer command\fR is
1371 automatically invoked with the following parameter (in
1391 \fIWindows 9x driver location\fR
1394 All parameters are filled in from the PRINTER_INFO_2 structure sent
1395 by the Windows NT/2000 client with one exception. The "Windows 9x
1396 driver location" parameter is included for backwards compatibility
1397 only. The remaining fields in the structure are generated from answers
1398 to the APW questions.
1401 Once the \fIadd printer command\fR has
1402 been executed, \fBsmbd\fR will reparse the \fI smb.conf\fR to determine if the share defined by the APW
1403 exists. If the sharename is still invalid, then \fBsmbd
1404 \fRwill return an ACCESS_DENIED error to the client.
1407 See also \fI delete printer command\fR, \fIprinting\fR,
1415 Example: \fBaddprinter command = /usr/bin/addprinter
1418 \fBadd share command (G)\fR
1419 Samba 2.2.0 introduced the ability to dynamically
1420 add and delete shares via the Windows NT 4.0 Server Manager. The
1421 \fIadd share command\fR is used to define an
1422 external program or script which will add a new service definition
1423 to \fIsmb.conf\fR. In order to successfully
1424 execute the \fIadd share command\fR, \fBsmbd\fR
1425 requires that the administrator be connected using a root account (i.e.
1428 When executed, \fBsmbd\fR will automatically invoke the
1429 \fIadd share command\fR with four parameters.
1433 \fIconfigFile\fR - the location
1434 of the global \fIsmb.conf\fR file.
1437 \fIshareName\fR - the name of the new
1441 \fIpathName\fR - path to an **existing**
1445 \fIcomment\fR - comment string to associate
1449 This parameter is only used for add file shares. To add printer shares,
1450 see the \fIadd printer
1454 See also \fIchange share
1455 command\fR, \fIdelete share
1462 Example: \fBadd share command = /usr/local/bin/addshare\fR
1465 \fBadd user script (G)\fR
1466 This is the full pathname to a script that will
1467 be run \fBAS ROOT\fR by smbd(8)
1468 under special circumstances described below.
1470 Normally, a Samba server requires that UNIX users are
1471 created for all users accessing files on this server. For sites
1472 that use Windows NT account databases as their primary user database
1473 creating these users and keeping the user list in sync with the
1474 Windows NT PDC is an onerous task. This option allows smbdto create the required UNIX users
1475 \fBON DEMAND\fR when a user accesses the Samba server.
1477 In order to use this option, smbd
1478 must be set to \fIsecurity=server\fR or \fI security=domain\fR and \fIadd user script\fR
1479 must be set to a full pathname for a script that will create a UNIX
1480 user given one argument of \fI%u\fR, which expands into
1481 the UNIX user name to create.
1483 When the Windows user attempts to access the Samba server,
1484 at login (session setup in the SMB protocol) time, smbdcontacts the \fIpassword server\fR and
1485 attempts to authenticate the given user with the given password. If the
1486 authentication succeeds then \fBsmbd\fR
1487 attempts to find a UNIX user in the UNIX password database to map the
1488 Windows user into. If this lookup fails, and \fIadd user script
1489 \fRis set then \fBsmbd\fR will
1490 call the specified script \fBAS ROOT\fR, expanding
1491 any \fI%u\fR argument to be the user name to create.
1493 If this script successfully creates the user then \fBsmbd
1494 \fRwill continue on as though the UNIX user
1495 already existed. In this way, UNIX users are dynamically created to
1496 match existing Windows NT accounts.
1498 See also \fI security\fR, \fIpassword server\fR,
1502 Default: \fBadd user script = <empty string>
1504 Example: \fBadd user script = /usr/local/samba/bin/add_user
1507 \fBadmin users (S)\fR
1508 This is a list of users who will be granted
1509 administrative privileges on the share. This means that they
1510 will do all file operations as the super-user (root).
1512 You should use this option very carefully, as any user in
1513 this list will be able to do anything they like on the share,
1514 irrespective of file permissions.
1516 Default: \fBno admin users\fR
1518 Example: \fBadmin users = jason\fR
1520 \fBallow hosts (S)\fR
1521 Synonym for \fIhosts allow\fR.
1523 \fBallow trusted domains (G)\fR
1524 This option only takes effect when the \fIsecurity\fR option is set to
1526 If it is set to no, then attempts to connect to a resource from
1527 a domain or workgroup other than the one which smbd is running
1528 in will fail, even if that domain is trusted by the remote server
1529 doing the authentication.
1531 This is useful if you only want your Samba server to
1532 serve resources to users in the domain it is a member of. As
1533 an example, suppose that there are two domains DOMA and DOMB. DOMB
1534 is trusted by DOMA, which contains the Samba server. Under normal
1535 circumstances, a user with an account in DOMB can then access the
1536 resources of a UNIX account with the same account name on the
1537 Samba server even if they do not have an account in DOMA. This
1538 can make implementing a security boundary difficult.
1540 Default: \fBallow trusted domains = yes\fR
1542 \fBannounce as (G)\fR
1543 This specifies what type of server
1545 will announce itself as, to a network neighborhood browse
1546 list. By default this is set to Windows NT. The valid options
1547 are : "NT Server" (which can also be written as "NT"),
1548 "NT Workstation", "Win95" or "WfW" meaning Windows NT Server,
1549 Windows NT Workstation, Windows 95 and Windows for Workgroups
1550 respectively. Do not change this parameter unless you have a
1551 specific need to stop Samba appearing as an NT server as this
1552 may prevent Samba servers from participating as browser servers
1555 Default: \fBannounce as = NT Server\fR
1557 Example: \fBannounce as = Win95\fR
1559 \fBannouce version (G)\fR
1560 This specifies the major and minor version numbers
1561 that nmbd will use when announcing itself as a server. The default
1562 is 4.2. Do not change this parameter unless you have a specific
1563 need to set a Samba server to be a downlevel server.
1565 Default: \fBannounce version = 4.2\fR
1567 Example: \fBannounce version = 2.0\fR
1569 \fBauto services (G)\fR
1570 This is a synonym for the \fIpreload\fR.
1573 This parameter lets you "turn off" a service. If
1574 \fIavailable = no\fR, then \fBALL\fR
1575 attempts to connect to the service will fail. Such failures are
1578 Default: \fBavailable = yes\fR
1580 \fBbind interfaces only (G)\fR
1581 This global parameter allows the Samba admin
1582 to limit what interfaces on a machine will serve smb requests. If
1583 affects file service smbd(8)and
1584 name service nmbd(8)in slightly
1587 For name service it causes \fBnmbd\fR to bind
1588 to ports 137 and 138 on the interfaces listed in the interfaces parameter. \fBnmbd
1589 \fRalso binds to the "all addresses" interface (0.0.0.0)
1590 on ports 137 and 138 for the purposes of reading broadcast messages.
1591 If this option is not set then \fBnmbd\fR will service
1592 name requests on all of these sockets. If \fIbind interfaces
1593 only\fR is set then \fBnmbd\fR will check the
1594 source address of any packets coming in on the broadcast sockets
1595 and discard any that don't match the broadcast addresses of the
1596 interfaces in the \fIinterfaces\fR parameter list.
1597 As unicast packets are received on the other sockets it allows
1598 \fBnmbd\fR to refuse to serve names to machines that
1599 send packets that arrive through any interfaces not listed in the
1600 \fIinterfaces\fR list. IP Source address spoofing
1601 does defeat this simple check, however so it must not be used
1602 seriously as a security feature for \fBnmbd\fR.
1604 For file service it causes smbd(8)
1605 to bind only to the interface list given in the interfaces parameter. This restricts the networks that
1606 \fBsmbd\fR will serve to packets coming in those
1607 interfaces. Note that you should not use this parameter for machines
1608 that are serving PPP or other intermittent or non-broadcast network
1609 interfaces as it will not cope with non-permanent interfaces.
1611 If \fIbind interfaces only\fR is set then
1612 unless the network address \fB127.0.0.1\fR is added
1613 to the \fIinterfaces\fR parameter list \fBsmbpasswd(8)\fR
1614 and \fBswat(8)\fRmay
1615 not work as expected due to the reasons covered below.
1617 To change a users SMB password, the \fBsmbpasswd\fR
1618 by default connects to the \fBlocalhost - 127.0.0.1\fR
1619 address as an SMB client to issue the password change request. If
1620 \fIbind interfaces only\fR is set then unless the
1621 network address \fB127.0.0.1\fR is added to the
1622 \fIinterfaces\fR parameter list then \fB smbpasswd\fR will fail to connect in it's default mode.
1623 \fBsmbpasswd\fR can be forced to use the primary IP interface
1624 of the local host by using its \fI-r remote machine\fR
1625 parameter, with \fIremote machine\fR set
1626 to the IP name of the primary interface of the local host.
1628 The \fBswat\fR status page tries to connect with
1629 \fBsmbd\fR and \fBnmbd\fR at the address
1630 \fB127.0.0.1\fR to determine if they are running.
1631 Not adding \fB127.0.0.1\fR will cause \fB smbd\fR and \fBnmbd\fR to always show
1632 "not running" even if they really are. This can prevent \fB swat\fR from starting/stopping/restarting \fBsmbd\fR
1635 Default: \fBbind interfaces only = no\fR
1637 \fBblocking locks (S)\fR
1638 This parameter controls the behavior of smbd(8)when given a request by a client
1639 to obtain a byte range lock on a region of an open file, and the
1640 request has a time limit associated with it.
1642 If this parameter is set and the lock range requested
1643 cannot be immediately satisfied, Samba 2.2 will internally
1644 queue the lock request, and periodically attempt to obtain
1645 the lock until the timeout period expires.
1647 If this parameter is set to False, then
1648 Samba 2.2 will behave as previous versions of Samba would and
1649 will fail the lock request immediately if the lock range
1652 Default: \fBblocking locks = yes\fR
1655 See the \fI browseable\fR.
1657 \fBbrowse list (G)\fR
1658 This controls whether \fBsmbd(8)\fRwill serve a browse list to
1659 a client doing a \fBNetServerEnum\fR call. Normally
1660 set to true. You should never need to change
1663 Default: \fBbrowse list = yes\fR
1665 \fBbrowseable (S)\fR
1666 This controls whether this share is seen in
1667 the list of available shares in a net view and in the browse list.
1669 Default: \fBbrowseable = yes\fR
1671 \fBcase sensitive (S)\fR
1672 See the discussion in the section NAME MANGLING.
1674 Default: \fBcase sensitive = no\fR
1676 \fBcasesignames (S)\fR
1680 \fBchange notify timeout (G)\fR
1681 This SMB allows a client to tell a server to
1682 "watch" a particular directory for any changes and only reply to
1683 the SMB request when a change has occurred. Such constant scanning of
1684 a directory is expensive under UNIX, hence an \fBsmbd(8)\fRdaemon only performs such a scan
1685 on each requested directory once every \fIchange notify
1688 Default: \fBchange notify timeout = 60\fR
1690 Example: \fBchange notify timeout = 300\fR
1692 Would change the scan time to every 5 minutes.
1694 \fBchange share command (G)\fR
1695 Samba 2.2.0 introduced the ability to dynamically
1696 add and delete shares via the Windows NT 4.0 Server Manager. The
1697 \fIchange share command\fR is used to define an
1698 external program or script which will modify an existing service definition
1699 in \fIsmb.conf\fR. In order to successfully
1700 execute the \fIchange share command\fR, \fBsmbd\fR
1701 requires that the administrator be connected using a root account (i.e.
1704 When executed, \fBsmbd\fR will automatically invoke the
1705 \fIchange share command\fR with four parameters.
1709 \fIconfigFile\fR - the location
1710 of the global \fIsmb.conf\fR file.
1713 \fIshareName\fR - the name of the new
1717 \fIpathName\fR - path to an **existing**
1721 \fIcomment\fR - comment string to associate
1725 This parameter is only used modify existing file shares definitions. To modify
1726 printer shares, use the "Printers..." folder as seen when browsing the Samba host.
1729 See also \fIadd share
1730 command\fR, \fIdelete
1737 Example: \fBchange share command = /usr/local/bin/addshare\fR
1740 \fBcharacter set (G)\fR
1741 This allows a smbd to map incoming filenames
1742 from a DOS Code page (see the client
1743 code page parameter) to several built in UNIX character sets.
1744 The built in code page translations are:
1748 ISO8859-1 : Western European
1749 UNIX character set. The parameter \fIclient code page\fR
1750 \fBMUST\fR be set to code page 850 if the
1751 \fIcharacter set\fR parameter is set to
1752 ISO8859-1 in order for the conversion to the
1753 UNIX character set to be done correctly.
1756 ISO8859-2 : Eastern European
1757 UNIX character set. The parameter \fIclient code page
1758 \fR\fBMUST\fR be set to code page 852 if
1759 the \fI character set\fR parameter is set
1760 to ISO8859-2 in order for the conversion
1761 to the UNIX character set to be done correctly.
1764 ISO8859-5 : Russian Cyrillic
1765 UNIX character set. The parameter \fIclient code page
1766 \fR\fBMUST\fR be set to code page
1767 866 if the \fIcharacter set \fR parameter is
1768 set to ISO8859-5 in order for the conversion
1769 to the UNIX character set to be done correctly.
1772 ISO8859-7 : Greek UNIX
1773 character set. The parameter \fIclient code page
1774 \fR\fBMUST\fR be set to code page
1775 737 if the \fIcharacter set\fR parameter is
1776 set to ISO8859-7 in order for the conversion
1777 to the UNIX character set to be done correctly.
1780 KOI8-R : Alternate mapping
1781 for Russian Cyrillic UNIX character set. The parameter
1782 \fIclient code page\fR \fBMUST\fR
1783 be set to code page 866 if the \fIcharacter set\fR
1784 parameter is set to KOI8-R in order for the
1785 conversion to the UNIX character set to be done correctly.
1788 \fBBUG\fR. These MSDOS code page to UNIX character
1789 set mappings should be dynamic, like the loading of MS DOS code pages,
1793 Normally this parameter is not set, meaning no filename
1794 translation is done.
1797 Default: \fBcharacter set = <empty string>\fR
1800 Example: \fBcharacter set = ISO8859-1\fR
1803 \fBclient code page (G)\fR
1804 This parameter specifies the DOS code page
1805 that the clients accessing Samba are using. To determine what code
1806 page a Windows or DOS client is using, open a DOS command prompt
1807 and type the command \fBchcp\fR. This will output
1808 the code page. The default for USA MS-DOS, Windows 95, and
1809 Windows NT releases is code page 437. The default for western
1810 European releases of the above operating systems is code page 850.
1812 This parameter tells smbd(8)
1813 which of the \fIcodepage.XXX
1814 \fRfiles to dynamically load on startup. These files,
1815 described more fully in the manual page \fBmake_smbcodepage(1)\fR, tell \fB smbd\fR how to map lower to upper case characters to provide
1816 the case insensitivity of filenames that Windows clients expect.
1818 Samba currently ships with the following code page files :
1822 Code Page 437 - MS-DOS Latin US
1825 Code Page 737 - Windows '95 Greek
1828 Code Page 850 - MS-DOS Latin 1
1831 Code Page 852 - MS-DOS Latin 2
1834 Code Page 861 - MS-DOS Icelandic
1837 Code Page 866 - MS-DOS Cyrillic
1840 Code Page 932 - MS-DOS Japanese SJIS
1843 Code Page 936 - MS-DOS Simplified Chinese
1846 Code Page 949 - MS-DOS Korean Hangul
1849 Code Page 950 - MS-DOS Traditional Chinese
1852 Thus this parameter may have any of the values 437, 737, 850, 852,
1853 861, 932, 936, 949, or 950. If you don't find the codepage you need,
1854 read the comments in one of the other codepage files and the
1855 \fBmake_smbcodepage(1)\fR man page and write one. Please
1856 remember to donate it back to the Samba user community.
1859 This parameter co-operates with the \fIvalid
1860 chars\fR parameter in determining what characters are
1861 valid in filenames and how capitalization is done. If you set both
1862 this parameter and the \fIvalid chars\fR parameter
1863 the \fIclient code page\fR parameter
1864 \fBMUST\fR be set before the \fIvalid
1865 chars\fR parameter in the \fIsmb.conf\fR
1866 file. The \fIvalid chars\fR string will then
1867 augment the character settings in the \fIclient code page\fR
1871 If not set, \fIclient code page\fR defaults
1876 chars\fR, \fIcode page directory\fR
1879 Default: \fBclient code page = 850\fR
1882 Example: \fBclient code page = 936\fR
1885 \fBcode page directory (G)\fR
1886 Define the location of the various client code page
1892 Default: \fBcode page directory = ${prefix}/lib/codepages
1894 Example: \fBcode page directory = /usr/share/samba/codepages
1896 \fBcodingsystem (G)\fR
1897 This parameter is used to determine how incoming
1898 Shift-JIS Japanese characters are mapped from the incoming \fIclient code page\fR
1899 used by the client, into file names in the UNIX filesystem.
1900 Only useful if \fIclient code page\fR is set to
1901 932 (Japanese Shift-JIS). The options are :
1905 SJIS - Shift-JIS. Does no
1906 conversion of the incoming filename.
1909 JIS8, J8BB, J8BH, J8@B,
1910 J8@J, J8@H - Convert from incoming Shift-JIS to eight
1911 bit JIS code with different shift-in, shift out codes.
1914 JIS7, J7BB, J7BH, J7@B, J7@J,
1915 J7@H - Convert from incoming Shift-JIS to seven bit
1916 JIS code with different shift-in, shift out codes.
1919 JUNET, JUBB, JUBH, JU@B, JU@J, JU@H
1920 - Convert from incoming Shift-JIS to JUNET code with different shift-in,
1924 EUC - Convert an incoming
1925 Shift-JIS character to EUC code.
1928 HEX - Convert an incoming
1929 Shift-JIS character to a 3 byte hex representation, i.e.
1933 CAP - Convert an incoming
1934 Shift-JIS character to the 3 byte hex representation used by
1935 the Columbia AppleTalk Program (CAP), i.e. :AB.
1936 This is used for compatibility between Samba and CAP.
1939 Default: \fBcoding system = <empty value>\fR
1943 This is a text field that is seen next to a share
1944 when a client does a queries the server, either via the network
1945 neighborhood or via \fBnet view\fR to list what shares
1948 If you want to set the string that is displayed next to the
1949 machine name then see the \fI server string\fR parameter.
1951 Default: \fBNo comment string\fR
1953 Example: \fBcomment = Fred's Files\fR
1955 \fBconfig file (G)\fR
1956 This allows you to override the config file
1957 to use, instead of the default (usually \fIsmb.conf\fR).
1958 There is a chicken and egg problem here as this option is set
1961 For this reason, if the name of the config file has changed
1962 when the parameters are loaded then it will reload them from
1963 the new config file.
1965 This option takes the usual substitutions, which can
1968 If the config file doesn't exist then it won't be loaded
1969 (allowing you to special case the config files of just a few
1972 Example: \fBconfig file = /usr/local/samba/lib/smb.conf.%m
1975 This parameter allows you to "clone" service
1976 entries. The specified service is simply duplicated under the
1977 current service's name. Any parameters specified in the current
1978 section will override those in the section being copied.
1980 This feature lets you set up a 'template' service and
1981 create similar services easily. Note that the service being
1982 copied must occur earlier in the configuration file than the
1983 service doing the copying.
1985 Default: \fBno value\fR
1987 Example: \fBcopy = otherservice\fR
1989 \fBcreate mask (S)\fR
1990 A synonym for this parameter is
1994 When a file is created, the necessary permissions are
1995 calculated according to the mapping from DOS modes to UNIX
1996 permissions, and the resulting UNIX mode is then bit-wise 'AND'ed
1997 with this parameter. This parameter may be thought of as a bit-wise
1998 MASK for the UNIX modes of a file. Any bit \fBnot\fR
1999 set here will be removed from the modes set on a file when it is
2002 The default value of this parameter removes the
2003 \&'group' and 'other' write and execute bits from the UNIX modes.
2005 Following this Samba will bit-wise 'OR' the UNIX mode created
2006 from this parameter with the value of the \fIforce create mode\fR
2007 parameter which is set to 000 by default.
2009 This parameter does not affect directory modes. See the
2010 parameter \fIdirectory mode
2013 See also the \fIforce
2014 create mode\fR parameter for forcing particular mode
2015 bits to be set on created files. See also the \fIdirectory mode"\fR parameter for masking
2016 mode bits on created directories. See also the \fIinherit permissions\fR parameter.
2018 Note that by default this parameter does not apply to permissions
2019 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
2020 this mask on access control lists also, they need to set the \fIrestrict acl with
2023 Default: \fBcreate mask = 0744\fR
2025 Example: \fBcreate mask = 0775\fR
2027 \fBcreate mode (S)\fR
2028 This is a synonym for \fI create mask\fR.
2031 The value of the parameter (a decimal integer)
2032 represents the number of minutes of inactivity before a connection
2033 is considered dead, and it is disconnected. The deadtime only takes
2034 effect if the number of open files is zero.
2036 This is useful to stop a server's resources being
2037 exhausted by a large number of inactive connections.
2039 Most clients have an auto-reconnect feature when a
2040 connection is broken so in most cases this parameter should be
2041 transparent to users.
2043 Using this parameter with a timeout of a few minutes
2044 is recommended for most systems.
2046 A deadtime of zero indicates that no auto-disconnection
2047 should be performed.
2049 Default: \fBdeadtime = 0\fR
2051 Example: \fBdeadtime = 15\fR
2053 \fBdebug hires timestamp (G)\fR
2054 Sometimes the timestamps in the log messages
2055 are needed with a resolution of higher that seconds, this
2056 boolean parameter adds microsecond resolution to the timestamp
2057 message header when turned on.
2059 Note that the parameter \fI debug timestamp\fR must be on for this to have an
2062 Default: \fBdebug hires timestamp = no\fR
2065 When using only one log file for more then one
2066 forked smbd-process there may be hard to follow which process
2067 outputs which message. This boolean parameter is adds the process-id
2068 to the timestamp message headers in the logfile when turned on.
2070 Note that the parameter \fI debug timestamp\fR must be on for this to have an
2073 Default: \fBdebug pid = no\fR
2075 \fBdebug timestamp (G)\fR
2076 Samba 2.2 debug log messages are timestamped
2077 by default. If you are running at a high \fIdebug level\fR these timestamps
2078 can be distracting. This boolean parameter allows timestamping
2081 Default: \fBdebug timestamp = yes\fR
2084 Samba is sometimes run as root and sometime
2085 run as the connected user, this boolean parameter inserts the
2086 current euid, egid, uid and gid to the timestamp message headers
2087 in the log file if turned on.
2089 Note that the parameter \fI debug timestamp\fR must be on for this to have an
2092 Default: \fBdebug uid = no\fR
2094 \fBdebuglevel (G)\fR
2095 The value of the parameter (an integer) allows
2096 the debug level (logging level) to be specified in the
2097 \fIsmb.conf\fR file. This is to give greater
2098 flexibility in the configuration of the system.
2100 The default will be the debug level specified on
2101 the command line or level zero if none was specified.
2103 Example: \fBdebug level = 3\fR
2106 A synonym for \fI default service\fR.
2108 \fBdefault case (S)\fR
2109 See the section on NAME MANGLING. Also note the \fIshort preserve case"\fR parameter.
2111 Default: \fBdefault case = lower\fR
2113 \fBdefault service (G)\fR
2114 This parameter specifies the name of a service
2115 which will be connected to if the service actually requested cannot
2116 be found. Note that the square brackets are \fBNOT\fR
2117 given in the parameter value (see example below).
2119 There is no default value for this parameter. If this
2120 parameter is not given, attempting to connect to a nonexistent
2121 service results in an error.
2123 Typically the default service would be a \fIguest ok\fR, \fIread-only\fR service.
2125 Also note that the apparent service name will be changed
2126 to equal that of the requested service, this is very useful as it
2127 allows you to use macros like \fI%S\fR to make
2130 Note also that any "_" characters in the name of the service
2131 used in the default service will get mapped to a "/". This allows for
2139 default service = pub
2147 \fBdelete printer command (G)\fR
2148 With the introduction of MS-RPC based printer
2149 support for Windows NT/2000 clients in Samba 2.2, it is now
2150 possible to delete printer at run time by issuing the
2151 DeletePrinter() RPC call.
2153 For a Samba host this means that the printer must be
2154 physically deleted from underlying printing system. The \fI deleteprinter command\fR defines a script to be run which
2155 will perform the necessary operations for removing the printer
2156 from the print system and from \fIsmb.conf\fR.
2158 The \fIdelete printer command\fR is
2159 automatically called with only one parameter: \fI "printer name"\fR.
2161 Once the \fIdelete printer command\fR has
2162 been executed, \fBsmbd\fR will reparse the \fI smb.conf\fR to associated printer no longer exists.
2163 If the sharename is still valid, then \fBsmbd
2164 \fRwill return an ACCESS_DENIED error to the client.
2166 See also \fI add printer command\fR, \fIprinting\fR,
2172 Example: \fBdeleteprinter command = /usr/bin/removeprinter
2174 \fBdelete readonly (S)\fR
2175 This parameter allows readonly files to be deleted.
2176 This is not normal DOS semantics, but is allowed by UNIX.
2178 This option may be useful for running applications such
2179 as rcs, where UNIX file ownership prevents changing file
2180 permissions, and DOS semantics prevent deletion of a read only file.
2182 Default: \fBdelete readonly = no\fR
2184 \fBdelete share command (G)\fR
2185 Samba 2.2.0 introduced the ability to dynamically
2186 add and delete shares via the Windows NT 4.0 Server Manager. The
2187 \fIdelete share command\fR is used to define an
2188 external program or script which will remove an existing service
2189 definition from \fIsmb.conf\fR. In order to successfully
2190 execute the \fIdelete share command\fR, \fBsmbd\fR
2191 requires that the administrator be connected using a root account (i.e.
2194 When executed, \fBsmbd\fR will automatically invoke the
2195 \fIdelete share command\fR with two parameters.
2199 \fIconfigFile\fR - the location
2200 of the global \fIsmb.conf\fR file.
2203 \fIshareName\fR - the name of
2204 the existing service.
2207 This parameter is only used to remove file shares. To delete printer shares,
2208 see the \fIdelete printer
2212 See also \fIdelete share
2213 command\fR, \fIchange
2220 Example: \fBdelete share command = /usr/local/bin/delshare\fR
2223 \fBdelete user script (G)\fR
2224 This is the full pathname to a script that will
2225 be run \fBAS ROOT\fR by \fBsmbd(8)\fRunder special circumstances
2228 Normally, a Samba server requires that UNIX users are
2229 created for all users accessing files on this server. For sites
2230 that use Windows NT account databases as their primary user database
2231 creating these users and keeping the user list in sync with the
2232 Windows NT PDC is an onerous task. This option allows \fB smbd\fR to delete the required UNIX users \fBON
2233 DEMAND\fR when a user accesses the Samba server and the
2234 Windows NT user no longer exists.
2236 In order to use this option, \fBsmbd\fR must be
2237 set to \fIsecurity=domain\fR and \fIdelete
2238 user script\fR must be set to a full pathname for a script
2239 that will delete a UNIX user given one argument of \fI%u
2240 \fR, which expands into the UNIX user name to delete.
2241 \fBNOTE\fR that this is different to the \fIadd user script\fR
2242 which will work with the \fIsecurity=server\fR option
2243 as well as \fIsecurity=domain\fR. The reason for this
2244 is only when Samba is a domain member does it get the information
2245 on an attempted user logon that a user no longer exists. In the
2246 \fIsecurity=server\fR mode a missing user
2247 is treated the same as an invalid password logon attempt. Deleting
2248 the user in this circumstance would not be a good idea.
2250 When the Windows user attempts to access the Samba server,
2251 at \fBlogin\fR (session setup in the SMB protocol)
2252 time, \fBsmbd\fR contacts the \fIpassword server\fR and attempts to authenticate
2253 the given user with the given password. If the authentication fails
2254 with the specific Domain error code meaning that the user no longer
2255 exists then \fBsmbd\fR attempts to find a UNIX user in
2256 the UNIX password database that matches the Windows user account. If
2257 this lookup succeeds, and \fIdelete user script\fR is
2258 set then \fBsmbd\fR will all the specified script
2259 \fBAS ROOT\fR, expanding any \fI%u\fR
2260 argument to be the user name to delete.
2262 This script should delete the given UNIX username. In this way,
2263 UNIX users are dynamically deleted to match existing Windows NT
2266 See also security=domain,
2267 \fIpassword server\fR
2268 , \fIadd user script\fR
2271 Default: \fBdelete user script = <empty string>
2273 Example: \fBdelete user script = /usr/local/samba/bin/del_user
2276 \fBdelete veto files (S)\fR
2277 This option is used when Samba is attempting to
2278 delete a directory that contains one or more vetoed directories
2279 (see the \fIveto files\fR
2280 option). If this option is set to False (the default) then if a vetoed
2281 directory contains any non-vetoed files or directories then the
2282 directory delete will fail. This is usually what you want.
2284 If this option is set to True, then Samba
2285 will attempt to recursively delete any files and directories within
2286 the vetoed directory. This can be useful for integration with file
2287 serving systems such as NetAtalk which create meta-files within
2288 directories you might normally veto DOS/Windows users from seeing
2289 (e.g. \fI.AppleDouble\fR)
2291 Setting \fBdelete veto files = yes\fR allows these
2292 directories to be transparently deleted when the parent directory
2293 is deleted (so long as the user has permissions to do so).
2295 See also the \fIveto
2298 Default: \fBdelete veto files = no\fR
2300 \fBdeny hosts (S)\fR
2301 Synonym for \fIhosts
2304 \fBdfree command (G)\fR
2305 The \fIdfree command\fR setting should
2306 only be used on systems where a problem occurs with the internal
2307 disk space calculations. This has been known to happen with Ultrix,
2308 but may occur with other operating systems. The symptom that was
2309 seen was an error of "Abort Retry Ignore" at the end of each
2312 This setting allows the replacement of the internal routines to
2313 calculate the total disk space and amount available with an external
2314 routine. The example below gives a possible script that might fulfill
2317 The external program will be passed a single parameter indicating
2318 a directory in the filesystem being queried. This will typically consist
2319 of the string \fI./\fR. The script should return two
2320 integers in ASCII. The first should be the total disk space in blocks,
2321 and the second should be the number of available blocks. An optional
2322 third return value can give the block size in bytes. The default
2323 blocksize is 1024 bytes.
2325 Note: Your script should \fBNOT\fR be setuid or
2326 setgid and should be owned by (and writeable only by) root!
2328 Default: \fBBy default internal routines for
2329 determining the disk capacity and remaining space will be used.
2331 Example: \fBdfree command = /usr/local/samba/bin/dfree
2333 Where the script dfree (which must be made executable) could be:
2339 df $1 | tail -1 | awk '{print $2" "$4}'
2344 or perhaps (on Sys V based systems):
2350 /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
2355 Note that you may have to replace the command names
2356 with full path names on some systems.
2362 \fBdirectory mask (S)\fR
2363 This parameter is the octal modes which are
2364 used when converting DOS modes to UNIX modes when creating UNIX
2367 When a directory is created, the necessary permissions are
2368 calculated according to the mapping from DOS modes to UNIX permissions,
2369 and the resulting UNIX mode is then bit-wise 'AND'ed with this
2370 parameter. This parameter may be thought of as a bit-wise MASK for
2371 the UNIX modes of a directory. Any bit \fBnot\fR set
2372 here will be removed from the modes set on a directory when it is
2375 The default value of this parameter removes the 'group'
2376 and 'other' write bits from the UNIX mode, allowing only the
2377 user who owns the directory to modify it.
2379 Following this Samba will bit-wise 'OR' the UNIX mode
2380 created from this parameter with the value of the \fIforce directory mode
2381 \fRparameter. This parameter is set to 000 by
2382 default (i.e. no extra mode bits are added).
2384 Note that by default this parameter does not apply to permissions
2385 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
2386 this mask on access control lists also, they need to set the \fIrestrict acl with
2390 directory mode\fR parameter to cause particular mode
2391 bits to always be set on created directories.
2393 See also the \fIcreate mode
2394 \fRparameter for masking mode bits on created files,
2395 and the \fIdirectory
2396 security mask\fR parameter.
2398 Also refer to the \fI inherit permissions\fR parameter.
2400 Default: \fBdirectory mask = 0755\fR
2402 Example: \fBdirectory mask = 0775\fR
2404 \fBdirectory mode (S)\fR
2405 Synonym for \fI directory mask\fR
2407 \fBdirectory security mask (S)\fR
2408 This parameter controls what UNIX permission bits
2409 can be modified when a Windows NT client is manipulating the UNIX
2410 permission on a directory using the native NT security dialog
2413 This parameter is applied as a mask (AND'ed with) to
2414 the changed permission bits, thus preventing any bits not in
2415 this mask from being modified. Essentially, zero bits in this
2416 mask may be treated as a set of bits the user is not allowed
2419 If not set explicitly this parameter is set to the same
2420 value as the \fIdirectory
2421 mask\fR parameter. To allow a user to
2422 modify all the user/group/world permissions on a directory, set
2423 this parameter to 0777.
2425 \fBNote\fR that users who can access the
2426 Samba server through other means can easily bypass this restriction,
2427 so it is primarily useful for standalone "appliance" systems.
2428 Administrators of most normal systems will probably want to set
2431 See also the \fI force directory security mode\fR, \fIsecurity mask\fR,
2432 \fIforce security mode
2435 Default: \fBdirectory security mask = <same as
2438 Example: \fBdirectory security mask = 0777\fR
2441 Specifies that nmbd(8)
2442 when acting as a WINS server and finding that a NetBIOS name has not
2443 been registered, should treat the NetBIOS name word-for-word as a DNS
2444 name and do a lookup with the DNS server for that name on behalf of
2445 the name-querying client.
2447 Note that the maximum length for a NetBIOS name is 15
2448 characters, so the DNS name (or DNS alias) can likewise only be
2449 15 characters, maximum.
2451 \fBnmbd\fR spawns a second copy of itself to do the
2452 DNS name lookup requests, as doing a name lookup is a blocking
2455 See also the parameter \fI wins support\fR.
2457 Default: \fBdns proxy = yes\fR
2459 \fBdomain admin group (G)\fR
2460 This is an \fBEXPERIMENTAL\fR parameter
2461 that is part of the unfinished Samba NT Domain Controller Code. It may
2462 be removed in a later release. To work with the latest code builds
2463 that may have more support for Samba NT Domain Controller functionality
2464 please subscribe to the mailing list samba-ntdom <URL:mailto:samba-ntdom@samba.org> available by
2465 visiting the web page at http://lists.samba.org/ <URL:http://lists.samba.org/>.
2467 \fBdomain admin users (G)\fR
2468 This is an \fBEXPERIMENTAL\fR parameter
2469 that is part of the unfinished Samba NT Domain Controller Code. It may
2470 be removed in a later release. To work with the latest code builds
2471 that may have more support for Samba NT Domain Controller functionality
2472 please subscribe to the mailing list samba-ntdom <URL:mailto:samba-ntdom@samba.org> available by
2473 visiting the web page at http://lists.samba.org/ <URL:http://lists.samba.org/>.
2475 \fBdomain groups (G)\fR
2476 This is an \fBEXPERIMENTAL\fR parameter
2477 that is part of the unfinished Samba NT Domain Controller Code. It may
2478 be removed in a later release. To work with the latest code builds
2479 that may have more support for Samba NT Domain Controller functionality
2480 please subscribe to the mailing list samba-ntdom <URL:mailto:samba-ntdom@samba.org> available by
2481 visiting the web page at http://lists.samba.org/ <URL:http://lists.samba.org/>.
2483 \fBdomain guest group (G)\fR
2484 This is an \fBEXPERIMENTAL\fR parameter
2485 that is part of the unfinished Samba NT Domain Controller Code. It may
2486 be removed in a later release. To work with the latest code builds
2487 that may have more support for Samba NT Domain Controller functionality
2488 please subscribe to the mailing list samba-ntdom <URL:mailto:samba-ntdom@samba.org> available by
2489 visiting the web page at http://lists.samba.org/ <URL:http://lists.samba.org/>.
2491 \fBdomain guest users (G)\fR
2492 This is an \fBEXPERIMENTAL\fR parameter
2493 that is part of the unfinished Samba NT Domain Controller Code. It may
2494 be removed in a later release. To work with the latest code builds
2495 that may have more support for Samba NT Domain Controller functionality
2496 please subscribe to the mailing list samba-ntdom <URL:mailto:samba-ntdom@samba.org> available by
2497 visiting the web page at http://lists.samba.org/ <URL:http://lists.samba.org/>.
2499 \fBdomain logons (G)\fR
2500 If set to true, the Samba server will serve
2501 Windows 95/98 Domain logons for the \fIworkgroup\fR it is in. Samba 2.2 also
2502 has limited capability to act as a domain controller for Windows
2503 NT 4 Domains. For more details on setting up this feature see
2504 the file DOMAINS.txt in the Samba documentation directory \fIdocs/
2505 \fRshipped with the source code.
2507 Default: \fBdomain logons = no\fR
2509 \fBdomain master (G)\fR
2510 Tell \fB nmbd(8)\fRto enable WAN-wide browse list
2511 collation. Setting this option causes \fBnmbd\fR to
2512 claim a special domain specific NetBIOS name that identifies
2513 it as a domain master browser for its given \fIworkgroup\fR. Local master browsers
2514 in the same \fIworkgroup\fR on broadcast-isolated
2515 subnets will give this \fBnmbd\fR their local browse lists,
2516 and then ask \fBsmbd(8)\fR
2517 for a complete copy of the browse list for the whole wide area
2518 network. Browser clients will then contact their local master browser,
2519 and will receive the domain-wide browse list, instead of just the list
2520 for their broadcast-isolated subnet.
2522 Note that Windows NT Primary Domain Controllers expect to be
2523 able to claim this \fIworkgroup\fR specific special
2524 NetBIOS name that identifies them as domain master browsers for
2525 that \fIworkgroup\fR by default (i.e. there is no
2526 way to prevent a Windows NT PDC from attempting to do this). This
2527 means that if this parameter is set and \fBnmbd\fR claims
2528 the special name for a \fIworkgroup\fR before a Windows
2529 NT PDC is able to do so then cross subnet browsing will behave
2530 strangely and may fail.
2532 If \fBdomain logons = yes\fR
2533 , then the default behavior is to enable the \fIdomain
2534 master\fR parameter. If \fIdomain logons\fR is
2535 not enabled (the default setting), then neither will \fIdomain
2536 master\fR be enabled by default.
2538 Default: \fBdomain master = auto\fR
2540 \fBdont descend (S)\fR
2541 There are certain directories on some systems
2542 (e.g., the \fI/proc\fR tree under Linux) that are either not
2543 of interest to clients or are infinitely deep (recursive). This
2544 parameter allows you to specify a comma-delimited list of directories
2545 that the server should always show as empty.
2547 Note that Samba can be very fussy about the exact format
2548 of the "dont descend" entries. For example you may need \fI ./proc\fR instead of just \fI/proc\fR.
2549 Experimentation is the best policy :-)
2551 Default: \fBnone (i.e., all directories are OK
2554 Example: \fBdont descend = /proc,/dev\fR
2556 \fBdos filemode (S)\fR
2557 The default behavior in Samba is to provide
2558 UNIX-like behavor where only the owner of a file/directory is
2559 able to change the permissions on it. However, this behavior
2560 is often confusing to DOS/Windows users. Enabling this parameter
2561 allows a user who has write access to the file (by whatever
2562 means) to modify the permissions on it. Note that a user
2563 belonging to the group owning the file will not be allowed to
2564 change permissions if the group is only granted read access.
2565 Ownership of the file/directory is not changed, only the permissions
2568 Default: \fBdos filemode = no\fR
2570 \fBdos filetime resolution (S)\fR
2571 Under the DOS and Windows FAT filesystem, the finest
2572 granularity on time resolution is two seconds. Setting this parameter
2573 for a share causes Samba to round the reported time down to the
2574 nearest two second boundary when a query call that requires one second
2575 resolution is made to \fBsmbd(8)\fR
2578 This option is mainly used as a compatibility option for Visual
2579 C++ when used against Samba shares. If oplocks are enabled on a
2580 share, Visual C++ uses two different time reading calls to check if a
2581 file has changed since it was last read. One of these calls uses a
2582 one-second granularity, the other uses a two second granularity. As
2583 the two second call rounds any odd second down, then if the file has a
2584 timestamp of an odd number of seconds then the two timestamps will not
2585 match and Visual C++ will keep reporting the file has changed. Setting
2586 this option causes the two timestamps to match, and Visual C++ is
2589 Default: \fBdos filetime resolution = no\fR
2591 \fBdos filetimes (S)\fR
2592 Under DOS and Windows, if a user can write to a
2593 file they can change the timestamp on it. Under POSIX semantics,
2594 only the owner of the file or root may change the timestamp. By
2595 default, Samba runs with POSIX semantics and refuses to change the
2596 timestamp on a file if the user \fBsmbd\fR is acting
2597 on behalf of is not the file owner. Setting this option to True allows DOS semantics and smbd will change the file
2598 timestamp as DOS requires.
2600 Default: \fBdos filetimes = no\fR
2602 \fBencrypt passwords (G)\fR
2603 This boolean controls whether encrypted passwords
2604 will be negotiated with the client. Note that Windows NT 4.0 SP3 and
2605 above and also Windows 98 will by default expect encrypted passwords
2606 unless a registry entry is changed. To use encrypted passwords in
2607 Samba see the file ENCRYPTION.txt in the Samba documentation
2608 directory \fIdocs/\fR shipped with the source code.
2610 In order for encrypted passwords to work correctly
2611 \fBsmbd(8)\fRmust either
2612 have access to a local \fIsmbpasswd(5)
2613 \fRprogram for information on how to set up
2614 and maintain this file), or set the security=[serve|domain] parameter which
2615 causes \fBsmbd\fR to authenticate against another
2618 Default: \fBencrypt passwords = no\fR
2620 \fBenhanced browsing (G)\fR
2621 This option enables a couple of enhancements to
2622 cross-subnet browse propogation that have been added in Samba
2623 but which are not standard in Microsoft implementations.
2624 \fBThese enhancements are currently only available in
2625 the HEAD Samba CVS tree (not Samba 2.2.x).\fR
2627 The first enhancement to browse propogation consists of a regular
2628 wildcard query to a Samba WINS server for all Domain Master Browsers,
2629 followed by a browse synchronisation with each of the returned
2630 DMBs. The second enhancement consists of a regular randomised browse
2631 synchronisation with all currently known DMBs.
2633 You may wish to disable this option if you have a problem with empty
2634 workgroups not disappearing from browse lists. Due to the restrictions
2635 of the browse protocols these enhancements can cause a empty workgroup
2636 to stay around forever which can be annoying.
2638 In general you should leave this option enabled as it makes
2639 cross-subnet browse propogation much more reliable.
2641 Default: \fBenhanced browsing = yes\fR
2643 \fBenumports command (G)\fR
2644 The concept of a "port" is fairly foreign
2645 to UNIX hosts. Under Windows NT/2000 print servers, a port
2646 is associated with a port monitor and generally takes the form of
2647 a local port (i.e. LPT1:, COM1:, FILE:) or a remote port
2648 (i.e. LPD Port Monitor, etc...). By default, Samba has only one
2649 port defined--"Samba Printer Port". Under
2650 Windows NT/2000, all printers must have a valid port name.
2651 If you wish to have a list of ports displayed (\fBsmbd
2652 \fRdoes not use a port name for anything) other than
2653 the default "Samba Printer Port", you
2654 can define \fIenumports command\fR to point to
2655 a program which should generate a list of ports, one per line,
2656 to standard output. This listing will then be used in response
2657 to the level 1 and 2 EnumPorts() RPC.
2659 Default: \fBno enumports command\fR
2661 Example: \fBenumports command = /usr/bin/listports
2664 This is a synonym for \fIpreexec\fR.
2666 \fBfake directory create times (S)\fR
2667 NTFS and Windows VFAT file systems keep a create
2668 time for all files and directories. This is not the same as the
2669 ctime - status change time - that Unix keeps, so Samba by default
2670 reports the earliest of the various times Unix does keep. Setting
2671 this parameter for a share causes Samba to always report midnight
2672 1-1-1980 as the create time for directories.
2674 This option is mainly used as a compatibility option for
2675 Visual C++ when used against Samba shares. Visual C++ generated
2676 makefiles have the object directory as a dependency for each object
2677 file, and a make rule to create the directory. Also, when NMAKE
2678 compares timestamps it uses the creation time when examining a
2679 directory. Thus the object directory will be created if it does not
2680 exist, but once it does exist it will always have an earlier
2681 timestamp than the object files it contains.
2683 However, Unix time semantics mean that the create time
2684 reported by Samba will be updated whenever a file is created or
2685 or deleted in the directory. NMAKE finds all object files in
2686 the object directory. The timestamp of the last one built is then
2687 compared to the timestamp of the object dircetory. If the
2688 directory's timestamp if newer, then all object files
2689 will be rebuilt. Enabling this option
2690 ensures directories always predate their contents and an NMAKE build
2691 will proceed as expected.
2693 Default: \fBfake directory create times = no\fR
2695 \fBfake oplocks (S)\fR
2696 Oplocks are the way that SMB clients get permission
2697 from a server to locally cache file operations. If a server grants
2698 an oplock (opportunistic lock) then the client is free to assume
2699 that it is the only one accessing the file and it will aggressively
2700 cache file data. With some oplock types the client may even cache
2701 file open/close operations. This can give enormous performance benefits.
2703 When you set \fBfake oplocks = yes\fR, \fBsmbd(8)\fRwill
2704 always grant oplock requests no matter how many clients are using
2707 It is generally much better to use the real \fIoplocks\fR support rather
2708 than this parameter.
2710 If you enable this option on all read-only shares or
2711 shares that you know will only be accessed from one client at a
2712 time such as physically read-only media like CDROMs, you will see
2713 a big performance improvement on many operations. If you enable
2714 this option on shares where multiple clients may be accessing the
2715 files read-write at the same time you can get data corruption. Use
2716 this option carefully!
2718 Default: \fBfake oplocks = no\fR
2720 \fBfollow symlinks (S)\fR
2721 This parameter allows the Samba administrator
2722 to stop \fBsmbd(8)\fR
2723 from following symbolic links in a particular share. Setting this
2724 parameter to no prevents any file or directory
2725 that is a symbolic link from being followed (the user will get an
2726 error). This option is very useful to stop users from adding a
2727 symbolic link to \fI/etc/passwd\fR in their home
2728 directory for instance. However it will slow filename lookups
2731 This option is enabled (i.e. \fBsmbd\fR will
2732 follow symbolic links) by default.
2734 Default: \fBfollow symlinks = yes\fR
2736 \fBforce create mode (S)\fR
2737 This parameter specifies a set of UNIX mode bit
2738 permissions that will \fBalways\fR be set on a
2739 file created by Samba. This is done by bitwise 'OR'ing these bits onto
2740 the mode bits of a file that is being created or having its
2741 permissions changed. The default for this parameter is (in octal)
2742 000. The modes in this parameter are bitwise 'OR'ed onto the file
2743 mode after the mask set in the \fIcreate mask\fR
2744 parameter is applied.
2746 Note that by default this parameter does not apply to permissions
2747 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
2748 this mask on access control lists also, they need to set the \fIrestrict acl with
2751 See also the parameter \fIcreate
2752 mask\fR for details on masking mode bits on files.
2754 See also the \fIinherit
2755 permissions\fR parameter.
2757 Default: \fBforce create mode = 000\fR
2759 Example: \fBforce create mode = 0755\fR
2761 would force all created files to have read and execute
2762 permissions set for 'group' and 'other' as well as the
2763 read/write/execute bits set for the 'user'.
2765 \fBforce directory mode (S)\fR
2766 This parameter specifies a set of UNIX mode bit
2767 permissions that will \fBalways\fR be set on a directory
2768 created by Samba. This is done by bitwise 'OR'ing these bits onto the
2769 mode bits of a directory that is being created. The default for this
2770 parameter is (in octal) 0000 which will not add any extra permission
2771 bits to a created directory. This operation is done after the mode
2772 mask in the parameter \fIdirectory mask\fR is
2775 Note that by default this parameter does not apply to permissions
2776 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
2777 this mask on access control lists also, they need to set the \fIrestrict acl with
2780 See also the parameter \fI directory mask\fR for details on masking mode bits
2781 on created directories.
2783 See also the \fI inherit permissions\fR parameter.
2785 Default: \fBforce directory mode = 000\fR
2787 Example: \fBforce directory mode = 0755\fR
2789 would force all created directories to have read and execute
2790 permissions set for 'group' and 'other' as well as the
2791 read/write/execute bits set for the 'user'.
2793 \fBforce directory security mode (S)\fR
2794 This parameter controls what UNIX permission bits
2795 can be modified when a Windows NT client is manipulating the UNIX
2796 permission on a directory using the native NT security dialog box.
2798 This parameter is applied as a mask (OR'ed with) to the
2799 changed permission bits, thus forcing any bits in this mask that
2800 the user may have modified to be on. Essentially, one bits in this
2801 mask may be treated as a set of bits that, when modifying security
2802 on a directory, the user has always set to be 'on'.
2804 If not set explicitly this parameter is set to the same
2805 value as the \fIforce
2806 directory mode\fR parameter. To allow
2807 a user to modify all the user/group/world permissions on a
2808 directory without restrictions, set this parameter to 000.
2810 \fBNote\fR that users who can access the
2811 Samba server through other means can easily bypass this restriction,
2812 so it is primarily useful for standalone "appliance" systems.
2813 Administrators of most normal systems will probably want to set
2816 See also the \fI directory security mask\fR, \fIsecurity mask\fR,
2817 \fIforce security mode
2820 Default: \fBforce directory security mode = <same as
2821 force directory mode>\fR
2823 Example: \fBforce directory security mode = 0\fR
2825 \fBforce group (S)\fR
2826 This specifies a UNIX group name that will be
2827 assigned as the default primary group for all users connecting
2828 to this service. This is useful for sharing files by ensuring
2829 that all access to files on service will use the named group for
2830 their permissions checking. Thus, by assigning permissions for this
2831 group to the files and directories within this service the Samba
2832 administrator can restrict or allow sharing of these files.
2834 In Samba 2.0.5 and above this parameter has extended
2835 functionality in the following way. If the group name listed here
2836 has a '+' character prepended to it then the current user accessing
2837 the share only has the primary group default assigned to this group
2838 if they are already assigned as a member of that group. This allows
2839 an administrator to decide that only users who are already in a
2840 particular group will create files with group ownership set to that
2841 group. This gives a finer granularity of ownership assignment. For
2842 example, the setting \fIforce group = +sys\fR means
2843 that only users who are already in group sys will have their default
2844 primary group assigned to sys when accessing this Samba share. All
2845 other users will retain their ordinary primary group.
2847 If the \fIforce user
2848 \fRparameter is also set the group specified in
2849 \fIforce group\fR will override the primary group
2850 set in \fIforce user\fR.
2855 Default: \fBno forced group\fR
2857 Example: \fBforce group = agroup\fR
2859 \fBforce security mode (S)\fR
2860 This parameter controls what UNIX permission
2861 bits can be modified when a Windows NT client is manipulating
2862 the UNIX permission on a file using the native NT security dialog
2865 This parameter is applied as a mask (OR'ed with) to the
2866 changed permission bits, thus forcing any bits in this mask that
2867 the user may have modified to be on. Essentially, one bits in this
2868 mask may be treated as a set of bits that, when modifying security
2869 on a file, the user has always set to be 'on'.
2871 If not set explicitly this parameter is set to the same
2872 value as the \fIforce
2873 create mode\fR parameter. To allow a user to
2874 modify all the user/group/world permissions on a file, with no
2875 restrictions set this parameter to 000.
2877 \fBNote\fR that users who can access
2878 the Samba server through other means can easily bypass this restriction,
2879 so it is primarily useful for standalone "appliance" systems.
2880 Administrators of most normal systems will probably want to set
2883 See also the \fI force directory security mode\fR,
2884 \fIdirectory security
2885 mask\fR, \fI security mask\fR parameters.
2887 Default: \fBforce security mode = <same as force
2890 Example: \fBforce security mode = 0\fR
2892 \fBforce user (S)\fR
2893 This specifies a UNIX user name that will be
2894 assigned as the default user for all users connecting to this service.
2895 This is useful for sharing files. You should also use it carefully
2896 as using it incorrectly can cause security problems.
2898 This user name only gets used once a connection is established.
2899 Thus clients still need to connect as a valid user and supply a
2900 valid password. Once connected, all file operations will be performed
2901 as the "forced user", no matter what username the client connected
2902 as. This can be very useful.
2904 In Samba 2.0.5 and above this parameter also causes the
2905 primary group of the forced user to be used as the primary group
2906 for all file activity. Prior to 2.0.5 the primary group was left
2907 as the primary group of the connecting user (this was a bug).
2909 See also \fIforce group
2911 Default: \fBno forced user\fR
2913 Example: \fBforce user = auser\fR
2916 This parameter allows the administrator to
2917 configure the string that specifies the type of filesystem a share
2918 is using that is reported by \fBsmbd(8)
2919 \fRwhen a client queries the filesystem type
2920 for a share. The default type is NTFS for
2921 compatibility with Windows NT but this can be changed to other
2922 strings such as Samba or FAT
2925 Default: \fBfstype = NTFS\fR
2927 Example: \fBfstype = Samba\fR
2929 \fBgetwd cache (G)\fR
2930 This is a tuning option. When this is enabled a
2931 caching algorithm will be used to reduce the time taken for getwd()
2932 calls. This can have a significant impact on performance, especially
2933 when the \fIwide links\fR
2934 parameter is set to False.
2936 Default: \fBgetwd cache = yes\fR
2939 Synonym for \fIforce
2942 \fBguest account (S)\fR
2943 This is a username which will be used for access
2944 to services which are specified as \fI guest ok\fR (see below). Whatever privileges this
2945 user has will be available to any client connecting to the guest service.
2946 Typically this user will exist in the password file, but will not
2947 have a valid login. The user account "ftp" is often a good choice
2948 for this parameter. If a username is specified in a given service,
2949 the specified username overrides this one.
2951 One some systems the default guest account "nobody" may not
2952 be able to print. Use another account in this case. You should test
2953 this by trying to log in as your guest user (perhaps by using the
2954 \fBsu -\fR command) and trying to print using the
2955 system print command such as \fBlpr(1)\fR or \fB lp(1)\fR.
2957 Default: \fBspecified at compile time, usually
2960 Example: \fBguest account = ftp\fR
2963 If this parameter is yes for
2964 a service, then no password is required to connect to the service.
2965 Privileges will be those of the \fI guest account\fR.
2967 See the section below on \fI security\fR for more information about this option.
2969 Default: \fBguest ok = no\fR
2971 \fBguest only (S)\fR
2972 If this parameter is yes for
2973 a service, then only guest connections to the service are permitted.
2974 This parameter will have no effect if \fIguest ok\fR is not set for the service.
2976 See the section below on \fI security\fR for more information about this option.
2978 Default: \fBguest only = no\fR
2980 \fBhide dot files (S)\fR
2981 This is a boolean parameter that controls whether
2982 files starting with a dot appear as hidden files.
2984 Default: \fBhide dot files = yes\fR
2987 This is a list of files or directories that are not
2988 visible but are accessible. The DOS 'hidden' attribute is applied
2989 to any files or directories that match.
2991 Each entry in the list must be separated by a '/',
2992 which allows spaces to be included in the entry. '*'
2993 and '?' can be used to specify multiple files or directories
2994 as in DOS wildcards.
2996 Each entry must be a Unix path, not a DOS path and must
2997 not include the Unix directory separator '/'.
2999 Note that the case sensitivity option is applicable
3002 Setting this parameter will affect the performance of Samba,
3003 as it will be forced to check all files and directories for a match
3004 as they are scanned.
3007 dot files\fR, \fI veto files\fR and \fIcase sensitive\fR.
3009 Default: \fBno file are hidden\fR
3011 Example: \fBhide files =
3012 /.*/DesktopFolderDB/TrashFor%m/resource.frk/\fR
3014 The above example is based on files that the Macintosh
3015 SMB client (DAVE) available from
3016 Thursby <URL:http://www.thursby.com> creates for internal use, and also still hides
3017 all files beginning with a dot.
3019 \fBhide local users(G)\fR
3020 This parameter toggles the hiding of local UNIX
3021 users (root, wheel, floppy, etc) from remote clients.
3023 Default: \fBhide local users = no\fR
3025 \fBhomedir map (G)\fR
3027 \fRis True, and \fBsmbd(8)\fRis also acting
3028 as a Win95/98 \fIlogon server\fR then this parameter
3029 specifies the NIS (or YP) map from which the server for the user's
3030 home directory should be extracted. At present, only the Sun
3031 auto.home map format is understood. The form of the map is:
3033 \fBusername server:/some/file/system\fR
3035 and the program will extract the servername from before
3036 the first ':'. There should probably be a better parsing system
3037 that copes with different map formats and also Amd (another
3040 \fBNOTE :\fRA working NIS client is required on
3041 the system for this option to work.
3043 See also \fInis homedir\fR
3044 , \fIdomain logons\fR
3047 Default: \fBhomedir map = <empty string>\fR
3049 Example: \fBhomedir map = amd.homedir\fR
3051 \fBhost msdfs (G)\fR
3052 This boolean parameter is only available
3053 if Samba has been configured and compiled with the \fB --with-msdfs\fR option. If set to yes,
3054 Samba will act as a Dfs server, and allow Dfs-aware clients
3055 to browse Dfs trees hosted on the server.
3057 See also the \fI msdfs root\fR share level parameter. For
3058 more information on setting up a Dfs tree on Samba,
3059 refer to msdfs_setup.html.
3061 Default: \fBhost msdfs = no\fR
3063 \fBhosts allow (S)\fR
3064 A synonym for this parameter is \fIallow
3067 This parameter is a comma, space, or tab delimited
3068 set of hosts which are permitted to access a service.
3070 If specified in the [global] section then it will
3071 apply to all services, regardless of whether the individual
3072 service has a different setting.
3074 You can specify the hosts by name or IP number. For
3075 example, you could restrict access to only the hosts on a
3076 Class C subnet with something like \fBallow hosts = 150.203.5.
3077 \fR\&. The full syntax of the list is described in the man
3078 page \fIhosts_access(5)\fR. Note that this man
3079 page may not be present on your system, so a brief description will
3082 Note that the localhost address 127.0.0.1 will always
3083 be allowed access unless specifically denied by a \fIhosts deny\fR option.
3085 You can also specify hosts by network/netmask pairs and
3086 by netgroup names if your system supports netgroups. The
3087 \fBEXCEPT\fR keyword can also be used to limit a
3088 wildcard list. The following examples may provide some help:
3090 Example 1: allow all IPs in 150.203.*.*; except one
3092 \fBhosts allow = 150.203. EXCEPT 150.203.6.66\fR
3094 Example 2: allow hosts that match the given network/netmask
3096 \fBhosts allow = 150.203.15.0/255.255.255.0\fR
3098 Example 3: allow a couple of hosts
3100 \fBhosts allow = lapland, arvidsjaur\fR
3102 Example 4: allow only hosts in NIS netgroup "foonet", but
3103 deny access from one particular host
3105 \fBhosts allow = @foonet\fR
3107 \fBhosts deny = pirate\fR
3109 Note that access still requires suitable user-level passwords.
3111 See \fBtestparm(1)\fR
3112 for a way of testing your host access to see if it does
3115 Default: \fBnone (i.e., all hosts permitted access)
3117 Example: \fBallow hosts = 150.203.5. myhost.mynet.edu.au
3119 \fBhosts deny (S)\fR
3120 The opposite of \fIhosts allow\fR
3121 - hosts listed here are \fBNOT\fR permitted access to
3122 services unless the specific services have their own lists to override
3123 this one. Where the lists conflict, the \fIallow\fR
3124 list takes precedence.
3126 Default: \fBnone (i.e., no hosts specifically excluded)
3128 Example: \fBhosts deny = 150.203.4. badhost.mynet.edu.au
3130 \fBhosts equiv (G)\fR
3131 If this global parameter is a non-null string,
3132 it specifies the name of a file to read for the names of hosts
3133 and users who will be allowed access without specifying a password.
3135 This is not be confused with \fIhosts allow\fR which is about hosts
3136 access to services and is more useful for guest services. \fI hosts equiv\fR may be useful for NT clients which will
3137 not supply passwords to samba.
3139 \fBNOTE :\fR The use of \fIhosts equiv
3140 \fRcan be a major security hole. This is because you are
3141 trusting the PC to supply the correct username. It is very easy to
3142 get a PC to supply a false username. I recommend that the
3143 \fIhosts equiv\fR option be only used if you really
3144 know what you are doing, or perhaps on a home network where you trust
3145 your spouse and kids. And only if you \fBreally\fR trust
3148 Default: \fBno host equivalences\fR
3150 Example: \fBhosts equiv = /etc/hosts.equiv\fR
3153 This allows you to include one config file
3154 inside another. The file is included literally, as though typed
3157 It takes the standard substitutions, except \fI%u
3158 \fR, \fI%P\fR and \fI%S\fR.
3160 Default: \fBno file included\fR
3162 Example: \fBinclude = /usr/local/samba/lib/admin_smb.conf
3164 \fBinherit permissions (S)\fR
3165 The permissions on new files and directories
3166 are normally governed by \fI create mask\fR, \fIdirectory mask\fR, \fIforce create mode\fR
3168 directory mode\fR but the boolean inherit
3169 permissions parameter overrides this.
3171 New directories inherit the mode of the parent directory,
3172 including bits such as setgid.
3174 New files inherit their read/write bits from the parent
3175 directory. Their execute bits continue to be determined by
3178 and \fImap system\fR
3181 Note that the setuid bit is \fBnever\fR set via
3182 inheritance (the code explicitly prohibits this).
3184 This can be particularly useful on large systems with
3185 many users, perhaps several thousand,to allow a single [homes]
3186 share to be used flexibly by each user.
3188 See also \fIcreate mask
3189 \fR, \fI directory mask\fR, \fIforce create mode\fR and \fIforce directory mode\fR
3192 Default: \fBinherit permissions = no\fR
3194 \fBinterfaces (G)\fR
3195 This option allows you to override the default
3196 network interfaces list that Samba will use for browsing, name
3197 registration and other NBT traffic. By default Samba will query
3198 the kernel for the list of all active interfaces and use any
3199 interfaces except 127.0.0.1 that are broadcast capable.
3201 The option takes a list of interface strings. Each string
3202 can be in any of the following forms:
3206 a network interface name (such as eth0).
3207 This may include shell-like wildcards so eth* will match
3208 any interface starting with the substring "eth"
3211 an IP address. In this case the netmask is
3212 determined from the list of interfaces obtained from the
3219 a broadcast/mask pair.
3222 The "mask" parameters can either be a bit length (such
3223 as 24 for a C class network) or a full netmask in dotted
3227 The "IP" parameters above can either be a full dotted
3228 decimal IP address or a hostname which will be looked up via
3229 the OS's normal hostname resolution mechanisms.
3232 For example, the following line:
3235 \fBinterfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0
3238 would configure three network interfaces corresponding
3239 to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10.
3240 The netmasks of the latter two interfaces would be set to 255.255.255.0.
3247 Default: \fBall active interfaces except 127.0.0.1
3248 that are broadcast capable\fR
3251 \fBinvalid users (S)\fR
3252 This is a list of users that should not be allowed
3253 to login to this service. This is really a \fBparanoid\fR
3254 check to absolutely ensure an improper setting does not breach
3257 A name starting with a '@' is interpreted as an NIS
3258 netgroup first (if your system supports NIS), and then as a UNIX
3259 group if the name was not found in the NIS netgroup database.
3261 A name starting with '+' is interpreted only
3262 by looking in the UNIX group database. A name starting with
3263 \&'&' is interpreted only by looking in the NIS netgroup database
3264 (this requires NIS to be working on your system). The characters
3265 \&'+' and '&' may be used at the start of the name in either order
3266 so the value \fI+&group\fR means check the
3267 UNIX group database, followed by the NIS netgroup database, and
3268 the value \fI&+group"\fR means check the NIS
3269 netgroup database, followed by the UNIX group database (the
3270 same as the '@' prefix).
3272 The current servicename is substituted for \fI%S\fR.
3273 This is useful in the [homes] section.
3275 See also \fIvalid users
3278 Default: \fBno invalid users\fR
3280 Example: \fBinvalid users = root fred admin @wheel
3283 The value of the parameter (an integer) represents
3284 the number of seconds between \fIkeepalive\fR
3285 packets. If this parameter is zero, no keepalive packets will be
3286 sent. Keepalive packets, if sent, allow the server to tell whether
3287 a client is still present and responding.
3289 Keepalives should, in general, not be needed if the socket
3290 being used has the SO_KEEPALIVE attribute set on it (see \fIsocket options\fR).
3291 Basically you should only use this option if you strike difficulties.
3293 Default: \fBkeepalive = 300\fR
3295 Example: \fBkeepalive = 600\fR
3297 \fBkernel oplocks (G)\fR
3298 For UNIXes that support kernel based \fIoplocks\fR
3299 (currently only IRIX and the Linux 2.4 kernel), this parameter
3300 allows the use of them to be turned on or off.
3302 Kernel oplocks support allows Samba \fIoplocks
3303 \fRto be broken whenever a local UNIX process or NFS operation
3304 accesses a file that \fBsmbd(8)\fR
3305 has oplocked. This allows complete data consistency between
3306 SMB/CIFS, NFS and local file access (and is a \fBvery\fR
3309 This parameter defaults to on on systems
3310 that have the support, and off on systems that
3311 don't. You should never need to touch this parameter.
3313 See also the \fIoplocks\fR
3314 and \fIlevel2 oplocks
3317 Default: \fBkernel oplocks = yes\fR
3319 \fBlanman auth (G)\fR
3320 This parameter determines whether or not smbd will
3321 attempt to authentication users using the LANMAN password hash.
3322 If disabled, only clients which support NT password hashes (e.g. Windows
3323 NT/2000 clients, smbclient, etc... but not Windows 95/98 or the MS DOS
3324 network client) will be able to connect to the Samba host.
3326 Default : \fBlanman auth = yes\fR
3328 \fBlevel2 oplocks (S)\fR
3329 This parameter controls whether Samba supports
3330 level2 (read-only) oplocks on a share.
3332 Level2, or read-only oplocks allow Windows NT clients
3333 that have an oplock on a file to downgrade from a read-write oplock
3334 to a read-only oplock once a second client opens the file (instead
3335 of releasing all oplocks on a second open, as in traditional,
3336 exclusive oplocks). This allows all openers of the file that
3337 support level2 oplocks to cache the file for read-ahead only (ie.
3338 they may not cache writes or lock requests) and increases performance
3339 for many accesses of files that are not commonly written (such as
3340 application .EXE files).
3342 Once one of the clients which have a read-only oplock
3343 writes to the file all clients are notified (no reply is needed
3344 or waited for) and told to break their oplocks to "none" and
3345 delete any read-ahead caches.
3347 It is recommended that this parameter be turned on
3348 to speed access to shared executables.
3350 For more discussions on level2 oplocks see the CIFS spec.
3352 Currently, if \fIkernel
3353 oplocks\fR are supported then level2 oplocks are
3354 not granted (even if this parameter is set to yes).
3355 Note also, the \fIoplocks\fR
3356 parameter must be set to "true" on this share in order for
3357 this parameter to have any effect.
3359 See also the \fIoplocks\fR
3360 and \fIkernel oplocks\fR
3363 Default: \fBlevel2 oplocks = yes\fR
3365 \fBlm announce (G)\fR
3366 This parameter determines if \fBnmbd(8)\fRwill produce Lanman announce
3367 broadcasts that are needed by OS/2 clients in order for them to see
3368 the Samba server in their browse list. This parameter can have three
3369 values, true, false, or
3370 auto. The default is auto.
3371 If set to false Samba will never produce these
3372 broadcasts. If set to true Samba will produce
3373 Lanman announce broadcasts at a frequency set by the parameter
3374 \fIlm interval\fR. If set to auto
3375 Samba will not send Lanman announce broadcasts by default but will
3376 listen for them. If it hears such a broadcast on the wire it will
3377 then start sending them at a frequency set by the parameter
3380 See also \fIlm interval
3383 Default: \fBlm announce = auto\fR
3385 Example: \fBlm announce = yes\fR
3387 \fBlm interval (G)\fR
3388 If Samba is set to produce Lanman announce
3389 broadcasts needed by OS/2 clients (see the \fIlm announce\fR parameter) then this
3390 parameter defines the frequency in seconds with which they will be
3391 made. If this is set to zero then no Lanman announcements will be
3392 made despite the setting of the \fIlm announce\fR
3398 Default: \fBlm interval = 60\fR
3400 Example: \fBlm interval = 120\fR
3402 \fBload printers (G)\fR
3403 A boolean variable that controls whether all
3404 printers in the printcap will be loaded for browsing by default.
3405 See the printers section for
3408 Default: \fBload printers = yes\fR
3410 \fBlocal master (G)\fR
3411 This option allows \fB nmbd(8)\fRto try and become a local master browser
3412 on a subnet. If set to False then \fB nmbd\fR will not attempt to become a local master browser
3413 on a subnet and will also lose in all browsing elections. By
3414 default this value is set to true. Setting this value to true doesn't
3415 mean that Samba will \fBbecome\fR the local master
3416 browser on a subnet, just that \fBnmbd\fR will \fB participate\fR in elections for local master browser.
3418 Setting this value to False will cause \fBnmbd\fR
3419 \fBnever\fR to become a local master browser.
3421 Default: \fBlocal master = yes\fR
3424 Synonym for \fI lock directory\fR.
3426 \fBlock directory (G)\fR
3427 This option specifies the directory where lock
3428 files will be placed. The lock files are used to implement the
3429 \fImax connections\fR
3432 Default: \fBlock directory = ${prefix}/var/locks\fR
3434 Example: \fBlock directory = /var/run/samba/locks\fR
3437 This controls whether or not locking will be
3438 performed by the server in response to lock requests from the
3441 If \fBlocking = no\fR, all lock and unlock
3442 requests will appear to succeed and all lock queries will report
3443 that the file in question is available for locking.
3445 If \fBlocking = yes\fR, real locking will be performed
3448 This option \fBmay\fR be useful for read-only
3449 filesystems which \fBmay\fR not need locking (such as
3450 cdrom drives), although setting this parameter of no
3451 is not really recommended even in this case.
3453 Be careful about disabling locking either globally or in a
3454 specific service, as lack of locking may result in data corruption.
3455 You should never need to set this parameter.
3457 Default: \fBlocking = yes\fR
3460 This option allows you to override the name
3461 of the Samba log file (also known as the debug file).
3463 This option takes the standard substitutions, allowing
3464 you to have separate log files for each user or machine.
3466 Example: \fBlog file = /usr/local/samba/var/log.%m
3469 Synonym for \fI debug level\fR.
3471 \fBlogon drive (G)\fR
3472 This parameter specifies the local path to
3473 which the home directory will be connected (see \fIlogon home\fR)
3474 and is only used by NT Workstations.
3476 Note that this option is only useful if Samba is set up as a
3479 Default: \fBlogon drive = z:\fR
3481 Example: \fBlogon drive = h:\fR
3483 \fBlogon home (G)\fR
3484 This parameter specifies the home directory
3485 location when a Win95/98 or NT Workstation logs into a Samba PDC.
3488 C:\\> \fBNET USE H: /HOME\fR
3490 from a command prompt, for example.
3492 This option takes the standard substitutions, allowing
3493 you to have separate logon scripts for each user or machine.
3495 This parameter can be used with Win9X workstations to ensure
3496 that roaming profiles are stored in a subdirectory of the user's
3497 home directory. This is done in the following way:
3499 \fBlogon home = \\\\%N\\%U\\profile\fR
3501 This tells Samba to return the above string, with
3502 substitutions made when a client requests the info, generally
3503 in a NetUserGetInfo request. Win9X clients truncate the info to
3504 \\\\server\\share when a user does \fBnet use /home"\fR
3505 but use the whole string when dealing with profiles.
3507 Note that in prior versions of Samba, the \fIlogon path\fR was returned rather than
3508 \fIlogon home\fR. This broke \fBnet use
3509 /home\fR but allowed profiles outside the home directory.
3510 The current implementation is correct, and can be used for
3511 profiles if you use the above trick.
3513 This option is only useful if Samba is set up as a logon
3516 Default: \fBlogon home = "\\\\%N\\%U"\fR
3518 Example: \fBlogon home = "\\\\remote_smb_server\\%U"\fR
3520 \fBlogon path (G)\fR
3521 This parameter specifies the home directory
3522 where roaming profiles (NTuser.dat etc files for Windows NT) are
3523 stored. Contrary to previous versions of these manual pages, it has
3524 nothing to do with Win 9X roaming profiles. To find out how to
3525 handle roaming profiles for Win 9X system, see the \fIlogon home\fR parameter.
3527 This option takes the standard substitutions, allowing you
3528 to have separate logon scripts for each user or machine. It also
3529 specifies the directory from which the "Application Data",
3530 (\fIdesktop\fR, \fIstart menu\fR,
3531 \fInetwork neighborhood\fR, \fIprograms\fR
3532 and other folders, and their contents, are loaded and displayed on
3533 your Windows NT client.
3535 The share and the path must be readable by the user for
3536 the preferences and directories to be loaded onto the Windows NT
3537 client. The share must be writeable when the logs in for the first
3538 time, in order that the Windows NT client can create the NTuser.dat
3539 and other directories.
3541 Thereafter, the directories and any of the contents can,
3542 if required, be made read-only. It is not advisable that the
3543 NTuser.dat file be made read-only - rename it to NTuser.man to
3544 achieve the desired effect (a \fBMAN\fRdatory
3547 Windows clients can sometimes maintain a connection to
3548 the [homes] share, even though there is no user logged in.
3549 Therefore, it is vital that the logon path does not include a
3550 reference to the homes share (i.e. setting this parameter to
3551 \\%N\\%U\\profile_path will cause problems).
3553 This option takes the standard substitutions, allowing
3554 you to have separate logon scripts for each user or machine.
3556 Note that this option is only useful if Samba is set up
3559 Default: \fBlogon path = \\\\%N\\%U\\profile\fR
3561 Example: \fBlogon path = \\\\PROFILESERVER\\PROFILE\\%U\fR
3563 \fBlogon script (G)\fR
3564 This parameter specifies the batch file (.bat) or
3565 NT command file (.cmd) to be downloaded and run on a machine when
3566 a user successfully logs in. The file must contain the DOS
3567 style cr/lf line endings. Using a DOS-style editor to create the
3568 file is recommended.
3570 The script must be a relative path to the [netlogon]
3571 service. If the [netlogon] service specifies a \fIpath\fR of \fI/usr/local/samba/netlogon
3572 \fR, and \fBlogon script = STARTUP.BAT\fR, then
3573 the file that will be downloaded is:
3575 \fI/usr/local/samba/netlogon/STARTUP.BAT\fR
3577 The contents of the batch file is entirely your choice. A
3578 suggested command would be to add \fBNET TIME \\\\SERVER /SET
3579 /YES\fR, to force every machine to synchronize clocks with
3580 the same time server. Another use would be to add \fBNET USE
3581 U: \\\\SERVER\\UTILS\fR for commonly used utilities, or \fB NET USE Q: \\\\SERVER\\ISO9001_QA\fR for example.
3583 Note that it is particularly important not to allow write
3584 access to the [netlogon] share, or to grant users write permission
3585 on the batch files in a secure environment, as this would allow
3586 the batch files to be arbitrarily modified and security to be
3589 This option takes the standard substitutions, allowing you
3590 to have separate logon scripts for each user or machine.
3592 This option is only useful if Samba is set up as a logon
3595 Default: \fBno logon script defined\fR
3597 Example: \fBlogon script = scripts\\%U.bat\fR
3599 \fBlppause command (S)\fR
3600 This parameter specifies the command to be
3601 executed on the server host in order to stop printing or spooling
3602 a specific print job.
3604 This command should be a program or script which takes
3605 a printer name and job number to pause the print job. One way
3606 of implementing this is by using job priorities, where jobs
3607 having a too low priority won't be sent to the printer.
3609 If a \fI%p\fR is given then the printername
3610 is put in its place. A \fI%j\fR is replaced with
3611 the job number (an integer). On HPUX (see \fIprinting=hpux
3612 \fR), if the \fI-p%p\fR option is added
3613 to the lpq command, the job will show up with the correct status, i.e.
3614 if the job priority is lower than the set fence priority it will
3615 have the PAUSED status, whereas if the priority is equal or higher it
3616 will have the SPOOLED or PRINTING status.
3618 Note that it is good practice to include the absolute path
3619 in the lppause command as the PATH may not be available to the server.
3621 See also the \fIprinting
3624 Default: Currently no default value is given to
3625 this string, unless the value of the \fIprinting\fR
3626 parameter is SYSV, in which case the default is :
3628 \fBlp -i %p-%j -H hold\fR
3630 or if the value of the \fIprinting\fR parameter
3631 is SOFTQ, then the default is:
3633 \fBqstat -s -j%j -h\fR
3635 Example for HPUX: \fBlppause command = /usr/bin/lpalt
3638 \fBlpq cache time (G)\fR
3639 This controls how long lpq info will be cached
3640 for to prevent the \fBlpq\fR command being called too
3641 often. A separate cache is kept for each variation of the \fB lpq\fR command used by the system, so if you use different
3642 \fBlpq\fR commands for different users then they won't
3643 share cache information.
3645 The cache files are stored in \fI/tmp/lpq.xxxx\fR
3646 where xxxx is a hash of the \fBlpq\fR command in use.
3648 The default is 10 seconds, meaning that the cached results
3649 of a previous identical \fBlpq\fR command will be used
3650 if the cached data is less than 10 seconds old. A large value may
3651 be advisable if your \fBlpq\fR command is very slow.
3653 A value of 0 will disable caching completely.
3655 See also the \fIprinting
3658 Default: \fBlpq cache time = 10\fR
3660 Example: \fBlpq cache time = 30\fR
3662 \fBlpq command (S)\fR
3663 This parameter specifies the command to be
3664 executed on the server host in order to obtain \fBlpq
3665 \fR-style printer status information.
3667 This command should be a program or script which
3668 takes a printer name as its only parameter and outputs printer
3671 Currently eight styles of printer status information
3672 are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX and SOFTQ.
3673 This covers most UNIX systems. You control which type is expected
3674 using the \fIprinting =\fR option.
3676 Some clients (notably Windows for Workgroups) may not
3677 correctly send the connection number for the printer they are
3678 requesting status information about. To get around this, the
3679 server reports on the first printer service connected to by the
3680 client. This only happens if the connection number sent is invalid.
3682 If a \fI%p\fR is given then the printername
3683 is put in its place. Otherwise it is placed at the end of the
3686 Note that it is good practice to include the absolute path
3687 in the \fIlpq command\fR as the \fB$PATH
3688 \fRmay not be available to the server.
3690 See also the \fIprinting
3693 Default: \fBdepends on the setting of \fI printing\fB\fR
3695 Example: \fBlpq command = /usr/bin/lpq -P%p\fR
3697 \fBlpresume command (S)\fR
3698 This parameter specifies the command to be
3699 executed on the server host in order to restart or continue
3700 printing or spooling a specific print job.
3702 This command should be a program or script which takes
3703 a printer name and job number to resume the print job. See
3704 also the \fIlppause command
3707 If a \fI%p\fR is given then the printername
3708 is put in its place. A \fI%j\fR is replaced with
3709 the job number (an integer).
3711 Note that it is good practice to include the absolute path
3712 in the \fIlpresume command\fR as the PATH may not
3713 be available to the server.
3715 See also the \fIprinting
3718 Default: Currently no default value is given
3719 to this string, unless the value of the \fIprinting\fR
3720 parameter is SYSV, in which case the default is :
3722 \fBlp -i %p-%j -H resume\fR
3724 or if the value of the \fIprinting\fR parameter
3725 is SOFTQ, then the default is:
3727 \fBqstat -s -j%j -r\fR
3729 Example for HPUX: \fBlpresume command = /usr/bin/lpalt
3732 \fBlprm command (S)\fR
3733 This parameter specifies the command to be
3734 executed on the server host in order to delete a print job.
3736 This command should be a program or script which takes
3737 a printer name and job number, and deletes the print job.
3739 If a \fI%p\fR is given then the printername
3740 is put in its place. A \fI%j\fR is replaced with
3741 the job number (an integer).
3743 Note that it is good practice to include the absolute
3744 path in the \fIlprm command\fR as the PATH may not be
3745 available to the server.
3747 See also the \fIprinting
3750 Default: \fBdepends on the setting of \fIprinting
3752 Example 1: \fBlprm command = /usr/bin/lprm -P%p %j
3754 Example 2: \fBlprm command = /usr/bin/cancel %p-%j
3756 \fBmachine password timeout (G)\fR
3757 If a Samba server is a member of an Windows
3758 NT Domain (see the security=domain)
3759 parameter) then periodically a running smbd(8)process will try and change the MACHINE ACCOUNT
3760 PASSWORD stored in the TDB called \fIprivate/secrets.tdb
3761 \fR\&. This parameter specifies how often this password
3762 will be changed, in seconds. The default is one week (expressed in
3763 seconds), the same as a Windows NT Domain member server.
3765 See also \fBsmbpasswd(8)
3766 \fR, and the security=domain) parameter.
3768 Default: \fBmachine password timeout = 604800\fR
3770 \fBmagic output (S)\fR
3771 This parameter specifies the name of a file
3772 which will contain output created by a magic script (see the
3776 Warning: If two clients use the same \fImagic script
3777 \fRin the same directory the output file content
3780 Default: \fBmagic output = <magic script name>.out
3782 Example: \fBmagic output = myfile.txt\fR
3784 \fBmagic script (S)\fR
3785 This parameter specifies the name of a file which,
3786 if opened, will be executed by the server when the file is closed.
3787 This allows a UNIX script to be sent to the Samba host and
3788 executed on behalf of the connected user.
3790 Scripts executed in this way will be deleted upon
3791 completion assuming that the user has the appripriate level
3792 of priviledge and the ile permissions allow the deletion.
3794 If the script generates output, output will be sent to
3795 the file specified by the \fI magic output\fR parameter (see above).
3797 Note that some shells are unable to interpret scripts
3798 containing CR/LF instead of CR as
3799 the end-of-line marker. Magic scripts must be executable
3800 \fBas is\fR on the host, which for some hosts and
3801 some shells will require filtering at the DOS end.
3803 Magic scripts are \fBEXPERIMENTAL\fR and
3804 should \fBNOT\fR be relied upon.
3806 Default: \fBNone. Magic scripts disabled.\fR
3808 Example: \fBmagic script = user.csh\fR
3810 \fBmangle case (S)\fR
3811 See the section on NAME MANGLING
3813 Default: \fBmangle case = no\fR
3815 \fBmangled map (S)\fR
3816 This is for those who want to directly map UNIX
3817 file names which can not be represented on Windows/DOS. The mangling
3818 of names is not always what is needed. In particular you may have
3819 documents with file extensions that differ between DOS and UNIX.
3820 For example, under UNIX it is common to use \fI.html\fR
3821 for HTML files, whereas under Windows/DOS \fI.htm\fR
3822 is more commonly used.
3824 So to map \fIhtml\fR to \fIhtm\fR
3827 \fBmangled map = (*.html *.htm)\fR
3829 One very useful case is to remove the annoying \fI;1
3830 \fRoff the ends of filenames on some CDROMS (only visible
3831 under some UNIXes). To do this use a map of (*;1 *;).
3833 Default: \fBno mangled map\fR
3835 Example: \fBmangled map = (*;1 *;)\fR
3837 \fBmangled names (S)\fR
3838 This controls whether non-DOS names under UNIX
3839 should be mapped to DOS-compatible names ("mangled") and made visible,
3840 or whether non-DOS names should simply be ignored.
3842 See the section on NAME MANGLING for details on how to control the mangling process.
3844 If mangling is used then the mangling algorithm is as follows:
3848 The first (up to) five alphanumeric characters
3849 before the rightmost dot of the filename are preserved, forced
3850 to upper case, and appear as the first (up to) five characters
3851 of the mangled name.
3854 A tilde "~" is appended to the first part of the mangled
3855 name, followed by a two-character unique sequence, based on the
3856 original root name (i.e., the original filename minus its final
3857 extension). The final extension is included in the hash calculation
3858 only if it contains any upper case characters or is longer than three
3861 Note that the character to use may be specified using
3862 the \fImangling char\fR
3863 option, if you don't like '~'.
3866 The first three alphanumeric characters of the final
3867 extension are preserved, forced to upper case and appear as the
3868 extension of the mangled name. The final extension is defined as that
3869 part of the original filename after the rightmost dot. If there are no
3870 dots in the filename, the mangled name will have no extension (except
3871 in the case of "hidden files" - see below).
3874 Files whose UNIX name begins with a dot will be
3875 presented as DOS hidden files. The mangled name will be created as
3876 for other filenames, but with the leading dot removed and "___" as
3877 its extension regardless of actual original extension (that's three
3881 The two-digit hash value consists of upper case
3882 alphanumeric characters.
3885 This algorithm can cause name collisions only if files
3886 in a directory share the same first five alphanumeric characters.
3887 The probability of such a clash is 1/1300.
3890 The name mangling (if enabled) allows a file to be
3891 copied between UNIX directories from Windows/DOS while retaining
3892 the long UNIX filename. UNIX files can be renamed to a new extension
3893 from Windows/DOS and will retain the same basename. Mangled names
3894 do not change between sessions.
3897 Default: \fBmangled names = yes\fR
3900 \fBmangled stack (G)\fR
3901 This parameter controls the number of mangled names
3902 that should be cached in the Samba server smbd(8).
3904 This stack is a list of recently mangled base names
3905 (extensions are only maintained if they are longer than 3 characters
3906 or contains upper case characters).
3908 The larger this value, the more likely it is that mangled
3909 names can be successfully converted to correct long UNIX names.
3910 However, large stack sizes will slow most directory access. Smaller
3911 stacks save memory in the server (each stack element costs 256 bytes).
3913 It is not possible to absolutely guarantee correct long
3914 file names, so be prepared for some surprises!
3916 Default: \fBmangled stack = 50\fR
3918 Example: \fBmangled stack = 100\fR
3920 \fBmangling char (S)\fR
3921 This controls what character is used as
3922 the \fBmagic\fR character in name mangling. The default is a '~'
3923 but this may interfere with some software. Use this option to set
3924 it to whatever you prefer.
3926 Default: \fBmangling char = ~\fR
3928 Example: \fBmangling char = ^\fR
3930 \fBmap archive (S)\fR
3931 This controls whether the DOS archive attribute
3932 should be mapped to the UNIX owner execute bit. The DOS archive bit
3933 is set when a file has been modified since its last backup. One
3934 motivation for this option it to keep Samba/your PC from making
3935 any file it touches from becoming executable under UNIX. This can
3936 be quite annoying for shared source code, documents, etc...
3938 Note that this requires the \fIcreate mask\fR
3939 parameter to be set such that owner execute bit is not masked out
3940 (i.e. it must include 100). See the parameter \fIcreate mask\fR for details.
3942 Default: \fBmap archive = yes\fR
3944 \fBmap hidden (S)\fR
3945 This controls whether DOS style hidden files
3946 should be mapped to the UNIX world execute bit.
3948 Note that this requires the \fIcreate mask\fR
3949 to be set such that the world execute bit is not masked out (i.e.
3950 it must include 001). See the parameter \fIcreate mask\fR for details.
3952 Default: \fBmap hidden = no\fR
3954 \fBmap system (S)\fR
3955 This controls whether DOS style system files
3956 should be mapped to the UNIX group execute bit.
3958 Note that this requires the \fIcreate mask\fR
3959 to be set such that the group execute bit is not masked out (i.e.
3960 it must include 010). See the parameter \fIcreate mask\fR for details.
3962 Default: \fBmap system = no\fR
3964 \fBmap to guest (G)\fR
3965 This parameter is only useful in security modes other than \fIsecurity=share\fR
3966 - i.e. user, server,
3969 This parameter can take three different values, which tell
3970 smbd(8)what to do with user
3971 login requests that don't match a valid UNIX user in some way.
3973 The three settings are :
3977 Never - Means user login
3978 requests with an invalid password are rejected. This is the
3982 Bad User - Means user
3983 logins with an invalid password are rejected, unless the username
3984 does not exist, in which case it is treated as a guest login and
3985 mapped into the \fI guest account\fR.
3988 Bad Password - Means user logins
3989 with an invalid password are treated as a guest login and mapped
3990 into the guest account. Note that
3991 this can cause problems as it means that any user incorrectly typing
3992 their password will be silently logged on as "guest" - and
3993 will not know the reason they cannot access files they think
3994 they should - there will have been no message given to them
3995 that they got their password wrong. Helpdesk services will
3996 \fBhate\fR you if you set the \fImap to
3997 guest\fR parameter this way :-).
4000 Note that this parameter is needed to set up "Guest"
4001 share services when using \fIsecurity\fR modes other than
4002 share. This is because in these modes the name of the resource being
4003 requested is \fBnot\fR sent to the server until after
4004 the server has successfully authenticated the client so the server
4005 cannot make authentication decisions at the correct time (connection
4006 to the share) for "Guest" shares.
4009 For people familiar with the older Samba releases, this
4010 parameter maps to the old compile-time setting of the GUEST_SESSSETUP value in local.h.
4013 Default: \fBmap to guest = Never\fR
4016 Example: \fBmap to guest = Bad User\fR
4019 \fBmax connections (S)\fR
4020 This option allows the number of simultaneous
4021 connections to a service to be limited. If \fImax connections
4022 \fRis greater than 0 then connections will be refused if
4023 this number of connections to the service are already open. A value
4024 of zero mean an unlimited number of connections may be made.
4026 Record lock files are used to implement this feature. The
4027 lock files will be stored in the directory specified by the \fIlock directory\fR
4030 Default: \fBmax connections = 0\fR
4032 Example: \fBmax connections = 10\fR
4034 \fBmax disk size (G)\fR
4035 This option allows you to put an upper limit
4036 on the apparent size of disks. If you set this option to 100
4037 then all shares will appear to be not larger than 100 MB in
4040 Note that this option does not limit the amount of
4041 data you can put on the disk. In the above case you could still
4042 store much more than 100 MB on the disk, but if a client ever asks
4043 for the amount of free disk space or the total disk size then the
4044 result will be bounded by the amount specified in \fImax
4047 This option is primarily useful to work around bugs
4048 in some pieces of software that can't handle very large disks,
4049 particularly disks over 1GB in size.
4051 A \fImax disk size\fR of 0 means no limit.
4053 Default: \fBmax disk size = 0\fR
4055 Example: \fBmax disk size = 1000\fR
4057 \fBmax log size (G)\fR
4058 This option (an integer in kilobytes) specifies
4059 the max size the log file should grow to. Samba periodically checks
4060 the size and if it is exceeded it will rename the file, adding
4061 a \fI.old\fR extension.
4063 A size of 0 means no limit.
4065 Default: \fBmax log size = 5000\fR
4067 Example: \fBmax log size = 1000\fR
4070 This option controls the maximum number of
4071 outstanding simultaneous SMB operations that samba tells the client
4072 it will allow. You should never need to set this parameter.
4074 Default: \fBmax mux = 50\fR
4076 \fBmax open files (G)\fR
4077 This parameter limits the maximum number of
4078 open files that one smbd(8)file
4079 serving process may have open for a client at any one time. The
4080 default for this parameter is set very high (10,000) as Samba uses
4081 only one bit per unopened file.
4083 The limit of the number of open files is usually set
4084 by the UNIX per-process file descriptor limit rather than
4085 this parameter so you should never need to touch this parameter.
4087 Default: \fBmax open files = 10000\fR
4089 \fBmax print jobs (S)\fR
4090 This parameter limits the maximum number of
4091 jobs allowable in a Samba printer queue at any given moment.
4092 If this number is exceeded, \fB smbd(8)\fRwill remote "Out of Space" to the client.
4096 Default: \fBmax print jobs = 1000\fR
4098 Example: \fBmax print jobs = 5000\fR
4100 \fBmax protocol (G)\fR
4101 The value of the parameter (a string) is the highest
4102 protocol level that will be supported by the server.
4104 Possible values are :
4108 CORE: Earliest version. No
4109 concept of user names.
4112 COREPLUS: Slight improvements on
4113 CORE for efficiency.
4116 LANMAN1: First \fB modern\fR version of the protocol. Long filename
4120 LANMAN2: Updates to Lanman1 protocol.
4123 NT1: Current up to date version of
4124 the protocol. Used by Windows NT. Known as CIFS.
4127 Normally this option should not be set as the automatic
4128 negotiation phase in the SMB protocol takes care of choosing
4129 the appropriate protocol.
4136 Default: \fBmax protocol = NT1\fR
4139 Example: \fBmax protocol = LANMAN1\fR
4142 \fBmax smbd processes (G)\fR
4143 This parameter limits the maximum number of
4145 processes concurrently running on a system and is intended
4146 as a stop gap to prevent degrading service to clients in the event
4147 that the server has insufficient resources to handle more than this
4148 number of connections. Remember that under normal operating
4149 conditions, each user will have an smbd associated with him or her
4150 to handle connections to all shares from a given host.
4152 Default: \fBmax smbd processes = 0\fR ## no limit
4154 Example: \fBmax smbd processes = 1000\fR
4157 This option tells nmbd(8)
4158 what the default 'time to live' of NetBIOS names should be (in seconds)
4159 when \fBnmbd\fR is requesting a name using either a
4160 broadcast packet or from a WINS server. You should never need to
4161 change this parameter. The default is 3 days.
4163 Default: \fBmax ttl = 259200\fR
4165 \fBmax wins ttl (G)\fR
4166 This option tells nmbd(8)
4167 when acting as a WINS server ( \fIwins support=yes\fR) what the maximum
4168 \&'time to live' of NetBIOS names that \fBnmbd\fR
4169 will grant will be (in seconds). You should never need to change this
4170 parameter. The default is 6 days (518400 seconds).
4173 wins ttl"\fR parameter.
4175 Default: \fBmax wins ttl = 518400\fR
4178 This option controls the maximum packet size
4179 that will be negotiated by Samba. The default is 65535, which
4180 is the maximum. In some cases you may find you get better performance
4181 with a smaller value. A value below 2048 is likely to cause problems.
4183 Default: \fBmax xmit = 65535\fR
4185 Example: \fBmax xmit = 8192\fR
4187 \fBmessage command (G)\fR
4188 This specifies what command to run when the
4189 server receives a WinPopup style message.
4191 This would normally be a command that would
4192 deliver the message somehow. How this is to be done is
4193 up to your imagination.
4197 \fBmessage command = csh -c 'xedit %s;rm %s' &\fR
4199 This delivers the message using \fBxedit\fR, then
4200 removes it afterwards. \fBNOTE THAT IT IS VERY IMPORTANT
4201 THAT THIS COMMAND RETURN IMMEDIATELY\fR. That's why I
4202 have the '&' on the end. If it doesn't return immediately then
4203 your PCs may freeze when sending messages (they should recover
4204 after 30secs, hopefully).
4206 All messages are delivered as the global guest user.
4207 The command takes the standard substitutions, although \fI %u\fR won't work (\fI%U\fR may be better
4210 Apart from the standard substitutions, some additional
4211 ones apply. In particular:
4215 \fI%s\fR = the filename containing
4219 \fI%t\fR = the destination that
4220 the message was sent to (probably the server name).
4223 \fI%f\fR = who the message
4227 You could make this command send mail, or whatever else
4228 takes your fancy. Please let us know of any really interesting
4232 Here's a way of sending the messages as mail to root:
4235 \fBmessage command = /bin/mail -s 'message from %f on
4236 %m' root < %s; rm %s\fR
4239 If you don't have a message command then the message
4240 won't be delivered and Samba will tell the sender there was
4241 an error. Unfortunately WfWg totally ignores the error code
4242 and carries on regardless, saying that the message was delivered.
4245 If you want to silently delete it then try:
4248 \fBmessage command = rm %s\fR
4251 Default: \fBno message command\fR
4254 Example: \fBmessage command = csh -c 'xedit %s;
4258 \fBmin passwd length (G)\fR
4259 Synonym for \fImin password length\fR.
4261 \fBmin password length (G)\fR
4262 This option sets the minimum length in characters
4263 of a plaintext password that \fBsmbd\fR will accept when performing
4264 UNIX password changing.
4267 password sync\fR, \fIpasswd program\fR and \fIpasswd chat debug\fR
4270 Default: \fBmin password length = 5\fR
4272 \fBmin print space (S)\fR
4273 This sets the minimum amount of free disk
4274 space that must be available before a user will be able to spool
4275 a print job. It is specified in kilobytes. The default is 0, which
4276 means a user can always spool a print job.
4278 See also the \fIprinting
4281 Default: \fBmin print space = 0\fR
4283 Example: \fBmin print space = 2000\fR
4285 \fBmin protocol (G)\fR
4286 The value of the parameter (a string) is the
4287 lowest SMB protocol dialect than Samba will support. Please refer
4288 to the \fImax protocol\fR
4289 parameter for a list of valid protocol names and a brief description
4290 of each. You may also wish to refer to the C source code in
4291 \fIsource/smbd/negprot.c\fR for a listing of known protocol
4292 dialects supported by clients.
4294 If you are viewing this parameter as a security measure, you should
4295 also refer to the \fIlanman
4296 auth\fR parameter. Otherwise, you should never need
4297 to change this parameter.
4299 Default : \fBmin protocol = CORE\fR
4301 Example : \fBmin protocol = NT1\fR # disable DOS
4304 \fBmin wins ttl (G)\fR
4305 This option tells nmbd(8)
4306 when acting as a WINS server (\fI wins support = yes\fR) what the minimum 'time to live'
4307 of NetBIOS names that \fBnmbd\fR will grant will be (in
4308 seconds). You should never need to change this parameter. The default
4309 is 6 hours (21600 seconds).
4311 Default: \fBmin wins ttl = 21600\fR
4313 \fBmsdfs root (S)\fR
4314 This boolean parameter is only available if
4315 Samba is configured and compiled with the \fB --with-msdfs\fR option. If set to yes>,
4316 Samba treats the share as a Dfs root and allows clients to browse
4317 the distributed file system tree rooted at the share directory.
4318 Dfs links are specified in the share directory by symbolic
4319 links of the form \fImsdfs:serverA\\shareA,serverB\\shareB
4320 \fRand so on. For more information on setting up a Dfs tree
4321 on Samba, refer to msdfs_setup.html
4324 See also \fIhost msdfs
4326 Default: \fBmsdfs root = no\fR
4328 \fBname resolve order (G)\fR
4329 This option is used by the programs in the Samba
4330 suite to determine what naming services to use and in what order
4331 to resolve host names to IP addresses. The option takes a space
4332 separated string of name resolution options.
4334 The options are :"lmhosts", "host", "wins" and "bcast". They
4335 cause names to be resolved as follows :
4339 lmhosts : Lookup an IP
4340 address in the Samba lmhosts file. If the line in lmhosts has
4341 no name type attached to the NetBIOS name (see the lmhosts(5)for details) then
4342 any name type matches for lookup.
4345 host : Do a standard host
4346 name to IP address resolution, using the system \fI/etc/hosts
4347 \fR, NIS, or DNS lookups. This method of name resolution
4348 is operating system depended for instance on IRIX or Solaris this
4349 may be controlled by the \fI/etc/nsswitch.conf\fR
4350 file). Note that this method is only used if the NetBIOS name
4351 type being queried is the 0x20 (server) name type, otherwise
4355 wins : Query a name with
4356 the IP address listed in the \fI wins server\fR parameter. If no WINS server has
4357 been specified this method will be ignored.
4360 bcast : Do a broadcast on
4361 each of the known local interfaces listed in the \fIinterfaces\fR
4362 parameter. This is the least reliable of the name resolution
4363 methods as it depends on the target host being on a locally
4367 Default: \fBname resolve order = lmhosts host wins bcast
4370 Example: \fBname resolve order = lmhosts bcast host
4373 This will cause the local lmhosts file to be examined
4374 first, followed by a broadcast attempt, followed by a normal
4375 system hostname lookup.
4378 \fBnetbios aliases (G)\fR
4379 This is a list of NetBIOS names that nmbd(8)will advertise as additional
4380 names by which the Samba server is known. This allows one machine
4381 to appear in browse lists under multiple names. If a machine is
4382 acting as a browse server or logon server none
4383 of these names will be advertised as either browse server or logon
4384 servers, only the primary name of the machine will be advertised
4385 with these capabilities.
4390 Default: \fBempty string (no additional names)\fR
4392 Example: \fBnetbios aliases = TEST TEST1 TEST2\fR
4394 \fBnetbios name (G)\fR
4395 This sets the NetBIOS name by which a Samba
4396 server is known. By default it is the same as the first component
4397 of the host's DNS name. If a machine is a browse server or
4398 logon server this name (or the first component
4399 of the hosts DNS name) will be the name that these services are
4405 Default: \fBmachine DNS name\fR
4407 Example: \fBnetbios name = MYNAME\fR
4409 \fBnetbios scope (G)\fR
4410 This sets the NetBIOS scope that Samba will
4411 operate under. This should not be set unless every machine
4412 on your LAN also sets this value.
4414 \fBnis homedir (G)\fR
4415 Get the home share server from a NIS map. For
4416 UNIX systems that use an automounter, the user's home directory
4417 will often be mounted on a workstation on demand from a remote
4420 When the Samba logon server is not the actual home directory
4421 server, but is mounting the home directories via NFS then two
4422 network hops would be required to access the users home directory
4423 if the logon server told the client to use itself as the SMB server
4424 for home directories (one over SMB and one over NFS). This can
4427 This option allows Samba to return the home share as
4428 being on a different server to the logon server and as
4429 long as a Samba daemon is running on the home directory server,
4430 it will be mounted on the Samba client directly from the directory
4431 server. When Samba is returning the home share to the client, it
4432 will consult the NIS map specified in \fIhomedir map\fR and return the server
4435 Note that for this option to work there must be a working
4436 NIS system and the Samba server with this option must also
4439 Default: \fBnis homedir = no\fR
4441 \fBnt acl support (G)\fR
4442 This boolean parameter controls whether
4443 smbd(8)will attempt to map
4444 UNIX permissions into Windows NT access control lists.
4446 Default: \fBnt acl support = yes\fR
4448 \fBnt pipe support (G)\fR
4449 This boolean parameter controls whether
4450 smbd(8)will allow Windows NT
4451 clients to connect to the NT SMB specific IPC$
4452 pipes. This is a developer debugging option and can be left
4455 Default: \fBnt pipe support = yes\fR
4457 \fBnt smb support (G)\fR
4458 This boolean parameter controls whether smbd(8)will negotiate NT specific SMB
4459 support with Windows NT clients. Although this is a developer
4460 debugging option and should be left alone, benchmarking has discovered
4461 that Windows NT clients give faster performance with this option
4462 set to no. This is still being investigated.
4463 If this option is set to no then Samba offers
4464 exactly the same SMB calls that versions prior to Samba 2.0 offered.
4465 This information may be of use if any users are having problems
4466 with NT SMB support.
4468 You should not need to ever disable this parameter.
4470 Default: \fBnt smb support = yes\fR
4472 \fBnull passwords (G)\fR
4473 Allow or disallow client access to accounts
4474 that have null passwords.
4476 See also smbpasswd (5).
4478 Default: \fBnull passwords = no\fR
4480 \fBobey pam restrictions (G)\fR
4481 When Samba 2.2 is configure to enable PAM support
4482 (i.e. --with-pam), this parameter will control whether or not Samba
4483 should obey PAM's account and session management directives. The
4484 default behavior is to use PAM for clear text authentication only
4485 and to ignore any account or session management. Note that Samba
4486 always ignores PAM for authentication in the case of \fIencrypt passwords = yes\fR
4487 \&. The reason is that PAM modules cannot support the challenge/response
4488 authentication mechanism needed in the presence of SMB password encryption.
4490 Default: \fBobey pam restrictions = no\fR
4493 This is a boolean option that controls whether
4494 connections with usernames not in the \fIuser\fR
4495 list will be allowed. By default this option is disabled so that a
4496 client can supply a username to be used by the server. Enabling
4497 this parameter will force the server to only user the login
4498 names from the \fIuser\fR list and is only really
4499 useful in shave level
4502 Note that this also means Samba won't try to deduce
4503 usernames from the service name. This can be annoying for
4504 the [homes] section. To get around this you could use \fBuser =
4505 %S\fR which means your \fIuser\fR list
4506 will be just the service name, which for home directories is the
4509 See also the \fIuser\fR
4512 Default: \fBonly user = no\fR
4514 \fBonly guest (S)\fR
4515 A synonym for \fI guest only\fR.
4517 \fBoplock break wait time (G)\fR
4518 This is a tuning parameter added due to bugs in
4519 both Windows 9x and WinNT. If Samba responds to a client too
4520 quickly when that client issues an SMB that can cause an oplock
4521 break request, then the network client can fail and not respond
4522 to the break request. This tuning parameter (which is set in milliseconds)
4523 is the amount of time Samba will wait before sending an oplock break
4524 request to such (broken) clients.
4526 \fBDO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
4527 AND UNDERSTOOD THE SAMBA OPLOCK CODE\fR.
4529 Default: \fBoplock break wait time = 0\fR
4531 \fBoplock contention limit (S)\fR
4532 This is a \fBvery\fR advanced
4533 smbd(8)tuning option to
4534 improve the efficiency of the granting of oplocks under multiple
4535 client contention for the same file.
4537 In brief it specifies a number, which causes smbd not to
4538 grant an oplock even when requested if the approximate number of
4539 clients contending for an oplock on the same file goes over this
4540 limit. This causes \fBsmbd\fR to behave in a similar
4543 \fBDO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
4544 AND UNDERSTOOD THE SAMBA OPLOCK CODE\fR.
4546 Default: \fBoplock contention limit = 2\fR
4549 This boolean option tells smbd whether to
4550 issue oplocks (opportunistic locks) to file open requests on this
4551 share. The oplock code can dramatically (approx. 30% or more) improve
4552 the speed of access to files on Samba servers. It allows the clients
4553 to aggressively cache files locally and you may want to disable this
4554 option for unreliable network environments (it is turned on by
4555 default in Windows NT Servers). For more information see the file
4556 \fISpeed.txt\fR in the Samba \fIdocs/\fR
4559 Oplocks may be selectively turned off on certain files with a
4560 share. See the \fI veto oplock files\fR parameter. On some systems
4561 oplocks are recognized by the underlying operating system. This
4562 allows data synchronization between all access to oplocked files,
4563 whether it be via Samba or NFS or a local UNIX process. See the
4564 \fIkernel oplocks\fR parameter for details.
4566 See also the \fIkernel
4567 oplocks\fR and \fI level2 oplocks\fR parameters.
4569 Default: \fBoplocks = yes\fR
4572 This integer value controls what level Samba
4573 advertises itself as for browse elections. The value of this
4574 parameter determines whether nmbd(8)
4575 has a chance of becoming a local master browser for the \fI WORKGROUP\fR in the local broadcast area.
4577 \fBNote :\fRBy default, Samba will win
4578 a local master browsing election over all Microsoft operating
4579 systems except a Windows NT 4.0/2000 Domain Controller. This
4580 means that a misconfigured Samba host can effectively isolate
4581 a subnet for browsing purposes. See \fIBROWSING.txt
4582 \fRin the Samba \fIdocs/\fR directory
4585 Default: \fBos level = 20\fR
4587 Example: \fBos level = 65 \fR
4589 \fBos2 driver map (G)\fR
4590 The parameter is used to define the absolute
4591 path to a file containing a mapping of Windows NT printer driver
4592 names to OS/2 printer driver names. The format is:
4594 <nt driver name> = <os2 driver
4597 For example, a valid entry using the HP LaserJet 5
4598 printer driver woudl appear as \fBHP LaserJet 5L = LASERJET.HP
4601 The need for the file is due to the printer driver namespace
4602 problem described in the Samba
4603 Printing HOWTO. For more details on OS/2 clients, please
4604 refer to the OS2-Client-HOWTO
4605 containing in the Samba documentation.
4607 Default: \fBos2 driver map = <empty string>
4609 \fBpam password change (G)\fR
4610 With the addition of better PAM support in Samba 2.2,
4611 this parameter, it is possible to use PAM's password change control
4612 flag for Samba. If enabled, then PAM will be used for password
4613 changes when requested by an SMB client, and the \fIpasswd chat\fR string will
4616 Default: \fBpam password change = no\fR
4618 \fBpanic action (G)\fR
4619 This is a Samba developer option that allows a
4620 system command to be called when either smbd(8)
4621 crashes. This is usually used to draw attention to the fact that
4624 Default: \fBpanic action = <empty string>\fR
4626 Example: \fBpanic action = "/bin/sleep 90000"\fR
4628 \fBpasswd chat (G)\fR
4629 This string controls the \fB"chat"\fR
4630 conversation that takes places between smbdand the local password changing
4631 program to change the users password. The string describes a
4632 sequence of response-receive pairs that smbd(8)uses to determine what to send to the
4633 \fIpasswd program\fR
4634 and what to expect back. If the expected output is not
4635 received then the password is not changed.
4637 This chat sequence is often quite site specific, depending
4638 on what local methods are used for password control (such as NIS
4641 The string can contain the macros \fI%o\fR
4642 and \fI%n\fR which are substituted for the old
4643 and new passwords respectively. It can also contain the standard
4644 macros \\n, \\r, \\t and %s to give line-feed,
4645 carriage-return, tab and space.
4647 The string can also contain a '*' which matches
4648 any sequence of characters.
4650 Double quotes can be used to collect strings with spaces
4651 in them into a single string.
4653 If the send string in any part of the chat sequence
4654 is a fullstop ".", then no string is sent. Similarly,
4655 if the expect string is a fullstop then no string is expected.
4657 Note that if the \fIunix
4658 password sync\fR parameter is set to true, then this
4659 sequence is called \fBAS ROOT\fR when the SMB password
4660 in the smbpasswd file is being changed, without access to the old
4661 password cleartext. In this case the old password cleartext is set
4662 to "" (the empty string).
4664 See also \fIunix password
4665 sync\fR, \fI passwd program\fR and \fIpasswd chat debug\fR.
4667 Default: \fBpasswd chat = *new*password* %n\\n
4668 *new*password* %n\\n *changed*\fR
4670 Example: \fBpasswd chat = "*Enter OLD password*" %o\\n
4671 "*Enter NEW password*" %n\\n "*Reenter NEW password*" %n\\n "*Password
4674 \fBpasswd chat debug (G)\fR
4675 This boolean specifies if the passwd chat script
4676 parameter is run in \fBdebug\fR mode. In this mode the
4677 strings passed to and received from the passwd chat are printed
4678 in the smbd(8)log with a
4680 of 100. This is a dangerous option as it will allow plaintext passwords
4681 to be seen in the \fBsmbd\fR log. It is available to help
4682 Samba admins debug their \fIpasswd chat\fR scripts
4683 when calling the \fIpasswd program\fR and should
4684 be turned off after this has been done. This parameter is off by
4687 See also <\fIpasswd chat\fR
4688 , \fIpasswd program\fR
4691 Default: \fBpasswd chat debug = no\fR
4693 \fBpasswd program (G)\fR
4694 The name of a program that can be used to set
4695 UNIX user passwords. Any occurrences of \fI%u\fR
4696 will be replaced with the user name. The user name is checked for
4697 existence before calling the password changing program.
4699 Also note that many passwd programs insist in \fBreasonable
4700 \fRpasswords, such as a minimum length, or the inclusion
4701 of mixed case chars and digits. This can pose a problem as some clients
4702 (such as Windows for Workgroups) uppercase the password before sending
4705 \fBNote\fR that if the \fIunix
4706 password sync\fR parameter is set to True
4707 then this program is called \fBAS ROOT\fR
4708 before the SMB password in the smbpasswd(5)
4709 file is changed. If this UNIX password change fails, then
4710 \fBsmbd\fR will fail to change the SMB password also
4711 (this is by design).
4713 If the \fIunix password sync\fR parameter
4714 is set this parameter \fBMUST USE ABSOLUTE PATHS\fR
4715 for \fBALL\fR programs called, and must be examined
4716 for security implications. Note that by default \fIunix
4717 password sync\fR is set to False.
4722 Default: \fBpasswd program = /bin/passwd\fR
4724 Example: \fBpasswd program = /sbin/npasswd %u\fR
4726 \fBpassword level (G)\fR
4727 Some client/server combinations have difficulty
4728 with mixed-case passwords. One offending client is Windows for
4729 Workgroups, which for some reason forces passwords to upper
4730 case when using the LANMAN1 protocol, but leaves them alone when
4731 using COREPLUS! Another problem child is the Windows 95/98
4732 family of operating systems. These clients upper case clear
4733 text passwords even when NT LM 0.12 selected by the protocol
4734 negotiation request/response.
4736 This parameter defines the maximum number of characters
4737 that may be upper case in passwords.
4739 For example, say the password given was "FRED". If \fI password level\fR is set to 1, the following combinations
4740 would be tried if "FRED" failed:
4742 "Fred", "fred", "fRed", "frEd","freD"
4744 If \fIpassword level\fR was set to 2,
4745 the following combinations would also be tried:
4747 "FRed", "FrEd", "FreD", "fREd", "fReD", "frED", ..
4751 The higher value this parameter is set to the more likely
4752 it is that a mixed case password will be matched against a single
4753 case password. However, you should be aware that use of this
4754 parameter reduces security and increases the time taken to
4755 process a new connection.
4757 A value of zero will cause only two attempts to be
4758 made - the password as is and the password in all-lower case.
4760 Default: \fBpassword level = 0\fR
4762 Example: \fBpassword level = 4\fR
4764 \fBpassword server (G)\fR
4765 By specifying the name of another SMB server (such
4766 as a WinNT box) with this option, and using \fBsecurity = domain
4767 \fRor \fBsecurity = server\fR you can get Samba
4768 to do all its username/password validation via a remote server.
4770 This option sets the name of the password server to use.
4771 It must be a NetBIOS name, so if the machine's NetBIOS name is
4772 different from its Internet name then you may have to add its NetBIOS
4773 name to the lmhosts file which is stored in the same directory
4774 as the \fIsmb.conf\fR file.
4776 The name of the password server is looked up using the
4778 resolve order\fR and so may resolved
4779 by any method and order described in that parameter.
4781 The password server much be a machine capable of using
4782 the "LM1.2X002" or the "NT LM 0.12" protocol, and it must be in
4783 user level security mode.
4785 \fBNOTE:\fR Using a password server
4786 means your UNIX box (running Samba) is only as secure as your
4787 password server. \fBDO NOT CHOOSE A PASSWORD SERVER THAT
4788 YOU DON'T COMPLETELY TRUST\fR.
4790 Never point a Samba server at itself for password
4791 serving. This will cause a loop and could lock up your Samba
4794 The name of the password server takes the standard
4795 substitutions, but probably the only useful one is \fI%m
4796 \fR, which means the Samba server will use the incoming
4797 client as the password server. If you use this then you better
4798 trust your clients, and you had better restrict them with hosts allow!
4800 If the \fIsecurity\fR parameter is set to
4801 domain, then the list of machines in this
4802 option must be a list of Primary or Backup Domain controllers for the
4803 Domain or the character '*', as the Samba server is effectively
4804 in that domain, and will use cryptographically authenticated RPC calls
4805 to authenticate the user logging on. The advantage of using \fB security = domain\fR is that if you list several hosts in the
4806 \fIpassword server\fR option then \fBsmbd
4807 \fRwill try each in turn till it finds one that responds. This
4808 is useful in case your primary server goes down.
4810 If the \fIpassword server\fR option is set
4811 to the character '*', then Samba will attempt to auto-locate the
4812 Primary or Backup Domain controllers to authenticate against by
4813 doing a query for the name WORKGROUP<1C>
4814 and then contacting each server returned in the list of IP
4815 addresses from the name resolution source.
4817 If the \fIsecurity\fR parameter is
4818 set to server, then there are different
4819 restrictions that \fBsecurity = domain\fR doesn't
4824 You may list several password servers in
4825 the \fIpassword server\fR parameter, however if an
4826 \fBsmbd\fR makes a connection to a password server,
4827 and then the password server fails, no more users will be able
4828 to be authenticated from this \fBsmbd\fR. This is a
4829 restriction of the SMB/CIFS protocol when in \fBsecurity=server
4830 \fRmode and cannot be fixed in Samba.
4833 If you are using a Windows NT server as your
4834 password server then you will have to ensure that your users
4835 are able to login from the Samba server, as when in \fB security=server\fR mode the network logon will appear to
4836 come from there rather than from the users workstation.
4839 See also the \fIsecurity
4843 Default: \fBpassword server = <empty string>\fR
4846 Example: \fBpassword server = NT-PDC, NT-BDC1, NT-BDC2
4849 Example: \fBpassword server = *\fR
4853 This parameter specifies a directory to which
4854 the user of the service is to be given access. In the case of
4855 printable services, this is where print data will spool prior to
4856 being submitted to the host for printing.
4858 For a printable service offering guest access, the service
4859 should be readonly and the path should be world-writeable and
4860 have the sticky bit set. This is not mandatory of course, but
4861 you probably won't get the results you expect if you do
4864 Any occurrences of \fI%u\fR in the path
4865 will be replaced with the UNIX username that the client is using
4866 on this connection. Any occurrences of \fI%m\fR
4867 will be replaced by the NetBIOS name of the machine they are
4868 connecting from. These replacements are very useful for setting
4869 up pseudo home directories for users.
4871 Note that this path will be based on \fIroot dir\fR if one was specified.
4875 Example: \fBpath = /home/fred\fR
4877 \fBposix locking (S)\fR
4879 daemon maintains an database of file locks obtained by SMB clients.
4880 The default behavior is to map this internal database to POSIX
4881 locks. This means that file locks obtained by SMB clients are
4882 consistent with those seen by POSIX compliant applications accessing
4883 the files via a non-SMB method (e.g. NFS or local file access).
4884 You should never need to disable this parameter.
4886 Default: \fBposix locking = yes\fR
4889 This option specifies a command to be run
4890 whenever the service is disconnected. It takes the usual
4891 substitutions. The command may be run as the root on some
4894 An interesting example may be do unmount server
4897 \fBpostexec = /etc/umount /cdrom\fR
4899 See also \fIpreexec\fR
4902 Default: \fBnone (no command executed)\fR
4904 Example: \fBpostexec = echo \\"%u disconnected from %S
4905 from %m (%I)\\" >> /tmp/log\fR
4907 \fBpostscript (S)\fR
4908 This parameter forces a printer to interpret
4909 the print files as postscript. This is done by adding a %!
4910 to the start of print output.
4912 This is most useful when you have lots of PCs that persist
4913 in putting a control-D at the start of print jobs, which then
4914 confuses your printer.
4916 Default: \fBpostscript = no\fR
4919 This option specifies a command to be run whenever
4920 the service is connected to. It takes the usual substitutions.
4922 An interesting example is to send the users a welcome
4923 message every time they log in. Maybe a message of the day? Here
4926 \fBpreexec = csh -c 'echo \\"Welcome to %S!\\" |
4927 /usr/local/samba/bin/smbclient -M %m -I %I' & \fR
4929 Of course, this could get annoying after a while :-)
4931 See also \fIpreexec close
4935 Default: \fBnone (no command executed)\fR
4937 Example: \fBpreexec = echo \\"%u connected to %S from %m
4938 (%I)\\" >> /tmp/log\fR
4940 \fBpreexec close (S)\fR
4941 This boolean option controls whether a non-zero
4942 return code from \fIpreexec
4943 \fRshould close the service being connected to.
4945 Default: \fBpreexec close = no\fR
4947 \fBpreferred master (G)\fR
4948 This boolean parameter controls if nmbd(8)is a preferred master browser
4951 If this is set to true, on startup, \fBnmbd\fR
4952 will force an election, and it will have a slight advantage in
4953 winning the election. It is recommended that this parameter is
4954 used in conjunction with \fB\fI domain master\fB = yes\fR, so that \fB nmbd\fR can guarantee becoming a domain master.
4956 Use this option with caution, because if there are several
4957 hosts (whether Samba servers, Windows 95 or NT) that are preferred
4958 master browsers on the same subnet, they will each periodically
4959 and continuously attempt to become the local master browser.
4960 This will result in unnecessary broadcast traffic and reduced browsing
4963 See also \fIos level\fR
4966 Default: \fBpreferred master = auto\fR
4968 \fBprefered master (G)\fR
4969 Synonym for \fI preferred master\fR for people who cannot spell :-).
4972 This is a list of services that you want to be
4973 automatically added to the browse lists. This is most useful
4974 for homes and printers services that would otherwise not be
4977 Note that if you just want all printers in your
4978 printcap file loaded then the \fIload printers\fR option is easier.
4980 Default: \fBno preloaded services\fR
4982 Example: \fBpreload = fred lp colorlp\fR
4984 \fBpreserve case (S)\fR
4985 This controls if new filenames are created
4986 with the case that the client passes, or if they are forced to
4987 be the \fIdefault case
4990 Default: \fBpreserve case = yes\fR
4992 See the section on NAME
4993 MANGLING for a fuller discussion.
4995 \fBprint command (S)\fR
4996 After a print job has finished spooling to
4997 a service, this command will be used via a \fBsystem()\fR
4998 call to process the spool file. Typically the command specified will
4999 submit the spool file to the host's printing subsystem, but there
5000 is no requirement that this be the case. The server will not remove
5001 the spool file, so whatever command you specify should remove the
5002 spool file when it has been processed, otherwise you will need to
5003 manually remove old spool files.
5005 The print command is simply a text string. It will be used
5006 verbatim, with two exceptions: All occurrences of \fI%s
5007 \fRand \fI%f\fR will be replaced by the
5008 appropriate spool file name, and all occurrences of \fI%p
5009 \fRwill be replaced by the appropriate printer name. The
5010 spool file name is generated automatically by the server, the printer
5011 name is discussed below.
5013 The print command \fBMUST\fR contain at least
5014 one occurrence of \fI%s\fR or \fI%f
5015 \fR- the \fI%p\fR is optional. At the time
5016 a job is submitted, if no printer name is supplied the \fI%p
5017 \fRwill be silently removed from the printer command.
5019 If specified in the [global] section, the print command given
5020 will be used for any printable service that does not have its own
5021 print command specified.
5023 If there is neither a specified print command for a
5024 printable service nor a global print command, spool files will
5025 be created but not processed and (most importantly) not removed.
5027 Note that printing may fail on some UNIXes from the
5028 nobody account. If this happens then create
5029 an alternative guest account that can print and set the \fIguest account\fR
5030 in the [global] section.
5032 You can form quite complex print commands by realizing
5033 that they are just passed to a shell. For example the following
5034 will log a print job, print the file, then remove it. Note that
5035 \&';' is the usual separator for command in shell scripts.
5037 \fBprint command = echo Printing %s >>
5038 /tmp/print.log; lpr -P %p %s; rm %s\fR
5040 You may have to vary this command considerably depending
5041 on how you normally print files on your system. The default for
5042 the parameter varies depending on the setting of the \fIprinting\fR parameter.
5044 Default: For \fBprinting= BSD, AIX, QNX, LPRNG
5047 \fBprint command = lpr -r -P%p %s\fR
5049 For \fBprinting= SYS or HPUX :\fR
5051 \fBprint command = lp -c -d%p %s; rm %s\fR
5053 For \fBprinting=SOFTQ :\fR
5055 \fBprint command = lp -d%p -s %s; rm %s\fR
5057 Example: \fBprint command = /usr/local/samba/bin/myprintscript
5061 Synonym for \fIprintable\fR.
5064 If this parameter is yes, then
5065 clients may open, write to and submit spool files on the directory
5066 specified for the service.
5068 Note that a printable service will ALWAYS allow writing
5069 to the service path (user privileges permitting) via the spooling
5070 of print data. The \fIwriteable
5071 \fRparameter controls only non-printing access to
5074 Default: \fBprintable = no\fR
5077 Synonym for \fI printcap name\fR.
5079 \fBprintcap name (G)\fR
5080 This parameter may be used to override the
5081 compiled-in default printcap name used by the server (usually \fI /etc/printcap\fR). See the discussion of the [printers] section above for reasons
5082 why you might want to do this.
5084 On System V systems that use \fBlpstat\fR to
5085 list available printers you can use \fBprintcap name = lpstat
5086 \fRto automatically obtain lists of available printers. This
5087 is the default for systems that define SYSV at configure time in
5088 Samba (this includes most System V based systems). If \fI printcap name\fR is set to \fBlpstat\fR on
5089 these systems then Samba will launch \fBlpstat -v\fR and
5090 attempt to parse the output to obtain a printer list.
5092 A minimal printcap file would look something like this:
5105 where the '|' separates aliases of a printer. The fact
5106 that the second alias has a space in it gives a hint to Samba
5107 that it's a comment.
5109 \fBNOTE\fR: Under AIX the default printcap
5110 name is \fI/etc/qconfig\fR. Samba will assume the
5111 file is in AIX \fIqconfig\fR format if the string
5112 \fIqconfig\fR appears in the printcap filename.
5114 Default: \fBprintcap name = /etc/printcap\fR
5116 Example: \fBprintcap name = /etc/myprintcap\fR
5118 \fBprinter admin (S)\fR
5119 This is a list of users that can do anything to
5120 printers via the remote administration interfaces offered by MS-RPC
5121 (usually using a NT workstation). Note that the root user always
5124 Default: \fBprinter admin = <empty string>\fR
5126 Example: \fBprinter admin = admin, @staff\fR
5128 \fBprinter driver (S)\fR
5129 \fBNote :\fRThis is a depreciated
5130 parameter and will be removed in the next major release
5131 following version 2.2. Please see the instructions in
5132 \fIPRINTER_DRIVER2.txt\fR in the \fIdocs
5133 \fRof the Samba distribution for more information
5134 on the new method of loading printer drivers onto a Samba server.
5136 This option allows you to control the string
5137 that clients receive when they ask the server for the printer driver
5138 associated with a printer. If you are using Windows95 or Windows NT
5139 then you can use this to automate the setup of printers on your
5142 You need to set this parameter to the exact string (case
5143 sensitive) that describes the appropriate printer driver for your
5144 system. If you don't know the exact string to use then you should
5145 first try with no \fI printer driver\fR option set and the client will
5146 give you a list of printer drivers. The appropriate strings are
5147 shown in a scroll box after you have chosen the printer manufacturer.
5152 Example: \fBprinter driver = HP LaserJet 4L\fR
5154 \fBprinter driver file (G)\fR
5155 \fBNote :\fRThis is a depreciated
5156 parameter and will be removed in the next major release
5157 following version 2.2. Please see the instructions in
5158 \fIPRINTER_DRIVER2.txt\fR in the \fIdocs
5159 \fRof the Samba distribution for more information
5160 on the new method of loading printer drivers onto a Samba server.
5162 This parameter tells Samba where the printer driver
5163 definition file, used when serving drivers to Windows 95 clients, is
5164 to be found. If this is not set, the default is :
5166 \fISAMBA_INSTALL_DIRECTORY
5167 /lib/printers.def\fR
5169 This file is created from Windows 95 \fImsprint.inf
5170 \fRfiles found on the Windows 95 client system. For more
5171 details on setting up serving of printer drivers to Windows 95
5172 clients, see the documentation file in the \fIdocs/\fR
5173 directory, \fIPRINTER_DRIVER.txt\fR.
5175 See also \fI printer driver location\fR.
5177 Default: \fBNone (set in compile).\fR
5179 Example: \fBprinter driver file =
5180 /usr/local/samba/printers/drivers.def\fR
5182 \fBprinter driver location (S)\fR
5183 \fBNote :\fRThis is a depreciated
5184 parameter and will be removed in the next major release
5185 following version 2.2. Please see the instructions in
5186 \fIPRINTER_DRIVER2.txt\fR in the \fIdocs
5187 \fRof the Samba distribution for more information
5188 on the new method of loading printer drivers onto a Samba server.
5190 This parameter tells clients of a particular printer
5191 share where to find the printer driver files for the automatic
5192 installation of drivers for Windows 95 machines. If Samba is set up
5193 to serve printer drivers to Windows 95 machines, this should be set to
5195 \fB\\\\MACHINE\\PRINTER$\fR
5197 Where MACHINE is the NetBIOS name of your Samba server,
5198 and PRINTER$ is a share you set up for serving printer driver
5199 files. For more details on setting this up see the documentation
5200 file in the \fIdocs/\fR directory, \fI PRINTER_DRIVER.txt\fR.
5202 See also \fI printer driver file\fR.
5206 Example: \fBprinter driver location = \\\\MACHINE\\PRINTER$
5208 \fBprinter name (S)\fR
5209 This parameter specifies the name of the printer
5210 to which print jobs spooled through a printable service will be sent.
5212 If specified in the [global] section, the printer
5213 name given will be used for any printable service that does
5214 not have its own printer name specified.
5216 Default: \fBnone (but may be lp
5219 Example: \fBprinter name = laserwriter\fR
5222 Synonym for \fI printer name\fR.
5225 This parameters controls how printer status
5226 information is interpreted on your system. It also affects the
5227 default values for the \fIprint command\fR,
5228 \fIlpq command\fR, \fIlppause command
5229 \fR, \fIlpresume command\fR, and
5230 \fIlprm command\fR if specified in the
5233 Currently eight printing styles are supported. They are
5240 To see what the defaults are for the other print
5241 commands when using the various options use the testparm(1)program.
5243 This option can be set on a per printer basis
5245 See also the discussion in the [printers] section.
5248 Synonym for \fImax protocol\fR.
5251 Synonym for \fIguest
5254 \fBqueuepause command (S)\fR
5255 This parameter specifies the command to be
5256 executed on the server host in order to pause the printerqueue.
5258 This command should be a program or script which takes
5259 a printer name as its only parameter and stops the printerqueue,
5260 such that no longer jobs are submitted to the printer.
5262 This command is not supported by Windows for Workgroups,
5263 but can be issued from the Printer's window under Windows 95
5266 If a \fI%p\fR is given then the printername
5267 is put in its place. Otherwise it is placed at the end of the command.
5269 Note that it is good practice to include the absolute
5270 path in the command as the PATH may not be available to the
5273 Default: \fBdepends on the setting of \fIprinting
5275 Example: \fBqueuepause command = disable %p\fR
5277 \fBqueueresume command (S)\fR
5278 This parameter specifies the command to be
5279 executed on the server host in order to resume the printerqueue. It
5280 is the command to undo the behavior that is caused by the
5281 previous parameter (\fI queuepause command\fR).
5283 This command should be a program or script which takes
5284 a printer name as its only parameter and resumes the printerqueue,
5285 such that queued jobs are resubmitted to the printer.
5287 This command is not supported by Windows for Workgroups,
5288 but can be issued from the Printer's window under Windows 95
5291 If a \fI%p\fR is given then the printername
5292 is put in its place. Otherwise it is placed at the end of the
5295 Note that it is good practice to include the absolute
5296 path in the command as the PATH may not be available to the
5299 Default: \fBdepends on the setting of \fIprinting\fB\fR
5301 Example: \fBqueuepause command = enable %p
5304 This boolean parameter controls whether smbd(8)will support the "Read
5305 Block Multiplex" SMB. This is now rarely used and defaults to
5306 no. You should never need to set this
5309 Default: \fBread bmpx = no\fR
5312 This is a list of users that are given read-only
5313 access to a service. If the connecting user is in this list then
5314 they will not be given write access, no matter what the \fIwriteable\fR
5315 option is set to. The list can include group names using the
5316 syntax described in the \fI invalid users\fR parameter.
5318 See also the \fI write list\fR parameter and the \fIinvalid users\fR
5321 Default: \fBread list = <empty string>\fR
5323 Example: \fBread list = mary, @students\fR
5326 Note that this is an inverted synonym for \fIwriteable\fR.
5329 This parameter controls whether or not the server
5330 will support the raw read SMB requests when transferring data
5333 If enabled, raw reads allow reads of 65535 bytes in
5334 one packet. This typically provides a major performance benefit.
5336 However, some clients either negotiate the allowable
5337 block size incorrectly or are incapable of supporting larger block
5338 sizes, and for these clients you may need to disable raw reads.
5340 In general this parameter should be viewed as a system tuning
5341 tool and left severely alone. See also \fIwrite raw\fR.
5343 Default: \fBread raw = yes\fR
5346 The option \fIread size\fR
5347 affects the overlap of disk reads/writes with network reads/writes.
5348 If the amount of data being transferred in several of the SMB
5349 commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger
5350 than this value then the server begins writing the data before it
5351 has received the whole packet from the network, or in the case of
5352 SMBreadbraw, it begins writing to the network before all the data
5353 has been read from disk.
5355 This overlapping works best when the speeds of disk and
5356 network access are similar, having very little effect when the
5357 speed of one is much greater than the other.
5359 The default value is 16384, but very little experimentation
5360 has been done yet to determine the optimal value, and it is likely
5361 that the best value will vary greatly between systems anyway.
5362 A value over 65536 is pointless and will cause you to allocate
5363 memory unnecessarily.
5365 Default: \fBread size = 16384\fR
5367 Example: \fBread size = 8192\fR
5369 \fBremote announce (G)\fR
5370 This option allows you to setup nmbd(8)to periodically announce itself
5371 to arbitrary IP addresses with an arbitrary workgroup name.
5373 This is useful if you want your Samba server to appear
5374 in a remote workgroup for which the normal browse propagation
5375 rules don't work. The remote workgroup can be anywhere that you
5376 can send IP packets to.
5380 \fBremote announce = 192.168.2.255/SERVERS
5381 192.168.4.255/STAFF\fR
5383 the above line would cause nmbd to announce itself
5384 to the two given IP addresses using the given workgroup names.
5385 If you leave out the workgroup name then the one given in
5387 parameter is used instead.
5389 The IP addresses you choose would normally be the broadcast
5390 addresses of the remote networks, but can also be the IP addresses
5391 of known browse masters if your network config is that stable.
5393 See the documentation file \fIBROWSING.txt\fR
5394 in the \fIdocs/\fR directory.
5396 Default: \fBremote announce = <empty string>
5398 \fBremote browse sync (G)\fR
5399 This option allows you to setup nmbd(8)to periodically request
5400 synchronization of browse lists with the master browser of a samba
5401 server that is on a remote segment. This option will allow you to
5402 gain browse lists for multiple workgroups across routed networks. This
5403 is done in a manner that does not work with any non-samba servers.
5405 This is useful if you want your Samba server and all local
5406 clients to appear in a remote workgroup for which the normal browse
5407 propagation rules don't work. The remote workgroup can be anywhere
5408 that you can send IP packets to.
5412 \fBremote browse sync = 192.168.2.255 192.168.4.255
5414 the above line would cause \fBnmbd\fR to request
5415 the master browser on the specified subnets or addresses to
5416 synchronize their browse lists with the local server.
5418 The IP addresses you choose would normally be the broadcast
5419 addresses of the remote networks, but can also be the IP addresses
5420 of known browse masters if your network config is that stable. If
5421 a machine IP address is given Samba makes NO attempt to validate
5422 that the remote machine is available, is listening, nor that it
5423 is in fact the browse master on it's segment.
5425 Default: \fBremote browse sync = <empty string>
5427 \fBrestrict acl with mask (S)\fR
5428 This is a boolean parameter. If set to false (default), then
5429 Creation of files with access control lists (ACLS) and modification of ACLs
5430 using the Windows NT/2000 ACL editor will be applied directly to the file
5433 If set to True, then all requests to set an ACL on a file will have the
5434 parameters \fIcreate mask\fR,
5435 \fIforce create mode\fR
5436 applied before setting the ACL, and all requests to set an ACL on a directory will
5437 have the parameters \fIdirectory
5439 directory mode\fR applied before setting the ACL.
5441 See also \fIcreate mask\fR,
5442 \fIforce create mode\fR,
5443 \fIdirectory mask\fR,
5444 \fIforce directory mode\fR
5446 Default: \fBrestrict acl with mask = no\fR
5448 \fBrestrict anonymous (G)\fR
5449 This is a boolean parameter. If it is true, then
5450 anonymous access to the server will be restricted, namely in the
5451 case where the server is expecting the client to send a username,
5452 but it doesn't. Setting it to true will force these anonymous
5453 connections to be denied, and the client will be required to always
5454 supply a username and password when connecting. Use of this parameter
5455 is only recommended for homogeneous NT client environments.
5457 This parameter makes the use of macro expansions that rely
5458 on the username (%U, %G, etc) consistent. NT 4.0
5459 likes to use anonymous connections when refreshing the share list,
5460 and this is a way to work around that.
5462 When restrict anonymous is true, all anonymous connections
5463 are denied no matter what they are for. This can effect the ability
5464 of a machine to access the samba Primary Domain Controller to revalidate
5465 it's machine account after someone else has logged on the client
5466 interactively. The NT client will display a message saying that
5467 the machine's account in the domain doesn't exist or the password is
5468 bad. The best way to deal with this is to reboot NT client machines
5469 between interactive logons, using "Shutdown and Restart", rather
5470 than "Close all programs and logon as a different user".
5472 Default: \fBrestrict anonymous = no\fR
5475 Synonym for \fIroot directory"\fR.
5478 Synonym for \fIroot directory"\fR.
5480 \fBroot directory (G)\fR
5481 The server will \fBchroot()\fR (i.e.
5482 Change it's root directory) to this directory on startup. This is
5483 not strictly necessary for secure operation. Even without it the
5484 server will deny access to files not in one of the service entries.
5485 It may also check for, and deny access to, soft links to other
5486 parts of the filesystem, or attempts to use ".." in file names
5487 to access other directories (depending on the setting of the \fIwide links\fR
5490 Adding a \fIroot directory\fR entry other
5491 than "/" adds an extra level of security, but at a price. It
5492 absolutely ensures that no access is given to files not in the
5493 sub-tree specified in the \fIroot directory\fR
5494 option, \fBincluding\fR some files needed for
5495 complete operation of the server. To maintain full operability
5496 of the server you will need to mirror some system files
5497 into the \fIroot directory\fR tree. In particular
5498 you will need to mirror \fI/etc/passwd\fR (or a
5499 subset of it), and any binaries or configuration files needed for
5500 printing (if required). The set of files that must be mirrored is
5501 operating system dependent.
5503 Default: \fBroot directory = /\fR
5505 Example: \fBroot directory = /homes/smb\fR
5507 \fBroot postexec (S)\fR
5508 This is the same as the \fIpostexec\fR
5509 parameter except that the command is run as root. This
5510 is useful for unmounting filesystems
5511 (such as cdroms) after a connection is closed.
5513 See also \fI postexec\fR.
5515 Default: \fBroot postexec = <empty string>
5517 \fBroot preexec (S)\fR
5518 This is the same as the \fIpreexec\fR
5519 parameter except that the command is run as root. This
5520 is useful for mounting filesystems (such as cdroms) after a
5521 connection is closed.
5523 See also \fI preexec\fR and \fIpreexec close\fR.
5525 Default: \fBroot preexec = <empty string>
5527 \fBroot preexec close (S)\fR
5528 This is the same as the \fIpreexec close
5529 \fRparameter except that the command is run as root.
5531 See also \fI preexec\fR and \fIpreexec close\fR.
5533 Default: \fBroot preexec close = no\fR
5536 This option affects how clients respond to
5537 Samba and is one of the most important settings in the \fI smb.conf\fR file.
5539 The option sets the "security mode bit" in replies to
5540 protocol negotiations with smbd(8)
5541 to turn share level security on or off. Clients decide
5542 based on this bit whether (and how) to transfer user and password
5543 information to the server.
5545 The default is \fBsecurity = user\fR, as this is
5546 the most common setting needed when talking to Windows 98 and
5549 The alternatives are \fBsecurity = share\fR,
5550 \fBsecurity = server\fR or \fBsecurity=domain
5553 In versions of Samba prior to 2..0, the default was
5554 \fBsecurity = share\fR mainly because that was
5555 the only option at one stage.
5557 There is a bug in WfWg that has relevance to this
5558 setting. When in user or server level security a WfWg client
5559 will totally ignore the password you type in the "connect
5560 drive" dialog box. This makes it very difficult (if not impossible)
5561 to connect to a Samba service as anyone except the user that
5562 you are logged into WfWg as.
5564 If your PCs use usernames that are the same as their
5565 usernames on the UNIX machine then you will want to use
5566 \fBsecurity = user\fR. If you mostly use usernames
5567 that don't exist on the UNIX box then use \fBsecurity =
5570 You should also use \fBsecurity = share\fR if you
5571 want to mainly setup shares without a password (guest shares). This
5572 is commonly used for a shared printer server. It is more difficult
5573 to setup guest shares with \fBsecurity = user\fR, see
5574 the \fImap to guest\fR
5575 parameter for details.
5577 It is possible to use \fBsmbd\fR in a \fB hybrid mode\fR where it is offers both user and share
5578 level security under different \fINetBIOS aliases\fR.
5580 The different settings will now be explained.
5584 When clients connect to a share level security server then
5585 need not log onto the server with a valid username and password before
5586 attempting to connect to a shared resource (although modern clients
5587 such as Windows 95/98 and Windows NT will send a logon request with
5588 a username but no password when talking to a \fBsecurity = share
5589 \fRserver). Instead, the clients send authentication information
5590 (passwords) on a per-share basis, at the time they attempt to connect
5593 Note that \fBsmbd\fR \fBALWAYS\fR
5594 uses a valid UNIX user to act on behalf of the client, even in
5595 \fBsecurity = share\fR level security.
5597 As clients are not required to send a username to the server
5598 in share level security, \fBsmbd\fR uses several
5599 techniques to determine the correct UNIX user to use on behalf
5602 A list of possible UNIX usernames to match with the given
5603 client password is constructed using the following methods :
5608 only\fR parameter is set, then all the other
5609 stages are missed and only the \fIguest account\fR username is checked.
5612 Is a username is sent with the share connection
5613 request, then this username (after mapping - see \fIusername map\fR),
5614 is added as a potential username.
5617 If the client did a previous \fBlogon
5618 \fRrequest (the SessionSetup SMB call) then the
5619 username sent in this SMB will be added as a potential username.
5622 The name of the service the client requested is
5623 added as a potential username.
5626 The NetBIOS name of the client is added to
5627 the list as a potential username.
5630 Any users on the \fI user\fR list are added as potential usernames.
5633 If the \fIguest only\fR parameter is
5634 not set, then this list is then tried with the supplied password.
5635 The first user for whom the password matches will be used as the
5639 If the \fIguest only\fR parameter is
5640 set, or no username can be determined then if the share is marked
5641 as available to the \fIguest account\fR, then this
5642 guest user will be used, otherwise access is denied.
5645 Note that it can be \fBvery\fR confusing
5646 in share-level security as to which UNIX username will eventually
5647 be used in granting access.
5650 See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
5656 This is the default security setting in Samba 2.2.
5657 With user-level security a client must first "log=on" with a
5658 valid username and password (which can be mapped using the \fIusername map\fR
5659 parameter). Encrypted passwords (see the \fIencrypted passwords\fR parameter) can also
5660 be used in this security mode. Parameters such as \fIuser\fR and \fIguest only\fR if set are then applied and
5661 may change the UNIX user to use on this connection, but only after
5662 the user has been successfully authenticated.
5665 \fBNote\fR that the name of the resource being
5666 requested is \fBnot\fR sent to the server until after
5667 the server has successfully authenticated the client. This is why
5668 guest shares don't work in user level security without allowing
5669 the server to automatically map unknown users into the \fIguest account\fR.
5670 See the \fImap to guest\fR
5671 parameter for details on doing this.
5674 See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
5677 \fBSECURITY = SERVER
5680 In this mode Samba will try to validate the username/password
5681 by passing it to another SMB server, such as an NT box. If this
5682 fails it will revert to \fBsecurity = user\fR, but note
5683 that if encrypted passwords have been negotiated then Samba cannot
5684 revert back to checking the UNIX password file, it must have a valid
5685 \fIsmbpasswd\fR file to check users against. See the
5686 documentation file in the \fIdocs/\fR directory
5687 \fIENCRYPTION.txt\fR for details on how to set this
5691 \fBNote\fR that from the clients point of
5692 view \fBsecurity = server\fR is the same as \fB security = user\fR. It only affects how the server deals
5693 with the authentication, it does not in any way affect what the
5697 \fBNote\fR that the name of the resource being
5698 requested is \fBnot\fR sent to the server until after
5699 the server has successfully authenticated the client. This is why
5700 guest shares don't work in user level security without allowing
5701 the server to automatically map unknown users into the \fIguest account\fR.
5702 See the \fImap to guest\fR
5703 parameter for details on doing this.
5706 See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
5709 See also the \fIpassword
5710 server\fR parameter and the \fIencrypted passwords\fR
5714 \fBSECURITY = DOMAIN
5717 This mode will only work correctly if smbpasswd(8)has been used to add this
5718 machine into a Windows NT Domain. It expects the \fIencrypted passwords\fR
5719 parameter to be set to true. In this
5720 mode Samba will try to validate the username/password by passing
5721 it to a Windows NT Primary or Backup Domain Controller, in exactly
5722 the same way that a Windows NT Server would do.
5725 \fBNote\fR that a valid UNIX user must still
5726 exist as well as the account on the Domain Controller to allow
5727 Samba to have a valid UNIX account to map file access to.
5730 \fBNote\fR that from the clients point
5731 of view \fBsecurity = domain\fR is the same as \fBsecurity = user
5732 \fR\&. It only affects how the server deals with the authentication,
5733 it does not in any way affect what the client sees.
5736 \fBNote\fR that the name of the resource being
5737 requested is \fBnot\fR sent to the server until after
5738 the server has successfully authenticated the client. This is why
5739 guest shares don't work in user level security without allowing
5740 the server to automatically map unknown users into the \fIguest account\fR.
5741 See the \fImap to guest\fR
5742 parameter for details on doing this.
5745 \fBBUG:\fR There is currently a bug in the
5746 implementation of \fBsecurity = domain\fR with respect
5747 to multi-byte character set usernames. The communication with a
5748 Domain Controller must be done in UNICODE and Samba currently
5749 does not widen multi-byte user names to UNICODE correctly, thus
5750 a multi-byte username will not be recognized correctly at the
5751 Domain Controller. This issue will be addressed in a future release.
5754 See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
5757 See also the \fIpassword
5758 server\fR parameter and the \fIencrypted passwords\fR
5762 Default: \fBsecurity = USER\fR
5765 Example: \fBsecurity = DOMAIN\fR
5768 \fBsecurity mask (S)\fR
5769 This parameter controls what UNIX permission
5770 bits can be modified when a Windows NT client is manipulating
5771 the UNIX permission on a file using the native NT security
5774 This parameter is applied as a mask (AND'ed with) to
5775 the changed permission bits, thus preventing any bits not in
5776 this mask from being modified. Essentially, zero bits in this
5777 mask may be treated as a set of bits the user is not allowed
5780 If not set explicitly this parameter is set to the same
5781 value as the \fIcreate mask
5782 \fRparameter. To allow a user to modify all the
5783 user/group/world permissions on a file, set this parameter to
5786 \fBNote\fR that users who can access the
5787 Samba server through other means can easily bypass this
5788 restriction, so it is primarily useful for standalone
5789 "appliance" systems. Administrators of most normal systems will
5790 probably want to set it to 0777.
5792 See also the \fIforce directory security mode\fR,
5794 security mask\fR, \fIforce security mode\fR parameters.
5796 Default: \fBsecurity mask = <same as create mask>
5798 Example: \fBsecurity mask = 0777\fR
5800 \fBserver string (G)\fR
5801 This controls what string will show up in the
5802 printer comment box in print manager and next to the IPC connection
5803 in \fBnet view"\fR. It can be any string that you wish
5804 to show to your users.
5806 It also sets what will appear in browse lists next
5807 to the machine name.
5809 A \fI%v\fR will be replaced with the Samba
5812 A \fI%h\fR will be replaced with the
5815 Default: \fBserver string = Samba %v\fR
5817 Example: \fBserver string = University of GNUs Samba
5820 \fBset directory (S)\fR
5821 If \fBset directory = no\fR, then
5822 users of the service may not use the setdir command to change
5825 The \fBsetdir\fR command is only implemented
5826 in the Digital Pathworks client. See the Pathworks documentation
5829 Default: \fBset directory = no\fR
5831 \fBshare modes (S)\fR
5832 This enables or disables the honoring of
5833 the \fIshare modes\fR during a file open. These
5834 modes are used by clients to gain exclusive read or write access
5837 These open modes are not directly supported by UNIX, so
5838 they are simulated using shared memory, or lock files if your
5839 UNIX doesn't support shared memory (almost all do).
5841 The share modes that are enabled by this option are
5843 DENY_READ, DENY_WRITE,
5844 DENY_NONE and DENY_FCB.
5846 This option gives full share compatibility and enabled
5849 You should \fBNEVER\fR turn this parameter
5850 off as many Windows applications will break if you do so.
5852 Default: \fBshare modes = yes\fR
5854 \fBshort preserve case (S)\fR
5855 This boolean parameter controls if new files
5856 which conform to 8.3 syntax, that is all in upper case and of
5857 suitable length, are created upper case, or if they are forced
5858 to be the \fIdefault case
5859 \fR\&. This option can be use with \fBpreserve case = yes\fR
5860 to permit long filenames to retain their case, while short
5863 See the section on NAME MANGLING.
5865 Default: \fBshort preserve case = yes\fR
5867 \fBshow add printer wizard (G)\fR
5868 With the introduction of MS-RPC based printing support
5869 for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will
5870 appear on Samba hosts in the share listing. Normally this folder will
5871 contain an icon for the MS Add Printer Wizard (APW). However, it is
5872 possible to disable this feature regardless of the level of privilege
5873 of the connected user.
5875 Under normal circumstances, the Windows NT/2000 client will
5876 open a handle on the printer server with OpenPrinterEx() asking for
5877 Administrator privileges. If the user does not have administrative
5878 access on the print server (i.e is not root or a member of the
5879 \fIprinter admin\fR group), the OpenPrinterEx()
5880 call fails and the clients another open call with a request for
5881 a lower privilege level. This should succeed, however the APW
5882 icon will not be displayed.
5884 Disabling the \fIshow add printer wizard\fR
5885 parameter will always cause the OpenPrinterEx() on the server
5886 to fail. Thus the APW icon will never be displayed. \fB Note :\fRThis does not prevent the same user from having
5887 administrative privilege on an individual printer.
5889 See also \fIaddprinter
5890 command\fR, \fIdeleteprinter command\fR, \fIprinter admin\fR
5892 Default :\fBshow add printer wizard = yes\fR
5894 \fBsmb passwd file (G)\fR
5895 This option sets the path to the encrypted
5896 smbpasswd file. By default the path to the smbpasswd file
5897 is compiled into Samba.
5899 Default: \fBsmb passwd file = ${prefix}/private/smbpasswd
5901 Example: \fBsmb passwd file = /etc/samba/smbpasswd
5903 \fBsocket address (G)\fR
5904 This option allows you to control what
5905 address Samba will listen for connections on. This is used to
5906 support multiple virtual interfaces on the one server, each
5907 with a different configuration.
5909 By default samba will accept connections on any
5912 Example: \fBsocket address = 192.168.2.20\fR
5914 \fBsocket options (G)\fR
5915 This option allows you to set socket options
5916 to be used when talking with the client.
5918 Socket options are controls on the networking layer
5919 of the operating systems which allow the connection to be
5922 This option will typically be used to tune your Samba
5923 server for optimal performance for your local network. There is
5924 no way that Samba can know what the optimal parameters are for
5925 your net, so you must experiment and choose them yourself. We
5926 strongly suggest you read the appropriate documentation for your
5927 operating system first (perhaps \fBman setsockopt\fR
5930 You may find that on some systems Samba will say
5931 "Unknown socket option" when you supply an option. This means you
5932 either incorrectly typed it or you need to add an include file
5933 to includes.h for your OS. If the latter is the case please
5934 send the patch to samba@samba.org <URL:mailto:samba@samba.org>.
5936 Any of the supported socket options may be combined
5937 in any way you like, as long as your OS allows it.
5939 This is the list of socket options currently settable
5974 Those marked with a \fB'*'\fR take an integer
5975 argument. The others can optionally take a 1 or 0 argument to enable
5976 or disable the option, by default they will be enabled if you
5977 don't specify 1 or 0.
5980 To specify an argument use the syntax SOME_OPTION=VALUE
5981 for example \fBSO_SNDBUF=8192\fR. Note that you must
5982 not have any spaces before or after the = sign.
5985 If you are on a local network then a sensible option
5989 \fBsocket options = IPTOS_LOWDELAY\fR
5992 If you have a local network then you could try:
5995 \fBsocket options = IPTOS_LOWDELAY TCP_NODELAY\fR
5998 If you are on a wide area network then perhaps try
5999 setting IPTOS_THROUGHPUT.
6002 Note that several of the options may cause your Samba
6003 server to fail completely. Use these options with caution!
6006 Default: \fBsocket options = TCP_NODELAY\fR
6009 Example: \fBsocket options = IPTOS_LOWDELAY\fR
6012 \fBsource environment (G)\fR
6013 This parameter causes Samba to set environment
6014 variables as per the content of the file named.
6016 If the value of this parameter starts with a "|" character
6017 then Samba will treat that value as a pipe command to open and
6018 will set the environment variables from the output of the pipe.
6020 The contents of the file or the output of the pipe should
6021 be formatted as the output of the standard Unix \fBenv(1)
6022 \fRcommand. This is of the form :
6024 Example environment entry:
6026 \fBSAMBA_NETBIOS_NAME=myhostname\fR
6028 Default: \fBNo default value\fR
6030 Examples: \fBsource environment = |/etc/smb.conf.sh
6032 Example: \fBsource environment =
6033 /usr/local/smb_env_vars\fR
6036 This variable is part of SSL-enabled Samba. This
6037 is only available if the SSL libraries have been compiled on your
6038 system and the configure option \fB--with-ssl\fR was
6039 given at configure time.
6041 \fBNote\fR that for export control reasons
6042 this code is \fBNOT\fR enabled by default in any
6043 current binary version of Samba.
6045 This variable enables or disables the entire SSL mode. If
6046 it is set to no, the SSL enabled samba behaves
6047 exactly like the non-SSL samba. If set to yes,
6048 it depends on the variables \fI ssl hosts\fR and \fIssl hosts resign\fR whether an SSL
6049 connection will be required.
6051 Default: \fBssl=no\fR
6053 \fBssl CA certDir (G)\fR
6054 This variable is part of SSL-enabled Samba. This
6055 is only available if the SSL libraries have been compiled on your
6056 system and the configure option \fB--with-ssl\fR was
6057 given at configure time.
6059 \fBNote\fR that for export control reasons
6060 this code is \fBNOT\fR enabled by default in any
6061 current binary version of Samba.
6063 This variable defines where to look up the Certification
6064 Authorities. The given directory should contain one file for
6065 each CA that samba will trust. The file name must be the hash
6066 value over the "Distinguished Name" of the CA. How this directory
6067 is set up is explained later in this document. All files within the
6068 directory that don't fit into this naming scheme are ignored. You
6069 don't need this variable if you don't verify client certificates.
6071 Default: \fBssl CA certDir = /usr/local/ssl/certs
6073 \fBssl CA certFile (G)\fR
6074 This variable is part of SSL-enabled Samba. This
6075 is only available if the SSL libraries have been compiled on your
6076 system and the configure option \fB--with-ssl\fR was
6077 given at configure time.
6079 \fBNote\fR that for export control reasons
6080 this code is \fBNOT\fR enabled by default in any
6081 current binary version of Samba.
6083 This variable is a second way to define the trusted CAs.
6084 The certificates of the trusted CAs are collected in one big
6085 file and this variable points to the file. You will probably
6086 only use one of the two ways to define your CAs. The first choice is
6087 preferable if you have many CAs or want to be flexible, the second
6088 is preferable if you only have one CA and want to keep things
6089 simple (you won't need to create the hashed file names). You
6090 don't need this variable if you don't verify client certificates.
6092 Default: \fBssl CA certFile = /usr/local/ssl/certs/trustedCAs.pem
6094 \fBssl ciphers (G)\fR
6095 This variable is part of SSL-enabled Samba. This
6096 is only available if the SSL libraries have been compiled on your
6097 system and the configure option \fB--with-ssl\fR was
6098 given at configure time.
6100 \fBNote\fR that for export control reasons
6101 this code is \fBNOT\fR enabled by default in any
6102 current binary version of Samba.
6104 This variable defines the ciphers that should be offered
6105 during SSL negotiation. You should not set this variable unless
6106 you know what you are doing.
6108 \fBssl client cert (G)\fR
6109 This variable is part of SSL-enabled Samba. This
6110 is only available if the SSL libraries have been compiled on your
6111 system and the configure option \fB--with-ssl\fR was
6112 given at configure time.
6114 \fBNote\fR that for export control reasons
6115 this code is \fBNOT\fR enabled by default in any
6116 current binary version of Samba.
6118 The certificate in this file is used by \fBsmbclient(1)\fRif it exists. It's needed
6119 if the server requires a client certificate.
6121 Default: \fBssl client cert = /usr/local/ssl/certs/smbclient.pem
6123 \fBssl client key (G)\fR
6124 This variable is part of SSL-enabled Samba. This
6125 is only available if the SSL libraries have been compiled on your
6126 system and the configure option \fB--with-ssl\fR was
6127 given at configure time.
6129 \fBNote\fR that for export control reasons
6130 this code is \fBNOT\fR enabled by default in any
6131 current binary version of Samba.
6133 This is the private key for \fBsmbclient(1)\fR. It's only needed if the
6134 client should have a certificate.
6136 Default: \fBssl client key = /usr/local/ssl/private/smbclient.pem
6138 \fBssl compatibility (G)\fR
6139 This variable is part of SSL-enabled Samba. This
6140 is only available if the SSL libraries have been compiled on your
6141 system and the configure option \fB--with-ssl\fR was
6142 given at configure time.
6144 \fBNote\fR that for export control reasons
6145 this code is \fBNOT\fR enabled by default in any
6146 current binary version of Samba.
6148 This variable defines whether SSLeay should be configured
6149 for bug compatibility with other SSL implementations. This is
6150 probably not desirable because currently no clients with SSL
6151 implementations other than SSLeay exist.
6153 Default: \fBssl compatibility = no\fR
6156 See \fI ssl hosts resign\fR.
6158 \fBssl hosts resign (G)\fR
6159 This variable is part of SSL-enabled Samba. This
6160 is only available if the SSL libraries have been compiled on your
6161 system and the configure option \fB--with-ssl\fR was
6162 given at configure time.
6164 \fBNote\fR that for export control reasons
6165 this code is \fBNOT\fR enabled by default in any
6166 current binary version of Samba.
6168 These two variables define whether samba will go
6169 into SSL mode or not. If none of them is defined, samba will
6170 allow only SSL connections. If the \fIssl hosts\fR variable lists
6171 hosts (by IP-address, IP-address range, net group or name),
6172 only these hosts will be forced into SSL mode. If the \fI ssl hosts resign\fR variable lists hosts, only these
6173 hosts will NOT be forced into SSL mode. The syntax for these two
6174 variables is the same as for the \fI hosts allow\fR and \fIhosts deny\fR pair of variables, only
6175 that the subject of the decision is different: It's not the access
6176 right but whether SSL is used or not.
6178 The example below requires SSL connections from all hosts
6179 outside the local net (which is 192.168.*.*).
6181 Default: \fBssl hosts = <empty string>\fR
6183 \fBssl hosts resign = <empty string>\fR
6185 Example: \fBssl hosts resign = 192.168.\fR
6187 \fBssl require clientcert (G)\fR
6188 This variable is part of SSL-enabled Samba. This
6189 is only available if the SSL libraries have been compiled on your
6190 system and the configure option \fB--with-ssl\fR was
6191 given at configure time.
6193 \fBNote\fR that for export control reasons
6194 this code is \fBNOT\fR enabled by default in any
6195 current binary version of Samba.
6197 If this variable is set to yes, the
6198 server will not tolerate connections from clients that don't
6199 have a valid certificate. The directory/file given in \fIssl CA certDir\fR
6200 and \fIssl CA certFile
6201 \fRwill be used to look up the CAs that issued
6202 the client's certificate. If the certificate can't be verified
6203 positively, the connection will be terminated. If this variable
6204 is set to no, clients don't need certificates.
6205 Contrary to web applications you really \fBshould\fR
6206 require client certificates. In the web environment the client's
6207 data is sensitive (credit card numbers) and the server must prove
6208 to be trustworthy. In a file server environment the server's data
6209 will be sensitive and the clients must prove to be trustworthy.
6211 Default: \fBssl require clientcert = no\fR
6213 \fBssl require servercert (G)\fR
6214 This variable is part of SSL-enabled Samba. This
6215 is only available if the SSL libraries have been compiled on your
6216 system and the configure option \fB--with-ssl\fR was
6217 given at configure time.
6219 \fBNote\fR that for export control reasons
6220 this code is \fBNOT\fR enabled by default in any
6221 current binary version of Samba.
6223 If this variable is set to yes, the
6225 will request a certificate from the server. Same as
6227 clientcert\fR for the server.
6229 Default: \fBssl require servercert = no\fR
6231 \fBssl server cert (G)\fR
6232 This variable is part of SSL-enabled Samba. This
6233 is only available if the SSL libraries have been compiled on your
6234 system and the configure option \fB--with-ssl\fR was
6235 given at configure time.
6237 \fBNote\fR that for export control reasons
6238 this code is \fBNOT\fR enabled by default in any
6239 current binary version of Samba.
6241 This is the file containing the server's certificate.
6242 The server \fBmust\fR have a certificate. The
6243 file may also contain the server's private key. See later for
6244 how certificates and private keys are created.
6246 Default: \fBssl server cert = <empty string>
6248 \fBssl server key (G)\fR
6249 This variable is part of SSL-enabled Samba. This
6250 is only available if the SSL libraries have been compiled on your
6251 system and the configure option \fB--with-ssl\fR was
6252 given at configure time.
6254 \fBNote\fR that for export control reasons
6255 this code is \fBNOT\fR enabled by default in any
6256 current binary version of Samba.
6258 This file contains the private key of the server. If
6259 this variable is not defined, the key is looked up in the
6260 certificate file (it may be appended to the certificate).
6261 The server \fBmust\fR have a private key
6262 and the certificate \fBmust\fR
6263 match this private key.
6265 Default: \fBssl server key = <empty string>
6267 \fBssl version (G)\fR
6268 This variable is part of SSL-enabled Samba. This
6269 is only available if the SSL libraries have been compiled on your
6270 system and the configure option \fB--with-ssl\fR was
6271 given at configure time.
6273 \fBNote\fR that for export control reasons
6274 this code is \fBNOT\fR enabled by default in any
6275 current binary version of Samba.
6277 This enumeration variable defines the versions of the
6278 SSL protocol that will be used. ssl2or3 allows
6279 dynamic negotiation of SSL v2 or v3, ssl2 results
6280 in SSL v2, ssl3 results in SSL v3 and
6281 tls1 results in TLS v1. TLS (Transport Layer
6282 Security) is the new standard for SSL.
6284 Default: \fBssl version = "ssl2or3"\fR
6286 \fBstat cache (G)\fR
6287 This parameter determines if smbd(8)will use a cache in order to
6288 speed up case insensitive name mappings. You should never need
6289 to change this parameter.
6291 Default: \fBstat cache = yes\fR
6293 \fBstat cache size (G)\fR
6294 This parameter determines the number of
6295 entries in the \fIstat cache\fR. You should
6296 never need to change this parameter.
6298 Default: \fBstat cache size = 50\fR
6301 This enables or disables logging of connections
6302 to a status file that smbstatus(1)
6305 With this disabled \fBsmbstatus\fR won't be able
6306 to tell you what connections are active. You should never need to
6307 change this parameter.
6309 Default: \fBstatus = yes\fR
6311 \fBstrict locking (S)\fR
6312 This is a boolean that controls the handling of
6313 file locking in the server. When this is set to yes
6314 the server will check every read and write access for file locks, and
6315 deny access if locks exist. This can be slow on some systems.
6317 When strict locking is no the server does file
6318 lock checks only when the client explicitly asks for them.
6320 Well behaved clients always ask for lock checks when it
6321 is important, so in the vast majority of cases \fBstrict
6322 locking = no\fR is preferable.
6324 Default: \fBstrict locking = no\fR
6326 \fBstrict sync (S)\fR
6327 Many Windows applications (including the Windows
6328 98 explorer shell) seem to confuse flushing buffer contents to
6329 disk with doing a sync to disk. Under UNIX, a sync call forces
6330 the process to be suspended until the kernel has ensured that
6331 all outstanding data in kernel disk buffers has been safely stored
6332 onto stable storage. This is very slow and should only be done
6333 rarely. Setting this parameter to no (the
6334 default) means that smbd ignores the Windows applications requests for
6335 a sync call. There is only a possibility of losing data if the
6336 operating system itself that Samba is running on crashes, so there is
6337 little danger in this default setting. In addition, this fixes many
6338 performance problems that people have reported with the new Windows98
6339 explorer shell file copies.
6341 See also the \fIsync
6342 always>\fR parameter.
6344 Default: \fBstrict sync = no\fR
6347 This is a boolean that controls whether to
6348 strip trailing dots off UNIX filenames. This helps with some
6349 CDROMs that have filenames ending in a single dot.
6351 Default: \fBstrip dot = no\fR
6353 \fBsync always (S)\fR
6354 This is a boolean parameter that controls
6355 whether writes will always be written to stable storage before
6356 the write call returns. If this is false then the server will be
6357 guided by the client's request in each write call (clients can
6358 set a bit indicating that a particular write should be synchronous).
6359 If this is true then every write will be followed by a \fBfsync()
6360 \fRcall to ensure the data is written to disk. Note that
6361 the \fIstrict sync\fR parameter must be set to
6362 yes in order for this parameter to have
6365 See also the \fIstrict
6368 Default: \fBsync always = no\fR
6371 This parameter maps how Samba debug messages
6372 are logged onto the system syslog logging levels. Samba debug
6373 level zero maps onto syslog LOG_ERR, debug
6374 level one maps onto LOG_WARNING, debug level
6375 two maps onto LOG_NOTICE, debug level three
6376 maps onto LOG_INFO. All higher levels are mapped to LOG_DEBUG.
6378 This parameter sets the threshold for sending messages
6379 to syslog. Only messages with debug level less than this value
6380 will be sent to syslog.
6382 Default: \fBsyslog = 1\fR
6384 \fBsyslog only (G)\fR
6385 If this parameter is set then Samba debug
6386 messages are logged into the system syslog only, and not to
6387 the debug log files.
6389 Default: \fBsyslog only = no\fR
6391 \fBtemplate homedir (G)\fR
6392 \fBNOTE:\fR this parameter is
6393 only available in Samba 3.0.
6395 When filling out the user information for a Windows NT
6396 user, the winbindd(8)daemon
6397 uses this parameter to fill in the home directory for that user.
6398 If the string \fI%D\fR is present it is substituted
6399 with the user's Windows NT domain name. If the string \fI%U
6400 \fRis present it is substituted with the user's Windows
6403 Default: \fBtemplate homedir = /home/%D/%U\fR
6405 \fBtemplate shell (G)\fR
6406 \fBNOTE:\fR this parameter is
6407 only available in Samba 3.0.
6409 When filling out the user information for a Windows NT
6410 user, the winbindd(8)daemon
6411 uses this parameter to fill in the login shell for that user.
6413 Default: \fBtemplate shell = /bin/false\fR
6415 \fBtime offset (G)\fR
6416 This parameter is a setting in minutes to add
6417 to the normal GMT to local time conversion. This is useful if
6418 you are serving a lot of PCs that have incorrect daylight
6419 saving time handling.
6421 Default: \fBtime offset = 0\fR
6423 Example: \fBtime offset = 60\fR
6425 \fBtime server (G)\fR
6426 This parameter determines if
6427 nmbd(8)advertises itself as a time server to Windows
6430 Default: \fBtime server = no\fR
6432 \fBtimestamp logs (G)\fR
6433 Synonym for \fI debug timestamp\fR.
6435 \fBtotal print jobs (G)\fR
6436 This parameter accepts an integer value which defines
6437 a limit on the maximum number of print jobs that will be accepted
6438 system wide at any given time. If a print job is submitted
6439 by a client which will exceed this number, then smbd will return an
6440 error indicating that no space is available on the server. The
6441 default value of 0 means that no such limit exists. This parameter
6442 can be used to prevent a server from exceeding its capacity and is
6443 designed as a printing throttle. See also
6444 \fImax print jobs\fR.
6446 Default: \fBtotal print jobs = 0\fR
6448 Example: \fBtotal print jobs = 5000\fR
6450 \fBunix password sync (G)\fR
6451 This boolean parameter controls whether Samba
6452 attempts to synchronize the UNIX password with the SMB password
6453 when the encrypted SMB password in the smbpasswd file is changed.
6454 If this is set to true the program specified in the \fIpasswd
6455 program\fRparameter is called \fBAS ROOT\fR -
6456 to allow the new UNIX password to be set without access to the
6457 old UNIX password (as the SMB password has change code has no
6458 access to the old password cleartext, only the new).
6461 program\fR, \fI passwd chat\fR.
6463 Default: \fBunix password sync = no\fR
6465 \fBupdate encrypted (G)\fR
6466 This boolean parameter allows a user logging
6467 on with a plaintext password to have their encrypted (hashed)
6468 password in the smbpasswd file to be updated automatically as
6469 they log on. This option allows a site to migrate from plaintext
6470 password authentication (users authenticate with plaintext
6471 password over the wire, and are checked against a UNIX account
6472 database) to encrypted password authentication (the SMB
6473 challenge/response authentication mechanism) without forcing
6474 all users to re-enter their passwords via smbpasswd at the time the
6475 change is made. This is a convenience option to allow the change over
6476 to encrypted passwords to be made over a longer period. Once all users
6477 have encrypted representations of their passwords in the smbpasswd
6478 file this parameter should be set to no.
6480 In order for this parameter to work correctly the \fIencrypt passwords\fR
6481 parameter must be set to no when
6482 this parameter is set to yes.
6484 Note that even when this parameter is set a user
6485 authenticating to \fBsmbd\fR must still enter a valid
6486 password in order to connect correctly, and to update their hashed
6487 (smbpasswd) passwords.
6489 Default: \fBupdate encrypted = no\fR
6491 \fBuse rhosts (G)\fR
6492 If this global parameter is a true, it specifies
6493 that the UNIX users \fI.rhosts\fR file in their home directory
6494 will be read to find the names of hosts and users who will be allowed
6495 access without specifying a password.
6497 \fBNOTE:\fR The use of \fIuse rhosts
6498 \fRcan be a major security hole. This is because you are
6499 trusting the PC to supply the correct username. It is very easy to
6500 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
6503 Default: \fBuse rhosts = no\fR
6506 Synonym for \fI username\fR.
6509 Synonym for \fI username\fR.
6512 Multiple users may be specified in a comma-delimited
6513 list, in which case the supplied password will be tested against
6514 each username in turn (left to right).
6516 The \fIusername\fR line is needed only when
6517 the PC is unable to supply its own username. This is the case
6518 for the COREPLUS protocol or where your users have different WfWg
6519 usernames to UNIX usernames. In both these cases you may also be
6520 better using the \\\\server\\share%user syntax instead.
6522 The \fIusername\fR line is not a great
6523 solution in many cases as it means Samba will try to validate
6524 the supplied password against each of the usernames in the
6525 \fIusername\fR line in turn. This is slow and
6526 a bad idea for lots of users in case of duplicate passwords.
6527 You may get timeouts or security breaches using this parameter
6530 Samba relies on the underlying UNIX security. This
6531 parameter does not restrict who can login, it just offers hints
6532 to the Samba server as to what usernames might correspond to the
6533 supplied password. Users can login as whoever they please and
6534 they will be able to do no more damage than if they started a
6535 telnet session. The daemon runs as the user that they log in as,
6536 so they cannot do anything that user cannot do.
6538 To restrict a service to a particular set of users you
6539 can use the \fIvalid users
6542 If any of the usernames begin with a '@' then the name
6543 will be looked up first in the yp netgroups list (if Samba
6544 is compiled with netgroup support), followed by a lookup in
6545 the UNIX groups database and will expand to a list of all users
6546 in the group of that name.
6548 If any of the usernames begin with a '+' then the name
6549 will be looked up only in the UNIX groups database and will
6550 expand to a list of all users in the group of that name.
6552 If any of the usernames begin with a '&'then the name
6553 will be looked up only in the yp netgroups database (if Samba
6554 is compiled with netgroup support) and will expand to a list
6555 of all users in the netgroup group of that name.
6557 Note that searching though a groups database can take
6558 quite some time, and some clients may time out during the
6561 See the section NOTE ABOUT
6562 USERNAME/PASSWORD VALIDATION for more information on how
6563 this parameter determines access to the services.
6565 Default: \fBThe guest account if a guest service,
6566 else <empty string>.\fR
6568 Examples:\fBusername = fred, mary, jack, jane,
6571 \fBusername level (G)\fR
6572 This option helps Samba to try and 'guess' at
6573 the real UNIX username, as many DOS clients send an all-uppercase
6574 username. By default Samba tries all lowercase, followed by the
6575 username with the first letter capitalized, and fails if the
6576 username is not found on the UNIX machine.
6578 If this parameter is set to non-zero the behavior changes.
6579 This parameter is a number that specifies the number of uppercase
6580 combinations to try while trying to determine the UNIX user name. The
6581 higher the number the more combinations will be tried, but the slower
6582 the discovery of usernames will be. Use this parameter when you have
6583 strange usernames on your UNIX machine, such as AstrangeUser
6586 Default: \fBusername level = 0\fR
6588 Example: \fBusername level = 5\fR
6590 \fBusername map (G)\fR
6591 This option allows you to specify a file containing
6592 a mapping of usernames from the clients to the server. This can be
6593 used for several purposes. The most common is to map usernames
6594 that users use on DOS or Windows machines to those that the UNIX
6595 box uses. The other is to map multiple users to a single username
6596 so that they can more easily share files.
6598 The map file is parsed line by line. Each line should
6599 contain a single UNIX username on the left then a '=' followed
6600 by a list of usernames on the right. The list of usernames on the
6601 right may contain names of the form @group in which case they
6602 will match any UNIX username in that group. The special client
6603 name '*' is a wildcard and matches any name. Each line of the
6604 map file may be up to 1023 characters long.
6606 The file is processed on each line by taking the
6607 supplied username and comparing it with each username on the right
6608 hand side of the '=' signs. If the supplied name matches any of
6609 the names on the right hand side then it is replaced with the name
6610 on the left. Processing then continues with the next line.
6612 If any line begins with a '#' or a ';' then it is
6615 If any line begins with an '!' then the processing
6616 will stop after that line if a mapping was done by the line.
6617 Otherwise mapping continues with every line being processed.
6618 Using '!' is most useful when you have a wildcard mapping line
6621 For example to map from the name admin
6622 or administrator to the UNIX name root you would use:
6624 \fBroot = admin administrator\fR
6626 Or to map anyone in the UNIX group system
6627 to the UNIX name sys you would use:
6631 You can have as many mappings as you like in a username
6634 If your system supports the NIS NETGROUP option then
6635 the netgroup database is checked before the \fI/etc/group
6636 \fRdatabase for matching groups.
6638 You can map Windows usernames that have spaces in them
6639 by using double quotes around the name. For example:
6641 \fBtridge = "Andrew Tridgell"\fR
6643 would map the windows username "Andrew Tridgell" to the
6644 unix username "tridge".
6646 The following example would map mary and fred to the
6647 unix user sys, and map the rest to guest. Note the use of the
6648 \&'!' to tell Samba to stop processing if it gets a match on
6659 Note that the remapping is applied to all occurrences
6660 of usernames. Thus if you connect to \\\\server\\fred and fred is remapped to mary then you
6661 will actually be connecting to \\\\server\\mary and will need to
6662 supply a password suitable for mary not
6663 fred. The only exception to this is the
6664 username passed to the \fI password server\fR (if you have one). The password
6665 server will receive whatever username the client supplies without
6668 Also note that no reverse mapping is done. The main effect
6669 this has is with printing. Users who have been mapped may have
6670 trouble deleting print jobs as PrintManager under WfWg will think
6671 they don't own the print job.
6673 Default: \fBno username map\fR
6675 Example: \fBusername map = /usr/local/samba/lib/users.map
6678 This boolean parameter is only available if
6679 Samba has been configured and compiled with the option \fB --with-utmp\fR. If set to True then Samba will attempt
6680 to add utmp or utmpx records (depending on the UNIX system) whenever a
6681 connection is made to a Samba server. Sites may use this to record the
6682 user connecting to a Samba share.
6684 See also the \fI utmp directory\fR parameter.
6686 Default: \fButmp = no\fR
6688 \fButmp directory(G)\fR
6689 This parameter is only available if Samba has
6690 been configured and compiled with the option \fB --with-utmp\fR. It specifies a directory pathname that is
6691 used to store the utmp or utmpx files (depending on the UNIX system) that
6692 record user connections to a Samba server. See also the \fIutmp\fR parameter. By default this is
6693 not set, meaning the system will use whatever utmp file the
6694 native system is set to use (usually
6695 \fI/var/run/utmp\fR on Linux).
6697 Default: \fBno utmp directory\fR
6699 \fBvalid chars (G)\fR
6700 The option allows you to specify additional
6701 characters that should be considered valid by the server in
6702 filenames. This is particularly useful for national character
6703 sets, such as adding u-umlaut or a-ring.
6705 The option takes a list of characters in either integer
6706 or character form with spaces between them. If you give two
6707 characters with a colon between them then it will be taken as
6708 an lowercase:uppercase pair.
6710 If you have an editor capable of entering the characters
6711 into the config file then it is probably easiest to use this
6712 method. Otherwise you can specify the characters in octal,
6713 decimal or hexadecimal form using the usual C notation.
6715 For example to add the single character 'Z' to the charset
6716 (which is a pointless thing to do as it's already there) you could
6717 do one of the following
6723 valid chars = 0132:0172
6728 The last two examples above actually add two characters,
6729 and alter the uppercase and lowercase mappings appropriately.
6731 Note that you \fBMUST\fR specify this parameter
6732 after the \fIclient code page\fR parameter if you
6733 have both set. If \fIclient code page\fR is set after
6734 the \fIvalid chars\fR parameter the \fIvalid
6735 chars\fR settings will be overwritten.
6737 See also the \fIclient
6738 code page\fR parameter.
6740 Default: \fBSamba defaults to using a reasonable set
6741 of valid characters for English systems\fR
6743 Example: \fBvalid chars = 0345:0305 0366:0326 0344:0304
6745 The above example allows filenames to have the Swedish
6748 \fBNOTE:\fR It is actually quite difficult to
6749 correctly produce a \fIvalid chars\fR line for
6750 a particular system. To automate the process tino@augsburg.net <URL:mailto:tino@augsburg.net> has written
6751 a package called \fBvalidchars\fR which will automatically
6752 produce a complete \fIvalid chars\fR line for
6753 a given client system. Look in the \fIexamples/validchars/
6754 \fRsubdirectory of your Samba source code distribution
6757 \fBvalid users (S)\fR
6758 This is a list of users that should be allowed
6759 to login to this service. Names starting with '@', '+' and '&'
6760 are interpreted using the same rules as described in the
6761 \fIinvalid users\fR parameter.
6763 If this is empty (the default) then any user can login.
6764 If a username is in both this list and the \fIinvalid
6765 users\fR list then access is denied for that user.
6767 The current servicename is substituted for \fI%S
6768 \fR\&. This is useful in the [homes] section.
6770 See also \fIinvalid users
6772 Default: \fBNo valid users list (anyone can login)
6774 Example: \fBvalid users = greg, @pcusers\fR
6777 This is a list of files and directories that
6778 are neither visible nor accessible. Each entry in the list must
6779 be separated by a '/', which allows spaces to be included
6780 in the entry. '*' and '?' can be used to specify multiple files
6781 or directories as in DOS wildcards.
6783 Each entry must be a unix path, not a DOS path and
6784 must \fBnot\fR include the unix directory
6787 Note that the \fIcase sensitive\fR option
6788 is applicable in vetoing files.
6790 One feature of the veto files parameter that it is important
6791 to be aware of, is that if a directory contains nothing but files
6792 that match the veto files parameter (which means that Windows/DOS
6793 clients cannot ever see them) is deleted, the veto files within
6794 that directory \fBare automatically deleted\fR along
6795 with it, if the user has UNIX permissions to do so.
6797 Setting this parameter will affect the performance
6798 of Samba, as it will be forced to check all files and directories
6799 for a match as they are scanned.
6801 See also \fIhide files
6802 \fRand \fI case sensitive\fR.
6804 Default: \fBNo files or directories are vetoed.
6809 ; Veto any files containing the word Security,
6810 ; any ending in .tmp, and any directory containing the
6812 veto files = /*Security*/*.tmp/*root*/
6814 ; Veto the Apple specific files that a NetAtalk server
6816 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
6821 \fBveto oplock files (S)\fR
6822 This parameter is only valid when the \fIoplocks\fR
6823 parameter is turned on for a share. It allows the Samba administrator
6824 to selectively turn off the granting of oplocks on selected files that
6825 match a wildcarded list, similar to the wildcarded list used in the
6829 Default: \fBNo files are vetoed for oplock
6832 You might want to do this on files that you know will
6833 be heavily contended for by clients. A good example of this
6834 is in the NetBench SMB benchmark program, which causes heavy
6835 client contention for files ending in \fI.SEM\fR.
6836 To cause Samba not to grant oplocks on these files you would use
6837 the line (either in the [global] section or in the section for
6838 the particular NetBench share :
6840 Example: \fBveto oplock files = /*;.SEM/
6842 \fBvfs object (S)\fR
6843 This parameter specifies a shared object file that
6844 is used for Samba VFS I/O operations. By default, normal
6845 disk I/O operations are used but these can be overloaded
6846 with a VFS object. The Samba VFS layer is new to Samba 2.2 and
6847 must be enabled at compile time with --with-vfs.
6849 Default : \fBno value\fR
6851 \fBvfs options (S)\fR
6852 This parameter allows parameters to be passed
6853 to the vfs layer at initialisation time. The Samba VFS layer
6854 is new to Samba 2.2 and must be enabled at compile time
6855 with --with-vfs. See also \fI vfs object\fR.
6857 Default : \fBno value\fR
6860 This allows you to override the volume label
6861 returned for a share. Useful for CDROMs with installation programs
6862 that insist on a particular volume label.
6864 Default: \fBthe name of the share\fR
6866 \fBwide links (S)\fR
6867 This parameter controls whether or not links
6868 in the UNIX file system may be followed by the server. Links
6869 that point to areas within the directory tree exported by the
6870 server are always allowed; this parameter controls access only
6871 to areas that are outside the directory tree being exported.
6873 Note that setting this parameter can have a negative
6874 effect on your server performance due to the extra system calls
6875 that Samba has to do in order to perform the link checks.
6877 Default: \fBwide links = yes\fR
6879 \fBwinbind cache time\fR
6880 \fBNOTE:\fR this parameter is only
6881 available in Samba 3.0.
6883 This parameter specifies the number of seconds the
6884 winbindd(8)daemon will cache
6885 user and group information before querying a Windows NT server
6888 Default: \fBwinbind cache type = 15\fR
6891 \fBNOTE:\fR this parameter is only
6892 available in Samba 3.0.
6894 The winbind gid parameter specifies the range of group
6895 ids that are allocated by the winbindd(8)daemon. This range of group ids should have no
6896 existing local or nis groups within it as strange conflicts can
6899 Default: \fBwinbind gid = <empty string>
6901 Example: \fBwinbind gid = 10000-20000\fR
6903 \fBwinbind separator\fR
6904 \fBNOTE:\fR this parameter is only
6905 available in Samba 3.0.
6907 This parameter allows an admin to define the character
6908 used when listing a username of the form of \fIDOMAIN
6909 \fR\\\fIuser\fR. This parameter
6910 is only applicable when using the \fIpam_winbind.so\fR
6911 and \fInss_winbind.so\fR modules for UNIX services.
6913 Example: \fBwinbind separator = \\\fR
6915 Example: \fBwinbind separator = +\fR
6918 \fBNOTE:\fR this parameter is only
6919 available in Samba 3.0.
6921 The winbind gid parameter specifies the range of group
6922 ids that are allocated by the winbindd(8)daemon. This range of ids should have no
6923 existing local or nis users within it as strange conflicts can
6926 Default: \fBwinbind uid = <empty string>
6928 Example: \fBwinbind uid = 10000-20000\fR
6931 When Samba is running as a WINS server this
6932 allows you to call an external program for all changes to the
6933 WINS database. The primary use for this option is to allow the
6934 dynamic update of external name resolution databases such as
6937 The wins hook parameter specifies the name of a script
6938 or executable that will be called as follows:
6940 \fBwins_hook operation name nametype ttl IP_list
6944 The first argument is the operation and is one
6945 of "add", "delete", or "refresh". In most cases the operation can
6946 be ignored as the rest of the parameters provide sufficient
6947 information. Note that "refresh" may sometimes be called when the
6948 name has not previously been added, in that case it should be treated
6952 The second argument is the netbios name. If the
6953 name is not a legal name then the wins hook is not called.
6954 Legal names contain only letters, digits, hyphens, underscores
6958 The third argument is the netbios name
6959 type as a 2 digit hexadecimal number.
6962 The fourth argument is the TTL (time to live)
6963 for the name in seconds.
6966 The fifth and subsequent arguments are the IP
6967 addresses currently registered for that name. If this list is
6968 empty then the name should be deleted.
6971 An example script that calls the BIND dynamic DNS update
6972 program \fBnsupdate\fR is provided in the examples
6973 directory of the Samba source code.
6976 \fBwins proxy (G)\fR
6977 This is a boolean that controls if nmbd(8)will respond to broadcast name
6978 queries on behalf of other hosts. You may need to set this
6979 to yes for some older clients.
6981 Default: \fBwins proxy = no\fR
6983 \fBwins server (G)\fR
6984 This specifies the IP address (or DNS name: IP
6985 address for preference) of the WINS server that nmbd(8)should register with. If you have a WINS server on
6986 your network then you should set this to the WINS server's IP.
6988 You should point this at your WINS server if you have a
6989 multi-subnetted network.
6991 \fBNOTE\fR. You need to set up Samba to point
6992 to a WINS server if you have multiple subnets and wish cross-subnet
6993 browsing to work correctly.
6995 See the documentation file \fIBROWSING.txt\fR
6996 in the docs/ directory of your Samba source distribution.
6998 Default: \fBnot enabled\fR
7000 Example: \fBwins server = 192.9.200.1\fR
7002 \fBwins support (G)\fR
7003 This boolean controls if the
7004 nmbd(8)process in Samba will act as a WINS server. You should
7005 not set this to true unless you have a multi-subnetted network and
7006 you wish a particular \fBnmbd\fR to be your WINS server.
7007 Note that you should \fBNEVER\fR set this to true
7008 on more than one machine in your network.
7010 Default: \fBwins support = no\fR
7013 This controls what workgroup your server will
7014 appear to be in when queried by clients. Note that this parameter
7015 also controls the Domain name used with the \fBsecurity=domain\fR
7018 Default: \fBset at compile time to WORKGROUP\fR
7020 Example: \fBworkgroup = MYGROUP\fR
7023 Synonym for \fI writeable\fR for people who can't spell :-).
7025 \fBwrite cache size (S)\fR
7026 If this integer parameter is set to non-zero value,
7027 Samba will create an in-memory cache for each oplocked file
7028 (it does \fBnot\fR do this for
7029 non-oplocked files). All writes that the client does not request
7030 to be flushed directly to disk will be stored in this cache if possible.
7031 The cache is flushed onto disk when a write comes in whose offset
7032 would not fit into the cache or when the file is closed by the client.
7033 Reads for the file are also served from this cache if the data is stored
7036 This cache allows Samba to batch client writes into a more
7037 efficient write size for RAID disks (ie. writes may be tuned to
7038 be the RAID stripe size) and can improve performance on systems
7039 where the disk subsystem is a bottleneck but there is free
7040 memory for userspace programs.
7042 The integer parameter specifies the size of this cache
7043 (per oplocked file) in bytes.
7045 Default: \fBwrite cache size = 0\fR
7047 Example: \fBwrite cache size = 262144\fR
7049 for a 256k cache size per file.
7051 \fBwrite list (S)\fR
7052 This is a list of users that are given read-write
7053 access to a service. If the connecting user is in this list then
7054 they will be given write access, no matter what the \fIwriteable\fR
7055 option is set to. The list can include group names using the
7058 Note that if a user is in both the read list and the
7059 write list then they will be given write access.
7061 See also the \fIread list
7064 Default: \fBwrite list = <empty string>
7066 Example: \fBwrite list = admin, root, @staff
7069 Synonym for \fI writeable\fR.
7072 This parameter controls whether or not the server
7073 will support raw writes SMB's when transferring data from clients.
7074 You should never need to change this parameter.
7076 Default: \fBwrite raw = yes\fR
7079 An inverted synonym is \fIread only\fR.
7081 If this parameter is no, then users
7082 of a service may not create or modify files in the service's
7085 Note that a printable service (\fBprintable = yes\fR)
7086 will \fBALWAYS\fR allow writing to the directory
7087 (user privileges permitting), but only via spooling operations.
7089 Default: \fBwriteable = no\fR
7092 Although the configuration file permits service names
7093 to contain spaces, your client software may not. Spaces will
7094 be ignored in comparisons anyway, so it shouldn't be a
7095 problem - but be aware of the possibility.
7097 On a similar note, many clients - especially DOS clients -
7098 limit service names to eight characters. smbd(8)
7099 has no such limitation, but attempts to connect from such
7100 clients will fail if they truncate the service names. For this reason
7101 you should probably keep your service names down to eight characters
7104 Use of the [homes] and [printers] special sections make life
7105 for an administrator easy, but the various combinations of default
7106 attributes can be tricky. Take extreme care when designing these
7107 sections. In particular, ensure that the permissions on spool
7108 directories are correct.
7111 This man page is correct for version 2.2 of
7126 The original Samba software and related utilities
7127 were created by Andrew Tridgell. Samba is now developed
7128 by the Samba Team as an Open Source project similar
7129 to the way the Linux kernel is developed.
7131 The original Samba man pages were written by Karl Auer.
7132 The man page sources were converted to YODL format (another
7133 excellent piece of Open Source software, available at
7134 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0
7135 release by Jeremy Allison. The conversion to DocBook for
7136 Samba 2.2 was done by Gerald Carter