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" "27 July 2002" "" ""
8 smb.conf \- The configuration file for the Samba suite
11 The \fIsmb.conf\fR file is a configuration
12 file for the Samba suite. \fIsmb.conf\fR contains
13 runtime configuration information for the Samba programs. The
14 \fIsmb.conf\fR file is designed to be configured and
15 administered by the \fBswat(8)\fR
16 program. The complete description of the file format and
17 possible parameters held within are here for reference purposes.
20 The file consists of sections and parameters. A section
21 begins with the name of the section in square brackets and continues
22 until the next section begins. Sections contain parameters of the
27 The file is line-based - that is, each newline-terminated
28 line represents either a comment, a section name or a parameter.
30 Section and parameter names are not case sensitive.
32 Only the first equals sign in a parameter is significant.
33 Whitespace before or after the first equals sign is discarded.
34 Leading, trailing and internal whitespace in section and parameter
35 names is irrelevant. Leading and trailing whitespace in a parameter
36 value is discarded. Internal whitespace within a parameter value
39 Any line beginning with a semicolon (';') or a hash ('#')
40 character is ignored, as are lines containing only whitespace.
42 Any line ending in a '\\' is continued
43 on the next line in the customary UNIX fashion.
45 The values following the equals sign in parameters are all
46 either a string (no quotes needed) or a boolean, which may be given
47 as yes/no, 0/1 or true/false. Case is not significant in boolean
48 values, but is preserved in string values. Some items such as
49 create modes are numeric.
50 .SH "SECTION DESCRIPTIONS"
52 Each section in the configuration file (except for the
53 [global] section) describes a shared resource (known
54 as a "share"). The section name is the name of the
55 shared resource and the parameters within the section define
56 the shares attributes.
58 There are three special sections, [global],
59 [homes] and [printers], which are
60 described under \fBspecial sections\fR. The
61 following notes apply to ordinary section descriptions.
63 A share consists of a directory to which access is being
64 given plus a description of the access rights which are granted
65 to the user of the service. Some housekeeping options are
68 Sections are either file share services (used by the
69 client as an extension of their native file systems) or
70 printable services (used by the client to access print services
71 on the host running the server).
73 Sections may be designated \fBguest\fR services,
74 in which case no password is required to access them. A specified
75 UNIX \fBguest account\fR is used to define access
76 privileges in this case.
78 Sections other than guest services will require a password
79 to access them. The client provides the username. As older clients
80 only provide passwords and not usernames, you may specify a list
81 of usernames to check against the password using the "user ="
82 option in the share definition. For modern clients such as
83 Windows 95/98/ME/NT/2000, this should not be necessary.
85 Note that the access rights granted by the server are
86 masked by the access rights granted to the specified or guest
87 UNIX user by the host system. The server does not grant more
88 access than the host system grants.
90 The following sample section defines a file space share.
91 The user has write access to the path \fI/home/bar\fR.
92 The share is accessed via the share name "foo":
103 The following sample section defines a printable share.
104 The share is readonly, but printable. That is, the only write
105 access permitted is via calls to open, write to and close a
106 spool file. The \fBguest ok\fR parameter means
107 access will be permitted as the default guest user (specified
112 path = /usr/spool/public
120 .SH "SPECIAL SECTIONS"
121 .SS "THE GLOBAL SECTION"
123 parameters in this section apply to the server
124 as a whole, or are defaults for sections which do not
125 specifically define certain items. See the notes
126 under PARAMETERS for more information.
127 .SS "THE HOMES SECTION"
129 If a section called homes is included in the
130 configuration file, services connecting clients to their
131 home directories can be created on the fly by the server.
133 When the connection request is made, the existing
134 sections are scanned. If a match is found, it is used. If no
135 match is found, the requested section name is treated as a
136 user name and looked up in the local password file. If the
137 name exists and the correct password has been given, a share is
138 created by cloning the [homes] section.
140 Some modifications are then made to the newly
144 The share name is changed from homes to
145 the located username.
148 If no path was given, the path is set to
149 the user's home directory.
151 If you decide to use a \fBpath =\fR line
152 in your [homes] section then you may find it useful
153 to use the %S macro. For example :
156 \fBpath = /data/pchome/%S\fR
159 would be useful if you have different home directories
160 for your PCs than for UNIX access.
163 This is a fast and simple way to give a large number
164 of clients access to their home directories with a minimum
168 A similar process occurs if the requested section
169 name is "homes", except that the share name is not
170 changed to that of the requesting user. This method of using
171 the [homes] section works well if different users share
175 The [homes] section can specify all the parameters
176 a normal service section can specify, though some make more sense
177 than others. The following is a typical and suitable [homes]
189 An important point is that if guest access is specified
190 in the [homes] section, all home directories will be
191 visible to all clients \fBwithout a password\fR.
192 In the very unlikely event that this is actually desirable, it
193 would be wise to also specify \fBread only
197 Note that the \fBbrowseable\fR flag for
198 auto home directories will be inherited from the global browseable
199 flag, not the [homes] browseable flag. This is useful as
200 it means setting \fBbrowseable = no\fR in
201 the [homes] section will hide the [homes] share but make
202 any auto home directories visible.
204 .SS "THE PRINTERS SECTION"
206 This section works like [homes],
209 If a [printers] section occurs in the
210 configuration file, users are able to connect to any printer
211 specified in the local host's printcap file.
213 When a connection request is made, the existing sections
214 are scanned. If a match is found, it is used. If no match is found,
215 but a [homes] section exists, it is used as described
216 above. Otherwise, the requested section name is treated as a
217 printer name and the appropriate printcap file is scanned to see
218 if the requested section name is a valid printer share name. If
219 a match is found, a new printer share is created by cloning
220 the [printers] section.
222 A few modifications are then made to the newly created
226 The share name is set to the located printer
230 If no printer name was given, the printer name
231 is set to the located printer name
234 If the share does not permit guest access and
235 no username was given, the username is set to the located
238 Note that the [printers] service MUST be
239 printable - if you specify otherwise, the server will refuse
240 to load the configuration file.
243 Typically the path specified would be that of a
244 world-writeable spool directory with the sticky bit set on
245 it. A typical [printers] entry would look like
251 path = /usr/spool/public
258 All aliases given for a printer in the printcap file
259 are legitimate printer names as far as the server is concerned.
260 If your printing subsystem doesn't work like that, you will have
261 to set up a pseudo-printcap. This is a file consisting of one or
262 more lines like this:
266 alias|alias|alias|alias...
272 Each alias should be an acceptable printer name for
273 your printing subsystem. In the [global] section, specify
274 the new file as your printcap. The server will then only recognize
275 names found in your pseudo-printcap, which of course can contain
276 whatever aliases you like. The same technique could be used
277 simply to limit access to a subset of your local printers.
280 An alias, by the way, is defined as any component of the
281 first entry of a printcap record. Records are separated by newlines,
282 components (if there are more than one) are separated by vertical
286 NOTE: On SYSV systems which use lpstat to determine what
287 printers are defined on the system you may be able to use
288 "printcap name = lpstat" to automatically obtain a list
289 of printers. See the "printcap name" option
294 parameters define the specific attributes of sections.
296 Some parameters are specific to the [global] section
297 (e.g., \fBsecurity\fR). Some parameters are usable
298 in all sections (e.g., \fBcreate mode\fR). All others
299 are permissible only in normal sections. For the purposes of the
300 following descriptions the [homes] and [printers]
301 sections will be considered normal. The letter \fBG\fR
302 in parentheses indicates that a parameter is specific to the
303 [global] section. The letter \fBS\fR
304 indicates that a parameter can be specified in a service specific
305 section. Note that all \fBS\fR parameters can also be specified in
306 the [global] section - in which case they will define
307 the default behavior for all services.
309 parameters are arranged here in alphabetical order - this may
310 not create best bedfellows, but at least you can find them! Where
311 there are synonyms, the preferred synonym is described, others refer
312 to the preferred synonym.
313 .SH "VARIABLE SUBSTITUTIONS"
315 Many of the strings that are settable in the config file
316 can take substitutions. For example the option "path =
317 /tmp/%u" would be interpreted as "path =
318 /tmp/john" if the user connected with the username john.
320 These substitutions are mostly noted in the descriptions below,
321 but there are some general substitutions which apply whenever they
322 might be relevant. These are:
325 the name of the current service, if any.
328 the root directory of the current service,
332 user name of the current service, if any.
335 primary group name of %u.
338 session user name (the user name that the client
339 wanted, not necessarily the same as the one they got).
342 primary group name of %U.
345 the home directory of the user given
352 the Internet hostname that Samba is running
356 the NetBIOS name of the client machine
360 the NetBIOS name of the server. This allows you
361 to change your config based on what the client calls you. Your
362 server can have a "dual personality".
364 Note that this paramater is not available when Samba listens
365 on port 445, as clients no longer send this information
368 the Internet name of the client machine.
371 the name of your NIS home directory server.
372 This is obtained from your NIS auto.map entry. If you have
373 not compiled Samba with the \fB--with-automount\fR
374 option then this value will be the same as %L.
377 the path of the service's home directory,
378 obtained from your NIS auto.map entry. The NIS auto.map entry
379 is split up as "%N:%p".
382 the selected protocol level after
383 protocol negotiation. It can be one of CORE, COREPLUS,
384 LANMAN1, LANMAN2 or NT1.
387 The process id of the current server
391 the architecture of the remote
392 machine. Only some are recognized, and those may not be
393 100% reliable. It currently recognizes Samba, WfWg, Win95,
394 WinNT and Win2k. Anything else will be known as
395 "UNKNOWN". If it gets it wrong then sending a level
396 3 log to samba@samba.org
397 <URL:mailto:samba@samba.org> should allow it to be fixed.
400 The IP address of the client machine.
403 the current date and time.
405 \fB%$(\fIenvvar\fB)\fR
406 The value of the environment variable
409 There are some quite creative things that can be done
410 with these substitutions and other smb.conf options.
414 Samba supports "name mangling" so that DOS and
415 Windows clients can use files that don't conform to the 8.3 format.
416 It can also be set to adjust the case of 8.3 format filenames.
418 There are several options that control the way mangling is
419 performed, and they are grouped here rather than listed separately.
420 For the defaults look at the output of the testparm program.
422 All of these options can be set separately for each service
423 (or globally, of course).
427 \fBmangling method\fR
428 controls the algorithm used for the generating
429 the mangled names. Can take two different values, "hash" and
430 "hash2". "hash" is the default and is the algorithm that has been
431 used in Samba for many years. "hash2" is a newer and considered
432 a better algorithm (generates less collisions) in the names.
433 However, many Win32 applications store the
434 mangled names and so changing to the new algorithm must not be done
435 lightly as these applications may break unless reinstalled.
436 New installations of Samba may set the default to hash2.
439 \fBmangle case = yes/no\fR
440 controls if names that have characters that
441 aren't of the "default" case are mangled. For example,
442 if this is yes then a name like "Mail" would be mangled.
445 \fBcase sensitive = yes/no\fR
446 controls whether filenames are case sensitive. If
447 they aren't then Samba must do a filename search and match on passed
448 names. Default \fBno\fR.
450 \fBdefault case = upper/lower\fR
451 controls what the default case is for new
452 filenames. Default \fBlower\fR.
454 \fBpreserve case = yes/no\fR
455 controls if new files are created with the
456 case that the client passes, or if they are forced to be the
457 "default" case. Default \fByes\fR.
459 \fBshort preserve case = yes/no\fR
460 controls if new files which conform to 8.3 syntax,
461 that is all in upper case and of suitable length, are created
462 upper case, or if they are forced to be the "default"
463 case. This option can be use with "preserve case = yes"
464 to permit long filenames to retain their case, while short names
465 are lowercased. Default \fByes\fR.
467 By default, Samba 2.2 has the same semantics as a Windows
468 NT server, in that it is case insensitive but case preserving.
470 .SH "NOTE ABOUT USERNAME/PASSWORD VALIDATION"
472 There are a number of ways in which a user can connect
473 to a service. The server uses the following steps in determining
474 if it will allow a connection to a specified service. If all the
475 steps fail, then the connection request is rejected. However, if one of the
476 steps succeeds, then the following steps are not checked.
478 If the service is marked "guest only = yes" and the
479 server is running with share-level security ("security = share")
480 then steps 1 to 5 are skipped.
482 If the client has passed a username/password
483 pair and that username/password pair is validated by the UNIX
484 system's password programs then the connection is made as that
485 username. Note that this includes the
486 \\\\server\\service%\fIusername\fR method of passing
489 If the client has previously registered a username
490 with the system and now supplies a correct password for that
491 username then the connection is allowed.
493 The client's NetBIOS name and any previously
494 used user names are checked against the supplied password, if
495 they match then the connection is allowed as the corresponding
498 If the client has previously validated a
499 username/password pair with the server and the client has passed
500 the validation token then that username is used.
502 If a "user = " field is given in the
503 \fIsmb.conf\fR file for the service and the client
504 has supplied a password, and that password matches (according to
505 the UNIX system's password checking) with one of the usernames
506 from the "user =" field then the connection is made as
507 the username in the "user =" line. If one
508 of the username in the "user =" list begins with a
509 \&'@' then that name expands to a list of names in
510 the group of the same name.
512 If the service is a guest service then a
513 connection is made as the username given in the "guest
514 account =" for the service, irrespective of the
516 .SH "COMPLETE LIST OF GLOBAL PARAMETERS"
518 Here is a list of all global parameters. See the section of
519 each parameter for details. Note that some are synonyms.
522 \fIadd printer command\fR
525 \fIadd share command\fR
528 \fIadd user script\fR
531 \fIallow trusted domains\fR
537 \fIannounce version\fR
543 \fIbind interfaces only\fR
549 \fIchange notify timeout\fR
552 \fIchange share command\fR
558 \fIclient code page\fR
561 \fIcode page directory\fR
573 \fIdebug hires timestamp\fR
579 \fIdebug timestamp\fR
591 \fIdefault service\fR
594 \fIdelete printer command\fR
597 \fIdelete share command\fR
600 \fIdelete user script\fR
606 \fIdisable spoolss\fR
612 \fIdomain admin group\fR
615 \fIdomain guest group\fR
624 \fIencrypt passwords\fR
627 \fIenhanced browsing\fR
630 \fIenumports command\fR
636 \fIhide local users\fR
639 \fIhide unreadable\fR
663 \fIlarge readwrite\fR
702 \fIlock spin count\fR
732 \fImachine password timeout\fR
738 \fImangling method\fR
759 \fImax smbd processes\fR
771 \fImessage command\fR
774 \fImin passwd length\fR
777 \fImin password length\fR
786 \fIname resolve order\fR
789 \fInetbios aliases\fR
801 \fInt pipe support\fR
807 \fInt status support\fR
813 \fIobey pam restrictions\fR
816 \fIoplock break wait time\fR
825 \fIpam password change\fR
834 \fIpasswd chat debug\fR
843 \fIpassword server\fR
846 \fIprefered master\fR
849 \fIpreferred master\fR
861 \fIprinter driver file\fR
876 \fIremote announce\fR
879 \fIremote browse sync\fR
882 \fIrestrict anonymous\fR
900 \fIshow add printer wizard\fR
903 \fIsmb passwd file\fR
912 \fIsource environment\fR
921 \fIssl CA certFile\fR
927 \fIssl client cert\fR
933 \fIssl compatibility\fR
939 \fIssl entropy bytes\fR
942 \fIssl entropy file\fR
948 \fIssl hosts resign\fR
951 \fIssl require clientcert\fR
954 \fIssl require servercert\fR
957 \fIssl server cert\fR
969 \fIstat cache size\fR
981 \fItemplate homedir\fR
996 \fItotal print jobs\fR
999 \fIunix extensions\fR
1002 \fIunix password sync\fR
1005 \fIupdate encrypted\fR
1014 \fIusername level\fR
1023 \fIutmp directory\fR
1029 \fIwinbind cache time\fR
1032 \fIwinbind enum users\fR
1035 \fIwinbind enum groups\fR
1041 \fIwinbind separator\fR
1047 \fIwinbind use default domain\fR
1066 .SH "COMPLETE LIST OF SERVICE PARAMETERS"
1068 Here is a list of all service parameters. See the section on
1069 each parameter for details. Note that some are synonyms.
1081 \fIblocking locks\fR
1093 \fIcase sensitive\fR
1117 \fIdefault devmode\fR
1120 \fIdelete readonly\fR
1123 \fIdelete veto files\fR
1132 \fIdirectory mask\fR
1135 \fIdirectory mode\fR
1138 \fIdirectory security mask\fR
1147 \fIdos filetime resolution\fR
1156 \fIfake directory create times\fR
1162 \fIfollow symlinks\fR
1165 \fIforce create mode\fR
1168 \fIforce directory mode\fR
1171 \fIforce directory security mode\fR
1177 \fIforce security mode\fR
1180 \fIforce unknown acl user\fR
1201 \fIhide dot files\fR
1219 \fIinherit permissions\fR
1225 \fIlevel2 oplocks\fR
1231 \fIlppause command\fR
1237 \fIlpresume command\fR
1270 \fImax connections\fR
1273 \fImax print jobs\fR
1276 \fImin print space\fR
1282 \fInt acl support\fR
1291 \fIoplock contention limit\fR
1333 \fIprinter driver\fR
1336 \fIprinter driver location\fR
1348 \fIqueuepause command\fR
1351 \fIqueueresume command\fR
1366 \fIroot preexec close\fR
1378 \fIshort preserve case\fR
1384 \fIstrict allocate\fR
1387 \fIstrict locking\fR
1396 \fIuse client driver\fR
1414 \fIveto oplock files\fR
1432 \fIwrite cache size\fR
1442 .SH "EXPLANATION OF EACH PARAMETER"
1444 \fBadd printer command (G)\fR
1445 With the introduction of MS-RPC based printing
1446 support for Windows NT/2000 clients in Samba 2.2, The MS Add
1447 Printer Wizard (APW) icon is now also available in the
1448 "Printers..." folder displayed a share listing. The APW
1449 allows for printers to be add remotely to a Samba or Windows
1450 NT/2000 print server.
1452 For a Samba host this means that the printer must be
1453 physically added to the underlying printing system. The \fIadd
1454 printer command\fR defines a script to be run which
1455 will perform the necessary operations for adding the printer
1456 to the print system and to add the appropriate service definition
1457 to the \fIsmb.conf\fR file in order that it can be
1458 shared by \fBsmbd(8)\fR
1461 The \fIadd printer command\fR is
1462 automatically invoked with the following parameter (in
1482 \fIWindows 9x driver location\fR
1485 All parameters are filled in from the PRINTER_INFO_2 structure sent
1486 by the Windows NT/2000 client with one exception. The "Windows 9x
1487 driver location" parameter is included for backwards compatibility
1488 only. The remaining fields in the structure are generated from answers
1489 to the APW questions.
1492 Once the \fIadd printer command\fR has
1493 been executed, \fBsmbd\fR will reparse the \fI smb.conf\fR to determine if the share defined by the APW
1494 exists. If the sharename is still invalid, then \fBsmbd
1495 \fRwill return an ACCESS_DENIED error to the client.
1498 See also \fI delete printer command\fR, \fIprinting\fR,
1506 Example: \fBaddprinter command = /usr/bin/addprinter
1509 \fBadd share command (G)\fR
1510 Samba 2.2.0 introduced the ability to dynamically
1511 add and delete shares via the Windows NT 4.0 Server Manager. The
1512 \fIadd share command\fR is used to define an
1513 external program or script which will add a new service definition
1514 to \fIsmb.conf\fR. In order to successfully
1515 execute the \fIadd share command\fR, \fBsmbd\fR
1516 requires that the administrator be connected using a root account (i.e.
1519 When executed, \fBsmbd\fR will automatically invoke the
1520 \fIadd share command\fR with four parameters.
1524 \fIconfigFile\fR - the location
1525 of the global \fIsmb.conf\fR file.
1528 \fIshareName\fR - the name of the new
1532 \fIpathName\fR - path to an **existing**
1536 \fIcomment\fR - comment string to associate
1540 This parameter is only used for add file shares. To add printer shares,
1541 see the \fIadd printer
1545 See also \fIchange share
1546 command\fR, \fIdelete share
1553 Example: \fBadd share command = /usr/local/bin/addshare\fR
1556 \fBadd user script (G)\fR
1557 This is the full pathname to a script that will
1558 be run \fBAS ROOT\fR by smbd(8)
1559 under special circumstances described below.
1561 Normally, a Samba server requires that UNIX users are
1562 created for all users accessing files on this server. For sites
1563 that use Windows NT account databases as their primary user database
1564 creating these users and keeping the user list in sync with the
1565 Windows NT PDC is an onerous task. This option allows smbdto create the required UNIX users
1566 \fBON DEMAND\fR when a user accesses the Samba server.
1568 In order to use this option, smbd
1569 must \fBNOT\fR be set to \fIsecurity = share\fR
1570 and \fIadd user script\fR
1571 must be set to a full pathname for a script that will create a UNIX
1572 user given one argument of \fI%u\fR, which expands into
1573 the UNIX user name to create.
1575 When the Windows user attempts to access the Samba server,
1576 at login (session setup in the SMB protocol) time, smbdcontacts the \fIpassword server\fR and
1577 attempts to authenticate the given user with the given password. If the
1578 authentication succeeds then \fBsmbd\fR
1579 attempts to find a UNIX user in the UNIX password database to map the
1580 Windows user into. If this lookup fails, and \fIadd user script
1581 \fRis set then \fBsmbd\fR will
1582 call the specified script \fBAS ROOT\fR, expanding
1583 any \fI%u\fR argument to be the user name to create.
1585 If this script successfully creates the user then \fBsmbd
1586 \fRwill continue on as though the UNIX user
1587 already existed. In this way, UNIX users are dynamically created to
1588 match existing Windows NT accounts.
1590 See also \fI security\fR, \fIpassword server\fR,
1594 Default: \fBadd user script = <empty string>
1596 Example: \fBadd user script = /usr/local/samba/bin/add_user
1599 \fBadmin users (S)\fR
1600 This is a list of users who will be granted
1601 administrative privileges on the share. This means that they
1602 will do all file operations as the super-user (root).
1604 You should use this option very carefully, as any user in
1605 this list will be able to do anything they like on the share,
1606 irrespective of file permissions.
1608 Default: \fBno admin users\fR
1610 Example: \fBadmin users = jason\fR
1612 \fBallow hosts (S)\fR
1613 Synonym for \fIhosts allow\fR.
1615 \fBallow trusted domains (G)\fR
1616 This option only takes effect when the \fIsecurity\fR option is set to
1618 If it is set to no, then attempts to connect to a resource from
1619 a domain or workgroup other than the one which smbdis running
1620 in will fail, even if that domain is trusted by the remote server
1621 doing the authentication.
1623 This is useful if you only want your Samba server to
1624 serve resources to users in the domain it is a member of. As
1625 an example, suppose that there are two domains DOMA and DOMB. DOMB
1626 is trusted by DOMA, which contains the Samba server. Under normal
1627 circumstances, a user with an account in DOMB can then access the
1628 resources of a UNIX account with the same account name on the
1629 Samba server even if they do not have an account in DOMA. This
1630 can make implementing a security boundary difficult.
1632 Default: \fBallow trusted domains = yes\fR
1634 \fBannounce as (G)\fR
1635 This specifies what type of server
1637 will announce itself as, to a network neighborhood browse
1638 list. By default this is set to Windows NT. The valid options
1639 are : "NT Server" (which can also be written as "NT"),
1640 "NT Workstation", "Win95" or "WfW" meaning Windows NT Server,
1641 Windows NT Workstation, Windows 95 and Windows for Workgroups
1642 respectively. Do not change this parameter unless you have a
1643 specific need to stop Samba appearing as an NT server as this
1644 may prevent Samba servers from participating as browser servers
1647 Default: \fBannounce as = NT Server\fR
1649 Example: \fBannounce as = Win95\fR
1651 \fBannounce version (G)\fR
1652 This specifies the major and minor version numbers
1653 that nmbd will use when announcing itself as a server. The default
1654 is 4.5. Do not change this parameter unless you have a specific
1655 need to set a Samba server to be a downlevel server.
1657 Default: \fBannounce version = 4.5\fR
1659 Example: \fBannounce version = 2.0\fR
1661 \fBauto services (G)\fR
1662 This is a synonym for the \fIpreload\fR.
1665 This parameter lets you "turn off" a service. If
1666 \fIavailable = no\fR, then \fBALL\fR
1667 attempts to connect to the service will fail. Such failures are
1670 Default: \fBavailable = yes\fR
1672 \fBbind interfaces only (G)\fR
1673 This global parameter allows the Samba admin
1674 to limit what interfaces on a machine will serve SMB requests. If
1675 affects file service smbd(8)and
1676 name service nmbd(8)in slightly
1679 For name service it causes \fBnmbd\fR to bind
1680 to ports 137 and 138 on the interfaces listed in the interfaces parameter. \fBnmbd
1681 \fRalso binds to the "all addresses" interface (0.0.0.0)
1682 on ports 137 and 138 for the purposes of reading broadcast messages.
1683 If this option is not set then \fBnmbd\fR will service
1684 name requests on all of these sockets. If \fIbind interfaces
1685 only\fR is set then \fBnmbd\fR will check the
1686 source address of any packets coming in on the broadcast sockets
1687 and discard any that don't match the broadcast addresses of the
1688 interfaces in the \fIinterfaces\fR parameter list.
1689 As unicast packets are received on the other sockets it allows
1690 \fBnmbd\fR to refuse to serve names to machines that
1691 send packets that arrive through any interfaces not listed in the
1692 \fIinterfaces\fR list. IP Source address spoofing
1693 does defeat this simple check, however so it must not be used
1694 seriously as a security feature for \fBnmbd\fR.
1696 For file service it causes smbd(8)
1697 to bind only to the interface list given in the interfaces parameter. This restricts the networks that
1698 \fBsmbd\fR will serve to packets coming in those
1699 interfaces. Note that you should not use this parameter for machines
1700 that are serving PPP or other intermittent or non-broadcast network
1701 interfaces as it will not cope with non-permanent interfaces.
1703 If \fIbind interfaces only\fR is set then
1704 unless the network address \fB127.0.0.1\fR is added
1705 to the \fIinterfaces\fR parameter list \fBsmbpasswd(8)\fR
1706 and \fBswat(8)\fRmay
1707 not work as expected due to the reasons covered below.
1709 To change a users SMB password, the \fBsmbpasswd\fR
1710 by default connects to the \fBlocalhost - 127.0.0.1\fR
1711 address as an SMB client to issue the password change request. If
1712 \fIbind interfaces only\fR is set then unless the
1713 network address \fB127.0.0.1\fR is added to the
1714 \fIinterfaces\fR parameter list then \fB smbpasswd\fR will fail to connect in it's default mode.
1715 \fBsmbpasswd\fR can be forced to use the primary IP interface
1716 of the local host by using its \fI-r remote machine\fR
1717 parameter, with \fIremote machine\fR set
1718 to the IP name of the primary interface of the local host.
1720 The \fBswat\fR status page tries to connect with
1721 \fBsmbd\fR and \fBnmbd\fR at the address
1722 \fB127.0.0.1\fR to determine if they are running.
1723 Not adding \fB127.0.0.1\fR will cause \fB smbd\fR and \fBnmbd\fR to always show
1724 "not running" even if they really are. This can prevent \fB swat\fR from starting/stopping/restarting \fBsmbd\fR
1727 Default: \fBbind interfaces only = no\fR
1729 \fBblock size (S)\fR
1730 This parameter controls the behavior of smbd(8)when reporting disk free sizes.
1731 By default, this reports a disk block size of 1024 bytes.
1733 Changing this parameter may have some effect on the
1734 efficiency of client writes, this is not yet confirmed. This
1735 parameter was added to allow advanced administrators to change
1736 it (usually to a higher value) and test the effect it has on
1737 client write performance without re-compiling the code. As this
1738 is an experimental option it may be removed in a future release.
1740 Changing this option does not change the disk free reporting
1741 size, just the block size unit reported to the client.
1743 Default: \fBblock size = 1024\fR
1745 Example: \fBblock size = 65536\fR
1747 \fBblocking locks (S)\fR
1748 This parameter controls the behavior of smbd(8)when given a request by a client
1749 to obtain a byte range lock on a region of an open file, and the
1750 request has a time limit associated with it.
1752 If this parameter is set and the lock range requested
1753 cannot be immediately satisfied, Samba 2.2 will internally
1754 queue the lock request, and periodically attempt to obtain
1755 the lock until the timeout period expires.
1757 If this parameter is set to false, then
1758 Samba 2.2 will behave as previous versions of Samba would and
1759 will fail the lock request immediately if the lock range
1762 Default: \fBblocking locks = yes\fR
1765 See the \fI browseable\fR.
1767 \fBbrowse list (G)\fR
1768 This controls whether \fBsmbd(8)\fRwill serve a browse list to
1769 a client doing a \fBNetServerEnum\fR call. Normally
1770 set to true. You should never need to change
1773 Default: \fBbrowse list = yes\fR
1775 \fBbrowseable (S)\fR
1776 This controls whether this share is seen in
1777 the list of available shares in a net view and in the browse list.
1779 Default: \fBbrowseable = yes\fR
1781 \fBcase sensitive (S)\fR
1782 See the discussion in the section NAME MANGLING.
1784 Default: \fBcase sensitive = no\fR
1786 \fBcasesignames (S)\fR
1790 \fBchange notify timeout (G)\fR
1791 This SMB allows a client to tell a server to
1792 "watch" a particular directory for any changes and only reply to
1793 the SMB request when a change has occurred. Such constant scanning of
1794 a directory is expensive under UNIX, hence an \fBsmbd(8)\fRdaemon only performs such a scan
1795 on each requested directory once every \fIchange notify
1798 Default: \fBchange notify timeout = 60\fR
1800 Example: \fBchange notify timeout = 300\fR
1802 Would change the scan time to every 5 minutes.
1804 \fBchange share command (G)\fR
1805 Samba 2.2.0 introduced the ability to dynamically
1806 add and delete shares via the Windows NT 4.0 Server Manager. The
1807 \fIchange share command\fR is used to define an
1808 external program or script which will modify an existing service definition
1809 in \fIsmb.conf\fR. In order to successfully
1810 execute the \fIchange share command\fR, \fBsmbd\fR
1811 requires that the administrator be connected using a root account (i.e.
1814 When executed, \fBsmbd\fR will automatically invoke the
1815 \fIchange share command\fR with four parameters.
1819 \fIconfigFile\fR - the location
1820 of the global \fIsmb.conf\fR file.
1823 \fIshareName\fR - the name of the new
1827 \fIpathName\fR - path to an **existing**
1831 \fIcomment\fR - comment string to associate
1835 This parameter is only used modify existing file shares definitions. To modify
1836 printer shares, use the "Printers..." folder as seen when browsing the Samba host.
1839 See also \fIadd share
1840 command\fR, \fIdelete
1847 Example: \fBchange share command = /usr/local/bin/addshare\fR
1850 \fBcharacter set (G)\fR
1851 This allows smbdto map incoming filenames
1852 from a DOS Code page (see the client
1853 code page parameter) to several built in UNIX character sets.
1854 The built in code page translations are:
1858 ISO8859-1 : Western European
1859 UNIX character set. The parameter \fIclient code page\fR
1860 \fBMUST\fR be set to code page 850 if the
1861 \fIcharacter set\fR parameter is set to
1862 ISO8859-1 in order for the conversion to the
1863 UNIX character set to be done correctly.
1866 ISO8859-2 : Eastern European
1867 UNIX character set. The parameter \fIclient code page
1868 \fR\fBMUST\fR be set to code page 852 if
1869 the \fI character set\fR parameter is set
1870 to ISO8859-2 in order for the conversion
1871 to the UNIX character set to be done correctly.
1874 ISO8859-5 : Russian Cyrillic
1875 UNIX character set. The parameter \fIclient code page
1876 \fR\fBMUST\fR be set to code page
1877 866 if the \fIcharacter set \fR parameter is
1878 set to ISO8859-5 in order for the conversion
1879 to the UNIX character set to be done correctly.
1882 ISO8859-7 : Greek UNIX
1883 character set. The parameter \fIclient code page
1884 \fR\fBMUST\fR be set to code page
1885 737 if the \fIcharacter set\fR parameter is
1886 set to ISO8859-7 in order for the conversion
1887 to the UNIX character set to be done correctly.
1890 KOI8-R : Alternate mapping
1891 for Russian Cyrillic UNIX character set. The parameter
1892 \fIclient code page\fR \fBMUST\fR
1893 be set to code page 866 if the \fIcharacter set\fR
1894 parameter is set to KOI8-R in order for the
1895 conversion to the UNIX character set to be done correctly.
1898 \fBBUG\fR. These MSDOS code page to UNIX character
1899 set mappings should be dynamic, like the loading of MS DOS code pages,
1903 Normally this parameter is not set, meaning no filename
1904 translation is done.
1907 Default: \fBcharacter set = <empty string>\fR
1910 Example: \fBcharacter set = ISO8859-1\fR
1913 \fBclient code page (G)\fR
1914 This parameter specifies the DOS code page
1915 that the clients accessing Samba are using. To determine what code
1916 page a Windows or DOS client is using, open a DOS command prompt
1917 and type the command \fBchcp\fR. This will output
1918 the code page. The default for USA MS-DOS, Windows 95, and
1919 Windows NT releases is code page 437. The default for western
1920 European releases of the above operating systems is code page 850.
1922 This parameter tells smbd(8)
1923 which of the \fIcodepage.XXX
1924 \fRfiles to dynamically load on startup. These files,
1925 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
1926 the case insensitivity of filenames that Windows clients expect.
1928 Samba currently ships with the following code page files :
1932 Code Page 437 - MS-DOS Latin US
1935 Code Page 737 - Windows '95 Greek
1938 Code Page 850 - MS-DOS Latin 1
1941 Code Page 852 - MS-DOS Latin 2
1944 Code Page 861 - MS-DOS Icelandic
1947 Code Page 866 - MS-DOS Cyrillic
1950 Code Page 932 - MS-DOS Japanese SJIS
1953 Code Page 936 - MS-DOS Simplified Chinese
1956 Code Page 949 - MS-DOS Korean Hangul
1959 Code Page 950 - MS-DOS Traditional Chinese
1962 Thus this parameter may have any of the values 437, 737, 850, 852,
1963 861, 932, 936, 949, or 950. If you don't find the codepage you need,
1964 read the comments in one of the other codepage files and the
1965 \fBmake_smbcodepage(1)\fR man page and write one. Please
1966 remember to donate it back to the Samba user community.
1969 This parameter co-operates with the \fIvalid
1970 chars\fR parameter in determining what characters are
1971 valid in filenames and how capitalization is done. If you set both
1972 this parameter and the \fIvalid chars\fR parameter
1973 the \fIclient code page\fR parameter
1974 \fBMUST\fR be set before the \fIvalid
1975 chars\fR parameter in the \fIsmb.conf\fR
1976 file. The \fIvalid chars\fR string will then
1977 augment the character settings in the \fIclient code page\fR
1981 If not set, \fIclient code page\fR defaults
1986 chars\fR, \fIcode page directory\fR
1989 Default: \fBclient code page = 850\fR
1992 Example: \fBclient code page = 936\fR
1995 \fBcode page directory (G)\fR
1996 Define the location of the various client code page
2002 Default: \fBcode page directory = ${prefix}/lib/codepages
2004 Example: \fBcode page directory = /usr/share/samba/codepages
2006 \fBcoding system (G)\fR
2007 This parameter is used to determine how incoming
2008 Shift-JIS Japanese characters are mapped from the incoming \fIclient code page\fR
2009 used by the client, into file names in the UNIX filesystem.
2010 Only useful if \fIclient code page\fR is set to
2011 932 (Japanese Shift-JIS). The options are :
2015 SJIS - Shift-JIS. Does no
2016 conversion of the incoming filename.
2019 JIS8, J8BB, J8BH, J8@B,
2020 J8@J, J8@H - Convert from incoming Shift-JIS to eight
2021 bit JIS code with different shift-in, shift out codes.
2024 JIS7, J7BB, J7BH, J7@B, J7@J,
2025 J7@H - Convert from incoming Shift-JIS to seven bit
2026 JIS code with different shift-in, shift out codes.
2029 JUNET, JUBB, JUBH, JU@B, JU@J, JU@H
2030 - Convert from incoming Shift-JIS to JUNET code with different shift-in,
2034 EUC - Convert an incoming
2035 Shift-JIS character to EUC code.
2038 HEX - Convert an incoming
2039 Shift-JIS character to a 3 byte hex representation, i.e.
2043 CAP - Convert an incoming
2044 Shift-JIS character to the 3 byte hex representation used by
2045 the Columbia AppleTalk Program (CAP), i.e. :AB.
2046 This is used for compatibility between Samba and CAP.
2049 Default: \fBcoding system = <empty value>\fR
2053 This is a text field that is seen next to a share
2054 when a client does a queries the server, either via the network
2055 neighborhood or via \fBnet view\fR to list what shares
2058 If you want to set the string that is displayed next to the
2059 machine name then see the \fI server string\fR parameter.
2061 Default: \fBNo comment string\fR
2063 Example: \fBcomment = Fred's Files\fR
2065 \fBconfig file (G)\fR
2066 This allows you to override the config file
2067 to use, instead of the default (usually \fIsmb.conf\fR).
2068 There is a chicken and egg problem here as this option is set
2071 For this reason, if the name of the config file has changed
2072 when the parameters are loaded then it will reload them from
2073 the new config file.
2075 This option takes the usual substitutions, which can
2078 If the config file doesn't exist then it won't be loaded
2079 (allowing you to special case the config files of just a few
2082 Example: \fBconfig file = /usr/local/samba/lib/smb.conf.%m
2085 This parameter allows you to "clone" service
2086 entries. The specified service is simply duplicated under the
2087 current service's name. Any parameters specified in the current
2088 section will override those in the section being copied.
2090 This feature lets you set up a 'template' service and
2091 create similar services easily. Note that the service being
2092 copied must occur earlier in the configuration file than the
2093 service doing the copying.
2095 Default: \fBno value\fR
2097 Example: \fBcopy = otherservice\fR
2099 \fBcreate mask (S)\fR
2100 A synonym for this parameter is
2104 When a file is created, the necessary permissions are
2105 calculated according to the mapping from DOS modes to UNIX
2106 permissions, and the resulting UNIX mode is then bit-wise 'AND'ed
2107 with this parameter. This parameter may be thought of as a bit-wise
2108 MASK for the UNIX modes of a file. Any bit \fBnot\fR
2109 set here will be removed from the modes set on a file when it is
2112 The default value of this parameter removes the
2113 \&'group' and 'other' write and execute bits from the UNIX modes.
2115 Following this Samba will bit-wise 'OR' the UNIX mode created
2116 from this parameter with the value of the \fIforce create mode\fR
2117 parameter which is set to 000 by default.
2119 This parameter does not affect directory modes. See the
2120 parameter \fIdirectory mode
2123 See also the \fIforce
2124 create mode\fR parameter for forcing particular mode
2125 bits to be set on created files. See also the \fIdirectory mode\fR parameter for masking
2126 mode bits on created directories. See also the \fIinherit permissions\fR parameter.
2128 Note that this parameter does not apply to permissions
2129 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
2130 a mask on access control lists also, they need to set the \fIsecurity mask\fR.
2132 Default: \fBcreate mask = 0744\fR
2134 Example: \fBcreate mask = 0775\fR
2136 \fBcreate mode (S)\fR
2137 This is a synonym for \fI create mask\fR.
2139 \fBcsc policy (S)\fR
2140 This stands for \fBclient-side caching
2141 policy\fR, and specifies how clients capable of offline
2142 caching will cache the files in the share. The valid values
2143 are: manual, documents, programs, disable.
2145 These values correspond to those used on Windows
2148 For example, shares containing roaming profiles can have
2149 offline caching disabled using \fBcsc policy = disable
2152 Default: \fBcsc policy = manual\fR
2154 Example: \fBcsc policy = programs\fR
2157 The value of the parameter (a decimal integer)
2158 represents the number of minutes of inactivity before a connection
2159 is considered dead, and it is disconnected. The deadtime only takes
2160 effect if the number of open files is zero.
2162 This is useful to stop a server's resources being
2163 exhausted by a large number of inactive connections.
2165 Most clients have an auto-reconnect feature when a
2166 connection is broken so in most cases this parameter should be
2167 transparent to users.
2169 Using this parameter with a timeout of a few minutes
2170 is recommended for most systems.
2172 A deadtime of zero indicates that no auto-disconnection
2173 should be performed.
2175 Default: \fBdeadtime = 0\fR
2177 Example: \fBdeadtime = 15\fR
2179 \fBdebug hires timestamp (G)\fR
2180 Sometimes the timestamps in the log messages
2181 are needed with a resolution of higher that seconds, this
2182 boolean parameter adds microsecond resolution to the timestamp
2183 message header when turned on.
2185 Note that the parameter \fI debug timestamp\fR must be on for this to have an
2188 Default: \fBdebug hires timestamp = no\fR
2191 When using only one log file for more then one
2192 forked smbd-process there may be hard to follow which process
2193 outputs which message. This boolean parameter is adds the process-id
2194 to the timestamp message headers in the logfile when turned on.
2196 Note that the parameter \fI debug timestamp\fR must be on for this to have an
2199 Default: \fBdebug pid = no\fR
2201 \fBdebug timestamp (G)\fR
2202 Samba 2.2 debug log messages are timestamped
2203 by default. If you are running at a high \fIdebug level\fR these timestamps
2204 can be distracting. This boolean parameter allows timestamping
2207 Default: \fBdebug timestamp = yes\fR
2210 Samba is sometimes run as root and sometime
2211 run as the connected user, this boolean parameter inserts the
2212 current euid, egid, uid and gid to the timestamp message headers
2213 in the log file if turned on.
2215 Note that the parameter \fI debug timestamp\fR must be on for this to have an
2218 Default: \fBdebug uid = no\fR
2220 \fBdebuglevel (G)\fR
2221 Synonym for \fI log level\fR.
2224 A synonym for \fI default service\fR.
2226 \fBdefault case (S)\fR
2227 See the section on NAME MANGLING. Also note the \fIshort preserve case\fR parameter.
2229 Default: \fBdefault case = lower\fR
2231 \fBdefault devmode (S)\fR
2232 This parameter is only applicable to printable services. When smbd is serving
2233 Printer Drivers to Windows NT/2k/XP clients, each printer on the Samba
2234 server has a Device Mode which defines things such as paper size and
2235 orientation and duplex settings. The device mode can only correctly be
2236 generated by the printer driver itself (which can only be executed on a
2237 Win32 platform). Because smbd is unable to execute the driver code
2238 to generate the device mode, the default behavior is to set this field
2241 Most problems with serving printer drivers to Windows NT/2k/XP clients
2242 can be traced to a problem with the generated device mode. Certain drivers
2243 will do things such as crashing the client's Explorer.exe with a NULL devmode.
2244 However, other printer drivers can cause the client's spooler service
2245 (spoolsv.exe) to die if the devmode was not created by the driver itself
2246 (i.e. smbd generates a default devmode).
2248 This parameter should be used with care and tested with the printer
2249 driver in question. It is better to leave the device mode to NULL
2250 and let the Windows client set the correct values. Because drivers do not
2251 do this all the time, setting \fBdefault devmode = yes\fR
2252 will instruct smbd to generate a default one.
2254 For more information on Windows NT/2k printing and Device Modes,
2255 see the MSDN documentation <URL:http://msdn.microsoft.com/>.
2257 Default: \fBdefault devmode = no\fR
2259 \fBdefault service (G)\fR
2260 This parameter specifies the name of a service
2261 which will be connected to if the service actually requested cannot
2262 be found. Note that the square brackets are \fBNOT\fR
2263 given in the parameter value (see example below).
2265 There is no default value for this parameter. If this
2266 parameter is not given, attempting to connect to a nonexistent
2267 service results in an error.
2269 Typically the default service would be a \fIguest ok\fR, \fIread-only\fR service.
2271 Also note that the apparent service name will be changed
2272 to equal that of the requested service, this is very useful as it
2273 allows you to use macros like \fI%S\fR to make
2276 Note also that any "_" characters in the name of the service
2277 used in the default service will get mapped to a "/". This allows for
2285 default service = pub
2293 \fBdelete printer command (G)\fR
2294 With the introduction of MS-RPC based printer
2295 support for Windows NT/2000 clients in Samba 2.2, it is now
2296 possible to delete printer at run time by issuing the
2297 DeletePrinter() RPC call.
2299 For a Samba host this means that the printer must be
2300 physically deleted from underlying printing system. The \fI deleteprinter command\fR defines a script to be run which
2301 will perform the necessary operations for removing the printer
2302 from the print system and from \fIsmb.conf\fR.
2304 The \fIdelete printer command\fR is
2305 automatically called with only one parameter: \fI "printer name"\fR.
2307 Once the \fIdelete printer command\fR has
2308 been executed, \fBsmbd\fR will reparse the \fI smb.conf\fR to associated printer no longer exists.
2309 If the sharename is still valid, then \fBsmbd
2310 \fRwill return an ACCESS_DENIED error to the client.
2312 See also \fI add printer command\fR, \fIprinting\fR,
2318 Example: \fBdeleteprinter command = /usr/bin/removeprinter
2320 \fBdelete readonly (S)\fR
2321 This parameter allows readonly files to be deleted.
2322 This is not normal DOS semantics, but is allowed by UNIX.
2324 This option may be useful for running applications such
2325 as rcs, where UNIX file ownership prevents changing file
2326 permissions, and DOS semantics prevent deletion of a read only file.
2328 Default: \fBdelete readonly = no\fR
2330 \fBdelete share command (G)\fR
2331 Samba 2.2.0 introduced the ability to dynamically
2332 add and delete shares via the Windows NT 4.0 Server Manager. The
2333 \fIdelete share command\fR is used to define an
2334 external program or script which will remove an existing service
2335 definition from \fIsmb.conf\fR. In order to successfully
2336 execute the \fIdelete share command\fR, \fBsmbd\fR
2337 requires that the administrator be connected using a root account (i.e.
2340 When executed, \fBsmbd\fR will automatically invoke the
2341 \fIdelete share command\fR with two parameters.
2345 \fIconfigFile\fR - the location
2346 of the global \fIsmb.conf\fR file.
2349 \fIshareName\fR - the name of
2350 the existing service.
2353 This parameter is only used to remove file shares. To delete printer shares,
2354 see the \fIdelete printer
2358 See also \fIadd share
2359 command\fR, \fIchange
2366 Example: \fBdelete share command = /usr/local/bin/delshare\fR
2369 \fBdelete user script (G)\fR
2370 This is the full pathname to a script that will
2371 be run \fBAS ROOT\fR by \fBsmbd(8)\fRunder special circumstances
2374 Normally, a Samba server requires that UNIX users are
2375 created for all users accessing files on this server. For sites
2376 that use Windows NT account databases as their primary user database
2377 creating these users and keeping the user list in sync with the
2378 Windows NT PDC is an onerous task. This option allows \fB smbd\fR to delete the required UNIX users \fBON
2379 DEMAND\fR when a user accesses the Samba server and the
2380 Windows NT user no longer exists.
2382 In order to use this option, \fBsmbd\fR must be
2383 set to \fIsecurity = domain\fR or \fIsecurity =
2384 user\fR and \fIdelete user script\fR
2385 must be set to a full pathname for a script
2386 that will delete a UNIX user given one argument of \fI%u\fR,
2387 which expands into the UNIX user name to delete.
2389 When the Windows user attempts to access the Samba server,
2390 at \fBlogin\fR (session setup in the SMB protocol)
2391 time, \fBsmbd\fR contacts the \fIpassword server\fR and attempts to authenticate
2392 the given user with the given password. If the authentication fails
2393 with the specific Domain error code meaning that the user no longer
2394 exists then \fBsmbd\fR attempts to find a UNIX user in
2395 the UNIX password database that matches the Windows user account. If
2396 this lookup succeeds, and \fIdelete user script\fR is
2397 set then \fBsmbd\fR will all the specified script
2398 \fBAS ROOT\fR, expanding any \fI%u\fR
2399 argument to be the user name to delete.
2401 This script should delete the given UNIX username. In this way,
2402 UNIX users are dynamically deleted to match existing Windows NT
2405 See also security = domain,
2406 \fIpassword server\fR
2407 , \fIadd user script\fR
2410 Default: \fBdelete user script = <empty string>
2412 Example: \fBdelete user script = /usr/local/samba/bin/del_user
2415 \fBdelete veto files (S)\fR
2416 This option is used when Samba is attempting to
2417 delete a directory that contains one or more vetoed directories
2418 (see the \fIveto files\fR
2419 option). If this option is set to false (the default) then if a vetoed
2420 directory contains any non-vetoed files or directories then the
2421 directory delete will fail. This is usually what you want.
2423 If this option is set to true, then Samba
2424 will attempt to recursively delete any files and directories within
2425 the vetoed directory. This can be useful for integration with file
2426 serving systems such as NetAtalk which create meta-files within
2427 directories you might normally veto DOS/Windows users from seeing
2428 (e.g. \fI.AppleDouble\fR)
2430 Setting \fBdelete veto files = yes\fR allows these
2431 directories to be transparently deleted when the parent directory
2432 is deleted (so long as the user has permissions to do so).
2434 See also the \fIveto
2437 Default: \fBdelete veto files = no\fR
2439 \fBdeny hosts (S)\fR
2440 Synonym for \fIhosts
2443 \fBdfree command (G)\fR
2444 The \fIdfree command\fR setting should
2445 only be used on systems where a problem occurs with the internal
2446 disk space calculations. This has been known to happen with Ultrix,
2447 but may occur with other operating systems. The symptom that was
2448 seen was an error of "Abort Retry Ignore" at the end of each
2451 This setting allows the replacement of the internal routines to
2452 calculate the total disk space and amount available with an external
2453 routine. The example below gives a possible script that might fulfill
2456 The external program will be passed a single parameter indicating
2457 a directory in the filesystem being queried. This will typically consist
2458 of the string \fI./\fR. The script should return two
2459 integers in ASCII. The first should be the total disk space in blocks,
2460 and the second should be the number of available blocks. An optional
2461 third return value can give the block size in bytes. The default
2462 blocksize is 1024 bytes.
2464 Note: Your script should \fBNOT\fR be setuid or
2465 setgid and should be owned by (and writeable only by) root!
2467 Default: \fBBy default internal routines for
2468 determining the disk capacity and remaining space will be used.
2470 Example: \fBdfree command = /usr/local/samba/bin/dfree
2472 Where the script dfree (which must be made executable) could be:
2478 df $1 | tail -1 | awk '{print $2" "$4}'
2483 or perhaps (on Sys V based systems):
2489 /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
2494 Note that you may have to replace the command names
2495 with full path names on some systems.
2501 \fBdirectory mask (S)\fR
2502 This parameter is the octal modes which are
2503 used when converting DOS modes to UNIX modes when creating UNIX
2506 When a directory is created, the necessary permissions are
2507 calculated according to the mapping from DOS modes to UNIX permissions,
2508 and the resulting UNIX mode is then bit-wise 'AND'ed with this
2509 parameter. This parameter may be thought of as a bit-wise MASK for
2510 the UNIX modes of a directory. Any bit \fBnot\fR set
2511 here will be removed from the modes set on a directory when it is
2514 The default value of this parameter removes the 'group'
2515 and 'other' write bits from the UNIX mode, allowing only the
2516 user who owns the directory to modify it.
2518 Following this Samba will bit-wise 'OR' the UNIX mode
2519 created from this parameter with the value of the \fIforce directory mode
2520 \fRparameter. This parameter is set to 000 by
2521 default (i.e. no extra mode bits are added).
2523 Note that this parameter does not apply to permissions
2524 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
2525 a mask on access control lists also, they need to set the \fIdirectory security mask\fR.
2528 directory mode\fR parameter to cause particular mode
2529 bits to always be set on created directories.
2531 See also the \fIcreate mode
2532 \fRparameter for masking mode bits on created files,
2533 and the \fIdirectory
2534 security mask\fR parameter.
2536 Also refer to the \fI inherit permissions\fR parameter.
2538 Default: \fBdirectory mask = 0755\fR
2540 Example: \fBdirectory mask = 0775\fR
2542 \fBdirectory mode (S)\fR
2543 Synonym for \fI directory mask\fR
2545 \fBdirectory security mask (S)\fR
2546 This parameter controls what UNIX permission bits
2547 can be modified when a Windows NT client is manipulating the UNIX
2548 permission on a directory using the native NT security dialog
2551 This parameter is applied as a mask (AND'ed with) to
2552 the changed permission bits, thus preventing any bits not in
2553 this mask from being modified. Essentially, zero bits in this
2554 mask may be treated as a set of bits the user is not allowed
2557 If not set explicitly this parameter is set to 0777
2558 meaning a user is allowed to modify all the user/group/world
2559 permissions on a directory.
2561 \fBNote\fR that users who can access the
2562 Samba server through other means can easily bypass this restriction,
2563 so it is primarily useful for standalone "appliance" systems.
2564 Administrators of most normal systems will probably want to leave
2565 it as the default of 0777.
2567 See also the \fI force directory security mode\fR, \fIsecurity mask\fR,
2568 \fIforce security mode
2571 Default: \fBdirectory security mask = 0777\fR
2573 Example: \fBdirectory security mask = 0700\fR
2575 \fBdisable spoolss (G)\fR
2576 Enabling this parameter will disables Samba's support
2577 for the SPOOLSS set of MS-RPC's and will yield identical behavior
2578 as Samba 2.0.x. Windows NT/2000 clients will downgrade to using
2579 Lanman style printing commands. Windows 9x/ME will be uneffected by
2580 the parameter. However, this will also disable the ability to upload
2581 printer drivers to a Samba server via the Windows NT Add Printer
2582 Wizard or by using the NT printer properties dialog window. It will
2583 also disable the capability of Windows NT/2000 clients to download
2584 print drivers from the Samba host upon demand.
2585 \fBBe very careful about enabling this parameter.\fR
2587 See also use client driver
2589 Default : \fBdisable spoolss = no\fR
2592 Specifies that nmbd(8)
2593 when acting as a WINS server and finding that a NetBIOS name has not
2594 been registered, should treat the NetBIOS name word-for-word as a DNS
2595 name and do a lookup with the DNS server for that name on behalf of
2596 the name-querying client.
2598 Note that the maximum length for a NetBIOS name is 15
2599 characters, so the DNS name (or DNS alias) can likewise only be
2600 15 characters, maximum.
2602 \fBnmbd\fR spawns a second copy of itself to do the
2603 DNS name lookup requests, as doing a name lookup is a blocking
2606 See also the parameter \fI wins support\fR.
2608 Default: \fBdns proxy = yes\fR
2610 \fBdomain admin group (G)\fR
2611 This parameter is intended as a temporary solution
2612 to enable users to be a member of the "Domain Admins" group when
2613 a Samba host is acting as a PDC. A complete solution will be provided
2614 by a system for mapping Windows NT/2000 groups onto UNIX groups.
2615 Please note that this parameter has a somewhat confusing name. It
2616 accepts a list of usernames and of group names in standard
2617 \fIsmb.conf\fR notation.
2620 guest group\fR, \fIdomain
2623 Default: \fBno domain administrators\fR
2625 Example: \fBdomain admin group = root @wheel\fR
2627 \fBdomain guest group (G)\fR
2628 This parameter is intended as a temporary solution
2629 to enable users to be a member of the "Domain Guests" group when
2630 a Samba host is acting as a PDC. A complete solution will be provided
2631 by a system for mapping Windows NT/2000 groups onto UNIX groups.
2632 Please note that this parameter has a somewhat confusing name. It
2633 accepts a list of usernames and of group names in standard
2634 \fIsmb.conf\fR notation.
2637 admin group\fR, \fIdomain
2640 Default: \fBno domain guests\fR
2642 Example: \fBdomain guest group = nobody @guest\fR
2644 \fBdomain logons (G)\fR
2645 If set to true, the Samba server will serve
2646 Windows 95/98 Domain logons for the \fIworkgroup\fR it is in. Samba 2.2 also
2647 has limited capability to act as a domain controller for Windows
2648 NT 4 Domains. For more details on setting up this feature see
2649 the Samba-PDC-HOWTO included in the \fIhtmldocs/\fR
2650 directory shipped with the source code.
2652 Default: \fBdomain logons = no\fR
2654 \fBdomain master (G)\fR
2655 Tell \fB nmbd(8)\fRto enable WAN-wide browse list
2656 collation. Setting this option causes \fBnmbd\fR to
2657 claim a special domain specific NetBIOS name that identifies
2658 it as a domain master browser for its given \fIworkgroup\fR. Local master browsers
2659 in the same \fIworkgroup\fR on broadcast-isolated
2660 subnets will give this \fBnmbd\fR their local browse lists,
2661 and then ask \fBsmbd(8)\fR
2662 for a complete copy of the browse list for the whole wide area
2663 network. Browser clients will then contact their local master browser,
2664 and will receive the domain-wide browse list, instead of just the list
2665 for their broadcast-isolated subnet.
2667 Note that Windows NT Primary Domain Controllers expect to be
2668 able to claim this \fIworkgroup\fR specific special
2669 NetBIOS name that identifies them as domain master browsers for
2670 that \fIworkgroup\fR by default (i.e. there is no
2671 way to prevent a Windows NT PDC from attempting to do this). This
2672 means that if this parameter is set and \fBnmbd\fR claims
2673 the special name for a \fIworkgroup\fR before a Windows
2674 NT PDC is able to do so then cross subnet browsing will behave
2675 strangely and may fail.
2677 If \fBdomain logons = yes\fR
2678 , then the default behavior is to enable the \fIdomain
2679 master\fR parameter. If \fIdomain logons\fR is
2680 not enabled (the default setting), then neither will \fIdomain
2681 master\fR be enabled by default.
2683 Default: \fBdomain master = auto\fR
2685 \fBdont descend (S)\fR
2686 There are certain directories on some systems
2687 (e.g., the \fI/proc\fR tree under Linux) that are either not
2688 of interest to clients or are infinitely deep (recursive). This
2689 parameter allows you to specify a comma-delimited list of directories
2690 that the server should always show as empty.
2692 Note that Samba can be very fussy about the exact format
2693 of the "dont descend" entries. For example you may need \fI ./proc\fR instead of just \fI/proc\fR.
2694 Experimentation is the best policy :-)
2696 Default: \fBnone (i.e., all directories are OK
2699 Example: \fBdont descend = /proc,/dev\fR
2701 \fBdos filemode (S)\fR
2702 The default behavior in Samba is to provide
2703 UNIX-like behavior where only the owner of a file/directory is
2704 able to change the permissions on it. However, this behavior
2705 is often confusing to DOS/Windows users. Enabling this parameter
2706 allows a user who has write access to the file (by whatever
2707 means) to modify the permissions on it. Note that a user
2708 belonging to the group owning the file will not be allowed to
2709 change permissions if the group is only granted read access.
2710 Ownership of the file/directory is not changed, only the permissions
2713 Default: \fBdos filemode = no\fR
2715 \fBdos filetime resolution (S)\fR
2716 Under the DOS and Windows FAT filesystem, the finest
2717 granularity on time resolution is two seconds. Setting this parameter
2718 for a share causes Samba to round the reported time down to the
2719 nearest two second boundary when a query call that requires one second
2720 resolution is made to \fBsmbd(8)\fR
2723 This option is mainly used as a compatibility option for Visual
2724 C++ when used against Samba shares. If oplocks are enabled on a
2725 share, Visual C++ uses two different time reading calls to check if a
2726 file has changed since it was last read. One of these calls uses a
2727 one-second granularity, the other uses a two second granularity. As
2728 the two second call rounds any odd second down, then if the file has a
2729 timestamp of an odd number of seconds then the two timestamps will not
2730 match and Visual C++ will keep reporting the file has changed. Setting
2731 this option causes the two timestamps to match, and Visual C++ is
2734 Default: \fBdos filetime resolution = no\fR
2736 \fBdos filetimes (S)\fR
2737 Under DOS and Windows, if a user can write to a
2738 file they can change the timestamp on it. Under POSIX semantics,
2739 only the owner of the file or root may change the timestamp. By
2740 default, Samba runs with POSIX semantics and refuses to change the
2741 timestamp on a file if the user \fBsmbd\fR is acting
2742 on behalf of is not the file owner. Setting this option to true allows DOS semantics and smbdwill change the file
2743 timestamp as DOS requires.
2745 Default: \fBdos filetimes = no\fR
2747 \fBencrypt passwords (G)\fR
2748 This boolean controls whether encrypted passwords
2749 will be negotiated with the client. Note that Windows NT 4.0 SP3 and
2750 above and also Windows 98 will by default expect encrypted passwords
2751 unless a registry entry is changed. To use encrypted passwords in
2752 Samba see the file ENCRYPTION.txt in the Samba documentation
2753 directory \fIdocs/\fR shipped with the source code.
2755 In order for encrypted passwords to work correctly
2756 \fBsmbd(8)\fRmust either
2757 have access to a local \fIsmbpasswd(5)
2758 \fRprogram for information on how to set up
2759 and maintain this file), or set the security = [server|domain] parameter which
2760 causes \fBsmbd\fR to authenticate against another
2763 Default: \fBencrypt passwords = no\fR
2765 \fBenhanced browsing (G)\fR
2766 This option enables a couple of enhancements to
2767 cross-subnet browse propagation that have been added in Samba
2768 but which are not standard in Microsoft implementations.
2770 The first enhancement to browse propagation consists of a regular
2771 wildcard query to a Samba WINS server for all Domain Master Browsers,
2772 followed by a browse synchronization with each of the returned
2773 DMBs. The second enhancement consists of a regular randomised browse
2774 synchronization with all currently known DMBs.
2776 You may wish to disable this option if you have a problem with empty
2777 workgroups not disappearing from browse lists. Due to the restrictions
2778 of the browse protocols these enhancements can cause a empty workgroup
2779 to stay around forever which can be annoying.
2781 In general you should leave this option enabled as it makes
2782 cross-subnet browse propagation much more reliable.
2784 Default: \fBenhanced browsing = yes\fR
2786 \fBenumports command (G)\fR
2787 The concept of a "port" is fairly foreign
2788 to UNIX hosts. Under Windows NT/2000 print servers, a port
2789 is associated with a port monitor and generally takes the form of
2790 a local port (i.e. LPT1:, COM1:, FILE:) or a remote port
2791 (i.e. LPD Port Monitor, etc...). By default, Samba has only one
2792 port defined--"Samba Printer Port". Under
2793 Windows NT/2000, all printers must have a valid port name.
2794 If you wish to have a list of ports displayed (\fBsmbd
2795 \fRdoes not use a port name for anything) other than
2796 the default "Samba Printer Port", you
2797 can define \fIenumports command\fR to point to
2798 a program which should generate a list of ports, one per line,
2799 to standard output. This listing will then be used in response
2800 to the level 1 and 2 EnumPorts() RPC.
2802 Default: \fBno enumports command\fR
2804 Example: \fBenumports command = /usr/bin/listports
2807 This is a synonym for \fIpreexec\fR.
2809 \fBfake directory create times (S)\fR
2810 NTFS and Windows VFAT file systems keep a create
2811 time for all files and directories. This is not the same as the
2812 ctime - status change time - that Unix keeps, so Samba by default
2813 reports the earliest of the various times Unix does keep. Setting
2814 this parameter for a share causes Samba to always report midnight
2815 1-1-1980 as the create time for directories.
2817 This option is mainly used as a compatibility option for
2818 Visual C++ when used against Samba shares. Visual C++ generated
2819 makefiles have the object directory as a dependency for each object
2820 file, and a make rule to create the directory. Also, when NMAKE
2821 compares timestamps it uses the creation time when examining a
2822 directory. Thus the object directory will be created if it does not
2823 exist, but once it does exist it will always have an earlier
2824 timestamp than the object files it contains.
2826 However, Unix time semantics mean that the create time
2827 reported by Samba will be updated whenever a file is created or
2828 or deleted in the directory. NMAKE finds all object files in
2829 the object directory. The timestamp of the last one built is then
2830 compared to the timestamp of the object directory. If the
2831 directory's timestamp if newer, then all object files
2832 will be rebuilt. Enabling this option
2833 ensures directories always predate their contents and an NMAKE build
2834 will proceed as expected.
2836 Default: \fBfake directory create times = no\fR
2838 \fBfake oplocks (S)\fR
2839 Oplocks are the way that SMB clients get permission
2840 from a server to locally cache file operations. If a server grants
2841 an oplock (opportunistic lock) then the client is free to assume
2842 that it is the only one accessing the file and it will aggressively
2843 cache file data. With some oplock types the client may even cache
2844 file open/close operations. This can give enormous performance benefits.
2846 When you set \fBfake oplocks = yes\fR, \fBsmbd(8)\fRwill
2847 always grant oplock requests no matter how many clients are using
2850 It is generally much better to use the real \fIoplocks\fR support rather
2851 than this parameter.
2853 If you enable this option on all read-only shares or
2854 shares that you know will only be accessed from one client at a
2855 time such as physically read-only media like CDROMs, you will see
2856 a big performance improvement on many operations. If you enable
2857 this option on shares where multiple clients may be accessing the
2858 files read-write at the same time you can get data corruption. Use
2859 this option carefully!
2861 Default: \fBfake oplocks = no\fR
2863 \fBfollow symlinks (S)\fR
2864 This parameter allows the Samba administrator
2865 to stop \fBsmbd(8)\fR
2866 from following symbolic links in a particular share. Setting this
2867 parameter to no prevents any file or directory
2868 that is a symbolic link from being followed (the user will get an
2869 error). This option is very useful to stop users from adding a
2870 symbolic link to \fI/etc/passwd\fR in their home
2871 directory for instance. However it will slow filename lookups
2874 This option is enabled (i.e. \fBsmbd\fR will
2875 follow symbolic links) by default.
2877 Default: \fBfollow symlinks = yes\fR
2879 \fBforce create mode (S)\fR
2880 This parameter specifies a set of UNIX mode bit
2881 permissions that will \fBalways\fR be set on a
2882 file created by Samba. This is done by bitwise 'OR'ing these bits onto
2883 the mode bits of a file that is being created or having its
2884 permissions changed. The default for this parameter is (in octal)
2885 000. The modes in this parameter are bitwise 'OR'ed onto the file
2886 mode after the mask set in the \fIcreate mask\fR
2887 parameter is applied.
2889 See also the parameter \fIcreate
2890 mask\fR for details on masking mode bits on files.
2892 See also the \fIinherit
2893 permissions\fR parameter.
2895 Default: \fBforce create mode = 000\fR
2897 Example: \fBforce create mode = 0755\fR
2899 would force all created files to have read and execute
2900 permissions set for 'group' and 'other' as well as the
2901 read/write/execute bits set for the 'user'.
2903 \fBforce directory mode (S)\fR
2904 This parameter specifies a set of UNIX mode bit
2905 permissions that will \fBalways\fR be set on a directory
2906 created by Samba. This is done by bitwise 'OR'ing these bits onto the
2907 mode bits of a directory that is being created. The default for this
2908 parameter is (in octal) 0000 which will not add any extra permission
2909 bits to a created directory. This operation is done after the mode
2910 mask in the parameter \fIdirectory mask\fR is
2913 See also the parameter \fI directory mask\fR for details on masking mode bits
2914 on created directories.
2916 See also the \fI inherit permissions\fR parameter.
2918 Default: \fBforce directory mode = 000\fR
2920 Example: \fBforce directory mode = 0755\fR
2922 would force all created directories to have read and execute
2923 permissions set for 'group' and 'other' as well as the
2924 read/write/execute bits set for the 'user'.
2926 \fBforce directory\fR
2927 This parameter controls what UNIX permission bits
2928 can be modified when a Windows NT client is manipulating the UNIX
2929 permission on a directory using the native NT security dialog box.
2931 This parameter is applied as a mask (OR'ed with) to the
2932 changed permission bits, thus forcing any bits in this mask that
2933 the user may have modified to be on. Essentially, one bits in this
2934 mask may be treated as a set of bits that, when modifying security
2935 on a directory, the user has always set to be 'on'.
2937 If not set explicitly this parameter is 000, which
2938 allows a user to modify all the user/group/world permissions on a
2939 directory without restrictions.
2941 \fBNote\fR that users who can access the
2942 Samba server through other means can easily bypass this restriction,
2943 so it is primarily useful for standalone "appliance" systems.
2944 Administrators of most normal systems will probably want to leave
2947 See also the \fI directory security mask\fR, \fIsecurity mask\fR,
2948 \fIforce security mode
2951 Default: \fBforce directory security mode = 0\fR
2953 Example: \fBforce directory security mode = 700\fR
2955 \fBforce group (S)\fR
2956 This specifies a UNIX group name that will be
2957 assigned as the default primary group for all users connecting
2958 to this service. This is useful for sharing files by ensuring
2959 that all access to files on service will use the named group for
2960 their permissions checking. Thus, by assigning permissions for this
2961 group to the files and directories within this service the Samba
2962 administrator can restrict or allow sharing of these files.
2964 In Samba 2.0.5 and above this parameter has extended
2965 functionality in the following way. If the group name listed here
2966 has a '+' character prepended to it then the current user accessing
2967 the share only has the primary group default assigned to this group
2968 if they are already assigned as a member of that group. This allows
2969 an administrator to decide that only users who are already in a
2970 particular group will create files with group ownership set to that
2971 group. This gives a finer granularity of ownership assignment. For
2972 example, the setting \fIforce group = +sys\fR means
2973 that only users who are already in group sys will have their default
2974 primary group assigned to sys when accessing this Samba share. All
2975 other users will retain their ordinary primary group.
2977 If the \fIforce user
2978 \fRparameter is also set the group specified in
2979 \fIforce group\fR will override the primary group
2980 set in \fIforce user\fR.
2985 Default: \fBno forced group\fR
2987 Example: \fBforce group = agroup\fR
2989 \fBforce security mode (S)\fR
2990 This parameter controls what UNIX permission
2991 bits can be modified when a Windows NT client is manipulating
2992 the UNIX permission on a file using the native NT security dialog
2995 This parameter is applied as a mask (OR'ed with) to the
2996 changed permission bits, thus forcing any bits in this mask that
2997 the user may have modified to be on. Essentially, one bits in this
2998 mask may be treated as a set of bits that, when modifying security
2999 on a file, the user has always set to be 'on'.
3001 If not set explicitly this parameter is set to 0,
3002 and allows a user to modify all the user/group/world permissions on a file,
3003 with no restrictions.
3005 \fBNote\fR that users who can access
3006 the Samba server through other means can easily bypass this restriction,
3007 so it is primarily useful for standalone "appliance" systems.
3008 Administrators of most normal systems will probably want to leave
3011 See also the \fI force directory security mode\fR,
3012 \fIdirectory security
3013 mask\fR, \fI security mask\fR parameters.
3015 Default: \fBforce security mode = 0\fR
3017 Example: \fBforce security mode = 700\fR
3019 \fBforce unknown acl user (S)\fR
3020 If this parameter is set, a Windows NT ACL that contains
3021 an unknown SID (security descriptor, or representation of a user or group id)
3022 as the owner or group owner of the file will be silently mapped into the
3023 current UNIX uid or gid of the currently connected user.
3025 This is designed to allow Windows NT clients to copy files and
3026 folders containing ACLs that were created locally on the client machine
3027 and contain users local to that machine only (no domain users) to be
3028 copied to a Samba server (usually with XCOPY /O) and have the unknown
3029 userid and groupid of the file owner map to the current connected user.
3030 This can only be fixed correctly when winbindd allows arbitrary mapping
3031 from any Windows NT SID to a UNIX uid or gid.
3033 Try using this parameter when XCOPY /O gives an ACCESS_DENIED error.
3035 See also \fIforce group
3037 Default: \fBFalse\fR
3039 Example: \fBforce unknown acl user = yes\fR
3041 \fBforce user (S)\fR
3042 This specifies a UNIX user name that will be
3043 assigned as the default user for all users connecting to this service.
3044 This is useful for sharing files. You should also use it carefully
3045 as using it incorrectly can cause security problems.
3047 This user name only gets used once a connection is established.
3048 Thus clients still need to connect as a valid user and supply a
3049 valid password. Once connected, all file operations will be performed
3050 as the "forced user", no matter what username the client connected
3051 as. This can be very useful.
3053 In Samba 2.0.5 and above this parameter also causes the
3054 primary group of the forced user to be used as the primary group
3055 for all file activity. Prior to 2.0.5 the primary group was left
3056 as the primary group of the connecting user (this was a bug).
3058 See also \fIforce group
3060 Default: \fBno forced user\fR
3062 Example: \fBforce user = auser\fR
3065 This parameter allows the administrator to
3066 configure the string that specifies the type of filesystem a share
3067 is using that is reported by \fBsmbd(8)
3068 \fRwhen a client queries the filesystem type
3069 for a share. The default type is NTFS for
3070 compatibility with Windows NT but this can be changed to other
3071 strings such as Samba or FAT
3074 Default: \fBfstype = NTFS\fR
3076 Example: \fBfstype = Samba\fR
3078 \fBgetwd cache (G)\fR
3079 This is a tuning option. When this is enabled a
3080 caching algorithm will be used to reduce the time taken for getwd()
3081 calls. This can have a significant impact on performance, especially
3082 when the \fIwide links\fR
3083 parameter is set to false.
3085 Default: \fBgetwd cache = yes\fR
3088 Synonym for \fIforce
3091 \fBguest account (S)\fR
3092 This is a username which will be used for access
3093 to services which are specified as \fI guest ok\fR (see below). Whatever privileges this
3094 user has will be available to any client connecting to the guest service.
3095 Typically this user will exist in the password file, but will not
3096 have a valid login. The user account "ftp" is often a good choice
3097 for this parameter. If a username is specified in a given service,
3098 the specified username overrides this one.
3100 One some systems the default guest account "nobody" may not
3101 be able to print. Use another account in this case. You should test
3102 this by trying to log in as your guest user (perhaps by using the
3103 \fBsu -\fR command) and trying to print using the
3104 system print command such as \fBlpr(1)\fR or \fB lp(1)\fR.
3106 Default: \fBspecified at compile time, usually
3109 Example: \fBguest account = ftp\fR
3112 If this parameter is yes for
3113 a service, then no password is required to connect to the service.
3114 Privileges will be those of the \fI guest account\fR.
3116 See the section below on \fI security\fR for more information about this option.
3118 Default: \fBguest ok = no\fR
3120 \fBguest only (S)\fR
3121 If this parameter is yes for
3122 a service, then only guest connections to the service are permitted.
3123 This parameter will have no effect if \fIguest ok\fR is not set for the service.
3125 See the section below on \fI security\fR for more information about this option.
3127 Default: \fBguest only = no\fR
3129 \fBhide dot files (S)\fR
3130 This is a boolean parameter that controls whether
3131 files starting with a dot appear as hidden files.
3133 Default: \fBhide dot files = yes\fR
3136 This is a list of files or directories that are not
3137 visible but are accessible. The DOS 'hidden' attribute is applied
3138 to any files or directories that match.
3140 Each entry in the list must be separated by a '/',
3141 which allows spaces to be included in the entry. '*'
3142 and '?' can be used to specify multiple files or directories
3143 as in DOS wildcards.
3145 Each entry must be a Unix path, not a DOS path and must
3146 not include the Unix directory separator '/'.
3148 Note that the case sensitivity option is applicable
3151 Setting this parameter will affect the performance of Samba,
3152 as it will be forced to check all files and directories for a match
3153 as they are scanned.
3156 dot files\fR, \fI veto files\fR and \fIcase sensitive\fR.
3158 Default: \fBno file are hidden\fR
3160 Example: \fBhide files =
3161 /.*/DesktopFolderDB/TrashFor%m/resource.frk/\fR
3163 The above example is based on files that the Macintosh
3164 SMB client (DAVE) available from
3165 Thursby <URL:http://www.thursby.com> creates for internal use, and also still hides
3166 all files beginning with a dot.
3168 \fBhide local users(G)\fR
3169 This parameter toggles the hiding of local UNIX
3170 users (root, wheel, floppy, etc) from remote clients.
3172 Default: \fBhide local users = no\fR
3174 \fBhide unreadable (S)\fR
3175 This parameter prevents clients from seeing the
3176 existance of files that cannot be read. Defaults to off.
3178 Default: \fBhide unreadable = no\fR
3180 \fBhomedir map (G)\fR
3182 \fRis true, and \fBsmbd(8)\fRis also acting
3183 as a Win95/98 \fIlogon server\fR then this parameter
3184 specifies the NIS (or YP) map from which the server for the user's
3185 home directory should be extracted. At present, only the Sun
3186 auto.home map format is understood. The form of the map is:
3188 \fBusername server:/some/file/system\fR
3190 and the program will extract the servername from before
3191 the first ':'. There should probably be a better parsing system
3192 that copes with different map formats and also Amd (another
3195 \fBNOTE :\fRA working NIS client is required on
3196 the system for this option to work.
3198 See also \fInis homedir\fR
3199 , \fIdomain logons\fR
3202 Default: \fBhomedir map = <empty string>\fR
3204 Example: \fBhomedir map = amd.homedir\fR
3206 \fBhost msdfs (G)\fR
3207 This boolean parameter is only available
3208 if Samba has been configured and compiled with the \fB --with-msdfs\fR option. If set to yes,
3209 Samba will act as a Dfs server, and allow Dfs-aware clients
3210 to browse Dfs trees hosted on the server.
3212 See also the \fI msdfs root\fR share level parameter. For
3213 more information on setting up a Dfs tree on Samba,
3214 refer to msdfs_setup.html.
3216 Default: \fBhost msdfs = no\fR
3218 \fBhosts allow (S)\fR
3219 A synonym for this parameter is \fIallow
3222 This parameter is a comma, space, or tab delimited
3223 set of hosts which are permitted to access a service.
3225 If specified in the [global] section then it will
3226 apply to all services, regardless of whether the individual
3227 service has a different setting.
3229 You can specify the hosts by name or IP number. For
3230 example, you could restrict access to only the hosts on a
3231 Class C subnet with something like \fBallow hosts = 150.203.5.
3232 \fR\&. The full syntax of the list is described in the man
3233 page \fIhosts_access(5)\fR. Note that this man
3234 page may not be present on your system, so a brief description will
3237 Note that the localhost address 127.0.0.1 will always
3238 be allowed access unless specifically denied by a \fIhosts deny\fR option.
3240 You can also specify hosts by network/netmask pairs and
3241 by netgroup names if your system supports netgroups. The
3242 \fBEXCEPT\fR keyword can also be used to limit a
3243 wildcard list. The following examples may provide some help:
3245 Example 1: allow all IPs in 150.203.*.*; except one
3247 \fBhosts allow = 150.203. EXCEPT 150.203.6.66\fR
3249 Example 2: allow hosts that match the given network/netmask
3251 \fBhosts allow = 150.203.15.0/255.255.255.0\fR
3253 Example 3: allow a couple of hosts
3255 \fBhosts allow = lapland, arvidsjaur\fR
3257 Example 4: allow only hosts in NIS netgroup "foonet", but
3258 deny access from one particular host
3260 \fBhosts allow = @foonet\fR
3262 \fBhosts deny = pirate\fR
3264 Note that access still requires suitable user-level passwords.
3266 See \fBtestparm(1)\fR
3267 for a way of testing your host access to see if it does
3270 Default: \fBnone (i.e., all hosts permitted access)
3272 Example: \fBallow hosts = 150.203.5. myhost.mynet.edu.au
3274 \fBhosts deny (S)\fR
3275 The opposite of \fIhosts allow\fR
3276 - hosts listed here are \fBNOT\fR permitted access to
3277 services unless the specific services have their own lists to override
3278 this one. Where the lists conflict, the \fIallow\fR
3279 list takes precedence.
3281 Default: \fBnone (i.e., no hosts specifically excluded)
3283 Example: \fBhosts deny = 150.203.4. badhost.mynet.edu.au
3285 \fBhosts equiv (G)\fR
3286 If this global parameter is a non-null string,
3287 it specifies the name of a file to read for the names of hosts
3288 and users who will be allowed access without specifying a password.
3290 This is not be confused with \fIhosts allow\fR which is about hosts
3291 access to services and is more useful for guest services. \fI hosts equiv\fR may be useful for NT clients which will
3292 not supply passwords to Samba.
3294 \fBNOTE :\fR The use of \fIhosts equiv
3295 \fRcan be a major security hole. This is because you are
3296 trusting the PC to supply the correct username. It is very easy to
3297 get a PC to supply a false username. I recommend that the
3298 \fIhosts equiv\fR option be only used if you really
3299 know what you are doing, or perhaps on a home network where you trust
3300 your spouse and kids. And only if you \fBreally\fR trust
3303 Default: \fBno host equivalences\fR
3305 Example: \fBhosts equiv = /etc/hosts.equiv\fR
3308 This allows you to include one config file
3309 inside another. The file is included literally, as though typed
3312 It takes the standard substitutions, except \fI%u
3313 \fR, \fI%P\fR and \fI%S\fR.
3315 Default: \fBno file included\fR
3317 Example: \fBinclude = /usr/local/samba/lib/admin_smb.conf
3319 \fBinherit acls (S)\fR
3320 This parameter can be used to ensure
3321 that if default acls exist on parent directories,
3322 they are always honored when creating a subdirectory.
3323 The default behavior is to use the mode specified
3324 when creating the directory. Enabling this option
3325 sets the mode to 0777, thus guaranteeing that
3326 default directory acls are propagated.
3328 Default: \fBinherit acls = no\fR
3330 \fBinherit permissions (S)\fR
3331 The permissions on new files and directories
3332 are normally governed by \fI create mask\fR, \fIdirectory mask\fR, \fIforce create mode\fR
3334 directory mode\fR but the boolean inherit
3335 permissions parameter overrides this.
3337 New directories inherit the mode of the parent directory,
3338 including bits such as setgid.
3340 New files inherit their read/write bits from the parent
3341 directory. Their execute bits continue to be determined by
3344 and \fImap system\fR
3347 Note that the setuid bit is \fBnever\fR set via
3348 inheritance (the code explicitly prohibits this).
3350 This can be particularly useful on large systems with
3351 many users, perhaps several thousand, to allow a single [homes]
3352 share to be used flexibly by each user.
3354 See also \fIcreate mask
3355 \fR, \fI directory mask\fR, \fIforce create mode\fR and \fIforce directory mode\fR
3358 Default: \fBinherit permissions = no\fR
3360 \fBinterfaces (G)\fR
3361 This option allows you to override the default
3362 network interfaces list that Samba will use for browsing, name
3363 registration and other NBT traffic. By default Samba will query
3364 the kernel for the list of all active interfaces and use any
3365 interfaces except 127.0.0.1 that are broadcast capable.
3367 The option takes a list of interface strings. Each string
3368 can be in any of the following forms:
3372 a network interface name (such as eth0).
3373 This may include shell-like wildcards so eth* will match
3374 any interface starting with the substring "eth"
3377 an IP address. In this case the netmask is
3378 determined from the list of interfaces obtained from the
3385 a broadcast/mask pair.
3388 The "mask" parameters can either be a bit length (such
3389 as 24 for a C class network) or a full netmask in dotted
3393 The "IP" parameters above can either be a full dotted
3394 decimal IP address or a hostname which will be looked up via
3395 the OS's normal hostname resolution mechanisms.
3398 For example, the following line:
3401 \fBinterfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0
3404 would configure three network interfaces corresponding
3405 to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10.
3406 The netmasks of the latter two interfaces would be set to 255.255.255.0.
3413 Default: \fBall active interfaces except 127.0.0.1
3414 that are broadcast capable\fR
3417 \fBinvalid users (S)\fR
3418 This is a list of users that should not be allowed
3419 to login to this service. This is really a \fBparanoid\fR
3420 check to absolutely ensure an improper setting does not breach
3423 A name starting with a '@' is interpreted as an NIS
3424 netgroup first (if your system supports NIS), and then as a UNIX
3425 group if the name was not found in the NIS netgroup database.
3427 A name starting with '+' is interpreted only
3428 by looking in the UNIX group database. A name starting with
3429 \&'&' is interpreted only by looking in the NIS netgroup database
3430 (this requires NIS to be working on your system). The characters
3431 \&'+' and '&' may be used at the start of the name in either order
3432 so the value \fI+&group\fR means check the
3433 UNIX group database, followed by the NIS netgroup database, and
3434 the value \fI&+group\fR means check the NIS
3435 netgroup database, followed by the UNIX group database (the
3436 same as the '@' prefix).
3438 The current servicename is substituted for \fI%S\fR.
3439 This is useful in the [homes] section.
3441 See also \fIvalid users
3444 Default: \fBno invalid users\fR
3446 Example: \fBinvalid users = root fred admin @wheel
3449 The value of the parameter (an integer) represents
3450 the number of seconds between \fIkeepalive\fR
3451 packets. If this parameter is zero, no keepalive packets will be
3452 sent. Keepalive packets, if sent, allow the server to tell whether
3453 a client is still present and responding.
3455 Keepalives should, in general, not be needed if the socket
3456 being used has the SO_KEEPALIVE attribute set on it (see \fIsocket options\fR).
3457 Basically you should only use this option if you strike difficulties.
3459 Default: \fBkeepalive = 300\fR
3461 Example: \fBkeepalive = 600\fR
3463 \fBkernel oplocks (G)\fR
3464 For UNIXes that support kernel based \fIoplocks\fR
3465 (currently only IRIX and the Linux 2.4 kernel), this parameter
3466 allows the use of them to be turned on or off.
3468 Kernel oplocks support allows Samba \fIoplocks
3469 \fRto be broken whenever a local UNIX process or NFS operation
3470 accesses a file that \fBsmbd(8)\fR
3471 has oplocked. This allows complete data consistency between
3472 SMB/CIFS, NFS and local file access (and is a \fBvery\fR
3475 This parameter defaults to on, but is translated
3476 to a no-op on systems that no not have the necessary kernel support.
3477 You should never need to touch this parameter.
3479 See also the \fIoplocks\fR
3480 and \fIlevel2 oplocks
3483 Default: \fBkernel oplocks = yes\fR
3485 \fBlanman auth (G)\fR
3486 This parameter determines whether or not smbdwill
3487 attempt to authenticate users using the LANMAN password hash.
3488 If disabled, only clients which support NT password hashes (e.g. Windows
3489 NT/2000 clients, smbclient, etc... but not Windows 95/98 or the MS DOS
3490 network client) will be able to connect to the Samba host.
3492 Default : \fBlanman auth = yes\fR
3494 \fBlarge readwrite (G)\fR
3495 This parameter determines whether or not smbd
3496 supports the new 64k streaming read and write varient SMB requests introduced
3497 with Windows 2000. Note that due to Windows 2000 client redirector bugs
3498 this requires Samba to be running on a 64-bit capable operating system such
3499 as IRIX, Solaris or a Linux 2.4 kernel. Can improve performance by 10% with
3500 Windows 2000 clients. Defaults to off. Not as tested as some other Samba
3503 Default : \fBlarge readwrite = no\fR
3505 \fBldap admin dn (G)\fR
3506 This parameter is only available if Samba has been
3507 configure to include the \fB--with-ldapsam\fR option
3508 at compile time. This option should be considered experimental and
3509 under active development.
3511 The \fIldap admin dn\fR defines the Distinguished
3512 Name (DN) name used by Samba to contact the ldap
3513 server when retreiving user account information. The \fIldap
3514 admin dn\fR is used in conjunction with the admin dn password
3515 stored in the \fIprivate/secrets.tdb\fR file. See the
3516 \fBsmbpasswd(8)\fRman
3517 page for more information on how to accmplish this.
3519 Default : \fBnone\fR
3521 \fBldap filter (G)\fR
3522 This parameter is only available if Samba has been
3523 configure to include the \fB--with-ldapsam\fR option
3524 at compile time. This option should be considered experimental and
3525 under active development.
3527 This parameter specifies the RFC 2254 compliant LDAP search filter.
3528 The default is to match the login name with the uid
3529 attribute for all entries matching the sambaAccount
3530 objectclass. Note that this filter should only return one entry.
3532 Default : \fBldap filter = (&(uid=%u)(objectclass=sambaAccount))\fR
3535 This parameter is only available if Samba has been
3536 configure to include the \fB--with-ldapsam\fR option
3537 at compile time. This option should be considered experimental and
3538 under active development.
3540 This option is used to control the tcp port number used to contact
3541 the \fIldap server\fR.
3542 The default is to use the stand LDAPS port 636.
3546 Default : \fBldap port = 636 ; if ldap ssl = on\fR
3548 Default : \fBldap port = 389 ; if ldap ssl = off\fR
3550 \fBldap server (G)\fR
3551 This parameter is only available if Samba has been
3552 configure to include the \fB--with-ldapsam\fR option
3553 at compile time. This option should be considered experimental and
3554 under active development.
3556 This parameter should contains the FQDN of the ldap directory
3557 server which should be queried to locate user account information.
3559 Default : \fBldap server = localhost\fR
3562 This parameter is only available if Samba has been
3563 configure to include the \fB--with-ldapsam\fR option
3564 at compile time. This option should be considered experimental and
3565 under active development.
3567 This option is used to define whether or not Samba should
3568 use SSL when connecting to the \fIldap
3569 server\fR. This is \fBNOT\fR related to
3570 Samba SSL support which is enabled by specifying the
3571 \fB--with-ssl\fR option to the \fIconfigure\fR
3572 script (see \fIssl\fR).
3574 The \fIldap ssl\fR can be set to one of three values:
3575 (a) on - Always use SSL when contacting the
3576 \fIldap server\fR, (b) off -
3577 Never use SSL when querying the directory, or (c) start_tls
3578 - Use the LDAPv3 StartTLS extended operation
3579 (RFC2830) for communicating with the directory server.
3581 Default : \fBldap ssl = on\fR
3583 \fBldap suffix (G)\fR
3584 This parameter is only available if Samba has been
3585 configure to include the \fB--with-ldapsam\fR option
3586 at compile time. This option should be considered experimental and
3587 under active development.
3589 Default : \fBnone\fR
3591 \fBlevel2 oplocks (S)\fR
3592 This parameter controls whether Samba supports
3593 level2 (read-only) oplocks on a share.
3595 Level2, or read-only oplocks allow Windows NT clients
3596 that have an oplock on a file to downgrade from a read-write oplock
3597 to a read-only oplock once a second client opens the file (instead
3598 of releasing all oplocks on a second open, as in traditional,
3599 exclusive oplocks). This allows all openers of the file that
3600 support level2 oplocks to cache the file for read-ahead only (ie.
3601 they may not cache writes or lock requests) and increases performance
3602 for many accesses of files that are not commonly written (such as
3603 application .EXE files).
3605 Once one of the clients which have a read-only oplock
3606 writes to the file all clients are notified (no reply is needed
3607 or waited for) and told to break their oplocks to "none" and
3608 delete any read-ahead caches.
3610 It is recommended that this parameter be turned on
3611 to speed access to shared executables.
3613 For more discussions on level2 oplocks see the CIFS spec.
3615 Currently, if \fIkernel
3616 oplocks\fR are supported then level2 oplocks are
3617 not granted (even if this parameter is set to yes).
3618 Note also, the \fIoplocks\fR
3619 parameter must be set to true on this share in order for
3620 this parameter to have any effect.
3622 See also the \fIoplocks\fR
3623 and \fIkernel oplocks\fR
3626 Default: \fBlevel2 oplocks = yes\fR
3628 \fBlm announce (G)\fR
3629 This parameter determines if \fBnmbd(8)\fRwill produce Lanman announce
3630 broadcasts that are needed by OS/2 clients in order for them to see
3631 the Samba server in their browse list. This parameter can have three
3632 values, true, false, or
3633 auto. The default is auto.
3634 If set to false Samba will never produce these
3635 broadcasts. If set to true Samba will produce
3636 Lanman announce broadcasts at a frequency set by the parameter
3637 \fIlm interval\fR. If set to auto
3638 Samba will not send Lanman announce broadcasts by default but will
3639 listen for them. If it hears such a broadcast on the wire it will
3640 then start sending them at a frequency set by the parameter
3643 See also \fIlm interval
3646 Default: \fBlm announce = auto\fR
3648 Example: \fBlm announce = yes\fR
3650 \fBlm interval (G)\fR
3651 If Samba is set to produce Lanman announce
3652 broadcasts needed by OS/2 clients (see the \fIlm announce\fR parameter) then this
3653 parameter defines the frequency in seconds with which they will be
3654 made. If this is set to zero then no Lanman announcements will be
3655 made despite the setting of the \fIlm announce\fR
3661 Default: \fBlm interval = 60\fR
3663 Example: \fBlm interval = 120\fR
3665 \fBload printers (G)\fR
3666 A boolean variable that controls whether all
3667 printers in the printcap will be loaded for browsing by default.
3668 See the printers section for
3671 Default: \fBload printers = yes\fR
3673 \fBlocal master (G)\fR
3674 This option allows \fB nmbd(8)\fRto try and become a local master browser
3675 on a subnet. If set to false then \fB nmbd\fR will not attempt to become a local master browser
3676 on a subnet and will also lose in all browsing elections. By
3677 default this value is set to true. Setting this value to true doesn't
3678 mean that Samba will \fBbecome\fR the local master
3679 browser on a subnet, just that \fBnmbd\fR will \fB participate\fR in elections for local master browser.
3681 Setting this value to false will cause \fBnmbd\fR
3682 \fBnever\fR to become a local master browser.
3684 Default: \fBlocal master = yes\fR
3687 Synonym for \fI lock directory\fR.
3689 \fBlock directory (G)\fR
3690 This option specifies the directory where lock
3691 files will be placed. The lock files are used to implement the
3692 \fImax connections\fR
3695 Default: \fBlock directory = ${prefix}/var/locks\fR
3697 Example: \fBlock directory = /var/run/samba/locks\fR
3699 \fBlock spin count (G)\fR
3700 This parameter controls the number of times
3701 that smbd should attempt to gain a byte range lock on the
3702 behalf of a client request. Experiments have shown that
3703 Windows 2k servers do not reply with a failure if the lock
3704 could not be immediately granted, but try a few more times
3705 in case the lock could later be aquired. This behavior
3706 is used to support PC database formats such as MS Access
3709 Default: \fBlock spin count = 2\fR
3711 \fBlock spin time (G)\fR
3712 The time in microseconds that smbd should
3713 pause before attempting to gain a failed lock. See
3715 count\fR for more details.
3717 Default: \fBlock spin time = 10\fR
3720 This controls whether or not locking will be
3721 performed by the server in response to lock requests from the
3724 If \fBlocking = no\fR, all lock and unlock
3725 requests will appear to succeed and all lock queries will report
3726 that the file in question is available for locking.
3728 If \fBlocking = yes\fR, real locking will be performed
3731 This option \fBmay\fR be useful for read-only
3732 filesystems which \fBmay\fR not need locking (such as
3733 CDROM drives), although setting this parameter of no
3734 is not really recommended even in this case.
3736 Be careful about disabling locking either globally or in a
3737 specific service, as lack of locking may result in data corruption.
3738 You should never need to set this parameter.
3740 Default: \fBlocking = yes\fR
3743 This option allows you to override the name
3744 of the Samba log file (also known as the debug file).
3746 This option takes the standard substitutions, allowing
3747 you to have separate log files for each user or machine.
3749 Example: \fBlog file = /usr/local/samba/var/log.%m
3752 The value of the parameter (an integer) allows
3753 the debug level (logging level) to be specified in the
3754 \fIsmb.conf\fR file. This is to give greater
3755 flexibility in the configuration of the system.
3757 The default will be the log level specified on
3758 the command line or level zero if none was specified.
3760 Example: \fBlog level = 3\fR
3762 \fBlogon drive (G)\fR
3763 This parameter specifies the local path to
3764 which the home directory will be connected (see \fIlogon home\fR)
3765 and is only used by NT Workstations.
3767 Note that this option is only useful if Samba is set up as a
3770 Default: \fBlogon drive = z:\fR
3772 Example: \fBlogon drive = h:\fR
3774 \fBlogon home (G)\fR
3775 This parameter specifies the home directory
3776 location when a Win95/98 or NT Workstation logs into a Samba PDC.
3779 C:\\> \fBNET USE H: /HOME\fR
3781 from a command prompt, for example.
3783 This option takes the standard substitutions, allowing
3784 you to have separate logon scripts for each user or machine.
3786 This parameter can be used with Win9X workstations to ensure
3787 that roaming profiles are stored in a subdirectory of the user's
3788 home directory. This is done in the following way:
3790 \fBlogon home = \\\\%N\\%U\\profile\fR
3792 This tells Samba to return the above string, with
3793 substitutions made when a client requests the info, generally
3794 in a NetUserGetInfo request. Win9X clients truncate the info to
3795 \\\\server\\share when a user does \fBnet use /home\fR
3796 but use the whole string when dealing with profiles.
3798 Note that in prior versions of Samba, the \fIlogon path\fR was returned rather than
3799 \fIlogon home\fR. This broke \fBnet use
3800 /home\fR but allowed profiles outside the home directory.
3801 The current implementation is correct, and can be used for
3802 profiles if you use the above trick.
3804 This option is only useful if Samba is set up as a logon
3807 Default: \fBlogon home = "\\\\%N\\%U"\fR
3809 Example: \fBlogon home = "\\\\remote_smb_server\\%U"\fR
3811 \fBlogon path (G)\fR
3812 This parameter specifies the home directory
3813 where roaming profiles (NTuser.dat etc files for Windows NT) are
3814 stored. Contrary to previous versions of these manual pages, it has
3815 nothing to do with Win 9X roaming profiles. To find out how to
3816 handle roaming profiles for Win 9X system, see the \fIlogon home\fR parameter.
3818 This option takes the standard substitutions, allowing you
3819 to have separate logon scripts for each user or machine. It also
3820 specifies the directory from which the "Application Data",
3821 (\fIdesktop\fR, \fIstart menu\fR,
3822 \fInetwork neighborhood\fR, \fIprograms\fR
3823 and other folders, and their contents, are loaded and displayed on
3824 your Windows NT client.
3826 The share and the path must be readable by the user for
3827 the preferences and directories to be loaded onto the Windows NT
3828 client. The share must be writeable when the user logs in for the first
3829 time, in order that the Windows NT client can create the NTuser.dat
3830 and other directories.
3832 Thereafter, the directories and any of the contents can,
3833 if required, be made read-only. It is not advisable that the
3834 NTuser.dat file be made read-only - rename it to NTuser.man to
3835 achieve the desired effect (a \fBMAN\fRdatory
3838 Windows clients can sometimes maintain a connection to
3839 the [homes] share, even though there is no user logged in.
3840 Therefore, it is vital that the logon path does not include a
3841 reference to the homes share (i.e. setting this parameter to
3842 \\%N\\%U\\profile_path will cause problems).
3844 This option takes the standard substitutions, allowing
3845 you to have separate logon scripts for each user or machine.
3847 Note that this option is only useful if Samba is set up
3850 Default: \fBlogon path = \\\\%N\\%U\\profile\fR
3852 Example: \fBlogon path = \\\\PROFILESERVER\\PROFILE\\%U\fR
3854 \fBlogon script (G)\fR
3855 This parameter specifies the batch file (.bat) or
3856 NT command file (.cmd) to be downloaded and run on a machine when
3857 a user successfully logs in. The file must contain the DOS
3858 style CR/LF line endings. Using a DOS-style editor to create the
3859 file is recommended.
3861 The script must be a relative path to the [netlogon]
3862 service. If the [netlogon] service specifies a \fIpath\fR of \fI/usr/local/samba/netlogon
3863 \fR, and \fBlogon script = STARTUP.BAT\fR, then
3864 the file that will be downloaded is:
3866 \fI/usr/local/samba/netlogon/STARTUP.BAT\fR
3868 The contents of the batch file are entirely your choice. A
3869 suggested command would be to add \fBNET TIME \\\\SERVER /SET
3870 /YES\fR, to force every machine to synchronize clocks with
3871 the same time server. Another use would be to add \fBNET USE
3872 U: \\\\SERVER\\UTILS\fR for commonly used utilities, or \fB NET USE Q: \\\\SERVER\\ISO9001_QA\fR for example.
3874 Note that it is particularly important not to allow write
3875 access to the [netlogon] share, or to grant users write permission
3876 on the batch files in a secure environment, as this would allow
3877 the batch files to be arbitrarily modified and security to be
3880 This option takes the standard substitutions, allowing you
3881 to have separate logon scripts for each user or machine.
3883 This option is only useful if Samba is set up as a logon
3886 Default: \fBno logon script defined\fR
3888 Example: \fBlogon script = scripts\\%U.bat\fR
3890 \fBlppause command (S)\fR
3891 This parameter specifies the command to be
3892 executed on the server host in order to stop printing or spooling
3893 a specific print job.
3895 This command should be a program or script which takes
3896 a printer name and job number to pause the print job. One way
3897 of implementing this is by using job priorities, where jobs
3898 having a too low priority won't be sent to the printer.
3900 If a \fI%p\fR is given then the printer name
3901 is put in its place. A \fI%j\fR is replaced with
3902 the job number (an integer). On HPUX (see \fIprinting=hpux
3903 \fR), if the \fI-p%p\fR option is added
3904 to the lpq command, the job will show up with the correct status, i.e.
3905 if the job priority is lower than the set fence priority it will
3906 have the PAUSED status, whereas if the priority is equal or higher it
3907 will have the SPOOLED or PRINTING status.
3909 Note that it is good practice to include the absolute path
3910 in the lppause command as the PATH may not be available to the server.
3912 See also the \fIprinting
3915 Default: Currently no default value is given to
3916 this string, unless the value of the \fIprinting\fR
3917 parameter is SYSV, in which case the default is :
3919 \fBlp -i %p-%j -H hold\fR
3921 or if the value of the \fIprinting\fR parameter
3922 is SOFTQ, then the default is:
3924 \fBqstat -s -j%j -h\fR
3926 Example for HPUX: \fBlppause command = /usr/bin/lpalt
3929 \fBlpq cache time (G)\fR
3930 This controls how long lpq info will be cached
3931 for to prevent the \fBlpq\fR command being called too
3932 often. A separate cache is kept for each variation of the \fB lpq\fR command used by the system, so if you use different
3933 \fBlpq\fR commands for different users then they won't
3934 share cache information.
3936 The cache files are stored in \fI/tmp/lpq.xxxx\fR
3937 where xxxx is a hash of the \fBlpq\fR command in use.
3939 The default is 10 seconds, meaning that the cached results
3940 of a previous identical \fBlpq\fR command will be used
3941 if the cached data is less than 10 seconds old. A large value may
3942 be advisable if your \fBlpq\fR command is very slow.
3944 A value of 0 will disable caching completely.
3946 See also the \fIprinting
3949 Default: \fBlpq cache time = 10\fR
3951 Example: \fBlpq cache time = 30\fR
3953 \fBlpq command (S)\fR
3954 This parameter specifies the command to be
3955 executed on the server host in order to obtain \fBlpq
3956 \fR-style printer status information.
3958 This command should be a program or script which
3959 takes a printer name as its only parameter and outputs printer
3962 Currently nine styles of printer status information
3963 are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ.
3964 This covers most UNIX systems. You control which type is expected
3965 using the \fIprinting =\fR option.
3967 Some clients (notably Windows for Workgroups) may not
3968 correctly send the connection number for the printer they are
3969 requesting status information about. To get around this, the
3970 server reports on the first printer service connected to by the
3971 client. This only happens if the connection number sent is invalid.
3973 If a \fI%p\fR is given then the printer name
3974 is put in its place. Otherwise it is placed at the end of the
3977 Note that it is good practice to include the absolute path
3978 in the \fIlpq command\fR as the \fB$PATH
3979 \fRmay not be available to the server. When compiled with
3980 the CUPS libraries, no \fIlpq command\fR is
3981 needed because smbd will make a library call to obtain the
3982 print queue listing.
3984 See also the \fIprinting
3987 Default: \fBdepends on the setting of \fI printing\fB\fR
3989 Example: \fBlpq command = /usr/bin/lpq -P%p\fR
3991 \fBlpresume command (S)\fR
3992 This parameter specifies the command to be
3993 executed on the server host in order to restart or continue
3994 printing or spooling a specific print job.
3996 This command should be a program or script which takes
3997 a printer name and job number to resume the print job. See
3998 also the \fIlppause command
4001 If a \fI%p\fR is given then the printer name
4002 is put in its place. A \fI%j\fR is replaced with
4003 the job number (an integer).
4005 Note that it is good practice to include the absolute path
4006 in the \fIlpresume command\fR as the PATH may not
4007 be available to the server.
4009 See also the \fIprinting
4012 Default: Currently no default value is given
4013 to this string, unless the value of the \fIprinting\fR
4014 parameter is SYSV, in which case the default is :
4016 \fBlp -i %p-%j -H resume\fR
4018 or if the value of the \fIprinting\fR parameter
4019 is SOFTQ, then the default is:
4021 \fBqstat -s -j%j -r\fR
4023 Example for HPUX: \fBlpresume command = /usr/bin/lpalt
4026 \fBlprm command (S)\fR
4027 This parameter specifies the command to be
4028 executed on the server host in order to delete a print job.
4030 This command should be a program or script which takes
4031 a printer name and job number, and deletes the print job.
4033 If a \fI%p\fR is given then the printer name
4034 is put in its place. A \fI%j\fR is replaced with
4035 the job number (an integer).
4037 Note that it is good practice to include the absolute
4038 path in the \fIlprm command\fR as the PATH may not be
4039 available to the server.
4041 See also the \fIprinting
4044 Default: \fBdepends on the setting of \fIprinting
4046 Example 1: \fBlprm command = /usr/bin/lprm -P%p %j
4048 Example 2: \fBlprm command = /usr/bin/cancel %p-%j
4050 \fBmachine password timeout (G)\fR
4051 If a Samba server is a member of a Windows
4052 NT Domain (see the security = domain)
4053 parameter) then periodically a running smbd(8)process will try and change the MACHINE ACCOUNT
4054 PASSWORD stored in the TDB called \fIprivate/secrets.tdb
4055 \fR\&. This parameter specifies how often this password
4056 will be changed, in seconds. The default is one week (expressed in
4057 seconds), the same as a Windows NT Domain member server.
4059 See also \fBsmbpasswd(8)
4060 \fR, and the security = domain) parameter.
4062 Default: \fBmachine password timeout = 604800\fR
4064 \fBmagic output (S)\fR
4065 This parameter specifies the name of a file
4066 which will contain output created by a magic script (see the
4070 Warning: If two clients use the same \fImagic script
4071 \fRin the same directory the output file content
4074 Default: \fBmagic output = <magic script name>.out
4076 Example: \fBmagic output = myfile.txt\fR
4078 \fBmagic script (S)\fR
4079 This parameter specifies the name of a file which,
4080 if opened, will be executed by the server when the file is closed.
4081 This allows a UNIX script to be sent to the Samba host and
4082 executed on behalf of the connected user.
4084 Scripts executed in this way will be deleted upon
4085 completion assuming that the user has the appropriate level
4086 of privilege and the file permissions allow the deletion.
4088 If the script generates output, output will be sent to
4089 the file specified by the \fI magic output\fR parameter (see above).
4091 Note that some shells are unable to interpret scripts
4092 containing CR/LF instead of CR as
4093 the end-of-line marker. Magic scripts must be executable
4094 \fBas is\fR on the host, which for some hosts and
4095 some shells will require filtering at the DOS end.
4097 Magic scripts are \fBEXPERIMENTAL\fR and
4098 should \fBNOT\fR be relied upon.
4100 Default: \fBNone. Magic scripts disabled.\fR
4102 Example: \fBmagic script = user.csh\fR
4104 \fBmangle case (S)\fR
4105 See the section on NAME MANGLING
4107 Default: \fBmangle case = no\fR
4109 \fBmangled map (S)\fR
4110 This is for those who want to directly map UNIX
4111 file names which cannot be represented on Windows/DOS. The mangling
4112 of names is not always what is needed. In particular you may have
4113 documents with file extensions that differ between DOS and UNIX.
4114 For example, under UNIX it is common to use \fI.html\fR
4115 for HTML files, whereas under Windows/DOS \fI.htm\fR
4116 is more commonly used.
4118 So to map \fIhtml\fR to \fIhtm\fR
4121 \fBmangled map = (*.html *.htm)\fR
4123 One very useful case is to remove the annoying \fI;1
4124 \fRoff the ends of filenames on some CDROMs (only visible
4125 under some UNIXes). To do this use a map of (*;1 *;).
4127 Default: \fBno mangled map\fR
4129 Example: \fBmangled map = (*;1 *;)\fR
4131 \fBmangled names (S)\fR
4132 This controls whether non-DOS names under UNIX
4133 should be mapped to DOS-compatible names ("mangled") and made visible,
4134 or whether non-DOS names should simply be ignored.
4136 See the section on NAME MANGLING for details on how to control the mangling process.
4138 If mangling algorithm "hash" is used then the mangling algorithm is as follows:
4142 The first (up to) five alphanumeric characters
4143 before the rightmost dot of the filename are preserved, forced
4144 to upper case, and appear as the first (up to) five characters
4145 of the mangled name.
4148 A tilde "~" is appended to the first part of the mangled
4149 name, followed by a two-character unique sequence, based on the
4150 original root name (i.e., the original filename minus its final
4151 extension). The final extension is included in the hash calculation
4152 only if it contains any upper case characters or is longer than three
4155 Note that the character to use may be specified using
4156 the \fImangling char\fR
4157 option, if you don't like '~'.
4160 The first three alphanumeric characters of the final
4161 extension are preserved, forced to upper case and appear as the
4162 extension of the mangled name. The final extension is defined as that
4163 part of the original filename after the rightmost dot. If there are no
4164 dots in the filename, the mangled name will have no extension (except
4165 in the case of "hidden files" - see below).
4168 Files whose UNIX name begins with a dot will be
4169 presented as DOS hidden files. The mangled name will be created as
4170 for other filenames, but with the leading dot removed and "___" as
4171 its extension regardless of actual original extension (that's three
4175 The two-digit hash value consists of upper case
4176 alphanumeric characters.
4179 This algorithm can cause name collisions only if files
4180 in a directory share the same first five alphanumeric characters.
4181 The probability of such a clash is 1/1300.
4184 If mangling algorithm "hash2" is used then the mangling algorithm is as follows:
4189 The first alphanumeric character
4190 before the rightmost dot of the filename is preserved, forced
4191 to upper case, and appears as the first character of the mangled name.
4194 A base63 hash of 5 characters is generated and the
4195 first 4 characters of that hash are appended to the first character.
4198 A tilde "~" is appended to the first part of the mangled
4199 name, followed by the final character of the base36 hash of the name.
4201 Note that the character to use may be specified using
4202 the \fImangling char\fR
4203 option, if you don't like '~'.
4206 The first three alphanumeric characters of the final
4207 extension are preserved, forced to upper case and appear as the
4208 extension of the mangled name. The final extension is defined as that
4209 part of the original filename after the rightmost dot. If there are no
4210 dots in the filename, the mangled name will have no extension (except
4211 in the case of "hidden files" - see below).
4214 Files whose UNIX name begins with a dot will be
4215 presented as DOS hidden files. The mangled name will be created as
4216 for other filenames, but with the leading dot removed and "___" as
4217 its extension regardless of actual original extension (that's three
4221 The name mangling (if enabled) allows a file to be
4222 copied between UNIX directories from Windows/DOS while retaining
4223 the long UNIX filename. UNIX files can be renamed to a new extension
4224 from Windows/DOS and will retain the same basename. Mangled names
4225 do not change between sessions.
4228 Default: \fBmangled names = yes\fR
4231 \fBmangled stack (G)\fR
4232 This parameter controls the number of mangled names
4233 that should be cached in the Samba server smbd(8).
4235 This stack is a list of recently mangled base names
4236 (extensions are only maintained if they are longer than 3 characters
4237 or contains upper case characters).
4239 The larger this value, the more likely it is that mangled
4240 names can be successfully converted to correct long UNIX names.
4241 However, large stack sizes will slow most directory accesses. Smaller
4242 stacks save memory in the server (each stack element costs 256 bytes).
4244 It is not possible to absolutely guarantee correct long
4245 filenames, so be prepared for some surprises!
4247 Default: \fBmangled stack = 50\fR
4249 Example: \fBmangled stack = 100\fR
4251 \fBmangling char (S)\fR
4252 This controls what character is used as
4253 the \fBmagic\fR character in name mangling. The default is a '~'
4254 but this may interfere with some software. Use this option to set
4255 it to whatever you prefer.
4257 Default: \fBmangling char = ~\fR
4259 Example: \fBmangling char = ^\fR
4261 \fBmangling mathod(G)\fR
4262 controls the algorithm used for the generating
4263 the mangled names. Can take two different values, "hash" and
4264 "hash2". "hash" is the default and is the algorithm that has been
4265 used in Samba for many years. "hash2" is a newer and considered
4266 a better algorithm (generates less collisions) in the names.
4267 However, many Win32 applications store the mangled names and so
4268 changing to the new algorithm must not be done
4269 lightly as these applications may break unless reinstalled.
4270 New installations of Samba may set the default to hash2.
4272 Default: \fBmangling method = hash\fR
4274 Example: \fBmangling method = hash2\fR
4276 \fBmap archive (S)\fR
4277 This controls whether the DOS archive attribute
4278 should be mapped to the UNIX owner execute bit. The DOS archive bit
4279 is set when a file has been modified since its last backup. One
4280 motivation for this option it to keep Samba/your PC from making
4281 any file it touches from becoming executable under UNIX. This can
4282 be quite annoying for shared source code, documents, etc...
4284 Note that this requires the \fIcreate mask\fR
4285 parameter to be set such that owner execute bit is not masked out
4286 (i.e. it must include 100). See the parameter \fIcreate mask\fR for details.
4288 Default: \fBmap archive = yes\fR
4290 \fBmap hidden (S)\fR
4291 This controls whether DOS style hidden files
4292 should be mapped to the UNIX world execute bit.
4294 Note that this requires the \fIcreate mask\fR
4295 to be set such that the world execute bit is not masked out (i.e.
4296 it must include 001). See the parameter \fIcreate mask\fR for details.
4298 Default: \fBmap hidden = no\fR
4300 \fBmap system (S)\fR
4301 This controls whether DOS style system files
4302 should be mapped to the UNIX group execute bit.
4304 Note that this requires the \fIcreate mask\fR
4305 to be set such that the group execute bit is not masked out (i.e.
4306 it must include 010). See the parameter \fIcreate mask\fR for details.
4308 Default: \fBmap system = no\fR
4310 \fBmap to guest (G)\fR
4311 This parameter is only useful in security modes other than \fIsecurity = share\fR
4312 - i.e. user, server,
4315 This parameter can take three different values, which tell
4316 smbd(8)what to do with user
4317 login requests that don't match a valid UNIX user in some way.
4319 The three settings are :
4323 Never - Means user login
4324 requests with an invalid password are rejected. This is the
4328 Bad User - Means user
4329 logins with an invalid password are rejected, unless the username
4330 does not exist, in which case it is treated as a guest login and
4331 mapped into the \fI guest account\fR.
4334 Bad Password - Means user logins
4335 with an invalid password are treated as a guest login and mapped
4336 into the guest account. Note that
4337 this can cause problems as it means that any user incorrectly typing
4338 their password will be silently logged on as "guest" - and
4339 will not know the reason they cannot access files they think
4340 they should - there will have been no message given to them
4341 that they got their password wrong. Helpdesk services will
4342 \fBhate\fR you if you set the \fImap to
4343 guest\fR parameter this way :-).
4346 Note that this parameter is needed to set up "Guest"
4347 share services when using \fIsecurity\fR modes other than
4348 share. This is because in these modes the name of the resource being
4349 requested is \fBnot\fR sent to the server until after
4350 the server has successfully authenticated the client so the server
4351 cannot make authentication decisions at the correct time (connection
4352 to the share) for "Guest" shares.
4355 For people familiar with the older Samba releases, this
4356 parameter maps to the old compile-time setting of the GUEST_SESSSETUP value in local.h.
4359 Default: \fBmap to guest = Never\fR
4362 Example: \fBmap to guest = Bad User\fR
4365 \fBmax connections (S)\fR
4366 This option allows the number of simultaneous
4367 connections to a service to be limited. If \fImax connections
4368 \fRis greater than 0 then connections will be refused if
4369 this number of connections to the service are already open. A value
4370 of zero mean an unlimited number of connections may be made.
4372 Record lock files are used to implement this feature. The
4373 lock files will be stored in the directory specified by the \fIlock directory\fR
4376 Default: \fBmax connections = 0\fR
4378 Example: \fBmax connections = 10\fR
4380 \fBmax disk size (G)\fR
4381 This option allows you to put an upper limit
4382 on the apparent size of disks. If you set this option to 100
4383 then all shares will appear to be not larger than 100 MB in
4386 Note that this option does not limit the amount of
4387 data you can put on the disk. In the above case you could still
4388 store much more than 100 MB on the disk, but if a client ever asks
4389 for the amount of free disk space or the total disk size then the
4390 result will be bounded by the amount specified in \fImax
4393 This option is primarily useful to work around bugs
4394 in some pieces of software that can't handle very large disks,
4395 particularly disks over 1GB in size.
4397 A \fImax disk size\fR of 0 means no limit.
4399 Default: \fBmax disk size = 0\fR
4401 Example: \fBmax disk size = 1000\fR
4403 \fBmax log size (G)\fR
4404 This option (an integer in kilobytes) specifies
4405 the max size the log file should grow to. Samba periodically checks
4406 the size and if it is exceeded it will rename the file, adding
4407 a \fI.old\fR extension.
4409 A size of 0 means no limit.
4411 Default: \fBmax log size = 5000\fR
4413 Example: \fBmax log size = 1000\fR
4416 This option controls the maximum number of
4417 outstanding simultaneous SMB operations that Samba tells the client
4418 it will allow. You should never need to set this parameter.
4420 Default: \fBmax mux = 50\fR
4422 \fBmax open files (G)\fR
4423 This parameter limits the maximum number of
4424 open files that one smbd(8)file
4425 serving process may have open for a client at any one time. The
4426 default for this parameter is set very high (10,000) as Samba uses
4427 only one bit per unopened file.
4429 The limit of the number of open files is usually set
4430 by the UNIX per-process file descriptor limit rather than
4431 this parameter so you should never need to touch this parameter.
4433 Default: \fBmax open files = 10000\fR
4435 \fBmax print jobs (S)\fR
4436 This parameter limits the maximum number of
4437 jobs allowable in a Samba printer queue at any given moment.
4438 If this number is exceeded, \fB smbd(8)\fRwill remote "Out of Space" to the client.
4442 Default: \fBmax print jobs = 1000\fR
4444 Example: \fBmax print jobs = 5000\fR
4446 \fBmax protocol (G)\fR
4447 The value of the parameter (a string) is the highest
4448 protocol level that will be supported by the server.
4450 Possible values are :
4454 CORE: Earliest version. No
4455 concept of user names.
4458 COREPLUS: Slight improvements on
4459 CORE for efficiency.
4462 LANMAN1: First \fB modern\fR version of the protocol. Long filename
4466 LANMAN2: Updates to Lanman1 protocol.
4469 NT1: Current up to date version of
4470 the protocol. Used by Windows NT. Known as CIFS.
4473 Normally this option should not be set as the automatic
4474 negotiation phase in the SMB protocol takes care of choosing
4475 the appropriate protocol.
4482 Default: \fBmax protocol = NT1\fR
4485 Example: \fBmax protocol = LANMAN1\fR
4488 \fBmax smbd processes (G)\fR
4489 This parameter limits the maximum number of
4491 processes concurrently running on a system and is intended
4492 as a stopgap to prevent degrading service to clients in the event
4493 that the server has insufficient resources to handle more than this
4494 number of connections. Remember that under normal operating
4495 conditions, each user will have an smbdassociated with him or her
4496 to handle connections to all shares from a given host.
4498 Default: \fBmax smbd processes = 0\fR ## no limit
4500 Example: \fBmax smbd processes = 1000\fR
4503 This option tells nmbd(8)
4504 what the default 'time to live' of NetBIOS names should be (in seconds)
4505 when \fBnmbd\fR is requesting a name using either a
4506 broadcast packet or from a WINS server. You should never need to
4507 change this parameter. The default is 3 days.
4509 Default: \fBmax ttl = 259200\fR
4511 \fBmax wins ttl (G)\fR
4512 This option tells nmbd(8)
4513 when acting as a WINS server ( \fIwins support = yes\fR) what the maximum
4514 \&'time to live' of NetBIOS names that \fBnmbd\fR
4515 will grant will be (in seconds). You should never need to change this
4516 parameter. The default is 6 days (518400 seconds).
4519 wins ttl\fR parameter.
4521 Default: \fBmax wins ttl = 518400\fR
4524 This option controls the maximum packet size
4525 that will be negotiated by Samba. The default is 65535, which
4526 is the maximum. In some cases you may find you get better performance
4527 with a smaller value. A value below 2048 is likely to cause problems.
4529 Default: \fBmax xmit = 65535\fR
4531 Example: \fBmax xmit = 8192\fR
4533 \fBmessage command (G)\fR
4534 This specifies what command to run when the
4535 server receives a WinPopup style message.
4537 This would normally be a command that would
4538 deliver the message somehow. How this is to be done is
4539 up to your imagination.
4543 \fBmessage command = csh -c 'xedit %s;rm %s' &\fR
4545 This delivers the message using \fBxedit\fR, then
4546 removes it afterwards. \fBNOTE THAT IT IS VERY IMPORTANT
4547 THAT THIS COMMAND RETURN IMMEDIATELY\fR. That's why I
4548 have the '&' on the end. If it doesn't return immediately then
4549 your PCs may freeze when sending messages (they should recover
4550 after 30 seconds, hopefully).
4552 All messages are delivered as the global guest user.
4553 The command takes the standard substitutions, although \fI %u\fR won't work (\fI%U\fR may be better
4556 Apart from the standard substitutions, some additional
4557 ones apply. In particular:
4561 \fI%s\fR = the filename containing
4565 \fI%t\fR = the destination that
4566 the message was sent to (probably the server name).
4569 \fI%f\fR = who the message
4573 You could make this command send mail, or whatever else
4574 takes your fancy. Please let us know of any really interesting
4578 Here's a way of sending the messages as mail to root:
4581 \fBmessage command = /bin/mail -s 'message from %f on
4582 %m' root < %s; rm %s\fR
4585 If you don't have a message command then the message
4586 won't be delivered and Samba will tell the sender there was
4587 an error. Unfortunately WfWg totally ignores the error code
4588 and carries on regardless, saying that the message was delivered.
4591 If you want to silently delete it then try:
4594 \fBmessage command = rm %s\fR
4597 Default: \fBno message command\fR
4600 Example: \fBmessage command = csh -c 'xedit %s;
4604 \fBmin passwd length (G)\fR
4605 Synonym for \fImin password length\fR.
4607 \fBmin password length (G)\fR
4608 This option sets the minimum length in characters
4609 of a plaintext password that \fBsmbd\fR will accept when performing
4610 UNIX password changing.
4613 password sync\fR, \fIpasswd program\fR and \fIpasswd chat debug\fR
4616 Default: \fBmin password length = 5\fR
4618 \fBmin print space (S)\fR
4619 This sets the minimum amount of free disk
4620 space that must be available before a user will be able to spool
4621 a print job. It is specified in kilobytes. The default is 0, which
4622 means a user can always spool a print job.
4624 See also the \fIprinting
4627 Default: \fBmin print space = 0\fR
4629 Example: \fBmin print space = 2000\fR
4631 \fBmin protocol (G)\fR
4632 The value of the parameter (a string) is the
4633 lowest SMB protocol dialect than Samba will support. Please refer
4634 to the \fImax protocol\fR
4635 parameter for a list of valid protocol names and a brief description
4636 of each. You may also wish to refer to the C source code in
4637 \fIsource/smbd/negprot.c\fR for a listing of known protocol
4638 dialects supported by clients.
4640 If you are viewing this parameter as a security measure, you should
4641 also refer to the \fIlanman
4642 auth\fR parameter. Otherwise, you should never need
4643 to change this parameter.
4645 Default : \fBmin protocol = CORE\fR
4647 Example : \fBmin protocol = NT1\fR # disable DOS
4650 \fBmin wins ttl (G)\fR
4651 This option tells nmbd(8)
4652 when acting as a WINS server (\fI wins support = yes\fR) what the minimum 'time to live'
4653 of NetBIOS names that \fBnmbd\fR will grant will be (in
4654 seconds). You should never need to change this parameter. The default
4655 is 6 hours (21600 seconds).
4657 Default: \fBmin wins ttl = 21600\fR
4659 \fBmsdfs root (S)\fR
4660 This boolean parameter is only available if
4661 Samba is configured and compiled with the \fB --with-msdfs\fR option. If set to yes,
4662 Samba treats the share as a Dfs root and allows clients to browse
4663 the distributed file system tree rooted at the share directory.
4664 Dfs links are specified in the share directory by symbolic
4665 links of the form \fImsdfs:serverA\\shareA,serverB\\shareB
4666 \fRand so on. For more information on setting up a Dfs tree
4667 on Samba, refer to msdfs_setup.html
4670 See also \fIhost msdfs
4672 Default: \fBmsdfs root = no\fR
4674 \fBname resolve order (G)\fR
4675 This option is used by the programs in the Samba
4676 suite to determine what naming services to use and in what order
4677 to resolve host names to IP addresses. The option takes a space
4678 separated string of name resolution options.
4680 The options are :"lmhosts", "host", "wins" and "bcast". They
4681 cause names to be resolved as follows :
4685 lmhosts : Lookup an IP
4686 address in the Samba lmhosts file. If the line in lmhosts has
4687 no name type attached to the NetBIOS name (see the lmhosts(5)for details) then
4688 any name type matches for lookup.
4691 host : Do a standard host
4692 name to IP address resolution, using the system \fI/etc/hosts
4693 \fR, NIS, or DNS lookups. This method of name resolution
4694 is operating system depended for instance on IRIX or Solaris this
4695 may be controlled by the \fI/etc/nsswitch.conf\fR
4696 file. Note that this method is only used if the NetBIOS name
4697 type being queried is the 0x20 (server) name type, otherwise
4701 wins : Query a name with
4702 the IP address listed in the \fI wins server\fR parameter. If no WINS server has
4703 been specified this method will be ignored.
4706 bcast : Do a broadcast on
4707 each of the known local interfaces listed in the \fIinterfaces\fR
4708 parameter. This is the least reliable of the name resolution
4709 methods as it depends on the target host being on a locally
4713 Default: \fBname resolve order = lmhosts host wins bcast
4716 Example: \fBname resolve order = lmhosts bcast host
4719 This will cause the local lmhosts file to be examined
4720 first, followed by a broadcast attempt, followed by a normal
4721 system hostname lookup.
4724 \fBnetbios aliases (G)\fR
4725 This is a list of NetBIOS names that nmbd(8)will advertise as additional
4726 names by which the Samba server is known. This allows one machine
4727 to appear in browse lists under multiple names. If a machine is
4728 acting as a browse server or logon server none
4729 of these names will be advertised as either browse server or logon
4730 servers, only the primary name of the machine will be advertised
4731 with these capabilities.
4736 Default: \fBempty string (no additional names)\fR
4738 Example: \fBnetbios aliases = TEST TEST1 TEST2\fR
4740 \fBnetbios name (G)\fR
4741 This sets the NetBIOS name by which a Samba
4742 server is known. By default it is the same as the first component
4743 of the host's DNS name. If a machine is a browse server or
4744 logon server this name (or the first component
4745 of the hosts DNS name) will be the name that these services are
4751 Default: \fBmachine DNS name\fR
4753 Example: \fBnetbios name = MYNAME\fR
4755 \fBnetbios scope (G)\fR
4756 This sets the NetBIOS scope that Samba will
4757 operate under. This should not be set unless every machine
4758 on your LAN also sets this value.
4760 \fBnis homedir (G)\fR
4761 Get the home share server from a NIS map. For
4762 UNIX systems that use an automounter, the user's home directory
4763 will often be mounted on a workstation on demand from a remote
4766 When the Samba logon server is not the actual home directory
4767 server, but is mounting the home directories via NFS then two
4768 network hops would be required to access the users home directory
4769 if the logon server told the client to use itself as the SMB server
4770 for home directories (one over SMB and one over NFS). This can
4773 This option allows Samba to return the home share as
4774 being on a different server to the logon server and as
4775 long as a Samba daemon is running on the home directory server,
4776 it will be mounted on the Samba client directly from the directory
4777 server. When Samba is returning the home share to the client, it
4778 will consult the NIS map specified in \fIhomedir map\fR and return the server
4781 Note that for this option to work there must be a working
4782 NIS system and the Samba server with this option must also
4785 Default: \fBnis homedir = no\fR
4787 \fBnt acl support (S)\fR
4788 This boolean parameter controls whether
4789 smbd(8)will attempt to map
4790 UNIX permissions into Windows NT access control lists.
4791 This parameter was formally a global parameter in releases
4794 Default: \fBnt acl support = yes\fR
4796 \fBnt pipe support (G)\fR
4797 This boolean parameter controls whether
4798 smbd(8)will allow Windows NT
4799 clients to connect to the NT SMB specific IPC$
4800 pipes. This is a developer debugging option and can be left
4803 Default: \fBnt pipe support = yes\fR
4805 \fBnt smb support (G)\fR
4806 This boolean parameter controls whether smbd(8)will negotiate NT specific SMB
4807 support with Windows NT/2k/XP clients. Although this is a developer
4808 debugging option and should be left alone, benchmarking has discovered
4809 that Windows NT clients give faster performance with this option
4810 set to no. This is still being investigated.
4811 If this option is set to no then Samba offers
4812 exactly the same SMB calls that versions prior to Samba 2.0 offered.
4813 This information may be of use if any users are having problems
4814 with NT SMB support.
4816 You should not need to ever disable this parameter.
4818 Default: \fBnt smb support = yes\fR
4820 \fBnt status support (G)\fR
4821 This boolean parameter controls whether smbd(8)will negotiate NT specific status
4822 support with Windows NT/2k/XP clients. This is a developer
4823 debugging option and should be left alone.
4824 If this option is set to no then Samba offers
4825 exactly the same DOS error codes that versions prior to Samba 2.2.3
4828 You should not need to ever disable this parameter.
4830 Default: \fBnt status support = yes\fR
4832 \fBnull passwords (G)\fR
4833 Allow or disallow client access to accounts
4834 that have null passwords.
4836 See also smbpasswd (5).
4838 Default: \fBnull passwords = no\fR
4840 \fBobey pam restrictions (G)\fR
4841 When Samba 2.2 is configured to enable PAM support
4842 (i.e. --with-pam), this parameter will control whether or not Samba
4843 should obey PAM's account and session management directives. The
4844 default behavior is to use PAM for clear text authentication only
4845 and to ignore any account or session management. Note that Samba
4846 always ignores PAM for authentication in the case of \fIencrypt passwords = yes\fR
4847 \&. The reason is that PAM modules cannot support the challenge/response
4848 authentication mechanism needed in the presence of SMB password encryption.
4850 Default: \fBobey pam restrictions = no\fR
4853 This is a boolean option that controls whether
4854 connections with usernames not in the \fIuser\fR
4855 list will be allowed. By default this option is disabled so that a
4856 client can supply a username to be used by the server. Enabling
4857 this parameter will force the server to only user the login
4858 names from the \fIuser\fR list and is only really
4859 useful in shave level
4862 Note that this also means Samba won't try to deduce
4863 usernames from the service name. This can be annoying for
4864 the [homes] section. To get around this you could use \fBuser =
4865 %S\fR which means your \fIuser\fR list
4866 will be just the service name, which for home directories is the
4869 See also the \fIuser\fR
4872 Default: \fBonly user = no\fR
4874 \fBonly guest (S)\fR
4875 A synonym for \fI guest only\fR.
4877 \fBoplock break wait time (G)\fR
4878 This is a tuning parameter added due to bugs in
4879 both Windows 9x and WinNT. If Samba responds to a client too
4880 quickly when that client issues an SMB that can cause an oplock
4881 break request, then the network client can fail and not respond
4882 to the break request. This tuning parameter (which is set in milliseconds)
4883 is the amount of time Samba will wait before sending an oplock break
4884 request to such (broken) clients.
4886 \fBDO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
4887 AND UNDERSTOOD THE SAMBA OPLOCK CODE\fR.
4889 Default: \fBoplock break wait time = 0\fR
4891 \fBoplock contention limit (S)\fR
4892 This is a \fBvery\fR advanced
4893 smbd(8)tuning option to
4894 improve the efficiency of the granting of oplocks under multiple
4895 client contention for the same file.
4897 In brief it specifies a number, which causes smbdnot to
4898 grant an oplock even when requested if the approximate number of
4899 clients contending for an oplock on the same file goes over this
4900 limit. This causes \fBsmbd\fR to behave in a similar
4903 \fBDO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
4904 AND UNDERSTOOD THE SAMBA OPLOCK CODE\fR.
4906 Default: \fBoplock contention limit = 2\fR
4909 This boolean option tells \fBsmbd\fR whether to
4910 issue oplocks (opportunistic locks) to file open requests on this
4911 share. The oplock code can dramatically (approx. 30% or more) improve
4912 the speed of access to files on Samba servers. It allows the clients
4913 to aggressively cache files locally and you may want to disable this
4914 option for unreliable network environments (it is turned on by
4915 default in Windows NT Servers). For more information see the file
4916 \fISpeed.txt\fR in the Samba \fIdocs/\fR
4919 Oplocks may be selectively turned off on certain files with a
4920 share. See the \fI veto oplock files\fR parameter. On some systems
4921 oplocks are recognized by the underlying operating system. This
4922 allows data synchronization between all access to oplocked files,
4923 whether it be via Samba or NFS or a local UNIX process. See the
4924 \fIkernel oplocks\fR parameter for details.
4926 See also the \fIkernel
4927 oplocks\fR and \fI level2 oplocks\fR parameters.
4929 Default: \fBoplocks = yes\fR
4932 This integer value controls what level Samba
4933 advertises itself as for browse elections. The value of this
4934 parameter determines whether nmbd(8)
4935 has a chance of becoming a local master browser for the \fI WORKGROUP\fR in the local broadcast area.
4937 \fBNote :\fRBy default, Samba will win
4938 a local master browsing election over all Microsoft operating
4939 systems except a Windows NT 4.0/2000 Domain Controller. This
4940 means that a misconfigured Samba host can effectively isolate
4941 a subnet for browsing purposes. See \fIBROWSING.txt
4942 \fRin the Samba \fIdocs/\fR directory
4945 Default: \fBos level = 20\fR
4947 Example: \fBos level = 65 \fR
4949 \fBos2 driver map (G)\fR
4950 The parameter is used to define the absolute
4951 path to a file containing a mapping of Windows NT printer driver
4952 names to OS/2 printer driver names. The format is:
4954 <nt driver name> = <os2 driver
4957 For example, a valid entry using the HP LaserJet 5
4958 printer driver would appear as \fBHP LaserJet 5L = LASERJET.HP
4961 The need for the file is due to the printer driver namespace
4962 problem described in the Samba
4963 Printing HOWTO. For more details on OS/2 clients, please
4964 refer to the OS2-Client-HOWTO
4965 containing in the Samba documentation.
4967 Default: \fBos2 driver map = <empty string>
4969 \fBpam password change (G)\fR
4970 With the addition of better PAM support in Samba 2.2,
4971 this parameter, it is possible to use PAM's password change control
4972 flag for Samba. If enabled, then PAM will be used for password
4973 changes when requested by an SMB client instead of the program listed in
4974 \fIpasswd program\fR.
4975 It should be possible to enable this without changing your
4977 parameter for most setups.
4979 Default: \fBpam password change = no\fR
4981 \fBpanic action (G)\fR
4982 This is a Samba developer option that allows a
4983 system command to be called when either smbd(8)
4984 crashes. This is usually used to draw attention to the fact that
4987 Default: \fBpanic action = <empty string>\fR
4989 Example: \fBpanic action = "/bin/sleep 90000"\fR
4991 \fBpasswd chat (G)\fR
4992 This string controls the \fB"chat"\fR
4993 conversation that takes places between smbdand the local password changing
4994 program to change the user's password. The string describes a
4995 sequence of response-receive pairs that smbd(8)uses to determine what to send to the
4996 \fIpasswd program\fR
4997 and what to expect back. If the expected output is not
4998 received then the password is not changed.
5000 This chat sequence is often quite site specific, depending
5001 on what local methods are used for password control (such as NIS
5004 Note that this parameter only is only used if the \fIunix
5005 password sync\fR parameter is set to yes. This
5006 sequence is then called \fBAS ROOT\fR when the SMB password
5007 in the smbpasswd file is being changed, without access to the old
5008 password cleartext. This means that root must be able to reset the user's password
5009 without knowing the text of the previous password. In the presence of NIS/YP,
5010 this means that the passwd program must be
5011 executed on the NIS master.
5013 The string can contain the macro \fI%n\fR which is substituted
5014 for the new password. The chat sequence can also contain the standard
5015 macros \\n, \\r, \\t and \\s to give line-feed,
5016 carriage-return, tab and space. The chat sequence string can also contain
5017 a '*' which matches any sequence of characters.
5018 Double quotes can be used to collect strings with spaces
5019 in them into a single string.
5021 If the send string in any part of the chat sequence
5022 is a full stop ".", then no string is sent. Similarly,
5023 if the expect string is a full stop then no string is expected.
5026 password change\fR parameter is set to true, the chat pairs
5027 may be matched in any order, and success is determined by the PAM result,
5028 not any particular output. The \\n macro is ignored for PAM conversions.
5030 See also \fIunix password
5031 sync\fR, \fI passwd program\fR , \fIpasswd chat debug\fR and \fIpam password change\fR.
5033 Default: \fBpasswd chat = *new*password* %n\\n
5034 *new*password* %n\\n *changed*\fR
5036 Example: \fBpasswd chat = "*Enter OLD password*" %o\\n
5037 "*Enter NEW password*" %n\\n "*Reenter NEW password*" %n\\n "*Password
5040 \fBpasswd chat debug (G)\fR
5041 This boolean specifies if the passwd chat script
5042 parameter is run in \fBdebug\fR mode. In this mode the
5043 strings passed to and received from the passwd chat are printed
5044 in the smbd(8)log with a
5046 of 100. This is a dangerous option as it will allow plaintext passwords
5047 to be seen in the \fBsmbd\fR log. It is available to help
5048 Samba admins debug their \fIpasswd chat\fR scripts
5049 when calling the \fIpasswd program\fR and should
5050 be turned off after this has been done. This option has no effect if the
5051 \fIpam password change\fR
5052 paramter is set. This parameter is off by default.
5054 See also \fIpasswd chat\fR
5055 , \fIpam password change\fR
5056 , \fIpasswd program\fR
5059 Default: \fBpasswd chat debug = no\fR
5061 \fBpasswd program (G)\fR
5062 The name of a program that can be used to set
5063 UNIX user passwords. Any occurrences of \fI%u\fR
5064 will be replaced with the user name. The user name is checked for
5065 existence before calling the password changing program.
5067 Also note that many passwd programs insist in \fBreasonable
5068 \fRpasswords, such as a minimum length, or the inclusion
5069 of mixed case chars and digits. This can pose a problem as some clients
5070 (such as Windows for Workgroups) uppercase the password before sending
5073 \fBNote\fR that if the \fIunix
5074 password sync\fR parameter is set to true
5075 then this program is called \fBAS ROOT\fR
5076 before the SMB password in the smbpasswd(5)
5077 file is changed. If this UNIX password change fails, then
5078 \fBsmbd\fR will fail to change the SMB password also
5079 (this is by design).
5081 If the \fIunix password sync\fR parameter
5082 is set this parameter \fBMUST USE ABSOLUTE PATHS\fR
5083 for \fBALL\fR programs called, and must be examined
5084 for security implications. Note that by default \fIunix
5085 password sync\fR is set to false.
5090 Default: \fBpasswd program = /bin/passwd\fR
5092 Example: \fBpasswd program = /sbin/npasswd %u\fR
5094 \fBpassword level (G)\fR
5095 Some client/server combinations have difficulty
5096 with mixed-case passwords. One offending client is Windows for
5097 Workgroups, which for some reason forces passwords to upper
5098 case when using the LANMAN1 protocol, but leaves them alone when
5099 using COREPLUS! Another problem child is the Windows 95/98
5100 family of operating systems. These clients upper case clear
5101 text passwords even when NT LM 0.12 selected by the protocol
5102 negotiation request/response.
5104 This parameter defines the maximum number of characters
5105 that may be upper case in passwords.
5107 For example, say the password given was "FRED". If \fI password level\fR is set to 1, the following combinations
5108 would be tried if "FRED" failed:
5110 "Fred", "fred", "fRed", "frEd","freD"
5112 If \fIpassword level\fR was set to 2,
5113 the following combinations would also be tried:
5115 "FRed", "FrEd", "FreD", "fREd", "fReD", "frED", ..
5119 The higher value this parameter is set to the more likely
5120 it is that a mixed case password will be matched against a single
5121 case password. However, you should be aware that use of this
5122 parameter reduces security and increases the time taken to
5123 process a new connection.
5125 A value of zero will cause only two attempts to be
5126 made - the password as is and the password in all-lower case.
5128 Default: \fBpassword level = 0\fR
5130 Example: \fBpassword level = 4\fR
5132 \fBpassword server (G)\fR
5133 By specifying the name of another SMB server (such
5134 as a WinNT box) with this option, and using \fBsecurity = domain
5135 \fRor \fBsecurity = server\fR you can get Samba
5136 to do all its username/password validation via a remote server.
5138 This option sets the name of the password server to use.
5139 It must be a NetBIOS name, so if the machine's NetBIOS name is
5140 different from its Internet name then you may have to add its NetBIOS
5141 name to the lmhosts file which is stored in the same directory
5142 as the \fIsmb.conf\fR file.
5144 The name of the password server is looked up using the
5146 resolve order\fR and so may resolved
5147 by any method and order described in that parameter.
5149 The password server much be a machine capable of using
5150 the "LM1.2X002" or the "NT LM 0.12" protocol, and it must be in
5151 user level security mode.
5153 \fBNOTE:\fR Using a password server
5154 means your UNIX box (running Samba) is only as secure as your
5155 password server. \fBDO NOT CHOOSE A PASSWORD SERVER THAT
5156 YOU DON'T COMPLETELY TRUST\fR.
5158 Never point a Samba server at itself for password
5159 serving. This will cause a loop and could lock up your Samba
5162 The name of the password server takes the standard
5163 substitutions, but probably the only useful one is \fI%m
5164 \fR, which means the Samba server will use the incoming
5165 client as the password server. If you use this then you better
5166 trust your clients, and you had better restrict them with hosts allow!
5168 If the \fIsecurity\fR parameter is set to
5169 domain, then the list of machines in this
5170 option must be a list of Primary or Backup Domain controllers for the
5171 Domain or the character '*', as the Samba server is effectively
5172 in that domain, and will use cryptographically authenticated RPC calls
5173 to authenticate the user logging on. The advantage of using \fB security = domain\fR is that if you list several hosts in the
5174 \fIpassword server\fR option then \fBsmbd
5175 \fRwill try each in turn till it finds one that responds. This
5176 is useful in case your primary server goes down.
5178 If the \fIpassword server\fR option is set
5179 to the character '*', then Samba will attempt to auto-locate the
5180 Primary or Backup Domain controllers to authenticate against by
5181 doing a query for the name WORKGROUP<1C>
5182 and then contacting each server returned in the list of IP
5183 addresses from the name resolution source.
5185 If the \fIsecurity\fR parameter is
5186 set to server, then there are different
5187 restrictions that \fBsecurity = domain\fR doesn't
5192 You may list several password servers in
5193 the \fIpassword server\fR parameter, however if an
5194 \fBsmbd\fR makes a connection to a password server,
5195 and then the password server fails, no more users will be able
5196 to be authenticated from this \fBsmbd\fR. This is a
5197 restriction of the SMB/CIFS protocol when in \fBsecurity = server
5198 \fRmode and cannot be fixed in Samba.
5201 If you are using a Windows NT server as your
5202 password server then you will have to ensure that your users
5203 are able to login from the Samba server, as when in \fB security = server\fR mode the network logon will appear to
5204 come from there rather than from the users workstation.
5207 See also the \fIsecurity
5211 Default: \fBpassword server = <empty string>\fR
5214 Example: \fBpassword server = NT-PDC, NT-BDC1, NT-BDC2
5217 Example: \fBpassword server = *\fR
5221 This parameter specifies a directory to which
5222 the user of the service is to be given access. In the case of
5223 printable services, this is where print data will spool prior to
5224 being submitted to the host for printing.
5226 For a printable service offering guest access, the service
5227 should be readonly and the path should be world-writeable and
5228 have the sticky bit set. This is not mandatory of course, but
5229 you probably won't get the results you expect if you do
5232 Any occurrences of \fI%u\fR in the path
5233 will be replaced with the UNIX username that the client is using
5234 on this connection. Any occurrences of \fI%m\fR
5235 will be replaced by the NetBIOS name of the machine they are
5236 connecting from. These replacements are very useful for setting
5237 up pseudo home directories for users.
5239 Note that this path will be based on \fIroot dir\fR if one was specified.
5243 Example: \fBpath = /home/fred\fR
5245 \fBpid directory (G)\fR
5246 This option specifies the directory where pid
5247 files will be placed.
5249 Default: \fBpid directory = ${prefix}/var/locks\fR
5251 Example: \fBpid directory = /var/run/\fR
5253 \fBposix locking (S)\fR
5255 daemon maintains an database of file locks obtained by SMB clients.
5256 The default behavior is to map this internal database to POSIX
5257 locks. This means that file locks obtained by SMB clients are
5258 consistent with those seen by POSIX compliant applications accessing
5259 the files via a non-SMB method (e.g. NFS or local file access).
5260 You should never need to disable this parameter.
5262 Default: \fBposix locking = yes\fR
5265 This option specifies a command to be run
5266 whenever the service is disconnected. It takes the usual
5267 substitutions. The command may be run as the root on some
5270 An interesting example may be to unmount server
5273 \fBpostexec = /etc/umount /cdrom\fR
5275 See also \fIpreexec\fR
5278 Default: \fBnone (no command executed)\fR
5280 Example: \fBpostexec = echo \\"%u disconnected from %S
5281 from %m (%I)\\" >> /tmp/log\fR
5283 \fBpostscript (S)\fR
5284 This parameter forces a printer to interpret
5285 the print files as PostScript. This is done by adding a %!
5286 to the start of print output.
5288 This is most useful when you have lots of PCs that persist
5289 in putting a control-D at the start of print jobs, which then
5290 confuses your printer.
5292 Default: \fBpostscript = no\fR
5295 This option specifies a command to be run whenever
5296 the service is connected to. It takes the usual substitutions.
5298 An interesting example is to send the users a welcome
5299 message every time they log in. Maybe a message of the day? Here
5302 \fBpreexec = csh -c 'echo \\"Welcome to %S!\\" |
5303 /usr/local/samba/bin/smbclient -M %m -I %I' & \fR
5305 Of course, this could get annoying after a while :-)
5307 See also \fIpreexec close
5311 Default: \fBnone (no command executed)\fR
5313 Example: \fBpreexec = echo \\"%u connected to %S from %m
5314 (%I)\\" >> /tmp/log\fR
5316 \fBpreexec close (S)\fR
5317 This boolean option controls whether a non-zero
5318 return code from \fIpreexec
5319 \fRshould close the service being connected to.
5321 Default: \fBpreexec close = no\fR
5323 \fBpreferred master (G)\fR
5324 This boolean parameter controls if nmbd(8)is a preferred master browser
5327 If this is set to true, on startup, \fBnmbd\fR
5328 will force an election, and it will have a slight advantage in
5329 winning the election. It is recommended that this parameter is
5330 used in conjunction with \fB\fI domain master\fB = yes\fR, so that \fB nmbd\fR can guarantee becoming a domain master.
5332 Use this option with caution, because if there are several
5333 hosts (whether Samba servers, Windows 95 or NT) that are preferred
5334 master browsers on the same subnet, they will each periodically
5335 and continuously attempt to become the local master browser.
5336 This will result in unnecessary broadcast traffic and reduced browsing
5339 See also \fIos level\fR
5342 Default: \fBpreferred master = auto\fR
5344 \fBprefered master (G)\fR
5345 Synonym for \fI preferred master\fR for people who cannot spell :-).
5348 This is a list of services that you want to be
5349 automatically added to the browse lists. This is most useful
5350 for homes and printers services that would otherwise not be
5353 Note that if you just want all printers in your
5354 printcap file loaded then the \fIload printers\fR option is easier.
5356 Default: \fBno preloaded services\fR
5358 Example: \fBpreload = fred lp colorlp\fR
5360 \fBpreserve case (S)\fR
5361 This controls if new filenames are created
5362 with the case that the client passes, or if they are forced to
5363 be the \fIdefault case
5366 Default: \fBpreserve case = yes\fR
5368 See the section on NAME
5369 MANGLING for a fuller discussion.
5371 \fBprint command (S)\fR
5372 After a print job has finished spooling to
5373 a service, this command will be used via a \fBsystem()\fR
5374 call to process the spool file. Typically the command specified will
5375 submit the spool file to the host's printing subsystem, but there
5376 is no requirement that this be the case. The server will not remove
5377 the spool file, so whatever command you specify should remove the
5378 spool file when it has been processed, otherwise you will need to
5379 manually remove old spool files.
5381 The print command is simply a text string. It will be used
5382 verbatim after macro substitutions have been made:
5384 s, %p - the path to the spool
5387 %p - the appropriate printer
5391 name as transmitted by the client.
5393 %c - The number of printed pages
5394 of the spooled job (if known).
5396 %z - the size of the spooled
5397 print job (in bytes)
5399 The print command \fBMUST\fR contain at least
5400 one occurrence of \fI%s\fR or \fI%f
5401 \fR- the \fI%p\fR is optional. At the time
5402 a job is submitted, if no printer name is supplied the \fI%p
5403 \fRwill be silently removed from the printer command.
5405 If specified in the [global] section, the print command given
5406 will be used for any printable service that does not have its own
5407 print command specified.
5409 If there is neither a specified print command for a
5410 printable service nor a global print command, spool files will
5411 be created but not processed and (most importantly) not removed.
5413 Note that printing may fail on some UNIXes from the
5414 nobody account. If this happens then create
5415 an alternative guest account that can print and set the \fIguest account\fR
5416 in the [global] section.
5418 You can form quite complex print commands by realizing
5419 that they are just passed to a shell. For example the following
5420 will log a print job, print the file, then remove it. Note that
5421 \&';' is the usual separator for command in shell scripts.
5423 \fBprint command = echo Printing %s >>
5424 /tmp/print.log; lpr -P %p %s; rm %s\fR
5426 You may have to vary this command considerably depending
5427 on how you normally print files on your system. The default for
5428 the parameter varies depending on the setting of the \fIprinting\fR parameter.
5430 Default: For \fBprinting = BSD, AIX, QNX, LPRNG
5433 \fBprint command = lpr -r -P%p %s\fR
5435 For \fBprinting = SYSV or HPUX :\fR
5437 \fBprint command = lp -c -d%p %s; rm %s\fR
5439 For \fBprinting = SOFTQ :\fR
5441 \fBprint command = lp -d%p -s %s; rm %s\fR
5443 For printing = CUPS : If SAMBA is compiled against
5444 libcups, then printcap = cups
5445 uses the CUPS API to
5446 submit jobs, etc. Otherwise it maps to the System V
5447 commands with the -oraw option for printing, i.e. it
5448 uses \fBlp -c -d%p -oraw; rm %s\fR.
5449 With \fBprinting = cups\fR,
5450 and if SAMBA is compiled against libcups, any manually
5451 set print command will be ignored.
5453 Example: \fBprint command = /usr/local/samba/bin/myprintscript
5457 Synonym for \fIprintable\fR.
5460 If this parameter is yes, then
5461 clients may open, write to and submit spool files on the directory
5462 specified for the service.
5464 Note that a printable service will ALWAYS allow writing
5465 to the service path (user privileges permitting) via the spooling
5466 of print data. The \fIwriteable
5467 \fRparameter controls only non-printing access to
5470 Default: \fBprintable = no\fR
5473 Synonym for \fI printcap name\fR.
5475 \fBprintcap name (G)\fR
5476 This parameter may be used to override the
5477 compiled-in default printcap name used by the server (usually \fI /etc/printcap\fR). See the discussion of the [printers] section above for reasons
5478 why you might want to do this.
5480 To use the CUPS printing interface set \fBprintcap name = cups
5481 \fR\&. This should be supplemented by an addtional setting
5482 printing = cups in the [global]
5483 section. \fBprintcap name = cups\fR will use the
5484 "dummy" printcap created by CUPS, as specified in your CUPS
5487 On System V systems that use \fBlpstat\fR to
5488 list available printers you can use \fBprintcap name = lpstat
5489 \fRto automatically obtain lists of available printers. This
5490 is the default for systems that define SYSV at configure time in
5491 Samba (this includes most System V based systems). If \fI printcap name\fR is set to \fBlpstat\fR on
5492 these systems then Samba will launch \fBlpstat -v\fR and
5493 attempt to parse the output to obtain a printer list.
5495 A minimal printcap file would look something like this:
5508 where the '|' separates aliases of a printer. The fact
5509 that the second alias has a space in it gives a hint to Samba
5510 that it's a comment.
5512 \fBNOTE\fR: Under AIX the default printcap
5513 name is \fI/etc/qconfig\fR. Samba will assume the
5514 file is in AIX \fIqconfig\fR format if the string
5515 \fIqconfig\fR appears in the printcap filename.
5517 Default: \fBprintcap name = /etc/printcap\fR
5519 Example: \fBprintcap name = /etc/myprintcap\fR
5521 \fBprinter admin (S)\fR
5522 This is a list of users that can do anything to
5523 printers via the remote administration interfaces offered by MS-RPC
5524 (usually using a NT workstation). Note that the root user always
5527 Default: \fBprinter admin = <empty string>\fR
5529 Example: \fBprinter admin = admin, @staff\fR
5531 \fBprinter driver (S)\fR
5532 \fBNote :\fRThis is a deprecated
5533 parameter and will be removed in the next major release
5534 following version 2.2. Please see the instructions in
5535 the Samba 2.2. Printing
5536 HOWTOfor more information
5537 on the new method of loading printer drivers onto a Samba server.
5539 This option allows you to control the string
5540 that clients receive when they ask the server for the printer driver
5541 associated with a printer. If you are using Windows95 or Windows NT
5542 then you can use this to automate the setup of printers on your
5545 You need to set this parameter to the exact string (case
5546 sensitive) that describes the appropriate printer driver for your
5547 system. If you don't know the exact string to use then you should
5548 first try with no \fI printer driver\fR option set and the client will
5549 give you a list of printer drivers. The appropriate strings are
5550 shown in a scroll box after you have chosen the printer manufacturer.
5555 Example: \fBprinter driver = HP LaserJet 4L\fR
5557 \fBprinter driver file (G)\fR
5558 \fBNote :\fRThis is a deprecated
5559 parameter and will be removed in the next major release
5560 following version 2.2. Please see the instructions in
5561 the Samba 2.2. Printing
5562 HOWTOfor more information
5563 on the new method of loading printer drivers onto a Samba server.
5565 This parameter tells Samba where the printer driver
5566 definition file, used when serving drivers to Windows 95 clients, is
5567 to be found. If this is not set, the default is :
5569 \fISAMBA_INSTALL_DIRECTORY
5570 /lib/printers.def\fR
5572 This file is created from Windows 95 \fImsprint.inf
5573 \fRfiles found on the Windows 95 client system. For more
5574 details on setting up serving of printer drivers to Windows 95
5575 clients, see the outdated documentation file in the \fIdocs/\fR
5576 directory, \fIPRINTER_DRIVER.txt\fR.
5578 See also \fI printer driver location\fR.
5580 Default: \fBNone (set in compile).\fR
5582 Example: \fBprinter driver file =
5583 /usr/local/samba/printers/drivers.def\fR
5585 \fBprinter driver location (S)\fR
5586 \fBNote :\fRThis is a deprecated
5587 parameter and will be removed in the next major release
5588 following version 2.2. Please see the instructions in
5589 the Samba 2.2. Printing
5590 HOWTOfor more information
5591 on the new method of loading printer drivers onto a Samba server.
5593 This parameter tells clients of a particular printer
5594 share where to find the printer driver files for the automatic
5595 installation of drivers for Windows 95 machines. If Samba is set up
5596 to serve printer drivers to Windows 95 machines, this should be set to
5598 \fB\\\\MACHINE\\PRINTER$\fR
5600 Where MACHINE is the NetBIOS name of your Samba server,
5601 and PRINTER$ is a share you set up for serving printer driver
5602 files. For more details on setting this up see the outdated documentation
5603 file in the \fIdocs/\fR directory, \fI PRINTER_DRIVER.txt\fR.
5605 See also \fI printer driver file\fR.
5609 Example: \fBprinter driver location = \\\\MACHINE\\PRINTER$
5611 \fBprinter name (S)\fR
5612 This parameter specifies the name of the printer
5613 to which print jobs spooled through a printable service will be sent.
5615 If specified in the [global] section, the printer
5616 name given will be used for any printable service that does
5617 not have its own printer name specified.
5619 Default: \fBnone (but may be lp
5622 Example: \fBprinter name = laserwriter\fR
5625 Synonym for \fI printer name\fR.
5628 This parameters controls how printer status
5629 information is interpreted on your system. It also affects the
5630 default values for the \fIprint command\fR,
5631 \fIlpq command\fR, \fIlppause command
5632 \fR, \fIlpresume command\fR, and
5633 \fIlprm command\fR if specified in the
5636 Currently nine printing styles are supported. They are
5643 To see what the defaults are for the other print
5644 commands when using the various options use the testparm(1)program.
5646 This option can be set on a per printer basis
5648 See also the discussion in the [printers] section.
5651 Synonym for \fImax protocol\fR.
5654 Synonym for \fIguest
5657 \fBqueuepause command (S)\fR
5658 This parameter specifies the command to be
5659 executed on the server host in order to pause the printer queue.
5661 This command should be a program or script which takes
5662 a printer name as its only parameter and stops the printer queue,
5663 such that no longer jobs are submitted to the printer.
5665 This command is not supported by Windows for Workgroups,
5666 but can be issued from the Printers window under Windows 95
5669 If a \fI%p\fR is given then the printer name
5670 is put in its place. Otherwise it is placed at the end of the command.
5672 Note that it is good practice to include the absolute
5673 path in the command as the PATH may not be available to the
5676 Default: \fBdepends on the setting of \fIprinting
5678 Example: \fBqueuepause command = disable %p\fR
5680 \fBqueueresume command (S)\fR
5681 This parameter specifies the command to be
5682 executed on the server host in order to resume the printer queue. It
5683 is the command to undo the behavior that is caused by the
5684 previous parameter (\fI queuepause command\fR).
5686 This command should be a program or script which takes
5687 a printer name as its only parameter and resumes the printer queue,
5688 such that queued jobs are resubmitted to the printer.
5690 This command is not supported by Windows for Workgroups,
5691 but can be issued from the Printers window under Windows 95
5694 If a \fI%p\fR is given then the printer name
5695 is put in its place. Otherwise it is placed at the end of the
5698 Note that it is good practice to include the absolute
5699 path in the command as the PATH may not be available to the
5702 Default: \fBdepends on the setting of \fIprinting\fB\fR
5704 Example: \fBqueuepause command = enable %p
5707 This boolean parameter controls whether smbd(8)will support the "Read
5708 Block Multiplex" SMB. This is now rarely used and defaults to
5709 no. You should never need to set this
5712 Default: \fBread bmpx = no\fR
5715 This is a list of users that are given read-only
5716 access to a service. If the connecting user is in this list then
5717 they will not be given write access, no matter what the \fIwriteable\fR
5718 option is set to. The list can include group names using the
5719 syntax described in the \fI invalid users\fR parameter.
5721 See also the \fI write list\fR parameter and the \fIinvalid users\fR
5724 Default: \fBread list = <empty string>\fR
5726 Example: \fBread list = mary, @students\fR
5729 Note that this is an inverted synonym for \fIwriteable\fR.
5732 This parameter controls whether or not the server
5733 will support the raw read SMB requests when transferring data
5736 If enabled, raw reads allow reads of 65535 bytes in
5737 one packet. This typically provides a major performance benefit.
5739 However, some clients either negotiate the allowable
5740 block size incorrectly or are incapable of supporting larger block
5741 sizes, and for these clients you may need to disable raw reads.
5743 In general this parameter should be viewed as a system tuning
5744 tool and left severely alone. See also \fIwrite raw\fR.
5746 Default: \fBread raw = yes\fR
5749 The option \fIread size\fR
5750 affects the overlap of disk reads/writes with network reads/writes.
5751 If the amount of data being transferred in several of the SMB
5752 commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger
5753 than this value then the server begins writing the data before it
5754 has received the whole packet from the network, or in the case of
5755 SMBreadbraw, it begins writing to the network before all the data
5756 has been read from disk.
5758 This overlapping works best when the speeds of disk and
5759 network access are similar, having very little effect when the
5760 speed of one is much greater than the other.
5762 The default value is 16384, but very little experimentation
5763 has been done yet to determine the optimal value, and it is likely
5764 that the best value will vary greatly between systems anyway.
5765 A value over 65536 is pointless and will cause you to allocate
5766 memory unnecessarily.
5768 Default: \fBread size = 16384\fR
5770 Example: \fBread size = 8192\fR
5772 \fBremote announce (G)\fR
5773 This option allows you to setup nmbd(8)to periodically announce itself
5774 to arbitrary IP addresses with an arbitrary workgroup name.
5776 This is useful if you want your Samba server to appear
5777 in a remote workgroup for which the normal browse propagation
5778 rules don't work. The remote workgroup can be anywhere that you
5779 can send IP packets to.
5783 \fBremote announce = 192.168.2.255/SERVERS
5784 192.168.4.255/STAFF\fR
5786 the above line would cause \fBnmbd\fR to announce itself
5787 to the two given IP addresses using the given workgroup names.
5788 If you leave out the workgroup name then the one given in
5790 parameter is used instead.
5792 The IP addresses you choose would normally be the broadcast
5793 addresses of the remote networks, but can also be the IP addresses
5794 of known browse masters if your network config is that stable.
5796 See the documentation file \fIBROWSING.txt\fR
5797 in the \fIdocs/\fR directory.
5799 Default: \fBremote announce = <empty string>
5801 \fBremote browse sync (G)\fR
5802 This option allows you to setup nmbd(8)to periodically request
5803 synchronization of browse lists with the master browser of a Samba
5804 server that is on a remote segment. This option will allow you to
5805 gain browse lists for multiple workgroups across routed networks. This
5806 is done in a manner that does not work with any non-Samba servers.
5808 This is useful if you want your Samba server and all local
5809 clients to appear in a remote workgroup for which the normal browse
5810 propagation rules don't work. The remote workgroup can be anywhere
5811 that you can send IP packets to.
5815 \fBremote browse sync = 192.168.2.255 192.168.4.255
5817 the above line would cause \fBnmbd\fR to request
5818 the master browser on the specified subnets or addresses to
5819 synchronize their browse lists with the local server.
5821 The IP addresses you choose would normally be the broadcast
5822 addresses of the remote networks, but can also be the IP addresses
5823 of known browse masters if your network config is that stable. If
5824 a machine IP address is given Samba makes NO attempt to validate
5825 that the remote machine is available, is listening, nor that it
5826 is in fact the browse master on its segment.
5828 Default: \fBremote browse sync = <empty string>
5830 \fBrestrict anonymous (G)\fR
5831 This is a boolean parameter. If it is true, then
5832 anonymous access to the server will be restricted, namely in the
5833 case where the server is expecting the client to send a username,
5834 but it doesn't. Setting it to true will force these anonymous
5835 connections to be denied, and the client will be required to always
5836 supply a username and password when connecting. Use of this parameter
5837 is only recommended for homogeneous NT client environments.
5839 This parameter makes the use of macro expansions that rely
5840 on the username (%U, %G, etc) consistent. NT 4.0
5841 likes to use anonymous connections when refreshing the share list,
5842 and this is a way to work around that.
5844 When restrict anonymous is true, all anonymous connections
5845 are denied no matter what they are for. This can effect the ability
5846 of a machine to access the Samba Primary Domain Controller to revalidate
5847 its machine account after someone else has logged on the client
5848 interactively. The NT client will display a message saying that
5849 the machine's account in the domain doesn't exist or the password is
5850 bad. The best way to deal with this is to reboot NT client machines
5851 between interactive logons, using "Shutdown and Restart", rather
5852 than "Close all programs and logon as a different user".
5854 Default: \fBrestrict anonymous = no\fR
5857 Synonym for \fIroot directory"\fR.
5860 Synonym for \fIroot directory"\fR.
5862 \fBroot directory (G)\fR
5863 The server will \fBchroot()\fR (i.e.
5864 Change its root directory) to this directory on startup. This is
5865 not strictly necessary for secure operation. Even without it the
5866 server will deny access to files not in one of the service entries.
5867 It may also check for, and deny access to, soft links to other
5868 parts of the filesystem, or attempts to use ".." in file names
5869 to access other directories (depending on the setting of the \fIwide links\fR
5872 Adding a \fIroot directory\fR entry other
5873 than "/" adds an extra level of security, but at a price. It
5874 absolutely ensures that no access is given to files not in the
5875 sub-tree specified in the \fIroot directory\fR
5876 option, \fBincluding\fR some files needed for
5877 complete operation of the server. To maintain full operability
5878 of the server you will need to mirror some system files
5879 into the \fIroot directory\fR tree. In particular
5880 you will need to mirror \fI/etc/passwd\fR (or a
5881 subset of it), and any binaries or configuration files needed for
5882 printing (if required). The set of files that must be mirrored is
5883 operating system dependent.
5885 Default: \fBroot directory = /\fR
5887 Example: \fBroot directory = /homes/smb\fR
5889 \fBroot postexec (S)\fR
5890 This is the same as the \fIpostexec\fR
5891 parameter except that the command is run as root. This
5892 is useful for unmounting filesystems
5893 (such as CDROMs) after a connection is closed.
5895 See also \fI postexec\fR.
5897 Default: \fBroot postexec = <empty string>
5899 \fBroot preexec (S)\fR
5900 This is the same as the \fIpreexec\fR
5901 parameter except that the command is run as root. This
5902 is useful for mounting filesystems (such as CDROMs) when a
5903 connection is opened.
5905 See also \fI preexec\fR and \fIpreexec close\fR.
5907 Default: \fBroot preexec = <empty string>
5909 \fBroot preexec close (S)\fR
5910 This is the same as the \fIpreexec close
5911 \fRparameter except that the command is run as root.
5913 See also \fI preexec\fR and \fIpreexec close\fR.
5915 Default: \fBroot preexec close = no\fR
5918 This option affects how clients respond to
5919 Samba and is one of the most important settings in the \fI smb.conf\fR file.
5921 The option sets the "security mode bit" in replies to
5922 protocol negotiations with smbd(8)
5923 to turn share level security on or off. Clients decide
5924 based on this bit whether (and how) to transfer user and password
5925 information to the server.
5927 The default is \fBsecurity = user\fR, as this is
5928 the most common setting needed when talking to Windows 98 and
5931 The alternatives are \fBsecurity = share\fR,
5932 \fBsecurity = server\fR or \fBsecurity = domain
5935 In versions of Samba prior to 2.0.0, the default was
5936 \fBsecurity = share\fR mainly because that was
5937 the only option at one stage.
5939 There is a bug in WfWg that has relevance to this
5940 setting. When in user or server level security a WfWg client
5941 will totally ignore the password you type in the "connect
5942 drive" dialog box. This makes it very difficult (if not impossible)
5943 to connect to a Samba service as anyone except the user that
5944 you are logged into WfWg as.
5946 If your PCs use usernames that are the same as their
5947 usernames on the UNIX machine then you will want to use
5948 \fBsecurity = user\fR. If you mostly use usernames
5949 that don't exist on the UNIX box then use \fBsecurity =
5952 You should also use \fBsecurity = share\fR if you
5953 want to mainly setup shares without a password (guest shares). This
5954 is commonly used for a shared printer server. It is more difficult
5955 to setup guest shares with \fBsecurity = user\fR, see
5956 the \fImap to guest\fR
5957 parameter for details.
5959 It is possible to use \fBsmbd\fR in a \fB hybrid mode\fR where it is offers both user and share
5960 level security under different \fINetBIOS aliases\fR.
5962 The different settings will now be explained.
5966 When clients connect to a share level security server they
5967 need not log onto the server with a valid username and password before
5968 attempting to connect to a shared resource (although modern clients
5969 such as Windows 95/98 and Windows NT will send a logon request with
5970 a username but no password when talking to a \fBsecurity = share
5971 \fRserver). Instead, the clients send authentication information
5972 (passwords) on a per-share basis, at the time they attempt to connect
5975 Note that \fBsmbd\fR \fBALWAYS\fR
5976 uses a valid UNIX user to act on behalf of the client, even in
5977 \fBsecurity = share\fR level security.
5979 As clients are not required to send a username to the server
5980 in share level security, \fBsmbd\fR uses several
5981 techniques to determine the correct UNIX user to use on behalf
5984 A list of possible UNIX usernames to match with the given
5985 client password is constructed using the following methods :
5990 only\fR parameter is set, then all the other
5991 stages are missed and only the \fIguest account\fR username is checked.
5994 Is a username is sent with the share connection
5995 request, then this username (after mapping - see \fIusername map\fR),
5996 is added as a potential username.
5999 If the client did a previous \fBlogon
6000 \fRrequest (the SessionSetup SMB call) then the
6001 username sent in this SMB will be added as a potential username.
6004 The name of the service the client requested is
6005 added as a potential username.
6008 The NetBIOS name of the client is added to
6009 the list as a potential username.
6012 Any users on the \fI user\fR list are added as potential usernames.
6015 If the \fIguest only\fR parameter is
6016 not set, then this list is then tried with the supplied password.
6017 The first user for whom the password matches will be used as the
6021 If the \fIguest only\fR parameter is
6022 set, or no username can be determined then if the share is marked
6023 as available to the \fIguest account\fR, then this
6024 guest user will be used, otherwise access is denied.
6027 Note that it can be \fBvery\fR confusing
6028 in share-level security as to which UNIX username will eventually
6029 be used in granting access.
6032 See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
6038 This is the default security setting in Samba 2.2.
6039 With user-level security a client must first "log-on" with a
6040 valid username and password (which can be mapped using the \fIusername map\fR
6041 parameter). Encrypted passwords (see the \fIencrypted passwords\fR parameter) can also
6042 be used in this security mode. Parameters such as \fIuser\fR and \fIguest only\fR if set are then applied and
6043 may change the UNIX user to use on this connection, but only after
6044 the user has been successfully authenticated.
6047 \fBNote\fR that the name of the resource being
6048 requested is \fBnot\fR sent to the server until after
6049 the server has successfully authenticated the client. This is why
6050 guest shares don't work in user level security without allowing
6051 the server to automatically map unknown users into the \fIguest account\fR.
6052 See the \fImap to guest\fR
6053 parameter for details on doing this.
6056 See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
6059 \fBSECURITY = SERVER
6062 In this mode Samba will try to validate the username/password
6063 by passing it to another SMB server, such as an NT box. If this
6064 fails it will revert to \fBsecurity = user\fR, but note
6065 that if encrypted passwords have been negotiated then Samba cannot
6066 revert back to checking the UNIX password file, it must have a valid
6067 \fIsmbpasswd\fR file to check users against. See the
6068 documentation file in the \fIdocs/\fR directory
6069 \fIENCRYPTION.txt\fR for details on how to set this
6073 \fBNote\fR that from the client's point of
6074 view \fBsecurity = server\fR is the same as \fB security = user\fR. It only affects how the server deals
6075 with the authentication, it does not in any way affect what the
6079 \fBNote\fR that the name of the resource being
6080 requested is \fBnot\fR sent to the server until after
6081 the server has successfully authenticated the client. This is why
6082 guest shares don't work in user level security without allowing
6083 the server to automatically map unknown users into the \fIguest account\fR.
6084 See the \fImap to guest\fR
6085 parameter for details on doing this.
6088 See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
6091 See also the \fIpassword
6092 server\fR parameter and the \fIencrypted passwords\fR
6096 \fBSECURITY = DOMAIN
6099 This mode will only work correctly if smbpasswd(8)has been used to add this
6100 machine into a Windows NT Domain. It expects the \fIencrypted passwords\fR
6101 parameter to be set to true. In this
6102 mode Samba will try to validate the username/password by passing
6103 it to a Windows NT Primary or Backup Domain Controller, in exactly
6104 the same way that a Windows NT Server would do.
6107 \fBNote\fR that a valid UNIX user must still
6108 exist as well as the account on the Domain Controller to allow
6109 Samba to have a valid UNIX account to map file access to.
6112 \fBNote\fR that from the client's point
6113 of view \fBsecurity = domain\fR is the same as \fBsecurity = user
6114 \fR\&. It only affects how the server deals with the authentication,
6115 it does not in any way affect what the client sees.
6118 \fBNote\fR that the name of the resource being
6119 requested is \fBnot\fR sent to the server until after
6120 the server has successfully authenticated the client. This is why
6121 guest shares don't work in user level security without allowing
6122 the server to automatically map unknown users into the \fIguest account\fR.
6123 See the \fImap to guest\fR
6124 parameter for details on doing this.
6127 \fBBUG:\fR There is currently a bug in the
6128 implementation of \fBsecurity = domain\fR with respect
6129 to multi-byte character set usernames. The communication with a
6130 Domain Controller must be done in UNICODE and Samba currently
6131 does not widen multi-byte user names to UNICODE correctly, thus
6132 a multi-byte username will not be recognized correctly at the
6133 Domain Controller. This issue will be addressed in a future release.
6136 See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
6139 See also the \fIpassword
6140 server\fR parameter and the \fIencrypted passwords\fR
6144 Default: \fBsecurity = USER\fR
6147 Example: \fBsecurity = DOMAIN\fR
6150 \fBsecurity mask (S)\fR
6151 This parameter controls what UNIX permission
6152 bits can be modified when a Windows NT client is manipulating
6153 the UNIX permission on a file using the native NT security
6156 This parameter is applied as a mask (AND'ed with) to
6157 the changed permission bits, thus preventing any bits not in
6158 this mask from being modified. Essentially, zero bits in this
6159 mask may be treated as a set of bits the user is not allowed
6162 If not set explicitly this parameter is 0777, allowing
6163 a user to modify all the user/group/world permissions on a file.
6165 \fBNote\fR that users who can access the
6166 Samba server through other means can easily bypass this
6167 restriction, so it is primarily useful for standalone
6168 "appliance" systems. Administrators of most normal systems will
6169 probably want to leave it set to 0777.
6171 See also the \fIforce directory security mode\fR,
6173 security mask\fR, \fIforce security mode\fR parameters.
6175 Default: \fBsecurity mask = 0777\fR
6177 Example: \fBsecurity mask = 0770\fR
6179 \fBserver string (G)\fR
6180 This controls what string will show up in the
6181 printer comment box in print manager and next to the IPC connection
6182 in \fBnet view\fR. It can be any string that you wish
6183 to show to your users.
6185 It also sets what will appear in browse lists next
6186 to the machine name.
6188 A \fI%v\fR will be replaced with the Samba
6191 A \fI%h\fR will be replaced with the
6194 Default: \fBserver string = Samba %v\fR
6196 Example: \fBserver string = University of GNUs Samba
6199 \fBset directory (S)\fR
6200 If \fBset directory = no\fR, then
6201 users of the service may not use the setdir command to change
6204 The \fBsetdir\fR command is only implemented
6205 in the Digital Pathworks client. See the Pathworks documentation
6208 Default: \fBset directory = no\fR
6210 \fBshare modes (S)\fR
6211 This enables or disables the honoring of
6212 the \fIshare modes\fR during a file open. These
6213 modes are used by clients to gain exclusive read or write access
6216 These open modes are not directly supported by UNIX, so
6217 they are simulated using shared memory, or lock files if your
6218 UNIX doesn't support shared memory (almost all do).
6220 The share modes that are enabled by this option are
6222 DENY_READ, DENY_WRITE,
6223 DENY_NONE and DENY_FCB.
6225 This option gives full share compatibility and enabled
6228 You should \fBNEVER\fR turn this parameter
6229 off as many Windows applications will break if you do so.
6231 Default: \fBshare modes = yes\fR
6233 \fBshort preserve case (S)\fR
6234 This boolean parameter controls if new files
6235 which conform to 8.3 syntax, that is all in upper case and of
6236 suitable length, are created upper case, or if they are forced
6237 to be the \fIdefault case
6238 \fR\&. This option can be use with \fBpreserve case = yes\fR
6239 to permit long filenames to retain their case, while short
6242 See the section on NAME MANGLING.
6244 Default: \fBshort preserve case = yes\fR
6246 \fBshow add printer wizard (G)\fR
6247 With the introduction of MS-RPC based printing support
6248 for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will
6249 appear on Samba hosts in the share listing. Normally this folder will
6250 contain an icon for the MS Add Printer Wizard (APW). However, it is
6251 possible to disable this feature regardless of the level of privilege
6252 of the connected user.
6254 Under normal circumstances, the Windows NT/2000 client will
6255 open a handle on the printer server with OpenPrinterEx() asking for
6256 Administrator privileges. If the user does not have administrative
6257 access on the print server (i.e is not root or a member of the
6258 \fIprinter admin\fR group), the OpenPrinterEx()
6259 call fails and the client makes another open call with a request for
6260 a lower privilege level. This should succeed, however the APW
6261 icon will not be displayed.
6263 Disabling the \fIshow add printer wizard\fR
6264 parameter will always cause the OpenPrinterEx() on the server
6265 to fail. Thus the APW icon will never be displayed. \fB Note :\fRThis does not prevent the same user from having
6266 administrative privilege on an individual printer.
6268 See also \fIaddprinter
6269 command\fR, \fIdeleteprinter command\fR, \fIprinter admin\fR
6271 Default :\fBshow add printer wizard = yes\fR
6273 \fBsmb passwd file (G)\fR
6274 This option sets the path to the encrypted
6275 smbpasswd file. By default the path to the smbpasswd file
6276 is compiled into Samba.
6278 Default: \fBsmb passwd file = ${prefix}/private/smbpasswd
6280 Example: \fBsmb passwd file = /etc/samba/smbpasswd
6282 \fBsocket address (G)\fR
6283 This option allows you to control what
6284 address Samba will listen for connections on. This is used to
6285 support multiple virtual interfaces on the one server, each
6286 with a different configuration.
6288 By default Samba will accept connections on any
6291 Example: \fBsocket address = 192.168.2.20\fR
6293 \fBsocket options (G)\fR
6294 This option allows you to set socket options
6295 to be used when talking with the client.
6297 Socket options are controls on the networking layer
6298 of the operating systems which allow the connection to be
6301 This option will typically be used to tune your Samba
6302 server for optimal performance for your local network. There is
6303 no way that Samba can know what the optimal parameters are for
6304 your net, so you must experiment and choose them yourself. We
6305 strongly suggest you read the appropriate documentation for your
6306 operating system first (perhaps \fBman setsockopt\fR
6309 You may find that on some systems Samba will say
6310 "Unknown socket option" when you supply an option. This means you
6311 either incorrectly typed it or you need to add an include file
6312 to includes.h for your OS. If the latter is the case please
6313 send the patch to samba@samba.org <URL:mailto:samba@samba.org>.
6315 Any of the supported socket options may be combined
6316 in any way you like, as long as your OS allows it.
6318 This is the list of socket options currently settable
6353 Those marked with a \fB'*'\fR take an integer
6354 argument. The others can optionally take a 1 or 0 argument to enable
6355 or disable the option, by default they will be enabled if you
6356 don't specify 1 or 0.
6359 To specify an argument use the syntax SOME_OPTION = VALUE
6360 for example \fBSO_SNDBUF = 8192\fR. Note that you must
6361 not have any spaces before or after the = sign.
6364 If you are on a local network then a sensible option
6368 \fBsocket options = IPTOS_LOWDELAY\fR
6371 If you have a local network then you could try:
6374 \fBsocket options = IPTOS_LOWDELAY TCP_NODELAY\fR
6377 If you are on a wide area network then perhaps try
6378 setting IPTOS_THROUGHPUT.
6381 Note that several of the options may cause your Samba
6382 server to fail completely. Use these options with caution!
6385 Default: \fBsocket options = TCP_NODELAY\fR
6388 Example: \fBsocket options = IPTOS_LOWDELAY\fR
6391 \fBsource environment (G)\fR
6392 This parameter causes Samba to set environment
6393 variables as per the content of the file named.
6395 If the value of this parameter starts with a "|" character
6396 then Samba will treat that value as a pipe command to open and
6397 will set the environment variables from the output of the pipe.
6399 The contents of the file or the output of the pipe should
6400 be formatted as the output of the standard Unix \fBenv(1)
6401 \fRcommand. This is of the form :
6403 Example environment entry:
6405 \fBSAMBA_NETBIOS_NAME = myhostname\fR
6407 Default: \fBNo default value\fR
6409 Examples: \fBsource environment = |/etc/smb.conf.sh
6411 Example: \fBsource environment =
6412 /usr/local/smb_env_vars\fR
6415 This variable is part of SSL-enabled Samba. This
6416 is only available if the SSL libraries have been compiled on your
6417 system and the configure option \fB--with-ssl\fR was
6418 given at configure time.
6420 This variable enables or disables the entire SSL mode. If
6421 it is set to no, the SSL-enabled Samba behaves
6422 exactly like the non-SSL Samba. If set to yes,
6423 it depends on the variables \fI ssl hosts\fR and \fIssl hosts resign\fR whether an SSL
6424 connection will be required.
6426 Default: \fBssl = no\fR
6428 \fBssl CA certDir (G)\fR
6429 This variable is part of SSL-enabled Samba. This
6430 is only available if the SSL libraries have been compiled on your
6431 system and the configure option \fB--with-ssl\fR was
6432 given at configure time.
6434 This variable defines where to look up the Certification
6435 Authorities. The given directory should contain one file for
6436 each CA that Samba will trust. The file name must be the hash
6437 value over the "Distinguished Name" of the CA. How this directory
6438 is set up is explained later in this document. All files within the
6439 directory that don't fit into this naming scheme are ignored. You
6440 don't need this variable if you don't verify client certificates.
6442 Default: \fBssl CA certDir = /usr/local/ssl/certs
6444 \fBssl CA certFile (G)\fR
6445 This variable is part of SSL-enabled Samba. This
6446 is only available if the SSL libraries have been compiled on your
6447 system and the configure option \fB--with-ssl\fR was
6448 given at configure time.
6450 This variable is a second way to define the trusted CAs.
6451 The certificates of the trusted CAs are collected in one big
6452 file and this variable points to the file. You will probably
6453 only use one of the two ways to define your CAs. The first choice is
6454 preferable if you have many CAs or want to be flexible, the second
6455 is preferable if you only have one CA and want to keep things
6456 simple (you won't need to create the hashed file names). You
6457 don't need this variable if you don't verify client certificates.
6459 Default: \fBssl CA certFile = /usr/local/ssl/certs/trustedCAs.pem
6461 \fBssl ciphers (G)\fR
6462 This variable is part of SSL-enabled Samba. This
6463 is only available if the SSL libraries have been compiled on your
6464 system and the configure option \fB--with-ssl\fR was
6465 given at configure time.
6467 This variable defines the ciphers that should be offered
6468 during SSL negotiation. You should not set this variable unless
6469 you know what you are doing.
6471 \fBssl client cert (G)\fR
6472 This variable is part of SSL-enabled Samba. This
6473 is only available if the SSL libraries have been compiled on your
6474 system and the configure option \fB--with-ssl\fR was
6475 given at configure time.
6477 The certificate in this file is used by \fBsmbclient(1)\fRif it exists. It's needed
6478 if the server requires a client certificate.
6480 Default: \fBssl client cert = /usr/local/ssl/certs/smbclient.pem
6482 \fBssl client key (G)\fR
6483 This variable is part of SSL-enabled Samba. This
6484 is only available if the SSL libraries have been compiled on your
6485 system and the configure option \fB--with-ssl\fR was
6486 given at configure time.
6488 This is the private key for \fBsmbclient(1)\fR. It's only needed if the
6489 client should have a certificate.
6491 Default: \fBssl client key = /usr/local/ssl/private/smbclient.pem
6493 \fBssl compatibility (G)\fR
6494 This variable is part of SSL-enabled Samba. This
6495 is only available if the SSL libraries have been compiled on your
6496 system and the configure option \fB--with-ssl\fR was
6497 given at configure time.
6499 This variable defines whether OpenSSL should be configured
6500 for bug compatibility with other SSL implementations. This is
6501 probably not desirable because currently no clients with SSL
6502 implementations other than OpenSSL exist.
6504 Default: \fBssl compatibility = no\fR
6506 \fBssl egd socket (G)\fR
6507 This variable is part of SSL-enabled Samba. This
6508 is only available if the SSL libraries have been compiled on your
6509 system and the configure option \fB--with-ssl\fR was
6510 given at configure time.
6512 This option is used to define the location of the communiation socket of
6513 an EGD or PRNGD daemon, from which entropy can be retrieved. This option
6514 can be used instead of or together with the \fIssl entropy file\fR
6515 directive. 255 bytes of entropy will be retrieved from the daemon.
6519 \fBssl entropy bytes (G)\fR
6520 This variable is part of SSL-enabled Samba. This
6521 is only available if the SSL libraries have been compiled on your
6522 system and the configure option \fB--with-ssl\fR was
6523 given at configure time.
6525 This parameter is used to define the number of bytes which should
6526 be read from the \fIssl entropy
6527 file\fR If a -1 is specified, the entire file will
6530 Default: \fBssl entropy bytes = 255\fR
6532 \fBssl entropy file (G)\fR
6533 This variable is part of SSL-enabled Samba. This
6534 is only available if the SSL libraries have been compiled on your
6535 system and the configure option \fB--with-ssl\fR was
6536 given at configure time.
6538 This parameter is used to specify a file from which processes will
6539 read "random bytes" on startup. In order to seed the internal pseudo
6540 random number generator, entropy must be provided. On system with a
6541 \fI/dev/urandom\fR device file, the processes
6542 will retrieve its entropy from the kernel. On systems without kernel
6543 entropy support, a file can be supplied that will be read on startup
6544 and that will be used to seed the PRNG.
6549 See \fI ssl hosts resign\fR.
6551 \fBssl hosts resign (G)\fR
6552 This variable is part of SSL-enabled Samba. This
6553 is only available if the SSL libraries have been compiled on your
6554 system and the configure option \fB--with-ssl\fR was
6555 given at configure time.
6557 These two variables define whether Samba will go
6558 into SSL mode or not. If none of them is defined, Samba will
6559 allow only SSL connections. If the \fIssl hosts\fR variable lists
6560 hosts (by IP-address, IP-address range, net group or name),
6561 only these hosts will be forced into SSL mode. If the \fI ssl hosts resign\fR variable lists hosts, only these
6562 hosts will \fBNOT\fR be forced into SSL mode. The syntax for these two
6563 variables is the same as for the \fI hosts allow\fR and \fIhosts deny\fR pair of variables, only
6564 that the subject of the decision is different: It's not the access
6565 right but whether SSL is used or not.
6567 The example below requires SSL connections from all hosts
6568 outside the local net (which is 192.168.*.*).
6570 Default: \fBssl hosts = <empty string>\fR
6572 \fBssl hosts resign = <empty string>\fR
6574 Example: \fBssl hosts resign = 192.168.\fR
6576 \fBssl require clientcert (G)\fR
6577 This variable is part of SSL-enabled Samba. This
6578 is only available if the SSL libraries have been compiled on your
6579 system and the configure option \fB--with-ssl\fR was
6580 given at configure time.
6582 If this variable is set to yes, the
6583 server will not tolerate connections from clients that don't
6584 have a valid certificate. The directory/file given in \fIssl CA certDir\fR
6585 and \fIssl CA certFile
6586 \fRwill be used to look up the CAs that issued
6587 the client's certificate. If the certificate can't be verified
6588 positively, the connection will be terminated. If this variable
6589 is set to no, clients don't need certificates.
6590 Contrary to web applications you really \fBshould\fR
6591 require client certificates. In the web environment the client's
6592 data is sensitive (credit card numbers) and the server must prove
6593 to be trustworthy. In a file server environment the server's data
6594 will be sensitive and the clients must prove to be trustworthy.
6596 Default: \fBssl require clientcert = no\fR
6598 \fBssl require servercert (G)\fR
6599 This variable is part of SSL-enabled Samba. This
6600 is only available if the SSL libraries have been compiled on your
6601 system and the configure option \fB--with-ssl\fR was
6602 given at configure time.
6604 If this variable is set to yes, the
6606 will request a certificate from the server. Same as
6608 clientcert\fR for the server.
6610 Default: \fBssl require servercert = no\fR
6612 \fBssl server cert (G)\fR
6613 This variable is part of SSL-enabled Samba. This
6614 is only available if the SSL libraries have been compiled on your
6615 system and the configure option \fB--with-ssl\fR was
6616 given at configure time.
6618 This is the file containing the server's certificate.
6619 The server \fBmust\fR have a certificate. The
6620 file may also contain the server's private key. See later for
6621 how certificates and private keys are created.
6623 Default: \fBssl server cert = <empty string>
6625 \fBssl server key (G)\fR
6626 This variable is part of SSL-enabled Samba. This
6627 is only available if the SSL libraries have been compiled on your
6628 system and the configure option \fB--with-ssl\fR was
6629 given at configure time.
6631 This file contains the private key of the server. If
6632 this variable is not defined, the key is looked up in the
6633 certificate file (it may be appended to the certificate).
6634 The server \fBmust\fR have a private key
6635 and the certificate \fBmust\fR
6636 match this private key.
6638 Default: \fBssl server key = <empty string>
6640 \fBssl version (G)\fR
6641 This variable is part of SSL-enabled Samba. This
6642 is only available if the SSL libraries have been compiled on your
6643 system and the configure option \fB--with-ssl\fR was
6644 given at configure time.
6646 This enumeration variable defines the versions of the
6647 SSL protocol that will be used. ssl2or3 allows
6648 dynamic negotiation of SSL v2 or v3, ssl2 results
6649 in SSL v2, ssl3 results in SSL v3 and
6650 tls1 results in TLS v1. TLS (Transport Layer
6651 Security) is the new standard for SSL.
6653 Default: \fBssl version = "ssl2or3"\fR
6655 \fBstat cache (G)\fR
6656 This parameter determines if smbd(8)will use a cache in order to
6657 speed up case insensitive name mappings. You should never need
6658 to change this parameter.
6660 Default: \fBstat cache = yes\fR
6662 \fBstat cache size (G)\fR
6663 This parameter determines the number of
6664 entries in the \fIstat cache\fR. You should
6665 never need to change this parameter.
6667 Default: \fBstat cache size = 50\fR
6670 This enables or disables logging of connections
6671 to a status file that smbstatus(1)
6674 With this disabled \fBsmbstatus\fR won't be able
6675 to tell you what connections are active. You should never need to
6676 change this parameter.
6678 Default: \fBstatus = yes\fR
6680 \fBstrict allocate (S)\fR
6681 This is a boolean that controls the handling of
6682 disk space allocation in the server. When this is set to yes
6683 the server will change from UNIX behaviour of not committing real
6684 disk storage blocks when a file is extended to the Windows behaviour
6685 of actually forcing the disk system to allocate real storage blocks
6686 when a file is created or extended to be a given size. In UNIX
6687 terminology this means that Samba will stop creating sparse files.
6688 This can be slow on some systems.
6690 When strict allocate is no the server does sparse
6691 disk block allocation when a file is extended.
6693 Setting this to yes can help Samba return
6694 out of quota messages on systems that are restricting the disk quota
6697 Default: \fBstrict allocate = no\fR
6699 \fBstrict locking (S)\fR
6700 This is a boolean that controls the handling of
6701 file locking in the server. When this is set to yes
6702 the server will check every read and write access for file locks, and
6703 deny access if locks exist. This can be slow on some systems.
6705 When strict locking is no the server does file
6706 lock checks only when the client explicitly asks for them.
6708 Well-behaved clients always ask for lock checks when it
6709 is important, so in the vast majority of cases \fBstrict
6710 locking = no\fR is preferable.
6712 Default: \fBstrict locking = no\fR
6714 \fBstrict sync (S)\fR
6715 Many Windows applications (including the Windows
6716 98 explorer shell) seem to confuse flushing buffer contents to
6717 disk with doing a sync to disk. Under UNIX, a sync call forces
6718 the process to be suspended until the kernel has ensured that
6719 all outstanding data in kernel disk buffers has been safely stored
6720 onto stable storage. This is very slow and should only be done
6721 rarely. Setting this parameter to no (the
6722 default) means that smbdignores the Windows applications requests for
6723 a sync call. There is only a possibility of losing data if the
6724 operating system itself that Samba is running on crashes, so there is
6725 little danger in this default setting. In addition, this fixes many
6726 performance problems that people have reported with the new Windows98
6727 explorer shell file copies.
6729 See also the \fIsync
6730 always>\fR parameter.
6732 Default: \fBstrict sync = no\fR
6735 This parameter is now unused in Samba (2.2.5 and above).
6736 It used strip trailing dots off UNIX filenames but was not correctly implmented.
6737 In Samba 2.2.5 and above UNIX filenames ending in a dot are invalid Windows long
6738 filenames (as they are in Windows NT and above) and are mangled to 8.3 before
6739 being returned to a client.
6741 Default: \fBstrip dot = no\fR
6743 \fBsync always (S)\fR
6744 This is a boolean parameter that controls
6745 whether writes will always be written to stable storage before
6746 the write call returns. If this is false then the server will be
6747 guided by the client's request in each write call (clients can
6748 set a bit indicating that a particular write should be synchronous).
6749 If this is true then every write will be followed by a \fBfsync()
6750 \fRcall to ensure the data is written to disk. Note that
6751 the \fIstrict sync\fR parameter must be set to
6752 yes in order for this parameter to have
6755 See also the \fIstrict
6758 Default: \fBsync always = no\fR
6761 This parameter maps how Samba debug messages
6762 are logged onto the system syslog logging levels. Samba debug
6763 level zero maps onto syslog LOG_ERR, debug
6764 level one maps onto LOG_WARNING, debug level
6765 two maps onto LOG_NOTICE, debug level three
6766 maps onto LOG_INFO. All higher levels are mapped to LOG_DEBUG.
6768 This parameter sets the threshold for sending messages
6769 to syslog. Only messages with debug level less than this value
6770 will be sent to syslog.
6772 Default: \fBsyslog = 1\fR
6774 \fBsyslog only (G)\fR
6775 If this parameter is set then Samba debug
6776 messages are logged into the system syslog only, and not to
6777 the debug log files.
6779 Default: \fBsyslog only = no\fR
6781 \fBtemplate homedir (G)\fR
6782 When filling out the user information for a Windows NT
6783 user, the winbindd(8)daemon
6784 uses this parameter to fill in the home directory for that user.
6785 If the string \fI%D\fR is present it is substituted
6786 with the user's Windows NT domain name. If the string \fI%U
6787 \fRis present it is substituted with the user's Windows
6790 Default: \fBtemplate homedir = /home/%D/%U\fR
6792 \fBtemplate shell (G)\fR
6793 When filling out the user information for a Windows NT
6794 user, the winbindd(8)daemon
6795 uses this parameter to fill in the login shell for that user.
6797 Default: \fBtemplate shell = /bin/false\fR
6799 \fBtime offset (G)\fR
6800 This parameter is a setting in minutes to add
6801 to the normal GMT to local time conversion. This is useful if
6802 you are serving a lot of PCs that have incorrect daylight
6803 saving time handling.
6805 Default: \fBtime offset = 0\fR
6807 Example: \fBtime offset = 60\fR
6809 \fBtime server (G)\fR
6810 This parameter determines if
6811 nmbd(8)advertises itself as a time server to Windows
6814 Default: \fBtime server = no\fR
6816 \fBtimestamp logs (G)\fR
6817 Synonym for \fI debug timestamp\fR.
6819 \fBtotal print jobs (G)\fR
6820 This parameter accepts an integer value which defines
6821 a limit on the maximum number of print jobs that will be accepted
6822 system wide at any given time. If a print job is submitted
6823 by a client which will exceed this number, then smbdwill return an
6824 error indicating that no space is available on the server. The
6825 default value of 0 means that no such limit exists. This parameter
6826 can be used to prevent a server from exceeding its capacity and is
6827 designed as a printing throttle. See also
6828 \fImax print jobs\fR.
6830 Default: \fBtotal print jobs = 0\fR
6832 Example: \fBtotal print jobs = 5000\fR
6834 \fBunix extensions(G)\fR
6835 This boolean parameter controls whether Samba
6836 implments the CIFS UNIX extensions, as defined by HP.
6837 These extensions enable Samba to better serve UNIX CIFS clients
6838 by supporting features such as symbolic links, hard links, etc...
6839 These extensions require a similarly enabled client, and are of
6840 no current use to Windows clients.
6842 Default: \fBunix extensions = no\fR
6844 \fBunix password sync (G)\fR
6845 This boolean parameter controls whether Samba
6846 attempts to synchronize the UNIX password with the SMB password
6847 when the encrypted SMB password in the smbpasswd file is changed.
6848 If this is set to true the program specified in the \fIpasswd
6849 program\fRparameter is called \fBAS ROOT\fR -
6850 to allow the new UNIX password to be set without access to the
6851 old UNIX password (as the SMB password change code has no
6852 access to the old password cleartext, only the new).
6855 program\fR, \fI passwd chat\fR.
6857 Default: \fBunix password sync = no\fR
6859 \fBupdate encrypted (G)\fR
6860 This boolean parameter allows a user logging
6861 on with a plaintext password to have their encrypted (hashed)
6862 password in the smbpasswd file to be updated automatically as
6863 they log on. This option allows a site to migrate from plaintext
6864 password authentication (users authenticate with plaintext
6865 password over the wire, and are checked against a UNIX account
6866 database) to encrypted password authentication (the SMB
6867 challenge/response authentication mechanism) without forcing
6868 all users to re-enter their passwords via smbpasswd at the time the
6869 change is made. This is a convenience option to allow the change over
6870 to encrypted passwords to be made over a longer period. Once all users
6871 have encrypted representations of their passwords in the smbpasswd
6872 file this parameter should be set to no.
6874 In order for this parameter to work correctly the \fIencrypt passwords\fR
6875 parameter must be set to no when
6876 this parameter is set to yes.
6878 Note that even when this parameter is set a user
6879 authenticating to \fBsmbd\fR must still enter a valid
6880 password in order to connect correctly, and to update their hashed
6881 (smbpasswd) passwords.
6883 Default: \fBupdate encrypted = no\fR
6885 \fBuse client driver (S)\fR
6886 This parameter applies only to Windows NT/2000
6887 clients. It has no affect on Windows 95/98/ME clients. When
6888 serving a printer to Windows NT/2000 clients without first installing
6889 a valid printer driver on the Samba host, the client will be required
6890 to install a local printer driver. From this point on, the client
6891 will treat the print as a local printer and not a network printer
6892 connection. This is much the same behavior that will occur
6893 when \fBdisable spoolss = yes\fR.
6896 factor is that under normal circumstances, the NT/2000 client will
6897 attempt to open the network printer using MS-RPC. The problem is that
6898 because the client considers the printer to be local, it will attempt
6899 to issue the OpenPrinterEx() call requesting access rights associated
6900 with the logged on user. If the user possesses local administator rights
6901 but not root privilegde on the Samba host (often the case), the OpenPrinterEx()
6902 call will fail. The result is that the client will now display an "Access
6903 Denied; Unable to connect" message in the printer queue window (even though
6904 jobs may successfully be printed).
6906 If this parameter is enabled for a printer, then any attempt
6907 to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped
6908 to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx()
6909 call to succeed. \fBThis parameter MUST not be able enabled
6910 on a print share which has valid print driver installed on the Samba
6913 See also disable spoolss
6915 Default: \fBuse client driver = no\fR
6918 This global parameter determines if the tdb internals of Samba can
6919 depend on mmap working correctly on the running system. Samba requires a coherent
6920 mmap/read-write system memory cache. Currently only HPUX does not have such a
6921 coherent cache, and so this parameter is set to false by
6922 default on HPUX. On all other systems this parameter should be left alone. This
6923 parameter is provided to help the Samba developers track down problems with
6924 the tdb internal code.
6926 Default: \fBuse mmap = yes\fR
6928 \fBuse rhosts (G)\fR
6929 If this global parameter is true, it specifies
6930 that the UNIX user's \fI.rhosts\fR file in their home directory
6931 will be read to find the names of hosts and users who will be allowed
6932 access without specifying a password.
6934 \fBNOTE:\fR The use of \fIuse rhosts
6935 \fRcan be a major security hole. This is because you are
6936 trusting the PC to supply the correct username. It is very easy to
6937 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
6940 Default: \fBuse rhosts = no\fR
6943 Synonym for \fI username\fR.
6946 Synonym for \fI username\fR.
6949 Multiple users may be specified in a comma-delimited
6950 list, in which case the supplied password will be tested against
6951 each username in turn (left to right).
6953 The \fIusername\fR line is needed only when
6954 the PC is unable to supply its own username. This is the case
6955 for the COREPLUS protocol or where your users have different WfWg
6956 usernames to UNIX usernames. In both these cases you may also be
6957 better using the \\\\server\\share%user syntax instead.
6959 The \fIusername\fR line is not a great
6960 solution in many cases as it means Samba will try to validate
6961 the supplied password against each of the usernames in the
6962 \fIusername\fR line in turn. This is slow and
6963 a bad idea for lots of users in case of duplicate passwords.
6964 You may get timeouts or security breaches using this parameter
6967 Samba relies on the underlying UNIX security. This
6968 parameter does not restrict who can login, it just offers hints
6969 to the Samba server as to what usernames might correspond to the
6970 supplied password. Users can login as whoever they please and
6971 they will be able to do no more damage than if they started a
6972 telnet session. The daemon runs as the user that they log in as,
6973 so they cannot do anything that user cannot do.
6975 To restrict a service to a particular set of users you
6976 can use the \fIvalid users
6979 If any of the usernames begin with a '@' then the name
6980 will be looked up first in the NIS netgroups list (if Samba
6981 is compiled with netgroup support), followed by a lookup in
6982 the UNIX groups database and will expand to a list of all users
6983 in the group of that name.
6985 If any of the usernames begin with a '+' then the name
6986 will be looked up only in the UNIX groups database and will
6987 expand to a list of all users in the group of that name.
6989 If any of the usernames begin with a '&'then the name
6990 will be looked up only in the NIS netgroups database (if Samba
6991 is compiled with netgroup support) and will expand to a list
6992 of all users in the netgroup group of that name.
6994 Note that searching though a groups database can take
6995 quite some time, and some clients may time out during the
6998 See the section NOTE ABOUT
6999 USERNAME/PASSWORD VALIDATION for more information on how
7000 this parameter determines access to the services.
7002 Default: \fBThe guest account if a guest service,
7003 else <empty string>.\fR
7005 Examples:\fBusername = fred, mary, jack, jane,
7008 \fBusername level (G)\fR
7009 This option helps Samba to try and 'guess' at
7010 the real UNIX username, as many DOS clients send an all-uppercase
7011 username. By default Samba tries all lowercase, followed by the
7012 username with the first letter capitalized, and fails if the
7013 username is not found on the UNIX machine.
7015 If this parameter is set to non-zero the behavior changes.
7016 This parameter is a number that specifies the number of uppercase
7017 combinations to try while trying to determine the UNIX user name. The
7018 higher the number the more combinations will be tried, but the slower
7019 the discovery of usernames will be. Use this parameter when you have
7020 strange usernames on your UNIX machine, such as AstrangeUser
7023 Default: \fBusername level = 0\fR
7025 Example: \fBusername level = 5\fR
7027 \fBusername map (G)\fR
7028 This option allows you to specify a file containing
7029 a mapping of usernames from the clients to the server. This can be
7030 used for several purposes. The most common is to map usernames
7031 that users use on DOS or Windows machines to those that the UNIX
7032 box uses. The other is to map multiple users to a single username
7033 so that they can more easily share files.
7035 The map file is parsed line by line. Each line should
7036 contain a single UNIX username on the left then a '=' followed
7037 by a list of usernames on the right. The list of usernames on the
7038 right may contain names of the form @group in which case they
7039 will match any UNIX username in that group. The special client
7040 name '*' is a wildcard and matches any name. Each line of the
7041 map file may be up to 1023 characters long.
7043 The file is processed on each line by taking the
7044 supplied username and comparing it with each username on the right
7045 hand side of the '=' signs. If the supplied name matches any of
7046 the names on the right hand side then it is replaced with the name
7047 on the left. Processing then continues with the next line.
7049 If any line begins with a '#' or a ';' then it is
7052 If any line begins with an '!' then the processing
7053 will stop after that line if a mapping was done by the line.
7054 Otherwise mapping continues with every line being processed.
7055 Using '!' is most useful when you have a wildcard mapping line
7058 For example to map from the name admin
7059 or administrator to the UNIX name root you would use:
7061 \fBroot = admin administrator\fR
7063 Or to map anyone in the UNIX group system
7064 to the UNIX name sys you would use:
7068 You can have as many mappings as you like in a username
7071 If your system supports the NIS NETGROUP option then
7072 the netgroup database is checked before the \fI/etc/group
7073 \fRdatabase for matching groups.
7075 You can map Windows usernames that have spaces in them
7076 by using double quotes around the name. For example:
7078 \fBtridge = "Andrew Tridgell"\fR
7080 would map the windows username "Andrew Tridgell" to the
7081 unix username "tridge".
7083 The following example would map mary and fred to the
7084 unix user sys, and map the rest to guest. Note the use of the
7085 \&'!' to tell Samba to stop processing if it gets a match on
7096 Note that the remapping is applied to all occurrences
7097 of usernames. Thus if you connect to \\\\server\\fred and fred is remapped to mary then you
7098 will actually be connecting to \\\\server\\mary and will need to
7099 supply a password suitable for mary not
7100 fred. The only exception to this is the
7101 username passed to the \fI password server\fR (if you have one). The password
7102 server will receive whatever username the client supplies without
7105 Also note that no reverse mapping is done. The main effect
7106 this has is with printing. Users who have been mapped may have
7107 trouble deleting print jobs as PrintManager under WfWg will think
7108 they don't own the print job.
7110 Default: \fBno username map\fR
7112 Example: \fBusername map = /usr/local/samba/lib/users.map
7115 This boolean parameter is only available if
7116 Samba has been configured and compiled with the option \fB --with-utmp\fR. If set to true then Samba will attempt
7117 to add utmp or utmpx records (depending on the UNIX system) whenever a
7118 connection is made to a Samba server. Sites may use this to record the
7119 user connecting to a Samba share.
7121 See also the \fI utmp directory\fR parameter.
7123 Default: \fButmp = no\fR
7125 \fButmp directory(G)\fR
7126 This parameter is only available if Samba has
7127 been configured and compiled with the option \fB --with-utmp\fR. It specifies a directory pathname that is
7128 used to store the utmp or utmpx files (depending on the UNIX system) that
7129 record user connections to a Samba server. See also the \fIutmp\fR parameter. By default this is
7130 not set, meaning the system will use whatever utmp file the
7131 native system is set to use (usually
7132 \fI/var/run/utmp\fR on Linux).
7134 Default: \fBno utmp directory\fR
7136 \fBvalid chars (G)\fR
7137 The option allows you to specify additional
7138 characters that should be considered valid by the server in
7139 filenames. This is particularly useful for national character
7140 sets, such as adding u-umlaut or a-ring.
7142 The option takes a list of characters in either integer
7143 or character form with spaces between them. If you give two
7144 characters with a colon between them then it will be taken as
7145 an lowercase:uppercase pair.
7147 If you have an editor capable of entering the characters
7148 into the config file then it is probably easiest to use this
7149 method. Otherwise you can specify the characters in octal,
7150 decimal or hexadecimal form using the usual C notation.
7152 For example to add the single character 'Z' to the charset
7153 (which is a pointless thing to do as it's already there) you could
7154 do one of the following
7160 valid chars = 0132:0172
7165 The last two examples above actually add two characters,
7166 and alter the uppercase and lowercase mappings appropriately.
7168 Note that you \fBMUST\fR specify this parameter
7169 after the \fIclient code page\fR parameter if you
7170 have both set. If \fIclient code page\fR is set after
7171 the \fIvalid chars\fR parameter the \fIvalid
7172 chars\fR settings will be overwritten.
7174 See also the \fIclient
7175 code page\fR parameter.
7177 Default: \fBSamba defaults to using a reasonable set
7178 of valid characters for English systems\fR
7180 Example: \fBvalid chars = 0345:0305 0366:0326 0344:0304
7182 The above example allows filenames to have the Swedish
7185 \fBNOTE:\fR It is actually quite difficult to
7186 correctly produce a \fIvalid chars\fR line for
7187 a particular system. To automate the process tino@augsburg.net <URL:mailto:tino@augsburg.net> has written
7188 a package called \fBvalidchars\fR which will automatically
7189 produce a complete \fIvalid chars\fR line for
7190 a given client system. Look in the \fIexamples/validchars/
7191 \fRsubdirectory of your Samba source code distribution
7194 \fBvalid users (S)\fR
7195 This is a list of users that should be allowed
7196 to login to this service. Names starting with '@', '+' and '&'
7197 are interpreted using the same rules as described in the
7198 \fIinvalid users\fR parameter.
7200 If this is empty (the default) then any user can login.
7201 If a username is in both this list and the \fIinvalid
7202 users\fR list then access is denied for that user.
7204 The current servicename is substituted for \fI%S
7205 \fR\&. This is useful in the [homes] section.
7207 See also \fIinvalid users
7209 Default: \fBNo valid users list (anyone can login)
7211 Example: \fBvalid users = greg, @pcusers\fR
7214 This is a list of files and directories that
7215 are neither visible nor accessible. Each entry in the list must
7216 be separated by a '/', which allows spaces to be included
7217 in the entry. '*' and '?' can be used to specify multiple files
7218 or directories as in DOS wildcards.
7220 Each entry must be a unix path, not a DOS path and
7221 must \fBnot\fR include the unix directory
7224 Note that the \fIcase sensitive\fR option
7225 is applicable in vetoing files.
7227 One feature of the veto files parameter that it
7228 is important to be aware of is Samba's behaviour when
7229 trying to delete a directory. If a directory that is
7230 to be deleted contains nothing but veto files this
7231 deletion will \fBfail\fR unless you also set
7232 the \fIdelete veto files\fR parameter to
7235 Setting this parameter will affect the performance
7236 of Samba, as it will be forced to check all files and directories
7237 for a match as they are scanned.
7239 See also \fIhide files
7240 \fRand \fI case sensitive\fR.
7242 Default: \fBNo files or directories are vetoed.
7247 ; Veto any files containing the word Security,
7248 ; any ending in .tmp, and any directory containing the
7250 veto files = /*Security*/*.tmp/*root*/
7252 ; Veto the Apple specific files that a NetAtalk server
7254 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
7258 \fBveto oplock files (S)\fR
7259 This parameter is only valid when the \fIoplocks\fR
7260 parameter is turned on for a share. It allows the Samba administrator
7261 to selectively turn off the granting of oplocks on selected files that
7262 match a wildcarded list, similar to the wildcarded list used in the
7266 Default: \fBNo files are vetoed for oplock
7269 You might want to do this on files that you know will
7270 be heavily contended for by clients. A good example of this
7271 is in the NetBench SMB benchmark program, which causes heavy
7272 client contention for files ending in \fI.SEM\fR.
7273 To cause Samba not to grant oplocks on these files you would use
7274 the line (either in the [global] section or in the section for
7275 the particular NetBench share :
7277 Example: \fBveto oplock files = /*.SEM/
7279 \fBvfs object (S)\fR
7280 This parameter specifies a shared object file that
7281 is used for Samba VFS I/O operations. By default, normal
7282 disk I/O operations are used but these can be overloaded
7283 with a VFS object. The Samba VFS layer is new to Samba 2.2 and
7284 must be enabled at compile time with --with-vfs.
7286 Default : \fBno value\fR
7288 \fBvfs options (S)\fR
7289 This parameter allows parameters to be passed
7290 to the vfs layer at initialization time. The Samba VFS layer
7291 is new to Samba 2.2 and must be enabled at compile time
7292 with --with-vfs. See also \fI vfs object\fR.
7294 Default : \fBno value\fR
7297 This allows you to override the volume label
7298 returned for a share. Useful for CDROMs with installation programs
7299 that insist on a particular volume label.
7301 Default: \fBthe name of the share\fR
7303 \fBwide links (S)\fR
7304 This parameter controls whether or not links
7305 in the UNIX file system may be followed by the server. Links
7306 that point to areas within the directory tree exported by the
7307 server are always allowed; this parameter controls access only
7308 to areas that are outside the directory tree being exported.
7310 Note that setting this parameter can have a negative
7311 effect on your server performance due to the extra system calls
7312 that Samba has to do in order to perform the link checks.
7314 Default: \fBwide links = yes\fR
7316 \fBwinbind cache time (G)\fR
7317 This parameter specifies the number of seconds the
7318 winbindd(8)daemon will cache
7319 user and group information before querying a Windows NT server
7322 Default: \fBwinbind cache type = 15\fR
7324 \fBwinbind enum users (G)\fR
7325 On large installations using
7326 winbindd(8)it may be
7327 necessary to suppress the enumeration of users through the
7329 \fBgetpwent()\fR and
7330 \fBendpwent()\fR group of system calls. If
7331 the \fIwinbind enum users\fR parameter is
7332 false, calls to the \fBgetpwent\fR system call
7333 will not return any data.
7335 \fBWarning:\fR Turning off user
7336 enumeration may cause some programs to behave oddly. For
7337 example, the finger program relies on having access to the
7338 full user list when searching for matching
7341 Default: \fBwinbind enum users = yes \fR
7343 \fBwinbind enum groups (G)\fR
7344 On large installations using
7345 winbindd(8)it may be
7346 necessary to suppress the enumeration of groups through the
7348 \fBgetgrent()\fR and
7349 \fBendgrent()\fR group of system calls. If
7350 the \fIwinbind enum groups\fR parameter is
7351 false, calls to the \fBgetgrent()\fR system
7352 call will not return any data.
7354 \fBWarning:\fR Turning off group
7355 enumeration may cause some programs to behave oddly.
7357 Default: \fBwinbind enum groups = yes \fR
7359 \fBwinbind gid (G)\fR
7360 The winbind gid parameter specifies the range of group
7361 ids that are allocated by the winbindd(8)daemon. This range of group ids should have no
7362 existing local or NIS groups within it as strange conflicts can
7365 Default: \fBwinbind gid = <empty string>
7367 Example: \fBwinbind gid = 10000-20000\fR
7369 \fBwinbind separator (G)\fR
7370 This parameter allows an admin to define the character
7371 used when listing a username of the form of \fIDOMAIN
7372 \fR\\\fIuser\fR. This parameter
7373 is only applicable when using the \fIpam_winbind.so\fR
7374 and \fInss_winbind.so\fR modules for UNIX services.
7376 Please note that setting this parameter to + causes problems
7377 with group membership at least on glibc systems, as the character +
7378 is used as a special character for NIS in /etc/group.
7380 Default: \fBwinbind separator = '\\'\fR
7382 Example: \fBwinbind separator = +\fR
7384 \fBwinbind uid (G)\fR
7385 The winbind gid parameter specifies the range of group
7386 ids that are allocated by the winbindd(8)daemon. This range of ids should have no
7387 existing local or NIS users within it as strange conflicts can
7390 Default: \fBwinbind uid = <empty string>
7392 Example: \fBwinbind uid = 10000-20000\fR
7394 \fBwinbind use default domain\fR
7396 \fBwinbind use default domain\fR
7397 This parameter specifies whether the winbindd(8)
7398 daemon should operate on users without domain component in their username.
7399 Users without a domain component are treated as is part of the winbindd server's
7400 own domain. While this does not benifit Windows users, it makes SSH, FTP and e-mail
7401 function in a way much closer to the way they would in a native unix system.
7403 Default: \fBwinbind use default domain = <falseg>
7405 Example: \fBwinbind use default domain = true\fR
7408 When Samba is running as a WINS server this
7409 allows you to call an external program for all changes to the
7410 WINS database. The primary use for this option is to allow the
7411 dynamic update of external name resolution databases such as
7414 The wins hook parameter specifies the name of a script
7415 or executable that will be called as follows:
7417 \fBwins_hook operation name nametype ttl IP_list
7421 The first argument is the operation and is one
7422 of "add", "delete", or "refresh". In most cases the operation can
7423 be ignored as the rest of the parameters provide sufficient
7424 information. Note that "refresh" may sometimes be called when the
7425 name has not previously been added, in that case it should be treated
7429 The second argument is the NetBIOS name. If the
7430 name is not a legal name then the wins hook is not called.
7431 Legal names contain only letters, digits, hyphens, underscores
7435 The third argument is the NetBIOS name
7436 type as a 2 digit hexadecimal number.
7439 The fourth argument is the TTL (time to live)
7440 for the name in seconds.
7443 The fifth and subsequent arguments are the IP
7444 addresses currently registered for that name. If this list is
7445 empty then the name should be deleted.
7448 An example script that calls the BIND dynamic DNS update
7449 program \fBnsupdate\fR is provided in the examples
7450 directory of the Samba source code.
7453 \fBwins proxy (G)\fR
7454 This is a boolean that controls if nmbd(8)will respond to broadcast name
7455 queries on behalf of other hosts. You may need to set this
7456 to yes for some older clients.
7458 Default: \fBwins proxy = no\fR
7460 \fBwins server (G)\fR
7461 This specifies the IP address (or DNS name: IP
7462 address for preference) of the WINS server that nmbd(8)should register with. If you have a WINS server on
7463 your network then you should set this to the WINS server's IP.
7465 You should point this at your WINS server if you have a
7466 multi-subnetted network.
7468 \fBNOTE\fR. You need to set up Samba to point
7469 to a WINS server if you have multiple subnets and wish cross-subnet
7470 browsing to work correctly.
7472 See the documentation file \fIBROWSING.txt\fR
7473 in the docs/ directory of your Samba source distribution.
7475 Default: \fBnot enabled\fR
7477 Example: \fBwins server = 192.9.200.1\fR
7479 \fBwins support (G)\fR
7480 This boolean controls if the
7481 nmbd(8)process in Samba will act as a WINS server. You should
7482 not set this to true unless you have a multi-subnetted network and
7483 you wish a particular \fBnmbd\fR to be your WINS server.
7484 Note that you should \fBNEVER\fR set this to true
7485 on more than one machine in your network.
7487 Default: \fBwins support = no\fR
7490 This controls what workgroup your server will
7491 appear to be in when queried by clients. Note that this parameter
7492 also controls the Domain name used with the \fBsecurity = domain\fR
7495 Default: \fBset at compile time to WORKGROUP\fR
7497 Example: \fBworkgroup = MYGROUP\fR
7500 Synonym for \fI writeable\fR for people who can't spell :-).
7502 \fBwrite cache size (S)\fR
7503 If this integer parameter is set to non-zero value,
7504 Samba will create an in-memory cache for each oplocked file
7505 (it does \fBnot\fR do this for
7506 non-oplocked files). All writes that the client does not request
7507 to be flushed directly to disk will be stored in this cache if possible.
7508 The cache is flushed onto disk when a write comes in whose offset
7509 would not fit into the cache or when the file is closed by the client.
7510 Reads for the file are also served from this cache if the data is stored
7513 This cache allows Samba to batch client writes into a more
7514 efficient write size for RAID disks (i.e. writes may be tuned to
7515 be the RAID stripe size) and can improve performance on systems
7516 where the disk subsystem is a bottleneck but there is free
7517 memory for userspace programs.
7519 The integer parameter specifies the size of this cache
7520 (per oplocked file) in bytes.
7522 Default: \fBwrite cache size = 0\fR
7524 Example: \fBwrite cache size = 262144\fR
7526 for a 256k cache size per file.
7528 \fBwrite list (S)\fR
7529 This is a list of users that are given read-write
7530 access to a service. If the connecting user is in this list then
7531 they will be given write access, no matter what the \fIwriteable\fR
7532 option is set to. The list can include group names using the
7535 Note that if a user is in both the read list and the
7536 write list then they will be given write access.
7538 See also the \fIread list
7541 Default: \fBwrite list = <empty string>
7543 Example: \fBwrite list = admin, root, @staff
7546 Synonym for \fI writeable\fR.
7549 This parameter controls whether or not the server
7550 will support raw write SMB's when transferring data from clients.
7551 You should never need to change this parameter.
7553 Default: \fBwrite raw = yes\fR
7556 An inverted synonym is \fIread only\fR.
7558 If this parameter is no, then users
7559 of a service may not create or modify files in the service's
7562 Note that a printable service (\fBprintable = yes\fR)
7563 will \fBALWAYS\fR allow writing to the directory
7564 (user privileges permitting), but only via spooling operations.
7566 Default: \fBwriteable = no\fR
7569 Although the configuration file permits service names
7570 to contain spaces, your client software may not. Spaces will
7571 be ignored in comparisons anyway, so it shouldn't be a
7572 problem - but be aware of the possibility.
7574 On a similar note, many clients - especially DOS clients -
7575 limit service names to eight characters. smbd(8)
7576 has no such limitation, but attempts to connect from such
7577 clients will fail if they truncate the service names. For this reason
7578 you should probably keep your service names down to eight characters
7581 Use of the [homes] and [printers] special sections make life
7582 for an administrator easy, but the various combinations of default
7583 attributes can be tricky. Take extreme care when designing these
7584 sections. In particular, ensure that the permissions on spool
7585 directories are correct.
7588 This man page is correct for version 2.2 of
7603 The original Samba software and related utilities
7604 were created by Andrew Tridgell. Samba is now developed
7605 by the Samba Team as an Open Source project similar
7606 to the way the Linux kernel is developed.
7608 The original Samba man pages were written by Karl Auer.
7609 The man page sources were converted to YODL format (another
7610 excellent piece of Open Source software, available at
7611 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0
7612 release by Jeremy Allison. The conversion to DocBook for
7613 Samba 2.2 was done by Gerald Carter