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" "24 April 2001" "" ""
8 smb.conf \- The configuration file for the Samba suite
11 The \fIsmb.conf\fR file is a configuration
12 file for the Samba suite. \fIsmb.conf\fR contains
13 runtime configuration information for the Samba programs. The
14 \fIsmb.conf\fR file is designed to be configured and
15 administered by the \fBswat(8)\fR
16 program. The complete description of the file format and
17 possible parameters held within are here for reference purposes.
20 The file consists of sections and parameters. A section
21 begins with the name of the section in square brackets and continues
22 until the next section begins. Sections contain parameters of the
27 The file is line-based - that is, each newline-terminated
28 line represents either a comment, a section name or a parameter.
30 Section and parameter names are not case sensitive.
32 Only the first equals sign in a parameter is significant.
33 Whitespace before or after the first equals sign is discarded.
34 Leading, trailing and internal whitespace in section and parameter
35 names is irrelevant. Leading and trailing whitespace in a parameter
36 value is discarded. Internal whitespace within a parameter value
39 Any line beginning with a semicolon (';') or a hash ('#')
40 character is ignored, as are lines containing only whitespace.
42 Any line ending in a '\\' is continued
43 on the next line in the customary UNIX fashion.
45 The values following the equals sign in parameters are all
46 either a string (no quotes needed) or a boolean, which may be given
47 as yes/no, 0/1 or true/false. Case is not significant in boolean
48 values, but is preserved in string values. Some items such as
49 create modes are numeric.
50 .SH "SECTION DESCRIPTIONS"
52 Each section in the configuration file (except for the
53 [global] section) describes a shared resource (known
54 as a "share"). The section name is the name of the
55 shared resource and the parameters within the section define
56 the shares attributes.
58 There are three special sections, [global],
59 [homes] and [printers], which are
60 described under \fBspecial sections\fR. The
61 following notes apply to ordinary section descriptions.
63 A share consists of a directory to which access is being
64 given plus a description of the access rights which are granted
65 to the user of the service. Some housekeeping options are
68 Sections are either file share services (used by the
69 client as an extension of their native file systems) or
70 printable services (used by the client to access print services
71 on the host running the server).
73 Sections may be designated \fBguest\fR services,
74 in which case no password is required to access them. A specified
75 UNIX \fBguest account\fR is used to define access
76 privileges in this case.
78 Sections other than guest services will require a password
79 to access them. The client provides the username. As older clients
80 only provide passwords and not usernames, you may specify a list
81 of usernames to check against the password using the "user="
82 option in the share definition. For modern clients such as
83 Windows 95/98/ME/NT/2000, this should not be necessary.
85 Note that the access rights granted by the server are
86 masked by the access rights granted to the specified or guest
87 UNIX user by the host system. The server does not grant more
88 access than the host system grants.
90 The following sample section defines a file space share.
91 The user has write access to the path \fI/home/bar\fR.
92 The share is accessed via the share name "foo":
103 The following sample section defines a printable share.
104 The share is readonly, but printable. That is, the only write
105 access permitted is via calls to open, write to and close a
106 spool file. The \fBguest ok\fR parameter means
107 access will be permitted as the default guest user (specified
112 path = /usr/spool/public
120 .SH "SPECIAL SECTIONS"
121 .SS "THE GLOBAL SECTION"
123 parameters in this section apply to the server
124 as a whole, or are defaults for sections which do not
125 specifically define certain items. See the notes
126 under PARAMETERS for more information.
127 .SS "THE HOMES SECTION"
129 If a section called homes is included in the
130 configuration file, services connecting clients to their
131 home directories can be created on the fly by the server.
133 When the connection request is made, the existing
134 sections are scanned. If a match is found, it is used. If no
135 match is found, the requested section name is treated as a
136 user name and looked up in the local password file. If the
137 name exists and the correct password has been given, a share is
138 created by cloning the [homes] section.
140 Some modifications are then made to the newly
144 The share name is changed from homes to
145 the located username.
148 If no path was given, the path is set to
149 the user's home directory.
151 If you decide to use a \fBpath=\fR line
152 in your [homes] section then you may find it useful
153 to use the %S macro. For example :
156 \fBpath=/data/pchome/%S\fR
159 would be useful if you have different home directories
160 for your PCs than for UNIX access.
163 This is a fast and simple way to give a large number
164 of clients access to their home directories with a minimum
168 A similar process occurs if the requested section
169 name is "homes", except that the share name is not
170 changed to that of the requesting user. This method of using
171 the [homes] section works well if different users share
175 The [homes] section can specify all the parameters
176 a normal service section can specify, though some make more sense
177 than others. The following is a typical and suitable [homes]
189 An important point is that if guest access is specified
190 in the [homes] section, all home directories will be
191 visible to all clients \fBwithout a password\fR.
192 In the very unlikely event that this is actually desirable, it
193 would be wise to also specify \fBread only
197 Note that the \fBbrowseable\fR flag for
198 auto home directories will be inherited from the global browseable
199 flag, not the [homes] browseable flag. This is useful as
200 it means setting browseable=no in the [homes] section
201 will hide the [homes] share but make any auto home
204 .SS "THE PRINTERS SECTION"
206 This section works like [homes],
209 If a [printers] section occurs in the
210 configuration file, users are able to connect to any printer
211 specified in the local host's printcap file.
213 When a connection request is made, the existing sections
214 are scanned. If a match is found, it is used. If no match is found,
215 but a [homes] section exists, it is used as described
216 above. Otherwise, the requested section name is treated as a
217 printer name and the appropriate printcap file is scanned to see
218 if the requested section name is a valid printer share name. If
219 a match is found, a new printer share is created by cloning
220 the [printers] section.
222 A few modifications are then made to the newly created
226 The share name is set to the located printer
230 If no printer name was given, the printer name
231 is set to the located printer name
234 If the share does not permit guest access and
235 no username was given, the username is set to the located
238 Note that the [printers] service MUST be
239 printable - if you specify otherwise, the server will refuse
240 to load the configuration file.
243 Typically the path specified would be that of a
244 world-writeable spool directory with the sticky bit set on
245 it. A typical [printers] entry would look like
251 path = /usr/spool/public
258 All aliases given for a printer in the printcap file
259 are legitimate printer names as far as the server is concerned.
260 If your printing subsystem doesn't work like that, you will have
261 to set up a pseudo-printcap. This is a file consisting of one or
262 more lines like this:
266 alias|alias|alias|alias...
272 Each alias should be an acceptable printer name for
273 your printing subsystem. In the [global] section, specify
274 the new file as your printcap. The server will then only recognize
275 names found in your pseudo-printcap, which of course can contain
276 whatever aliases you like. The same technique could be used
277 simply to limit access to a subset of your local printers.
280 An alias, by the way, is defined as any component of the
281 first entry of a printcap record. Records are separated by newlines,
282 components (if there are more than one) are separated by vertical
286 NOTE: On SYSV systems which use lpstat to determine what
287 printers are defined on the system you may be able to use
288 "printcap name = lpstat" to automatically obtain a list
289 of printers. See the "printcap name" option
294 parameters define the specific attributes of sections.
296 Some parameters are specific to the [global] section
297 (e.g., \fBsecurity\fR). Some parameters are usable
298 in all sections (e.g., \fBcreate mode\fR). All others
299 are permissible only in normal sections. For the purposes of the
300 following descriptions the [homes] and [printers]
301 sections will be considered normal. The letter \fBG\fR
302 in parentheses indicates that a parameter is specific to the
303 [global] section. The letter \fBS\fR
304 indicates that a parameter can be specified in a service specific
305 section. Note that all \fBS\fR parameters can also be specified in
306 the [global] section - in which case they will define
307 the default behavior for all services.
309 parameters are arranged here in alphabetical order - this may
310 not create best bedfellows, but at least you can find them! Where
311 there are synonyms, the preferred synonym is described, others refer
312 to the preferred synonym.
313 .SH "VARIABLE SUBSTITUTIONS"
315 Many of the strings that are settable in the config file
316 can take substitutions. For example the option "path =
317 /tmp/%u" would be interpreted as "path =
318 /tmp/john" if the user connected with the username john.
320 These substitutions are mostly noted in the descriptions below,
321 but there are some general substitutions which apply whenever they
322 might be relevant. These are:
325 the name of the current service, if any.
328 the root directory of the current service,
332 user name of the current service, if any.
335 primary group name of %u.
338 session user name (the user name that the client
339 wanted, not necessarily the same as the one they got).
342 primary group name of %U.
345 the home directory of the user given
352 the Internet hostname that Samba is running
356 the NetBIOS name of the client machine
360 the NetBIOS name of the server. This allows you
361 to change your config based on what the client calls you. Your
362 server can have a "dual personality".
365 the Internet name of the client machine.
368 the name of your NIS home directory server.
369 This is obtained from your NIS auto.map entry. If you have
370 not compiled Samba with the \fB--with-automount\fR
371 option then this value will be the same as %.
374 the path of the service's home directory,
375 obtained from your NIS auto.map entry. The NIS auto.map entry
376 is split up as "%N:%p".
379 the selected protocol level after
380 protocol negotiation. It can be one of CORE, COREPLUS,
381 LANMAN1, LANMAN2 or NT1.
384 The process id of the current server
388 the architecture of the remote
389 machine. Only some are recognized, and those may not be
390 100% reliable. It currently recognizes Samba, WfWg,
391 WinNT and Win95. Anything else will be known as
392 "UNKNOWN". If it gets it wrong then sending a level
393 3 log to samba@samba.org
394 <URL:mailto:samba@samba.org> should allow it to be fixed.
397 The IP address of the client machine.
400 the current date and time.
402 \fB%$(\fIenvvar\fB)\fR
403 The value of the environment variable
406 There are some quite creative things that can be done
407 with these substitutions and other smb.conf options.
411 Samba supports "name mangling" so that DOS and
412 Windows clients can use files that don't conform to the 8.3 format.
413 It can also be set to adjust the case of 8.3 format filenames.
415 There are several options that control the way mangling is
416 performed, and they are grouped here rather than listed separately.
417 For the defaults look at the output of the testparm program.
419 All of these options can be set separately for each service
420 (or globally, of course).
424 \fBmangle case= yes/no\fR
425 controls if names that have characters that
426 aren't of the "default" case are mangled. For example,
427 if this is yes then a name like "Mail" would be mangled.
430 \fBcase sensitive = yes/no\fR
431 controls whether filenames are case sensitive. If
432 they aren't then Samba must do a filename search and match on passed
433 names. Default \fBno\fR.
435 \fBdefault case = upper/lower\fR
436 controls what the default case is for new
437 filenames. Default \fBlower\fR.
439 \fBpreserve case = yes/no\fR
440 controls if new files are created with the
441 case that the client passes, or if they are forced to be the
442 "default" case. Default \fByes\fR.
444 \fBshort preserve case = yes/no\fR
445 controls if new files which conform to 8.3 syntax,
446 that is all in upper case and of suitable length, are created
447 upper case, or if they are forced to be the "default"
448 case. This option can be use with "preserve case = yes"
449 to permit long filenames to retain their case, while short names
450 are lowered. Default \fByes\fR.
452 By default, Samba 2.2 has the same semantics as a Windows
453 NT server, in that it is case insensitive but case preserving.
455 .SH "NOTE ABOUT USERNAME/PASSWORD VALIDATION"
457 There are a number of ways in which a user can connect
458 to a service. The server uses the following steps in determining
459 if it will allow a connection to a specified service. If all the
460 steps fail, then the connection request is rejected. However, if one of the
461 steps succeeds, then the following steps are not checked.
463 If the service is marked "guest only = yes" then
464 steps 1 to 5 are skipped.
466 If the client has passed a username/password
467 pair and that username/password pair is validated by the UNIX
468 system's password programs then the connection is made as that
469 username. Note that this includes the
470 \\\\server\\service%\fIusername\fR method of passing
473 If the client has previously registered a username
474 with the system and now supplies a correct password for that
475 username then the connection is allowed.
477 The client's netbios name and any previously
478 used user names are checked against the supplied password, if
479 they match then the connection is allowed as the corresponding
482 If the client has previously validated a
483 username/password pair with the server and the client has passed
484 the validation token then that username is used.
486 If a "user = " field is given in the
487 \fIsmb.conf\fR file for the service and the client
488 has supplied a password, and that password matches (according to
489 the UNIX system's password checking) with one of the usernames
490 from the "user=" field then the connection is made as
491 the username in the "user=" line. If one
492 of the username in the "user=" list begins with a
493 \&'@' then that name expands to a list of names in
494 the group of the same name.
496 If the service is a guest service then a
497 connection is made as the username given in the "guest
498 account =" for the service, irrespective of the
500 .SH "COMPLETE LIST OF GLOBAL PARAMETERS"
502 Here is a list of all global parameters. See the section of
503 each parameter for details. Note that some are synonyms.
506 \fIadd 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
932 \fIupdate encrypted\fR
950 \fIwinbind cache time\fR
956 \fIwinbind separator\fR
978 .SH "COMPLETE LIST OF SERVICE PARAMETERS"
980 Here is a list of all service parameters. See the section on
981 each parameter for details. Note that some are synonyms.
1002 \fIcase sensitive\fR
1023 \fIdelete readonly\fR
1026 \fIdelete veto files\fR
1035 \fIdirectory mask\fR
1038 \fIdirectory mode\fR
1041 \fIdirectory security mask\fR
1050 \fIdos filetime resolution\fR
1059 \fIfake directory create times\fR
1065 \fIfollow symlinks\fR
1068 \fIforce create mode\fR
1071 \fIforce directory mode\fR
1074 \fIforce directory security mode\fR
1080 \fIforce security mode\fR
1101 \fIhide dot files\fR
1116 \fIinherit permissions\fR
1122 \fIlevel2 oplocks\fR
1128 \fIlppause command\fR
1134 \fIlpresume command\fR
1167 \fImax connections\fR
1170 \fImax print jobs\fR
1173 \fImin print space\fR
1185 \fIoplock contention limit\fR
1227 \fIprinter driver\fR
1230 \fIprinter driver location\fR
1242 \fIqueuepause command\fR
1245 \fIqueueresume command\fR
1260 \fIroot preexec close\fR
1272 \fIshort preserve case\fR
1278 \fIstrict locking\fR
1305 \fIveto oplock files\fR
1323 \fIwrite cache size\fR
1333 .SH "EXPLANATION OF EACH PARAMETER"
1335 \fBadd user script (G)\fR
1336 This is the full pathname to a script that will
1337 be run \fBAS ROOT\fR by smbd(8)
1338 under special circumstances described below.
1340 Normally, a Samba server requires that UNIX users are
1341 created for all users accessing files on this server. For sites
1342 that use Windows NT account databases as their primary user database
1343 creating these users and keeping the user list in sync with the
1344 Windows NT PDC is an onerous task. This option allows smbdto create the required UNIX users
1345 \fBON DEMAND\fR when a user accesses the Samba server.
1347 In order to use this option, smbdmust be set to \fIsecurity=server\fR or \fI security=domain\fR and \fIadd user script\fR
1348 must be set to a full pathname for a script that will create a UNIX
1349 user given one argument of \fI%u\fR, which expands into
1350 the UNIX user name to create.
1352 When the Windows user attempts to access the Samba server,
1353 at login (session setup in the SMB protocol) time, smbdcontacts the \fIpassword server\fR and
1354 attempts to authenticate the given user with the given password. If the
1355 authentication succeeds then \fBsmbd\fR
1356 attempts to find a UNIX user in the UNIX password database to map the
1357 Windows user into. If this lookup fails, and \fIadd user script
1358 \fRis set then \fBsmbd\fR will
1359 call the specified script \fBAS ROOT\fR, expanding
1360 any \fI%u\fR argument to be the user name to create.
1362 If this script successfully creates the user then \fBsmbd
1363 \fRwill continue on as though the UNIX user
1364 already existed. In this way, UNIX users are dynamically created to
1365 match existing Windows NT accounts.
1367 See also \fI security\fR, \fIpassword server\fR,
1371 Default: \fBadd user script = <empty string>
1373 Example: \fBadd user script = /usr/local/samba/bin/add_user
1376 \fBaddprinter command (G)\fR
1377 With the introduction of MS-RPC based printing
1378 support for Windows NT/2000 clients in Samba 2.2, The MS Add
1379 Printer Wizard (APW) icon is now also available in the
1380 "Printers..." folder displayed a share listing. The APW
1381 allows for printers to be add remotely to a Samba or Windows
1382 NT/2000 print server.
1384 For a Samba host this means that the printer must be
1385 physically added to underlying printing system. The \fI addprinter command\fR defines a script to be run which
1386 will perform the necessary operations for adding the printer
1387 to the print system and to add the appropriate service definition
1388 to the \fIsmb.conf\fR file in order that it can be
1389 shared by \fBsmbd(8)\fR
1392 The \fIaddprinter command\fR is
1393 automatically invoked with the following parameter (in
1413 \fIWindows 9x driver location\fR
1416 All parameters are filled in from the PRINTER_INFO_2 structure sent
1417 by the Windows NT/2000 client with one exception. The "Windows 9x
1418 driver location" parameter is included for backwards compatibility
1419 only. The remaining fields in the structure are generated from answers
1420 to the APW questions.
1423 Once the \fIaddprinter command\fR has
1424 been executed, \fBsmbd\fR will reparse the \fI smb.conf\fR to determine if the share defined by the APW
1425 exists. If the sharename is still invalid, then \fBsmbd
1426 \fRwill return an ACCESS_DENIED error to the client.
1429 See also \fI deleteprinter command\fR, \fIprinting\fR,
1437 Example: \fBaddprinter command = /usr/bin/addprinter
1440 \fBadmin users (S)\fR
1441 This is a list of users who will be granted
1442 administrative privileges on the share. This means that they
1443 will do all file operations as the super-user (root).
1445 You should use this option very carefully, as any user in
1446 this list will be able to do anything they like on the share,
1447 irrespective of file permissions.
1449 Default: \fBno admin users\fR
1451 Example: \fBadmin users = jason\fR
1453 \fBallow hosts (S)\fR
1454 Synonym for \fIhosts allow\fR.
1456 \fBallow trusted domains (G)\fR
1457 This option only takes effect when the \fIsecurity\fR option is set to
1459 If it is set to no, then attempts to connect to a resource from
1460 a domain or workgroup other than the one which smbd is running
1461 in will fail, even if that domain is trusted by the remote server
1462 doing the authentication.
1464 This is useful if you only want your Samba server to
1465 serve resources to users in the domain it is a member of. As
1466 an example, suppose that there are two domains DOMA and DOMB. DOMB
1467 is trusted by DOMA, which contains the Samba server. Under normal
1468 circumstances, a user with an account in DOMB can then access the
1469 resources of a UNIX account with the same account name on the
1470 Samba server even if they do not have an account in DOMA. This
1471 can make implementing a security boundary difficult.
1473 Default: \fBallow trusted domains = yes\fR
1475 \fBannounce as (G)\fR
1476 This specifies what type of server
1477 \fBnmbd\fRwill announce itself as, to a network neighborhood browse
1478 list. By default this is set to Windows NT. The valid options
1479 are : "NT Server" (which can also be written as "NT"),
1480 "NT Workstation", "Win95" or "WfW" meaning Windows NT Server,
1481 Windows NT Workstation, Windows 95 and Windows for Workgroups
1482 respectively. Do not change this parameter unless you have a
1483 specific need to stop Samba appearing as an NT server as this
1484 may prevent Samba servers from participating as browser servers
1487 Default: \fBannounce as = NT Server\fR
1489 Example: \fBannounce as = Win95\fR
1491 \fBannouce version (G)\fR
1492 This specifies the major and minor version numbers
1493 that nmbd will use when announcing itself as a server. The default
1494 is 4.2. Do not change this parameter unless you have a specific
1495 need to set a Samba server to be a downlevel server.
1497 Default: \fBannounce version = 4.2\fR
1499 Example: \fBannounce version = 2.0\fR
1501 \fBauto services (G)\fR
1502 This is a synonym for the \fIpreload\fR.
1505 This parameter lets you "turn off" a service. If
1506 \fIavailable = no\fR, then \fBALL\fR
1507 attempts to connect to the service will fail. Such failures are
1510 Default: \fBavailable = yes\fR
1512 \fBbind interfaces only (G)\fR
1513 This global parameter allows the Samba admin
1514 to limit what interfaces on a machine will serve smb requests. If
1515 affects file service smbd(8)and
1516 name service nmbd(8)in slightly
1519 For name service it causes \fBnmbd\fR to bind
1520 to ports 137 and 138 on the interfaces listed in the interfaces parameter. \fBnmbd
1521 \fRalso binds to the "all addresses" interface (0.0.0.0)
1522 on ports 137 and 138 for the purposes of reading broadcast messages.
1523 If this option is not set then \fBnmbd\fR will service
1524 name requests on all of these sockets. If \fIbind interfaces
1525 only\fR is set then \fBnmbd\fR will check the
1526 source address of any packets coming in on the broadcast sockets
1527 and discard any that don't match the broadcast addresses of the
1528 interfaces in the \fIinterfaces\fR parameter list.
1529 As unicast packets are received on the other sockets it allows
1530 \fBnmbd\fR to refuse to serve names to machines that
1531 send packets that arrive through any interfaces not listed in the
1532 \fIinterfaces\fR list. IP Source address spoofing
1533 does defeat this simple check, however so it must not be used
1534 seriously as a security feature for \fBnmbd\fR.
1536 For file service it causes smbd(8)to bind only to the interface list given in the interfaces parameter. This restricts the networks that
1537 \fBsmbd\fR will serve to packets coming in those
1538 interfaces. Note that you should not use this parameter for machines
1539 that are serving PPP or other intermittent or non-broadcast network
1540 interfaces as it will not cope with non-permanent interfaces.
1542 If \fIbind interfaces only\fR is set then
1543 unless the network address \fB127.0.0.1\fR is added
1544 to the \fIinterfaces\fR parameter list \fBsmbpasswd(8)\fRand \fBswat(8)\fRmay
1545 not work as expected due to the reasons covered below.
1547 To change a users SMB password, the \fBsmbpasswd\fR
1548 by default connects to the \fBlocalhost - 127.0.0.1\fR
1549 address as an SMB client to issue the password change request. If
1550 \fIbind interfaces only\fR is set then unless the
1551 network address \fB127.0.0.1\fR is added to the
1552 \fIinterfaces\fR parameter list then \fB smbpasswd\fR will fail to connect in it's default mode.
1553 \fBsmbpasswd\fR can be forced to use the primary IP interface
1554 of the local host by using its \fI-r remote machine\fR
1555 parameter, with \fIremote machine\fR set
1556 to the IP name of the primary interface of the local host.
1558 The \fBswat\fR status page tries to connect with
1559 \fBsmbd\fR and \fBnmbd\fR at the address
1560 \fB127.0.0.1\fR to determine if they are running.
1561 Not adding \fB127.0.0.1\fR will cause \fB smbd\fR and \fBnmbd\fR to always show
1562 "not running" even if they really are. This can prevent \fB swat\fR from starting/stopping/restarting \fBsmbd\fR
1565 Default: \fBbind interfaces only = no\fR
1567 \fBblocking locks (S)\fR
1568 This parameter controls the behavior of smbd(8)when given a request by a client
1569 to obtain a byte range lock on a region of an open file, and the
1570 request has a time limit associated with it.
1572 If this parameter is set and the lock range requested
1573 cannot be immediately satisfied, Samba 2.2 will internally
1574 queue the lock request, and periodically attempt to obtain
1575 the lock until the timeout period expires.
1577 If this parameter is set to False, then
1578 Samba 2.2 will behave as previous versions of Samba would and
1579 will fail the lock request immediately if the lock range
1582 Default: \fBblocking locks = yes\fR
1585 See the \fI browseable\fR.
1587 \fBbrowse list (G)\fR
1588 This controls whether \fBsmbd(8)\fRwill serve a browse list to
1589 a client doing a \fBNetServerEnum\fR call. Normally
1590 set to true. You should never need to change
1593 Default: \fBbrowse list = yes\fR
1595 \fBbrowseable (S)\fR
1596 This controls whether this share is seen in
1597 the list of available shares in a net view and in the browse list.
1599 Default: \fBbrowseable = yes\fR
1601 \fBcase sensitive (S)\fR
1602 See the discussion in the section NAME MANGLING.
1604 Default: \fBcase sensitive = no\fR
1606 \fBcasesignames (S)\fR
1610 \fBchange notify timeout (G)\fR
1611 This SMB allows a client to tell a server to
1612 "watch" a particular directory for any changes and only reply to
1613 the SMB request when a change has occurred. Such constant scanning of
1614 a directory is expensive under UNIX, hence an \fBsmbd(8)\fRdaemon only performs such a scan
1615 on each requested directory once every \fIchange notify
1618 Default: \fBchange notify timeout = 60\fR
1620 Example: \fBchange notify timeout = 300\fR
1622 Would change the scan time to every 5 minutes.
1624 \fBcharacter set (G)\fR
1625 This allows a smbd to map incoming filenames
1626 from a DOS Code page (see the client
1627 code page parameter) to several built in UNIX character sets.
1628 The built in code page translations are:
1632 ISO8859-1 : Western European
1633 UNIX character set. The parameter \fIclient code page\fR
1634 \fBMUST\fR be set to code page 850 if the
1635 \fIcharacter set\fR parameter is set to
1636 ISO8859-1 in order for the conversion to the
1637 UNIX character set to be done correctly.
1640 ISO8859-2 : Eastern European
1641 UNIX character set. The parameter \fIclient code page
1642 \fR\fBMUST\fR be set to code page 852 if
1643 the \fI character set\fR parameter is set
1644 to ISO8859-2 in order for the conversion
1645 to the UNIX character set to be done correctly.
1648 ISO8859-5 : Russian Cyrillic
1649 UNIX character set. The parameter \fIclient code page
1650 \fR\fBMUST\fR be set to code page
1651 866 if the \fIcharacter set \fR parameter is
1652 set to ISO8859-5 in order for the conversion
1653 to the UNIX character set to be done correctly.
1656 ISO8859-7 : Greek UNIX
1657 character set. The parameter \fIclient code page
1658 \fR\fBMUST\fR be set to code page
1659 737 if the \fIcharacter set\fR parameter is
1660 set to ISO8859-7 in order for the conversion
1661 to the UNIX character set to be done correctly.
1664 KOI8-R : Alternate mapping
1665 for Russian Cyrillic UNIX character set. The parameter
1666 \fIclient code page\fR \fBMUST\fR
1667 be set to code page 866 if the \fIcharacter set\fR
1668 parameter is set to KOI8-R in order for the
1669 conversion to the UNIX character set to be done correctly.
1672 \fBBUG\fR. These MSDOS code page to UNIX character
1673 set mappings should be dynamic, like the loading of MS DOS code pages,
1677 Normally this parameter is not set, meaning no filename
1678 translation is done.
1681 Default: \fBcharacter set = <empty string>\fR
1684 Example: \fBcharacter set = ISO8859-1\fR
1687 \fBclient code page (G)\fR
1688 This parameter specifies the DOS code page
1689 that the clients accessing Samba are using. To determine what code
1690 page a Windows or DOS client is using, open a DOS command prompt
1691 and type the command \fBchcp\fR. This will output
1692 the code page. The default for USA MS-DOS, Windows 95, and
1693 Windows NT releases is code page 437. The default for western
1694 European releases of the above operating systems is code page 850.
1696 This parameter tells smbd(8)which of the \fIcodepage.XXX
1697 \fRfiles to dynamically load on startup. These files,
1698 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
1699 the case insensitivity of filenames that Windows clients expect.
1701 Samba currently ships with the following code page files :
1705 Code Page 437 - MS-DOS Latin US
1708 Code Page 737 - Windows '95 Greek
1711 Code Page 850 - MS-DOS Latin 1
1714 Code Page 852 - MS-DOS Latin 2
1717 Code Page 861 - MS-DOS Icelandic
1720 Code Page 866 - MS-DOS Cyrillic
1723 Code Page 932 - MS-DOS Japanese SJIS
1726 Code Page 936 - MS-DOS Simplified Chinese
1729 Code Page 949 - MS-DOS Korean Hangul
1732 Code Page 950 - MS-DOS Traditional Chinese
1735 Thus this parameter may have any of the values 437, 737, 850, 852,
1736 861, 932, 936, 949, or 950. If you don't find the codepage you need,
1737 read the comments in one of the other codepage files and the
1738 \fBmake_smbcodepage(1)\fR man page and write one. Please
1739 remember to donate it back to the Samba user community.
1742 This parameter co-operates with the \fIvalid
1743 chars\fR parameter in determining what characters are
1744 valid in filenames and how capitalization is done. If you set both
1745 this parameter and the \fIvalid chars\fR parameter
1746 the \fIclient code page\fR parameter
1747 \fBMUST\fR be set before the \fIvalid
1748 chars\fR parameter in the \fIsmb.conf\fR
1749 file. The \fIvalid chars\fR string will then
1750 augment the character settings in the \fIclient code page\fR
1754 If not set, \fIclient code page\fR defaults
1759 chars\fR, \fIcode page directory\fR
1762 Default: \fBclient code page = 850\fR
1765 Example: \fBclient code page = 936\fR
1768 \fBcode page directory (G)\fR
1769 Define the location of the various client code page
1775 Default: \fBcode page directory = ${prefix}/lib/codepages
1777 Example: \fBcode page directory = /usr/share/samba/codepages
1779 \fBcodingsystem (G)\fR
1780 This parameter is used to determine how incoming
1781 Shift-JIS Japanese characters are mapped from the incoming \fIclient code page\fR
1782 used by the client, into file names in the UNIX filesystem.
1783 Only useful if \fIclient code page\fR is set to
1784 932 (Japanese Shift-JIS). The options are :
1788 SJIS - Shift-JIS. Does no
1789 conversion of the incoming filename.
1792 JIS8, J8BB, J8BH, J8@B,
1793 J8@J, J8@H - Convert from incoming Shift-JIS to eight
1794 bit JIS code with different shift-in, shift out codes.
1797 JIS7, J7BB, J7BH, J7@B, J7@J,
1798 J7@H - Convert from incoming Shift-JIS to seven bit
1799 JIS code with different shift-in, shift out codes.
1802 JUNET, JUBB, JUBH, JU@B, JU@J, JU@H
1803 - Convert from incoming Shift-JIS to JUNET code with different shift-in,
1807 EUC - Convert an incoming
1808 Shift-JIS character to EUC code.
1811 HEX - Convert an incoming
1812 Shift-JIS character to a 3 byte hex representation, i.e.
1816 CAP - Convert an incoming
1817 Shift-JIS character to the 3 byte hex representation used by
1818 the Columbia AppleTalk Program (CAP), i.e. :AB.
1819 This is used for compatibility between Samba and CAP.
1822 Default: \fBcoding system = <empty value>\fR
1826 This is a text field that is seen next to a share
1827 when a client does a queries the server, either via the network
1828 neighborhood or via \fBnet view\fR to list what shares
1831 If you want to set the string that is displayed next to the
1832 machine name then see the \fI server string\fR parameter.
1834 Default: \fBNo comment string\fR
1836 Example: \fBcomment = Fred's Files\fR
1838 \fBconfig file (G)\fR
1839 This allows you to override the config file
1840 to use, instead of the default (usually \fIsmb.conf\fR).
1841 There is a chicken and egg problem here as this option is set
1844 For this reason, if the name of the config file has changed
1845 when the parameters are loaded then it will reload them from
1846 the new config file.
1848 This option takes the usual substitutions, which can
1851 If the config file doesn't exist then it won't be loaded
1852 (allowing you to special case the config files of just a few
1855 Example: \fBconfig file = /usr/local/samba/lib/smb.conf.%m
1858 This parameter allows you to "clone" service
1859 entries. The specified service is simply duplicated under the
1860 current service's name. Any parameters specified in the current
1861 section will override those in the section being copied.
1863 This feature lets you set up a 'template' service and
1864 create similar services easily. Note that the service being
1865 copied must occur earlier in the configuration file than the
1866 service doing the copying.
1868 Default: \fBno value\fR
1870 Example: \fBcopy = otherservice\fR
1872 \fBcreate mask (S)\fR
1873 A synonym for this parameter is
1877 When a file is created, the necessary permissions are
1878 calculated according to the mapping from DOS modes to UNIX
1879 permissions, and the resulting UNIX mode is then bit-wise 'AND'ed
1880 with this parameter. This parameter may be thought of as a bit-wise
1881 MASK for the UNIX modes of a file. Any bit \fBnot\fR
1882 set here will be removed from the modes set on a file when it is
1885 The default value of this parameter removes the
1886 \&'group' and 'other' write and execute bits from the UNIX modes.
1888 Following this Samba will bit-wise 'OR' the UNIX mode created
1889 from this parameter with the value of the \fIforce create mode\fR
1890 parameter which is set to 000 by default.
1892 This parameter does not affect directory modes. See the
1893 parameter \fIdirectory mode
1896 See also the \fIforce
1897 create mode\fR parameter for forcing particular mode
1898 bits to be set on created files. See also the \fIdirectory mode"\fR parameter for masking
1899 mode bits on created directories. See also the \fIinherit permissions\fR parameter.
1901 Default: \fBcreate mask = 0744\fR
1903 Example: \fBcreate mask = 0775\fR
1905 \fBcreate mode (S)\fR
1906 This is a synonym for \fI create mask\fR.
1909 The value of the parameter (a decimal integer)
1910 represents the number of minutes of inactivity before a connection
1911 is considered dead, and it is disconnected. The deadtime only takes
1912 effect if the number of open files is zero.
1914 This is useful to stop a server's resources being
1915 exhausted by a large number of inactive connections.
1917 Most clients have an auto-reconnect feature when a
1918 connection is broken so in most cases this parameter should be
1919 transparent to users.
1921 Using this parameter with a timeout of a few minutes
1922 is recommended for most systems.
1924 A deadtime of zero indicates that no auto-disconnection
1925 should be performed.
1927 Default: \fBdeadtime = 0\fR
1929 Example: \fBdeadtime = 15\fR
1931 \fBdebug hires timestamp (G)\fR
1932 Sometimes the timestamps in the log messages
1933 are needed with a resolution of higher that seconds, this
1934 boolean parameter adds microsecond resolution to the timestamp
1935 message header when turned on.
1937 Note that the parameter \fI debug timestamp\fR must be on for this to have an
1940 Default: \fBdebug hires timestamp = no\fR
1943 When using only one log file for more then one
1944 forked smbd-process there may be hard to follow which process
1945 outputs which message. This boolean parameter is adds the process-id
1946 to the timestamp message headers in the logfile when turned on.
1948 Note that the parameter \fI debug timestamp\fR must be on for this to have an
1951 Default: \fBdebug pid = no\fR
1953 \fBdebug timestamp (G)\fR
1954 Samba 2.2 debug log messages are timestamped
1955 by default. If you are running at a high \fIdebug level\fR these timestamps
1956 can be distracting. This boolean parameter allows timestamping
1959 Default: \fBdebug timestamp = yes\fR
1962 Samba is sometimes run as root and sometime
1963 run as the connected user, this boolean parameter inserts the
1964 current euid, egid, uid and gid to the timestamp message headers
1965 in the log file if turned on.
1967 Note that the parameter \fI debug timestamp\fR must be on for this to have an
1970 Default: \fBdebug uid = no\fR
1972 \fBdebuglevel (G)\fR
1973 The value of the parameter (an integer) allows
1974 the debug level (logging level) to be specified in the
1975 \fIsmb.conf\fR file. This is to give greater
1976 flexibility in the configuration of the system.
1978 The default will be the debug level specified on
1979 the command line or level zero if none was specified.
1981 Example: \fBdebug level = 3\fR
1984 A synonym for \fI default service\fR.
1986 \fBdefault case (S)\fR
1987 See the section on NAME MANGLING. Also note the \fIshort preserve case"\fR parameter.
1989 Default: \fBdefault case = lower\fR
1991 \fBdefault service (G)\fR
1992 This parameter specifies the name of a service
1993 which will be connected to if the service actually requested cannot
1994 be found. Note that the square brackets are \fBNOT\fR
1995 given in the parameter value (see example below).
1997 There is no default value for this parameter. If this
1998 parameter is not given, attempting to connect to a nonexistent
1999 service results in an error.
2001 Typically the default service would be a \fIguest ok\fR, \fIread-only\fR service.
2003 Also note that the apparent service name will be changed
2004 to equal that of the requested service, this is very useful as it
2005 allows you to use macros like \fI%S\fR to make
2008 Note also that any "_" characters in the name of the service
2009 used in the default service will get mapped to a "/". This allows for
2017 default service = pub
2025 \fBdelete readonly (S)\fR
2026 This parameter allows readonly files to be deleted.
2027 This is not normal DOS semantics, but is allowed by UNIX.
2029 This option may be useful for running applications such
2030 as rcs, where UNIX file ownership prevents changing file
2031 permissions, and DOS semantics prevent deletion of a read only file.
2033 Default: \fBdelete readonly = no\fR
2035 \fBdelete user script (G)\fR
2036 This is the full pathname to a script that will
2037 be run \fBAS ROOT\fR by \fBsmbd(8)\fRunder special circumstances
2040 Normally, a Samba server requires that UNIX users are
2041 created for all users accessing files on this server. For sites
2042 that use Windows NT account databases as their primary user database
2043 creating these users and keeping the user list in sync with the
2044 Windows NT PDC is an onerous task. This option allows \fB smbd\fR to delete the required UNIX users \fBON
2045 DEMAND\fR when a user accesses the Samba server and the
2046 Windows NT user no longer exists.
2048 In order to use this option, \fBsmbd\fR must be
2049 set to \fIsecurity=domain\fR and \fIdelete
2050 user script\fR must be set to a full pathname for a script
2051 that will delete a UNIX user given one argument of \fI%u
2052 \fR, which expands into the UNIX user name to delete.
2053 \fBNOTE\fR that this is different to the \fIadd user script\fR
2054 which will work with the \fIsecurity=server\fR option
2055 as well as \fIsecurity=domain\fR. The reason for this
2056 is only when Samba is a domain member does it get the information
2057 on an attempted user logon that a user no longer exists. In the
2058 \fIsecurity=server\fR mode a missing user
2059 is treated the same as an invalid password logon attempt. Deleting
2060 the user in this circumstance would not be a good idea.
2062 When the Windows user attempts to access the Samba server,
2063 at \fBlogin\fR (session setup in the SMB protocol)
2064 time, \fBsmbd\fR contacts the \fIpassword server\fR and attempts to authenticate
2065 the given user with the given password. If the authentication fails
2066 with the specific Domain error code meaning that the user no longer
2067 exists then \fBsmbd\fR attempts to find a UNIX user in
2068 the UNIX password database that matches the Windows user account. If
2069 this lookup succeeds, and \fIdelete user script\fR is
2070 set then \fBsmbd\fR will all the specified script
2071 \fBAS ROOT\fR, expanding any \fI%u\fR
2072 argument to be the user name to delete.
2074 This script should delete the given UNIX username. In this way,
2075 UNIX users are dynamically deleted to match existing Windows NT
2078 See also security=domain,
2079 \fIpassword server\fR
2080 , \fIadd user script\fR
2083 Default: \fBdelete user script = <empty string>
2085 Example: \fBdelete user script = /usr/local/samba/bin/del_user
2088 \fBdeleteprinter command (G)\fR
2089 With the introduction of MS-RPC based printer
2090 support for Windows NT/2000 clients in Samba 2.2, it is now
2091 possible to delete printer at run time by issuing the
2092 DeletePrinter() RPC call.
2094 For a Samba host this means that the printer must be
2095 physically deleted from underlying printing system. The \fI deleteprinter command\fR defines a script to be run which
2096 will perform the necessary operations for removing the printer
2097 from the print system and from \fIsmb.conf\fR.
2099 The \fIdeleteprinter command\fR is
2100 automatically called with only one parameter: \fI "printer name"\fR.
2102 Once the \fIdeleteprinter command\fR has
2103 been executed, \fBsmbd\fR will reparse the \fI smb.conf\fR to associated printer no longer exists.
2104 If the sharename is still valid, then \fBsmbd
2105 \fRwill return an ACCESS_DENIED error to the client.
2107 See also \fI addprinter command\fR, \fIprinting\fR,
2113 Example: \fBdeleteprinter command = /usr/bin/removeprinter
2115 \fBdelete veto files (S)\fR
2116 This option is used when Samba is attempting to
2117 delete a directory that contains one or more vetoed directories
2118 (see the \fIveto files\fR
2119 option). If this option is set to False (the default) then if a vetoed
2120 directory contains any non-vetoed files or directories then the
2121 directory delete will fail. This is usually what you want.
2123 If this option is set to True, then Samba
2124 will attempt to recursively delete any files and directories within
2125 the vetoed directory. This can be useful for integration with file
2126 serving systems such as NetAtalk which create meta-files within
2127 directories you might normally veto DOS/Windows users from seeing
2128 (e.g. \fI.AppleDouble\fR)
2130 Setting \fBdelete veto files = yes\fR allows these
2131 directories to be transparently deleted when the parent directory
2132 is deleted (so long as the user has permissions to do so).
2134 See also the \fIveto
2137 Default: \fBdelete veto files = no\fR
2139 \fBdeny hosts (S)\fR
2140 Synonym for \fIhosts
2143 \fBdfree command (G)\fR
2144 The \fIdfree command\fR setting should
2145 only be used on systems where a problem occurs with the internal
2146 disk space calculations. This has been known to happen with Ultrix,
2147 but may occur with other operating systems. The symptom that was
2148 seen was an error of "Abort Retry Ignore" at the end of each
2151 This setting allows the replacement of the internal routines to
2152 calculate the total disk space and amount available with an external
2153 routine. The example below gives a possible script that might fulfill
2156 The external program will be passed a single parameter indicating
2157 a directory in the filesystem being queried. This will typically consist
2158 of the string \fI./\fR. The script should return two
2159 integers in ASCII. The first should be the total disk space in blocks,
2160 and the second should be the number of available blocks. An optional
2161 third return value can give the block size in bytes. The default
2162 blocksize is 1024 bytes.
2164 Note: Your script should \fBNOT\fR be setuid or
2165 setgid and should be owned by (and writeable only by) root!
2167 Default: \fBBy default internal routines for
2168 determining the disk capacity and remaining space will be used.
2170 Example: \fBdfree command = /usr/local/samba/bin/dfree
2172 Where the script dfree (which must be made executable) could be:
2178 df $1 | tail -1 | awk '{print $2" "$4}'
2183 or perhaps (on Sys V based systems):
2189 /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
2194 Note that you may have to replace the command names
2195 with full path names on some systems.
2201 \fBdirectory mask (S)\fR
2202 This parameter is the octal modes which are
2203 used when converting DOS modes to UNIX modes when creating UNIX
2206 When a directory is created, the necessary permissions are
2207 calculated according to the mapping from DOS modes to UNIX permissions,
2208 and the resulting UNIX mode is then bit-wise 'AND'ed with this
2209 parameter. This parameter may be thought of as a bit-wise MASK for
2210 the UNIX modes of a directory. Any bit \fBnot\fR set
2211 here will be removed from the modes set on a directory when it is
2214 The default value of this parameter removes the 'group'
2215 and 'other' write bits from the UNIX mode, allowing only the
2216 user who owns the directory to modify it.
2218 Following this Samba will bit-wise 'OR' the UNIX mode
2219 created from this parameter with the value of the \fIforce directory mode
2220 \fRparameter. This parameter is set to 000 by
2221 default (i.e. no extra mode bits are added).
2224 directory mode\fR parameter to cause particular mode
2225 bits to always be set on created directories.
2227 See also the \fIcreate mode
2228 \fRparameter for masking mode bits on created files,
2229 and the \fIdirectory
2230 security mask\fR parameter.
2232 Also refer to the \fI inherit permissions\fR parameter.
2234 Default: \fBdirectory mask = 0755\fR
2236 Example: \fBdirectory mask = 0775\fR
2238 \fBdirectory mode (S)\fR
2239 Synonym for \fI directory mask\fR
2241 \fBdirectory security mask (S)\fR
2242 This parameter controls what UNIX permission bits
2243 can be modified when a Windows NT client is manipulating the UNIX
2244 permission on a directory using the native NT security dialog
2247 This parameter is applied as a mask (AND'ed with) to
2248 the changed permission bits, thus preventing any bits not in
2249 this mask from being modified. Essentially, zero bits in this
2250 mask may be treated as a set of bits the user is not allowed
2253 If not set explicitly this parameter is set to the same
2254 value as the \fIdirectory
2255 mask\fR parameter. To allow a user to
2256 modify all the user/group/world permissions on a directory, set
2257 this parameter to 0777.
2259 \fBNote\fR that users who can access the
2260 Samba server through other means can easily bypass this restriction,
2261 so it is primarily useful for standalone "appliance" systems.
2262 Administrators of most normal systems will probably want to set
2265 See also the \fI force directory security mode\fR, \fIsecurity mask\fR,
2266 \fIforce security mode
2269 Default: \fBdirectory security mask = <same as
2272 Example: \fBdirectory security mask = 0777\fR
2275 Specifies that nmbd(8)when acting as a WINS server and finding that a NetBIOS name has not
2276 been registered, should treat the NetBIOS name word-for-word as a DNS
2277 name and do a lookup with the DNS server for that name on behalf of
2278 the name-querying client.
2280 Note that the maximum length for a NetBIOS name is 15
2281 characters, so the DNS name (or DNS alias) can likewise only be
2282 15 characters, maximum.
2284 \fBnmbd\fR spawns a second copy of itself to do the
2285 DNS name lookup requests, as doing a name lookup is a blocking
2288 See also the parameter \fI wins support\fR.
2290 Default: \fBdns proxy = yes\fR
2292 \fBdomain admin group (G)\fR
2293 This is an \fBEXPERIMENTAL\fR parameter
2294 that is part of the unfinished Samba NT Domain Controller Code. It may
2295 be removed in a later release. To work with the latest code builds
2296 that may have more support for Samba NT Domain Controller functionality
2297 please subscribe to the mailing list samba-ntdom <URL:mailto:samba-ntdom@samba.org> available by
2298 visiting the web page at http://lists.samba.org/ <URL:http://lists.samba.org/>.
2300 \fBdomain admin users (G)\fR
2301 This is an \fBEXPERIMENTAL\fR parameter
2302 that is part of the unfinished Samba NT Domain Controller Code. It may
2303 be removed in a later release. To work with the latest code builds
2304 that may have more support for Samba NT Domain Controller functionality
2305 please subscribe to the mailing list samba-ntdom <URL:mailto:samba-ntdom@samba.org> available by
2306 visiting the web page at http://lists.samba.org/ <URL:http://lists.samba.org/>.
2308 \fBdomain groups (G)\fR
2309 This is an \fBEXPERIMENTAL\fR parameter
2310 that is part of the unfinished Samba NT Domain Controller Code. It may
2311 be removed in a later release. To work with the latest code builds
2312 that may have more support for Samba NT Domain Controller functionality
2313 please subscribe to the mailing list samba-ntdom <URL:mailto:samba-ntdom@samba.org> available by
2314 visiting the web page at http://lists.samba.org/ <URL:http://lists.samba.org/>.
2316 \fBdomain guest group (G)\fR
2317 This is an \fBEXPERIMENTAL\fR parameter
2318 that is part of the unfinished Samba NT Domain Controller Code. It may
2319 be removed in a later release. To work with the latest code builds
2320 that may have more support for Samba NT Domain Controller functionality
2321 please subscribe to the mailing list samba-ntdom <URL:mailto:samba-ntdom@samba.org> available by
2322 visiting the web page at http://lists.samba.org/ <URL:http://lists.samba.org/>.
2324 \fBdomain guest users (G)\fR
2325 This is an \fBEXPERIMENTAL\fR parameter
2326 that is part of the unfinished Samba NT Domain Controller Code. It may
2327 be removed in a later release. To work with the latest code builds
2328 that may have more support for Samba NT Domain Controller functionality
2329 please subscribe to the mailing list samba-ntdom <URL:mailto:samba-ntdom@samba.org> available by
2330 visiting the web page at http://lists.samba.org/ <URL:http://lists.samba.org/>.
2332 \fBdomain logons (G)\fR
2333 If set to true, the Samba server will serve
2334 Windows 95/98 Domain logons for the \fIworkgroup\fR it is in. Samba 2.2 also
2335 has limited capability to act as a domain controller for Windows
2336 NT 4 Domains. For more details on setting up this feature see
2337 the file DOMAINS.txt in the Samba documentation directory \fIdocs/
2338 \fRshipped with the source code.
2340 Default: \fBdomain logons = no\fR
2342 \fBdomain master (G)\fR
2343 Tell \fB nmbd(8)\fRto enable WAN-wide browse list
2344 collation. Setting this option causes \fBnmbd\fR to
2345 claim a special domain specific NetBIOS name that identifies
2346 it as a domain master browser for its given \fIworkgroup\fR. Local master browsers
2347 in the same \fIworkgroup\fR on broadcast-isolated
2348 subnets will give this \fBnmbd\fR their local browse lists,
2349 and then ask \fBsmbd(8)\fRfor a complete copy of the browse list for the whole wide area
2350 network. Browser clients will then contact their local master browser,
2351 and will receive the domain-wide browse list, instead of just the list
2352 for their broadcast-isolated subnet.
2354 Note that Windows NT Primary Domain Controllers expect to be
2355 able to claim this \fIworkgroup\fR specific special
2356 NetBIOS name that identifies them as domain master browsers for
2357 that \fIworkgroup\fR by default (i.e. there is no
2358 way to prevent a Windows NT PDC from attempting to do this). This
2359 means that if this parameter is set and \fBnmbd\fR claims
2360 the special name for a \fIworkgroup\fR before a Windows
2361 NT PDC is able to do so then cross subnet browsing will behave
2362 strangely and may fail.
2364 If \fBdomain logons = yes\fR
2365 , then the default behavior is to enable the \fIdomain
2366 master\fR parameter. If \fIdomain logons\fR is
2367 not enabled (the default setting), then neither will \fIdomain
2368 master\fR be enabled by default.
2370 Default: \fBdomain master = auto\fR
2372 \fBdont descend (S)\fR
2373 There are certain directories on some systems
2374 (e.g., the \fI/proc\fR tree under Linux) that are either not
2375 of interest to clients or are infinitely deep (recursive). This
2376 parameter allows you to specify a comma-delimited list of directories
2377 that the server should always show as empty.
2379 Note that Samba can be very fussy about the exact format
2380 of the "dont descend" entries. For example you may need \fI ./proc\fR instead of just \fI/proc\fR.
2381 Experimentation is the best policy :-)
2383 Default: \fBnone (i.e., all directories are OK
2386 Example: \fBdont descend = /proc,/dev\fR
2388 \fBdos filemode (S)\fR
2389 The default behavior in Samba is to provide
2390 UNIX-like behavor where only the owner of a file/directory is
2391 able to change the permissions on it. However, this behavior
2392 is often confusing to DOS/Windows users. Enabling this parameter
2393 allows a user who has write access to the file (by whatever
2394 means) to modify the permissions on it. Note that a user
2395 belonging to the group owning the file will not be allowed to
2396 change permissions if the group is only granted read access.
2397 Ownership of the file/directory is not changed, only the permissions
2400 Default: \fBdos filemode = no\fR
2402 \fBdos filetime resolution (S)\fR
2403 Under the DOS and Windows FAT filesystem, the finest
2404 granularity on time resolution is two seconds. Setting this parameter
2405 for a share causes Samba to round the reported time down to the
2406 nearest two second boundary when a query call that requires one second
2407 resolution is made to \fBsmbd(8)\fR
2410 This option is mainly used as a compatibility option for Visual
2411 C++ when used against Samba shares. If oplocks are enabled on a
2412 share, Visual C++ uses two different time reading calls to check if a
2413 file has changed since it was last read. One of these calls uses a
2414 one-second granularity, the other uses a two second granularity. As
2415 the two second call rounds any odd second down, then if the file has a
2416 timestamp of an odd number of seconds then the two timestamps will not
2417 match and Visual C++ will keep reporting the file has changed. Setting
2418 this option causes the two timestamps to match, and Visual C++ is
2421 Default: \fBdos filetime resolution = no\fR
2423 \fBdos filetimes (S)\fR
2424 Under DOS and Windows, if a user can write to a
2425 file they can change the timestamp on it. Under POSIX semantics,
2426 only the owner of the file or root may change the timestamp. By
2427 default, Samba runs with POSIX semantics and refuses to change the
2428 timestamp on a file if the user \fBsmbd\fR is acting
2429 on behalf of is not the file owner. Setting this option to True allows DOS semantics and smbd will change the file
2430 timestamp as DOS requires.
2432 Default: \fBdos filetimes = no\fR
2434 \fBencrypt passwords (G)\fR
2435 This boolean controls whether encrypted passwords
2436 will be negotiated with the client. Note that Windows NT 4.0 SP3 and
2437 above and also Windows 98 will by default expect encrypted passwords
2438 unless a registry entry is changed. To use encrypted passwords in
2439 Samba see the file ENCRYPTION.txt in the Samba documentation
2440 directory \fIdocs/\fR shipped with the source code.
2442 In order for encrypted passwords to work correctly
2443 \fBsmbd(8)\fRmust either
2444 have access to a local \fIsmbpasswd(5)
2445 \fRprogram for information on how to set up
2446 and maintain this file), or set the security=[serve|domain] parameter which
2447 causes \fBsmbd\fR to authenticate against another
2450 Default: \fBencrypt passwords = no\fR
2452 \fBenhanced browsing (G)\fR
2453 This option enables a couple of enhancements to
2454 cross-subnet browse propogation that have been added in Samba
2455 but which are not standard in Microsoft implementations.
2456 \fBThese enhancements are currently only available in
2457 the HEAD Samba CVS tree (not Samba 2.2.x).\fR
2459 The first enhancement to browse propogation consists of a regular
2460 wildcard query to a Samba WINS server for all Domain Master Browsers,
2461 followed by a browse synchronisation with each of the returned
2462 DMBs. The second enhancement consists of a regular randomised browse
2463 synchronisation with all currently known DMBs.
2465 You may wish to disable this option if you have a problem with empty
2466 workgroups not disappearing from browse lists. Due to the restrictions
2467 of the browse protocols these enhancements can cause a empty workgroup
2468 to stay around forever which can be annoying.
2470 In general you should leave this option enabled as it makes
2471 cross-subnet browse propogation much more reliable.
2473 Default: \fBenhanced browsing = yes\fR
2475 \fBenumports command (G)\fR
2476 The concept of a "port" is fairly foreign
2477 to UNIX hosts. Under Windows NT/2000 print servers, a port
2478 is associated with a port monitor and generally takes the form of
2479 a local port (i.e. LPT1:, COM1:, FILE:) or a remote port
2480 (i.e. LPD Port Monitor, etc...). By default, Samba has only one
2481 port defined--"Samba Printer Port". Under
2482 Windows NT/2000, all printers must have a valid port name.
2483 If you wish to have a list of ports displayed (\fBsmbd
2484 \fRdoes not use a port name for anything) other than
2485 the default "Samba Printer Port", you
2486 can define \fIenumports command\fR to point to
2487 a program which should generate a list of ports, one per line,
2488 to standard output. This listing will then be used in response
2489 to the level 1 and 2 EnumPorts() RPC.
2491 Default: \fBno enumports command\fR
2493 Example: \fBenumports command = /usr/bin/listports
2496 This is a synonym for \fIpreexec\fR.
2498 \fBfake directory create times (S)\fR
2499 NTFS and Windows VFAT file systems keep a create
2500 time for all files and directories. This is not the same as the
2501 ctime - status change time - that Unix keeps, so Samba by default
2502 reports the earliest of the various times Unix does keep. Setting
2503 this parameter for a share causes Samba to always report midnight
2504 1-1-1980 as the create time for directories.
2506 This option is mainly used as a compatibility option for
2507 Visual C++ when used against Samba shares. Visual C++ generated
2508 makefiles have the object directory as a dependency for each object
2509 file, and a make rule to create the directory. Also, when NMAKE
2510 compares timestamps it uses the creation time when examining a
2511 directory. Thus the object directory will be created if it does not
2512 exist, but once it does exist it will always have an earlier
2513 timestamp than the object files it contains.
2515 However, Unix time semantics mean that the create time
2516 reported by Samba will be updated whenever a file is created or
2517 or deleted in the directory. NMAKE finds all object files in
2518 the object directory. The timestamp of the last one built is then
2519 compared to the timestamp of the object dircetory. If the
2520 directory's timestamp if newer, then all object files
2521 will be rebuilt. Enabling this option
2522 ensures directories always predate their contents and an NMAKE build
2523 will proceed as expected.
2525 Default: \fBfake directory create times = no\fR
2527 \fBfake oplocks (S)\fR
2528 Oplocks are the way that SMB clients get permission
2529 from a server to locally cache file operations. If a server grants
2530 an oplock (opportunistic lock) then the client is free to assume
2531 that it is the only one accessing the file and it will aggressively
2532 cache file data. With some oplock types the client may even cache
2533 file open/close operations. This can give enormous performance benefits.
2535 When you set \fBfake oplocks = yes\fR, \fBsmbd(8)\fRwill
2536 always grant oplock requests no matter how many clients are using
2539 It is generally much better to use the real \fIoplocks\fR support rather
2540 than this parameter.
2542 If you enable this option on all read-only shares or
2543 shares that you know will only be accessed from one client at a
2544 time such as physically read-only media like CDROMs, you will see
2545 a big performance improvement on many operations. If you enable
2546 this option on shares where multiple clients may be accessing the
2547 files read-write at the same time you can get data corruption. Use
2548 this option carefully!
2550 Default: \fBfake oplocks = no\fR
2552 \fBfollow symlinks (S)\fR
2553 This parameter allows the Samba administrator
2554 to stop \fBsmbd(8)\fRfrom following symbolic links in a particular share. Setting this
2555 parameter to no prevents any file or directory
2556 that is a symbolic link from being followed (the user will get an
2557 error). This option is very useful to stop users from adding a
2558 symbolic link to \fI/etc/passwd\fR in their home
2559 directory for instance. However it will slow filename lookups
2562 This option is enabled (i.e. \fBsmbd\fR will
2563 follow symbolic links) by default.
2565 Default: \fBfollow symlinks = yes\fR
2567 \fBforce create mode (S)\fR
2568 This parameter specifies a set of UNIX mode bit
2569 permissions that will \fBalways\fR be set on a
2570 file created by Samba. This is done by bitwise 'OR'ing these bits onto
2571 the mode bits of a file that is being created or having its
2572 permissions changed. The default for this parameter is (in octal)
2573 000. The modes in this parameter are bitwise 'OR'ed onto the file
2574 mode after the mask set in the \fIcreate mask\fR
2575 parameter is applied.
2577 See also the parameter \fIcreate
2578 mask\fR for details on masking mode bits on files.
2580 See also the \fIinherit
2581 permissions\fR parameter.
2583 Default: \fBforce create mode = 000\fR
2585 Example: \fBforce create mode = 0755\fR
2587 would force all created files to have read and execute
2588 permissions set for 'group' and 'other' as well as the
2589 read/write/execute bits set for the 'user'.
2591 \fBforce directory mode (S)\fR
2592 This parameter specifies a set of UNIX mode bit
2593 permissions that will \fBalways\fR be set on a directory
2594 created by Samba. This is done by bitwise 'OR'ing these bits onto the
2595 mode bits of a directory that is being created. The default for this
2596 parameter is (in octal) 0000 which will not add any extra permission
2597 bits to a created directory. This operation is done after the mode
2598 mask in the parameter \fIdirectory mask\fR is
2601 See also the parameter \fI directory mask\fR for details on masking mode bits
2602 on created directories.
2604 See also the \fI inherit permissions\fR parameter.
2606 Default: \fBforce directory mode = 000\fR
2608 Example: \fBforce directory mode = 0755\fR
2610 would force all created directories to have read and execute
2611 permissions set for 'group' and 'other' as well as the
2612 read/write/execute bits set for the 'user'.
2614 \fBforce directory security mode (S)\fR
2615 This parameter controls what UNIX permission bits
2616 can be modified when a Windows NT client is manipulating the UNIX
2617 permission on a directory using the native NT security dialog box.
2619 This parameter is applied as a mask (OR'ed with) to the
2620 changed permission bits, thus forcing any bits in this mask that
2621 the user may have modified to be on. Essentially, one bits in this
2622 mask may be treated as a set of bits that, when modifying security
2623 on a directory, the user has always set to be 'on'.
2625 If not set explicitly this parameter is set to the same
2626 value as the \fIforce
2627 directory mode\fR parameter. To allow
2628 a user to modify all the user/group/world permissions on a
2629 directory without restrictions, set this parameter to 000.
2631 \fBNote\fR that users who can access the
2632 Samba server through other means can easily bypass this restriction,
2633 so it is primarily useful for standalone "appliance" systems.
2634 Administrators of most normal systems will probably want to set
2637 See also the \fI directory security mask\fR, \fIsecurity mask\fR,
2638 \fIforce security mode
2641 Default: \fBforce directory security mode = <same as
2642 force directory mode>\fR
2644 Example: \fBforce directory security mode = 0\fR
2646 \fBforce group (S)\fR
2647 This specifies a UNIX group name that will be
2648 assigned as the default primary group for all users connecting
2649 to this service. This is useful for sharing files by ensuring
2650 that all access to files on service will use the named group for
2651 their permissions checking. Thus, by assigning permissions for this
2652 group to the files and directories within this service the Samba
2653 administrator can restrict or allow sharing of these files.
2655 In Samba 2.0.5 and above this parameter has extended
2656 functionality in the following way. If the group name listed here
2657 has a '+' character prepended to it then the current user accessing
2658 the share only has the primary group default assigned to this group
2659 if they are already assigned as a member of that group. This allows
2660 an administrator to decide that only users who are already in a
2661 particular group will create files with group ownership set to that
2662 group. This gives a finer granularity of ownership assignment. For
2663 example, the setting \fIforce group = +sys\fR means
2664 that only users who are already in group sys will have their default
2665 primary group assigned to sys when accessing this Samba share. All
2666 other users will retain their ordinary primary group.
2668 If the \fIforce user
2669 \fRparameter is also set the group specified in
2670 \fIforce group\fR will override the primary group
2671 set in \fIforce user\fR.
2676 Default: \fBno forced group\fR
2678 Example: \fBforce group = agroup\fR
2680 \fBforce security mode (S)\fR
2681 This parameter controls what UNIX permission
2682 bits can be modified when a Windows NT client is manipulating
2683 the UNIX permission on a file using the native NT security dialog
2686 This parameter is applied as a mask (OR'ed with) to the
2687 changed permission bits, thus forcing any bits in this mask that
2688 the user may have modified to be on. Essentially, one bits in this
2689 mask may be treated as a set of bits that, when modifying security
2690 on a file, the user has always set to be 'on'.
2692 If not set explicitly this parameter is set to the same
2693 value as the \fIforce
2694 create mode\fR parameter. To allow a user to
2695 modify all the user/group/world permissions on a file, with no
2696 restrictions set this parameter to 000.
2698 \fBNote\fR that users who can access
2699 the Samba server through other means can easily bypass this restriction,
2700 so it is primarily useful for standalone "appliance" systems.
2701 Administrators of most normal systems will probably want to set
2704 See also the \fI force directory security mode\fR,
2705 \fIdirectory security
2706 mask\fR, \fI security mask\fR parameters.
2708 Default: \fBforce security mode = <same as force
2711 Example: \fBforce security mode = 0\fR
2713 \fBforce user (S)\fR
2714 This specifies a UNIX user name that will be
2715 assigned as the default user for all users connecting to this service.
2716 This is useful for sharing files. You should also use it carefully
2717 as using it incorrectly can cause security problems.
2719 This user name only gets used once a connection is established.
2720 Thus clients still need to connect as a valid user and supply a
2721 valid password. Once connected, all file operations will be performed
2722 as the "forced user", no matter what username the client connected
2723 as. This can be very useful.
2725 In Samba 2.0.5 and above this parameter also causes the
2726 primary group of the forced user to be used as the primary group
2727 for all file activity. Prior to 2.0.5 the primary group was left
2728 as the primary group of the connecting user (this was a bug).
2730 See also \fIforce group
2732 Default: \fBno forced user\fR
2734 Example: \fBforce user = auser\fR
2737 This parameter allows the administrator to
2738 configure the string that specifies the type of filesystem a share
2739 is using that is reported by \fBsmbd(8)
2740 \fRwhen a client queries the filesystem type
2741 for a share. The default type is NTFS for
2742 compatibility with Windows NT but this can be changed to other
2743 strings such as Samba or FAT
2746 Default: \fBfstype = NTFS\fR
2748 Example: \fBfstype = Samba\fR
2750 \fBgetwd cache (G)\fR
2751 This is a tuning option. When this is enabled a
2752 caching algorithm will be used to reduce the time taken for getwd()
2753 calls. This can have a significant impact on performance, especially
2754 when the \fIwide links\fR
2755 parameter is set to False.
2757 Default: \fBgetwd cache = yes\fR
2760 Synonym for \fIforce
2763 \fBguest account (S)\fR
2764 This is a username which will be used for access
2765 to services which are specified as \fI guest ok\fR (see below). Whatever privileges this
2766 user has will be available to any client connecting to the guest service.
2767 Typically this user will exist in the password file, but will not
2768 have a valid login. The user account "ftp" is often a good choice
2769 for this parameter. If a username is specified in a given service,
2770 the specified username overrides this one.
2772 One some systems the default guest account "nobody" may not
2773 be able to print. Use another account in this case. You should test
2774 this by trying to log in as your guest user (perhaps by using the
2775 \fBsu -\fR command) and trying to print using the
2776 system print command such as \fBlpr(1)\fR or \fB lp(1)\fR.
2778 Default: \fBspecified at compile time, usually
2781 Example: \fBguest account = ftp\fR
2784 If this parameter is yes for
2785 a service, then no password is required to connect to the service.
2786 Privileges will be those of the \fI guest account\fR.
2788 See the section below on \fI security\fR for more information about this option.
2790 Default: \fBguest ok = no\fR
2792 \fBguest only (S)\fR
2793 If this parameter is yes for
2794 a service, then only guest connections to the service are permitted.
2795 This parameter will have no effect if \fIguest ok\fR is not set for the service.
2797 See the section below on \fI security\fR for more information about this option.
2799 Default: \fBguest only = no\fR
2801 \fBhide dot files (S)\fR
2802 This is a boolean parameter that controls whether
2803 files starting with a dot appear as hidden files.
2805 Default: \fBhide dot files = yes\fR
2808 This is a list of files or directories that are not
2809 visible but are accessible. The DOS 'hidden' attribute is applied
2810 to any files or directories that match.
2812 Each entry in the list must be separated by a '/',
2813 which allows spaces to be included in the entry. '*'
2814 and '?' can be used to specify multiple files or directories
2815 as in DOS wildcards.
2817 Each entry must be a Unix path, not a DOS path and must
2818 not include the Unix directory separator '/'.
2820 Note that the case sensitivity option is applicable
2823 Setting this parameter will affect the performance of Samba,
2824 as it will be forced to check all files and directories for a match
2825 as they are scanned.
2828 dot files\fR, \fI veto files\fR and \fIcase sensitive\fR.
2830 Default: \fBno file are hidden\fR
2832 Example: \fBhide files =
2833 /.*/DesktopFolderDB/TrashFor%m/resource.frk/\fR
2835 The above example is based on files that the Macintosh
2836 SMB client (DAVE) available from
2837 Thursby <URL:http://www.thursby.com> creates for internal use, and also still hides
2838 all files beginning with a dot.
2840 \fBhide local users(G)\fR
2841 This parameter toggles the hiding of local UNIX
2842 users (root, wheel, floppy, etc) from remote clients.
2844 Default: \fBhide local users = no\fR
2846 \fBhomedir map (G)\fR
2848 \fRis True, and \fBsmbd(8)\fRis also acting
2849 as a Win95/98 \fIlogon server\fR then this parameter
2850 specifies the NIS (or YP) map from which the server for the user's
2851 home directory should be extracted. At present, only the Sun
2852 auto.home map format is understood. The form of the map is:
2854 \fBusername server:/some/file/system\fR
2856 and the program will extract the servername from before
2857 the first ':'. There should probably be a better parsing system
2858 that copes with different map formats and also Amd (another
2861 \fBNOTE :\fRA working NIS client is required on
2862 the system for this option to work.
2864 See also \fInis homedir\fR
2865 , \fIdomain logons\fR
2868 Default: \fBhomedir map = <empty string>\fR
2870 Example: \fBhomedir map = amd.homedir\fR
2872 \fBhost msdfs (G)\fR
2873 This boolean parameter is only available
2874 if Samba has been configured and compiled with the \fB --with-msdfs\fR option. If set to yes,
2875 Samba will act as a Dfs server, and allow Dfs-aware clients
2876 to browse Dfs trees hosted on the server.
2878 See also the \fI msdfs root\fR share level parameter. For
2879 more information on setting up a Dfs tree on Samba,
2880 refer to msdfs_setup.html.
2882 Default: \fBhost msdfs = no\fR
2884 \fBhosts allow (S)\fR
2885 A synonym for this parameter is \fIallow
2888 This parameter is a comma, space, or tab delimited
2889 set of hosts which are permitted to access a service.
2891 If specified in the [global] section then it will
2892 apply to all services, regardless of whether the individual
2893 service has a different setting.
2895 You can specify the hosts by name or IP number. For
2896 example, you could restrict access to only the hosts on a
2897 Class C subnet with something like \fBallow hosts = 150.203.5.
2898 \fR\&. The full syntax of the list is described in the man
2899 page \fIhosts_access(5)\fR. Note that this man
2900 page may not be present on your system, so a brief description will
2903 Note that the localhost address 127.0.0.1 will always
2904 be allowed access unless specifically denied by a \fIhosts deny\fR option.
2906 You can also specify hosts by network/netmask pairs and
2907 by netgroup names if your system supports netgroups. The
2908 \fBEXCEPT\fR keyword can also be used to limit a
2909 wildcard list. The following examples may provide some help:
2911 Example 1: allow all IPs in 150.203.*.*; except one
2913 \fBhosts allow = 150.203. EXCEPT 150.203.6.66\fR
2915 Example 2: allow hosts that match the given network/netmask
2917 \fBhosts allow = 150.203.15.0/255.255.255.0\fR
2919 Example 3: allow a couple of hosts
2921 \fBhosts allow = lapland, arvidsjaur\fR
2923 Example 4: allow only hosts in NIS netgroup "foonet", but
2924 deny access from one particular host
2926 \fBhosts allow = @foonet\fR
2928 \fBhosts deny = pirate\fR
2930 Note that access still requires suitable user-level passwords.
2932 See \fBtestparm(1)\fR
2933 for a way of testing your host access to see if it does
2936 Default: \fBnone (i.e., all hosts permitted access)
2938 Example: \fBallow hosts = 150.203.5. myhost.mynet.edu.au
2940 \fBhosts deny (S)\fR
2941 The opposite of \fIhosts allow\fR
2942 - hosts listed here are \fBNOT\fR permitted access to
2943 services unless the specific services have their own lists to override
2944 this one. Where the lists conflict, the \fIallow\fR
2945 list takes precedence.
2947 Default: \fBnone (i.e., no hosts specifically excluded)
2949 Example: \fBhosts deny = 150.203.4. badhost.mynet.edu.au
2951 \fBhosts equiv (G)\fR
2952 If this global parameter is a non-null string,
2953 it specifies the name of a file to read for the names of hosts
2954 and users who will be allowed access without specifying a password.
2956 This is not be confused with \fIhosts allow\fR which is about hosts
2957 access to services and is more useful for guest services. \fI hosts equiv\fR may be useful for NT clients which will
2958 not supply passwords to samba.
2960 \fBNOTE :\fR The use of \fIhosts equiv
2961 \fRcan be a major security hole. This is because you are
2962 trusting the PC to supply the correct username. It is very easy to
2963 get a PC to supply a false username. I recommend that the
2964 \fIhosts equiv\fR option be only used if you really
2965 know what you are doing, or perhaps on a home network where you trust
2966 your spouse and kids. And only if you \fBreally\fR trust
2969 Default: \fBno host equivalences\fR
2971 Example: \fBhosts equiv = /etc/hosts.equiv\fR
2974 This allows you to include one config file
2975 inside another. The file is included literally, as though typed
2978 It takes the standard substitutions, except \fI%u
2979 \fR, \fI%P\fR and \fI%S\fR.
2981 Default: \fBno file included\fR
2983 Example: \fBinclude = /usr/local/samba/lib/admin_smb.conf
2985 \fBinherit permissions (S)\fR
2986 The permissions on new files and directories
2987 are normally governed by \fI create mask\fR, \fIdirectory mask\fR, \fIforce create mode\fR
2989 directory mode\fR but the boolean inherit
2990 permissions parameter overrides this.
2992 New directories inherit the mode of the parent directory,
2993 including bits such as setgid.
2995 New files inherit their read/write bits from the parent
2996 directory. Their execute bits continue to be determined by
2999 and \fImap system\fR
3002 Note that the setuid bit is \fBnever\fR set via
3003 inheritance (the code explicitly prohibits this).
3005 This can be particularly useful on large systems with
3006 many users, perhaps several thousand,to allow a single [homes]
3007 share to be used flexibly by each user.
3009 See also \fIcreate mask
3010 \fR, \fI directory mask\fR, \fIforce create mode\fR and \fIforce directory mode\fR
3013 Default: \fBinherit permissions = no\fR
3015 \fBinterfaces (G)\fR
3016 This option allows you to override the default
3017 network interfaces list that Samba will use for browsing, name
3018 registration and other NBT traffic. By default Samba will query
3019 the kernel for the list of all active interfaces and use any
3020 interfaces except 127.0.0.1 that are broadcast capable.
3022 The option takes a list of interface strings. Each string
3023 can be in any of the following forms:
3027 a network interface name (such as eth0).
3028 This may include shell-like wildcards so eth* will match
3029 any interface starting with the substring "eth"
3032 an IP address. In this case the netmask is
3033 determined from the list of interfaces obtained from the
3040 a broadcast/mask pair.
3043 The "mask" parameters can either be a bit length (such
3044 as 24 for a C class network) or a full netmask in dotted
3048 The "IP" parameters above can either be a full dotted
3049 decimal IP address or a hostname which will be looked up via
3050 the OS's normal hostname resolution mechanisms.
3053 For example, the following line:
3056 \fBinterfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0
3059 would configure three network interfaces corresponding
3060 to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10.
3061 The netmasks of the latter two interfaces would be set to 255.255.255.0.
3068 Default: \fBall active interfaces except 127.0.0.1
3069 that are broadcast capable\fR
3072 \fBinvalid users (S)\fR
3073 This is a list of users that should not be allowed
3074 to login to this service. This is really a \fBparanoid\fR
3075 check to absolutely ensure an improper setting does not breach
3078 A name starting with a '@' is interpreted as an NIS
3079 netgroup first (if your system supports NIS), and then as a UNIX
3080 group if the name was not found in the NIS netgroup database.
3082 A name starting with '+' is interpreted only
3083 by looking in the UNIX group database. A name starting with
3084 \&'&' is interpreted only by looking in the NIS netgroup database
3085 (this requires NIS to be working on your system). The characters
3086 \&'+' and '&' may be used at the start of the name in either order
3087 so the value \fI+&group\fR means check the
3088 UNIX group database, followed by the NIS netgroup database, and
3089 the value \fI&+group"\fR means check the NIS
3090 netgroup database, followed by the UNIX group database (the
3091 same as the '@' prefix).
3093 The current servicename is substituted for \fI%S\fR.
3094 This is useful in the [homes] section.
3096 See also \fIvalid users
3099 Default: \fBno invalid users\fR
3101 Example: \fBinvalid users = root fred admin @wheel
3104 The value of the parameter (an integer) represents
3105 the number of seconds between \fIkeepalive\fR
3106 packets. If this parameter is zero, no keepalive packets will be
3107 sent. Keepalive packets, if sent, allow the server to tell whether
3108 a client is still present and responding.
3110 Keepalives should, in general, not be needed if the socket
3111 being used has the SO_KEEPALIVE attribute set on it (see \fIsocket options\fR).
3112 Basically you should only use this option if you strike difficulties.
3114 Default: \fBkeepalive = 300\fR
3116 Example: \fBkeepalive = 600\fR
3118 \fBkernel oplocks (G)\fR
3119 For UNIXes that support kernel based \fIoplocks\fR
3120 (currently only IRIX and the Linux 2.4 kernel), this parameter
3121 allows the use of them to be turned on or off.
3123 Kernel oplocks support allows Samba \fIoplocks
3124 \fRto be broken whenever a local UNIX process or NFS operation
3125 accesses a file that \fBsmbd(8)\fR
3126 has oplocked. This allows complete data consistency between
3127 SMB/CIFS, NFS and local file access (and is a \fBvery\fR
3130 This parameter defaults to on on systems
3131 that have the support, and off on systems that
3132 don't. You should never need to touch this parameter.
3134 See also the \fIoplocks\fR
3135 and \fIlevel2 oplocks
3138 Default: \fBkernel oplocks = yes\fR
3140 \fBlanman auth (G)\fR
3141 This parameter determines whether or not smbd will
3142 attempt to authentication users using the LANMAN password hash.
3143 If disabled, only clients which support NT password hashes (e.g. Windows
3144 NT/2000 clients, smbclient, etc... but not Windows 95/98 or the MS DOS
3145 network client) will be able to connect to the Samba host.
3147 Default : \fBlanman auth = yes\fR
3149 \fBlevel2 oplocks (S)\fR
3150 This parameter controls whether Samba supports
3151 level2 (read-only) oplocks on a share.
3153 Level2, or read-only oplocks allow Windows NT clients
3154 that have an oplock on a file to downgrade from a read-write oplock
3155 to a read-only oplock once a second client opens the file (instead
3156 of releasing all oplocks on a second open, as in traditional,
3157 exclusive oplocks). This allows all openers of the file that
3158 support level2 oplocks to cache the file for read-ahead only (ie.
3159 they may not cache writes or lock requests) and increases performance
3160 for many accesses of files that are not commonly written (such as
3161 application .EXE files).
3163 Once one of the clients which have a read-only oplock
3164 writes to the file all clients are notified (no reply is needed
3165 or waited for) and told to break their oplocks to "none" and
3166 delete any read-ahead caches.
3168 It is recommended that this parameter be turned on
3169 to speed access to shared executables.
3171 For more discussions on level2 oplocks see the CIFS spec.
3173 Currently, if \fIkernel
3174 oplocks\fR are supported then level2 oplocks are
3175 not granted (even if this parameter is set to yes).
3176 Note also, the \fIoplocks\fR
3177 parameter must be set to "true" on this share in order for
3178 this parameter to have any effect.
3180 See also the \fIoplocks\fR
3181 and \fIkernel oplocks\fR
3184 Default: \fBlevel2 oplocks = yes\fR
3186 \fBlm announce (G)\fR
3187 This parameter determines if \fBnmbd(8)\fRwill produce Lanman announce
3188 broadcasts that are needed by OS/2 clients in order for them to see
3189 the Samba server in their browse list. This parameter can have three
3190 values, true, false, or
3191 auto. The default is auto.
3192 If set to false Samba will never produce these
3193 broadcasts. If set to true Samba will produce
3194 Lanman announce broadcasts at a frequency set by the parameter
3195 \fIlm interval\fR. If set to auto
3196 Samba will not send Lanman announce broadcasts by default but will
3197 listen for them. If it hears such a broadcast on the wire it will
3198 then start sending them at a frequency set by the parameter
3201 See also \fIlm interval
3204 Default: \fBlm announce = auto\fR
3206 Example: \fBlm announce = yes\fR
3208 \fBlm interval (G)\fR
3209 If Samba is set to produce Lanman announce
3210 broadcasts needed by OS/2 clients (see the \fIlm announce\fR parameter) then this
3211 parameter defines the frequency in seconds with which they will be
3212 made. If this is set to zero then no Lanman announcements will be
3213 made despite the setting of the \fIlm announce\fR
3219 Default: \fBlm interval = 60\fR
3221 Example: \fBlm interval = 120\fR
3223 \fBload printers (G)\fR
3224 A boolean variable that controls whether all
3225 printers in the printcap will be loaded for browsing by default.
3226 See the printers section for
3229 Default: \fBload printers = yes\fR
3231 \fBlocal master (G)\fR
3232 This option allows \fB nmbd(8)\fRto try and become a local master browser
3233 on a subnet. If set to False then \fB nmbd\fR will not attempt to become a local master browser
3234 on a subnet and will also lose in all browsing elections. By
3235 default this value is set to true. Setting this value to true doesn't
3236 mean that Samba will \fBbecome\fR the local master
3237 browser on a subnet, just that \fBnmbd\fR will \fB participate\fR in elections for local master browser.
3239 Setting this value to False will cause \fBnmbd\fR
3240 \fBnever\fR to become a local master browser.
3242 Default: \fBlocal master = yes\fR
3245 Synonym for \fI lock directory\fR.
3247 \fBlock directory (G)\fR
3248 This option specifies the directory where lock
3249 files will be placed. The lock files are used to implement the
3250 \fImax connections\fR
3253 Default: \fBlock directory = ${prefix}/var/locks\fR
3255 Example: \fBlock directory = /var/run/samba/locks\fR
3258 This controls whether or not locking will be
3259 performed by the server in response to lock requests from the
3262 If \fBlocking = no\fR, all lock and unlock
3263 requests will appear to succeed and all lock queries will report
3264 that the file in question is available for locking.
3266 If \fBlocking = yes\fR, real locking will be performed
3269 This option \fBmay\fR be useful for read-only
3270 filesystems which \fBmay\fR not need locking (such as
3271 cdrom drives), although setting this parameter of no
3272 is not really recommended even in this case.
3274 Be careful about disabling locking either globally or in a
3275 specific service, as lack of locking may result in data corruption.
3276 You should never need to set this parameter.
3278 Default: \fBlocking = yes\fR
3281 This option allows you to override the name
3282 of the Samba log file (also known as the debug file).
3284 This option takes the standard substitutions, allowing
3285 you to have separate log files for each user or machine.
3287 Example: \fBlog file = /usr/local/samba/var/log.%m
3290 Synonym for \fI debug level\fR.
3292 \fBlogon drive (G)\fR
3293 This parameter specifies the local path to
3294 which the home directory will be connected (see \fIlogon home\fR)
3295 and is only used by NT Workstations.
3297 Note that this option is only useful if Samba is set up as a
3300 Default: \fBlogon drive = z:\fR
3302 Example: \fBlogon drive = h:\fR
3304 \fBlogon home (G)\fR
3305 This parameter specifies the home directory
3306 location when a Win95/98 or NT Workstation logs into a Samba PDC.
3309 C:\\> \fBNET USE H: /HOME\fR
3311 from a command prompt, for example.
3313 This option takes the standard substitutions, allowing
3314 you to have separate logon scripts for each user or machine.
3316 This parameter can be used with Win9X workstations to ensure
3317 that roaming profiles are stored in a subdirectory of the user's
3318 home directory. This is done in the following way:
3320 \fBlogon home = \\\\%N\\%U\\profile\fR
3322 This tells Samba to return the above string, with
3323 substitutions made when a client requests the info, generally
3324 in a NetUserGetInfo request. Win9X clients truncate the info to
3325 \\\\server\\share when a user does \fBnet use /home"\fR
3326 but use the whole string when dealing with profiles.
3328 Note that in prior versions of Samba, the \fIlogon path\fR was returned rather than
3329 \fIlogon home\fR. This broke \fBnet use
3330 /home\fR but allowed profiles outside the home directory.
3331 The current implementation is correct, and can be used for
3332 profiles if you use the above trick.
3334 This option is only useful if Samba is set up as a logon
3337 Default: \fBlogon home = "\\\\%N\\%U"\fR
3339 Example: \fBlogon home = "\\\\remote_smb_server\\%U"\fR
3341 \fBlogon path (G)\fR
3342 This parameter specifies the home directory
3343 where roaming profiles (NTuser.dat etc files for Windows NT) are
3344 stored. Contrary to previous versions of these manual pages, it has
3345 nothing to do with Win 9X roaming profiles. To find out how to
3346 handle roaming profiles for Win 9X system, see the \fIlogon home\fR parameter.
3348 This option takes the standard substitutions, allowing you
3349 to have separate logon scripts for each user or machine. It also
3350 specifies the directory from which the "Application Data",
3351 (\fIdesktop\fR, \fIstart menu\fR,
3352 \fInetwork neighborhood\fR, \fIprograms\fR
3353 and other folders, and their contents, are loaded and displayed on
3354 your Windows NT client.
3356 The share and the path must be readable by the user for
3357 the preferences and directories to be loaded onto the Windows NT
3358 client. The share must be writeable when the logs in for the first
3359 time, in order that the Windows NT client can create the NTuser.dat
3360 and other directories.
3362 Thereafter, the directories and any of the contents can,
3363 if required, be made read-only. It is not advisable that the
3364 NTuser.dat file be made read-only - rename it to NTuser.man to
3365 achieve the desired effect (a \fBMAN\fRdatory
3368 Windows clients can sometimes maintain a connection to
3369 the [homes] share, even though there is no user logged in.
3370 Therefore, it is vital that the logon path does not include a
3371 reference to the homes share (i.e. setting this parameter to
3372 \\%N\\%U\\profile_path will cause problems).
3374 This option takes the standard substitutions, allowing
3375 you to have separate logon scripts for each user or machine.
3377 Note that this option is only useful if Samba is set up
3380 Default: \fBlogon path = \\\\%N\\%U\\profile\fR
3382 Example: \fBlogon path = \\\\PROFILESERVER\\PROFILE\\%U\fR
3384 \fBlogon script (G)\fR
3385 This parameter specifies the batch file (.bat) or
3386 NT command file (.cmd) to be downloaded and run on a machine when
3387 a user successfully logs in. The file must contain the DOS
3388 style cr/lf line endings. Using a DOS-style editor to create the
3389 file is recommended.
3391 The script must be a relative path to the [netlogon]
3392 service. If the [netlogon] service specifies a \fIpath\fR of \fI/usr/local/samba/netlogon
3393 \fR, and \fBlogon script = STARTUP.BAT\fR, then
3394 the file that will be downloaded is:
3396 \fI/usr/local/samba/netlogon/STARTUP.BAT\fR
3398 The contents of the batch file is entirely your choice. A
3399 suggested command would be to add \fBNET TIME \\\\SERVER /SET
3400 /YES\fR, to force every machine to synchronize clocks with
3401 the same time server. Another use would be to add \fBNET USE
3402 U: \\\\SERVER\\UTILS\fR for commonly used utilities, or \fB NET USE Q: \\\\SERVER\\ISO9001_QA\fR for example.
3404 Note that it is particularly important not to allow write
3405 access to the [netlogon] share, or to grant users write permission
3406 on the batch files in a secure environment, as this would allow
3407 the batch files to be arbitrarily modified and security to be
3410 This option takes the standard substitutions, allowing you
3411 to have separate logon scripts for each user or machine.
3413 This option is only useful if Samba is set up as a logon
3416 Default: \fBno logon script defined\fR
3418 Example: \fBlogon script = scripts\\%U.bat\fR
3420 \fBlppause command (S)\fR
3421 This parameter specifies the command to be
3422 executed on the server host in order to stop printing or spooling
3423 a specific print job.
3425 This command should be a program or script which takes
3426 a printer name and job number to pause the print job. One way
3427 of implementing this is by using job priorities, where jobs
3428 having a too low priority won't be sent to the printer.
3430 If a \fI%p\fR is given then the printername
3431 is put in its place. A \fI%j\fR is replaced with
3432 the job number (an integer). On HPUX (see \fIprinting=hpux
3433 \fR), if the \fI-p%p\fR option is added
3434 to the lpq command, the job will show up with the correct status, i.e.
3435 if the job priority is lower than the set fence priority it will
3436 have the PAUSED status, whereas if the priority is equal or higher it
3437 will have the SPOOLED or PRINTING status.
3439 Note that it is good practice to include the absolute path
3440 in the lppause command as the PATH may not be available to the server.
3442 See also the \fIprinting
3445 Default: Currently no default value is given to
3446 this string, unless the value of the \fIprinting\fR
3447 parameter is SYSV, in which case the default is :
3449 \fBlp -i %p-%j -H hold\fR
3451 or if the value of the \fIprinting\fR parameter
3452 is SOFTQ, then the default is:
3454 \fBqstat -s -j%j -h\fR
3456 Example for HPUX: \fBlppause command = /usr/bin/lpalt
3459 \fBlpq cache time (G)\fR
3460 This controls how long lpq info will be cached
3461 for to prevent the \fBlpq\fR command being called too
3462 often. A separate cache is kept for each variation of the \fB lpq\fR command used by the system, so if you use different
3463 \fBlpq\fR commands for different users then they won't
3464 share cache information.
3466 The cache files are stored in \fI/tmp/lpq.xxxx\fR
3467 where xxxx is a hash of the \fBlpq\fR command in use.
3469 The default is 10 seconds, meaning that the cached results
3470 of a previous identical \fBlpq\fR command will be used
3471 if the cached data is less than 10 seconds old. A large value may
3472 be advisable if your \fBlpq\fR command is very slow.
3474 A value of 0 will disable caching completely.
3476 See also the \fIprinting
3479 Default: \fBlpq cache time = 10\fR
3481 Example: \fBlpq cache time = 30\fR
3483 \fBlpq command (S)\fR
3484 This parameter specifies the command to be
3485 executed on the server host in order to obtain \fBlpq
3486 \fR-style printer status information.
3488 This command should be a program or script which
3489 takes a printer name as its only parameter and outputs printer
3492 Currently eight styles of printer status information
3493 are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX and SOFTQ.
3494 This covers most UNIX systems. You control which type is expected
3495 using the \fIprinting =\fR option.
3497 Some clients (notably Windows for Workgroups) may not
3498 correctly send the connection number for the printer they are
3499 requesting status information about. To get around this, the
3500 server reports on the first printer service connected to by the
3501 client. This only happens if the connection number sent is invalid.
3503 If a \fI%p\fR is given then the printername
3504 is put in its place. Otherwise it is placed at the end of the
3507 Note that it is good practice to include the absolute path
3508 in the \fIlpq command\fR as the \fB$PATH
3509 \fRmay not be available to the server.
3511 See also the \fIprinting
3514 Default: \fBdepends on the setting of \fI printing\fB\fR
3516 Example: \fBlpq command = /usr/bin/lpq -P%p\fR
3518 \fBlpresume command (S)\fR
3519 This parameter specifies the command to be
3520 executed on the server host in order to restart or continue
3521 printing or spooling a specific print job.
3523 This command should be a program or script which takes
3524 a printer name and job number to resume the print job. See
3525 also the \fIlppause command
3528 If a \fI%p\fR is given then the printername
3529 is put in its place. A \fI%j\fR is replaced with
3530 the job number (an integer).
3532 Note that it is good practice to include the absolute path
3533 in the \fIlpresume command\fR as the PATH may not
3534 be available to the server.
3536 See also the \fIprinting
3539 Default: Currently no default value is given
3540 to this string, unless the value of the \fIprinting\fR
3541 parameter is SYSV, in which case the default is :
3543 \fBlp -i %p-%j -H resume\fR
3545 or if the value of the \fIprinting\fR parameter
3546 is SOFTQ, then the default is:
3548 \fBqstat -s -j%j -r\fR
3550 Example for HPUX: \fBlpresume command = /usr/bin/lpalt
3553 \fBlprm command (S)\fR
3554 This parameter specifies the command to be
3555 executed on the server host in order to delete a print job.
3557 This command should be a program or script which takes
3558 a printer name and job number, and deletes the print job.
3560 If a \fI%p\fR is given then the printername
3561 is put in its place. A \fI%j\fR is replaced with
3562 the job number (an integer).
3564 Note that it is good practice to include the absolute
3565 path in the \fIlprm command\fR as the PATH may not be
3566 available to the server.
3568 See also the \fIprinting
3571 Default: \fBdepends on the setting of \fIprinting
3573 Example 1: \fBlprm command = /usr/bin/lprm -P%p %j
3575 Example 2: \fBlprm command = /usr/bin/cancel %p-%j
3577 \fBmachine password timeout (G)\fR
3578 If a Samba server is a member of an Windows
3579 NT Domain (see the security=domain)
3580 parameter) then periodically a running smbd(8)process will try and change the MACHINE ACCOUNT
3581 PASSWORD stored in the TDB called \fIprivate/secrets.tdb
3582 \fR\&. This parameter specifies how often this password
3583 will be changed, in seconds. The default is one week (expressed in
3584 seconds), the same as a Windows NT Domain member server.
3586 See also \fBsmbpasswd(8)
3587 \fR, and the security=domain) parameter.
3589 Default: \fBmachine password timeout = 604800\fR
3591 \fBmagic output (S)\fR
3592 This parameter specifies the name of a file
3593 which will contain output created by a magic script (see the
3597 Warning: If two clients use the same \fImagic script
3598 \fRin the same directory the output file content
3601 Default: \fBmagic output = <magic script name>.out
3603 Example: \fBmagic output = myfile.txt\fR
3605 \fBmagic script (S)\fR
3606 This parameter specifies the name of a file which,
3607 if opened, will be executed by the server when the file is closed.
3608 This allows a UNIX script to be sent to the Samba host and
3609 executed on behalf of the connected user.
3611 Scripts executed in this way will be deleted upon
3612 completion assuming that the user has the appripriate level
3613 of priviledge and the ile permissions allow the deletion.
3615 If the script generates output, output will be sent to
3616 the file specified by the \fI magic output\fR parameter (see above).
3618 Note that some shells are unable to interpret scripts
3619 containing CR/LF instead of CR as
3620 the end-of-line marker. Magic scripts must be executable
3621 \fBas is\fR on the host, which for some hosts and
3622 some shells will require filtering at the DOS end.
3624 Magic scripts are \fBEXPERIMENTAL\fR and
3625 should \fBNOT\fR be relied upon.
3627 Default: \fBNone. Magic scripts disabled.\fR
3629 Example: \fBmagic script = user.csh\fR
3631 \fBmangle case (S)\fR
3632 See the section on NAME MANGLING
3634 Default: \fBmangle case = no\fR
3636 \fBmangled map (S)\fR
3637 This is for those who want to directly map UNIX
3638 file names which can not be represented on Windows/DOS. The mangling
3639 of names is not always what is needed. In particular you may have
3640 documents with file extensions that differ between DOS and UNIX.
3641 For example, under UNIX it is common to use \fI.html\fR
3642 for HTML files, whereas under Windows/DOS \fI.htm\fR
3643 is more commonly used.
3645 So to map \fIhtml\fR to \fIhtm\fR
3648 \fBmangled map = (*.html *.htm)\fR
3650 One very useful case is to remove the annoying \fI;1
3651 \fRoff the ends of filenames on some CDROMS (only visible
3652 under some UNIXes). To do this use a map of (*;1 *;).
3654 Default: \fBno mangled map\fR
3656 Example: \fBmangled map = (*;1 *;)\fR
3658 \fBmangled names (S)\fR
3659 This controls whether non-DOS names under UNIX
3660 should be mapped to DOS-compatible names ("mangled") and made visible,
3661 or whether non-DOS names should simply be ignored.
3663 See the section on NAME MANGLING for details on how to control the mangling process.
3665 If mangling is used then the mangling algorithm is as follows:
3669 The first (up to) five alphanumeric characters
3670 before the rightmost dot of the filename are preserved, forced
3671 to upper case, and appear as the first (up to) five characters
3672 of the mangled name.
3675 A tilde "~" is appended to the first part of the mangled
3676 name, followed by a two-character unique sequence, based on the
3677 original root name (i.e., the original filename minus its final
3678 extension). The final extension is included in the hash calculation
3679 only if it contains any upper case characters or is longer than three
3682 Note that the character to use may be specified using
3683 the \fImangling char\fR
3684 option, if you don't like '~'.
3687 The first three alphanumeric characters of the final
3688 extension are preserved, forced to upper case and appear as the
3689 extension of the mangled name. The final extension is defined as that
3690 part of the original filename after the rightmost dot. If there are no
3691 dots in the filename, the mangled name will have no extension (except
3692 in the case of "hidden files" - see below).
3695 Files whose UNIX name begins with a dot will be
3696 presented as DOS hidden files. The mangled name will be created as
3697 for other filenames, but with the leading dot removed and "___" as
3698 its extension regardless of actual original extension (that's three
3702 The two-digit hash value consists of upper case
3703 alphanumeric characters.
3706 This algorithm can cause name collisions only if files
3707 in a directory share the same first five alphanumeric characters.
3708 The probability of such a clash is 1/1300.
3711 The name mangling (if enabled) allows a file to be
3712 copied between UNIX directories from Windows/DOS while retaining
3713 the long UNIX filename. UNIX files can be renamed to a new extension
3714 from Windows/DOS and will retain the same basename. Mangled names
3715 do not change between sessions.
3718 Default: \fBmangled names = yes\fR
3721 \fBmangled stack (G)\fR
3722 This parameter controls the number of mangled names
3723 that should be cached in the Samba server smbd(8).
3725 This stack is a list of recently mangled base names
3726 (extensions are only maintained if they are longer than 3 characters
3727 or contains upper case characters).
3729 The larger this value, the more likely it is that mangled
3730 names can be successfully converted to correct long UNIX names.
3731 However, large stack sizes will slow most directory access. Smaller
3732 stacks save memory in the server (each stack element costs 256 bytes).
3734 It is not possible to absolutely guarantee correct long
3735 file names, so be prepared for some surprises!
3737 Default: \fBmangled stack = 50\fR
3739 Example: \fBmangled stack = 100\fR
3741 \fBmangling char (S)\fR
3742 This controls what character is used as
3743 the \fBmagic\fR character in name mangling. The default is a '~'
3744 but this may interfere with some software. Use this option to set
3745 it to whatever you prefer.
3747 Default: \fBmangling char = ~\fR
3749 Example: \fBmangling char = ^\fR
3751 \fBmap archive (S)\fR
3752 This controls whether the DOS archive attribute
3753 should be mapped to the UNIX owner execute bit. The DOS archive bit
3754 is set when a file has been modified since its last backup. One
3755 motivation for this option it to keep Samba/your PC from making
3756 any file it touches from becoming executable under UNIX. This can
3757 be quite annoying for shared source code, documents, etc...
3759 Note that this requires the \fIcreate mask\fR
3760 parameter to be set such that owner execute bit is not masked out
3761 (i.e. it must include 100). See the parameter \fIcreate mask\fR for details.
3763 Default: \fBmap archive = yes\fR
3765 \fBmap hidden (S)\fR
3766 This controls whether DOS style hidden files
3767 should be mapped to the UNIX world execute bit.
3769 Note that this requires the \fIcreate mask\fR
3770 to be set such that the world execute bit is not masked out (i.e.
3771 it must include 001). See the parameter \fIcreate mask\fR for details.
3773 Default: \fBmap hidden = no\fR
3775 \fBmap system (S)\fR
3776 This controls whether DOS style system files
3777 should be mapped to the UNIX group execute bit.
3779 Note that this requires the \fIcreate mask\fR
3780 to be set such that the group execute bit is not masked out (i.e.
3781 it must include 010). See the parameter \fIcreate mask\fR for details.
3783 Default: \fBmap system = no\fR
3785 \fBmap to guest (G)\fR
3786 This parameter is only useful in security modes other than \fIsecurity=share\fR
3787 - i.e. user, server,
3790 This parameter can take three different values, which tell
3791 smbd(8)what to do with user
3792 login requests that don't match a valid UNIX user in some way.
3794 The three settings are :
3798 Never - Means user login
3799 requests with an invalid password are rejected. This is the
3803 Bad User - Means user
3804 logins with an invalid password are rejected, unless the username
3805 does not exist, in which case it is treated as a guest login and
3806 mapped into the \fI guest account\fR.
3809 Bad Password - Means user logins
3810 with an invalid password are treated as a guest login and mapped
3811 into the guest account. Note that
3812 this can cause problems as it means that any user incorrectly typing
3813 their password will be silently logged on as "guest" - and
3814 will not know the reason they cannot access files they think
3815 they should - there will have been no message given to them
3816 that they got their password wrong. Helpdesk services will
3817 \fBhate\fR you if you set the \fImap to
3818 guest\fR parameter this way :-).
3821 Note that this parameter is needed to set up "Guest"
3822 share services when using \fIsecurity\fR modes other than
3823 share. This is because in these modes the name of the resource being
3824 requested is \fBnot\fR sent to the server until after
3825 the server has successfully authenticated the client so the server
3826 cannot make authentication decisions at the correct time (connection
3827 to the share) for "Guest" shares.
3830 For people familiar with the older Samba releases, this
3831 parameter maps to the old compile-time setting of the GUEST_SESSSETUP value in local.h.
3834 Default: \fBmap to guest = Never\fR
3837 Example: \fBmap to guest = Bad User\fR
3840 \fBmax connections (S)\fR
3841 This option allows the number of simultaneous
3842 connections to a service to be limited. If \fImax connections
3843 \fRis greater than 0 then connections will be refused if
3844 this number of connections to the service are already open. A value
3845 of zero mean an unlimited number of connections may be made.
3847 Record lock files are used to implement this feature. The
3848 lock files will be stored in the directory specified by the \fIlock directory\fR
3851 Default: \fBmax connections = 0\fR
3853 Example: \fBmax connections = 10\fR
3855 \fBmax disk size (G)\fR
3856 This option allows you to put an upper limit
3857 on the apparent size of disks. If you set this option to 100
3858 then all shares will appear to be not larger than 100 MB in
3861 Note that this option does not limit the amount of
3862 data you can put on the disk. In the above case you could still
3863 store much more than 100 MB on the disk, but if a client ever asks
3864 for the amount of free disk space or the total disk size then the
3865 result will be bounded by the amount specified in \fImax
3868 This option is primarily useful to work around bugs
3869 in some pieces of software that can't handle very large disks,
3870 particularly disks over 1GB in size.
3872 A \fImax disk size\fR of 0 means no limit.
3874 Default: \fBmax disk size = 0\fR
3876 Example: \fBmax disk size = 1000\fR
3878 \fBmax log size (G)\fR
3879 This option (an integer in kilobytes) specifies
3880 the max size the log file should grow to. Samba periodically checks
3881 the size and if it is exceeded it will rename the file, adding
3882 a \fI.old\fR extension.
3884 A size of 0 means no limit.
3886 Default: \fBmax log size = 5000\fR
3888 Example: \fBmax log size = 1000\fR
3891 This option controls the maximum number of
3892 outstanding simultaneous SMB operations that samba tells the client
3893 it will allow. You should never need to set this parameter.
3895 Default: \fBmax mux = 50\fR
3897 \fBmax open files (G)\fR
3898 This parameter limits the maximum number of
3899 open files that one smbd(8)file
3900 serving process may have open for a client at any one time. The
3901 default for this parameter is set very high (10,000) as Samba uses
3902 only one bit per unopened file.
3904 The limit of the number of open files is usually set
3905 by the UNIX per-process file descriptor limit rather than
3906 this parameter so you should never need to touch this parameter.
3908 Default: \fBmax open files = 10000\fR
3910 \fBmax print jobs (S)\fR
3911 This parameter limits the maximum number of
3912 jobs allowable in a Samba printer queue at any given moment.
3913 If this number is exceeded, \fB smbd(8)\fRwill remote "Out of Space" to the client.
3917 Default: \fBmax print jobs = 1000\fR
3919 Example: \fBmax print jobs = 5000\fR
3921 \fBmax protocol (G)\fR
3922 The value of the parameter (a string) is the highest
3923 protocol level that will be supported by the server.
3925 Possible values are :
3929 CORE: Earliest version. No
3930 concept of user names.
3933 COREPLUS: Slight improvements on
3934 CORE for efficiency.
3937 LANMAN1: First \fB modern\fR version of the protocol. Long filename
3941 LANMAN2: Updates to Lanman1 protocol.
3944 NT1: Current up to date version of
3945 the protocol. Used by Windows NT. Known as CIFS.
3948 Normally this option should not be set as the automatic
3949 negotiation phase in the SMB protocol takes care of choosing
3950 the appropriate protocol.
3957 Default: \fBmax protocol = NT1\fR
3960 Example: \fBmax protocol = LANMAN1\fR
3963 \fBmax smbd processes (G)\fR
3964 This parameter limits the maximum number of
3965 \fBsmbd(8)\fRprocesses concurrently running on a system and is intended
3966 as a stop gap to prevent degrading service to clients in the event
3967 that the server has insufficient resources to handle more than this
3968 number of connections. Remember that under normal operating
3969 conditions, each user will have an smbd associated with him or her
3970 to handle connections to all shares from a given host.
3972 Default: \fBmax smbd processes = 0\fR ## no limit
3974 Example: \fBmax smbd processes = 1000\fR
3977 This option tells nmbd(8)what the default 'time to live' of NetBIOS names should be (in seconds)
3978 when \fBnmbd\fR is requesting a name using either a
3979 broadcast packet or from a WINS server. You should never need to
3980 change this parameter. The default is 3 days.
3982 Default: \fBmax ttl = 259200\fR
3984 \fBmax wins ttl (G)\fR
3985 This option tells nmbd(8)
3986 when acting as a WINS server ( \fIwins support=yes\fR) what the maximum
3987 \&'time to live' of NetBIOS names that \fBnmbd\fR
3988 will grant will be (in seconds). You should never need to change this
3989 parameter. The default is 6 days (518400 seconds).
3992 wins ttl"\fR parameter.
3994 Default: \fBmax wins ttl = 518400\fR
3997 This option controls the maximum packet size
3998 that will be negotiated by Samba. The default is 65535, which
3999 is the maximum. In some cases you may find you get better performance
4000 with a smaller value. A value below 2048 is likely to cause problems.
4002 Default: \fBmax xmit = 65535\fR
4004 Example: \fBmax xmit = 8192\fR
4006 \fBmessage command (G)\fR
4007 This specifies what command to run when the
4008 server receives a WinPopup style message.
4010 This would normally be a command that would
4011 deliver the message somehow. How this is to be done is
4012 up to your imagination.
4016 \fBmessage command = csh -c 'xedit %s;rm %s' &\fR
4018 This delivers the message using \fBxedit\fR, then
4019 removes it afterwards. \fBNOTE THAT IT IS VERY IMPORTANT
4020 THAT THIS COMMAND RETURN IMMEDIATELY\fR. That's why I
4021 have the '&' on the end. If it doesn't return immediately then
4022 your PCs may freeze when sending messages (they should recover
4023 after 30secs, hopefully).
4025 All messages are delivered as the global guest user.
4026 The command takes the standard substitutions, although \fI %u\fR won't work (\fI%U\fR may be better
4029 Apart from the standard substitutions, some additional
4030 ones apply. In particular:
4034 \fI%s\fR = the filename containing
4038 \fI%t\fR = the destination that
4039 the message was sent to (probably the server name).
4042 \fI%f\fR = who the message
4046 You could make this command send mail, or whatever else
4047 takes your fancy. Please let us know of any really interesting
4051 Here's a way of sending the messages as mail to root:
4054 \fBmessage command = /bin/mail -s 'message from %f on
4055 %m' root < %s; rm %s\fR
4058 If you don't have a message command then the message
4059 won't be delivered and Samba will tell the sender there was
4060 an error. Unfortunately WfWg totally ignores the error code
4061 and carries on regardless, saying that the message was delivered.
4064 If you want to silently delete it then try:
4067 \fBmessage command = rm %s\fR
4070 Default: \fBno message command\fR
4073 Example: \fBmessage command = csh -c 'xedit %s;
4077 \fBmin passwd length (G)\fR
4078 Synonym for \fImin password length\fR.
4080 \fBmin password length (G)\fR
4081 This option sets the minimum length in characters
4082 of a plaintext password that \fBsmbd\fR will accept when performing
4083 UNIX password changing.
4086 password sync\fR, \fIpasswd program\fR and \fIpasswd chat debug\fR
4089 Default: \fBmin password length = 5\fR
4091 \fBmin print space (S)\fR
4092 This sets the minimum amount of free disk
4093 space that must be available before a user will be able to spool
4094 a print job. It is specified in kilobytes. The default is 0, which
4095 means a user can always spool a print job.
4097 See also the \fIprinting
4100 Default: \fBmin print space = 0\fR
4102 Example: \fBmin print space = 2000\fR
4104 \fBmin protocol (G)\fR
4105 The value of the parameter (a string) is the
4106 lowest SMB protocol dialect than Samba will support. Please refer
4107 to the \fImax protocol\fR
4108 parameter for a list of valid protocol names and a brief description
4109 of each. You may also wish to refer to the C source code in
4110 \fIsource/smbd/negprot.c\fR for a listing of known protocol
4111 dialects supported by clients.
4113 If you are viewing this parameter as a security measure, you should
4114 also refer to the \fIlanman
4115 auth\fR parameter. Otherwise, you should never need
4116 to change this parameter.
4118 Default : \fBmin protocol = CORE\fR
4120 Example : \fBmin protocol = NT1\fR # disable DOS
4123 \fBmin wins ttl (G)\fR
4124 This option tells nmbd(8)when acting as a WINS server (\fI wins support = yes\fR) what the minimum 'time to live'
4125 of NetBIOS names that \fBnmbd\fR will grant will be (in
4126 seconds). You should never need to change this parameter. The default
4127 is 6 hours (21600 seconds).
4129 Default: \fBmin wins ttl = 21600\fR
4131 \fBmsdfs root (S)\fR
4132 This boolean parameter is only available if
4133 Samba is configured and compiled with the \fB --with-msdfs\fR option. If set to yes>,
4134 Samba treats the share as a Dfs root and allows clients to browse
4135 the distributed file system tree rooted at the share directory.
4136 Dfs links are specified in the share directory by symbolic
4137 links of the form \fImsdfs:serverA\\shareA,serverB\\shareB
4138 \fRand so on. For more information on setting up a Dfs tree
4139 on Samba, refer to msdfs_setup.html
4142 See also \fIhost msdfs
4144 Default: \fBmsdfs root = no\fR
4146 \fBname resolve order (G)\fR
4147 This option is used by the programs in the Samba
4148 suite to determine what naming services to use and in what order
4149 to resolve host names to IP addresses. The option takes a space
4150 separated string of name resolution options.
4152 The options are :"lmhosts", "host", "wins" and "bcast". They
4153 cause names to be resolved as follows :
4157 lmhosts : Lookup an IP
4158 address in the Samba lmhosts file. If the line in lmhosts has
4159 no name type attached to the NetBIOS name (see the lmhosts(5)for details) then
4160 any name type matches for lookup.
4163 host : Do a standard host
4164 name to IP address resolution, using the system \fI/etc/hosts
4165 \fR, NIS, or DNS lookups. This method of name resolution
4166 is operating system depended for instance on IRIX or Solaris this
4167 may be controlled by the \fI/etc/nsswitch.conf\fR
4168 file). Note that this method is only used if the NetBIOS name
4169 type being queried is the 0x20 (server) name type, otherwise
4173 wins : Query a name with
4174 the IP address listed in the \fI wins server\fR parameter. If no WINS server has
4175 been specified this method will be ignored.
4178 bcast : Do a broadcast on
4179 each of the known local interfaces listed in the \fIinterfaces\fR
4180 parameter. This is the least reliable of the name resolution
4181 methods as it depends on the target host being on a locally
4185 Default: \fBname resolve order = lmhosts host wins bcast
4188 Example: \fBname resolve order = lmhosts bcast host
4191 This will cause the local lmhosts file to be examined
4192 first, followed by a broadcast attempt, followed by a normal
4193 system hostname lookup.
4196 \fBnetbios aliases (G)\fR
4197 This is a list of NetBIOS names that nmbd(8)will advertise as additional
4198 names by which the Samba server is known. This allows one machine
4199 to appear in browse lists under multiple names. If a machine is
4200 acting as a browse server or logon server none
4201 of these names will be advertised as either browse server or logon
4202 servers, only the primary name of the machine will be advertised
4203 with these capabilities.
4208 Default: \fBempty string (no additional names)\fR
4210 Example: \fBnetbios aliases = TEST TEST1 TEST2\fR
4212 \fBnetbios name (G)\fR
4213 This sets the NetBIOS name by which a Samba
4214 server is known. By default it is the same as the first component
4215 of the host's DNS name. If a machine is a browse server or
4216 logon server this name (or the first component
4217 of the hosts DNS name) will be the name that these services are
4223 Default: \fBmachine DNS name\fR
4225 Example: \fBnetbios name = MYNAME\fR
4227 \fBnetbios scope (G)\fR
4228 This sets the NetBIOS scope that Samba will
4229 operate under. This should not be set unless every machine
4230 on your LAN also sets this value.
4232 \fBnis homedir (G)\fR
4233 Get the home share server from a NIS map. For
4234 UNIX systems that use an automounter, the user's home directory
4235 will often be mounted on a workstation on demand from a remote
4238 When the Samba logon server is not the actual home directory
4239 server, but is mounting the home directories via NFS then two
4240 network hops would be required to access the users home directory
4241 if the logon server told the client to use itself as the SMB server
4242 for home directories (one over SMB and one over NFS). This can
4245 This option allows Samba to return the home share as
4246 being on a different server to the logon server and as
4247 long as a Samba daemon is running on the home directory server,
4248 it will be mounted on the Samba client directly from the directory
4249 server. When Samba is returning the home share to the client, it
4250 will consult the NIS map specified in \fIhomedir map\fR and return the server
4253 Note that for this option to work there must be a working
4254 NIS system and the Samba server with this option must also
4257 Default: \fBnis homedir = no\fR
4259 \fBnt acl support (G)\fR
4260 This boolean parameter controls whether
4261 smbd(8)will attempt to map
4262 UNIX permissions into Windows NT access control lists.
4264 Default: \fBnt acl support = yes\fR
4266 \fBnt pipe support (G)\fR
4267 This boolean parameter controls whether
4268 smbd(8)will allow Windows NT
4269 clients to connect to the NT SMB specific IPC$
4270 pipes. This is a developer debugging option and can be left
4273 Default: \fBnt pipe support = yes\fR
4275 \fBnt smb support (G)\fR
4276 This boolean parameter controls whether smbd(8)will negotiate NT specific SMB
4277 support with Windows NT clients. Although this is a developer
4278 debugging option and should be left alone, benchmarking has discovered
4279 that Windows NT clients give faster performance with this option
4280 set to no. This is still being investigated.
4281 If this option is set to no then Samba offers
4282 exactly the same SMB calls that versions prior to Samba 2.0 offered.
4283 This information may be of use if any users are having problems
4284 with NT SMB support.
4286 You should not need to ever disable this parameter.
4288 Default: \fBnt smb support = yes\fR
4290 \fBnull passwords (G)\fR
4291 Allow or disallow client access to accounts
4292 that have null passwords.
4294 See also smbpasswd (5).
4296 Default: \fBnull passwords = no\fR
4299 This is a boolean option that controls whether
4300 connections with usernames not in the \fIuser\fR
4301 list will be allowed. By default this option is disabled so that a
4302 client can supply a username to be used by the server. Enabling
4303 this parameter will force the server to only user the login
4304 names from the \fIuser\fR list and is only really
4305 useful in shave level
4308 Note that this also means Samba won't try to deduce
4309 usernames from the service name. This can be annoying for
4310 the [homes] section. To get around this you could use \fBuser =
4311 %S\fR which means your \fIuser\fR list
4312 will be just the service name, which for home directories is the
4315 See also the \fIuser\fR
4318 Default: \fBonly user = no\fR
4320 \fBole locking compatibility (G)\fR
4321 This parameter allows an administrator to turn
4322 off the byte range lock manipulation that is done within Samba to
4323 give compatibility for OLE applications. Windows OLE applications
4324 use byte range locking as a form of inter-process communication, by
4325 locking ranges of bytes around the 2^32 region of a file range. This
4326 can cause certain UNIX lock managers to crash or otherwise cause
4327 problems. Setting this parameter to no means you
4328 trust your UNIX lock manager to handle such cases correctly.
4330 Default: \fBole locking compatibility = yes\fR
4332 \fBonly guest (S)\fR
4333 A synonym for \fI guest only\fR.
4335 \fBoplock break wait time (G)\fR
4336 This is a tuning parameter added due to bugs in
4337 both Windows 9x and WinNT. If Samba responds to a client too
4338 quickly when that client issues an SMB that can cause an oplock
4339 break request, then the network client can fail and not respond
4340 to the break request. This tuning parameter (which is set in milliseconds)
4341 is the amount of time Samba will wait before sending an oplock break
4342 request to such (broken) clients.
4344 \fBDO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
4345 AND UNDERSTOOD THE SAMBA OPLOCK CODE\fR.
4347 Default: \fBoplock break wait time = 0\fR
4349 \fBoplock contention limit (S)\fR
4350 This is a \fBvery\fR advanced
4351 smbd(8)tuning option to
4352 improve the efficiency of the granting of oplocks under multiple
4353 client contention for the same file.
4355 In brief it specifies a number, which causes smbd not to
4356 grant an oplock even when requested if the approximate number of
4357 clients contending for an oplock on the same file goes over this
4358 limit. This causes \fBsmbd\fR to behave in a similar
4361 \fBDO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
4362 AND UNDERSTOOD THE SAMBA OPLOCK CODE\fR.
4364 Default: \fBoplock contention limit = 2\fR
4367 This boolean option tells smbd whether to
4368 issue oplocks (opportunistic locks) to file open requests on this
4369 share. The oplock code can dramatically (approx. 30% or more) improve
4370 the speed of access to files on Samba servers. It allows the clients
4371 to aggressively cache files locally and you may want to disable this
4372 option for unreliable network environments (it is turned on by
4373 default in Windows NT Servers). For more information see the file
4374 \fISpeed.txt\fR in the Samba \fIdocs/\fR
4377 Oplocks may be selectively turned off on certain files with a
4378 share. See the \fI veto oplock files\fR parameter. On some systems
4379 oplocks are recognized by the underlying operating system. This
4380 allows data synchronization between all access to oplocked files,
4381 whether it be via Samba or NFS or a local UNIX process. See the
4382 \fIkernel oplocks\fR parameter for details.
4384 See also the \fIkernel
4385 oplocks\fR and \fI level2 oplocks\fR parameters.
4387 Default: \fBoplocks = yes\fR
4390 This integer value controls what level Samba
4391 advertises itself as for browse elections. The value of this
4392 parameter determines whether nmbd(8)has a chance of becoming a local master browser for the \fI WORKGROUP\fR in the local broadcast area.
4394 \fBNote :\fRBy default, Samba will win
4395 a local master browsing election over all Microsoft operating
4396 systems except a Windows NT 4.0/2000 Domain Controller. This
4397 means that a misconfigured Samba host can effectively isolate
4398 a subnet for browsing purposes. See \fIBROWSING.txt
4399 \fRin the Samba \fIdocs/\fR directory
4402 Default: \fBos level = 20\fR
4404 Example: \fBos level = 65 \fR
4406 \fBos2 driver map (G)\fR
4407 The parameter is used to define the absolute
4408 path to a file containing a mapping of Windows NT printer driver
4409 names to OS/2 printer driver names. The format is:
4411 <nt driver name> = <os2 driver
4414 For example, a valid entry using the HP LaserJet 5
4415 printer driver woudl appear as \fBHP LaserJet 5L = LASERJET.HP
4418 The need for the file is due to the printer driver namespace
4419 problem described in the Samba
4420 Printing HOWTO. For more details on OS/2 clients, please
4421 refer to the OS2-Client-HOWTO
4422 containing in the Samba documentation.
4424 Default: \fBos2 driver map = <empty string>
4426 \fBpanic action (G)\fR
4427 This is a Samba developer option that allows a
4428 system command to be called when either smbd(8)crashes. This is usually used to draw attention to the fact that
4431 Default: \fBpanic action = <empty string>\fR
4433 Example: \fBpanic action = "/bin/sleep 90000"\fR
4435 \fBpasswd chat (G)\fR
4436 This string controls the \fB"chat"\fR
4437 conversation that takes places between smbdand the local password changing
4438 program to change the users password. The string describes a
4439 sequence of response-receive pairs that smbd(8)uses to determine what to send to the
4440 \fIpasswd program\fR
4441 and what to expect back. If the expected output is not
4442 received then the password is not changed.
4444 This chat sequence is often quite site specific, depending
4445 on what local methods are used for password control (such as NIS
4448 The string can contain the macros \fI%o\fR
4449 and \fI%n\fR which are substituted for the old
4450 and new passwords respectively. It can also contain the standard
4451 macros \\n, \\r, \\t and %s to give line-feed,
4452 carriage-return, tab and space.
4454 The string can also contain a '*' which matches
4455 any sequence of characters.
4457 Double quotes can be used to collect strings with spaces
4458 in them into a single string.
4460 If the send string in any part of the chat sequence
4461 is a fullstop ".", then no string is sent. Similarly,
4462 if the expect string is a fullstop then no string is expected.
4464 Note that if the \fIunix
4465 password sync\fR parameter is set to true, then this
4466 sequence is called \fBAS ROOT\fR when the SMB password
4467 in the smbpasswd file is being changed, without access to the old
4468 password cleartext. In this case the old password cleartext is set
4469 to "" (the empty string).
4471 See also \fIunix password
4472 sync\fR, \fI passwd program\fR and \fIpasswd chat debug\fR.
4474 Default: \fBpasswd chat = *new*password* %n\\n
4475 *new*password* %n\\n *changed*\fR
4477 Example: \fBpasswd chat = "*Enter OLD password*" %o\\n
4478 "*Enter NEW password*" %n\\n "*Reenter NEW password*" %n\\n "*Password
4481 \fBpasswd chat debug (G)\fR
4482 This boolean specifies if the passwd chat script
4483 parameter is run in \fBdebug\fR mode. In this mode the
4484 strings passed to and received from the passwd chat are printed
4485 in the smbd(8)log with a
4487 of 100. This is a dangerous option as it will allow plaintext passwords
4488 to be seen in the \fBsmbd\fR log. It is available to help
4489 Samba admins debug their \fIpasswd chat\fR scripts
4490 when calling the \fIpasswd program\fR and should
4491 be turned off after this has been done. This parameter is off by
4494 See also <\fIpasswd chat\fR
4495 , \fIpasswd program\fR
4498 Default: \fBpasswd chat debug = no\fR
4500 \fBpasswd program (G)\fR
4501 The name of a program that can be used to set
4502 UNIX user passwords. Any occurrences of \fI%u\fR
4503 will be replaced with the user name. The user name is checked for
4504 existence before calling the password changing program.
4506 Also note that many passwd programs insist in \fBreasonable
4507 \fRpasswords, such as a minimum length, or the inclusion
4508 of mixed case chars and digits. This can pose a problem as some clients
4509 (such as Windows for Workgroups) uppercase the password before sending
4512 \fBNote\fR that if the \fIunix
4513 password sync\fR parameter is set to True
4514 then this program is called \fBAS ROOT\fR
4515 before the SMB password in the smbpasswd(5)
4516 file is changed. If this UNIX password change fails, then
4517 \fBsmbd\fR will fail to change the SMB password also
4518 (this is by design).
4520 If the \fIunix password sync\fR parameter
4521 is set this parameter \fBMUST USE ABSOLUTE PATHS\fR
4522 for \fBALL\fR programs called, and must be examined
4523 for security implications. Note that by default \fIunix
4524 password sync\fR is set to False.
4529 Default: \fBpasswd program = /bin/passwd\fR
4531 Example: \fBpasswd program = /sbin/npasswd %u\fR
4533 \fBpassword level (G)\fR
4534 Some client/server combinations have difficulty
4535 with mixed-case passwords. One offending client is Windows for
4536 Workgroups, which for some reason forces passwords to upper
4537 case when using the LANMAN1 protocol, but leaves them alone when
4538 using COREPLUS! Another problem child is the Windows 95/98
4539 family of operating systems. These clients upper case clear
4540 text passwords even when NT LM 0.12 selected by the protocol
4541 negotiation request/response.
4543 This parameter defines the maximum number of characters
4544 that may be upper case in passwords.
4546 For example, say the password given was "FRED". If \fI password level\fR is set to 1, the following combinations
4547 would be tried if "FRED" failed:
4549 "Fred", "fred", "fRed", "frEd","freD"
4551 If \fIpassword level\fR was set to 2,
4552 the following combinations would also be tried:
4554 "FRed", "FrEd", "FreD", "fREd", "fReD", "frED", ..
4558 The higher value this parameter is set to the more likely
4559 it is that a mixed case password will be matched against a single
4560 case password. However, you should be aware that use of this
4561 parameter reduces security and increases the time taken to
4562 process a new connection.
4564 A value of zero will cause only two attempts to be
4565 made - the password as is and the password in all-lower case.
4567 Default: \fBpassword level = 0\fR
4569 Example: \fBpassword level = 4\fR
4571 \fBpassword server (G)\fR
4572 By specifying the name of another SMB server (such
4573 as a WinNT box) with this option, and using \fBsecurity = domain
4574 \fRor \fBsecurity = server\fR you can get Samba
4575 to do all its username/password validation via a remote server.
4577 This option sets the name of the password server to use.
4578 It must be a NetBIOS name, so if the machine's NetBIOS name is
4579 different from its Internet name then you may have to add its NetBIOS
4580 name to the lmhosts file which is stored in the same directory
4581 as the \fIsmb.conf\fR file.
4583 The name of the password server is looked up using the
4585 resolve order\fR and so may resolved
4586 by any method and order described in that parameter.
4588 The password server much be a machine capable of using
4589 the "LM1.2X002" or the "NT LM 0.12" protocol, and it must be in
4590 user level security mode.
4592 \fBNOTE:\fR Using a password server
4593 means your UNIX box (running Samba) is only as secure as your
4594 password server. \fBDO NOT CHOOSE A PASSWORD SERVER THAT
4595 YOU DON'T COMPLETELY TRUST\fR.
4597 Never point a Samba server at itself for password
4598 serving. This will cause a loop and could lock up your Samba
4601 The name of the password server takes the standard
4602 substitutions, but probably the only useful one is \fI%m
4603 \fR, which means the Samba server will use the incoming
4604 client as the password server. If you use this then you better
4605 trust your clients, and you had better restrict them with hosts allow!
4607 If the \fIsecurity\fR parameter is set to
4608 domain, then the list of machines in this
4609 option must be a list of Primary or Backup Domain controllers for the
4610 Domain or the character '*', as the Samba server is effectively
4611 in that domain, and will use cryptographically authenticated RPC calls
4612 to authenticate the user logging on. The advantage of using \fB security = domain\fR is that if you list several hosts in the
4613 \fIpassword server\fR option then \fBsmbd
4614 \fRwill try each in turn till it finds one that responds. This
4615 is useful in case your primary server goes down.
4617 If the \fIpassword server\fR option is set
4618 to the character '*', then Samba will attempt to auto-locate the
4619 Primary or Backup Domain controllers to authenticate against by
4620 doing a query for the name WORKGROUP<1C>
4621 and then contacting each server returned in the list of IP
4622 addresses from the name resolution source.
4624 If the \fIsecurity\fR parameter is
4625 set to server, then there are different
4626 restrictions that \fBsecurity = domain\fR doesn't
4631 You may list several password servers in
4632 the \fIpassword server\fR parameter, however if an
4633 \fBsmbd\fR makes a connection to a password server,
4634 and then the password server fails, no more users will be able
4635 to be authenticated from this \fBsmbd\fR. This is a
4636 restriction of the SMB/CIFS protocol when in \fBsecurity=server
4637 \fRmode and cannot be fixed in Samba.
4640 If you are using a Windows NT server as your
4641 password server then you will have to ensure that your users
4642 are able to login from the Samba server, as when in \fB security=server\fR mode the network logon will appear to
4643 come from there rather than from the users workstation.
4646 See also the \fIsecurity
4650 Default: \fBpassword server = <empty string>\fR
4653 Example: \fBpassword server = NT-PDC, NT-BDC1, NT-BDC2
4656 Example: \fBpassword server = *\fR
4660 This parameter specifies a directory to which
4661 the user of the service is to be given access. In the case of
4662 printable services, this is where print data will spool prior to
4663 being submitted to the host for printing.
4665 For a printable service offering guest access, the service
4666 should be readonly and the path should be world-writeable and
4667 have the sticky bit set. This is not mandatory of course, but
4668 you probably won't get the results you expect if you do
4671 Any occurrences of \fI%u\fR in the path
4672 will be replaced with the UNIX username that the client is using
4673 on this connection. Any occurrences of \fI%m\fR
4674 will be replaced by the NetBIOS name of the machine they are
4675 connecting from. These replacements are very useful for setting
4676 up pseudo home directories for users.
4678 Note that this path will be based on \fIroot dir\fR if one was specified.
4682 Example: \fBpath = /home/fred\fR
4684 \fBposix locking (S)\fR
4685 The \fBsmbd(8)\fRdaemon maintains an database of file locks obtained by SMB clients.
4686 The default behavior is to map this internal database to POSIX
4687 locks. This means that file locks obtained by SMB clients are
4688 consistent with those seen by POSIX compliant applications accessing
4689 the files via a non-SMB method (e.g. NFS or local file access).
4690 You should never need to disable this parameter.
4692 Default: \fBposix locking = yes\fR
4695 This option specifies a command to be run
4696 whenever the service is disconnected. It takes the usual
4697 substitutions. The command may be run as the root on some
4700 An interesting example may be do unmount server
4703 \fBpostexec = /etc/umount /cdrom\fR
4705 See also \fIpreexec\fR
4708 Default: \fBnone (no command executed)\fR
4710 Example: \fBpostexec = echo \\"%u disconnected from %S
4711 from %m (%I)\\" >> /tmp/log\fR
4713 \fBpostscript (S)\fR
4714 This parameter forces a printer to interpret
4715 the print files as postscript. This is done by adding a %!
4716 to the start of print output.
4718 This is most useful when you have lots of PCs that persist
4719 in putting a control-D at the start of print jobs, which then
4720 confuses your printer.
4722 Default: \fBpostscript = no\fR
4725 This option specifies a command to be run whenever
4726 the service is connected to. It takes the usual substitutions.
4728 An interesting example is to send the users a welcome
4729 message every time they log in. Maybe a message of the day? Here
4732 \fBpreexec = csh -c 'echo \\"Welcome to %S!\\" |
4733 /usr/local/samba/bin/smbclient -M %m -I %I' & \fR
4735 Of course, this could get annoying after a while :-)
4737 See also \fIpreexec close
4741 Default: \fBnone (no command executed)\fR
4743 Example: \fBpreexec = echo \\"%u connected to %S from %m
4744 (%I)\\" >> /tmp/log\fR
4746 \fBpreexec close (S)\fR
4747 This boolean option controls whether a non-zero
4748 return code from \fIpreexec
4749 \fRshould close the service being connected to.
4751 Default: \fBpreexec close = no\fR
4753 \fBpreferred master (G)\fR
4754 This boolean parameter controls if nmbd(8)is a preferred master browser
4757 If this is set to true, on startup, \fBnmbd\fR
4758 will force an election, and it will have a slight advantage in
4759 winning the election. It is recommended that this parameter is
4760 used in conjunction with \fB\fI domain master\fB = yes\fR, so that \fB nmbd\fR can guarantee becoming a domain master.
4762 Use this option with caution, because if there are several
4763 hosts (whether Samba servers, Windows 95 or NT) that are preferred
4764 master browsers on the same subnet, they will each periodically
4765 and continuously attempt to become the local master browser.
4766 This will result in unnecessary broadcast traffic and reduced browsing
4769 See also \fIos level\fR
4772 Default: \fBpreferred master = auto\fR
4774 \fBprefered master (G)\fR
4775 Synonym for \fI preferred master\fR for people who cannot spell :-).
4778 This is a list of services that you want to be
4779 automatically added to the browse lists. This is most useful
4780 for homes and printers services that would otherwise not be
4783 Note that if you just want all printers in your
4784 printcap file loaded then the \fIload printers\fR option is easier.
4786 Default: \fBno preloaded services\fR
4788 Example: \fBpreload = fred lp colorlp\fR
4790 \fBpreserve case (S)\fR
4791 This controls if new filenames are created
4792 with the case that the client passes, or if they are forced to
4793 be the \fIdefault case
4796 Default: \fBpreserve case = yes\fR
4798 See the section on NAME
4799 MANGLING for a fuller discussion.
4801 \fBprint command (S)\fR
4802 After a print job has finished spooling to
4803 a service, this command will be used via a \fBsystem()\fR
4804 call to process the spool file. Typically the command specified will
4805 submit the spool file to the host's printing subsystem, but there
4806 is no requirement that this be the case. The server will not remove
4807 the spool file, so whatever command you specify should remove the
4808 spool file when it has been processed, otherwise you will need to
4809 manually remove old spool files.
4811 The print command is simply a text string. It will be used
4812 verbatim, with two exceptions: All occurrences of \fI%s
4813 \fRand \fI%f\fR will be replaced by the
4814 appropriate spool file name, and all occurrences of \fI%p
4815 \fRwill be replaced by the appropriate printer name. The
4816 spool file name is generated automatically by the server, the printer
4817 name is discussed below.
4819 The print command \fBMUST\fR contain at least
4820 one occurrence of \fI%s\fR or \fI%f
4821 \fR- the \fI%p\fR is optional. At the time
4822 a job is submitted, if no printer name is supplied the \fI%p
4823 \fRwill be silently removed from the printer command.
4825 If specified in the [global] section, the print command given
4826 will be used for any printable service that does not have its own
4827 print command specified.
4829 If there is neither a specified print command for a
4830 printable service nor a global print command, spool files will
4831 be created but not processed and (most importantly) not removed.
4833 Note that printing may fail on some UNIXes from the
4834 nobody account. If this happens then create
4835 an alternative guest account that can print and set the \fIguest account\fR
4836 in the [global] section.
4838 You can form quite complex print commands by realizing
4839 that they are just passed to a shell. For example the following
4840 will log a print job, print the file, then remove it. Note that
4841 \&';' is the usual separator for command in shell scripts.
4843 \fBprint command = echo Printing %s >>
4844 /tmp/print.log; lpr -P %p %s; rm %s\fR
4846 You may have to vary this command considerably depending
4847 on how you normally print files on your system. The default for
4848 the parameter varies depending on the setting of the \fIprinting\fR parameter.
4850 Default: For \fBprinting= BSD, AIX, QNX, LPRNG
4853 \fBprint command = lpr -r -P%p %s\fR
4855 For \fBprinting= SYS or HPUX :\fR
4857 \fBprint command = lp -c -d%p %s; rm %s\fR
4859 For \fBprinting=SOFTQ :\fR
4861 \fBprint command = lp -d%p -s %s; rm %s\fR
4863 Example: \fBprint command = /usr/local/samba/bin/myprintscript
4867 Synonym for \fIprintable\fR.
4870 If this parameter is yes, then
4871 clients may open, write to and submit spool files on the directory
4872 specified for the service.
4874 Note that a printable service will ALWAYS allow writing
4875 to the service path (user privileges permitting) via the spooling
4876 of print data. The \fIwriteable
4877 \fRparameter controls only non-printing access to
4880 Default: \fBprintable = no\fR
4883 Synonym for \fI printcap name\fR.
4885 \fBprintcap name (G)\fR
4886 This parameter may be used to override the
4887 compiled-in default printcap name used by the server (usually \fI /etc/printcap\fR). See the discussion of the [printers] section above for reasons
4888 why you might want to do this.
4890 On System V systems that use \fBlpstat\fR to
4891 list available printers you can use \fBprintcap name = lpstat
4892 \fRto automatically obtain lists of available printers. This
4893 is the default for systems that define SYSV at configure time in
4894 Samba (this includes most System V based systems). If \fI printcap name\fR is set to \fBlpstat\fR on
4895 these systems then Samba will launch \fBlpstat -v\fR and
4896 attempt to parse the output to obtain a printer list.
4898 A minimal printcap file would look something like this:
4911 where the '|' separates aliases of a printer. The fact
4912 that the second alias has a space in it gives a hint to Samba
4913 that it's a comment.
4915 \fBNOTE\fR: Under AIX the default printcap
4916 name is \fI/etc/qconfig\fR. Samba will assume the
4917 file is in AIX \fIqconfig\fR format if the string
4918 \fIqconfig\fR appears in the printcap filename.
4920 Default: \fBprintcap name = /etc/printcap\fR
4922 Example: \fBprintcap name = /etc/myprintcap\fR
4924 \fBprinter admin (S)\fR
4925 This is a list of users that can do anything to
4926 printers via the remote administration interfaces offered by MS-RPC
4927 (usually using a NT workstation). Note that the root user always
4930 Default: \fBprinter admin = <empty string>\fR
4932 Example: \fBprinter admin = admin, @staff\fR
4934 \fBprinter driver (S)\fR
4935 \fBNote :\fRThis is a depreciated
4936 parameter and will be removed in the next major release
4937 following version 2.2. Please see the instructions in
4938 \fIPRINTER_DRIVER2.txt\fR in the \fIdocs
4939 \fRof the Samba distribution for more information
4940 on the new method of loading printer drivers onto a Samba server.
4942 This option allows you to control the string
4943 that clients receive when they ask the server for the printer driver
4944 associated with a printer. If you are using Windows95 or Windows NT
4945 then you can use this to automate the setup of printers on your
4948 You need to set this parameter to the exact string (case
4949 sensitive) that describes the appropriate printer driver for your
4950 system. If you don't know the exact string to use then you should
4951 first try with no \fI printer driver\fR option set and the client will
4952 give you a list of printer drivers. The appropriate strings are
4953 shown in a scroll box after you have chosen the printer manufacturer.
4958 Example: \fBprinter driver = HP LaserJet 4L\fR
4960 \fBprinter driver file (G)\fR
4961 \fBNote :\fRThis is a depreciated
4962 parameter and will be removed in the next major release
4963 following version 2.2. Please see the instructions in
4964 \fIPRINTER_DRIVER2.txt\fR in the \fIdocs
4965 \fRof the Samba distribution for more information
4966 on the new method of loading printer drivers onto a Samba server.
4968 This parameter tells Samba where the printer driver
4969 definition file, used when serving drivers to Windows 95 clients, is
4970 to be found. If this is not set, the default is :
4972 \fISAMBA_INSTALL_DIRECTORY
4973 /lib/printers.def\fR
4975 This file is created from Windows 95 \fImsprint.inf
4976 \fRfiles found on the Windows 95 client system. For more
4977 details on setting up serving of printer drivers to Windows 95
4978 clients, see the documentation file in the \fIdocs/\fR
4979 directory, \fIPRINTER_DRIVER.txt\fR.
4981 See also \fI printer driver location\fR.
4983 Default: \fBNone (set in compile).\fR
4985 Example: \fBprinter driver file =
4986 /usr/local/samba/printers/drivers.def\fR
4988 \fBprinter driver location (S)\fR
4989 \fBNote :\fRThis is a depreciated
4990 parameter and will be removed in the next major release
4991 following version 2.2. Please see the instructions in
4992 \fIPRINTER_DRIVER2.txt\fR in the \fIdocs
4993 \fRof the Samba distribution for more information
4994 on the new method of loading printer drivers onto a Samba server.
4996 This parameter tells clients of a particular printer
4997 share where to find the printer driver files for the automatic
4998 installation of drivers for Windows 95 machines. If Samba is set up
4999 to serve printer drivers to Windows 95 machines, this should be set to
5001 \fB\\\\MACHINE\\PRINTER$\fR
5003 Where MACHINE is the NetBIOS name of your Samba server,
5004 and PRINTER$ is a share you set up for serving printer driver
5005 files. For more details on setting this up see the documentation
5006 file in the \fIdocs/\fR directory, \fI PRINTER_DRIVER.txt\fR.
5008 See also \fI printer driver file\fR.
5012 Example: \fBprinter driver location = \\\\MACHINE\\PRINTER$
5014 \fBprinter name (S)\fR
5015 This parameter specifies the name of the printer
5016 to which print jobs spooled through a printable service will be sent.
5018 If specified in the [global] section, the printer
5019 name given will be used for any printable service that does
5020 not have its own printer name specified.
5022 Default: \fBnone (but may be lp
5025 Example: \fBprinter name = laserwriter\fR
5028 Synonym for \fI printer name\fR.
5031 This parameters controls how printer status
5032 information is interpreted on your system. It also affects the
5033 default values for the \fIprint command\fR,
5034 \fIlpq command\fR, \fIlppause command
5035 \fR, \fIlpresume command\fR, and
5036 \fIlprm command\fR if specified in the
5039 Currently eight printing styles are supported. They are
5046 To see what the defaults are for the other print
5047 commands when using the various options use the testparm(1)program.
5049 This option can be set on a per printer basis
5051 See also the discussion in the [printers] section.
5054 Synonym for \fImax protocol\fR.
5057 Synonym for \fIguest
5060 \fBqueuepause command (S)\fR
5061 This parameter specifies the command to be
5062 executed on the server host in order to pause the printerqueue.
5064 This command should be a program or script which takes
5065 a printer name as its only parameter and stops the printerqueue,
5066 such that no longer jobs are submitted to the printer.
5068 This command is not supported by Windows for Workgroups,
5069 but can be issued from the Printer's window under Windows 95
5072 If a \fI%p\fR is given then the printername
5073 is put in its place. Otherwise it is placed at the end of the command.
5075 Note that it is good practice to include the absolute
5076 path in the command as the PATH may not be available to the
5079 Default: \fBdepends on the setting of \fIprinting
5081 Example: \fBqueuepause command = disable %p\fR
5083 \fBqueueresume command (S)\fR
5084 This parameter specifies the command to be
5085 executed on the server host in order to resume the printerqueue. It
5086 is the command to undo the behavior that is caused by the
5087 previous parameter (\fI queuepause command\fR).
5089 This command should be a program or script which takes
5090 a printer name as its only parameter and resumes the printerqueue,
5091 such that queued jobs are resubmitted to the printer.
5093 This command is not supported by Windows for Workgroups,
5094 but can be issued from the Printer's window under Windows 95
5097 If a \fI%p\fR is given then the printername
5098 is put in its place. Otherwise it is placed at the end of the
5101 Note that it is good practice to include the absolute
5102 path in the command as the PATH may not be available to the
5105 Default: \fBdepends on the setting of \fIprinting\fB\fR
5107 Example: \fBqueuepause command = enable %p
5110 This boolean parameter controls whether smbd(8)will support the "Read
5111 Block Multiplex" SMB. This is now rarely used and defaults to
5112 no. You should never need to set this
5115 Default: \fBread bmpx = no\fR
5118 This is a list of users that are given read-only
5119 access to a service. If the connecting user is in this list then
5120 they will not be given write access, no matter what the \fIwriteable\fR
5121 option is set to. The list can include group names using the
5122 syntax described in the \fI invalid users\fR parameter.
5124 See also the \fI write list\fR parameter and the \fIinvalid users\fR
5127 Default: \fBread list = <empty string>\fR
5129 Example: \fBread list = mary, @students\fR
5132 Note that this is an inverted synonym for \fIwriteable\fR.
5135 This parameter controls whether or not the server
5136 will support the raw read SMB requests when transferring data
5139 If enabled, raw reads allow reads of 65535 bytes in
5140 one packet. This typically provides a major performance benefit.
5142 However, some clients either negotiate the allowable
5143 block size incorrectly or are incapable of supporting larger block
5144 sizes, and for these clients you may need to disable raw reads.
5146 In general this parameter should be viewed as a system tuning
5147 tool and left severely alone. See also \fIwrite raw\fR.
5149 Default: \fBread raw = yes\fR
5152 The option \fIread size\fR
5153 affects the overlap of disk reads/writes with network reads/writes.
5154 If the amount of data being transferred in several of the SMB
5155 commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger
5156 than this value then the server begins writing the data before it
5157 has received the whole packet from the network, or in the case of
5158 SMBreadbraw, it begins writing to the network before all the data
5159 has been read from disk.
5161 This overlapping works best when the speeds of disk and
5162 network access are similar, having very little effect when the
5163 speed of one is much greater than the other.
5165 The default value is 16384, but very little experimentation
5166 has been done yet to determine the optimal value, and it is likely
5167 that the best value will vary greatly between systems anyway.
5168 A value over 65536 is pointless and will cause you to allocate
5169 memory unnecessarily.
5171 Default: \fBread size = 16384\fR
5173 Example: \fBread size = 8192\fR
5175 \fBremote announce (G)\fR
5176 This option allows you to setup nmbd(8)to periodically announce itself
5177 to arbitrary IP addresses with an arbitrary workgroup name.
5179 This is useful if you want your Samba server to appear
5180 in a remote workgroup for which the normal browse propagation
5181 rules don't work. The remote workgroup can be anywhere that you
5182 can send IP packets to.
5186 \fBremote announce = 192.168.2.255/SERVERS
5187 192.168.4.255/STAFF\fR
5189 the above line would cause nmbd to announce itself
5190 to the two given IP addresses using the given workgroup names.
5191 If you leave out the workgroup name then the one given in
5193 parameter is used instead.
5195 The IP addresses you choose would normally be the broadcast
5196 addresses of the remote networks, but can also be the IP addresses
5197 of known browse masters if your network config is that stable.
5199 See the documentation file \fIBROWSING.txt\fR
5200 in the \fIdocs/\fR directory.
5202 Default: \fBremote announce = <empty string>
5204 \fBremote browse sync (G)\fR
5205 This option allows you to setup nmbd(8)to periodically request
5206 synchronization of browse lists with the master browser of a samba
5207 server that is on a remote segment. This option will allow you to
5208 gain browse lists for multiple workgroups across routed networks. This
5209 is done in a manner that does not work with any non-samba servers.
5211 This is useful if you want your Samba server and all local
5212 clients to appear in a remote workgroup for which the normal browse
5213 propagation rules don't work. The remote workgroup can be anywhere
5214 that you can send IP packets to.
5218 \fBremote browse sync = 192.168.2.255 192.168.4.255
5220 the above line would cause \fBnmbd\fR to request
5221 the master browser on the specified subnets or addresses to
5222 synchronize their browse lists with the local server.
5224 The IP addresses you choose would normally be the broadcast
5225 addresses of the remote networks, but can also be the IP addresses
5226 of known browse masters if your network config is that stable. If
5227 a machine IP address is given Samba makes NO attempt to validate
5228 that the remote machine is available, is listening, nor that it
5229 is in fact the browse master on it's segment.
5231 Default: \fBremote browse sync = <empty string>
5233 \fBrestrict anonymous (G)\fR
5234 This is a boolean parameter. If it is true, then
5235 anonymous access to the server will be restricted, namely in the
5236 case where the server is expecting the client to send a username,
5237 but it doesn't. Setting it to true will force these anonymous
5238 connections to be denied, and the client will be required to always
5239 supply a username and password when connecting. Use of this parameter
5240 is only recommended for homogeneous NT client environments.
5242 This parameter makes the use of macro expansions that rely
5243 on the username (%U, %G, etc) consistent. NT 4.0
5244 likes to use anonymous connections when refreshing the share list,
5245 and this is a way to work around that.
5247 When restrict anonymous is true, all anonymous connections
5248 are denied no matter what they are for. This can effect the ability
5249 of a machine to access the samba Primary Domain Controller to revalidate
5250 it's machine account after someone else has logged on the client
5251 interactively. The NT client will display a message saying that
5252 the machine's account in the domain doesn't exist or the password is
5253 bad. The best way to deal with this is to reboot NT client machines
5254 between interactive logons, using "Shutdown and Restart", rather
5255 than "Close all programs and logon as a different user".
5257 Default: \fBrestrict anonymous = no\fR
5260 Synonym for \fIroot directory"\fR.
5263 Synonym for \fIroot directory"\fR.
5265 \fBroot directory (G)\fR
5266 The server will \fBchroot()\fR (i.e.
5267 Change it's root directory) to this directory on startup. This is
5268 not strictly necessary for secure operation. Even without it the
5269 server will deny access to files not in one of the service entries.
5270 It may also check for, and deny access to, soft links to other
5271 parts of the filesystem, or attempts to use ".." in file names
5272 to access other directories (depending on the setting of the \fIwide links\fR
5275 Adding a \fIroot directory\fR entry other
5276 than "/" adds an extra level of security, but at a price. It
5277 absolutely ensures that no access is given to files not in the
5278 sub-tree specified in the \fIroot directory\fR
5279 option, \fBincluding\fR some files needed for
5280 complete operation of the server. To maintain full operability
5281 of the server you will need to mirror some system files
5282 into the \fIroot directory\fR tree. In particular
5283 you will need to mirror \fI/etc/passwd\fR (or a
5284 subset of it), and any binaries or configuration files needed for
5285 printing (if required). The set of files that must be mirrored is
5286 operating system dependent.
5288 Default: \fBroot directory = /\fR
5290 Example: \fBroot directory = /homes/smb\fR
5292 \fBroot postexec (S)\fR
5293 This is the same as the \fIpostexec\fR
5294 parameter except that the command is run as root. This
5295 is useful for unmounting filesystems
5296 (such as cdroms) after a connection is closed.
5298 See also \fI postexec\fR.
5300 Default: \fBroot postexec = <empty string>
5302 \fBroot preexec (S)\fR
5303 This is the same as the \fIpreexec\fR
5304 parameter except that the command is run as root. This
5305 is useful for mounting filesystems (such as cdroms) after a
5306 connection is closed.
5308 See also \fI preexec\fR and \fIpreexec close\fR.
5310 Default: \fBroot preexec = <empty string>
5312 \fBroot preexec close (S)\fR
5313 This is the same as the \fIpreexec close
5314 \fRparameter except that the command is run as root.
5316 See also \fI preexec\fR and \fIpreexec close\fR.
5318 Default: \fBroot preexec close = no\fR
5321 This option affects how clients respond to
5322 Samba and is one of the most important settings in the \fI smb.conf\fR file.
5324 The option sets the "security mode bit" in replies to
5325 protocol negotiations with smbd(8)
5326 to turn share level security on or off. Clients decide
5327 based on this bit whether (and how) to transfer user and password
5328 information to the server.
5330 The default is \fBsecurity = user\fR, as this is
5331 the most common setting needed when talking to Windows 98 and
5334 The alternatives are \fBsecurity = share\fR,
5335 \fBsecurity = server\fR or \fBsecurity=domain
5338 In versions of Samba prior to 2..0, the default was
5339 \fBsecurity = share\fR mainly because that was
5340 the only option at one stage.
5342 There is a bug in WfWg that has relevance to this
5343 setting. When in user or server level security a WfWg client
5344 will totally ignore the password you type in the "connect
5345 drive" dialog box. This makes it very difficult (if not impossible)
5346 to connect to a Samba service as anyone except the user that
5347 you are logged into WfWg as.
5349 If your PCs use usernames that are the same as their
5350 usernames on the UNIX machine then you will want to use
5351 \fBsecurity = user\fR. If you mostly use usernames
5352 that don't exist on the UNIX box then use \fBsecurity =
5355 You should also use \fBsecurity = share\fR if you
5356 want to mainly setup shares without a password (guest shares). This
5357 is commonly used for a shared printer server. It is more difficult
5358 to setup guest shares with \fBsecurity = user\fR, see
5359 the \fImap to guest\fR
5360 parameter for details.
5362 It is possible to use \fBsmbd\fR in a \fB hybrid mode\fR where it is offers both user and share
5363 level security under different \fINetBIOS aliases\fR.
5365 The different settings will now be explained.
5369 When clients connect to a share level security server then
5370 need not log onto the server with a valid username and password before
5371 attempting to connect to a shared resource (although modern clients
5372 such as Windows 95/98 and Windows NT will send a logon request with
5373 a username but no password when talking to a \fBsecurity = share
5374 \fRserver). Instead, the clients send authentication information
5375 (passwords) on a per-share basis, at the time they attempt to connect
5378 Note that \fBsmbd\fR \fBALWAYS\fR
5379 uses a valid UNIX user to act on behalf of the client, even in
5380 \fBsecurity = share\fR level security.
5382 As clients are not required to send a username to the server
5383 in share level security, \fBsmbd\fR uses several
5384 techniques to determine the correct UNIX user to use on behalf
5387 A list of possible UNIX usernames to match with the given
5388 client password is constructed using the following methods :
5393 only\fR parameter is set, then all the other
5394 stages are missed and only the \fIguest account\fR username is checked.
5397 Is a username is sent with the share connection
5398 request, then this username (after mapping - see \fIusername map\fR),
5399 is added as a potential username.
5402 If the client did a previous \fBlogon
5403 \fRrequest (the SessionSetup SMB call) then the
5404 username sent in this SMB will be added as a potential username.
5407 The name of the service the client requested is
5408 added as a potential username.
5411 The NetBIOS name of the client is added to
5412 the list as a potential username.
5415 Any users on the \fI user\fR list are added as potential usernames.
5418 If the \fIguest only\fR parameter is
5419 not set, then this list is then tried with the supplied password.
5420 The first user for whom the password matches will be used as the
5424 If the \fIguest only\fR parameter is
5425 set, or no username can be determined then if the share is marked
5426 as available to the \fIguest account\fR, then this
5427 guest user will be used, otherwise access is denied.
5430 Note that it can be \fBvery\fR confusing
5431 in share-level security as to which UNIX username will eventually
5432 be used in granting access.
5435 See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
5441 This is the default security setting in Samba 2.2.
5442 With user-level security a client must first "log=on" with a
5443 valid username and password (which can be mapped using the \fIusername map\fR
5444 parameter). Encrypted passwords (see the \fIencrypted passwords\fR parameter) can also
5445 be used in this security mode. Parameters such as \fIuser\fR and \fIguest only\fR if set are then applied and
5446 may change the UNIX user to use on this connection, but only after
5447 the user has been successfully authenticated.
5450 \fBNote\fR that the name of the resource being
5451 requested is \fBnot\fR sent to the server until after
5452 the server has successfully authenticated the client. This is why
5453 guest shares don't work in user level security without allowing
5454 the server to automatically map unknown users into the \fIguest account\fR.
5455 See the \fImap to guest\fR
5456 parameter for details on doing this.
5459 See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
5462 \fBSECURITY = SERVER
5465 In this mode Samba will try to validate the username/password
5466 by passing it to another SMB server, such as an NT box. If this
5467 fails it will revert to \fBsecurity = user\fR, but note
5468 that if encrypted passwords have been negotiated then Samba cannot
5469 revert back to checking the UNIX password file, it must have a valid
5470 \fIsmbpasswd\fR file to check users against. See the
5471 documentation file in the \fIdocs/\fR directory
5472 \fIENCRYPTION.txt\fR for details on how to set this
5476 \fBNote\fR that from the clients point of
5477 view \fBsecurity = server\fR is the same as \fB security = user\fR. It only affects how the server deals
5478 with the authentication, it does not in any way affect what the
5482 \fBNote\fR that the name of the resource being
5483 requested is \fBnot\fR sent to the server until after
5484 the server has successfully authenticated the client. This is why
5485 guest shares don't work in user level security without allowing
5486 the server to automatically map unknown users into the \fIguest account\fR.
5487 See the \fImap to guest\fR
5488 parameter for details on doing this.
5491 See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
5494 See also the \fIpassword
5495 server\fR parameter and the \fIencrypted passwords\fR
5499 \fBSECURITY = DOMAIN
5502 This mode will only work correctly if smbpasswd(8)has been used to add this
5503 machine into a Windows NT Domain. It expects the \fIencrypted passwords\fR
5504 parameter to be set to true. In this
5505 mode Samba will try to validate the username/password by passing
5506 it to a Windows NT Primary or Backup Domain Controller, in exactly
5507 the same way that a Windows NT Server would do.
5510 \fBNote\fR that a valid UNIX user must still
5511 exist as well as the account on the Domain Controller to allow
5512 Samba to have a valid UNIX account to map file access to.
5515 \fBNote\fR that from the clients point
5516 of view \fBsecurity = domain\fR is the same as \fBsecurity = user
5517 \fR\&. It only affects how the server deals with the authentication,
5518 it does not in any way affect what the client sees.
5521 \fBNote\fR that the name of the resource being
5522 requested is \fBnot\fR sent to the server until after
5523 the server has successfully authenticated the client. This is why
5524 guest shares don't work in user level security without allowing
5525 the server to automatically map unknown users into the \fIguest account\fR.
5526 See the \fImap to guest\fR
5527 parameter for details on doing this.
5530 \fBBUG:\fR There is currently a bug in the
5531 implementation of \fBsecurity = domain\fR with respect
5532 to multi-byte character set usernames. The communication with a
5533 Domain Controller must be done in UNICODE and Samba currently
5534 does not widen multi-byte user names to UNICODE correctly, thus
5535 a multi-byte username will not be recognized correctly at the
5536 Domain Controller. This issue will be addressed in a future release.
5539 See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
5542 See also the \fIpassword
5543 server\fR parameter and the \fIencrypted passwords\fR
5547 Default: \fBsecurity = USER\fR
5550 Example: \fBsecurity = DOMAIN\fR
5553 \fBsecurity mask (S)\fR
5554 This parameter controls what UNIX permission
5555 bits can be modified when a Windows NT client is manipulating
5556 the UNIX permission on a file using the native NT security
5559 This parameter is applied as a mask (AND'ed with) to
5560 the changed permission bits, thus preventing any bits not in
5561 this mask from being modified. Essentially, zero bits in this
5562 mask may be treated as a set of bits the user is not allowed
5565 If not set explicitly this parameter is set to the same
5566 value as the \fIcreate mask
5567 \fRparameter. To allow a user to modify all the
5568 user/group/world permissions on a file, set this parameter to
5571 \fBNote\fR that users who can access the
5572 Samba server through other means can easily bypass this
5573 restriction, so it is primarily useful for standalone
5574 "appliance" systems. Administrators of most normal systems will
5575 probably want to set it to 0777.
5577 See also the \fIforce directory security mode\fR,
5579 security mask\fR, \fIforce security mode\fR parameters.
5581 Default: \fBsecurity mask = <same as create mask>
5583 Example: \fBsecurity mask = 0777\fR
5585 \fBserver string (G)\fR
5586 This controls what string will show up in the
5587 printer comment box in print manager and next to the IPC connection
5588 in \fBnet view"\fR. It can be any string that you wish
5589 to show to your users.
5591 It also sets what will appear in browse lists next
5592 to the machine name.
5594 A \fI%v\fR will be replaced with the Samba
5597 A \fI%h\fR will be replaced with the
5600 Default: \fBserver string = Samba %v\fR
5602 Example: \fBserver string = University of GNUs Samba
5605 \fBset directory (S)\fR
5606 If \fBset directory = no\fR, then
5607 users of the service may not use the setdir command to change
5610 The \fBsetdir\fR command is only implemented
5611 in the Digital Pathworks client. See the Pathworks documentation
5614 Default: \fBset directory = no\fR
5616 \fBshare modes (S)\fR
5617 This enables or disables the honoring of
5618 the \fIshare modes\fR during a file open. These
5619 modes are used by clients to gain exclusive read or write access
5622 These open modes are not directly supported by UNIX, so
5623 they are simulated using shared memory, or lock files if your
5624 UNIX doesn't support shared memory (almost all do).
5626 The share modes that are enabled by this option are
5628 DENY_READ, DENY_WRITE,
5629 DENY_NONE and DENY_FCB.
5631 This option gives full share compatibility and enabled
5634 You should \fBNEVER\fR turn this parameter
5635 off as many Windows applications will break if you do so.
5637 Default: \fBshare modes = yes\fR
5639 \fBshort preserve case (S)\fR
5640 This boolean parameter controls if new files
5641 which conform to 8.3 syntax, that is all in upper case and of
5642 suitable length, are created upper case, or if they are forced
5643 to be the \fIdefault case
5644 \fR\&. This option can be use with \fBpreserve case = yes\fR
5645 to permit long filenames to retain their case, while short
5648 See the section on NAME MANGLING.
5650 Default: \fBshort preserve case = yes\fR
5652 \fBshow add printer wizard (G)\fR
5653 With the introduction of MS-RPC based printing support
5654 for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will
5655 appear on Samba hosts in the share listing. Normally this folder will
5656 contain an icon for the MS Add Printer Wizard (APW). However, it is
5657 possible to disable this feature regardless of the level of privilege
5658 of the connected user.
5660 Under normal circumstances, the Windows NT/2000 client will
5661 open a handle on the printer server with OpenPrinterEx() asking for
5662 Administrator privileges. If the user does not have administrative
5663 access on the print server (i.e is not root or a member of the
5664 \fIprinter admin\fR group), the OpenPrinterEx()
5665 call fails and the clients another open call with a request for
5666 a lower privilege level. This should succeed, however the APW
5667 icon will not be displayed.
5669 Disabling the \fIshow add printer wizard\fR
5670 parameter will always cause the OpenPrinterEx() on the server
5671 to fail. Thus the APW icon will never be displayed. \fB Note :\fRThis does not prevent the same user from having
5672 administrative privilege on an individual printer.
5674 See also \fIaddprinter
5675 command\fR, \fIdeleteprinter command\fR, \fIprinter admin\fR
5677 Default :\fBshow add printer wizard = yes\fR
5679 \fBsmb passwd file (G)\fR
5680 This option sets the path to the encrypted
5681 smbpasswd file. By default the path to the smbpasswd file
5682 is compiled into Samba.
5684 Default: \fBsmb passwd file = ${prefix}/private/smbpasswd
5686 Example: \fBsmb passwd file = /etc/samba/smbpasswd
5688 \fBsocket address (G)\fR
5689 This option allows you to control what
5690 address Samba will listen for connections on. This is used to
5691 support multiple virtual interfaces on the one server, each
5692 with a different configuration.
5694 By default samba will accept connections on any
5697 Example: \fBsocket address = 192.168.2.20\fR
5699 \fBsocket options (G)\fR
5700 This option allows you to set socket options
5701 to be used when talking with the client.
5703 Socket options are controls on the networking layer
5704 of the operating systems which allow the connection to be
5707 This option will typically be used to tune your Samba
5708 server for optimal performance for your local network. There is
5709 no way that Samba can know what the optimal parameters are for
5710 your net, so you must experiment and choose them yourself. We
5711 strongly suggest you read the appropriate documentation for your
5712 operating system first (perhaps \fBman setsockopt\fR
5715 You may find that on some systems Samba will say
5716 "Unknown socket option" when you supply an option. This means you
5717 either incorrectly typed it or you need to add an include file
5718 to includes.h for your OS. If the latter is the case please
5719 send the patch to samba@samba.org <URL:mailto:samba@samba.org>.
5721 Any of the supported socket options may be combined
5722 in any way you like, as long as your OS allows it.
5724 This is the list of socket options currently settable
5759 Those marked with a \fB'*'\fR take an integer
5760 argument. The others can optionally take a 1 or 0 argument to enable
5761 or disable the option, by default they will be enabled if you
5762 don't specify 1 or 0.
5765 To specify an argument use the syntax SOME_OPTION=VALUE
5766 for example \fBSO_SNDBUF=8192\fR. Note that you must
5767 not have any spaces before or after the = sign.
5770 If you are on a local network then a sensible option
5774 \fBsocket options = IPTOS_LOWDELAY\fR
5777 If you have a local network then you could try:
5780 \fBsocket options = IPTOS_LOWDELAY TCP_NODELAY\fR
5783 If you are on a wide area network then perhaps try
5784 setting IPTOS_THROUGHPUT.
5787 Note that several of the options may cause your Samba
5788 server to fail completely. Use these options with caution!
5791 Default: \fBsocket options = TCP_NODELAY\fR
5794 Example: \fBsocket options = IPTOS_LOWDELAY\fR
5797 \fBsource environment (G)\fR
5798 This parameter causes Samba to set environment
5799 variables as per the content of the file named.
5801 If the value of this parameter starts with a "|" character
5802 then Samba will treat that value as a pipe command to open and
5803 will set the environment variables from the output of the pipe.
5805 The contents of the file or the output of the pipe should
5806 be formatted as the output of the standard Unix \fBenv(1)
5807 \fRcommand. This is of the form :
5809 Example environment entry:
5811 \fBSAMBA_NETBIOS_NAME=myhostname\fR
5813 Default: \fBNo default value\fR
5815 Examples: \fBsource environment = |/etc/smb.conf.sh
5817 Example: \fBsource environment =
5818 /usr/local/smb_env_vars\fR
5821 This variable is part of SSL-enabled Samba. This
5822 is only available if the SSL libraries have been compiled on your
5823 system and the configure option \fB--with-ssl\fR was
5824 given at configure time.
5826 \fBNote\fR that for export control reasons
5827 this code is \fBNOT\fR enabled by default in any
5828 current binary version of Samba.
5830 This variable enables or disables the entire SSL mode. If
5831 it is set to no, the SSL enabled samba behaves
5832 exactly like the non-SSL samba. If set to yes,
5833 it depends on the variables \fI ssl hosts\fR and \fIssl hosts resign\fR whether an SSL
5834 connection will be required.
5836 Default: \fBssl=no\fR
5838 \fBssl CA certDir (G)\fR
5839 This variable is part of SSL-enabled Samba. This
5840 is only available if the SSL libraries have been compiled on your
5841 system and the configure option \fB--with-ssl\fR was
5842 given at configure time.
5844 \fBNote\fR that for export control reasons
5845 this code is \fBNOT\fR enabled by default in any
5846 current binary version of Samba.
5848 This variable defines where to look up the Certification
5849 Authorities. The given directory should contain one file for
5850 each CA that samba will trust. The file name must be the hash
5851 value over the "Distinguished Name" of the CA. How this directory
5852 is set up is explained later in this document. All files within the
5853 directory that don't fit into this naming scheme are ignored. You
5854 don't need this variable if you don't verify client certificates.
5856 Default: \fBssl CA certDir = /usr/local/ssl/certs
5858 \fBssl CA certFile (G)\fR
5859 This variable is part of SSL-enabled Samba. This
5860 is only available if the SSL libraries have been compiled on your
5861 system and the configure option \fB--with-ssl\fR was
5862 given at configure time.
5864 \fBNote\fR that for export control reasons
5865 this code is \fBNOT\fR enabled by default in any
5866 current binary version of Samba.
5868 This variable is a second way to define the trusted CAs.
5869 The certificates of the trusted CAs are collected in one big
5870 file and this variable points to the file. You will probably
5871 only use one of the two ways to define your CAs. The first choice is
5872 preferable if you have many CAs or want to be flexible, the second
5873 is preferable if you only have one CA and want to keep things
5874 simple (you won't need to create the hashed file names). You
5875 don't need this variable if you don't verify client certificates.
5877 Default: \fBssl CA certFile = /usr/local/ssl/certs/trustedCAs.pem
5879 \fBssl ciphers (G)\fR
5880 This variable is part of SSL-enabled Samba. This
5881 is only available if the SSL libraries have been compiled on your
5882 system and the configure option \fB--with-ssl\fR was
5883 given at configure time.
5885 \fBNote\fR that for export control reasons
5886 this code is \fBNOT\fR enabled by default in any
5887 current binary version of Samba.
5889 This variable defines the ciphers that should be offered
5890 during SSL negotiation. You should not set this variable unless
5891 you know what you are doing.
5893 \fBssl client cert (G)\fR
5894 This variable is part of SSL-enabled Samba. This
5895 is only available if the SSL libraries have been compiled on your
5896 system and the configure option \fB--with-ssl\fR was
5897 given at configure time.
5899 \fBNote\fR that for export control reasons
5900 this code is \fBNOT\fR enabled by default in any
5901 current binary version of Samba.
5903 The certificate in this file is used by \fBsmbclient(1)\fRif it exists. It's needed
5904 if the server requires a client certificate.
5906 Default: \fBssl client cert = /usr/local/ssl/certs/smbclient.pem
5908 \fBssl client key (G)\fR
5909 This variable is part of SSL-enabled Samba. This
5910 is only available if the SSL libraries have been compiled on your
5911 system and the configure option \fB--with-ssl\fR was
5912 given at configure time.
5914 \fBNote\fR that for export control reasons
5915 this code is \fBNOT\fR enabled by default in any
5916 current binary version of Samba.
5918 This is the private key for \fBsmbclient(1)\fR. It's only needed if the
5919 client should have a certificate.
5921 Default: \fBssl client key = /usr/local/ssl/private/smbclient.pem
5923 \fBssl compatibility (G)\fR
5924 This variable is part of SSL-enabled Samba. This
5925 is only available if the SSL libraries have been compiled on your
5926 system and the configure option \fB--with-ssl\fR was
5927 given at configure time.
5929 \fBNote\fR that for export control reasons
5930 this code is \fBNOT\fR enabled by default in any
5931 current binary version of Samba.
5933 This variable defines whether SSLeay should be configured
5934 for bug compatibility with other SSL implementations. This is
5935 probably not desirable because currently no clients with SSL
5936 implementations other than SSLeay exist.
5938 Default: \fBssl compatibility = no\fR
5941 See \fI ssl hosts resign\fR.
5943 \fBssl hosts resign (G)\fR
5944 This variable is part of SSL-enabled Samba. This
5945 is only available if the SSL libraries have been compiled on your
5946 system and the configure option \fB--with-ssl\fR was
5947 given at configure time.
5949 \fBNote\fR that for export control reasons
5950 this code is \fBNOT\fR enabled by default in any
5951 current binary version of Samba.
5953 These two variables define whether samba will go
5954 into SSL mode or not. If none of them is defined, samba will
5955 allow only SSL connections. If the \fIssl hosts\fR variable lists
5956 hosts (by IP-address, IP-address range, net group or name),
5957 only these hosts will be forced into SSL mode. If the \fI ssl hosts resign\fR variable lists hosts, only these
5958 hosts will NOT be forced into SSL mode. The syntax for these two
5959 variables is the same as for the \fI hosts allow\fR and \fIhosts deny\fR pair of variables, only
5960 that the subject of the decision is different: It's not the access
5961 right but whether SSL is used or not.
5963 The example below requires SSL connections from all hosts
5964 outside the local net (which is 192.168.*.*).
5966 Default: \fBssl hosts = <empty string>\fR
5968 \fBssl hosts resign = <empty string>\fR
5970 Example: \fBssl hosts resign = 192.168.\fR
5972 \fBssl require clientcert (G)\fR
5973 This variable is part of SSL-enabled Samba. This
5974 is only available if the SSL libraries have been compiled on your
5975 system and the configure option \fB--with-ssl\fR was
5976 given at configure time.
5978 \fBNote\fR that for export control reasons
5979 this code is \fBNOT\fR enabled by default in any
5980 current binary version of Samba.
5982 If this variable is set to yes, the
5983 server will not tolerate connections from clients that don't
5984 have a valid certificate. The directory/file given in \fIssl CA certDir\fR
5985 and \fIssl CA certFile
5986 \fRwill be used to look up the CAs that issued
5987 the client's certificate. If the certificate can't be verified
5988 positively, the connection will be terminated. If this variable
5989 is set to no, clients don't need certificates.
5990 Contrary to web applications you really \fBshould\fR
5991 require client certificates. In the web environment the client's
5992 data is sensitive (credit card numbers) and the server must prove
5993 to be trustworthy. In a file server environment the server's data
5994 will be sensitive and the clients must prove to be trustworthy.
5996 Default: \fBssl require clientcert = no\fR
5998 \fBssl require servercert (G)\fR
5999 This variable is part of SSL-enabled Samba. This
6000 is only available if the SSL libraries have been compiled on your
6001 system and the configure option \fB--with-ssl\fR was
6002 given at configure time.
6004 \fBNote\fR that for export control reasons
6005 this code is \fBNOT\fR enabled by default in any
6006 current binary version of Samba.
6008 If this variable is set to yes, the
6010 will request a certificate from the server. Same as
6012 clientcert\fR for the server.
6014 Default: \fBssl require servercert = no\fR
6016 \fBssl server cert (G)\fR
6017 This variable is part of SSL-enabled Samba. This
6018 is only available if the SSL libraries have been compiled on your
6019 system and the configure option \fB--with-ssl\fR was
6020 given at configure time.
6022 \fBNote\fR that for export control reasons
6023 this code is \fBNOT\fR enabled by default in any
6024 current binary version of Samba.
6026 This is the file containing the server's certificate.
6027 The server \fBmust\fR have a certificate. The
6028 file may also contain the server's private key. See later for
6029 how certificates and private keys are created.
6031 Default: \fBssl server cert = <empty string>
6033 \fBssl server key (G)\fR
6034 This variable is part of SSL-enabled Samba. This
6035 is only available if the SSL libraries have been compiled on your
6036 system and the configure option \fB--with-ssl\fR was
6037 given at configure time.
6039 \fBNote\fR that for export control reasons
6040 this code is \fBNOT\fR enabled by default in any
6041 current binary version of Samba.
6043 This file contains the private key of the server. If
6044 this variable is not defined, the key is looked up in the
6045 certificate file (it may be appended to the certificate).
6046 The server \fBmust\fR have a private key
6047 and the certificate \fBmust\fR
6048 match this private key.
6050 Default: \fBssl server key = <empty string>
6052 \fBssl version (G)\fR
6053 This variable is part of SSL-enabled Samba. This
6054 is only available if the SSL libraries have been compiled on your
6055 system and the configure option \fB--with-ssl\fR was
6056 given at configure time.
6058 \fBNote\fR that for export control reasons
6059 this code is \fBNOT\fR enabled by default in any
6060 current binary version of Samba.
6062 This enumeration variable defines the versions of the
6063 SSL protocol that will be used. ssl2or3 allows
6064 dynamic negotiation of SSL v2 or v3, ssl2 results
6065 in SSL v2, ssl3 results in SSL v3 and
6066 tls1 results in TLS v1. TLS (Transport Layer
6067 Security) is the new standard for SSL.
6069 Default: \fBssl version = "ssl2or3"\fR
6071 \fBstat cache (G)\fR
6072 This parameter determines if smbd(8)will use a cache in order to
6073 speed up case insensitive name mappings. You should never need
6074 to change this parameter.
6076 Default: \fBstat cache = yes\fR
6078 \fBstat cache size (G)\fR
6079 This parameter determines the number of
6080 entries in the \fIstat cache\fR. You should
6081 never need to change this parameter.
6083 Default: \fBstat cache size = 50\fR
6086 This enables or disables logging of connections
6087 to a status file that smbstatus(1)can read.
6089 With this disabled \fBsmbstatus\fR won't be able
6090 to tell you what connections are active. You should never need to
6091 change this parameter.
6093 Default: \fBstatus = yes\fR
6095 \fBstrict locking (S)\fR
6096 This is a boolean that controls the handling of
6097 file locking in the server. When this is set to yes
6098 the server will check every read and write access for file locks, and
6099 deny access if locks exist. This can be slow on some systems.
6101 When strict locking is no the server does file
6102 lock checks only when the client explicitly asks for them.
6104 Well behaved clients always ask for lock checks when it
6105 is important, so in the vast majority of cases \fBstrict
6106 locking = no\fR is preferable.
6108 Default: \fBstrict locking = no\fR
6110 \fBstrict sync (S)\fR
6111 Many Windows applications (including the Windows
6112 98 explorer shell) seem to confuse flushing buffer contents to
6113 disk with doing a sync to disk. Under UNIX, a sync call forces
6114 the process to be suspended until the kernel has ensured that
6115 all outstanding data in kernel disk buffers has been safely stored
6116 onto stable storage. This is very slow and should only be done
6117 rarely. Setting this parameter to no (the
6118 default) means that smbd ignores the Windows applications requests for
6119 a sync call. There is only a possibility of losing data if the
6120 operating system itself that Samba is running on crashes, so there is
6121 little danger in this default setting. In addition, this fixes many
6122 performance problems that people have reported with the new Windows98
6123 explorer shell file copies.
6125 See also the \fIsync
6126 always>\fR parameter.
6128 Default: \fBstrict sync = no\fR
6131 This is a boolean that controls whether to
6132 strip trailing dots off UNIX filenames. This helps with some
6133 CDROMs that have filenames ending in a single dot.
6135 Default: \fBstrip dot = no\fR
6137 \fBsync always (S)\fR
6138 This is a boolean parameter that controls
6139 whether writes will always be written to stable storage before
6140 the write call returns. If this is false then the server will be
6141 guided by the client's request in each write call (clients can
6142 set a bit indicating that a particular write should be synchronous).
6143 If this is true then every write will be followed by a \fBfsync()
6144 \fRcall to ensure the data is written to disk. Note that
6145 the \fIstrict sync\fR parameter must be set to
6146 yes in order for this parameter to have
6149 See also the \fIstrict
6152 Default: \fBsync always = no\fR
6155 This parameter maps how Samba debug messages
6156 are logged onto the system syslog logging levels. Samba debug
6157 level zero maps onto syslog LOG_ERR, debug
6158 level one maps onto LOG_WARNING, debug level
6159 two maps onto LOG_NOTICE, debug level three
6160 maps onto LOG_INFO. All higher levels are mapped to LOG_DEBUG.
6162 This parameter sets the threshold for sending messages
6163 to syslog. Only messages with debug level less than this value
6164 will be sent to syslog.
6166 Default: \fBsyslog = 1\fR
6168 \fBsyslog only (G)\fR
6169 If this parameter is set then Samba debug
6170 messages are logged into the system syslog only, and not to
6171 the debug log files.
6173 Default: \fBsyslog only = no\fR
6175 \fBtemplate homedir (G)\fR
6176 \fBNOTE:\fR this parameter is
6177 only available in Samba 3.0.
6179 When filling out the user information for a Windows NT
6180 user, the winbindd(8)daemon
6181 uses this parameter to fill in the home directory for that user.
6182 If the string \fI%D\fR is present it is substituted
6183 with the user's Windows NT domain name. If the string \fI%U
6184 \fRis present it is substituted with the user's Windows
6187 Default: \fBtemplate homedir = /home/%D/%U\fR
6189 \fBtemplate shell (G)\fR
6190 \fBNOTE:\fR this parameter is
6191 only available in Samba 3.0.
6193 When filling out the user information for a Windows NT
6194 user, the winbindd(8)daemon
6195 uses this parameter to fill in the login shell for that user.
6197 Default: \fBtemplate shell = /bin/false\fR
6199 \fBtime offset (G)\fR
6200 This parameter is a setting in minutes to add
6201 to the normal GMT to local time conversion. This is useful if
6202 you are serving a lot of PCs that have incorrect daylight
6203 saving time handling.
6205 Default: \fBtime offset = 0\fR
6207 Example: \fBtime offset = 60\fR
6209 \fBtime server (G)\fR
6210 This parameter determines if
6211 nmbd(8)advertises itself as a time server to Windows
6214 Default: \fBtime server = no\fR
6216 \fBtimestamp logs (G)\fR
6217 Synonym for \fI debug timestamp\fR.
6219 \fBtotal print jobs (G)\fR
6220 This parameter accepts an integer value which defines
6221 a limit on the maximum number of print jobs that will be accepted
6222 system wide at any given time. If a print job is submitted
6223 by a client which will exceed this number, then smbd will return an
6224 error indicating that no space is available on the server. The
6225 default value of 0 means that no such limit exists. This parameter
6226 can be used to prevent a server from exceeding its capacity and is
6227 designed as a printing throttle. See also
6228 \fImax print jobs\fR.
6230 Default: \fBtotal print jobs = 0\fR
6232 Example: \fBtotal print jobs = 5000\fR
6234 \fBunix password sync (G)\fR
6235 This boolean parameter controls whether Samba
6236 attempts to synchronize the UNIX password with the SMB password
6237 when the encrypted SMB password in the smbpasswd file is changed.
6238 If this is set to true the program specified in the \fIpasswd
6239 program\fRparameter is called \fBAS ROOT\fR -
6240 to allow the new UNIX password to be set without access to the
6241 old UNIX password (as the SMB password has change code has no
6242 access to the old password cleartext, only the new).
6245 program\fR, \fI passwd chat\fR.
6247 Default: \fBunix password sync = no\fR
6249 \fBupdate encrypted (G)\fR
6250 This boolean parameter allows a user logging
6251 on with a plaintext password to have their encrypted (hashed)
6252 password in the smbpasswd file to be updated automatically as
6253 they log on. This option allows a site to migrate from plaintext
6254 password authentication (users authenticate with plaintext
6255 password over the wire, and are checked against a UNIX account
6256 database) to encrypted password authentication (the SMB
6257 challenge/response authentication mechanism) without forcing
6258 all users to re-enter their passwords via smbpasswd at the time the
6259 change is made. This is a convenience option to allow the change over
6260 to encrypted passwords to be made over a longer period. Once all users
6261 have encrypted representations of their passwords in the smbpasswd
6262 file this parameter should be set to no.
6264 In order for this parameter to work correctly the \fIencrypt passwords\fR
6265 parameter must be set to no when
6266 this parameter is set to yes.
6268 Note that even when this parameter is set a user
6269 authenticating to \fBsmbd\fR must still enter a valid
6270 password in order to connect correctly, and to update their hashed
6271 (smbpasswd) passwords.
6273 Default: \fBupdate encrypted = no\fR
6275 \fBuse rhosts (G)\fR
6276 If this global parameter is a true, it specifies
6277 that the UNIX users \fI.rhosts\fR file in their home directory
6278 will be read to find the names of hosts and users who will be allowed
6279 access without specifying a password.
6281 \fBNOTE:\fR The use of \fIuse rhosts
6282 \fRcan be a major security hole. This is because you are
6283 trusting the PC to supply the correct username. It is very easy to
6284 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
6287 Default: \fBuse rhosts = no\fR
6290 Synonym for \fI username\fR.
6293 Synonym for \fI username\fR.
6296 Multiple users may be specified in a comma-delimited
6297 list, in which case the supplied password will be tested against
6298 each username in turn (left to right).
6300 The \fIusername\fR line is needed only when
6301 the PC is unable to supply its own username. This is the case
6302 for the COREPLUS protocol or where your users have different WfWg
6303 usernames to UNIX usernames. In both these cases you may also be
6304 better using the \\\\server\\share%user syntax instead.
6306 The \fIusername\fR line is not a great
6307 solution in many cases as it means Samba will try to validate
6308 the supplied password against each of the usernames in the
6309 \fIusername\fR line in turn. This is slow and
6310 a bad idea for lots of users in case of duplicate passwords.
6311 You may get timeouts or security breaches using this parameter
6314 Samba relies on the underlying UNIX security. This
6315 parameter does not restrict who can login, it just offers hints
6316 to the Samba server as to what usernames might correspond to the
6317 supplied password. Users can login as whoever they please and
6318 they will be able to do no more damage than if they started a
6319 telnet session. The daemon runs as the user that they log in as,
6320 so they cannot do anything that user cannot do.
6322 To restrict a service to a particular set of users you
6323 can use the \fIvalid users
6326 If any of the usernames begin with a '@' then the name
6327 will be looked up first in the yp netgroups list (if Samba
6328 is compiled with netgroup support), followed by a lookup in
6329 the UNIX groups database and will expand to a list of all users
6330 in the group of that name.
6332 If any of the usernames begin with a '+' then the name
6333 will be looked up only in the UNIX groups database and will
6334 expand to a list of all users in the group of that name.
6336 If any of the usernames begin with a '&'then the name
6337 will be looked up only in the yp netgroups database (if Samba
6338 is compiled with netgroup support) and will expand to a list
6339 of all users in the netgroup group of that name.
6341 Note that searching though a groups database can take
6342 quite some time, and some clients may time out during the
6345 See the section NOTE ABOUT
6346 USERNAME/PASSWORD VALIDATION for more information on how
6347 this parameter determines access to the services.
6349 Default: \fBThe guest account if a guest service,
6350 else <empty string>.\fR
6352 Examples:\fBusername = fred, mary, jack, jane,
6355 \fBusername level (G)\fR
6356 This option helps Samba to try and 'guess' at
6357 the real UNIX username, as many DOS clients send an all-uppercase
6358 username. By default Samba tries all lowercase, followed by the
6359 username with the first letter capitalized, and fails if the
6360 username is not found on the UNIX machine.
6362 If this parameter is set to non-zero the behavior changes.
6363 This parameter is a number that specifies the number of uppercase
6364 combinations to try while trying to determine the UNIX user name. The
6365 higher the number the more combinations will be tried, but the slower
6366 the discovery of usernames will be. Use this parameter when you have
6367 strange usernames on your UNIX machine, such as AstrangeUser
6370 Default: \fBusername level = 0\fR
6372 Example: \fBusername level = 5\fR
6374 \fBusername map (G)\fR
6375 This option allows you to specify a file containing
6376 a mapping of usernames from the clients to the server. This can be
6377 used for several purposes. The most common is to map usernames
6378 that users use on DOS or Windows machines to those that the UNIX
6379 box uses. The other is to map multiple users to a single username
6380 so that they can more easily share files.
6382 The map file is parsed line by line. Each line should
6383 contain a single UNIX username on the left then a '=' followed
6384 by a list of usernames on the right. The list of usernames on the
6385 right may contain names of the form @group in which case they
6386 will match any UNIX username in that group. The special client
6387 name '*' is a wildcard and matches any name. Each line of the
6388 map file may be up to 1023 characters long.
6390 The file is processed on each line by taking the
6391 supplied username and comparing it with each username on the right
6392 hand side of the '=' signs. If the supplied name matches any of
6393 the names on the right hand side then it is replaced with the name
6394 on the left. Processing then continues with the next line.
6396 If any line begins with a '#' or a ';' then it is
6399 If any line begins with an '!' then the processing
6400 will stop after that line if a mapping was done by the line.
6401 Otherwise mapping continues with every line being processed.
6402 Using '!' is most useful when you have a wildcard mapping line
6405 For example to map from the name admin
6406 or administrator to the UNIX name root you would use:
6408 \fBroot = admin administrator\fR
6410 Or to map anyone in the UNIX group system
6411 to the UNIX name sys you would use:
6415 You can have as many mappings as you like in a username
6418 If your system supports the NIS NETGROUP option then
6419 the netgroup database is checked before the \fI/etc/group
6420 \fRdatabase for matching groups.
6422 You can map Windows usernames that have spaces in them
6423 by using double quotes around the name. For example:
6425 \fBtridge = "Andrew Tridgell"\fR
6427 would map the windows username "Andrew Tridgell" to the
6428 unix username "tridge".
6430 The following example would map mary and fred to the
6431 unix user sys, and map the rest to guest. Note the use of the
6432 \&'!' to tell Samba to stop processing if it gets a match on
6443 Note that the remapping is applied to all occurrences
6444 of usernames. Thus if you connect to \\\\server\\fred and fred is remapped to mary then you
6445 will actually be connecting to \\\\server\\mary and will need to
6446 supply a password suitable for mary not
6447 fred. The only exception to this is the
6448 username passed to the \fI password server\fR (if you have one). The password
6449 server will receive whatever username the client supplies without
6452 Also note that no reverse mapping is done. The main effect
6453 this has is with printing. Users who have been mapped may have
6454 trouble deleting print jobs as PrintManager under WfWg will think
6455 they don't own the print job.
6457 Default: \fBno username map\fR
6459 Example: \fBusername map = /usr/local/samba/lib/users.map
6462 This boolean parameter is only available if
6463 Samba has been configured and compiled with the option \fB --with-utmp\fR. If set to True then Samba will attempt
6464 to add utmp or utmpx records (depending on the UNIX system) whenever a
6465 connection is made to a Samba server. Sites may use this to record the
6466 user connecting to a Samba share.
6468 See also the \fI utmp directory\fR parameter.
6470 Default: \fButmp = no\fR
6472 \fButmp directory(G)\fR
6473 This parameter is only available if Samba has
6474 been configured and compiled with the option \fB --with-utmp\fR. It specifies a directory pathname that is
6475 used to store the utmp or utmpx files (depending on the UNIX system) that
6476 record user connections to a Samba server. See also the \fIutmp\fR parameter. By default this is
6477 not set, meaning the system will use whatever utmp file the
6478 native system is set to use (usually
6479 \fI/var/run/utmp\fR on Linux).
6481 Default: \fBno utmp directory\fR
6483 \fBvalid chars (G)\fR
6484 The option allows you to specify additional
6485 characters that should be considered valid by the server in
6486 filenames. This is particularly useful for national character
6487 sets, such as adding u-umlaut or a-ring.
6489 The option takes a list of characters in either integer
6490 or character form with spaces between them. If you give two
6491 characters with a colon between them then it will be taken as
6492 an lowercase:uppercase pair.
6494 If you have an editor capable of entering the characters
6495 into the config file then it is probably easiest to use this
6496 method. Otherwise you can specify the characters in octal,
6497 decimal or hexadecimal form using the usual C notation.
6499 For example to add the single character 'Z' to the charset
6500 (which is a pointless thing to do as it's already there) you could
6501 do one of the following
6507 valid chars = 0132:0172
6512 The last two examples above actually add two characters,
6513 and alter the uppercase and lowercase mappings appropriately.
6515 Note that you \fBMUST\fR specify this parameter
6516 after the \fIclient code page\fR parameter if you
6517 have both set. If \fIclient code page\fR is set after
6518 the \fIvalid chars\fR parameter the \fIvalid
6519 chars\fR settings will be overwritten.
6521 See also the \fIclient
6522 code page\fR parameter.
6524 Default: \fBSamba defaults to using a reasonable set
6525 of valid characters for English systems\fR
6527 Example: \fBvalid chars = 0345:0305 0366:0326 0344:0304
6529 The above example allows filenames to have the Swedish
6532 \fBNOTE:\fR It is actually quite difficult to
6533 correctly produce a \fIvalid chars\fR line for
6534 a particular system. To automate the process tino@augsburg.net <URL:mailto:tino@augsburg.net> has written
6535 a package called \fBvalidchars\fR which will automatically
6536 produce a complete \fIvalid chars\fR line for
6537 a given client system. Look in the \fIexamples/validchars/
6538 \fRsubdirectory of your Samba source code distribution
6541 \fBvalid users (S)\fR
6542 This is a list of users that should be allowed
6543 to login to this service. Names starting with '@', '+' and '&'
6544 are interpreted using the same rules as described in the
6545 \fIinvalid users\fR parameter.
6547 If this is empty (the default) then any user can login.
6548 If a username is in both this list and the \fIinvalid
6549 users\fR list then access is denied for that user.
6551 The current servicename is substituted for \fI%S
6552 \fR\&. This is useful in the [homes] section.
6554 See also \fIinvalid users
6556 Default: \fBNo valid users list (anyone can login)
6558 Example: \fBvalid users = greg, @pcusers\fR
6561 This is a list of files and directories that
6562 are neither visible nor accessible. Each entry in the list must
6563 be separated by a '/', which allows spaces to be included
6564 in the entry. '*' and '?' can be used to specify multiple files
6565 or directories as in DOS wildcards.
6567 Each entry must be a unix path, not a DOS path and
6568 must \fBnot\fR include the unix directory
6571 Note that the \fIcase sensitive\fR option
6572 is applicable in vetoing files.
6574 One feature of the veto files parameter that it is important
6575 to be aware of, is that if a directory contains nothing but files
6576 that match the veto files parameter (which means that Windows/DOS
6577 clients cannot ever see them) is deleted, the veto files within
6578 that directory \fBare automatically deleted\fR along
6579 with it, if the user has UNIX permissions to do so.
6581 Setting this parameter will affect the performance
6582 of Samba, as it will be forced to check all files and directories
6583 for a match as they are scanned.
6585 See also \fIhide files
6586 \fRand \fI case sensitive\fR.
6588 Default: \fBNo files or directories are vetoed.
6593 ; Veto any files containing the word Security,
6594 ; any ending in .tmp, and any directory containing the
6596 veto files = /*Security*/*.tmp/*root*/
6598 ; Veto the Apple specific files that a NetAtalk server
6600 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
6605 \fBveto oplock files (S)\fR
6606 This parameter is only valid when the \fIoplocks\fR
6607 parameter is turned on for a share. It allows the Samba administrator
6608 to selectively turn off the granting of oplocks on selected files that
6609 match a wildcarded list, similar to the wildcarded list used in the
6613 Default: \fBNo files are vetoed for oplock
6616 You might want to do this on files that you know will
6617 be heavily contended for by clients. A good example of this
6618 is in the NetBench SMB benchmark program, which causes heavy
6619 client contention for files ending in \fI.SEM\fR.
6620 To cause Samba not to grant oplocks on these files you would use
6621 the line (either in the [global] section or in the section for
6622 the particular NetBench share :
6624 Example: \fBveto oplock files = /*;.SEM/
6626 \fBvfs object (S)\fR
6627 This parameter specifies a shared object file that
6628 is used for Samba VFS I/O operations. By default, normal
6629 disk I/O operations are used but these can be overloaded
6630 with a VFS object. The Samba VFS layer is new to Samba 2.2 and
6631 must be enabled at compile time with --with-vfs.
6633 Default : \fBno value\fR
6635 \fBvfs options (S)\fR
6636 This parameter allows parameters to be passed
6637 to the vfs layer at initialisation time. The Samba VFS layer
6638 is new to Samba 2.2 and must be enabled at compile time
6639 with --with-vfs. See also \fI vfs object\fR.
6641 Default : \fBno value\fR
6644 This allows you to override the volume label
6645 returned for a share. Useful for CDROMs with installation programs
6646 that insist on a particular volume label.
6648 Default: \fBthe name of the share\fR
6650 \fBwide links (S)\fR
6651 This parameter controls whether or not links
6652 in the UNIX file system may be followed by the server. Links
6653 that point to areas within the directory tree exported by the
6654 server are always allowed; this parameter controls access only
6655 to areas that are outside the directory tree being exported.
6657 Note that setting this parameter can have a negative
6658 effect on your server performance due to the extra system calls
6659 that Samba has to do in order to perform the link checks.
6661 Default: \fBwide links = yes\fR
6663 \fBwinbind cache time\fR
6664 \fBNOTE:\fR this parameter is only
6665 available in Samba 3.0.
6667 This parameter specifies the number of seconds the
6668 winbindd(8)daemon will cache
6669 user and group information before querying a Windows NT server
6672 Default: \fBwinbind cache type = 15\fR
6675 \fBNOTE:\fR this parameter is only
6676 available in Samba 3.0.
6678 The winbind gid parameter specifies the range of group
6679 ids that are allocated by the winbindd(8)daemon. This range of group ids should have no
6680 existing local or nis groups within it as strange conflicts can
6683 Default: \fBwinbind gid = <empty string>
6685 Example: \fBwinbind gid = 10000-20000\fR
6687 \fBwinbind separator\fR
6688 \fBNOTE:\fR this parameter is only
6689 available in Samba 3.0.
6691 This parameter allows an admin to define the character
6692 used when listing a username of the form of \fIDOMAIN
6693 \fR\\\fIuser\fR. This parameter
6694 is only applicable when using the \fIpam_winbind.so\fR
6695 and \fInss_winbind.so\fR modules for UNIX services.
6697 Example: \fBwinbind separator = \\\fR
6699 Example: \fBwinbind separator = +\fR
6702 \fBNOTE:\fR this parameter is only
6703 available in Samba 3.0.
6705 The winbind gid parameter specifies the range of group
6706 ids that are allocated by the winbindd(8)daemon. This range of ids should have no
6707 existing local or nis users within it as strange conflicts can
6710 Default: \fBwinbind uid = <empty string>
6712 Example: \fBwinbind uid = 10000-20000\fR
6715 When Samba is running as a WINS server this
6716 allows you to call an external program for all changes to the
6717 WINS database. The primary use for this option is to allow the
6718 dynamic update of external name resolution databases such as
6721 The wins hook parameter specifies the name of a script
6722 or executable that will be called as follows:
6724 \fBwins_hook operation name nametype ttl IP_list
6728 The first argument is the operation and is one
6729 of "add", "delete", or "refresh". In most cases the operation can
6730 be ignored as the rest of the parameters provide sufficient
6731 information. Note that "refresh" may sometimes be called when the
6732 name has not previously been added, in that case it should be treated
6736 The second argument is the netbios name. If the
6737 name is not a legal name then the wins hook is not called.
6738 Legal names contain only letters, digits, hyphens, underscores
6742 The third argument is the netbios name
6743 type as a 2 digit hexadecimal number.
6746 The fourth argument is the TTL (time to live)
6747 for the name in seconds.
6750 The fifth and subsequent arguments are the IP
6751 addresses currently registered for that name. If this list is
6752 empty then the name should be deleted.
6755 An example script that calls the BIND dynamic DNS update
6756 program \fBnsupdate\fR is provided in the examples
6757 directory of the Samba source code.
6760 \fBwins proxy (G)\fR
6761 This is a boolean that controls if nmbd(8)will respond to broadcast name
6762 queries on behalf of other hosts. You may need to set this
6763 to yes for some older clients.
6765 Default: \fBwins proxy = no\fR
6767 \fBwins server (G)\fR
6768 This specifies the IP address (or DNS name: IP
6769 address for preference) of the WINS server that nmbd(8)should register with. If you have a WINS server on
6770 your network then you should set this to the WINS server's IP.
6772 You should point this at your WINS server if you have a
6773 multi-subnetted network.
6775 \fBNOTE\fR. You need to set up Samba to point
6776 to a WINS server if you have multiple subnets and wish cross-subnet
6777 browsing to work correctly.
6779 See the documentation file \fIBROWSING.txt\fR
6780 in the docs/ directory of your Samba source distribution.
6782 Default: \fBnot enabled\fR
6784 Example: \fBwins server = 192.9.200.1\fR
6786 \fBwins support (G)\fR
6787 This boolean controls if the
6788 nmbd(8)process in Samba will act as a WINS server. You should
6789 not set this to true unless you have a multi-subnetted network and
6790 you wish a particular \fBnmbd\fR to be your WINS server.
6791 Note that you should \fBNEVER\fR set this to true
6792 on more than one machine in your network.
6794 Default: \fBwins support = no\fR
6797 This controls what workgroup your server will
6798 appear to be in when queried by clients. Note that this parameter
6799 also controls the Domain name used with the \fBsecurity=domain\fR
6802 Default: \fBset at compile time to WORKGROUP\fR
6804 Example: \fBworkgroup = MYGROUP\fR
6807 Synonym for \fI writeable\fR for people who can't spell :-).
6809 \fBwrite cache size (S)\fR
6810 If this integer parameter is set to non-zero value,
6811 Samba will create an in-memory cache for each oplocked file
6812 (it does \fBnot\fR do this for
6813 non-oplocked files). All writes that the client does not request
6814 to be flushed directly to disk will be stored in this cache if possible.
6815 The cache is flushed onto disk when a write comes in whose offset
6816 would not fit into the cache or when the file is closed by the client.
6817 Reads for the file are also served from this cache if the data is stored
6820 This cache allows Samba to batch client writes into a more
6821 efficient write size for RAID disks (ie. writes may be tuned to
6822 be the RAID stripe size) and can improve performance on systems
6823 where the disk subsystem is a bottleneck but there is free
6824 memory for userspace programs.
6826 The integer parameter specifies the size of this cache
6827 (per oplocked file) in bytes.
6829 Default: \fBwrite cache size = 0\fR
6831 Example: \fBwrite cache size = 262144\fR
6833 for a 256k cache size per file.
6835 \fBwrite list (S)\fR
6836 This is a list of users that are given read-write
6837 access to a service. If the connecting user is in this list then
6838 they will be given write access, no matter what the \fIwriteable\fR
6839 option is set to. The list can include group names using the
6842 Note that if a user is in both the read list and the
6843 write list then they will be given write access.
6845 See also the \fIread list
6848 Default: \fBwrite list = <empty string>
6850 Example: \fBwrite list = admin, root, @staff
6853 Synonym for \fI writeable\fR.
6856 This parameter controls whether or not the server
6857 will support raw writes SMB's when transferring data from clients.
6858 You should never need to change this parameter.
6860 Default: \fBwrite raw = yes\fR
6863 An inverted synonym is \fIread only\fR.
6865 If this parameter is no, then users
6866 of a service may not create or modify files in the service's
6869 Note that a printable service (\fBprintable = yes\fR)
6870 will \fBALWAYS\fR allow writing to the directory
6871 (user privileges permitting), but only via spooling operations.
6873 Default: \fBwriteable = no\fR
6876 Although the configuration file permits service names
6877 to contain spaces, your client software may not. Spaces will
6878 be ignored in comparisons anyway, so it shouldn't be a
6879 problem - but be aware of the possibility.
6881 On a similar note, many clients - especially DOS clients -
6882 limit service names to eight characters. smbd(8)
6883 has no such limitation, but attempts to connect from such
6884 clients will fail if they truncate the service names. For this reason
6885 you should probably keep your service names down to eight characters
6888 Use of the [homes] and [printers] special sections make life
6889 for an administrator easy, but the various combinations of default
6890 attributes can be tricky. Take extreme care when designing these
6891 sections. In particular, ensure that the permissions on spool
6892 directories are correct.
6895 This man page is correct for version 2.2 of
6907 \fBtestprns(1)\fR.SH "AUTHOR"
6909 The original Samba software and related utilities
6910 were created by Andrew Tridgell. Samba is now developed
6911 by the Samba Team as an Open Source project similar
6912 to the way the Linux kernel is developed.
6914 The original Samba man pages were written by Karl Auer.
6915 The man page sources were converted to YODL format (another
6916 excellent piece of Open Source software, available at
6917 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0
6918 release by Jeremy Allison. The conversion to DocBook for
6919 Samba 2.2 was done by Gerald Carter