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