1 .TH "smb\&.conf " "5" "23 Oct 1998" "Samba" "SAMBA"
4 smb\&.conf \- The configuration file for the Samba suite
8 \fBsmb\&.conf\fP The \fBsmb\&.conf\fP file is a configuration file for the
9 Samba suite\&. \fBsmb\&.conf\fP contains runtime configuration information
10 for the Samba programs\&. The \fBsmb\&.conf\fP file is designed to be
11 configured and administered by the \fBswat (8)\fP
12 program\&. The complete description of the file format and possible
13 parameters held within are here for reference purposes\&.
17 The file consists of sections and parameters\&. A section begins with
18 the name of the section in square brackets and continues until the
19 next section begins\&. Sections contain parameters of the form
21 \f(CW\'name = value\'\fP
23 The file is line-based - that is, each newline-terminated line
24 represents either a comment, a section name or a parameter\&.
26 Section and parameter names are not case sensitive\&.
28 Only the first equals sign in a parameter is significant\&. Whitespace
29 before or after the first equals sign is discarded\&. Leading, trailing
30 and internal whitespace in section and parameter names is
31 irrelevant\&. Leading and trailing whitespace in a parameter value is
32 discarded\&. Internal whitespace within a parameter value is retained
35 Any line beginning with a semicolon (\';\') or a hash (\'#\') character is
36 ignored, as are lines containing only whitespace\&.
38 Any line ending in a \f(CW\'\e\'\fP is "continued" on the next line in the
39 customary UNIX fashion\&.
41 The values following the equals sign in parameters are all either a
42 string (no quotes needed) or a boolean, which may be given as yes/no,
43 0/1 or true/false\&. Case is not significant in boolean values, but is
44 preserved in string values\&. Some items such as create modes are
47 .SH "SECTION DESCRIPTIONS"
49 Each section in the configuration file (except for the
50 \fB[global]\fP section) describes a shared resource (known
51 as a \fI"share"\fP)\&. The section name is the name of the shared resource
52 and the parameters within the section define the shares attributes\&.
54 There are three special sections, \fB[global]\fP,
55 \fB[homes]\fP and \fB[printers]\fP, which are
56 described under \fB\'special sections\'\fP\&. The
57 following notes apply to ordinary section descriptions\&.
59 A share consists of a directory to which access is being given plus
60 a description of the access rights which are granted to the user of
61 the service\&. Some housekeeping options are also specifiable\&.
63 Sections are either filespace services (used by the client as an
64 extension of their native file systems) or printable services (used by
65 the client to access print services on the host running the server)\&.
67 Sections may be designated \fBguest\fP services, in which
68 case no password is required to access them\&. A specified UNIX
69 \fBguest account\fP is used to define access
70 privileges in this case\&.
72 Sections other than guest services will require a password to access
73 them\&. The client provides the username\&. As older clients only provide
74 passwords and not usernames, you may specify a list of usernames to
75 check against the password using the \fB"user="\fP option in
76 the share definition\&. For modern clients such as Windows 95/98 and
77 Windows NT, this should not be necessary\&.
79 Note that the access rights granted by the server are masked by the
80 access rights granted to the specified or guest UNIX user by the host
81 system\&. The server does not grant more access than the host system
84 The following sample section defines a file space share\&. The user has
85 write access to the path \f(CW/home/bar\fP\&. The share is accessed via
102 The following sample section defines a printable share\&. The share
103 is readonly, but printable\&. That is, the only write access permitted
104 is via calls to open, write to and close a spool file\&. The
105 \fB\'guest ok\'\fP parameter means access will be permitted
106 as the default guest user (specified elsewhere):
113 path = /usr/spool/public
122 .SH "SPECIAL SECTIONS"
125 .IP "\fBThe [global] section\fP"
127 Parameters in this section apply to the server as a whole, or are
128 defaults for sections which do not specifically define certain
129 items\&. See the notes under \fB\'PARAMETERS\'\fP for more
132 .IP "\fBThe [homes] section\fP"
134 If a section called \f(CW\'homes\'\fP is included in the configuration file,
135 services connecting clients to their home directories can be created
136 on the fly by the server\&.
138 When the connection request is made, the existing sections are
139 scanned\&. If a match is found, it is used\&. If no match is found, the
140 requested section name is treated as a user name and looked up in the
141 local password file\&. If the name exists and the correct password has
142 been given, a share is created by cloning the [homes] section\&.
144 Some modifications are then made to the newly created share:
148 The share name is changed from \f(CW\'homes\'\fP to the located
152 If no path was given, the path is set to the user\'s home
156 If you decide to use a \fBpath=\fP line in your [homes]
157 section then you may find it useful to use the \fB%S\fP
158 macro\&. For example :
160 \f(CWpath=/data/pchome/%S\fP
162 would be useful if you have different home directories for your PCs
163 than for UNIX access\&.
165 This is a fast and simple way to give a large number of clients access
166 to their home directories with a minimum of fuss\&.
168 A similar process occurs if the requested section name is \f(CW"homes"\fP,
169 except that the share name is not changed to that of the requesting
170 user\&. This method of using the [homes] section works well if different
171 users share a client PC\&.
173 The [homes] section can specify all the parameters a normal service
174 section can specify, though some make more sense than others\&. The
175 following is a typical and suitable [homes] section:
188 An important point is that if guest access is specified in the [homes]
189 section, all home directories will be visible to all clients
190 \fBwithout a password\fP\&. In the very unlikely event that this is
191 actually desirable, it would be wise to also specify \fBread only
194 Note that the \fBbrowseable\fP flag for auto home
195 directories will be inherited from the global browseable flag, not the
196 [homes] browseable flag\&. This is useful as it means setting
197 browseable=no in the [homes] section will hide the [homes] share but
198 make any auto home directories visible\&.
200 .IP "\fBThe [printers] section\fP"
202 This section works like \fB[homes]\fP, but for printers\&.
204 If a [printers] section occurs in the configuration file, users are
205 able to connect to any printer specified in the local host\'s printcap
208 When a connection request is made, the existing sections are
209 scanned\&. If a match is found, it is used\&. If no match is found, but a
210 \fB[homes]\fP section exists, it is used as described
211 above\&. Otherwise, the requested section name is treated as a printer
212 name and the appropriate printcap file is scanned to see if the
213 requested section name is a valid printer share name\&. If a match is
214 found, a new printer share is created by cloning the [printers]
217 A few modifications are then made to the newly created share:
221 The share name is set to the located printer name
224 If no printer name was given, the printer name is set to the
228 If the share does not permit guest access and no username was
229 given, the username is set to the located printer name\&.
232 Note that the [printers] service MUST be printable - if you specify
233 otherwise, the server will refuse to load the configuration file\&.
235 Typically the path specified would be that of a world-writeable spool
236 directory with the sticky bit set on it\&. A typical [printers] entry
237 would look like this:
244 path = /usr/spool/public
253 All aliases given for a printer in the printcap file are legitimate
254 printer names as far as the server is concerned\&. If your printing
255 subsystem doesn\'t work like that, you will have to set up a
256 pseudo-printcap\&. This is a file consisting of one or more lines like
262 alias|alias|alias|alias\&.\&.\&.
267 Each alias should be an acceptable printer name for your printing
268 subsystem\&. In the \fB[global]\fP section, specify the new
269 file as your printcap\&. The server will then only recognize names
270 found in your pseudo-printcap, which of course can contain whatever
271 aliases you like\&. The same technique could be used simply to limit
272 access to a subset of your local printers\&.
274 An alias, by the way, is defined as any component of the first entry
275 of a printcap record\&. Records are separated by newlines, components
276 (if there are more than one) are separated by vertical bar symbols
279 NOTE: On SYSV systems which use lpstat to determine what printers are
280 defined on the system you may be able to use \fB"printcap name =
281 lpstat"\fP to automatically obtain a list of
282 printers\&. See the \fB"printcap name"\fP option for
288 Parameters define the specific attributes of sections\&.
290 Some parameters are specific to the \fB[global]\fP section
291 (e\&.g\&., \fBsecurity\fP)\&. Some parameters are usable in
292 all sections (e\&.g\&., \fBcreate mode\fP)\&. All others are
293 permissible only in normal sections\&. For the purposes of the following
294 descriptions the \fB[homes]\fP and
295 \fB[printers]\fP sections will be considered normal\&.
296 The letter \f(CW\'G\'\fP in parentheses indicates that a parameter is
297 specific to the \fB[global]\fP section\&. The letter \f(CW\'S\'\fP
298 indicates that a parameter can be specified in a service specific
299 section\&. Note that all \f(CW\'S\'\fP parameters can also be specified in the
300 \fB[global]\fP section - in which case they will define
301 the default behavior for all services\&.
303 Parameters are arranged here in alphabetical order - this may not
304 create best bedfellows, but at least you can find them! Where there
305 are synonyms, the preferred synonym is described, others refer to the
308 .SH "VARIABLE SUBSTITUTIONS"
310 Many of the strings that are settable in the config file can take
311 substitutions\&. For example the option \fB\f(CW"path =
312 /tmp/%u"\fP\fP would be interpreted as \f(CW"path = /tmp/john"\fP if
313 the user connected with the username john\&.
315 These substitutions are mostly noted in the descriptions below, but
316 there are some general substitutions which apply whenever they might
317 be relevant\&. These are:
321 \fB%S\fP = the name of the current service, if any\&.
324 \fB%P\fP = the root directory of the current service, if any\&.
327 \fB%u\fP = user name of the current service, if any\&.
330 \fB%g\fP = primary group name of \fB%u\fP\&.
333 \fB%U\fP = session user name (the user name that
334 the client wanted, not necessarily the same as the one they got)\&.
337 \fB%G\fP = primary group name of \fB%U\fP\&.
340 \fB%H\fP = the home directory of the user given by \fB%u\fP\&.
343 \fB%v\fP = the Samba version\&.
346 \fB%h\fP = the internet hostname that Samba is running on\&.
349 \fB%m\fP = the NetBIOS name of the client machine (very useful)\&.
352 \fB%L\fP = the NetBIOS name of the server\&. This allows you to change your
353 config based on what the client calls you\&. Your server can have a "dual
357 \fB%M\fP = the internet name of the client machine\&.
360 \fB%N\fP = the name of your NIS home directory server\&. This is
361 obtained from your NIS auto\&.map entry\&. If you have not compiled Samba
362 with the \fB--with-automount\fP option then this value will be the same
366 \fB%p\fP = the path of the service\'s home directory, obtained from your NIS
367 auto\&.map entry\&. The NIS auto\&.map entry is split up as "%N:%p"\&.
370 \fB%R\fP = the selected protocol level after protocol
371 negotiation\&. It can be one of CORE, COREPLUS, LANMAN1, LANMAN2 or NT1\&.
374 \fB%d\fP = The process id of the current server process\&.
377 \fB%a\fP = the architecture of the remote
378 machine\&. Only some are recognized, and those may not be 100%
379 reliable\&. It currently recognizes Samba, WfWg, WinNT and
380 Win95\&. Anything else will be known as "UNKNOWN"\&. If it gets it wrong
381 then sending a level 3 log to \fIsamba-bugs@samba\&.org\fP
382 should allow it to be fixed\&.
385 \fB%I\fP = The IP address of the client machine\&.
388 \fB%T\fP = the current date and time\&.
391 There are some quite creative things that can be done with these
392 substitutions and other smb\&.conf options\&.
396 Samba supports \fI"name mangling"\fP so that DOS and Windows clients can
397 use files that don\'t conform to the 8\&.3 format\&. It can also be set to
398 adjust the case of 8\&.3 format filenames\&.
400 There are several options that control the way mangling is performed,
401 and they are grouped here rather than listed separately\&. For the
402 defaults look at the output of the testparm program\&.
404 All of these options can be set separately for each service (or
405 globally, of course)\&.
409 \fB"mangle case = yes/no"\fP controls if names that have characters that
410 aren\'t of the "default" case are mangled\&. For example, if this is yes
411 then a name like \f(CW"Mail"\fP would be mangled\&. Default \fIno\fP\&.
413 \fB"case sensitive = yes/no"\fP controls whether filenames are case
414 sensitive\&. If they aren\'t then Samba must do a filename search and
415 match on passed names\&. Default \fIno\fP\&.
417 \fB"default case = upper/lower"\fP controls what the default case is for new
418 filenames\&. Default \fIlower\fP\&.
420 \fB"preserve case = yes/no"\fP controls if new files are created with the
421 case that the client passes, or if they are forced to be the \f(CW"default"\fP
422 case\&. Default \fIYes\fP\&.
425 \fB"short preserve case = yes/no"\fP controls if new files which conform
426 to 8\&.3 syntax, that is all in upper case and of suitable length, are
427 created upper case, or if they are forced to be the \f(CW"default"\fP
428 case\&. This option can be use with \fB"preserve case =
429 yes"\fP to permit long filenames to retain their
430 case, while short names are lowered\&. Default \fIYes\fP\&.
432 By default, Samba 2\&.0 has the same semantics as a Windows NT
433 server, in that it is case insensitive but case preserving\&.
435 .SH "NOTE ABOUT USERNAME/PASSWORD VALIDATION"
437 There are a number of ways in which a user can connect to a
438 service\&. The server follows the following steps in determining if it
439 will allow a connection to a specified service\&. If all the steps fail
440 then the connection request is rejected\&. If one of the steps pass then
441 the following steps are not checked\&.
443 If the service is marked \fB"guest only = yes"\fP then
444 steps 1 to 5 are skipped\&.
448 Step 1: If the client has passed a username/password pair and
449 that username/password pair is validated by the UNIX system\'s password
450 programs then the connection is made as that username\&. Note that this
451 includes the \f(CW\e\eserver\eservice%username\fP method of passing a
455 Step 2: If the client has previously registered a username with
456 the system and now supplies a correct password for that username then
457 the connection is allowed\&.
460 Step 3: The client\'s netbios name and any previously used user
461 names are checked against the supplied password, if they match then
462 the connection is allowed as the corresponding user\&.
465 Step 4: If the client has previously validated a
466 username/password pair with the server and the client has passed the
467 validation token then that username is used\&. This step is skipped if
468 \fB"revalidate = yes"\fP for this service\&.
471 Step 5: If a \fB"user = "\fP field is given in the
472 smb\&.conf file for the service and the client has supplied a password,
473 and that password matches (according to the UNIX system\'s password
474 checking) with one of the usernames from the \fBuser=\fP
475 field then the connection is made as the username in the
476 \fB"user="\fP line\&. If one of the username in the
477 \fBuser=\fP list begins with a \f(CW\'@\'\fP then that name
478 expands to a list of names in the group of the same name\&.
481 Step 6: If the service is a guest service then a connection is
482 made as the username given in the \fB"guest account
483 ="\fP for the service, irrespective of the supplied
487 .SH "COMPLETE LIST OF GLOBAL PARAMETERS"
489 Here is a list of all global parameters\&. See the section of each
490 parameter for details\&. Note that some are synonyms\&.
494 \fBadd user script\fP
497 \fBallow trusted domains\fP
503 \fBannounce version\fP
509 \fBbind interfaces only\fP
515 \fBchange notify timeout\fP
521 \fBclient code page\fP
533 \fBdebug hires timestamp\fP
539 \fBdebug timestamp\fP
551 \fBdefault service\fP
554 \fBdelete user script\fP
563 \fBdomain admin group\fP
566 \fBdomain admin users\fP
569 \fBdomain controller\fP
575 \fBdomain guest group\fP
578 \fBdomain guest users\fP
587 \fBencrypt passwords\fP
617 \fBldap root passwd\fP
665 \fBmachine password timeout\fP
698 \fBmessage command\fP
701 \fBmin passwd length\fP
707 \fBname resolve order\fP
710 \fBnetbios aliases\fP
722 \fBnt pipe support\fP
731 \fBole locking compatibility\fP
734 \fBoplock break wait time\fP
749 \fBpasswd chat debug\fP
758 \fBpassword server\fP
761 \fBprefered master\fP
764 \fBpreferred master\fP
776 \fBprinter driver file\fP
785 \fBread prediction\fP
794 \fBremote announce\fP
797 \fBremote browse sync\fP
800 \fBrestrict anonymous\fP
818 \fBshared mem size\fP
821 \fBsmb passwd file\fP
839 \fBssl CA certFile\fP
845 \fBssl client cert\fP
851 \fBssl compatibility\fP
857 \fBssl hosts resign\fP
860 \fBssl require clientcert\fP
863 \fBssl require servercert\fP
866 \fBssl server cert\fP
878 \fBstat cache size\fP
899 \fBunix password sync\fP
905 \fBupdate encrypted\fP
938 .SH "COMPLETE LIST OF SERVICE PARAMETERS"
940 Here is a list of all service parameters\&. See the section of each
941 parameter for details\&. Note that some are synonyms\&.
951 \fBalternate permissions\fP
987 \fBdelete readonly\fP
990 \fBdelete veto files\fP
1002 \fBdirectory mode\fP
1005 \fBdirectory security mask\fP
1011 \fBdos filetime resolution\fP
1020 \fBfake directory create times\fP
1026 \fBfollow symlinks\fP
1029 \fBforce create mode\fP
1032 \fBforce directory mode\fP
1035 \fBforce directory security mode\fP
1041 \fBforce security mode\fP
1062 \fBhide dot files\fP
1080 \fBlevel2 oplocks\fP
1086 \fBlppause command\fP
1092 \fBlpresume command\fP
1128 \fBmax connections\fP
1131 \fBmin print space\fP
1143 \fBoplock contention limit\fP
1176 \fBprinter driver\fP
1179 \fBprinter driver location\fP
1191 \fBqueuepause command\fP
1194 \fBqueueresume command\fP
1215 \fBroot preexec close\fP
1224 \fBshort preserve case\fP
1230 \fBstrict locking\fP
1254 \fBveto oplock files\fP
1275 .SH "EXPLANATION OF EACH PARAMETER"
1278 .IP "\fBadd user script (G)\fP"
1280 This is the full pathname to a script that will be run \fIAS ROOT\fP by
1281 \fBsmbd (8)\fP under special circumstances decribed
1284 Normally, a Samba server requires that UNIX users are created for all
1285 users accessing files on this server\&. For sites that use Windows NT
1286 account databases as their primary user database creating these users
1287 and keeping the user list in sync with the Windows NT PDC is an
1288 onerous task\&. This option allows \fBsmbd\fP to create
1289 the required UNIX users \fION DEMAND\fP when a user accesses the Samba
1292 In order to use this option, \fBsmbd\fP must be set to
1293 \fBsecurity=server\fP or
1294 \fBsecurity=domain\fP and \fB"add user script"\fP
1295 must be set to a full pathname for a script that will create a UNIX user
1296 given one argument of \fB%u\fP, which expands into the UNIX user name to
1299 When the Windows user attempts to access the Samba server, at
1300 \fI"login"\fP(session setup in the SMB protocol) time,
1301 \fBsmbd\fP contacts the \fBpassword
1302 server\fP and attempts to authenticate the given user
1303 with the given password\&. If the authentication succeeds then
1304 \fBsmbd\fP attempts to find a UNIX user in the UNIX
1305 password database to map the Windows user into\&. If this lookup fails,
1306 and \fB"add user script"\fP is set then \fBsmbd\fP will
1307 call the specified script \fIAS ROOT\fP, expanding any \fB%u\fP argument
1308 to be the user name to create\&.
1310 If this script successfully creates the user then
1311 \fBsmbd\fP will continue on as though the UNIX user
1312 already existed\&. In this way, UNIX users are dynamically created to
1313 match existing Windows NT accounts\&.
1315 See also \fBsecurity=server\fP,
1316 \fBsecurity=domain\fP, \fBpassword
1317 server\fP, \fBdelete user
1321 \f(CW add user script = <empty string>\fP
1324 \f(CW add user script = /usr/local/samba/bin/add_user %u\fP
1326 .IP "\fBadmin users (S)\fP"
1328 This is a list of users who will be granted administrative privileges
1329 on the share\&. This means that they will do all file operations as the
1330 super-user (root)\&.
1332 You should use this option very carefully, as any user in this list
1333 will be able to do anything they like on the share, irrespective of
1338 \f(CW no admin users\fP
1342 \f(CW admin users = jason\fP
1344 .IP "\fBallow hosts (S)\fP"
1346 Synonym for \fBhosts allow\fP\&.
1348 .IP "\fBallow trusted domains (G)\fP"
1350 This option only takes effect when the \fBsecurity\fP
1351 option is set to \fBserver\fP or \fBdomain\fP\&. If it is set to no,
1352 then attempts to connect to a resource from a domain or workgroup other than
1353 the one which smbd is running in will fail, even if that domain
1354 is trusted by the remote server doing the authentication\&.
1356 This is useful if you only want your Samba server to serve resources
1357 to users in the domain it is a member of\&. As an example, suppose that there are
1358 two domains DOMA and DOMB\&. DOMB is trusted by DOMA, which contains
1359 the Samba server\&. Under normal circumstances, a user with an account
1360 in DOMB can then access the resources of a UNIX account with the same
1361 account name on the Samba server even if they do not have an account
1362 in DOMA\&. This can make implementing a security boundary difficult\&.
1365 \f(CW allow trusted domains = Yes\fP
1368 \f(CW allow trusted domains = No\fP
1370 .IP "\fBalternate permissions (S)\fP"
1372 This is a deprecated parameter\&. It no longer has any effect in Samba2\&.0\&.
1373 In previous versions of Samba it affected the way the DOS "read only"
1374 attribute was mapped for a file\&. In Samba2\&.0 a file is marked "read only"
1375 if the UNIX file does not have the \'w\' bit set for the owner of the file,
1376 regardless if the owner of the file is the currently logged on user or not\&.
1378 .IP "\fBannounce as (G)\fP"
1380 This specifies what type of server \fBnmbd\fP will
1381 announce itself as, to a network neighborhood browse list\&. By default
1382 this is set to Windows NT\&. The valid options are : "NT", which is a
1383 synonym for "NT Server", "NT Server", "NT Workstation", "Win95" or
1384 "WfW" meaning Windows NT Server, Windows NT Workstation, Windows 95
1385 and Windows for Workgroups respectively\&. Do not change this parameter
1386 unless you have a specific need to stop Samba appearing as an NT server
1387 as this may prevent Samba servers from participating as browser servers correctly\&.
1390 \f(CW announce as = NT Server\fP
1393 \f(CW announce as = Win95\fP
1395 .IP "\fBannounce version (G)\fP"
1397 This specifies the major and minor version numbers that nmbd will use
1398 when announcing itself as a server\&. The default is 4\&.2\&. Do not change
1399 this parameter unless you have a specific need to set a Samba server
1400 to be a downlevel server\&.
1403 \f(CW announce version = 4\&.2\fP
1406 \f(CW announce version = 2\&.0\fP
1408 .IP "\fBauto services (G)\fP"
1410 This is a list of services that you want to be automatically added to
1411 the browse lists\&. This is most useful for homes and printers services
1412 that would otherwise not be visible\&.
1414 Note that if you just want all printers in your printcap file loaded
1415 then the \fB"load printers"\fP option is easier\&.
1418 \f(CW no auto services\fP
1421 \f(CW auto services = fred lp colorlp\fP
1423 .IP "\fBavailable (S)\fP"
1425 This parameter lets you \fI\'turn off\'\fP a service\&. If \f(CW\'available = no\'\fP,
1426 then \fIALL\fP attempts to connect to the service will fail\&. Such failures
1430 \f(CW available = yes\fP
1433 \f(CW available = no\fP
1435 .IP "\fBbind interfaces only (G)\fP"
1437 This global parameter allows the Samba admin to limit what interfaces
1438 on a machine will serve smb requests\&. If affects file service
1439 \fBsmbd\fP and name service \fBnmbd\fP
1440 in slightly different ways\&.
1442 For name service it causes \fBnmbd\fP to bind to ports
1443 137 and 138 on the interfaces listed in the
1444 \fB\'interfaces\'\fP
1445 parameter\&. \fBnmbd\fP also binds to the \'all
1446 addresses\' interface (0\&.0\&.0\&.0) on ports 137 and 138 for the purposes
1447 of reading broadcast messages\&. If this option is not set then
1448 \fBnmbd\fP will service name requests on all of these
1449 sockets\&. If \fB"bind interfaces only"\fP is set then
1450 \fBnmbd\fP will check the source address of any
1451 packets coming in on the broadcast sockets and discard any that don\'t
1452 match the broadcast addresses of the interfaces in the
1453 \fB\'interfaces\'\fP parameter list\&. As unicast packets
1454 are received on the other sockets it allows \fBnmbd\fP
1455 to refuse to serve names to machines that send packets that arrive
1456 through any interfaces not listed in the
1457 \fB"interfaces"\fP list\&. IP Source address spoofing
1458 does defeat this simple check, however so it must not be used
1459 seriously as a security feature for \fBnmbd\fP\&.
1461 For file service it causes \fBsmbd\fP to bind only to
1462 the interface list given in the \fB\'interfaces\'\fP
1463 parameter\&. This restricts the networks that \fBsmbd\fP
1464 will serve to packets coming in those interfaces\&. Note that you
1465 should not use this parameter for machines that are serving PPP or
1466 other intermittent or non-broadcast network interfaces as it will not
1467 cope with non-permanent interfaces\&.
1469 If \fB"bind interfaces only"\fP is set then unless the network address
1470 \fI127\&.0\&.0\&.1\fP is added to the \fB\'interfaces\'\fP parameter
1471 list \fBsmbpasswd\fP and
1472 \fBswat\fP may not work as expected due to the
1473 reasons covered below\&.
1475 To change a users SMB password, the \fBsmbpasswd\fP
1476 by default connects to the \fI"localhost" - 127\&.0\&.0\&.1\fP address as an SMB
1477 client to issue the password change request\&. If \fB"bind interfaces only"\fP
1478 is set then unless the network address \fI127\&.0\&.0\&.1\fP is added to the
1479 \fB\'interfaces\'\fP parameter list then
1480 \fBsmbpasswd\fP will fail to connect in it\'s
1481 default mode\&. \fBsmbpasswd\fP can be forced to
1482 use the primary IP interface of the local host by using its
1483 \fB"-r remote machine"\fP parameter, with
1484 \fB"remote machine"\fP set to the IP name of the primary interface
1485 of the local host\&.
1487 The \fBswat\fP status page tries to connect with
1488 \fBsmbd\fP and \fBnmbd\fP at the address
1489 \fI127\&.0\&.0\&.1\fP to determine if they are running\&. Not adding \fI127\&.0\&.0\&.1\fP will cause
1490 \fBsmbd\fP and \fBnmbd\fP to always show
1491 "not running" even if they really are\&. This can prevent
1492 \fBswat\fP from starting/stopping/restarting
1493 \fBsmbd\fP and \fBnmbd\fP\&.
1496 \f(CW bind interfaces only = False\fP
1499 \f(CW bind interfaces only = True\fP
1501 .IP "\fBblocking locks (S)\fP"
1503 This parameter controls the behavior of \fBsmbd\fP when
1504 given a request by a client to obtain a byte range lock on a region
1505 of an open file, and the request has a time limit associated with it\&.
1507 If this parameter is set and the lock range requested cannot be
1508 immediately satisfied, Samba 2\&.0 will internally queue the lock
1509 request, and periodically attempt to obtain the lock until the
1510 timeout period expires\&.
1512 If this parameter is set to "False", then Samba 2\&.0 will behave
1513 as previous versions of Samba would and will fail the lock
1514 request immediately if the lock range cannot be obtained\&.
1516 This parameter can be set per share\&.
1519 \f(CW blocking locks = True\fP
1522 \f(CW blocking locks = False\fP
1524 .IP "\fBbrowsable (S)\fP"
1526 Synonym for \fBbrowseable\fP\&.
1528 .IP "\fBbrowse list(G)\fP"
1530 This controls whether \fBsmbd\fP will serve a browse
1531 list to a client doing a NetServerEnum call\&. Normally set to true\&. You
1532 should never need to change this\&.
1535 \f(CW browse list = Yes\fP
1537 .IP "\fBbrowseable\fP"
1539 This controls whether this share is seen in the list of available
1540 shares in a net view and in the browse list\&.
1543 \f(CW browseable = Yes\fP
1546 \f(CW browseable = No\fP
1548 .IP "\fBcase sensitive (G)\fP"
1550 See the discussion in the section \fBNAME MANGLING\fP\&.
1552 .IP "\fBcasesignames (G)\fP"
1554 Synonym for \fB"case sensitive"\fP\&.
1556 .IP "\fBchange notify timeout (G)\fP"
1558 One of the new NT SMB requests that Samba 2\&.0 supports is the
1559 "ChangeNotify" requests\&. This SMB allows a client to tell a server to
1560 \fI"watch"\fP a particular directory for any changes and only reply to
1561 the SMB request when a change has occurred\&. Such constant scanning of
1562 a directory is expensive under UNIX, hence an
1563 \fBsmbd\fP daemon only performs such a scan on each
1564 requested directory once every \fBchange notify timeout\fP seconds\&.
1566 \fBchange notify timeout\fP is specified in units of seconds\&.
1569 \f(CW change notify timeout = 60\fP
1572 \f(CW change notify timeout = 300\fP
1574 Would change the scan time to every 5 minutes\&.
1576 .IP "\fBcharacter set (G)\fP"
1578 This allows a smbd to map incoming filenames from a DOS Code page (see
1579 the \fBclient code page\fP parameter) to several
1580 built in UNIX character sets\&. The built in code page translations are:
1584 \fBISO8859-1\fP Western European UNIX character set\&. The parameter
1585 \fBclient code page\fP \fIMUST\fP be set to code
1586 page 850 if the \fBcharacter set\fP parameter is set to iso8859-1
1587 in order for the conversion to the UNIX character set to be done
1591 \fBISO8859-2\fP Eastern European UNIX character set\&. The parameter
1592 \fBclient code page\fP \fIMUST\fP be set to code
1593 page 852 if the \fBcharacter set\fP parameter is set to ISO8859-2
1594 in order for the conversion to the UNIX character set to be done
1598 \fBISO8859-5\fP Russian Cyrillic UNIX character set\&. The parameter
1599 \fBclient code page\fP \fIMUST\fP be set to code
1600 page 866 if the \fBcharacter set\fP parameter is set to ISO8859-5
1601 in order for the conversion to the UNIX character set to be done
1605 \fBISO8859-7\fP Greek UNIX character set\&. The parameter
1606 \fBclient code page\fP \fIMUST\fP be set to code
1607 page 737 if the \fBcharacter set\fP parameter is set to ISO8859-7
1608 in order for the conversion to the UNIX character set to be done
1612 \fBKOI8-R\fP Alternate mapping for Russian Cyrillic UNIX
1613 character set\&. The parameter \fBclient code
1614 page\fP \fIMUST\fP be set to code page 866 if the
1615 \fBcharacter set\fP parameter is set to KOI8-R in order for the
1616 conversion to the UNIX character set to be done correctly\&.
1619 \fIBUG\fP\&. These MSDOS code page to UNIX character set mappings should
1620 be dynamic, like the loading of MS DOS code pages, not static\&.
1622 See also \fBclient code page\fP\&. Normally this
1623 parameter is not set, meaning no filename translation is done\&.
1626 \f(CW character set = <empty string>\fP
1629 \f(CW character set = ISO8859-1\fP
1631 .IP "\fBclient code page (G)\fP"
1633 This parameter specifies the DOS code page that the clients accessing
1634 Samba are using\&. To determine what code page a Windows or DOS client
1635 is using, open a DOS command prompt and type the command "chcp"\&. This
1636 will output the code page\&. The default for USA MS-DOS, Windows 95, and
1637 Windows NT releases is code page 437\&. The default for western european
1638 releases of the above operating systems is code page 850\&.
1640 This parameter tells \fBsmbd\fP which of the
1641 \f(CWcodepage\&.XXX\fP files to dynamically load on startup\&. These files,
1642 described more fully in the manual page \fBmake_smbcodepage
1643 (1)\fP, tell \fBsmbd\fP how
1644 to map lower to upper case characters to provide the case insensitivity
1645 of filenames that Windows clients expect\&.
1647 Samba currently ships with the following code page files :
1651 \fBCode Page 437 - MS-DOS Latin US\fP
1654 \fBCode Page 737 - Windows \'95 Greek\fP
1657 \fBCode Page 850 - MS-DOS Latin 1\fP
1660 \fBCode Page 852 - MS-DOS Latin 2\fP
1663 \fBCode Page 861 - MS-DOS Icelandic\fP
1666 \fBCode Page 866 - MS-DOS Cyrillic\fP
1669 \fBCode Page 932 - MS-DOS Japanese SJIS\fP
1672 \fBCode Page 936 - MS-DOS Simplified Chinese\fP
1675 \fBCode Page 949 - MS-DOS Korean Hangul\fP
1678 \fBCode Page 950 - MS-DOS Traditional Chinese\fP
1681 Thus this parameter may have any of the values 437, 737, 850, 852,
1682 861, 932, 936, 949, or 950\&. If you don\'t find the codepage you need,
1683 read the comments in one of the other codepage files and the
1684 \fBmake_smbcodepage (1)\fP man page and
1685 write one\&. Please remember to donate it back to the Samba user
1688 This parameter co-operates with the \fB"valid
1689 chars"\fP parameter in determining what characters are
1690 valid in filenames and how capitalization is done\&. If you set both
1691 this parameter and the \fB"valid chars"\fP parameter
1692 the \fB"client code page"\fP parameter \fIMUST\fP be set before the
1693 \fB"valid chars"\fP parameter in the \fBsmb\&.conf\fP
1694 file\&. The \fB"valid chars"\fP string will then augment
1695 the character settings in the "client code page" parameter\&.
1697 If not set, \fB"client code page"\fP defaults to 850\&.
1699 See also : \fB"valid chars"\fP
1702 \f(CW client code page = 850\fP
1705 \f(CW client code page = 936\fP
1707 .IP "\fBcodingsystem (G)\fP"
1709 This parameter is used to determine how incoming Shift-JIS Japanese
1710 characters are mapped from the incoming \fB"client code
1711 page"\fP used by the client, into file names in the
1712 UNIX filesystem\&. Only useful if \fB"client code
1713 page"\fP is set to 932 (Japanese Shift-JIS)\&.
1719 \fBSJIS\fP Shift-JIS\&. Does no conversion of the incoming filename\&.
1722 \fBJIS8, J8BB, J8BH, J8@B, J8@J, J8@H \fP Convert from incoming
1723 Shift-JIS to eight bit JIS code with different shift-in, shift out
1727 \fBJIS7, J7BB, J7BH, J7@B, J7@J, J7@H \fP Convert from incoming
1728 Shift-JIS to seven bit JIS code with different shift-in, shift out
1732 \fBJUNET, JUBB, JUBH, JU@B, JU@J, JU@H \fP Convert from incoming
1733 Shift-JIS to JUNET code with different shift-in, shift out codes\&.
1736 \fBEUC\fP Convert an incoming Shift-JIS character to EUC code\&.
1739 \fBHEX\fP Convert an incoming Shift-JIS character to a 3 byte hex
1740 representation, i\&.e\&. \f(CW:AB\fP\&.
1743 \fBCAP\fP Convert an incoming Shift-JIS character to the 3 byte hex
1744 representation used by the Columbia AppleTalk Program (CAP),
1745 i\&.e\&. \f(CW:AB\fP\&. This is used for compatibility between Samba and CAP\&.
1748 .IP "\fBcomment (S)\fP"
1750 This is a text field that is seen next to a share when a client does a
1751 queries the server, either via the network neighborhood or via "net
1752 view" to list what shares are available\&.
1754 If you want to set the string that is displayed next to the machine
1755 name then see the server string command\&.
1758 \f(CW No comment string\fP
1761 \f(CW comment = Fred\'s Files\fP
1763 .IP "\fBconfig file (G)\fP"
1765 This allows you to override the config file to use, instead of the
1766 default (usually \fBsmb\&.conf\fP)\&. There is a chicken and egg problem
1767 here as this option is set in the config file!
1769 For this reason, if the name of the config file has changed when the
1770 parameters are loaded then it will reload them from the new config
1773 This option takes the usual substitutions, which can be very useful\&.
1775 If the config file doesn\'t exist then it won\'t be loaded (allowing you
1776 to special case the config files of just a few clients)\&.
1779 \f(CW config file = /usr/local/samba/lib/smb\&.conf\&.%m\fP
1781 .IP "\fBcopy (S)\fP"
1783 This parameter allows you to \fI\'clone\'\fP service entries\&. The specified
1784 service is simply duplicated under the current service\'s name\&. Any
1785 parameters specified in the current section will override those in the
1786 section being copied\&.
1788 This feature lets you set up a \'template\' service and create similar
1789 services easily\&. Note that the service being copied must occur earlier
1790 in the configuration file than the service doing the copying\&.
1796 \f(CW copy = otherservice\fP
1798 .IP "\fBcreate mask (S)\fP"
1800 A synonym for this parameter is \fB\'create mode\'\fP\&.
1802 When a file is created, the necessary permissions are calculated
1803 according to the mapping from DOS modes to UNIX permissions, and the
1804 resulting UNIX mode is then bit-wise \'AND\'ed with this parameter\&.
1805 This parameter may be thought of as a bit-wise MASK for the UNIX modes
1806 of a file\&. Any bit \fI*not*\fP set here will be removed from the modes set
1807 on a file when it is created\&.
1809 The default value of this parameter removes the \'group\' and \'other\'
1810 write and execute bits from the UNIX modes\&.
1812 Following this Samba will bit-wise \'OR\' the UNIX mode created from
1813 this parameter with the value of the "force create mode" parameter
1814 which is set to 000 by default\&.
1816 This parameter does not affect directory modes\&. See the parameter
1817 \fB\'directory mode\'\fP for details\&.
1819 See also the \fB"force create mode"\fP parameter
1820 for forcing particular mode bits to be set on created files\&. See also
1821 the \fB"directory mode"\fP parameter for masking
1822 mode bits on created directories\&.
1825 \f(CW create mask = 0744\fP
1828 \f(CW create mask = 0775\fP
1830 .IP "\fBcreate mode (S)\fP"
1832 This is a synonym for \fBcreate mask\fP\&.
1834 .IP "\fBdeadtime (G)\fP"
1836 The value of the parameter (a decimal integer) represents the number
1837 of minutes of inactivity before a connection is considered dead, and
1838 it is disconnected\&. The deadtime only takes effect if the number of
1839 open files is zero\&.
1841 This is useful to stop a server\'s resources being exhausted by a large
1842 number of inactive connections\&.
1844 Most clients have an auto-reconnect feature when a connection is
1845 broken so in most cases this parameter should be transparent to users\&.
1847 Using this parameter with a timeout of a few minutes is recommended
1850 A deadtime of zero indicates that no auto-disconnection should be
1854 \f(CW deadtime = 0\fP
1857 \f(CW deadtime = 15\fP
1859 .IP "\fBdebug hires timestamp (G)\fP"
1861 Sometimes the timestamps in the log messages are needed with a
1862 resolution of higher that seconds, this boolean parameter adds
1863 microsecond resolution to the timestamp message header when turned on\&.
1865 Note that the parameter \fBdebug timestamp\fP
1866 must be on for this to have an effect\&.
1869 \f(CW debug hires timestamp = No\fP
1872 \f(CW debug hires timestamp = Yes\fP
1874 .IP "\fBdebug timestamp (G)\fP"
1876 Samba2\&.0 debug log messages are timestamped by default\&. If you are
1877 running at a high \fB"debug level"\fP these timestamps
1878 can be distracting\&. This boolean parameter allows them to be turned
1882 \f(CW debug timestamp = Yes\fP
1885 \f(CW debug timestamp = No\fP
1887 .IP "\fBdebug pid (G)\fP"
1889 When using only one log file for more then one forked smbd-process
1890 there may be hard to follow which process outputs which message\&.
1891 This boolean parameter is adds the process-id to the timestamp message
1892 headers in the logfile when turned on\&.
1894 Note that the parameter \fBdebug timestamp\fP
1895 must be on for this to have an effect\&.
1898 \f(CW debug pid = No\fP
1901 \f(CW debug pid = Yes\fP
1903 .IP "\fBdebug uid (G)\fP"
1905 Samba is sometimes run as root and sometime run as the connected
1906 user, this boolean parameter inserts the current euid, egid, uid
1907 and gid to the timestamp message headers in the log file if turned on\&.
1909 Note that the parameter \fBdebug timestamp\fP
1910 must be on for this to have an effect\&.
1913 \f(CW debug uid = No\fP
1916 \f(CW debug uid = Yes\fP
1918 .IP "\fBdebug level (G)\fP"
1920 The value of the parameter (an integer) allows the debug level
1921 (logging level) to be specified in the \fBsmb\&.conf\fP file\&. This is to
1922 give greater flexibility in the configuration of the system\&.
1924 The default will be the debug level specified on the command line
1925 or level zero if none was specified\&.
1928 \f(CW debug level = 3\fP
1930 .IP "\fBdefault (G)\fP"
1932 A synonym for \fBdefault service\fP\&.
1934 .IP "\fBdefault case (S)\fP"
1936 See the section on \fB"NAME MANGLING"\fP\&. Also note
1937 the \fB"short preserve case"\fP parameter\&.
1939 .IP "\fBdefault service (G)\fP"
1941 This parameter specifies the name of a service which will be connected
1942 to if the service actually requested cannot be found\&. Note that the
1943 square brackets are \fINOT\fP given in the parameter value (see example
1946 There is no default value for this parameter\&. If this parameter is not
1947 given, attempting to connect to a nonexistent service results in an
1950 Typically the default service would be a \fBguest ok\fP,
1951 \fBread-only\fP service\&.
1953 Also note that the apparent service name will be changed to equal that
1954 of the requested service, this is very useful as it allows you to use
1955 macros like \fB%S\fP to make a wildcard service\&.
1957 Note also that any \f(CW\'_\'\fP characters in the name of the service used
1958 in the default service will get mapped to a \f(CW\'/\'\fP\&. This allows for
1959 interesting things\&.
1966 default service = pub
1975 .IP "\fBdelete user script (G)\fP"
1977 This is the full pathname to a script that will be run \fIAS ROOT\fP by
1978 \fBsmbd (8)\fP under special circumstances decribed
1981 Normally, a Samba server requires that UNIX users are created for all
1982 users accessing files on this server\&. For sites that use Windows NT
1983 account databases as their primary user database creating these users
1984 and keeping the user list in sync with the Windows NT PDC is an
1985 onerous task\&. This option allows \fBsmbd\fP to delete
1986 the required UNIX users \fION DEMAND\fP when a user accesses the Samba
1987 server and the Windows NT user no longer exists\&.
1989 In order to use this option, \fBsmbd\fP must be set to
1990 \fBsecurity=domain\fP and \fB"delete user
1991 script"\fP must be set to a full pathname for a script that will delete
1992 a UNIX user given one argument of \fB%u\fP, which expands into the UNIX
1993 user name to delete\&. \fINOTE\fP that this is different to the
1994 \fBadd user script\fP which will work with the
1995 \fBsecurity=server\fP option as well as
1996 \fBsecurity=domain\fP\&. The reason for this
1997 is only when Samba is a domain member does it get the information
1998 on an attempted user logon that a user no longer exists\&. In the
1999 \fBsecurity=server\fP mode a missing user
2000 is treated the same as an invalid password logon attempt\&. Deleting
2001 the user in this circumstance would not be a good idea\&.
2003 When the Windows user attempts to access the Samba server, at
2004 \fI"login"\fP(session setup in the SMB protocol) time,
2005 \fBsmbd\fP contacts the \fBpassword
2006 server\fP and attempts to authenticate the given user
2007 with the given password\&. If the authentication fails with the specific
2008 Domain error code meaning that the user no longer exists then
2009 \fBsmbd\fP attempts to find a UNIX user in the UNIX
2010 password database that matches the Windows user account\&. If this lookup succeeds,
2011 and \fB"delete user script"\fP is set then \fBsmbd\fP will
2012 call the specified script \fIAS ROOT\fP, expanding any \fB%u\fP argument
2013 to be the user name to delete\&.
2015 This script should delete the given UNIX username\&. In this way, UNIX
2016 users are dynamically deleted to match existing Windows NT accounts\&.
2018 See also \fBsecurity=domain\fP,
2019 \fBpassword server\fP, \fBadd user
2023 \f(CW delete user script = <empty string>\fP
2026 \f(CW delete user script = /usr/local/samba/bin/del_user %u\fP
2028 .IP "\fBdelete readonly (S)\fP"
2030 This parameter allows readonly files to be deleted\&. This is not
2031 normal DOS semantics, but is allowed by UNIX\&.
2033 This option may be useful for running applications such as rcs, where
2034 UNIX file ownership prevents changing file permissions, and DOS
2035 semantics prevent deletion of a read only file\&.
2038 \f(CW delete readonly = No\fP
2041 \f(CW delete readonly = Yes\fP
2043 .IP "\fBdelete veto files (S)\fP"
2045 This option is used when Samba is attempting to delete a directory
2046 that contains one or more vetoed directories (see the \fB\'veto
2047 files\'\fP option)\&. If this option is set to False (the
2048 default) then if a vetoed directory contains any non-vetoed files or
2049 directories then the directory delete will fail\&. This is usually what
2052 If this option is set to True, then Samba will attempt to recursively
2053 delete any files and directories within the vetoed directory\&. This can
2054 be useful for integration with file serving systems such as \fBNetAtalk\fP,
2055 which create meta-files within directories you might normally veto
2056 DOS/Windows users from seeing (e\&.g\&. \f(CW\&.AppleDouble\fP)
2058 Setting \f(CW\'delete veto files = True\'\fP allows these directories to be
2059 transparently deleted when the parent directory is deleted (so long
2060 as the user has permissions to do so)\&.
2062 See also the \fBveto files\fP parameter\&.
2065 \f(CW delete veto files = False\fP
2068 \f(CW delete veto files = True\fP
2070 .IP "\fBdeny hosts (S)\fP"
2072 Synonym for \fBhosts deny\fP\&.
2074 .IP "\fBdfree command (G)\fP"
2076 The dfree command setting should only be used on systems where a
2077 problem occurs with the internal disk space calculations\&. This has
2078 been known to happen with Ultrix, but may occur with other operating
2079 systems\&. The symptom that was seen was an error of "Abort Retry
2080 Ignore" at the end of each directory listing\&.
2082 This setting allows the replacement of the internal routines to
2083 calculate the total disk space and amount available with an external
2084 routine\&. The example below gives a possible script that might fulfill
2087 The external program will be passed a single parameter indicating a
2088 directory in the filesystem being queried\&. This will typically consist
2089 of the string \f(CW"\&./"\fP\&. The script should return two integers in
2090 ascii\&. The first should be the total disk space in blocks, and the
2091 second should be the number of available blocks\&. An optional third
2092 return value can give the block size in bytes\&. The default blocksize
2095 Note: Your script should \fINOT\fP be setuid or setgid and should be
2096 owned by (and writeable only by) root!
2099 \f(CW By default internal routines for determining the disk capacity
2100 and remaining space will be used\&.\fP
2103 \f(CW dfree command = /usr/local/samba/bin/dfree\fP
2105 Where the script dfree (which must be made executable) could be:
2112 df $1 | tail -1 | awk \'{print $2" "$4}\'
2118 or perhaps (on Sys V based systems):
2125 /usr/bin/df -k $1 | tail -1 | awk \'{print $3" "$5}\'
2131 Note that you may have to replace the command names with full
2132 path names on some systems\&.
2134 .IP "\fBdirectory (S)\fP"
2136 Synonym for \fBpath\fP\&.
2138 .IP "\fBdirectory mask (S)\fP"
2140 This parameter is the octal modes which are used when converting DOS
2141 modes to UNIX modes when creating UNIX directories\&.
2143 When a directory is created, the necessary permissions are calculated
2144 according to the mapping from DOS modes to UNIX permissions, and the
2145 resulting UNIX mode is then bit-wise \'AND\'ed with this parameter\&.
2146 This parameter may be thought of as a bit-wise MASK for the UNIX modes
2147 of a directory\&. Any bit \fI*not*\fP set here will be removed from the
2148 modes set on a directory when it is created\&.
2150 The default value of this parameter removes the \'group\' and \'other\'
2151 write bits from the UNIX mode, allowing only the user who owns the
2152 directory to modify it\&.
2154 Following this Samba will bit-wise \'OR\' the UNIX mode created from
2155 this parameter with the value of the "force directory mode"
2156 parameter\&. This parameter is set to 000 by default (i\&.e\&. no extra mode
2159 See the \fB"force directory mode"\fP parameter
2160 to cause particular mode bits to always be set on created directories\&.
2162 See also the \fB"create mode"\fP parameter for masking
2163 mode bits on created files, and the \fB"directory security mask"\fP
2167 \f(CW directory mask = 0755\fP
2170 \f(CW directory mask = 0775\fP
2172 .IP "\fBdirectory mode (S)\fP"
2174 Synonym for \fBdirectory mask\fP\&.
2176 .IP "\fBdirectory security mask (S)\fP"
2178 This parameter controls what UNIX permission bits can be modified
2179 when a Windows NT client is manipulating the UNIX permission on a
2180 directory using the native NT security dialog box\&.
2182 This parameter is applied as a mask (AND\'ed with) to the changed
2183 permission bits, thus preventing any bits not in this mask from
2184 being modified\&. Essentially, zero bits in this mask may be treated
2185 as a set of bits the user is not allowed to change\&.
2187 If not set explicitly this parameter is set to the same value as the
2188 \fBdirectory mask\fP parameter\&. To allow a user to
2189 modify all the user/group/world permissions on a directory, set this
2190 parameter to 0777\&.
2192 \fINote\fP that users who can access the Samba server through other
2193 means can easily bypass this restriction, so it is primarily
2194 useful for standalone "appliance" systems\&. Administrators of
2195 most normal systems will probably want to set it to 0777\&.
2197 See also the \fBforce directory security
2198 mode\fP, \fBsecurity
2199 mask\fP, \fBforce security mode\fP
2203 \f(CW directory security mask = <same as directory mask>\fP
2206 \f(CW directory security mask = 0777\fP
2208 .IP "\fBdns proxy (G)\fP"
2210 Specifies that \fBnmbd\fP when acting as a WINS
2211 server and finding that a NetBIOS name has not been registered, should
2212 treat the NetBIOS name word-for-word as a DNS name and do a lookup
2213 with the DNS server for that name on behalf of the name-querying
2216 Note that the maximum length for a NetBIOS name is 15 characters, so
2217 the DNS name (or DNS alias) can likewise only be 15 characters,
2220 \fBnmbd\fP spawns a second copy of itself to do the
2221 DNS name lookup requests, as doing a name lookup is a blocking action\&.
2223 See also the parameter \fBwins support\fP\&.
2226 \f(CW dns proxy = yes\fP
2228 \fBdomain admin group (G)\fP
2230 This is an \fBEXPERIMENTAL\fP parameter that is part of the unfinished
2231 Samba NT Domain Controller Code\&. It may be removed in a later release\&.
2232 To work with the latest code builds that may have more support for
2233 Samba NT Domain Controller functionality please subscribe to the
2234 mailing list \fBSamba-ntdom\fP available by sending email to
2235 \fIlistproc@samba\&.org\fP
2237 .IP "\fBdomain admin users (G)\fP"
2239 This is an \fBEXPERIMENTAL\fP parameter that is part of the unfinished
2240 Samba NT Domain Controller Code\&. It may be removed in a later release\&.
2241 To work with the latest code builds that may have more support for
2242 Samba NT Domain Controller functionality please subscribe to the
2243 mailing list \fBSamba-ntdom\fP available by sending email to
2244 \fIlistproc@samba\&.org\fP
2246 .IP "\fBdomain controller (G)\fP"
2248 This is a \fBDEPRECATED\fP parameter\&. It is currently not used within
2249 the Samba source and should be removed from all current smb\&.conf
2250 files\&. It is left behind for compatibility reasons\&.
2252 .IP "\fBdomain groups (G)\fP"
2254 This is an \fBEXPERIMENTAL\fP parameter that is part of the unfinished
2255 Samba NT Domain Controller Code\&. It may be removed in a later release\&.
2256 To work with the latest code builds that may have more support for
2257 Samba NT Domain Controller functionality please subscribe to the
2258 mailing list \fBSamba-ntdom\fP available by sending email to
2259 \fIlistproc@samba\&.org\fP
2261 .IP "\fBdomain guest group (G)\fP"
2263 This is an \fBEXPERIMENTAL\fP parameter that is part of the unfinished
2264 Samba NT Domain Controller Code\&. It may be removed in a later release\&.
2265 To work with the latest code builds that may have more support for
2266 Samba NT Domain Controller functionality please subscribe to the
2267 mailing list \fBSamba-ntdom\fP available by sending email to
2268 \fIlistproc@samba\&.org\fP
2270 .IP "\fBdomain guest users (G)\fP"
2272 This is an \fBEXPERIMENTAL\fP parameter that is part of the unfinished
2273 Samba NT Domain Controller Code\&. It may be removed in a later release\&.
2274 To work with the latest code builds that may have more support for
2275 Samba NT Domain Controller functionality please subscribe to the
2276 mailing list \fBSamba-ntdom\fP available by sending email to
2277 \fIlistproc@samba\&.org\fP
2279 .IP "\fBdomain logons (G)\fP"
2281 If set to true, the Samba server will serve Windows 95/98 Domain
2282 logons for the \fBworkgroup\fP it is in\&. For more
2283 details on setting up this feature see the file DOMAINS\&.txt in the
2284 Samba documentation directory \f(CWdocs/\fP shipped with the source code\&.
2286 Note that Win95/98 Domain logons are \fINOT\fP the same as Windows
2287 NT Domain logons\&. NT Domain logons require a Primary Domain Controller
2288 (PDC) for the Domain\&. It is intended that in a future release Samba
2289 will be able to provide this functionality for Windows NT clients
2293 \f(CW domain logons = no\fP
2295 .IP "\fBdomain master (G)\fP"
2297 Tell \fBnmbd\fP to enable WAN-wide browse list
2298 collation\&. Setting this option causes \fBnmbd\fP to
2299 claim a special domain specific NetBIOS name that identifies it as a
2300 domain master browser for its given
2301 \fBworkgroup\fP\&. Local master browsers in the same
2302 \fBworkgroup\fP on broadcast-isolated subnets will give
2303 this \fBnmbd\fP their local browse lists, and then
2304 ask \fBsmbd\fP for a complete copy of the browse list
2305 for the whole wide area network\&. Browser clients will then contact
2306 their local master browser, and will receive the domain-wide browse
2307 list, instead of just the list for their broadcast-isolated subnet\&.
2309 Note that Windows NT Primary Domain Controllers expect to be able to
2310 claim this \fBworkgroup\fP specific special NetBIOS
2311 name that identifies them as domain master browsers for that
2312 \fBworkgroup\fP by default (i\&.e\&. there is no way to
2313 prevent a Windows NT PDC from attempting to do this)\&. This means that
2314 if this parameter is set and \fBnmbd\fP claims the
2315 special name for a \fBworkgroup\fP before a Windows NT
2316 PDC is able to do so then cross subnet browsing will behave strangely
2320 \f(CW domain master = no\fP
2322 .IP "\fBdont descend (S)\fP"
2324 There are certain directories on some systems (e\&.g\&., the \f(CW/proc\fP tree
2325 under Linux) that are either not of interest to clients or are
2326 infinitely deep (recursive)\&. This parameter allows you to specify a
2327 comma-delimited list of directories that the server should always show
2330 Note that Samba can be very fussy about the exact format of the "dont
2331 descend" entries\&. For example you may need \f(CW"\&./proc"\fP instead of
2332 just \f(CW"/proc"\fP\&. Experimentation is the best policy :-)
2335 \f(CW none (i\&.e\&., all directories are OK to descend)\fP
2338 \f(CW dont descend = /proc,/dev\fP
2340 .IP "\fBdos filetime resolution (S)\fP"
2342 Under the DOS and Windows FAT filesystem, the finest granularity on
2343 time resolution is two seconds\&. Setting this parameter for a share
2344 causes Samba to round the reported time down to the nearest two second
2345 boundary when a query call that requires one second resolution is made
2348 This option is mainly used as a compatibility option for Visual C++
2349 when used against Samba shares\&. If oplocks are enabled on a share,
2350 Visual C++ uses two different time reading calls to check if a file
2351 has changed since it was last read\&. One of these calls uses a
2352 one-second granularity, the other uses a two second granularity\&. As
2353 the two second call rounds any odd second down, then if the file has a
2354 timestamp of an odd number of seconds then the two timestamps will not
2355 match and Visual C++ will keep reporting the file has changed\&. Setting
2356 this option causes the two timestamps to match, and Visual C++ is
2360 \f(CW dos filetime resolution = False\fP
2363 \f(CW dos filetime resolution = True\fP
2365 .IP "\fBdos filetimes (S)\fP"
2367 Under DOS and Windows, if a user can write to a file they can change
2368 the timestamp on it\&. Under POSIX semantics, only the owner of the file
2369 or root may change the timestamp\&. By default, Samba runs with POSIX
2370 semantics and refuses to change the timestamp on a file if the user
2371 smbd is acting on behalf of is not the file owner\&. Setting this option
2372 to True allows DOS semantics and smbd will change the file timestamp as
2376 \f(CW dos filetimes = False\fP
2379 \f(CW dos filetimes = True\fP
2381 .IP "\fBencrypt passwords (G)\fP"
2383 This boolean controls whether encrypted passwords will be negotiated
2384 with the client\&. Note that Windows NT 4\&.0 SP3 and above and also
2385 Windows 98 will by default expect encrypted passwords unless a
2386 registry entry is changed\&. To use encrypted passwords in Samba see the
2387 file ENCRYPTION\&.txt in the Samba documentation directory \f(CWdocs/\fP
2388 shipped with the source code\&.
2390 In order for encrypted passwords to work correctly
2391 \fBsmbd\fP must either have access to a local
2392 \fBsmbpasswd (5)\fP file (see the
2393 \fBsmbpasswd (8)\fP program for information on
2394 how to set up and maintain this file), or set the
2395 \fBsecurity=\fP parameter to either
2397 \fB"domain"\fP which causes
2398 \fBsmbd\fP to authenticate against another server\&.
2400 .IP "\fBexec (S)\fP"
2402 This is a synonym for \fBpreexec\fP\&.
2404 .IP "\fBfake directory create times (S)\fP"
2406 NTFS and Windows VFAT file systems keep a create time for all files
2407 and directories\&. This is not the same as the ctime - status change
2408 time - that Unix keeps, so Samba by default reports the earliest of
2409 the various times Unix does keep\&. Setting this parameter for a share
2410 causes Samba to always report midnight 1-1-1980 as the create time for
2413 This option is mainly used as a compatibility option for Visual C++
2414 when used against Samba shares\&. Visual C++ generated makefiles have
2415 the object directory as a dependency for each object file, and a make
2416 rule to create the directory\&. Also, when NMAKE compares timestamps it
2417 uses the creation time when examining a directory\&. Thus the object
2418 directory will be created if it does not exist, but once it does exist
2419 it will always have an earlier timestamp than the object files it
2422 However, Unix time semantics mean that the create time reported by
2423 Samba will be updated whenever a file is created or deleted in the
2424 directory\&. NMAKE therefore finds all object files in the object
2425 directory bar the last one built are out of date compared to the
2426 directory and rebuilds them\&. Enabling this option ensures directories
2427 always predate their contents and an NMAKE build will proceed as
2431 \f(CW fake directory create times = False\fP
2434 \f(CW fake directory create times = True\fP
2436 .IP "\fBfake oplocks (S)\fP"
2438 Oplocks are the way that SMB clients get permission from a server to
2439 locally cache file operations\&. If a server grants an oplock
2440 (opportunistic lock) then the client is free to assume that it is the
2441 only one accessing the file and it will aggressively cache file
2442 data\&. With some oplock types the client may even cache file open/close
2443 operations\&. This can give enormous performance benefits\&.
2445 When you set \f(CW"fake oplocks = yes"\fP \fBsmbd\fP will
2446 always grant oplock requests no matter how many clients are using the
2449 It is generally much better to use the real \fBoplocks\fP
2450 support rather than this parameter\&.
2452 If you enable this option on all read-only shares or shares that you
2453 know will only be accessed from one client at a time such as
2454 physically read-only media like CDROMs, you will see a big performance
2455 improvement on many operations\&. If you enable this option on shares
2456 where multiple clients may be accessing the files read-write at the
2457 same time you can get data corruption\&. Use this option carefully!
2459 This option is disabled by default\&.
2461 .IP "\fBfollow symlinks (S)\fP"
2463 This parameter allows the Samba administrator to stop
2464 \fBsmbd\fP from following symbolic links in a
2465 particular share\&. Setting this parameter to \fI"No"\fP prevents any file
2466 or directory that is a symbolic link from being followed (the user
2467 will get an error)\&. This option is very useful to stop users from
2468 adding a symbolic link to \f(CW/etc/passwd\fP in their home directory for
2469 instance\&. However it will slow filename lookups down slightly\&.
2471 This option is enabled (i\&.e\&. \fBsmbd\fP will follow
2472 symbolic links) by default\&.
2474 .IP "\fBforce create mode (S)\fP"
2476 This parameter specifies a set of UNIX mode bit permissions that will
2477 \fI*always*\fP be set on a file created by Samba\&. This is done by
2478 bitwise \'OR\'ing these bits onto the mode bits of a file that is being
2479 created\&. The default for this parameter is (in octal) 000\&. The modes
2480 in this parameter are bitwise \'OR\'ed onto the file mode after the mask
2481 set in the \fB"create mask"\fP parameter is applied\&.
2483 See also the parameter \fB"create mask"\fP for details
2484 on masking mode bits on created files\&.
2487 \f(CW force create mode = 000\fP
2490 \f(CW force create mode = 0755\fP
2492 would force all created files to have read and execute permissions set
2493 for \'group\' and \'other\' as well as the read/write/execute bits set for
2496 .IP "\fBforce directory mode (S)\fP"
2498 This parameter specifies a set of UNIX mode bit permissions that will
2499 \fI*always*\fP be set on a directory created by Samba\&. This is done by
2500 bitwise \'OR\'ing these bits onto the mode bits of a directory that is
2501 being created\&. The default for this parameter is (in octal) 0000 which
2502 will not add any extra permission bits to a created directory\&. This
2503 operation is done after the mode mask in the parameter
2504 \fB"directory mask"\fP is applied\&.
2506 See also the parameter \fB"directory mask"\fP for
2507 details on masking mode bits on created directories\&.
2510 \f(CW force directory mode = 000\fP
2513 \f(CW force directory mode = 0755\fP
2515 would force all created directories to have read and execute
2516 permissions set for \'group\' and \'other\' as well as the
2517 read/write/execute bits set for the \'user\'\&.
2519 .IP "\fBforce directory security mode (S)\fP"
2521 This parameter controls what UNIX permission bits can be modified when
2522 a Windows NT client is manipulating the UNIX permission on a directory
2523 using the native NT security dialog box\&.
2525 This parameter is applied as a mask (OR\'ed with) to the changed
2526 permission bits, thus forcing any bits in this mask that the user may
2527 have modified to be on\&. Essentially, one bits in this mask may be
2528 treated as a set of bits that, when modifying security on a directory,
2529 the user has always set to be \'on\'\&.
2531 If not set explicitly this parameter is set to the same value as the
2532 \fBforce directory mode\fP parameter\&. To allow
2533 a user to modify all the user/group/world permissions on a directory,
2534 with restrictions set this parameter to 000\&.
2536 \fINote\fP that users who can access the Samba server through other
2537 means can easily bypass this restriction, so it is primarily
2538 useful for standalone "appliance" systems\&. Administrators of
2539 most normal systems will probably want to set it to 0000\&.
2541 See also the \fBdirectory security mask\fP,
2542 \fBsecurity mask\fP, \fBforce security
2543 mode\fP parameters\&.
2546 \f(CW force directory security mode = <same as force directory mode>\fP
2549 \f(CW force directory security mode = 0\fP
2551 .IP "\fBforce group (S)\fP"
2553 This specifies a UNIX group name that will be assigned as the default
2554 primary group for all users connecting to this service\&. This is useful
2555 for sharing files by ensuring that all access to files on service will
2556 use the named group for their permissions checking\&. Thus, by assigning
2557 permissions for this group to the files and directories within this
2558 service the Samba administrator can restrict or allow sharing of these
2561 In Samba 2\&.0\&.5 and above this parameter has extended functionality in the following
2562 way\&. If the group name listed here has a \'+\' character prepended to it
2563 then the current user accessing the share only has the primary group
2564 default assigned to this group if they are already assigned as a member
2565 of that group\&. This allows an administrator to decide that only users
2566 who are already in a particular group will create files with group
2567 ownership set to that group\&. This gives a finer granularity of ownership
2568 assignment\&. For example, the setting \f(CWforce group = +sys\fP means
2569 that only users who are already in group sys will have their default
2570 primary group assigned to sys when accessing this Samba share\&. All
2571 other users will retain their ordinary primary group\&.
2573 If the \fB"force user"\fP parameter is also set the
2574 group specified in \fBforce group\fP will override the primary group
2575 set in \fB"force user"\fP\&.
2577 See also \fB"force user"\fP
2580 \f(CW no forced group\fP
2583 \f(CW force group = agroup\fP
2585 .IP "\fBforce security mode (S)\fP"
2587 This parameter controls what UNIX permission bits can be modified when
2588 a Windows NT client is manipulating the UNIX permission on a file
2589 using the native NT security dialog box\&.
2591 This parameter is applied as a mask (OR\'ed with) to the changed
2592 permission bits, thus forcing any bits in this mask that the user may
2593 have modified to be on\&. Essentially, one bits in this mask may be
2594 treated as a set of bits that, when modifying security on a file, the
2595 user has always set to be \'on\'\&.
2597 If not set explicitly this parameter is set to the same value as the
2598 \fBforce create mode\fP parameter\&. To allow
2599 a user to modify all the user/group/world permissions on a file,
2600 with no restrictions set this parameter to 000\&.
2602 \fINote\fP that users who can access the Samba server through other
2603 means can easily bypass this restriction, so it is primarily
2604 useful for standalone "appliance" systems\&. Administrators of
2605 most normal systems will probably want to set it to 0000\&.
2607 See also the \fBforce directory security
2608 mode\fP, \fBdirectory security
2609 mask\fP, \fBsecurity mask\fP
2613 \f(CW force security mode = <same as force create mode>\fP
2616 \f(CW force security mode = 0\fP
2618 .IP "\fBforce user (S)\fP"
2620 This specifies a UNIX user name that will be assigned as the default
2621 user for all users connecting to this service\&. This is useful for
2622 sharing files\&. You should also use it carefully as using it
2623 incorrectly can cause security problems\&.
2625 This user name only gets used once a connection is established\&. Thus
2626 clients still need to connect as a valid user and supply a valid
2627 password\&. Once connected, all file operations will be performed as the
2628 \f(CW"forced user"\fP, no matter what username the client connected as\&.
2630 This can be very useful\&.
2632 In Samba 2\&.0\&.5 and above this parameter also causes the primary
2633 group of the forced user to be used as the primary group for all
2634 file activity\&. Prior to 2\&.0\&.5 the primary group was left as the
2635 primary group of the connecting user (this was a bug)\&.
2637 See also \fB"force group"\fP
2640 \f(CW no forced user\fP
2643 \f(CW force user = auser\fP
2645 .IP "\fBfstype (S)\fP"
2647 This parameter allows the administrator to configure the string that
2648 specifies the type of filesystem a share is using that is reported by
2649 \fBsmbd\fP when a client queries the filesystem type
2650 for a share\&. The default type is \fB"NTFS"\fP for compatibility with
2651 Windows NT but this can be changed to other strings such as "Samba" or
2652 "FAT" if required\&.
2655 \f(CW fstype = NTFS\fP
2658 \f(CW fstype = Samba\fP
2660 .IP "\fBgetwd cache (G)\fP"
2662 This is a tuning option\&. When this is enabled a caching algorithm
2663 will be used to reduce the time taken for getwd() calls\&. This can have
2664 a significant impact on performance, especially when the
2665 \fBwidelinks\fP parameter is set to False\&.
2668 \f(CW getwd cache = No\fP
2671 \f(CW getwd cache = Yes\fP
2673 .IP "\fBgroup (S)\fP"
2675 Synonym for \fB"force group"\fP\&.
2677 .IP "\fBguest account (S)\fP"
2679 This is a username which will be used for access to services which are
2680 specified as \fB\'guest ok\'\fP (see below)\&. Whatever
2681 privileges this user has will be available to any client connecting to
2682 the guest service\&. Typically this user will exist in the password
2683 file, but will not have a valid login\&. The user account \fB"ftp"\fP is
2684 often a good choice for this parameter\&. If a username is specified in
2685 a given service, the specified username overrides this one\&.
2687 One some systems the default guest account "nobody" may not be able to
2688 print\&. Use another account in this case\&. You should test this by
2689 trying to log in as your guest user (perhaps by using the \f(CW"su -"\fP
2690 command) and trying to print using the system print command such as
2691 \fBlpr (1)\fP or \fBlp (1)\fP\&.
2694 \f(CW specified at compile time, usually "nobody"\fP
2697 \f(CW guest account = ftp\fP
2699 .IP "\fBguest ok (S)\fP"
2701 If this parameter is \fI\'yes\'\fP for a service, then no password is
2702 required to connect to the service\&. Privileges will be those of the
2703 \fBguest account\fP\&.
2705 See the section below on \fBsecurity\fP for more
2706 information about this option\&.
2709 \f(CW guest ok = no\fP
2712 \f(CW guest ok = yes\fP
2714 .IP "\fBguest only (S)\fP"
2716 If this parameter is \fI\'yes\'\fP for a service, then only guest
2717 connections to the service are permitted\&. This parameter will have no
2718 affect if \fB"guest ok"\fP or \fB"public"\fP
2719 is not set for the service\&.
2721 See the section below on \fBsecurity\fP for more
2722 information about this option\&.
2725 \f(CW guest only = no\fP
2728 \f(CW guest only = yes\fP
2730 .IP "\fBhide dot files (S)\fP"
2732 This is a boolean parameter that controls whether files starting with
2733 a dot appear as hidden files\&.
2736 \f(CW hide dot files = yes\fP
2739 \f(CW hide dot files = no\fP
2741 .IP "\fBhide files(S)\fP"
2743 This is a list of files or directories that are not visible but are
2744 accessible\&. The DOS \'hidden\' attribute is applied to any files or
2745 directories that match\&.
2747 Each entry in the list must be separated by a \f(CW\'/\'\fP, which allows
2748 spaces to be included in the entry\&. \f(CW\'*\'\fP and \f(CW\'?\'\fP can be used
2749 to specify multiple files or directories as in DOS wildcards\&.
2751 Each entry must be a Unix path, not a DOS path and must not include the
2752 Unix directory separator \f(CW\'/\'\fP\&.
2754 Note that the case sensitivity option is applicable in hiding files\&.
2756 Setting this parameter will affect the performance of Samba, as it
2757 will be forced to check all files and directories for a match as they
2760 See also \fB"hide dot files"\fP, \fB"veto
2761 files"\fP and \fB"case sensitive"\fP\&.
2768 No files or directories are hidden by this option (dot files are
2769 hidden by default because of the "hide dot files" option)\&.
2776 \f(CW hide files = /\&.*/DesktopFolderDB/TrashFor%m/resource\&.frk/\fP
2778 The above example is based on files that the Macintosh SMB client
2779 (DAVE) available from \fBThursby\fP creates for
2780 internal use, and also still hides all files beginning with a dot\&.
2782 .IP "\fBhomedir map (G)\fP"
2784 If \fB"nis homedir"\fP is true, and
2785 \fBsmbd\fP is also acting as a Win95/98 \fBlogon
2786 server\fP then this parameter specifies the NIS (or YP)
2787 map from which the server for the user\'s home directory should be
2788 extracted\&. At present, only the Sun auto\&.home map format is
2789 understood\&. The form of the map is:
2791 \f(CWusername server:/some/file/system\fP
2793 and the program will extract the servername from before the first
2794 \f(CW\':\'\fP\&. There should probably be a better parsing system that copes
2795 with different map formats and also Amd (another automounter) maps\&.
2797 NB: A working NIS is required on the system for this option to work\&.
2799 See also \fB"nis homedir"\fP, \fBdomain
2803 \f(CW homedir map = auto\&.home\fP
2806 \f(CW homedir map = amd\&.homedir\fP
2808 .IP "\fBhosts allow (S)\fP"
2810 A synonym for this parameter is \fB\'allow hosts\'\fP
2812 This parameter is a comma, space, or tab delimited set of hosts which
2813 are permitted to access a service\&.
2815 If specified in the \fB[global]\fP section then it will
2816 apply to all services, regardless of whether the individual service
2817 has a different setting\&.
2819 You can specify the hosts by name or IP number\&. For example, you could
2820 restrict access to only the hosts on a Class C subnet with something
2821 like \f(CW"allow hosts = 150\&.203\&.5\&."\fP\&. The full syntax of the list is
2822 described in the man page \fBhosts_access (5)\fP\&. Note that this man
2823 page may not be present on your system, so a brief description will
2824 be given here also\&.
2826 Note that the localhost address 127\&.0\&.0\&.1 will always be allowed
2827 access unless specifically denied by a "hosts deny" option\&.
2829 You can also specify hosts by network/netmask pairs and by netgroup
2830 names if your system supports netgroups\&. The \fIEXCEPT\fP keyword can also
2831 be used to limit a wildcard list\&. The following examples may provide
2834 \fBExample 1\fP: allow all IPs in 150\&.203\&.*\&.* except one
2836 \f(CW hosts allow = 150\&.203\&. EXCEPT 150\&.203\&.6\&.66\fP
2838 \fBExample 2\fP: allow hosts that match the given network/netmask
2840 \f(CW hosts allow = 150\&.203\&.15\&.0/255\&.255\&.255\&.0\fP
2842 \fBExample 3\fP: allow a couple of hosts
2844 \f(CW hosts allow = lapland, arvidsjaur\fP
2846 \fBExample 4\fP: allow only hosts in NIS netgroup "foonet", but
2847 deny access from one particular host
2849 \f(CW hosts allow = @foonet\fP
2851 \f(CW hosts deny = pirate\fP
2853 Note that access still requires suitable user-level passwords\&.
2855 See \fBtestparm (1)\fP for a way of testing your
2856 host access to see if it does what you expect\&.
2859 \f(CW none (i\&.e\&., all hosts permitted access)\fP
2862 \f(CW allow hosts = 150\&.203\&.5\&. myhost\&.mynet\&.edu\&.au\fP
2864 .IP "\fBhosts deny (S)\fP"
2866 The opposite of \fB\'hosts allow\'\fP - hosts listed
2867 here are \fINOT\fP permitted access to services unless the specific
2868 services have their own lists to override this one\&. Where the lists
2869 conflict, the \fB\'allow\'\fP list takes precedence\&.
2872 \f(CW none (i\&.e\&., no hosts specifically excluded)\fP
2875 \f(CW hosts deny = 150\&.203\&.4\&. badhost\&.mynet\&.edu\&.au\fP
2877 .IP "\fBhosts equiv (G)\fP"
2879 If this global parameter is a non-null string, it specifies the name
2880 of a file to read for the names of hosts and users who will be allowed
2881 access without specifying a password\&.
2883 This is not be confused with \fBhosts allow\fP which
2884 is about hosts access to services and is more useful for guest
2885 services\&. \fBhosts equiv\fP may be useful for NT clients which will not
2886 supply passwords to samba\&.
2888 NOTE: The use of \fBhosts equiv\fP can be a major security hole\&. This is
2889 because you are trusting the PC to supply the correct username\&. It is
2890 very easy to get a PC to supply a false username\&. I recommend that the
2891 \fBhosts equiv\fP option be only used if you really know what you are
2892 doing, or perhaps on a home network where you trust your spouse and
2893 kids\&. And only if you \fIreally\fP trust them :-)\&.
2896 \f(CW No host equivalences\fP
2899 \f(CW hosts equiv = /etc/hosts\&.equiv\fP
2901 .IP "\fBinclude (G)\fP"
2903 This allows you to include one config file inside another\&. The file
2904 is included literally, as though typed in place\&.
2906 It takes the standard substitutions, except \fB%u\fP,
2907 \fB%P\fP and \fB%S\fP\&.
2909 .IP "\fBinterfaces (G)\fP"
2911 This option allows you to override the default network interfaces list
2912 that Samba will use for browsing, name registration and other NBT
2913 traffic\&. By default Samba will query the kernel for the list of all
2914 active interfaces and use any interfaces except 127\&.0\&.0\&.1 that are
2915 broadcast capable\&.
2917 The option takes a list of interface strings\&. Each string can be in
2918 any of the following forms:
2921 a network interface name (such as eth0)\&. This may include
2922 shell-like wildcards so eth* will match any interface starting
2923 with the substring "eth"
2924 if() a IP address\&. In this case the netmask is determined
2925 from the list of interfaces obtained from the kernel
2926 if() a IP/mask pair\&.
2927 if() a broadcast/mask pair\&.
2929 The "mask" parameters can either be a bit length (such as 24 for a C
2930 class network) or a full netmask in dotted decmal form\&.
2932 The "IP" parameters above can either be a full dotted decimal IP
2933 address or a hostname which will be looked up via the OSes normal
2934 hostname resolution mechanisms\&.
2936 For example, the following line:
2938 \f(CWinterfaces = eth0 192\&.168\&.2\&.10/24 192\&.168\&.3\&.10/255\&.255\&.255\&.0\fP
2940 would configure three network interfaces corresponding to the eth0
2941 device and IP addresses 192\&.168\&.2\&.10 and 192\&.168\&.3\&.10\&. The netmasks of
2942 the latter two interfaces would be set to 255\&.255\&.255\&.0\&.
2944 See also \fB"bind interfaces only"\fP\&.
2946 .IP "\fBinvalid users (S)\fP"
2948 This is a list of users that should not be allowed to login to this
2949 service\&. This is really a \fI"paranoid"\fP check to absolutely ensure an
2950 improper setting does not breach your security\&.
2952 A name starting with a \f(CW\'@\'\fP is interpreted as an NIS netgroup first
2953 (if your system supports NIS), and then as a UNIX group if the name
2954 was not found in the NIS netgroup database\&.
2956 A name starting with \f(CW\'+\'\fP is interpreted only by looking in the
2957 UNIX group database\&. A name starting with \f(CW\'&\'\fP is interpreted only
2958 by looking in the NIS netgroup database (this requires NIS to be
2959 working on your system)\&. The characters \f(CW\'+\'\fP and \f(CW\'&\'\fP may be
2960 used at the start of the name in either order so the value
2961 \f(CW"+&group"\fP means check the UNIX group database, followed by the NIS
2962 netgroup database, and the value \f(CW"&+group"\fP means check the NIS
2963 netgroup database, followed by the UNIX group database (the same as
2964 the \f(CW\'@\'\fP prefix)\&.
2966 The current servicename is substituted for
2967 \fB%S\fP\&. This is useful in the \fB[homes]\fP
2970 See also \fB"valid users"\fP\&.
2973 \f(CW No invalid users\fP
2976 \f(CW invalid users = root fred admin @wheel\fP
2978 .IP "\fBkeepalive (G)\fP"
2980 The value of the parameter (an integer) represents the number of
2981 seconds between \fB\'keepalive\'\fP packets\&. If this parameter is zero, no
2982 keepalive packets will be sent\&. Keepalive packets, if sent, allow the
2983 server to tell whether a client is still present and responding\&.
2985 Keepalives should, in general, not be needed if the socket being used
2986 has the SO_KEEPALIVE attribute set on it (see \fB"socket
2987 options"\fP)\&. Basically you should only use this option
2988 if you strike difficulties\&.
2991 \f(CW keepalive = 0\fP
2994 \f(CW keepalive = 60\fP
2996 .IP "\fBkernel oplocks (G)\fP"
2998 For UNIXs that support kernel based \fBoplocks\fP
2999 (currently only IRIX but hopefully also Linux and FreeBSD soon) this
3000 parameter allows the use of them to be turned on or off\&.
3002 Kernel oplocks support allows Samba \fBoplocks\fP to be
3003 broken whenever a local UNIX process or NFS operation accesses a file
3004 that \fBsmbd\fP has oplocked\&. This allows complete
3005 data consistency between SMB/CIFS, NFS and local file access (and is a
3006 \fIvery\fP cool feature :-)\&.
3008 This parameter defaults to \fI"On"\fP on systems that have the support,
3009 and \fI"off"\fP on systems that don\'t\&. You should never need to touch
3012 See also the \fB"oplocks"\fP and \fB"level2 oplocks"\fP
3015 .IP "\fBldap filter (G)\fP"
3017 This parameter is part of the \fIEXPERIMENTAL\fP Samba support for a
3018 password database stored on an LDAP server back-end\&. These options
3019 are only available if your version of Samba was configured with
3020 the \fB--with-ldap\fP option\&.
3022 This parameter specifies an LDAP search filter used to search for a
3023 user name in the LDAP database\&. It must contain the string
3024 \fB%u\fP which will be replaced with the user being
3028 \f(CW empty string\&.\fP
3030 .IP "\fBldap port (G)\fP"
3032 This parameter is part of the \fIEXPERIMENTAL\fP Samba support for a
3033 password database stored on an LDAP server back-end\&. These options
3034 are only available if your version of Samba was configured with
3035 the \fB--with-ldap\fP option\&.
3037 This parameter specifies the TCP port number to use to contact
3038 the LDAP server on\&.
3041 \f(CW ldap port = 389\&.\fP
3043 .IP "\fBldap root (G)\fP"
3045 This parameter is part of the \fIEXPERIMENTAL\fP Samba support for a
3046 password database stored on an LDAP server back-end\&. These options
3047 are only available if your version of Samba was configured with
3048 the \fB--with-ldap\fP option\&.
3050 This parameter specifies the entity to bind to the LDAP server
3051 as (essentially the LDAP username) in order to be able to perform
3052 queries and modifications on the LDAP database\&.
3054 See also \fBldap root passwd\fP\&.
3057 \f(CW empty string (no user defined)\fP
3059 .IP "\fBldap root passwd (G)\fP"
3061 This parameter is part of the \fIEXPERIMENTAL\fP Samba support for a
3062 password database stored on an LDAP server back-end\&. These options
3063 are only available if your version of Samba was configured with
3064 the \fB--with-ldap\fP option\&.
3066 This parameter specifies the password for the entity to bind to the
3067 LDAP server as (the password for this LDAP username) in order to be
3068 able to perform queries and modifications on the LDAP database\&.
3070 \fIBUGS:\fP This parameter should \fINOT\fP be a readable parameter
3071 in the \fBsmb\&.conf\fP file and will be removed once a correct
3072 storage place is found\&.
3074 See also \fBldap root\fP\&.
3077 \f(CW empty string\&.\fP
3079 .IP "\fBldap server (G)\fP"
3081 This parameter is part of the \fIEXPERIMENTAL\fP Samba support for a
3082 password database stored on an LDAP server back-end\&. These options
3083 are only available if your version of Samba was configured with
3084 the \fB--with-ldap\fP option\&.
3086 This parameter specifies the DNS name of the LDAP server to use
3087 for SMB/CIFS authentication purposes\&.
3090 \f(CW ldap server = localhost\fP
3092 .IP "\fBldap suffix (G)\fP"
3094 This parameter is part of the \fIEXPERIMENTAL\fP Samba support for a
3095 password database stored on an LDAP server back-end\&. These options
3096 are only available if your version of Samba was configured with
3097 the \fB--with-ldap\fP option\&.
3099 This parameter specifies the \f(CW"dn"\fP or LDAP \fI"distinguished name"\fP
3100 that tells \fBsmbd\fP to start from when searching
3101 for an entry in the LDAP password database\&.
3104 \f(CW empty string\&.\fP
3106 .IP "\fBlevel2 oplocks (S)\fP"
3108 This parameter (new in Samba 2\&.0\&.5) controls whether Samba supports
3109 level2 (read-only) oplocks on a share\&. In Samba 2\&.0\&.4 this parameter
3110 defaults to "False" as the code is new, but will default to "True"
3111 in a later release\&.
3113 Level2, or read-only oplocks allow Windows NT clients that have an
3114 oplock on a file to downgrade from a read-write oplock to a read-only
3115 oplock once a second client opens the file (instead of releasing all
3116 oplocks on a second open, as in traditional, exclusive oplocks)\&. This
3117 allows all openers of the file that support level2 oplocks to cache
3118 the file for read-ahead only (ie\&. they may not cache writes or lock
3119 requests) and increases performance for many acesses of files that
3120 are not commonly written (such as application \&.EXE files)\&.
3122 Once one of the clients which have a read-only oplock writes to
3123 the file all clients are notified (no reply is needed or waited
3124 for) and told to break their oplocks to "none" and delete any
3125 read-ahead caches\&.
3127 It is recommended that this parameter be turned on to speed access
3128 to shared executables (and also to test the code :-)\&.
3130 For more discussions on level2 oplocks see the CIFS spec\&.
3132 Currently, if \fB"kernel oplocks"\fP are supported
3133 then level2 oplocks are not granted (even if this parameter is set
3134 to \f(CW"true"\fP)\&. Note also, the \fB"oplocks"\fP parameter must
3135 be set to "true" on this share in order for this parameter to have any
3138 See also the \fB"oplocks"\fP and \fB"kernel oplocks"\fP parameters\&.
3141 \f(CW level2 oplocks = False\fP
3144 \f(CW level2 oplocks = True\fP
3146 .IP "\fBlm announce (G)\fP"
3148 This parameter determines if \fBnmbd\fP will produce
3149 Lanman announce broadcasts that are needed by \fBOS/2\fP clients in order
3150 for them to see the Samba server in their browse list\&. This parameter
3151 can have three values, \f(CW"true"\fP, \f(CW"false"\fP, or \f(CW"auto"\fP\&. The
3152 default is \f(CW"auto"\fP\&. If set to \f(CW"false"\fP Samba will never produce
3153 these broadcasts\&. If set to \f(CW"true"\fP Samba will produce Lanman
3154 announce broadcasts at a frequency set by the parameter \fB"lm
3155 interval"\fP\&. If set to \f(CW"auto"\fP Samba will not send Lanman
3156 announce broadcasts by default but will listen for them\&. If it hears
3157 such a broadcast on the wire it will then start sending them at a
3158 frequency set by the parameter \fB"lm interval"\fP\&.
3160 See also \fB"lm interval"\fP\&.
3163 \f(CW lm announce = auto\fP
3166 \f(CW lm announce = true\fP
3168 .IP "\fBlm interval (G)\fP"
3170 If Samba is set to produce Lanman announce broadcasts needed by
3171 \fBOS/2\fP clients (see the \fB"lm announce"\fP
3172 parameter) then this parameter defines the frequency in seconds with
3173 which they will be made\&. If this is set to zero then no Lanman
3174 announcements will be made despite the setting of the \fB"lm
3175 announce"\fP parameter\&.
3177 See also \fB"lm announce"\fP\&.
3180 \f(CW lm interval = 60\fP
3183 \f(CW lm interval = 120\fP
3185 .IP "\fBload printers (G)\fP"
3187 A boolean variable that controls whether all printers in the printcap
3188 will be loaded for browsing by default\&. See the
3189 \fB"printers"\fP section for more details\&.
3192 \f(CW load printers = yes\fP
3195 \f(CW load printers = no\fP
3197 .IP "\fBlocal master (G)\fP"
3199 This option allows \fBnmbd\fP to try and become a
3200 local master browser on a subnet\&. If set to False then
3201 \fBnmbd\fP will not attempt to become a local master
3202 browser on a subnet and will also lose in all browsing elections\&. By
3203 default this value is set to true\&. Setting this value to true doesn\'t
3204 mean that Samba will \fIbecome\fP the local master browser on a subnet,
3205 just that \fBnmbd\fP will \fIparticipate\fP in
3206 elections for local master browser\&.
3208 Setting this value to False will cause \fBnmbd\fP
3209 \fInever\fP to become a local master browser\&.
3212 \f(CW local master = yes\fP
3214 .IP "\fBlock dir (G)\fP"
3216 Synonym for \fB"lock directory"\fP\&.
3218 .IP "\fBlock directory (G)\fP"
3220 This option specifies the directory where lock files will be placed\&.
3221 The lock files are used to implement the \fB"max
3222 connections"\fP option\&.
3225 \f(CW lock directory = /tmp/samba\fP
3228 \f(CW lock directory = /usr/local/samba/var/locks\fP
3230 .IP "\fBlocking (S)\fP"
3232 This controls whether or not locking will be performed by the server
3233 in response to lock requests from the client\&.
3235 If \f(CW"locking = no"\fP, all lock and unlock requests will appear to
3236 succeed and all lock queries will indicate that the queried lock is
3239 If \f(CW"locking = yes"\fP, real locking will be performed by the server\&.
3241 This option \fImay\fP be useful for read-only filesystems which \fImay\fP
3242 not need locking (such as cdrom drives), although setting this
3243 parameter of \f(CW"no"\fP is not really recommended even in this case\&.
3245 Be careful about disabling locking either globally or in a specific
3246 service, as lack of locking may result in data corruption\&. You should
3247 never need to set this parameter\&.
3250 \f(CW locking = yes\fP
3253 \f(CW locking = no\fP
3255 .IP "\fBlog file (G)\fP"
3257 This options allows you to override the name of the Samba log file
3258 (also known as the debug file)\&.
3260 This option takes the standard substitutions, allowing you to have
3261 separate log files for each user or machine\&.
3264 \f(CW log file = /usr/local/samba/var/log\&.%m\fP
3266 .IP "\fBlog level (G)\fP"
3268 Synonym for \fB"debug level"\fP\&.
3270 .IP "\fBlogon drive (G)\fP"
3272 This parameter specifies the local path to which the home directory
3273 will be connected (see \fB"logon home"\fP) and is only
3274 used by NT Workstations\&.
3276 Note that this option is only useful if Samba is set up as a
3277 \fBlogon server\fP\&.
3280 \f(CW logon drive = h:\fP
3282 .IP "\fBlogon home (G)\fP"
3284 This parameter specifies the home directory location when a Win95/98 or
3285 NT Workstation logs into a Samba PDC\&. It allows you to do
3287 \f(CW"NET USE H: /HOME"\fP
3289 from a command prompt, for example\&.
3291 This option takes the standard substitutions, allowing you to have
3292 separate logon scripts for each user or machine\&.
3294 Note that this option is only useful if Samba is set up as a
3295 \fBlogon server\fP\&.
3298 \f(CW logon home = "\e\eremote_smb_server\e%U"\fP
3301 \f(CW logon home = "\e\e%N\e%U"\fP
3303 .IP "\fBlogon path (G)\fP"
3305 This parameter specifies the home directory where roaming profiles
3306 (USER\&.DAT / USER\&.MAN files for Windows 95/98) are stored\&.
3308 This option takes the standard substitutions, allowing you to have
3309 separate logon scripts for each user or machine\&. It also specifies
3310 the directory from which the \f(CW"desktop"\fP, \f(CW"start menu"\fP,
3311 \f(CW"network neighborhood"\fP and \f(CW"programs"\fP folders, and their
3312 contents, are loaded and displayed on your Windows 95/98 client\&.
3314 The share and the path must be readable by the user for the
3315 preferences and directories to be loaded onto the Windows 95/98
3316 client\&. The share must be writeable when the logs in for the first
3317 time, in order that the Windows 95/98 client can create the user\&.dat
3318 and other directories\&.
3320 Thereafter, the directories and any of the contents can, if required, be
3321 made read-only\&. It is not advisable that the USER\&.DAT file be made
3322 read-only - rename it to USER\&.MAN to achieve the desired effect (a
3323 \fIMAN\fPdatory profile)\&.
3325 Windows clients can sometimes maintain a connection to the [homes]
3326 share, even though there is no user logged in\&. Therefore, it is vital
3327 that the logon path does not include a reference to the homes share
3328 (i\&.e\&. setting this parameter to \f(CW\e\e%N\eHOMES\eprofile_path\fP will cause
3331 This option takes the standard substitutions, allowing you to have
3332 separate logon scripts for each user or machine\&.
3334 Note that this option is only useful if Samba is set up as a
3335 \fBlogon server\fP\&.
3338 \f(CW logon path = \e\e%N\e%U\eprofile\fP
3341 \f(CW logon path = \e\ePROFILESERVER\eHOME_DIR\e%U\ePROFILE\fP
3343 .IP "\fBlogon script (G)\fP"
3345 This parameter specifies the batch file (\&.bat) or NT command file
3346 (\&.cmd) to be downloaded and run on a machine when a user successfully
3347 logs in\&. The file must contain the DOS style cr/lf line endings\&.
3348 Using a DOS-style editor to create the file is recommended\&.
3350 The script must be a relative path to the \f(CW[netlogon]\fP service\&. If
3351 the \f(CW[netlogon]\fP service specifies a \fBpath\fP of
3352 /usr/local/samba/netlogon, and logon script = STARTUP\&.BAT, then the
3353 file that will be downloaded is:
3355 \f(CW/usr/local/samba/netlogon/STARTUP\&.BAT\fP
3357 The contents of the batch file is entirely your choice\&. A suggested
3358 command would be to add \f(CWNET TIME \e\eSERVER /SET /YES\fP, to force every
3359 machine to synchronize clocks with the same time server\&. Another use
3360 would be to add \f(CWNET USE U: \e\eSERVER\eUTILS\fP for commonly used
3361 utilities, or \f(CWNET USE Q: \e\eSERVER\eISO9001_QA\fP for example\&.
3363 Note that it is particularly important not to allow write access to
3364 the \f(CW[netlogon]\fP share, or to grant users write permission on the
3365 batch files in a secure environment, as this would allow the batch
3366 files to be arbitrarily modified and security to be breached\&.
3368 This option takes the standard substitutions, allowing you to have
3369 separate logon scripts for each user or machine\&.
3371 Note that this option is only useful if Samba is set up as a
3372 \fBlogon server\fP\&.
3375 \f(CW logon script = scripts\e%U\&.bat\fP
3377 .IP "\fBlppause command (S)\fP"
3379 This parameter specifies the command to be executed on the server host
3380 in order to stop printing or spooling a specific print job\&.
3382 This command should be a program or script which takes a printer name
3383 and job number to pause the print job\&. One way of implementing this is
3384 by using job priorities, where jobs having a too low priority won\'t be
3385 sent to the printer\&.
3387 If a \f(CW"%p"\fP is given then the printername is put in its place\&. A
3388 \f(CW"%j"\fP is replaced with the job number (an integer)\&. On HPUX (see
3389 \fBprinting=hpux\fP), if the \f(CW"-p%p"\fP option is added
3390 to the lpq command, the job will show up with the correct status,
3391 i\&.e\&. if the job priority is lower than the set fence priority it will
3392 have the PAUSED status, whereas if the priority is equal or higher it
3393 will have the SPOOLED or PRINTING status\&.
3395 Note that it is good practice to include the absolute path in the
3396 lppause command as the PATH may not be available to the server\&.
3398 See also the \fB"printing"\fP parameter\&.
3401 Currently no default value is given to this string, unless the
3402 value of the \fB"printing"\fP parameter is \f(CWSYSV\fP, in
3403 which case the default is :
3405 \f(CW lp -i %p-%j -H hold\fP
3407 or if the value of the \fB"printing"\fP parameter is \f(CWsoftq\fP,
3408 then the default is:
3410 \f(CW qstat -s -j%j -h\fP
3412 \fBExample for HPUX:\fP
3413 lppause command = /usr/bin/lpalt %p-%j -p0
3415 .IP "\fBlpq cache time (G)\fP"
3417 This controls how long lpq info will be cached for to prevent the
3418 \fBlpq\fP command being called too often\&. A separate cache is kept for
3419 each variation of the \fBlpq\fP command used by the system, so if you
3420 use different \fBlpq\fP commands for different users then they won\'t
3421 share cache information\&.
3423 The cache files are stored in \f(CW/tmp/lpq\&.xxxx\fP where xxxx is a hash of
3424 the \fBlpq\fP command in use\&.
3426 The default is 10 seconds, meaning that the cached results of a
3427 previous identical \fBlpq\fP command will be used if the cached data is
3428 less than 10 seconds old\&. A large value may be advisable if your
3429 \fBlpq\fP command is very slow\&.
3431 A value of 0 will disable caching completely\&.
3433 See also the \fB"printing"\fP parameter\&.
3436 \f(CW lpq cache time = 10\fP
3439 \f(CW lpq cache time = 30\fP
3441 .IP "\fBlpq command (S)\fP"
3443 This parameter specifies the command to be executed on the server host
3444 in order to obtain \f(CW"lpq"\fP-style printer status information\&.
3446 This command should be a program or script which takes a printer name
3447 as its only parameter and outputs printer status information\&.
3449 Currently eight styles of printer status information are supported;
3450 BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX and SOFTQ\&. This covers most UNIX
3451 systems\&. You control which type is expected using the
3452 \fB"printing ="\fP option\&.
3454 Some clients (notably Windows for Workgroups) may not correctly send
3455 the connection number for the printer they are requesting status
3456 information about\&. To get around this, the server reports on the first
3457 printer service connected to by the client\&. This only happens if the
3458 connection number sent is invalid\&.
3460 If a \f(CW%p\fP is given then the printername is put in its place\&. Otherwise
3461 it is placed at the end of the command\&.
3463 Note that it is good practice to include the absolute path in the \fBlpq
3464 command\fP as the PATH may not be available to the server\&.
3466 See also the \fB"printing"\fP parameter\&.
3469 \f(CW depends on the setting of printing =\fP
3472 \f(CW lpq command = /usr/bin/lpq %p\fP
3474 .IP "\fBlpresume command (S)\fP"
3476 This parameter specifies the command to be executed on the server host
3477 in order to restart or continue printing or spooling a specific print
3480 This command should be a program or script which takes a printer name
3481 and job number to resume the print job\&. See also the \fB"lppause
3482 command"\fP parameter\&.
3484 If a \f(CW%p\fP is given then the printername is put in its place\&. A
3485 \f(CW%j\fP is replaced with the job number (an integer)\&.
3487 Note that it is good practice to include the absolute path in the \fBlpresume
3488 command\fP as the PATH may not be available to the server\&.
3490 See also the \fB"printing"\fP parameter\&.
3494 Currently no default value is given to this string, unless the
3495 value of the \fB"printing"\fP parameter is \f(CWSYSV\fP, in
3496 which case the default is :
3498 \f(CW lp -i %p-%j -H resume\fP
3500 or if the value of the \fB"printing"\fP parameter is \f(CWsoftq\fP,
3501 then the default is:
3503 \f(CW qstat -s -j%j -r\fP
3505 \fBExample for HPUX:\fP
3506 \f(CW lpresume command = /usr/bin/lpalt %p-%j -p2\fP
3508 .IP "\fBlprm command (S)\fP"
3510 This parameter specifies the command to be executed on the server host
3511 in order to delete a print job\&.
3513 This command should be a program or script which takes a printer name
3514 and job number, and deletes the print job\&.
3516 If a \f(CW%p\fP is given then the printername is put in its place\&. A
3517 \f(CW%j\fP is replaced with the job number (an integer)\&.
3519 Note that it is good practice to include the absolute path in the
3520 \fBlprm command\fP as the PATH may not be available to the server\&.
3522 See also the \fB"printing"\fP parameter\&.
3525 \f(CW depends on the setting of "printing ="\fP
3528 \f(CW lprm command = /usr/bin/lprm -P%p %j\fP
3531 \f(CW lprm command = /usr/bin/cancel %p-%j\fP
3533 .IP "\fBmachine password timeout (G)\fP"
3535 If a Samba server is a member of an Windows NT Domain (see the
3536 \fB"security=domain"\fP) parameter) then
3537 periodically a running \fBsmbd\fP process will try and
3538 change the \fBMACHINE ACCOUNT PASWORD\fP stored in the file called
3539 \f(CW<Domain>\&.<Machine>\&.mac\fP where \f(CW<Domain>\fP is the name of the
3540 Domain we are a member of and \f(CW<Machine>\fP is the primary
3541 \fB"NetBIOS name"\fP of the machine
3542 \fBsmbd\fP is running on\&. This parameter specifies how
3543 often this password will be changed, in seconds\&. The default is one
3544 week (expressed in seconds), the same as a Windows NT Domain member
3547 See also \fBsmbpasswd (8)\fP, and the
3548 \fB"security=domain"\fP) parameter\&.
3551 \f(CW machine password timeout = 604800\fP
3553 .IP "\fBmagic output (S)\fP"
3555 This parameter specifies the name of a file which will contain output
3556 created by a magic script (see the \fB"magic
3557 script"\fP parameter below)\&.
3559 Warning: If two clients use the same \fB"magic
3560 script"\fP in the same directory the output file content
3564 \f(CW magic output = <magic script name>\&.out\fP
3567 \f(CW magic output = myfile\&.txt\fP
3569 .IP "\fBmagic script (S)\fP"
3571 This parameter specifies the name of a file which, if opened, will be
3572 executed by the server when the file is closed\&. This allows a UNIX
3573 script to be sent to the Samba host and executed on behalf of the
3576 Scripts executed in this way will be deleted upon completion,
3577 permissions permitting\&.
3579 If the script generates output, output will be sent to the file
3580 specified by the \fB"magic output"\fP parameter (see
3583 Note that some shells are unable to interpret scripts containing
3584 carriage-return-linefeed instead of linefeed as the end-of-line
3585 marker\&. Magic scripts must be executable \fI"as is"\fP on the host,
3586 which for some hosts and some shells will require filtering at the DOS
3589 Magic scripts are \fIEXPERIMENTAL\fP and should \fINOT\fP be relied upon\&.
3592 \f(CW None\&. Magic scripts disabled\&.\fP
3595 \f(CW magic script = user\&.csh\fP
3597 .IP "\fBmangle case (S)\fP"
3599 See the section on \fB"NAME MANGLING"\fP\&.
3601 .IP "\fBmangle locks (S)\fP"
3603 This option is was introduced with Samba 2\&.0\&.4 and above and has been
3604 removed in Samba 2\&.0\&.6 as Samba now dynamically configures such things
3605 on 32 bit systems\&.
3607 .IP "\fBmangled map (S)\fP"
3609 This is for those who want to directly map UNIX file names which can
3610 not be represented on Windows/DOS\&. The mangling of names is not always
3611 what is needed\&. In particular you may have documents with file
3612 extensions that differ between DOS and UNIX\&. For example, under UNIX
3613 it is common to use \f(CW"\&.html"\fP for HTML files, whereas under
3614 Windows/DOS \f(CW"\&.htm"\fP is more commonly used\&.
3616 So to map \f(CW"html"\fP to \f(CW"htm"\fP you would use:
3618 \f(CW mangled map = (*\&.html *\&.htm)\fP
3620 One very useful case is to remove the annoying \f(CW";1"\fP off the ends
3621 of filenames on some CDROMS (only visible under some UNIXs)\&. To do
3622 this use a map of (*;1 *)\&.
3625 \f(CW no mangled map\fP
3628 \f(CW mangled map = (*;1 *)\fP
3630 .IP "\fBmangled names (S)\fP"
3632 This controls whether non-DOS names under UNIX should be mapped to
3633 DOS-compatible names ("mangled") and made visible, or whether non-DOS
3634 names should simply be ignored\&.
3636 See the section on \fB"NAME MANGLING"\fP for details
3637 on how to control the mangling process\&.
3639 If mangling is used then the mangling algorithm is as follows:
3643 The first (up to) five alphanumeric characters before the
3644 rightmost dot of the filename are preserved, forced to upper case, and
3645 appear as the first (up to) five characters of the mangled name\&.
3648 A tilde \f(CW"~"\fP is appended to the first part of the mangled
3649 name, followed by a two-character unique sequence, based on the
3650 original root name (i\&.e\&., the original filename minus its final
3651 extension)\&. The final extension is included in the hash calculation
3652 only if it contains any upper case characters or is longer than three
3655 Note that the character to use may be specified using the
3656 \fB"mangling char"\fP option, if you don\'t like
3660 The first three alphanumeric characters of the final extension
3661 are preserved, forced to upper case and appear as the extension of the
3662 mangled name\&. The final extension is defined as that part of the
3663 original filename after the rightmost dot\&. If there are no dots in the
3664 filename, the mangled name will have no extension (except in the case
3665 of \fB"hidden files"\fP - see below)\&.
3668 Files whose UNIX name begins with a dot will be presented as DOS
3669 hidden files\&. The mangled name will be created as for other filenames,
3670 but with the leading dot removed and \f(CW"___"\fP as its extension regardless
3671 of actual original extension (that\'s three underscores)\&.
3674 The two-digit hash value consists of upper case alphanumeric
3677 This algorithm can cause name collisions only if files in a directory
3678 share the same first five alphanumeric characters\&. The probability of
3679 such a clash is 1/1300\&.
3681 The name mangling (if enabled) allows a file to be copied between UNIX
3682 directories from Windows/DOS while retaining the long UNIX
3683 filename\&. UNIX files can be renamed to a new extension from
3684 Windows/DOS and will retain the same basename\&. Mangled names do not
3685 change between sessions\&.
3688 \f(CW mangled names = yes\fP
3691 \f(CW mangled names = no\fP
3693 .IP "\fBmangling char (S)\fP"
3695 This controls what character is used as the \fI"magic"\fP character in
3696 \fBname mangling\fP\&. The default is a \f(CW\'~\'\fP but
3697 this may interfere with some software\&. Use this option to set it to
3698 whatever you prefer\&.
3701 \f(CW mangling char = ~\fP
3704 \f(CW mangling char = ^\fP
3706 .IP "\fBmangled stack (G)\fP"
3708 This parameter controls the number of mangled names that should be
3709 cached in the Samba server \fBsmbd\fP\&.
3711 This stack is a list of recently mangled base names (extensions are
3712 only maintained if they are longer than 3 characters or contains upper
3715 The larger this value, the more likely it is that mangled names can be
3716 successfully converted to correct long UNIX names\&. However, large
3717 stack sizes will slow most directory access\&. Smaller stacks save
3718 memory in the server (each stack element costs 256 bytes)\&.
3720 It is not possible to absolutely guarantee correct long file names, so
3721 be prepared for some surprises!
3724 \f(CW mangled stack = 50\fP
3727 \f(CW mangled stack = 100\fP
3729 .IP "\fBmap archive (S)\fP"
3731 This controls whether the DOS archive attribute should be mapped to
3732 the UNIX owner execute bit\&. The DOS archive bit is set when a file
3733 has been modified since its last backup\&. One motivation for this
3734 option it to keep Samba/your PC from making any file it touches from
3735 becoming executable under UNIX\&. This can be quite annoying for shared
3736 source code, documents, etc\&.\&.\&.
3738 Note that this requires the \fB"create mask"\fP
3739 parameter to be set such that owner execute bit is not masked out
3740 (i\&.e\&. it must include 100)\&. See the parameter \fB"create
3741 mask"\fP for details\&.
3744 \f(CW map archive = yes\fP
3747 \f(CW map archive = no\fP
3749 .IP "\fBmap hidden (S)\fP"
3751 This controls whether DOS style hidden files should be mapped to the
3752 UNIX world execute bit\&.
3754 Note that this requires the \fB"create mask"\fP to be
3755 set such that the world execute bit is not masked out (i\&.e\&. it must
3756 include 001)\&. See the parameter \fB"create mask"\fP
3760 \f(CW map hidden = no\fP
3763 \f(CW map hidden = yes\fP
3765 .IP "\fBmap system (S)\fP"
3767 This controls whether DOS style system files should be mapped to the
3768 UNIX group execute bit\&.
3770 Note that this requires the \fB"create mask"\fP to be
3771 set such that the group execute bit is not masked out (i\&.e\&. it must
3772 include 010)\&. See the parameter \fB"create mask"\fP
3776 \f(CW map system = no\fP
3779 \f(CW map system = yes\fP
3781 .IP "\fBmap to guest (G)\fP"
3783 This parameter is only useful in \fBsecurity\fP modes
3784 other than \fB"security=share"\fP - i\&.e\&. user,
3785 server, and domain\&.
3787 This parameter can take three different values, which tell
3788 \fBsmbd\fP what to do with user login requests that
3789 don\'t match a valid UNIX user in some way\&.
3791 The three settings are :
3795 \fB"Never"\fP - Means user login requests with an invalid password
3796 are rejected\&. This is the default\&.
3799 \fB"Bad User"\fP - Means user logins with an invalid password are
3800 rejected, unless the username does not exist, in which case it is
3801 treated as a guest login and mapped into the \fB"guest
3805 \fB"Bad Password"\fP - Means user logins with an invalid
3806 password are treated as a guest login and mapped into the
3807 \fB"guest account"\fP\&. Note that this can
3808 cause problems as it means that any user incorrectly typing their
3809 password will be silently logged on a \fB"guest"\fP - and
3810 will not know the reason they cannot access files they think
3811 they should - there will have been no message given to them
3812 that they got their password wrong\&. Helpdesk services will
3813 \fI*hate*\fP you if you set the \fB"map to guest"\fP parameter
3817 Note that this parameter is needed to set up \fB"Guest"\fP share
3818 services when using \fBsecurity\fP modes other than
3819 share\&. This is because in these modes the name of the resource being
3820 requested is \fI*not*\fP sent to the server until after the server has
3821 successfully authenticated the client so the server cannot make
3822 authentication decisions at the correct time (connection to the
3823 share) for \fB"Guest"\fP shares\&.
3825 For people familiar with the older Samba releases, this parameter
3826 maps to the old compile-time setting of the GUEST_SESSSETUP value
3830 \f(CW map to guest = Never\fP
3832 \f(CW map to guest = Bad User\fP
3834 .IP "\fBmax connections (S)\fP"
3836 This option allows the number of simultaneous connections to a service
3837 to be limited\&. If \fB"max connections"\fP is greater than 0 then
3838 connections will be refused if this number of connections to the
3839 service are already open\&. A value of zero mean an unlimited number of
3840 connections may be made\&.
3842 Record lock files are used to implement this feature\&. The lock files
3843 will be stored in the directory specified by the \fB"lock
3844 directory"\fP option\&.
3847 \f(CW max connections = 0\fP
3850 \f(CW max connections = 10\fP
3852 .IP "\fBmax disk size (G)\fP"
3854 This option allows you to put an upper limit on the apparent size of
3855 disks\&. If you set this option to 100 then all shares will appear to be
3856 not larger than 100 MB in size\&.
3858 Note that this option does not limit the amount of data you can put on
3859 the disk\&. In the above case you could still store much more than 100
3860 MB on the disk, but if a client ever asks for the amount of free disk
3861 space or the total disk size then the result will be bounded by the
3862 amount specified in \fB"max disk size"\fP\&.
3864 This option is primarily useful to work around bugs in some pieces of
3865 software that can\'t handle very large disks, particularly disks over
3868 A \fB"max disk size"\fP of 0 means no limit\&.
3871 \f(CW max disk size = 0\fP
3874 \f(CW max disk size = 1000\fP
3876 .IP "\fBmax log size (G)\fP"
3878 This option (an integer in kilobytes) specifies the max size the log
3879 file should grow to\&. Samba periodically checks the size and if it is
3880 exceeded it will rename the file, adding a \f(CW"\&.old"\fP extension\&.
3882 A size of 0 means no limit\&.
3885 \f(CW max log size = 5000\fP
3888 \f(CW max log size = 1000\fP
3890 .IP "\fBmax mux (G)\fP"
3892 This option controls the maximum number of outstanding simultaneous
3893 SMB operations that samba tells the client it will allow\&. You should
3894 never need to set this parameter\&.
3897 \f(CW max mux = 50\fP
3899 .IP "\fBmax open files (G)\fP"
3901 This parameter limits the maximum number of open files that one
3902 \fBsmbd\fP file serving process may have open for
3903 a client at any one time\&. The default for this parameter is set
3904 very high (10,000) as Samba uses only one bit per unopened file\&.
3906 The limit of the number of open files is usually set by the
3907 UNIX per-process file descriptor limit rather than this parameter
3908 so you should never need to touch this parameter\&.
3911 \f(CW max open files = 10000\fP
3913 .IP "\fBmax packet (G)\fP"
3915 Synonym for (packetsize)\&.
3917 .IP "\fBmax ttl (G)\fP"
3919 This option tells \fBnmbd\fP what the default \'time
3920 to live\' of NetBIOS names should be (in seconds) when
3921 \fBnmbd\fP is requesting a name using either a
3922 broadcast packet or from a WINS server\&. You should never need to
3923 change this parameter\&. The default is 3 days\&.
3926 \f(CW max ttl = 259200\fP
3928 .IP "\fBmax wins ttl (G)\fP"
3930 This option tells \fBnmbd\fP when acting as a WINS
3931 server \fB(wins support =true)\fP what the maximum
3932 \'time to live\' of NetBIOS names that \fBnmbd\fP will
3933 grant will be (in seconds)\&. You should never need to change this
3934 parameter\&. The default is 6 days (518400 seconds)\&.
3936 See also the \fB"min wins ttl"\fP parameter\&.
3939 \f(CW max wins ttl = 518400\fP
3941 .IP "\fBmax xmit (G)\fP"
3943 This option controls the maximum packet size that will be negotiated
3944 by Samba\&. The default is 65535, which is the maximum\&. In some cases
3945 you may find you get better performance with a smaller value\&. A value
3946 below 2048 is likely to cause problems\&.
3949 \f(CW max xmit = 65535\fP
3952 \f(CW max xmit = 8192\fP
3954 .IP "\fBmessage command (G)\fP"
3956 This specifies what command to run when the server receives a WinPopup
3959 This would normally be a command that would deliver the message
3960 somehow\&. How this is to be done is up to your imagination\&.
3964 \f(CW message command = csh -c \'xedit %s;rm %s\' &\fP
3966 This delivers the message using \fBxedit\fP, then removes it
3967 afterwards\&. \fINOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN
3968 IMMEDIATELY\fP\&. That\'s why I have the \f(CW\'&\'\fP on the end\&. If it doesn\'t
3969 return immediately then your PCs may freeze when sending messages
3970 (they should recover after 30secs, hopefully)\&.
3972 All messages are delivered as the global guest user\&. The command takes
3973 the standard substitutions, although \fB%u\fP won\'t work
3974 (\fB%U\fP may be better in this case)\&.
3976 Apart from the standard substitutions, some additional ones apply\&. In
3981 \f(CW"%s"\fP = the filename containing the message\&.
3984 \f(CW"%t"\fP = the destination that the message was sent to (probably the server
3988 \f(CW"%f"\fP = who the message is from\&.
3991 You could make this command send mail, or whatever else takes your
3992 fancy\&. Please let us know of any really interesting ideas you have\&.
3994 Here\'s a way of sending the messages as mail to root:
3996 \f(CWmessage command = /bin/mail -s \'message from %f on %m\' root < %s; rm %s\fP
3998 If you don\'t have a message command then the message won\'t be
3999 delivered and Samba will tell the sender there was an
4000 error\&. Unfortunately WfWg totally ignores the error code and carries
4001 on regardless, saying that the message was delivered\&.
4003 If you want to silently delete it then try:
4005 \f(CW"message command = rm %s"\fP\&.
4008 \f(CW no message command\fP
4011 \f(CW message command = csh -c \'xedit %s;rm %s\' &\fP
4013 .IP "\fBmin print space (S)\fP"
4015 This sets the minimum amount of free disk space that must be available
4016 before a user will be able to spool a print job\&. It is specified in
4017 kilobytes\&. The default is 0, which means a user can always spool a print
4020 See also the \fBprinting\fP parameter\&.
4023 \f(CW min print space = 0\fP
4026 \f(CW min print space = 2000\fP
4028 .IP "\fBmin passwd length (G)\fP"
4030 This option sets the minimum length in characters of a plaintext password
4031 than smbd will accept when performing UNIX password changing\&.
4033 See also \fB"unix password sync"\fP,
4034 \fB"passwd program"\fP and \fB"passwd chat
4038 \f(CW min passwd length = 5\fP
4040 .IP "\fBmin wins ttl (G)\fP"
4042 This option tells \fBnmbd\fP when acting as a WINS
4043 server \fB(wins support = true)\fP what the minimum
4044 \'time to live\' of NetBIOS names that \fBnmbd\fP will
4045 grant will be (in seconds)\&. You should never need to change this
4046 parameter\&. The default is 6 hours (21600 seconds)\&.
4049 \f(CW min wins ttl = 21600\fP
4051 .IP "\fBname resolve order (G)\fP"
4053 This option is used by the programs in the Samba suite to determine
4054 what naming services and in what order to resolve host names to IP
4055 addresses\&. The option takes a space separated string of different name
4056 resolution options\&.
4058 The options are :"lmhosts", "host", "wins" and "bcast"\&. They cause
4059 names to be resolved as follows :
4063 \fBlmhosts\fP : Lookup an IP address in the Samba lmhosts file\&.
4064 If the line in lmhosts has no name type attached to the NetBIOS
4065 name (see the \fBlmhosts (5)\fP for details) then
4066 any name type matches for lookup\&.
4069 \fBhost\fP : Do a standard host name to IP address resolution,
4070 using the system /etc/hosts, NIS, or DNS lookups\&. This method of name
4071 resolution is operating system depended for instance on IRIX or
4072 Solaris this may be controlled by the \fI/etc/nsswitch\&.conf\fP file)\&.
4073 Note that this method is only used if the NetBIOS name type being
4074 queried is the 0x20 (server) name type, otherwise it is ignored\&.
4077 \fBwins\fP : Query a name with the IP address listed in the
4078 \fBwins server\fP parameter\&. If no WINS server has
4079 been specified this method will be ignored\&.
4082 \fBbcast\fP : Do a broadcast on each of the known local interfaces
4083 listed in the \fBinterfaces\fP parameter\&. This is the
4084 least reliable of the name resolution methods as it depends on the
4085 target host being on a locally connected subnet\&.
4089 \f(CW name resolve order = lmhosts host wins bcast\fP
4092 \f(CW name resolve order = lmhosts bcast host\fP
4094 This will cause the local lmhosts file to be examined first, followed
4095 by a broadcast attempt, followed by a normal system hostname lookup\&.
4097 .IP "\fBnetbios aliases (G)\fP"
4099 This is a list of NetBIOS names that \fBnmbd\fP will
4100 advertise as additional names by which the Samba server is known\&. This
4101 allows one machine to appear in browse lists under multiple names\&. If
4102 a machine is acting as a \fBbrowse server\fP or
4103 \fBlogon server\fP none of these names will be
4104 advertised as either browse server or logon servers, only the primary
4105 name of the machine will be advertised with these capabilities\&.
4107 See also \fB"netbios name"\fP\&.
4110 \f(CW empty string (no additional names)\fP
4113 \f(CW netbios aliases = TEST TEST1 TEST2\fP
4115 .IP "\fBnetbios name (G)\fP"
4117 This sets the NetBIOS name by which a Samba server is known\&. By
4118 default it is the same as the first component of the host\'s DNS name\&.
4119 If a machine is a \fBbrowse server\fP or
4120 \fBlogon server\fP this name (or the first component
4121 of the hosts DNS name) will be the name that these services are
4124 See also \fB"netbios aliases"\fP\&.
4127 \f(CW Machine DNS name\&.\fP
4130 \f(CW netbios name = MYNAME\fP
4132 .IP "\fBnis homedir (G)\fP"
4134 Get the home share server from a NIS map\&. For UNIX systems that use an
4135 automounter, the user\'s home directory will often be mounted on a
4136 workstation on demand from a remote server\&.
4138 When the Samba logon server is not the actual home directory server,
4139 but is mounting the home directories via NFS then two network hops
4140 would be required to access the users home directory if the logon
4141 server told the client to use itself as the SMB server for home
4142 directories (one over SMB and one over NFS)\&. This can be very
4145 This option allows Samba to return the home share as being on a
4146 different server to the logon server and as long as a Samba daemon is
4147 running on the home directory server, it will be mounted on the Samba
4148 client directly from the directory server\&. When Samba is returning the
4149 home share to the client, it will consult the NIS map specified in
4150 \fB"homedir map"\fP and return the server listed
4153 Note that for this option to work there must be a working NIS
4154 system and the Samba server with this option must also be a
4155 \fBlogon server\fP\&.
4158 \f(CW nis homedir = false\fP
4161 \f(CW nis homedir = true\fP
4163 .IP "\fBnt acl support (G)\fP"
4165 This boolean parameter controls whether \fBsmbd\fP
4166 will attempt to map UNIX permissions into Windows NT access control lists\&.
4169 \f(CW nt acl support = yes\fP
4172 \f(CW nt acl support = no\fP
4174 .IP "\fBnt pipe support (G)\fP"
4176 This boolean parameter controls whether \fBsmbd\fP
4177 will allow Windows NT clients to connect to the NT SMB specific
4178 \f(CWIPC$\fP pipes\&. This is a developer debugging option and can be left
4182 \f(CW nt pipe support = yes\fP
4184 .IP "\fBnt smb support (G)\fP"
4186 This boolean parameter controls whether \fBsmbd\fP
4187 will negotiate NT specific SMB support with Windows NT
4188 clients\&. Although this is a developer debugging option and should be
4189 left alone, benchmarking has discovered that Windows NT clients give
4190 faster performance with this option set to \f(CW"no"\fP\&. This is still
4191 being investigated\&. If this option is set to \f(CW"no"\fP then Samba
4192 offers exactly the same SMB calls that versions prior to Samba2\&.0
4193 offered\&. This information may be of use if any users are having
4194 problems with NT SMB support\&.
4197 \f(CW nt support = yes\fP
4199 .IP "\fBnull passwords (G)\fP"
4201 Allow or disallow client access to accounts that have null passwords\&.
4203 See also \fBsmbpasswd (5)\fP\&.
4206 \f(CW null passwords = no\fP
4209 \f(CW null passwords = yes\fP
4211 .IP "\fBole locking compatibility (G)\fP"
4213 This parameter allows an administrator to turn off the byte range lock
4214 manipulation that is done within Samba to give compatibility for OLE
4215 applications\&. Windows OLE applications use byte range locking as a
4216 form of inter-process communication, by locking ranges of bytes around
4217 the 2^32 region of a file range\&. This can cause certain UNIX lock
4218 managers to crash or otherwise cause problems\&. Setting this parameter
4219 to \f(CW"no"\fP means you trust your UNIX lock manager to handle such cases
4223 \f(CW ole locking compatibility = yes\fP
4226 \f(CW ole locking compatibility = no\fP
4228 .IP "\fBonly guest (S)\fP"
4230 A synonym for \fB"guest only"\fP\&.
4232 .IP "\fBonly user (S)\fP"
4234 This is a boolean option that controls whether connections with
4235 usernames not in the \fBuser=\fP list will be allowed\&. By
4236 default this option is disabled so a client can supply a username to
4237 be used by the server\&.
4239 Note that this also means Samba won\'t try to deduce usernames from the
4240 service name\&. This can be annoying for the \fB[homes]\fP
4241 section\&. To get around this you could use "\fBuser\fP =
4242 \fB%S\fP" which means your \fB"user"\fP list
4243 will be just the service name, which for home directories is the name
4246 See also the \fBuser\fP parameter\&.
4249 \f(CW only user = False\fP
4252 \f(CW only user = True\fP
4254 .IP "\fBoplocks (S)\fP"
4256 This boolean option tells smbd whether to issue oplocks (opportunistic
4257 locks) to file open requests on this share\&. The oplock code can
4258 dramatically (approx\&. 30% or more) improve the speed of access to files
4259 on Samba servers\&. It allows the clients to aggressively cache files
4260 locally and you may want to disable this option for unreliable network
4261 environments (it is turned on by default in Windows NT Servers)\&. For
4262 more information see the file Speed\&.txt in the Samba docs/ directory\&.
4264 Oplocks may be selectively turned off on certain files on a per share basis\&.
4265 See the \'veto oplock files\' parameter\&. On some systems oplocks are recognized
4266 by the underlying operating system\&. This allows data synchronization between
4267 all access to oplocked files, whether it be via Samba or NFS or a local
4268 UNIX process\&. See the \fBkernel oplocks\fP parameter
4271 See also the \fB"kernel oplocks"\fP and
4272 \fB"level2 oplocks"\fP parameters\&.
4275 \f(CW oplocks = True\fP
4278 \f(CW oplocks = False\fP
4280 .IP "\fBoplock break wait time (G)\fP"
4282 This is a tuning parameter added due to bugs in both Windows 9x and WinNT\&.
4283 If Samba responds to a client too quickly when that client issues an SMB that
4284 can cause an oplock break request, then the client redirector can fail and
4285 not respond to the break request\&. This tuning parameter (which is set in
4286 milliseconds) is the amount of time Samba will wait before sending an
4287 oplock break request to such (broken) clients\&.
4289 \fIDO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA
4293 \f(CW oplock break wait time = 10\fP
4295 .IP "\fBoplock contention limit (S)\fP"
4297 This is a \fIvery\fP advanced \fBsmbd\fP tuning option to improve
4298 the efficiency of the granting of oplocks under multiple client contention for the same file\&.
4300 In brief it specifies a number, which causes smbd not to grant an oplock even
4301 when requested if the approximate number of clients contending for an oplock on
4302 the same file goes over this limit\&. This causes \fBsmbd\fP to
4303 behave in a similar way to Windows NT\&.
4305 \fIDO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA
4309 \f(CW oplock contention limit = 2\fP
4311 .IP "\fBos level (G)\fP"
4313 This integer value controls what level Samba advertises itself as for
4314 browse elections\&. The value of this parameter determines whether
4315 \fBnmbd\fP has a chance of becoming a local master
4316 browser for the \fBWORKGROUP\fP in the local broadcast
4317 area\&. The default is zero, which means \fBnmbd\fP will
4318 lose elections to Windows machines\&. See BROWSING\&.txt in the Samba
4319 docs/ directory for details\&.
4322 \f(CW os level = 20\fP
4325 \f(CW os level = 65 ; This will win against any NT Server\fP
4327 .IP "\fBpacket size (G)\fP"
4329 This is a deprecated parameter that how no effect on the current
4330 Samba code\&. It is left in the parameter list to prevent breaking
4331 old \fBsmb\&.conf\fP files\&.
4333 .IP "\fBpanic action (G)\fP"
4335 This is a Samba developer option that allows a system command to be
4336 called when either \fBsmbd\fP or
4337 \fBnmbd\fP crashes\&. This is usually used to draw
4338 attention to the fact that a problem occurred\&.
4341 \f(CW panic action = <empty string>\fP
4343 .IP "\fBpasswd chat (G)\fP"
4345 This string controls the \fI"chat"\fP conversation that takes places
4346 between \fBsmbd\fP and the local password changing
4347 program to change the users password\&. The string describes a sequence
4348 of response-receive pairs that \fBsmbd\fP uses to
4349 determine what to send to the \fBpasswd\fP program
4350 and what to expect back\&. If the expected output is not received then
4351 the password is not changed\&.
4353 This chat sequence is often quite site specific, depending on what
4354 local methods are used for password control (such as NIS etc)\&.
4356 The string can contain the macros \f(CW"%o"\fP and \f(CW"%n"\fP which are
4357 substituted for the old and new passwords respectively\&. It can also
4358 contain the standard macros \f(CW"\en"\fP, \f(CW"\er"\fP, \f(CW"\et"\fP and \f(CW"\es"\fP
4359 to give line-feed, carriage-return, tab and space\&.
4361 The string can also contain a \f(CW\'*\'\fP which matches any sequence of
4364 Double quotes can be used to collect strings with spaces in them into
4367 If the send string in any part of the chat sequence is a fullstop
4368 \f(CW"\&."\fP then no string is sent\&. Similarly, is the expect string is a
4369 fullstop then no string is expected\&.
4371 Note that if the \fB"unix password sync"\fP
4372 parameter is set to true, then this sequence is called \fI*AS ROOT*\fP
4373 when the SMB password in the smbpasswd file is being changed, without
4374 access to the old password cleartext\&. In this case the old password
4375 cleartext is set to \f(CW""\fP (the empty string)\&.
4377 See also \fB"unix password sync"\fP,
4378 \fB"passwd program"\fP and \fB"passwd chat
4385 passwd chat = "*Enter OLD password*" %o\en "*Enter NEW password*" %n\en "*Reenter NEW password*" %n\en "*Password changed*"
4395 passwd chat = *old*password* %o\en *new*password* %n\en *new*password* %n\en *changed*
4400 .IP "\fBpasswd chat debug (G)\fP"
4402 This boolean specifies if the passwd chat script parameter is run in
4403 \f(CW"debug"\fP mode\&. In this mode the strings passed to and received from
4404 the passwd chat are printed in the \fBsmbd\fP log with
4405 a \fB"debug level"\fP of 100\&. This is a dangerous
4406 option as it will allow plaintext passwords to be seen in the
4407 \fBsmbd\fP log\&. It is available to help Samba admins
4408 debug their \fB"passwd chat"\fP scripts when calling
4409 the \fB"passwd program"\fP and should be turned off
4410 after this has been done\&. This parameter is off by default\&.
4412 See also \fB"passwd chat"\fP, \fB"passwd
4416 \f(CW passwd chat debug = True\fP
4419 \f(CW passwd chat debug = False\fP
4421 .IP "\fBpasswd program (G)\fP"
4423 The name of a program that can be used to set UNIX user passwords\&.
4424 Any occurrences of \fB%u\fP will be replaced with the
4425 user name\&. The user name is checked for existence before calling the
4426 password changing program\&.
4428 Also note that many passwd programs insist in \fI"reasonable"\fP
4429 passwords, such as a minimum length, or the inclusion of mixed case
4430 chars and digits\&. This can pose a problem as some clients (such as
4431 Windows for Workgroups) uppercase the password before sending it\&.
4433 \fINote\fP that if the \fB"unix password sync"\fP
4434 parameter is set to \f(CW"True"\fP then this program is called \fI*AS
4435 ROOT*\fP before the SMB password in the
4436 \fBsmbpasswd\fP file is changed\&. If this UNIX
4437 password change fails, then \fBsmbd\fP will fail to
4438 change the SMB password also (this is by design)\&.
4440 If the \fB"unix password sync"\fP parameter is
4441 set this parameter \fIMUST USE ABSOLUTE PATHS\fP for \fIALL\fP programs
4442 called, and must be examined for security implications\&. Note that by
4443 default \fB"unix password sync"\fP is set to
4446 See also \fB"unix password sync"\fP\&.
4449 \f(CW passwd program = /bin/passwd\fP
4452 \f(CW passwd program = /sbin/passwd %u\fP
4454 .IP "\fBpassword level (G)\fP"
4456 Some client/server combinations have difficulty with mixed-case
4457 passwords\&. One offending client is Windows for Workgroups, which for
4458 some reason forces passwords to upper case when using the LANMAN1
4459 protocol, but leaves them alone when using COREPLUS!
4461 This parameter defines the maximum number of characters that may be
4462 upper case in passwords\&.
4464 For example, say the password given was \f(CW"FRED"\fP\&. If \fBpassword
4465 level\fP is set to 1, the following combinations would be tried if
4466 \f(CW"FRED"\fP failed:
4468 \f(CW"Fred"\fP, \f(CW"fred"\fP, \f(CW"fRed"\fP, \f(CW"frEd"\fP, \f(CW"freD"\fP
4470 If \fBpassword level\fP was set to 2, the following combinations would
4473 \f(CW"FRed"\fP, \f(CW"FrEd"\fP, \f(CW"FreD"\fP, \f(CW"fREd"\fP, \f(CW"fReD"\fP,
4474 \f(CW"frED"\fP, \f(CW\&.\&.\fP
4478 The higher value this parameter is set to the more likely it is that a
4479 mixed case password will be matched against a single case
4480 password\&. However, you should be aware that use of this parameter
4481 reduces security and increases the time taken to process a new
4484 A value of zero will cause only two attempts to be made - the password
4485 as is and the password in all-lower case\&.
4488 \f(CW password level = 0\fP
4491 \f(CW password level = 4\fP
4493 .IP "\fBpassword server (G)\fP"
4495 By specifying the name of another SMB server (such as a WinNT box)
4496 with this option, and using \fB"security = domain"\fP or
4497 \fB"security = server"\fP you can get Samba to do all
4498 its username/password validation via a remote server\&.
4500 This options sets the name of the password server to use\&. It must be a
4501 NetBIOS name, so if the machine\'s NetBIOS name is different from its
4502 internet name then you may have to add its NetBIOS name to the lmhosts
4503 file which is stored in the same directory as the \fBsmb\&.conf\fP file\&.
4505 The name of the password server is looked up using the parameter
4506 \fB"name resolve order="\fP and so may resolved
4507 by any method and order described in that parameter\&.
4509 The password server much be a machine capable of using the "LM1\&.2X002"
4510 or the "LM NT 0\&.12" protocol, and it must be in user level security
4513 NOTE: Using a password server means your UNIX box (running Samba) is
4514 only as secure as your password server\&. \fIDO NOT CHOOSE A PASSWORD
4515 SERVER THAT YOU DON\'T COMPLETELY TRUST\fP\&.
4517 Never point a Samba server at itself for password serving\&. This will
4518 cause a loop and could lock up your Samba server!
4520 The name of the password server takes the standard substitutions, but
4521 probably the only useful one is \fB%m\fP, which means
4522 the Samba server will use the incoming client as the password
4523 server\&. If you use this then you better trust your clients, and you
4524 better restrict them with hosts allow!
4526 If the \fB"security"\fP parameter is set to
4527 \fB"domain"\fP, then the list of machines in this option must be a list
4528 of Primary or Backup Domain controllers for the
4529 \fBDomain\fP or the character \f(CW*\fP, as the Samba server is cryptographicly
4530 in that domain, and will use cryptographicly authenticated RPC calls
4531 to authenticate the user logging on\&. The advantage of using
4532 \fB"security=domain"\fP is that if you list
4533 several hosts in the \fB"password server"\fP option then
4534 \fBsmbd\fP will try each in turn till it finds one
4535 that responds\&. This is useful in case your primary server goes down\&.
4537 If the \fB"password server"\fP option is set to the character \f(CW*\fP,
4538 then Samba will attempt to auto-locate the Primary or Backup Domain controllers
4539 to authenticate against by doing a query for the name \f(CWWORKGROUP<1C>\fP
4540 and then contacting each server returned in the list of IP addresses
4541 from the \fBname resolution\fP source\&.
4543 If the \fB"security"\fP parameter is set to
4544 \fB"server"\fP, then there are different
4545 restrictions that \fB"security=domain"\fP
4546 doesn\'t suffer from:
4550 You may list several password servers in the \fB"password server"\fP
4551 parameter, however if an \fBsmbd\fP makes a connection
4552 to a password server, and then the password server fails, no more
4553 users will be able to be authenticated from this
4554 \fBsmbd\fP\&. This is a restriction of the SMB/CIFS
4555 protocol when in \fB"security=server"\fP mode
4556 and cannot be fixed in Samba\&.
4559 If you are using a Windows NT server as your password server then
4560 you will have to ensure that your users are able to login from the
4561 Samba server, as when in
4562 \fB"security=server"\fP mode the network
4563 logon will appear to come from there rather than from the users
4567 See also the \fB"security"\fP parameter\&.
4570 \f(CW password server = <empty string>\fP
4573 \f(CW password server = NT-PDC, NT-BDC1, NT-BDC2\fP
4576 \f(CW password server = *\fP
4578 .IP "\fBpath (S)\fP"
4580 This parameter specifies a directory to which the user of the service
4581 is to be given access\&. In the case of printable services, this is
4582 where print data will spool prior to being submitted to the host for
4585 For a printable service offering guest access, the service should be
4586 readonly and the path should be world-writeable and have the sticky bit
4587 set\&. This is not mandatory of course, but you probably won\'t get the
4588 results you expect if you do otherwise\&.
4590 Any occurrences of \fB%u\fP in the path will be replaced
4591 with the UNIX username that the client is using on this
4592 connection\&. Any occurrences of \fB%m\fP will be replaced
4593 by the NetBIOS name of the machine they are connecting from\&. These
4594 replacements are very useful for setting up pseudo home directories
4597 Note that this path will be based on \fB"root dir"\fP if
4598 one was specified\&.
4604 \f(CW path = /home/fred\fP
4606 .IP "\fBpostexec (S)\fP"
4608 This option specifies a command to be run whenever the service is
4609 disconnected\&. It takes the usual substitutions\&. The command may be run
4610 as the root on some systems\&.
4612 An interesting example may be do unmount server resources:
4614 \f(CWpostexec = /etc/umount /cdrom\fP
4616 See also \fBpreexec\fP\&.
4619 \f(CW none (no command executed)\fP
4622 \f(CW postexec = echo "%u disconnected from %S from %m (%I)" >> /tmp/log\fP
4624 .IP "\fBpostscript (S)\fP"
4626 This parameter forces a printer to interpret the print files as
4627 postscript\&. This is done by adding a \f(CW%!\fP to the start of print output\&.
4629 This is most useful when you have lots of PCs that persist in putting
4630 a control-D at the start of print jobs, which then confuses your
4634 \f(CW postscript = False\fP
4637 \f(CW postscript = True\fP
4639 .IP "\fBpreexec (S)\fP"
4641 This option specifies a command to be run whenever the service is
4642 connected to\&. It takes the usual substitutions\&.
4644 An interesting example is to send the users a welcome message every
4645 time they log in\&. Maybe a message of the day? Here is an example:
4651 preexec = csh -c \'echo \e"Welcome to %S!\e" | /usr/local/samba/bin/smbclient -M %m -I %I\' &
4657 Of course, this could get annoying after a while :-)
4659 See also \fBpreexec close\fP and \fBpostexec\fP\&.
4662 \f(CW none (no command executed)\fP
4665 \f(CW preexec = echo \e"%u connected to %S from %m (%I)\e" >> /tmp/log\fP
4667 .IP "\fBpreexec close (S)\fP"
4669 This boolean option controls whether a non-zero return code from
4670 \fB"preexec"\fP should close the service being connected to\&.
4673 \f(CW preexec close = no\fP
4676 \f(CW preexec close = yes\fP
4678 .IP "\fBpreferred master (G)\fP"
4680 This boolean parameter controls if \fBnmbd\fP is a
4681 preferred master browser for its workgroup\&.
4683 If this is set to true, on startup, \fBnmbd\fP will
4684 force an election, and it will have a slight advantage in winning the
4685 election\&. It is recommended that this parameter is used in
4686 conjunction with \fB"domain master = yes"\fP, so
4687 that \fBnmbd\fP can guarantee becoming a domain
4690 Use this option with caution, because if there are several hosts
4691 (whether Samba servers, Windows 95 or NT) that are preferred master
4692 browsers on the same subnet, they will each periodically and
4693 continuously attempt to become the local master browser\&. This will
4694 result in unnecessary broadcast traffic and reduced browsing
4697 See also \fBos level\fP\&.
4700 \f(CW preferred master = no\fP
4703 \f(CW preferred master = yes\fP
4705 .IP "\fBprefered master (G)\fP"
4707 Synonym for \fB"preferred master"\fP for people
4708 who cannot spell :-)\&.
4711 Synonym for \fB"auto services"\fP\&.
4713 .IP "\fBpreserve case (S)\fP"
4715 This controls if new filenames are created with the case that the
4716 client passes, or if they are forced to be the \f(CW"default"\fP case\&.
4719 \f(CW preserve case = yes\fP
4721 See the section on \fB"NAME MANGLING"\fP for a
4722 fuller discussion\&.
4724 .IP "\fBprint command (S)\fP"
4726 After a print job has finished spooling to a service, this command
4727 will be used via a \f(CWsystem()\fP call to process the spool
4728 file\&. Typically the command specified will submit the spool file to
4729 the host\'s printing subsystem, but there is no requirement that this
4730 be the case\&. The server will not remove the spool file, so whatever
4731 command you specify should remove the spool file when it has been
4732 processed, otherwise you will need to manually remove old spool files\&.
4734 The print command is simply a text string\&. It will be used verbatim,
4735 with two exceptions: All occurrences of \f(CW"%s"\fP will be replaced by
4736 the appropriate spool file name, and all occurrences of \f(CW"%p"\fP will
4737 be replaced by the appropriate printer name\&. The spool file name is
4738 generated automatically by the server, the printer name is discussed
4741 The full path name will be used for the filename if \f(CW"%s"\fP is not
4742 preceded by a \f(CW\'/\'\fP\&. If you don\'t like this (it can stuff up some
4743 lpq output) then use \f(CW"%f"\fP instead\&. Any occurrences of \f(CW"%f"\fP get
4744 replaced by the spool filename without the full path at the front\&.
4746 The print command \fIMUST\fP contain at least one occurrence of \f(CW"%s"\fP
4747 or \f(CW"%f"\fP - the \f(CW"%p"\fP is optional\&. At the time a job is
4748 submitted, if no printer name is supplied the \f(CW"%p"\fP will be
4749 silently removed from the printer command\&.
4751 If specified in the \fB"[global]"\fP section, the print
4752 command given will be used for any printable service that does not
4753 have its own print command specified\&.
4755 If there is neither a specified print command for a printable service
4756 nor a global print command, spool files will be created but not
4757 processed and (most importantly) not removed\&.
4759 Note that printing may fail on some UNIXs from the \f(CW"nobody"\fP
4760 account\&. If this happens then create an alternative guest account that
4761 can print and set the \fB"guest account"\fP in the
4762 \fB"[global]"\fP section\&.
4764 You can form quite complex print commands by realizing that they are
4765 just passed to a shell\&. For example the following will log a print
4766 job, print the file, then remove it\&. Note that \f(CW\';\'\fP is the usual
4767 separator for command in shell scripts\&.
4769 \f(CWprint command = echo Printing %s >> /tmp/print\&.log; lpr -P %p %s; rm %s\fP
4771 You may have to vary this command considerably depending on how you
4772 normally print files on your system\&. The default for the parameter
4773 varies depending on the setting of the \fB"printing="\fP
4777 For \fB"printing="\fP BSD, AIX, QNX, LPRNG or PLP :
4778 \f(CW print command = lpr -r -P%p %s\fP
4780 For \fB"printing="\fP SYS or HPUX :
4781 \f(CW print command = lp -c -d%p %s; rm %s\fP
4783 For \fB"printing="\fP SOFTQ :
4784 \f(CW print command = lp -d%p -s %s; rm %s\fP
4787 \f(CW print command = /usr/local/samba/bin/myprintscript %p %s\fP
4789 .IP "\fBprint ok (S)\fP"
4791 Synonym for \fBprintable\fP\&.
4793 .IP "\fBprintable (S)\fP"
4795 If this parameter is \f(CW"yes"\fP, then clients may open, write to and
4796 submit spool files on the directory specified for the service\&.
4798 Note that a printable service will ALWAYS allow writing to the service
4799 path (user privileges permitting) via the spooling of print data\&. The
4800 \fB"read only"\fP parameter controls only non-printing
4801 access to the resource\&.
4804 \f(CW printable = no\fP
4807 \f(CW printable = yes\fP
4809 .IP "\fBprintcap (G)\fP"
4811 Synonym for \fBprintcapname\fP\&.
4813 .IP "\fBprintcap name (G)\fP"
4815 This parameter may be used to override the compiled-in default
4816 printcap name used by the server (usually /etc/printcap)\&. See the
4817 discussion of the \fB[printers]\fP section above for
4818 reasons why you might want to do this\&.
4820 On System V systems that use \fBlpstat\fP to list available printers you
4821 can use \f(CW"printcap name = lpstat"\fP to automatically obtain lists of
4822 available printers\&. This is the default for systems that define SYSV
4823 at configure time in Samba (this includes most System V based
4824 systems)\&. If \fB"printcap name"\fP is set to \fBlpstat\fP on these systems
4825 then Samba will launch \f(CW"lpstat -v"\fP and attempt to parse the output
4826 to obtain a printer list\&.
4828 A minimal printcap file would look something like this:
4844 where the \f(CW\'|\'\fP separates aliases of a printer\&. The fact that the
4845 second alias has a space in it gives a hint to Samba that it\'s a
4848 \fINOTE\fP: Under AIX the default printcap name is
4849 \f(CW"/etc/qconfig"\fP\&. Samba will assume the file is in AIX \f(CW"qconfig"\fP
4850 format if the string \f(CW"/qconfig"\fP appears in the printcap filename\&.
4853 \f(CW printcap name = /etc/printcap\fP
4856 \f(CW printcap name = /etc/myprintcap\fP
4858 .IP "\fBprinter (S)\fP"
4860 This parameter specifies the name of the printer to which print jobs
4861 spooled through a printable service will be sent\&.
4863 If specified in the \fB[global]\fP section, the printer
4864 name given will be used for any printable service that does not have
4865 its own printer name specified\&.
4868 none (but may be \f(CW"lp"\fP on many systems)
4871 printer name = laserwriter
4873 .IP "\fBprinter driver (S)\fP"
4875 This option allows you to control the string that clients receive when
4876 they ask the server for the printer driver associated with a
4877 printer\&. If you are using Windows95 or WindowsNT then you can use this
4878 to automate the setup of printers on your system\&.
4880 You need to set this parameter to the exact string (case sensitive)
4881 that describes the appropriate printer driver for your system\&. If you
4882 don\'t know the exact string to use then you should first try with no
4883 \fB"printer driver"\fP option set and the client will give you a list of
4884 printer drivers\&. The appropriate strings are shown in a scrollbox
4885 after you have chosen the printer manufacturer\&.
4887 See also \fB"printer driver file"\fP\&.
4890 printer driver = HP LaserJet 4L
4892 .IP "\fBprinter driver file (G)\fP"
4894 This parameter tells Samba where the printer driver definition file,
4895 used when serving drivers to Windows 95 clients, is to be found\&. If
4896 this is not set, the default is :
4898 \f(CWSAMBA_INSTALL_DIRECTORY/lib/printers\&.def\fP
4900 This file is created from Windows 95 \f(CW"msprint\&.def"\fP files found on
4901 the Windows 95 client system\&. For more details on setting up serving
4902 of printer drivers to Windows 95 clients, see the documentation file
4903 in the docs/ directory, PRINTER_DRIVER\&.txt\&.
4906 \f(CW None (set in compile)\&.\fP
4909 \f(CW printer driver file = /usr/local/samba/printers/drivers\&.def\fP
4911 See also \fB"printer driver location"\fP\&.
4913 .IP "\fBprinter driver location (S)\fP"
4915 This parameter tells clients of a particular printer share where to
4916 find the printer driver files for the automatic installation of
4917 drivers for Windows 95 machines\&. If Samba is set up to serve printer
4918 drivers to Windows 95 machines, this should be set to
4920 \f(CW\e\eMACHINE\eaPRINTER$\fP
4922 Where MACHINE is the NetBIOS name of your Samba server, and PRINTER$
4923 is a share you set up for serving printer driver files\&. For more
4924 details on setting this up see the documentation file in the docs/
4925 directory, PRINTER_DRIVER\&.txt\&.
4931 \f(CW printer driver location = \e\eMACHINE\ePRINTER$\fP
4933 See also \fB"printer driver file"\fP\&.
4935 .IP "\fBprinter name (S)\fP"
4937 Synonym for \fBprinter\fP\&.
4939 .IP "\fBprinting (S)\fP"
4941 This parameters controls how printer status information is interpreted
4942 on your system, and also affects the default values for the
4943 \fB"print command"\fP, \fB"lpq
4944 command"\fP \fB"lppause command"\fP,
4945 \fB"lpresume command"\fP, and \fB"lprm
4948 Currently eight printing styles are supported\&. They are
4949 \fB"printing=BSD"\fP, \fB"printing=AIX"\fP, \fB"printing=LPRNG"\fP,
4950 \fB"printing=PLP"\fP,
4951 \fB"printing=SYSV"\fP,\fB"printing="HPUX"\fP,\fB"printing=QNX"\fP and
4952 \fB"printing=SOFTQ"\fP\&.
4954 To see what the defaults are for the other print commands when using
4955 these three options use the \fB"testparm"\fP program\&.
4957 This option can be set on a per printer basis
4959 See also the discussion in the \fB[printers]\fP section\&.
4961 .IP "\fBprotocol (G)\fP"
4963 The value of the parameter (a string) is the highest protocol level
4964 that will be supported by the server\&.
4966 Possible values are :
4970 CORE: Earliest version\&. No concept of user names\&.
4973 COREPLUS: Slight improvements on CORE for efficiency\&.
4976 LANMAN1: First \fI"modern"\fP version of the protocol\&. Long
4980 LANMAN2: Updates to Lanman1 protocol\&.
4983 NT1: Current up to date version of the protocol\&. Used by Windows
4984 NT\&. Known as CIFS\&.
4987 Normally this option should not be set as the automatic negotiation
4988 phase in the SMB protocol takes care of choosing the appropriate
4992 \f(CW protocol = NT1\fP
4995 \f(CW protocol = LANMAN1\fP
4997 .IP "\fBpublic (S)\fP"
4999 Synonym for \fB"guest ok"\fP\&.
5001 .IP "\fBqueuepause command (S)\fP"
5003 This parameter specifies the command to be executed on the server host
5004 in order to pause the printerqueue\&.
5006 This command should be a program or script which takes a printer name
5007 as its only parameter and stops the printerqueue, such that no longer
5008 jobs are submitted to the printer\&.
5010 This command is not supported by Windows for Workgroups, but can be
5011 issued from the Printer\'s window under Windows 95 & NT\&.
5013 If a \f(CW"%p"\fP is given then the printername is put in its
5014 place\&. Otherwise it is placed at the end of the command\&.
5016 Note that it is good practice to include the absolute path in the
5017 command as the PATH may not be available to the server\&.
5020 \f(CW depends on the setting of "printing ="\fP
5023 \f(CW queuepause command = disable %p\fP
5025 .IP "\fBqueueresume command (S)\fP"
5027 This parameter specifies the command to be executed on the server host
5028 in order to resume the printerqueue\&. It is the command to undo the
5029 behavior that is caused by the previous parameter
5030 (\fB"queuepause command\fP)\&.
5032 This command should be a program or script which takes a printer name
5033 as its only parameter and resumes the printerqueue, such that queued
5034 jobs are resubmitted to the printer\&.
5036 This command is not supported by Windows for Workgroups, but can be
5037 issued from the Printer\'s window under Windows 95 & NT\&.
5039 If a \f(CW"%p"\fP is given then the printername is put in its
5040 place\&. Otherwise it is placed at the end of the command\&.
5042 Note that it is good practice to include the absolute path in the
5043 command as the PATH may not be available to the server\&.
5046 \f(CW depends on the setting of "printing ="\fP
5049 \f(CW queuepause command = enable %p\fP
5051 .IP "\fBread bmpx (G)\fP"
5053 This boolean parameter controls whether \fBsmbd\fP
5054 will support the "Read Block Multiplex" SMB\&. This is now rarely used
5055 and defaults to off\&. You should never need to set this parameter\&.
5060 .IP "\fBread list (S)\fP"
5062 This is a list of users that are given read-only access to a
5063 service\&. If the connecting user is in this list then they will not be
5064 given write access, no matter what the \fB"read only"\fP
5065 option is set to\&. The list can include group names using the syntax
5066 described in the \fB"invalid users"\fP parameter\&.
5068 See also the \fB"write list"\fP parameter and
5069 the \fB"invalid users"\fP parameter\&.
5072 \f(CW read list = <empty string>\fP
5075 \f(CW read list = mary, @students\fP
5077 .IP "\fBread only (S)\fP"
5079 Note that this is an inverted synonym for
5080 \fB"writeable"\fP and \fB"write ok"\fP\&.
5082 See also \fB"writeable"\fP and \fB"write
5085 .IP "\fBread prediction (G)\fP"
5087 \fINOTE\fP: This code is currently disabled in Samba2\&.0 and
5088 may be removed at a later date\&. Hence this parameter has
5091 This options enables or disables the read prediction code used to
5092 speed up reads from the server\&. When enabled the server will try to
5093 pre-read data from the last accessed file that was opened read-only
5094 while waiting for packets\&.
5097 \f(CW read prediction = False\fP
5099 .IP "\fBread raw (G)\fP"
5101 This parameter controls whether or not the server will support the raw
5102 read SMB requests when transferring data to clients\&.
5104 If enabled, raw reads allow reads of 65535 bytes in one packet\&. This
5105 typically provides a major performance benefit\&.
5107 However, some clients either negotiate the allowable block size
5108 incorrectly or are incapable of supporting larger block sizes, and for
5109 these clients you may need to disable raw reads\&.
5111 In general this parameter should be viewed as a system tuning tool and left
5112 severely alone\&. See also \fB"write raw"\fP\&.
5115 \f(CW read raw = yes\fP
5117 .IP "\fBread size (G)\fP"
5119 The option \fB"read size"\fP affects the overlap of disk reads/writes
5120 with network reads/writes\&. If the amount of data being transferred in
5121 several of the SMB commands (currently SMBwrite, SMBwriteX and
5122 SMBreadbraw) is larger than this value then the server begins writing
5123 the data before it has received the whole packet from the network, or
5124 in the case of SMBreadbraw, it begins writing to the network before
5125 all the data has been read from disk\&.
5127 This overlapping works best when the speeds of disk and network access
5128 are similar, having very little effect when the speed of one is much
5129 greater than the other\&.
5131 The default value is 16384, but very little experimentation has been
5132 done yet to determine the optimal value, and it is likely that the
5133 best value will vary greatly between systems anyway\&. A value over
5134 65536 is pointless and will cause you to allocate memory
5138 \f(CW read size = 16384\fP
5141 \f(CW read size = 8192\fP
5143 .IP "\fBremote announce (G)\fP"
5145 This option allows you to setup \fBnmbd\fP to
5146 periodically announce itself to arbitrary IP addresses with an
5147 arbitrary workgroup name\&.
5149 This is useful if you want your Samba server to appear in a remote
5150 workgroup for which the normal browse propagation rules don\'t
5151 work\&. The remote workgroup can be anywhere that you can send IP
5156 \f(CW remote announce = 192\&.168\&.2\&.255/SERVERS 192\&.168\&.4\&.255/STAFF\fP
5158 the above line would cause nmbd to announce itself to the two given IP
5159 addresses using the given workgroup names\&. If you leave out the
5160 workgroup name then the one given in the
5161 \fB"workgroup"\fP parameter is used instead\&.
5163 The IP addresses you choose would normally be the broadcast addresses
5164 of the remote networks, but can also be the IP addresses of known
5165 browse masters if your network config is that stable\&.
5167 See the documentation file BROWSING\&.txt in the docs/ directory\&.
5170 \f(CW remote announce = <empty string>\fP
5173 \f(CW remote announce = 192\&.168\&.2\&.255/SERVERS 192\&.168\&.4\&.255/STAFF\fP
5175 .IP "\fBremote browse sync (G)\fP"
5177 This option allows you to setup \fBnmbd\fP to
5178 periodically request synchronization of browse lists with the master
5179 browser of a samba server that is on a remote segment\&. This option
5180 will allow you to gain browse lists for multiple workgroups across
5181 routed networks\&. This is done in a manner that does not work with any
5182 non-samba servers\&.
5184 This is useful if you want your Samba server and all local clients to
5185 appear in a remote workgroup for which the normal browse propagation
5186 rules don\'t work\&. The remote workgroup can be anywhere that you can
5187 send IP packets to\&.
5191 \f(CW remote browse sync = 192\&.168\&.2\&.255 192\&.168\&.4\&.255\fP
5193 the above line would cause \fBnmbd\fP to request the
5194 master browser on the specified subnets or addresses to synchronize
5195 their browse lists with the local server\&.
5197 The IP addresses you choose would normally be the broadcast addresses
5198 of the remote networks, but can also be the IP addresses of known
5199 browse masters if your network config is that stable\&. If a machine IP
5200 address is given Samba makes NO attempt to validate that the remote
5201 machine is available, is listening, nor that it is in fact the browse
5202 master on it\'s segment\&.
5205 \f(CW remote browse sync = <empty string>\fP
5208 \f(CW remote browse sync = 192\&.168\&.2\&.255 192\&.168\&.4\&.255\fP
5210 .IP "\fBrestrict anonymous (G)\fP"
5212 This is a boolean parameter\&. If it is true, then anonymous access
5213 to the server will be restricted, namely in the case where the server
5214 is expecting the client to send a username, but it doesn\'t\&. Setting
5215 it to true will force these anonymous connections to be denied, and
5216 the client will be required to always supply a username and password
5217 when connecting\&. Use of this parameter is only recommened for homogenous
5218 NT client environments\&.
5220 This parameter makes the use of macro expansions that rely
5221 on the username (%U, %G, etc) consistant\&. NT 4\&.0 likes to use
5222 anonymous connections when refreshing the share list, and this
5223 is a way to work around that\&.
5225 When restrict anonymous is true, all anonymous connections are denied
5226 no matter what they are for\&. This can effect the ability of a machine
5227 to access the samba Primary Domain Controller to revalidate it\'s machine
5228 account after someone else has logged on the client interactively\&. The
5229 NT client will display a message saying that the machine\'s account in
5230 the domain doesn\'t exist or the password is bad\&. The best way to deal
5231 with this is to reboot NT client machines between interactive logons,
5232 using "Shutdown and Restart", rather than "Close all programs and logon
5233 as a different user"\&.
5236 \f(CW restrict anonymous = false\fP
5239 \f(CW restrict anonymous = true\fP
5241 .IP "\fBrevalidate (S)\fP"
5243 Note that this option only works with
5244 \fB"security=share"\fP and will be ignored if
5245 this is not the case\&.
5247 This option controls whether Samba will allow a previously validated
5248 username/password pair to be used to attach to a share\&. Thus if you
5249 connect to \f(CW\e\eserver\eshare1\fP then to \f(CW\e\eserver\eshare2\fP it won\'t
5250 automatically allow the client to request connection to the second
5251 share as the same username as the first without a password\&.
5253 If \fB"revalidate"\fP is \f(CW"True"\fP then the client will be denied
5254 automatic access as the same username\&.
5257 \f(CW revalidate = False\fP
5260 \f(CW revalidate = True\fP
5262 .IP "\fBroot (G)\fP"
5264 Synonym for \fB"root directory"\fP\&.
5266 .IP "\fBroot dir (G)\fP"
5268 Synonym for \fB"root directory"\fP\&.
5270 .IP "\fBroot directory (G)\fP"
5272 The server will \f(CW"chroot()"\fP (i\&.e\&. Change it\'s root directory) to
5273 this directory on startup\&. This is not strictly necessary for secure
5274 operation\&. Even without it the server will deny access to files not in
5275 one of the service entries\&. It may also check for, and deny access to,
5276 soft links to other parts of the filesystem, or attempts to use
5277 \f(CW"\&.\&."\fP in file names to access other directories (depending on the
5278 setting of the \fB"wide links"\fP parameter)\&.
5280 Adding a \fB"root directory"\fP entry other than \f(CW"/"\fP adds an extra
5281 level of security, but at a price\&. It absolutely ensures that no
5282 access is given to files not in the sub-tree specified in the \fB"root
5283 directory"\fP option, \fI*including*\fP some files needed for complete
5284 operation of the server\&. To maintain full operability of the server
5285 you will need to mirror some system files into the \fB"root
5286 directory"\fP tree\&. In particular you will need to mirror /etc/passwd
5287 (or a subset of it), and any binaries or configuration files needed
5288 for printing (if required)\&. The set of files that must be mirrored is
5289 operating system dependent\&.
5292 \f(CW root directory = /\fP
5295 \f(CW root directory = /homes/smb\fP
5297 .IP "\fBroot postexec (S)\fP"
5299 This is the same as the \fB"postexec"\fP parameter
5300 except that the command is run as root\&. This is useful for unmounting
5301 filesystems (such as cdroms) after a connection is closed\&.
5303 See also \fB"postexec"\fP\&.
5305 .IP "\fBroot preexec (S)\fP"
5307 This is the same as the \fB"preexec"\fP parameter except
5308 that the command is run as root\&. This is useful for mounting
5309 filesystems (such as cdroms) before a connection is finalized\&.
5311 See also \fB"preexec"\fP
5312 and \fB"root preexec close"\fP\&.
5314 .IP "\fBroot preexec close (S)\fP"
5316 This is the same as the \fB"preexec close"\fP parameter
5317 except that the command is run as root\&.
5319 See also \fB"preexec"\fP, \fB"preexec close"\fP\&.
5321 .IP "\fBsecurity (G)\fP"
5323 This option affects how clients respond to Samba and is one of the most
5324 important settings in the \fBsmb\&.conf\fP file\&.
5326 The option sets the \f(CW"security mode bit"\fP in replies to protocol
5327 negotiations with \fBsmbd\fP to turn share level
5328 security on or off\&. Clients decide based on this bit whether (and how)
5329 to transfer user and password information to the server\&.
5331 The default is "security=user", as this is
5332 the most common setting needed when talking to Windows 98 and Windows
5335 The alternatives are \fB"security = share"\fP,
5336 \fB"security = server"\fP or
5337 \fB"security=domain"\fP\&.
5339 \fI*****NOTE THAT THIS DEFAULT IS DIFFERENT IN SAMBA2\&.0 THAN FOR
5340 PREVIOUS VERSIONS OF SAMBA *******\fP\&.
5342 In previous versions of Samba the default was
5343 \fB"security=share"\fP mainly because that was
5344 the only option at one stage\&.
5346 There is a bug in WfWg that has relevance to this setting\&. When in
5347 user or server level security a WfWg client will totally ignore the
5348 password you type in the "connect drive" dialog box\&. This makes it
5349 very difficult (if not impossible) to connect to a Samba service as
5350 anyone except the user that you are logged into WfWg as\&.
5352 If your PCs use usernames that are the same as their usernames on the
5353 UNIX machine then you will want to use \fB"security = user"\fP\&. If you
5354 mostly use usernames that don\'t exist on the UNIX box then use
5355 \fB"security = share"\fP\&.
5357 You should also use \fBsecurity=share\fP if
5358 you want to mainly setup shares without a password (guest
5359 shares)\&. This is commonly used for a shared printer server\&. It is more
5360 difficult to setup guest shares with
5361 \fBsecurity=user\fP, see the \fB"map to
5362 guest"\fPparameter for details\&.
5364 It is possible to use \fBsmbd\fP in a \fI"hybrid
5365 mode"\fP where it is offers both user and share level security under
5366 different \fBNetBIOS aliases\fP\&. See the
5367 \fBNetBIOS aliases\fP and the
5368 \fBinclude\fP parameters for more information\&.
5370 The different settings will now be explained\&.
5373 .IP "\fB"security=share"\fP"
5374 When clients connect to a share level
5375 security server then need not log onto the server with a valid
5376 username and password before attempting to connect to a shared
5377 resource (although modern clients such as Windows 95/98 and Windows NT
5378 will send a logon request with a username but no password when talking
5379 to a \fBsecurity=share\fP server)\&. Instead, the clients send
5380 authentication information (passwords) on a per-share basis, at the
5381 time they attempt to connect to that share\&.
5383 Note that \fBsmbd\fP \fI*ALWAYS*\fP uses a valid UNIX
5384 user to act on behalf of the client, even in \fB"security=share"\fP
5387 As clients are not required to send a username to the server
5388 in share level security, \fBsmbd\fP uses several
5389 techniques to determine the correct UNIX user to use on behalf
5392 A list of possible UNIX usernames to match with the given
5393 client password is constructed using the following methods :
5397 If the \fB"guest only"\fP parameter is set, then
5398 all the other stages are missed and only the \fB"guest
5399 account"\fP username is checked\&.
5402 Is a username is sent with the share connection request, then
5403 this username (after mapping - see \fB"username
5404 map"\fP), is added as a potential username\&.
5407 If the client did a previous \fI"logon"\fP request (the
5408 SessionSetup SMB call) then the username sent in this SMB
5409 will be added as a potential username\&.
5412 The name of the service the client requested is added
5413 as a potential username\&.
5416 The NetBIOS name of the client is added to the list as a
5417 potential username\&.
5420 Any users on the \fB"user"\fP list are added
5421 as potential usernames\&.
5424 If the \fB"guest only"\fP parameter is not set, then
5425 this list is then tried with the supplied password\&. The first user for
5426 whom the password matches will be used as the UNIX user\&.
5428 If the \fB"guest only"\fP parameter is set, or no
5429 username can be determined then if the share is marked as available to
5430 the \fB"guest account"\fP, then this guest user will
5431 be used, otherwise access is denied\&.
5433 Note that it can be \fI*very*\fP confusing in share-level security as to
5434 which UNIX username will eventually be used in granting access\&.
5436 See also the section \fB"NOTE ABOUT USERNAME/PASSWORD
5439 .IP "\fB"security=user"\fP"
5441 This is the default security setting in Samba2\&.0\&. With user-level
5442 security a client must first \f(CW"log-on"\fP with a valid username and
5443 password (which can be mapped using the \fB"username
5444 map"\fP parameter)\&. Encrypted passwords (see the
5445 \fB"encrypted passwords"\fP parameter) can also
5446 be used in this security mode\&. Parameters such as
5447 \fB"user"\fP and \fB"guest only"\fP, if set
5448 are then applied and may change the UNIX user to use on this
5449 connection, but only after the user has been successfully
5452 \fINote\fP that the name of the resource being requested is
5453 \fI*not*\fP sent to the server until after the server has successfully
5454 authenticated the client\&. This is why guest shares don\'t work in user
5455 level security without allowing the server to automatically map unknown
5456 users into the \fB"guest account"\fP\&. See the
5457 \fB"map to guest"\fP parameter for details on
5460 See also the section \fB"NOTE ABOUT USERNAME/PASSWORD
5463 .IP "\fB"security=server"\fP"
5465 In this mode Samba will try to validate the username/password by
5466 passing it to another SMB server, such as an NT box\&. If this fails it
5467 will revert to \fB"security = user"\fP, but note that if encrypted
5468 passwords have been negotiated then Samba cannot revert back to
5469 checking the UNIX password file, it must have a valid smbpasswd file
5470 to check users against\&. See the documentation file in the docs/
5471 directory ENCRYPTION\&.txt for details on how to set this up\&.
5473 \fINote\fP that from the clients point of view \fB"security=server"\fP is
5474 the same as \fB"security=user"\fP\&. It only
5475 affects how the server deals with the authentication, it does not in
5476 any way affect what the client sees\&.
5478 \fINote\fP that the name of the resource being requested is
5479 \fI*not*\fP sent to the server until after the server has successfully
5480 authenticated the client\&. This is why guest shares don\'t work in server
5481 level security without allowing the server to automatically map unknown
5482 users into the \fB"guest account"\fP\&. See the
5483 \fB"map to guest"\fP parameter for details on
5486 See also the section \fB"NOTE ABOUT USERNAME/PASSWORD
5489 See also the \fB"password server"\fP parameter\&.
5490 and the \fB"encrypted passwords"\fP parameter\&.
5492 .IP "\fB"security=domain"\fP"
5494 This mode will only work correctly if
5495 \fBsmbpasswd\fP has been used to add this machine
5496 into a Windows NT Domain\&. It expects the \fB"encrypted
5497 passwords"\fP parameter to be set to \f(CW"true"\fP\&. In
5498 this mode Samba will try to validate the username/password by passing
5499 it to a Windows NT Primary or Backup Domain Controller, in exactly the
5500 same way that a Windows NT Server would do\&.
5502 \fINote\fP that a valid UNIX user must still exist as well as the
5503 account on the Domain Controller to allow Samba to have a valid
5504 UNIX account to map file access to\&.
5506 \fINote\fP that from the clients point of view \fB"security=domain"\fP is
5507 the same as \fB"security=user"\fP\&. It only
5508 affects how the server deals with the authentication, it does not in
5509 any way affect what the client sees\&.
5511 \fINote\fP that the name of the resource being requested is
5512 \fI*not*\fP sent to the server until after the server has successfully
5513 authenticated the client\&. This is why guest shares don\'t work in domain
5514 level security without allowing the server to automatically map unknown
5515 users into the \fB"guest account"\fP\&. See the
5516 \fB"map to guest"\fP parameter for details on
5519 \fIBUG:\fP There is currently a bug in the implementation of
5520 \fB"security=domain\fP with respect to multi-byte character
5521 set usernames\&. The communication with a Domain Controller
5522 must be done in UNICODE and Samba currently does not widen
5523 multi-byte user names to UNICODE correctly, thus a multi-byte
5524 username will not be recognized correctly at the Domain Controller\&.
5525 This issue will be addressed in a future release\&.
5527 See also the section \fB"NOTE ABOUT USERNAME/PASSWORD
5530 See also the \fB"password server"\fP parameter\&.
5531 and the \fB"encrypted passwords"\fP parameter\&.
5535 \f(CW security = USER\fP
5538 \f(CW security = DOMAIN\fP
5540 .IP "\fBsecurity mask (S)\fP"
5542 This parameter controls what UNIX permission bits can be modified
5543 when a Windows NT client is manipulating the UNIX permission on a
5544 file using the native NT security dialog box\&.
5546 This parameter is applied as a mask (AND\'ed with) to the changed
5547 permission bits, thus preventing any bits not in this mask from
5548 being modified\&. Essentially, zero bits in this mask may be treated
5549 as a set of bits the user is not allowed to change\&.
5551 If not set explicitly this parameter is set to the same value as the
5552 \fBcreate mask\fP parameter\&. To allow a user to
5553 modify all the user/group/world permissions on a file, set this
5554 parameter to 0777\&.
5556 \fINote\fP that users who can access the Samba server through other
5557 means can easily bypass this restriction, so it is primarily
5558 useful for standalone "appliance" systems\&. Administrators of
5559 most normal systems will probably want to set it to 0777\&.
5561 See also the \fBforce directory security
5562 mode\fP, \fBdirectory security
5563 mask\fP, \fBforce security
5564 mode\fP parameters\&.
5567 \f(CW security mask = <same as create mask>\fP
5570 \f(CW security mask = 0777\fP
5572 .IP "\fBserver string (G)\fP"
5574 This controls what string will show up in the printer comment box in
5575 print manager and next to the IPC connection in \f(CW"net view"\fP\&. It can be
5576 any string that you wish to show to your users\&.
5578 It also sets what will appear in browse lists next to the machine
5581 A \f(CW"%v"\fP will be replaced with the Samba version number\&.
5583 A \f(CW"%h"\fP will be replaced with the hostname\&.
5586 \f(CW server string = Samba %v\fP
5589 \f(CW server string = University of GNUs Samba Server\fP
5591 .IP "\fBset directory (S)\fP"
5593 If \f(CW"set directory = no"\fP, then users of the service may not use the
5594 setdir command to change directory\&.
5596 The setdir command is only implemented in the Digital Pathworks
5597 client\&. See the Pathworks documentation for details\&.
5600 \f(CW set directory = no\fP
5603 \f(CW set directory = yes\fP
5605 .IP "\fBshare modes (S)\fP"
5607 This enables or disables the honoring of the \f(CW"share modes"\fP during a
5608 file open\&. These modes are used by clients to gain exclusive read or
5609 write access to a file\&.
5611 These open modes are not directly supported by UNIX, so they are
5612 simulated using shared memory, or lock files if your UNIX doesn\'t
5613 support shared memory (almost all do)\&.
5615 The share modes that are enabled by this option are DENY_DOS,
5616 DENY_ALL, DENY_READ, DENY_WRITE, DENY_NONE and DENY_FCB\&.
5618 This option gives full share compatibility and enabled by default\&.
5620 You should \fI*NEVER*\fP turn this parameter off as many Windows
5621 applications will break if you do so\&.
5624 \f(CW share modes = yes\fP
5626 .IP "\fBshared mem size (G)\fP"
5628 It specifies the size of the shared memory (in bytes) to use between
5629 \fBsmbd\fP processes\&. This parameter defaults to one
5630 megabyte of shared memory\&. It is possible that if you have a large
5631 server with many files open simultaneously that you may need to
5632 increase this parameter\&. Signs that this parameter is set too low are
5633 users reporting strange problems trying to save files (locking errors)
5634 and error messages in the smbd log looking like \f(CW"ERROR
5635 smb_shm_alloc : alloc of XX bytes failed"\fP\&.
5637 If your OS refuses the size that Samba asks for then Samba will try a
5638 smaller size, reducing by a factor of 0\&.8 until the OS accepts it\&.
5641 \f(CW shared mem size = 1048576\fP
5644 \f(CW shared mem size = 5242880 ; Set to 5mb for a large number of files\&.\fP
5646 .IP "\fBshort preserve case (G)\fP"
5648 This boolean parameter controls if new files which conform to 8\&.3
5649 syntax, that is all in upper case and of suitable length, are created
5650 upper case, or if they are forced to be the \f(CW"default"\fP case\&. This
5651 option can be use with \fB"preserve case
5652 =yes"\fP to permit long filenames to retain their
5653 case, while short names are lowered\&. Default \fIYes\fP\&.
5655 See the section on \fBNAME MANGLING\fP\&.
5658 \f(CW short preserve case = yes\fP
5660 .IP "\fBsmb passwd file (G)\fP"
5662 This option sets the path to the encrypted smbpasswd file\&. By default
5663 the path to the smbpasswd file is compiled into Samba\&.
5666 \f(CW smb passwd file= <compiled default>\fP
5669 \f(CW smb passwd file = /usr/samba/private/smbpasswd\fP
5671 .IP "\fBsmbrun (G)\fP"
5673 This sets the full path to the \fBsmbrun\fP binary\&. This defaults to the
5674 value in the Makefile\&.
5676 You must get this path right for many services to work correctly\&.
5678 You should not need to change this parameter so long as Samba
5679 is installed correctly\&.
5682 \f(CW smbrun=<compiled default>\fP
5685 \f(CW smbrun = /usr/local/samba/bin/smbrun\fP
5687 .IP "\fBsocket address (G)\fP"
5689 This option allows you to control what address Samba will listen for
5690 connections on\&. This is used to support multiple virtual interfaces on
5691 the one server, each with a different configuration\&.
5693 By default samba will accept connections on any address\&.
5696 \f(CW socket address = 192\&.168\&.2\&.20\fP
5698 .IP "\fBsocket options (G)\fP"
5700 This option allows you to set socket options to be used when talking
5703 Socket options are controls on the networking layer of the operating
5704 systems which allow the connection to be tuned\&.
5706 This option will typically be used to tune your Samba server for
5707 optimal performance for your local network\&. There is no way that Samba
5708 can know what the optimal parameters are for your net, so you must
5709 experiment and choose them yourself\&. We strongly suggest you read the
5710 appropriate documentation for your operating system first (perhaps
5711 \fB"man setsockopt"\fP will help)\&.
5713 You may find that on some systems Samba will say "Unknown socket
5714 option" when you supply an option\&. This means you either incorrectly
5715 typed it or you need to add an include file to includes\&.h for your OS\&.
5716 If the latter is the case please send the patch to
5717 \fIsamba-bugs@samba\&.org\fP\&.
5719 Any of the supported socket options may be combined in any way you
5720 like, as long as your OS allows it\&.
5722 This is the list of socket options currently settable using this
5757 Those marked with a \f(CW*\fP take an integer argument\&. The others can
5758 optionally take a 1 or 0 argument to enable or disable the option, by
5759 default they will be enabled if you don\'t specify 1 or 0\&.
5761 To specify an argument use the syntax SOME_OPTION=VALUE for example
5762 \f(CWSO_SNDBUF=8192\fP\&. Note that you must not have any spaces before or after
5765 If you are on a local network then a sensible option might be
5767 \f(CWsocket options = IPTOS_LOWDELAY\fP
5769 If you have a local network then you could try:
5771 \f(CWsocket options = IPTOS_LOWDELAY TCP_NODELAY\fP
5773 If you are on a wide area network then perhaps try setting
5776 Note that several of the options may cause your Samba server to fail
5777 completely\&. Use these options with caution!
5780 \f(CW socket options = TCP_NODELAY\fP
5783 \f(CW socket options = IPTOS_LOWDELAY\fP
5787 This variable is part of SSL-enabled Samba\&. This is only available if
5788 the SSL libraries have been compiled on your system and the configure
5789 option \f(CW"--with-ssl"\fP was given at configure time\&.
5791 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5792 enabled by default in any current binary version of Samba\&.
5794 This variable enables or disables the entire SSL mode\&. If it is set to
5795 "no", the SSL enabled samba behaves exactly like the non-SSL samba\&. If
5796 set to "yes", it depends on the variables \fB"ssl
5797 hosts"\fP and \fB"ssl hosts resign"\fP
5798 whether an SSL connection will be required\&.
5805 .IP "\fBssl CA certDir (G)\fP"
5807 This variable is part of SSL-enabled Samba\&. This is only available if
5808 the SSL libraries have been compiled on your system and the configure
5809 option \f(CW"--with-ssl"\fP was given at configure time\&.
5811 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5812 enabled by default in any current binary version of Samba\&.
5814 This variable defines where to look up the Certification
5815 Authorities\&. The given directory should contain one file for each CA
5816 that samba will trust\&. The file name must be the hash value over the
5817 "Distinguished Name" of the CA\&. How this directory is set up is
5818 explained later in this document\&. All files within the directory that
5819 don\'t fit into this naming scheme are ignored\&. You don\'t need this
5820 variable if you don\'t verify client certificates\&.
5823 \f(CW ssl CA certDir = /usr/local/ssl/certs\fP
5825 .IP "\fBssl CA certFile (G)\fP"
5827 This variable is part of SSL-enabled Samba\&. This is only available if
5828 the SSL libraries have been compiled on your system and the configure
5829 option \f(CW"--with-ssl"\fP was given at configure time\&.
5831 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5832 enabled by default in any current binary version of Samba\&.
5834 This variable is a second way to define the trusted CAs\&. The
5835 certificates of the trusted CAs are collected in one big file and this
5836 variable points to the file\&. You will probably only use one of the two
5837 ways to define your CAs\&. The first choice is preferable if you have
5838 many CAs or want to be flexible, the second is preferable if you only
5839 have one CA and want to keep things simple (you won\'t need to create
5840 the hashed file names)\&. You don\'t need this variable if you don\'t
5841 verify client certificates\&.
5844 \f(CW ssl CA certFile = /usr/local/ssl/certs/trustedCAs\&.pem\fP
5846 .IP "\fBssl ciphers (G)\fP"
5848 This variable is part of SSL-enabled Samba\&. This is only available if
5849 the SSL libraries have been compiled on your system and the configure
5850 option \f(CW"--with-ssl"\fP was given at configure time\&.
5852 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5853 enabled by default in any current binary version of Samba\&.
5855 This variable defines the ciphers that should be offered during SSL
5856 negotiation\&. You should not set this variable unless you know what you
5859 .IP "\fBssl client cert (G)\fP"
5861 This variable is part of SSL-enabled Samba\&. This is only available if
5862 the SSL libraries have been compiled on your system and the configure
5863 option \f(CW"--with-ssl"\fP was given at configure time\&.
5865 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5866 enabled by default in any current binary version of Samba\&.
5868 The certificate in this file is used by
5869 \fBsmbclient\fP if it exists\&. It\'s needed if the
5870 server requires a client certificate\&.
5873 \f(CW ssl client cert = /usr/local/ssl/certs/smbclient\&.pem\fP
5875 .IP "\fBssl client key (G)\fP"
5877 This variable is part of SSL-enabled Samba\&. This is only available if
5878 the SSL libraries have been compiled on your system and the configure
5879 option \f(CW"--with-ssl"\fP was given at configure time\&.
5881 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5882 enabled by default in any current binary version of Samba\&.
5884 This is the private key for \fBsmbclient\fP\&. It\'s
5885 only needed if the client should have a certificate\&.
5888 \f(CW ssl client key = /usr/local/ssl/private/smbclient\&.pem\fP
5890 .IP "\fBssl compatibility (G)\fP"
5892 This variable is part of SSL-enabled Samba\&. This is only available if
5893 the SSL libraries have been compiled on your system and the configure
5894 option \f(CW"--with-ssl"\fP was given at configure time\&.
5896 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5897 enabled by default in any current binary version of Samba\&.
5899 This variable defines whether SSLeay should be configured for bug
5900 compatibility with other SSL implementations\&. This is probably not
5901 desirable because currently no clients with SSL implementations other
5902 than SSLeay exist\&.
5905 \f(CW ssl compatibility = no\fP
5907 .IP "\fBssl hosts (G)\fP"
5909 See \fB"ssl hosts resign"\fP\&.
5911 .IP "\fBssl hosts resign (G)\fP"
5913 This variable is part of SSL-enabled Samba\&. This is only available if
5914 the SSL libraries have been compiled on your system and the configure
5915 option \f(CW"--with-ssl"\fP was given at configure time\&.
5917 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5918 enabled by default in any current binary version of Samba\&.
5920 These two variables define whether samba will go into SSL mode or
5921 not\&. If none of them is defined, samba will allow only SSL
5922 connections\&. If the \fB"ssl hosts"\fP variable lists
5923 hosts (by IP-address, IP-address range, net group or name), only these
5924 hosts will be forced into SSL mode\&. If the \fB"ssl hosts resign"\fP
5925 variable lists hosts, only these hosts will NOT be forced into SSL
5926 mode\&. The syntax for these two variables is the same as for the
5927 \fB"hosts allow"\fP and \fB"hosts
5928 deny"\fP pair of variables, only that the subject of the
5929 decision is different: It\'s not the access right but whether SSL is
5930 used or not\&. See the \fB"allow hosts"\fP parameter for
5931 details\&. The example below requires SSL connections from all hosts
5932 outside the local net (which is 192\&.168\&.*\&.*)\&.
5935 \f(CW ssl hosts = <empty string>\fP
5936 \f(CW ssl hosts resign = <empty string>\fP
5939 \f(CW ssl hosts resign = 192\&.168\&.\fP
5941 .IP "\fBssl require clientcert (G)\fP"
5943 This variable is part of SSL-enabled Samba\&. This is only available if
5944 the SSL libraries have been compiled on your system and the configure
5945 option \f(CW"--with-ssl"\fP was given at configure time\&.
5947 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5948 enabled by default in any current binary version of Samba\&.
5950 If this variable is set to \f(CW"yes"\fP, the server will not tolerate
5951 connections from clients that don\'t have a valid certificate\&. The
5952 directory/file given in \fB"ssl CA certDir"\fP and
5953 \fB"ssl CA certFile"\fP will be used to look up the
5954 CAs that issued the client\'s certificate\&. If the certificate can\'t be
5955 verified positively, the connection will be terminated\&. If this
5956 variable is set to \f(CW"no"\fP, clients don\'t need certificates\&. Contrary
5957 to web applications you really \fI*should*\fP require client
5958 certificates\&. In the web environment the client\'s data is sensitive
5959 (credit card numbers) and the server must prove to be trustworthy\&. In
5960 a file server environment the server\'s data will be sensitive and the
5961 clients must prove to be trustworthy\&.
5964 \f(CW ssl require clientcert = no\fP
5966 .IP "\fBssl require servercert (G)\fP"
5968 This variable is part of SSL-enabled Samba\&. This is only available if
5969 the SSL libraries have been compiled on your system and the configure
5970 option \f(CW"--with-ssl"\fP was given at configure time\&.
5972 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5973 enabled by default in any current binary version of Samba\&.
5975 If this variable is set to \f(CW"yes"\fP, the
5976 \fBsmbclient\fP will request a certificate from
5977 the server\&. Same as \fB"ssl require
5978 clientcert"\fP for the server\&.
5981 \f(CW ssl require servercert = no\fP
5983 .IP "\fBssl server cert (G)\fP"
5985 This variable is part of SSL-enabled Samba\&. This is only available if
5986 the SSL libraries have been compiled on your system and the configure
5987 option \f(CW"--with-ssl"\fP was given at configure time\&.
5989 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5990 enabled by default in any current binary version of Samba\&.
5992 This is the file containing the server\'s certificate\&. The server _must_
5993 have a certificate\&. The file may also contain the server\'s private key\&.
5994 See later for how certificates and private keys are created\&.
5997 \f(CW ssl server cert = <empty string>\fP
5999 .IP "\fBssl server key (G)\fP"
6001 This variable is part of SSL-enabled Samba\&. This is only available if
6002 the SSL libraries have been compiled on your system and the configure
6003 option \f(CW"--with-ssl"\fP was given at configure time\&.
6005 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
6006 enabled by default in any current binary version of Samba\&.
6008 This file contains the private key of the server\&. If this variable is
6009 not defined, the key is looked up in the certificate file (it may be
6010 appended to the certificate)\&. The server \fI*must*\fP have a private key
6011 and the certificate \fI*must*\fP match this private key\&.
6014 \f(CW ssl server key = <empty string>\fP
6016 .IP "\fBssl version (G)\fP"
6018 This variable is part of SSL-enabled Samba\&. This is only available if
6019 the SSL libraries have been compiled on your system and the configure
6020 option \f(CW"--with-ssl"\fP was given at configure time\&.
6022 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
6023 enabled by default in any current binary version of Samba\&.
6025 This enumeration variable defines the versions of the SSL protocol
6026 that will be used\&. \f(CW"ssl2or3"\fP allows dynamic negotiation of SSL v2
6027 or v3, \f(CW"ssl2"\fP results in SSL v2, \f(CW"ssl3"\fP results in SSL v3 and
6028 "tls1" results in TLS v1\&. TLS (Transport Layer Security) is the
6029 (proposed?) new standard for SSL\&.
6032 \f(CW ssl version = "ssl2or3"\fP
6034 .IP "\fBstat cache (G)\fP"
6036 This parameter determines if \fBsmbd\fP will use a
6037 cache in order to speed up case insensitive name mappings\&. You should
6038 never need to change this parameter\&.
6041 \f(CW stat cache = yes\fP
6043 .IP "\fBstat cache size (G)\fP"
6045 This parameter determines the number of entries in the \fBstat
6046 cache\fP\&. You should never need to change this parameter\&.
6049 \f(CW stat cache size = 50\fP
6051 .IP "\fBstatus (G)\fP"
6053 This enables or disables logging of connections to a status file that
6054 \fBsmbstatus\fP can read\&.
6056 With this disabled \fBsmbstatus\fP won\'t be able
6057 to tell you what connections are active\&. You should never need to
6058 change this parameter\&.
6063 .IP "\fBstrict locking (S)\fP"
6065 This is a boolean that controls the handling of file locking in the
6066 server\&. When this is set to \f(CW"yes"\fP the server will check every read and
6067 write access for file locks, and deny access if locks exist\&. This can
6068 be slow on some systems\&.
6070 When strict locking is \f(CW"no"\fP the server does file lock checks only
6071 when the client explicitly asks for them\&.
6073 Well behaved clients always ask for lock checks when it is important,
6074 so in the vast majority of cases \fB"strict locking = no"\fP is
6078 \f(CW strict locking = no\fP
6081 \f(CW strict locking = yes\fP
6083 .IP "\fBstrict sync (S)\fP"
6085 Many Windows applications (including the Windows 98 explorer shell)
6086 seem to confuse flushing buffer contents to disk with doing a sync to
6087 disk\&. Under UNIX, a sync call forces the process to be suspended until
6088 the kernel has ensured that all outstanding data in kernel disk
6089 buffers has been safely stored onto stable storage\&. This is very slow
6090 and should only be done rarely\&. Setting this parameter to "no" (the
6091 default) means that smbd ignores the Windows applications requests for
6092 a sync call\&. There is only a possibility of losing data if the
6093 operating system itself that Samba is running on crashes, so there is
6094 little danger in this default setting\&. In addition, this fixes many
6095 performance problems that people have reported with the new Windows98
6096 explorer shell file copies\&.
6098 See also the \fB"sync always"\fP parameter\&.
6101 \f(CW strict sync = no\fP
6104 \f(CW strict sync = yes\fP
6106 .IP "\fBstrip dot (G)\fP"
6108 This is a boolean that controls whether to strip trailing dots off
6109 UNIX filenames\&. This helps with some CDROMs that have filenames ending
6113 \f(CW strip dot = no\fP
6116 \f(CW strip dot = yes\fP
6118 .IP "\fBsync always (S)\fP"
6120 This is a boolean parameter that controls whether writes will always
6121 be written to stable storage before the write call returns\&. If this is
6122 false then the server will be guided by the client\'s request in each
6123 write call (clients can set a bit indicating that a particular write
6124 should be synchronous)\&. If this is true then every write will be
6125 followed by a fsync() call to ensure the data is written to disk\&.
6126 Note that the \fB"strict sync"\fP parameter must be
6127 set to \f(CW"yes"\fP in order for this parameter to have any affect\&.
6129 See also the \fB"strict sync"\fP parameter\&.
6132 \f(CW sync always = no\fP
6135 \f(CW sync always = yes\fP
6137 .IP "\fBsyslog (G)\fP"
6139 This parameter maps how Samba debug messages are logged onto the
6140 system syslog logging levels\&. Samba debug level zero maps onto syslog
6141 LOG_ERR, debug level one maps onto LOG_WARNING, debug level two maps
6142 onto LOG_NOTICE, debug level three maps onto LOG_INFO\&. All higher
6143 levels are mapped to LOG_DEBUG\&.
6145 This paramter sets the threshold for sending messages to syslog\&.
6146 Only messages with debug level less than this value will be sent
6152 .IP "\fBsyslog only (G)\fP"
6154 If this parameter is set then Samba debug messages are logged into the
6155 system syslog only, and not to the debug log files\&.
6158 \f(CW syslog only = no\fP
6160 .IP "\fBtime offset (G)\fP"
6162 This parameter is a setting in minutes to add to the normal GMT to
6163 local time conversion\&. This is useful if you are serving a lot of PCs
6164 that have incorrect daylight saving time handling\&.
6167 \f(CW time offset = 0\fP
6170 \f(CW time offset = 60\fP
6173 .IP "\fBtime server (G)\fP"
6175 This parameter determines if \fBnmbd\fP advertises
6176 itself as a time server to Windows clients\&. The default is False\&.
6179 \f(CW time server = False\fP
6182 \f(CW time server = True\fP
6184 .IP "\fBtimestamp logs (G)\fP"
6186 Samba2\&.0 will a timestamps to all log entries by default\&. This
6187 can be distracting if you are attempting to debug a problem\&. This
6188 parameter allows the timestamping to be turned off\&.
6191 \f(CW timestamp logs = True\fP
6194 \f(CW timestamp logs = False\fP
6196 .IP "\fBunix password sync (G)\fP"
6198 This boolean parameter controls whether Samba attempts to synchronize
6199 the UNIX password with the SMB password when the encrypted SMB
6200 password in the smbpasswd file is changed\&. If this is set to true the
6201 program specified in the \fB"passwd program"\fP
6202 parameter is called \fI*AS ROOT*\fP - to allow the new UNIX password to be
6203 set without access to the old UNIX password (as the SMB password has
6204 change code has no access to the old password cleartext, only the
6205 new)\&. By default this is set to \f(CW"false"\fP\&.
6207 See also \fB"passwd program"\fP, \fB"passwd
6211 \f(CW unix password sync = False\fP
6214 \f(CW unix password sync = True\fP
6216 .IP "\fBunix realname (G)\fP"
6218 This boolean parameter when set causes samba to supply the real name
6219 field from the unix password file to the client\&. This is useful for
6220 setting up mail clients and WWW browsers on systems used by more than
6224 \f(CW unix realname = no\fP
6227 \f(CW unix realname = yes\fP
6229 .IP "\fBupdate encrypted (G)\fP"
6231 This boolean parameter allows a user logging on with a plaintext
6232 password to have their encrypted (hashed) password in the smbpasswd
6233 file to be updated automatically as they log on\&. This option allows a
6234 site to migrate from plaintext password authentication (users
6235 authenticate with plaintext password over the wire, and are checked
6236 against a UNIX account database) to encrypted password authentication
6237 (the SMB challenge/response authentication mechanism) without forcing
6238 all users to re-enter their passwords via smbpasswd at the time the
6239 change is made\&. This is a convenience option to allow the change over
6240 to encrypted passwords to be made over a longer period\&. Once all users
6241 have encrypted representations of their passwords in the smbpasswd
6242 file this parameter should be set to \f(CW"off"\fP\&.
6244 In order for this parameter to work correctly the \fB"encrypt
6245 passwords"\fP parameter must be set to \f(CW"no"\fP when
6246 this parameter is set to \f(CW"yes"\fP\&.
6248 Note that even when this parameter is set a user authenticating to
6249 smbd must still enter a valid password in order to connect correctly,
6250 and to update their hashed (smbpasswd) passwords\&.
6253 \f(CW update encrypted = no\fP
6256 \f(CW update encrypted = yes\fP
6258 .IP "\fBuse rhosts (G)\fP"
6260 If this global parameter is a true, it specifies that the UNIX users
6261 \f(CW"\&.rhosts"\fP file in their home directory will be read to find the
6262 names of hosts and users who will be allowed access without specifying
6265 NOTE: The use of \fBuse rhosts\fP can be a major security hole\&. This is
6266 because you are trusting the PC to supply the correct username\&. It is
6267 very easy to get a PC to supply a false username\&. I recommend that the
6268 \fBuse rhosts\fP option be only used if you really know what you are
6272 \f(CW use rhosts = no\fP
6275 \f(CW use rhosts = yes\fP
6277 .IP "\fBuser (S)\fP"
6279 Synonym for \fB"username"\fP\&.
6281 .IP "\fBusers (S)\fP"
6283 Synonym for \fB"username"\fP\&.
6285 .IP "\fBusername (S)\fP"
6287 Multiple users may be specified in a comma-delimited list, in which
6288 case the supplied password will be tested against each username in
6289 turn (left to right)\&.
6291 The \fBusername=\fP line is needed only when the PC is unable to supply
6292 its own username\&. This is the case for the COREPLUS protocol or where
6293 your users have different WfWg usernames to UNIX usernames\&. In both
6294 these cases you may also be better using the \f(CW\e\eserver\eshare%user\fP
6297 The \fBusername=\fP line is not a great solution in many cases as it
6298 means Samba will try to validate the supplied password against each of
6299 the usernames in the username= line in turn\&. This is slow and a bad
6300 idea for lots of users in case of duplicate passwords\&. You may get
6301 timeouts or security breaches using this parameter unwisely\&.
6303 Samba relies on the underlying UNIX security\&. This parameter does not
6304 restrict who can login, it just offers hints to the Samba server as to
6305 what usernames might correspond to the supplied password\&. Users can
6306 login as whoever they please and they will be able to do no more
6307 damage than if they started a telnet session\&. The daemon runs as the
6308 user that they log in as, so they cannot do anything that user cannot
6311 To restrict a service to a particular set of users you can use the
6312 \fB"valid users="\fP parameter\&.
6314 If any of the usernames begin with a \f(CW\'@\'\fP then the name will be
6315 looked up first in the yp netgroups list (if Samba is compiled with
6316 netgroup support), followed by a lookup in the UNIX groups database
6317 and will expand to a list of all users in the group of that name\&.
6319 If any of the usernames begin with a \f(CW\'+\'\fP then the name will be
6320 looked up only in the UNIX groups database and will expand to a list
6321 of all users in the group of that name\&.
6323 If any of the usernames begin with a \f(CW\'&\'\fP then the name will be
6324 looked up only in the yp netgroups database (if Samba is compiled with
6325 netgroup support) and will expand to a list of all users in the
6326 netgroup group of that name\&.
6328 Note that searching though a groups database can take quite some time,
6329 and some clients may time out during the search\&.
6331 See the section \fB"NOTE ABOUT USERNAME/PASSWORD
6332 VALIDATION"\fP for more
6333 information on how this parameter determines access to the services\&.
6336 \f(CW The guest account if a guest service, else the name of the service\&.\fP
6344 username = fred, mary, jack, jane, @users, @pcgroup
6350 .IP "\fBusername level (G)\fP"
6352 This option helps Samba to try and \'guess\' at the real UNIX username,
6353 as many DOS clients send an all-uppercase username\&. By default Samba
6354 tries all lowercase, followed by the username with the first letter
6355 capitalized, and fails if the username is not found on the UNIX
6358 If this parameter is set to non-zero the behavior changes\&. This
6359 parameter is a number that specifies the number of uppercase
6360 combinations to try whilst trying to determine the UNIX user name\&. The
6361 higher the number the more combinations will be tried, but the slower
6362 the discovery of usernames will be\&. Use this parameter when you have
6363 strange usernames on your UNIX machine, such as \f(CW"AstrangeUser"\fP\&.
6366 \f(CW username level = 0\fP
6369 \f(CW username level = 5\fP
6371 .IP "\fBusername map (G)\fP"
6373 This option allows you to specify a file containing a mapping of
6374 usernames from the clients to the server\&. This can be used for several
6375 purposes\&. The most common is to map usernames that users use on DOS or
6376 Windows machines to those that the UNIX box uses\&. The other is to map
6377 multiple users to a single username so that they can more easily share
6380 The map file is parsed line by line\&. Each line should contain a single
6381 UNIX username on the left then a \f(CW\'=\'\fP followed by a list of
6382 usernames on the right\&. The list of usernames on the right may contain
6383 names of the form @group in which case they will match any UNIX
6384 username in that group\&. The special client name \f(CW\'*\'\fP is a wildcard
6385 and matches any name\&. Each line of the map file may be up to 1023
6388 The file is processed on each line by taking the supplied username and
6389 comparing it with each username on the right hand side of the \f(CW\'=\'\fP
6390 signs\&. If the supplied name matches any of the names on the right hand
6391 side then it is replaced with the name on the left\&. Processing then
6392 continues with the next line\&.
6394 If any line begins with a \f(CW\'#\'\fP or a \f(CW\';\'\fP then it is ignored
6396 If any line begins with an \f(CW\'!\'\fP then the processing will stop after
6397 that line if a mapping was done by the line\&. Otherwise mapping
6398 continues with every line being processed\&. Using \f(CW\'!\'\fP is most
6399 useful when you have a wildcard mapping line later in the file\&.
6401 For example to map from the name \f(CW"admin"\fP or \f(CW"administrator"\fP to
6402 the UNIX name \f(CW"root"\fP you would use:
6404 \f(CW root = admin administrator\fP
6406 Or to map anyone in the UNIX group \f(CW"system"\fP to the UNIX name
6407 \f(CW"sys"\fP you would use:
6409 \f(CW sys = @system\fP
6411 You can have as many mappings as you like in a username map file\&.
6413 If your system supports the NIS NETGROUP option then the netgroup
6414 database is checked before the \f(CW/etc/group\fP database for matching
6417 You can map Windows usernames that have spaces in them by using double
6418 quotes around the name\&. For example:
6420 \f(CW tridge = "Andrew Tridgell"\fP
6422 would map the windows username \f(CW"Andrew Tridgell"\fP to the unix
6425 The following example would map mary and fred to the unix user sys,
6426 and map the rest to guest\&. Note the use of the \f(CW\'!\'\fP to tell Samba
6427 to stop processing if it gets a match on that line\&.
6440 Note that the remapping is applied to all occurrences of
6441 usernames\&. Thus if you connect to \f(CW"\e\eserver\efred"\fP and \f(CW"fred"\fP
6442 is remapped to \f(CW"mary"\fP then you will actually be connecting to
6443 \f(CW"\e\eserver\emary"\fP and will need to supply a password suitable for
6444 \f(CW"mary"\fP not \f(CW"fred"\fP\&. The only exception to this is the username
6445 passed to the \fB"password server"\fP (if you have
6446 one)\&. The password server will receive whatever username the client
6447 supplies without modification\&.
6449 Also note that no reverse mapping is done\&. The main effect this has is
6450 with printing\&. Users who have been mapped may have trouble deleting
6451 print jobs as PrintManager under WfWg will think they don\'t own the
6455 \f(CW no username map\fP
6458 \f(CW username map = /usr/local/samba/lib/users\&.map\fP
6460 .IP "\fBvalid chars (S)\fP"
6462 The option allows you to specify additional characters that should be
6463 considered valid by the server in filenames\&. This is particularly
6464 useful for national character sets, such as adding u-umlaut or a-ring\&.
6466 The option takes a list of characters in either integer or character
6467 form with spaces between them\&. If you give two characters with a colon
6468 between them then it will be taken as an lowercase:uppercase pair\&.
6470 If you have an editor capable of entering the characters into the
6471 config file then it is probably easiest to use this method\&. Otherwise
6472 you can specify the characters in octal, decimal or hexadecimal form
6473 using the usual C notation\&.
6475 For example to add the single character \f(CW\'Z\'\fP to the charset (which
6476 is a pointless thing to do as it\'s already there) you could do one of
6485 valid chars = 0132:0172
6491 The last two examples above actually add two characters, and alter the
6492 uppercase and lowercase mappings appropriately\&.
6494 Note that you MUST specify this parameter after the \fB"client
6495 code page"\fP parameter if you have both set\&. If
6496 \fB"client code page"\fP is set after the
6497 \fB"valid chars"\fP parameter the \fB"valid chars"\fP settings will be
6500 See also the \fB"client code page"\fP parameter\&.
6507 Samba defaults to using a reasonable set of valid characters
6515 \f(CW valid chars = 0345:0305 0366:0326 0344:0304\fP
6517 The above example allows filenames to have the Swedish characters in
6520 NOTE: It is actually quite difficult to correctly produce a \fB"valid
6521 chars"\fP line for a particular system\&. To automate the process
6522 \fItino@augsburg\&.net\fP has written a package called \fB"validchars"\fP
6523 which will automatically produce a complete \fB"valid chars"\fP line for
6524 a given client system\&. Look in the examples/validchars/ subdirectory
6525 of your Samba source code distribution for this package\&.
6527 .IP "\fBvalid users (S)\fP"
6529 This is a list of users that should be allowed to login to this
6530 service\&. Names starting with \f(CW\'@\'\fP, \f(CW\'+\'\fP and \f(CW\'&\'\fP are
6531 interpreted using the same rules as described in the \fB"invalid
6532 users"\fP parameter\&.
6534 If this is empty (the default) then any user can login\&. If a username
6535 is in both this list and the \fB"invalid users"\fP
6536 list then access is denied for that user\&.
6538 The current servicename is substituted for
6539 \fB"%S"\fP\&. This is useful in the
6540 \fB[homes]\fP section\&.
6542 See also \fB"invalid users"\fP\&.
6545 \f(CW No valid users list\&. (anyone can login)\fP
6548 \f(CW valid users = greg, @pcusers\fP
6550 .IP "\fBveto files(S)\fP"
6552 This is a list of files and directories that are neither visible nor
6553 accessible\&. Each entry in the list must be separated by a \f(CW\'/\'\fP,
6554 which allows spaces to be included in the entry\&. \f(CW\'*\'\fP and \f(CW\'?\'\fP
6555 can be used to specify multiple files or directories as in DOS
6558 Each entry must be a unix path, not a DOS path and must \fI*not*\fP include the
6559 unix directory separator \f(CW\'/\'\fP\&.
6561 Note that the \fB"case sensitive"\fP option is
6562 applicable in vetoing files\&.
6564 One feature of the veto files parameter that it is important to be
6565 aware of, is that if a directory contains nothing but files that match
6566 the veto files parameter (which means that Windows/DOS clients cannot
6567 ever see them) is deleted, the veto files within that directory *are
6568 automatically deleted* along with it, if the user has UNIX permissions
6571 Setting this parameter will affect the performance of Samba, as it
6572 will be forced to check all files and directories for a match as they
6575 See also \fB"hide files"\fP and \fB"case
6579 \f(CW No files or directories are vetoed\&.\fP
6590 Veto any files containing the word Security,
6591 any ending in \&.tmp, and any directory containing the
6594 veto files = /*Security*/*\&.tmp/*root*/
6606 Veto the Apple specific files that a NetAtalk server
6609 veto files = /\&.AppleDouble/\&.bin/\&.AppleDesktop/Network Trash Folder/
6615 .IP "\fBveto oplock files (S)\fP"
6617 This parameter is only valid when the \fB"oplocks"\fP
6618 parameter is turned on for a share\&. It allows the Samba administrator
6619 to selectively turn off the granting of oplocks on selected files that
6620 match a wildcarded list, similar to the wildcarded list used in the
6621 \fB"veto files"\fP parameter\&.
6624 \f(CW No files are vetoed for oplock grants\&.\fP
6628 You might want to do this on files that you know will be heavily
6629 contended for by clients\&. A good example of this is in the NetBench
6630 SMB benchmark program, which causes heavy client contention for files
6631 ending in \f(CW"\&.SEM"\fP\&. To cause Samba not to grant oplocks on these
6632 files you would use the line (either in the \fB[global]\fP
6633 section or in the section for the particular NetBench share :
6635 \f(CW veto oplock files = /*\&.SEM/\fP
6637 .IP "\fBvolume (S)\fP"
6639 This allows you to override the volume label returned for a
6640 share\&. Useful for CDROMs with installation programs that insist on a
6641 particular volume label\&.
6643 The default is the name of the share\&.
6645 .IP "\fBwide links (S)\fP"
6647 This parameter controls whether or not links in the UNIX file system
6648 may be followed by the server\&. Links that point to areas within the
6649 directory tree exported by the server are always allowed; this
6650 parameter controls access only to areas that are outside the directory
6651 tree being exported\&.
6653 Note that setting this parameter can have a negative effect on your
6654 server performance due to the extra system calls that Samba has to
6655 do in order to perform the link checks\&.
6658 \f(CW wide links = yes\fP
6661 \f(CW wide links = no\fP
6663 .IP "\fBwins proxy (G)\fP"
6665 This is a boolean that controls if \fBnmbd\fP will
6666 respond to broadcast name queries on behalf of other hosts\&. You may
6667 need to set this to \f(CW"yes"\fP for some older clients\&.
6670 \f(CW wins proxy = no\fP
6672 .IP "\fBwins server (G)\fP"
6674 This specifies the IP address (or DNS name: IP address for preference)
6675 of the WINS server that \fBnmbd\fP should register with\&.
6676 If you have a WINS server on your network then you should set this to
6677 the WINS server\'s IP\&.
6679 You should point this at your WINS server if you have a
6680 multi-subnetted network\&.
6682 \fINOTE\fP\&. You need to set up Samba to point to a WINS server if you
6683 have multiple subnets and wish cross-subnet browsing to work correctly\&.
6685 See the documentation file BROWSING\&.txt in the docs/ directory of your
6686 Samba source distribution\&.
6689 \f(CW wins server = \fP
6692 \f(CW wins server = 192\&.9\&.200\&.1\fP
6694 .IP "\fBwins hook (G)\fP"
6696 When Samba is running as a WINS server this allows you to call an
6697 external program for all changes to the WINS database\&. The primary use
6698 for this option is to allow the dynamic update of external name
6699 resolution databases such as dynamic DNS\&.
6701 The wins hook parameter specifies the name of a script or executable
6702 that will be called as follows:
6704 wins_hook operation name nametype ttl IP_list
6706 The first argument is the operation and is one of "add", "delete",
6707 or "refresh"\&. In most cases the operation can be ignored as the rest
6708 of the parameters provide sufficient information\&. Note that "refresh"
6709 may sometimes be called when the name has not previously been added,
6710 in that case it should be treated as an add\&.
6712 The second argument is the netbios name\&. If the name is not a legal
6713 name then the wins hook is not called\&. Legal names contain only
6714 letters, digits, hyphens, underscores and periods\&.
6716 The third argument is the netbios name type as a 2 digit hexadecimal
6719 The fourth argument is the TTL (time to live) for the name in seconds\&.
6721 The fifth and subsequent arguments are the IP addresses currently
6722 registered for that name\&. If this list is empty then the name should
6725 An example script that calls the BIND dynamic DNS update program
6726 "nsupdate" is provided in the examples directory of the Samba source
6729 .IP "\fBwins support (G)\fP"
6731 This boolean controls if the \fBnmbd\fP process in
6732 Samba will act as a WINS server\&. You should not set this to true
6733 unless you have a multi-subnetted network and you wish a particular
6734 \fBnmbd\fP to be your WINS server\&. Note that you
6735 should \fI*NEVER*\fP set this to true on more than one machine in your
6739 \f(CW wins support = no\fP
6741 .IP "\fBworkgroup (G)\fP"
6743 This controls what workgroup your server will appear to be in when
6744 queried by clients\&. Note that this parameter also controls the Domain
6745 name used with the \fB"security=domain"\fP
6749 \f(CW set at compile time to WORKGROUP\fP
6754 .IP "\fBwritable (S)\fP"
6756 Synonym for \fB"writeable"\fP for people who can\'t spell :-)\&.
6758 .IP "\fBwrite list (S)\fP"
6760 This is a list of users that are given read-write access to a
6761 service\&. If the connecting user is in this list then they will be
6762 given write access, no matter what the \fB"read only"\fP
6763 option is set to\&. The list can include group names using the @group
6766 Note that if a user is in both the read list and the write list then
6767 they will be given write access\&.
6769 See also the \fB"read list"\fP option\&.
6772 \f(CW write list = <empty string>\fP
6775 \f(CW write list = admin, root, @staff\fP
6777 .IP "\fBwrite ok (S)\fP"
6779 Synonym for \fBwriteable\fP\&.
6781 .IP "\fBwrite raw (G)\fP"
6783 This parameter controls whether or not the server will support raw
6784 writes SMB\'s when transferring data from clients\&. You should never
6785 need to change this parameter\&.
6788 \f(CW write raw = yes\fP
6790 .IP "\fBwriteable\fP"
6792 An inverted synonym is \fB"read only"\fP\&.
6794 If this parameter is \f(CW"no"\fP, then users of a service may not create
6795 or modify files in the service\'s directory\&.
6797 Note that a printable service \fB("printable = yes")\fP
6798 will \fI*ALWAYS*\fP allow writing to the directory (user privileges
6799 permitting), but only via spooling operations\&.
6802 \f(CW writeable = no\fP
6820 Although the configuration file permits service names to contain
6821 spaces, your client software may not\&. Spaces will be ignored in
6822 comparisons anyway, so it shouldn\'t be a problem - but be aware of the
6825 On a similar note, many clients - especially DOS clients - limit
6826 service names to eight characters\&. \fBSmbd\fP has no
6827 such limitation, but attempts to connect from such clients will fail
6828 if they truncate the service names\&. For this reason you should
6829 probably keep your service names down to eight characters in length\&.
6831 Use of the \fB[homes]\fP and \fB[printers]\fP
6832 special sections make life for an administrator easy, but the various
6833 combinations of default attributes can be tricky\&. Take extreme care
6834 when designing these sections\&. In particular, ensure that the
6835 permissions on spool directories are correct\&.
6839 This man page is correct for version 2\&.0 of the Samba suite\&.
6843 \fBsmbd (8)\fP, \fBsmbclient (1)\fP,
6844 \fBnmbd (8)\fP, \fBtestparm (1)\fP,
6845 \fBtestprns (1)\fP, \fBSamba\fP,
6846 \fBnmblookup (1)\fP, \fBsmbpasswd (5)\fP,
6847 \fBsmbpasswd (8)\fP\&.
6851 The original Samba software and related utilities were created by
6852 Andrew Tridgell \fIsamba-bugs@samba\&.org\fP\&. Samba is now developed
6853 by the Samba Team as an Open Source project similar to the way the
6854 Linux kernel is developed\&.
6856 The original Samba man pages were written by Karl Auer\&. The man page
6857 sources were converted to YODL format (another excellent piece of Open
6858 Source software, available at
6859 \fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP)
6860 and updated for the Samba2\&.0 release by Jeremy Allison\&.
6861 \fIsamba-bugs@samba\&.org\fP\&.
6863 See \fBsamba (7)\fP to find out how to get a full
6864 list of contributors and details on how to submit bug reports,
git.samba.org / kai / samba-autobuild / .git / blob