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 "23 Jun 2001" "smb.conf 2.2.0a"
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 user script\fR
509 \fIaddprinter command\fR
512 \fIallow trusted domains\fR
518 \fIannounce version\fR
524 \fIbind interfaces only\fR
530 \fIchange notify timeout\fR
536 \fIclient code page\fR
539 \fIcode page directory\fR
551 \fIdebug hires timestamp\fR
557 \fIdebug timestamp\fR
569 \fIdefault service\fR
572 \fIdelete user script\fR
575 \fIdeleteprinter command\fR
584 \fIdomain admin group\fR
587 \fIdomain admin users\fR
593 \fIdomain guest group\fR
596 \fIdomain guest users\fR
605 \fIencrypt passwords\fR
608 \fIenhanced browsing\fR
611 \fIenumports command\fR
617 \fIhide local users\fR
680 \fImachine password timeout\fR
704 \fImax smbd processes\fR
716 \fImessage command\fR
719 \fImin passwd length\fR
722 \fImin password length\fR
731 \fIname resolve order\fR
734 \fInetbios aliases\fR
749 \fInt pipe support\fR
758 \fIoplock break wait time\fR
773 \fIpasswd chat debug\fR
782 \fIpassword server\fR
785 \fIprefered master\fR
788 \fIpreferred master\fR
800 \fIprinter driver file\fR
815 \fIremote announce\fR
818 \fIremote browse sync\fR
821 \fIrestrict anonymous\fR
839 \fIshow add printer wizard\fR
842 \fIsmb passwd file\fR
851 \fIsource environment\fR
860 \fIssl CA certFile\fR
866 \fIssl client cert\fR
872 \fIssl compatibility\fR
878 \fIssl hosts resign\fR
881 \fIssl require clientcert\fR
884 \fIssl require servercert\fR
887 \fIssl server cert\fR
899 \fIstat cache size\fR
911 \fItemplate homedir\fR
926 \fItotal print jobs\fR
929 \fIunix password sync\fR
935 \fIupdate encrypted\fR
953 \fIwinbind cache time\fR
959 \fIwinbind separator\fR
981 .SH "COMPLETE LIST OF SERVICE PARAMETERS"
983 Here is a list of all service parameters. See the section on
984 each parameter for details. Note that some are synonyms.
1005 \fIcase sensitive\fR
1026 \fIdelete readonly\fR
1029 \fIdelete veto files\fR
1038 \fIdirectory mask\fR
1041 \fIdirectory mode\fR
1044 \fIdirectory security mask\fR
1053 \fIdos filetime resolution\fR
1062 \fIfake directory create times\fR
1068 \fIfollow symlinks\fR
1071 \fIforce create mode\fR
1074 \fIforce directory mode\fR
1077 \fIforce directory security mode\fR
1083 \fIforce security mode\fR
1104 \fIhide dot files\fR
1119 \fIinherit permissions\fR
1125 \fIlevel2 oplocks\fR
1131 \fIlppause command\fR
1137 \fIlpresume command\fR
1170 \fImax connections\fR
1173 \fImax print jobs\fR
1176 \fImin print space\fR
1188 \fIoplock contention limit\fR
1230 \fIprinter driver\fR
1233 \fIprinter driver location\fR
1245 \fIqueuepause command\fR
1248 \fIqueueresume command\fR
1263 \fIroot preexec close\fR
1275 \fIshort preserve case\fR
1281 \fIstrict locking\fR
1308 \fIveto oplock files\fR
1326 \fIwrite cache size\fR
1336 .SH "EXPLANATION OF EACH PARAMETER"
1338 \fBadd user script (G)\fR
1339 This is the full pathname to a script that will
1340 be run \fBAS ROOT\fR by smbd(8)
1341 under special circumstances described below.
1343 Normally, a Samba server requires that UNIX users are
1344 created for all users accessing files on this server. For sites
1345 that use Windows NT account databases as their primary user database
1346 creating these users and keeping the user list in sync with the
1347 Windows NT PDC is an onerous task. This option allows smbdto create the required UNIX users
1348 \fBON DEMAND\fR when a user accesses the Samba server.
1350 In order to use this option, smbdmust be set to \fIsecurity=server\fR or \fI security=domain\fR and \fIadd user script\fR
1351 must be set to a full pathname for a script that will create a UNIX
1352 user given one argument of \fI%u\fR, which expands into
1353 the UNIX user name to create.
1355 When the Windows user attempts to access the Samba server,
1356 at login (session setup in the SMB protocol) time, smbdcontacts the \fIpassword server\fR and
1357 attempts to authenticate the given user with the given password. If the
1358 authentication succeeds then \fBsmbd\fR
1359 attempts to find a UNIX user in the UNIX password database to map the
1360 Windows user into. If this lookup fails, and \fIadd user script
1361 \fRis set then \fBsmbd\fR will
1362 call the specified script \fBAS ROOT\fR, expanding
1363 any \fI%u\fR argument to be the user name to create.
1365 If this script successfully creates the user then \fBsmbd
1366 \fRwill continue on as though the UNIX user
1367 already existed. In this way, UNIX users are dynamically created to
1368 match existing Windows NT accounts.
1370 See also \fI security\fR, \fIpassword server\fR,
1374 Default: \fBadd user script = <empty string>
1376 Example: \fBadd user script = /usr/local/samba/bin/add_user
1379 \fBaddprinter command (G)\fR
1380 With the introduction of MS-RPC based printing
1381 support for Windows NT/2000 clients in Samba 2.2, The MS Add
1382 Printer Wizard (APW) icon is now also available in the
1383 "Printers..." folder displayed a share listing. The APW
1384 allows for printers to be add remotely to a Samba or Windows
1385 NT/2000 print server.
1387 For a Samba host this means that the printer must be
1388 physically added to underlying printing system. The \fI addprinter command\fR defines a script to be run which
1389 will perform the necessary operations for adding the printer
1390 to the print system and to add the appropriate service definition
1391 to the \fIsmb.conf\fR file in order that it can be
1392 shared by \fBsmbd(8)\fR
1395 The \fIaddprinter command\fR is
1396 automatically invoked with the following parameter (in
1416 \fIWindows 9x driver location\fR
1419 All parameters are filled in from the PRINTER_INFO_2 structure sent
1420 by the Windows NT/2000 client with one exception. The "Windows 9x
1421 driver location" parameter is included for backwards compatibility
1422 only. The remaining fields in the structure are generated from answers
1423 to the APW questions.
1426 Once the \fIaddprinter command\fR has
1427 been executed, \fBsmbd\fR will reparse the \fI smb.conf\fR to determine if the share defined by the APW
1428 exists. If the sharename is still invalid, then \fBsmbd
1429 \fRwill return an ACCESS_DENIED error to the client.
1432 See also \fI deleteprinter command\fR, \fIprinting\fR,
1440 Example: \fBaddprinter command = /usr/bin/addprinter
1443 \fBadmin users (S)\fR
1444 This is a list of users who will be granted
1445 administrative privileges on the share. This means that they
1446 will do all file operations as the super-user (root).
1448 You should use this option very carefully, as any user in
1449 this list will be able to do anything they like on the share,
1450 irrespective of file permissions.
1452 Default: \fBno admin users\fR
1454 Example: \fBadmin users = jason\fR
1456 \fBallow hosts (S)\fR
1457 Synonym for \fIhosts allow\fR.
1459 \fBallow trusted domains (G)\fR
1460 This option only takes effect when the \fIsecurity\fR option is set to
1462 If it is set to no, then attempts to connect to a resource from
1463 a domain or workgroup other than the one which smbd is running
1464 in will fail, even if that domain is trusted by the remote server
1465 doing the authentication.
1467 This is useful if you only want your Samba server to
1468 serve resources to users in the domain it is a member of. As
1469 an example, suppose that there are two domains DOMA and DOMB. DOMB
1470 is trusted by DOMA, which contains the Samba server. Under normal
1471 circumstances, a user with an account in DOMB can then access the
1472 resources of a UNIX account with the same account name on the
1473 Samba server even if they do not have an account in DOMA. This
1474 can make implementing a security boundary difficult.
1476 Default: \fBallow trusted domains = yes\fR
1478 \fBannounce as (G)\fR
1479 This specifies what type of server
1480 \fBnmbd\fRwill announce itself as, to a network neighborhood browse
1481 list. By default this is set to Windows NT. The valid options
1482 are : "NT Server" (which can also be written as "NT"),
1483 "NT Workstation", "Win95" or "WfW" meaning Windows NT Server,
1484 Windows NT Workstation, Windows 95 and Windows for Workgroups
1485 respectively. Do not change this parameter unless you have a
1486 specific need to stop Samba appearing as an NT server as this
1487 may prevent Samba servers from participating as browser servers
1490 Default: \fBannounce as = NT Server\fR
1492 Example: \fBannounce as = Win95\fR
1494 \fBannouce version (G)\fR
1495 This specifies the major and minor version numbers
1496 that nmbd will use when announcing itself as a server. The default
1497 is 4.2. Do not change this parameter unless you have a specific
1498 need to set a Samba server to be a downlevel server.
1500 Default: \fBannounce version = 4.2\fR
1502 Example: \fBannounce version = 2.0\fR
1504 \fBauto services (G)\fR
1505 This is a synonym for the \fIpreload\fR.
1508 This parameter lets you "turn off" a service. If
1509 \fIavailable = no\fR, then \fBALL\fR
1510 attempts to connect to the service will fail. Such failures are
1513 Default: \fBavailable = yes\fR
1515 \fBbind interfaces only (G)\fR
1516 This global parameter allows the Samba admin
1517 to limit what interfaces on a machine will serve smb requests. If
1518 affects file service smbd(8)and
1519 name service nmbd(8)in slightly
1522 For name service it causes \fBnmbd\fR to bind
1523 to ports 137 and 138 on the interfaces listed in the interfaces parameter. \fBnmbd
1524 \fRalso binds to the "all addresses" interface (0.0.0.0)
1525 on ports 137 and 138 for the purposes of reading broadcast messages.
1526 If this option is not set then \fBnmbd\fR will service
1527 name requests on all of these sockets. If \fIbind interfaces
1528 only\fR is set then \fBnmbd\fR will check the
1529 source address of any packets coming in on the broadcast sockets
1530 and discard any that don't match the broadcast addresses of the
1531 interfaces in the \fIinterfaces\fR parameter list.
1532 As unicast packets are received on the other sockets it allows
1533 \fBnmbd\fR to refuse to serve names to machines that
1534 send packets that arrive through any interfaces not listed in the
1535 \fIinterfaces\fR list. IP Source address spoofing
1536 does defeat this simple check, however so it must not be used
1537 seriously as a security feature for \fBnmbd\fR.
1539 For file service it causes smbd(8)to bind only to the interface list given in the interfaces parameter. This restricts the networks that
1540 \fBsmbd\fR will serve to packets coming in those
1541 interfaces. Note that you should not use this parameter for machines
1542 that are serving PPP or other intermittent or non-broadcast network
1543 interfaces as it will not cope with non-permanent interfaces.
1545 If \fIbind interfaces only\fR is set then
1546 unless the network address \fB127.0.0.1\fR is added
1547 to the \fIinterfaces\fR parameter list \fBsmbpasswd(8)\fRand \fBswat(8)\fRmay
1548 not work as expected due to the reasons covered below.
1550 To change a users SMB password, the \fBsmbpasswd\fR
1551 by default connects to the \fBlocalhost - 127.0.0.1\fR
1552 address as an SMB client to issue the password change request. If
1553 \fIbind interfaces only\fR is set then unless the
1554 network address \fB127.0.0.1\fR is added to the
1555 \fIinterfaces\fR parameter list then \fB smbpasswd\fR will fail to connect in it's default mode.
1556 \fBsmbpasswd\fR can be forced to use the primary IP interface
1557 of the local host by using its \fI-r remote machine\fR
1558 parameter, with \fIremote machine\fR set
1559 to the IP name of the primary interface of the local host.
1561 The \fBswat\fR status page tries to connect with
1562 \fBsmbd\fR and \fBnmbd\fR at the address
1563 \fB127.0.0.1\fR to determine if they are running.
1564 Not adding \fB127.0.0.1\fR will cause \fB smbd\fR and \fBnmbd\fR to always show
1565 "not running" even if they really are. This can prevent \fB swat\fR from starting/stopping/restarting \fBsmbd\fR
1568 Default: \fBbind interfaces only = no\fR
1570 \fBblocking locks (S)\fR
1571 This parameter controls the behavior of smbd(8)when given a request by a client
1572 to obtain a byte range lock on a region of an open file, and the
1573 request has a time limit associated with it.
1575 If this parameter is set and the lock range requested
1576 cannot be immediately satisfied, Samba 2.2 will internally
1577 queue the lock request, and periodically attempt to obtain
1578 the lock until the timeout period expires.
1580 If this parameter is set to False, then
1581 Samba 2.2 will behave as previous versions of Samba would and
1582 will fail the lock request immediately if the lock range
1585 Default: \fBblocking locks = yes\fR
1588 See the \fI browseable\fR.
1590 \fBbrowse list (G)\fR
1591 This controls whether \fBsmbd(8)\fRwill serve a browse list to
1592 a client doing a \fBNetServerEnum\fR call. Normally
1593 set to true. You should never need to change
1596 Default: \fBbrowse list = yes\fR
1598 \fBbrowseable (S)\fR
1599 This controls whether this share is seen in
1600 the list of available shares in a net view and in the browse list.
1602 Default: \fBbrowseable = yes\fR
1604 \fBcase sensitive (S)\fR
1605 See the discussion in the section NAME MANGLING.
1607 Default: \fBcase sensitive = no\fR
1609 \fBcasesignames (S)\fR
1613 \fBchange notify timeout (G)\fR
1614 This SMB allows a client to tell a server to
1615 "watch" a particular directory for any changes and only reply to
1616 the SMB request when a change has occurred. Such constant scanning of
1617 a directory is expensive under UNIX, hence an \fBsmbd(8)\fRdaemon only performs such a scan
1618 on each requested directory once every \fIchange notify
1621 Default: \fBchange notify timeout = 60\fR
1623 Example: \fBchange notify timeout = 300\fR
1625 Would change the scan time to every 5 minutes.
1627 \fBcharacter set (G)\fR
1628 This allows a smbd to map incoming filenames
1629 from a DOS Code page (see the client
1630 code page parameter) to several built in UNIX character sets.
1631 The built in code page translations are:
1635 ISO8859-1 : Western European
1636 UNIX character set. The parameter \fIclient code page\fR
1637 \fBMUST\fR be set to code page 850 if the
1638 \fIcharacter set\fR parameter is set to
1639 ISO8859-1 in order for the conversion to the
1640 UNIX character set to be done correctly.
1643 ISO8859-2 : Eastern European
1644 UNIX character set. The parameter \fIclient code page
1645 \fR\fBMUST\fR be set to code page 852 if
1646 the \fI character set\fR parameter is set
1647 to ISO8859-2 in order for the conversion
1648 to the UNIX character set to be done correctly.
1651 ISO8859-5 : Russian Cyrillic
1652 UNIX character set. The parameter \fIclient code page
1653 \fR\fBMUST\fR be set to code page
1654 866 if the \fIcharacter set \fR parameter is
1655 set to ISO8859-5 in order for the conversion
1656 to the UNIX character set to be done correctly.
1659 ISO8859-7 : Greek UNIX
1660 character set. The parameter \fIclient code page
1661 \fR\fBMUST\fR be set to code page
1662 737 if the \fIcharacter set\fR parameter is
1663 set to ISO8859-7 in order for the conversion
1664 to the UNIX character set to be done correctly.
1667 KOI8-R : Alternate mapping
1668 for Russian Cyrillic UNIX character set. The parameter
1669 \fIclient code page\fR \fBMUST\fR
1670 be set to code page 866 if the \fIcharacter set\fR
1671 parameter is set to KOI8-R in order for the
1672 conversion to the UNIX character set to be done correctly.
1675 \fBBUG\fR. These MSDOS code page to UNIX character
1676 set mappings should be dynamic, like the loading of MS DOS code pages,
1680 Normally this parameter is not set, meaning no filename
1681 translation is done.
1684 Default: \fBcharacter set = <empty string>\fR
1687 Example: \fBcharacter set = ISO8859-1\fR
1690 \fBclient code page (G)\fR
1691 This parameter specifies the DOS code page
1692 that the clients accessing Samba are using. To determine what code
1693 page a Windows or DOS client is using, open a DOS command prompt
1694 and type the command \fBchcp\fR. This will output
1695 the code page. The default for USA MS-DOS, Windows 95, and
1696 Windows NT releases is code page 437. The default for western
1697 European releases of the above operating systems is code page 850.
1699 This parameter tells smbd(8)which of the \fIcodepage.XXX
1700 \fRfiles to dynamically load on startup. These files,
1701 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
1702 the case insensitivity of filenames that Windows clients expect.
1704 Samba currently ships with the following code page files :
1708 Code Page 437 - MS-DOS Latin US
1711 Code Page 737 - Windows '95 Greek
1714 Code Page 850 - MS-DOS Latin 1
1717 Code Page 852 - MS-DOS Latin 2
1720 Code Page 861 - MS-DOS Icelandic
1723 Code Page 866 - MS-DOS Cyrillic
1726 Code Page 932 - MS-DOS Japanese SJIS
1729 Code Page 936 - MS-DOS Simplified Chinese
1732 Code Page 949 - MS-DOS Korean Hangul
1735 Code Page 950 - MS-DOS Traditional Chinese
1738 Thus this parameter may have any of the values 437, 737, 850, 852,
1739 861, 932, 936, 949, or 950. If you don't find the codepage you need,
1740 read the comments in one of the other codepage files and the
1741 \fBmake_smbcodepage(1)\fR man page and write one. Please
1742 remember to donate it back to the Samba user community.
1745 This parameter co-operates with the \fIvalid
1746 chars\fR parameter in determining what characters are
1747 valid in filenames and how capitalization is done. If you set both
1748 this parameter and the \fIvalid chars\fR parameter
1749 the \fIclient code page\fR parameter
1750 \fBMUST\fR be set before the \fIvalid
1751 chars\fR parameter in the \fIsmb.conf\fR
1752 file. The \fIvalid chars\fR string will then
1753 augment the character settings in the \fIclient code page\fR
1757 If not set, \fIclient code page\fR defaults
1762 chars\fR, \fIcode page directory\fR
1765 Default: \fBclient code page = 850\fR
1768 Example: \fBclient code page = 936\fR
1771 \fBcode page directory (G)\fR
1772 Define the location of the various client code page
1778 Default: \fBcode page directory = ${prefix}/lib/codepages
1780 Example: \fBcode page directory = /usr/share/samba/codepages
1782 \fBcodingsystem (G)\fR
1783 This parameter is used to determine how incoming
1784 Shift-JIS Japanese characters are mapped from the incoming \fIclient code page\fR
1785 used by the client, into file names in the UNIX filesystem.
1786 Only useful if \fIclient code page\fR is set to
1787 932 (Japanese Shift-JIS). The options are :
1791 SJIS - Shift-JIS. Does no
1792 conversion of the incoming filename.
1795 JIS8, J8BB, J8BH, J8@B,
1796 J8@J, J8@H - Convert from incoming Shift-JIS to eight
1797 bit JIS code with different shift-in, shift out codes.
1800 JIS7, J7BB, J7BH, J7@B, J7@J,
1801 J7@H - Convert from incoming Shift-JIS to seven bit
1802 JIS code with different shift-in, shift out codes.
1805 JUNET, JUBB, JUBH, JU@B, JU@J, JU@H
1806 - Convert from incoming Shift-JIS to JUNET code with different shift-in,
1810 EUC - Convert an incoming
1811 Shift-JIS character to EUC code.
1814 HEX - Convert an incoming
1815 Shift-JIS character to a 3 byte hex representation, i.e.
1819 CAP - Convert an incoming
1820 Shift-JIS character to the 3 byte hex representation used by
1821 the Columbia AppleTalk Program (CAP), i.e. :AB.
1822 This is used for compatibility between Samba and CAP.
1825 Default: \fBcoding system = <empty value>\fR
1829 This is a text field that is seen next to a share
1830 when a client does a queries the server, either via the network
1831 neighborhood or via \fBnet view\fR to list what shares
1834 If you want to set the string that is displayed next to the
1835 machine name then see the \fI server string\fR parameter.
1837 Default: \fBNo comment string\fR
1839 Example: \fBcomment = Fred's Files\fR
1841 \fBconfig file (G)\fR
1842 This allows you to override the config file
1843 to use, instead of the default (usually \fIsmb.conf\fR).
1844 There is a chicken and egg problem here as this option is set
1847 For this reason, if the name of the config file has changed
1848 when the parameters are loaded then it will reload them from
1849 the new config file.
1851 This option takes the usual substitutions, which can
1854 If the config file doesn't exist then it won't be loaded
1855 (allowing you to special case the config files of just a few
1858 Example: \fBconfig file = /usr/local/samba/lib/smb.conf.%m
1861 This parameter allows you to "clone" service
1862 entries. The specified service is simply duplicated under the
1863 current service's name. Any parameters specified in the current
1864 section will override those in the section being copied.
1866 This feature lets you set up a 'template' service and
1867 create similar services easily. Note that the service being
1868 copied must occur earlier in the configuration file than the
1869 service doing the copying.
1871 Default: \fBno value\fR
1873 Example: \fBcopy = otherservice\fR
1875 \fBcreate mask (S)\fR
1876 A synonym for this parameter is
1880 When a file is created, the necessary permissions are
1881 calculated according to the mapping from DOS modes to UNIX
1882 permissions, and the resulting UNIX mode is then bit-wise 'AND'ed
1883 with this parameter. This parameter may be thought of as a bit-wise
1884 MASK for the UNIX modes of a file. Any bit \fBnot\fR
1885 set here will be removed from the modes set on a file when it is
1888 The default value of this parameter removes the
1889 \&'group' and 'other' write and execute bits from the UNIX modes.
1891 Following this Samba will bit-wise 'OR' the UNIX mode created
1892 from this parameter with the value of the \fIforce create mode\fR
1893 parameter which is set to 000 by default.
1895 This parameter does not affect directory modes. See the
1896 parameter \fIdirectory mode
1899 See also the \fIforce
1900 create mode\fR parameter for forcing particular mode
1901 bits to be set on created files. See also the \fIdirectory mode"\fR parameter for masking
1902 mode bits on created directories. See also the \fIinherit permissions\fR parameter.
1904 Default: \fBcreate mask = 0744\fR
1906 Example: \fBcreate mask = 0775\fR
1908 \fBcreate mode (S)\fR
1909 This is a synonym for \fI create mask\fR.
1912 The value of the parameter (a decimal integer)
1913 represents the number of minutes of inactivity before a connection
1914 is considered dead, and it is disconnected. The deadtime only takes
1915 effect if the number of open files is zero.
1917 This is useful to stop a server's resources being
1918 exhausted by a large number of inactive connections.
1920 Most clients have an auto-reconnect feature when a
1921 connection is broken so in most cases this parameter should be
1922 transparent to users.
1924 Using this parameter with a timeout of a few minutes
1925 is recommended for most systems.
1927 A deadtime of zero indicates that no auto-disconnection
1928 should be performed.
1930 Default: \fBdeadtime = 0\fR
1932 Example: \fBdeadtime = 15\fR
1934 \fBdebug hires timestamp (G)\fR
1935 Sometimes the timestamps in the log messages
1936 are needed with a resolution of higher that seconds, this
1937 boolean parameter adds microsecond resolution to the timestamp
1938 message header when turned on.
1940 Note that the parameter \fI debug timestamp\fR must be on for this to have an
1943 Default: \fBdebug hires timestamp = no\fR
1946 When using only one log file for more then one
1947 forked smbd-process there may be hard to follow which process
1948 outputs which message. This boolean parameter is adds the process-id
1949 to the timestamp message headers in the logfile when turned on.
1951 Note that the parameter \fI debug timestamp\fR must be on for this to have an
1954 Default: \fBdebug pid = no\fR
1956 \fBdebug timestamp (G)\fR
1957 Samba 2.2 debug log messages are timestamped
1958 by default. If you are running at a high \fIdebug level\fR these timestamps
1959 can be distracting. This boolean parameter allows timestamping
1962 Default: \fBdebug timestamp = yes\fR
1965 Samba is sometimes run as root and sometime
1966 run as the connected user, this boolean parameter inserts the
1967 current euid, egid, uid and gid to the timestamp message headers
1968 in the log file if turned on.
1970 Note that the parameter \fI debug timestamp\fR must be on for this to have an
1973 Default: \fBdebug uid = no\fR
1975 \fBdebuglevel (G)\fR
1976 The value of the parameter (an integer) allows
1977 the debug level (logging level) to be specified in the
1978 \fIsmb.conf\fR file. This is to give greater
1979 flexibility in the configuration of the system.
1981 The default will be the debug level specified on
1982 the command line or level zero if none was specified.
1984 Example: \fBdebug level = 3\fR
1987 A synonym for \fI default service\fR.
1989 \fBdefault case (S)\fR
1990 See the section on NAME MANGLING. Also note the \fIshort preserve case"\fR parameter.
1992 Default: \fBdefault case = lower\fR
1994 \fBdefault service (G)\fR
1995 This parameter specifies the name of a service
1996 which will be connected to if the service actually requested cannot
1997 be found. Note that the square brackets are \fBNOT\fR
1998 given in the parameter value (see example below).
2000 There is no default value for this parameter. If this
2001 parameter is not given, attempting to connect to a nonexistent
2002 service results in an error.
2004 Typically the default service would be a \fIguest ok\fR, \fIread-only\fR service.
2006 Also note that the apparent service name will be changed
2007 to equal that of the requested service, this is very useful as it
2008 allows you to use macros like \fI%S\fR to make
2011 Note also that any "_" characters in the name of the service
2012 used in the default service will get mapped to a "/". This allows for
2020 default service = pub
2028 \fBdelete readonly (S)\fR
2029 This parameter allows readonly files to be deleted.
2030 This is not normal DOS semantics, but is allowed by UNIX.
2032 This option may be useful for running applications such
2033 as rcs, where UNIX file ownership prevents changing file
2034 permissions, and DOS semantics prevent deletion of a read only file.
2036 Default: \fBdelete readonly = no\fR
2038 \fBdelete user script (G)\fR
2039 This is the full pathname to a script that will
2040 be run \fBAS ROOT\fR by \fBsmbd(8)\fRunder special circumstances
2043 Normally, a Samba server requires that UNIX users are
2044 created for all users accessing files on this server. For sites
2045 that use Windows NT account databases as their primary user database
2046 creating these users and keeping the user list in sync with the
2047 Windows NT PDC is an onerous task. This option allows \fB smbd\fR to delete the required UNIX users \fBON
2048 DEMAND\fR when a user accesses the Samba server and the
2049 Windows NT user no longer exists.
2051 In order to use this option, \fBsmbd\fR must be
2052 set to \fIsecurity=domain\fR and \fIdelete
2053 user script\fR must be set to a full pathname for a script
2054 that will delete a UNIX user given one argument of \fI%u
2055 \fR, which expands into the UNIX user name to delete.
2056 \fBNOTE\fR that this is different to the \fIadd user script\fR
2057 which will work with the \fIsecurity=server\fR option
2058 as well as \fIsecurity=domain\fR. The reason for this
2059 is only when Samba is a domain member does it get the information
2060 on an attempted user logon that a user no longer exists. In the
2061 \fIsecurity=server\fR mode a missing user
2062 is treated the same as an invalid password logon attempt. Deleting
2063 the user in this circumstance would not be a good idea.
2065 When the Windows user attempts to access the Samba server,
2066 at \fBlogin\fR (session setup in the SMB protocol)
2067 time, \fBsmbd\fR contacts the \fIpassword server\fR and attempts to authenticate
2068 the given user with the given password. If the authentication fails
2069 with the specific Domain error code meaning that the user no longer
2070 exists then \fBsmbd\fR attempts to find a UNIX user in
2071 the UNIX password database that matches the Windows user account. If
2072 this lookup succeeds, and \fIdelete user script\fR is
2073 set then \fBsmbd\fR will all the specified script
2074 \fBAS ROOT\fR, expanding any \fI%u\fR
2075 argument to be the user name to delete.
2077 This script should delete the given UNIX username. In this way,
2078 UNIX users are dynamically deleted to match existing Windows NT
2081 See also security=domain,
2082 \fIpassword server\fR
2083 , \fIadd user script\fR
2086 Default: \fBdelete user script = <empty string>
2088 Example: \fBdelete user script = /usr/local/samba/bin/del_user
2091 \fBdeleteprinter command (G)\fR
2092 With the introduction of MS-RPC based printer
2093 support for Windows NT/2000 clients in Samba 2.2, it is now
2094 possible to delete printer at run time by issuing the
2095 DeletePrinter() RPC call.
2097 For a Samba host this means that the printer must be
2098 physically deleted from underlying printing system. The \fI deleteprinter command\fR defines a script to be run which
2099 will perform the necessary operations for removing the printer
2100 from the print system and from \fIsmb.conf\fR.
2102 The \fIdeleteprinter command\fR is
2103 automatically called with only one parameter: \fI "printer name"\fR.
2105 Once the \fIdeleteprinter command\fR has
2106 been executed, \fBsmbd\fR will reparse the \fI smb.conf\fR to associated printer no longer exists.
2107 If the sharename is still valid, then \fBsmbd
2108 \fRwill return an ACCESS_DENIED error to the client.
2110 See also \fI addprinter command\fR, \fIprinting\fR,
2116 Example: \fBdeleteprinter command = /usr/bin/removeprinter
2118 \fBdelete veto files (S)\fR
2119 This option is used when Samba is attempting to
2120 delete a directory that contains one or more vetoed directories
2121 (see the \fIveto files\fR
2122 option). If this option is set to False (the default) then if a vetoed
2123 directory contains any non-vetoed files or directories then the
2124 directory delete will fail. This is usually what you want.
2126 If this option is set to True, then Samba
2127 will attempt to recursively delete any files and directories within
2128 the vetoed directory. This can be useful for integration with file
2129 serving systems such as NetAtalk which create meta-files within
2130 directories you might normally veto DOS/Windows users from seeing
2131 (e.g. \fI.AppleDouble\fR)
2133 Setting \fBdelete veto files = yes\fR allows these
2134 directories to be transparently deleted when the parent directory
2135 is deleted (so long as the user has permissions to do so).
2137 See also the \fIveto
2140 Default: \fBdelete veto files = no\fR
2142 \fBdeny hosts (S)\fR
2143 Synonym for \fIhosts
2146 \fBdfree command (G)\fR
2147 The \fIdfree command\fR setting should
2148 only be used on systems where a problem occurs with the internal
2149 disk space calculations. This has been known to happen with Ultrix,
2150 but may occur with other operating systems. The symptom that was
2151 seen was an error of "Abort Retry Ignore" at the end of each
2154 This setting allows the replacement of the internal routines to
2155 calculate the total disk space and amount available with an external
2156 routine. The example below gives a possible script that might fulfill
2159 The external program will be passed a single parameter indicating
2160 a directory in the filesystem being queried. This will typically consist
2161 of the string \fI./\fR. The script should return two
2162 integers in ASCII. The first should be the total disk space in blocks,
2163 and the second should be the number of available blocks. An optional
2164 third return value can give the block size in bytes. The default
2165 blocksize is 1024 bytes.
2167 Note: Your script should \fBNOT\fR be setuid or
2168 setgid and should be owned by (and writeable only by) root!
2170 Default: \fBBy default internal routines for
2171 determining the disk capacity and remaining space will be used.
2173 Example: \fBdfree command = /usr/local/samba/bin/dfree
2175 Where the script dfree (which must be made executable) could be:
2181 df $1 | tail -1 | awk '{print $2" "$4}'
2186 or perhaps (on Sys V based systems):
2192 /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
2197 Note that you may have to replace the command names
2198 with full path names on some systems.
2204 \fBdirectory mask (S)\fR
2205 This parameter is the octal modes which are
2206 used when converting DOS modes to UNIX modes when creating UNIX
2209 When a directory is created, the necessary permissions are
2210 calculated according to the mapping from DOS modes to UNIX permissions,
2211 and the resulting UNIX mode is then bit-wise 'AND'ed with this
2212 parameter. This parameter may be thought of as a bit-wise MASK for
2213 the UNIX modes of a directory. Any bit \fBnot\fR set
2214 here will be removed from the modes set on a directory when it is
2217 The default value of this parameter removes the 'group'
2218 and 'other' write bits from the UNIX mode, allowing only the
2219 user who owns the directory to modify it.
2221 Following this Samba will bit-wise 'OR' the UNIX mode
2222 created from this parameter with the value of the \fIforce directory mode
2223 \fRparameter. This parameter is set to 000 by
2224 default (i.e. no extra mode bits are added).
2227 directory mode\fR parameter to cause particular mode
2228 bits to always be set on created directories.
2230 See also the \fIcreate mode
2231 \fRparameter for masking mode bits on created files,
2232 and the \fIdirectory
2233 security mask\fR parameter.
2235 Also refer to the \fI inherit permissions\fR parameter.
2237 Default: \fBdirectory mask = 0755\fR
2239 Example: \fBdirectory mask = 0775\fR
2241 \fBdirectory mode (S)\fR
2242 Synonym for \fI directory mask\fR
2244 \fBdirectory security mask (S)\fR
2245 This parameter controls what UNIX permission bits
2246 can be modified when a Windows NT client is manipulating the UNIX
2247 permission on a directory using the native NT security dialog
2250 This parameter is applied as a mask (AND'ed with) to
2251 the changed permission bits, thus preventing any bits not in
2252 this mask from being modified. Essentially, zero bits in this
2253 mask may be treated as a set of bits the user is not allowed
2256 If not set explicitly this parameter is set to the same
2257 value as the \fIdirectory
2258 mask\fR parameter. To allow a user to
2259 modify all the user/group/world permissions on a directory, set
2260 this parameter to 0777.
2262 \fBNote\fR that users who can access the
2263 Samba server through other means can easily bypass this restriction,
2264 so it is primarily useful for standalone "appliance" systems.
2265 Administrators of most normal systems will probably want to set
2268 See also the \fI force directory security mode\fR, \fIsecurity mask\fR,
2269 \fIforce security mode
2272 Default: \fBdirectory security mask = <same as
2275 Example: \fBdirectory security mask = 0777\fR
2278 Specifies that nmbd(8)when acting as a WINS server and finding that a NetBIOS name has not
2279 been registered, should treat the NetBIOS name word-for-word as a DNS
2280 name and do a lookup with the DNS server for that name on behalf of
2281 the name-querying client.
2283 Note that the maximum length for a NetBIOS name is 15
2284 characters, so the DNS name (or DNS alias) can likewise only be
2285 15 characters, maximum.
2287 \fBnmbd\fR spawns a second copy of itself to do the
2288 DNS name lookup requests, as doing a name lookup is a blocking
2291 See also the parameter \fI wins support\fR.
2293 Default: \fBdns proxy = yes\fR
2295 \fBdomain admin group (G)\fR
2296 This is an \fBEXPERIMENTAL\fR parameter
2297 that is part of the unfinished Samba NT Domain Controller Code. It may
2298 be removed in a later release. To work with the latest code builds
2299 that may have more support for Samba NT Domain Controller functionality
2300 please subscribe to the mailing list samba-ntdom <URL:mailto:samba-ntdom@samba.org> available by
2301 visiting the web page at http://lists.samba.org/ <URL:http://lists.samba.org/>.
2303 \fBdomain admin users (G)\fR
2304 This is an \fBEXPERIMENTAL\fR parameter
2305 that is part of the unfinished Samba NT Domain Controller Code. It may
2306 be removed in a later release. To work with the latest code builds
2307 that may have more support for Samba NT Domain Controller functionality
2308 please subscribe to the mailing list samba-ntdom <URL:mailto:samba-ntdom@samba.org> available by
2309 visiting the web page at http://lists.samba.org/ <URL:http://lists.samba.org/>.
2311 \fBdomain groups (G)\fR
2312 This is an \fBEXPERIMENTAL\fR parameter
2313 that is part of the unfinished Samba NT Domain Controller Code. It may
2314 be removed in a later release. To work with the latest code builds
2315 that may have more support for Samba NT Domain Controller functionality
2316 please subscribe to the mailing list samba-ntdom <URL:mailto:samba-ntdom@samba.org> available by
2317 visiting the web page at http://lists.samba.org/ <URL:http://lists.samba.org/>.
2319 \fBdomain guest group (G)\fR
2320 This is an \fBEXPERIMENTAL\fR parameter
2321 that is part of the unfinished Samba NT Domain Controller Code. It may
2322 be removed in a later release. To work with the latest code builds
2323 that may have more support for Samba NT Domain Controller functionality
2324 please subscribe to the mailing list samba-ntdom <URL:mailto:samba-ntdom@samba.org> available by
2325 visiting the web page at http://lists.samba.org/ <URL:http://lists.samba.org/>.
2327 \fBdomain guest users (G)\fR
2328 This is an \fBEXPERIMENTAL\fR parameter
2329 that is part of the unfinished Samba NT Domain Controller Code. It may
2330 be removed in a later release. To work with the latest code builds
2331 that may have more support for Samba NT Domain Controller functionality
2332 please subscribe to the mailing list samba-ntdom <URL:mailto:samba-ntdom@samba.org> available by
2333 visiting the web page at http://lists.samba.org/ <URL:http://lists.samba.org/>.
2335 \fBdomain logons (G)\fR
2336 If set to true, the Samba server will serve
2337 Windows 95/98 Domain logons for the \fIworkgroup\fR it is in. Samba 2.2 also
2338 has limited capability to act as a domain controller for Windows
2339 NT 4 Domains. For more details on setting up this feature see
2340 the file DOMAINS.txt in the Samba documentation directory \fIdocs/
2341 \fRshipped with the source code.
2343 Default: \fBdomain logons = no\fR
2345 \fBdomain master (G)\fR
2346 Tell \fB nmbd(8)\fRto enable WAN-wide browse list
2347 collation. Setting this option causes \fBnmbd\fR to
2348 claim a special domain specific NetBIOS name that identifies
2349 it as a domain master browser for its given \fIworkgroup\fR. Local master browsers
2350 in the same \fIworkgroup\fR on broadcast-isolated
2351 subnets will give this \fBnmbd\fR their local browse lists,
2352 and then ask \fBsmbd(8)\fRfor a complete copy of the browse list for the whole wide area
2353 network. Browser clients will then contact their local master browser,
2354 and will receive the domain-wide browse list, instead of just the list
2355 for their broadcast-isolated subnet.
2357 Note that Windows NT Primary Domain Controllers expect to be
2358 able to claim this \fIworkgroup\fR specific special
2359 NetBIOS name that identifies them as domain master browsers for
2360 that \fIworkgroup\fR by default (i.e. there is no
2361 way to prevent a Windows NT PDC from attempting to do this). This
2362 means that if this parameter is set and \fBnmbd\fR claims
2363 the special name for a \fIworkgroup\fR before a Windows
2364 NT PDC is able to do so then cross subnet browsing will behave
2365 strangely and may fail.
2367 If \fBdomain logons = yes\fR
2368 , then the default behavior is to enable the \fIdomain
2369 master\fR parameter. If \fIdomain logons\fR is
2370 not enabled (the default setting), then neither will \fIdomain
2371 master\fR be enabled by default.
2373 Default: \fBdomain master = auto\fR
2375 \fBdont descend (S)\fR
2376 There are certain directories on some systems
2377 (e.g., the \fI/proc\fR tree under Linux) that are either not
2378 of interest to clients or are infinitely deep (recursive). This
2379 parameter allows you to specify a comma-delimited list of directories
2380 that the server should always show as empty.
2382 Note that Samba can be very fussy about the exact format
2383 of the "dont descend" entries. For example you may need \fI ./proc\fR instead of just \fI/proc\fR.
2384 Experimentation is the best policy :-)
2386 Default: \fBnone (i.e., all directories are OK
2389 Example: \fBdont descend = /proc,/dev\fR
2391 \fBdos filemode (S)\fR
2392 The default behavior in Samba is to provide
2393 UNIX-like behavor where only the owner of a file/directory is
2394 able to change the permissions on it. However, this behavior
2395 is often confusing to DOS/Windows users. Enabling this parameter
2396 allows a user who has write access to the file (by whatever
2397 means) to modify the permissions on it. Note that a user
2398 belonging to the group owning the file will not be allowed to
2399 change permissions if the group is only granted read access.
2400 Ownership of the file/directory is not changed, only the permissions
2403 Default: \fBdos filemode = no\fR
2405 \fBdos filetime resolution (S)\fR
2406 Under the DOS and Windows FAT filesystem, the finest
2407 granularity on time resolution is two seconds. Setting this parameter
2408 for a share causes Samba to round the reported time down to the
2409 nearest two second boundary when a query call that requires one second
2410 resolution is made to \fBsmbd(8)\fR
2413 This option is mainly used as a compatibility option for Visual
2414 C++ when used against Samba shares. If oplocks are enabled on a
2415 share, Visual C++ uses two different time reading calls to check if a
2416 file has changed since it was last read. One of these calls uses a
2417 one-second granularity, the other uses a two second granularity. As
2418 the two second call rounds any odd second down, then if the file has a
2419 timestamp of an odd number of seconds then the two timestamps will not
2420 match and Visual C++ will keep reporting the file has changed. Setting
2421 this option causes the two timestamps to match, and Visual C++ is
2424 Default: \fBdos filetime resolution = no\fR
2426 \fBdos filetimes (S)\fR
2427 Under DOS and Windows, if a user can write to a
2428 file they can change the timestamp on it. Under POSIX semantics,
2429 only the owner of the file or root may change the timestamp. By
2430 default, Samba runs with POSIX semantics and refuses to change the
2431 timestamp on a file if the user \fBsmbd\fR is acting
2432 on behalf of is not the file owner. Setting this option to True allows DOS semantics and smbd will change the file
2433 timestamp as DOS requires.
2435 Default: \fBdos filetimes = no\fR
2437 \fBencrypt passwords (G)\fR
2438 This boolean controls whether encrypted passwords
2439 will be negotiated with the client. Note that Windows NT 4.0 SP3 and
2440 above and also Windows 98 will by default expect encrypted passwords
2441 unless a registry entry is changed. To use encrypted passwords in
2442 Samba see the file ENCRYPTION.txt in the Samba documentation
2443 directory \fIdocs/\fR shipped with the source code.
2445 In order for encrypted passwords to work correctly
2446 \fBsmbd(8)\fRmust either
2447 have access to a local \fIsmbpasswd(5)
2448 \fRprogram for information on how to set up
2449 and maintain this file), or set the security=[serve|domain] parameter which
2450 causes \fBsmbd\fR to authenticate against another
2453 Default: \fBencrypt passwords = no\fR
2455 \fBenhanced browsing (G)\fR
2456 This option enables a couple of enhancements to
2457 cross-subnet browse propogation that have been added in Samba
2458 but which are not standard in Microsoft implementations.
2459 \fBThese enhancements are currently only available in
2460 the HEAD Samba CVS tree (not Samba 2.2.x).\fR
2462 The first enhancement to browse propogation consists of a regular
2463 wildcard query to a Samba WINS server for all Domain Master Browsers,
2464 followed by a browse synchronisation with each of the returned
2465 DMBs. The second enhancement consists of a regular randomised browse
2466 synchronisation with all currently known DMBs.
2468 You may wish to disable this option if you have a problem with empty
2469 workgroups not disappearing from browse lists. Due to the restrictions
2470 of the browse protocols these enhancements can cause a empty workgroup
2471 to stay around forever which can be annoying.
2473 In general you should leave this option enabled as it makes
2474 cross-subnet browse propogation much more reliable.
2476 Default: \fBenhanced browsing = yes\fR
2478 \fBenumports command (G)\fR
2479 The concept of a "port" is fairly foreign
2480 to UNIX hosts. Under Windows NT/2000 print servers, a port
2481 is associated with a port monitor and generally takes the form of
2482 a local port (i.e. LPT1:, COM1:, FILE:) or a remote port
2483 (i.e. LPD Port Monitor, etc...). By default, Samba has only one
2484 port defined--"Samba Printer Port". Under
2485 Windows NT/2000, all printers must have a valid port name.
2486 If you wish to have a list of ports displayed (\fBsmbd
2487 \fRdoes not use a port name for anything) other than
2488 the default "Samba Printer Port", you
2489 can define \fIenumports command\fR to point to
2490 a program which should generate a list of ports, one per line,
2491 to standard output. This listing will then be used in response
2492 to the level 1 and 2 EnumPorts() RPC.
2494 Default: \fBno enumports command\fR
2496 Example: \fBenumports command = /usr/bin/listports
2499 This is a synonym for \fIpreexec\fR.
2501 \fBfake directory create times (S)\fR
2502 NTFS and Windows VFAT file systems keep a create
2503 time for all files and directories. This is not the same as the
2504 ctime - status change time - that Unix keeps, so Samba by default
2505 reports the earliest of the various times Unix does keep. Setting
2506 this parameter for a share causes Samba to always report midnight
2507 1-1-1980 as the create time for directories.
2509 This option is mainly used as a compatibility option for
2510 Visual C++ when used against Samba shares. Visual C++ generated
2511 makefiles have the object directory as a dependency for each object
2512 file, and a make rule to create the directory. Also, when NMAKE
2513 compares timestamps it uses the creation time when examining a
2514 directory. Thus the object directory will be created if it does not
2515 exist, but once it does exist it will always have an earlier
2516 timestamp than the object files it contains.
2518 However, Unix time semantics mean that the create time
2519 reported by Samba will be updated whenever a file is created or
2520 or deleted in the directory. NMAKE finds all object files in
2521 the object directory. The timestamp of the last one built is then
2522 compared to the timestamp of the object dircetory. If the
2523 directory's timestamp if newer, then all object files
2524 will be rebuilt. Enabling this option
2525 ensures directories always predate their contents and an NMAKE build
2526 will proceed as expected.
2528 Default: \fBfake directory create times = no\fR
2530 \fBfake oplocks (S)\fR
2531 Oplocks are the way that SMB clients get permission
2532 from a server to locally cache file operations. If a server grants
2533 an oplock (opportunistic lock) then the client is free to assume
2534 that it is the only one accessing the file and it will aggressively
2535 cache file data. With some oplock types the client may even cache
2536 file open/close operations. This can give enormous performance benefits.
2538 When you set \fBfake oplocks = yes\fR, \fBsmbd(8)\fRwill
2539 always grant oplock requests no matter how many clients are using
2542 It is generally much better to use the real \fIoplocks\fR support rather
2543 than this parameter.
2545 If you enable this option on all read-only shares or
2546 shares that you know will only be accessed from one client at a
2547 time such as physically read-only media like CDROMs, you will see
2548 a big performance improvement on many operations. If you enable
2549 this option on shares where multiple clients may be accessing the
2550 files read-write at the same time you can get data corruption. Use
2551 this option carefully!
2553 Default: \fBfake oplocks = no\fR
2555 \fBfollow symlinks (S)\fR
2556 This parameter allows the Samba administrator
2557 to stop \fBsmbd(8)\fRfrom following symbolic links in a particular share. Setting this
2558 parameter to no prevents any file or directory
2559 that is a symbolic link from being followed (the user will get an
2560 error). This option is very useful to stop users from adding a
2561 symbolic link to \fI/etc/passwd\fR in their home
2562 directory for instance. However it will slow filename lookups
2565 This option is enabled (i.e. \fBsmbd\fR will
2566 follow symbolic links) by default.
2568 Default: \fBfollow symlinks = yes\fR
2570 \fBforce create mode (S)\fR
2571 This parameter specifies a set of UNIX mode bit
2572 permissions that will \fBalways\fR be set on a
2573 file created by Samba. This is done by bitwise 'OR'ing these bits onto
2574 the mode bits of a file that is being created or having its
2575 permissions changed. The default for this parameter is (in octal)
2576 000. The modes in this parameter are bitwise 'OR'ed onto the file
2577 mode after the mask set in the \fIcreate mask\fR
2578 parameter is applied.
2580 See also the parameter \fIcreate
2581 mask\fR for details on masking mode bits on files.
2583 See also the \fIinherit
2584 permissions\fR parameter.
2586 Default: \fBforce create mode = 000\fR
2588 Example: \fBforce create mode = 0755\fR
2590 would force all created files to have read and execute
2591 permissions set for 'group' and 'other' as well as the
2592 read/write/execute bits set for the 'user'.
2594 \fBforce directory mode (S)\fR
2595 This parameter specifies a set of UNIX mode bit
2596 permissions that will \fBalways\fR be set on a directory
2597 created by Samba. This is done by bitwise 'OR'ing these bits onto the
2598 mode bits of a directory that is being created. The default for this
2599 parameter is (in octal) 0000 which will not add any extra permission
2600 bits to a created directory. This operation is done after the mode
2601 mask in the parameter \fIdirectory mask\fR is
2604 See also the parameter \fI directory mask\fR for details on masking mode bits
2605 on created directories.
2607 See also the \fI inherit permissions\fR parameter.
2609 Default: \fBforce directory mode = 000\fR
2611 Example: \fBforce directory mode = 0755\fR
2613 would force all created directories to have read and execute
2614 permissions set for 'group' and 'other' as well as the
2615 read/write/execute bits set for the 'user'.
2617 \fBforce directory security mode (S)\fR
2618 This parameter controls what UNIX permission bits
2619 can be modified when a Windows NT client is manipulating the UNIX
2620 permission on a directory using the native NT security dialog box.
2622 This parameter is applied as a mask (OR'ed with) to the
2623 changed permission bits, thus forcing any bits in this mask that
2624 the user may have modified to be on. Essentially, one bits in this
2625 mask may be treated as a set of bits that, when modifying security
2626 on a directory, the user has always set to be 'on'.
2628 If not set explicitly this parameter is set to the same
2629 value as the \fIforce
2630 directory mode\fR parameter. To allow
2631 a user to modify all the user/group/world permissions on a
2632 directory without restrictions, set this parameter to 000.
2634 \fBNote\fR that users who can access the
2635 Samba server through other means can easily bypass this restriction,
2636 so it is primarily useful for standalone "appliance" systems.
2637 Administrators of most normal systems will probably want to set
2640 See also the \fI directory security mask\fR, \fIsecurity mask\fR,
2641 \fIforce security mode
2644 Default: \fBforce directory security mode = <same as
2645 force directory mode>\fR
2647 Example: \fBforce directory security mode = 0\fR
2649 \fBforce group (S)\fR
2650 This specifies a UNIX group name that will be
2651 assigned as the default primary group for all users connecting
2652 to this service. This is useful for sharing files by ensuring
2653 that all access to files on service will use the named group for
2654 their permissions checking. Thus, by assigning permissions for this
2655 group to the files and directories within this service the Samba
2656 administrator can restrict or allow sharing of these files.
2658 In Samba 2.0.5 and above this parameter has extended
2659 functionality in the following way. If the group name listed here
2660 has a '+' character prepended to it then the current user accessing
2661 the share only has the primary group default assigned to this group
2662 if they are already assigned as a member of that group. This allows
2663 an administrator to decide that only users who are already in a
2664 particular group will create files with group ownership set to that
2665 group. This gives a finer granularity of ownership assignment. For
2666 example, the setting \fIforce group = +sys\fR means
2667 that only users who are already in group sys will have their default
2668 primary group assigned to sys when accessing this Samba share. All
2669 other users will retain their ordinary primary group.
2671 If the \fIforce user
2672 \fRparameter is also set the group specified in
2673 \fIforce group\fR will override the primary group
2674 set in \fIforce user\fR.
2679 Default: \fBno forced group\fR
2681 Example: \fBforce group = agroup\fR
2683 \fBforce security mode (S)\fR
2684 This parameter controls what UNIX permission
2685 bits can be modified when a Windows NT client is manipulating
2686 the UNIX permission on a file using the native NT security dialog
2689 This parameter is applied as a mask (OR'ed with) to the
2690 changed permission bits, thus forcing any bits in this mask that
2691 the user may have modified to be on. Essentially, one bits in this
2692 mask may be treated as a set of bits that, when modifying security
2693 on a file, the user has always set to be 'on'.
2695 If not set explicitly this parameter is set to the same
2696 value as the \fIforce
2697 create mode\fR parameter. To allow a user to
2698 modify all the user/group/world permissions on a file, with no
2699 restrictions set this parameter to 000.
2701 \fBNote\fR that users who can access
2702 the Samba server through other means can easily bypass this restriction,
2703 so it is primarily useful for standalone "appliance" systems.
2704 Administrators of most normal systems will probably want to set
2707 See also the \fI force directory security mode\fR,
2708 \fIdirectory security
2709 mask\fR, \fI security mask\fR parameters.
2711 Default: \fBforce security mode = <same as force
2714 Example: \fBforce security mode = 0\fR
2716 \fBforce user (S)\fR
2717 This specifies a UNIX user name that will be
2718 assigned as the default user for all users connecting to this service.
2719 This is useful for sharing files. You should also use it carefully
2720 as using it incorrectly can cause security problems.
2722 This user name only gets used once a connection is established.
2723 Thus clients still need to connect as a valid user and supply a
2724 valid password. Once connected, all file operations will be performed
2725 as the "forced user", no matter what username the client connected
2726 as. This can be very useful.
2728 In Samba 2.0.5 and above this parameter also causes the
2729 primary group of the forced user to be used as the primary group
2730 for all file activity. Prior to 2.0.5 the primary group was left
2731 as the primary group of the connecting user (this was a bug).
2733 See also \fIforce group
2735 Default: \fBno forced user\fR
2737 Example: \fBforce user = auser\fR
2740 This parameter allows the administrator to
2741 configure the string that specifies the type of filesystem a share
2742 is using that is reported by \fBsmbd(8)
2743 \fRwhen a client queries the filesystem type
2744 for a share. The default type is NTFS for
2745 compatibility with Windows NT but this can be changed to other
2746 strings such as Samba or FAT
2749 Default: \fBfstype = NTFS\fR
2751 Example: \fBfstype = Samba\fR
2753 \fBgetwd cache (G)\fR
2754 This is a tuning option. When this is enabled a
2755 caching algorithm will be used to reduce the time taken for getwd()
2756 calls. This can have a significant impact on performance, especially
2757 when the \fIwide links\fR
2758 parameter is set to False.
2760 Default: \fBgetwd cache = yes\fR
2763 Synonym for \fIforce
2766 \fBguest account (S)\fR
2767 This is a username which will be used for access
2768 to services which are specified as \fI guest ok\fR (see below). Whatever privileges this
2769 user has will be available to any client connecting to the guest service.
2770 Typically this user will exist in the password file, but will not
2771 have a valid login. The user account "ftp" is often a good choice
2772 for this parameter. If a username is specified in a given service,
2773 the specified username overrides this one.
2775 One some systems the default guest account "nobody" may not
2776 be able to print. Use another account in this case. You should test
2777 this by trying to log in as your guest user (perhaps by using the
2778 \fBsu -\fR command) and trying to print using the
2779 system print command such as \fBlpr(1)\fR or \fB lp(1)\fR.
2781 Default: \fBspecified at compile time, usually
2784 Example: \fBguest account = ftp\fR
2787 If this parameter is yes for
2788 a service, then no password is required to connect to the service.
2789 Privileges will be those of the \fI guest account\fR.
2791 See the section below on \fI security\fR for more information about this option.
2793 Default: \fBguest ok = no\fR
2795 \fBguest only (S)\fR
2796 If this parameter is yes for
2797 a service, then only guest connections to the service are permitted.
2798 This parameter will have no effect if \fIguest ok\fR is not set for the service.
2800 See the section below on \fI security\fR for more information about this option.
2802 Default: \fBguest only = no\fR
2804 \fBhide dot files (S)\fR
2805 This is a boolean parameter that controls whether
2806 files starting with a dot appear as hidden files.
2808 Default: \fBhide dot files = yes\fR
2811 This is a list of files or directories that are not
2812 visible but are accessible. The DOS 'hidden' attribute is applied
2813 to any files or directories that match.
2815 Each entry in the list must be separated by a '/',
2816 which allows spaces to be included in the entry. '*'
2817 and '?' can be used to specify multiple files or directories
2818 as in DOS wildcards.
2820 Each entry must be a Unix path, not a DOS path and must
2821 not include the Unix directory separator '/'.
2823 Note that the case sensitivity option is applicable
2826 Setting this parameter will affect the performance of Samba,
2827 as it will be forced to check all files and directories for a match
2828 as they are scanned.
2831 dot files\fR, \fI veto files\fR and \fIcase sensitive\fR.
2833 Default: \fBno file are hidden\fR
2835 Example: \fBhide files =
2836 /.*/DesktopFolderDB/TrashFor%m/resource.frk/\fR
2838 The above example is based on files that the Macintosh
2839 SMB client (DAVE) available from
2840 Thursby <URL:http://www.thursby.com> creates for internal use, and also still hides
2841 all files beginning with a dot.
2843 \fBhide local users(G)\fR
2844 This parameter toggles the hiding of local UNIX
2845 users (root, wheel, floppy, etc) from remote clients.
2847 Default: \fBhide local users = no\fR
2849 \fBhomedir map (G)\fR
2851 \fRis True, and \fBsmbd(8)\fRis also acting
2852 as a Win95/98 \fIlogon server\fR then this parameter
2853 specifies the NIS (or YP) map from which the server for the user's
2854 home directory should be extracted. At present, only the Sun
2855 auto.home map format is understood. The form of the map is:
2857 \fBusername server:/some/file/system\fR
2859 and the program will extract the servername from before
2860 the first ':'. There should probably be a better parsing system
2861 that copes with different map formats and also Amd (another
2864 \fBNOTE :\fRA working NIS client is required on
2865 the system for this option to work.
2867 See also \fInis homedir\fR
2868 , \fIdomain logons\fR
2871 Default: \fBhomedir map = <empty string>\fR
2873 Example: \fBhomedir map = amd.homedir\fR
2875 \fBhost msdfs (G)\fR
2876 This boolean parameter is only available
2877 if Samba has been configured and compiled with the \fB --with-msdfs\fR option. If set to yes,
2878 Samba will act as a Dfs server, and allow Dfs-aware clients
2879 to browse Dfs trees hosted on the server.
2881 See also the \fI msdfs root\fR share level parameter. For
2882 more information on setting up a Dfs tree on Samba,
2883 refer to msdfs_setup.html.
2885 Default: \fBhost msdfs = no\fR
2887 \fBhosts allow (S)\fR
2888 A synonym for this parameter is \fIallow
2891 This parameter is a comma, space, or tab delimited
2892 set of hosts which are permitted to access a service.
2894 If specified in the [global] section then it will
2895 apply to all services, regardless of whether the individual
2896 service has a different setting.
2898 You can specify the hosts by name or IP number. For
2899 example, you could restrict access to only the hosts on a
2900 Class C subnet with something like \fBallow hosts = 150.203.5.
2901 \fR\&. The full syntax of the list is described in the man
2902 page \fIhosts_access(5)\fR. Note that this man
2903 page may not be present on your system, so a brief description will
2906 Note that the localhost address 127.0.0.1 will always
2907 be allowed access unless specifically denied by a \fIhosts deny\fR option.
2909 You can also specify hosts by network/netmask pairs and
2910 by netgroup names if your system supports netgroups. The
2911 \fBEXCEPT\fR keyword can also be used to limit a
2912 wildcard list. The following examples may provide some help:
2914 Example 1: allow all IPs in 150.203.*.*; except one
2916 \fBhosts allow = 150.203. EXCEPT 150.203.6.66\fR
2918 Example 2: allow hosts that match the given network/netmask
2920 \fBhosts allow = 150.203.15.0/255.255.255.0\fR
2922 Example 3: allow a couple of hosts
2924 \fBhosts allow = lapland, arvidsjaur\fR
2926 Example 4: allow only hosts in NIS netgroup "foonet", but
2927 deny access from one particular host
2929 \fBhosts allow = @foonet\fR
2931 \fBhosts deny = pirate\fR
2933 Note that access still requires suitable user-level passwords.
2935 See \fBtestparm(1)\fR
2936 for a way of testing your host access to see if it does
2939 Default: \fBnone (i.e., all hosts permitted access)
2941 Example: \fBallow hosts = 150.203.5. myhost.mynet.edu.au
2943 \fBhosts deny (S)\fR
2944 The opposite of \fIhosts allow\fR
2945 - hosts listed here are \fBNOT\fR permitted access to
2946 services unless the specific services have their own lists to override
2947 this one. Where the lists conflict, the \fIallow\fR
2948 list takes precedence.
2950 Default: \fBnone (i.e., no hosts specifically excluded)
2952 Example: \fBhosts deny = 150.203.4. badhost.mynet.edu.au
2954 \fBhosts equiv (G)\fR
2955 If this global parameter is a non-null string,
2956 it specifies the name of a file to read for the names of hosts
2957 and users who will be allowed access without specifying a password.
2959 This is not be confused with \fIhosts allow\fR which is about hosts
2960 access to services and is more useful for guest services. \fI hosts equiv\fR may be useful for NT clients which will
2961 not supply passwords to samba.
2963 \fBNOTE :\fR The use of \fIhosts equiv
2964 \fRcan be a major security hole. This is because you are
2965 trusting the PC to supply the correct username. It is very easy to
2966 get a PC to supply a false username. I recommend that the
2967 \fIhosts equiv\fR option be only used if you really
2968 know what you are doing, or perhaps on a home network where you trust
2969 your spouse and kids. And only if you \fBreally\fR trust
2972 Default: \fBno host equivalences\fR
2974 Example: \fBhosts equiv = /etc/hosts.equiv\fR
2977 This allows you to include one config file
2978 inside another. The file is included literally, as though typed
2981 It takes the standard substitutions, except \fI%u
2982 \fR, \fI%P\fR and \fI%S\fR.
2984 Default: \fBno file included\fR
2986 Example: \fBinclude = /usr/local/samba/lib/admin_smb.conf
2988 \fBinherit permissions (S)\fR
2989 The permissions on new files and directories
2990 are normally governed by \fI create mask\fR, \fIdirectory mask\fR, \fIforce create mode\fR
2992 directory mode\fR but the boolean inherit
2993 permissions parameter overrides this.
2995 New directories inherit the mode of the parent directory,
2996 including bits such as setgid.
2998 New files inherit their read/write bits from the parent
2999 directory. Their execute bits continue to be determined by
3002 and \fImap system\fR
3005 Note that the setuid bit is \fBnever\fR set via
3006 inheritance (the code explicitly prohibits this).
3008 This can be particularly useful on large systems with
3009 many users, perhaps several thousand,to allow a single [homes]
3010 share to be used flexibly by each user.
3012 See also \fIcreate mask
3013 \fR, \fI directory mask\fR, \fIforce create mode\fR and \fIforce directory mode\fR
3016 Default: \fBinherit permissions = no\fR
3018 \fBinterfaces (G)\fR
3019 This option allows you to override the default
3020 network interfaces list that Samba will use for browsing, name
3021 registration and other NBT traffic. By default Samba will query
3022 the kernel for the list of all active interfaces and use any
3023 interfaces except 127.0.0.1 that are broadcast capable.
3025 The option takes a list of interface strings. Each string
3026 can be in any of the following forms:
3030 a network interface name (such as eth0).
3031 This may include shell-like wildcards so eth* will match
3032 any interface starting with the substring "eth"
3035 an IP address. In this case the netmask is
3036 determined from the list of interfaces obtained from the
3043 a broadcast/mask pair.
3046 The "mask" parameters can either be a bit length (such
3047 as 24 for a C class network) or a full netmask in dotted
3051 The "IP" parameters above can either be a full dotted
3052 decimal IP address or a hostname which will be looked up via
3053 the OS's normal hostname resolution mechanisms.
3056 For example, the following line:
3059 \fBinterfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0
3062 would configure three network interfaces corresponding
3063 to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10.
3064 The netmasks of the latter two interfaces would be set to 255.255.255.0.
3071 Default: \fBall active interfaces except 127.0.0.1
3072 that are broadcast capable\fR
3075 \fBinvalid users (S)\fR
3076 This is a list of users that should not be allowed
3077 to login to this service. This is really a \fBparanoid\fR
3078 check to absolutely ensure an improper setting does not breach
3081 A name starting with a '@' is interpreted as an NIS
3082 netgroup first (if your system supports NIS), and then as a UNIX
3083 group if the name was not found in the NIS netgroup database.
3085 A name starting with '+' is interpreted only
3086 by looking in the UNIX group database. A name starting with
3087 \&'&' is interpreted only by looking in the NIS netgroup database
3088 (this requires NIS to be working on your system). The characters
3089 \&'+' and '&' may be used at the start of the name in either order
3090 so the value \fI+&group\fR means check the
3091 UNIX group database, followed by the NIS netgroup database, and
3092 the value \fI&+group"\fR means check the NIS
3093 netgroup database, followed by the UNIX group database (the
3094 same as the '@' prefix).
3096 The current servicename is substituted for \fI%S\fR.
3097 This is useful in the [homes] section.
3099 See also \fIvalid users
3102 Default: \fBno invalid users\fR
3104 Example: \fBinvalid users = root fred admin @wheel
3107 The value of the parameter (an integer) represents
3108 the number of seconds between \fIkeepalive\fR
3109 packets. If this parameter is zero, no keepalive packets will be
3110 sent. Keepalive packets, if sent, allow the server to tell whether
3111 a client is still present and responding.
3113 Keepalives should, in general, not be needed if the socket
3114 being used has the SO_KEEPALIVE attribute set on it (see \fIsocket options\fR).
3115 Basically you should only use this option if you strike difficulties.
3117 Default: \fBkeepalive = 300\fR
3119 Example: \fBkeepalive = 600\fR
3121 \fBkernel oplocks (G)\fR
3122 For UNIXes that support kernel based \fIoplocks\fR
3123 (currently only IRIX and the Linux 2.4 kernel), this parameter
3124 allows the use of them to be turned on or off.
3126 Kernel oplocks support allows Samba \fIoplocks
3127 \fRto be broken whenever a local UNIX process or NFS operation
3128 accesses a file that \fBsmbd(8)\fR
3129 has oplocked. This allows complete data consistency between
3130 SMB/CIFS, NFS and local file access (and is a \fBvery\fR
3133 This parameter defaults to on on systems
3134 that have the support, and off on systems that
3135 don't. You should never need to touch this parameter.
3137 See also the \fIoplocks\fR
3138 and \fIlevel2 oplocks
3141 Default: \fBkernel oplocks = yes\fR
3143 \fBlanman auth (G)\fR
3144 This parameter determines whether or not smbd will
3145 attempt to authentication users using the LANMAN password hash.
3146 If disabled, only clients which support NT password hashes (e.g. Windows
3147 NT/2000 clients, smbclient, etc... but not Windows 95/98 or the MS DOS
3148 network client) will be able to connect to the Samba host.
3150 Default : \fBlanman auth = yes\fR
3152 \fBlevel2 oplocks (S)\fR
3153 This parameter controls whether Samba supports
3154 level2 (read-only) oplocks on a share.
3156 Level2, or read-only oplocks allow Windows NT clients
3157 that have an oplock on a file to downgrade from a read-write oplock
3158 to a read-only oplock once a second client opens the file (instead
3159 of releasing all oplocks on a second open, as in traditional,
3160 exclusive oplocks). This allows all openers of the file that
3161 support level2 oplocks to cache the file for read-ahead only (ie.
3162 they may not cache writes or lock requests) and increases performance
3163 for many accesses of files that are not commonly written (such as
3164 application .EXE files).
3166 Once one of the clients which have a read-only oplock
3167 writes to the file all clients are notified (no reply is needed
3168 or waited for) and told to break their oplocks to "none" and
3169 delete any read-ahead caches.
3171 It is recommended that this parameter be turned on
3172 to speed access to shared executables.
3174 For more discussions on level2 oplocks see the CIFS spec.
3176 Currently, if \fIkernel
3177 oplocks\fR are supported then level2 oplocks are
3178 not granted (even if this parameter is set to yes).
3179 Note also, the \fIoplocks\fR
3180 parameter must be set to "true" on this share in order for
3181 this parameter to have any effect.
3183 See also the \fIoplocks\fR
3184 and \fIkernel oplocks\fR
3187 Default: \fBlevel2 oplocks = yes\fR
3189 \fBlm announce (G)\fR
3190 This parameter determines if \fBnmbd(8)\fRwill produce Lanman announce
3191 broadcasts that are needed by OS/2 clients in order for them to see
3192 the Samba server in their browse list. This parameter can have three
3193 values, true, false, or
3194 auto. The default is auto.
3195 If set to false Samba will never produce these
3196 broadcasts. If set to true Samba will produce
3197 Lanman announce broadcasts at a frequency set by the parameter
3198 \fIlm interval\fR. If set to auto
3199 Samba will not send Lanman announce broadcasts by default but will
3200 listen for them. If it hears such a broadcast on the wire it will
3201 then start sending them at a frequency set by the parameter
3204 See also \fIlm interval
3207 Default: \fBlm announce = auto\fR
3209 Example: \fBlm announce = yes\fR
3211 \fBlm interval (G)\fR
3212 If Samba is set to produce Lanman announce
3213 broadcasts needed by OS/2 clients (see the \fIlm announce\fR parameter) then this
3214 parameter defines the frequency in seconds with which they will be
3215 made. If this is set to zero then no Lanman announcements will be
3216 made despite the setting of the \fIlm announce\fR
3222 Default: \fBlm interval = 60\fR
3224 Example: \fBlm interval = 120\fR
3226 \fBload printers (G)\fR
3227 A boolean variable that controls whether all
3228 printers in the printcap will be loaded for browsing by default.
3229 See the printers section for
3232 Default: \fBload printers = yes\fR
3234 \fBlocal master (G)\fR
3235 This option allows \fB nmbd(8)\fRto try and become a local master browser
3236 on a subnet. If set to False then \fB nmbd\fR will not attempt to become a local master browser
3237 on a subnet and will also lose in all browsing elections. By
3238 default this value is set to true. Setting this value to true doesn't
3239 mean that Samba will \fBbecome\fR the local master
3240 browser on a subnet, just that \fBnmbd\fR will \fB participate\fR in elections for local master browser.
3242 Setting this value to False will cause \fBnmbd\fR
3243 \fBnever\fR to become a local master browser.
3245 Default: \fBlocal master = yes\fR
3248 Synonym for \fI lock directory\fR.
3250 \fBlock directory (G)\fR
3251 This option specifies the directory where lock
3252 files will be placed. The lock files are used to implement the
3253 \fImax connections\fR
3256 Default: \fBlock directory = ${prefix}/var/locks\fR
3258 Example: \fBlock directory = /var/run/samba/locks\fR
3261 This controls whether or not locking will be
3262 performed by the server in response to lock requests from the
3265 If \fBlocking = no\fR, all lock and unlock
3266 requests will appear to succeed and all lock queries will report
3267 that the file in question is available for locking.
3269 If \fBlocking = yes\fR, real locking will be performed
3272 This option \fBmay\fR be useful for read-only
3273 filesystems which \fBmay\fR not need locking (such as
3274 cdrom drives), although setting this parameter of no
3275 is not really recommended even in this case.
3277 Be careful about disabling locking either globally or in a
3278 specific service, as lack of locking may result in data corruption.
3279 You should never need to set this parameter.
3281 Default: \fBlocking = yes\fR
3284 This option allows you to override the name
3285 of the Samba log file (also known as the debug file).
3287 This option takes the standard substitutions, allowing
3288 you to have separate log files for each user or machine.
3290 Example: \fBlog file = /usr/local/samba/var/log.%m
3293 Synonym for \fI debug level\fR.
3295 \fBlogon drive (G)\fR
3296 This parameter specifies the local path to
3297 which the home directory will be connected (see \fIlogon home\fR)
3298 and is only used by NT Workstations.
3300 Note that this option is only useful if Samba is set up as a
3303 Default: \fBlogon drive = z:\fR
3305 Example: \fBlogon drive = h:\fR
3307 \fBlogon home (G)\fR
3308 This parameter specifies the home directory
3309 location when a Win95/98 or NT Workstation logs into a Samba PDC.
3312 C:\\> \fBNET USE H: /HOME\fR
3314 from a command prompt, for example.
3316 This option takes the standard substitutions, allowing
3317 you to have separate logon scripts for each user or machine.
3319 This parameter can be used with Win9X workstations to ensure
3320 that roaming profiles are stored in a subdirectory of the user's
3321 home directory. This is done in the following way:
3323 \fBlogon home = \\\\%N\\%U\\profile\fR
3325 This tells Samba to return the above string, with
3326 substitutions made when a client requests the info, generally
3327 in a NetUserGetInfo request. Win9X clients truncate the info to
3328 \\\\server\\share when a user does \fBnet use /home"\fR
3329 but use the whole string when dealing with profiles.
3331 Note that in prior versions of Samba, the \fIlogon path\fR was returned rather than
3332 \fIlogon home\fR. This broke \fBnet use
3333 /home\fR but allowed profiles outside the home directory.
3334 The current implementation is correct, and can be used for
3335 profiles if you use the above trick.
3337 This option is only useful if Samba is set up as a logon
3340 Default: \fBlogon home = "\\\\%N\\%U"\fR
3342 Example: \fBlogon home = "\\\\remote_smb_server\\%U"\fR
3344 \fBlogon path (G)\fR
3345 This parameter specifies the home directory
3346 where roaming profiles (NTuser.dat etc files for Windows NT) are
3347 stored. Contrary to previous versions of these manual pages, it has
3348 nothing to do with Win 9X roaming profiles. To find out how to
3349 handle roaming profiles for Win 9X system, see the \fIlogon home\fR parameter.
3351 This option takes the standard substitutions, allowing you
3352 to have separate logon scripts for each user or machine. It also
3353 specifies the directory from which the "Application Data",
3354 (\fIdesktop\fR, \fIstart menu\fR,
3355 \fInetwork neighborhood\fR, \fIprograms\fR
3356 and other folders, and their contents, are loaded and displayed on
3357 your Windows NT client.
3359 The share and the path must be readable by the user for
3360 the preferences and directories to be loaded onto the Windows NT
3361 client. The share must be writeable when the logs in for the first
3362 time, in order that the Windows NT client can create the NTuser.dat
3363 and other directories.
3365 Thereafter, the directories and any of the contents can,
3366 if required, be made read-only. It is not advisable that the
3367 NTuser.dat file be made read-only - rename it to NTuser.man to
3368 achieve the desired effect (a \fBMAN\fRdatory
3371 Windows clients can sometimes maintain a connection to
3372 the [homes] share, even though there is no user logged in.
3373 Therefore, it is vital that the logon path does not include a
3374 reference to the homes share (i.e. setting this parameter to
3375 \\%N\\%U\\profile_path will cause problems).
3377 This option takes the standard substitutions, allowing
3378 you to have separate logon scripts for each user or machine.
3380 Note that this option is only useful if Samba is set up
3383 Default: \fBlogon path = \\\\%N\\%U\\profile\fR
3385 Example: \fBlogon path = \\\\PROFILESERVER\\PROFILE\\%U\fR
3387 \fBlogon script (G)\fR
3388 This parameter specifies the batch file (.bat) or
3389 NT command file (.cmd) to be downloaded and run on a machine when
3390 a user successfully logs in. The file must contain the DOS
3391 style cr/lf line endings. Using a DOS-style editor to create the
3392 file is recommended.
3394 The script must be a relative path to the [netlogon]
3395 service. If the [netlogon] service specifies a \fIpath\fR of \fI/usr/local/samba/netlogon
3396 \fR, and \fBlogon script = STARTUP.BAT\fR, then
3397 the file that will be downloaded is:
3399 \fI/usr/local/samba/netlogon/STARTUP.BAT\fR
3401 The contents of the batch file is entirely your choice. A
3402 suggested command would be to add \fBNET TIME \\\\SERVER /SET
3403 /YES\fR, to force every machine to synchronize clocks with
3404 the same time server. Another use would be to add \fBNET USE
3405 U: \\\\SERVER\\UTILS\fR for commonly used utilities, or \fB NET USE Q: \\\\SERVER\\ISO9001_QA\fR for example.
3407 Note that it is particularly important not to allow write
3408 access to the [netlogon] share, or to grant users write permission
3409 on the batch files in a secure environment, as this would allow
3410 the batch files to be arbitrarily modified and security to be
3413 This option takes the standard substitutions, allowing you
3414 to have separate logon scripts for each user or machine.
3416 This option is only useful if Samba is set up as a logon
3419 Default: \fBno logon script defined\fR
3421 Example: \fBlogon script = scripts\\%U.bat\fR
3423 \fBlppause command (S)\fR
3424 This parameter specifies the command to be
3425 executed on the server host in order to stop printing or spooling
3426 a specific print job.
3428 This command should be a program or script which takes
3429 a printer name and job number to pause the print job. One way
3430 of implementing this is by using job priorities, where jobs
3431 having a too low priority won't be sent to the printer.
3433 If a \fI%p\fR is given then the printername
3434 is put in its place. A \fI%j\fR is replaced with
3435 the job number (an integer). On HPUX (see \fIprinting=hpux
3436 \fR), if the \fI-p%p\fR option is added
3437 to the lpq command, the job will show up with the correct status, i.e.
3438 if the job priority is lower than the set fence priority it will
3439 have the PAUSED status, whereas if the priority is equal or higher it
3440 will have the SPOOLED or PRINTING status.
3442 Note that it is good practice to include the absolute path
3443 in the lppause command as the PATH may not be available to the server.
3445 See also the \fIprinting
3448 Default: Currently no default value is given to
3449 this string, unless the value of the \fIprinting\fR
3450 parameter is SYSV, in which case the default is :
3452 \fBlp -i %p-%j -H hold\fR
3454 or if the value of the \fIprinting\fR parameter
3455 is SOFTQ, then the default is:
3457 \fBqstat -s -j%j -h\fR
3459 Example for HPUX: \fBlppause command = /usr/bin/lpalt
3462 \fBlpq cache time (G)\fR
3463 This controls how long lpq info will be cached
3464 for to prevent the \fBlpq\fR command being called too
3465 often. A separate cache is kept for each variation of the \fB lpq\fR command used by the system, so if you use different
3466 \fBlpq\fR commands for different users then they won't
3467 share cache information.
3469 The cache files are stored in \fI/tmp/lpq.xxxx\fR
3470 where xxxx is a hash of the \fBlpq\fR command in use.
3472 The default is 10 seconds, meaning that the cached results
3473 of a previous identical \fBlpq\fR command will be used
3474 if the cached data is less than 10 seconds old. A large value may
3475 be advisable if your \fBlpq\fR command is very slow.
3477 A value of 0 will disable caching completely.
3479 See also the \fIprinting
3482 Default: \fBlpq cache time = 10\fR
3484 Example: \fBlpq cache time = 30\fR
3486 \fBlpq command (S)\fR
3487 This parameter specifies the command to be
3488 executed on the server host in order to obtain \fBlpq
3489 \fR-style printer status information.
3491 This command should be a program or script which
3492 takes a printer name as its only parameter and outputs printer
3495 Currently eight styles of printer status information
3496 are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX and SOFTQ.
3497 This covers most UNIX systems. You control which type is expected
3498 using the \fIprinting =\fR option.
3500 Some clients (notably Windows for Workgroups) may not
3501 correctly send the connection number for the printer they are
3502 requesting status information about. To get around this, the
3503 server reports on the first printer service connected to by the
3504 client. This only happens if the connection number sent is invalid.
3506 If a \fI%p\fR is given then the printername
3507 is put in its place. Otherwise it is placed at the end of the
3510 Note that it is good practice to include the absolute path
3511 in the \fIlpq command\fR as the \fB$PATH
3512 \fRmay not be available to the server.
3514 See also the \fIprinting
3517 Default: \fBdepends on the setting of \fI printing\fB\fR
3519 Example: \fBlpq command = /usr/bin/lpq -P%p\fR
3521 \fBlpresume command (S)\fR
3522 This parameter specifies the command to be
3523 executed on the server host in order to restart or continue
3524 printing or spooling a specific print job.
3526 This command should be a program or script which takes
3527 a printer name and job number to resume the print job. See
3528 also the \fIlppause command
3531 If a \fI%p\fR is given then the printername
3532 is put in its place. A \fI%j\fR is replaced with
3533 the job number (an integer).
3535 Note that it is good practice to include the absolute path
3536 in the \fIlpresume command\fR as the PATH may not
3537 be available to the server.
3539 See also the \fIprinting
3542 Default: Currently no default value is given
3543 to this string, unless the value of the \fIprinting\fR
3544 parameter is SYSV, in which case the default is :
3546 \fBlp -i %p-%j -H resume\fR
3548 or if the value of the \fIprinting\fR parameter
3549 is SOFTQ, then the default is:
3551 \fBqstat -s -j%j -r\fR
3553 Example for HPUX: \fBlpresume command = /usr/bin/lpalt
3556 \fBlprm command (S)\fR
3557 This parameter specifies the command to be
3558 executed on the server host in order to delete a print job.
3560 This command should be a program or script which takes
3561 a printer name and job number, and deletes the print job.
3563 If a \fI%p\fR is given then the printername
3564 is put in its place. A \fI%j\fR is replaced with
3565 the job number (an integer).
3567 Note that it is good practice to include the absolute
3568 path in the \fIlprm command\fR as the PATH may not be
3569 available to the server.
3571 See also the \fIprinting
3574 Default: \fBdepends on the setting of \fIprinting
3576 Example 1: \fBlprm command = /usr/bin/lprm -P%p %j
3578 Example 2: \fBlprm command = /usr/bin/cancel %p-%j
3580 \fBmachine password timeout (G)\fR
3581 If a Samba server is a member of an Windows
3582 NT Domain (see the security=domain)
3583 parameter) then periodically a running smbd(8)process will try and change the MACHINE ACCOUNT
3584 PASSWORD stored in the TDB called \fIprivate/secrets.tdb
3585 \fR\&. This parameter specifies how often this password
3586 will be changed, in seconds. The default is one week (expressed in
3587 seconds), the same as a Windows NT Domain member server.
3589 See also \fBsmbpasswd(8)
3590 \fR, and the security=domain) parameter.
3592 Default: \fBmachine password timeout = 604800\fR
3594 \fBmagic output (S)\fR
3595 This parameter specifies the name of a file
3596 which will contain output created by a magic script (see the
3600 Warning: If two clients use the same \fImagic script
3601 \fRin the same directory the output file content
3604 Default: \fBmagic output = <magic script name>.out
3606 Example: \fBmagic output = myfile.txt\fR
3608 \fBmagic script (S)\fR
3609 This parameter specifies the name of a file which,
3610 if opened, will be executed by the server when the file is closed.
3611 This allows a UNIX script to be sent to the Samba host and
3612 executed on behalf of the connected user.
3614 Scripts executed in this way will be deleted upon
3615 completion assuming that the user has the appripriate level
3616 of priviledge and the ile permissions allow the deletion.
3618 If the script generates output, output will be sent to
3619 the file specified by the \fI magic output\fR parameter (see above).
3621 Note that some shells are unable to interpret scripts
3622 containing CR/LF instead of CR as
3623 the end-of-line marker. Magic scripts must be executable
3624 \fBas is\fR on the host, which for some hosts and
3625 some shells will require filtering at the DOS end.
3627 Magic scripts are \fBEXPERIMENTAL\fR and
3628 should \fBNOT\fR be relied upon.
3630 Default: \fBNone. Magic scripts disabled.\fR
3632 Example: \fBmagic script = user.csh\fR
3634 \fBmangle case (S)\fR
3635 See the section on NAME MANGLING
3637 Default: \fBmangle case = no\fR
3639 \fBmangled map (S)\fR
3640 This is for those who want to directly map UNIX
3641 file names which can not be represented on Windows/DOS. The mangling
3642 of names is not always what is needed. In particular you may have
3643 documents with file extensions that differ between DOS and UNIX.
3644 For example, under UNIX it is common to use \fI.html\fR
3645 for HTML files, whereas under Windows/DOS \fI.htm\fR
3646 is more commonly used.
3648 So to map \fIhtml\fR to \fIhtm\fR
3651 \fBmangled map = (*.html *.htm)\fR
3653 One very useful case is to remove the annoying \fI;1
3654 \fRoff the ends of filenames on some CDROMS (only visible
3655 under some UNIXes). To do this use a map of (*;1 *;).
3657 Default: \fBno mangled map\fR
3659 Example: \fBmangled map = (*;1 *;)\fR
3661 \fBmangled names (S)\fR
3662 This controls whether non-DOS names under UNIX
3663 should be mapped to DOS-compatible names ("mangled") and made visible,
3664 or whether non-DOS names should simply be ignored.
3666 See the section on NAME MANGLING for details on how to control the mangling process.
3668 If mangling is used then the mangling algorithm is as follows:
3672 The first (up to) five alphanumeric characters
3673 before the rightmost dot of the filename are preserved, forced
3674 to upper case, and appear as the first (up to) five characters
3675 of the mangled name.
3678 A tilde "~" is appended to the first part of the mangled
3679 name, followed by a two-character unique sequence, based on the
3680 original root name (i.e., the original filename minus its final
3681 extension). The final extension is included in the hash calculation
3682 only if it contains any upper case characters or is longer than three
3685 Note that the character to use may be specified using
3686 the \fImangling char\fR
3687 option, if you don't like '~'.
3690 The first three alphanumeric characters of the final
3691 extension are preserved, forced to upper case and appear as the
3692 extension of the mangled name. The final extension is defined as that
3693 part of the original filename after the rightmost dot. If there are no
3694 dots in the filename, the mangled name will have no extension (except
3695 in the case of "hidden files" - see below).
3698 Files whose UNIX name begins with a dot will be
3699 presented as DOS hidden files. The mangled name will be created as
3700 for other filenames, but with the leading dot removed and "___" as
3701 its extension regardless of actual original extension (that's three
3705 The two-digit hash value consists of upper case
3706 alphanumeric characters.
3709 This algorithm can cause name collisions only if files
3710 in a directory share the same first five alphanumeric characters.
3711 The probability of such a clash is 1/1300.
3714 The name mangling (if enabled) allows a file to be
3715 copied between UNIX directories from Windows/DOS while retaining
3716 the long UNIX filename. UNIX files can be renamed to a new extension
3717 from Windows/DOS and will retain the same basename. Mangled names
3718 do not change between sessions.
3721 Default: \fBmangled names = yes\fR
3724 \fBmangled stack (G)\fR
3725 This parameter controls the number of mangled names
3726 that should be cached in the Samba server smbd(8).
3728 This stack is a list of recently mangled base names
3729 (extensions are only maintained if they are longer than 3 characters
3730 or contains upper case characters).
3732 The larger this value, the more likely it is that mangled
3733 names can be successfully converted to correct long UNIX names.
3734 However, large stack sizes will slow most directory access. Smaller
3735 stacks save memory in the server (each stack element costs 256 bytes).
3737 It is not possible to absolutely guarantee correct long
3738 file names, so be prepared for some surprises!
3740 Default: \fBmangled stack = 50\fR
3742 Example: \fBmangled stack = 100\fR
3744 \fBmangling char (S)\fR
3745 This controls what character is used as
3746 the \fBmagic\fR character in name mangling. The default is a '~'
3747 but this may interfere with some software. Use this option to set
3748 it to whatever you prefer.
3750 Default: \fBmangling char = ~\fR
3752 Example: \fBmangling char = ^\fR
3754 \fBmap archive (S)\fR
3755 This controls whether the DOS archive attribute
3756 should be mapped to the UNIX owner execute bit. The DOS archive bit
3757 is set when a file has been modified since its last backup. One
3758 motivation for this option it to keep Samba/your PC from making
3759 any file it touches from becoming executable under UNIX. This can
3760 be quite annoying for shared source code, documents, etc...
3762 Note that this requires the \fIcreate mask\fR
3763 parameter to be set such that owner execute bit is not masked out
3764 (i.e. it must include 100). See the parameter \fIcreate mask\fR for details.
3766 Default: \fBmap archive = yes\fR
3768 \fBmap hidden (S)\fR
3769 This controls whether DOS style hidden files
3770 should be mapped to the UNIX world execute bit.
3772 Note that this requires the \fIcreate mask\fR
3773 to be set such that the world execute bit is not masked out (i.e.
3774 it must include 001). See the parameter \fIcreate mask\fR for details.
3776 Default: \fBmap hidden = no\fR
3778 \fBmap system (S)\fR
3779 This controls whether DOS style system files
3780 should be mapped to the UNIX group execute bit.
3782 Note that this requires the \fIcreate mask\fR
3783 to be set such that the group execute bit is not masked out (i.e.
3784 it must include 010). See the parameter \fIcreate mask\fR for details.
3786 Default: \fBmap system = no\fR
3788 \fBmap to guest (G)\fR
3789 This parameter is only useful in security modes other than \fIsecurity=share\fR
3790 - i.e. user, server,
3793 This parameter can take three different values, which tell
3794 smbd(8)what to do with user
3795 login requests that don't match a valid UNIX user in some way.
3797 The three settings are :
3801 Never - Means user login
3802 requests with an invalid password are rejected. This is the
3806 Bad User - Means user
3807 logins with an invalid password are rejected, unless the username
3808 does not exist, in which case it is treated as a guest login and
3809 mapped into the \fI guest account\fR.
3812 Bad Password - Means user logins
3813 with an invalid password are treated as a guest login and mapped
3814 into the guest account. Note that
3815 this can cause problems as it means that any user incorrectly typing
3816 their password will be silently logged on as "guest" - and
3817 will not know the reason they cannot access files they think
3818 they should - there will have been no message given to them
3819 that they got their password wrong. Helpdesk services will
3820 \fBhate\fR you if you set the \fImap to
3821 guest\fR parameter this way :-).
3824 Note that this parameter is needed to set up "Guest"
3825 share services when using \fIsecurity\fR modes other than
3826 share. This is because in these modes the name of the resource being
3827 requested is \fBnot\fR sent to the server until after
3828 the server has successfully authenticated the client so the server
3829 cannot make authentication decisions at the correct time (connection
3830 to the share) for "Guest" shares.
3833 For people familiar with the older Samba releases, this
3834 parameter maps to the old compile-time setting of the GUEST_SESSSETUP value in local.h.
3837 Default: \fBmap to guest = Never\fR
3840 Example: \fBmap to guest = Bad User\fR
3843 \fBmax connections (S)\fR
3844 This option allows the number of simultaneous
3845 connections to a service to be limited. If \fImax connections
3846 \fRis greater than 0 then connections will be refused if
3847 this number of connections to the service are already open. A value
3848 of zero mean an unlimited number of connections may be made.
3850 Record lock files are used to implement this feature. The
3851 lock files will be stored in the directory specified by the \fIlock directory\fR
3854 Default: \fBmax connections = 0\fR
3856 Example: \fBmax connections = 10\fR
3858 \fBmax disk size (G)\fR
3859 This option allows you to put an upper limit
3860 on the apparent size of disks. If you set this option to 100
3861 then all shares will appear to be not larger than 100 MB in
3864 Note that this option does not limit the amount of
3865 data you can put on the disk. In the above case you could still
3866 store much more than 100 MB on the disk, but if a client ever asks
3867 for the amount of free disk space or the total disk size then the
3868 result will be bounded by the amount specified in \fImax
3871 This option is primarily useful to work around bugs
3872 in some pieces of software that can't handle very large disks,
3873 particularly disks over 1GB in size.
3875 A \fImax disk size\fR of 0 means no limit.
3877 Default: \fBmax disk size = 0\fR
3879 Example: \fBmax disk size = 1000\fR
3881 \fBmax log size (G)\fR
3882 This option (an integer in kilobytes) specifies
3883 the max size the log file should grow to. Samba periodically checks
3884 the size and if it is exceeded it will rename the file, adding
3885 a \fI.old\fR extension.
3887 A size of 0 means no limit.
3889 Default: \fBmax log size = 5000\fR
3891 Example: \fBmax log size = 1000\fR
3894 This option controls the maximum number of
3895 outstanding simultaneous SMB operations that samba tells the client
3896 it will allow. You should never need to set this parameter.
3898 Default: \fBmax mux = 50\fR
3900 \fBmax open files (G)\fR
3901 This parameter limits the maximum number of
3902 open files that one smbd(8)file
3903 serving process may have open for a client at any one time. The
3904 default for this parameter is set very high (10,000) as Samba uses
3905 only one bit per unopened file.
3907 The limit of the number of open files is usually set
3908 by the UNIX per-process file descriptor limit rather than
3909 this parameter so you should never need to touch this parameter.
3911 Default: \fBmax open files = 10000\fR
3913 \fBmax print jobs (S)\fR
3914 This parameter limits the maximum number of
3915 jobs allowable in a Samba printer queue at any given moment.
3916 If this number is exceeded, \fB smbd(8)\fRwill remote "Out of Space" to the client.
3920 Default: \fBmax print jobs = 1000\fR
3922 Example: \fBmax print jobs = 5000\fR
3924 \fBmax protocol (G)\fR
3925 The value of the parameter (a string) is the highest
3926 protocol level that will be supported by the server.
3928 Possible values are :
3932 CORE: Earliest version. No
3933 concept of user names.
3936 COREPLUS: Slight improvements on
3937 CORE for efficiency.
3940 LANMAN1: First \fB modern\fR version of the protocol. Long filename
3944 LANMAN2: Updates to Lanman1 protocol.
3947 NT1: Current up to date version of
3948 the protocol. Used by Windows NT. Known as CIFS.
3951 Normally this option should not be set as the automatic
3952 negotiation phase in the SMB protocol takes care of choosing
3953 the appropriate protocol.
3960 Default: \fBmax protocol = NT1\fR
3963 Example: \fBmax protocol = LANMAN1\fR
3966 \fBmax smbd processes (G)\fR
3967 This parameter limits the maximum number of
3968 \fBsmbd(8)\fRprocesses concurrently running on a system and is intended
3969 as a stop gap to prevent degrading service to clients in the event
3970 that the server has insufficient resources to handle more than this
3971 number of connections. Remember that under normal operating
3972 conditions, each user will have an smbd associated with him or her
3973 to handle connections to all shares from a given host.
3975 Default: \fBmax smbd processes = 0\fR ## no limit
3977 Example: \fBmax smbd processes = 1000\fR
3980 This option tells nmbd(8)what the default 'time to live' of NetBIOS names should be (in seconds)
3981 when \fBnmbd\fR is requesting a name using either a
3982 broadcast packet or from a WINS server. You should never need to
3983 change this parameter. The default is 3 days.
3985 Default: \fBmax ttl = 259200\fR
3987 \fBmax wins ttl (G)\fR
3988 This option tells nmbd(8)
3989 when acting as a WINS server ( \fIwins support=yes\fR) what the maximum
3990 \&'time to live' of NetBIOS names that \fBnmbd\fR
3991 will grant will be (in seconds). You should never need to change this
3992 parameter. The default is 6 days (518400 seconds).
3995 wins ttl"\fR parameter.
3997 Default: \fBmax wins ttl = 518400\fR
4000 This option controls the maximum packet size
4001 that will be negotiated by Samba. The default is 65535, which
4002 is the maximum. In some cases you may find you get better performance
4003 with a smaller value. A value below 2048 is likely to cause problems.
4005 Default: \fBmax xmit = 65535\fR
4007 Example: \fBmax xmit = 8192\fR
4009 \fBmessage command (G)\fR
4010 This specifies what command to run when the
4011 server receives a WinPopup style message.
4013 This would normally be a command that would
4014 deliver the message somehow. How this is to be done is
4015 up to your imagination.
4019 \fBmessage command = csh -c 'xedit %s;rm %s' &\fR
4021 This delivers the message using \fBxedit\fR, then
4022 removes it afterwards. \fBNOTE THAT IT IS VERY IMPORTANT
4023 THAT THIS COMMAND RETURN IMMEDIATELY\fR. That's why I
4024 have the '&' on the end. If it doesn't return immediately then
4025 your PCs may freeze when sending messages (they should recover
4026 after 30secs, hopefully).
4028 All messages are delivered as the global guest user.
4029 The command takes the standard substitutions, although \fI %u\fR won't work (\fI%U\fR may be better
4032 Apart from the standard substitutions, some additional
4033 ones apply. In particular:
4037 \fI%s\fR = the filename containing
4041 \fI%t\fR = the destination that
4042 the message was sent to (probably the server name).
4045 \fI%f\fR = who the message
4049 You could make this command send mail, or whatever else
4050 takes your fancy. Please let us know of any really interesting
4054 Here's a way of sending the messages as mail to root:
4057 \fBmessage command = /bin/mail -s 'message from %f on
4058 %m' root < %s; rm %s\fR
4061 If you don't have a message command then the message
4062 won't be delivered and Samba will tell the sender there was
4063 an error. Unfortunately WfWg totally ignores the error code
4064 and carries on regardless, saying that the message was delivered.
4067 If you want to silently delete it then try:
4070 \fBmessage command = rm %s\fR
4073 Default: \fBno message command\fR
4076 Example: \fBmessage command = csh -c 'xedit %s;
4080 \fBmin passwd length (G)\fR
4081 Synonym for \fImin password length\fR.
4083 \fBmin password length (G)\fR
4084 This option sets the minimum length in characters
4085 of a plaintext password that \fBsmbd\fR will accept when performing
4086 UNIX password changing.
4089 password sync\fR, \fIpasswd program\fR and \fIpasswd chat debug\fR
4092 Default: \fBmin password length = 5\fR
4094 \fBmin print space (S)\fR
4095 This sets the minimum amount of free disk
4096 space that must be available before a user will be able to spool
4097 a print job. It is specified in kilobytes. The default is 0, which
4098 means a user can always spool a print job.
4100 See also the \fIprinting
4103 Default: \fBmin print space = 0\fR
4105 Example: \fBmin print space = 2000\fR
4107 \fBmin protocol (G)\fR
4108 The value of the parameter (a string) is the
4109 lowest SMB protocol dialect than Samba will support. Please refer
4110 to the \fImax protocol\fR
4111 parameter for a list of valid protocol names and a brief description
4112 of each. You may also wish to refer to the C source code in
4113 \fIsource/smbd/negprot.c\fR for a listing of known protocol
4114 dialects supported by clients.
4116 If you are viewing this parameter as a security measure, you should
4117 also refer to the \fIlanman
4118 auth\fR parameter. Otherwise, you should never need
4119 to change this parameter.
4121 Default : \fBmin protocol = CORE\fR
4123 Example : \fBmin protocol = NT1\fR # disable DOS
4126 \fBmin wins ttl (G)\fR
4127 This option tells nmbd(8)when acting as a WINS server (\fI wins support = yes\fR) what the minimum 'time to live'
4128 of NetBIOS names that \fBnmbd\fR will grant will be (in
4129 seconds). You should never need to change this parameter. The default
4130 is 6 hours (21600 seconds).
4132 Default: \fBmin wins ttl = 21600\fR
4134 \fBmsdfs root (S)\fR
4135 This boolean parameter is only available if
4136 Samba is configured and compiled with the \fB --with-msdfs\fR option. If set to yes>,
4137 Samba treats the share as a Dfs root and allows clients to browse
4138 the distributed file system tree rooted at the share directory.
4139 Dfs links are specified in the share directory by symbolic
4140 links of the form \fImsdfs:serverA\\shareA,serverB\\shareB
4141 \fRand so on. For more information on setting up a Dfs tree
4142 on Samba, refer to msdfs_setup.html
4145 See also \fIhost msdfs
4147 Default: \fBmsdfs root = no\fR
4149 \fBname resolve order (G)\fR
4150 This option is used by the programs in the Samba
4151 suite to determine what naming services to use and in what order
4152 to resolve host names to IP addresses. The option takes a space
4153 separated string of name resolution options.
4155 The options are :"lmhosts", "host", "wins" and "bcast". They
4156 cause names to be resolved as follows :
4160 lmhosts : Lookup an IP
4161 address in the Samba lmhosts file. If the line in lmhosts has
4162 no name type attached to the NetBIOS name (see the lmhosts(5)for details) then
4163 any name type matches for lookup.
4166 host : Do a standard host
4167 name to IP address resolution, using the system \fI/etc/hosts
4168 \fR, NIS, or DNS lookups. This method of name resolution
4169 is operating system depended for instance on IRIX or Solaris this
4170 may be controlled by the \fI/etc/nsswitch.conf\fR
4171 file). Note that this method is only used if the NetBIOS name
4172 type being queried is the 0x20 (server) name type, otherwise
4176 wins : Query a name with
4177 the IP address listed in the \fI wins server\fR parameter. If no WINS server has
4178 been specified this method will be ignored.
4181 bcast : Do a broadcast on
4182 each of the known local interfaces listed in the \fIinterfaces\fR
4183 parameter. This is the least reliable of the name resolution
4184 methods as it depends on the target host being on a locally
4188 Default: \fBname resolve order = lmhosts host wins bcast
4191 Example: \fBname resolve order = lmhosts bcast host
4194 This will cause the local lmhosts file to be examined
4195 first, followed by a broadcast attempt, followed by a normal
4196 system hostname lookup.
4199 \fBnetbios aliases (G)\fR
4200 This is a list of NetBIOS names that nmbd(8)will advertise as additional
4201 names by which the Samba server is known. This allows one machine
4202 to appear in browse lists under multiple names. If a machine is
4203 acting as a browse server or logon server none
4204 of these names will be advertised as either browse server or logon
4205 servers, only the primary name of the machine will be advertised
4206 with these capabilities.
4211 Default: \fBempty string (no additional names)\fR
4213 Example: \fBnetbios aliases = TEST TEST1 TEST2\fR
4215 \fBnetbios name (G)\fR
4216 This sets the NetBIOS name by which a Samba
4217 server is known. By default it is the same as the first component
4218 of the host's DNS name. If a machine is a browse server or
4219 logon server this name (or the first component
4220 of the hosts DNS name) will be the name that these services are
4226 Default: \fBmachine DNS name\fR
4228 Example: \fBnetbios name = MYNAME\fR
4230 \fBnetbios scope (G)\fR
4231 This sets the NetBIOS scope that Samba will
4232 operate under. This should not be set unless every machine
4233 on your LAN also sets this value.
4235 \fBnis homedir (G)\fR
4236 Get the home share server from a NIS map. For
4237 UNIX systems that use an automounter, the user's home directory
4238 will often be mounted on a workstation on demand from a remote
4241 When the Samba logon server is not the actual home directory
4242 server, but is mounting the home directories via NFS then two
4243 network hops would be required to access the users home directory
4244 if the logon server told the client to use itself as the SMB server
4245 for home directories (one over SMB and one over NFS). This can
4248 This option allows Samba to return the home share as
4249 being on a different server to the logon server and as
4250 long as a Samba daemon is running on the home directory server,
4251 it will be mounted on the Samba client directly from the directory
4252 server. When Samba is returning the home share to the client, it
4253 will consult the NIS map specified in \fIhomedir map\fR and return the server
4256 Note that for this option to work there must be a working
4257 NIS system and the Samba server with this option must also
4260 Default: \fBnis homedir = no\fR
4262 \fBnt acl support (G)\fR
4263 This boolean parameter controls whether
4264 smbd(8)will attempt to map
4265 UNIX permissions into Windows NT access control lists.
4267 Default: \fBnt acl support = yes\fR
4269 \fBnt pipe support (G)\fR
4270 This boolean parameter controls whether
4271 smbd(8)will allow Windows NT
4272 clients to connect to the NT SMB specific IPC$
4273 pipes. This is a developer debugging option and can be left
4276 Default: \fBnt pipe support = yes\fR
4278 \fBnt smb support (G)\fR
4279 This boolean parameter controls whether smbd(8)will negotiate NT specific SMB
4280 support with Windows NT clients. Although this is a developer
4281 debugging option and should be left alone, benchmarking has discovered
4282 that Windows NT clients give faster performance with this option
4283 set to no. This is still being investigated.
4284 If this option is set to no then Samba offers
4285 exactly the same SMB calls that versions prior to Samba 2.0 offered.
4286 This information may be of use if any users are having problems
4287 with NT SMB support.
4289 You should not need to ever disable this parameter.
4291 Default: \fBnt smb support = yes\fR
4293 \fBnull passwords (G)\fR
4294 Allow or disallow client access to accounts
4295 that have null passwords.
4297 See also smbpasswd (5).
4299 Default: \fBnull passwords = no\fR
4302 This is a boolean option that controls whether
4303 connections with usernames not in the \fIuser\fR
4304 list will be allowed. By default this option is disabled so that a
4305 client can supply a username to be used by the server. Enabling
4306 this parameter will force the server to only user the login
4307 names from the \fIuser\fR list and is only really
4308 useful in shave level
4311 Note that this also means Samba won't try to deduce
4312 usernames from the service name. This can be annoying for
4313 the [homes] section. To get around this you could use \fBuser =
4314 %S\fR which means your \fIuser\fR list
4315 will be just the service name, which for home directories is the
4318 See also the \fIuser\fR
4321 Default: \fBonly user = no\fR
4323 \fBole locking compatibility (G)\fR
4324 This parameter allows an administrator to turn
4325 off the byte range lock manipulation that is done within Samba to
4326 give compatibility for OLE applications. Windows OLE applications
4327 use byte range locking as a form of inter-process communication, by
4328 locking ranges of bytes around the 2^32 region of a file range. This
4329 can cause certain UNIX lock managers to crash or otherwise cause
4330 problems. Setting this parameter to no means you
4331 trust your UNIX lock manager to handle such cases correctly.
4333 Default: \fBole locking compatibility = yes\fR
4335 \fBonly guest (S)\fR
4336 A synonym for \fI guest only\fR.
4338 \fBoplock break wait time (G)\fR
4339 This is a tuning parameter added due to bugs in
4340 both Windows 9x and WinNT. If Samba responds to a client too
4341 quickly when that client issues an SMB that can cause an oplock
4342 break request, then the network client can fail and not respond
4343 to the break request. This tuning parameter (which is set in milliseconds)
4344 is the amount of time Samba will wait before sending an oplock break
4345 request to such (broken) clients.
4347 \fBDO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
4348 AND UNDERSTOOD THE SAMBA OPLOCK CODE\fR.
4350 Default: \fBoplock break wait time = 0\fR
4352 \fBoplock contention limit (S)\fR
4353 This is a \fBvery\fR advanced
4354 smbd(8)tuning option to
4355 improve the efficiency of the granting of oplocks under multiple
4356 client contention for the same file.
4358 In brief it specifies a number, which causes smbd not to
4359 grant an oplock even when requested if the approximate number of
4360 clients contending for an oplock on the same file goes over this
4361 limit. This causes \fBsmbd\fR to behave in a similar
4364 \fBDO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
4365 AND UNDERSTOOD THE SAMBA OPLOCK CODE\fR.
4367 Default: \fBoplock contention limit = 2\fR
4370 This boolean option tells smbd whether to
4371 issue oplocks (opportunistic locks) to file open requests on this
4372 share. The oplock code can dramatically (approx. 30% or more) improve
4373 the speed of access to files on Samba servers. It allows the clients
4374 to aggressively cache files locally and you may want to disable this
4375 option for unreliable network environments (it is turned on by
4376 default in Windows NT Servers). For more information see the file
4377 \fISpeed.txt\fR in the Samba \fIdocs/\fR
4380 Oplocks may be selectively turned off on certain files with a
4381 share. See the \fI veto oplock files\fR parameter. On some systems
4382 oplocks are recognized by the underlying operating system. This
4383 allows data synchronization between all access to oplocked files,
4384 whether it be via Samba or NFS or a local UNIX process. See the
4385 \fIkernel oplocks\fR parameter for details.
4387 See also the \fIkernel
4388 oplocks\fR and \fI level2 oplocks\fR parameters.
4390 Default: \fBoplocks = yes\fR
4393 This integer value controls what level Samba
4394 advertises itself as for browse elections. The value of this
4395 parameter determines whether nmbd(8)has a chance of becoming a local master browser for the \fI WORKGROUP\fR in the local broadcast area.
4397 \fBNote :\fRBy default, Samba will win
4398 a local master browsing election over all Microsoft operating
4399 systems except a Windows NT 4.0/2000 Domain Controller. This
4400 means that a misconfigured Samba host can effectively isolate
4401 a subnet for browsing purposes. See \fIBROWSING.txt
4402 \fRin the Samba \fIdocs/\fR directory
4405 Default: \fBos level = 20\fR
4407 Example: \fBos level = 65 \fR
4409 \fBos2 driver map (G)\fR
4410 The parameter is used to define the absolute
4411 path to a file containing a mapping of Windows NT printer driver
4412 names to OS/2 printer driver names. The format is:
4414 <nt driver name> = <os2 driver
4417 For example, a valid entry using the HP LaserJet 5
4418 printer driver woudl appear as \fBHP LaserJet 5L = LASERJET.HP
4421 The need for the file is due to the printer driver namespace
4422 problem described in the Samba
4423 Printing HOWTO. For more details on OS/2 clients, please
4424 refer to the OS2-Client-HOWTO
4425 containing in the Samba documentation.
4427 Default: \fBos2 driver map = <empty string>
4429 \fBpanic action (G)\fR
4430 This is a Samba developer option that allows a
4431 system command to be called when either smbd(8)crashes. This is usually used to draw attention to the fact that
4434 Default: \fBpanic action = <empty string>\fR
4436 Example: \fBpanic action = "/bin/sleep 90000"\fR
4438 \fBpasswd chat (G)\fR
4439 This string controls the \fB"chat"\fR
4440 conversation that takes places between smbdand the local password changing
4441 program to change the users password. The string describes a
4442 sequence of response-receive pairs that smbd(8)uses to determine what to send to the
4443 \fIpasswd program\fR
4444 and what to expect back. If the expected output is not
4445 received then the password is not changed.
4447 This chat sequence is often quite site specific, depending
4448 on what local methods are used for password control (such as NIS
4451 The string can contain the macros \fI%o\fR
4452 and \fI%n\fR which are substituted for the old
4453 and new passwords respectively. It can also contain the standard
4454 macros \\n, \\r, \\t and %s to give line-feed,
4455 carriage-return, tab and space.
4457 The string can also contain a '*' which matches
4458 any sequence of characters.
4460 Double quotes can be used to collect strings with spaces
4461 in them into a single string.
4463 If the send string in any part of the chat sequence
4464 is a fullstop ".", then no string is sent. Similarly,
4465 if the expect string is a fullstop then no string is expected.
4467 Note that if the \fIunix
4468 password sync\fR parameter is set to true, then this
4469 sequence is called \fBAS ROOT\fR when the SMB password
4470 in the smbpasswd file is being changed, without access to the old
4471 password cleartext. In this case the old password cleartext is set
4472 to "" (the empty string).
4474 See also \fIunix password
4475 sync\fR, \fI passwd program\fR and \fIpasswd chat debug\fR.
4477 Default: \fBpasswd chat = *new*password* %n\\n
4478 *new*password* %n\\n *changed*\fR
4480 Example: \fBpasswd chat = "*Enter OLD password*" %o\\n
4481 "*Enter NEW password*" %n\\n "*Reenter NEW password*" %n\\n "*Password
4484 \fBpasswd chat debug (G)\fR
4485 This boolean specifies if the passwd chat script
4486 parameter is run in \fBdebug\fR mode. In this mode the
4487 strings passed to and received from the passwd chat are printed
4488 in the smbd(8)log with a
4490 of 100. This is a dangerous option as it will allow plaintext passwords
4491 to be seen in the \fBsmbd\fR log. It is available to help
4492 Samba admins debug their \fIpasswd chat\fR scripts
4493 when calling the \fIpasswd program\fR and should
4494 be turned off after this has been done. This parameter is off by
4497 See also <\fIpasswd chat\fR
4498 , \fIpasswd program\fR
4501 Default: \fBpasswd chat debug = no\fR
4503 \fBpasswd program (G)\fR
4504 The name of a program that can be used to set
4505 UNIX user passwords. Any occurrences of \fI%u\fR
4506 will be replaced with the user name. The user name is checked for
4507 existence before calling the password changing program.
4509 Also note that many passwd programs insist in \fBreasonable
4510 \fRpasswords, such as a minimum length, or the inclusion
4511 of mixed case chars and digits. This can pose a problem as some clients
4512 (such as Windows for Workgroups) uppercase the password before sending
4515 \fBNote\fR that if the \fIunix
4516 password sync\fR parameter is set to True
4517 then this program is called \fBAS ROOT\fR
4518 before the SMB password in the smbpasswd(5)
4519 file is changed. If this UNIX password change fails, then
4520 \fBsmbd\fR will fail to change the SMB password also
4521 (this is by design).
4523 If the \fIunix password sync\fR parameter
4524 is set this parameter \fBMUST USE ABSOLUTE PATHS\fR
4525 for \fBALL\fR programs called, and must be examined
4526 for security implications. Note that by default \fIunix
4527 password sync\fR is set to False.
4532 Default: \fBpasswd program = /bin/passwd\fR
4534 Example: \fBpasswd program = /sbin/npasswd %u\fR
4536 \fBpassword level (G)\fR
4537 Some client/server combinations have difficulty
4538 with mixed-case passwords. One offending client is Windows for
4539 Workgroups, which for some reason forces passwords to upper
4540 case when using the LANMAN1 protocol, but leaves them alone when
4541 using COREPLUS! Another problem child is the Windows 95/98
4542 family of operating systems. These clients upper case clear
4543 text passwords even when NT LM 0.12 selected by the protocol
4544 negotiation request/response.
4546 This parameter defines the maximum number of characters
4547 that may be upper case in passwords.
4549 For example, say the password given was "FRED". If \fI password level\fR is set to 1, the following combinations
4550 would be tried if "FRED" failed:
4552 "Fred", "fred", "fRed", "frEd","freD"
4554 If \fIpassword level\fR was set to 2,
4555 the following combinations would also be tried:
4557 "FRed", "FrEd", "FreD", "fREd", "fReD", "frED", ..
4561 The higher value this parameter is set to the more likely
4562 it is that a mixed case password will be matched against a single
4563 case password. However, you should be aware that use of this
4564 parameter reduces security and increases the time taken to
4565 process a new connection.
4567 A value of zero will cause only two attempts to be
4568 made - the password as is and the password in all-lower case.
4570 Default: \fBpassword level = 0\fR
4572 Example: \fBpassword level = 4\fR
4574 \fBpassword server (G)\fR
4575 By specifying the name of another SMB server (such
4576 as a WinNT box) with this option, and using \fBsecurity = domain
4577 \fRor \fBsecurity = server\fR you can get Samba
4578 to do all its username/password validation via a remote server.
4580 This option sets the name of the password server to use.
4581 It must be a NetBIOS name, so if the machine's NetBIOS name is
4582 different from its Internet name then you may have to add its NetBIOS
4583 name to the lmhosts file which is stored in the same directory
4584 as the \fIsmb.conf\fR file.
4586 The name of the password server is looked up using the
4588 resolve order\fR and so may resolved
4589 by any method and order described in that parameter.
4591 The password server much be a machine capable of using
4592 the "LM1.2X002" or the "NT LM 0.12" protocol, and it must be in
4593 user level security mode.
4595 \fBNOTE:\fR Using a password server
4596 means your UNIX box (running Samba) is only as secure as your
4597 password server. \fBDO NOT CHOOSE A PASSWORD SERVER THAT
4598 YOU DON'T COMPLETELY TRUST\fR.
4600 Never point a Samba server at itself for password
4601 serving. This will cause a loop and could lock up your Samba
4604 The name of the password server takes the standard
4605 substitutions, but probably the only useful one is \fI%m
4606 \fR, which means the Samba server will use the incoming
4607 client as the password server. If you use this then you better
4608 trust your clients, and you had better restrict them with hosts allow!
4610 If the \fIsecurity\fR parameter is set to
4611 domain, then the list of machines in this
4612 option must be a list of Primary or Backup Domain controllers for the
4613 Domain or the character '*', as the Samba server is effectively
4614 in that domain, and will use cryptographically authenticated RPC calls
4615 to authenticate the user logging on. The advantage of using \fB security = domain\fR is that if you list several hosts in the
4616 \fIpassword server\fR option then \fBsmbd
4617 \fRwill try each in turn till it finds one that responds. This
4618 is useful in case your primary server goes down.
4620 If the \fIpassword server\fR option is set
4621 to the character '*', then Samba will attempt to auto-locate the
4622 Primary or Backup Domain controllers to authenticate against by
4623 doing a query for the name WORKGROUP<1C>
4624 and then contacting each server returned in the list of IP
4625 addresses from the name resolution source.
4627 If the \fIsecurity\fR parameter is
4628 set to server, then there are different
4629 restrictions that \fBsecurity = domain\fR doesn't
4634 You may list several password servers in
4635 the \fIpassword server\fR parameter, however if an
4636 \fBsmbd\fR makes a connection to a password server,
4637 and then the password server fails, no more users will be able
4638 to be authenticated from this \fBsmbd\fR. This is a
4639 restriction of the SMB/CIFS protocol when in \fBsecurity=server
4640 \fRmode and cannot be fixed in Samba.
4643 If you are using a Windows NT server as your
4644 password server then you will have to ensure that your users
4645 are able to login from the Samba server, as when in \fB security=server\fR mode the network logon will appear to
4646 come from there rather than from the users workstation.
4649 See also the \fIsecurity
4653 Default: \fBpassword server = <empty string>\fR
4656 Example: \fBpassword server = NT-PDC, NT-BDC1, NT-BDC2
4659 Example: \fBpassword server = *\fR
4663 This parameter specifies a directory to which
4664 the user of the service is to be given access. In the case of
4665 printable services, this is where print data will spool prior to
4666 being submitted to the host for printing.
4668 For a printable service offering guest access, the service
4669 should be readonly and the path should be world-writeable and
4670 have the sticky bit set. This is not mandatory of course, but
4671 you probably won't get the results you expect if you do
4674 Any occurrences of \fI%u\fR in the path
4675 will be replaced with the UNIX username that the client is using
4676 on this connection. Any occurrences of \fI%m\fR
4677 will be replaced by the NetBIOS name of the machine they are
4678 connecting from. These replacements are very useful for setting
4679 up pseudo home directories for users.
4681 Note that this path will be based on \fIroot dir\fR if one was specified.
4685 Example: \fBpath = /home/fred\fR
4687 \fBposix locking (S)\fR
4688 The \fBsmbd(8)\fRdaemon maintains an database of file locks obtained by SMB clients.
4689 The default behavior is to map this internal database to POSIX
4690 locks. This means that file locks obtained by SMB clients are
4691 consistent with those seen by POSIX compliant applications accessing
4692 the files via a non-SMB method (e.g. NFS or local file access).
4693 You should never need to disable this parameter.
4695 Default: \fBposix locking = yes\fR
4698 This option specifies a command to be run
4699 whenever the service is disconnected. It takes the usual
4700 substitutions. The command may be run as the root on some
4703 An interesting example may be do unmount server
4706 \fBpostexec = /etc/umount /cdrom\fR
4708 See also \fIpreexec\fR
4711 Default: \fBnone (no command executed)\fR
4713 Example: \fBpostexec = echo \\"%u disconnected from %S
4714 from %m (%I)\\" >> /tmp/log\fR
4716 \fBpostscript (S)\fR
4717 This parameter forces a printer to interpret
4718 the print files as postscript. This is done by adding a %!
4719 to the start of print output.
4721 This is most useful when you have lots of PCs that persist
4722 in putting a control-D at the start of print jobs, which then
4723 confuses your printer.
4725 Default: \fBpostscript = no\fR
4728 This option specifies a command to be run whenever
4729 the service is connected to. It takes the usual substitutions.
4731 An interesting example is to send the users a welcome
4732 message every time they log in. Maybe a message of the day? Here
4735 \fBpreexec = csh -c 'echo \\"Welcome to %S!\\" |
4736 /usr/local/samba/bin/smbclient -M %m -I %I' & \fR
4738 Of course, this could get annoying after a while :-)
4740 See also \fIpreexec close
4744 Default: \fBnone (no command executed)\fR
4746 Example: \fBpreexec = echo \\"%u connected to %S from %m
4747 (%I)\\" >> /tmp/log\fR
4749 \fBpreexec close (S)\fR
4750 This boolean option controls whether a non-zero
4751 return code from \fIpreexec
4752 \fRshould close the service being connected to.
4754 Default: \fBpreexec close = no\fR
4756 \fBpreferred master (G)\fR
4757 This boolean parameter controls if nmbd(8)is a preferred master browser
4760 If this is set to true, on startup, \fBnmbd\fR
4761 will force an election, and it will have a slight advantage in
4762 winning the election. It is recommended that this parameter is
4763 used in conjunction with \fB\fI domain master\fB = yes\fR, so that \fB nmbd\fR can guarantee becoming a domain master.
4765 Use this option with caution, because if there are several
4766 hosts (whether Samba servers, Windows 95 or NT) that are preferred
4767 master browsers on the same subnet, they will each periodically
4768 and continuously attempt to become the local master browser.
4769 This will result in unnecessary broadcast traffic and reduced browsing
4772 See also \fIos level\fR
4775 Default: \fBpreferred master = auto\fR
4777 \fBprefered master (G)\fR
4778 Synonym for \fI preferred master\fR for people who cannot spell :-).
4781 This is a list of services that you want to be
4782 automatically added to the browse lists. This is most useful
4783 for homes and printers services that would otherwise not be
4786 Note that if you just want all printers in your
4787 printcap file loaded then the \fIload printers\fR option is easier.
4789 Default: \fBno preloaded services\fR
4791 Example: \fBpreload = fred lp colorlp\fR
4793 \fBpreserve case (S)\fR
4794 This controls if new filenames are created
4795 with the case that the client passes, or if they are forced to
4796 be the \fIdefault case
4799 Default: \fBpreserve case = yes\fR
4801 See the section on NAME
4802 MANGLING for a fuller discussion.
4804 \fBprint command (S)\fR
4805 After a print job has finished spooling to
4806 a service, this command will be used via a \fBsystem()\fR
4807 call to process the spool file. Typically the command specified will
4808 submit the spool file to the host's printing subsystem, but there
4809 is no requirement that this be the case. The server will not remove
4810 the spool file, so whatever command you specify should remove the
4811 spool file when it has been processed, otherwise you will need to
4812 manually remove old spool files.
4814 The print command is simply a text string. It will be used
4815 verbatim, with two exceptions: All occurrences of \fI%s
4816 \fRand \fI%f\fR will be replaced by the
4817 appropriate spool file name, and all occurrences of \fI%p
4818 \fRwill be replaced by the appropriate printer name. The
4819 spool file name is generated automatically by the server, the printer
4820 name is discussed below.
4822 The print command \fBMUST\fR contain at least
4823 one occurrence of \fI%s\fR or \fI%f
4824 \fR- the \fI%p\fR is optional. At the time
4825 a job is submitted, if no printer name is supplied the \fI%p
4826 \fRwill be silently removed from the printer command.
4828 If specified in the [global] section, the print command given
4829 will be used for any printable service that does not have its own
4830 print command specified.
4832 If there is neither a specified print command for a
4833 printable service nor a global print command, spool files will
4834 be created but not processed and (most importantly) not removed.
4836 Note that printing may fail on some UNIXes from the
4837 nobody account. If this happens then create
4838 an alternative guest account that can print and set the \fIguest account\fR
4839 in the [global] section.
4841 You can form quite complex print commands by realizing
4842 that they are just passed to a shell. For example the following
4843 will log a print job, print the file, then remove it. Note that
4844 \&';' is the usual separator for command in shell scripts.
4846 \fBprint command = echo Printing %s >>
4847 /tmp/print.log; lpr -P %p %s; rm %s\fR
4849 You may have to vary this command considerably depending
4850 on how you normally print files on your system. The default for
4851 the parameter varies depending on the setting of the \fIprinting\fR parameter.
4853 Default: For \fBprinting= BSD, AIX, QNX, LPRNG
4856 \fBprint command = lpr -r -P%p %s\fR
4858 For \fBprinting= SYS or HPUX :\fR
4860 \fBprint command = lp -c -d%p %s; rm %s\fR
4862 For \fBprinting=SOFTQ :\fR
4864 \fBprint command = lp -d%p -s %s; rm %s\fR
4866 Example: \fBprint command = /usr/local/samba/bin/myprintscript
4870 Synonym for \fIprintable\fR.
4873 If this parameter is yes, then
4874 clients may open, write to and submit spool files on the directory
4875 specified for the service.
4877 Note that a printable service will ALWAYS allow writing
4878 to the service path (user privileges permitting) via the spooling
4879 of print data. The \fIwriteable
4880 \fRparameter controls only non-printing access to
4883 Default: \fBprintable = no\fR
4886 Synonym for \fI printcap name\fR.
4888 \fBprintcap name (G)\fR
4889 This parameter may be used to override the
4890 compiled-in default printcap name used by the server (usually \fI /etc/printcap\fR). See the discussion of the [printers] section above for reasons
4891 why you might want to do this.
4893 On System V systems that use \fBlpstat\fR to
4894 list available printers you can use \fBprintcap name = lpstat
4895 \fRto automatically obtain lists of available printers. This
4896 is the default for systems that define SYSV at configure time in
4897 Samba (this includes most System V based systems). If \fI printcap name\fR is set to \fBlpstat\fR on
4898 these systems then Samba will launch \fBlpstat -v\fR and
4899 attempt to parse the output to obtain a printer list.
4901 A minimal printcap file would look something like this:
4914 where the '|' separates aliases of a printer. The fact
4915 that the second alias has a space in it gives a hint to Samba
4916 that it's a comment.
4918 \fBNOTE\fR: Under AIX the default printcap
4919 name is \fI/etc/qconfig\fR. Samba will assume the
4920 file is in AIX \fIqconfig\fR format if the string
4921 \fIqconfig\fR appears in the printcap filename.
4923 Default: \fBprintcap name = /etc/printcap\fR
4925 Example: \fBprintcap name = /etc/myprintcap\fR
4927 \fBprinter admin (S)\fR
4928 This is a list of users that can do anything to
4929 printers via the remote administration interfaces offered by MS-RPC
4930 (usually using a NT workstation). Note that the root user always
4933 Default: \fBprinter admin = <empty string>\fR
4935 Example: \fBprinter admin = admin, @staff\fR
4937 \fBprinter driver (S)\fR
4938 \fBNote :\fRThis is a depreciated
4939 parameter and will be removed in the next major release
4940 following version 2.2. Please see the instructions in
4941 \fIPRINTER_DRIVER2.txt\fR in the \fIdocs
4942 \fRof the Samba distribution for more information
4943 on the new method of loading printer drivers onto a Samba server.
4945 This option allows you to control the string
4946 that clients receive when they ask the server for the printer driver
4947 associated with a printer. If you are using Windows95 or Windows NT
4948 then you can use this to automate the setup of printers on your
4951 You need to set this parameter to the exact string (case
4952 sensitive) that describes the appropriate printer driver for your
4953 system. If you don't know the exact string to use then you should
4954 first try with no \fI printer driver\fR option set and the client will
4955 give you a list of printer drivers. The appropriate strings are
4956 shown in a scroll box after you have chosen the printer manufacturer.
4961 Example: \fBprinter driver = HP LaserJet 4L\fR
4963 \fBprinter driver file (G)\fR
4964 \fBNote :\fRThis is a depreciated
4965 parameter and will be removed in the next major release
4966 following version 2.2. Please see the instructions in
4967 \fIPRINTER_DRIVER2.txt\fR in the \fIdocs
4968 \fRof the Samba distribution for more information
4969 on the new method of loading printer drivers onto a Samba server.
4971 This parameter tells Samba where the printer driver
4972 definition file, used when serving drivers to Windows 95 clients, is
4973 to be found. If this is not set, the default is :
4975 \fISAMBA_INSTALL_DIRECTORY
4976 /lib/printers.def\fR
4978 This file is created from Windows 95 \fImsprint.inf
4979 \fRfiles found on the Windows 95 client system. For more
4980 details on setting up serving of printer drivers to Windows 95
4981 clients, see the documentation file in the \fIdocs/\fR
4982 directory, \fIPRINTER_DRIVER.txt\fR.
4984 See also \fI printer driver location\fR.
4986 Default: \fBNone (set in compile).\fR
4988 Example: \fBprinter driver file =
4989 /usr/local/samba/printers/drivers.def\fR
4991 \fBprinter driver location (S)\fR
4992 \fBNote :\fRThis is a depreciated
4993 parameter and will be removed in the next major release
4994 following version 2.2. Please see the instructions in
4995 \fIPRINTER_DRIVER2.txt\fR in the \fIdocs
4996 \fRof the Samba distribution for more information
4997 on the new method of loading printer drivers onto a Samba server.
4999 This parameter tells clients of a particular printer
5000 share where to find the printer driver files for the automatic
5001 installation of drivers for Windows 95 machines. If Samba is set up
5002 to serve printer drivers to Windows 95 machines, this should be set to
5004 \fB\\\\MACHINE\\PRINTER$\fR
5006 Where MACHINE is the NetBIOS name of your Samba server,
5007 and PRINTER$ is a share you set up for serving printer driver
5008 files. For more details on setting this up see the documentation
5009 file in the \fIdocs/\fR directory, \fI PRINTER_DRIVER.txt\fR.
5011 See also \fI printer driver file\fR.
5015 Example: \fBprinter driver location = \\\\MACHINE\\PRINTER$
5017 \fBprinter name (S)\fR
5018 This parameter specifies the name of the printer
5019 to which print jobs spooled through a printable service will be sent.
5021 If specified in the [global] section, the printer
5022 name given will be used for any printable service that does
5023 not have its own printer name specified.
5025 Default: \fBnone (but may be lp
5028 Example: \fBprinter name = laserwriter\fR
5031 Synonym for \fI printer name\fR.
5034 This parameters controls how printer status
5035 information is interpreted on your system. It also affects the
5036 default values for the \fIprint command\fR,
5037 \fIlpq command\fR, \fIlppause command
5038 \fR, \fIlpresume command\fR, and
5039 \fIlprm command\fR if specified in the
5042 Currently eight printing styles are supported. They are
5049 To see what the defaults are for the other print
5050 commands when using the various options use the testparm(1)program.
5052 This option can be set on a per printer basis
5054 See also the discussion in the [printers] section.
5057 Synonym for \fImax protocol\fR.
5060 Synonym for \fIguest
5063 \fBqueuepause command (S)\fR
5064 This parameter specifies the command to be
5065 executed on the server host in order to pause the printerqueue.
5067 This command should be a program or script which takes
5068 a printer name as its only parameter and stops the printerqueue,
5069 such that no longer jobs are submitted to the printer.
5071 This command is not supported by Windows for Workgroups,
5072 but can be issued from the Printer's window under Windows 95
5075 If a \fI%p\fR is given then the printername
5076 is put in its place. Otherwise it is placed at the end of the command.
5078 Note that it is good practice to include the absolute
5079 path in the command as the PATH may not be available to the
5082 Default: \fBdepends on the setting of \fIprinting
5084 Example: \fBqueuepause command = disable %p\fR
5086 \fBqueueresume command (S)\fR
5087 This parameter specifies the command to be
5088 executed on the server host in order to resume the printerqueue. It
5089 is the command to undo the behavior that is caused by the
5090 previous parameter (\fI queuepause command\fR).
5092 This command should be a program or script which takes
5093 a printer name as its only parameter and resumes the printerqueue,
5094 such that queued jobs are resubmitted to the printer.
5096 This command is not supported by Windows for Workgroups,
5097 but can be issued from the Printer's window under Windows 95
5100 If a \fI%p\fR is given then the printername
5101 is put in its place. Otherwise it is placed at the end of the
5104 Note that it is good practice to include the absolute
5105 path in the command as the PATH may not be available to the
5108 Default: \fBdepends on the setting of \fIprinting\fB\fR
5110 Example: \fBqueuepause command = enable %p
5113 This boolean parameter controls whether smbd(8)will support the "Read
5114 Block Multiplex" SMB. This is now rarely used and defaults to
5115 no. You should never need to set this
5118 Default: \fBread bmpx = no\fR
5121 This is a list of users that are given read-only
5122 access to a service. If the connecting user is in this list then
5123 they will not be given write access, no matter what the \fIwriteable\fR
5124 option is set to. The list can include group names using the
5125 syntax described in the \fI invalid users\fR parameter.
5127 See also the \fI write list\fR parameter and the \fIinvalid users\fR
5130 Default: \fBread list = <empty string>\fR
5132 Example: \fBread list = mary, @students\fR
5135 Note that this is an inverted synonym for \fIwriteable\fR.
5138 This parameter controls whether or not the server
5139 will support the raw read SMB requests when transferring data
5142 If enabled, raw reads allow reads of 65535 bytes in
5143 one packet. This typically provides a major performance benefit.
5145 However, some clients either negotiate the allowable
5146 block size incorrectly or are incapable of supporting larger block
5147 sizes, and for these clients you may need to disable raw reads.
5149 In general this parameter should be viewed as a system tuning
5150 tool and left severely alone. See also \fIwrite raw\fR.
5152 Default: \fBread raw = yes\fR
5155 The option \fIread size\fR
5156 affects the overlap of disk reads/writes with network reads/writes.
5157 If the amount of data being transferred in several of the SMB
5158 commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger
5159 than this value then the server begins writing the data before it
5160 has received the whole packet from the network, or in the case of
5161 SMBreadbraw, it begins writing to the network before all the data
5162 has been read from disk.
5164 This overlapping works best when the speeds of disk and
5165 network access are similar, having very little effect when the
5166 speed of one is much greater than the other.
5168 The default value is 16384, but very little experimentation
5169 has been done yet to determine the optimal value, and it is likely
5170 that the best value will vary greatly between systems anyway.
5171 A value over 65536 is pointless and will cause you to allocate
5172 memory unnecessarily.
5174 Default: \fBread size = 16384\fR
5176 Example: \fBread size = 8192\fR
5178 \fBremote announce (G)\fR
5179 This option allows you to setup nmbd(8)to periodically announce itself
5180 to arbitrary IP addresses with an arbitrary workgroup name.
5182 This is useful if you want your Samba server to appear
5183 in a remote workgroup for which the normal browse propagation
5184 rules don't work. The remote workgroup can be anywhere that you
5185 can send IP packets to.
5189 \fBremote announce = 192.168.2.255/SERVERS
5190 192.168.4.255/STAFF\fR
5192 the above line would cause nmbd to announce itself
5193 to the two given IP addresses using the given workgroup names.
5194 If you leave out the workgroup name then the one given in
5196 parameter is used instead.
5198 The IP addresses you choose would normally be the broadcast
5199 addresses of the remote networks, but can also be the IP addresses
5200 of known browse masters if your network config is that stable.
5202 See the documentation file \fIBROWSING.txt\fR
5203 in the \fIdocs/\fR directory.
5205 Default: \fBremote announce = <empty string>
5207 \fBremote browse sync (G)\fR
5208 This option allows you to setup nmbd(8)to periodically request
5209 synchronization of browse lists with the master browser of a samba
5210 server that is on a remote segment. This option will allow you to
5211 gain browse lists for multiple workgroups across routed networks. This
5212 is done in a manner that does not work with any non-samba servers.
5214 This is useful if you want your Samba server and all local
5215 clients to appear in a remote workgroup for which the normal browse
5216 propagation rules don't work. The remote workgroup can be anywhere
5217 that you can send IP packets to.
5221 \fBremote browse sync = 192.168.2.255 192.168.4.255
5223 the above line would cause \fBnmbd\fR to request
5224 the master browser on the specified subnets or addresses to
5225 synchronize their browse lists with the local server.
5227 The IP addresses you choose would normally be the broadcast
5228 addresses of the remote networks, but can also be the IP addresses
5229 of known browse masters if your network config is that stable. If
5230 a machine IP address is given Samba makes NO attempt to validate
5231 that the remote machine is available, is listening, nor that it
5232 is in fact the browse master on it's segment.
5234 Default: \fBremote browse sync = <empty string>
5236 \fBrestrict anonymous (G)\fR
5237 This is a boolean parameter. If it is true, then
5238 anonymous access to the server will be restricted, namely in the
5239 case where the server is expecting the client to send a username,
5240 but it doesn't. Setting it to true will force these anonymous
5241 connections to be denied, and the client will be required to always
5242 supply a username and password when connecting. Use of this parameter
5243 is only recommended for homogeneous NT client environments.
5245 This parameter makes the use of macro expansions that rely
5246 on the username (%U, %G, etc) consistent. NT 4.0
5247 likes to use anonymous connections when refreshing the share list,
5248 and this is a way to work around that.
5250 When restrict anonymous is true, all anonymous connections
5251 are denied no matter what they are for. This can effect the ability
5252 of a machine to access the samba Primary Domain Controller to revalidate
5253 it's machine account after someone else has logged on the client
5254 interactively. The NT client will display a message saying that
5255 the machine's account in the domain doesn't exist or the password is
5256 bad. The best way to deal with this is to reboot NT client machines
5257 between interactive logons, using "Shutdown and Restart", rather
5258 than "Close all programs and logon as a different user".
5260 Default: \fBrestrict anonymous = no\fR
5263 Synonym for \fIroot directory"\fR.
5266 Synonym for \fIroot directory"\fR.
5268 \fBroot directory (G)\fR
5269 The server will \fBchroot()\fR (i.e.
5270 Change it's root directory) to this directory on startup. This is
5271 not strictly necessary for secure operation. Even without it the
5272 server will deny access to files not in one of the service entries.
5273 It may also check for, and deny access to, soft links to other
5274 parts of the filesystem, or attempts to use ".." in file names
5275 to access other directories (depending on the setting of the \fIwide links\fR
5278 Adding a \fIroot directory\fR entry other
5279 than "/" adds an extra level of security, but at a price. It
5280 absolutely ensures that no access is given to files not in the
5281 sub-tree specified in the \fIroot directory\fR
5282 option, \fBincluding\fR some files needed for
5283 complete operation of the server. To maintain full operability
5284 of the server you will need to mirror some system files
5285 into the \fIroot directory\fR tree. In particular
5286 you will need to mirror \fI/etc/passwd\fR (or a
5287 subset of it), and any binaries or configuration files needed for
5288 printing (if required). The set of files that must be mirrored is
5289 operating system dependent.
5291 Default: \fBroot directory = /\fR
5293 Example: \fBroot directory = /homes/smb\fR
5295 \fBroot postexec (S)\fR
5296 This is the same as the \fIpostexec\fR
5297 parameter except that the command is run as root. This
5298 is useful for unmounting filesystems
5299 (such as cdroms) after a connection is closed.
5301 See also \fI postexec\fR.
5303 Default: \fBroot postexec = <empty string>
5305 \fBroot preexec (S)\fR
5306 This is the same as the \fIpreexec\fR
5307 parameter except that the command is run as root. This
5308 is useful for mounting filesystems (such as cdroms) after a
5309 connection is closed.
5311 See also \fI preexec\fR and \fIpreexec close\fR.
5313 Default: \fBroot preexec = <empty string>
5315 \fBroot preexec close (S)\fR
5316 This is the same as the \fIpreexec close
5317 \fRparameter except that the command is run as root.
5319 See also \fI preexec\fR and \fIpreexec close\fR.
5321 Default: \fBroot preexec close = no\fR
5324 This option affects how clients respond to
5325 Samba and is one of the most important settings in the \fI smb.conf\fR file.
5327 The option sets the "security mode bit" in replies to
5328 protocol negotiations with smbd(8)
5329 to turn share level security on or off. Clients decide
5330 based on this bit whether (and how) to transfer user and password
5331 information to the server.
5333 The default is \fBsecurity = user\fR, as this is
5334 the most common setting needed when talking to Windows 98 and
5337 The alternatives are \fBsecurity = share\fR,
5338 \fBsecurity = server\fR or \fBsecurity=domain
5341 In versions of Samba prior to 2..0, the default was
5342 \fBsecurity = share\fR mainly because that was
5343 the only option at one stage.
5345 There is a bug in WfWg that has relevance to this
5346 setting. When in user or server level security a WfWg client
5347 will totally ignore the password you type in the "connect
5348 drive" dialog box. This makes it very difficult (if not impossible)
5349 to connect to a Samba service as anyone except the user that
5350 you are logged into WfWg as.
5352 If your PCs use usernames that are the same as their
5353 usernames on the UNIX machine then you will want to use
5354 \fBsecurity = user\fR. If you mostly use usernames
5355 that don't exist on the UNIX box then use \fBsecurity =
5358 You should also use \fBsecurity = share\fR if you
5359 want to mainly setup shares without a password (guest shares). This
5360 is commonly used for a shared printer server. It is more difficult
5361 to setup guest shares with \fBsecurity = user\fR, see
5362 the \fImap to guest\fR
5363 parameter for details.
5365 It is possible to use \fBsmbd\fR in a \fB hybrid mode\fR where it is offers both user and share
5366 level security under different \fINetBIOS aliases\fR.
5368 The different settings will now be explained.
5372 When clients connect to a share level security server then
5373 need not log onto the server with a valid username and password before
5374 attempting to connect to a shared resource (although modern clients
5375 such as Windows 95/98 and Windows NT will send a logon request with
5376 a username but no password when talking to a \fBsecurity = share
5377 \fRserver). Instead, the clients send authentication information
5378 (passwords) on a per-share basis, at the time they attempt to connect
5381 Note that \fBsmbd\fR \fBALWAYS\fR
5382 uses a valid UNIX user to act on behalf of the client, even in
5383 \fBsecurity = share\fR level security.
5385 As clients are not required to send a username to the server
5386 in share level security, \fBsmbd\fR uses several
5387 techniques to determine the correct UNIX user to use on behalf
5390 A list of possible UNIX usernames to match with the given
5391 client password is constructed using the following methods :
5396 only\fR parameter is set, then all the other
5397 stages are missed and only the \fIguest account\fR username is checked.
5400 Is a username is sent with the share connection
5401 request, then this username (after mapping - see \fIusername map\fR),
5402 is added as a potential username.
5405 If the client did a previous \fBlogon
5406 \fRrequest (the SessionSetup SMB call) then the
5407 username sent in this SMB will be added as a potential username.
5410 The name of the service the client requested is
5411 added as a potential username.
5414 The NetBIOS name of the client is added to
5415 the list as a potential username.
5418 Any users on the \fI user\fR list are added as potential usernames.
5421 If the \fIguest only\fR parameter is
5422 not set, then this list is then tried with the supplied password.
5423 The first user for whom the password matches will be used as the
5427 If the \fIguest only\fR parameter is
5428 set, or no username can be determined then if the share is marked
5429 as available to the \fIguest account\fR, then this
5430 guest user will be used, otherwise access is denied.
5433 Note that it can be \fBvery\fR confusing
5434 in share-level security as to which UNIX username will eventually
5435 be used in granting access.
5438 See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
5444 This is the default security setting in Samba 2.2.
5445 With user-level security a client must first "log=on" with a
5446 valid username and password (which can be mapped using the \fIusername map\fR
5447 parameter). Encrypted passwords (see the \fIencrypted passwords\fR parameter) can also
5448 be used in this security mode. Parameters such as \fIuser\fR and \fIguest only\fR if set are then applied and
5449 may change the UNIX user to use on this connection, but only after
5450 the user has been successfully authenticated.
5453 \fBNote\fR that the name of the resource being
5454 requested is \fBnot\fR sent to the server until after
5455 the server has successfully authenticated the client. This is why
5456 guest shares don't work in user level security without allowing
5457 the server to automatically map unknown users into the \fIguest account\fR.
5458 See the \fImap to guest\fR
5459 parameter for details on doing this.
5462 See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
5465 \fBSECURITY = SERVER
5468 In this mode Samba will try to validate the username/password
5469 by passing it to another SMB server, such as an NT box. If this
5470 fails it will revert to \fBsecurity = user\fR, but note
5471 that if encrypted passwords have been negotiated then Samba cannot
5472 revert back to checking the UNIX password file, it must have a valid
5473 \fIsmbpasswd\fR file to check users against. See the
5474 documentation file in the \fIdocs/\fR directory
5475 \fIENCRYPTION.txt\fR for details on how to set this
5479 \fBNote\fR that from the clients point of
5480 view \fBsecurity = server\fR is the same as \fB security = user\fR. It only affects how the server deals
5481 with the authentication, it does not in any way affect what the
5485 \fBNote\fR that the name of the resource being
5486 requested is \fBnot\fR sent to the server until after
5487 the server has successfully authenticated the client. This is why
5488 guest shares don't work in user level security without allowing
5489 the server to automatically map unknown users into the \fIguest account\fR.
5490 See the \fImap to guest\fR
5491 parameter for details on doing this.
5494 See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
5497 See also the \fIpassword
5498 server\fR parameter and the \fIencrypted passwords\fR
5502 \fBSECURITY = DOMAIN
5505 This mode will only work correctly if smbpasswd(8)has been used to add this
5506 machine into a Windows NT Domain. It expects the \fIencrypted passwords\fR
5507 parameter to be set to true. In this
5508 mode Samba will try to validate the username/password by passing
5509 it to a Windows NT Primary or Backup Domain Controller, in exactly
5510 the same way that a Windows NT Server would do.
5513 \fBNote\fR that a valid UNIX user must still
5514 exist as well as the account on the Domain Controller to allow
5515 Samba to have a valid UNIX account to map file access to.
5518 \fBNote\fR that from the clients point
5519 of view \fBsecurity = domain\fR is the same as \fBsecurity = user
5520 \fR\&. It only affects how the server deals with the authentication,
5521 it does not in any way affect what the client sees.
5524 \fBNote\fR that the name of the resource being
5525 requested is \fBnot\fR sent to the server until after
5526 the server has successfully authenticated the client. This is why
5527 guest shares don't work in user level security without allowing
5528 the server to automatically map unknown users into the \fIguest account\fR.
5529 See the \fImap to guest\fR
5530 parameter for details on doing this.
5533 \fBBUG:\fR There is currently a bug in the
5534 implementation of \fBsecurity = domain\fR with respect
5535 to multi-byte character set usernames. The communication with a
5536 Domain Controller must be done in UNICODE and Samba currently
5537 does not widen multi-byte user names to UNICODE correctly, thus
5538 a multi-byte username will not be recognized correctly at the
5539 Domain Controller. This issue will be addressed in a future release.
5542 See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
5545 See also the \fIpassword
5546 server\fR parameter and the \fIencrypted passwords\fR
5550 Default: \fBsecurity = USER\fR
5553 Example: \fBsecurity = DOMAIN\fR
5556 \fBsecurity mask (S)\fR
5557 This parameter controls what UNIX permission
5558 bits can be modified when a Windows NT client is manipulating
5559 the UNIX permission on a file using the native NT security
5562 This parameter is applied as a mask (AND'ed with) to
5563 the changed permission bits, thus preventing any bits not in
5564 this mask from being modified. Essentially, zero bits in this
5565 mask may be treated as a set of bits the user is not allowed
5568 If not set explicitly this parameter is set to the same
5569 value as the \fIcreate mask
5570 \fRparameter. To allow a user to modify all the
5571 user/group/world permissions on a file, set this parameter to
5574 \fBNote\fR that users who can access the
5575 Samba server through other means can easily bypass this
5576 restriction, so it is primarily useful for standalone
5577 "appliance" systems. Administrators of most normal systems will
5578 probably want to set it to 0777.
5580 See also the \fIforce directory security mode\fR,
5582 security mask\fR, \fIforce security mode\fR parameters.
5584 Default: \fBsecurity mask = <same as create mask>
5586 Example: \fBsecurity mask = 0777\fR
5588 \fBserver string (G)\fR
5589 This controls what string will show up in the
5590 printer comment box in print manager and next to the IPC connection
5591 in \fBnet view"\fR. It can be any string that you wish
5592 to show to your users.
5594 It also sets what will appear in browse lists next
5595 to the machine name.
5597 A \fI%v\fR will be replaced with the Samba
5600 A \fI%h\fR will be replaced with the
5603 Default: \fBserver string = Samba %v\fR
5605 Example: \fBserver string = University of GNUs Samba
5608 \fBset directory (S)\fR
5609 If \fBset directory = no\fR, then
5610 users of the service may not use the setdir command to change
5613 The \fBsetdir\fR command is only implemented
5614 in the Digital Pathworks client. See the Pathworks documentation
5617 Default: \fBset directory = no\fR
5619 \fBshare modes (S)\fR
5620 This enables or disables the honoring of
5621 the \fIshare modes\fR during a file open. These
5622 modes are used by clients to gain exclusive read or write access
5625 These open modes are not directly supported by UNIX, so
5626 they are simulated using shared memory, or lock files if your
5627 UNIX doesn't support shared memory (almost all do).
5629 The share modes that are enabled by this option are
5631 DENY_READ, DENY_WRITE,
5632 DENY_NONE and DENY_FCB.
5634 This option gives full share compatibility and enabled
5637 You should \fBNEVER\fR turn this parameter
5638 off as many Windows applications will break if you do so.
5640 Default: \fBshare modes = yes\fR
5642 \fBshort preserve case (S)\fR
5643 This boolean parameter controls if new files
5644 which conform to 8.3 syntax, that is all in upper case and of
5645 suitable length, are created upper case, or if they are forced
5646 to be the \fIdefault case
5647 \fR\&. This option can be use with \fBpreserve case = yes\fR
5648 to permit long filenames to retain their case, while short
5651 See the section on NAME MANGLING.
5653 Default: \fBshort preserve case = yes\fR
5655 \fBshow add printer wizard (G)\fR
5656 With the introduction of MS-RPC based printing support
5657 for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will
5658 appear on Samba hosts in the share listing. Normally this folder will
5659 contain an icon for the MS Add Printer Wizard (APW). However, it is
5660 possible to disable this feature regardless of the level of privilege
5661 of the connected user.
5663 Under normal circumstances, the Windows NT/2000 client will
5664 open a handle on the printer server with OpenPrinterEx() asking for
5665 Administrator privileges. If the user does not have administrative
5666 access on the print server (i.e is not root or a member of the
5667 \fIprinter admin\fR group), the OpenPrinterEx()
5668 call fails and the clients another open call with a request for
5669 a lower privilege level. This should succeed, however the APW
5670 icon will not be displayed.
5672 Disabling the \fIshow add printer wizard\fR
5673 parameter will always cause the OpenPrinterEx() on the server
5674 to fail. Thus the APW icon will never be displayed. \fB Note :\fRThis does not prevent the same user from having
5675 administrative privilege on an individual printer.
5677 See also \fIaddprinter
5678 command\fR, \fIdeleteprinter command\fR, \fIprinter admin\fR
5680 Default :\fBshow add printer wizard = yes\fR
5682 \fBsmb passwd file (G)\fR
5683 This option sets the path to the encrypted
5684 smbpasswd file. By default the path to the smbpasswd file
5685 is compiled into Samba.
5687 Default: \fBsmb passwd file = ${prefix}/private/smbpasswd
5689 Example: \fBsmb passwd file = /etc/samba/smbpasswd
5691 \fBsocket address (G)\fR
5692 This option allows you to control what
5693 address Samba will listen for connections on. This is used to
5694 support multiple virtual interfaces on the one server, each
5695 with a different configuration.
5697 By default samba will accept connections on any
5700 Example: \fBsocket address = 192.168.2.20\fR
5702 \fBsocket options (G)\fR
5703 This option allows you to set socket options
5704 to be used when talking with the client.
5706 Socket options are controls on the networking layer
5707 of the operating systems which allow the connection to be
5710 This option will typically be used to tune your Samba
5711 server for optimal performance for your local network. There is
5712 no way that Samba can know what the optimal parameters are for
5713 your net, so you must experiment and choose them yourself. We
5714 strongly suggest you read the appropriate documentation for your
5715 operating system first (perhaps \fBman setsockopt\fR
5718 You may find that on some systems Samba will say
5719 "Unknown socket option" when you supply an option. This means you
5720 either incorrectly typed it or you need to add an include file
5721 to includes.h for your OS. If the latter is the case please
5722 send the patch to samba@samba.org <URL:mailto:samba@samba.org>.
5724 Any of the supported socket options may be combined
5725 in any way you like, as long as your OS allows it.
5727 This is the list of socket options currently settable
5762 Those marked with a \fB'*'\fR take an integer
5763 argument. The others can optionally take a 1 or 0 argument to enable
5764 or disable the option, by default they will be enabled if you
5765 don't specify 1 or 0.
5768 To specify an argument use the syntax SOME_OPTION=VALUE
5769 for example \fBSO_SNDBUF=8192\fR. Note that you must
5770 not have any spaces before or after the = sign.
5773 If you are on a local network then a sensible option
5777 \fBsocket options = IPTOS_LOWDELAY\fR
5780 If you have a local network then you could try:
5783 \fBsocket options = IPTOS_LOWDELAY TCP_NODELAY\fR
5786 If you are on a wide area network then perhaps try
5787 setting IPTOS_THROUGHPUT.
5790 Note that several of the options may cause your Samba
5791 server to fail completely. Use these options with caution!
5794 Default: \fBsocket options = TCP_NODELAY\fR
5797 Example: \fBsocket options = IPTOS_LOWDELAY\fR
5800 \fBsource environment (G)\fR
5801 This parameter causes Samba to set environment
5802 variables as per the content of the file named.
5804 If the value of this parameter starts with a "|" character
5805 then Samba will treat that value as a pipe command to open and
5806 will set the environment variables from the output of the pipe.
5808 The contents of the file or the output of the pipe should
5809 be formatted as the output of the standard Unix \fBenv(1)
5810 \fRcommand. This is of the form :
5812 Example environment entry:
5814 \fBSAMBA_NETBIOS_NAME=myhostname\fR
5816 Default: \fBNo default value\fR
5818 Examples: \fBsource environment = |/etc/smb.conf.sh
5820 Example: \fBsource environment =
5821 /usr/local/smb_env_vars\fR
5824 This variable is part of SSL-enabled Samba. This
5825 is only available if the SSL libraries have been compiled on your
5826 system and the configure option \fB--with-ssl\fR was
5827 given at configure time.
5829 \fBNote\fR that for export control reasons
5830 this code is \fBNOT\fR enabled by default in any
5831 current binary version of Samba.
5833 This variable enables or disables the entire SSL mode. If
5834 it is set to no, the SSL enabled samba behaves
5835 exactly like the non-SSL samba. If set to yes,
5836 it depends on the variables \fI ssl hosts\fR and \fIssl hosts resign\fR whether an SSL
5837 connection will be required.
5839 Default: \fBssl=no\fR
5841 \fBssl CA certDir (G)\fR
5842 This variable is part of SSL-enabled Samba. This
5843 is only available if the SSL libraries have been compiled on your
5844 system and the configure option \fB--with-ssl\fR was
5845 given at configure time.
5847 \fBNote\fR that for export control reasons
5848 this code is \fBNOT\fR enabled by default in any
5849 current binary version of Samba.
5851 This variable defines where to look up the Certification
5852 Authorities. The given directory should contain one file for
5853 each CA that samba will trust. The file name must be the hash
5854 value over the "Distinguished Name" of the CA. How this directory
5855 is set up is explained later in this document. All files within the
5856 directory that don't fit into this naming scheme are ignored. You
5857 don't need this variable if you don't verify client certificates.
5859 Default: \fBssl CA certDir = /usr/local/ssl/certs
5861 \fBssl CA certFile (G)\fR
5862 This variable is part of SSL-enabled Samba. This
5863 is only available if the SSL libraries have been compiled on your
5864 system and the configure option \fB--with-ssl\fR was
5865 given at configure time.
5867 \fBNote\fR that for export control reasons
5868 this code is \fBNOT\fR enabled by default in any
5869 current binary version of Samba.
5871 This variable is a second way to define the trusted CAs.
5872 The certificates of the trusted CAs are collected in one big
5873 file and this variable points to the file. You will probably
5874 only use one of the two ways to define your CAs. The first choice is
5875 preferable if you have many CAs or want to be flexible, the second
5876 is preferable if you only have one CA and want to keep things
5877 simple (you won't need to create the hashed file names). You
5878 don't need this variable if you don't verify client certificates.
5880 Default: \fBssl CA certFile = /usr/local/ssl/certs/trustedCAs.pem
5882 \fBssl ciphers (G)\fR
5883 This variable is part of SSL-enabled Samba. This
5884 is only available if the SSL libraries have been compiled on your
5885 system and the configure option \fB--with-ssl\fR was
5886 given at configure time.
5888 \fBNote\fR that for export control reasons
5889 this code is \fBNOT\fR enabled by default in any
5890 current binary version of Samba.
5892 This variable defines the ciphers that should be offered
5893 during SSL negotiation. You should not set this variable unless
5894 you know what you are doing.
5896 \fBssl client cert (G)\fR
5897 This variable is part of SSL-enabled Samba. This
5898 is only available if the SSL libraries have been compiled on your
5899 system and the configure option \fB--with-ssl\fR was
5900 given at configure time.
5902 \fBNote\fR that for export control reasons
5903 this code is \fBNOT\fR enabled by default in any
5904 current binary version of Samba.
5906 The certificate in this file is used by \fBsmbclient(1)\fRif it exists. It's needed
5907 if the server requires a client certificate.
5909 Default: \fBssl client cert = /usr/local/ssl/certs/smbclient.pem
5911 \fBssl client key (G)\fR
5912 This variable is part of SSL-enabled Samba. This
5913 is only available if the SSL libraries have been compiled on your
5914 system and the configure option \fB--with-ssl\fR was
5915 given at configure time.
5917 \fBNote\fR that for export control reasons
5918 this code is \fBNOT\fR enabled by default in any
5919 current binary version of Samba.
5921 This is the private key for \fBsmbclient(1)\fR. It's only needed if the
5922 client should have a certificate.
5924 Default: \fBssl client key = /usr/local/ssl/private/smbclient.pem
5926 \fBssl compatibility (G)\fR
5927 This variable is part of SSL-enabled Samba. This
5928 is only available if the SSL libraries have been compiled on your
5929 system and the configure option \fB--with-ssl\fR was
5930 given at configure time.
5932 \fBNote\fR that for export control reasons
5933 this code is \fBNOT\fR enabled by default in any
5934 current binary version of Samba.
5936 This variable defines whether SSLeay should be configured
5937 for bug compatibility with other SSL implementations. This is
5938 probably not desirable because currently no clients with SSL
5939 implementations other than SSLeay exist.
5941 Default: \fBssl compatibility = no\fR
5944 See \fI ssl hosts resign\fR.
5946 \fBssl hosts resign (G)\fR
5947 This variable is part of SSL-enabled Samba. This
5948 is only available if the SSL libraries have been compiled on your
5949 system and the configure option \fB--with-ssl\fR was
5950 given at configure time.
5952 \fBNote\fR that for export control reasons
5953 this code is \fBNOT\fR enabled by default in any
5954 current binary version of Samba.
5956 These two variables define whether samba will go
5957 into SSL mode or not. If none of them is defined, samba will
5958 allow only SSL connections. If the \fIssl hosts\fR variable lists
5959 hosts (by IP-address, IP-address range, net group or name),
5960 only these hosts will be forced into SSL mode. If the \fI ssl hosts resign\fR variable lists hosts, only these
5961 hosts will NOT be forced into SSL mode. The syntax for these two
5962 variables is the same as for the \fI hosts allow\fR and \fIhosts deny\fR pair of variables, only
5963 that the subject of the decision is different: It's not the access
5964 right but whether SSL is used or not.
5966 The example below requires SSL connections from all hosts
5967 outside the local net (which is 192.168.*.*).
5969 Default: \fBssl hosts = <empty string>\fR
5971 \fBssl hosts resign = <empty string>\fR
5973 Example: \fBssl hosts resign = 192.168.\fR
5975 \fBssl require clientcert (G)\fR
5976 This variable is part of SSL-enabled Samba. This
5977 is only available if the SSL libraries have been compiled on your
5978 system and the configure option \fB--with-ssl\fR was
5979 given at configure time.
5981 \fBNote\fR that for export control reasons
5982 this code is \fBNOT\fR enabled by default in any
5983 current binary version of Samba.
5985 If this variable is set to yes, the
5986 server will not tolerate connections from clients that don't
5987 have a valid certificate. The directory/file given in \fIssl CA certDir\fR
5988 and \fIssl CA certFile
5989 \fRwill be used to look up the CAs that issued
5990 the client's certificate. If the certificate can't be verified
5991 positively, the connection will be terminated. If this variable
5992 is set to no, clients don't need certificates.
5993 Contrary to web applications you really \fBshould\fR
5994 require client certificates. In the web environment the client's
5995 data is sensitive (credit card numbers) and the server must prove
5996 to be trustworthy. In a file server environment the server's data
5997 will be sensitive and the clients must prove to be trustworthy.
5999 Default: \fBssl require clientcert = no\fR
6001 \fBssl require servercert (G)\fR
6002 This variable is part of SSL-enabled Samba. This
6003 is only available if the SSL libraries have been compiled on your
6004 system and the configure option \fB--with-ssl\fR was
6005 given at configure time.
6007 \fBNote\fR that for export control reasons
6008 this code is \fBNOT\fR enabled by default in any
6009 current binary version of Samba.
6011 If this variable is set to yes, the
6013 will request a certificate from the server. Same as
6015 clientcert\fR for the server.
6017 Default: \fBssl require servercert = no\fR
6019 \fBssl server cert (G)\fR
6020 This variable is part of SSL-enabled Samba. This
6021 is only available if the SSL libraries have been compiled on your
6022 system and the configure option \fB--with-ssl\fR was
6023 given at configure time.
6025 \fBNote\fR that for export control reasons
6026 this code is \fBNOT\fR enabled by default in any
6027 current binary version of Samba.
6029 This is the file containing the server's certificate.
6030 The server \fBmust\fR have a certificate. The
6031 file may also contain the server's private key. See later for
6032 how certificates and private keys are created.
6034 Default: \fBssl server cert = <empty string>
6036 \fBssl server key (G)\fR
6037 This variable is part of SSL-enabled Samba. This
6038 is only available if the SSL libraries have been compiled on your
6039 system and the configure option \fB--with-ssl\fR was
6040 given at configure time.
6042 \fBNote\fR that for export control reasons
6043 this code is \fBNOT\fR enabled by default in any
6044 current binary version of Samba.
6046 This file contains the private key of the server. If
6047 this variable is not defined, the key is looked up in the
6048 certificate file (it may be appended to the certificate).
6049 The server \fBmust\fR have a private key
6050 and the certificate \fBmust\fR
6051 match this private key.
6053 Default: \fBssl server key = <empty string>
6055 \fBssl version (G)\fR
6056 This variable is part of SSL-enabled Samba. This
6057 is only available if the SSL libraries have been compiled on your
6058 system and the configure option \fB--with-ssl\fR was
6059 given at configure time.
6061 \fBNote\fR that for export control reasons
6062 this code is \fBNOT\fR enabled by default in any
6063 current binary version of Samba.
6065 This enumeration variable defines the versions of the
6066 SSL protocol that will be used. ssl2or3 allows
6067 dynamic negotiation of SSL v2 or v3, ssl2 results
6068 in SSL v2, ssl3 results in SSL v3 and
6069 tls1 results in TLS v1. TLS (Transport Layer
6070 Security) is the new standard for SSL.
6072 Default: \fBssl version = "ssl2or3"\fR
6074 \fBstat cache (G)\fR
6075 This parameter determines if smbd(8)will use a cache in order to
6076 speed up case insensitive name mappings. You should never need
6077 to change this parameter.
6079 Default: \fBstat cache = yes\fR
6081 \fBstat cache size (G)\fR
6082 This parameter determines the number of
6083 entries in the \fIstat cache\fR. You should
6084 never need to change this parameter.
6086 Default: \fBstat cache size = 50\fR
6089 This enables or disables logging of connections
6090 to a status file that smbstatus(1)can read.
6092 With this disabled \fBsmbstatus\fR won't be able
6093 to tell you what connections are active. You should never need to
6094 change this parameter.
6096 Default: \fBstatus = yes\fR
6098 \fBstrict locking (S)\fR
6099 This is a boolean that controls the handling of
6100 file locking in the server. When this is set to yes
6101 the server will check every read and write access for file locks, and
6102 deny access if locks exist. This can be slow on some systems.
6104 When strict locking is no the server does file
6105 lock checks only when the client explicitly asks for them.
6107 Well behaved clients always ask for lock checks when it
6108 is important, so in the vast majority of cases \fBstrict
6109 locking = no\fR is preferable.
6111 Default: \fBstrict locking = no\fR
6113 \fBstrict sync (S)\fR
6114 Many Windows applications (including the Windows
6115 98 explorer shell) seem to confuse flushing buffer contents to
6116 disk with doing a sync to disk. Under UNIX, a sync call forces
6117 the process to be suspended until the kernel has ensured that
6118 all outstanding data in kernel disk buffers has been safely stored
6119 onto stable storage. This is very slow and should only be done
6120 rarely. Setting this parameter to no (the
6121 default) means that smbd ignores the Windows applications requests for
6122 a sync call. There is only a possibility of losing data if the
6123 operating system itself that Samba is running on crashes, so there is
6124 little danger in this default setting. In addition, this fixes many
6125 performance problems that people have reported with the new Windows98
6126 explorer shell file copies.
6128 See also the \fIsync
6129 always>\fR parameter.
6131 Default: \fBstrict sync = no\fR
6134 This is a boolean that controls whether to
6135 strip trailing dots off UNIX filenames. This helps with some
6136 CDROMs that have filenames ending in a single dot.
6138 Default: \fBstrip dot = no\fR
6140 \fBsync always (S)\fR
6141 This is a boolean parameter that controls
6142 whether writes will always be written to stable storage before
6143 the write call returns. If this is false then the server will be
6144 guided by the client's request in each write call (clients can
6145 set a bit indicating that a particular write should be synchronous).
6146 If this is true then every write will be followed by a \fBfsync()
6147 \fRcall to ensure the data is written to disk. Note that
6148 the \fIstrict sync\fR parameter must be set to
6149 yes in order for this parameter to have
6152 See also the \fIstrict
6155 Default: \fBsync always = no\fR
6158 This parameter maps how Samba debug messages
6159 are logged onto the system syslog logging levels. Samba debug
6160 level zero maps onto syslog LOG_ERR, debug
6161 level one maps onto LOG_WARNING, debug level
6162 two maps onto LOG_NOTICE, debug level three
6163 maps onto LOG_INFO. All higher levels are mapped to LOG_DEBUG.
6165 This parameter sets the threshold for sending messages
6166 to syslog. Only messages with debug level less than this value
6167 will be sent to syslog.
6169 Default: \fBsyslog = 1\fR
6171 \fBsyslog only (G)\fR
6172 If this parameter is set then Samba debug
6173 messages are logged into the system syslog only, and not to
6174 the debug log files.
6176 Default: \fBsyslog only = no\fR
6178 \fBtemplate homedir (G)\fR
6179 \fBNOTE:\fR this parameter is
6180 only available in Samba 3.0.
6182 When filling out the user information for a Windows NT
6183 user, the winbindd(8)daemon
6184 uses this parameter to fill in the home directory for that user.
6185 If the string \fI%D\fR is present it is substituted
6186 with the user's Windows NT domain name. If the string \fI%U
6187 \fRis present it is substituted with the user's Windows
6190 Default: \fBtemplate homedir = /home/%D/%U\fR
6192 \fBtemplate shell (G)\fR
6193 \fBNOTE:\fR this parameter is
6194 only available in Samba 3.0.
6196 When filling out the user information for a Windows NT
6197 user, the winbindd(8)daemon
6198 uses this parameter to fill in the login shell for that user.
6200 Default: \fBtemplate shell = /bin/false\fR
6202 \fBtime offset (G)\fR
6203 This parameter is a setting in minutes to add
6204 to the normal GMT to local time conversion. This is useful if
6205 you are serving a lot of PCs that have incorrect daylight
6206 saving time handling.
6208 Default: \fBtime offset = 0\fR
6210 Example: \fBtime offset = 60\fR
6212 \fBtime server (G)\fR
6213 This parameter determines if
6214 nmbd(8)advertises itself as a time server to Windows
6217 Default: \fBtime server = no\fR
6219 \fBtimestamp logs (G)\fR
6220 Synonym for \fI debug timestamp\fR.
6222 \fBtotal print jobs (G)\fR
6223 This parameter accepts an integer value which defines
6224 a limit on the maximum number of print jobs that will be accepted
6225 system wide at any given time. If a print job is submitted
6226 by a client which will exceed this number, then smbd will return an
6227 error indicating that no space is available on the server. The
6228 default value of 0 means that no such limit exists. This parameter
6229 can be used to prevent a server from exceeding its capacity and is
6230 designed as a printing throttle. See also
6231 \fImax print jobs\fR.
6233 Default: \fBtotal print jobs = 0\fR
6235 Example: \fBtotal print jobs = 5000\fR
6237 \fBunix password sync (G)\fR
6238 This boolean parameter controls whether Samba
6239 attempts to synchronize the UNIX password with the SMB password
6240 when the encrypted SMB password in the smbpasswd file is changed.
6241 If this is set to true the program specified in the \fIpasswd
6242 program\fRparameter is called \fBAS ROOT\fR -
6243 to allow the new UNIX password to be set without access to the
6244 old UNIX password (as the SMB password has change code has no
6245 access to the old password cleartext, only the new).
6248 program\fR, \fI passwd chat\fR.
6250 Default: \fBunix password sync = no\fR
6252 \fBunix realname (G)\fR
6253 This boolean parameter when set causes samba
6254 to supply the real name field from the unix password file to
6255 the client. This is useful for setting up mail clients and WWW
6256 browsers on systems used by more than one person.
6258 Default: \fBunix realname = yes\fR
6260 \fBupdate encrypted (G)\fR
6261 This boolean parameter allows a user logging
6262 on with a plaintext password to have their encrypted (hashed)
6263 password in the smbpasswd file to be updated automatically as
6264 they log on. This option allows a site to migrate from plaintext
6265 password authentication (users authenticate with plaintext
6266 password over the wire, and are checked against a UNIX account
6267 database) to encrypted password authentication (the SMB
6268 challenge/response authentication mechanism) without forcing
6269 all users to re-enter their passwords via smbpasswd at the time the
6270 change is made. This is a convenience option to allow the change over
6271 to encrypted passwords to be made over a longer period. Once all users
6272 have encrypted representations of their passwords in the smbpasswd
6273 file this parameter should be set to no.
6275 In order for this parameter to work correctly the \fIencrypt passwords\fR
6276 parameter must be set to no when
6277 this parameter is set to yes.
6279 Note that even when this parameter is set a user
6280 authenticating to \fBsmbd\fR must still enter a valid
6281 password in order to connect correctly, and to update their hashed
6282 (smbpasswd) passwords.
6284 Default: \fBupdate encrypted = no\fR
6286 \fBuse rhosts (G)\fR
6287 If this global parameter is a true, it specifies
6288 that the UNIX users \fI.rhosts\fR file in their home directory
6289 will be read to find the names of hosts and users who will be allowed
6290 access without specifying a password.
6292 \fBNOTE:\fR The use of \fIuse rhosts
6293 \fRcan be a major security hole. This is because you are
6294 trusting the PC to supply the correct username. It is very easy to
6295 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
6298 Default: \fBuse rhosts = no\fR
6301 Synonym for \fI username\fR.
6304 Synonym for \fI username\fR.
6307 Multiple users may be specified in a comma-delimited
6308 list, in which case the supplied password will be tested against
6309 each username in turn (left to right).
6311 The \fIusername\fR line is needed only when
6312 the PC is unable to supply its own username. This is the case
6313 for the COREPLUS protocol or where your users have different WfWg
6314 usernames to UNIX usernames. In both these cases you may also be
6315 better using the \\\\server\\share%user syntax instead.
6317 The \fIusername\fR line is not a great
6318 solution in many cases as it means Samba will try to validate
6319 the supplied password against each of the usernames in the
6320 \fIusername\fR line in turn. This is slow and
6321 a bad idea for lots of users in case of duplicate passwords.
6322 You may get timeouts or security breaches using this parameter
6325 Samba relies on the underlying UNIX security. This
6326 parameter does not restrict who can login, it just offers hints
6327 to the Samba server as to what usernames might correspond to the
6328 supplied password. Users can login as whoever they please and
6329 they will be able to do no more damage than if they started a
6330 telnet session. The daemon runs as the user that they log in as,
6331 so they cannot do anything that user cannot do.
6333 To restrict a service to a particular set of users you
6334 can use the \fIvalid users
6337 If any of the usernames begin with a '@' then the name
6338 will be looked up first in the yp netgroups list (if Samba
6339 is compiled with netgroup support), followed by a lookup in
6340 the UNIX groups database and will expand to a list of all users
6341 in the group of that name.
6343 If any of the usernames begin with a '+' then the name
6344 will be looked up only in the UNIX groups database and will
6345 expand to a list of all users in the group of that name.
6347 If any of the usernames begin with a '&'then the name
6348 will be looked up only in the yp netgroups database (if Samba
6349 is compiled with netgroup support) and will expand to a list
6350 of all users in the netgroup group of that name.
6352 Note that searching though a groups database can take
6353 quite some time, and some clients may time out during the
6356 See the section NOTE ABOUT
6357 USERNAME/PASSWORD VALIDATION for more information on how
6358 this parameter determines access to the services.
6360 Default: \fBThe guest account if a guest service,
6361 else <empty string>.\fR
6363 Examples:\fBusername = fred, mary, jack, jane,
6366 \fBusername level (G)\fR
6367 This option helps Samba to try and 'guess' at
6368 the real UNIX username, as many DOS clients send an all-uppercase
6369 username. By default Samba tries all lowercase, followed by the
6370 username with the first letter capitalized, and fails if the
6371 username is not found on the UNIX machine.
6373 If this parameter is set to non-zero the behavior changes.
6374 This parameter is a number that specifies the number of uppercase
6375 combinations to try while trying to determine the UNIX user name. The
6376 higher the number the more combinations will be tried, but the slower
6377 the discovery of usernames will be. Use this parameter when you have
6378 strange usernames on your UNIX machine, such as AstrangeUser
6381 Default: \fBusername level = 0\fR
6383 Example: \fBusername level = 5\fR
6385 \fBusername map (G)\fR
6386 This option allows you to specify a file containing
6387 a mapping of usernames from the clients to the server. This can be
6388 used for several purposes. The most common is to map usernames
6389 that users use on DOS or Windows machines to those that the UNIX
6390 box uses. The other is to map multiple users to a single username
6391 so that they can more easily share files.
6393 The map file is parsed line by line. Each line should
6394 contain a single UNIX username on the left then a '=' followed
6395 by a list of usernames on the right. The list of usernames on the
6396 right may contain names of the form @group in which case they
6397 will match any UNIX username in that group. The special client
6398 name '*' is a wildcard and matches any name. Each line of the
6399 map file may be up to 1023 characters long.
6401 The file is processed on each line by taking the
6402 supplied username and comparing it with each username on the right
6403 hand side of the '=' signs. If the supplied name matches any of
6404 the names on the right hand side then it is replaced with the name
6405 on the left. Processing then continues with the next line.
6407 If any line begins with a '#' or a ';' then it is
6410 If any line begins with an '!' then the processing
6411 will stop after that line if a mapping was done by the line.
6412 Otherwise mapping continues with every line being processed.
6413 Using '!' is most useful when you have a wildcard mapping line
6416 For example to map from the name admin
6417 or administrator to the UNIX name root you would use:
6419 \fBroot = admin administrator\fR
6421 Or to map anyone in the UNIX group system
6422 to the UNIX name sys you would use:
6426 You can have as many mappings as you like in a username
6429 If your system supports the NIS NETGROUP option then
6430 the netgroup database is checked before the \fI/etc/group
6431 \fRdatabase for matching groups.
6433 You can map Windows usernames that have spaces in them
6434 by using double quotes around the name. For example:
6436 \fBtridge = "Andrew Tridgell"\fR
6438 would map the windows username "Andrew Tridgell" to the
6439 unix username "tridge".
6441 The following example would map mary and fred to the
6442 unix user sys, and map the rest to guest. Note the use of the
6443 \&'!' to tell Samba to stop processing if it gets a match on
6454 Note that the remapping is applied to all occurrences
6455 of usernames. Thus if you connect to \\\\server\\fred and fred is remapped to mary then you
6456 will actually be connecting to \\\\server\\mary and will need to
6457 supply a password suitable for mary not
6458 fred. The only exception to this is the
6459 username passed to the \fI password server\fR (if you have one). The password
6460 server will receive whatever username the client supplies without
6463 Also note that no reverse mapping is done. The main effect
6464 this has is with printing. Users who have been mapped may have
6465 trouble deleting print jobs as PrintManager under WfWg will think
6466 they don't own the print job.
6468 Default: \fBno username map\fR
6470 Example: \fBusername map = /usr/local/samba/lib/users.map
6473 This boolean parameter is only available if
6474 Samba has been configured and compiled with the option \fB --with-utmp\fR. If set to True then Samba will attempt
6475 to add utmp or utmpx records (depending on the UNIX system) whenever a
6476 connection is made to a Samba server. Sites may use this to record the
6477 user connecting to a Samba share.
6479 See also the \fI utmp directory\fR parameter.
6481 Default: \fButmp = no\fR
6483 \fButmp directory(G)\fR
6484 This parameter is only available if Samba has
6485 been configured and compiled with the option \fB --with-utmp\fR. It specifies a directory pathname that is
6486 used to store the utmp or utmpx files (depending on the UNIX system) that
6487 record user connections to a Samba server. See also the \fIutmp\fR parameter. By default this is
6488 not set, meaning the system will use whatever utmp file the
6489 native system is set to use (usually
6490 \fI/var/run/utmp\fR on Linux).
6492 Default: \fBno utmp directory\fR
6494 \fBvalid chars (G)\fR
6495 The option allows you to specify additional
6496 characters that should be considered valid by the server in
6497 filenames. This is particularly useful for national character
6498 sets, such as adding u-umlaut or a-ring.
6500 The option takes a list of characters in either integer
6501 or character form with spaces between them. If you give two
6502 characters with a colon between them then it will be taken as
6503 an lowercase:uppercase pair.
6505 If you have an editor capable of entering the characters
6506 into the config file then it is probably easiest to use this
6507 method. Otherwise you can specify the characters in octal,
6508 decimal or hexadecimal form using the usual C notation.
6510 For example to add the single character 'Z' to the charset
6511 (which is a pointless thing to do as it's already there) you could
6512 do one of the following
6518 valid chars = 0132:0172
6523 The last two examples above actually add two characters,
6524 and alter the uppercase and lowercase mappings appropriately.
6526 Note that you \fBMUST\fR specify this parameter
6527 after the \fIclient code page\fR parameter if you
6528 have both set. If \fIclient code page\fR is set after
6529 the \fIvalid chars\fR parameter the \fIvalid
6530 chars\fR settings will be overwritten.
6532 See also the \fIclient
6533 code page\fR parameter.
6535 Default: \fBSamba defaults to using a reasonable set
6536 of valid characters for English systems\fR
6538 Example: \fBvalid chars = 0345:0305 0366:0326 0344:0304
6540 The above example allows filenames to have the Swedish
6543 \fBNOTE:\fR It is actually quite difficult to
6544 correctly produce a \fIvalid chars\fR line for
6545 a particular system. To automate the process tino@augsburg.net <URL:mailto:tino@augsburg.net> has written
6546 a package called \fBvalidchars\fR which will automatically
6547 produce a complete \fIvalid chars\fR line for
6548 a given client system. Look in the \fIexamples/validchars/
6549 \fRsubdirectory of your Samba source code distribution
6552 \fBvalid users (S)\fR
6553 This is a list of users that should be allowed
6554 to login to this service. Names starting with '@', '+' and '&'
6555 are interpreted using the same rules as described in the
6556 \fIinvalid users\fR parameter.
6558 If this is empty (the default) then any user can login.
6559 If a username is in both this list and the \fIinvalid
6560 users\fR list then access is denied for that user.
6562 The current servicename is substituted for \fI%S
6563 \fR\&. This is useful in the [homes] section.
6565 See also \fIinvalid users
6567 Default: \fBNo valid users list (anyone can login)
6569 Example: \fBvalid users = greg, @pcusers\fR
6572 This is a list of files and directories that
6573 are neither visible nor accessible. Each entry in the list must
6574 be separated by a '/', which allows spaces to be included
6575 in the entry. '*' and '?' can be used to specify multiple files
6576 or directories as in DOS wildcards.
6578 Each entry must be a unix path, not a DOS path and
6579 must \fBnot\fR include the unix directory
6582 Note that the \fIcase sensitive\fR option
6583 is applicable in vetoing files.
6585 One feature of the veto files parameter that it is important
6586 to be aware of, is that if a directory contains nothing but files
6587 that match the veto files parameter (which means that Windows/DOS
6588 clients cannot ever see them) is deleted, the veto files within
6589 that directory \fBare automatically deleted\fR along
6590 with it, if the user has UNIX permissions to do so.
6592 Setting this parameter will affect the performance
6593 of Samba, as it will be forced to check all files and directories
6594 for a match as they are scanned.
6596 See also \fIhide files
6597 \fRand \fI case sensitive\fR.
6599 Default: \fBNo files or directories are vetoed.
6604 ; Veto any files containing the word Security,
6605 ; any ending in .tmp, and any directory containing the
6607 veto files = /*Security*/*.tmp/*root*/
6609 ; Veto the Apple specific files that a NetAtalk server
6611 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
6616 \fBveto oplock files (S)\fR
6617 This parameter is only valid when the \fIoplocks\fR
6618 parameter is turned on for a share. It allows the Samba administrator
6619 to selectively turn off the granting of oplocks on selected files that
6620 match a wildcarded list, similar to the wildcarded list used in the
6624 Default: \fBNo files are vetoed for oplock
6627 You might want to do this on files that you know will
6628 be heavily contended for by clients. A good example of this
6629 is in the NetBench SMB benchmark program, which causes heavy
6630 client contention for files ending in \fI.SEM\fR.
6631 To cause Samba not to grant oplocks on these files you would use
6632 the line (either in the [global] section or in the section for
6633 the particular NetBench share :
6635 Example: \fBveto oplock files = /*;.SEM/
6637 \fBvfs object (S)\fR
6638 This parameter specifies a shared object file that
6639 is used for Samba VFS I/O operations. By default, normal
6640 disk I/O operations are used but these can be overloaded
6641 with a VFS object. The Samba VFS layer is new to Samba 2.2 and
6642 must be enabled at compile time with --with-vfs.
6644 Default : \fBno value\fR
6646 \fBvfs options (S)\fR
6647 This parameter allows parameters to be passed
6648 to the vfs layer at initialisation time. The Samba VFS layer
6649 is new to Samba 2.2 and must be enabled at compile time
6650 with --with-vfs. See also \fI vfs object\fR.
6652 Default : \fBno value\fR
6655 This allows you to override the volume label
6656 returned for a share. Useful for CDROMs with installation programs
6657 that insist on a particular volume label.
6659 Default: \fBthe name of the share\fR
6661 \fBwide links (S)\fR
6662 This parameter controls whether or not links
6663 in the UNIX file system may be followed by the server. Links
6664 that point to areas within the directory tree exported by the
6665 server are always allowed; this parameter controls access only
6666 to areas that are outside the directory tree being exported.
6668 Note that setting this parameter can have a negative
6669 effect on your server performance due to the extra system calls
6670 that Samba has to do in order to perform the link checks.
6672 Default: \fBwide links = yes\fR
6674 \fBwinbind cache time\fR
6675 \fBNOTE:\fR this parameter is only
6676 available in Samba 3.0.
6678 This parameter specifies the number of seconds the
6679 winbindd(8)daemon will cache
6680 user and group information before querying a Windows NT server
6683 Default: \fBwinbind cache type = 15\fR
6686 \fBNOTE:\fR this parameter is only
6687 available in Samba 3.0.
6689 The winbind gid parameter specifies the range of group
6690 ids that are allocated by the winbindd(8)daemon. This range of group ids should have no
6691 existing local or nis groups within it as strange conflicts can
6694 Default: \fBwinbind gid = <empty string>
6696 Example: \fBwinbind gid = 10000-20000\fR
6698 \fBwinbind separator\fR
6699 \fBNOTE:\fR this parameter is only
6700 available in Samba 3.0.
6702 This parameter allows an admin to define the character
6703 used when listing a username of the form of \fIDOMAIN
6704 \fR\\\fIuser\fR. This parameter
6705 is only applicable when using the \fIpam_winbind.so\fR
6706 and \fInss_winbind.so\fR modules for UNIX services.
6708 Example: \fBwinbind separator = \\\fR
6710 Example: \fBwinbind separator = +\fR
6713 \fBNOTE:\fR this parameter is only
6714 available in Samba 3.0.
6716 The winbind gid parameter specifies the range of group
6717 ids that are allocated by the winbindd(8)daemon. This range of ids should have no
6718 existing local or nis users within it as strange conflicts can
6721 Default: \fBwinbind uid = <empty string>
6723 Example: \fBwinbind uid = 10000-20000\fR
6726 When Samba is running as a WINS server this
6727 allows you to call an external program for all changes to the
6728 WINS database. The primary use for this option is to allow the
6729 dynamic update of external name resolution databases such as
6732 The wins hook parameter specifies the name of a script
6733 or executable that will be called as follows:
6735 \fBwins_hook operation name nametype ttl IP_list
6739 The first argument is the operation and is one
6740 of "add", "delete", or "refresh". In most cases the operation can
6741 be ignored as the rest of the parameters provide sufficient
6742 information. Note that "refresh" may sometimes be called when the
6743 name has not previously been added, in that case it should be treated
6747 The second argument is the netbios name. If the
6748 name is not a legal name then the wins hook is not called.
6749 Legal names contain only letters, digits, hyphens, underscores
6753 The third argument is the netbios name
6754 type as a 2 digit hexadecimal number.
6757 The fourth argument is the TTL (time to live)
6758 for the name in seconds.
6761 The fifth and subsequent arguments are the IP
6762 addresses currently registered for that name. If this list is
6763 empty then the name should be deleted.
6766 An example script that calls the BIND dynamic DNS update
6767 program \fBnsupdate\fR is provided in the examples
6768 directory of the Samba source code.
6771 \fBwins proxy (G)\fR
6772 This is a boolean that controls if nmbd(8)will respond to broadcast name
6773 queries on behalf of other hosts. You may need to set this
6774 to yes for some older clients.
6776 Default: \fBwins proxy = no\fR
6778 \fBwins server (G)\fR
6779 This specifies the IP address (or DNS name: IP
6780 address for preference) of the WINS server that nmbd(8)should register with. If you have a WINS server on
6781 your network then you should set this to the WINS server's IP.
6783 You should point this at your WINS server if you have a
6784 multi-subnetted network.
6786 \fBNOTE\fR. You need to set up Samba to point
6787 to a WINS server if you have multiple subnets and wish cross-subnet
6788 browsing to work correctly.
6790 See the documentation file \fIBROWSING.txt\fR
6791 in the docs/ directory of your Samba source distribution.
6793 Default: \fBnot enabled\fR
6795 Example: \fBwins server = 192.9.200.1\fR
6797 \fBwins support (G)\fR
6798 This boolean controls if the
6799 nmbd(8)process in Samba will act as a WINS server. You should
6800 not set this to true unless you have a multi-subnetted network and
6801 you wish a particular \fBnmbd\fR to be your WINS server.
6802 Note that you should \fBNEVER\fR set this to true
6803 on more than one machine in your network.
6805 Default: \fBwins support = no\fR
6808 This controls what workgroup your server will
6809 appear to be in when queried by clients. Note that this parameter
6810 also controls the Domain name used with the \fBsecurity=domain\fR
6813 Default: \fBset at compile time to WORKGROUP\fR
6815 Example: \fBworkgroup = MYGROUP\fR
6818 Synonym for \fI writeable\fR for people who can't spell :-).
6820 \fBwrite cache size (S)\fR
6821 If this integer parameter is set to non-zero value,
6822 Samba will create an in-memory cache for each oplocked file
6823 (it does \fBnot\fR do this for
6824 non-oplocked files). All writes that the client does not request
6825 to be flushed directly to disk will be stored in this cache if possible.
6826 The cache is flushed onto disk when a write comes in whose offset
6827 would not fit into the cache or when the file is closed by the client.
6828 Reads for the file are also served from this cache if the data is stored
6831 This cache allows Samba to batch client writes into a more
6832 efficient write size for RAID disks (ie. writes may be tuned to
6833 be the RAID stripe size) and can improve performance on systems
6834 where the disk subsystem is a bottleneck but there is free
6835 memory for userspace programs.
6837 The integer parameter specifies the size of this cache
6838 (per oplocked file) in bytes.
6840 Default: \fBwrite cache size = 0\fR
6842 Example: \fBwrite cache size = 262144\fR
6844 for a 256k cache size per file.
6846 \fBwrite list (S)\fR
6847 This is a list of users that are given read-write
6848 access to a service. If the connecting user is in this list then
6849 they will be given write access, no matter what the \fIwriteable\fR
6850 option is set to. The list can include group names using the
6853 Note that if a user is in both the read list and the
6854 write list then they will be given write access.
6856 See also the \fIread list
6859 Default: \fBwrite list = <empty string>
6861 Example: \fBwrite list = admin, root, @staff
6864 Synonym for \fI writeable\fR.
6867 This parameter controls whether or not the server
6868 will support raw writes SMB's when transferring data from clients.
6869 You should never need to change this parameter.
6871 Default: \fBwrite raw = yes\fR
6874 An inverted synonym is \fIread only\fR.
6876 If this parameter is no, then users
6877 of a service may not create or modify files in the service's
6880 Note that a printable service (\fBprintable = yes\fR)
6881 will \fBALWAYS\fR allow writing to the directory
6882 (user privileges permitting), but only via spooling operations.
6884 Default: \fBwriteable = no\fR
6887 Although the configuration file permits service names
6888 to contain spaces, your client software may not. Spaces will
6889 be ignored in comparisons anyway, so it shouldn't be a
6890 problem - but be aware of the possibility.
6892 On a similar note, many clients - especially DOS clients -
6893 limit service names to eight characters. smbd(8)
6894 has no such limitation, but attempts to connect from such
6895 clients will fail if they truncate the service names. For this reason
6896 you should probably keep your service names down to eight characters
6899 Use of the [homes] and [printers] special sections make life
6900 for an administrator easy, but the various combinations of default
6901 attributes can be tricky. Take extreme care when designing these
6902 sections. In particular, ensure that the permissions on spool
6903 directories are correct.
6906 This man page is correct for version 2.2 of
6918 \fBtestprns(1)\fR.SH "AUTHOR"
6920 The original Samba software and related utilities
6921 were created by Andrew Tridgell. Samba is now developed
6922 by the Samba Team as an Open Source project similar
6923 to the way the Linux kernel is developed.
6925 The original Samba man pages were written by Karl Auer.
6926 The man page sources were converted to YODL format (another
6927 excellent piece of Open Source software, available at
6928 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0
6929 release by Jeremy Allison. The conversion to DocBook for
6930 Samba 2.2 was done by Gerald Carter