1 .TH SMB.CONF 5 "18 May 1999" "smb.conf 2.0.4"
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 timestamp\fP
542 \fBdefault service\fP
545 \fBdelete user script\fP
554 \fBdomain admin group\fP
557 \fBdomain admin users\fP
560 \fBdomain controller\fP
566 \fBdomain guest group\fP
569 \fBdomain guest users\fP
578 \fBencrypt passwords\fP
608 \fBldap root passwd\fP
656 \fBmachine password timeout\fP
689 \fBmessage command\fP
692 \fBmin passwd length\fP
698 \fBname resolve order\fP
701 \fBnetbios aliases\fP
713 \fBnt pipe support\fP
722 \fBole locking compatibility\fP
725 \fBoplock break wait time\fP
740 \fBpasswd chat debug\fP
749 \fBpassword server\fP
752 \fBprefered master\fP
755 \fBpreferred master\fP
767 \fBprinter driver file\fP
776 \fBread prediction\fP
785 \fBremote announce\fP
788 \fBremote browse sync\fP
791 \fBrestrict anonymous\fP
809 \fBshared mem size\fP
812 \fBsmb passwd file\fP
830 \fBssl CA certFile\fP
836 \fBssl client cert\fP
842 \fBssl compatibility\fP
848 \fBssl hosts resign\fP
851 \fBssl require clientcert\fP
854 \fBssl require servercert\fP
857 \fBssl server cert\fP
869 \fBstat cache size\fP
890 \fBunix password sync\fP
896 \fBupdate encrypted\fP
926 .SH "COMPLETE LIST OF SERVICE PARAMETERS"
928 Here is a list of all service parameters\&. See the section of each
929 parameter for details\&. Note that some are synonyms\&.
939 \fBalternate permissions\fP
975 \fBdelete readonly\fP
978 \fBdelete veto files\fP
996 \fBdos filetime resolution\fP
1005 \fBfake directory create times\fP
1011 \fBfollow symlinks\fP
1014 \fBforce create mode\fP
1017 \fBforce directory mode\fP
1041 \fBhide dot files\fP
1062 \fBlppause command\fP
1068 \fBlpresume command\fP
1104 \fBmax connections\fP
1107 \fBmin print space\fP
1119 \fBoplock contention limit\fP
1149 \fBprinter driver\fP
1152 \fBprinter driver location\fP
1164 \fBqueuepause command\fP
1167 \fBqueueresume command\fP
1191 \fBshort preserve case\fP
1197 \fBstrict locking\fP
1221 \fBveto oplock files\fP
1242 .SH "EXPLANATION OF EACH PARAMETER"
1245 .IP "\fBadd user script (G)\fP"
1247 This is the full pathname to a script that will be run \fIAS ROOT\fP by
1248 \fBsmbd (8)\fP under special circumstances decribed
1251 Normally, a Samba server requires that UNIX users are created for all
1252 users accessing files on this server\&. For sites that use Windows NT
1253 account databases as their primary user database creating these users
1254 and keeping the user list in sync with the Windows NT PDC is an
1255 onerous task\&. This option allows \fBsmbd\fP to create
1256 the required UNIX users \fION DEMAND\fP when a user accesses the Samba
1259 In order to use this option, \fBsmbd\fP must be set to
1260 \fBsecurity=server\fP or
1261 \fBsecurity=domain\fP and \fB"add user script"\fP
1262 must be set to a full pathname for a script that will create a UNIX user
1263 given one argument of \fB%u\fP, which expands into the UNIX user name to
1266 When the Windows user attempts to access the Samba server, at
1267 \fI"login"\fP(session setup in the SMB protocol) time,
1268 \fBsmbd\fP contacts the \fBpassword
1269 server\fP and attempts to authenticate the given user
1270 with the given password\&. If the authentication succeeds then
1271 \fBsmbd\fP attempts to find a UNIX user in the UNIX
1272 password database to map the Windows user into\&. If this lookup fails,
1273 and \fB"add user script"\fP is set then \fBsmbd\fP will
1274 call the specified script \fIAS ROOT\fP, expanding any \fB%u\fP argument
1275 to be the user name to create\&.
1277 If this script successfully creates the user then
1278 \fBsmbd\fP will continue on as though the UNIX user
1279 already existed\&. In this way, UNIX users are dynamically created to
1280 match existing Windows NT accounts\&.
1282 See also \fBsecurity=server\fP,
1283 \fBsecurity=domain\fP, \fBpassword
1284 server\fP, \fBdelete user
1288 \f(CW add user script = <empty string>\fP
1291 \f(CW add user script = /usr/local/samba/bin/add_user %u\fP
1293 .IP "\fBadmin users (S)\fP"
1295 This is a list of users who will be granted administrative privileges
1296 on the share\&. This means that they will do all file operations as the
1297 super-user (root)\&.
1299 You should use this option very carefully, as any user in this list
1300 will be able to do anything they like on the share, irrespective of
1305 \f(CW no admin users\fP
1309 \f(CW admin users = jason\fP
1311 .IP "\fBallow hosts (S)\fP"
1313 Synonym for \fBhosts allow\fP\&.
1315 .IP "\fBallow trusted domains (G)\fP"
1317 This option only takes effect when the \fBsecurity\fP
1318 option is set to \fBserver\fP or \fBdomain\fP\&. If it is set to no,
1319 then attempts to connect to a resource from a domain or workgroup other than
1320 the one which smbd is running in will fail, even if that domain
1321 is trusted by the remote server doing the authentication\&.
1323 This is useful if you only want your Samba server to serve resources
1324 to users in the domain it is a member of\&. As an example, suppose that there are
1325 two domains DOMA and DOMB\&. DOMB is trusted by DOMA, which contains
1326 the Samba server\&. Under normal circumstances, a user with an account
1327 in DOMB can then access the resources of a UNIX account with the same
1328 account name on the Samba server even if they do not have an account
1329 in DOMA\&. This can make implementing a security boundary difficult\&.
1332 \f(CW allow trusted domains = Yes\fP
1335 \f(CW allow trusted domains = No\fP
1337 .IP "\fBalternate permissions (S)\fP"
1339 This is a deprecated parameter\&. It no longer has any effect in Samba2\&.0\&.
1340 In previous versions of Samba it affected the way the DOS "read only"
1341 attribute was mapped for a file\&. In Samba2\&.0 a file is marked "read only"
1342 if the UNIX file does not have the \'w\' bit set for the owner of the file,
1343 regardless if the owner of the file is the currently logged on user or not\&.
1345 .IP "\fBannounce as (G)\fP"
1347 This specifies what type of server \fBnmbd\fP will
1348 announce itself as, to a network neighborhood browse list\&. By default
1349 this is set to Windows NT\&. The valid options are : "NT", which is a
1350 synonym for "NT Server", "NT Server", "NT Workstation", "Win95" or
1351 "WfW" meaning Windows NT Server, Windows NT Workstation, Windows 95
1352 and Windows for Workgroups respectively\&. Do not change this parameter
1353 unless you have a specific need to stop Samba appearing as an NT server
1354 as this may prevent Samba servers from participating as browser servers correctly\&.
1357 \f(CW announce as = NT Server\fP
1360 \f(CW announce as = Win95\fP
1362 .IP "\fBannounce version (G)\fP"
1364 This specifies the major and minor version numbers that nmbd will use
1365 when announcing itself as a server\&. The default is 4\&.2\&. Do not change
1366 this parameter unless you have a specific need to set a Samba server
1367 to be a downlevel server\&.
1370 \f(CW announce version = 4\&.2\fP
1373 \f(CW announce version = 2\&.0\fP
1375 .IP "\fBauto services (G)\fP"
1377 This is a list of services that you want to be automatically added to
1378 the browse lists\&. This is most useful for homes and printers services
1379 that would otherwise not be visible\&.
1381 Note that if you just want all printers in your printcap file loaded
1382 then the \fB"load printers"\fP option is easier\&.
1385 \f(CW no auto services\fP
1388 \f(CW auto services = fred lp colorlp\fP
1390 .IP "\fBavailable (S)\fP"
1392 This parameter lets you \fI\'turn off\'\fP a service\&. If \f(CW\'available = no\'\fP,
1393 then \fIALL\fP attempts to connect to the service will fail\&. Such failures
1397 \f(CW available = yes\fP
1400 \f(CW available = no\fP
1402 .IP "\fBbind interfaces only (G)\fP"
1404 This global parameter allows the Samba admin to limit what interfaces
1405 on a machine will serve smb requests\&. If affects file service
1406 \fBsmbd\fP and name service \fBnmbd\fP
1407 in slightly different ways\&.
1409 For name service it causes \fBnmbd\fP to bind to ports
1410 137 and 138 on the interfaces listed in the
1411 \fB\'interfaces\'\fP
1412 parameter\&. \fBnmbd\fP also binds to the \'all
1413 addresses\' interface (0\&.0\&.0\&.0) on ports 137 and 138 for the purposes
1414 of reading broadcast messages\&. If this option is not set then
1415 \fBnmbd\fP will service name requests on all of these
1416 sockets\&. If \fB"bind interfaces only"\fP is set then
1417 \fBnmbd\fP will check the source address of any
1418 packets coming in on the broadcast sockets and discard any that don\'t
1419 match the broadcast addresses of the interfaces in the
1420 \fB\'interfaces\'\fP parameter list\&. As unicast packets
1421 are received on the other sockets it allows \fBnmbd\fP
1422 to refuse to serve names to machines that send packets that arrive
1423 through any interfaces not listed in the
1424 \fB"interfaces"\fP list\&. IP Source address spoofing
1425 does defeat this simple check, however so it must not be used
1426 seriously as a security feature for \fBnmbd\fP\&.
1428 For file service it causes \fBsmbd\fP to bind only to
1429 the interface list given in the \fB\'interfaces\'\fP
1430 parameter\&. This restricts the networks that \fBsmbd\fP
1431 will serve to packets coming in those interfaces\&. Note that you
1432 should not use this parameter for machines that are serving PPP or
1433 other intermittent or non-broadcast network interfaces as it will not
1434 cope with non-permanent interfaces\&.
1436 If \fB"bind interfaces only"\fP is set then unless the network address
1437 \fI127\&.0\&.0\&.1\fP is added to the \fB\'interfaces\'\fP parameter
1438 list \fBsmbpasswd\fP and
1439 \fBswat\fP may not work as expected due to the
1440 reasons covered below\&.
1442 To change a users SMB password, the \fBsmbpasswd\fP
1443 by default connects to the \fI"localhost" - 127\&.0\&.0\&.1\fP address as an SMB
1444 client to issue the password change request\&. If \fB"bind interfaces only"\fP
1445 is set then unless the network address \fI127\&.0\&.0\&.1\fP is added to the
1446 \fB\'interfaces\'\fP parameter list then
1447 \fBsmbpasswd\fP will fail to connect in it\'s
1448 default mode\&. \fBsmbpasswd\fP can be forced to
1449 use the primary IP interface of the local host by using its
1450 \fB"-r remote machine"\fP parameter, with
1451 \fB"remote machine"\fP set to the IP name of the primary interface
1452 of the local host\&.
1454 The \fBswat\fP status page tries to connect with
1455 \fBsmbd\fP and \fBnmbd\fP at the address
1456 \fI127\&.0\&.0\&.1\fP to determine if they are running\&. Not adding \fI127\&.0\&.0\&.1\fP will cause
1457 \fBsmbd\fP and \fBnmbd\fP to always show
1458 "not running" even if they really are\&. This can prevent
1459 \fBswat\fP from starting/stopping/restarting
1460 \fBsmbd\fP and \fBnmbd\fP\&.
1463 \f(CW bind interfaces only = False\fP
1466 \f(CW bind interfaces only = True\fP
1468 .IP "\fBblocking locks (S)\fP"
1470 This parameter controls the behavior of \fBsmbd\fP when
1471 given a request by a client to obtain a byte range lock on a region
1472 of an open file, and the request has a time limit associated with it\&.
1474 If this parameter is set and the lock range requested cannot be
1475 immediately satisfied, Samba 2\&.0 will internally queue the lock
1476 request, and periodically attempt to obtain the lock until the
1477 timeout period expires\&.
1479 If this parameter is set to "False", then Samba 2\&.0 will behave
1480 as previous versions of Samba would and will fail the lock
1481 request immediately if the lock range cannot be obtained\&.
1483 This parameter can be set per share\&.
1486 \f(CW blocking locks = True\fP
1489 \f(CW blocking locks = False\fP
1491 .IP "\fBbrowsable (S)\fP"
1493 Synonym for \fBbrowseable\fP\&.
1495 .IP "\fBbrowse list(G)\fP"
1497 This controls whether \fBsmbd\fP will serve a browse
1498 list to a client doing a NetServerEnum call\&. Normally set to true\&. You
1499 should never need to change this\&.
1502 \f(CW browse list = Yes\fP
1504 .IP "\fBbrowseable\fP"
1506 This controls whether this share is seen in the list of available
1507 shares in a net view and in the browse list\&.
1510 \f(CW browseable = Yes\fP
1513 \f(CW browseable = No\fP
1515 .IP "\fBcase sensitive (G)\fP"
1517 See the discussion in the section \fBNAME MANGLING\fP\&.
1519 .IP "\fBcasesignames (G)\fP"
1521 Synonym for \fB"case sensitive"\fP\&.
1523 .IP "\fBchange notify timeout (G)\fP"
1525 One of the new NT SMB requests that Samba 2\&.0 supports is the
1526 "ChangeNotify" requests\&. This SMB allows a client to tell a server to
1527 \fI"watch"\fP a particular directory for any changes and only reply to
1528 the SMB request when a change has occurred\&. Such constant scanning of
1529 a directory is expensive under UNIX, hence an
1530 \fBsmbd\fP daemon only performs such a scan on each
1531 requested directory once every \fBchange notify timeout\fP seconds\&.
1533 \fBchange notify timeout\fP is specified in units of seconds\&.
1536 \f(CW change notify timeout = 60\fP
1539 \f(CW change notify timeout = 300\fP
1541 Would change the scan time to every 5 minutes\&.
1543 .IP "\fBcharacter set (G)\fP"
1545 This allows a smbd to map incoming filenames from a DOS Code page (see
1546 the \fBclient code page\fP parameter) to several
1547 built in UNIX character sets\&. The built in code page translations are:
1551 \fBISO8859-1\fP Western European UNIX character set\&. The parameter
1552 \fBclient code page\fP \fIMUST\fP be set to code
1553 page 850 if the \fBcharacter set\fP parameter is set to iso8859-1
1554 in order for the conversion to the UNIX character set to be done
1558 \fBISO8859-2\fP Eastern European UNIX character set\&. The parameter
1559 \fBclient code page\fP \fIMUST\fP be set to code
1560 page 852 if the \fBcharacter set\fP parameter is set to ISO8859-2
1561 in order for the conversion to the UNIX character set to be done
1565 \fBISO8859-5\fP Russian Cyrillic UNIX character set\&. The parameter
1566 \fBclient code page\fP \fIMUST\fP be set to code
1567 page 866 if the \fBcharacter set\fP parameter is set to ISO8859-2
1568 in order for the conversion to the UNIX character set to be done
1572 \fBKOI8-R\fP Alternate mapping for Russian Cyrillic UNIX
1573 character set\&. The parameter \fBclient code
1574 page\fP \fIMUST\fP be set to code page 866 if the
1575 \fBcharacter set\fP parameter is set to KOI8-R in order for the
1576 conversion to the UNIX character set to be done correctly\&.
1579 \fIBUG\fP\&. These MSDOS code page to UNIX character set mappings should
1580 be dynamic, like the loading of MS DOS code pages, not static\&.
1582 See also \fBclient code page\fP\&. Normally this
1583 parameter is not set, meaning no filename translation is done\&.
1586 \f(CW character set = <empty string>\fP
1589 \f(CW character set = ISO8859-1\fP
1591 .IP "\fBclient code page (G)\fP"
1593 This parameter specifies the DOS code page that the clients accessing
1594 Samba are using\&. To determine what code page a Windows or DOS client
1595 is using, open a DOS command prompt and type the command "chcp"\&. This
1596 will output the code page\&. The default for USA MS-DOS, Windows 95, and
1597 Windows NT releases is code page 437\&. The default for western european
1598 releases of the above operating systems is code page 850\&.
1600 This parameter tells \fBsmbd\fP which of the
1601 \f(CWcodepage\&.XXX\fP files to dynamically load on startup\&. These files,
1602 described more fully in the manual page \fBmake_smbcodepage
1603 (1)\fP, tell \fBsmbd\fP how
1604 to map lower to upper case characters to provide the case insensitivity
1605 of filenames that Windows clients expect\&.
1607 Samba currently ships with the following code page files :
1611 \fBCode Page 437 - MS-DOS Latin US\fP
1614 \fBCode Page 737 - Windows \'95 Greek\fP
1617 \fBCode Page 850 - MS-DOS Latin 1\fP
1620 \fBCode Page 852 - MS-DOS Latin 2\fP
1623 \fBCode Page 861 - MS-DOS Icelandic\fP
1626 \fBCode Page 866 - MS-DOS Cyrillic\fP
1629 \fBCode Page 932 - MS-DOS Japanese SJIS\fP
1632 \fBCode Page 936 - MS-DOS Simplified Chinese\fP
1635 \fBCode Page 949 - MS-DOS Korean Hangul\fP
1638 \fBCode Page 950 - MS-DOS Traditional Chinese\fP
1641 Thus this parameter may have any of the values 437, 737, 850, 852,
1642 861, 932, 936, 949, or 950\&. If you don\'t find the codepage you need,
1643 read the comments in one of the other codepage files and the
1644 \fBmake_smbcodepage (1)\fP man page and
1645 write one\&. Please remember to donate it back to the Samba user
1648 This parameter co-operates with the \fB"valid
1649 chars"\fP parameter in determining what characters are
1650 valid in filenames and how capitalization is done\&. If you set both
1651 this parameter and the \fB"valid chars"\fP parameter
1652 the \fB"client code page"\fP parameter \fIMUST\fP be set before the
1653 \fB"valid chars"\fP parameter in the \fBsmb\&.conf\fP
1654 file\&. The \fB"valid chars"\fP string will then augment
1655 the character settings in the "client code page" parameter\&.
1657 If not set, \fB"client code page"\fP defaults to 850\&.
1659 See also : \fB"valid chars"\fP
1662 \f(CW client code page = 850\fP
1665 \f(CW client code page = 936\fP
1667 .IP "\fBcodingsystem (G)\fP"
1669 This parameter is used to determine how incoming Shift-JIS Japanese
1670 characters are mapped from the incoming \fB"client code
1671 page"\fP used by the client, into file names in the
1672 UNIX filesystem\&. Only useful if \fB"client code
1673 page"\fP is set to 932 (Japanese Shift-JIS)\&.
1679 \fBSJIS\fP Shift-JIS\&. Does no conversion of the incoming filename\&.
1682 \fBJIS8, J8BB, J8BH, J8@B, J8@J, J8@H \fP Convert from incoming
1683 Shift-JIS to eight bit JIS code with different shift-in, shift out
1687 \fBJIS7, J7BB, J7BH, J7@B, J7@J, J7@H \fP Convert from incoming
1688 Shift-JIS to seven bit JIS code with different shift-in, shift out
1692 \fBJUNET, JUBB, JUBH, JU@B, JU@J, JU@H \fP Convert from incoming
1693 Shift-JIS to JUNET code with different shift-in, shift out codes\&.
1696 \fBEUC\fP Convert an incoming Shift-JIS character to EUC code\&.
1699 \fBHEX\fP Convert an incoming Shift-JIS character to a 3 byte hex
1700 representation, i\&.e\&. \f(CW:AB\fP\&.
1703 \fBCAP\fP Convert an incoming Shift-JIS character to the 3 byte hex
1704 representation used by the Columbia AppleTalk Program (CAP),
1705 i\&.e\&. \f(CW:AB\fP\&. This is used for compatibility between Samba and CAP\&.
1708 .IP "\fBcomment (S)\fP"
1710 This is a text field that is seen next to a share when a client does a
1711 queries the server, either via the network neighborhood or via "net
1712 view" to list what shares are available\&.
1714 If you want to set the string that is displayed next to the machine
1715 name then see the server string command\&.
1718 \f(CW No comment string\fP
1721 \f(CW comment = Fred\'s Files\fP
1723 .IP "\fBconfig file (G)\fP"
1725 This allows you to override the config file to use, instead of the
1726 default (usually \fBsmb\&.conf\fP)\&. There is a chicken and egg problem
1727 here as this option is set in the config file!
1729 For this reason, if the name of the config file has changed when the
1730 parameters are loaded then it will reload them from the new config
1733 This option takes the usual substitutions, which can be very useful\&.
1735 If the config file doesn\'t exist then it won\'t be loaded (allowing you
1736 to special case the config files of just a few clients)\&.
1739 \f(CW config file = /usr/local/samba/lib/smb\&.conf\&.%m\fP
1741 .IP "\fBcopy (S)\fP"
1743 This parameter allows you to \fI\'clone\'\fP service entries\&. The specified
1744 service is simply duplicated under the current service\'s name\&. Any
1745 parameters specified in the current section will override those in the
1746 section being copied\&.
1748 This feature lets you set up a \'template\' service and create similar
1749 services easily\&. Note that the service being copied must occur earlier
1750 in the configuration file than the service doing the copying\&.
1756 \f(CW copy = otherservice\fP
1758 .IP "\fBcreate mask (S)\fP"
1760 A synonym for this parameter is \fB\'create mode\'\fP\&.
1762 When a file is created, the necessary permissions are calculated
1763 according to the mapping from DOS modes to UNIX permissions, and the
1764 resulting UNIX mode is then bit-wise \'AND\'ed with this parameter\&.
1765 This parameter may be thought of as a bit-wise MASK for the UNIX modes
1766 of a file\&. Any bit \fI*not*\fP set here will be removed from the modes set
1767 on a file when it is created\&.
1769 The default value of this parameter removes the \'group\' and \'other\'
1770 write and execute bits from the UNIX modes\&.
1772 Following this Samba will bit-wise \'OR\' the UNIX mode created from
1773 this parameter with the value of the "force create mode" parameter
1774 which is set to 000 by default\&.
1776 This parameter does not affect directory modes\&. See the parameter
1777 \fB\'directory mode\'\fP for details\&.
1779 See also the \fB"force create mode"\fP parameter
1780 for forcing particular mode bits to be set on created files\&. See also
1781 the \fB"directory mode"\fP parameter for masking
1782 mode bits on created directories\&.
1785 \f(CW create mask = 0744\fP
1788 \f(CW create mask = 0775\fP
1790 .IP "\fBcreate mode (S)\fP"
1792 This is a synonym for \fBcreate mask\fP\&.
1794 .IP "\fBdeadtime (G)\fP"
1796 The value of the parameter (a decimal integer) represents the number
1797 of minutes of inactivity before a connection is considered dead, and
1798 it is disconnected\&. The deadtime only takes effect if the number of
1799 open files is zero\&.
1801 This is useful to stop a server\'s resources being exhausted by a large
1802 number of inactive connections\&.
1804 Most clients have an auto-reconnect feature when a connection is
1805 broken so in most cases this parameter should be transparent to users\&.
1807 Using this parameter with a timeout of a few minutes is recommended
1810 A deadtime of zero indicates that no auto-disconnection should be
1814 \f(CW deadtime = 0\fP
1817 \f(CW deadtime = 15\fP
1819 .IP "\fBdebug timestamp (G)\fP"
1821 Samba2\&.0 debug log messages are timestamped by default\&. If you are
1822 running at a high \fB"debug level"\fP these timestamps
1823 can be distracting\&. This boolean parameter allows them to be turned
1827 \f(CW debug timestamp = Yes\fP
1830 \f(CW debug timestamp = No\fP
1832 .IP "\fBdebug level (G)\fP"
1834 The value of the parameter (an integer) allows the debug level
1835 (logging level) to be specified in the \fBsmb\&.conf\fP file\&. This is to
1836 give greater flexibility in the configuration of the system\&.
1838 The default will be the debug level specified on the command line
1839 or level zero if none was specified\&.
1842 \f(CW debug level = 3\fP
1844 .IP "\fBdefault (G)\fP"
1846 A synonym for \fBdefault service\fP\&.
1848 .IP "\fBdefault case (S)\fP"
1850 See the section on \fB"NAME MANGLING"\fP\&. Also note
1851 the \fB"short preserve case"\fP parameter\&.
1853 .IP "\fBdefault service (G)\fP"
1855 This parameter specifies the name of a service which will be connected
1856 to if the service actually requested cannot be found\&. Note that the
1857 square brackets are \fINOT\fP given in the parameter value (see example
1860 There is no default value for this parameter\&. If this parameter is not
1861 given, attempting to connect to a nonexistent service results in an
1864 Typically the default service would be a \fBguest ok\fP,
1865 \fBread-only\fP service\&.
1867 Also note that the apparent service name will be changed to equal that
1868 of the requested service, this is very useful as it allows you to use
1869 macros like \fB%S\fP to make a wildcard service\&.
1871 Note also that any \f(CW\'_\'\fP characters in the name of the service used
1872 in the default service will get mapped to a \f(CW\'/\'\fP\&. This allows for
1873 interesting things\&.
1880 default service = pub
1889 .IP "\fBdelete user script (G)\fP"
1891 This is the full pathname to a script that will be run \fIAS ROOT\fP by
1892 \fBsmbd (8)\fP under special circumstances decribed
1895 Normally, a Samba server requires that UNIX users are created for all
1896 users accessing files on this server\&. For sites that use Windows NT
1897 account databases as their primary user database creating these users
1898 and keeping the user list in sync with the Windows NT PDC is an
1899 onerous task\&. This option allows \fBsmbd\fP to delete
1900 the required UNIX users \fION DEMAND\fP when a user accesses the Samba
1901 server and the Windows NT user no longer exists\&.
1903 In order to use this option, \fBsmbd\fP must be set to
1904 \fBsecurity=domain\fP and \fB"delete user
1905 script"\fP must be set to a full pathname for a script that will delete
1906 a UNIX user given one argument of \fB%u\fP, which expands into the UNIX
1907 user name to delete\&. \fINOTE\fP that this is different to the
1908 \fBadd user script\fP which will work with the
1909 \fBsecurity=server\fP option as well as
1910 \fBsecurity=domain\fP\&. The reason for this
1911 is only when Samba is a domain member does it get the information
1912 on an attempted user logon that a user no longer exists\&. In the
1913 \fBsecurity=server\fP mode a missing user
1914 is treated the same as an invalid password logon attempt\&. Deleting
1915 the user in this circumstance would not be a good idea\&.
1917 When the Windows user attempts to access the Samba server, at
1918 \fI"login"\fP(session setup in the SMB protocol) time,
1919 \fBsmbd\fP contacts the \fBpassword
1920 server\fP and attempts to authenticate the given user
1921 with the given password\&. If the authentication fails with the specific
1922 Domain error code meaning that the user no longer exists then
1923 \fBsmbd\fP attempts to find a UNIX user in the UNIX
1924 password database that matches the Windows user account\&. If this lookup succeeds,
1925 and \fB"delete user script"\fP is set then \fBsmbd\fP will
1926 call the specified script \fIAS ROOT\fP, expanding any \fB%u\fP argument
1927 to be the user name to delete\&.
1929 This script should delete the given UNIX username\&. In this way, UNIX
1930 users are dynamically deleted to match existing Windows NT accounts\&.
1932 See also \fBsecurity=domain\fP,
1933 \fBpassword server\fP, \fBadd user
1937 \f(CW delete user script = <empty string>\fP
1940 \f(CW delete user script = /usr/local/samba/bin/del_user %u\fP
1942 .IP "\fBdelete readonly (S)\fP"
1944 This parameter allows readonly files to be deleted\&. This is not
1945 normal DOS semantics, but is allowed by UNIX\&.
1947 This option may be useful for running applications such as rcs, where
1948 UNIX file ownership prevents changing file permissions, and DOS
1949 semantics prevent deletion of a read only file\&.
1952 \f(CW delete readonly = No\fP
1955 \f(CW delete readonly = Yes\fP
1957 .IP "\fBdelete veto files (S)\fP"
1959 This option is used when Samba is attempting to delete a directory
1960 that contains one or more vetoed directories (see the \fB\'veto
1961 files\'\fP option)\&. If this option is set to False (the
1962 default) then if a vetoed directory contains any non-vetoed files or
1963 directories then the directory delete will fail\&. This is usually what
1966 If this option is set to True, then Samba will attempt to recursively
1967 delete any files and directories within the vetoed directory\&. This can
1968 be useful for integration with file serving systems such as \fBNetAtalk\fP,
1969 which create meta-files within directories you might normally veto
1970 DOS/Windows users from seeing (e\&.g\&. \f(CW\&.AppleDouble\fP)
1972 Setting \f(CW\'delete veto files = True\'\fP allows these directories to be
1973 transparently deleted when the parent directory is deleted (so long
1974 as the user has permissions to do so)\&.
1976 See also the \fBveto files\fP parameter\&.
1979 \f(CW delete veto files = False\fP
1982 \f(CW delete veto files = True\fP
1984 .IP "\fBdeny hosts (S)\fP"
1986 Synonym for \fBhosts deny\fP\&.
1988 .IP "\fBdfree command (G)\fP"
1990 The dfree command setting should only be used on systems where a
1991 problem occurs with the internal disk space calculations\&. This has
1992 been known to happen with Ultrix, but may occur with other operating
1993 systems\&. The symptom that was seen was an error of "Abort Retry
1994 Ignore" at the end of each directory listing\&.
1996 This setting allows the replacement of the internal routines to
1997 calculate the total disk space and amount available with an external
1998 routine\&. The example below gives a possible script that might fulfill
2001 The external program will be passed a single parameter indicating a
2002 directory in the filesystem being queried\&. This will typically consist
2003 of the string \f(CW"\&./"\fP\&. The script should return two integers in
2004 ascii\&. The first should be the total disk space in blocks, and the
2005 second should be the number of available blocks\&. An optional third
2006 return value can give the block size in bytes\&. The default blocksize
2009 Note: Your script should \fINOT\fP be setuid or setgid and should be
2010 owned by (and writeable only by) root!
2013 \f(CW By default internal routines for determining the disk capacity
2014 and remaining space will be used\&.\fP
2017 \f(CW dfree command = /usr/local/samba/bin/dfree\fP
2019 Where the script dfree (which must be made executable) could be:
2026 df $1 | tail -1 | awk \'{print $2" "$4}\'
2032 or perhaps (on Sys V based systems):
2039 /usr/bin/df -k $1 | tail -1 | awk \'{print $3" "$5}\'
2045 Note that you may have to replace the command names with full
2046 path names on some systems\&.
2048 .IP "\fBdirectory (S)\fP"
2050 Synonym for \fBpath\fP\&.
2052 .IP "\fBdirectory mask (S)\fP"
2054 This parameter is the octal modes which are used when converting DOS
2055 modes to UNIX modes when creating UNIX directories\&.
2057 When a directory is created, the necessary permissions are calculated
2058 according to the mapping from DOS modes to UNIX permissions, and the
2059 resulting UNIX mode is then bit-wise \'AND\'ed with this parameter\&.
2060 This parameter may be thought of as a bit-wise MASK for the UNIX modes
2061 of a directory\&. Any bit \fI*not*\fP set here will be removed from the
2062 modes set on a directory when it is created\&.
2064 The default value of this parameter removes the \'group\' and \'other\'
2065 write bits from the UNIX mode, allowing only the user who owns the
2066 directory to modify it\&.
2068 Following this Samba will bit-wise \'OR\' the UNIX mode created from
2069 this parameter with the value of the "force directory mode"
2070 parameter\&. This parameter is set to 000 by default (i\&.e\&. no extra mode
2073 See the \fB"force directory mode"\fP parameter
2074 to cause particular mode bits to always be set on created directories\&.
2076 See also the \fB"create mode"\fP parameter for masking
2077 mode bits on created files\&.
2080 \f(CW directory mask = 0755\fP
2083 \f(CW directory mask = 0775\fP
2085 .IP "\fBdirectory mode (S)\fP"
2087 Synonym for \fBdirectory mask\fP\&.
2089 .IP "\fBdns proxy (G)\fP"
2091 Specifies that \fBnmbd\fP when acting as a WINS
2092 server and finding that a NetBIOS name has not been registered, should
2093 treat the NetBIOS name word-for-word as a DNS name and do a lookup
2094 with the DNS server for that name on behalf of the name-querying
2097 Note that the maximum length for a NetBIOS name is 15 characters, so
2098 the DNS name (or DNS alias) can likewise only be 15 characters,
2101 \fBnmbd\fP spawns a second copy of itself to do the
2102 DNS name lookup requests, as doing a name lookup is a blocking action\&.
2104 See also the parameter \fBwins support\fP\&.
2107 \f(CW dns proxy = yes\fP
2109 \fBdomain admin group (G)\fP
2111 This is an \fBEXPERIMENTAL\fP parameter that is part of the unfinished
2112 Samba NT Domain Controller Code\&. It may be removed in a later release\&.
2113 To work with the latest code builds that may have more support for
2114 Samba NT Domain Controller functionality please subscribe to the
2115 mailing list \fBSamba-ntdom\fP available by sending email to
2116 \fIlistproc@samba\&.org\fP
2118 .IP "\fBdomain admin users (G)\fP"
2120 This is an \fBEXPERIMENTAL\fP parameter that is part of the unfinished
2121 Samba NT Domain Controller Code\&. It may be removed in a later release\&.
2122 To work with the latest code builds that may have more support for
2123 Samba NT Domain Controller functionality please subscribe to the
2124 mailing list \fBSamba-ntdom\fP available by sending email to
2125 \fIlistproc@samba\&.org\fP
2127 .IP "\fBdomain controller (G)\fP"
2129 This is a \fBDEPRECATED\fP parameter\&. It is currently not used within
2130 the Samba source and should be removed from all current smb\&.conf
2131 files\&. It is left behind for compatibility reasons\&.
2133 .IP "\fBdomain groups (G)\fP"
2135 This is an \fBEXPERIMENTAL\fP parameter that is part of the unfinished
2136 Samba NT Domain Controller Code\&. It may be removed in a later release\&.
2137 To work with the latest code builds that may have more support for
2138 Samba NT Domain Controller functionality please subscribe to the
2139 mailing list \fBSamba-ntdom\fP available by sending email to
2140 \fIlistproc@samba\&.org\fP
2142 .IP "\fBdomain guest group (G)\fP"
2144 This is an \fBEXPERIMENTAL\fP parameter that is part of the unfinished
2145 Samba NT Domain Controller Code\&. It may be removed in a later release\&.
2146 To work with the latest code builds that may have more support for
2147 Samba NT Domain Controller functionality please subscribe to the
2148 mailing list \fBSamba-ntdom\fP available by sending email to
2149 \fIlistproc@samba\&.org\fP
2151 .IP "\fBdomain guest users (G)\fP"
2153 This is an \fBEXPERIMENTAL\fP parameter that is part of the unfinished
2154 Samba NT Domain Controller Code\&. It may be removed in a later release\&.
2155 To work with the latest code builds that may have more support for
2156 Samba NT Domain Controller functionality please subscribe to the
2157 mailing list \fBSamba-ntdom\fP available by sending email to
2158 \fIlistproc@samba\&.org\fP
2160 .IP "\fBdomain logons (G)\fP"
2162 If set to true, the Samba server will serve Windows 95/98 Domain
2163 logons for the \fBworkgroup\fP it is in\&. For more
2164 details on setting up this feature see the file DOMAINS\&.txt in the
2165 Samba documentation directory \f(CWdocs/\fP shipped with the source code\&.
2167 Note that Win95/98 Domain logons are \fINOT\fP the same as Windows
2168 NT Domain logons\&. NT Domain logons require a Primary Domain Controller
2169 (PDC) for the Domain\&. It is intended that in a future release Samba
2170 will be able to provide this functionality for Windows NT clients
2174 \f(CW domain logons = no\fP
2176 .IP "\fBdomain master (G)\fP"
2178 Tell \fBnmbd\fP to enable WAN-wide browse list
2179 collation\&. Setting this option causes \fBnmbd\fP to
2180 claim a special domain specific NetBIOS name that identifies it as a
2181 domain master browser for its given
2182 \fBworkgroup\fP\&. Local master browsers in the same
2183 \fBworkgroup\fP on broadcast-isolated subnets will give
2184 this \fBnmbd\fP their local browse lists, and then
2185 ask \fBsmbd\fP for a complete copy of the browse list
2186 for the whole wide area network\&. Browser clients will then contact
2187 their local master browser, and will receive the domain-wide browse
2188 list, instead of just the list for their broadcast-isolated subnet\&.
2190 Note that Windows NT Primary Domain Controllers expect to be able to
2191 claim this \fBworkgroup\fP specific special NetBIOS
2192 name that identifies them as domain master browsers for that
2193 \fBworkgroup\fP by default (i\&.e\&. there is no way to
2194 prevent a Windows NT PDC from attempting to do this)\&. This means that
2195 if this parameter is set and \fBnmbd\fP claims the
2196 special name for a \fBworkgroup\fP before a Windows NT
2197 PDC is able to do so then cross subnet browsing will behave strangely
2201 \f(CW domain master = no\fP
2203 .IP "\fBdont descend (S)\fP"
2205 There are certain directories on some systems (e\&.g\&., the \f(CW/proc\fP tree
2206 under Linux) that are either not of interest to clients or are
2207 infinitely deep (recursive)\&. This parameter allows you to specify a
2208 comma-delimited list of directories that the server should always show
2211 Note that Samba can be very fussy about the exact format of the "dont
2212 descend" entries\&. For example you may need \f(CW"\&./proc"\fP instead of
2213 just \f(CW"/proc"\fP\&. Experimentation is the best policy :-)
2216 \f(CW none (i\&.e\&., all directories are OK to descend)\fP
2219 \f(CW dont descend = /proc,/dev\fP
2221 .IP "\fBdos filetime resolution (S)\fP"
2223 Under the DOS and Windows FAT filesystem, the finest granularity on
2224 time resolution is two seconds\&. Setting this parameter for a share
2225 causes Samba to round the reported time down to the nearest two second
2226 boundary when a query call that requires one second resolution is made
2229 This option is mainly used as a compatibility option for Visual C++
2230 when used against Samba shares\&. If oplocks are enabled on a share,
2231 Visual C++ uses two different time reading calls to check if a file
2232 has changed since it was last read\&. One of these calls uses a
2233 one-second granularity, the other uses a two second granularity\&. As
2234 the two second call rounds any odd second down, then if the file has a
2235 timestamp of an odd number of seconds then the two timestamps will not
2236 match and Visual C++ will keep reporting the file has changed\&. Setting
2237 this option causes the two timestamps to match, and Visual C++ is
2241 \f(CW dos filetime resolution = False\fP
2244 \f(CW dos filetime resolution = True\fP
2246 .IP "\fBdos filetimes (S)\fP"
2248 Under DOS and Windows, if a user can write to a file they can change
2249 the timestamp on it\&. Under POSIX semantics, only the owner of the file
2250 or root may change the timestamp\&. By default, Samba runs with POSIX
2251 semantics and refuses to change the timestamp on a file if the user
2252 smbd is acting on behalf of is not the file owner\&. Setting this option
2253 to True allows DOS semantics and smbd will change the file timestamp as
2257 \f(CW dos filetimes = False\fP
2260 \f(CW dos filetimes = True\fP
2262 .IP "\fBencrypt passwords (G)\fP"
2264 This boolean controls whether encrypted passwords will be negotiated
2265 with the client\&. Note that Windows NT 4\&.0 SP3 and above and also
2266 Windows 98 will by default expect encrypted passwords unless a
2267 registry entry is changed\&. To use encrypted passwords in Samba see the
2268 file ENCRYPTION\&.txt in the Samba documentation directory \f(CWdocs/\fP
2269 shipped with the source code\&.
2271 In order for encrypted passwords to work correctly
2272 \fBsmbd\fP must either have access to a local
2273 \fBsmbpasswd (5)\fP file (see the
2274 \fBsmbpasswd (8)\fP program for information on
2275 how to set up and maintain this file), or set the
2276 \fBsecurity=\fP parameter to either
2278 \fB"domain"\fP which causes
2279 \fBsmbd\fP to authenticate against another server\&.
2281 .IP "\fBexec (S)\fP"
2283 This is a synonym for \fBpreexec\fP\&.
2285 .IP "\fBfake directory create times (S)\fP"
2287 NTFS and Windows VFAT file systems keep a create time for all files
2288 and directories\&. This is not the same as the ctime - status change
2289 time - that Unix keeps, so Samba by default reports the earliest of
2290 the various times Unix does keep\&. Setting this parameter for a share
2291 causes Samba to always report midnight 1-1-1980 as the create time for
2294 This option is mainly used as a compatibility option for Visual C++
2295 when used against Samba shares\&. Visual C++ generated makefiles have
2296 the object directory as a dependency for each object file, and a make
2297 rule to create the directory\&. Also, when NMAKE compares timestamps it
2298 uses the creation time when examining a directory\&. Thus the object
2299 directory will be created if it does not exist, but once it does exist
2300 it will always have an earlier timestamp than the object files it
2303 However, Unix time semantics mean that the create time reported by
2304 Samba will be updated whenever a file is created or deleted in the
2305 directory\&. NMAKE therefore finds all object files in the object
2306 directory bar the last one built are out of date compared to the
2307 directory and rebuilds them\&. Enabling this option ensures directories
2308 always predate their contents and an NMAKE build will proceed as
2312 \f(CW fake directory create times = False\fP
2315 \f(CW fake directory create times = True\fP
2317 .IP "\fBfake oplocks (S)\fP"
2319 Oplocks are the way that SMB clients get permission from a server to
2320 locally cache file operations\&. If a server grants an oplock
2321 (opportunistic lock) then the client is free to assume that it is the
2322 only one accessing the file and it will aggressively cache file
2323 data\&. With some oplock types the client may even cache file open/close
2324 operations\&. This can give enormous performance benefits\&.
2326 When you set \f(CW"fake oplocks = yes"\fP \fBsmbd\fP will
2327 always grant oplock requests no matter how many clients are using the
2330 It is generally much better to use the real \fBoplocks\fP
2331 support rather than this parameter\&.
2333 If you enable this option on all read-only shares or shares that you
2334 know will only be accessed from one client at a time such as
2335 physically read-only media like CDROMs, you will see a big performance
2336 improvement on many operations\&. If you enable this option on shares
2337 where multiple clients may be accessing the files read-write at the
2338 same time you can get data corruption\&. Use this option carefully!
2340 This option is disabled by default\&.
2342 .IP "\fBfollow symlinks (S)\fP"
2344 This parameter allows the Samba administrator to stop
2345 \fBsmbd\fP from following symbolic links in a
2346 particular share\&. Setting this parameter to \fI"No"\fP prevents any file
2347 or directory that is a symbolic link from being followed (the user
2348 will get an error)\&. This option is very useful to stop users from
2349 adding a symbolic link to \f(CW/etc/passwd\fP in their home directory for
2350 instance\&. However it will slow filename lookups down slightly\&.
2352 This option is enabled (i\&.e\&. \fBsmbd\fP will follow
2353 symbolic links) by default\&.
2355 .IP "\fBforce create mode (S)\fP"
2357 This parameter specifies a set of UNIX mode bit permissions that will
2358 \fI*always*\fP be set on a file created by Samba\&. This is done by
2359 bitwise \'OR\'ing these bits onto the mode bits of a file that is being
2360 created\&. The default for this parameter is (in octal) 000\&. The modes
2361 in this parameter are bitwise \'OR\'ed onto the file mode after the mask
2362 set in the \fB"create mask"\fP parameter is applied\&.
2364 See also the parameter \fB"create mask"\fP for details
2365 on masking mode bits on created files\&.
2368 \f(CW force create mode = 000\fP
2371 \f(CW force create mode = 0755\fP
2373 would force all created files to have read and execute permissions set
2374 for \'group\' and \'other\' as well as the read/write/execute bits set for
2377 .IP "\fBforce directory mode (S)\fP"
2379 This parameter specifies a set of UNIX mode bit permissions that will
2380 \fI*always*\fP be set on a directory created by Samba\&. This is done by
2381 bitwise \'OR\'ing these bits onto the mode bits of a directory that is
2382 being created\&. The default for this parameter is (in octal) 0000 which
2383 will not add any extra permission bits to a created directory\&. This
2384 operation is done after the mode mask in the parameter
2385 \fB"directory mask"\fP is applied\&.
2387 See also the parameter \fB"directory mask"\fP for
2388 details on masking mode bits on created directories\&.
2391 \f(CW force directory mode = 000\fP
2394 \f(CW force directory mode = 0755\fP
2396 would force all created directories to have read and execute
2397 permissions set for \'group\' and \'other\' as well as the
2398 read/write/execute bits set for the \'user\'\&.
2400 .IP "\fBforce group (S)\fP"
2402 This specifies a UNIX group name that will be assigned as the default
2403 primary group for all users connecting to this service\&. This is useful
2404 for sharing files by ensuring that all access to files on service will
2405 use the named group for their permissions checking\&. Thus, by assigning
2406 permissions for this group to the files and directories within this
2407 service the Samba administrator can restrict or allow sharing of these
2411 \f(CW no forced group\fP
2414 \f(CW force group = agroup\fP
2416 .IP "\fBforce user (S)\fP"
2418 This specifies a UNIX user name that will be assigned as the default
2419 user for all users connecting to this service\&. This is useful for
2420 sharing files\&. You should also use it carefully as using it
2421 incorrectly can cause security problems\&.
2423 This user name only gets used once a connection is established\&. Thus
2424 clients still need to connect as a valid user and supply a valid
2425 password\&. Once connected, all file operations will be performed as the
2426 \f(CW"forced user"\fP, no matter what username the client connected as\&.
2428 This can be very useful\&.
2431 \f(CW no forced user\fP
2434 \f(CW force user = auser\fP
2436 .IP "\fBfstype (S)\fP"
2438 This parameter allows the administrator to configure the string that
2439 specifies the type of filesystem a share is using that is reported by
2440 \fBsmbd\fP when a client queries the filesystem type
2441 for a share\&. The default type is \fB"NTFS"\fP for compatibility with
2442 Windows NT but this can be changed to other strings such as "Samba" or
2443 "FAT" if required\&.
2446 \f(CW fstype = NTFS\fP
2449 \f(CW fstype = Samba\fP
2451 .IP "\fBgetwd cache (G)\fP"
2453 This is a tuning option\&. When this is enabled a caching algorithm
2454 will be used to reduce the time taken for getwd() calls\&. This can have
2455 a significant impact on performance, especially when the
2456 \fBwidelinks\fP parameter is set to False\&.
2459 \f(CW getwd cache = No\fP
2462 \f(CW getwd cache = Yes\fP
2464 .IP "\fBgroup (S)\fP"
2466 Synonym for \fB"force group"\fP\&.
2468 .IP "\fBguest account (S)\fP"
2470 This is a username which will be used for access to services which are
2471 specified as \fB\'guest ok\'\fP (see below)\&. Whatever
2472 privileges this user has will be available to any client connecting to
2473 the guest service\&. Typically this user will exist in the password
2474 file, but will not have a valid login\&. The user account \fB"ftp"\fP is
2475 often a good choice for this parameter\&. If a username is specified in
2476 a given service, the specified username overrides this one\&.
2478 One some systems the default guest account "nobody" may not be able to
2479 print\&. Use another account in this case\&. You should test this by
2480 trying to log in as your guest user (perhaps by using the \f(CW"su -"\fP
2481 command) and trying to print using the system print command such as
2482 \fBlpr (1)\fP or \fBlp (1)\fP\&.
2485 \f(CW specified at compile time, usually "nobody"\fP
2488 \f(CW guest account = ftp\fP
2490 .IP "\fBguest ok (S)\fP"
2492 If this parameter is \fI\'yes\'\fP for a service, then no password is
2493 required to connect to the service\&. Privileges will be those of the
2494 \fBguest account\fP\&.
2496 See the section below on \fBsecurity\fP for more
2497 information about this option\&.
2500 \f(CW guest ok = no\fP
2503 \f(CW guest ok = yes\fP
2505 .IP "\fBguest only (S)\fP"
2507 If this parameter is \fI\'yes\'\fP for a service, then only guest
2508 connections to the service are permitted\&. This parameter will have no
2509 affect if \fB"guest ok"\fP or \fB"public"\fP
2510 is not set for the service\&.
2512 See the section below on \fBsecurity\fP for more
2513 information about this option\&.
2516 \f(CW guest only = no\fP
2519 \f(CW guest only = yes\fP
2521 .IP "\fBhide dot files (S)\fP"
2523 This is a boolean parameter that controls whether files starting with
2524 a dot appear as hidden files\&.
2527 \f(CW hide dot files = yes\fP
2530 \f(CW hide dot files = no\fP
2532 .IP "\fBhide files(S)\fP"
2534 This is a list of files or directories that are not visible but are
2535 accessible\&. The DOS \'hidden\' attribute is applied to any files or
2536 directories that match\&.
2538 Each entry in the list must be separated by a \f(CW\'/\'\fP, which allows
2539 spaces to be included in the entry\&. \f(CW\'*\'\fP and \f(CW\'?\'\fP can be used
2540 to specify multiple files or directories as in DOS wildcards\&.
2542 Each entry must be a Unix path, not a DOS path and must not include the
2543 Unix directory separator \f(CW\'/\'\fP\&.
2545 Note that the case sensitivity option is applicable in hiding files\&.
2547 Setting this parameter will affect the performance of Samba, as it
2548 will be forced to check all files and directories for a match as they
2551 See also \fB"hide dot files"\fP, \fB"veto
2552 files"\fP and \fB"case sensitive"\fP\&.
2559 No files or directories are hidden by this option (dot files are
2560 hidden by default because of the "hide dot files" option)\&.
2567 \f(CW hide files = /\&.*/DesktopFolderDB/TrashFor%m/resource\&.frk/\fP
2569 The above example is based on files that the Macintosh SMB client
2570 (DAVE) available from \fBThursby\fP creates for
2571 internal use, and also still hides all files beginning with a dot\&.
2573 .IP "\fBhomedir map (G)\fP"
2575 If \fB"nis homedir"\fP is true, and
2576 \fBsmbd\fP is also acting as a Win95/98 \fBlogon
2577 server\fP then this parameter specifies the NIS (or YP)
2578 map from which the server for the user\'s home directory should be
2579 extracted\&. At present, only the Sun auto\&.home map format is
2580 understood\&. The form of the map is:
2582 \f(CWusername server:/some/file/system\fP
2584 and the program will extract the servername from before the first
2585 \f(CW\':\'\fP\&. There should probably be a better parsing system that copes
2586 with different map formats and also Amd (another automounter) maps\&.
2588 NB: A working NIS is required on the system for this option to work\&.
2590 See also \fB"nis homedir"\fP, \fBdomain
2594 \f(CW homedir map = auto\&.home\fP
2597 \f(CW homedir map = amd\&.homedir\fP
2599 .IP "\fBhosts allow (S)\fP"
2601 A synonym for this parameter is \fB\'allow hosts\'\fP
2603 This parameter is a comma, space, or tab delimited set of hosts which
2604 are permitted to access a service\&.
2606 If specified in the \fB[global]\fP section then it will
2607 apply to all services, regardless of whether the individual service
2608 has a different setting\&.
2610 You can specify the hosts by name or IP number\&. For example, you could
2611 restrict access to only the hosts on a Class C subnet with something
2612 like \f(CW"allow hosts = 150\&.203\&.5\&."\fP\&. The full syntax of the list is
2613 described in the man page \fBhosts_access (5)\fP\&. Note that this man
2614 page may not be present on your system, so a brief description will
2615 be given here also\&.
2617 \fINOTE:\fP IF you wish to allow the \fBsmbpasswd
2618 (8)\fP program to be run by local users to change
2619 their Samba passwords using the local \fBsmbd (8)\fP
2620 daemon, then you \fIMUST\fP ensure that the localhost is listed in your
2621 \fBhosts allow\fP list, as \fBsmbpasswd (8)\fP runs
2622 in client-server mode and is seen by the local
2623 \fBsmbd\fP process as just another client\&.
2625 You can also specify hosts by network/netmask pairs and by netgroup
2626 names if your system supports netgroups\&. The \fIEXCEPT\fP keyword can also
2627 be used to limit a wildcard list\&. The following examples may provide
2630 \fBExample 1\fP: allow localhost and all IPs in 150\&.203\&.*\&.* except one
2632 \f(CW hosts allow = localhost, 150\&.203\&. EXCEPT 150\&.203\&.6\&.66\fP
2634 \fBExample 2\fP: allow localhost and hosts that match the given network/netmask
2636 \f(CW hosts allow = localhost, 150\&.203\&.15\&.0/255\&.255\&.255\&.0\fP
2638 \fBExample 3\fP: allow a localhost plus a couple of hosts
2640 \f(CW hosts allow = localhost, lapland, arvidsjaur\fP
2642 \fBExample 4\fP: allow only hosts in NIS netgroup "foonet" or localhost, but
2643 deny access from one particular host
2645 \f(CW hosts allow = @foonet, localhost\fP
2647 \f(CW hosts deny = pirate\fP
2649 Note that access still requires suitable user-level passwords\&.
2651 See \fBtestparm (1)\fP for a way of testing your
2652 host access to see if it does what you expect\&.
2655 \f(CW none (i\&.e\&., all hosts permitted access)\fP
2658 \f(CW allow hosts = 150\&.203\&.5\&. localhost myhost\&.mynet\&.edu\&.au\fP
2660 .IP "\fBhosts deny (S)\fP"
2662 The opposite of \fB\'hosts allow\'\fP - hosts listed
2663 here are \fINOT\fP permitted access to services unless the specific
2664 services have their own lists to override this one\&. Where the lists
2665 conflict, the \fB\'allow\'\fP list takes precedence\&.
2668 \f(CW none (i\&.e\&., no hosts specifically excluded)\fP
2671 \f(CW hosts deny = 150\&.203\&.4\&. badhost\&.mynet\&.edu\&.au\fP
2673 .IP "\fBhosts equiv (G)\fP"
2675 If this global parameter is a non-null string, it specifies the name
2676 of a file to read for the names of hosts and users who will be allowed
2677 access without specifying a password\&.
2679 This is not be confused with \fBhosts allow\fP which
2680 is about hosts access to services and is more useful for guest
2681 services\&. \fBhosts equiv\fP may be useful for NT clients which will not
2682 supply passwords to samba\&.
2684 NOTE: The use of \fBhosts equiv\fP can be a major security hole\&. This is
2685 because you are trusting the PC to supply the correct username\&. It is
2686 very easy to get a PC to supply a false username\&. I recommend that the
2687 \fBhosts equiv\fP option be only used if you really know what you are
2688 doing, or perhaps on a home network where you trust your spouse and
2689 kids\&. And only if you \fIreally\fP trust them :-)\&.
2692 \f(CW No host equivalences\fP
2695 \f(CW hosts equiv = /etc/hosts\&.equiv\fP
2697 .IP "\fBinclude (G)\fP"
2699 This allows you to include one config file inside another\&. The file
2700 is included literally, as though typed in place\&.
2702 It takes the standard substitutions, except \fB%u\fP,
2703 \fB%P\fP and \fB%S\fP\&.
2705 .IP "\fBinterfaces (G)\fP"
2707 This option allows you to setup multiple network interfaces, so that
2708 Samba can properly handle browsing on all interfaces\&.
2710 The option takes a list of ip/netmask pairs\&. The netmask may either be
2711 a bitmask, or a bitlength\&.
2713 For example, the following line:
2715 \f(CWinterfaces = 192\&.168\&.2\&.10/24 192\&.168\&.3\&.10/24\fP
2717 would configure two network interfaces with IP addresses 192\&.168\&.2\&.10
2718 and 192\&.168\&.3\&.10\&. The netmasks of both interfaces would be set to
2719 255\&.255\&.255\&.0\&.
2721 You could produce an equivalent result by using:
2723 \f(CWinterfaces = 192\&.168\&.2\&.10/255\&.255\&.255\&.0 192\&.168\&.3\&.10/255\&.255\&.255\&.0\fP
2725 if you prefer that format\&.
2727 If this option is not set then Samba will attempt to find a primary
2728 interface, but won\'t attempt to configure more than one interface\&.
2730 See also \fB"bind interfaces only"\fP\&.
2732 .IP "\fBinvalid users (S)\fP"
2734 This is a list of users that should not be allowed to login to this
2735 service\&. This is really a \fI"paranoid"\fP check to absolutely ensure an
2736 improper setting does not breach your security\&.
2738 A name starting with a \f(CW\'@\'\fP is interpreted as an NIS netgroup first
2739 (if your system supports NIS), and then as a UNIX group if the name
2740 was not found in the NIS netgroup database\&.
2742 A name starting with \f(CW\'+\'\fP is interpreted only by looking in the
2743 UNIX group database\&. A name starting with \f(CW\'&\'\fP is interpreted only
2744 by looking in the NIS netgroup database (this requires NIS to be
2745 working on your system)\&. The characters \f(CW\'+\'\fP and \f(CW\'&\'\fP may be
2746 used at the start of the name in either order so the value
2747 \f(CW"+&group"\fP means check the UNIX group database, followed by the NIS
2748 netgroup database, and the value \f(CW"&+group"\fP means check the NIS
2749 netgroup database, followed by the UNIX group database (the same as
2750 the \f(CW\'@\'\fP prefix)\&.
2752 The current servicename is substituted for
2753 \fB%S\fP\&. This is useful in the \fB[homes]\fP
2756 See also \fB"valid users"\fP\&.
2759 \f(CW No invalid users\fP
2762 \f(CW invalid users = root fred admin @wheel\fP
2764 .IP "\fBkeepalive (G)\fP"
2766 The value of the parameter (an integer) represents the number of
2767 seconds between \fB\'keepalive\'\fP packets\&. If this parameter is zero, no
2768 keepalive packets will be sent\&. Keepalive packets, if sent, allow the
2769 server to tell whether a client is still present and responding\&.
2771 Keepalives should, in general, not be needed if the socket being used
2772 has the SO_KEEPALIVE attribute set on it (see \fB"socket
2773 options"\fP)\&. Basically you should only use this option
2774 if you strike difficulties\&.
2777 \f(CW keepalive = 0\fP
2780 \f(CW keepalive = 60\fP
2782 .IP "\fBkernel oplocks (G)\fP"
2784 For UNIXs that support kernel based \fBoplocks\fP
2785 (currently only IRIX but hopefully also Linux and FreeBSD soon) this
2786 parameter allows the use of them to be turned on or off\&.
2788 Kernel oplocks support allows Samba \fBoplocks\fP to be
2789 broken whenever a local UNIX process or NFS operation accesses a file
2790 that \fBsmbd\fP has oplocked\&. This allows complete
2791 data consistency between SMB/CIFS, NFS and local file access (and is a
2792 \fIvery\fP cool feature :-)\&.
2794 This parameter defaults to \fI"On"\fP on systems that have the support,
2795 and \fI"off"\fP on systems that don\'t\&. You should never need to touch
2798 .IP "\fBldap filter (G)\fP"
2800 This parameter is part of the \fIEXPERIMENTAL\fP Samba support for a
2801 password database stored on an LDAP server back-end\&. These options
2802 are only available if your version of Samba was configured with
2803 the \fB--with-ldap\fP option\&.
2805 This parameter specifies an LDAP search filter used to search for a
2806 user name in the LDAP database\&. It must contain the string
2807 \fB%u\fP which will be replaced with the user being
2811 \f(CW empty string\&.\fP
2813 .IP "\fBldap port (G)\fP"
2815 This parameter is part of the \fIEXPERIMENTAL\fP Samba support for a
2816 password database stored on an LDAP server back-end\&. These options
2817 are only available if your version of Samba was configured with
2818 the \fB--with-ldap\fP option\&.
2820 This parameter specifies the TCP port number to use to contact
2821 the LDAP server on\&.
2824 \f(CW ldap port = 389\&.\fP
2826 .IP "\fBldap root (G)\fP"
2828 This parameter is part of the \fIEXPERIMENTAL\fP Samba support for a
2829 password database stored on an LDAP server back-end\&. These options
2830 are only available if your version of Samba was configured with
2831 the \fB--with-ldap\fP option\&.
2833 This parameter specifies the entity to bind to the LDAP server
2834 as (essentially the LDAP username) in order to be able to perform
2835 queries and modifications on the LDAP database\&.
2837 See also \fBldap root passwd\fP\&.
2840 \f(CW empty string (no user defined)\fP
2842 .IP "\fBldap root passwd (G)\fP"
2844 This parameter is part of the \fIEXPERIMENTAL\fP Samba support for a
2845 password database stored on an LDAP server back-end\&. These options
2846 are only available if your version of Samba was configured with
2847 the \fB--with-ldap\fP option\&.
2849 This parameter specifies the password for the entity to bind to the
2850 LDAP server as (the password for this LDAP username) in order to be
2851 able to perform queries and modifications on the LDAP database\&.
2853 \fIBUGS:\fP This parameter should \fINOT\fP be a readable parameter
2854 in the \fBsmb\&.conf\fP file and will be removed once a correct
2855 storage place is found\&.
2857 See also \fBldap root\fP\&.
2860 \f(CW empty string\&.\fP
2862 .IP "\fBldap server (G)\fP"
2864 This parameter is part of the \fIEXPERIMENTAL\fP Samba support for a
2865 password database stored on an LDAP server back-end\&. These options
2866 are only available if your version of Samba was configured with
2867 the \fB--with-ldap\fP option\&.
2869 This parameter specifies the DNS name of the LDAP server to use
2870 for SMB/CIFS authentication purposes\&.
2873 \f(CW ldap server = localhost\fP
2875 .IP "\fBldap suffix (G)\fP"
2877 This parameter is part of the \fIEXPERIMENTAL\fP Samba support for a
2878 password database stored on an LDAP server back-end\&. These options
2879 are only available if your version of Samba was configured with
2880 the \fB--with-ldap\fP option\&.
2882 This parameter specifies the \f(CW"dn"\fP or LDAP \fI"distinguished name"\fP
2883 that tells \fBsmbd\fP to start from when searching
2884 for an entry in the LDAP password database\&.
2887 \f(CW empty string\&.\fP
2889 .IP "\fBlm announce (G)\fP"
2891 This parameter determines if \fBnmbd\fP will produce
2892 Lanman announce broadcasts that are needed by \fBOS/2\fP clients in order
2893 for them to see the Samba server in their browse list\&. This parameter
2894 can have three values, \f(CW"true"\fP, \f(CW"false"\fP, or \f(CW"auto"\fP\&. The
2895 default is \f(CW"auto"\fP\&. If set to \f(CW"false"\fP Samba will never produce
2896 these broadcasts\&. If set to \f(CW"true"\fP Samba will produce Lanman
2897 announce broadcasts at a frequency set by the parameter \fB"lm
2898 interval"\fP\&. If set to \f(CW"auto"\fP Samba will not send Lanman
2899 announce broadcasts by default but will listen for them\&. If it hears
2900 such a broadcast on the wire it will then start sending them at a
2901 frequency set by the parameter \fB"lm interval"\fP\&.
2903 See also \fB"lm interval"\fP\&.
2906 \f(CW lm announce = auto\fP
2909 \f(CW lm announce = true\fP
2911 .IP "\fBlm interval (G)\fP"
2913 If Samba is set to produce Lanman announce broadcasts needed by
2914 \fBOS/2\fP clients (see the \fB"lm announce"\fP
2915 parameter) then this parameter defines the frequency in seconds with
2916 which they will be made\&. If this is set to zero then no Lanman
2917 announcements will be made despite the setting of the \fB"lm
2918 announce"\fP parameter\&.
2920 See also \fB"lm announce"\fP\&.
2923 \f(CW lm interval = 60\fP
2926 \f(CW lm interval = 120\fP
2928 .IP "\fBload printers (G)\fP"
2930 A boolean variable that controls whether all printers in the printcap
2931 will be loaded for browsing by default\&. See the
2932 \fB"printers"\fP section for more details\&.
2935 \f(CW load printers = yes\fP
2938 \f(CW load printers = no\fP
2940 .IP "\fBlocal master (G)\fP"
2942 This option allows \fBnmbd\fP to try and become a
2943 local master browser on a subnet\&. If set to False then
2944 \fBnmbd\fP will not attempt to become a local master
2945 browser on a subnet and will also lose in all browsing elections\&. By
2946 default this value is set to true\&. Setting this value to true doesn\'t
2947 mean that Samba will \fIbecome\fP the local master browser on a subnet,
2948 just that \fBnmbd\fP will \fIparticipate\fP in
2949 elections for local master browser\&.
2951 Setting this value to False will cause \fBnmbd\fP
2952 \fInever\fP to become a local master browser\&.
2955 \f(CW local master = yes\fP
2957 .IP "\fBlock dir (G)\fP"
2959 Synonym for \fB"lock directory"\fP\&.
2961 .IP "\fBlock directory (G)\fP"
2963 This option specifies the directory where lock files will be placed\&.
2964 The lock files are used to implement the \fB"max
2965 connections"\fP option\&.
2968 \f(CW lock directory = /tmp/samba\fP
2971 \f(CW lock directory = /usr/local/samba/var/locks\fP
2973 .IP "\fBlocking (S)\fP"
2975 This controls whether or not locking will be performed by the server
2976 in response to lock requests from the client\&.
2978 If \f(CW"locking = no"\fP, all lock and unlock requests will appear to
2979 succeed and all lock queries will indicate that the queried lock is
2982 If \f(CW"locking = yes"\fP, real locking will be performed by the server\&.
2984 This option \fImay\fP be useful for read-only filesystems which \fImay\fP
2985 not need locking (such as cdrom drives), although setting this
2986 parameter of \f(CW"no"\fP is not really recommended even in this case\&.
2988 Be careful about disabling locking either globally or in a specific
2989 service, as lack of locking may result in data corruption\&. You should
2990 never need to set this parameter\&.
2993 \f(CW locking = yes\fP
2996 \f(CW locking = no\fP
2998 .IP "\fBlog file (G)\fP"
3000 This options allows you to override the name of the Samba log file
3001 (also known as the debug file)\&.
3003 This option takes the standard substitutions, allowing you to have
3004 separate log files for each user or machine\&.
3007 \f(CW log file = /usr/local/samba/var/log\&.%m\fP
3009 .IP "\fBlog level (G)\fP"
3011 Synonym for \fB"debug level"\fP\&.
3013 .IP "\fBlogon drive (G)\fP"
3015 This parameter specifies the local path to which the home directory
3016 will be connected (see \fB"logon home"\fP) and is only
3017 used by NT Workstations\&.
3019 Note that this option is only useful if Samba is set up as a
3020 \fBlogon server\fP\&.
3023 \f(CW logon drive = h:\fP
3025 .IP "\fBlogon home (G)\fP"
3027 This parameter specifies the home directory location when a Win95/98 or
3028 NT Workstation logs into a Samba PDC\&. It allows you to do
3030 \f(CW"NET USE H: /HOME"\fP
3032 from a command prompt, for example\&.
3034 This option takes the standard substitutions, allowing you to have
3035 separate logon scripts for each user or machine\&.
3037 Note that this option is only useful if Samba is set up as a
3038 \fBlogon server\fP\&.
3041 \f(CW logon home = "\e\eremote_smb_server\e%U"\fP
3044 \f(CW logon home = "\e\e%N\e%U"\fP
3046 .IP "\fBlogon path (G)\fP"
3048 This parameter specifies the home directory where roaming profiles
3049 (USER\&.DAT / USER\&.MAN files for Windows 95/98) are stored\&.
3051 This option takes the standard substitutions, allowing you to have
3052 separate logon scripts for each user or machine\&. It also specifies
3053 the directory from which the \f(CW"desktop"\fP, \f(CW"start menu"\fP,
3054 \f(CW"network neighborhood"\fP and \f(CW"programs"\fP folders, and their
3055 contents, are loaded and displayed on your Windows 95/98 client\&.
3057 The share and the path must be readable by the user for the
3058 preferences and directories to be loaded onto the Windows 95/98
3059 client\&. The share must be writeable when the logs in for the first
3060 time, in order that the Windows 95/98 client can create the user\&.dat
3061 and other directories\&.
3063 Thereafter, the directories and any of the contents can, if required, be
3064 made read-only\&. It is not advisable that the USER\&.DAT file be made
3065 read-only - rename it to USER\&.MAN to achieve the desired effect (a
3066 \fIMAN\fPdatory profile)\&.
3068 Windows clients can sometimes maintain a connection to the [homes]
3069 share, even though there is no user logged in\&. Therefore, it is vital
3070 that the logon path does not include a reference to the homes share
3071 (i\&.e\&. setting this parameter to \f(CW\e\e%N\eHOMES\eprofile_path\fP will cause
3074 This option takes the standard substitutions, allowing you to have
3075 separate logon scripts for each user or machine\&.
3077 Note that this option is only useful if Samba is set up as a
3078 \fBlogon server\fP\&.
3081 \f(CW logon path = \e\e%N\e%U\eprofile\fP
3084 \f(CW logon path = \e\ePROFILESERVER\eHOME_DIR\e%U\ePROFILE\fP
3086 .IP "\fBlogon script (G)\fP"
3088 This parameter specifies the batch file (\&.bat) or NT command file
3089 (\&.cmd) to be downloaded and run on a machine when a user successfully
3090 logs in\&. The file must contain the DOS style cr/lf line endings\&.
3091 Using a DOS-style editor to create the file is recommended\&.
3093 The script must be a relative path to the \f(CW[netlogon]\fP service\&. If
3094 the \f(CW[netlogon]\fP service specifies a \fBpath\fP of
3095 /usr/local/samba/netlogon, and logon script = STARTUP\&.BAT, then the
3096 file that will be downloaded is:
3098 \f(CW/usr/local/samba/netlogon/STARTUP\&.BAT\fP
3100 The contents of the batch file is entirely your choice\&. A suggested
3101 command would be to add \f(CWNET TIME \e\eSERVER /SET /YES\fP, to force every
3102 machine to synchronize clocks with the same time server\&. Another use
3103 would be to add \f(CWNET USE U: \e\eSERVER\eUTILS\fP for commonly used
3104 utilities, or \f(CWNET USE Q: \e\eSERVER\eISO9001_QA\fP for example\&.
3106 Note that it is particularly important not to allow write access to
3107 the \f(CW[netlogon]\fP share, or to grant users write permission on the
3108 batch files in a secure environment, as this would allow the batch
3109 files to be arbitrarily modified and security to be breached\&.
3111 This option takes the standard substitutions, allowing you to have
3112 separate logon scripts for each user or machine\&.
3114 Note that this option is only useful if Samba is set up as a
3115 \fBlogon server\fP\&.
3118 \f(CW logon script = scripts\e%U\&.bat\fP
3120 .IP "\fBlppause command (S)\fP"
3122 This parameter specifies the command to be executed on the server host
3123 in order to stop printing or spooling a specific print job\&.
3125 This command should be a program or script which takes a printer name
3126 and job number to pause the print job\&. One way of implementing this is
3127 by using job priorities, where jobs having a too low priority won\'t be
3128 sent to the printer\&.
3130 If a \f(CW"%p"\fP is given then the printername is put in its place\&. A
3131 \f(CW"%j"\fP is replaced with the job number (an integer)\&. On HPUX (see
3132 \fBprinting=hpux\fP), if the \f(CW"-p%p"\fP option is added
3133 to the lpq command, the job will show up with the correct status,
3134 i\&.e\&. if the job priority is lower than the set fence priority it will
3135 have the PAUSED status, whereas if the priority is equal or higher it
3136 will have the SPOOLED or PRINTING status\&.
3138 Note that it is good practice to include the absolute path in the
3139 lppause command as the PATH may not be available to the server\&.
3141 See also the \fB"printing"\fP parameter\&.
3144 Currently no default value is given to this string, unless the
3145 value of the \fB"printing"\fP parameter is \f(CWSYSV\fP, in
3146 which case the default is :
3148 \f(CW lp -i %p-%j -H hold\fP
3150 or if the value of the \fB"printing"\fP parameter is \f(CWsoftq\fP,
3151 then the default is:
3153 \f(CW qstat -s -j%j -h\fP
3155 \fBExample for HPUX:\fP
3156 lppause command = /usr/bin/lpalt %p-%j -p0
3158 .IP "\fBlpq cache time (G)\fP"
3160 This controls how long lpq info will be cached for to prevent the
3161 \fBlpq\fP command being called too often\&. A separate cache is kept for
3162 each variation of the \fBlpq\fP command used by the system, so if you
3163 use different \fBlpq\fP commands for different users then they won\'t
3164 share cache information\&.
3166 The cache files are stored in \f(CW/tmp/lpq\&.xxxx\fP where xxxx is a hash of
3167 the \fBlpq\fP command in use\&.
3169 The default is 10 seconds, meaning that the cached results of a
3170 previous identical \fBlpq\fP command will be used if the cached data is
3171 less than 10 seconds old\&. A large value may be advisable if your
3172 \fBlpq\fP command is very slow\&.
3174 A value of 0 will disable caching completely\&.
3176 See also the \fB"printing"\fP parameter\&.
3179 \f(CW lpq cache time = 10\fP
3182 \f(CW lpq cache time = 30\fP
3184 .IP "\fBlpq command (S)\fP"
3186 This parameter specifies the command to be executed on the server host
3187 in order to obtain \f(CW"lpq"\fP-style printer status information\&.
3189 This command should be a program or script which takes a printer name
3190 as its only parameter and outputs printer status information\&.
3192 Currently eight styles of printer status information are supported;
3193 BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX and SOFTQ\&. This covers most UNIX
3194 systems\&. You control which type is expected using the
3195 \fB"printing ="\fP option\&.
3197 Some clients (notably Windows for Workgroups) may not correctly send
3198 the connection number for the printer they are requesting status
3199 information about\&. To get around this, the server reports on the first
3200 printer service connected to by the client\&. This only happens if the
3201 connection number sent is invalid\&.
3203 If a \f(CW%p\fP is given then the printername is put in its place\&. Otherwise
3204 it is placed at the end of the command\&.
3206 Note that it is good practice to include the absolute path in the \fBlpq
3207 command\fP as the PATH may not be available to the server\&.
3209 See also the \fB"printing"\fP parameter\&.
3212 \f(CW depends on the setting of printing =\fP
3215 \f(CW lpq command = /usr/bin/lpq %p\fP
3217 .IP "\fBlpresume command (S)\fP"
3219 This parameter specifies the command to be executed on the server host
3220 in order to restart or continue printing or spooling a specific print
3223 This command should be a program or script which takes a printer name
3224 and job number to resume the print job\&. See also the \fB"lppause
3225 command"\fP parameter\&.
3227 If a \f(CW%p\fP is given then the printername is put in its place\&. A
3228 \f(CW%j\fP is replaced with the job number (an integer)\&.
3230 Note that it is good practice to include the absolute path in the \fBlpresume
3231 command\fP as the PATH may not be available to the server\&.
3233 See also the \fB"printing"\fP parameter\&.
3237 Currently no default value is given to this string, unless the
3238 value of the \fB"printing"\fP parameter is \f(CWSYSV\fP, in
3239 which case the default is :
3241 \f(CW lp -i %p-%j -H resume\fP
3243 or if the value of the \fB"printing"\fP parameter is \f(CWsoftq\fP,
3244 then the default is:
3246 \f(CW qstat -s -j%j -r\fP
3248 \fBExample for HPUX:\fP
3249 \f(CW lpresume command = /usr/bin/lpalt %p-%j -p2\fP
3251 .IP "\fBlprm command (S)\fP"
3253 This parameter specifies the command to be executed on the server host
3254 in order to delete a print job\&.
3256 This command should be a program or script which takes a printer name
3257 and job number, and deletes the print job\&.
3259 If a \f(CW%p\fP is given then the printername is put in its place\&. A
3260 \f(CW%j\fP is replaced with the job number (an integer)\&.
3262 Note that it is good practice to include the absolute path in the
3263 \fBlprm command\fP as the PATH may not be available to the server\&.
3265 See also the \fB"printing"\fP parameter\&.
3268 \f(CW depends on the setting of "printing ="\fP
3271 \f(CW lprm command = /usr/bin/lprm -P%p %j\fP
3274 \f(CW lprm command = /usr/bin/cancel %p-%j\fP
3276 .IP "\fBmachine password timeout (G)\fP"
3278 If a Samba server is a member of an Windows NT Domain (see the
3279 \fB"security=domain"\fP) parameter) then
3280 periodically a running \fBsmbd\fP process will try and
3281 change the \fBMACHINE ACCOUNT PASWORD\fP stored in the file called
3282 \f(CW<Domain>\&.<Machine>\&.mac\fP where \f(CW<Domain>\fP is the name of the
3283 Domain we are a member of and \f(CW<Machine>\fP is the primary
3284 \fB"NetBIOS name"\fP of the machine
3285 \fBsmbd\fP is running on\&. This parameter specifies how
3286 often this password will be changed, in seconds\&. The default is one
3287 week (expressed in seconds), the same as a Windows NT Domain member
3290 See also \fBsmbpasswd (8)\fP, and the
3291 \fB"security=domain"\fP) parameter\&.
3294 \f(CW machine password timeout = 604800\fP
3296 .IP "\fBmagic output (S)\fP"
3298 This parameter specifies the name of a file which will contain output
3299 created by a magic script (see the \fB"magic
3300 script"\fP parameter below)\&.
3302 Warning: If two clients use the same \fB"magic
3303 script"\fP in the same directory the output file content
3307 \f(CW magic output = <magic script name>\&.out\fP
3310 \f(CW magic output = myfile\&.txt\fP
3312 .IP "\fBmagic script (S)\fP"
3314 This parameter specifies the name of a file which, if opened, will be
3315 executed by the server when the file is closed\&. This allows a UNIX
3316 script to be sent to the Samba host and executed on behalf of the
3319 Scripts executed in this way will be deleted upon completion,
3320 permissions permitting\&.
3322 If the script generates output, output will be sent to the file
3323 specified by the \fB"magic output"\fP parameter (see
3326 Note that some shells are unable to interpret scripts containing
3327 carriage-return-linefeed instead of linefeed as the end-of-line
3328 marker\&. Magic scripts must be executable \fI"as is"\fP on the host,
3329 which for some hosts and some shells will require filtering at the DOS
3332 Magic scripts are \fIEXPERIMENTAL\fP and should \fINOT\fP be relied upon\&.
3335 \f(CW None\&. Magic scripts disabled\&.\fP
3338 \f(CW magic script = user\&.csh\fP
3340 .IP "\fBmangle case (S)\fP"
3342 See the section on \fB"NAME MANGLING"\fP\&.
3344 .IP "\fBmangle locks (S)\fP"
3346 This option is new with Samba 2\&.0\&.4 and above\&. It only has an effect on locking
3347 when Samba is running on a 32-bit platform such as Linux (2\&.0, 2\&.2) on x86 but not on
3348 64-bit platforms such as IRIX, Solaris 2\&.7 and above, AIX 4\&.2 etc\&.
3350 This option was introduced as NT clients have a bug in that they still send 64-bit
3351 lock requests to servers like Samba on 32-bit platforms that have explicitly
3352 told the client that they do not support 64-bit file access\&.
3354 If this option is set to "True" (the default) on a 32-bit system then Samba
3355 will truncate any lock length greater than 31 bits (the POSIX limit on 32-bit
3356 systems) and then attempt to mangle the lock offset from a 64-bit value to a
3357 high 32 bit value\&. It does this by examining the number of bits set in the
3358 top 32 bits, looking at the lower 31 bits starting from the 31st bit going
3359 downward (the POSIX limit on 32-bit systems) for a range of zero bits that
3360 this can be mapped into and then mapping the upper set bits into the lower
3363 If no space can be found then a locking error is returned to the client\&.
3365 Note that this option has \fBNO\fP effect on 64 bit systems\&. It should not
3366 be turned off on 32 bit systems unless it can be shown that this is causing
3367 a locking problem for a client application\&.
3370 \f(CW mangle locks = Yes\fP
3373 \f(CW mangle locks = No\fP
3375 .IP "\fBmangled map (S)\fP"
3377 This is for those who want to directly map UNIX file names which can
3378 not be represented on Windows/DOS\&. The mangling of names is not always
3379 what is needed\&. In particular you may have documents with file
3380 extensions that differ between DOS and UNIX\&. For example, under UNIX
3381 it is common to use \f(CW"\&.html"\fP for HTML files, whereas under
3382 Windows/DOS \f(CW"\&.htm"\fP is more commonly used\&.
3384 So to map \f(CW"html"\fP to \f(CW"htm"\fP you would use:
3386 \f(CW mangled map = (*\&.html *\&.htm)\fP
3388 One very useful case is to remove the annoying \f(CW";1"\fP off the ends
3389 of filenames on some CDROMS (only visible under some UNIXs)\&. To do
3390 this use a map of (*;1 *)\&.
3393 \f(CW no mangled map\fP
3396 \f(CW mangled map = (*;1 *)\fP
3398 .IP "\fBmangled names (S)\fP"
3400 This controls whether non-DOS names under UNIX should be mapped to
3401 DOS-compatible names ("mangled") and made visible, or whether non-DOS
3402 names should simply be ignored\&.
3404 See the section on \fB"NAME MANGLING"\fP for details
3405 on how to control the mangling process\&.
3407 If mangling is used then the mangling algorithm is as follows:
3411 The first (up to) five alphanumeric characters before the
3412 rightmost dot of the filename are preserved, forced to upper case, and
3413 appear as the first (up to) five characters of the mangled name\&.
3416 A tilde \f(CW"~"\fP is appended to the first part of the mangled
3417 name, followed by a two-character unique sequence, based on the
3418 original root name (i\&.e\&., the original filename minus its final
3419 extension)\&. The final extension is included in the hash calculation
3420 only if it contains any upper case characters or is longer than three
3423 Note that the character to use may be specified using the
3424 \fB"mangling char"\fP option, if you don\'t like
3428 The first three alphanumeric characters of the final extension
3429 are preserved, forced to upper case and appear as the extension of the
3430 mangled name\&. The final extension is defined as that part of the
3431 original filename after the rightmost dot\&. If there are no dots in the
3432 filename, the mangled name will have no extension (except in the case
3433 of \fB"hidden files"\fP - see below)\&.
3436 Files whose UNIX name begins with a dot will be presented as DOS
3437 hidden files\&. The mangled name will be created as for other filenames,
3438 but with the leading dot removed and \f(CW"___"\fP as its extension regardless
3439 of actual original extension (that\'s three underscores)\&.
3442 The two-digit hash value consists of upper case alphanumeric
3445 This algorithm can cause name collisions only if files in a directory
3446 share the same first five alphanumeric characters\&. The probability of
3447 such a clash is 1/1300\&.
3449 The name mangling (if enabled) allows a file to be copied between UNIX
3450 directories from Windows/DOS while retaining the long UNIX
3451 filename\&. UNIX files can be renamed to a new extension from
3452 Windows/DOS and will retain the same basename\&. Mangled names do not
3453 change between sessions\&.
3456 \f(CW mangled names = yes\fP
3459 \f(CW mangled names = no\fP
3461 .IP "\fBmangling char (S)\fP"
3463 This controls what character is used as the \fI"magic"\fP character in
3464 \fBname mangling\fP\&. The default is a \f(CW\'~\'\fP but
3465 this may interfere with some software\&. Use this option to set it to
3466 whatever you prefer\&.
3469 \f(CW mangling char = ~\fP
3472 \f(CW mangling char = ^\fP
3474 .IP "\fBmangled stack (G)\fP"
3476 This parameter controls the number of mangled names that should be
3477 cached in the Samba server \fBsmbd\fP\&.
3479 This stack is a list of recently mangled base names (extensions are
3480 only maintained if they are longer than 3 characters or contains upper
3483 The larger this value, the more likely it is that mangled names can be
3484 successfully converted to correct long UNIX names\&. However, large
3485 stack sizes will slow most directory access\&. Smaller stacks save
3486 memory in the server (each stack element costs 256 bytes)\&.
3488 It is not possible to absolutely guarantee correct long file names, so
3489 be prepared for some surprises!
3492 \f(CW mangled stack = 50\fP
3495 \f(CW mangled stack = 100\fP
3497 .IP "\fBmap archive (S)\fP"
3499 This controls whether the DOS archive attribute should be mapped to
3500 the UNIX owner execute bit\&. The DOS archive bit is set when a file
3501 has been modified since its last backup\&. One motivation for this
3502 option it to keep Samba/your PC from making any file it touches from
3503 becoming executable under UNIX\&. This can be quite annoying for shared
3504 source code, documents, etc\&.\&.\&.
3506 Note that this requires the \fB"create mask"\fP
3507 parameter to be set such that owner execute bit is not masked out
3508 (i\&.e\&. it must include 100)\&. See the parameter \fB"create
3509 mask"\fP for details\&.
3512 \f(CW map archive = yes\fP
3515 \f(CW map archive = no\fP
3517 .IP "\fBmap hidden (S)\fP"
3519 This controls whether DOS style hidden files should be mapped to the
3520 UNIX world execute bit\&.
3522 Note that this requires the \fB"create mask"\fP to be
3523 set such that the world execute bit is not masked out (i\&.e\&. it must
3524 include 001)\&. See the parameter \fB"create mask"\fP
3528 \f(CW map hidden = no\fP
3531 \f(CW map hidden = yes\fP
3533 .IP "\fBmap system (S)\fP"
3535 This controls whether DOS style system files should be mapped to the
3536 UNIX group execute bit\&.
3538 Note that this requires the \fB"create mask"\fP to be
3539 set such that the group execute bit is not masked out (i\&.e\&. it must
3540 include 010)\&. See the parameter \fB"create mask"\fP
3544 \f(CW map system = no\fP
3547 \f(CW map system = yes\fP
3549 .IP "\fBmap to guest (G)\fP"
3551 This parameter is only useful in \fBsecurity\fP modes
3552 other than \fB"security=share"\fP - i\&.e\&. user,
3553 server, and domain\&.
3555 This parameter can take three different values, which tell
3556 \fBsmbd\fP what to do with user login requests that
3557 don\'t match a valid UNIX user in some way\&.
3559 The three settings are :
3563 \fB"Never"\fP - Means user login requests with an invalid password
3564 are rejected\&. This is the default\&.
3567 \fB"Bad User"\fP - Means user logins with an invalid password are
3568 rejected, unless the username does not exist, in which case it is
3569 treated as a guest login and mapped into the \fB"guest
3573 \fB"Bad Password"\fP - Means user logins with an invalid
3574 password are treated as a guest login and mapped into the
3575 \fB"guest account"\fP\&. Note that this can
3576 cause problems as it means that any user incorrectly typing their
3577 password will be silently logged on a \fB"guest"\fP - and
3578 will not know the reason they cannot access files they think
3579 they should - there will have been no message given to them
3580 that they got their password wrong\&. Helpdesk services will
3581 \fI*hate*\fP you if you set the \fB"map to guest"\fP parameter
3585 Note that this parameter is needed to set up \fB"Guest"\fP share
3586 services when using \fBsecurity\fP modes other than
3587 share\&. This is because in these modes the name of the resource being
3588 requested is \fI*not*\fP sent to the server until after the server has
3589 successfully authenticated the client so the server cannot make
3590 authentication decisions at the correct time (connection to the
3591 share) for \fB"Guest"\fP shares\&.
3593 For people familiar with the older Samba releases, this parameter
3594 maps to the old compile-time setting of the GUEST_SESSSETUP value
3598 \f(CW map to guest = Never\fP
3600 \f(CW map to guest = Bad User\fP
3602 .IP "\fBmax connections (S)\fP"
3604 This option allows the number of simultaneous connections to a service
3605 to be limited\&. If \fB"max connections"\fP is greater than 0 then
3606 connections will be refused if this number of connections to the
3607 service are already open\&. A value of zero mean an unlimited number of
3608 connections may be made\&.
3610 Record lock files are used to implement this feature\&. The lock files
3611 will be stored in the directory specified by the \fB"lock
3612 directory"\fP option\&.
3615 \f(CW max connections = 0\fP
3618 \f(CW max connections = 10\fP
3620 .IP "\fBmax disk size (G)\fP"
3622 This option allows you to put an upper limit on the apparent size of
3623 disks\&. If you set this option to 100 then all shares will appear to be
3624 not larger than 100 MB in size\&.
3626 Note that this option does not limit the amount of data you can put on
3627 the disk\&. In the above case you could still store much more than 100
3628 MB on the disk, but if a client ever asks for the amount of free disk
3629 space or the total disk size then the result will be bounded by the
3630 amount specified in \fB"max disk size"\fP\&.
3632 This option is primarily useful to work around bugs in some pieces of
3633 software that can\'t handle very large disks, particularly disks over
3636 A \fB"max disk size"\fP of 0 means no limit\&.
3639 \f(CW max disk size = 0\fP
3642 \f(CW max disk size = 1000\fP
3644 .IP "\fBmax log size (G)\fP"
3646 This option (an integer in kilobytes) specifies the max size the log
3647 file should grow to\&. Samba periodically checks the size and if it is
3648 exceeded it will rename the file, adding a \f(CW"\&.old"\fP extension\&.
3650 A size of 0 means no limit\&.
3653 \f(CW max log size = 5000\fP
3656 \f(CW max log size = 1000\fP
3658 .IP "\fBmax mux (G)\fP"
3660 This option controls the maximum number of outstanding simultaneous
3661 SMB operations that samba tells the client it will allow\&. You should
3662 never need to set this parameter\&.
3665 \f(CW max mux = 50\fP
3667 .IP "\fBmax open files (G)\fP"
3669 This parameter limits the maximum number of open files that one
3670 \fBsmbd\fP file serving process may have open for
3671 a client at any one time\&. The default for this parameter is set
3672 very high (10,000) as Samba uses only one bit per unopened file\&.
3674 The limit of the number of open files is usually set by the
3675 UNIX per-process file descriptor limit rather than this parameter
3676 so you should never need to touch this parameter\&.
3679 \f(CW max open files = 10000\fP
3681 .IP "\fBmax packet (G)\fP"
3683 Synonym for (packetsize)\&.
3685 .IP "\fBmax ttl (G)\fP"
3687 This option tells \fBnmbd\fP what the default \'time
3688 to live\' of NetBIOS names should be (in seconds) when
3689 \fBnmbd\fP is requesting a name using either a
3690 broadcast packet or from a WINS server\&. You should never need to
3691 change this parameter\&. The default is 3 days\&.
3694 \f(CW max ttl = 259200\fP
3696 .IP "\fBmax wins ttl (G)\fP"
3698 This option tells \fBnmbd\fP when acting as a WINS
3699 server \fB(wins support =true)\fP what the maximum
3700 \'time to live\' of NetBIOS names that \fBnmbd\fP will
3701 grant will be (in seconds)\&. You should never need to change this
3702 parameter\&. The default is 6 days (518400 seconds)\&.
3704 See also the \fB"min wins ttl"\fP parameter\&.
3707 \f(CW max wins ttl = 518400\fP
3709 .IP "\fBmax xmit (G)\fP"
3711 This option controls the maximum packet size that will be negotiated
3712 by Samba\&. The default is 65535, which is the maximum\&. In some cases
3713 you may find you get better performance with a smaller value\&. A value
3714 below 2048 is likely to cause problems\&.
3717 \f(CW max xmit = 65535\fP
3720 \f(CW max xmit = 8192\fP
3722 .IP "\fBmessage command (G)\fP"
3724 This specifies what command to run when the server receives a WinPopup
3727 This would normally be a command that would deliver the message
3728 somehow\&. How this is to be done is up to your imagination\&.
3732 \f(CW message command = csh -c \'xedit %s;rm %s\' &\fP
3734 This delivers the message using \fBxedit\fP, then removes it
3735 afterwards\&. \fINOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN
3736 IMMEDIATELY\fP\&. That\'s why I have the \f(CW\'&\'\fP on the end\&. If it doesn\'t
3737 return immediately then your PCs may freeze when sending messages
3738 (they should recover after 30secs, hopefully)\&.
3740 All messages are delivered as the global guest user\&. The command takes
3741 the standard substitutions, although \fB%u\fP won\'t work
3742 (\fB%U\fP may be better in this case)\&.
3744 Apart from the standard substitutions, some additional ones apply\&. In
3749 \f(CW"%s"\fP = the filename containing the message\&.
3752 \f(CW"%t"\fP = the destination that the message was sent to (probably the server
3756 \f(CW"%f"\fP = who the message is from\&.
3759 You could make this command send mail, or whatever else takes your
3760 fancy\&. Please let us know of any really interesting ideas you have\&.
3762 Here\'s a way of sending the messages as mail to root:
3764 \f(CWmessage command = /bin/mail -s \'message from %f on %m\' root < %s; rm %s\fP
3766 If you don\'t have a message command then the message won\'t be
3767 delivered and Samba will tell the sender there was an
3768 error\&. Unfortunately WfWg totally ignores the error code and carries
3769 on regardless, saying that the message was delivered\&.
3771 If you want to silently delete it then try:
3773 \f(CW"message command = rm %s"\fP\&.
3776 \f(CW no message command\fP
3779 \f(CW message command = csh -c \'xedit %s;rm %s\' &\fP
3781 .IP "\fBmin print space (S)\fP"
3783 This sets the minimum amount of free disk space that must be available
3784 before a user will be able to spool a print job\&. It is specified in
3785 kilobytes\&. The default is 0, which means a user can always spool a print
3788 See also the \fBprinting\fP parameter\&.
3791 \f(CW min print space = 0\fP
3794 \f(CW min print space = 2000\fP
3796 .IP "\fBmin passwd length (G)\fP"
3798 This option sets the minimum length in characters of a plaintext password
3799 than smbd will accept when performing UNIX password changing\&.
3801 See also \fB"unix password sync"\fP,
3802 \fB"passwd program"\fP and \fB"passwd chat
3806 \f(CW min passwd length = 5\fP
3808 .IP "\fBmin wins ttl (G)\fP"
3810 This option tells \fBnmbd\fP when acting as a WINS
3811 server \fB(wins support = true)\fP what the minimum
3812 \'time to live\' of NetBIOS names that \fBnmbd\fP will
3813 grant will be (in seconds)\&. You should never need to change this
3814 parameter\&. The default is 6 hours (21600 seconds)\&.
3817 \f(CW min wins ttl = 21600\fP
3819 .IP "\fBname resolve order (G)\fP"
3821 This option is used by the programs in the Samba suite to determine
3822 what naming services and in what order to resolve host names to IP
3823 addresses\&. The option takes a space separated string of different name
3824 resolution options\&.
3826 The options are :"lmhosts", "host", "wins" and "bcast"\&. They cause
3827 names to be resolved as follows :
3831 \fBlmhosts\fP : Lookup an IP address in the Samba lmhosts file\&.
3832 If the line in lmhosts has no name type attached to the NetBIOS
3833 name (see the \fBlmhosts (5)\fP for details) then
3834 any name type matches for lookup\&.
3837 \fBhost\fP : Do a standard host name to IP address resolution,
3838 using the system /etc/hosts, NIS, or DNS lookups\&. This method of name
3839 resolution is operating system depended for instance on IRIX or
3840 Solaris this may be controlled by the \fI/etc/nsswitch\&.conf\fP file)\&.
3841 Note that this method is only used if the NetBIOS name type being
3842 queried is the 0x20 (server) name type, otherwise it is ignored\&.
3845 \fBwins\fP : Query a name with the IP address listed in the
3846 \fBwins server\fP parameter\&. If no WINS server has
3847 been specified this method will be ignored\&.
3850 \fBbcast\fP : Do a broadcast on each of the known local interfaces
3851 listed in the \fBinterfaces\fP parameter\&. This is the
3852 least reliable of the name resolution methods as it depends on the
3853 target host being on a locally connected subnet\&.
3857 \f(CW name resolve order = lmhosts host wins bcast\fP
3860 \f(CW name resolve order = lmhosts bcast host\fP
3862 This will cause the local lmhosts file to be examined first, followed
3863 by a broadcast attempt, followed by a normal system hostname lookup\&.
3865 .IP "\fBnetbios aliases (G)\fP"
3867 This is a list of NetBIOS names that \fBnmbd\fP will
3868 advertise as additional names by which the Samba server is known\&. This
3869 allows one machine to appear in browse lists under multiple names\&. If
3870 a machine is acting as a \fBbrowse server\fP or
3871 \fBlogon server\fP none of these names will be
3872 advertised as either browse server or logon servers, only the primary
3873 name of the machine will be advertised with these capabilities\&.
3875 See also \fB"netbios name"\fP\&.
3878 \f(CW empty string (no additional names)\fP
3881 \f(CW netbios aliases = TEST TEST1 TEST2\fP
3883 .IP "\fBnetbios name (G)\fP"
3885 This sets the NetBIOS name by which a Samba server is known\&. By
3886 default it is the same as the first component of the host\'s DNS name\&.
3887 If a machine is a \fBbrowse server\fP or
3888 \fBlogon server\fP this name (or the first component
3889 of the hosts DNS name) will be the name that these services are
3892 See also \fB"netbios aliases"\fP\&.
3895 \f(CW Machine DNS name\&.\fP
3898 \f(CW netbios name = MYNAME\fP
3900 .IP "\fBnis homedir (G)\fP"
3902 Get the home share server from a NIS map\&. For UNIX systems that use an
3903 automounter, the user\'s home directory will often be mounted on a
3904 workstation on demand from a remote server\&.
3906 When the Samba logon server is not the actual home directory server,
3907 but is mounting the home directories via NFS then two network hops
3908 would be required to access the users home directory if the logon
3909 server told the client to use itself as the SMB server for home
3910 directories (one over SMB and one over NFS)\&. This can be very
3913 This option allows Samba to return the home share as being on a
3914 different server to the logon server and as long as a Samba daemon is
3915 running on the home directory server, it will be mounted on the Samba
3916 client directly from the directory server\&. When Samba is returning the
3917 home share to the client, it will consult the NIS map specified in
3918 \fB"homedir map"\fP and return the server listed
3921 Note that for this option to work there must be a working NIS
3922 system and the Samba server with this option must also be a
3923 \fBlogon server\fP\&.
3926 \f(CW nis homedir = false\fP
3929 \f(CW nis homedir = true\fP
3931 .IP "\fBnt acl support (G)\fP"
3933 This boolean parameter controls whether \fBsmbd\fP
3934 will attempt to map UNIX permissions into Windows NT access control lists\&.
3937 \f(CW nt acl support = yes\fP
3940 \f(CW nt acl support = no\fP
3942 .IP "\fBnt pipe support (G)\fP"
3944 This boolean parameter controls whether \fBsmbd\fP
3945 will allow Windows NT clients to connect to the NT SMB specific
3946 \f(CWIPC$\fP pipes\&. This is a developer debugging option and can be left
3950 \f(CW nt pipe support = yes\fP
3952 .IP "\fBnt smb support (G)\fP"
3954 This boolean parameter controls whether \fBsmbd\fP
3955 will negotiate NT specific SMB support with Windows NT
3956 clients\&. Although this is a developer debugging option and should be
3957 left alone, benchmarking has discovered that Windows NT clients give
3958 faster performance with this option set to \f(CW"no"\fP\&. This is still
3959 being investigated\&. If this option is set to \f(CW"no"\fP then Samba
3960 offers exactly the same SMB calls that versions prior to Samba2\&.0
3961 offered\&. This information may be of use if any users are having
3962 problems with NT SMB support\&.
3965 \f(CW nt support = yes\fP
3967 .IP "\fBnull passwords (G)\fP"
3969 Allow or disallow client access to accounts that have null passwords\&.
3971 See also \fBsmbpasswd (5)\fP\&.
3974 \f(CW null passwords = no\fP
3977 \f(CW null passwords = yes\fP
3979 .IP "\fBole locking compatibility (G)\fP"
3981 This parameter allows an administrator to turn off the byte range lock
3982 manipulation that is done within Samba to give compatibility for OLE
3983 applications\&. Windows OLE applications use byte range locking as a
3984 form of inter-process communication, by locking ranges of bytes around
3985 the 2^32 region of a file range\&. This can cause certain UNIX lock
3986 managers to crash or otherwise cause problems\&. Setting this parameter
3987 to \f(CW"no"\fP means you trust your UNIX lock manager to handle such cases
3991 \f(CW ole locking compatibility = yes\fP
3994 \f(CW ole locking compatibility = no\fP
3996 .IP "\fBonly guest (S)\fP"
3998 A synonym for \fB"guest only"\fP\&.
4000 .IP "\fBonly user (S)\fP"
4002 This is a boolean option that controls whether connections with
4003 usernames not in the \fBuser=\fP list will be allowed\&. By
4004 default this option is disabled so a client can supply a username to
4005 be used by the server\&.
4007 Note that this also means Samba won\'t try to deduce usernames from the
4008 service name\&. This can be annoying for the \fB[homes]\fP
4009 section\&. To get around this you could use "\fBuser\fP =
4010 \fB%S\fP" which means your \fB"user"\fP list
4011 will be just the service name, which for home directories is the name
4014 See also the \fBuser\fP parameter\&.
4017 \f(CW only user = False\fP
4020 \f(CW only user = True\fP
4022 .IP "\fBoplocks (S)\fP"
4024 This boolean option tells smbd whether to issue oplocks (opportunistic
4025 locks) to file open requests on this share\&. The oplock code can
4026 dramatically (approx\&. 30% or more) improve the speed of access to files
4027 on Samba servers\&. It allows the clients to aggressively cache files
4028 locally and you may want to disable this option for unreliable network
4029 environments (it is turned on by default in Windows NT Servers)\&. For
4030 more information see the file Speed\&.txt in the Samba docs/ directory\&.
4032 Oplocks may be selectively turned off on certain files on a per share basis\&.
4033 See the \'veto oplock files\' parameter\&. On some systems oplocks are recognized
4034 by the underlying operating system\&. This allows data synchronization between
4035 all access to oplocked files, whether it be via Samba or NFS or a local
4036 UNIX process\&. See the \fBkernel oplocks\fP parameter
4040 \f(CW oplocks = True\fP
4043 \f(CW oplocks = False\fP
4045 .IP "\fBoplock break wait time (G)\fP.YODLTAGSTART. roffcmd .IP
4046 This is a tuning parameter added due to bugs in both Windows 9x and WinNT\&.
4047 If Samba responds to a client too quickly when that client issues an SMB that
4048 can cause an oplock break request, then the client redirector can fail and
4049 not respond to the break request\&. This tuning parameter (which is set in
4050 milliseconds) is the amount of time Samba will wait before sending an
4051 oplock break request to such (broken) clients\&.
4053 \fIDO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA
4057 \f(CW oplock break wait time = 10\fP
4059 .IP "\fBoplock contention limit (S)\fP"
4061 This is a \fIvery\fP advanced \fBsmbd\fP tuning option to improve
4062 the efficiency of the granting of oplocks under multiple client contention for the same file\&.
4064 In brief it specifies a number, which causes smbd not to grant an oplock even
4065 when requested if the approximate number of clients contending for an oplock on
4066 the same file goes over this limit\&. This causes \fBsmbd\fP to
4067 behave in a similar way to Windows NT\&.
4069 \fIDO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA
4073 \f(CW oplock contention limit = 2\fP
4075 .IP "\fBos level (G)\fP"
4077 This integer value controls what level Samba advertises itself as for
4078 browse elections\&. The value of this parameter determines whether
4079 \fBnmbd\fP has a chance of becoming a local master
4080 browser for the \fBWORKGROUP\fP in the local broadcast
4081 area\&. The default is zero, which means \fBnmbd\fP will
4082 lose elections to Windows machines\&. See BROWSING\&.txt in the Samba
4083 docs/ directory for details\&.
4086 \f(CW os level = 0\fP
4089 \f(CW os level = 65 ; This will win against any NT Server\fP
4091 .IP "\fBpacket size (G)\fP"
4093 This is a deprecated parameter that how no effect on the current
4094 Samba code\&. It is left in the parameter list to prevent breaking
4095 old \fBsmb\&.conf\fP files\&.
4097 .IP "\fBpanic action (G)\fP"
4099 This is a Samba developer option that allows a system command to be
4100 called when either \fBsmbd\fP or
4101 \fBnmbd\fP crashes\&. This is usually used to draw
4102 attention to the fact that a problem occurred\&.
4105 \f(CW panic action = <empty string>\fP
4107 .IP "\fBpasswd chat (G)\fP"
4109 This string controls the \fI"chat"\fP conversation that takes places
4110 between \fBsmbd\fP and the local password changing
4111 program to change the users password\&. The string describes a sequence
4112 of response-receive pairs that \fBsmbd\fP uses to
4113 determine what to send to the \fBpasswd\fP program
4114 and what to expect back\&. If the expected output is not received then
4115 the password is not changed\&.
4117 This chat sequence is often quite site specific, depending on what
4118 local methods are used for password control (such as NIS etc)\&.
4120 The string can contain the macros \f(CW"%o"\fP and \f(CW"%n"\fP which are
4121 substituted for the old and new passwords respectively\&. It can also
4122 contain the standard macros \f(CW"\en"\fP, \f(CW"\er"\fP, \f(CW"\et"\fP and \f(CW"\es"\fP
4123 to give line-feed, carriage-return, tab and space\&.
4125 The string can also contain a \f(CW\'*\'\fP which matches any sequence of
4128 Double quotes can be used to collect strings with spaces in them into
4131 If the send string in any part of the chat sequence is a fullstop
4132 \f(CW"\&."\fP then no string is sent\&. Similarly, is the expect string is a
4133 fullstop then no string is expected\&.
4135 Note that if the \fB"unix password sync"\fP
4136 parameter is set to true, then this sequence is called \fI*AS ROOT*\fP
4137 when the SMB password in the smbpasswd file is being changed, without
4138 access to the old password cleartext\&. In this case the old password
4139 cleartext is set to \f(CW""\fP (the empty string)\&.
4141 See also \fB"unix password sync"\fP,
4142 \fB"passwd program"\fP and \fB"passwd chat
4149 passwd chat = "*Enter OLD password*" %o\en "*Enter NEW password*" %n\en "*Reenter NEW password*" %n\en "*Password changed*"
4159 passwd chat = *old*password* %o\en *new*password* %n\en *new*password* %n\en *changed*
4164 .IP "\fBpasswd chat debug (G)\fP"
4166 This boolean specifies if the passwd chat script parameter is run in
4167 \f(CW"debug"\fP mode\&. In this mode the strings passed to and received from
4168 the passwd chat are printed in the \fBsmbd\fP log with
4169 a \fB"debug level"\fP of 100\&. This is a dangerous
4170 option as it will allow plaintext passwords to be seen in the
4171 \fBsmbd\fP log\&. It is available to help Samba admins
4172 debug their \fB"passwd chat"\fP scripts when calling
4173 the \fB"passwd program"\fP and should be turned off
4174 after this has been done\&. This parameter is off by default\&.
4176 See also \fB"passwd chat"\fP, \fB"passwd
4180 \f(CW passwd chat debug = True\fP
4183 \f(CW passwd chat debug = False\fP
4185 .IP "\fBpasswd program (G)\fP"
4187 The name of a program that can be used to set UNIX user passwords\&.
4188 Any occurrences of \fB%u\fP will be replaced with the
4189 user name\&. The user name is checked for existence before calling the
4190 password changing program\&.
4192 Also note that many passwd programs insist in \fI"reasonable"\fP
4193 passwords, such as a minimum length, or the inclusion of mixed case
4194 chars and digits\&. This can pose a problem as some clients (such as
4195 Windows for Workgroups) uppercase the password before sending it\&.
4197 \fINote\fP that if the \fB"unix password sync"\fP
4198 parameter is set to \f(CW"True"\fP then this program is called \fI*AS
4199 ROOT*\fP before the SMB password in the
4200 \fBsmbpasswd\fP file is changed\&. If this UNIX
4201 password change fails, then \fBsmbd\fP will fail to
4202 change the SMB password also (this is by design)\&.
4204 If the \fB"unix password sync"\fP parameter is
4205 set this parameter \fIMUST USE ABSOLUTE PATHS\fP for \fIALL\fP programs
4206 called, and must be examined for security implications\&. Note that by
4207 default \fB"unix password sync"\fP is set to
4210 See also \fB"unix password sync"\fP\&.
4213 \f(CW passwd program = /bin/passwd\fP
4216 \f(CW passwd program = /sbin/passwd %u\fP
4218 .IP "\fBpassword level (G)\fP"
4220 Some client/server combinations have difficulty with mixed-case
4221 passwords\&. One offending client is Windows for Workgroups, which for
4222 some reason forces passwords to upper case when using the LANMAN1
4223 protocol, but leaves them alone when using COREPLUS!
4225 This parameter defines the maximum number of characters that may be
4226 upper case in passwords\&.
4228 For example, say the password given was \f(CW"FRED"\fP\&. If \fBpassword
4229 level\fP is set to 1, the following combinations would be tried if
4230 \f(CW"FRED"\fP failed:
4232 \f(CW"Fred"\fP, \f(CW"fred"\fP, \f(CW"fRed"\fP, \f(CW"frEd"\fP, \f(CW"freD"\fP
4234 If \fBpassword level\fP was set to 2, the following combinations would
4237 \f(CW"FRed"\fP, \f(CW"FrEd"\fP, \f(CW"FreD"\fP, \f(CW"fREd"\fP, \f(CW"fReD"\fP,
4238 \f(CW"frED"\fP, \f(CW\&.\&.\fP
4242 The higher value this parameter is set to the more likely it is that a
4243 mixed case password will be matched against a single case
4244 password\&. However, you should be aware that use of this parameter
4245 reduces security and increases the time taken to process a new
4248 A value of zero will cause only two attempts to be made - the password
4249 as is and the password in all-lower case\&.
4252 \f(CW password level = 0\fP
4255 \f(CW password level = 4\fP
4257 .IP "\fBpassword server (G)\fP"
4259 By specifying the name of another SMB server (such as a WinNT box)
4260 with this option, and using \fB"security = domain"\fP or
4261 \fB"security = server"\fP you can get Samba to do all
4262 its username/password validation via a remote server\&.
4264 This options sets the name of the password server to use\&. It must be a
4265 NetBIOS name, so if the machine\'s NetBIOS name is different from its
4266 internet name then you may have to add its NetBIOS name to the lmhosts
4267 file which is stored in the same directory as the \fBsmb\&.conf\fP file\&.
4269 The name of the password server is looked up using the parameter
4270 \fB"name resolve order="\fP and so may resolved
4271 by any method and order described in that parameter\&.
4273 The password server much be a machine capable of using the "LM1\&.2X002"
4274 or the "LM NT 0\&.12" protocol, and it must be in user level security
4277 NOTE: Using a password server means your UNIX box (running Samba) is
4278 only as secure as your password server\&. \fIDO NOT CHOOSE A PASSWORD
4279 SERVER THAT YOU DON\'T COMPLETELY TRUST\fP\&.
4281 Never point a Samba server at itself for password serving\&. This will
4282 cause a loop and could lock up your Samba server!
4284 The name of the password server takes the standard substitutions, but
4285 probably the only useful one is \fB%m\fP, which means
4286 the Samba server will use the incoming client as the password
4287 server\&. If you use this then you better trust your clients, and you
4288 better restrict them with hosts allow!
4290 If the \fB"security"\fP parameter is set to
4291 \fB"domain"\fP, then the list of machines in this option must be a list
4292 of Primary or Backup Domain controllers for the
4293 \fBDomain\fP, as the Samba server is cryptographicly
4294 in that domain, and will use cryptographicly authenticated RPC calls
4295 to authenticate the user logging on\&. The advantage of using
4296 \fB"security=domain"\fP is that if you list
4297 several hosts in the \fB"password server"\fP option then
4298 \fBsmbd\fP will try each in turn till it finds one
4299 that responds\&. This is useful in case your primary server goes down\&.
4301 If the \fB"security"\fP parameter is set to
4302 \fB"server"\fP, then there are different
4303 restrictions that \fB"security=domain"\fP
4304 doesn\'t suffer from:
4308 You may list several password servers in the \fB"password server"\fP
4309 parameter, however if an \fBsmbd\fP makes a connection
4310 to a password server, and then the password server fails, no more
4311 users will be able to be authenticated from this
4312 \fBsmbd\fP\&. This is a restriction of the SMB/CIFS
4313 protocol when in \fB"security=server"\fP mode
4314 and cannot be fixed in Samba\&.
4317 If you are using a Windows NT server as your password server then
4318 you will have to ensure that your users are able to login from the
4319 Samba server, as when in
4320 \fB"security=server"\fP mode the network
4321 logon will appear to come from there rather than from the users
4325 See also the \fB"security"\fP parameter\&.
4328 \f(CW password server = <empty string>\fP
4331 \f(CW password server = NT-PDC, NT-BDC1, NT-BDC2\fP
4333 .IP "\fBpath (S)\fP"
4335 This parameter specifies a directory to which the user of the service
4336 is to be given access\&. In the case of printable services, this is
4337 where print data will spool prior to being submitted to the host for
4340 For a printable service offering guest access, the service should be
4341 readonly and the path should be world-writeable and have the sticky bit
4342 set\&. This is not mandatory of course, but you probably won\'t get the
4343 results you expect if you do otherwise\&.
4345 Any occurrences of \fB%u\fP in the path will be replaced
4346 with the UNIX username that the client is using on this
4347 connection\&. Any occurrences of \fB%m\fP will be replaced
4348 by the NetBIOS name of the machine they are connecting from\&. These
4349 replacements are very useful for setting up pseudo home directories
4352 Note that this path will be based on \fB"root dir"\fP if
4353 one was specified\&.
4359 \f(CW path = /home/fred\fP
4361 .IP "\fBpostexec (S)\fP"
4363 This option specifies a command to be run whenever the service is
4364 disconnected\&. It takes the usual substitutions\&. The command may be run
4365 as the root on some systems\&.
4367 An interesting example may be do unmount server resources:
4369 \f(CWpostexec = /etc/umount /cdrom\fP
4371 See also \fBpreexec\fP\&.
4374 \f(CW none (no command executed)\fP
4377 \f(CW postexec = echo "%u disconnected from %S from %m (%I)" >> /tmp/log\fP
4379 .IP "\fBpostscript (S)\fP"
4381 This parameter forces a printer to interpret the print files as
4382 postscript\&. This is done by adding a \f(CW%!\fP to the start of print output\&.
4384 This is most useful when you have lots of PCs that persist in putting
4385 a control-D at the start of print jobs, which then confuses your
4389 \f(CW postscript = False\fP
4392 \f(CW postscript = True\fP
4394 .IP "\fBpreexec (S)\fP"
4396 This option specifies a command to be run whenever the service is
4397 connected to\&. It takes the usual substitutions\&.
4399 An interesting example is to send the users a welcome message every
4400 time they log in\&. Maybe a message of the day? Here is an example:
4406 preexec = csh -c \'echo \e"Welcome to %S!\e" | /usr/local/samba/bin/smbclient -M %m -I %I\' &
4412 Of course, this could get annoying after a while :-" .YODLTAGEND.
4414 See also \fBpostexec\fP\&.
4417 \f(CW none (no command executed)\fP
4420 \f(CW preexec = echo \e"%u connected to %S from %m (%I)\e" >> /tmp/log\fP
4422 .IP "\fBpreferred master (G)\fP"
4424 This boolean parameter controls if \fBnmbd\fP is a
4425 preferred master browser for its workgroup\&.
4427 If this is set to true, on startup, \fBnmbd\fP will
4428 force an election, and it will have a slight advantage in winning the
4429 election\&. It is recommended that this parameter is used in
4430 conjunction with \fB"domain master = yes"\fP, so
4431 that \fBnmbd\fP can guarantee becoming a domain
4434 Use this option with caution, because if there are several hosts
4435 (whether Samba servers, Windows 95 or NT) that are preferred master
4436 browsers on the same subnet, they will each periodically and
4437 continuously attempt to become the local master browser\&. This will
4438 result in unnecessary broadcast traffic and reduced browsing
4441 See also \fBos level\fP\&.
4444 \f(CW preferred master = no\fP
4447 \f(CW preferred master = yes\fP
4449 .IP "\fBprefered master (G)\fP"
4451 Synonym for \fB"preferred master"\fP for people
4452 who cannot spell :-)\&.
4455 Synonym for \fB"auto services"\fP\&.
4457 .IP "\fBpreserve case (S)\fP"
4459 This controls if new filenames are created with the case that the
4460 client passes, or if they are forced to be the \f(CW"default"\fP case\&.
4463 \f(CW preserve case = yes\fP
4465 See the section on \fB"NAME MANGLING"\fP for a
4466 fuller discussion\&.
4468 .IP "\fBprint command (S)\fP"
4470 After a print job has finished spooling to a service, this command
4471 will be used via a \f(CWsystem()\fP call to process the spool
4472 file\&. Typically the command specified will submit the spool file to
4473 the host\'s printing subsystem, but there is no requirement that this
4474 be the case\&. The server will not remove the spool file, so whatever
4475 command you specify should remove the spool file when it has been
4476 processed, otherwise you will need to manually remove old spool files\&.
4478 The print command is simply a text string\&. It will be used verbatim,
4479 with two exceptions: All occurrences of \f(CW"%s"\fP will be replaced by
4480 the appropriate spool file name, and all occurrences of \f(CW"%p"\fP will
4481 be replaced by the appropriate printer name\&. The spool file name is
4482 generated automatically by the server, the printer name is discussed
4485 The full path name will be used for the filename if \f(CW"%s"\fP is not
4486 preceded by a \f(CW\'/\'\fP\&. If you don\'t like this (it can stuff up some
4487 lpq output) then use \f(CW"%f"\fP instead\&. Any occurrences of \f(CW"%f"\fP get
4488 replaced by the spool filename without the full path at the front\&.
4490 The print command \fIMUST\fP contain at least one occurrence of \f(CW"%s"\fP
4491 or \f(CW"%f"\fP - the \f(CW"%p"\fP is optional\&. At the time a job is
4492 submitted, if no printer name is supplied the \f(CW"%p"\fP will be
4493 silently removed from the printer command\&.
4495 If specified in the \fB"[global]"\fP section, the print
4496 command given will be used for any printable service that does not
4497 have its own print command specified\&.
4499 If there is neither a specified print command for a printable service
4500 nor a global print command, spool files will be created but not
4501 processed and (most importantly) not removed\&.
4503 Note that printing may fail on some UNIXs from the \f(CW"nobody"\fP
4504 account\&. If this happens then create an alternative guest account that
4505 can print and set the \fB"guest account"\fP in the
4506 \fB"[global]"\fP section\&.
4508 You can form quite complex print commands by realizing that they are
4509 just passed to a shell\&. For example the following will log a print
4510 job, print the file, then remove it\&. Note that \f(CW\';\'\fP is the usual
4511 separator for command in shell scripts\&.
4513 \f(CWprint command = echo Printing %s >> /tmp/print\&.log; lpr -P %p %s; rm %s\fP
4515 You may have to vary this command considerably depending on how you
4516 normally print files on your system\&. The default for the parameter
4517 varies depending on the setting of the \fB"printing="\fP
4521 For \fB"printing="\fP BSD, AIX, QNX, LPRNG or PLP :
4522 \f(CW print command = lpr -r -P%p %s\fP
4524 For \fB"printing="\fP SYS or HPUX :
4525 \f(CW print command = lp -c -d%p %s; rm %s\fP
4527 For \fB"printing="\fP SOFTQ :
4528 \f(CW print command = lp -d%p -s %s; rm %s\fP
4531 \f(CW print command = /usr/local/samba/bin/myprintscript %p %s\fP
4533 .IP "\fBprint ok (S)\fP"
4535 Synonym for \fBprintable\fP\&.
4537 .IP "\fBprintable (S)\fP"
4539 If this parameter is \f(CW"yes"\fP, then clients may open, write to and
4540 submit spool files on the directory specified for the service\&.
4542 Note that a printable service will ALWAYS allow writing to the service
4543 path (user privileges permitting) via the spooling of print data\&. The
4544 \fB"read only"\fP parameter controls only non-printing
4545 access to the resource\&.
4548 \f(CW printable = no\fP
4551 \f(CW printable = yes\fP
4553 .IP "\fBprintcap (G)\fP"
4555 Synonym for \fBprintcapname\fP\&.
4557 .IP "\fBprintcap name (G)\fP"
4559 This parameter may be used to override the compiled-in default
4560 printcap name used by the server (usually /etc/printcap)\&. See the
4561 discussion of the \fB[printers]\fP section above for
4562 reasons why you might want to do this\&.
4564 On System V systems that use \fBlpstat\fP to list available printers you
4565 can use \f(CW"printcap name = lpstat"\fP to automatically obtain lists of
4566 available printers\&. This is the default for systems that define SYSV
4567 at configure time in Samba (this includes most System V based
4568 systems)\&. If \fB"printcap name"\fP is set to \fBlpstat\fP on these systems
4569 then Samba will launch \f(CW"lpstat -v"\fP and attempt to parse the output
4570 to obtain a printer list\&.
4572 A minimal printcap file would look something like this:
4588 where the \f(CW\'|\'\fP separates aliases of a printer\&. The fact that the
4589 second alias has a space in it gives a hint to Samba that it\'s a
4592 \fINOTE\fP: Under AIX the default printcap name is
4593 \f(CW"/etc/qconfig"\fP\&. Samba will assume the file is in AIX \f(CW"qconfig"\fP
4594 format if the string \f(CW"/qconfig"\fP appears in the printcap filename\&.
4597 \f(CW printcap name = /etc/printcap\fP
4600 \f(CW printcap name = /etc/myprintcap\fP
4602 .IP "\fBprinter (S)\fP"
4604 This parameter specifies the name of the printer to which print jobs
4605 spooled through a printable service will be sent\&.
4607 If specified in the \fB[global]\fP section, the printer
4608 name given will be used for any printable service that does not have
4609 its own printer name specified\&.
4612 none (but may be \f(CW"lp"\fP on many systems)
4615 printer name = laserwriter
4617 .IP "\fBprinter driver (S)\fP"
4619 This option allows you to control the string that clients receive when
4620 they ask the server for the printer driver associated with a
4621 printer\&. If you are using Windows95 or WindowsNT then you can use this
4622 to automate the setup of printers on your system\&.
4624 You need to set this parameter to the exact string (case sensitive)
4625 that describes the appropriate printer driver for your system\&. If you
4626 don\'t know the exact string to use then you should first try with no
4627 \fB"printer driver"\fP option set and the client will give you a list of
4628 printer drivers\&. The appropriate strings are shown in a scrollbox
4629 after you have chosen the printer manufacturer\&.
4631 See also \fB"printer driver file"\fP\&.
4634 printer driver = HP LaserJet 4L
4636 .IP "\fBprinter driver file (G)\fP"
4638 This parameter tells Samba where the printer driver definition file,
4639 used when serving drivers to Windows 95 clients, is to be found\&. If
4640 this is not set, the default is :
4642 \f(CWSAMBA_INSTALL_DIRECTORY/lib/printers\&.def\fP
4644 This file is created from Windows 95 \f(CW"msprint\&.def"\fP files found on
4645 the Windows 95 client system\&. For more details on setting up serving
4646 of printer drivers to Windows 95 clients, see the documentation file
4647 in the docs/ directory, PRINTER_DRIVER\&.txt\&.
4650 \f(CW None (set in compile)\&.\fP
4653 \f(CW printer driver file = /usr/local/samba/printers/drivers\&.def\fP
4655 See also \fB"printer driver location"\fP\&.
4657 .IP "\fBprinter driver location (S)\fP"
4659 This parameter tells clients of a particular printer share where to
4660 find the printer driver files for the automatic installation of
4661 drivers for Windows 95 machines\&. If Samba is set up to serve printer
4662 drivers to Windows 95 machines, this should be set to
4664 \f(CW\e\eMACHINE\eaPRINTER$\fP
4666 Where MACHINE is the NetBIOS name of your Samba server, and PRINTER$
4667 is a share you set up for serving printer driver files\&. For more
4668 details on setting this up see the documentation file in the docs/
4669 directory, PRINTER_DRIVER\&.txt\&.
4675 \f(CW printer driver location = \e\eMACHINE\ePRINTER$\fP
4677 See also \fB"printer driver file"\fP\&.
4679 .IP "\fBprinter name (S)\fP"
4681 Synonym for \fBprinter\fP\&.
4683 .IP "\fBprinting (S)\fP"
4685 This parameters controls how printer status information is interpreted
4686 on your system, and also affects the default values for the
4687 \fB"print command"\fP, \fB"lpq
4688 command"\fP \fB"lppause command"\fP,
4689 \fB"lpresume command"\fP, and \fB"lprm
4692 Currently eight printing styles are supported\&. They are
4693 \fB"printing=BSD"\fP, \fB"printing=AIX"\fP, \fB"printing=LPRNG"\fP,
4694 \fB"printing=PLP"\fP,
4695 \fB"printing=SYSV"\fP,\fB"printing="HPUX"\fP,\fB"printing=QNX"\fP and
4696 \fB"printing=SOFTQ"\fP\&.
4698 To see what the defaults are for the other print commands when using
4699 these three options use the \fB"testparm"\fP program\&.
4701 This option can be set on a per printer basis
4703 See also the discussion in the \fB[printers]\fP section\&.
4705 .IP "\fBprotocol (G)\fP"
4707 The value of the parameter (a string) is the highest protocol level
4708 that will be supported by the server\&.
4710 Possible values are :
4714 CORE: Earliest version\&. No concept of user names\&.
4717 COREPLUS: Slight improvements on CORE for efficiency\&.
4720 LANMAN1: First \fI"modern"\fP version of the protocol\&. Long
4724 LANMAN2: Updates to Lanman1 protocol\&.
4727 NT1: Current up to date version of the protocol\&. Used by Windows
4728 NT\&. Known as CIFS\&.
4731 Normally this option should not be set as the automatic negotiation
4732 phase in the SMB protocol takes care of choosing the appropriate
4736 \f(CW protocol = NT1\fP
4739 \f(CW protocol = LANMAN1\fP
4741 .IP "\fBpublic (S)\fP"
4743 Synonym for \fB"guest ok"\fP\&.
4745 .IP "\fBqueuepause command (S)\fP"
4747 This parameter specifies the command to be executed on the server host
4748 in order to pause the printerqueue\&.
4750 This command should be a program or script which takes a printer name
4751 as its only parameter and stops the printerqueue, such that no longer
4752 jobs are submitted to the printer\&.
4754 This command is not supported by Windows for Workgroups, but can be
4755 issued from the Printer\'s window under Windows 95 & NT\&.
4757 If a \f(CW"%p"\fP is given then the printername is put in its
4758 place\&. Otherwise it is placed at the end of the command\&.
4760 Note that it is good practice to include the absolute path in the
4761 command as the PATH may not be available to the server\&.
4764 \f(CW depends on the setting of "printing ="\fP
4767 \f(CW queuepause command = disable %p\fP
4769 .IP "\fBqueueresume command (S)\fP"
4771 This parameter specifies the command to be executed on the server host
4772 in order to resume the printerqueue\&. It is the command to undo the
4773 behavior that is caused by the previous parameter
4774 (\fB"queuepause command\fP)\&.
4776 This command should be a program or script which takes a printer name
4777 as its only parameter and resumes the printerqueue, such that queued
4778 jobs are resubmitted to the printer\&.
4780 This command is not supported by Windows for Workgroups, but can be
4781 issued from the Printer\'s window under Windows 95 & NT\&.
4783 If a \f(CW"%p"\fP is given then the printername is put in its
4784 place\&. Otherwise it is placed at the end of the command\&.
4786 Note that it is good practice to include the absolute path in the
4787 command as the PATH may not be available to the server\&.
4790 \f(CW depends on the setting of "printing ="\fP
4793 \f(CW queuepause command = enable %p\fP
4795 .IP "\fBread bmpx (G)\fP"
4797 This boolean parameter controls whether \fBsmbd\fP
4798 will support the "Read Block Multiplex" SMB\&. This is now rarely used
4799 and defaults to off\&. You should never need to set this parameter\&.
4804 .IP "\fBread list (S)\fP"
4806 This is a list of users that are given read-only access to a
4807 service\&. If the connecting user is in this list then they will not be
4808 given write access, no matter what the \fB"read only"\fP
4809 option is set to\&. The list can include group names using the syntax
4810 described in the \fB"invalid users"\fP parameter\&.
4812 See also the \fB"write list"\fP parameter and
4813 the \fB"invalid users"\fP parameter\&.
4816 \f(CW read list = <empty string>\fP
4819 \f(CW read list = mary, @students\fP
4821 .IP "\fBread only (S)\fP"
4823 Note that this is an inverted synonym for
4824 \fB"writeable"\fP and \fB"write ok"\fP\&.
4826 See also \fB"writeable"\fP and \fB"write
4829 .IP "\fBread prediction (G)\fP"
4831 \fINOTE\fP: This code is currently disabled in Samba2\&.0 and
4832 may be removed at a later date\&. Hence this parameter has
4835 This options enables or disables the read prediction code used to
4836 speed up reads from the server\&. When enabled the server will try to
4837 pre-read data from the last accessed file that was opened read-only
4838 while waiting for packets\&.
4841 \f(CW read prediction = False\fP
4843 .IP "\fBread raw (G)\fP"
4845 This parameter controls whether or not the server will support the raw
4846 read SMB requests when transferring data to clients\&.
4848 If enabled, raw reads allow reads of 65535 bytes in one packet\&. This
4849 typically provides a major performance benefit\&.
4851 However, some clients either negotiate the allowable block size
4852 incorrectly or are incapable of supporting larger block sizes, and for
4853 these clients you may need to disable raw reads\&.
4855 In general this parameter should be viewed as a system tuning tool and left
4856 severely alone\&. See also \fB"write raw"\fP\&.
4859 \f(CW read raw = yes\fP
4861 .IP "\fBread size (G)\fP"
4863 The option \fB"read size"\fP affects the overlap of disk reads/writes
4864 with network reads/writes\&. If the amount of data being transferred in
4865 several of the SMB commands (currently SMBwrite, SMBwriteX and
4866 SMBreadbraw) is larger than this value then the server begins writing
4867 the data before it has received the whole packet from the network, or
4868 in the case of SMBreadbraw, it begins writing to the network before
4869 all the data has been read from disk\&.
4871 This overlapping works best when the speeds of disk and network access
4872 are similar, having very little effect when the speed of one is much
4873 greater than the other\&.
4875 The default value is 16384, but very little experimentation has been
4876 done yet to determine the optimal value, and it is likely that the
4877 best value will vary greatly between systems anyway\&. A value over
4878 65536 is pointless and will cause you to allocate memory
4882 \f(CW read size = 16384\fP
4885 \f(CW read size = 8192\fP
4887 .IP "\fBremote announce (G)\fP"
4889 This option allows you to setup \fBnmbd\fP to
4890 periodically announce itself to arbitrary IP addresses with an
4891 arbitrary workgroup name\&.
4893 This is useful if you want your Samba server to appear in a remote
4894 workgroup for which the normal browse propagation rules don\'t
4895 work\&. The remote workgroup can be anywhere that you can send IP
4900 \f(CW remote announce = 192\&.168\&.2\&.255/SERVERS 192\&.168\&.4\&.255/STAFF\fP
4902 the above line would cause nmbd to announce itself to the two given IP
4903 addresses using the given workgroup names\&. If you leave out the
4904 workgroup name then the one given in the
4905 \fB"workgroup"\fP parameter is used instead\&.
4907 The IP addresses you choose would normally be the broadcast addresses
4908 of the remote networks, but can also be the IP addresses of known
4909 browse masters if your network config is that stable\&.
4911 See the documentation file BROWSING\&.txt in the docs/ directory\&.
4914 \f(CW remote announce = <empty string>\fP
4917 \f(CW remote announce = 192\&.168\&.2\&.255/SERVERS 192\&.168\&.4\&.255/STAFF\fP
4919 .IP "\fBremote browse sync (G)\fP"
4921 This option allows you to setup \fBnmbd\fP to
4922 periodically request synchronization of browse lists with the master
4923 browser of a samba server that is on a remote segment\&. This option
4924 will allow you to gain browse lists for multiple workgroups across
4925 routed networks\&. This is done in a manner that does not work with any
4926 non-samba servers\&.
4928 This is useful if you want your Samba server and all local clients to
4929 appear in a remote workgroup for which the normal browse propagation
4930 rules don\'t work\&. The remote workgroup can be anywhere that you can
4931 send IP packets to\&.
4935 \f(CW remote browse sync = 192\&.168\&.2\&.255 192\&.168\&.4\&.255\fP
4937 the above line would cause \fBnmbd\fP to request the
4938 master browser on the specified subnets or addresses to synchronize
4939 their browse lists with the local server\&.
4941 The IP addresses you choose would normally be the broadcast addresses
4942 of the remote networks, but can also be the IP addresses of known
4943 browse masters if your network config is that stable\&. If a machine IP
4944 address is given Samba makes NO attempt to validate that the remote
4945 machine is available, is listening, nor that it is in fact the browse
4946 master on it\'s segment\&.
4949 \f(CW remote browse sync = <empty string>\fP
4952 \f(CW remote browse sync = 192\&.168\&.2\&.255 192\&.168\&.4\&.255\fP
4954 .IP "\fBrestrict anonymous (G)\fP"
4956 This is a boolean parameter\&. If it is true, then anonymous access
4957 to the server will be restricted, namely in the case where the server
4958 is expecting the client to send a username, but it doesn\'t\&. Setting
4959 it to true will force these anonymous connections to be denied, and
4960 the client will be required to always supply a username and password
4961 when connecting\&. Use of this parameter is only recommened for homogenous
4962 NT client environments\&.
4964 This parameter makes the use of macro expansions that rely
4965 on the username (%U, %G, etc) consistant\&. NT 4\&.0 likes to use
4966 anonymous connections when refreshing the share list, and this
4967 is a way to work around that\&.
4969 When restrict anonymous is true, all anonymous connections are denied
4970 no matter what they are for\&. This can effect the ability of a machine
4971 to access the samba Primary Domain Controller to revalidate it\'s machine
4972 account after someone else has logged on the client interactively\&. The
4973 NT client will display a message saying that the machine\'s account in
4974 the domain doesn\'t exist or the password is bad\&. The best way to deal
4975 with this is to reboot NT client machines between interactive logons,
4976 using "Shutdown and Restart", rather than "Close all programs and logon
4977 as a different user"\&.
4980 \f(CW restrict anonymous = false\fP
4983 \f(CW restrict anonymous = true\fP
4985 .IP "\fBrevalidate (S)\fP"
4987 Note that this option only works with
4988 \fB"security=share"\fP and will be ignored if
4989 this is not the case\&.
4991 This option controls whether Samba will allow a previously validated
4992 username/password pair to be used to attach to a share\&. Thus if you
4993 connect to \f(CW\e\eserver\eshare1\fP then to \f(CW\e\eserver\eshare2\fP it won\'t
4994 automatically allow the client to request connection to the second
4995 share as the same username as the first without a password\&.
4997 If \fB"revalidate"\fP is \f(CW"True"\fP then the client will be denied
4998 automatic access as the same username\&.
5001 \f(CW revalidate = False\fP
5004 \f(CW revalidate = True\fP
5006 .IP "\fBroot (G)\fP"
5008 Synonym for \fB"root directory"\fP\&.
5010 .IP "\fBroot dir (G)\fP"
5012 Synonym for \fB"root directory"\fP\&.
5014 .IP "\fBroot directory (G)\fP"
5016 The server will \f(CW"chroot()"\fP (i\&.e\&. Change it\'s root directory) to
5017 this directory on startup\&. This is not strictly necessary for secure
5018 operation\&. Even without it the server will deny access to files not in
5019 one of the service entries\&. It may also check for, and deny access to,
5020 soft links to other parts of the filesystem, or attempts to use
5021 \f(CW"\&.\&."\fP in file names to access other directories (depending on the
5022 setting of the \fB"wide links"\fP parameter)\&.
5024 Adding a \fB"root directory"\fP entry other than \f(CW"/"\fP adds an extra
5025 level of security, but at a price\&. It absolutely ensures that no
5026 access is given to files not in the sub-tree specified in the \fB"root
5027 directory"\fP option, \fI*including*\fP some files needed for complete
5028 operation of the server\&. To maintain full operability of the server
5029 you will need to mirror some system files into the \fB"root
5030 directory"\fP tree\&. In particular you will need to mirror /etc/passwd
5031 (or a subset of it), and any binaries or configuration files needed
5032 for printing (if required)\&. The set of files that must be mirrored is
5033 operating system dependent\&.
5036 \f(CW root directory = /\fP
5039 \f(CW root directory = /homes/smb\fP
5041 .IP "\fBroot postexec (S)\fP"
5043 This is the same as the \fB"postexec"\fP parameter
5044 except that the command is run as root\&. This is useful for unmounting
5045 filesystems (such as cdroms) after a connection is closed\&.
5047 See also \fB"postexec"\fP\&.
5049 .IP "\fBroot preexec (S)\fP"
5051 This is the same as the \fB"preexec"\fP parameter except
5052 that the command is run as root\&. This is useful for mounting
5053 filesystems (such as cdroms) before a connection is finalized\&.
5055 See also \fB"preexec"\fP\&.
5057 .IP "\fBsecurity (G)\fP"
5059 This option affects how clients respond to Samba and is one of the most
5060 important settings in the \fBsmb\&.conf\fP file\&.
5062 The option sets the \f(CW"security mode bit"\fP in replies to protocol
5063 negotiations with \fBsmbd\fP to turn share level
5064 security on or off\&. Clients decide based on this bit whether (and how)
5065 to transfer user and password information to the server\&.
5067 The default is "security=user", as this is
5068 the most common setting needed when talking to Windows 98 and Windows
5071 The alternatives are \fB"security = share"\fP,
5072 \fB"security = server"\fP or
5073 \fB"security=domain"\fP\&.
5075 \fI*****NOTE THAT THIS DEFAULT IS DIFFERENT IN SAMBA2\&.0 THAN FOR
5076 PREVIOUS VERSIONS OF SAMBA *******\fP\&.
5078 In previous versions of Samba the default was
5079 \fB"security=share"\fP mainly because that was
5080 the only option at one stage\&.
5082 There is a bug in WfWg that has relevance to this setting\&. When in
5083 user or server level security a WfWg client will totally ignore the
5084 password you type in the "connect drive" dialog box\&. This makes it
5085 very difficult (if not impossible) to connect to a Samba service as
5086 anyone except the user that you are logged into WfWg as\&.
5088 If your PCs use usernames that are the same as their usernames on the
5089 UNIX machine then you will want to use \fB"security = user"\fP\&. If you
5090 mostly use usernames that don\'t exist on the UNIX box then use
5091 \fB"security = share"\fP\&.
5093 You should also use \fBsecurity=share\fP if
5094 you want to mainly setup shares without a password (guest
5095 shares)\&. This is commonly used for a shared printer server\&. It is more
5096 difficult to setup guest shares with
5097 \fBsecurity=user\fP, see the \fB"map to
5098 guest"\fPparameter for details\&.
5100 It is possible to use \fBsmbd\fP in a \fI"hybrid
5101 mode"\fP where it is offers both user and share level security under
5102 different \fBNetBIOS aliases\fP\&. See the
5103 \fBNetBIOS aliases\fP and the
5104 \fBinclude\fP parameters for more information\&.
5106 The different settings will now be explained\&.
5109 .IP "\fB"security=share"\fP"
5110 When clients connect to a share level
5111 security server then need not log onto the server with a valid
5112 username and password before attempting to connect to a shared
5113 resource (although modern clients such as Windows 95/98 and Windows NT
5114 will send a logon request with a username but no password when talking
5115 to a \fBsecurity=share\fP server)\&. Instead, the clients send
5116 authentication information (passwords) on a per-share basis, at the
5117 time they attempt to connect to that share\&.
5119 Note that \fBsmbd\fP \fI*ALWAYS*\fP uses a valid UNIX
5120 user to act on behalf of the client, even in \fB"security=share"\fP
5123 As clients are not required to send a username to the server
5124 in share level security, \fBsmbd\fP uses several
5125 techniques to determine the correct UNIX user to use on behalf
5128 A list of possible UNIX usernames to match with the given
5129 client password is constructed using the following methods :
5133 If the \fB"guest only"\fP parameter is set, then
5134 all the other stages are missed and only the \fB"guest
5135 account"\fP username is checked\&.
5138 Is a username is sent with the share connection request, then
5139 this username (after mapping - see \fB"username
5140 map"\fP), is added as a potential username\&.
5143 If the client did a previous \fI"logon"\fP request (the
5144 SessionSetup SMB call) then the username sent in this SMB
5145 will be added as a potential username\&.
5148 The name of the service the client requested is added
5149 as a potential username\&.
5152 The NetBIOS name of the client is added to the list as a
5153 potential username\&.
5156 Any users on the \fB"user"\fP list are added
5157 as potential usernames\&.
5160 If the \fB"guest only"\fP parameter is not set, then
5161 this list is then tried with the supplied password\&. The first user for
5162 whom the password matches will be used as the UNIX user\&.
5164 If the \fB"guest only"\fP parameter is set, or no
5165 username can be determined then if the share is marked as available to
5166 the \fB"guest account"\fP, then this guest user will
5167 be used, otherwise access is denied\&.
5169 Note that it can be \fI*very*\fP confusing in share-level security as to
5170 which UNIX username will eventually be used in granting access\&.
5172 See also the section \fB"NOTE ABOUT USERNAME/PASSWORD
5175 .IP "\fB"security=user"\fP"
5177 This is the default security setting in Samba2\&.0\&. With user-level
5178 security a client must first \f(CW"log-on"\fP with a valid username and
5179 password (which can be mapped using the \fB"username
5180 map"\fP parameter)\&. Encrypted passwords (see the
5181 \fB"encrypted passwords"\fP parameter) can also
5182 be used in this security mode\&. Parameters such as
5183 \fB"user"\fP and \fB"guest only"\fP, if set
5184 are then applied and may change the UNIX user to use on this
5185 connection, but only after the user has been successfully
5188 \fINote\fP that the name of the resource being requested is
5189 \fI*not*\fP sent to the server until after the server has successfully
5190 authenticated the client\&. This is why guest shares don\'t work in user
5191 level security without allowing the server to automatically map unknown
5192 users into the \fB"guest account"\fP\&. See the
5193 \fB"map to guest"\fP parameter for details on
5196 See also the section \fB"NOTE ABOUT USERNAME/PASSWORD
5199 .IP "\fB"security=server"\fP"
5201 In this mode Samba will try to validate the username/password by
5202 passing it to another SMB server, such as an NT box\&. If this fails it
5203 will revert to \fB"security = user"\fP, but note that if encrypted
5204 passwords have been negotiated then Samba cannot revert back to
5205 checking the UNIX password file, it must have a valid smbpasswd file
5206 to check users against\&. See the documentation file in the docs/
5207 directory ENCRYPTION\&.txt for details on how to set this up\&.
5209 \fINote\fP that from the clients point of view \fB"security=server"\fP is
5210 the same as \fB"security=user"\fP\&. It only
5211 affects how the server deals with the authentication, it does not in
5212 any way affect what the client sees\&.
5214 \fINote\fP that the name of the resource being requested is
5215 \fI*not*\fP sent to the server until after the server has successfully
5216 authenticated the client\&. This is why guest shares don\'t work in server
5217 level security without allowing the server to automatically map unknown
5218 users into the \fB"guest account"\fP\&. See the
5219 \fB"map to guest"\fP parameter for details on
5222 See also the section \fB"NOTE ABOUT USERNAME/PASSWORD
5225 See also the \fB"password server"\fP parameter\&.
5226 and the \fB"encrypted passwords"\fP parameter\&.
5228 .IP "\fB"security=domain"\fP"
5230 This mode will only work correctly if
5231 \fBsmbpasswd\fP has been used to add this machine
5232 into a Windows NT Domain\&. It expects the \fB"encrypted
5233 passwords"\fP parameter to be set to \f(CW"true"\fP\&. In
5234 this mode Samba will try to validate the username/password by passing
5235 it to a Windows NT Primary or Backup Domain Controller, in exactly the
5236 same way that a Windows NT Server would do\&.
5238 \fINote\fP that a valid UNIX user must still exist as well as the
5239 account on the Domain Controller to allow Samba to have a valid
5240 UNIX account to map file access to\&.
5242 \fINote\fP that from the clients point of view \fB"security=domain"\fP is
5243 the same as \fB"security=user"\fP\&. It only
5244 affects how the server deals with the authentication, it does not in
5245 any way affect what the client sees\&.
5247 \fINote\fP that the name of the resource being requested is
5248 \fI*not*\fP sent to the server until after the server has successfully
5249 authenticated the client\&. This is why guest shares don\'t work in domain
5250 level security without allowing the server to automatically map unknown
5251 users into the \fB"guest account"\fP\&. See the
5252 \fB"map to guest"\fP parameter for details on
5255 e,(BUG:) There is currently a bug in the implementation of
5256 \fB"security=domain\fP with respect to multi-byte character
5257 set usernames\&. The communication with a Domain Controller
5258 must be done in UNICODE and Samba currently does not widen
5259 multi-byte user names to UNICODE correctly, thus a multi-byte
5260 username will not be recognized correctly at the Domain Controller\&.
5261 This issue will be addressed in a future release\&.
5263 See also the section \fB"NOTE ABOUT USERNAME/PASSWORD
5266 See also the \fB"password server"\fP parameter\&.
5267 and the \fB"encrypted passwords"\fP parameter\&.
5271 \f(CW security = USER\fP
5274 \f(CW security = DOMAIN\fP
5276 .IP "\fBserver string (G)\fP"
5278 This controls what string will show up in the printer comment box in
5279 print manager and next to the IPC connection in \f(CW"net view"\fP\&. It can be
5280 any string that you wish to show to your users\&.
5282 It also sets what will appear in browse lists next to the machine
5285 A \f(CW"%v"\fP will be replaced with the Samba version number\&.
5287 A \f(CW"%h"\fP will be replaced with the hostname\&.
5290 \f(CW server string = Samba %v\fP
5293 \f(CW server string = University of GNUs Samba Server\fP
5295 .IP "\fBset directory (S)\fP"
5297 If \f(CW"set directory = no"\fP, then users of the service may not use the
5298 setdir command to change directory\&.
5300 The setdir command is only implemented in the Digital Pathworks
5301 client\&. See the Pathworks documentation for details\&.
5304 \f(CW set directory = no\fP
5307 \f(CW set directory = yes\fP
5309 .IP "\fBshare modes (S)\fP"
5311 This enables or disables the honoring of the \f(CW"share modes"\fP during a
5312 file open\&. These modes are used by clients to gain exclusive read or
5313 write access to a file\&.
5315 These open modes are not directly supported by UNIX, so they are
5316 simulated using shared memory, or lock files if your UNIX doesn\'t
5317 support shared memory (almost all do)\&.
5319 The share modes that are enabled by this option are DENY_DOS,
5320 DENY_ALL, DENY_READ, DENY_WRITE, DENY_NONE and DENY_FCB\&.
5322 This option gives full share compatibility and enabled by default\&.
5324 You should \fI*NEVER*\fP turn this parameter off as many Windows
5325 applications will break if you do so\&.
5328 \f(CW share modes = yes\fP
5330 .IP "\fBshared mem size (G)\fP"
5332 It specifies the size of the shared memory (in bytes) to use between
5333 \fBsmbd\fP processes\&. This parameter defaults to one
5334 megabyte of shared memory\&. It is possible that if you have a large
5335 server with many files open simultaneously that you may need to
5336 increase this parameter\&. Signs that this parameter is set too low are
5337 users reporting strange problems trying to save files (locking errors)
5338 and error messages in the smbd log looking like \f(CW"ERROR
5339 smb_shm_alloc : alloc of XX bytes failed"\fP\&.
5342 \f(CW shared mem size = 1048576\fP
5345 \f(CW shared mem size = 5242880 ; Set to 5mb for a large number of files\&.\fP
5347 .IP "\fBshort preserve case (G)\fP"
5349 This boolean parameter controls if new files which conform to 8\&.3
5350 syntax, that is all in upper case and of suitable length, are created
5351 upper case, or if they are forced to be the \f(CW"default"\fP case\&. This
5352 option can be use with \fB"preserve case
5353 =yes"\fP to permit long filenames to retain their
5354 case, while short names are lowered\&. Default \fIYes\fP\&.
5356 See the section on \fBNAME MANGLING\fP\&.
5359 \f(CW short preserve case = yes\fP
5361 .IP "\fBsmb passwd file (G)\fP"
5363 This option sets the path to the encrypted smbpasswd file\&. By default
5364 the path to the smbpasswd file is compiled into Samba\&.
5367 \f(CW smb passwd file= <compiled default>\fP
5370 \f(CW smb passwd file = /usr/samba/private/smbpasswd\fP
5372 .IP "\fBsmbrun (G)\fP"
5374 This sets the full path to the \fBsmbrun\fP binary\&. This defaults to the
5375 value in the Makefile\&.
5377 You must get this path right for many services to work correctly\&.
5379 You should not need to change this parameter so long as Samba
5380 is installed correctly\&.
5383 \f(CW smbrun=<compiled default>\fP
5386 \f(CW smbrun = /usr/local/samba/bin/smbrun\fP
5388 .IP "\fBsocket address (G)\fP"
5390 This option allows you to control what address Samba will listen for
5391 connections on\&. This is used to support multiple virtual interfaces on
5392 the one server, each with a different configuration\&.
5394 By default samba will accept connections on any address\&.
5397 \f(CW socket address = 192\&.168\&.2\&.20\fP
5399 .IP "\fBsocket options (G)\fP"
5401 This option allows you to set socket options to be used when talking
5404 Socket options are controls on the networking layer of the operating
5405 systems which allow the connection to be tuned\&.
5407 This option will typically be used to tune your Samba server for
5408 optimal performance for your local network\&. There is no way that Samba
5409 can know what the optimal parameters are for your net, so you must
5410 experiment and choose them yourself\&. We strongly suggest you read the
5411 appropriate documentation for your operating system first (perhaps
5412 \fB"man setsockopt"\fP will help)\&.
5414 You may find that on some systems Samba will say "Unknown socket
5415 option" when you supply an option\&. This means you either incorrectly
5416 typed it or you need to add an include file to includes\&.h for your OS\&.
5417 If the latter is the case please send the patch to
5418 \fIsamba-bugs@samba\&.org\fP\&.
5420 Any of the supported socket options may be combined in any way you
5421 like, as long as your OS allows it\&.
5423 This is the list of socket options currently settable using this
5458 Those marked with a \f(CW*\fP take an integer argument\&. The others can
5459 optionally take a 1 or 0 argument to enable or disable the option, by
5460 default they will be enabled if you don\'t specify 1 or 0\&.
5462 To specify an argument use the syntax SOME_OPTION=VALUE for example
5463 \f(CWSO_SNDBUF=8192\fP\&. Note that you must not have any spaces before or after
5466 If you are on a local network then a sensible option might be
5468 \f(CWsocket options = IPTOS_LOWDELAY\fP
5470 If you have a local network then you could try:
5472 \f(CWsocket options = IPTOS_LOWDELAY TCP_NODELAY\fP
5474 If you are on a wide area network then perhaps try setting
5477 Note that several of the options may cause your Samba server to fail
5478 completely\&. Use these options with caution!
5481 \f(CW socket options = TCP_NODELAY\fP
5484 \f(CW socket options = IPTOS_LOWDELAY\fP
5488 This variable is part of SSL-enabled Samba\&. This is only available if
5489 the SSL libraries have been compiled on your system and the configure
5490 option \f(CW"--with-ssl"\fP was given at configure time\&.
5492 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5493 enabled by default in any current binary version of Samba\&.
5495 This variable enables or disables the entire SSL mode\&. If it is set to
5496 "no", the SSL enabled samba behaves exactly like the non-SSL samba\&. If
5497 set to "yes", it depends on the variables \fB"ssl
5498 hosts"\fP and \fB"ssl hosts resign"\fP
5499 whether an SSL connection will be required\&.
5506 .IP "\fBssl CA certDir (G)\fP"
5508 This variable is part of SSL-enabled Samba\&. This is only available if
5509 the SSL libraries have been compiled on your system and the configure
5510 option \f(CW"--with-ssl"\fP was given at configure time\&.
5512 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5513 enabled by default in any current binary version of Samba\&.
5515 This variable defines where to look up the Certification
5516 Authorities\&. The given directory should contain one file for each CA
5517 that samba will trust\&. The file name must be the hash value over the
5518 "Distinguished Name" of the CA\&. How this directory is set up is
5519 explained later in this document\&. All files within the directory that
5520 don\'t fit into this naming scheme are ignored\&. You don\'t need this
5521 variable if you don\'t verify client certificates\&.
5524 \f(CW ssl CA certDir = /usr/local/ssl/certs\fP
5526 .IP "\fBssl CA certFile (G)\fP"
5528 This variable is part of SSL-enabled Samba\&. This is only available if
5529 the SSL libraries have been compiled on your system and the configure
5530 option \f(CW"--with-ssl"\fP was given at configure time\&.
5532 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5533 enabled by default in any current binary version of Samba\&.
5535 This variable is a second way to define the trusted CAs\&. The
5536 certificates of the trusted CAs are collected in one big file and this
5537 variable points to the file\&. You will probably only use one of the two
5538 ways to define your CAs\&. The first choice is preferable if you have
5539 many CAs or want to be flexible, the second is preferable if you only
5540 have one CA and want to keep things simple (you won\'t need to create
5541 the hashed file names)\&. You don\'t need this variable if you don\'t
5542 verify client certificates\&.
5545 \f(CW ssl CA certFile = /usr/local/ssl/certs/trustedCAs\&.pem\fP
5547 .IP "\fBssl ciphers (G)\fP"
5549 This variable is part of SSL-enabled Samba\&. This is only available if
5550 the SSL libraries have been compiled on your system and the configure
5551 option \f(CW"--with-ssl"\fP was given at configure time\&.
5553 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5554 enabled by default in any current binary version of Samba\&.
5556 This variable defines the ciphers that should be offered during SSL
5557 negotiation\&. You should not set this variable unless you know what you
5560 .IP "\fBssl client cert (G)\fP"
5562 This variable is part of SSL-enabled Samba\&. This is only available if
5563 the SSL libraries have been compiled on your system and the configure
5564 option \f(CW"--with-ssl"\fP was given at configure time\&.
5566 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5567 enabled by default in any current binary version of Samba\&.
5569 The certificate in this file is used by
5570 \fBsmbclient\fP if it exists\&. It\'s needed if the
5571 server requires a client certificate\&.
5574 \f(CW ssl client cert = /usr/local/ssl/certs/smbclient\&.pem\fP
5576 .IP "\fBssl client key (G)\fP"
5578 This variable is part of SSL-enabled Samba\&. This is only available if
5579 the SSL libraries have been compiled on your system and the configure
5580 option \f(CW"--with-ssl"\fP was given at configure time\&.
5582 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5583 enabled by default in any current binary version of Samba\&.
5585 This is the private key for \fBsmbclient\fP\&. It\'s
5586 only needed if the client should have a certificate\&.
5589 \f(CW ssl client key = /usr/local/ssl/private/smbclient\&.pem\fP
5591 .IP "\fBssl compatibility (G)\fP"
5593 This variable is part of SSL-enabled Samba\&. This is only available if
5594 the SSL libraries have been compiled on your system and the configure
5595 option \f(CW"--with-ssl"\fP was given at configure time\&.
5597 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5598 enabled by default in any current binary version of Samba\&.
5600 This variable defines whether SSLeay should be configured for bug
5601 compatibility with other SSL implementations\&. This is probably not
5602 desirable because currently no clients with SSL implementations other
5603 than SSLeay exist\&.
5606 \f(CW ssl compatibility = no\fP
5608 .IP "\fBssl hosts (G)\fP"
5610 See \fB"ssl hosts resign"\fP\&.
5612 .IP "\fBssl hosts resign (G)\fP"
5614 This variable is part of SSL-enabled Samba\&. This is only available if
5615 the SSL libraries have been compiled on your system and the configure
5616 option \f(CW"--with-ssl"\fP was given at configure time\&.
5618 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5619 enabled by default in any current binary version of Samba\&.
5621 These two variables define whether samba will go into SSL mode or
5622 not\&. If none of them is defined, samba will allow only SSL
5623 connections\&. If the \fB"ssl hosts"\fP variable lists
5624 hosts (by IP-address, IP-address range, net group or name), only these
5625 hosts will be forced into SSL mode\&. If the \fB"ssl hosts resign"\fP
5626 variable lists hosts, only these hosts will NOT be forced into SSL
5627 mode\&. The syntax for these two variables is the same as for the
5628 \fB"hosts allow"\fP and \fB"hosts
5629 deny"\fP pair of variables, only that the subject of the
5630 decision is different: It\'s not the access right but whether SSL is
5631 used or not\&. See the \fB"allow hosts"\fP parameter for
5632 details\&. The example below requires SSL connections from all hosts
5633 outside the local net (which is 192\&.168\&.*\&.*)\&.
5636 \f(CW ssl hosts = <empty string>\fP
5637 \f(CW ssl hosts resign = <empty string>\fP
5640 \f(CW ssl hosts resign = 192\&.168\&.\fP
5642 .IP "\fBssl require clientcert (G)\fP"
5644 This variable is part of SSL-enabled Samba\&. This is only available if
5645 the SSL libraries have been compiled on your system and the configure
5646 option \f(CW"--with-ssl"\fP was given at configure time\&.
5648 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5649 enabled by default in any current binary version of Samba\&.
5651 If this variable is set to \f(CW"yes"\fP, the server will not tolerate
5652 connections from clients that don\'t have a valid certificate\&. The
5653 directory/file given in \fB"ssl CA certDir"\fP and
5654 \fB"ssl CA certFile"\fP will be used to look up the
5655 CAs that issued the client\'s certificate\&. If the certificate can\'t be
5656 verified positively, the connection will be terminated\&. If this
5657 variable is set to \f(CW"no"\fP, clients don\'t need certificates\&. Contrary
5658 to web applications you really \fI*should*\fP require client
5659 certificates\&. In the web environment the client\'s data is sensitive
5660 (credit card numbers) and the server must prove to be trustworthy\&. In
5661 a file server environment the server\'s data will be sensitive and the
5662 clients must prove to be trustworthy\&.
5665 \f(CW ssl require clientcert = no\fP
5667 .IP "\fBssl require servercert (G)\fP"
5669 This variable is part of SSL-enabled Samba\&. This is only available if
5670 the SSL libraries have been compiled on your system and the configure
5671 option \f(CW"--with-ssl"\fP was given at configure time\&.
5673 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5674 enabled by default in any current binary version of Samba\&.
5676 If this variable is set to \f(CW"yes"\fP, the
5677 \fBsmbclient\fP will request a certificate from
5678 the server\&. Same as \fB"ssl require
5679 clientcert"\fP for the server\&.
5682 \f(CW ssl require servercert = no\fP
5684 .IP "\fBssl server cert (G)\fP"
5686 This variable is part of SSL-enabled Samba\&. This is only available if
5687 the SSL libraries have been compiled on your system and the configure
5688 option \f(CW"--with-ssl"\fP was given at configure time\&.
5690 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5691 enabled by default in any current binary version of Samba\&.
5693 This is the file containing the server\'s certificate\&. The server _must_
5694 have a certificate\&. The file may also contain the server\'s private key\&.
5695 See later for how certificates and private keys are created\&.
5698 \f(CW ssl server cert = <empty string>\fP
5700 .IP "\fBssl server key (G)\fP"
5702 This variable is part of SSL-enabled Samba\&. This is only available if
5703 the SSL libraries have been compiled on your system and the configure
5704 option \f(CW"--with-ssl"\fP was given at configure time\&.
5706 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5707 enabled by default in any current binary version of Samba\&.
5709 This file contains the private key of the server\&. If this variable is
5710 not defined, the key is looked up in the certificate file (it may be
5711 appended to the certificate)\&. The server \fI*must*\fP have a private key
5712 and the certificate \fI*must*\fP match this private key\&.
5715 \f(CW ssl server key = <empty string>\fP
5717 .IP "\fBssl version (G)\fP"
5719 This variable is part of SSL-enabled Samba\&. This is only available if
5720 the SSL libraries have been compiled on your system and the configure
5721 option \f(CW"--with-ssl"\fP was given at configure time\&.
5723 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5724 enabled by default in any current binary version of Samba\&.
5726 This enumeration variable defines the versions of the SSL protocol
5727 that will be used\&. \f(CW"ssl2or3"\fP allows dynamic negotiation of SSL v2
5728 or v3, \f(CW"ssl2"\fP results in SSL v2, \f(CW"ssl3"\fP results in SSL v3 and
5729 "tls1" results in TLS v1\&. TLS (Transport Layer Security) is the
5730 (proposed?) new standard for SSL\&.
5733 \f(CW ssl version = "ssl2or3"\fP
5735 .IP "\fBstat cache (G)\fP"
5737 This parameter determines if \fBsmbd\fP will use a
5738 cache in order to speed up case insensitive name mappings\&. You should
5739 never need to change this parameter\&.
5742 \f(CW stat cache = yes\fP
5744 .IP "\fBstat cache size (G)\fP"
5746 This parameter determines the number of entries in the \fBstat
5747 cache\fP\&. You should never need to change this parameter\&.
5750 \f(CW stat cache size = 50\fP
5752 .IP "\fBstatus (G)\fP"
5754 This enables or disables logging of connections to a status file that
5755 \fBsmbstatus\fP can read\&.
5757 With this disabled \fBsmbstatus\fP won\'t be able
5758 to tell you what connections are active\&. You should never need to
5759 change this parameter\&.
5764 .IP "\fBstrict locking (S)\fP"
5766 This is a boolean that controls the handling of file locking in the
5767 server\&. When this is set to \f(CW"yes"\fP the server will check every read and
5768 write access for file locks, and deny access if locks exist\&. This can
5769 be slow on some systems\&.
5771 When strict locking is \f(CW"no"\fP the server does file lock checks only
5772 when the client explicitly asks for them\&.
5774 Well behaved clients always ask for lock checks when it is important,
5775 so in the vast majority of cases \fB"strict locking = no"\fP is
5779 \f(CW strict locking = no\fP
5782 \f(CW strict locking = yes\fP
5784 .IP "\fBstrict sync (S)\fP"
5786 Many Windows applications (including the Windows 98 explorer shell)
5787 seem to confuse flushing buffer contents to disk with doing a sync to
5788 disk\&. Under UNIX, a sync call forces the process to be suspended until
5789 the kernel has ensured that all outstanding data in kernel disk
5790 buffers has been safely stored onto stable storage\&. This is very slow
5791 and should only be done rarely\&. Setting this parameter to "no" (the
5792 default) means that smbd ignores the Windows applications requests for
5793 a sync call\&. There is only a possibility of losing data if the
5794 operating system itself that Samba is running on crashes, so there is
5795 little danger in this default setting\&. In addition, this fixes many
5796 performance problems that people have reported with the new Windows98
5797 explorer shell file copies\&.
5799 See also the \fB"sync always"\fP parameter\&.
5802 \f(CW strict sync = no\fP
5805 \f(CW strict sync = yes\fP
5807 .IP "\fBstrip dot (G)\fP"
5809 This is a boolean that controls whether to strip trailing dots off
5810 UNIX filenames\&. This helps with some CDROMs that have filenames ending
5814 \f(CW strip dot = no\fP
5817 \f(CW strip dot = yes\fP
5819 .IP "\fBsync always (S)\fP"
5821 This is a boolean parameter that controls whether writes will always
5822 be written to stable storage before the write call returns\&. If this is
5823 false then the server will be guided by the client\'s request in each
5824 write call (clients can set a bit indicating that a particular write
5825 should be synchronous)\&. If this is true then every write will be
5826 followed by a fsync() call to ensure the data is written to disk\&.
5827 Note that the \fB"strict sync"\fP parameter must be
5828 set to \f(CW"yes"\fP in order for this parameter to have any affect\&.
5830 See also the \fB"strict sync"\fP parameter\&.
5833 \f(CW sync always = no\fP
5836 \f(CW sync always = yes\fP
5838 .IP "\fBsyslog (G)\fP"
5840 This parameter maps how Samba debug messages are logged onto the
5841 system syslog logging levels\&. Samba debug level zero maps onto syslog
5842 LOG_ERR, debug level one maps onto LOG_WARNING, debug level two maps
5843 onto LOG_NOTICE, debug level three maps onto LOG_INFO\&. All higher
5844 levels are mapped to LOG_DEBUG\&.
5846 This paramter sets the threshold for sending messages to syslog\&.
5847 Only messages with debug level less than this value will be sent
5853 .IP "\fBsyslog only (G)\fP"
5855 If this parameter is set then Samba debug messages are logged into the
5856 system syslog only, and not to the debug log files\&.
5859 \f(CW syslog only = no\fP
5861 .IP "\fBtime offset (G)\fP"
5863 This parameter is a setting in minutes to add to the normal GMT to
5864 local time conversion\&. This is useful if you are serving a lot of PCs
5865 that have incorrect daylight saving time handling\&.
5868 \f(CW time offset = 0\fP
5871 \f(CW time offset = 60\fP
5874 .IP "\fBtime server (G)\fP"
5876 This parameter determines if \fBnmbd\fP advertises
5877 itself as a time server to Windows clients\&. The default is False\&.
5880 \f(CW time server = False\fP
5883 \f(CW time server = True\fP
5885 .IP "\fBtimestamp logs (G)\fP"
5887 Samba2\&.0 will a timestamps to all log entries by default\&. This
5888 can be distracting if you are attempting to debug a problem\&. This
5889 parameter allows the timestamping to be turned off\&.
5892 \f(CW timestamp logs = True\fP
5895 \f(CW timestamp logs = False\fP
5897 .IP "\fBunix password sync (G)\fP"
5899 This boolean parameter controls whether Samba attempts to synchronize
5900 the UNIX password with the SMB password when the encrypted SMB
5901 password in the smbpasswd file is changed\&. If this is set to true the
5902 program specified in the \fB"passwd program"\fP
5903 parameter is called \fI*AS ROOT*\fP - to allow the new UNIX password to be
5904 set without access to the old UNIX password (as the SMB password has
5905 change code has no access to the old password cleartext, only the
5906 new)\&. By default this is set to \f(CW"false"\fP\&.
5908 See also \fB"passwd program"\fP, \fB"passwd
5912 \f(CW unix password sync = False\fP
5915 \f(CW unix password sync = True\fP
5917 .IP "\fBunix realname (G)\fP"
5919 This boolean parameter when set causes samba to supply the real name
5920 field from the unix password file to the client\&. This is useful for
5921 setting up mail clients and WWW browsers on systems used by more than
5925 \f(CW unix realname = no\fP
5928 \f(CW unix realname = yes\fP
5930 .IP "\fBupdate encrypted (G)\fP"
5932 This boolean parameter allows a user logging on with a plaintext
5933 password to have their encrypted (hashed) password in the smbpasswd
5934 file to be updated automatically as they log on\&. This option allows a
5935 site to migrate from plaintext password authentication (users
5936 authenticate with plaintext password over the wire, and are checked
5937 against a UNIX account database) to encrypted password authentication
5938 (the SMB challenge/response authentication mechanism) without forcing
5939 all users to re-enter their passwords via smbpasswd at the time the
5940 change is made\&. This is a convenience option to allow the change over
5941 to encrypted passwords to be made over a longer period\&. Once all users
5942 have encrypted representations of their passwords in the smbpasswd
5943 file this parameter should be set to \f(CW"off"\fP\&.
5945 In order for this parameter to work correctly the \fB"encrypt
5946 passwords"\fP parameter must be set to \f(CW"no"\fP when
5947 this parameter is set to \f(CW"yes"\fP\&.
5949 Note that even when this parameter is set a user authenticating to
5950 smbd must still enter a valid password in order to connect correctly,
5951 and to update their hashed (smbpasswd) passwords\&.
5954 \f(CW update encrypted = no\fP
5957 \f(CW update encrypted = yes\fP
5959 .IP "\fBuse rhosts (G)\fP"
5961 If this global parameter is a true, it specifies that the UNIX users
5962 \f(CW"\&.rhosts"\fP file in their home directory will be read to find the
5963 names of hosts and users who will be allowed access without specifying
5966 NOTE: The use of \fBuse rhosts\fP can be a major security hole\&. This is
5967 because you are trusting the PC to supply the correct username\&. It is
5968 very easy to get a PC to supply a false username\&. I recommend that the
5969 \fBuse rhosts\fP option be only used if you really know what you are
5973 \f(CW use rhosts = no\fP
5976 \f(CW use rhosts = yes\fP
5978 .IP "\fBuser (S)\fP"
5980 Synonym for \fB"username"\fP\&.
5982 .IP "\fBusers (S)\fP"
5984 Synonym for \fB"username"\fP\&.
5986 .IP "\fBusername (S)\fP"
5988 Multiple users may be specified in a comma-delimited list, in which
5989 case the supplied password will be tested against each username in
5990 turn (left to right)\&.
5992 The \fBusername=\fP line is needed only when the PC is unable to supply
5993 its own username\&. This is the case for the COREPLUS protocol or where
5994 your users have different WfWg usernames to UNIX usernames\&. In both
5995 these cases you may also be better using the \f(CW\e\eserver\eshare%user\fP
5998 The \fBusername=\fP line is not a great solution in many cases as it
5999 means Samba will try to validate the supplied password against each of
6000 the usernames in the username= line in turn\&. This is slow and a bad
6001 idea for lots of users in case of duplicate passwords\&. You may get
6002 timeouts or security breaches using this parameter unwisely\&.
6004 Samba relies on the underlying UNIX security\&. This parameter does not
6005 restrict who can login, it just offers hints to the Samba server as to
6006 what usernames might correspond to the supplied password\&. Users can
6007 login as whoever they please and they will be able to do no more
6008 damage than if they started a telnet session\&. The daemon runs as the
6009 user that they log in as, so they cannot do anything that user cannot
6012 To restrict a service to a particular set of users you can use the
6013 \fB"valid users="\fP parameter\&.
6015 If any of the usernames begin with a \f(CW\'@\'\fP then the name will be
6016 looked up first in the yp netgroups list (if Samba is compiled with
6017 netgroup support), followed by a lookup in the UNIX groups database
6018 and will expand to a list of all users in the group of that name\&.
6020 If any of the usernames begin with a \f(CW\'+\'\fP then the name will be
6021 looked up only in the UNIX groups database and will expand to a list
6022 of all users in the group of that name\&.
6024 If any of the usernames begin with a \f(CW\'&\'\fP then the name will be
6025 looked up only in the yp netgroups database (if Samba is compiled with
6026 netgroup support) and will expand to a list of all users in the
6027 netgroup group of that name\&.
6029 Note that searching though a groups database can take quite some time,
6030 and some clients may time out during the search\&.
6032 See the section \fB"NOTE ABOUT USERNAME/PASSWORD
6033 VALIDATION"\fP for more
6034 information on how this parameter determines access to the services\&.
6037 \f(CW The guest account if a guest service, else the name of the service\&.\fP
6045 username = fred, mary, jack, jane, @users, @pcgroup
6051 .IP "\fBusername level (G)\fP"
6053 This option helps Samba to try and \'guess\' at the real UNIX username,
6054 as many DOS clients send an all-uppercase username\&. By default Samba
6055 tries all lowercase, followed by the username with the first letter
6056 capitalized, and fails if the username is not found on the UNIX
6059 If this parameter is set to non-zero the behavior changes\&. This
6060 parameter is a number that specifies the number of uppercase
6061 combinations to try whilst trying to determine the UNIX user name\&. The
6062 higher the number the more combinations will be tried, but the slower
6063 the discovery of usernames will be\&. Use this parameter when you have
6064 strange usernames on your UNIX machine, such as \f(CW"AstrangeUser"\fP\&.
6067 \f(CW username level = 0\fP
6070 \f(CW username level = 5\fP
6072 .IP "\fBusername map (G)\fP"
6074 This option allows you to specify a file containing a mapping of
6075 usernames from the clients to the server\&. This can be used for several
6076 purposes\&. The most common is to map usernames that users use on DOS or
6077 Windows machines to those that the UNIX box uses\&. The other is to map
6078 multiple users to a single username so that they can more easily share
6081 The map file is parsed line by line\&. Each line should contain a single
6082 UNIX username on the left then a \f(CW\'=\'\fP followed by a list of
6083 usernames on the right\&. The list of usernames on the right may contain
6084 names of the form @group in which case they will match any UNIX
6085 username in that group\&. The special client name \f(CW\'*\'\fP is a wildcard
6086 and matches any name\&. Each line of the map file may be up to 1023
6089 The file is processed on each line by taking the supplied username and
6090 comparing it with each username on the right hand side of the \f(CW\'=\'\fP
6091 signs\&. If the supplied name matches any of the names on the right hand
6092 side then it is replaced with the name on the left\&. Processing then
6093 continues with the next line\&.
6095 If any line begins with a \f(CW\'#\'\fP or a \f(CW\';\'\fP then it is ignored
6097 If any line begins with an \f(CW\'!\'\fP then the processing will stop after
6098 that line if a mapping was done by the line\&. Otherwise mapping
6099 continues with every line being processed\&. Using \f(CW\'!\'\fP is most
6100 useful when you have a wildcard mapping line later in the file\&.
6102 For example to map from the name \f(CW"admin"\fP or \f(CW"administrator"\fP to
6103 the UNIX name \f(CW"root"\fP you would use:
6105 \f(CW root = admin administrator\fP
6107 Or to map anyone in the UNIX group \f(CW"system"\fP to the UNIX name
6108 \f(CW"sys"\fP you would use:
6110 \f(CW sys = @system\fP
6112 You can have as many mappings as you like in a username map file\&.
6114 If your system supports the NIS NETGROUP option then the netgroup
6115 database is checked before the \f(CW/etc/group\fP database for matching
6118 You can map Windows usernames that have spaces in them by using double
6119 quotes around the name\&. For example:
6121 \f(CW tridge = "Andrew Tridgell"\fP
6123 would map the windows username \f(CW"Andrew Tridgell"\fP to the unix
6126 The following example would map mary and fred to the unix user sys,
6127 and map the rest to guest\&. Note the use of the \f(CW\'!\'\fP to tell Samba
6128 to stop processing if it gets a match on that line\&.
6141 Note that the remapping is applied to all occurrences of
6142 usernames\&. Thus if you connect to \f(CW"\e\eserver\efred"\fP and \f(CW"fred"\fP
6143 is remapped to \f(CW"mary"\fP then you will actually be connecting to
6144 \f(CW"\e\eserver\emary"\fP and will need to supply a password suitable for
6145 \f(CW"mary"\fP not \f(CW"fred"\fP\&. The only exception to this is the username
6146 passed to the \fB"password server"\fP (if you have
6147 one)\&. The password server will receive whatever username the client
6148 supplies without modification\&.
6150 Also note that no reverse mapping is done\&. The main effect this has is
6151 with printing\&. Users who have been mapped may have trouble deleting
6152 print jobs as PrintManager under WfWg will think they don\'t own the
6156 \f(CW no username map\fP
6159 \f(CW username map = /usr/local/samba/lib/users\&.map\fP
6161 .IP "\fBvalid chars (S)\fP"
6163 The option allows you to specify additional characters that should be
6164 considered valid by the server in filenames\&. This is particularly
6165 useful for national character sets, such as adding u-umlaut or a-ring\&.
6167 The option takes a list of characters in either integer or character
6168 form with spaces between them\&. If you give two characters with a colon
6169 between them then it will be taken as an lowercase:uppercase pair\&.
6171 If you have an editor capable of entering the characters into the
6172 config file then it is probably easiest to use this method\&. Otherwise
6173 you can specify the characters in octal, decimal or hexadecimal form
6174 using the usual C notation\&.
6176 For example to add the single character \f(CW\'Z\'\fP to the charset (which
6177 is a pointless thing to do as it\'s already there) you could do one of
6186 valid chars = 0132:0172
6192 The last two examples above actually add two characters, and alter the
6193 uppercase and lowercase mappings appropriately\&.
6195 Note that you MUST specify this parameter after the \fB"client
6196 code page"\fP parameter if you have both set\&. If
6197 \fB"client code page"\fP is set after the
6198 \fB"valid chars"\fP parameter the \fB"valid chars"\fP settings will be
6201 See also the \fB"client code page"\fP parameter\&.
6208 Samba defaults to using a reasonable set of valid characters
6216 \f(CW valid chars = 0345:0305 0366:0326 0344:0304\fP
6218 The above example allows filenames to have the Swedish characters in
6221 NOTE: It is actually quite difficult to correctly produce a \fB"valid
6222 chars"\fP line for a particular system\&. To automate the process
6223 \fItino@augsburg\&.net\fP has written a package called \fB"validchars"\fP
6224 which will automatically produce a complete \fB"valid chars"\fP line for
6225 a given client system\&. Look in the examples/validchars/ subdirectory
6226 of your Samba source code distribution for this package\&.
6228 .IP "\fBvalid users (S)\fP"
6230 This is a list of users that should be allowed to login to this
6231 service\&. Names starting with \f(CW\'@\'\fP, \f(CW\'+\'\fP and \f(CW\'&\'\fP are
6232 interpreted using the same rules as described in the \fB"invalid
6233 users"\fP parameter\&.
6235 If this is empty (the default) then any user can login\&. If a username
6236 is in both this list and the \fB"invalid users"\fP
6237 list then access is denied for that user\&.
6239 The current servicename is substituted for
6240 \fB"%S"\fP\&. This is useful in the
6241 \fB[homes]\fP section\&.
6243 See also \fB"invalid users"\fP\&.
6246 \f(CW No valid users list\&. (anyone can login)\fP
6249 \f(CW valid users = greg, @pcusers\fP
6251 .IP "\fBveto files(S)\fP"
6253 This is a list of files and directories that are neither visible nor
6254 accessible\&. Each entry in the list must be separated by a \f(CW\'/\'\fP,
6255 which allows spaces to be included in the entry\&. \f(CW\'*\'\fP and \f(CW\'?\'\fP
6256 can be used to specify multiple files or directories as in DOS
6259 Each entry must be a unix path, not a DOS path and must \fI*not*\fP include the
6260 unix directory separator \f(CW\'/\'\fP\&.
6262 Note that the \fB"case sensitive"\fP option is
6263 applicable in vetoing files\&.
6265 One feature of the veto files parameter that it is important to be
6266 aware of, is that if a directory contains nothing but files that match
6267 the veto files parameter (which means that Windows/DOS clients cannot
6268 ever see them) is deleted, the veto files within that directory *are
6269 automatically deleted* along with it, if the user has UNIX permissions
6272 Setting this parameter will affect the performance of Samba, as it
6273 will be forced to check all files and directories for a match as they
6276 See also \fB"hide files"\fP and \fB"case
6280 \f(CW No files or directories are vetoed\&.\fP
6291 Veto any files containing the word Security,
6292 any ending in \&.tmp, and any directory containing the
6295 veto files = /*Security*/*\&.tmp/*root*/
6307 Veto the Apple specific files that a NetAtalk server
6310 veto files = /\&.AppleDouble/\&.bin/\&.AppleDesktop/Network Trash Folder/
6316 .IP "\fBveto oplock files (S)\fP"
6318 This parameter is only valid when the \fB"oplocks"\fP
6319 parameter is turned on for a share\&. It allows the Samba administrator
6320 to selectively turn off the granting of oplocks on selected files that
6321 match a wildcarded list, similar to the wildcarded list used in the
6322 \fB"veto files"\fP parameter\&.
6325 \f(CW No files are vetoed for oplock grants\&.\fP
6329 You might want to do this on files that you know will be heavily
6330 contended for by clients\&. A good example of this is in the NetBench
6331 SMB benchmark program, which causes heavy client contention for files
6332 ending in \f(CW"\&.SEM"\fP\&. To cause Samba not to grant oplocks on these
6333 files you would use the line (either in the \fB[global]\fP
6334 section or in the section for the particular NetBench share :
6336 \f(CW veto oplock files = /*\&.SEM/\fP
6338 .IP "\fBvolume (S)\fP"
6340 This allows you to override the volume label returned for a
6341 share\&. Useful for CDROMs with installation programs that insist on a
6342 particular volume label\&.
6344 The default is the name of the share\&.
6346 .IP "\fBwide links (S)\fP"
6348 This parameter controls whether or not links in the UNIX file system
6349 may be followed by the server\&. Links that point to areas within the
6350 directory tree exported by the server are always allowed; this
6351 parameter controls access only to areas that are outside the directory
6352 tree being exported\&.
6354 Note that setting this parameter can have a negative effect on your
6355 server performance due to the extra system calls that Samba has to
6356 do in order to perform the link checks\&.
6359 \f(CW wide links = yes\fP
6362 \f(CW wide links = no\fP
6364 .IP "\fBwins proxy (G)\fP"
6366 This is a boolean that controls if \fBnmbd\fP will
6367 respond to broadcast name queries on behalf of other hosts\&. You may
6368 need to set this to \f(CW"yes"\fP for some older clients\&.
6371 \f(CW wins proxy = no\fP
6373 .IP "\fBwins server (G)\fP"
6375 This specifies the IP address (or DNS name: IP address for preference)
6376 of the WINS server that \fBnmbd\fP should register with\&.
6377 If you have a WINS server on your network then you should set this to
6378 the WINS server\'s IP\&.
6380 You should point this at your WINS server if you have a
6381 multi-subnetted network\&.
6383 \fINOTE\fP\&. You need to set up Samba to point to a WINS server if you
6384 have multiple subnets and wish cross-subnet browsing to work correctly\&.
6386 See the documentation file BROWSING\&.txt in the docs/ directory of your
6387 Samba source distribution\&.
6390 \f(CW wins server = \fP
6393 \f(CW wins server = 192\&.9\&.200\&.1\fP
6395 .IP "\fBwins support (G)\fP"
6397 This boolean controls if the \fBnmbd\fP process in
6398 Samba will act as a WINS server\&. You should not set this to true
6399 unless you have a multi-subnetted network and you wish a particular
6400 \fBnmbd\fP to be your WINS server\&. Note that you
6401 should \fI*NEVER*\fP set this to true on more than one machine in your
6405 \f(CW wins support = no\fP
6407 .IP "\fBworkgroup (G)\fP"
6409 This controls what workgroup your server will appear to be in when
6410 queried by clients\&. Note that this parameter also controls the Domain
6411 name used with the \fB"security=domain"\fP
6415 \f(CW set at compile time to WORKGROUP\fP
6420 .IP "\fBwritable (S)\fP"
6422 Synonym for \fB"writeable"\fP for people who can\'t spell :-)\&.
6424 .IP "\fBwrite list (S)\fP"
6426 This is a list of users that are given read-write access to a
6427 service\&. If the connecting user is in this list then they will be
6428 given write access, no matter what the \fB"read only"\fP
6429 option is set to\&. The list can include group names using the @group
6432 Note that if a user is in both the read list and the write list then
6433 they will be given write access\&.
6435 See also the \fB"read list"\fP option\&.
6438 \f(CW write list = <empty string>\fP
6441 \f(CW write list = admin, root, @staff\fP
6443 .IP "\fBwrite ok (S)\fP"
6445 Synonym for \fBwriteable\fP\&.
6447 .IP "\fBwrite raw (G)\fP"
6449 This parameter controls whether or not the server will support raw
6450 writes SMB\'s when transferring data from clients\&. You should never
6451 need to change this parameter\&.
6454 \f(CW write raw = yes\fP
6456 .IP "\fBwriteable\fP"
6458 An inverted synonym is \fB"read only"\fP\&.
6460 If this parameter is \f(CW"no"\fP, then users of a service may not create
6461 or modify files in the service\'s directory\&.
6463 Note that a printable service \fB("printable = yes")\fP
6464 will \fI*ALWAYS*\fP allow writing to the directory (user privileges
6465 permitting), but only via spooling operations\&.
6468 \f(CW writeable = no\fP
6485 Although the configuration file permits service names to contain
6486 spaces, your client software may not\&. Spaces will be ignored in
6487 comparisons anyway, so it shouldn\'t be a problem - but be aware of the
6490 On a similar note, many clients - especially DOS clients - limit
6491 service names to eight characters\&. \fBSmbd\fP has no
6492 such limitation, but attempts to connect from such clients will fail
6493 if they truncate the service names\&. For this reason you should
6494 probably keep your service names down to eight characters in length\&.
6496 Use of the \fB[homes]\fP and \fB[printers]\fP
6497 special sections make life for an administrator easy, but the various
6498 combinations of default attributes can be tricky\&. Take extreme care
6499 when designing these sections\&. In particular, ensure that the
6500 permissions on spool directories are correct\&.
6504 This man page is correct for version 2\&.0 of the Samba suite\&.
6508 \fBsmbd (8)\fP, \fBsmbclient (1)\fP,
6509 \fBnmbd (8)\fP, \fBtestparm (1)\fP,
6510 \fBtestprns (1)\fP, \fBSamba\fP,
6511 \fBnmblookup (1)\fP, \fBsmbpasswd (5)\fP,
6512 \fBsmbpasswd (8)\fP\&.
6516 The original Samba software and related utilities were created by
6517 Andrew Tridgell \fIsamba-bugs@samba\&.org\fP\&. Samba is now developed
6518 by the Samba Team as an Open Source project similar to the way the
6519 Linux kernel is developed\&.
6521 The original Samba man pages were written by Karl Auer\&. The man page
6522 sources were converted to YODL format (another excellent piece of Open
6523 Source software, available at
6524 \fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP)
6525 and updated for the Samba2\&.0 release by Jeremy Allison\&.
6526 \fIsamba-bugs@samba\&.org\fP\&.
6528 See \fBsamba (7)\fP to find out how to get a full
6529 list of contributors and details on how to submit bug reports,