f7b57756ee021aa11e38810e238159bc38ab38b6
[samba.git] / docs / yodldocs / smb.conf.5.yo
1 mailto(samba-bugs@samba.org) 
2
3 manpage(smb.conf htmlcommand((5)))(5)(23 Oct 1998)(Samba)(SAMBA)
4
5 label(NAME)
6 manpagename(smb.conf)(The configuration file for the Samba suite)
7
8 label(SYNOPSIS)
9 manpagesynopsis() 
10
11 bf(smb.conf) The bf(smb.conf) file is a configuration file for the
12 Samba suite. bf(smb.conf) contains runtime configuration information
13 for the Samba programs. The bf(smb.conf) file is designed to be
14 configured and administered by the url(bf(swat (8)))(swat.8.html)
15 program. The complete description of the file format and possible
16 parameters held within are here for reference purposes.
17
18 label(FILEFORMAT)
19 manpagesection(FILE FORMAT)
20
21 The file consists of sections and parameters. A section begins with
22 the name of the section in square brackets and continues until the
23 next section begins. Sections contain parameters of the form 
24
25 tt('name = value')
26
27 The file is line-based - that is, each newline-terminated line
28 represents either a comment, a section name or a parameter.
29
30 Section and parameter names are not case sensitive.
31
32 Only the first equals sign in a parameter is significant. Whitespace
33 before or after the first equals sign is discarded. Leading, trailing
34 and internal whitespace in section and parameter names is
35 irrelevant. Leading and trailing whitespace in a parameter value is
36 discarded. Internal whitespace within a parameter value is retained
37 verbatim.
38
39 Any line beginning with a semicolon (';') or a hash ('#') character is
40 ignored, as are lines containing only whitespace.
41
42 Any line ending in a tt('\') is "continued" on the next line in the
43 customary UNIX fashion.
44
45 The values following the equals sign in parameters are all either a
46 string (no quotes needed) or a boolean, which may be given as yes/no,
47 0/1 or true/false. Case is not significant in boolean values, but is
48 preserved in string values. Some items such as create modes are
49 numeric.
50
51 label(SECTIONDESCRIPTIONS)
52 manpagesection(SECTION DESCRIPTIONS)
53
54 Each section in the configuration file (except for the
55 link(bf([global]))(global) section) describes a shared resource (known
56 as a em("share")). The section name is the name of the shared resource
57 and the parameters within the section define the shares attributes.
58
59 There are three special sections, link(bf([global]))(global),
60 link(bf([homes]))(homes) and link(bf([printers]))(printers), which are
61 described under link(bf('special sections'))(SPECIALSECTIONS). The
62 following notes apply to ordinary section descriptions.
63
64 A share consists of a directory to which access is being given plus
65 a description of the access rights which are granted to the user of
66 the service. Some housekeeping options are also specifiable.
67
68 Sections are either filespace services (used by the client as an
69 extension of their native file systems) or printable services (used by
70 the client to access print services on the host running the server).
71
72 Sections may be designated link(bf(guest))(guestok) services, in which
73 case no password is required to access them. A specified UNIX
74 link(bf(guest account))(guestaccount) is used to define access
75 privileges in this case.
76
77 Sections other than guest services will require a password to access
78 them. The client provides the username. As older clients only provide
79 passwords and not usernames, you may specify a list of usernames to
80 check against the password using the link(bf("user="))(user) option in
81 the share definition. For modern clients such as Windows 95/98 and
82 Windows NT, this should not be necessary.
83
84 Note that the access rights granted by the server are masked by the
85 access rights granted to the specified or guest UNIX user by the host
86 system. The server does not grant more access than the host system
87 grants.
88
89 The following sample section defines a file space share. The user has
90 write access to the path tt(/home/bar). The share is accessed via
91 the share name "foo":
92
93 verb(
94
95         [foo]
96                 path = /home/bar
97                 writeable = true
98
99 )
100
101 The following sample section defines a printable share. The share
102 is readonly, but printable. That is, the only write access permitted
103 is via calls to open, write to and close a spool file. The
104 link(bf('guest ok'))(guestok) parameter means access will be permitted
105 as the default guest user (specified elsewhere):
106
107 verb(
108         [aprinter]
109                 path = /usr/spool/public
110                 read only = true
111                 printable = true
112                 guest ok = true
113 )
114
115 label(SPECIALSECTIONS)
116 manpagesection(SPECIAL SECTIONS)
117
118 startdit()
119
120 label(global)
121 dit(bf(The [global] section))
122
123 Parameters in this section apply to the server as a whole, or are
124 defaults for sections which do not specifically define certain
125 items. See the notes under link(bf('PARAMETERS'))(PARAMETERS) for more
126 information.
127
128 label(homes)
129 dit(bf(The [homes] section))
130
131 If a section called tt('homes') is included in the configuration file,
132 services connecting clients to their home directories can be created
133 on the fly by the server.
134
135 When the connection request is made, the existing sections are
136 scanned. If a match is found, it is used. If no match is found, the
137 requested section name is treated as a user name and looked up in the
138 local password file. If the name exists and the correct password has
139 been given, a share is created by cloning the [homes] section.
140
141 Some modifications are then made to the newly created share:
142
143 startit()
144
145 it() The share name is changed from tt('homes') to the located
146 username
147
148 it() If no path was given, the path is set to the user's home
149 directory.
150
151 endit()
152
153 If you decide to use a link(bf(path=))(path) line in your [homes]
154 section then you may find it useful to use the link(bf(%S))(percentS)
155 macro. For example :
156
157 tt(path=/data/pchome/%S)
158
159 would be useful if you have different home directories for your PCs
160 than for UNIX access.
161
162 This is a fast and simple way to give a large number of clients access
163 to their home directories with a minimum of fuss.
164
165 A similar process occurs if the requested section name is tt("homes"),
166 except that the share name is not changed to that of the requesting
167 user. This method of using the [homes] section works well if different
168 users share a client PC.
169
170 The [homes] section can specify all the parameters a normal service
171 section can specify, though some make more sense than others. The
172 following is a typical and suitable [homes] section:
173
174 verb(
175         [homes]
176                 writeable = yes
177 )
178
179 An important point is that if guest access is specified in the [homes]
180 section, all home directories will be visible to all clients
181 bf(without a password). In the very unlikely event that this is
182 actually desirable, it would be wise to also specify link(bf(read only
183 access))(readonly).
184
185 Note that the link(bf(browseable))(browseable) flag for auto home
186 directories will be inherited from the global browseable flag, not the
187 [homes] browseable flag. This is useful as it means setting
188 browseable=no in the [homes] section will hide the [homes] share but
189 make any auto home directories visible.
190
191 label(printers)
192 dit(bf(The [printers] section))
193
194 This section works like link(bf([homes]))(homes), but for printers.
195
196 If a [printers] section occurs in the configuration file, users are
197 able to connect to any printer specified in the local host's printcap
198 file.
199
200 When a connection request is made, the existing sections are
201 scanned. If a match is found, it is used. If no match is found, but a
202 link(bf([homes]))(homes) section exists, it is used as described
203 above. Otherwise, the requested section name is treated as a printer
204 name and the appropriate printcap file is scanned to see if the
205 requested section name is a valid printer share name. If a match is
206 found, a new printer share is created by cloning the [printers]
207 section.
208
209 A few modifications are then made to the newly created share:
210
211 startit()
212
213 it() The share name is set to the located printer name
214
215 it() If no printer name was given, the printer name is set to the
216 located printer name
217
218 it() If the share does not permit guest access and no username was
219 given, the username is set to the located printer name.
220
221 endit()
222
223 Note that the [printers] service MUST be printable - if you specify
224 otherwise, the server will refuse to load the configuration file.
225
226 Typically the path specified would be that of a world-writeable spool
227 directory with the sticky bit set on it. A typical [printers] entry
228 would look like this:
229
230 verb(
231         [printers]
232                 path = /usr/spool/public
233                 writeable = no
234                 guest ok = yes
235                 printable = yes 
236 )
237
238 All aliases given for a printer in the printcap file are legitimate
239 printer names as far as the server is concerned. If your printing
240 subsystem doesn't work like that, you will have to set up a
241 pseudo-printcap. This is a file consisting of one or more lines like
242 this:
243
244 verb(        alias|alias|alias|alias...    )
245
246 Each alias should be an acceptable printer name for your printing
247 subsystem. In the link(bf([global]))(global) section, specify the new
248 file as your printcap.  The server will then only recognize names
249 found in your pseudo-printcap, which of course can contain whatever
250 aliases you like. The same technique could be used simply to limit
251 access to a subset of your local printers.
252
253 An alias, by the way, is defined as any component of the first entry
254 of a printcap record. Records are separated by newlines, components
255 (if there are more than one) are separated by vertical bar symbols
256 ("|").
257
258 NOTE: On SYSV systems which use lpstat to determine what printers are
259 defined on the system you may be able to use link(bf("printcap name =
260 lpstat"))(printcapname) to automatically obtain a list of
261 printers. See the link(bf("printcap name"))(printcapname) option for
262 more details.
263
264 enddit()
265
266 label(PARAMETERS)
267 manpagesection(PARAMETERS)
268
269 Parameters define the specific attributes of sections.
270
271 Some parameters are specific to the link(bf([global]))(global) section
272 (e.g., link(bf(security))(security)).  Some parameters are usable in
273 all sections (e.g., link(bf(create mode))(createmode)). All others are
274 permissible only in normal sections. For the purposes of the following
275 descriptions the link(bf([homes]))(homes) and
276 link(bf([printers]))(printers) sections will be considered normal.
277 The letter tt('G') in parentheses indicates that a parameter is
278 specific to the link(bf([global]))(global) section. The letter tt('S')
279 indicates that a parameter can be specified in a service specific
280 section. Note that all tt('S') parameters can also be specified in the
281 link(bf([global]))(global) section - in which case they will define
282 the default behavior for all services.
283
284 Parameters are arranged here in alphabetical order - this may not
285 create best bedfellows, but at least you can find them! Where there
286 are synonyms, the preferred synonym is described, others refer to the
287 preferred synonym.
288
289 label(VARIABLESUBSTITUTIONS)
290 manpagesection(VARIABLE SUBSTITUTIONS)
291
292 Many of the strings that are settable in the config file can take
293 substitutions. For example the option link(bf(tt("path =
294 /tmp/%u")))(path) would be interpreted as tt("path = /tmp/john") if
295 the user connected with the username john.
296
297 These substitutions are mostly noted in the descriptions below, but
298 there are some general substitutions which apply whenever they might
299 be relevant. These are:
300
301 startit()
302
303 label(percentS) 
304 it() bf(%S) = the name of the current service, if any.
305
306 label(percentP)
307 it() bf(%P) = the root directory of the current service, if any.
308
309 label(percentu)
310 it() bf(%u) = user name of the current service, if any.
311
312 label(percentg)
313 it() bf(%g) = primary group name of link(bf(%u))(percentu).
314
315 label(percentU) 
316 it() bf(%U) = session user name (the user name that
317 the client wanted, not necessarily the same as the one they got).
318
319 label(percentG)
320 it() bf(%G) = primary group name of link(bf(%U))(percentU).
321
322 label(percentH)
323 it() bf(%H) = the home directory of the user given by link(bf(%u))(percentu).
324
325 label(percentv)
326 it() bf(%v) = the Samba version.
327
328 label(percenth)
329 it() bf(%h) = the internet hostname that Samba is running on.
330
331 label(percentm)
332 it() bf(%m) = the NetBIOS name of the client machine (very useful).
333
334 label(percentL)
335 it() bf(%L) = the NetBIOS name of the server. This allows you to change your
336 config based on what the client calls you. Your server can have a "dual
337 personality".
338
339 label(percentM) 
340 it() bf(%M) = the internet name of the client machine.
341
342 label(percentN)
343 it() bf(%N) = the name of your NIS home directory server.  This is
344 obtained from your NIS auto.map entry.  If you have not compiled Samba
345 with the bf(--with-automount) option then this value will be the same
346 as link(bf(%L))(percentL).
347
348 label(percentp)
349 it() bf(%p) = the path of the service's home directory, obtained from your NIS
350 auto.map entry. The NIS auto.map entry is split up as "%N:%p".
351
352 label(percentR) 
353 it() bf(%R) = the selected protocol level after protocol
354 negotiation. It can be one of CORE, COREPLUS, LANMAN1, LANMAN2 or NT1.
355
356 label(percentd)
357 it() bf(%d) = The process id of the current server process.
358
359 label(percenta) 
360 it() bf(%a) = the architecture of the remote
361 machine. Only some are recognized, and those may not be 100%
362 reliable. It currently recognizes Samba, WfWg, WinNT and
363 Win95. Anything else will be known as "UNKNOWN". If it gets it wrong
364 then sending a level 3 log to email(samba-bugs@samba.org)
365 should allow it to be fixed.
366
367 label(percentI)
368 it() bf(%I) = The IP address of the client machine.
369
370 label(percentT)
371 it() bf(%T) = the current date and time.
372
373 endit()
374
375 There are some quite creative things that can be done with these
376 substitutions and other smb.conf options.
377
378 label(NAMEMANGLING)
379 manpagesection(NAME MANGLING)
380
381 Samba supports em("name mangling") so that DOS and Windows clients can
382 use files that don't conform to the 8.3 format. It can also be set to
383 adjust the case of 8.3 format filenames.
384
385 There are several options that control the way mangling is performed,
386 and they are grouped here rather than listed separately. For the
387 defaults look at the output of the testparm program.
388
389 All of these options can be set separately for each service (or
390 globally, of course).
391
392 The options are:
393
394 label(manglecaseoption)
395 bf("mangle case = yes/no") controls if names that have characters that
396 aren't of the "default" case are mangled. For example, if this is yes
397 then a name like tt("Mail") would be mangled. Default em(no).
398
399 label(casesensitiveoption)
400 bf("case sensitive = yes/no") controls whether filenames are case
401 sensitive. If they aren't then Samba must do a filename search and
402 match on passed names. Default em(no).
403
404 label(defaultcaseoption)
405 bf("default case = upper/lower") controls what the default case is for new
406 filenames. Default em(lower).
407
408 label(preservecaseoption)
409 bf("preserve case = yes/no") controls if new files are created with the
410 case that the client passes, or if they are forced to be the tt("default")
411 case. Default em(Yes).
412
413 label(shortpreservecaseoption)
414
415 bf("short preserve case = yes/no") controls if new files which conform
416 to 8.3 syntax, that is all in upper case and of suitable length, are
417 created upper case, or if they are forced to be the tt("default")
418 case. This option can be use with link(bf("preserve case =
419 yes"))(preservecaseoption) to permit long filenames to retain their
420 case, while short names are lowered. Default em(Yes).
421
422 By default, Samba 2.0 has the same semantics as a Windows NT
423 server, in that it is case insensitive but case preserving.
424
425 label(NOTEABOUTUSERNAMEPASSWORDVALIDATION)
426 manpagesection(NOTE ABOUT USERNAME/PASSWORD VALIDATION)
427
428 There are a number of ways in which a user can connect to a
429 service. The server follows the following steps in determining if it
430 will allow a connection to a specified service. If all the steps fail
431 then the connection request is rejected. If one of the steps pass then
432 the following steps are not checked.
433
434 If the service is marked link(bf("guest only = yes"))(guestonly) then
435 steps 1 to 5 are skipped.
436
437 starteit()
438
439 eit() Step 1: If the client has passed a username/password pair and
440 that username/password pair is validated by the UNIX system's password
441 programs then the connection is made as that username. Note that this
442 includes the tt(\\server\service%username) method of passing a
443 username.
444
445 eit() Step 2: If the client has previously registered a username with
446 the system and now supplies a correct password for that username then
447 the connection is allowed.
448
449 eit() Step 3: The client's netbios name and any previously used user
450 names are checked against the supplied password, if they match then
451 the connection is allowed as the corresponding user.
452
453 eit() Step 4: If the client has previously validated a
454 username/password pair with the server and the client has passed the
455 validation token then that username is used. This step is skipped if
456 link(bf("revalidate = yes"))(revalidate) for this service.
457
458 eit() Step 5: If a link(bf("user = "))(user) field is given in the
459 smb.conf file for the service and the client has supplied a password,
460 and that password matches (according to the UNIX system's password
461 checking) with one of the usernames from the link(bf(user=))(user)
462 field then the connection is made as the username in the
463 link(bf("user="))(user) line. If one of the username in the
464 link(bf(user=))(user) list begins with a tt('@') then that name
465 expands to a list of names in the group of the same name.
466
467 eit() Step 6: If the service is a guest service then a connection is
468 made as the username given in the link(bf("guest account
469 ="))(guestaccount) for the service, irrespective of the supplied
470 password.
471
472 endeit()
473
474 label(COMPLETELISTOFGLOBALPARAMETERS)
475 manpagesection(COMPLETE LIST OF GLOBAL PARAMETERS)
476
477 Here is a list of all global parameters. See the section of each
478 parameter for details.  Note that some are synonyms.
479
480 startit()
481
482 it() link(bf(announce as))(announceas)
483
484 it() link(bf(announce version))(announceversion)
485
486 it() link(bf(auto services))(autoservices)
487
488 it() link(bf(bind interfaces only))(bindinterfacesonly)
489
490 it() link(bf(browse list))(browselist)
491
492 it() link(bf(change notify timeout))(changenotifytimeout)
493
494 it() link(bf(character set))(characterset)
495
496 it() link(bf(client code page))(clientcodepage)
497
498 it() link(bf(coding system))(codingsystem)
499
500 it() link(bf(config file))(configfile)
501
502 it() link(bf(deadtime))(deadtime)
503
504 it() link(bf(debug timestamp))(debugtimestamp)
505
506 it() link(bf(debuglevel))(debuglevel)
507
508 it() link(bf(default))(default)
509
510 it() link(bf(default service))(defaultservice)
511
512 it() link(bf(dfree command))(dfreecommand)
513
514 it() link(bf(dns proxy))(dnsproxy)
515
516 it() link(bf(domain admin group))(domainadmingroup)
517
518 it() link(bf(domain admin users))(domainadminusers)
519
520 it() link(bf(domain controller))(domaincontroller)
521
522 it() link(bf(domain group map))(domaingroupmap)
523
524 it() link(bf(domain groups))(domaingroups)
525
526 it() link(bf(domain guest group))(domainguestgroup)
527
528 it() link(bf(domain guest users))(domainguestusers)
529
530 it() link(bf(domain logons))(domainlogons)
531
532 it() link(bf(domain master))(domainmaster)
533
534 it() link(bf(domain user map))(domainusermap)
535
536 it() link(bf(encrypt passwords))(encryptpasswords)
537
538 it() link(bf(getwd cache))(getwdcache)
539
540 it() link(bf(homedir map))(homedirmap)
541
542 it() link(bf(hosts equiv))(hostsequiv)
543
544 it() link(bf(interfaces))(interfaces)
545
546 it() link(bf(keepalive))(keepalive)
547
548 it() link(bf(kernel oplocks))(kerneloplocks)
549
550 it() link(bf(ldap filter))(ldapfilter)
551
552 it() link(bf(ldap port))(ldapport)
553
554 it() link(bf(ldap root))(ldaproot)
555
556 it() link(bf(ldap root passwd))(ldaprootpasswd)
557
558 it() link(bf(ldap server))(ldapserver)
559
560 it() link(bf(ldap suffix))(ldapsuffix)
561
562 it() link(bf(lm announce))(lmannounce)
563
564 it() link(bf(lm interval))(lminterval)
565
566 it() link(bf(load printers))(loadprinters)
567
568 it() link(bf(local group map))(localgroupmap)
569
570 it() link(bf(local master))(localmaster)
571
572 it() link(bf(lock dir))(lockdir)
573
574 it() link(bf(lock directory))(lockdirectory)
575
576 it() link(bf(log file))(logfile)
577
578 it() link(bf(log level))(loglevel)
579
580 it() link(bf(logon drive))(logondrive)
581
582 it() link(bf(logon home))(logonhome)
583
584 it() link(bf(logon path))(logonpath)
585
586 it() link(bf(logon script))(logonscript)
587
588 it() link(bf(lpq cache time))(lpqcachetime)
589
590 it() link(bf(machine password timeout))(machinepasswordtimeout)
591
592 it() link(bf(mangled stack))(mangledstack)
593
594 it() link(bf(max disk size))(maxdisksize)
595
596 it() link(bf(max log size))(maxlogsize)
597
598 it() link(bf(max mux))(maxmux)
599
600 it() link(bf(max open files))(maxopenfiles)
601
602 it() link(bf(max packet))(maxpacket)
603
604 it() link(bf(max ttl))(maxttl)
605
606 it() link(bf(max wins ttl))(maxwinsttl)
607
608 it() link(bf(max xmit))(maxxmit)
609
610 it() link(bf(message command))(messagecommand)
611
612 it() link(bf(min wins ttl))(minwinsttl)
613
614 it() link(bf(name resolve order))(nameresolveorder)
615
616 it() link(bf(netbios aliases))(netbiosaliases)
617
618 it() link(bf(netbios name))(netbiosname)
619
620 it() link(bf(nis homedir))(nishomedir)
621
622 it() link(bf(nt pipe support))(ntpipesupport)
623
624 it() link(bf(nt smb support))(ntsmbsupport)
625
626 it() link(bf(null passwords))(nullpasswords)
627
628 it() link(bf(ole locking compatibility))(olelockingcompatibility)
629
630 it() link(bf(os level))(oslevel)
631
632 it() link(bf(packet size))(packetsize)
633
634 it() link(bf(panic action))(panicaction)
635
636 it() link(bf(passwd chat))(passwdchat)
637
638 it() link(bf(passwd chat debug))(passwdchatdebug)
639
640 it() link(bf(passwd program))(passwdprogram)
641
642 it() link(bf(password level))(passwordlevel)
643
644 it() link(bf(password server))(passwordserver)
645
646 it() link(bf(prefered master))(preferedmaster)
647
648 it() link(bf(preferred master))(preferredmaster)
649
650 it() link(bf(preload))(preload)
651
652 it() link(bf(printcap))(printcap)
653
654 it() link(bf(printcap name))(printcapname)
655
656 it() link(bf(printer driver file))(printerdriverfile)
657
658 it() link(bf(protocol))(protocol)
659
660 it() link(bf(read bmpx))(readbmpx)
661
662 it() link(bf(read prediction))(readprediction)
663
664 it() link(bf(read raw))(readraw)
665
666 it() link(bf(read size))(readsize)
667
668 it() link(bf(remote announce))(remoteannounce)
669
670 it() link(bf(remote browse sync))(remotebrowsesync)
671
672 it() link(bf(root))(root)
673
674 it() link(bf(root dir))(rootdir)
675
676 it() link(bf(root directory))(rootdirectory)
677
678 it() link(bf(security))(security)
679
680 it() link(bf(server string))(serverstring)
681
682 it() link(bf(shared mem size))(sharedmemsize)
683
684 it() link(bf(smb passwd file))(smbpasswdfile)
685
686 it() link(bf(smbrun))(smbrun)
687
688 it() link(bf(socket address))(socketaddress)
689
690 it() link(bf(socket options))(socketoptions)
691
692 it() link(bf(ssl))(ssl)
693
694 it() link(bf(ssl CA certDir))(sslCAcertDir)
695
696 it() link(bf(ssl CA certFile))(sslCAcertFile)
697
698 it() link(bf(ssl ciphers))(sslciphers)
699
700 it() link(bf(ssl client cert))(sslclientcert)
701
702 it() link(bf(ssl client key))(sslclientkey)
703
704 it() link(bf(ssl compatibility))(sslcompatibility)
705
706 it() link(bf(ssl hosts))(sslhosts)
707
708 it() link(bf(ssl hosts resign))(sslhostsresign)
709
710 it() link(bf(ssl require clientcert))(sslrequireclientcert)
711
712 it() link(bf(ssl require servercert))(sslrequireservercert)
713
714 it() link(bf(ssl server cert))(sslservercert)
715
716 it() link(bf(ssl server key))(sslserverkey)
717
718 it() link(bf(ssl version))(sslversion)
719
720 it() link(bf(stat cache))(statcache)
721
722 it() link(bf(stat cache size))(statcachesize)
723
724 it() link(bf(strip dot))(stripdot)
725
726 it() link(bf(syslog))(syslog)
727
728 it() link(bf(syslog only))(syslogonly)
729
730 it() link(bf(time offset))(timeoffset)
731
732 it() link(bf(time server))(timeserver)
733
734 it() link(bf(timestamp logs))(timestamplogs)
735
736 it() link(bf(unix password sync))(unixpasswordsync)
737
738 it() link(bf(unix realname))(unixrealname)
739
740 it() link(bf(update encrypted))(updateencrypted)
741
742 it() link(bf(use rhosts))(userhosts)
743
744 it() link(bf(username level))(usernamelevel)
745
746 it() link(bf(username map))(usernamemap)
747
748 it() link(bf(valid chars))(validchars)
749
750 it() link(bf(wins proxy))(winsproxy)
751
752 it() link(bf(wins server))(winsserver)
753
754 it() link(bf(wins support))(winssupport)
755
756 it() link(bf(workgroup))(workgroup)
757
758 it() link(bf(write raw))(writeraw)
759
760 endit()
761
762 label(COMPLETELISTOFSERVICEPARAMETERS)
763 manpagesection(COMPLETE LIST OF SERVICE PARAMETERS)
764
765 Here is a list of all service parameters. See the section of each
766 parameter for details. Note that some are synonyms.
767
768 startit()
769
770 it() link(bf(admin users))(adminusers)
771
772 it() link(bf(allow hosts))(allowhosts)
773
774 it() link(bf(alternate permissions))(alternatepermissions)
775
776 it() link(bf(available))(available)
777
778 it() link(bf(blocking locks))(blockinglocks)
779
780 it() link(bf(browsable))(browsable)
781
782 it() link(bf(browseable))(browseable)
783
784 it() link(bf(case sensitive))(casesensitive)
785
786 it() link(bf(casesignames))(casesignames)
787
788 it() link(bf(comment))(comment)
789
790 it() link(bf(copy))(copy)
791
792 it() link(bf(create mask))(createmask)
793
794 it() link(bf(create mode))(createmode)
795
796 it() link(bf(default case))(defaultcase)
797
798 it() link(bf(delete readonly))(deletereadonly)
799
800 it() link(bf(delete veto files))(deletevetofiles)
801
802 it() link(bf(deny hosts))(denyhosts)
803
804 it() link(bf(directory))(directory)
805
806 it() link(bf(directory mask))(directorymask)
807
808 it() link(bf(directory mode))(directorymode)
809
810 it() link(bf(dont descend))(dontdescend)
811
812 it() link(bf(dos filetime resolution))(dosfiletimeresolution)
813
814 it() link(bf(dos filetimes))(dosfiletimes)
815
816 it() link(bf(exec))(exec)
817
818 it() link(bf(fake directory create times))(fakedirectorycreatetimes)
819
820 it() link(bf(fake oplocks))(fakeoplocks)
821
822 it() link(bf(follow symlinks))(followsymlinks)
823
824 it() link(bf(force create mode))(forcecreatemode)
825
826 it() link(bf(force directory mode))(forcedirectorymode)
827
828 it() link(bf(force group))(forcegroup)
829
830 it() link(bf(force user))(forceuser)
831
832 it() link(bf(fstype))(fstype)
833
834 it() link(bf(group))(group)
835
836 it() link(bf(guest account))(guestaccount)
837
838 it() link(bf(guest ok))(guestok)
839
840 it() link(bf(guest only))(guestonly)
841
842 it() link(bf(hide dot files))(hidedotfiles)
843
844 it() link(bf(hide files))(hidefiles)
845
846 it() link(bf(hosts allow))(hostsallow)
847
848 it() link(bf(hosts deny))(hostsdeny)
849
850 it() link(bf(include))(include)
851
852 it() link(bf(invalid users))(invalidusers)
853
854 it() link(bf(locking))(locking)
855
856 it() link(bf(lppause command))(lppausecommand)
857
858 it() link(bf(lpq command))(lpqcommand)
859
860 it() link(bf(lpresume command))(lpresumecommand)
861
862 it() link(bf(lprm command))(lprmcommand)
863
864 it() link(bf(magic output))(magicoutput)
865
866 it() link(bf(magic script))(magicscript)
867
868 it() link(bf(mangle case))(manglecase)
869
870 it() link(bf(mangled map))(mangledmap)
871
872 it() link(bf(mangled names))(manglednames)
873
874 it() link(bf(mangling char))(manglingchar)
875
876 it() link(bf(map archive))(maparchive)
877
878 it() link(bf(map hidden))(maphidden)
879
880 it() link(bf(map system))(mapsystem)
881
882 it() link(bf(map to guest))(maptoguest)
883
884 it() link(bf(max connections))(maxconnections)
885
886 it() link(bf(min print space))(minprintspace)
887
888 it() link(bf(only guest))(onlyguest)
889
890 it() link(bf(only user))(onlyuser)
891
892 it() link(bf(oplocks))(oplocks)
893
894 it() link(bf(path))(path)
895
896 it() link(bf(postexec))(postexec)
897
898 it() link(bf(postscript))(postscript)
899
900 it() link(bf(preexec))(preexec)
901
902 it() link(bf(preserve case))(preservecase)
903
904 it() link(bf(print command))(printcommand)
905
906 it() link(bf(print ok))(printok)
907
908 it() link(bf(printable))(printable)
909
910 it() link(bf(printer))(printer)
911
912 it() link(bf(printer driver))(printerdriver)
913
914 it() link(bf(printer driver location))(printerdriverlocation)
915
916 it() link(bf(printer name))(printername)
917
918 it() link(bf(printing))(printing)
919
920 it() link(bf(public))(public)
921
922 it() link(bf(queuepause command))(queuepausecommand)
923
924 it() link(bf(queueresume command))(queueresumecommand)
925
926 it() link(bf(read list))(readlist)
927
928 it() link(bf(read only))(readonly)
929
930 it() link(bf(revalidate))(revalidate)
931
932 it() link(bf(root postexec))(rootpostexec)
933
934 it() link(bf(root preexec))(rootpreexec)
935
936 it() link(bf(set directory))(setdirectory)
937
938 it() link(bf(share modes))(sharemodes)
939
940 it() link(bf(short preserve case))(shortpreservecase)
941
942 it() link(bf(status))(status)
943
944 it() link(bf(strict locking))(strictlocking)
945
946 it() link(bf(strict sync))(strictsync)
947
948 it() link(bf(sync always))(syncalways)
949
950 it() link(bf(user))(user)
951
952 it() link(bf(username))(username)
953
954 it() link(bf(users))(users)
955
956 it() link(bf(valid users))(validusers)
957
958 it() link(bf(veto files))(vetofiles)
959
960 it() link(bf(veto oplock files))(vetooplockfiles)
961
962 it() link(bf(volume))(volume)
963
964 it() link(bf(wide links))(widelinks)
965
966 it() link(bf(writable))(writable)
967
968 it() link(bf(write list))(writelist)
969
970 it() link(bf(write ok))(writeok)
971
972 it() link(bf(writeable))(writeable)
973
974 endit()
975
976 label(EXPLANATIONOFEACHPARAMETER)
977 manpagesection(EXPLANATION OF EACH PARAMETER)
978
979 startdit()
980
981 label(adminusers)
982 dit(bf(admin users (S)))
983
984 This is a list of users who will be granted administrative privileges
985 on the share. This means that they will do all file operations as the
986 super-user (root).
987
988 You should use this option very carefully, as any user in this list
989 will be able to do anything they like on the share, irrespective of
990 file permissions.
991
992   bf(Default:) nl()
993 tt(     no admin users)
994
995   bf(Example:) nl()
996 tt(     admin users = jason)
997
998 label(allow hosts)
999 dit(bf(allow hosts (S)))
1000
1001 A synonym for this parameter is link(bf('hosts allow'))(hostsallow)
1002
1003 This parameter is a comma, space, or tab delimited set of hosts which
1004 are permitted to access a service.
1005
1006 If specified in the link(bf([global]))(global) section then it will
1007 apply to all services, regardless of whether the individual service
1008 has a different setting.
1009
1010 You can specify the hosts by name or IP number. For example, you could
1011 restrict access to only the hosts on a Class C subnet with something
1012 like tt("allow hosts = 150.203.5."). The full syntax of the list is
1013 described in the man page bf(hosts_access (5)). Note that this man
1014 page may not be present on your system, so a brief description will
1015 be given here also.
1016
1017 em(NOTE:) IF you wish to allow the url(bf(smbpasswd
1018 (8)))(smbpasswd.html.8) program to be run by local users to change
1019 their Samba passwords using the local url(bf(smbd (8)))(smbd.8.html)
1020 daemon, then you em(MUST) ensure that the localhost is listed in your
1021 bf(allow hosts) list, as url(bf(smbpasswd (8)))(smbpasswd.html.8) runs
1022 in client-server mode and is seen by the local
1023 url(bf(smbd))(smbd.8.html) process as just another client.
1024
1025 You can also specify hosts by network/netmask pairs and by netgroup
1026 names if your system supports netgroups. The em(EXCEPT) keyword can also
1027 be used to limit a wildcard list. The following examples may provide
1028 some help:
1029
1030 bf(Example 1): allow localhost and all IPs in 150.203.*.* except one
1031
1032 tt(     hosts allow = localhost, 150.203. EXCEPT 150.203.6.66)
1033
1034 bf(Example 2): allow localhost and hosts that match the given network/netmask
1035
1036 tt(     hosts allow = localhost, 150.203.15.0/255.255.255.0)
1037
1038 bf(Example 3): allow a localhost plus a couple of hosts
1039
1040 tt(     hosts allow = localhost, lapland, arvidsjaur)
1041
1042 bf(Example 4): allow only hosts in NIS netgroup "foonet" or localhost, but 
1043 deny access from one particular host
1044
1045 tt(     hosts allow = @foonet, localhost)
1046 tt(     hosts deny = pirate)
1047
1048 Note that access still requires suitable user-level passwords.
1049
1050 See url(bf(testparm (1)))(testparm.1.html) for a way of testing your
1051 host access to see if it does what you expect.
1052
1053   bf(Default:)
1054 tt(     none (i.e., all hosts permitted access))
1055
1056   bf(Example:)
1057 tt(     allow hosts = 150.203.5. localhost myhost.mynet.edu.au)
1058
1059 label(alternatepermissions)
1060 dit(bf(alternate permissions (S)))
1061
1062 This is a deprecated parameter. It no longer has any effect in Samba2.0.
1063 In previous versions of Samba it affected the way the DOS "read only"
1064 attribute was mapped for a file. In Samba2.0 a file is marked "read only"
1065 if the UNIX file does not have the 'w' bit set for the owner of the file,
1066 regardless if the owner of the file is the currently logged on user or not.
1067
1068 label(announceas)
1069 dit(bf(announce as (G)))
1070
1071 This specifies what type of server url(bf(nmbd))(nmbd.8.html) will
1072 announce itself as, to a network neighborhood browse list. By default
1073 this is set to Windows NT. The valid options are : "NT", "Win95" or
1074 "WfW" meaning Windows NT, Windows 95 and Windows for Workgroups
1075 respectively. Do not change this parameter unless you have a specific
1076 need to stop Samba appearing as an NT server as this may prevent Samba
1077 servers from participating as browser servers correctly.
1078
1079   bf(Default:)
1080 tt(     announce as = NT)
1081
1082   bf(Example)
1083 tt(     announce as = Win95)
1084
1085 label(announceversion)
1086 dit(bf(announce version (G)))
1087
1088 This specifies the major and minor version numbers that nmbd will use
1089 when announcing itself as a server. The default is 4.2.  Do not change
1090 this parameter unless you have a specific need to set a Samba server
1091 to be a downlevel server.
1092
1093   bf(Default:)
1094 tt(     announce version = 4.2)
1095
1096   bf(Example:)
1097 tt(     announce version = 2.0)
1098
1099
1100 label(autoservices)
1101 dit(bf(auto services (G)))
1102
1103 This is a list of services that you want to be automatically added to
1104 the browse lists. This is most useful for homes and printers services
1105 that would otherwise not be visible.
1106
1107 Note that if you just want all printers in your printcap file loaded
1108 then the link(bf("load printers"))(loadprinters) option is easier.
1109
1110   bf(Default:)
1111 tt(     no auto services)
1112
1113   bf(Example:)
1114 tt(     auto services = fred lp colorlp)
1115
1116 label(available)
1117 dit(bf(available (S)))
1118
1119 This parameter lets you em('turn off') a service. If tt('available = no'),
1120 then em(ALL) attempts to connect to the service will fail. Such failures
1121 are logged.
1122
1123   bf(Default:)
1124 tt(     available = yes)
1125
1126   bf(Example:)
1127 tt(     available = no)
1128
1129 label(bindinterfacesonly)
1130 dit(bf(bind interfaces only (G)))
1131
1132 This global parameter allows the Samba admin to limit what interfaces
1133 on a machine will serve smb requests. If affects file service
1134 url(bf(smbd))(smbd.8.html) and name service url(bf(nmbd))(nmbd.8.html)
1135 in slightly different ways.
1136
1137 For name service it causes url(bf(nmbd))(nmbd.8.html) to bind to ports
1138 137 and 138 on the interfaces listed in the
1139 link(bf('interfaces'))(interfaces)
1140 parameter. url(bf(nmbd))(nmbd.8.html) also binds to the 'all
1141 addresses' interface (0.0.0.0) on ports 137 and 138 for the purposes
1142 of reading broadcast messages. If this option is not set then
1143 url(bf(nmbd))(nmbd.8.html) will service name requests on all of these
1144 sockets. If bf("bind interfaces only") is set then
1145 url(bf(nmbd))(nmbd.8.html) will check the source address of any
1146 packets coming in on the broadcast sockets and discard any that don't
1147 match the broadcast addresses of the interfaces in the
1148 link(bf('interfaces'))(interfaces) parameter list. As unicast packets
1149 are received on the other sockets it allows url(bf(nmbd))(nmbd.8.html)
1150 to refuse to serve names to machines that send packets that arrive
1151 through any interfaces not listed in the
1152 link(bf("interfaces"))(interfaces) list.  IP Source address spoofing
1153 does defeat this simple check, however so it must not be used
1154 seriously as a security feature for url(bf(nmbd))(nmbd.8.html).
1155
1156 For file service it causes url(bf(smbd))(smbd.8.html) to bind only to
1157 the interface list given in the link(bf('interfaces'))(interfaces)
1158 parameter. This restricts the networks that url(bf(smbd))(smbd.8.html)
1159 will serve to packets coming in those interfaces.  Note that you
1160 should not use this parameter for machines that are serving PPP or
1161 other intermittent or non-broadcast network interfaces as it will not
1162 cope with non-permanent interfaces.
1163
1164 In addition, to change a users SMB password, the
1165 url(bf(smbpasswd))(smbpasswd.8.html) by default connects to the
1166 em("localhost" - 127.0.0.1) address as an SMB client to issue the
1167 password change request. If bf("bind interfaces only") is set then
1168 unless the network address em(127.0.0.1) is added to the
1169 link(bf('interfaces'))(interfaces) parameter list then
1170 url(bf(smbpasswd))(smbpasswd.8.html) will fail to connect in it's
1171 default mode. url(bf(smbpasswd))(smbpasswd.8.html) can be forced to
1172 use the primary IP interface of the local host by using its
1173 url(bf("-r remote machine"))(smbpasswd.8.html#minusr) parameter, with
1174 bf("remote machine") set to the IP name of the primary interface
1175 of the local host.
1176
1177   bf(Default:)
1178 tt(     bind interfaces only = False)
1179
1180   bf(Example:)
1181 tt(     bind interfaces only = True)
1182
1183 label(blockinglocks)
1184 dit(bf(blocking locks (S)))
1185
1186 This parameter controls the behavior of url(bf(smbd))(smbd.8.html) when
1187 given a request by a client to obtain a byte range lock on a region
1188 of an open file, and the request has a time limit associated with it.
1189
1190 If this parameter is set and the lock range requested cannot be
1191 immediately satisfied, Samba 2.0 will internally queue the lock 
1192 request, and periodically attempt to obtain the lock until the
1193 timeout period expires.
1194
1195 If this parameter is set to "False", then Samba 2.0 will behave
1196 as previous versions of Samba would and will fail the lock
1197 request immediately if the lock range cannot be obtained.
1198
1199 This parameter can be set per share.
1200
1201   bf(Default:)
1202 tt(     blocking locks = True)
1203
1204   bf(Example:)
1205 tt(     blocking locks = False)
1206
1207 label(browsable)
1208 dit(bf(browsable (S)))
1209
1210 Synonym for link(bf(browseable))(browseable).
1211
1212 label(browselist)
1213 dit(bf(browse list(G)))
1214
1215 This controls whether url(bf(smbd))(smbd.8.html) will serve a browse
1216 list to a client doing a NetServerEnum call. Normally set to true. You
1217 should never need to change this.
1218
1219   bf(Default:)
1220 tt(     browse list = Yes)
1221
1222 label(browseable)
1223 dit(bf(browseable))
1224
1225 This controls whether this share is seen in the list of available
1226 shares in a net view and in the browse list.
1227
1228   bf(Default:)
1229 tt(     browseable = Yes)
1230
1231   bf(Example:)
1232 tt(     browseable = No)
1233
1234 label(casesensitive)
1235 dit(bf(case sensitive (G)))
1236
1237 See the discussion in the section link(bf(NAME MANGLING))(NAMEMANGLING).
1238
1239 label(casesignames)
1240 dit(bf(casesignames (G)))
1241
1242 Synonym for link(bf("case sensitive"))(casesensitive).
1243
1244 label(changenotifytimeout)
1245 dit(bf(change notify timeout (G)))
1246
1247 One of the new NT SMB requests that Samba 2.0 supports is the
1248 "ChangeNotify" requests. This SMB allows a client to tell a server to
1249 em("watch") a particular directory for any changes and only reply to
1250 the SMB request when a change has occurred. Such constant scanning of
1251 a directory is expensive under UNIX, hence an
1252 url(bf(smbd))(smbd.8.html) daemon only performs such a scan on each
1253 requested directory once every bf(change notify timeout) seconds.
1254
1255 bf(change notify timeout) is specified in units of seconds.
1256
1257   bf(Default:)
1258 tt(     change notify timeout = 60)
1259
1260   bf(Example:)
1261 tt(     change notify timeout = 300)
1262
1263 Would change the scan time to every 5 minutes.
1264
1265 label(characterset)
1266 dit(bf(character set (G)))
1267
1268 This allows a smbd to map incoming filenames from a DOS Code page (see
1269 the link(bf(client code page))(clientcodepage) parameter) to several
1270 built in UNIX character sets. The built in code page translations are:
1271
1272 startit()
1273
1274 it() bf(ISO8859-1) Western European UNIX character set. The parameter
1275 link(bf(client code page))(clientcodepage) em(MUST) be set to code
1276 page 850 if the bf(character set) parameter is set to iso8859-1
1277 in order for the conversion to the UNIX character set to be done
1278 correctly.
1279
1280 it() bf(ISO8859-2) Eastern European UNIX character set. The parameter
1281 link(bf(client code page))(clientcodepage) em(MUST) be set to code
1282 page 852 if the bf(character set) parameter is set to ISO8859-2
1283 in order for the conversion to the UNIX character set to be done
1284 correctly. 
1285
1286 it() bf(ISO8859-5) Russian Cyrillic UNIX character set. The parameter
1287 link(bf(client code page))(clientcodepage) em(MUST) be set to code
1288 page 866 if the bf(character set) parameter is set to ISO8859-2
1289 in order for the conversion to the UNIX character set to be done
1290 correctly. 
1291
1292 it() bf(KOI8-R) Alternate mapping for Russian Cyrillic UNIX
1293 character set. The parameter link(bf(client code
1294 page))(clientcodepage) em(MUST) be set to code page 866 if the
1295 bf(character set) parameter is set to KOI8-R in order for the
1296 conversion to the UNIX character set to be done correctly.
1297
1298 endit()
1299
1300 em(BUG). These MSDOS code page to UNIX character set mappings should
1301 be dynamic, like the loading of MS DOS code pages, not static.
1302
1303 See also link(bf(client code page))(clientcodepage).  Normally this
1304 parameter is not set, meaning no filename translation is done.
1305
1306   bf(Default:)
1307 tt(     character set = <empty string>)
1308
1309   bf(Example:)
1310 tt(     character set = ISO8859-1)
1311
1312 label(clientcodepage)
1313 dit(bf(client code page (G)))
1314
1315 This parameter specifies the DOS code page that the clients accessing
1316 Samba are using. To determine what code page a Windows or DOS client
1317 is using, open a DOS command prompt and type the command "chcp". This
1318 will output the code page. The default for USA MS-DOS, Windows 95, and
1319 Windows NT releases is code page 437. The default for western european
1320 releases of the above operating systems is code page 850.
1321
1322 This parameter tells url(bf(smbd))(smbd.8.html) which of the
1323 tt(codepage.XXX) files to dynamically load on startup. These files,
1324 described more fully in the manual page url(bf(make_smbcodepage
1325 (1)))(make_smbcodepage.1.html), tell url(bf(smbd))(smbd.8.html) how
1326 to map lower to upper case characters to provide the case insensitivity
1327 of filenames that Windows clients expect.
1328
1329 Samba currently ships with the following code page files :
1330
1331 startit()
1332
1333 it() bf(Code Page 437 - MS-DOS Latin US)
1334
1335 it() bf(Code Page 737 - Windows '95 Greek)
1336
1337 it() bf(Code Page 850 - MS-DOS Latin 1)
1338
1339 it() bf(Code Page 852 - MS-DOS Latin 2)
1340
1341 it() bf(Code Page 861 - MS-DOS Icelandic)
1342
1343 it() bf(Code Page 866 - MS-DOS Cyrillic)
1344
1345 it() bf(Code Page 932 - MS-DOS Japanese SJIS)
1346
1347 it() bf(Code Page 936 - MS-DOS Simplified Chinese)
1348
1349 it() bf(Code Page 949 - MS-DOS Korean Hangul)
1350
1351 it() bf(Code Page 950 - MS-DOS Traditional Chinese)
1352
1353 endit()
1354
1355 Thus this parameter may have any of the values 437, 737, 850, 852,
1356 861, 932, 936, 949, or 950.  If you don't find the codepage you need,
1357 read the comments in one of the other codepage files and the
1358 url(bf(make_smbcodepage (1)))(make_smbcodepage.1.html) man page and
1359 write one. Please remember to donate it back to the Samba user
1360 community.
1361
1362 This parameter co-operates with the link(bf("valid
1363 chars"))(validchars) parameter in determining what characters are
1364 valid in filenames and how capitalization is done. If you set both
1365 this parameter and the link(bf("valid chars"))(validchars) parameter
1366 the bf("client code page") parameter em(MUST) be set before the
1367 link(bf("valid chars"))(validchars) parameter in the bf(smb.conf)
1368 file. The link(bf("valid chars"))(validchars) string will then augment
1369 the character settings in the "client code page" parameter.
1370
1371 If not set, bf("client code page") defaults to 850.
1372
1373 See also : link(bf("valid chars"))(validchars)
1374
1375   bf(Default:)
1376 tt(     client code page = 850)
1377
1378   bf(Example:)
1379 tt(     client code page = 936)
1380
1381 label(codingsystem)
1382 dit(bf(codingsystem (G)))
1383
1384 This parameter is used to determine how incoming Shift-JIS Japanese
1385 characters are mapped from the incoming link(bf("client code
1386 page"))(clientcodepage) used by the client, into file names in the
1387 UNIX filesystem. Only useful if link(bf("client code
1388 page"))(clientcodepage) is set to 932 (Japanese Shift-JIS).
1389
1390 The options are :
1391
1392 startit()
1393
1394 it() bf(SJIS)  Shift-JIS. Does no conversion of the incoming filename.
1395
1396 it() bf(JIS8, J8BB, J8BH, J8@B, J8@J, J8@H ) Convert from incoming
1397 Shift-JIS to eight bit JIS code with different shift-in, shift out
1398 codes.
1399
1400 it() bf(JIS7, J7BB, J7BH, J7@B, J7@J, J7@H ) Convert from incoming
1401 Shift-JIS to seven bit JIS code with different shift-in, shift out
1402 codes.
1403
1404 it() bf(JUNET, JUBB, JUBH, JU@B, JU@J, JU@H ) Convert from incoming
1405 Shift-JIS to JUNET code with different shift-in, shift out codes.
1406
1407 it() bf(EUC)  Convert an incoming Shift-JIS character to EUC code.
1408
1409 it() bf(HEX) Convert an incoming Shift-JIS character to a 3 byte hex
1410 representation, i.e. tt(:AB).
1411
1412 it() bf(CAP) Convert an incoming Shift-JIS character to the 3 byte hex
1413 representation used by the Columbia AppleTalk Program (CAP),
1414 i.e. tt(:AB).  This is used for compatibility between Samba and CAP.
1415
1416 endit()
1417
1418 label(comment)
1419 dit(bf(comment (S)))
1420
1421 This is a text field that is seen next to a share when a client does a
1422 queries the server, either via the network neighborhood or via "net
1423 view" to list what shares are available.
1424
1425 If you want to set the string that is displayed next to the machine
1426 name then see the server string command.
1427
1428   bf(Default:)
1429 tt(     No comment string)
1430
1431   bf(Example:)
1432 tt(     comment = Fred's Files)
1433
1434 label(configfile)
1435 dit(bf(config file (G)))
1436
1437 This allows you to override the config file to use, instead of the
1438 default (usually bf(smb.conf)). There is a chicken and egg problem
1439 here as this option is set in the config file!
1440
1441 For this reason, if the name of the config file has changed when the
1442 parameters are loaded then it will reload them from the new config
1443 file.
1444
1445 This option takes the usual substitutions, which can be very useful.
1446
1447 If the config file doesn't exist then it won't be loaded (allowing you
1448 to special case the config files of just a few clients).
1449
1450   bf(Example:)
1451 tt(     config file = /usr/local/samba/lib/smb.conf.%m)
1452
1453 label(copy)
1454 dit(bf(copy (S)))
1455
1456 This parameter allows you to em('clone') service entries. The specified
1457 service is simply duplicated under the current service's name. Any
1458 parameters specified in the current section will override those in the
1459 section being copied.
1460
1461 This feature lets you set up a 'template' service and create similar
1462 services easily. Note that the service being copied must occur earlier
1463 in the configuration file than the service doing the copying.
1464
1465   bf(Default:)
1466 tt(     none)
1467
1468   bf(Example:)
1469 tt(     copy = otherservice)
1470
1471 label(createmask)
1472 dit(bf(create mask (S)))
1473
1474 A synonym for this parameter is link(bf('create mode'))(createmode).
1475
1476 When a file is created, the necessary permissions are calculated
1477 according to the mapping from DOS modes to UNIX permissions, and the
1478 resulting UNIX mode is then bit-wise 'AND'ed with this parameter.
1479 This parameter may be thought of as a bit-wise MASK for the UNIX modes
1480 of a file. Any bit em(*not*) set here will be removed from the modes set
1481 on a file when it is created.
1482
1483 The default value of this parameter removes the 'group' and 'other'
1484 write and execute bits from the UNIX modes.
1485
1486 Following this Samba will bit-wise 'OR' the UNIX mode created from
1487 this parameter with the value of the "force create mode" parameter
1488 which is set to 000 by default.
1489
1490 This parameter does not affect directory modes. See the parameter
1491 link(bf('directory mode'))(directorymode) for details.
1492
1493 See also the link(bf("force create mode"))(forcecreatemode) parameter
1494 for forcing particular mode bits to be set on created files. See also
1495 the link(bf("directory mode"))(directorymode) parameter for masking
1496 mode bits on created directories.
1497
1498   bf(Default:)
1499 tt(     create mask = 0744)
1500
1501   bf(Example:)
1502 tt(     create mask = 0775)
1503
1504 label(createmode)
1505 dit(bf(create mode (S)))
1506
1507 This is a synonym for link(bf(create mask))(createmask).
1508
1509 label(deadtime)
1510 dit(bf(deadtime (G)))
1511
1512 The value of the parameter (a decimal integer) represents the number
1513 of minutes of inactivity before a connection is considered dead, and
1514 it is disconnected. The deadtime only takes effect if the number of
1515 open files is zero.
1516
1517 This is useful to stop a server's resources being exhausted by a large
1518 number of inactive connections.
1519
1520 Most clients have an auto-reconnect feature when a connection is
1521 broken so in most cases this parameter should be transparent to users.
1522
1523 Using this parameter with a timeout of a few minutes is recommended
1524 for most systems.
1525
1526 A deadtime of zero indicates that no auto-disconnection should be
1527 performed.
1528
1529   bf(Default:)
1530 tt(     deadtime = 0)
1531
1532   bf(Example:)
1533 tt(     deadtime = 15)
1534
1535 label(debugtimestamp)
1536 dit(bf(debug timestamp (G)))
1537
1538 Samba2.0 debug log messages are timestamped by default. If you are
1539 running at a high link(bf("debug level"))(debuglevel) these timestamps
1540 can be distracting. This boolean parameter allows them to be turned
1541 off.
1542
1543   bf(Default:)
1544 tt(     debug timestamp = Yes)
1545
1546   bf(Example:)
1547 tt(     debug timestamp = No)
1548
1549 label(debuglevel)
1550 dit(bf(debug level (G)))
1551
1552 The value of the parameter (an integer) allows the debug level
1553 (logging level) to be specified in the bf(smb.conf) file. This is to
1554 give greater flexibility in the configuration of the system.
1555
1556 The default will be the debug level specified on the command line
1557 or level zero if none was specified.
1558
1559   bf(Example:)
1560 tt(     debug level = 3)
1561
1562 label(default)
1563 dit(bf(default (G)))
1564
1565 A synonym for link(bf(default service))(defaultservice).
1566
1567 label(defaultcase)
1568 dit(bf(default case (S)))
1569
1570 See the section on link(bf("NAME MANGLING"))(NAMEMANGLING). Also note
1571 the link(bf("short preserve case"))(shortpreservecase) parameter.
1572
1573 label(default service)
1574 dit(bf(default service (G)))
1575
1576 This parameter specifies the name of a service which will be connected
1577 to if the service actually requested cannot be found. Note that the
1578 square brackets are em(NOT) given in the parameter value (see example
1579 below).
1580
1581 There is no default value for this parameter. If this parameter is not
1582 given, attempting to connect to a nonexistent service results in an
1583 error.
1584
1585 Typically the default service would be a link(bf(guest ok))(guestok),
1586 link(bf(read-only))(readonly) service.
1587
1588 Also note that the apparent service name will be changed to equal that
1589 of the requested service, this is very useful as it allows you to use
1590 macros like link(bf(%S))(percentS) to make a wildcard service.
1591
1592 Note also that any tt('_') characters in the name of the service used
1593 in the default service will get mapped to a tt('/'). This allows for
1594 interesting things.
1595
1596
1597   bf(Example:)
1598 verb(
1599         default service = pub
1600         
1601         [pub]
1602                 path = /%S
1603 )
1604
1605 label(deletereadonly)
1606 dit(bf(delete readonly (S)))
1607
1608 This parameter allows readonly files to be deleted.  This is not
1609 normal DOS semantics, but is allowed by UNIX.
1610
1611 This option may be useful for running applications such as rcs, where
1612 UNIX file ownership prevents changing file permissions, and DOS
1613 semantics prevent deletion of a read only file.
1614
1615   bf(Default:)
1616 tt(     delete readonly = No)
1617
1618   bf(Example:)
1619 tt(     delete readonly = Yes)
1620
1621 label(deletevetofiles)
1622 dit(bf(delete veto files (S)))
1623
1624 This option is used when Samba is attempting to delete a directory
1625 that contains one or more vetoed directories (see the link(bf('veto
1626 files'))(vetofiles) option).  If this option is set to False (the
1627 default) then if a vetoed directory contains any non-vetoed files or
1628 directories then the directory delete will fail. This is usually what
1629 you want.
1630
1631 If this option is set to True, then Samba will attempt to recursively
1632 delete any files and directories within the vetoed directory. This can
1633 be useful for integration with file serving systems such as bf(NetAtalk),
1634 which create meta-files within directories you might normally veto
1635 DOS/Windows users from seeing (e.g. tt(.AppleDouble))
1636
1637 Setting tt('delete veto files = True') allows these directories to be 
1638 transparently deleted when the parent directory is deleted (so long
1639 as the user has permissions to do so).
1640
1641 See also the link(bf(veto files))(vetofiles) parameter.
1642
1643   bf(Default:)
1644 tt(     delete veto files = False)
1645
1646   bf(Example:)
1647 tt(     delete veto files = True)
1648
1649 label(denyhosts)
1650 dit(bf(deny hosts (S)))
1651
1652 The opposite of link(bf('allow hosts'))(allowhosts) - hosts listed
1653 here are em(NOT) permitted access to services unless the specific
1654 services have their own lists to override this one. Where the lists
1655 conflict, the link(bf('allow'))(allowhosts) list takes precedence.
1656
1657   bf(Default:)
1658 tt(     none (i.e., no hosts specifically excluded))
1659
1660   bf(Example:)
1661 tt(     deny hosts = 150.203.4. badhost.mynet.edu.au)
1662
1663 label(dfreecommand)
1664 dit(bf(dfree command (G)))
1665
1666 The dfree command setting should only be used on systems where a
1667 problem occurs with the internal disk space calculations. This has
1668 been known to happen with Ultrix, but may occur with other operating
1669 systems. The symptom that was seen was an error of "Abort Retry
1670 Ignore" at the end of each directory listing.
1671
1672 This setting allows the replacement of the internal routines to
1673 calculate the total disk space and amount available with an external
1674 routine. The example below gives a possible script that might fulfill
1675 this function.
1676
1677 The external program will be passed a single parameter indicating a
1678 directory in the filesystem being queried. This will typically consist
1679 of the string tt("./"). The script should return two integers in
1680 ascii. The first should be the total disk space in blocks, and the
1681 second should be the number of available blocks. An optional third
1682 return value can give the block size in bytes. The default blocksize
1683 is 1024 bytes.
1684
1685 Note: Your script should em(NOT) be setuid or setgid and should be
1686 owned by (and writeable only by) root!
1687
1688   bf(Default:)
1689 tt(     By default internal routines for determining the disk capacity
1690 and remaining space will be used.)
1691
1692   bf(Example:)
1693 tt(     dfree command = /usr/local/samba/bin/dfree)
1694
1695 Where the script dfree (which must be made executable) could be:
1696
1697 verb(
1698         #!/bin/sh
1699         df $1 | tail -1 | awk '{print $2" "$4}'
1700 )
1701
1702 or perhaps (on Sys V based systems):
1703
1704 verb(
1705         #!/bin/sh
1706         /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
1707 )
1708
1709         Note that you may have to replace the command names with full
1710 path names on some systems.
1711
1712 label(directory)
1713 dit(bf(directory (S)))
1714
1715 Synonym for link(bf(path))(path).
1716
1717 label(directorymask)
1718 dit(bf(directory mask (S)))
1719
1720 This parameter is the octal modes which are used when converting DOS
1721 modes to UNIX modes when creating UNIX directories.
1722
1723 When a directory is created, the necessary permissions are calculated
1724 according to the mapping from DOS modes to UNIX permissions, and the
1725 resulting UNIX mode is then bit-wise 'AND'ed with this parameter.
1726 This parameter may be thought of as a bit-wise MASK for the UNIX modes
1727 of a directory. Any bit em(*not*) set here will be removed from the
1728 modes set on a directory when it is created.
1729
1730 The default value of this parameter removes the 'group' and 'other'
1731 write bits from the UNIX mode, allowing only the user who owns the
1732 directory to modify it.
1733
1734 Following this Samba will bit-wise 'OR' the UNIX mode created from
1735 this parameter with the value of the "force directory mode"
1736 parameter. This parameter is set to 000 by default (i.e. no extra mode
1737 bits are added).
1738
1739 See the link(bf("force directory mode"))(forcedirectorymode) parameter
1740 to cause particular mode bits to always be set on created directories.
1741
1742 See also the link(bf("create mode"))(createmode) parameter for masking
1743 mode bits on created files.
1744
1745   bf(Default:)
1746 tt(     directory mask = 0755)
1747
1748   bf(Example:)
1749 tt(     directory mask = 0775)
1750
1751 label(directorymode)
1752 dit(bf(directory mode (S)))
1753
1754 Synonym for link(bf(directory mask))(directorymask).
1755
1756 label(dnsproxy)
1757 dit(bf(dns proxy (G)))
1758
1759 Specifies that url(bf(nmbd))(nmbd.8.html) when acting as a WINS
1760 server and finding that a NetBIOS name has not been registered, should
1761 treat the NetBIOS name word-for-word as a DNS name and do a lookup
1762 with the DNS server for that name on behalf of the name-querying
1763 client.
1764
1765 Note that the maximum length for a NetBIOS name is 15 characters, so
1766 the DNS name (or DNS alias) can likewise only be 15 characters,
1767 maximum.
1768
1769 url(bf(nmbd))(nmbd.8.html) spawns a second copy of itself to do the
1770 DNS name lookup requests, as doing a name lookup is a blocking action.
1771
1772 See also the parameter link(bf(wins support))(winssupport).
1773
1774   bf(Default:)
1775 tt(     dns proxy = yes)
1776
1777 label(domainadmingroup)
1778 bf(domain admin group (G))
1779
1780 This is an bf(EXPERIMENTAL) parameter that is part of the unfinished
1781 Samba NT Domain Controller Code.  It has been removed as of November 98.
1782 To work with the latest code builds that may have more support for
1783 Samba NT Domain Controller functionality please subscribe to the
1784 mailing list bf(Samba-ntdom) available by sending email to
1785 email(listproc@samba.org)
1786
1787 label(domainadminusers) 
1788 dit(bf(domain admin users (G)))
1789
1790 This is an bf(EXPERIMENTAL) parameter that is part of the unfinished
1791 Samba NT Domain Controller Code. It has been removed as of November 98.
1792 To work with the latest code builds that may have more support for
1793 Samba NT Domain Controller functionality please subscribe to the
1794 mailing list bf(Samba-ntdom) available by sending email to
1795 email(listproc@samba.org)
1796
1797 label(domain controller)
1798 dit(bf(domain controller (G)))
1799
1800 This is a bf(DEPRECATED) parameter. It is currently not used within
1801 the Samba source and should be removed from all current smb.conf
1802 files. It is left behind for compatibility reasons.
1803
1804 label(domaingroupmap)
1805 dit(bf(domain group map (G)))
1806
1807 This option allows you to specify a file containing unique mappings
1808 of individual NT Domain Group names (in any domain) to UNIX group
1809 names.  This allows NT domain groups to be presented correctly to
1810 NT users, despite the lack of native support for the NT Security model
1811 (based on VAX/VMS) in UNIX.  The reader is advised to become familiar
1812 with the NT Domain system and its administration.
1813
1814 This option is used in conjunction with link(bf('local group map'))(localgroupmap)
1815 and link(bf('domain user map'))(domainusermap).  The use of these three
1816 options is trivial and often unnecessary in the case where Samba is
1817 not expected to interact with any other SAM databases (whether local
1818 workstations or Domain Controllers).
1819
1820
1821 The map file is parsed line by line.  If any line begins with a tt('#')
1822 or a tt(';') then it is ignored.  Each line should contain a single UNIX
1823 group name on the left then a single NT Domain Group name on the right,
1824 separated by a tabstop or tt('=').  If either name contains spaces then
1825 it should be enclosed in quotes.
1826 The line can be either of the form:
1827
1828 tt(  UNIXgroupname      \\DOMAIN_NAME\\DomainGroupName )
1829
1830 or:
1831
1832 tt(  UNIXgroupname      DomainGroupName )
1833
1834 In the case where Samba is either an bf(EXPERIMENTAL) Domain Controller
1835 or it is a member of a domain using link(bf("security = domain"))(security),
1836 the latter format can be used: the default Domain name is the Samba Server's
1837 Domain name, specified by link(bf("workgroup = MYGROUP"))(workgroup).
1838
1839 Any UNIX groups that are em(NOT) specified in this map file are assumed to
1840 be either Local or Domain Groups, depending on the role of the Samba Server.
1841
1842 In the case when Samba is an bf(EXPERIMENTAL) Domain Controller, Samba
1843 will present em(ALL) such unspecified UNIX groups as its own NT Domain
1844 Groups, with the same name.
1845
1846 In the case where Samba is member of a domain using
1847 link(bf("security = domain"))(security), Samba will check the UNIX name with
1848 its Domain Controller (see link(bf("password server"))(passwordserver))
1849 as if it was an NT Domain Group.  If the Domain Controller says that it is not,
1850 such unspecified (unmapped) UNIX groups which also are not NT Domain
1851 Groups are treated as Local Groups in the Samba Server's local SAM database.
1852 NT Administrators will recognise these as Workstation Local Groups,
1853 which are managed by running bf(USRMGR.EXE) and selecting a remote
1854 Domain named "\\WORKSTATION_NAME", or by running bf(MUSRMGR.EXE) on
1855 a local Workstation.
1856
1857 This may sound complicated, but it means that a Samba Server as
1858 either a member of a domain or as an bf(EXPERIMENTAL) Domain Controller
1859 will act like an NT Workstation (with a local SAM database) or an NT PDC
1860 (with a Domain SAM database) respectively, without the need for any of
1861 the map files at all.  If you bf(want) to get fancy, however, you can.
1862
1863 Note that adding an entry to map an arbitrary NT group in an arbitrary
1864 Domain to an arbitrary UNIX group em(REQUIRES) the following:
1865
1866 startit()
1867
1868 it() that the UNIX group exists on the UNIX server.
1869
1870 it() that the NT Domain Group exists in the specified NT Domain
1871
1872 it() that the UNIX Server knows about the specified Domain; 
1873
1874 it() that all the UNIX users (who are expecting to access the Samba
1875 Server as the correct NT user and with the correct NT group permissions)
1876 in the UNIX group be mapped to the correct NT Domain users in the specified
1877 NT Domain using link(bf('domain user map'))(domainusermap).
1878
1879 endit()
1880
1881 Failure to meet any of these requirements may result in either (or
1882 both) errors reported in the log files or (and) incorrect or missing
1883 access rights granted to users.
1884
1885
1886 label(domaingroups)
1887 dit(bf(domain groups (G)))
1888
1889 This is an bf(EXPERIMENTAL) parameter that is part of the unfinished
1890 Samba NT Domain Controller Code. It has been removed as of November 98.
1891 To work with the latest code builds that may have more support for
1892 Samba NT Domain Controller functionality please subscribe to the
1893 mailing list bf(Samba-ntdom) available by sending email to
1894 email(listproc@samba.org)
1895
1896 label(domainguestgroup)
1897 dit(bf(domain guest group (G)))
1898
1899 This is an bf(EXPERIMENTAL) parameter that is part of the unfinished
1900 Samba NT Domain Controller Code. It has been removed as of November 98.
1901 To work with the latest code builds that may have more support for
1902 Samba NT Domain Controller functionality please subscribe to the
1903 mailing list bf(Samba-ntdom) available by sending email to
1904 email(listproc@samba.org)
1905
1906 label(domainguestusers)
1907 dit(bf(domain guest users (G)))
1908
1909 This is an bf(EXPERIMENTAL) parameter that is part of the unfinished
1910 Samba NT Domain Controller Code. It has been removed as of November 98.
1911 To work with the latest code builds that may have more support for
1912 Samba NT Domain Controller functionality please subscribe to the
1913 mailing list bf(Samba-ntdom) available by sending email to
1914 email(listproc@samba.org)
1915
1916 label(domainlogons)
1917 dit(bf(domain logons (G)))
1918
1919 If set to true, the Samba server will serve Windows 95/98 Domain
1920 logons for the link(bf(workgroup))(workgroup) it is in. For more
1921 details on setting up this feature see the file DOMAINS.txt in the
1922 Samba documentation directory tt(docs/) shipped with the source code.
1923
1924 Note that Win95/98 Domain logons are em(NOT) the same as Windows
1925 NT Domain logons. NT Domain logons require a Primary Domain Controller
1926 (PDC) for the Domain. It is intended that in a future release Samba
1927 will be able to provide this functionality for Windows NT clients
1928 also.
1929
1930   bf(Default:)
1931 tt(     domain logons = no)
1932
1933 label(domainmaster)
1934 dit(bf(domain master (G)))
1935
1936 Tell url(bf(nmbd))(nmbd.8.html) to enable WAN-wide browse list
1937 collation. Setting this option causes url(bf(nmbd))(nmbd.8.html) to
1938 claim a special domain specific NetBIOS name that identifies it as a
1939 domain master browser for its given
1940 link(bf(workgroup))(workgroup). Local master browsers in the same
1941 link(bf(workgroup))(workgroup) on broadcast-isolated subnets will give
1942 this url(bf(nmbd))(nmbd.8.html) their local browse lists, and then
1943 ask url(bf(smbd))(smbd.8.html) for a complete copy of the browse list
1944 for the whole wide area network.  Browser clients will then contact
1945 their local master browser, and will receive the domain-wide browse
1946 list, instead of just the list for their broadcast-isolated subnet.
1947
1948 Note that Windows NT Primary Domain Controllers expect to be able to
1949 claim this link(bf(workgroup))(workgroup) specific special NetBIOS
1950 name that identifies them as domain master browsers for that
1951 link(bf(workgroup))(workgroup) by default (i.e. there is no way to
1952 prevent a Windows NT PDC from attempting to do this). This means that
1953 if this parameter is set and url(bf(nmbd))(nmbd.8.html) claims the
1954 special name for a link(bf(workgroup))(workgroup) before a Windows NT
1955 PDC is able to do so then cross subnet browsing will behave strangely
1956 and may fail.
1957
1958   bf(Default:)
1959 tt(     domain master = no)
1960
1961
1962 label(domainusermap)
1963 dit(bf(domain user map (G)))
1964
1965 This option allows you to specify a file containing unique mappings
1966 of individual NT Domain User names (in any domain) to UNIX user
1967 names.  This allows NT domain users to be presented correctly to
1968 NT systems, despite the lack of native support for the NT Security model
1969 (based on VAX/VMS) in UNIX.  The reader is advised to become familiar
1970 with the NT Domain system and its administration.
1971
1972 This option is used in conjunction with link(bf('local group map'))(localgroupmap)
1973 and link(bf('domain group map'))(domaingroupmap).  The use of these three
1974 options is trivial and often unnecessary in the case where Samba is
1975 not expected to interact with any other SAM databases (whether local
1976 workstations or Domain Controllers).
1977
1978 This option, which provides (and maintains) a one-to-one link between
1979 UNIX and NT users, is em(DIFFERENT) from link(bf('username map'))
1980 (usernamemap), which does em(NOT) maintain a distinction between the
1981 name(s) it can map to and the name it maps.
1982
1983
1984 The map file is parsed line by line.  If any line begins with a tt('#')
1985 or a tt(';') then the line is ignored.  Each line should contain a single UNIX
1986 user name on the left then a single NT Domain User name on the right,
1987 separated by a tabstop or tt('=').  If either name contains spaces then
1988 it should be enclosed in quotes.
1989 The line can be either of the form:
1990
1991 tt(  UNIXusername       \\DOMAIN_NAME\\DomainUserName )
1992
1993 or:
1994
1995 tt(  UNIXusername       DomainUserName )
1996
1997 In the case where Samba is either an bf(EXPERIMENTAL) Domain Controller
1998 or it is a member of a domain using link(bf("security = domain"))(security),
1999 the latter format can be used: the default Domain name is the Samba Server's
2000 Domain name, specified by link(bf("workgroup = MYGROUP"))(workgroup).
2001
2002 Any UNIX users that are em(NOT) specified in this map file are assumed
2003 to be either Domain or Workstation Users, depending on the role of the
2004 Samba Server.
2005
2006 In the case when Samba is an bf(EXPERIMENTAL) Domain Controller, Samba
2007 will present em(ALL) such unspecified UNIX users as its own NT Domain
2008 Users, with the same name.
2009
2010 In the case where Samba is a member of a domain using
2011 link(bf("security = domain"))(security), Samba will check the UNIX name with
2012 its Domain Controller (see link(bf("password server"))(passwordserver))
2013 as if it was an NT Domain User.  If the Domain Controller says that it is not,
2014 such unspecified (unmapped) UNIX users which also are not NT Domain
2015 Users are treated as Local Users in the Samba Server's local SAM database.
2016 NT Administrators will recognise these as Workstation Users,
2017 which are managed by running bf(USRMGR.EXE) and selecting a remote
2018 Domain named "\\WORKSTATION_NAME", or by running bf(MUSRMGR.EXE) on
2019 a local Workstation.
2020
2021 This may sound complicated, but it means that a Samba Server as
2022 either a member of a domain or as an bf(EXPERIMENTAL) Domain Controller
2023 will act like an NT Workstation (with a local SAM database) or an NT PDC
2024 (with a Domain SAM database) respectively, without the need for any of
2025 the map files at all.  If you bf(want) to get fancy, however, you can.
2026
2027 Note that adding an entry to map an arbitrary NT User in an arbitrary
2028 Domain to an arbitrary UNIX user em(REQUIRES) the following:
2029
2030 startit()
2031
2032 it() that the UNIX user exists on the UNIX server.
2033
2034 it() that the NT Domain User exists in the specified NT Domain.
2035
2036 it() that the UNIX Server knows about the specified Domain.
2037
2038 endit()
2039
2040 Failure to meet any of these requirements may result in either (or
2041 both) errors reported in the log files or (and) incorrect or missing
2042 access rights granted to users.
2043
2044
2045 label(dont descend)
2046 dit(bf(dont descend (S)))
2047
2048 There are certain directories on some systems (e.g., the tt(/proc) tree
2049 under Linux) that are either not of interest to clients or are
2050 infinitely deep (recursive). This parameter allows you to specify a
2051 comma-delimited list of directories that the server should always show
2052 as empty.
2053
2054 Note that Samba can be very fussy about the exact format of the "dont
2055 descend" entries. For example you may need tt("./proc") instead of
2056 just tt("/proc"). Experimentation is the best policy :-)
2057
2058   bf(Default:)
2059 tt(     none (i.e., all directories are OK to descend))
2060
2061   bf(Example:)
2062 tt(     dont descend = /proc,/dev)
2063
2064 label(dosfiletimeresolution)
2065 dit(bf(dos filetime resolution (S)))
2066
2067 Under the DOS and Windows FAT filesystem, the finest granularity on
2068 time resolution is two seconds. Setting this parameter for a share
2069 causes Samba to round the reported time down to the nearest two second
2070 boundary when a query call that requires one second resolution is made
2071 to url(bf(smbd))(smbd.8.html).
2072
2073 This option is mainly used as a compatibility option for Visual C++
2074 when used against Samba shares. If oplocks are enabled on a share,
2075 Visual C++ uses two different time reading calls to check if a file
2076 has changed since it was last read. One of these calls uses a
2077 one-second granularity, the other uses a two second granularity. As
2078 the two second call rounds any odd second down, then if the file has a
2079 timestamp of an odd number of seconds then the two timestamps will not
2080 match and Visual C++ will keep reporting the file has changed. Setting
2081 this option causes the two timestamps to match, and Visual C++ is
2082 happy.
2083
2084   bf(Default:)
2085 tt(     dos filetime resolution = False)
2086
2087   bf(Example:)
2088 tt(     dos filetime resolution = True)
2089
2090 label(dos filetimes)
2091 dit(bf(dos filetimes (S)))
2092
2093 Under DOS and Windows, if a user can write to a file they can change
2094 the timestamp on it. Under POSIX semantics, only the owner of the file
2095 or root may change the timestamp. By default, Samba runs with POSIX
2096 semantics and refuses to change the timestamp on a file if the user
2097 smbd is acting on behalf of is not the file owner. Setting this option
2098 to True allows DOS semantics and smbd will change the file timestamp as
2099 DOS requires.
2100
2101   bf(Default:)
2102 tt(     dos filetimes = False)
2103
2104   bf(Example:)
2105 tt(     dos filetimes = True)
2106
2107 label(encryptpasswords)
2108 dit(bf(encrypt passwords (G)))
2109
2110 This boolean controls whether encrypted passwords will be negotiated
2111 with the client. Note that Windows NT 4.0 SP3 and above and also
2112 Windows 98 will by default expect encrypted passwords unless a
2113 registry entry is changed. To use encrypted passwords in Samba see the
2114 file ENCRYPTION.txt in the Samba documentation directory tt(docs/)
2115 shipped with the source code.
2116
2117 In order for encrypted passwords to work correctly
2118 url(bf(smbd))(smbd.8.html) must either have access to a local
2119 url(bf(smbpasswd (5)))(smbpasswd.5.html) file (see the
2120 url(bf(smbpasswd (8)))(smbpasswd.8.html) program for information on
2121 how to set up and maintain this file), or set the
2122 link(bf(security=))(security) parameter to either
2123 link(bf("server"))(securityequalserver) or
2124 link(bf("domain"))(securityequaldomain) which causes
2125 url(bf(smbd))(smbd.8.html) to authenticate against another server.
2126
2127 label(exec)
2128 dit(bf(exec (S)))
2129
2130 This is a synonym for link(bf(preexec))(preexec).
2131
2132 label(fake directory create times)
2133 dit(bf(fake directory create times (S)))
2134
2135 NTFS and Windows VFAT file systems keep a create time for all files
2136 and directories. This is not the same as the ctime - status change
2137 time - that Unix keeps, so Samba by default reports the earliest of
2138 the various times Unix does keep. Setting this parameter for a share
2139 causes Samba to always report midnight 1-1-1980 as the create time for
2140 directories.
2141
2142 This option is mainly used as a compatibility option for Visual C++
2143 when used against Samba shares. Visual C++ generated makefiles have
2144 the object directory as a dependency for each object file, and a make
2145 rule to create the directory. Also, when NMAKE compares timestamps it
2146 uses the creation time when examining a directory. Thus the object
2147 directory will be created if it does not exist, but once it does exist
2148 it will always have an earlier timestamp than the object files it
2149 contains.
2150
2151 However, Unix time semantics mean that the create time reported by
2152 Samba will be updated whenever a file is created or deleted in the
2153 directory. NMAKE therefore finds all object files in the object
2154 directory bar the last one built are out of date compared to the
2155 directory and rebuilds them. Enabling this option ensures directories
2156 always predate their contents and an NMAKE build will proceed as
2157 expected.
2158
2159   bf(Default:)
2160 tt(     fake directory create times = False)
2161
2162   bf(Example:)
2163 tt(     fake directory create times = True)
2164
2165 label(fakeoplocks)
2166 dit(bf(fake oplocks (S)))
2167
2168 Oplocks are the way that SMB clients get permission from a server to
2169 locally cache file operations. If a server grants an oplock
2170 (opportunistic lock) then the client is free to assume that it is the
2171 only one accessing the file and it will aggressively cache file
2172 data. With some oplock types the client may even cache file open/close
2173 operations. This can give enormous performance benefits.
2174
2175 When you set tt("fake oplocks = yes") url(bf(smbd))(smbd.8.html) will
2176 always grant oplock requests no matter how many clients are using the
2177 file.
2178
2179 It is generally much better to use the real link(bf(oplocks))(oplocks)
2180 support rather than this parameter.
2181
2182 If you enable this option on all read-only shares or shares that you
2183 know will only be accessed from one client at a time such as
2184 physically read-only media like CDROMs, you will see a big performance
2185 improvement on many operations. If you enable this option on shares
2186 where multiple clients may be accessing the files read-write at the
2187 same time you can get data corruption. Use this option carefully!
2188
2189 This option is disabled by default.
2190
2191 label(followsymlinks)
2192 dit(bf(follow symlinks (S)))
2193
2194 This parameter allows the Samba administrator to stop
2195 url(bf(smbd))(smbd.8.html) from following symbolic links in a
2196 particular share. Setting this parameter to em("No") prevents any file
2197 or directory that is a symbolic link from being followed (the user
2198 will get an error).  This option is very useful to stop users from
2199 adding a symbolic link to tt(/etc/passwd) in their home directory for
2200 instance.  However it will slow filename lookups down slightly.
2201
2202 This option is enabled (i.e. url(bf(smbd))(smbd.8.html) will follow
2203 symbolic links) by default.
2204
2205 label(forcecreatemode)
2206 dit(bf(force create mode (S)))
2207
2208 This parameter specifies a set of UNIX mode bit permissions that will
2209 em(*always*) be set on a file created by Samba. This is done by
2210 bitwise 'OR'ing these bits onto the mode bits of a file that is being
2211 created. The default for this parameter is (in octal) 000. The modes
2212 in this parameter are bitwise 'OR'ed onto the file mode after the mask
2213 set in the link(bf("create mask"))(createmask) parameter is applied.
2214
2215 See also the parameter link(bf("create mask"))(createmask) for details
2216 on masking mode bits on created files.
2217
2218   bf(Default:)
2219 tt(     force create mode = 000)
2220
2221   bf(Example:)
2222 tt(     force create mode = 0755)
2223
2224 would force all created files to have read and execute permissions set
2225 for 'group' and 'other' as well as the read/write/execute bits set for
2226 the 'user'.
2227
2228 label(forcedirectorymode)
2229 dit(bf(force directory mode (S)))
2230
2231 This parameter specifies a set of UNIX mode bit permissions that will
2232 em(*always*) be set on a directory created by Samba. This is done by
2233 bitwise 'OR'ing these bits onto the mode bits of a directory that is
2234 being created. The default for this parameter is (in octal) 0000 which
2235 will not add any extra permission bits to a created directory. This
2236 operation is done after the mode mask in the parameter
2237 link(bf("directory mask"))(directorymask) is applied.
2238
2239 See also the parameter link(bf("directory mask"))(directorymask) for
2240 details on masking mode bits on created directories.
2241
2242   bf(Default:)
2243 tt(     force directory mode = 000)
2244
2245   bf(Example:)
2246 tt(     force directory mode = 0755)
2247
2248 would force all created directories to have read and execute
2249 permissions set for 'group' and 'other' as well as the
2250 read/write/execute bits set for the 'user'.
2251
2252 label(forcegroup)
2253 dit(bf(force group (S)))
2254
2255 This specifies a UNIX group name that will be assigned as the default
2256 primary group for all users connecting to this service. This is useful
2257 for sharing files by ensuring that all access to files on service will
2258 use the named group for their permissions checking. Thus, by assigning
2259 permissions for this group to the files and directories within this
2260 service the Samba administrator can restrict or allow sharing of these
2261 files.
2262
2263   bf(Default:)
2264 tt(     no forced group)
2265
2266   bf(Example:)
2267 tt(     force group = agroup)
2268
2269 label(forceuser)
2270 dit(bf(force user (S)))
2271
2272 This specifies a UNIX user name that will be assigned as the default
2273 user for all users connecting to this service. This is useful for
2274 sharing files. You should also use it carefully as using it
2275 incorrectly can cause security problems.
2276
2277 This user name only gets used once a connection is established. Thus
2278 clients still need to connect as a valid user and supply a valid
2279 password. Once connected, all file operations will be performed as the
2280 tt("forced user"), no matter what username the client connected as.
2281
2282 This can be very useful.
2283
2284   bf(Default:)
2285 tt(     no forced user)
2286
2287   bf(Example:)
2288 tt(     force user = auser)
2289
2290 label(fstype)
2291 dit(bf(fstype (S)))
2292
2293 This parameter allows the administrator to configure the string that
2294 specifies the type of filesystem a share is using that is reported by
2295 url(bf(smbd))(smbd.8.html) when a client queries the filesystem type
2296 for a share. The default type is bf("NTFS") for compatibility with
2297 Windows NT but this can be changed to other strings such as "Samba" or
2298 "FAT" if required.
2299
2300   bf(Default:)
2301 tt(     fstype = NTFS)
2302
2303   bf(Example:)
2304 tt(     fstype = Samba)
2305
2306 label(getwdcache)
2307 dit(bf(getwd cache (G)))
2308
2309 This is a tuning option. When this is enabled a caching algorithm
2310 will be used to reduce the time taken for getwd() calls. This can have
2311 a significant impact on performance, especially when the
2312 link(bf(widelinks))(widelinks) parameter is set to False.
2313
2314   bf(Default:)
2315 tt(     getwd cache = No)
2316
2317   bf(Example:)
2318 tt(     getwd cache = Yes)
2319
2320 label(group)
2321 dit(bf(group (S)))
2322
2323 Synonym for link(bf("force group"))(forcegroup).
2324
2325 label(guestaccount)
2326 dit(bf(guest account (S)))
2327
2328 This is a username which will be used for access to services which are
2329 specified as link(bf('guest ok'))(guestok) (see below). Whatever
2330 privileges this user has will be available to any client connecting to
2331 the guest service. Typically this user will exist in the password
2332 file, but will not have a valid login. The user account bf("ftp") is
2333 often a good choice for this parameter. If a username is specified in
2334 a given service, the specified username overrides this one.
2335
2336 One some systems the default guest account "nobody" may not be able to
2337 print. Use another account in this case. You should test this by
2338 trying to log in as your guest user (perhaps by using the tt("su -")
2339 command) and trying to print using the system print command such as
2340 bf(lpr (1)) or bf(lp (1)).
2341
2342   bf(Default:)
2343 tt(     specified at compile time, usually "nobody")
2344
2345   bf(Example:)
2346 tt(     guest account = ftp)
2347
2348 label(guestok)
2349 dit(bf(guest ok (S)))
2350
2351 If this parameter is em('yes') for a service, then no password is
2352 required to connect to the service. Privileges will be those of the
2353 link(bf(guest account))(guestaccount).
2354
2355 See the section below on link(bf(security))(security) for more
2356 information about this option.
2357
2358   bf(Default:)
2359 tt(     guest ok = no)
2360
2361   bf(Example:)
2362 tt(     guest ok = yes)
2363
2364 label(guestonly)
2365 dit(bf(guest only (S)))
2366
2367 If this parameter is em('yes') for a service, then only guest
2368 connections to the service are permitted. This parameter will have no
2369 affect if link(bf("guest ok"))(guestok) or link(bf("public"))(public)
2370 is not set for the service.
2371
2372 See the section below on link(bf(security))(security) for more
2373 information about this option.
2374
2375   bf(Default:)
2376 tt(     guest only = no)
2377
2378   bf(Example:)
2379 tt(     guest only = yes)
2380
2381 label(hidedotfiles)
2382 dit(bf(hide dot files (S)))
2383
2384 This is a boolean parameter that controls whether files starting with
2385 a dot appear as hidden files.
2386
2387   bf(Default:)
2388 tt(     hide dot files = yes)
2389
2390   bf(Example:)
2391 tt(     hide dot files = no)
2392
2393
2394 label(hidefiles)
2395 dit(bf(hide files(S)))
2396
2397 This is a list of files or directories that are not visible but are
2398 accessible.  The DOS 'hidden' attribute is applied to any files or
2399 directories that match.
2400
2401 Each entry in the list must be separated by a tt('/'), which allows
2402 spaces to be included in the entry.  tt('*') and tt('?') can be used
2403 to specify multiple files or directories as in DOS wildcards.
2404
2405 Each entry must be a Unix path, not a DOS path and must not include the 
2406 Unix directory separator tt('/').
2407
2408 Note that the case sensitivity option is applicable in hiding files.
2409
2410 Setting this parameter will affect the performance of Samba, as it
2411 will be forced to check all files and directories for a match as they
2412 are scanned.
2413
2414 See also link(bf("hide dot files"))(hidedotfiles), link(bf("veto
2415 files"))(vetofiles) and link(bf("case sensitive"))(casesensitive).
2416
2417   bf(Default)
2418 verb(
2419         No files or directories are hidden by this option (dot files are
2420         hidden by default because of the "hide dot files" option).
2421 )
2422
2423   bf(Example)
2424 tt(     hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/)
2425
2426 The above example is based on files that the Macintosh SMB client
2427 (DAVE) available from url(bf(Thursby))(www.thursby.com) creates for
2428 internal use, and also still hides all files beginning with a dot.
2429
2430 label(homedirmap)
2431 dit(bf(homedir map (G)))
2432
2433 If link(bf("nis homedir"))(nishomedir) is true, and
2434 url(bf(smbd))(smbd.8.html) is also acting as a Win95/98 link(bf(logon
2435 server))(domainlogons) then this parameter specifies the NIS (or YP)
2436 map from which the server for the user's home directory should be
2437 extracted.  At present, only the Sun auto.home map format is
2438 understood. The form of the map is:
2439
2440 tt(username     server:/some/file/system)
2441
2442 and the program will extract the servername from before the first
2443 tt(':').  There should probably be a better parsing system that copes
2444 with different map formats and also Amd (another automounter) maps.
2445
2446 NB: A working NIS is required on the system for this option to work.
2447
2448 See also link(bf("nis homedir"))(nishomedir), link(bf(domain
2449 logons))(domainlogons).
2450
2451   bf(Default:)
2452 tt(     homedir map = auto.home)
2453
2454   bf(Example:)
2455 tt(     homedir map = amd.homedir)
2456
2457 label(hostsallow)
2458 dit(bf(hosts allow (S)))
2459
2460 Synonym for link(bf(allow hosts))(allowhosts).
2461
2462 label(hostsdeny)
2463 dit(bf(hosts deny (S)))
2464
2465 Synonym for link(bf(denyhosts))(denyhosts).
2466
2467 label(hostsequiv)
2468 dit(bf(hosts equiv (G)))
2469
2470 If this global parameter is a non-null string, it specifies the name
2471 of a file to read for the names of hosts and users who will be allowed
2472 access without specifying a password.
2473
2474 This is not be confused with link(bf(allow hosts))(allowhosts) which
2475 is about hosts access to services and is more useful for guest
2476 services. bf(hosts equiv) may be useful for NT clients which will not
2477 supply passwords to samba.
2478
2479 NOTE: The use of bf(hosts equiv) can be a major security hole. This is
2480 because you are trusting the PC to supply the correct username. It is
2481 very easy to get a PC to supply a false username. I recommend that the
2482 bf(hosts equiv) option be only used if you really know what you are
2483 doing, or perhaps on a home network where you trust your spouse and
2484 kids. And only if you em(really) trust them :-).
2485
2486   bf(Default)
2487 tt(     No host equivalences)
2488
2489   bf(Example)
2490 tt(     hosts equiv = /etc/hosts.equiv)
2491
2492 label(include)
2493 dit(bf(include (G)))
2494
2495 This allows you to include one config file inside another.  The file
2496 is included literally, as though typed in place.
2497
2498 It takes the standard substitutions, except link(bf(%u))(percentu),
2499 link(bf(%P))(percentP) and link(bf(%S))(percentS).
2500
2501 label(interfaces)
2502 dit(bf(interfaces (G)))
2503
2504 This option allows you to setup multiple network interfaces, so that
2505 Samba can properly handle browsing on all interfaces.
2506
2507 The option takes a list of ip/netmask pairs. The netmask may either be
2508 a bitmask, or a bitlength.
2509
2510 For example, the following line:
2511
2512 tt(interfaces = 192.168.2.10/24 192.168.3.10/24)
2513
2514 would configure two network interfaces with IP addresses 192.168.2.10
2515 and 192.168.3.10. The netmasks of both interfaces would be set to
2516 255.255.255.0.
2517
2518 You could produce an equivalent result by using:
2519
2520 tt(interfaces = 192.168.2.10/255.255.255.0 192.168.3.10/255.255.255.0)
2521
2522 if you prefer that format.
2523
2524 If this option is not set then Samba will attempt to find a primary
2525 interface, but won't attempt to configure more than one interface.
2526
2527 See also link(bf("bind interfaces only"))(bindinterfacesonly).
2528
2529 label(invalidusers)
2530 dit(bf(invalid users (S)))
2531
2532 This is a list of users that should not be allowed to login to this
2533 service. This is really a em("paranoid") check to absolutely ensure an
2534 improper setting does not breach your security.
2535
2536 A name starting with a tt('@') is interpreted as an NIS netgroup first
2537 (if your system supports NIS), and then as a UNIX group if the name
2538 was not found in the NIS netgroup database.
2539
2540 A name starting with tt('+') is interpreted only by looking in the
2541 UNIX group database. A name starting with tt('&') is interpreted only
2542 by looking in the NIS netgroup database (this requires NIS to be
2543 working on your system). The characters tt('+') and tt('&') may be
2544 used at the start of the name in either order so the value
2545 tt("+&group") means check the UNIX group database, followed by the NIS
2546 netgroup database, and the value tt("&+group") means check the NIS
2547 netgroup database, followed by the UNIX group database (the same as
2548 the tt('@') prefix).
2549
2550 The current servicename is substituted for
2551 link(bf(%S))(percentS). This is useful in the link(bf([homes]))(homes)
2552 section.
2553
2554 See also link(bf("valid users"))(validusers).
2555
2556   bf(Default:)
2557 tt(     No invalid users)
2558
2559   bf(Example:)
2560 tt(     invalid users = root fred admin @wheel)
2561
2562 label(keepalive)
2563 dit(bf(keepalive (G)))
2564
2565 The value of the parameter (an integer) represents the number of
2566 seconds between bf('keepalive') packets. If this parameter is zero, no
2567 keepalive packets will be sent. Keepalive packets, if sent, allow the
2568 server to tell whether a client is still present and responding.
2569
2570 Keepalives should, in general, not be needed if the socket being used
2571 has the SO_KEEPALIVE attribute set on it (see link(bf("socket
2572 options"))(socketoptions)). Basically you should only use this option
2573 if you strike difficulties.
2574
2575   bf(Default:)
2576 tt(     keep alive = 0)
2577
2578   bf(Example:)
2579 tt(     keep alive = 60)
2580
2581 label(kerneloplocks)
2582 dit(bf(kernel oplocks (G)))
2583
2584 For UNIXs that support kernel based link(bf(oplocks))(oplocks)
2585 (currently only IRIX but hopefully also Linux and FreeBSD soon) this
2586 parameter allows the use of them to be turned on or off.
2587
2588 Kernel oplocks support allows Samba link(bf(oplocks))(oplocks) to be
2589 broken whenever a local UNIX process or NFS operation accesses a file
2590 that url(bf(smbd))(smbd.8.html) has oplocked. This allows complete
2591 data consistency between SMB/CIFS, NFS and local file access (and is a
2592 em(very) cool feature :-).
2593
2594 This parameter defaults to em("On") on systems that have the support,
2595 and em("off") on systems that don't. You should never need to touch
2596 this parameter.
2597
2598 label(ldapfilter)
2599 dit(bf(ldap filter (G)))
2600
2601 This parameter is part of the em(EXPERIMENTAL) Samba support for a
2602 password database stored on an LDAP server back-end. These options
2603 are only available if your version of Samba was configured with
2604 the bf(--with-ldap) option.
2605
2606 This parameter specifies an LDAP search filter used to search for a
2607 user name in the LDAP database. It must contain the string
2608 link(bf(%u))(percentU) which will be replaced with the user being
2609 searched for.
2610
2611   bf(Default:)
2612 tt(     empty string.)
2613
2614 label(ldapport)
2615 dit(bf(ldap port (G)))
2616
2617 This parameter is part of the em(EXPERIMENTAL) Samba support for a
2618 password database stored on an LDAP server back-end. These options
2619 are only available if your version of Samba was configured with
2620 the bf(--with-ldap) option.
2621
2622 This parameter specifies the TCP port number to use to contact
2623 the LDAP server on.
2624
2625   bf(Default:)
2626 tt(     ldap port = 389.)
2627
2628 label(ldaproot)
2629 dit(bf(ldap root (G)))
2630
2631 This parameter is part of the em(EXPERIMENTAL) Samba support for a
2632 password database stored on an LDAP server back-end. These options
2633 are only available if your version of Samba was configured with
2634 the bf(--with-ldap) option.
2635
2636 This parameter specifies the entity to bind to the LDAP server
2637 as (essentially the LDAP username) in order to be able to perform
2638 queries and modifications on the LDAP database.
2639
2640 See also link(bf(ldap root passwd))(ldaprootpasswd).
2641
2642   bf(Default:)
2643 tt(     empty string (no user defined))
2644
2645 label(ldaprootpasswd)
2646 dit(bf(ldap root passwd (G)))
2647
2648 This parameter is part of the em(EXPERIMENTAL) Samba support for a
2649 password database stored on an LDAP server back-end. These options
2650 are only available if your version of Samba was configured with
2651 the bf(--with-ldap) option.
2652
2653 This parameter specifies the password for the entity to bind to the
2654 LDAP server as (the password for this LDAP username) in order to be
2655 able to perform queries and modifications on the LDAP database.
2656
2657 em(BUGS:) This parameter should em(NOT) be a readable parameter
2658 in the bf(smb.conf) file and will be removed once a correct
2659 storage place is found.
2660
2661 See also link(bf(ldap root))(ldaproot).
2662
2663   bf(Default:)
2664 tt(     empty string.)
2665
2666 label(ldapserver)
2667 dit(bf(ldap server (G)))
2668
2669 This parameter is part of the em(EXPERIMENTAL) Samba support for a
2670 password database stored on an LDAP server back-end. These options
2671 are only available if your version of Samba was configured with
2672 the bf(--with-ldap) option.
2673
2674 This parameter specifies the DNS name of the LDAP server to use
2675 for SMB/CIFS authentication purposes.
2676
2677   bf(Default:)
2678 tt(     ldap server = localhost)
2679
2680 label(ldapsuffix)
2681 dit(bf(ldap suffix (G)))
2682
2683 This parameter is part of the em(EXPERIMENTAL) Samba support for a
2684 password database stored on an LDAP server back-end. These options
2685 are only available if your version of Samba was configured with
2686 the bf(--with-ldap) option.
2687
2688 This parameter specifies the tt("dn") or LDAP em("distinguished name")
2689 that tells url(bf(smbd))(smbd.8.html) to start from when searching
2690 for an entry in the LDAP password database.
2691
2692   bf(Default:)
2693 tt(     empty string.)
2694
2695 label(lmannounce)
2696 dit(bf(lm announce (G)))
2697
2698 This parameter determines if url(bf(nmbd))(nmbd.8.html) will produce
2699 Lanman announce broadcasts that are needed by bf(OS/2) clients in order
2700 for them to see the Samba server in their browse list. This parameter
2701 can have three values, tt("true"), tt("false"), or tt("auto"). The
2702 default is tt("auto").  If set to tt("false") Samba will never produce
2703 these broadcasts. If set to tt("true") Samba will produce Lanman
2704 announce broadcasts at a frequency set by the parameter link(bf("lm
2705 interval"))(lminterval). If set to tt("auto") Samba will not send Lanman
2706 announce broadcasts by default but will listen for them. If it hears
2707 such a broadcast on the wire it will then start sending them at a
2708 frequency set by the parameter link(bf("lm interval"))(lminterval).
2709
2710 See also link(bf("lm interval"))(lminterval).
2711
2712   bf(Default:)
2713 tt(     lm announce = auto)
2714
2715   bf(Example:)
2716 tt(     lm announce = true)
2717
2718 label(lminterval)
2719 dit(bf(lm interval (G)))
2720
2721 If Samba is set to produce Lanman announce broadcasts needed by
2722 bf(OS/2) clients (see the link(bf("lm announce"))(lmannounce)
2723 parameter) then this parameter defines the frequency in seconds with
2724 which they will be made.  If this is set to zero then no Lanman
2725 announcements will be made despite the setting of the link(bf("lm
2726 announce"))(lmannounce) parameter.
2727
2728 See also link(bf("lm announce"))(lmannounce).
2729
2730   bf(Default:)
2731 tt(     lm interval = 60)
2732
2733   bf(Example:)
2734 tt(     lm interval = 120)
2735
2736 label(loadprinters)
2737 dit(bf(load printers (G)))
2738
2739 A boolean variable that controls whether all printers in the printcap
2740 will be loaded for browsing by default. See the
2741 link(bf("printers"))(printers) section for more details.
2742
2743   bf(Default:)
2744 tt(     load printers = yes)
2745
2746   bf(Example:)
2747 tt(     load printers = no)
2748
2749 label(localgroupmap)
2750 dit(bf(local group map (G)))
2751
2752 This option allows you to specify a file containing unique mappings
2753 of individual NT Local Group names (in any domain) to UNIX group
2754 names.  This allows NT Local groups (aliases) to be presented correctly to
2755 NT users, despite the lack of native support for the NT Security model
2756 (based on VAX/VMS) in UNIX.  The reader is advised to become familiar
2757 with the NT Domain system and its administration.
2758
2759 This option is used in conjunction with link(bf('domain group map'))(domaingroupmap)
2760 and link(bf('domain name map'))(domainusermap).  The use of these three
2761 options is trivial and often unnecessary in the case where Samba
2762 is not expected to interact with any other SAM databases (whether local
2763 workstations or Domain Controllers).
2764
2765
2766 The map file is parsed line by line.  If any line begins with a tt('#')
2767 or a tt(';') then it is ignored.  Each line should contain a single UNIX
2768 group name on the left then a single NT Local Group name on the right,
2769 separated by a tabstop or tt('=').  If either name contains spaces then
2770 it should be enclosed in quotes.
2771 The line can be either of the form:
2772
2773 tt(  UNIXgroupname      \\DOMAIN_NAME\\LocalGroupName )
2774
2775 or:
2776
2777 tt(  UNIXgroupname      LocalGroupName )
2778
2779 In the case where Samba is either an bf(EXPERIMENTAL) Domain Controller
2780 or it is a member of a domain using link(bf("security = domain"))(security),
2781 the latter format can be used: the default Domain name is the Samba Server's
2782 Domain name, specified by link(bf("workgroup = MYGROUP"))(workgroup).
2783
2784 Any UNIX groups that are em(NOT) specified in this map file are treated
2785 as either Local or Domain Groups depending on the role of the Samba Server.
2786
2787 In the case when Samba is an bf(EXPERIMENTAL) Domain Controller, Samba
2788 will present em(ALL) unspecified UNIX groups as its own NT Domain
2789 Groups, with the same name, and em(NOT) as Local Groups.
2790
2791 In the case where Samba is member of a domain using
2792 link(bf("security = domain"))(security), Samba will check the UNIX name with
2793 its Domain Controller (see link(bf("password server"))(passwordserver))
2794 as if it was an NT Domain Group.  If the Domain Controller says that it is not,
2795 such unspecified (unmapped) UNIX groups which also are not NT Domain
2796 Groups are treated as Local Groups in the Samba Server's local SAM database.
2797 NT Administrators will recognise these as Workstation Local Groups,
2798 which are managed by running bf(USRMGR.EXE) and selecting a remote
2799 Domain named "\\WORKSTATION_NAME", or by running bf(MUSRMGR.EXE) on
2800 a local Workstation.
2801
2802 This may sound complicated, but it means that a Samba Server as
2803 either a member of a domain or as an bf(EXPERIMENTAL) Domain Controller
2804 will act like an NT Workstation (with a local SAM database) or an NT PDC
2805 (with a Domain SAM database) respectively, without the need for any of
2806 the map files at all.  If you bf(want) to get fancy, however, you can.
2807
2808 Note that adding an entry to map an arbitrary NT group in an arbitrary
2809 Domain to an arbitrary UNIX group em(REQUIRES) the following:
2810
2811 startit()
2812
2813 it() that the UNIX group exists on the UNIX server.
2814
2815 it() that the NT Domain Group exists in the specified NT Domain
2816
2817 it() that the UNIX Server knows about the specified Domain; 
2818
2819 it() that all the UNIX users (who are expecting to access the Samba
2820 Server as the correct NT user and with the correct NT group permissions)
2821 in the UNIX group be mapped to the correct NT Domain users in the specified
2822 NT Domain using link(bf('domain user map'))(domainusermap).
2823
2824 endit()
2825
2826 Failure to meet any of these requirements may result in either (or
2827 both) errors reported in the log files or (and) incorrect or missing
2828 access rights granted to users.
2829
2830
2831 label(localmaster)
2832 dit(bf(local master (G)))
2833
2834 This option allows url(bf(nmbd))(nmbd.8.html) to try and become a
2835 local master browser on a subnet. If set to False then
2836 url(bf(nmbd))(nmbd.8.html) will not attempt to become a local master
2837 browser on a subnet and will also lose in all browsing elections. By
2838 default this value is set to true. Setting this value to true doesn't
2839 mean that Samba will em(become) the local master browser on a subnet,
2840 just that url(bf(nmbd))(nmbd.8.html) will em(participate) in
2841 elections for local master browser.
2842
2843 Setting this value to False will cause url(bf(nmbd))(nmbd.8.html)
2844 em(never) to become a local master browser.
2845
2846   bf(Default:)
2847 tt(     local master = yes)
2848
2849 label(lock dir)
2850 dit(bf(lock dir (G)))
2851
2852 Synonym for link(bf("lock directory"))(lockdirectory).
2853
2854 label(lockdirectory)
2855 dit(bf(lock directory (G)))
2856
2857 This option specifies the directory where lock files will be placed.
2858 The lock files are used to implement the link(bf("max
2859 connections"))(maxconnections) option.
2860
2861   bf(Default:)
2862 tt(     lock directory = /tmp/samba)
2863
2864   bf(Example:)
2865 tt(     lock directory = /usr/local/samba/var/locks)
2866
2867 label(locking)
2868 dit(bf(locking (S)))
2869
2870 This controls whether or not locking will be performed by the server
2871 in response to lock requests from the client.
2872
2873 If tt("locking = no"), all lock and unlock requests will appear to
2874 succeed and all lock queries will indicate that the queried lock is
2875 clear.
2876
2877 If tt("locking = yes"), real locking will be performed by the server.
2878
2879 This option em(may) be useful for read-only filesystems which em(may)
2880 not need locking (such as cdrom drives), although setting this
2881 parameter of tt("no") is not really recommended even in this case.
2882
2883 Be careful about disabling locking either globally or in a specific
2884 service, as lack of locking may result in data corruption. You should
2885 never need to set this parameter.
2886
2887   bf(Default:)
2888 tt(     locking = yes)
2889
2890   bf(Example:)
2891 tt(     locking = no)
2892
2893 label(logfile)
2894 dit(bf(log file (G)))
2895
2896 This options allows you to override the name of the Samba log file
2897 (also known as the debug file).
2898
2899 This option takes the standard substitutions, allowing you to have
2900 separate log files for each user or machine.
2901
2902   bf(Example:)
2903 tt(     log file = /usr/local/samba/var/log.%m)
2904
2905 label(loglevel)
2906 dit(bf(log level (G)))
2907
2908 Synonym for link(bf("debug level"))(debuglevel).
2909
2910 label(logondrive)
2911 dit(bf(logon drive (G)))
2912
2913 This parameter specifies the local path to which the home directory
2914 will be connected (see link(bf("logon home"))(logonhome)) and is only
2915 used by NT Workstations. 
2916
2917 Note that this option is only useful if Samba is set up as a
2918 link(bf(logon server))(domainlogons).
2919
2920   bf(Example:)
2921 tt(     logon drive = h:)
2922
2923 label(logonhome)
2924 dit(bf(logon home (G)))
2925
2926 This parameter specifies the home directory location when a Win95/98 or
2927 NT Workstation logs into a Samba PDC.  It allows you to do 
2928
2929 tt("NET USE H: /HOME")
2930
2931 from a command prompt, for example.
2932
2933 This option takes the standard substitutions, allowing you to have
2934 separate logon scripts for each user or machine.
2935
2936 Note that this option is only useful if Samba is set up as a
2937 link(bf(logon server))(domainlogons).
2938
2939   bf(Example:)
2940 tt(     logon home = "\\remote_smb_server\%U")
2941
2942   bf(Default:)
2943 tt(     logon home = "\\%N\%U")
2944
2945 label(logonpath)
2946 dit(bf(logon path (G)))
2947
2948 This parameter specifies the home directory where roaming profiles
2949 (USER.DAT / USER.MAN files for Windows 95/98) are stored.
2950
2951 This option takes the standard substitutions, allowing you to have
2952 separate logon scripts for each user or machine.  It also specifies
2953 the directory from which the tt("desktop"), tt("start menu"),
2954 tt("network neighborhood") and tt("programs") folders, and their
2955 contents, are loaded and displayed on your Windows 95/98 client.
2956
2957 The share and the path must be readable by the user for the
2958 preferences and directories to be loaded onto the Windows 95/98
2959 client.  The share must be writeable when the logs in for the first
2960 time, in order that the Windows 95/98 client can create the user.dat
2961 and other directories.
2962
2963 Thereafter, the directories and any of the contents can, if required, be
2964 made read-only.  It is not advisable that the USER.DAT file be made
2965 read-only - rename it to USER.MAN to achieve the desired effect (a
2966 em(MAN)datory profile).
2967
2968 Windows clients can sometimes maintain a connection to the [homes]
2969 share, even though there is no user logged in.  Therefore, it is vital
2970 that the logon path does not include a reference to the homes share
2971 (i.e. setting this parameter to tt(\\%N\HOMES\profile_path) will cause
2972 problems).
2973
2974 This option takes the standard substitutions, allowing you to have
2975 separate logon scripts for each user or machine.
2976
2977 Note that this option is only useful if Samba is set up as a
2978 link(bf(logon server))(domainlogons).
2979
2980   bf(Default:)
2981 tt(     logon path = \\%N\%U\profile)
2982
2983   bf(Example:)
2984 tt(     logon path = \\PROFILESERVER\HOME_DIR\%U\PROFILE)
2985
2986 label(logonscript)
2987 dit(bf(logon script (G)))
2988
2989 This parameter specifies the batch file (.bat) or NT command file
2990 (.cmd) to be downloaded and run on a machine when a user successfully
2991 logs in.  The file must contain the DOS style cr/lf line endings.
2992 Using a DOS-style editor to create the file is recommended.
2993
2994 The script must be a relative path to the tt([netlogon]) service.  If
2995 the tt([netlogon]) service specifies a link(bf(path))(path) of
2996 /usr/local/samba/netlogon, and logon script = STARTUP.BAT, then the
2997 file that will be downloaded is:
2998
2999 tt(/usr/local/samba/netlogon/STARTUP.BAT)
3000
3001 The contents of the batch file is entirely your choice.  A suggested
3002 command would be to add tt(NET TIME \\SERVER /SET /YES), to force every
3003 machine to synchronize clocks with the same time server.  Another use
3004 would be to add tt(NET USE U: \\SERVER\UTILS) for commonly used
3005 utilities, or tt(NET USE Q: \\SERVER\ISO9001_QA) for example.
3006
3007 Note that it is particularly important not to allow write access to
3008 the tt([netlogon]) share, or to grant users write permission on the
3009 batch files in a secure environment, as this would allow the batch
3010 files to be arbitrarily modified and security to be breached.
3011
3012 This option takes the standard substitutions, allowing you to have
3013 separate logon scripts for each user or machine.
3014
3015 Note that this option is only useful if Samba is set up as a
3016 link(bf(logon server))(domainlogons).
3017
3018   bf(Example:)
3019 tt(     logon script = scripts\%U.bat)
3020
3021 label(lppausecommand)
3022 dit(bf(lppause command (S)))
3023
3024 This parameter specifies the command to be executed on the server host
3025 in order to stop printing or spooling a specific print job.
3026
3027 This command should be a program or script which takes a printer name
3028 and job number to pause the print job. One way of implementing this is
3029 by using job priorities, where jobs having a too low priority won't be
3030 sent to the printer.
3031
3032 If a tt("%p") is given then the printername is put in its place. A
3033 tt("%j") is replaced with the job number (an integer).  On HPUX (see
3034 link(bf(printing=hpux))(printing)), if the tt("-p%p") option is added
3035 to the lpq command, the job will show up with the correct status,
3036 i.e. if the job priority is lower than the set fence priority it will
3037 have the PAUSED status, whereas if the priority is equal or higher it
3038 will have the SPOOLED or PRINTING status.
3039
3040 Note that it is good practice to include the absolute path in the
3041 lppause command as the PATH may not be available to the server.
3042
3043 See also the link(bf("printing"))(printing) parameter.
3044
3045   bf(Default:)
3046         Currently no default value is given to this string, unless the
3047 value of the link(bf("printing"))(printing) parameter is tt(SYSV), in
3048 which case the default is :
3049
3050 tt(     lp -i %p-%j -H hold)
3051
3052 or if the value of the link(bf("printing"))(printing) parameter is tt(softq),
3053 then the default is:
3054
3055 tt(     qstat -s -j%j -h)
3056  
3057   bf(Example for HPUX:)
3058         lppause command = /usr/bin/lpalt %p-%j -p0
3059
3060 label(lpqcachetime)
3061 dit(bf(lpq cache time (G)))
3062
3063 This controls how long lpq info will be cached for to prevent the
3064 bf(lpq) command being called too often. A separate cache is kept for
3065 each variation of the bf(lpq) command used by the system, so if you
3066 use different bf(lpq) commands for different users then they won't
3067 share cache information.
3068
3069 The cache files are stored in tt(/tmp/lpq.xxxx) where xxxx is a hash of
3070 the bf(lpq) command in use.
3071
3072 The default is 10 seconds, meaning that the cached results of a
3073 previous identical bf(lpq) command will be used if the cached data is
3074 less than 10 seconds old. A large value may be advisable if your
3075 bf(lpq) command is very slow.
3076
3077 A value of 0 will disable caching completely.
3078
3079 See also the link(bf("printing"))(printing) parameter.
3080
3081   bf(Default:)
3082 tt(     lpq cache time = 10)
3083
3084   bf(Example:)
3085 tt(     lpq cache time = 30)
3086
3087 label(lpqcommand)
3088 dit(bf(lpq command (S)))
3089
3090 This parameter specifies the command to be executed on the server host
3091 in order to obtain tt("lpq")-style printer status information.
3092
3093 This command should be a program or script which takes a printer name
3094 as its only parameter and outputs printer status information.
3095
3096 Currently eight styles of printer status information are supported;
3097 BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX and SOFTQ. This covers most UNIX
3098 systems. You control which type is expected using the
3099 link(bf("printing ="))(printing) option.
3100
3101 Some clients (notably Windows for Workgroups) may not correctly send
3102 the connection number for the printer they are requesting status
3103 information about. To get around this, the server reports on the first
3104 printer service connected to by the client. This only happens if the
3105 connection number sent is invalid.
3106
3107 If a tt(%p) is given then the printername is put in its place. Otherwise
3108 it is placed at the end of the command.
3109
3110 Note that it is good practice to include the absolute path in the bf(lpq
3111 command) as the PATH may not be available to the server.
3112
3113 See also the link(bf("printing"))(printing) parameter.
3114
3115   bf(Default:)
3116 tt(        depends on the setting of printing =)
3117
3118   bf(Example:)
3119 tt(     lpq command = /usr/bin/lpq %p)
3120
3121 label(lpresumecommand)
3122 dit(bf(lpresume command (S)))
3123
3124 This parameter specifies the command to be executed on the server host
3125 in order to restart or continue printing or spooling a specific print
3126 job.
3127
3128 This command should be a program or script which takes a printer name
3129 and job number to resume the print job. See also the link(bf("lppause
3130 command"))(lppausecommand) parameter.
3131
3132 If a tt(%p) is given then the printername is put in its place. A
3133 tt(%j) is replaced with the job number (an integer).
3134
3135 Note that it is good practice to include the absolute path in the bf(lpresume
3136 command) as the PATH may not be available to the server.
3137
3138 See also the link(bf("printing"))(printing) parameter.
3139
3140   bf(Default:)
3141
3142         Currently no default value is given to this string, unless the
3143 value of the link(bf("printing"))(printing) parameter is tt(SYSV), in
3144 which case the default is :
3145
3146 tt(     lp -i %p-%j -H resume)
3147
3148 or if the value of the link(bf("printing"))(printing) parameter is tt(softq),
3149 then the default is:
3150
3151 tt(     qstat -s -j%j -r)
3152  
3153   bf(Example for HPUX:)
3154 tt(        lpresume command = /usr/bin/lpalt %p-%j -p2)
3155
3156 label(lprmcommand)
3157 dit(bf(lprm command (S)))
3158
3159 This parameter specifies the command to be executed on the server host
3160 in order to delete a print job.
3161
3162 This command should be a program or script which takes a printer name
3163 and job number, and deletes the print job.
3164
3165 If a tt(%p) is given then the printername is put in its place. A
3166 tt(%j) is replaced with the job number (an integer).
3167
3168 Note that it is good practice to include the absolute path in the
3169 bf(lprm command) as the PATH may not be available to the server.
3170
3171 See also the link(bf("printing"))(printing) parameter.
3172
3173   bf(Default:)
3174 tt(     depends on the setting of "printing =")
3175
3176   bf(Example 1:)
3177 tt(     lprm command = /usr/bin/lprm -P%p %j)
3178
3179   bf(Example 2:)
3180 tt(     lprm command = /usr/bin/cancel %p-%j)
3181
3182 label(machinepasswordtimeout)
3183 dit(bf(machine password timeout (G)))
3184
3185 If a Samba server is a member of an Windows NT Domain (see the
3186 link(bf("security=domain"))(securityequaldomain)) parameter) then
3187 periodically a running url(bf(smbd))(smbd.8.html) process will try and
3188 change the bf(MACHINE ACCOUNT PASWORD) stored in the file called
3189 tt(<Domain>.<Machine>.mac) where tt(<Domain>) is the name of the
3190 Domain we are a member of and tt(<Machine>) is the primary
3191 link(bf("NetBIOS name"))(netbiosname) of the machine
3192 url(bf(smbd))(smbd.8.html) is running on. This parameter specifies how
3193 often this password will be changed, in seconds. The default is one
3194 week (expressed in seconds), the same as a Windows NT Domain member
3195 server.
3196
3197 See also url(bf(smbpasswd (8)))(smbpasswd.8.html), and the
3198 link(bf("security=domain"))(securityequaldomain)) parameter.
3199
3200   bf(Default:)
3201 tt(     machine password timeout = 604800)
3202
3203 label(magicoutput)
3204 dit(bf(magic output (S)))
3205
3206 This parameter specifies the name of a file which will contain output
3207 created by a magic script (see the link(bf("magic
3208 script"))(magicscript) parameter below).
3209
3210 Warning: If two clients use the same link(bf("magic
3211 script"))(magicscript) in the same directory the output file content
3212 is undefined.
3213
3214   bf(Default:)
3215 tt(     magic output = <magic script name>.out)
3216
3217   bf(Example:)
3218 tt(     magic output = myfile.txt)
3219
3220 label(magicscript)
3221 dit(bf(magic script (S)))
3222
3223 This parameter specifies the name of a file which, if opened, will be
3224 executed by the server when the file is closed. This allows a UNIX
3225 script to be sent to the Samba host and executed on behalf of the
3226 connected user.
3227
3228 Scripts executed in this way will be deleted upon completion,
3229 permissions permitting.
3230
3231 If the script generates output, output will be sent to the file
3232 specified by the link(bf("magic output"))(magicoutput) parameter (see
3233 above).
3234
3235 Note that some shells are unable to interpret scripts containing
3236 carriage-return-linefeed instead of linefeed as the end-of-line
3237 marker. Magic scripts must be executable em("as is") on the host,
3238 which for some hosts and some shells will require filtering at the DOS
3239 end.
3240
3241 Magic scripts are em(EXPERIMENTAL) and should em(NOT) be relied upon.
3242
3243   bf(Default:)
3244 tt(     None. Magic scripts disabled.)
3245
3246   bf(Example:)
3247 tt(     magic script = user.csh)
3248
3249 label(manglecase)
3250 dit(bf(mangle case (S)))
3251
3252 See the section on link(bf("NAME MANGLING"))(NAMEMANGLING).
3253
3254 label(mangledmap)
3255 dit(bf(mangled map (S)))
3256
3257 This is for those who want to directly map UNIX file names which can
3258 not be represented on Windows/DOS.  The mangling of names is not always
3259 what is needed.  In particular you may have documents with file
3260 extensions that differ between DOS and UNIX. For example, under UNIX
3261 it is common to use tt(".html") for HTML files, whereas under
3262 Windows/DOS tt(".htm") is more commonly used.
3263
3264 So to map tt("html") to tt("htm") you would use:
3265
3266 tt(  mangled map = (*.html *.htm))
3267
3268 One very useful case is to remove the annoying tt(";1") off the ends
3269 of filenames on some CDROMS (only visible under some UNIXs). To do
3270 this use a map of (*;1 *).
3271
3272   bf(default:)
3273 tt(     no mangled map)
3274
3275   bf(Example:)
3276 tt(     mangled map = (*;1 *))
3277
3278 label(manglednames)
3279 dit(bf(mangled names (S)))
3280
3281 This controls whether non-DOS names under UNIX should be mapped to
3282 DOS-compatible names ("mangled") and made visible, or whether non-DOS
3283 names should simply be ignored.
3284
3285 See the section on link(bf("NAME MANGLING"))(NAMEMANGLING) for details
3286 on how to control the mangling process.
3287
3288 If mangling is used then the mangling algorithm is as follows:
3289
3290 startit()
3291
3292 it() The first (up to) five alphanumeric characters before the
3293 rightmost dot of the filename are preserved, forced to upper case, and
3294 appear as the first (up to) five characters of the mangled name.
3295
3296 it() A tilde tt("~") is appended to the first part of the mangled
3297 name, followed by a two-character unique sequence, based on the
3298 original root name (i.e., the original filename minus its final
3299 extension). The final extension is included in the hash calculation
3300 only if it contains any upper case characters or is longer than three
3301 characters.
3302
3303 Note that the character to use may be specified using the
3304 link(bf("mangling char"))(manglingchar) option, if you don't like
3305 tt('~').
3306
3307 it() The first three alphanumeric characters of the final extension
3308 are preserved, forced to upper case and appear as the extension of the
3309 mangled name. The final extension is defined as that part of the
3310 original filename after the rightmost dot. If there are no dots in the
3311 filename, the mangled name will have no extension (except in the case
3312 of link(bf("hidden files"))(hidefiles) - see below).
3313
3314 it() Files whose UNIX name begins with a dot will be presented as DOS
3315 hidden files. The mangled name will be created as for other filenames,
3316 but with the leading dot removed and tt("___") as its extension regardless
3317 of actual original extension (that's three underscores).
3318
3319 endit()
3320
3321 The two-digit hash value consists of upper case alphanumeric
3322 characters.
3323
3324 This algorithm can cause name collisions only if files in a directory
3325 share the same first five alphanumeric characters. The probability of
3326 such a clash is 1/1300.
3327
3328 The name mangling (if enabled) allows a file to be copied between UNIX
3329 directories from Windows/DOS while retaining the long UNIX
3330 filename. UNIX files can be renamed to a new extension from
3331 Windows/DOS and will retain the same basename. Mangled names do not
3332 change between sessions.
3333
3334   bf(Default:)
3335 tt(     mangled names = yes)
3336
3337   bf(Example:)
3338 tt(     mangled names = no)
3339
3340 label(manglingchar)
3341 dit(bf(mangling char (S)))
3342
3343 This controls what character is used as the em("magic") character in
3344 link(bf(name mangling))(manglednames). The default is a tt('~') but
3345 this may interfere with some software. Use this option to set it to
3346 whatever you prefer.
3347
3348   bf(Default:)
3349 tt(     mangling char = ~)
3350
3351   bf(Example:)
3352 tt(     mangling char = ^)
3353
3354 label(mangledstack)
3355 dit(bf(mangled stack (G)))
3356
3357 This parameter controls the number of mangled names that should be
3358 cached in the Samba server url(bf(smbd))(smbd.8.html).
3359
3360 This stack is a list of recently mangled base names (extensions are
3361 only maintained if they are longer than 3 characters or contains upper
3362 case characters).
3363
3364 The larger this value, the more likely it is that mangled names can be
3365 successfully converted to correct long UNIX names. However, large
3366 stack sizes will slow most directory access. Smaller stacks save
3367 memory in the server (each stack element costs 256 bytes).
3368
3369 It is not possible to absolutely guarantee correct long file names, so
3370 be prepared for some surprises!
3371
3372   bf(Default:)
3373 tt(     mangled stack = 50)
3374
3375   bf(Example:)
3376 tt(     mangled stack = 100)
3377
3378 label(maparchive)
3379 dit(bf(map archive (S)))
3380
3381 This controls whether the DOS archive attribute should be mapped to
3382 the UNIX owner execute bit.  The DOS archive bit is set when a file
3383 has been modified since its last backup.  One motivation for this
3384 option it to keep Samba/your PC from making any file it touches from
3385 becoming executable under UNIX.  This can be quite annoying for shared
3386 source code, documents, etc...
3387
3388 Note that this requires the link(bf("create mask"))(createmask)
3389 parameter to be set such that owner execute bit is not masked out
3390 (i.e. it must include 100). See the parameter link(bf("create
3391 mask"))(createmask) for details.
3392
3393   bf(Default:)
3394 tt(      map archive = yes)
3395
3396   bf(Example:)
3397 tt(      map archive = no)
3398
3399 label(maphidden)
3400 dit(bf(map hidden (S)))
3401
3402 This controls whether DOS style hidden files should be mapped to the
3403 UNIX world execute bit.
3404
3405 Note that this requires the link(bf("create mask"))(createmask) to be
3406 set such that the world execute bit is not masked out (i.e. it must
3407 include 001). See the parameter link(bf("create mask"))(createmask)
3408 for details.
3409
3410   bf(Default:)
3411 tt(     map hidden = no)
3412
3413   bf(Example:)
3414 tt(     map hidden = yes)
3415
3416 label(mapsystem)
3417 dit(bf(map system (S)))
3418
3419 This controls whether DOS style system files should be mapped to the
3420 UNIX group execute bit.
3421
3422 Note that this requires the link(bf("create mask"))(createmask) to be
3423 set such that the group execute bit is not masked out (i.e. it must
3424 include 010). See the parameter link(bf("create mask"))(createmask)
3425 for details.
3426
3427   bf(Default:)
3428 tt(     map system = no)
3429
3430   bf(Example:)
3431 tt(     map system = yes)
3432
3433 label(maptoguest)
3434 dit(bf(map to guest (G)))
3435
3436 This parameter is only useful in link(bf(security))(security) modes
3437 other than link(bf("security=share"))(securityequalshare) - i.e. user,
3438 server, and domain.
3439
3440 This parameter can take three different values, which tell
3441 url(bf(smbd))(smbd.8.html) what to do with user login requests that
3442 don't match a valid UNIX user in some way.
3443
3444 The three settings are :
3445
3446 startit()
3447
3448 it() bf("Never") - Means user login requests with an invalid password
3449 are rejected. This is the default.
3450
3451 it() bf("Bad User") - Means user logins with an invalid password are
3452 rejected, unless the username does not exist, in which case it is
3453 treated as a guest login and mapped into the link(bf("guest
3454 account"))(guestaccount).
3455
3456 it() bf("Bad Password") - Means user logins with an invalid
3457 password are treated as a guest login and mapped into the
3458 link(bf("guest account"))(guestaccount). Note that this can
3459 cause problems as it means that any user incorrectly typing their
3460 password will be silently logged on a bf("guest") - and 
3461 will not know the reason they cannot access files they think
3462 they should - there will have been no message given to them
3463 that they got their password wrong. Helpdesk services will
3464 em(*hate*) you if you set the bf("map to guest") parameter
3465 this way :-).
3466
3467 endit()
3468
3469 Note that this parameter is needed to set up bf("Guest") share
3470 services when using link(bf(security))(security) modes other than
3471 share. This is because in these modes the name of the resource being
3472 requested is em(*not*) sent to the server until after the server has
3473 successfully authenticated the client so the server cannot make
3474 authentication decisions at the correct time (connection to the
3475 share) for bf("Guest") shares.
3476
3477 For people familiar with the older Samba releases, this parameter
3478 maps to the old compile-time setting of the GUEST_SESSSETUP value
3479 in local.h.
3480
3481   bf(Default:)
3482 tt(     map to guest = Never)
3483   bf(Example):
3484 tt(     map to guest = Bad User)
3485
3486 label(maxconnections)
3487 dit(bf(max connections (S)))
3488
3489 This option allows the number of simultaneous connections to a service
3490 to be limited. If bf("max connections") is greater than 0 then
3491 connections will be refused if this number of connections to the
3492 service are already open. A value of zero mean an unlimited number of
3493 connections may be made.
3494
3495 Record lock files are used to implement this feature. The lock files
3496 will be stored in the directory specified by the link(bf("lock
3497 directory"))(lockdirectory) option.
3498
3499   bf(Default:)
3500 tt(     max connections = 0)
3501
3502   bf(Example:)
3503 tt(     max connections = 10)
3504
3505 label(maxdisksize)
3506 dit(bf(max disk size (G)))
3507
3508 This option allows you to put an upper limit on the apparent size of
3509 disks. If you set this option to 100 then all shares will appear to be
3510 not larger than 100 MB in size.
3511
3512 Note that this option does not limit the amount of data you can put on
3513 the disk. In the above case you could still store much more than 100
3514 MB on the disk, but if a client ever asks for the amount of free disk
3515 space or the total disk size then the result will be bounded by the
3516 amount specified in bf("max disk size").
3517
3518 This option is primarily useful to work around bugs in some pieces of
3519 software that can't handle very large disks, particularly disks over
3520 1GB in size.
3521
3522 A bf("max disk size") of 0 means no limit.
3523
3524   bf(Default:)
3525 tt(     max disk size = 0)
3526
3527   bf(Example:)
3528 tt(     max disk size = 1000)
3529
3530 label(maxlogsize)
3531 dit(bf(max log size (G)))
3532
3533 This option (an integer in kilobytes) specifies the max size the log
3534 file should grow to. Samba periodically checks the size and if it is
3535 exceeded it will rename the file, adding a tt(".old") extension.
3536
3537 A size of 0 means no limit.
3538
3539   bf(Default:)
3540 tt(     max log size = 5000)
3541
3542   bf(Example:)
3543 tt(     max log size = 1000)
3544
3545 label(maxmux)
3546 dit(bf(max mux (G)))
3547
3548 This option controls the maximum number of outstanding simultaneous
3549 SMB operations that samba tells the client it will allow. You should
3550 never need to set this parameter.
3551
3552   bf(Default:)
3553 tt(     max mux = 50)
3554
3555 label(maxopenfiles)
3556 dit(bf(maxopenfiles (G)))
3557
3558 This parameter limits the maximum number of open files that one
3559 url(bf(smbd))(smbd.8.html) file serving process may have open for
3560 a client at any one time. The default for this parameter is set
3561 very high (10,000) as Samba uses only one bit per unopened file.
3562
3563 The limit of the number of open files is usually set by the
3564 UNIX per-process file descriptor limit rather than this parameter
3565 so you should never need to touch this parameter.
3566
3567   bf(Default:)
3568 tt(     max open files = 10000)
3569
3570 label(maxpacket)
3571 dit(bf(max packet (G)))
3572
3573 Synonym for label(bf("packet size"))(packetsize).
3574
3575 label(maxttl)
3576 dit(bf(max ttl (G)))
3577
3578 This option tells url(bf(nmbd))(nmbd.8.html) what the default 'time
3579 to live' of NetBIOS names should be (in seconds) when
3580 url(bf(nmbd))(nmbd.8.html) is requesting a name using either a
3581 broadcast packet or from a WINS server. You should never need to
3582 change this parameter. The default is 3 days.
3583
3584   bf(Default:)
3585 tt(     max ttl = 259200)
3586
3587 label(maxwinsttl)
3588 dit(bf(max wins ttl (G)))
3589
3590 This option tells url(bf(nmbd))(nmbd.8.html) when acting as a WINS
3591 server link(bf((wins support =true)))(winssupport) what the maximum
3592 'time to live' of NetBIOS names that url(bf(nmbd))(nmbd.8.html) will
3593 grant will be (in seconds). You should never need to change this
3594 parameter.  The default is 6 days (518400 seconds).
3595
3596 See also the link(bf("min wins ttl"))(minwinsttl) parameter.
3597
3598   bf(Default:)
3599 tt(        max wins ttl = 518400)
3600
3601 label(maxxmit)
3602 dit(bf(max xmit (G)))
3603
3604 This option controls the maximum packet size that will be negotiated
3605 by Samba. The default is 65535, which is the maximum. In some cases
3606 you may find you get better performance with a smaller value. A value
3607 below 2048 is likely to cause problems.
3608
3609   bf(Default:)
3610 tt(     max xmit = 65535)
3611
3612   bf(Example:)
3613 tt(     max xmit = 8192)
3614
3615 label(messagecommand)
3616 dit(bf(message command (G)))
3617
3618 This specifies what command to run when the server receives a WinPopup
3619 style message.
3620
3621 This would normally be a command that would deliver the message
3622 somehow. How this is to be done is up to your imagination.
3623
3624 An example is:
3625
3626 tt(   message command = csh -c 'xedit %s;rm %s' &)
3627
3628 This delivers the message using bf(xedit), then removes it
3629 afterwards. em(NOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN
3630 IMMEDIATELY). That's why I have the tt('&') on the end. If it doesn't
3631 return immediately then your PCs may freeze when sending messages
3632 (they should recover after 30secs, hopefully).
3633
3634 All messages are delivered as the global guest user. The command takes
3635 the standard substitutions, although link(bf(%u))(percentu) won't work
3636 (link(bf(%U))(percentU) may be better in this case).
3637
3638 Apart from the standard substitutions, some additional ones apply. In
3639 particular:
3640
3641 startit()
3642
3643 it() tt("%s") = the filename containing the message.
3644
3645 it() tt("%t") = the destination that the message was sent to (probably the server
3646 name).
3647
3648 it() tt("%f") = who the message is from.
3649
3650 endit()
3651
3652 You could make this command send mail, or whatever else takes your
3653 fancy. Please let us know of any really interesting ideas you have.
3654
3655 Here's a way of sending the messages as mail to root:
3656
3657 tt(message command = /bin/mail -s 'message from %f on %m' root < %s; rm %s)
3658
3659 If you don't have a message command then the message won't be
3660 delivered and Samba will tell the sender there was an
3661 error. Unfortunately WfWg totally ignores the error code and carries
3662 on regardless, saying that the message was delivered.
3663
3664 If you want to silently delete it then try:
3665
3666 tt("message command = rm %s").
3667
3668   bf(Default:)
3669 tt(     no message command)
3670
3671   bf(Example:)
3672 tt(        message command = csh -c 'xedit %s;rm %s' &)
3673
3674 label(minprintspace)
3675 dit(bf(min print space (S)))
3676
3677 This sets the minimum amount of free disk space that must be available
3678 before a user will be able to spool a print job. It is specified in
3679 kilobytes. The default is 0, which means a user can always spool a print
3680 job.
3681
3682 See also the link(bf(printing))(printing) parameter.
3683
3684   bf(Default:)
3685 tt(     min print space = 0)
3686
3687   bf(Example:)
3688 tt(     min print space = 2000)
3689
3690 label(minwinsttl)
3691 dit(bf(min wins ttl (G)))
3692
3693 This option tells url(bf(nmbd))(nmbd.8.html) when acting as a WINS
3694 server link(bf((wins support = true)))(winssupport) what the minimum
3695 'time to live' of NetBIOS names that url(bf(nmbd))(nmbd.8.html) will
3696 grant will be (in seconds). You should never need to change this
3697 parameter.  The default is 6 hours (21600 seconds).
3698
3699   bf(Default:)
3700 tt(     min wins ttl = 21600)
3701
3702
3703 label(nameresolveorder)
3704 dit(bf(name resolve order (G)))
3705
3706 This option is used by the programs in the Samba suite to determine
3707 what naming services and in what order to resolve host names to IP
3708 addresses. The option takes a space separated string of different name
3709 resolution options.
3710
3711 The options are :"lmhosts", "host", "wins" and "bcast". They cause
3712 names to be resolved as follows :
3713
3714 startit()
3715
3716 it() bf(lmhosts) : Lookup an IP address in the Samba lmhosts file.
3717
3718 it() bf(host) : Do a standard host name to IP address resolution,
3719 using the system /etc/hosts, NIS, or DNS lookups. This method of name
3720 resolution is operating system depended for instance on IRIX or
3721 Solaris this may be controlled by the em(/etc/nsswitch.conf) file).
3722
3723 it() bf(wins) : Query a name with the IP address listed in the
3724 link(bf(wins server))(winsserver) parameter. If no WINS server has
3725 been specified this method will be ignored.
3726
3727 it() bf(bcast) : Do a broadcast on each of the known local interfaces
3728 listed in the link(bf(interfaces))(interfaces) parameter. This is the
3729 least reliable of the name resolution methods as it depends on the
3730 target host being on a locally connected subnet.
3731
3732 endit()
3733
3734   bf(Default:)
3735 tt(     name resolve order = lmhosts host wins bcast)
3736
3737   bf(Example:)
3738 tt(     name resolve order = lmhosts bcast host)
3739
3740 This will cause the local lmhosts file to be examined first, followed
3741 by a broadcast attempt, followed by a normal system hostname lookup.
3742
3743 label(netbiosaliases)
3744 dit(bf(netbios aliases (G)))
3745
3746 This is a list of NetBIOS names that url(bf(nmbd))(nmbd.8.html) will
3747 advertise as additional names by which the Samba server is known. This
3748 allows one machine to appear in browse lists under multiple names. If
3749 a machine is acting as a link(bf(browse server))(localmaster) or
3750 link(bf(logon server))(domainlogons) none of these names will be
3751 advertised as either browse server or logon servers, only the primary
3752 name of the machine will be advertised with these capabilities.
3753
3754 See also link(bf("netbios name"))(netbiosname).
3755
3756   bf(Default:)
3757 tt(     empty string (no additional names))
3758
3759   bf(Example:)
3760 tt(     netbios aliases = TEST TEST1 TEST2)
3761
3762 label(netbiosname)
3763 dit(bf(netbios name (G)))
3764
3765 This sets the NetBIOS name by which a Samba server is known. By
3766 default it is the same as the first component of the host's DNS name.
3767 If a machine is a link(bf(browse server))(localmaster) or
3768 link(bf(logon server))(domainlogons) this name (or the first component
3769 of the hosts DNS name) will be the name that these services are
3770 advertised under.
3771
3772 See also link(bf("netbios aliases"))(netbiosaliases).
3773
3774   bf(Default:)
3775 tt(     Machine DNS name.)
3776
3777   bf(Example:)
3778 tt(     netbios name = MYNAME)
3779
3780 label(nishomedir)
3781 dit(bf(nis homedir (G)))
3782
3783 Get the home share server from a NIS map. For UNIX systems that use an
3784 automounter, the user's home directory will often be mounted on a
3785 workstation on demand from a remote server. 
3786
3787 When the Samba logon server is not the actual home directory server,
3788 but is mounting the home directories via NFS then two network hops
3789 would be required to access the users home directory if the logon
3790 server told the client to use itself as the SMB server for home
3791 directories (one over SMB and one over NFS). This can be very
3792 slow.
3793
3794 This option allows Samba to return the home share as being on a
3795 different server to the logon server and as long as a Samba daemon is
3796 running on the home directory server, it will be mounted on the Samba
3797 client directly from the directory server. When Samba is returning the
3798 home share to the client, it will consult the NIS map specified in
3799 link(bf("homedir map"))(homedirmap) and return the server listed
3800 there.
3801
3802 Note that for this option to work there must be a working NIS
3803 system and the Samba server with this option must also be a
3804 link(bf(logon server))(domainlogons).
3805
3806   bf(Default:)
3807 tt(     nis homedir = false)
3808
3809   bf(Example:)
3810 tt(     nis homedir = true)
3811
3812 label(ntpipesupport)
3813 dit(bf(nt pipe support (G)))
3814
3815 This boolean parameter controls whether url(bf(smbd))(smbd.8.html)
3816 will allow Windows NT clients to connect to the NT SMB specific
3817 tt(IPC$) pipes. This is a developer debugging option and can be left
3818 alone.
3819
3820   bf(Default:)
3821 tt(     nt pipe support = yes)
3822
3823 label(ntsmbsupport)
3824 dit(bf(nt smb support (G)))
3825
3826 This boolean parameter controls whether url(bf(smbd))(smbd.8.html)
3827 will negotiate NT specific SMB support with Windows NT
3828 clients. Although this is a developer debugging option and should be
3829 left alone, benchmarking has discovered that Windows NT clients give
3830 faster performance with this option set to tt("no"). This is still
3831 being investigated. If this option is set to tt("no") then Samba
3832 offers exactly the same SMB calls that versions prior to Samba2.0
3833 offered. This information may be of use if any users are having
3834 problems with NT SMB support.
3835
3836   bf(Default:)
3837 tt(     nt support = yes)
3838
3839 label(nullpasswords)
3840 dit(bf(null passwords (G)))
3841
3842 Allow or disallow client access to accounts that have null passwords. 
3843
3844 See also url(bf(smbpasswd (5)))(smbpasswd.5.html).
3845
3846   bf(Default:)
3847 tt(     null passwords = no)
3848
3849   bf(Example:)
3850 tt(     null passwords = yes)
3851
3852 label(olelockingcompatibility)
3853 dit(bf(ole locking compatibility (G)))
3854
3855 This parameter allows an administrator to turn off the byte range lock
3856 manipulation that is done within Samba to give compatibility for OLE
3857 applications. Windows OLE applications use byte range locking as a
3858 form of inter-process communication, by locking ranges of bytes around
3859 the 2^32 region of a file range. This can cause certain UNIX lock
3860 managers to crash or otherwise cause problems. Setting this parameter
3861 to tt("no") means you trust your UNIX lock manager to handle such cases
3862 correctly.
3863
3864   bf(Default:)
3865 tt(     ole locking compatibility = yes)
3866
3867   bf(Example:)
3868 tt(     ole locking compatibility = no)
3869
3870 label(onlyguest)
3871 dit(bf(only guest (S)))
3872
3873 A synonym for link(bf("guest only"))(guestonly).
3874
3875 label(onlyuser)
3876 dit(bf(only user (S)))
3877
3878 This is a boolean option that controls whether connections with
3879 usernames not in the link(bf(user=))(user) list will be allowed. By
3880 default this option is disabled so a client can supply a username to
3881 be used by the server.
3882
3883 Note that this also means Samba won't try to deduce usernames from the
3884 service name. This can be annoying for the link(bf([homes]))(homes)
3885 section. To get around this you could use "link(bf(user))(user) =
3886 link(bf(%S))(percentS)" which means your link(bf("user"))(user) list
3887 will be just the service name, which for home directories is the name
3888 of the user.
3889
3890 See also the link(bf(user))(user) parameter.
3891
3892   bf(Default:)
3893 tt(     only user = False)
3894
3895   bf(Example:)
3896 tt(     only user = True)
3897
3898 label(oplocks)
3899 dit(bf(oplocks (S)))
3900
3901 This boolean option tells smbd whether to issue oplocks (opportunistic
3902 locks) to file open requests on this share. The oplock code can
3903 dramatically (approx. 30% or more) improve the speed of access to files
3904 on Samba servers. It allows the clients to aggressively cache files
3905 locally and you may want to disable this option for unreliable network
3906 environments (it is turned on by default in Windows NT Servers).  For
3907 more information see the file Speed.txt in the Samba docs/ directory.
3908
3909 Oplocks may be selectively turned off on certain files on a per share basis.
3910 See the 'veto oplock files' parameter. On some systems oplocks are recognized
3911 by the underlying operating system. This allows data synchronization between
3912 all access to oplocked files, whether it be via Samba or NFS or a local
3913 UNIX process. See the link(bf(kernel oplocks))(kerneloplocks) parameter
3914 for details.
3915
3916   bf(Default:)
3917 tt(     oplocks = True)
3918
3919   bf(Example:)
3920 tt(     oplocks = False)
3921
3922 label(oslevel)
3923 dit(bf(os level (G)))
3924
3925 This integer value controls what level Samba advertises itself as for
3926 browse elections. The value of this parameter determines whether
3927 url(bf(nmbd))(nmbd.8.html) has a chance of becoming a local master
3928 browser for the link(bf(WORKGROUP))(workgroup) in the local broadcast
3929 area. The default is zero, which means url(bf(nmbd))(nmbd.8.html) will
3930 lose elections to Windows machines. See BROWSING.txt in the Samba
3931 docs/ directory for details.
3932
3933   bf(Default:)
3934 tt(     os level = 0)
3935
3936   bf(Example:)
3937 tt(     os level = 65    ; This will win against any NT Server)
3938
3939 label(packetsize)
3940 dit(bf(packet size (G)))
3941
3942 This is a deprecated parameter that how no effect on the current
3943 Samba code. It is left in the parameter list to prevent breaking
3944 old bf(smb.conf) files.
3945
3946 label(panicaction)
3947 dit(bf(panic action (G)))
3948
3949 This is a Samba developer option that allows a system command to be
3950 called when either url(bf(smbd))(smbd.8.html) or
3951 url(bf(nmbd))(nmbd.8.html) crashes. This is usually used to draw
3952 attention to the fact that a problem occurred.
3953
3954   bf(Default:)
3955 tt(     panic action = <empty string>)
3956
3957 label(passwdchat)
3958 dit(bf(passwd chat (G)))
3959
3960 This string controls the em("chat") conversation that takes places
3961 between url(bf(smbd))(smbd.8.html) and the local password changing
3962 program to change the users password. The string describes a sequence
3963 of response-receive pairs that url(bf(smbd))(smbd.8.html) uses to
3964 determine what to send to the link(bf(passwd))(passwdprogram) program
3965 and what to expect back. If the expected output is not received then
3966 the password is not changed.
3967
3968 This chat sequence is often quite site specific, depending on what
3969 local methods are used for password control (such as NIS etc).
3970
3971 The string can contain the macros tt("%o") and tt("%n") which are
3972 substituted for the old and new passwords respectively. It can also
3973 contain the standard macros tt("\n"), tt("\r"), tt("\t") and tt("\s")
3974 to give line-feed, carriage-return, tab and space.
3975
3976 The string can also contain a tt('*') which matches any sequence of
3977 characters.
3978
3979 Double quotes can be used to collect strings with spaces in them into
3980 a single string.
3981
3982 If the send string in any part of the chat sequence is a fullstop
3983 tt(".")  then no string is sent. Similarly, is the expect string is a
3984 fullstop then no string is expected.
3985
3986 Note that if the link(bf("unix password sync"))(unixpasswordsync)
3987 parameter is set to true, then this sequence is called em(*AS ROOT*)
3988 when the SMB password in the smbpasswd file is being changed, without
3989 access to the old password cleartext. In this case the old password
3990 cleartext is set to tt("") (the empty string).
3991
3992 See also link(bf("unix password sync"))(unixpasswordsync),
3993 link(bf("passwd program"))(passwdprogram) and link(bf("passwd chat
3994 debug"))(passwdchatdebug).
3995
3996   bf(Example:) 
3997 verb( passwd chat = "*Enter OLD password*" %o\n "*Enter NEW password*" %n\n \
3998                        "*Reenter NEW password*" %n\n "*Password changed*"
3999 )
4000
4001   bf(Default:)
4002 verb(       passwd chat = *old*password* %o\n *new*password* %n\n *new*password* %n\n *changed*)
4003
4004 label(passwdchatdebug)
4005 dit(bf(passwd chat debug (G)))
4006
4007 This boolean specifies if the passwd chat script parameter is run in
4008 tt("debug") mode. In this mode the strings passed to and received from
4009 the passwd chat are printed in the url(bf(smbd))(smbd.8.html) log with
4010 a link(bf("debug level"))(debuglevel) of 100. This is a dangerous
4011 option as it will allow plaintext passwords to be seen in the
4012 url(bf(smbd))(smbd.8.html) log. It is available to help Samba admins
4013 debug their link(bf("passwd chat"))(passwdchat) scripts when calling
4014 the link(bf("passwd program"))(passwdprogram) and should be turned off
4015 after this has been done. This parameter is off by default.
4016
4017 See also link(bf("passwd chat"))(passwdchat"), link(bf("passwd
4018 program"))(passwdprogram).
4019
4020   bf(Example:)
4021 tt(     passwd chat debug = True)
4022
4023   bf(Default:)
4024 tt(     passwd chat debug = False)
4025
4026 label(passwdprogram)
4027 dit(bf(passwd program (G)))
4028
4029 The name of a program that can be used to set UNIX user passwords.
4030 Any occurrences of link(bf(%u))(percentu) will be replaced with the
4031 user name. The user name is checked for existence before calling the
4032 password changing program.
4033
4034 Also note that many passwd programs insist in em("reasonable")
4035 passwords, such as a minimum length, or the inclusion of mixed case
4036 chars and digits. This can pose a problem as some clients (such as
4037 Windows for Workgroups) uppercase the password before sending it.
4038
4039 em(Note) that if the link(bf("unix password sync"))(unixpasswordsync)
4040 parameter is set to tt("True") then this program is called em(*AS
4041 ROOT*) before the SMB password in the
4042 url(bf(smbpasswd))(smbpasswd.5.html) file is changed. If this UNIX
4043 password change fails, then url(bf(smbd))(smbd.8.html) will fail to
4044 change the SMB password also (this is by design).
4045
4046 If the link(bf("unix password sync"))(unixpasswordsync) parameter is
4047 set this parameter em(MUST USE ABSOLUTE PATHS) for em(ALL) programs
4048 called, and must be examined for security implications. Note that by
4049 default link(bf("unix password sync"))(unixpasswordsync) is set to
4050 tt("False").
4051
4052 See also link(bf("unix password sync"))(unixpasswordsync).
4053
4054   bf(Default:)
4055 tt(     passwd program = /bin/passwd)
4056
4057   bf(Example:)
4058 tt(     passwd program = /sbin/passwd %u)
4059
4060 label(passwordlevel)
4061 dit(bf(password level (G)))
4062
4063 Some client/server combinations have difficulty with mixed-case
4064 passwords.  One offending client is Windows for Workgroups, which for
4065 some reason forces passwords to upper case when using the LANMAN1
4066 protocol, but leaves them alone when using COREPLUS!
4067
4068 This parameter defines the maximum number of characters that may be
4069 upper case in passwords.
4070
4071 For example, say the password given was tt("FRED"). If bf(password
4072 level) is set to 1, the following combinations would be tried if
4073 tt("FRED") failed:
4074
4075 tt("Fred"), tt("fred"), tt("fRed"), tt("frEd"), tt("freD")
4076
4077 If bf(password level) was set to 2, the following combinations would
4078 also be tried: 
4079
4080 tt("FRed"), tt("FrEd"), tt("FreD"), tt("fREd"), tt("fReD"),
4081 tt("frED"), tt(..)
4082
4083 And so on.
4084
4085 The higher value this parameter is set to the more likely it is that a
4086 mixed case password will be matched against a single case
4087 password. However, you should be aware that use of this parameter
4088 reduces security and increases the time taken to process a new
4089 connection.
4090
4091 A value of zero will cause only two attempts to be made - the password
4092 as is and the password in all-lower case.
4093
4094   bf(Default:)
4095 tt(     password level = 0)
4096
4097   bf(Example:)
4098 tt(     password level = 4)
4099
4100 label(passwordserver)
4101 dit(bf(password server (G)))
4102
4103 By specifying the name of another SMB server (such as a WinNT box)
4104 with this option, and using link(bf("security = domain"))(security) or
4105 link(bf("security = server"))(security) you can get Samba to do all
4106 its username/password validation via a remote server.
4107
4108 This options sets the name of the password server to use. It must be a
4109 NetBIOS name, so if the machine's NetBIOS name is different from its
4110 internet name then you may have to add its NetBIOS name to the lmhosts 
4111 file which is stored in the same directory as the bf(smb.conf) file.
4112
4113 The name of the password server is looked up using the parameter
4114 link(bf("name resolve order="))(nameresolveorder) and so may resolved
4115 by any method and order described in that parameter.
4116
4117 The password server much be a machine capable of using the "LM1.2X002"
4118 or the "LM NT 0.12" protocol, and it must be in user level security
4119 mode. 
4120
4121 NOTE: Using a password server means your UNIX box (running Samba) is
4122 only as secure as your password server. em(DO NOT CHOOSE A PASSWORD
4123 SERVER THAT YOU DON'T COMPLETELY TRUST).
4124
4125 Never point a Samba server at itself for password serving. This will
4126 cause a loop and could lock up your Samba server!
4127
4128 The name of the password server takes the standard substitutions, but
4129 probably the only useful one is link(bf(%m))(percentm), which means
4130 the Samba server will use the incoming client as the password
4131 server. If you use this then you better trust your clients, and you
4132 better restrict them with hosts allow!
4133
4134 If the link(bf("security"))(security) parameter is set to
4135 bf("domain"), then the list of machines in this option must be a list
4136 of Primary or Backup Domain controllers for the
4137 link(bf(Domain))(workgroup), as the Samba server is cryptographicly
4138 in that domain, and will use cryptographicly authenticated RPC calls
4139 to authenticate the user logging on. The advantage of using
4140 link(bf("security=domain"))(securityequaldomain) is that if you list
4141 several hosts in the bf("password server") option then
4142 url(bf(smbd))(smbd.8.html) will try each in turn till it finds one
4143 that responds. This is useful in case your primary server goes down.
4144
4145 If the link(bf("security"))(security) parameter is set to
4146 link(bf("server"))(securityequalserver), then there are different
4147 restrictions that link(bf("security=domain"))(securityequaldomain)
4148 doesn't suffer from:
4149
4150 startit()
4151
4152 it() You may list several password servers in the bf("password server")
4153 parameter, however if an url(bf(smbd))(smbd.8.html) makes a connection
4154 to a password server, and then the password server fails, no more
4155 users will be able to be authenticated from this
4156 url(bf(smbd))(smbd.8.html).  This is a restriction of the SMB/CIFS
4157 protocol when in link(bf("security=server"))(securityequalserver) mode
4158 and cannot be fixed in Samba.
4159
4160 it() If you are using a Windows NT server as your password server then
4161 you will have to ensure that your users are able to login from the
4162 Samba server, as when in
4163 link(bf("security=server"))(securityequalserver) mode the network
4164 logon will appear to come from there rather than from the users
4165 workstation.
4166
4167 endit()
4168
4169 See also the link(bf("security"))(security) parameter.
4170
4171   bf(Default:)
4172 tt(     password server = <empty string>)
4173
4174   bf(Example:)
4175 tt(     password server = NT-PDC, NT-BDC1, NT-BDC2)
4176
4177 label(path)
4178 dit(bf(path (S)))
4179
4180 This parameter specifies a directory to which the user of the service
4181 is to be given access. In the case of printable services, this is
4182 where print data will spool prior to being submitted to the host for
4183 printing.
4184
4185 For a printable service offering guest access, the service should be
4186 readonly and the path should be world-writeable and have the sticky bit
4187 set. This is not mandatory of course, but you probably won't get the
4188 results you expect if you do otherwise.
4189
4190 Any occurrences of link(bf(%u))(percentu) in the path will be replaced
4191 with the UNIX username that the client is using on this
4192 connection. Any occurrences of link(bf(%m))(percentm) will be replaced
4193 by the NetBIOS name of the machine they are connecting from. These
4194 replacements are very useful for setting up pseudo home directories
4195 for users.
4196
4197 Note that this path will be based on link(bf("root dir"))(rootdir) if
4198 one was specified.
4199
4200   bf(Default:)
4201 tt(     none)
4202
4203   bf(Example:)
4204 tt(     path = /home/fred)
4205
4206 label(postexec)
4207 dit(bf(postexec (S)))
4208
4209 This option specifies a command to be run whenever the service is
4210 disconnected. It takes the usual substitutions. The command may be run
4211 as the root on some systems.
4212
4213 An interesting example may be do unmount server resources:
4214
4215 tt(postexec = /etc/umount /cdrom)
4216
4217 See also link(bf(preexec))(preexec).
4218
4219   bf(Default:)
4220 tt(      none (no command executed))
4221
4222   bf(Example:)
4223 tt(      postexec = echo "%u disconnected from %S from %m (%I)" >> /tmp/log)
4224
4225 label(postscript)
4226 dit(bf(postscript (S)))
4227
4228 This parameter forces a printer to interpret the print files as
4229 postscript. This is done by adding a tt(%!) to the start of print output.
4230
4231 This is most useful when you have lots of PCs that persist in putting
4232 a control-D at the start of print jobs, which then confuses your
4233 printer.
4234
4235   bf(Default:)
4236 tt(     postscript = False)
4237
4238   bf(Example:)
4239 tt(     postscript = True)
4240
4241 label(preexec)
4242 dit(bf(preexec (S)))
4243
4244 This option specifies a command to be run whenever the service is
4245 connected to. It takes the usual substitutions.
4246
4247 An interesting example is to send the users a welcome message every
4248 time they log in. Maybe a message of the day? Here is an example:
4249
4250 verb(
4251         preexec = csh -c 'echo \"Welcome to %S!\" | \
4252                 /usr/local/samba/bin/smbclient -M %m -I %I' &
4253 )
4254
4255 Of course, this could get annoying after a while :-)
4256
4257 See also link(bf(postexec))(postexec).
4258
4259   bf(Default:)
4260 tt(     none (no command executed))
4261
4262   bf(Example:)
4263 tt(        preexec = echo \"%u connected to %S from %m (%I)\" >> /tmp/log)
4264
4265 label(preferredmaster)
4266 dit(bf(preferred master (G)))
4267
4268 This boolean parameter controls if url(bf(nmbd))(nmbd.8.html) is a
4269 preferred master browser for its workgroup.
4270
4271 If this is set to true, on startup, url(bf(nmbd))(nmbd.8.html) will
4272 force an election, and it will have a slight advantage in winning the
4273 election.  It is recommended that this parameter is used in
4274 conjunction with link(bf("domain master = yes"))(domainmaster), so
4275 that url(bf(nmbd))(nmbd.8.html) can guarantee becoming a domain
4276 master.
4277
4278 Use this option with caution, because if there are several hosts
4279 (whether Samba servers, Windows 95 or NT) that are preferred master
4280 browsers on the same subnet, they will each periodically and
4281 continuously attempt to become the local master browser.  This will
4282 result in unnecessary broadcast traffic and reduced browsing
4283 capabilities.
4284
4285 See also link(bf(os level))(oslevel).
4286
4287   bf(Default:)
4288 tt(     preferred master = no)
4289
4290   bf(Example:)
4291 tt(     preferred master = yes)
4292
4293 label(preferedmaster)
4294 dit(bf(prefered master (G)))
4295
4296 Synonym for link(bf("preferred master"))(preferredmaster) for people
4297 who cannot spell :-).
4298
4299 label(preload)
4300 dit(bf(preload))
4301 Synonym for link(bf("auto services"))(autoservices).
4302
4303 label(preservecase)
4304 dit(bf(preserve case (S)))
4305
4306 This controls if new filenames are created with the case that the
4307 client passes, or if they are forced to be the tt("default") case.
4308
4309   bf(Default:)
4310 tt(       preserve case = yes)
4311
4312 See the section on link(bf("NAME MANGLING"))(NAMEMANGLING) for a
4313 fuller discussion.
4314
4315 label(printcommand)
4316 dit(bf(print command (S)))
4317
4318 After a print job has finished spooling to a service, this command
4319 will be used via a tt(system()) call to process the spool
4320 file. Typically the command specified will submit the spool file to
4321 the host's printing subsystem, but there is no requirement that this
4322 be the case. The server will not remove the spool file, so whatever
4323 command you specify should remove the spool file when it has been
4324 processed, otherwise you will need to manually remove old spool files.
4325
4326 The print command is simply a text string. It will be used verbatim,
4327 with two exceptions: All occurrences of tt("%s") will be replaced by
4328 the appropriate spool file name, and all occurrences of tt("%p") will
4329 be replaced by the appropriate printer name. The spool file name is
4330 generated automatically by the server, the printer name is discussed
4331 below.
4332
4333 The full path name will be used for the filename if tt("%s") is not
4334 preceded by a tt('/'). If you don't like this (it can stuff up some
4335 lpq output) then use tt("%f") instead. Any occurrences of tt("%f") get
4336 replaced by the spool filename without the full path at the front.
4337
4338 The print command em(MUST) contain at least one occurrence of tt("%s")
4339 or tt("%f") - the tt("%p") is optional. At the time a job is
4340 submitted, if no printer name is supplied the tt("%p") will be
4341 silently removed from the printer command.
4342
4343 If specified in the link(bf("[global]"))(global) section, the print
4344 command given will be used for any printable service that does not
4345 have its own print command specified.
4346
4347 If there is neither a specified print command for a printable service
4348 nor a global print command, spool files will be created but not
4349 processed and (most importantly) not removed.
4350
4351 Note that printing may fail on some UNIXs from the tt("nobody")
4352 account. If this happens then create an alternative guest account that
4353 can print and set the link(bf("guest account"))(guestaccount) in the
4354 link(bf("[global]"))(global) section.
4355
4356 You can form quite complex print commands by realizing that they are
4357 just passed to a shell. For example the following will log a print
4358 job, print the file, then remove it. Note that tt(';') is the usual
4359 separator for command in shell scripts.
4360
4361 tt(print command = echo Printing %s >> /tmp/print.log; lpr -P %p %s; rm %s)
4362
4363 You may have to vary this command considerably depending on how you
4364 normally print files on your system. The default for the parameter
4365 varies depending on the setting of the link(bf("printing="))(printing)
4366 parameter.
4367
4368   bf(Default:)
4369         For link(bf("printing="))(printing) BSD, AIX, QNX, LPRNG or PLP :
4370 tt(     print command = lpr -r -P%p %s)
4371
4372         For link(bf("printing="))(printing) SYS or HPUX :
4373 tt(     print command = lp -c -d%p %s; rm %s)
4374
4375         For link(bf("printing="))(printing) SOFTQ :
4376 tt(     print command = lp -d%p -s %s; rm %s)
4377
4378   bf(Example:)
4379 tt(     print command = /usr/local/samba/bin/myprintscript %p %s)
4380
4381 label(printok)
4382 dit(bf(print ok (S)))
4383
4384 Synonym for link(bf(printable))(printable).
4385
4386 label(printable)
4387 dit(bf(printable (S)))
4388
4389 If this parameter is tt("yes"), then clients may open, write to and
4390 submit spool files on the directory specified for the service.
4391
4392 Note that a printable service will ALWAYS allow writing to the service
4393 path (user privileges permitting) via the spooling of print data. The
4394 link(bf("read only"))(readonly) parameter controls only non-printing
4395 access to the resource.
4396
4397   bf(Default:)
4398 tt(     printable = no)
4399
4400   bf(Example:)
4401 tt(     printable = yes)
4402
4403 label(printcap)
4404 dit(bf(printcap (G)))
4405
4406 Synonym for link(bf(printcapname))(printcapname).
4407
4408 label(printcapname)
4409 dit(bf(printcap name (G)))
4410
4411 This parameter may be used to override the compiled-in default
4412 printcap name used by the server (usually /etc/printcap). See the
4413 discussion of the link(bf([printers]))(printers) section above for
4414 reasons why you might want to do this.
4415
4416 On System V systems that use bf(lpstat) to list available printers you
4417 can use tt("printcap name = lpstat") to automatically obtain lists of
4418 available printers. This is the default for systems that define SYSV
4419 at configure time in Samba (this includes most System V based
4420 systems). If bf("printcap name") is set to bf(lpstat) on these systems
4421 then Samba will launch tt("lpstat -v") and attempt to parse the output
4422 to obtain a printer list.
4423
4424 A minimal printcap file would look something like this:
4425
4426 verb(
4427         print1|My Printer 1
4428         print2|My Printer 2
4429         print3|My Printer 3
4430         print4|My Printer 4
4431         print5|My Printer 5
4432 )
4433
4434 where the tt('|') separates aliases of a printer. The fact that the
4435 second alias has a space in it gives a hint to Samba that it's a
4436 comment.
4437
4438 em(NOTE): Under AIX the default printcap name is
4439 tt("/etc/qconfig"). Samba will assume the file is in AIX tt("qconfig")
4440 format if the string tt("/qconfig") appears in the printcap filename.
4441
4442   bf(Default:)
4443 tt(     printcap name = /etc/printcap)
4444
4445   bf(Example:)
4446 tt(     printcap name = /etc/myprintcap)
4447
4448 label(printer)
4449 dit(bf(printer (S)))
4450
4451 This parameter specifies the name of the printer to which print jobs
4452 spooled through a printable service will be sent.
4453
4454 If specified in the link(bf([global]))(global) section, the printer
4455 name given will be used for any printable service that does not have
4456 its own printer name specified.
4457
4458   bf(Default:)
4459         none (but may be tt("lp") on many systems)
4460
4461   bf(Example:)
4462         printer name = laserwriter
4463
4464 label(printerdriver)
4465 dit(bf(printer driver (S)))
4466
4467 This option allows you to control the string that clients receive when
4468 they ask the server for the printer driver associated with a
4469 printer. If you are using Windows95 or WindowsNT then you can use this
4470 to automate the setup of printers on your system.
4471
4472 You need to set this parameter to the exact string (case sensitive)
4473 that describes the appropriate printer driver for your system. If you
4474 don't know the exact string to use then you should first try with no
4475 bf("printer driver") option set and the client will give you a list of
4476 printer drivers. The appropriate strings are shown in a scrollbox
4477 after you have chosen the printer manufacturer.
4478
4479 See also link(bf("printer driver file"))(printerdriverfile).
4480
4481   bf(Example:)
4482         printer driver = HP LaserJet 4L
4483
4484 label(printerdriverfile)
4485 dit(bf(printer driver file (G)))
4486
4487 This parameter tells Samba where the printer driver definition file,
4488 used when serving drivers to Windows 95 clients, is to be found. If
4489 this is not set, the default is :
4490
4491 tt(SAMBA_INSTALL_DIRECTORY/lib/printers.def)
4492
4493 This file is created from Windows 95 tt("msprint.def") files found on
4494 the Windows 95 client system. For more details on setting up serving
4495 of printer drivers to Windows 95 clients, see the documentation file
4496 in the docs/ directory, PRINTER_DRIVER.txt.
4497
4498   bf(Default:)
4499 tt(     None (set in compile).)
4500
4501   bf(Example:)
4502 tt(     printer driver file = /usr/local/samba/printers/drivers.def)
4503
4504 See also link(bf("printer driver location"))(printerdriverlocation).
4505
4506 label(printerdriverlocation)
4507 dit(bf(printer driver location (S)))
4508
4509 This parameter tells clients of a particular printer share where to
4510 find the printer driver files for the automatic installation of
4511 drivers for Windows 95 machines. If Samba is set up to serve printer
4512 drivers to Windows 95 machines, this should be set to
4513
4514 tt(\\MACHINE\aPRINTER$)
4515
4516 Where MACHINE is the NetBIOS name of your Samba server, and PRINTER$
4517 is a share you set up for serving printer driver files. For more
4518 details on setting this up see the documentation file in the docs/
4519 directory, PRINTER_DRIVER.txt.
4520
4521   bf(Default:)
4522 tt(     None)
4523
4524   bf(Example:)
4525 tt(     printer driver location = \\MACHINE\PRINTER$)
4526
4527 See also link(bf("printer driver file"))(printerdriverfile).
4528
4529 label(printername)
4530 dit(bf(printer name (S)))
4531
4532 Synonym for link(bf(printer))(printer).
4533
4534 label(printing)
4535 dit(bf(printing (S)))
4536
4537 This parameters controls how printer status information is interpreted
4538 on your system, and also affects the default values for the
4539 link(bf("print command"))(printcommand), link(bf("lpq
4540 command"))(lpqcommand) link(bf("lppause command"))(lppausecommand),
4541 link(bf("lpresume command"))(lpresumecommand), and link(bf("lprm
4542 command"))(lprmcommand).
4543
4544 Currently eight printing styles are supported. They are
4545 bf("printing=BSD"), bf("printing=AIX"), bf("printing=LPRNG"),
4546 bf("printing=PLP"),
4547 bf("printing=SYSV"),bf("printing="HPUX"),bf("printing=QNX") and
4548 bf("printing=SOFTQ").
4549
4550 To see what the defaults are for the other print commands when using
4551 these three options use the url(bf("testparm"))(testparm) program.
4552
4553 This option can be set on a per printer basis
4554
4555 See also the discussion in the link(bf([printers]))(printers) section.
4556
4557 label(protocol)
4558 dit(bf(protocol (G)))
4559
4560 The value of the parameter (a string) is the highest protocol level
4561 that will be supported by the server.
4562
4563 Possible values are :
4564
4565 startit()
4566
4567 it() CORE: Earliest version. No concept of user names.
4568
4569 it() COREPLUS: Slight improvements on CORE for efficiency.
4570
4571 it() LANMAN1: First em("modern") version of the protocol. Long
4572 filename support.
4573
4574 it() LANMAN2: Updates to Lanman1 protocol.
4575
4576 it() NT1: Current up to date version of the protocol. Used by Windows
4577 NT. Known as CIFS.
4578
4579 endit()
4580
4581 Normally this option should not be set as the automatic negotiation
4582 phase in the SMB protocol takes care of choosing the appropriate
4583 protocol.
4584
4585   bf(Default:)
4586 tt(     protocol = NT1)
4587
4588   bf(Example:)
4589 tt(     protocol = LANMAN1)
4590
4591 label(public)
4592 dit(bf(public (S)))
4593
4594 Synonym for link(bf("guest ok"))(guestok).
4595
4596 label(queuepausecommand)
4597 dit(bf(queuepause command (S)))
4598
4599 This parameter specifies the command to be executed on the server host
4600 in order to pause the printerqueue.
4601
4602 This command should be a program or script which takes a printer name
4603 as its only parameter and stops the printerqueue, such that no longer
4604 jobs are submitted to the printer.
4605
4606 This command is not supported by Windows for Workgroups, but can be
4607 issued from the Printer's window under Windows 95 & NT.
4608
4609 If a tt("%p") is given then the printername is put in its
4610 place. Otherwise it is placed at the end of the command.
4611
4612 Note that it is good practice to include the absolute path in the
4613 command as the PATH may not be available to the server.
4614
4615   bf(Default:)
4616 tt(        depends on the setting of "printing =")
4617
4618   bf(Example:)
4619 tt(      queuepause command = disable %p)
4620
4621 label(queueresumecommand)
4622 dit(bf(queueresume command (S)))
4623
4624 This parameter specifies the command to be executed on the server host
4625 in order to resume the printerqueue. It is the command to undo the
4626 behavior that is caused by the previous parameter
4627 (link(bf("queuepause command))(queuepausecommand)).
4628  
4629 This command should be a program or script which takes a printer name
4630 as its only parameter and resumes the printerqueue, such that queued
4631 jobs are resubmitted to the printer.
4632
4633 This command is not supported by Windows for Workgroups, but can be
4634 issued from the Printer's window under Windows 95 & NT.
4635
4636 If a tt("%p") is given then the printername is put in its
4637 place. Otherwise it is placed at the end of the command.
4638
4639 Note that it is good practice to include the absolute path in the
4640 command as the PATH may not be available to the server.
4641