2d2470855fb159f74d186613fbcee0579d49be99
[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))
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 .SS create mode (S)
1449 See
1450 .B create mask.
1451
1452 .SS deadtime (G)
1453 The value of the parameter (a decimal integer) represents the number of
1454 minutes of inactivity before a connection is considered dead, and it
1455 is disconnected. The deadtime only takes effect if the number of open files
1456 is zero.
1457
1458 This is useful to stop a server's resources being exhausted by a large
1459 number of inactive connections.
1460
1461 Most clients have an auto-reconnect feature when a connection is broken so
1462 in most cases this parameter should be transparent to users.
1463
1464 Using this parameter with a timeout of a few minutes is recommended
1465 for most systems.
1466
1467 A deadtime of zero indicates that no auto-disconnection should be performed.
1468
1469 .B Default:
1470         deadtime = 0
1471
1472 .B Example:
1473         deadtime = 15
1474 .SS debug level (G)
1475 The value of the parameter (an integer) allows the debug level
1476 (logging level) to be specified in the
1477 .B smb.conf
1478 file. This is to give
1479 greater flexibility in the configuration of the system.
1480
1481 The default will be the debug level specified on the command line.
1482
1483 .B Example:
1484         debug level = 3
1485 .SS default (G)
1486 See
1487 .B default service.
1488 .SS default case (S)
1489
1490 See the section on "NAME MANGLING" Also note the addition of "short
1491 preserve case"
1492
1493 .SS default service (G)
1494 A synonym for this parameter is 'default'.
1495
1496 This parameter specifies the name of a service which will be connected to
1497 if the service actually requested cannot be found. Note that the square
1498 brackets are NOT given in the parameter value (see example below).
1499
1500 There is no default value for this parameter. If this parameter is not given,
1501 attempting to connect to a nonexistent service results in an error.
1502
1503 Typically the default service would be a public, read-only service.
1504
1505 Also note that as of 1.9.14 the apparent service name will be changed to
1506 equal that of the requested service, this is very useful as it allows
1507 you to use macros like %S to make a wildcard service.
1508
1509 Note also that any _ characters in the name of the service used in the
1510 default service will get mapped to a /. This allows for interesting
1511 things.
1512
1513
1514 .B Example:
1515         default service = pub
1516         
1517         [pub]
1518              path = /%S
1519           
1520
1521 .SS delete readonly (S)
1522 This parameter allows readonly files to be deleted.  This is not normal DOS
1523 semantics, but is allowed by UNIX.
1524
1525 This option may be useful for running applications such as rcs, where UNIX
1526 file ownership prevents changing file permissions, and DOS semantics prevent
1527 deletion of a read only file.
1528
1529 .B Default:
1530         delete readonly = No
1531
1532 .B Example:
1533         delete readonly = Yes
1534 .SS deny hosts (S)
1535 A synonym for this parameter is 'hosts deny'.
1536
1537 The opposite of 'allow hosts' - hosts listed here are NOT permitted
1538 access to services unless the specific services have their own lists to
1539 override this one. Where the lists conflict, the 'allow' list takes precedence.
1540
1541 .B Default:
1542         none (i.e., no hosts specifically excluded)
1543
1544 .B Example:
1545         deny hosts = 150.203.4. badhost.mynet.edu.au
1546
1547 .SS delete veto files (S)
1548
1549 This option is used when Samba is attempting to delete a directory
1550 that contains one or more vetoed directories (see the 'veto files' option).
1551 If this option is set to False (the default) then if a vetoed directory
1552 contains any non-vetoed files or directories then the directory delete 
1553 will fail. This is usually what you want. 
1554
1555 If this option is set to True, then Samba will attempt
1556 to recursively delete any files and directories within the vetoed
1557 directory. This can be useful for integration with file serving
1558 systems such as Netatalk, which create meta-files within directories
1559 you might normally veto DOS/Windows users from seeing (eg. .AppleDouble)
1560
1561 Setting 'delete veto files = True' allows these directories to be 
1562 transparently deleted when the parent directory is deleted (so long
1563 as the user has permissions to do so).
1564
1565 .B Default:
1566     delete veto files = False
1567
1568 .B Example:
1569     delete veto files = True
1570
1571 See
1572 .B veto files
1573
1574 .SS dfree command (G)
1575 The dfree command setting should only be used on systems where a
1576 problem occurs with the internal disk space calculations. This has
1577 been known to happen with Ultrix, but may occur with other operating
1578 systems. The symptom that was seen was an error of "Abort Retry
1579 Ignore" at the end of each directory listing.
1580
1581 This setting allows the replacement of the internal routines to
1582 calculate the total disk space and amount available with an external
1583 routine. The example below gives a possible script that might fulfill
1584 this function. 
1585
1586 The external program will be passed a single parameter indicating a
1587 directory in the filesystem being queried. This will typically consist
1588 of the string "./". The script should return two integers in ascii. The
1589 first should be the total disk space in blocks, and the second should
1590 be the number of available blocks. An optional third return value
1591 can give the block size in bytes. The default blocksize is 1024 bytes.
1592
1593 Note: Your script should NOT be setuid or setgid and should be owned by
1594 (and writable only by) root!
1595
1596 .B Default:
1597         By default internal routines for determining the disk capacity
1598 and remaining space will be used.
1599
1600 .B Example:
1601         dfree command = /usr/local/samba/bin/dfree
1602
1603         Where the script dfree (which must be made executable) could be
1604
1605 .nf
1606         #!/bin/sh
1607         df $1 | tail -1 | awk '{print $2" "$4}'
1608 .fi
1609
1610         or perhaps (on Sys V)
1611
1612 .nf
1613         #!/bin/sh
1614         /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
1615 .fi
1616
1617         Note that you may have to replace the command names with full
1618 path names on some systems.
1619 .SS directory (S)
1620 See
1621 .B path.
1622
1623 .SS directory mask (S)
1624 A synonym for this parameter is 'directory mode'.
1625
1626 This parameter is the octal modes which are used when converting DOS modes 
1627 to UNIX modes when creating UNIX directories.
1628
1629 When a directory is created, the neccessary permissions are calculated
1630 according to the mapping from DOS modes to UNIX permissions, and
1631 the resulting UNIX mode is then bit-wise 'AND'ed with this parameter.
1632 This parameter may be thought of as a bit-wise MASK for the UNIX
1633 modes of a directory. Any bit *not* set here will be removed from the
1634 modes set on a directory when it is created.
1635
1636 The default value of this parameter removes the 'group' and 'other'
1637 write bits from the UNIX mode, allowing only the user who owns the
1638 directory to modify it.
1639
1640 Following this Samba will bit-wise 'OR' the UNIX mode created from
1641 this parameter with the value of the "force directory mode" parameter. 
1642 This parameter is set to 000 by default (ie. no extra mode bits are added).
1643
1644 See the "force directory mode" parameter to cause particular mode
1645 bits to always be set on created directories.
1646
1647 See also the "create mode" parameter for masking mode bits on created
1648 files.
1649
1650 .B Default:
1651         directory mask = 0755
1652
1653 .B Example:
1654         directory mask = 0775
1655
1656 .SS directory mode (S)
1657 See
1658 .B directory mask.
1659
1660 .SS dns proxy (G)
1661
1662 Specifies that nmbd should (as a WINS server), on finding that a NetBIOS
1663 name has not been registered, treat the NetBIOS name word-for-word as
1664 a DNS name.
1665
1666 Note that the maximum length for a NetBIOS name is 15
1667 characters, so the DNS name (or DNS alias) can likewise only be 15
1668 characters, maximum.
1669
1670 Note also that nmbd will block completely until the DNS name is resolved.
1671 This will result in temporary loss of browsing and WINS services.
1672 Enable this option only if you are certain that DNS resolution is fast,
1673 or you can live with the consequences of periodic pauses in nmbd service.
1674
1675 .B Default:
1676          dns proxy = yes
1677
1678 .SS domain controller (G)
1679
1680 The meaning of this parameter changed from a string to a boolean (yes/no)
1681 value. It is currently not used within the Samba source and should be removed
1682 from all current smb.conf files. It is left behind for compatibility reasons.
1683
1684 .B Default:
1685          domain controller = no
1686
1687 .SS domain logons (G)
1688
1689 If set to true, the Samba server will serve Windows 95 domain logons
1690 for the workgroup it is in. For more details on setting up this feature
1691 see the file DOMAINS.txt in the Samba source documentation directory.
1692
1693 .B Default:
1694          domain logons = no
1695
1696 .SS domain master (G)
1697
1698 Enable WAN-wide browse list collation.  Local master browsers on 
1699 broadcast-isolated subnets will give samba their local browse lists, and 
1700 ask for a complete copy of the browse list for the whole wide area network.
1701 Browser clients will then contact their local master browser, and will
1702 receive the domain-wide browse list, instead of just the list for their
1703 broadcast-isolated subnet.
1704
1705 .B Default:
1706         domain master = no
1707
1708 .SS dont descend (S)
1709 There are certain directories on some systems (eg., the /proc tree under
1710 Linux) that are either not of interest to clients or are infinitely deep
1711 (recursive). This parameter allows you to specify a comma-delimited list
1712 of directories that the server should always show as empty.
1713
1714 Note that Samba can be very fussy about the exact format of the "dont
1715 descend" entries. For example you may need "./proc" instead of just
1716 "/proc". Experimentation is the best policy :-)
1717
1718 .B Default:
1719         none (i.e., all directories are OK to descend)
1720
1721 .B Example:
1722         dont descend = /proc,/dev
1723
1724 .SS dos filetimes (S)
1725 Under DOS and Windows, if a user can write to a file they can change
1726 the timestamp on it. Under POSIX semantics, only the owner of the file
1727 or root may change the timestamp. By default, Samba runs with POSIX
1728 semantics and refuses to change the timestamp on a file if the user
1729 smbd is acting on behalf of is not the file owner. Setting this option
1730 to True allows DOS semantics and smbd will change the file timstamp as 
1731 DOS requires. This is a correct implementation of a previous compile-time
1732 options (UTIME_WORKAROUND) which was broken and is now removed.
1733
1734 .B Default:
1735         dos filetimes = False
1736
1737 .B Example:
1738         dos filetimes = True
1739
1740 .SS dos filetime resolution (S)
1741 Under the DOS and Windows FAT filesystem, the finest granulatity on
1742 time resolution is two seconds. Setting this parameter for a share
1743 causes Samba to round the reported time down to the nearest two
1744 second boundary when a query call that requires one second resolution
1745 is made to smbd. 
1746
1747 This option is mainly used as a compatibility option for Visual C++ 
1748 when used against Samba shares. If oplocks are enabled on a share,
1749 Visual C++ uses two different time reading calls to check if a file 
1750 has changed since it was last read. One of these calls uses a one-second 
1751 granularity, the other uses a two second granularity. As the two second 
1752 call rounds any odd second down, then if the file has a timestamp of an 
1753 odd number of seconds then the two timestamps will not match and Visual 
1754 C++ will keep reporting the file has changed. Setting this option causes 
1755 the two timestamps to match, and Visual C++ is happy.
1756
1757 .B Default:
1758         dos filetime resolution = False
1759
1760 .B Example:
1761         dos filetime resolution = True
1762
1763 .SS encrypt passwords (G)
1764
1765 This boolean controls whether encrypted passwords will be negotiated
1766 with the client. Note that Windows NT 4.0 SP3 and above will by default
1767 expect encrypted passwords unless a registry entry is changed. To use
1768 encrypted passwords in Samba see the file docs/ENCRYPTION.txt.
1769
1770 .SS exec (S)
1771
1772 This is an alias for preexec
1773
1774 .SS fake directory create times (S)
1775 NTFS and Windows VFAT file systems keep a create time for all files
1776 and directories. This is not the same as the ctime - status change
1777 time - that Unix keeps, so Samba by default reports the earliest
1778 of the various times Unix does keep. Setting this parameter for a
1779 share causes Samba to always report midnight 1-1-1980 as
1780 the create time for directories.
1781
1782 This option is mainly used as a compatibility option for Visual C++ 
1783 when used against Samba shares. Visual C++ generated makefiles
1784 have the object directory as a dependency for each object file,
1785 and a make rule to create the directory. Also, when NMAKE
1786 compares timestamps it uses the creation time when examining
1787 a directory. Thus the object directory will be created if it does
1788 not exist, but once it does exist it will always have an earlier
1789 timestamp than the object files it contains.
1790
1791 However, Unix time semantics mean that the create time reported
1792 by Samba will be updated whenever a file is created or deleted
1793 in the directory. NMAKE therefore finds all object files in the
1794 object directory bar the last one built are out of date compared
1795 to the directory and rebuilds them. Enabling this option ensures
1796 directories always predate their contents and an NMAKE build will
1797 proceed as expected.
1798
1799 .B Default:
1800         fake directory create times = False
1801
1802 .B Example:
1803         fake directory create times = True
1804
1805 .SS fake oplocks (S)
1806
1807 Oplocks are the way that SMB clients get permission from a server to
1808 locally cache file operations. If a server grants an oplock
1809 (opportunistic lock) then the client is free to assume that it is the
1810 only one accessing the file and it will aggressively cache file
1811 data. With some oplock types the client may even cache file open/close
1812 operations. This can give enormous performance benefits.
1813
1814 When you set "fake oplocks = yes" Samba will always grant oplock
1815 requests no matter how many clients are using the file. 
1816
1817 By enabling this option on all read-only shares or shares that you know
1818 will only be accessed from one client at a time you will see a big
1819 performance improvement on many operations. If you enable this option
1820 on shares where multiple clients may be accessing the files read-write
1821 at the same time you can get data corruption. Use this option
1822 carefully! 
1823
1824 It is generally much better to use the real oplock support except for
1825 physically read-only media such as CDROMs.
1826
1827 This option is disabled by default.
1828
1829 .SS follow symlinks (S)
1830
1831 This parameter allows the Samba administrator to stop smbd from
1832 following symbolic links in a particular share. Setting this
1833 parameter to "No" prevents any file or directory that is a 
1834 symbolic link from being followed (the user will get an error).
1835 This option is very useful to stop users from adding a symbolic
1836 link to /etc/pasword in their home directory for instance.
1837 However it will slow filename lookups down slightly.
1838
1839 This option is enabled (ie. smbd will follow symbolic links)
1840 by default.
1841
1842 .SS force create mode (S)
1843 This parameter specifies a set of UNIX mode bit permissions that
1844 will *always* be set on a file created by Samba. This is done
1845 by bitwise 'OR'ing these bits onto the mode bits of a file that
1846 is being created. The default for this parameter is (in octel)
1847 000. The modes in this parameter are bitwise 'OR'ed onto the
1848 file mode after the mask set in the "create mask" parameter
1849 is applied.
1850
1851 See also the parameter "create mask" for details on masking mode
1852 bits on created files.
1853
1854 .B Default:
1855        force create mode = 000
1856
1857 .B Example:
1858        force create mode = 0755
1859
1860 would force all created files to have read and execute permissions
1861 set for 'group' and 'other' as well as the read/write/execute bits 
1862 set for the 'user'.
1863
1864 .SS force directory mode (S)
1865 This parameter specifies a set of UNIX mode bit permissions that
1866 will *always* be set on a directory created by Samba. This is done
1867 by bitwise 'OR'ing these bits onto the mode bits of a directory that
1868 is being created. The default for this parameter is (in octel)
1869 0000 which will not add any extra permission bits to a created
1870 directory. This operation is done after the mode mask in the parameter 
1871 "directory mask" is applied.
1872
1873 See also the parameter "directory mask" for details on masking mode
1874 bits on created directories.
1875
1876 .B Default:
1877        force directory mode = 000
1878
1879 .B Example:
1880        force directory mode = 0755
1881
1882 would force all created directories to have read and execute permissions
1883 set for 'group' and 'other' as well as the read/write/execute bits 
1884 set for the 'user'.
1885
1886 .SS force group (S)
1887 This specifies a group name that all connections to this service
1888 should be made as. This may be useful for sharing files.
1889
1890 .B Default:
1891        no forced group
1892
1893 .B Example:
1894        force group = agroup
1895
1896 .SS force user (S)
1897 This specifies a user name that all connections to this service
1898 should be made as. This may be useful for sharing files. You should
1899 also use it carefully as using it incorrectly can cause security
1900 problems.
1901
1902 This user name only gets used once a connection is established. Thus
1903 clients still need to connect as a valid user and supply a valid
1904 password. Once connected, all file operations will be performed as the
1905 "forced user", not matter what username the client connected as.
1906
1907 .B Default:
1908        no forced user
1909
1910 .B Example:
1911        force user = auser
1912
1913 .SS getwd cache (G)
1914 This is a tuning option. When this is enabled a cacheing algorithm will
1915 be used to reduce the time taken for getwd() calls. This can have a
1916 significant impact on performance, especially when widelinks is False.
1917
1918 .B Default:
1919         getwd cache = No
1920
1921 .B Example:
1922         getwd cache = Yes
1923
1924 .SS group (S)
1925 This is an alias for "force group" and is only kept for compatibility
1926 with old versions of Samba. It may be removed in future versions.
1927
1928 .SS guest account (S)
1929 This is a username which will be used for access to services which are
1930 specified as 'guest ok' (see below). Whatever privileges this user has
1931 will be available to any client connecting to the guest
1932 service. Typically this user will exist in the password file, but will
1933 not have a valid login. If a username is specified in a given service,
1934 the specified username overrides this one.
1935
1936 One some systems the account "nobody" may not be able to print. Use
1937 another account in this case. You should test this by trying to log in
1938 as your guest user (perhaps by using the "su \-" command) and trying to
1939 print using
1940 .BR lpr .
1941
1942 Note that as of version 1.9 of Samba this option may be set
1943 differently for each service.
1944
1945 .B Default:
1946         specified at compile time
1947
1948 .B Example:
1949         guest account = nobody
1950 .SS guest ok (S)
1951 See
1952 .B public.
1953 .SS guest only (S)
1954 If this parameter is 'yes' for a service, then only guest connections to the
1955 service are permitted. This parameter will have no affect if "guest ok" or
1956 "public" is not set for the service.
1957
1958 See the section below on user/password validation for more information about
1959 this option.
1960
1961 .B Default:
1962         guest only = no
1963
1964 .B Example:
1965         guest only = yes
1966 .SS hide dot files (S)
1967 This is a boolean parameter that controls whether files starting with
1968 a dot appear as hidden files.
1969
1970 .B Default:
1971         hide dot files = yes
1972
1973 .B Example:
1974         hide dot files = no
1975
1976
1977 .SS hide files(S)
1978 This is a list of files or directories that are not visible but are
1979 accessible.  The DOS 'hidden' attribute is applied to any files or
1980 directories that match.
1981
1982 Each entry in the list must be separated by a "/", which allows spaces
1983 to be included in the entry.  '*' and '?' can be used to specify multiple 
1984 files or directories as in DOS wildcards.
1985
1986 Each entry must be a unix path, not a DOS path and must not include the 
1987 unix directory separator "/".
1988
1989 Note that the case sensitivity option is applicable in hiding files.
1990
1991 Setting this parameter will affect the performance of Samba, as
1992 it will be forced to check all files and directories for a match
1993 as they are scanned.
1994
1995 See also "hide dot files", "veto files" and "case sensitive"
1996
1997 .B Default
1998         No files or directories are hidden by this option (dot files are
1999     hidden by default because of the "hide dot files" option).
2000
2001 .B Example
2002         hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
2003
2004 The above example is based on files that the Macintosh client (DAVE)
2005 creates for internal use, and also still hides all files beginning with
2006 a dot.
2007
2008 .SS homedir map (G)
2009 If "nis homedir" is true, this parameter specifies the NIS (or YP) map
2010 from which the server for the user's home directory should be extracted.
2011 At present, only the Sun auto.home map format is understood. The form of
2012 the map is:
2013
2014 username        server:/some/file/system
2015
2016 and the program will extract the servername from before the first ':'.
2017 There should probably be a better parsing system that copes with different
2018 map formats and also Amd (another automounter) maps.
2019
2020 NB: The -DNETGROUP option is required in the Makefile for option to work
2021 and on some architectures the line -lrpcsvc needs to be added to the
2022 LIBSM variable. This is required for Solaris 2, FreeBSD and HPUX.
2023
2024 See also "nis homedir"
2025
2026 .B Default:
2027         homedir map = auto.home
2028
2029 .B Example:
2030         homedir map = amd.homedir
2031 .SS hosts allow (S)
2032 See
2033 .B allow hosts.
2034 .SS hosts deny (S)
2035 See
2036 .B deny hosts.
2037
2038 .SS hosts equiv (G)
2039 If this global parameter is a non-null string, it specifies the name of
2040 a file to read for the names of hosts and users who will be allowed access
2041 without specifying a password.
2042
2043 This is not be confused with 
2044 .B allow hosts
2045 which is about hosts access to services and is more useful for guest services.
2046 .B hosts equiv
2047 may be useful for NT clients which will not supply passwords to samba.
2048
2049 NOTE: The use of hosts.equiv can be a major security hole. This is
2050 because you are trusting the PC to supply the correct username. It is
2051 very easy to get a PC to supply a false username. I recommend that the
2052 hosts.equiv option be only used if you really know what you are doing,
2053 or perhaps on a home network where you trust your wife and kids :-)
2054
2055 .B Default
2056         No host equivalences
2057
2058 .B Example
2059         hosts equiv = /etc/hosts.equiv
2060
2061 .SS include (G)
2062
2063 This allows you to include one config file inside another.  The file is
2064 included literally, as though typed in place.
2065
2066 It takes the standard substitutions, except %u, %P and %S
2067
2068 .SS interfaces (G)
2069
2070 This option allows you to setup multiple network interfaces, so that
2071 Samba can properly handle browsing on all interfaces.
2072
2073 The option takes a list of ip/netmask pairs. The netmask may either be
2074 a bitmask, or a bitlength. 
2075
2076 For example, the following line:
2077
2078 interfaces = 192.168.2.10/24 192.168.3.10/24
2079
2080 would configure two network interfaces with IP addresses 192.168.2.10
2081 and 192.168.3.10. The netmasks of both interfaces would be set to
2082 255.255.255.0. 
2083
2084 You could produce an equivalent result by using:
2085
2086 interfaces = 192.168.2.10/255.255.255.0 192.168.3.10/255.255.255.0
2087
2088 if you prefer that format.
2089
2090 If this option is not set then Samba will attempt to find a primary
2091 interface, but won't attempt to configure more than one interface.
2092
2093 .SS invalid users (S)
2094 This is a list of users that should not be allowed to login to this
2095 service. This is really a "paranoid" check to absolutely ensure an
2096 improper setting does not breach your security.
2097
2098 A name starting with @ is interpreted as a yp netgroup first (if this
2099 has been compiled into Samba), and then as a UNIX group if the name
2100 was not found in the yp netgroup database.
2101
2102 A name starting with + is interpreted only by looking in the UNIX
2103 group database. A name starting with & is interpreted only by looking
2104 in the yp netgroup database (this has no effect if Samba is compiled
2105 without netgroup support).
2106
2107 The current servicename is substituted for %S. This is useful in the
2108 [homes] section.
2109
2110 See also "valid users"
2111
2112 .B Default
2113         No invalid users
2114
2115 .B Example
2116         invalid users = root fred admin @wheel
2117
2118 .SS keepalive (G)
2119 The value of the parameter (an integer) represents the number of seconds 
2120 between 'keepalive' packets. If this parameter is zero, no keepalive packets
2121 will be sent. Keepalive packets, if sent, allow the server to tell whether a
2122 client is still present and responding.
2123
2124 Keepalives should, in general, not be needed if the socket being used
2125 has the SO_KEEPALIVE attribute set on it (see "socket
2126 options"). Basically you should only use this option if you strike
2127 difficulties.
2128
2129 .B Default:
2130         keep alive = 0
2131
2132 .B Example:
2133         keep alive = 60
2134
2135 .SS lm announce (G)
2136
2137 This parameter determines if Samba will produce Lanman announce
2138 broadcasts that are needed by OS/2 clients in order for them to
2139 see the Samba server in their browse list. This parameter can
2140 have three values, true, false, or auto. The default is auto.
2141 If set to False Samba will never produce these broadcasts. If
2142 set to true Samba will produce Lanman announce broadcasts at
2143 a frequency set by the parameter 'lm interval'. If set to auto
2144 Samba will not send Lanman announce broadcasts by default but
2145 will listen for them. If it hears such a broadcast on the wire
2146 it will then start sending them at a frequency set by the parameter 
2147 'lm interval'.
2148
2149 See also "lm interval".
2150
2151 .B Default:
2152        lm announce = auto
2153
2154 .B Example:
2155        lm announce = true
2156
2157 .SS lm interval (G)
2158
2159 If Samba is set to produce Lanman announce broadcasts needed
2160 by OS/2 clients (see the "lm announce" parameter) this parameter
2161 defines the frequency in seconds with which they will be made.
2162 If this is set to zero then no Lanman announcements will be
2163 made despite the setting of the "lm announce" parameter.
2164
2165 See also "lm announce".
2166
2167 .B Default:
2168         lm interval = 60
2169
2170 .B Example:
2171         lm interval = 120
2172
2173 .SS load printers (G)
2174 A boolean variable that controls whether all printers in the printcap
2175 will be loaded for browsing by default. 
2176
2177 .B Default:
2178         load printers = yes
2179
2180 .B Example:
2181         load printers = no
2182
2183 .SS local master (G)
2184 This option allows the nmbd to become a local master browser on a
2185 subnet. If set to False then nmbd will not attempt to become a local
2186 master browser on a subnet and will also lose in all browsing elections. 
2187 By default this value is set to true. Setting this value to true doesn't 
2188 mean that Samba will become the local master browser on a subnet, just 
2189 that the nmbd will participate in elections for local master browser.
2190
2191 .B Default:
2192         local master = yes
2193
2194 .SS lock directory (G)
2195 This option specifies the directory where lock files will be placed.
2196 The lock files are used to implement the "max connections" option.
2197
2198 .B Default:
2199         lock directory = /tmp/samba
2200
2201 .B Example: 
2202         lock directory = /usr/local/samba/var/locks
2203
2204 .SS locking (S)
2205 This controls whether or not locking will be performed by the server in 
2206 response to lock requests from the client.
2207
2208 If "locking = no", all lock and unlock requests will appear to succeed and 
2209 all lock queries will indicate that the queried lock is clear.
2210
2211 If "locking = yes", real locking will be performed by the server.
2212
2213 This option may be particularly useful for read-only filesystems which
2214 do not need locking (such as cdrom drives).
2215
2216 Be careful about disabling locking either globally or in a specific
2217 service, as lack of locking may result in data corruption.
2218
2219 .B Default:
2220         locking = yes
2221
2222 .B Example:
2223         locking = no
2224
2225 .SS log file (G)
2226
2227 This options allows you to override the name of the Samba log file
2228 (also known as the debug file).
2229
2230 This option takes the standard substitutions, allowing you to have
2231 separate log files for each user or machine.
2232
2233 .B Example:
2234         log file = /usr/local/samba/var/log.%m
2235
2236 .SS log level (G)
2237 see "debug level"
2238
2239 .SS logon drive (G)
2240
2241 This parameter specifies the local path to which the home directory
2242 will be connected (see "logon home") and is only used by NT Workstations.
2243
2244 .B Example:
2245         logon drive = h:
2246
2247 .SS logon home (G)
2248
2249 This parameter specifies the home directory location when a Win95 or
2250 NT Workstation logs into a Samba PDC.  It allows you to do "NET USE
2251 H: /HOME" from a command prompt, for example.
2252
2253 .B
2254 This option takes the standard substitutions, allowing you to have
2255 separate logon scripts for each user or machine.
2256
2257 .B Example:
2258         logon home = "\\\\remote_smb_server\\%U"
2259
2260 .B Default:
2261         logon home = "\\\\%N\\%U"
2262
2263 .SS logon path (G)
2264
2265 This parameter specifies the home directory where roaming profiles 
2266 (USER.DAT / USER.MAN files for Windows 95) are stored.
2267
2268 This option takes the standard substitutions, allowing you to have
2269 separate logon scripts for each user or machine.  It also specifies
2270 the directory from which the "desktop", "start menu", "nethood" and
2271 "programs" folders, and their contents, are loaded and displayed
2272 on your Windows 95 client.
2273
2274 The share and the path must be readable by the user for the preferences
2275 and directories to be loaded onto the Windows 95 client.  The share
2276 must be writeable when the logs in for the first time, in order that
2277 the Windows 95 client can create the user.dat and other directories.
2278
2279 Thereafter, the directories and any of contents can, if required,
2280 be made read-only.  It is not adviseable that the USER.DAT file be made
2281 read-only - rename it to USER.MAN to achieve the desired effect
2282 (a MANdatory profile).
2283
2284 Windows clients can sometimes maintain a connection to the [homes]
2285 share, even though there is no user logged in.  Therefore, it is
2286 vital that the logon path does not include a reference to the
2287 homes share (i.e \\\\%N\\HOMES\profile_path will cause problems).
2288
2289 .B
2290 This option takes the standard substitutions, allowing you to have
2291 separate logon scripts for each user or machine.
2292
2293 .B Default:
2294         logon path = \\\\%N\\%U\\profile
2295
2296 .B Example:
2297         logon path = \\\\PROFILESERVER\\HOME_DIR\\%U\\PROFILE
2298
2299 .SS logon script (G)
2300
2301 This parameter specifies the batch file (.bat) or NT command file (.cmd)
2302 to be downloaded and run on a machine when a user successfully logs in.
2303 The file must contain the DOS style cr/lf line endings.  Using a DOS-style
2304 editor to create the file is recommended.
2305
2306 The script must be a relative path to the [netlogon] service.  If the
2307 [netlogon] service specifies a path of /usr/local/samba/netlogon, and
2308 logon script = STARTUP.BAT, then file that will be downloaded is:
2309
2310 .B /usr/local/samba/netlogon/STARTUP.BAT
2311
2312 The contents of the batch file is entirely your choice.  A suggested
2313 command would be to add NET TIME \\\\SERVER /SET /YES, to force every
2314 machine to synchronise clocks with the same time server.  Another use
2315 would be to add NET USE U: \\\\SERVER\\UTILS for commonly used utilities,
2316 or NET USE Q: \\\\SERVER\\ISO9001_QA.
2317
2318 Note that it is particularly important not to allow write access to
2319 the [netlogon] share, or to grant users write permission on the
2320 batch files in a secure environment, as this would allow the batch
2321 files to be arbitrarily modified.
2322
2323 .B
2324 This option takes the standard substitutions, allowing you to have
2325 separate logon scripts for each user or machine.
2326
2327 .B Example:
2328         logon script = scripts\\%U.bat
2329
2330 .SS lppause command (S)
2331 This parameter specifies the command to be executed on the server host in
2332 order to stop printing or spooling a specific print job.
2333
2334 This command should be a program or script which takes a printer name and
2335 job number to pause the print job. Currently I don't know of any print
2336 spooler system that can do this with a simple option, except for the PPR
2337 system from Trinity College (ppr\-dist.trincoll.edu/pub/ppr). One way
2338 of implementing this is by using job priorities, where jobs having a too
2339 low priority won't be sent to the printer. See also the
2340 .B lppause
2341 command.
2342
2343 If a %p is given then the printername is put in its place. A %j is
2344 replaced with the job number (an integer).
2345 On HPUX (see printing=hpux), if the -p%p option is added to the lpq
2346 command, the job will show up with the correct status, i.e. if the job
2347 priority is lower than the set fence priority it will have the PAUSED
2348 status, whereas if the priority is equal or higher it will have the
2349 SPOOLED or PRINTING status.
2350
2351 Note that it is good practice to include the absolute path in the lppause
2352 command as the PATH may not be available to the server.
2353
2354 .B Default:
2355         Currently no default value is given to this string
2356
2357 .B Example for HPUX:
2358         lppause command = /usr/bin/lpalt %p-%j -p0
2359
2360 .SS lpq cache time (G)
2361
2362 This controls how long lpq info will be cached for to prevent the lpq
2363 command being called too often. A separate cache is kept for each
2364 variation of the lpq command used by the system, so if you use
2365 different lpq commands for different users then they won't share cache
2366 information.
2367
2368 The cache files are stored in /tmp/lpq.xxxx where xxxx is a hash
2369 of the lpq command in use.
2370
2371 The default is 10 seconds, meaning that the cached results of a
2372 previous identical lpq command will be used if the cached data is less
2373 than 10 seconds old. A large value may be advisable if your lpq
2374 command is very slow.
2375
2376 A value of 0 will disable cacheing completely.
2377
2378 .B Default:
2379         lpq cache time = 10
2380
2381 .B Example:
2382         lpq cache time = 30
2383
2384 .SS lpq command (S)
2385 This parameter specifies the command to be executed on the server host in
2386 order to obtain "lpq"-style printer status information. 
2387
2388 This command should be a program or script which takes a printer name
2389 as its only parameter and outputs printer status information. 
2390
2391 Currently six styles of printer status information are supported; BSD,
2392 SYSV, AIX, HPUX, QNX, LPRNG and PLP. This covers most UNIX systems. You
2393 control which type is expected using the "printing =" option.
2394
2395 Some clients (notably Windows for Workgroups) may not correctly send the
2396 connection number for the printer they are requesting status information
2397 about. To get around this, the server reports on the first printer service
2398 connected to by the client. This only happens if the connection number sent
2399 is invalid.
2400
2401 If a %p is given then the printername is put in its place. Otherwise
2402 it is placed at the end of the command.
2403
2404 Note that it is good practice to include the absolute path in the lpq
2405 command as the PATH may not be available to the server.
2406
2407 .B Default:
2408         depends on the setting of "printing ="
2409
2410 .B Example:
2411         lpq command = /usr/bin/lpq %p
2412
2413 .SS lpresume command (S)
2414 This parameter specifies the command to be executed on the server host in
2415 order to restart or continue printing or spooling a specific print job.
2416
2417 This command should be a program or script which takes a printer name and
2418 job number to resume the print job. See also the lppause command.
2419
2420 If a %p is given then the printername is put in its place. A %j is
2421 replaced with the job number (an integer).
2422
2423 Note that it is good practice to include the absolute path in the lpresume
2424 command as the PATH may not be available to the server.
2425
2426 .B Default:
2427         Currently no default value is given to this string
2428
2429 .B Example for HPUX:
2430         lpresume command = /usr/bin/lpalt %p-%j -p2
2431
2432 .SS lprm command (S)
2433 This parameter specifies the command to be executed on the server host in
2434 order to delete a print job.
2435
2436 This command should be a program or script which takes a printer name
2437 and job number, and deletes the print job.
2438
2439 Currently seven styles of printer control are supported; BSD, SYSV, AIX
2440 HPUX, QNX, LPRNG and PLP. This covers most UNIX systems. You control
2441 which type is expected using the "printing =" option.
2442
2443 If a %p is given then the printername is put in its place. A %j is
2444 replaced with the job number (an integer).
2445
2446 Note that it is good practice to include the absolute path in the lprm
2447 command as the PATH may not be available to the server.
2448
2449 .B Default:
2450         depends on the setting of "printing ="
2451
2452 .B Example 1:
2453         lprm command = /usr/bin/lprm -P%p %j
2454
2455 .B Example 2:
2456         lprm command = /usr/bin/cancel %p-%j
2457
2458 .SS magic output (S)
2459 This parameter specifies the name of a file which will contain output
2460 created by a magic script (see
2461 .I magic script
2462 below).
2463
2464 Warning: If two clients use the same magic script in the same directory the
2465 output file content is undefined.
2466 .B Default:
2467         magic output = <magic script name>.out
2468
2469 .B Example:
2470         magic output = myfile.txt
2471 .SS magic script (S)
2472 This parameter specifies the name of a file which, if opened, will be
2473 executed by the server when the file is closed. This allows a UNIX script
2474 to be sent to the Samba host and executed on behalf of the connected user.
2475
2476 Scripts executed in this way will be deleted upon completion, permissions
2477 permitting.
2478
2479 If the script generates output, output will be sent to the file specified by
2480 the
2481 .I magic output
2482 parameter (see above).
2483
2484 Note that some shells are unable to interpret scripts containing
2485 carriage-return-linefeed instead of linefeed as the end-of-line
2486 marker. Magic scripts must be executable "as is" on the host, which
2487 for some hosts and some shells will require filtering at the DOS end.
2488
2489 Magic scripts are EXPERIMENTAL and should NOT be relied upon.
2490
2491 .B Default:
2492         None. Magic scripts disabled.
2493
2494 .B Example:
2495         magic script = user.csh
2496
2497 .SS mangle case (S)
2498
2499 See the section on "NAME MANGLING"
2500
2501 .SS mangled map (S)
2502 This is for those who want to directly map UNIX file names which are
2503 not representable on DOS.  The mangling of names is not always what is
2504 needed.  In particular you may have documents with file extensions
2505 that differ between DOS and UNIX. For example, under UNIX it is common
2506 to use .html for HTML files, whereas under DOS .htm is more commonly
2507 used.
2508
2509 So to map 'html' to 'htm' you put:
2510
2511   mangled map = (*.html *.htm)
2512
2513 One very useful case is to remove the annoying ;1 off the ends of
2514 filenames on some CDROMS (only visible under some UNIXes). To do this
2515 use a map of (*;1 *)
2516
2517 .B default:
2518         no mangled map
2519
2520 .B Example:
2521         mangled map = (*;1 *)
2522
2523 .SS mangled names (S)
2524 This controls whether non-DOS names under UNIX should be mapped to
2525 DOS-compatible names ("mangled") and made visible, or whether non-DOS names
2526 should simply be ignored.
2527
2528 See the section on "NAME MANGLING" for details on how to control the
2529 mangling process.
2530
2531 If mangling is used then the mangling algorithm is as follows:
2532 .RS
2533 - the first (up to) five alphanumeric characters before the rightmost dot of
2534 the filename are preserved, forced to upper case, and appear as the first (up
2535 to) five characters of the mangled name.
2536
2537 - a tilde ("~") is appended to the first part of the mangled name, followed
2538 by a two-character unique sequence, based on the original root name 
2539 (i.e., the original filename minus its final extension). The final
2540 extension is included in the hash calculation only if it contains any upper
2541 case characters or is longer than three characters.
2542
2543 Note that the character to use may be specified using the "mangling
2544 char" option, if you don't like ~.
2545
2546 - the first three alphanumeric characters of the final extension are preserved,
2547 forced to upper case and appear as the extension of the mangled name. The 
2548 final extension is defined as that part of the original filename after the
2549 rightmost dot. If there are no dots in the filename, the mangled name will
2550 have no extension (except in the case of hidden files - see below).
2551
2552 - files whose UNIX name begins with a dot will be presented as DOS hidden
2553 files. The mangled name will be created as for other filenames, but with the
2554 leading dot removed and "___" as its extension regardless of actual original
2555 extension (that's three underscores).
2556 .RE
2557
2558 The two-digit hash value consists of upper case alphanumeric characters.
2559
2560 This algorithm can cause name collisions only if files in a directory share
2561 the same first five alphanumeric characters. The probability of such a clash 
2562 is 1/1300.
2563
2564 The name mangling (if enabled) allows a file to be copied between UNIX
2565 directories from DOS while retaining the long UNIX filename. UNIX files can
2566 be renamed to a new extension from DOS and will retain the same basename. 
2567 Mangled names do not change between sessions.
2568
2569 .B Default:
2570         mangled names = yes
2571
2572 .B Example:
2573         mangled names = no
2574 .SS mangling char (S)
2575 This controls what character is used as the "magic" character in name
2576 mangling. The default is a ~ but this may interfere with some
2577 software. Use this option to set it to whatever you prefer.
2578
2579 .B Default:
2580         mangling char = ~
2581
2582 .B Example:
2583         mangling char = ^
2584
2585 .SS mangled stack (G)
2586 This parameter controls the number of mangled names that should be cached in
2587 the Samba server.
2588
2589 This stack is a list of recently mangled base names (extensions are only
2590 maintained if they are longer than 3 characters or contains upper case
2591 characters).
2592
2593 The larger this value, the more likely it is that mangled names can be
2594 successfully converted to correct long UNIX names. However, large stack
2595 sizes will slow most directory access. Smaller stacks save memory in the
2596 server (each stack element costs 256 bytes).
2597
2598 It is not possible to absolutely guarantee correct long file names, so
2599 be prepared for some surprises!
2600
2601 .B Default:
2602         mangled stack = 50
2603
2604 .B Example:
2605         mangled stack = 100
2606
2607 .SS map archive (S)
2608 This controls whether the DOS archive attribute should be mapped to the
2609 UNIX owner execute bit.  The DOS archive bit is set when a file has been modified
2610 since its last backup.  One motivation for this option it to keep Samba/your
2611 PC from making any file it touches from becoming executable under UNIX.
2612 This can be quite annoying for shared source code, documents,  etc...
2613
2614 Note that this requires the 'create mask' to be set such that owner
2615 execute bit is not masked out (ie. it must include 100). See the 
2616 parameter "create mask" for details.
2617
2618 .B Default:
2619       map archive = yes
2620
2621 .B Example:
2622       map archive = no
2623
2624 .SS map hidden (S)
2625 This controls whether DOS style hidden files should be mapped to the
2626 UNIX world execute bit.
2627
2628 Note that this requires the 'create mask' to be set such that the world
2629 execute bit is not masked out (ie. it must include 001). 
2630 See the parameter "create mask" for details.
2631
2632 .B Default:
2633         map hidden = no
2634
2635 .B Example:
2636         map hidden = yes
2637 .SS map system (S)
2638 This controls whether DOS style system files should be mapped to the
2639 UNIX group execute bit.
2640
2641 Note that this requires the 'create mask' to be set such that the group
2642 execute bit is not masked out (ie. it must include 010). See the parameter 
2643 "create mask" for details.
2644
2645 .B Default:
2646         map system = no
2647
2648 .B Example:
2649         map system = yes
2650 .SS max connections (S)
2651 This option allows the number of simultaneous connections to a
2652 service to be limited. If "max connections" is greater than 0 then
2653 connections will be refused if this number of connections to the
2654 service are already open. A value of zero mean an unlimited number of
2655 connections may be made.
2656
2657 Record lock files are used to implement this feature. The lock files
2658 will be stored in the directory specified by the "lock directory" option.
2659
2660 .B Default:
2661         max connections = 0
2662
2663 .B Example:
2664         max connections = 10
2665
2666 .SS max disk size (G)
2667 This option allows you to put an upper limit on the apparent size of
2668 disks. If you set this option to 100 then all shares will appear to be
2669 not larger than 100 MB in size.
2670
2671 Note that this option does not limit the amount of data you can put on
2672 the disk. In the above case you could still store much more than 100
2673 MB on the disk, but if a client ever asks for the amount of free disk
2674 space or the total disk size then the result will be bounded by the
2675 amount specified in "max disk size".
2676
2677 This option is primarily useful to work around bugs in some pieces of
2678 software that can't handle very large disks, particularly disks over
2679 1GB in size.
2680
2681 A "max disk size" of 0 means no limit.
2682
2683 .B Default:
2684         max disk size = 0
2685
2686 .B Example:
2687         max disk size = 1000
2688
2689 .SS max log size (G)
2690
2691 This option (an integer in kilobytes) specifies the max size the log
2692 file should grow to. Samba periodically checks the size and if it is
2693 exceeded it will rename the file, adding a .old extension.
2694
2695 A size of 0 means no limit.
2696
2697 .B Default:
2698         max log size = 5000
2699
2700 .B Example:
2701         max log size = 1000
2702
2703 .SS max mux (G)
2704
2705 This option controls the maximum number of outstanding simultaneous SMB 
2706 operations that samba tells the client it will allow. You should never need 
2707 to set this parameter.
2708
2709 .B Default:
2710         max mux = 50
2711
2712 .SS max packet (G)
2713
2714 A synonym for this parameter is 'packet size'.
2715
2716 .SS max ttl (G)
2717
2718 This option tells nmbd what the default 'time to live' of NetBIOS
2719 names should be (in seconds) when nmbd is requesting a name using
2720 either a broadcast or from a WINS server. You should never need to 
2721 change this parameter.
2722
2723 .B Default:
2724         max ttl = 14400
2725
2726 .SS max wins ttl (G)
2727
2728 This option tells nmbd when acting as a WINS server (wins support = true)
2729 what the maximum 'time to live' of NetBIOS names that nmbd will grant will
2730 be (in seconds). You should never need to change this parameter.     
2731 The default is 3 days (259200 seconds).
2732
2733 .B Default:
2734         max wins ttl = 259200
2735
2736 .SS max xmit (G)
2737
2738 This option controls the maximum packet size that will be negotiated
2739 by Samba. The default is 65535, which is the maximum. In some cases
2740 you may find you get better performance with a smaller value. A value
2741 below 2048 is likely to cause problems.
2742
2743 .B Default:
2744         max xmit = 65535
2745
2746 .B Example:
2747         max xmit = 8192
2748
2749 .SS message command (G)
2750
2751 This specifies what command to run when the server receives a WinPopup
2752 style message.
2753
2754 This would normally be a command that would deliver the message
2755 somehow. How this is to be done is up to your imagination.
2756
2757 What I use is:
2758
2759    message command = csh -c 'xedit %s;rm %s' &
2760
2761 This delivers the message using xedit, then removes it
2762 afterwards. NOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN
2763 IMMEDIATELY. That's why I have the & on the end. If it doesn't return
2764 immediately then your PCs may freeze when sending messages (they
2765 should recover after 30secs, hopefully).
2766
2767 All messages are delivered as the global guest user. The command takes
2768 the standard substitutions, although %u won't work (%U may be better
2769 in this case).
2770
2771 Apart from the standard substitutions, some additional ones apply. In
2772 particular:
2773
2774 %s = the filename containing the message
2775
2776 %t = the destination that the message was sent to (probably the server
2777 name)
2778
2779 %f = who the message is from
2780
2781 You could make this command send mail, or whatever else takes your
2782 fancy. Please let me know of any really interesting ideas you have.
2783
2784 Here's a way of sending the messages as mail to root:
2785
2786 message command = /bin/mail -s 'message from %f on %m' root < %s; rm %s
2787
2788 If you don't have a message command then the message won't be
2789 delivered and Samba will tell the sender there was an
2790 error. Unfortunately WfWg totally ignores the error code and carries
2791 on regardless, saying that the message was delivered.
2792
2793 If you want to silently delete it then try "message command = rm %s".
2794
2795 For the really adventurous, try something like this:
2796
2797 message command = csh -c 'csh < %s |& /usr/local/samba/bin/smbclient \e
2798                   -M %m; rm %s' &
2799
2800 this would execute the command as a script on the server, then give
2801 them the result in a WinPopup message. Note that this could cause a
2802 loop if you send a message from the server using smbclient! You better
2803 wrap the above in a script that checks for this :-)
2804
2805 .B Default:
2806         no message command
2807
2808 .B Example:
2809         message command = csh -c 'xedit %s;rm %s' &
2810
2811 .SS min print space (S)
2812
2813 This sets the minimum amount of free disk space that must be available
2814 before a user will be able to spool a print job. It is specified in
2815 kilobytes. The default is 0, which means no limit.
2816
2817 .B Default:
2818         min print space = 0
2819
2820 .B Example:
2821         min print space = 2000
2822
2823 .SS min wins ttl (G)
2824
2825 This option tells nmbd when acting as a WINS server (wins support = true)
2826 what the minimum 'time to live' of NetBIOS names that nmbd will grant will
2827 be (in seconds). You should never need to change this parameter.
2828 The default is 6 hours (21600 seconds).
2829
2830 .B Default:
2831         min wins ttl = 21600
2832
2833 .SS name resolve order (G)
2834
2835 This option is used by the programs smbd, nmbd and smbclient to determine
2836 what naming services and in what order to resolve host names to IP addresses.
2837 This option is most useful in smbclient. The option takes a space separated
2838 string of different name resolution options. These are "lmhosts", "host",
2839 "wins" and "bcast". They cause names to be resolved as follows :
2840
2841 lmhosts : Lookup an IP address in the Samba lmhosts file.
2842 host    : Do a standard host name to IP address resolution, using the
2843           system /etc/hosts, NIS, or DNS lookups. This method of name
2844           resolution is operating system depended (for instance on Solaris
2845           this may be controlled by the /etc/nsswitch.conf file).
2846 wins    : Query a name with the IP address listed in the "wins server ="
2847           parameter. If no WINS server has been specified this method will
2848           be ignored.
2849 bcast   : Do a broadcast on each of the known local interfaces listed in
2850           the "interfaces =" parameter. This is the least reliable of the
2851           name resolution methods as it depends on the target host being
2852           on a locally connected subnet.
2853
2854 The default order is lmhosts, host, wins, bcast and these name resolution
2855 methods will be attempted in this order.
2856
2857 This option was first introduced in Samba 1.9.18p4.
2858
2859 .B Default:
2860         name resolve order = lmhosts host wins bcast
2861
2862 .Example:
2863         name resolve order = lmhosts bcast host
2864
2865 This will cause the local lmhosts file to be examined first, followed
2866 by a broadcast attempt, followed by a normal system hostname lookup.
2867
2868 .SS netbios aliases (G)
2869
2870 This is a list of names that nmbd will advertise as additional
2871 names by which the Samba server is known. This allows one machine
2872 to appear in browse lists under multiple names. If a machine is
2873 acting as a browse server or logon server none of these names
2874 will be advertised as either browse server or logon servers, only
2875 the primary name of the machine will be advertised with these
2876 capabilities.
2877
2878 See also 'netbios name'.
2879
2880 .B Example:
2881    netbios aliases = TEST TEST1 TEST2
2882
2883 .SS netbios name (G)
2884
2885 This sets the NetBIOS name by which a Samba server is known. By
2886 default it is the same as the first component of the host's DNS name.
2887 If a machine is a browse server or logon server this name (or the
2888 first component of the hosts DNS name) will be the name that these
2889 services are advertised under.
2890
2891 See also 'netbios aliases'.
2892
2893 .B Example:
2894    netbios name = MYNAME
2895
2896 .SS nis homedir (G)
2897 Get the home share server from a NIS (or YP) map. For unix systems that
2898 use an automounter, the user's home directory will often be mounted on
2899 a workstation on demand from a remote server. When the Samba logon server
2900 is not the actual home directory server, two network hops are required
2901 to access the home directory and this can be very slow especially with 
2902 writing via Samba to an NFS mounted directory. This option allows samba
2903 to return the home share as being on a different server to the logon
2904 server and as long as a samba daemon is running on the home directory 
2905 server, it will be mounted on the Samba client directly from the directory
2906 server. When Samba is returning the home share to the client, it will
2907 consult the NIS (or YP) map specified in "homedir map" and return the
2908 server listed there.
2909
2910 .B Default:
2911         nis homedir = false
2912
2913 .B Example:
2914         nis homedir = true
2915
2916 .SS networkstation user login (G)
2917 This global parameter (new for 1.9.18p3) affects server level security.
2918 With this set (recommended) samba will do a full NetWkstaUserLogon to
2919 confirm that the client really should have login rights. This can cause
2920 problems with machines in trust relationships in which case you can
2921 disable it here, but be warned, we have heard that some NT machines
2922 will then allow anyone in with any password! Make sure you test it.
2923
2924 In Samba 1.9.18p5 this parameter is of limited use, as smbd now
2925 explicitly tests for this NT bug and will refuse to use a password
2926 server that has the problem. The parameter now defaults to off,
2927 and it should not be neccessary to set this parameter to on. It will
2928 be removed in a future Samba release.
2929
2930 .B Default:
2931         networkstation user login = no
2932
2933 .B Example:
2934         networkstation user login = yes
2935
2936 .SS null passwords (G)
2937 Allow or disallow access to accounts that have null passwords. 
2938
2939 .B Default:
2940         null passwords = no
2941
2942 .B Example:
2943         null passwords = yes
2944
2945 .SS ole locking compatibility (G)
2946
2947 This parameter allows an administrator to turn off the byte range
2948 lock manipulation that is done within Samba to give compatibility
2949 for OLE applications. Windows OLE applications use byte range locking
2950 as a form of inter-process communication, by locking ranges of bytes
2951 around the 2^32 region of a file range. This can cause certain UNIX
2952 lock managers to crash or otherwise cause problems. Setting this
2953 parameter to "no" means you trust your UNIX lock manager to handle
2954 such cases correctly.
2955
2956 .B Default:
2957      ole locking compatibility = yes
2958
2959 .B Example:
2960      ole locking compatibility = no
2961
2962
2963 .SS only guest (S)
2964 A synonym for this command is 'guest only'.
2965
2966 .SS only user (S)
2967 This is a boolean option that controls whether connections with
2968 usernames not in the user= list will be allowed. By default this
2969 option is disabled so a client can supply a username to be used by
2970 the server.
2971
2972 Note that this also means Samba won't try to deduce usernames from the
2973 service name. This can be annoying for the [homes] section. To get
2974 around this you could use "user = %S" which means your "user" list
2975 will be just the service name, which for home directories is the name
2976 of the user.
2977
2978 .B Default: 
2979         only user = False
2980
2981 .B Example: 
2982         only user = True
2983
2984 .SS oplocks (S)
2985 This boolean option tells smbd whether to issue oplocks (opportunistic
2986 locks) to file open requests on this share. The oplock code was introduced in
2987 Samba 1.9.18 and can dramatically (approx 30% or more) improve the speed
2988 of access to files on Samba servers. It allows the clients to agressively
2989 cache files locally and you may want to disable this option for unreliable
2990 network environments (it is turned on by default in Windows NT Servers).
2991 For more information see the file Speed.txt in the Samba docs/ directory.
2992
2993 Oplocks may be selectively turned off on certain files on a per share basis.
2994 See the 'veto oplock files' parameter.
2995
2996 .B Default:
2997     oplocks = True
2998
2999 .B Example:
3000     oplocks = False
3001
3002
3003 .SS os level (G)
3004 This integer value controls what level Samba advertises itself as for
3005 browse elections. See BROWSING.txt for details.
3006
3007 .SS packet size (G)
3008 The maximum transmit packet size during a raw read. This option is no
3009 longer implemented as of version 1.7.00, and is kept only so old
3010 configuration files do not become invalid.
3011
3012 .SS passwd chat (G)
3013 This string controls the "chat" conversation that takes places
3014 between smbd and the local password changing program to change the
3015 users password. The string describes a sequence of response-receive
3016 pairs that smbd uses to determine what to send to the passwd program
3017 and what to expect back. If the expected output is not received then
3018 the password is not changed.
3019
3020 This chat sequence is often quite site specific, depending on what
3021 local methods are used for password control (such as NIS+ etc).
3022
3023 The string can contain the macros %o and %n which are substituted for
3024 the old and new passwords respectively. It can also contain the
3025 standard macros \en \er \et and \es to give line-feed, carriage-return,
3026 tab and space.
3027
3028 The string can also contain a * which matches any sequence of
3029 characters.
3030
3031 Double quotes can be used to collect strings with spaces in them into
3032 a single string.
3033
3034 If the send string in any part of the chat sequence is a fullstop "."
3035 then no string is sent. Similarly, is the expect string is a fullstop
3036 then no string is expected.
3037
3038 Note that if the 'unix password sync' parameter is set to true,
3039 then this sequence is called *AS ROOT* when the SMB password in the
3040 smbpasswd file is being changed, without access to the old password
3041 cleartext. In this case the old password cleartext is set to ""
3042 (the empty string).
3043
3044 See also 'unix password sync' and 'passwd chat debug'
3045
3046 .B Example:
3047         passwd chat = "*Enter OLD password*" %o\en "*Enter NEW password*" %n\en \e
3048                        "*Reenter NEW password*" %n\en "*Password changed*"
3049
3050
3051 .B Default:
3052        passwd chat = *old*password* %o\en *new*password* %n\en *new*password* %n\en *changed*
3053
3054 .SS passwd chat debug (G)
3055
3056 This boolean specifies if the passwd chat script parameter is run
3057 in 'debug' mode. In this mode the strings passed to and received
3058 from the passwd chat are printed in the smbd log with a debug level
3059 of 100. This is a dangerous option as it will allow plaintext passwords
3060 to be seen in the smbd log. It is available to help Samba admins
3061 debug their passwd chat scripts and should be turned off after
3062 this has been done. This parameter is off by default.
3063
3064 .B Example:
3065      passwd chat debug = True
3066
3067 .B Default:
3068      passwd chat debug = False
3069
3070 .SS passwd program (G)
3071 The name of a program that can be used to set user passwords.
3072
3073 This is only available if you have enabled remote password changing at
3074 compile time (see the comments in the Makefile for details). Any occurrences 
3075 of %u will be replaced with the user name. The user name is checked
3076 for existance before calling the password changing program.
3077
3078 Also note that many passwd programs insist in "reasonable" passwords,
3079 such as a minimum length, or the inclusion of mixed case chars and
3080 digits. This can pose a problem as some clients (such as Windows for
3081 Workgroups) uppercase the password before sending it. 
3082
3083 Note that if the 'unix password sync' parameter is set to true,
3084 then this sequence is called *AS ROOT* when the SMB password in the
3085 smbpasswd file is being changed. If the 'unix passwd sync' parameter
3086 is set this parameter MUST USE ABSOLUTE PATHS for ALL programs called,
3087 and must be examined for security implications. Note that by default
3088 'unix password sync' is set to False.
3089
3090 See also 'unix password sync'
3091
3092 .B Default:
3093         passwd program = /bin/passwd
3094
3095 .B Example:
3096         passwd program = /sbin/passwd %u
3097
3098 .SS password level (G)
3099 Some client/server combinations have difficulty with mixed-case passwords.
3100 One offending client is Windows for Workgroups, which for some reason forces
3101 passwords to upper case when using the LANMAN1 protocol, but leaves them alone
3102 when using COREPLUS!
3103
3104 This parameter defines the maximum number of characters that may be upper case
3105 in passwords.
3106
3107 For example, say the password given was "FRED". If
3108 .B password level
3109 is set to 1 (one), the following combinations would be tried if "FRED" failed:
3110 "Fred", "fred", "fRed", "frEd", "freD". If
3111 .B password level was set to 2 (two), the following combinations would also be
3112 tried: "FRed", "FrEd", "FreD", "fREd", "fReD", "frED". And so on.
3113
3114 The higher value this parameter is set to the more likely it is that a mixed
3115 case password will be matched against a single case password. However, you
3116 should be aware that use of this parameter reduces security and increases the
3117 time taken to process a new connection.
3118
3119 A value of zero will cause only two attempts to be made - the password as is
3120 and the password in all-lower case.
3121
3122 If you find the connections are taking too long with this option then
3123 you probably have a slow crypt() routine. Samba now comes with a fast
3124 "ufc crypt" that you can select in the Makefile. You should also make
3125 sure the PASSWORD_LENGTH option is correct for your system in local.h
3126 and includes.h. On most systems only the first 8 chars of a password
3127 are significant so PASSWORD_LENGTH should be 8, but on some longer
3128 passwords are significant. The includes.h file tries to select the
3129 right length for your system.
3130
3131 .B Default:
3132         password level = 0
3133
3134 .B Example:
3135         password level = 4
3136
3137 .SS password server (G)
3138
3139 By specifying the name of another SMB server (such as a WinNT box)
3140 with this option, and using "security = server" you can get Samba to
3141 do all its username/password validation via a remote server.
3142
3143 This options sets the name of the password server to use. It must be a
3144 netbios name, so if the machine's netbios name is different from its
3145 internet name then you may have to add its netbios name to
3146 /etc/hosts.
3147
3148 Note that with Samba 1.9.18p4 and above the name of the password
3149 server is looked up using the parameter "name resolve order=" and
3150 so may resolved by any method and order described in that parameter.
3151
3152 The password server much be a machine capable of using the "LM1.2X002"
3153 or the "LM NT 0.12" protocol, and it must be in user level security
3154 mode. 
3155
3156 NOTE: Using a password server means your UNIX box (running Samba) is
3157 only as secure as your password server. DO NOT CHOOSE A PASSWORD
3158 SERVER THAT YOU DON'T COMPLETELY TRUST.
3159
3160 Never point a Samba server at itself for password serving. This will
3161 cause a loop and could lock up your Samba server!
3162
3163 The name of the password server takes the standard substitutions, but
3164 probably the only useful one is %m, which means the Samba server will
3165 use the incoming client as the password server. If you use this then
3166 you better trust your clients, and you better restrict them with hosts
3167 allow!
3168
3169 If you list several hosts in the "password server" option then smbd
3170 will try each in turn till it finds one that responds. This is useful
3171 in case your primary server goes down.
3172
3173 If you are using a WindowsNT server as your password server then you
3174 will have to ensure that your users are able to login from the Samba 
3175 server, as the network logon will appear to come from there rather
3176 than from the users workstation.
3177
3178 .SS path (S)
3179 A synonym for this parameter is 'directory'.
3180
3181 This parameter specifies a directory to which the user of the service is to
3182 be given access. In the case of printable services, this is where print data 
3183 will spool prior to being submitted to the host for printing.
3184
3185 For a printable service offering guest access, the service should be readonly
3186 and the path should be world-writable and have the sticky bit set. This is not
3187 mandatory of course, but you probably won't get the results you expect if you
3188 do otherwise.
3189
3190 Any occurrences of %u in the path will be replaced with the username
3191 that the client is connecting as. Any occurrences of %m will be
3192 replaced by the name of the machine they are connecting from. These
3193 replacements are very useful for setting up pseudo home directories
3194 for users.
3195
3196 Note that this path will be based on 'root dir' if one was specified.
3197 .B Default:
3198         none
3199
3200 .B Example:
3201         path = /home/fred+ 
3202
3203 .SS postexec (S)
3204
3205 This option specifies a command to be run whenever the service is
3206 disconnected. It takes the usual substitutions. The command may be run
3207 as the root on some systems.
3208
3209 An interesting example may be do unmount server resources:
3210
3211 postexec = /etc/umount /cdrom
3212
3213 See also preexec
3214
3215 .B Default:
3216       none (no command executed)
3217
3218 .B Example:
3219       postexec = echo \e"%u disconnected from %S from %m (%I)\e" >> /tmp/log
3220
3221 .SS postscript (S)
3222 This parameter forces a printer to interpret the print files as
3223 postscript. This is done by adding a %! to the start of print output. 
3224
3225 This is most useful when you have lots of PCs that persist in putting
3226 a control-D at the start of print jobs, which then confuses your
3227 printer.
3228
3229 .B Default: 
3230         postscript = False
3231
3232 .B Example: 
3233         postscript = True
3234
3235 .SS preexec (S)
3236
3237 This option specifies a command to be run whenever the service is
3238 connected to. It takes the usual substitutions.
3239
3240 An interesting example is to send the users a welcome message every
3241 time they log in. Maybe a message of the day? Here is an example:
3242
3243 preexec = csh -c 'echo \e"Welcome to %S!\e" | \e
3244        /usr/local/samba/bin/smbclient -M %m -I %I' &
3245
3246 Of course, this could get annoying after a while :-)
3247
3248 See also postexec
3249
3250 .B Default:
3251         none (no command executed)
3252
3253 .B Example:
3254         preexec = echo \e"%u connected to %S from %m (%I)\e" >> /tmp/log
3255
3256 .SS preferred master (G)
3257 This boolean parameter controls if Samba is a preferred master browser
3258 for its workgroup.
3259 If this is set to true, on startup, samba will force an election, 
3260 and it will have a slight advantage in winning the election.  
3261 It is recommended that this parameter is used in conjunction 
3262 with domain master = yes, so that samba can guarantee becoming 
3263 a domain master.  
3264
3265 Use this option with caution, because if there are several hosts
3266 (whether samba servers, Windows 95 or NT) that are preferred master
3267 browsers on the same subnet, they will each periodically and continuously
3268 attempt to become the local master browser.  This will result in
3269 unnecessary broadcast traffic and reduced browsing capabilities.
3270
3271 See
3272 .B os level = nn
3273
3274 .B Default:
3275         preferred master = no
3276
3277 .SS preload
3278 This is an alias for "auto services"
3279
3280 .SS preserve case (S)
3281
3282 This controls if new filenames are created with the case that the
3283 client passes, or if they are forced to be the "default" case.
3284
3285 .B Default:
3286        preserve case = no
3287
3288 See the section on "NAME MANGLING" for a fuller discussion.
3289
3290 .SS print command (S)
3291 After a print job has finished spooling to a service, this command will be
3292 used via a system() call to process the spool file. Typically the command 
3293 specified will submit the spool file to the host's printing subsystem, but
3294 there is no requirement that this be the case. The server will not remove the
3295 spool file, so whatever command you specify should remove the spool file when
3296 it has been processed, otherwise you will need to manually remove old spool
3297 files.
3298
3299 The print command is simply a text string. It will be used verbatim,
3300 with two exceptions: All occurrences of "%s" will be replaced by the
3301 appropriate spool file name, and all occurrences of "%p" will be
3302 replaced by the appropriate printer name. The spool file name is
3303 generated automatically by the server, the printer name is discussed
3304 below.
3305
3306 The full path name will be used for the filename if %s is not preceded
3307 by a /. If you don't like this (it can stuff up some lpq output) then
3308 use %f instead. Any occurrences of %f get replaced by the spool
3309 filename without the full path at the front.
3310
3311 The print command MUST contain at least one occurrence of "%s" or %f -
3312 the "%p" is optional. At the time a job is submitted, if no printer
3313 name is supplied the "%p" will be silently removed from the printer
3314 command.
3315
3316 If specified in the [global] section, the print command given will be used
3317 for any printable service that does not have its own print command specified.
3318
3319 If there is neither a specified print command for a printable service nor a 
3320 global print command, spool files will be created but not processed and (most
3321 importantly) not removed.
3322
3323 Note that printing may fail on some UNIXes from the "nobody"
3324 account. If this happens then create an alternative guest account that
3325 can print and set the "guest account" in the [global] section.
3326
3327 You can form quite complex print commands by realising that they are
3328 just passed to a shell. For example the following will log a print
3329 job, print the file, then remove it. Note that ; is the usual
3330 separator for command in shell scripts.
3331
3332 print command = echo Printing %s >> /tmp/print.log; lpr -P %p %s; rm %s
3333
3334 You may have to vary this command considerably depending on how you
3335 normally print files on your system.
3336
3337 .B Default:
3338         print command = lpr -r -P %p %s
3339
3340 .B Example:
3341         print command = /usr/local/samba/bin/myprintscript %p %s
3342 .SS print ok (S)
3343 See
3344 .B printable.
3345 .SS printable (S)
3346 A synonym for this parameter is 'print ok'.
3347
3348 If this parameter is 'yes', then clients may open, write to and submit spool 
3349 files on the directory specified for the service.
3350
3351 Note that a printable service will ALWAYS allow writing to the service path
3352 (user privileges permitting) via the spooling of print data. The 'read only'
3353 parameter controls only non-printing access to the resource.
3354
3355 .B Default:
3356         printable = no
3357
3358 .B Example:
3359         printable = yes
3360
3361 .SS printcap name (G)
3362 This parameter may be used to override the compiled-in default printcap
3363 name used by the server (usually /etc/printcap). See the discussion of the
3364 [printers] section above for reasons why you might want to do this.
3365
3366 On SystemV systems that use lpstat to list available printers you
3367 can use "printcap name = lpstat" to automatically obtain lists of
3368 available printers. This is the default for systems that define 
3369 SYSV at compile time in Samba (this includes most SystemV based
3370 systems). If "printcap name" is set to lpstat on these systems then
3371 Samba will launch "lpstat -v" and attempt to parse the output to
3372 obtain a printer list.
3373
3374 A minimal printcap file would look something like this:
3375
3376 print1|My Printer 1
3377 .br
3378 print2|My Printer 2
3379 .br
3380 print3|My Printer 3
3381 .br
3382 print4|My Printer 4
3383 .br
3384 print5|My Printer 5
3385
3386 where the | separates aliases of a printer. The fact that the second
3387 alias has a space in it gives a hint to Samba that it's a comment.
3388
3389 NOTE: Under AIX the default printcap name is "/etc/qconfig". Samba
3390 will assume the file is in AIX "qconfig" format if the string
3391 "/qconfig" appears in the printcap filename.
3392
3393 .B Default:
3394         printcap name = /etc/printcap
3395
3396 .B Example:
3397         printcap name = /etc/myprintcap
3398
3399 .SS printer (S)
3400 A synonym for this parameter is 'printer name'.
3401
3402 This parameter specifies the name of the printer to which print jobs spooled
3403 through a printable service will be sent.
3404
3405 If specified in the [global] section, the printer name given will be used
3406 for any printable service that does not have its own printer name specified.
3407
3408 .B Default:
3409         none (but may be 'lp' on many systems)
3410
3411 .B Example:
3412         printer name = laserwriter
3413
3414 .SS printer driver (S)
3415 This option allows you to control the string that clients receive when
3416 they ask the server for the printer driver associated with a
3417 printer. If you are using Windows95 or WindowsNT then you can use this
3418 to automate the setup of printers on your system.
3419
3420 You need to set this parameter to the exact string (case sensitive)
3421 that describes the appropriate printer driver for your system. 
3422 If you don't know the exact string to use then you should first try
3423 with no "printer driver" option set and the client will give you a
3424 list of printer drivers. The appropriate strings are shown in a
3425 scrollbox after you have chosen the printer manufacturer.
3426
3427 .B Example:
3428         printer driver = HP LaserJet 4L
3429
3430 .SS printer name (S)
3431 See
3432 .B printer.
3433
3434 .SS printer driver file (G)
3435 This parameter tells Samba where the printer driver definition file,
3436 used when serving drivers to Windows 95 clients, is to be found. If
3437 this is not set, the default is :
3438
3439 SAMBA_INSTALL_DIRECTORY/lib/printers.def
3440
3441 This file is created from Windows 95 'msprint.def' files found on the
3442 Windows 95 client system. For more details on setting up serving of
3443 printer drivers to Windows 95 clients, see the documentation file
3444 docs/PRINTER_DRIVER.txt.
3445
3446 .B Default:
3447     None (set in compile).
3448
3449 .B Example:
3450     printer driver file = /usr/local/samba/printers/drivers.def
3451
3452 Related parameters.
3453 .B printer driver location
3454
3455 .SS printer driver location (S)
3456 This parameter tells clients of a particular printer share where
3457 to find the printer driver files for the automatic installation
3458 of drivers for Windows 95 machines. If Samba is set up to serve
3459 printer drivers to Windows 95 machines, this should be set to
3460
3461 \e\eMACHINE\ePRINTER$
3462
3463 Where MACHINE is the NetBIOS name of your Samba server, and PRINTER$ 
3464 is a share you set up for serving printer driver files. For more 
3465 details on setting this up see the documentation file 
3466 docs/PRINTER_DRIVER.txt.
3467
3468 .B Default:
3469     None
3470
3471 .B Example:
3472     printer driver location = \e\eMACHINE\ePRINTER$
3473
3474 Related paramerers.
3475 .B printer driver file
3476
3477
3478 .SS printing (S)
3479 This parameters controls how printer status information is interpreted
3480 on your system, and also affects the default values for the "print
3481 command", "lpq command" and "lprm command".
3482
3483 Currently six printing styles are supported. They are "printing =
3484 bsd", "printing = sysv", "printing = hpux", "printing = aix",
3485 "printing = qnx" and "printing = plp".
3486
3487 To see what the defaults are for the other print commands when using
3488 these three options use the "testparm" program.
3489
3490 As of version 1.9.18 of Samba this option can be set on a per printer basis
3491
3492 .SS protocol (G)
3493 The value of the parameter (a string) is the highest protocol level that will
3494 be supported by the server. 
3495
3496 Possible values are CORE, COREPLUS, LANMAN1, LANMAN2 and NT1. The relative
3497 merits of each are discussed in the README file.
3498
3499 Normally this option should not be set as the automatic negotiation
3500 phase in the SMB protocol takes care of choosing the appropriate protocol.
3501
3502 .B Default:
3503         protocol = NT1
3504
3505 .B Example:
3506         protocol = LANMAN1
3507
3508 .SS public (S)
3509 A synonym for this parameter is 'guest ok'.
3510
3511 If this parameter is 'yes' for a service, then no password is required
3512 to connect to the service. Privileges will be those of the guest
3513 account.
3514
3515 See the section below on user/password validation for more information about
3516 this option.
3517
3518 .B Default:
3519         public = no
3520
3521 .B Example:
3522         public = yes
3523
3524 .SS queuepause command (S)
3525 This parameter specifies the command to be executed on the server host in
3526 order to pause the printerqueue.
3527
3528 This command should be a program or script which takes a printer name
3529 as its only parameter and stops the printerqueue, such that no longer 
3530 jobs are submitted to the printer.
3531
3532 This command is not supported by Windows for Workgroups, but can be
3533 issued from the Printer's window under Windows 95 & NT.
3534
3535 If a %p is given then the printername is put in its place. Otherwise
3536 it is placed at the end of the command. 
3537
3538 Note that it is good practice to include the absolute path in the 
3539 command as the PATH may not be available to the server.
3540
3541 .B Default:
3542         depends on the setting of "printing ="
3543
3544 .B Example:
3545       queuepause command = disable %p
3546
3547 .SS queueresume command (S)
3548 This parameter specifies the command to be executed on the server host in
3549 order to resume the printerqueue. It is the command to undo the behaviour
3550 that is caused by the previous parameter (queuepause command).
3551  
3552 This command should be a program or script which takes a printer name
3553 as its only parameter and resumes the printerqueue, such that queued
3554 jobs are resubmitted to the printer.
3555
3556 This command is not supported by Windows for Workgroups, but can be
3557 issued from the Printer's window under Windows 95 & NT.
3558
3559 If a %p is given then the printername is put in its place. Otherwise
3560 it is placed at the end of the command.
3561
3562 Note that it is good practice to include the absolute path in the 
3563 command as the PATH may not be available to the server.
3564
3565 .B Default:
3566         depends on the setting of "printing ="
3567
3568 .B Example:
3569       queuepause command = enable %p
3570
3571 .SS read list (S)
3572 This is a list of users that are given read-only access to a
3573 service. If the connecting user is in this list then they will
3574 not be given write access, no matter what the "read only" option
3575 is set to. The list can include group names using the @group syntax.
3576
3577 See also the "write list" option
3578
3579 .B Default:
3580      read list =
3581
3582 .B Example:
3583      read list = mary, @students
3584
3585 .SS read only (S)
3586 See
3587 .B writable
3588 and
3589 .B write ok.
3590 Note that this is an inverted synonym for writable and write ok.
3591 .SS read prediction (G)
3592 This options enables or disables the read prediction code used to
3593 speed up reads from the server. When enabled the server will try to
3594 pre-read data from the last accessed file that was opened read-only
3595 while waiting for packets.
3596
3597 .SS Default:
3598         read prediction = False
3599
3600 .SS Example:
3601         read prediction = True
3602 .SS read raw (G)
3603 This parameter controls whether or not the server will support raw reads when
3604 transferring data to clients.
3605
3606 If enabled, raw reads allow reads of 65535 bytes in one packet. This
3607 typically provides a major performance benefit.
3608
3609 However, some clients either negotiate the allowable block size incorrectly
3610 or are incapable of supporting larger block sizes, and for these clients you
3611 may need to disable raw reads.
3612
3613 In general this parameter should be viewed as a system tuning tool and left
3614 severely alone. See also
3615 .B write raw.
3616
3617 .B Default:
3618         read raw = yes
3619
3620 .B Example:
3621         read raw = no
3622 .SS read size (G)
3623
3624 The option "read size" affects the overlap of disk reads/writes with
3625 network reads/writes. If the amount of data being transferred in
3626 several of the SMB commands (currently SMBwrite, SMBwriteX and
3627 SMBreadbraw) is larger than this value then the server begins writing
3628 the data before it has received the whole packet from the network, or
3629 in the case of SMBreadbraw, it begins writing to the network before
3630 all the data has been read from disk.
3631
3632 This overlapping works best when the speeds of disk and network access
3633 are similar, having very little effect when the speed of one is much
3634 greater than the other.
3635
3636 The default value is 2048, but very little experimentation has been
3637 done yet to determine the optimal value, and it is likely that the best
3638 value will vary greatly between systems anyway. A value over 65536 is
3639 pointless and will cause you to allocate memory unnecessarily.
3640
3641 .B Default:
3642         read size = 2048
3643
3644 .B Example:
3645         read size = 8192
3646
3647 .SS remote announce (G)
3648
3649 This option allows you to setup nmbd to periodically announce itself
3650 to arbitrary IP addresses with an arbitrary workgroup name. 
3651
3652 This is useful if you want your Samba server to appear in a remote
3653 workgroup for which the normal browse propagation rules don't
3654 work. The remote workgroup can be anywhere that you can send IP
3655 packets to.
3656
3657 For example:
3658
3659        remote announce = 192.168.2.255/SERVERS 192.168.4.255/STAFF
3660
3661 the above line would cause nmbd to announce itself to the two given IP
3662 addresses using the given workgroup names. If you leave out the
3663 workgroup name then the one given in the "workgroup" option is used
3664 instead. 
3665
3666 The IP addresses you choose would normally be the broadcast addresses
3667 of the remote networks, but can also be the IP addresses of known
3668 browse masters if your network config is that stable.
3669
3670 This option replaces similar functionality from the nmbd lmhosts file.
3671
3672 .SS remote browse sync (G)
3673
3674 This option allows you to setup nmbd to periodically request synchronisation
3675 of browse lists with the master browser of a samba server that is on a remote
3676 segment. This option will allow you to gain browse lists for multiple
3677 workgroups across routed networks. This is done in a manner that does not work
3678 with any non-samba servers.
3679
3680 This is useful if you want your Samba server and all local clients
3681 to appear in a remote workgroup for which the normal browse propagation
3682 rules don't work. The remote workgroup can be anywhere that you can send IP
3683 packets to.
3684
3685 For example:
3686
3687        remote browse sync = 192.168.2.255 192.168.4.255
3688
3689 the above line would cause nmbd to request the master browser on the
3690 specified subnets or addresses to synchronise their browse lists with
3691 the local server.
3692
3693 The IP addresses you choose would normally be the broadcast addresses
3694 of the remote networks, but can also be the IP addresses of known
3695 browse masters if your network config is that stable. If a machine IP
3696 address is given Samba makes NO attempt to validate that the remote
3697 machine is available, is listening, nor that it is in fact the browse
3698 master on it's segment.
3699
3700
3701 .SS revalidate (S)
3702
3703 This option controls whether Samba will allow a previously validated
3704 username/password pair to be used to attach to a share. Thus if you
3705 connect to \e\eserver\eshare1 then to \e\eserver\eshare2 it won't
3706 automatically allow the client to request connection to the second
3707 share as the same username as the first without a password.
3708
3709 Note that this option only works with security=share and will
3710 be ignored if this is not the case.
3711
3712 If "revalidate" is True then the client will be denied automatic
3713 access as the same username.
3714
3715 .B Default:
3716         revalidate = False
3717
3718 .B Example:
3719         revalidate = True
3720
3721 .SS root (G)
3722 See
3723 .B root directory.
3724 .SS root dir (G)
3725 See
3726 .B root directory.
3727 .SS root directory (G)
3728 Synonyms for this parameter are 'root dir' and 'root'.
3729
3730 The server will chroot() to this directory on startup. This is not 
3731 strictly necessary for secure operation. Even without it the server
3732 will deny access to files not in one of the service entries. It may 
3733 also check for, and deny access to, soft links to other parts of the 
3734 filesystem, or attempts to use .. in file names to access other 
3735 directories (depending on the setting of the "wide links" parameter).
3736
3737 Adding a "root dir" entry other than "/" adds an extra level of security, 
3738 but at a price. It absolutely ensures that no access is given to files not
3739 in the sub-tree specified in the "root dir" option, *including* some files 
3740 needed for complete operation of the server. To maintain full operability
3741 of the server you will need to mirror some system files into the "root dir"
3742 tree. In particular you will need to mirror /etc/passwd (or a subset of it),
3743 and any binaries or configuration files needed for printing (if required). 
3744 The set of files that must be mirrored is operating system dependent.
3745
3746 .B Default:
3747         root directory = /
3748
3749 .B Example:
3750         root directory = /homes/smb
3751 .SS root postexec (S)
3752
3753 This is the same as postexec except that the command is run as
3754 root. This is useful for unmounting filesystems (such as cdroms) after
3755 a connection is closed.
3756
3757 .SS root preexec (S)
3758
3759 This is the same as preexec except that the command is run as
3760 root. This is useful for mounting filesystems (such as cdroms) before
3761 a connection is finalised.
3762
3763 .SS security (G)
3764 This option affects how clients respond to Samba.
3765
3766 The option sets the "security mode bit" in replies to protocol negotiations
3767 to turn share level security on or off. Clients decide based on this bit 
3768 whether (and how) to transfer user and password information to the server.
3769
3770 The default is "security=SHARE", mainly because that was the only
3771 option at one stage.
3772
3773 The alternatives are "security = user" or "security = server". 
3774
3775 If your PCs use usernames that are the same as their usernames on the
3776 UNIX machine then you will want to use "security = user". If you
3777 mostly use usernames that don't exist on the UNIX box then use
3778 "security = share".
3779
3780 There is a bug in WfWg that may affect your decision. When in user
3781 level security a WfWg client will totally ignore the password you type
3782 in the "connect drive" dialog box. This makes it very difficult (if
3783 not impossible) to connect to a Samba service as anyone except the
3784 user that you are logged into WfWg as.
3785
3786 If you use "security = server" then Samba will try to validate the
3787 username/password by passing it to another SMB server, such as an NT
3788 box. If this fails it will revert to "security = USER", but note that
3789 if encrypted passwords have been negotiated then Samba cannot revert
3790 back to checking the UNIX password file, it must have a valid 
3791 smbpasswd file to check users against. See the documentation
3792 docs/ENCRYPTION.txt for details on how to set this up.
3793
3794 See the "password server" option for more details.
3795
3796 .B Default:
3797         security = SHARE
3798
3799 .B Example:
3800         security = USER
3801 .SS server string (G)
3802 This controls what string will show up in the printer comment box in
3803 print manager and next to the IPC connection in "net view". It can be
3804 any string that you wish to show to your users.
3805
3806 It also sets what will appear in browse lists next to the machine name.
3807
3808 A %v will be replaced with the Samba version number.
3809
3810 A %h will be replaced with the hostname.
3811
3812 .B Default:
3813         server string = Samba %v
3814
3815 .B Example:
3816         server string = University of GNUs Samba Server
3817
3818 .SS set directory (S)
3819 If 'set directory = no', then users of the service may not use the setdir
3820 command to change directory.
3821
3822 The setdir command is only implemented in the Digital Pathworks client. See the
3823 Pathworks documentation for details.
3824
3825 .B Default:
3826         set directory = no
3827
3828 .B Example:
3829         set directory = yes
3830
3831 .SS shared file entries (G)
3832 This parameter has been removed (as of Samba 1.9.18 and above). The new
3833 System V shared memory code prohibits the user from allocating the
3834 share hash bucket size directly.
3835
3836 .SS shared mem size (G)
3837 This parameter is only useful when Samba has been compiled with FAST_SHARE_MODES.
3838 It specifies the size of the shared memory (in bytes) to use between smbd 
3839 processes. You should never change this parameter unless you have studied 
3840 the source and know what you are doing. This parameter defaults to 1024
3841 multiplied by the setting of the maximum number of open files in the
3842 file local.h in the Samba source code. MAX_OPEN_FILES is normally set
3843 to 100, so this parameter defaults to 102400 bytes.
3844
3845 .B Default
3846         shared mem size = 102400
3847
3848 .SS smb passwd file (G)
3849 This option sets the path to the encrypted smbpasswd file. This is a *VERY
3850 DANGEROUS OPTION* if the smb.conf is user writable. By default the path
3851 to the smbpasswd file is compiled into Samba.
3852
3853 .SS smbrun (G)
3854 This sets the full path to the smbrun binary. This defaults to the
3855 value in the Makefile.
3856
3857 You must get this path right for many services to work correctly.
3858
3859 .B Default:
3860 taken from Makefile
3861
3862 .B Example:
3863         smbrun = /usr/local/samba/bin/smbrun
3864
3865 .SS share modes (S)
3866
3867 This enables or disables the honouring of the "share modes" during a
3868 file open. These modes are used by clients to gain exclusive read or
3869 write access to a file. 
3870
3871 These open modes are not directly supported by UNIX, so they are
3872 simulated using lock files in the "lock directory". The "lock
3873 directory" specified in smb.conf must be readable by all users.
3874
3875 The share modes that are enabled by this option are DENY_DOS,
3876 DENY_ALL, DENY_READ, DENY_WRITE, DENY_NONE and DENY_FCB.
3877
3878 Enabling this option gives full share compatibility but may cost a bit
3879 of processing time on the UNIX server. They are enabled by default.
3880
3881 .B Default:
3882         share modes = yes
3883
3884 .B Example:
3885         share modes = no
3886
3887 .SS short preserve case (S)
3888
3889 This controls if new short filenames are created with the case that
3890 the client passes, or if they are forced to be the "default" case.
3891
3892 .B Default:
3893        short preserve case = no
3894
3895 See the section on "NAME MANGLING" for a fuller discussion.
3896
3897 .SS socket address (G)
3898
3899 This option allows you to control what address Samba will listen for
3900 connections on. This is used to support multiple virtual interfaces on
3901 the one server, each with a different configuration.
3902
3903 By default samba will accept connections on any address.
3904
3905 .B Example:
3906         socket address = 192.168.2.20
3907
3908 .SS socket options (G)
3909 This option (which can also be invoked with the -O command line
3910 option) allows you to set socket options to be used when talking with
3911 the client.
3912
3913 Socket options are controls on the networking layer of the operating
3914 systems which allow the connection to be tuned.
3915
3916 This option will typically be used to tune your Samba server for
3917 optimal performance for your local network. There is no way that Samba
3918 can know what the optimal parameters are for your net, so you must
3919 experiment and choose them yourself. I strongly suggest you read the
3920 appropriate documentation for your operating system first (perhaps
3921 "man setsockopt" will help).
3922
3923 You may find that on some systems Samba will say "Unknown socket
3924 option" when you supply an option. This means you either mis-typed it
3925 or you need to add an include file to includes.h for your OS. If the
3926 latter is the case please send the patch to me
3927 (samba-bugs@samba.anu.edu.au).
3928
3929 Any of the supported socket options may be combined in any way you
3930 like, as long as your OS allows it.
3931
3932 This is the list of socket options currently settable using this
3933 option:
3934
3935   SO_KEEPALIVE
3936
3937   SO_REUSEADDR
3938
3939   SO_BROADCAST
3940
3941   TCP_NODELAY
3942
3943   IPTOS_LOWDELAY
3944
3945   IPTOS_THROUGHPUT
3946
3947   SO_SNDBUF *
3948
3949   SO_RCVBUF *
3950
3951   SO_SNDLOWAT *
3952
3953   SO_RCVLOWAT *
3954
3955 Those marked with a * take an integer argument. The others can
3956 optionally take a 1 or 0 argument to enable or disable the option, by
3957 default they will be enabled if you don't specify 1 or 0.
3958
3959 To specify an argument use the syntax SOME_OPTION=VALUE for example
3960 SO_SNDBUF=8192. Note that you must not have any spaces before or after
3961 the = sign.
3962
3963 If you are on a local network then a sensible option might be
3964
3965 socket options = IPTOS_LOWDELAY
3966
3967 If you have an almost unloaded local network and you don't mind a lot
3968 of extra CPU usage in the server then you could try
3969
3970 socket options = IPTOS_LOWDELAY TCP_NODELAY
3971
3972 If you are on a wide area network then perhaps try setting
3973 IPTOS_THROUGHPUT. 
3974
3975 Note that several of the options may cause your Samba server to fail
3976 completely. Use these options with caution!
3977
3978 .B Default:
3979         no socket options
3980
3981 .B Example:
3982         socket options = IPTOS_LOWDELAY 
3983
3984
3985
3986
3987 .SS status (G)
3988 This enables or disables logging of connections to a status file that
3989 .B smbstatus
3990 can read.
3991
3992 With this disabled
3993 .B smbstatus
3994 won't be able to tell you what
3995 connections are active.
3996
3997 .B Default:
3998         status = yes
3999
4000 .B Example:
4001         status = no
4002
4003 .SS strict locking (S)
4004 This is a boolean that controls the handling of file locking in the
4005 server. When this is set to yes the server will check every read and
4006 write access for file locks, and deny access if locks exist. This can
4007 be slow on some systems.
4008
4009 When strict locking is "no" the server does file lock checks only when
4010 the client explicitly asks for them. 
4011
4012 Well behaved clients always ask for lock checks when it is important,
4013 so in the vast majority of cases "strict locking = no" is preferable.
4014
4015 .B Default:
4016         strict locking = no
4017
4018 .B Example:
4019         strict locking = yes
4020
4021 .SS strict sync (S)
4022 Many Windows applications (including the Windows 98 explorer
4023 shell) seem to confuse flushing buffer contents to disk with
4024 doing a sync to disk. Under UNIX, a sync call forces the process
4025 to be suspended until the kernel has ensured that all outstanding
4026 data in kernel disk buffers has been safely stored onto stable
4027 storate. This is very slow and should only be done rarely. Setting
4028 this parameter to "no" (the default) means that smbd ignores the
4029 Windows applications requests for a sync call. There is only a
4030 possibility of losing data if the operating system itself that
4031 Samba is running on crashes, so there is little danger in this
4032 default setting. In addition, this fixes many performace problems
4033 that people have reported with the new Windows98 explorer shell
4034 file copies.
4035
4036 See also the "sync always" parameter.
4037
4038 .B Default:
4039      strict sync = no
4040
4041 .B Example:
4042      strict sync = yes
4043
4044
4045 .SS strip dot (G)
4046 This is a boolean that controls whether to strip trailing dots off
4047 UNIX filenames. This helps with some CDROMs that have filenames ending in a
4048 single dot.
4049
4050 .B Default:
4051         strip dot = no
4052
4053 .B Example:
4054     strip dot = yes
4055
4056 .SS syslog (G)
4057 This parameter maps how Samba debug messages are logged onto the
4058 system syslog logging levels. Samba debug level zero maps onto
4059 syslog LOG_ERR, debug level one maps onto LOG_WARNING, debug
4060 level two maps to LOG_NOTICE, debug level three maps onto LOG_INFO.
4061 The paramter sets the threshold for doing the mapping, all Samba
4062 debug messages above this threashold are mapped to syslog LOG_DEBUG
4063 messages.
4064
4065 .B Default:
4066
4067         syslog = 1
4068
4069 .SS syslog only (G)
4070 If this parameter is set then Samba debug messages are logged into
4071 the system syslog only, and not to the debug log files.
4072
4073 .B Default:
4074         syslog only = no
4075
4076 .SS sync always (S)
4077
4078 This is a boolean parameter that controls whether writes will always
4079 be written to stable storage before the write call returns. If this is
4080 false then the server will be guided by the client's request in each
4081 write call (clients can set a bit indicating that a particular write
4082 should be synchronous). If this is true then every write will be
4083 followed by a fsync() call to ensure the data is written to disk.
4084 Note that the "strict sync" parameter must be set to "yes" in
4085 order for this parameter to have any affect.
4086
4087 See also the "strict sync" parameter.
4088
4089 .B Default:
4090         sync always = no
4091
4092 .B Example:
4093         sync always = yes
4094
4095 .SS time offset (G)
4096 This parameter is a setting in minutes to add to the normal GMT to
4097 local time conversion. This is useful if you are serving a lot of PCs
4098 that have incorrect daylight saving time handling.
4099
4100 .B Default:
4101         time offset = 0
4102
4103 .B Example:
4104         time offset = 60
4105
4106 .SS time server (G)
4107 This parameter determines if nmbd advertises itself as a time server
4108 to Windows clients. The default is False.
4109
4110 .B Default:
4111         time server = False
4112
4113 .B Example:
4114         time server = True
4115
4116 .SS unix password sync (G)
4117 This boolean parameter controlls whether Samba attempts to synchronise
4118 the UNIX password with the SMB password when the encrypted SMB password
4119 in the smbpasswd file is changed. If this is set to true the 'passwd program'
4120 program is called *AS ROOT* - to allow the new UNIX password to be set
4121 without access to the old UNIX password (as the SMB password has change
4122 code has no access to the old password cleartext, only the new). By
4123 default this is set to false.
4124
4125 See also 'passwd program', 'passwd chat'
4126
4127 .B Default:
4128          unix password sync = False
4129
4130 .B Example:
4131          unix password sync = True
4132
4133 .SS unix realname (G)
4134 This boolean parameter when set causes samba to supply the real name field
4135 from the unix password file to the client. This is useful for setting up
4136 mail clients and WWW browsers on systems used by more than one person.
4137
4138 .B Default:
4139         unix realname = no
4140
4141 .B Example:
4142         unix realname = yes
4143
4144 .SS update encrypted (G)
4145 This boolean parameter allows a user logging on with a plaintext
4146 password to have their encrypted (hashed) password in the smbpasswd
4147 file to be updated automatically as they log on. This option allows
4148 a site to migrate from plaintext password authentication (users 
4149 authenticate with plaintext password over the wire, and are checked
4150 against a UNIX account database) to encrypted password authentication
4151 (the SMB challenge/response authentication mechanism) without forcing
4152 all users to re-enter their passwords via smbpasswd at the time the change
4153 is made. This is a convenience option to allow the change over to
4154 encrypted passwords to be made over a longer period. Once all users
4155 have encrypted representations of their passwords in the smbpasswd
4156 file this parameter should be set to "off".
4157
4158 In order for this parameter to work correctly the "encrypt passwords"
4159 must be set to "no" when this parameter is set to "yes".
4160
4161 Note that even when this parameter is set a user authenticating to
4162 smbd must still enter a valid password in order to connect correctly,
4163 and to update their hashed (smbpasswd) passwords.
4164
4165 .B Default:
4166         update encrypted = no
4167
4168 .B Example:
4169         update encrypted = yes
4170
4171 .SS user (S)
4172 See
4173 .B username.
4174 .SS username (S)
4175 A synonym for this parameter is 'user'.
4176
4177 Multiple users may be specified in a comma-delimited list, in which case the
4178 supplied password will be tested against each username in turn (left to right).
4179
4180 The username= line is needed only when the PC is unable to supply its own
4181 username. This is the case for the coreplus protocol or where your
4182 users have different WfWg usernames to UNIX usernames. In both these
4183 cases you may also be better using the \e\eserver\eshare%user syntax
4184 instead. 
4185
4186 The username= line is not a great solution in many cases as it means Samba
4187 will try to validate the supplied password against each of the
4188 usernames in the username= line in turn. This is slow and a bad idea for
4189 lots of users in case of duplicate passwords. You may get timeouts or
4190 security breaches using this parameter unwisely.
4191
4192 Samba relies on the underlying UNIX security. This parameter does not
4193 restrict who can login, it just offers hints to the Samba server as to
4194 what usernames might correspond to the supplied password. Users can
4195 login as whoever they please and they will be able to do no more
4196 damage than if they started a telnet session. The daemon runs as the
4197 user that they log in as, so they cannot do anything that user cannot
4198 do.
4199
4200 To restrict a service to a particular set of users you can use the
4201 "valid users=" line.
4202
4203 If any of the usernames begin with a @ then the name will be looked up
4204 first in the yp netgroups list (if Samba is compiled with netgroup support),
4205 followed by a lookup in the UNIX groups database and will expand to a list of
4206 all users in the group of that name.
4207
4208 If any of the usernames begin with a + then the name will be looked up only
4209 in the UNIX groups database and will expand to a list of all users in the 
4210 group of that name.
4211
4212 If any of the usernames begin with a & then the name will be looked up only
4213 in the yp netgroups database (if Samba is compiled with netgroup support) and
4214 will expand to a list of all users in the netgroup group of that name.
4215
4216 Note that searching though a groups database can take quite
4217 some time, and some clients may time out during the search.
4218
4219 See the section below on username/password validation for more information
4220 on how this parameter determines access to the services.
4221
4222 .B Default:
4223         The guest account if a guest service, else the name of the service.
4224
4225 .B Examples:
4226         username = fred
4227         username = fred, mary, jack, jane, @users, @pcgroup
4228
4229 .SS username level (G)
4230
4231 This option helps Samba to try and 'guess' at the real UNIX username,
4232 as many DOS clients send an all-uppercase username. By default Samba
4233 tries all lowercase, followed by the username with the first letter
4234 capitalized, and fails if the username is not found on the UNIX machine.
4235
4236 If this parameter is set to non-zero the behaviour changes. This 
4237 parameter is a number that specifies the number of uppercase combinations 
4238 to try whilst trying to determine the UNIX user name. The higher the number
4239 the more combinations will be tried, but the slower the discovery
4240 of usernames will be. Use this parameter when you have strange
4241 usernames on your UNIX machine, such as 'AstrangeUser'.
4242
4243 .B Default:
4244     username level = 0
4245
4246 .B Example:
4247     username level = 5
4248
4249 .SS username map (G)
4250
4251 This option allows you to to specify a file containing a mapping of
4252 usernames from the clients to the server. This can be used for several
4253 purposes. The most common is to map usernames that users use on DOS or
4254 Windows machines to those that the UNIX box uses. The other is to map
4255 multiple users to a single username so that they can more easily share
4256 files.
4257
4258 The map file is parsed line by line. Each line should contain a single
4259 UNIX username on the left then a '=' followed by a list of usernames
4260 on the right. The list of usernames on the right may contain names of
4261 the form @group in which case they will match any UNIX username in
4262 that group. The special client name '*' is a wildcard and matches any
4263 name. Each line of the map file may be up to 1023 characters long.
4264
4265 The file is processed on each line by taking the supplied username and
4266 comparing it with each username on the right hand side of the '='
4267 signs. If the supplied name matches any of the names on the right
4268 hand side then it is replaced with the name on the left. Processing
4269 then continues with the next line.
4270
4271 If any line begins with a '#' or a ';' then it is ignored
4272
4273 If any line begins with an ! then the processing will stop after that
4274 line if a mapping was done by the line. Otherwise mapping continues
4275 with every line being processed. Using ! is most useful when you have
4276 a wildcard mapping line later in the file.
4277
4278 For example to map from the name "admin" or "administrator" to the UNIX
4279 name "root" you would use
4280
4281         root = admin administrator
4282
4283 Or to map anyone in the UNIX group "system" to the UNIX name "sys" you
4284 would use
4285
4286         sys = @system
4287
4288 You can have as many mappings as you like in a username map file.
4289
4290 If Samba has been compiled with the -DNETGROUP compile option
4291 then the netgroup database is checked before the /etc/group
4292 database for matching groups.
4293
4294 You can map Windows usernames that have spaces in them by using double
4295 quotes around the name. For example:
4296
4297         tridge = "Andrew Tridgell"
4298
4299 would map the windows username "Andrew Tridgell" to the unix username
4300 tridge.
4301
4302 The following example would map mary and fred to the unix user sys,
4303 and map the rest to guest. Note the use of the ! to tell Samba to stop
4304 processing if it gets a match on that line.
4305
4306         !sys = mary fred
4307         guest = *
4308
4309
4310 Note that the remapping is applied to all occurrences of
4311 usernames. Thus if you connect to "\e\eserver\efred" and "fred" is
4312 remapped to "mary" then you will actually be connecting to
4313 "\e\eserver\emary" and will need to supply a password suitable for
4314 "mary" not "fred". The only exception to this is the username passed
4315 to the "password server" (if you have one). The password server will
4316 receive whatever username the client supplies without modification.
4317
4318 Also note that no reverse mapping is done. The main effect this has is
4319 with printing. Users who have been mapped may have trouble deleting
4320 print jobs as PrintManager under WfWg will think they don't own the
4321 print job.
4322
4323 .B Default
4324         no username map
4325
4326 .B Example
4327         username map = /usr/local/samba/lib/users.map
4328
4329 .SS valid chars (S)
4330
4331 The option allows you to specify additional characters that should be
4332 considered valid by the server in filenames. This is particularly
4333 useful for national character sets, such as adding u-umlaut or a-ring.
4334
4335 The option takes a list of characters in either integer or character
4336 form with spaces between them. If you give two characters with a colon
4337 between them then it will be taken as an lowercase:uppercase pair.
4338
4339 If you have an editor capable of entering the characters into the
4340 config file then it is probably easiest to use this method. Otherwise
4341 you can specify the characters in octal, decimal or hexadecimal form
4342 using the usual C notation.
4343
4344 For example to add the single character 'Z' to the charset (which is a
4345 pointless thing to do as it's already there) you could do one of the
4346 following
4347
4348 valid chars = Z
4349 valid chars = z:Z
4350 valid chars = 0132:0172
4351
4352 The last two examples above actually add two characters, and alter
4353 the uppercase and lowercase mappings appropriately.
4354
4355 Note that you MUST specify this parameter after the "client code page"
4356 parameter if you have both set. If "client code page" is set after
4357 the "valid chars" parameter the "valid chars" settings will be
4358 overwritten.
4359
4360 See also the "client code page" parameter.
4361
4362 .B Default
4363 .br
4364         Samba defaults to using a reasonable set of valid characters
4365 .br
4366         for english systems
4367
4368 .B Example
4369         valid chars = 0345:0305 0366:0326 0344:0304
4370
4371 The above example allows filenames to have the swedish characters in
4372 them. 
4373
4374 NOTE: It is actually quite difficult to correctly produce a "valid
4375 chars" line for a particular system. To automate the process
4376 tino@augsburg.net has written a package called "validchars" which will
4377 automatically produce a complete "valid chars" line for a given client
4378 system. Look in the examples subdirectory for this package.
4379
4380 .SS valid users (S)
4381 This is a list of users that should be allowed to login to this
4382 service. A name starting with @ is interpreted as a UNIX group.
4383
4384 If this is empty (the default) then any user can login. If a username
4385 is in both this list and the "invalid users" list then access is
4386 denied for that user.
4387
4388 The current servicename is substituted for %S. This is useful in the
4389 [homes] section.
4390
4391 See also "invalid users"
4392
4393 .B Default
4394         No valid users list. (anyone can login)
4395
4396 .B Example
4397         valid users = greg, @pcusers
4398
4399
4400 .SS veto files(S)
4401 This is a list of files and directories that are neither visible nor
4402 accessible.  Each entry in the list must be separated by a "/", which
4403 allows spaces to be included in the entry.  '*' and '?' can be used to
4404 specify multiple files or directories as in DOS wildcards.
4405
4406 Each entry must be a unix path, not a DOS path and must not include the 
4407 unix directory separator "/".
4408
4409 Note that the case sensitivity option is applicable in vetoing files.
4410
4411 One feature of the veto files parameter that it is important to be
4412 aware of, is that if a directory contains nothing but files that
4413 match the veto files parameter (which means that Windows/DOS clients
4414 cannot ever see them) is deleted, the veto files within that directory
4415 *are automatically deleted* along with it, if the user has UNIX permissions
4416 to do so.
4417  
4418 Setting this parameter will affect the performance of Samba, as
4419 it will be forced to check all files and directories for a match
4420 as they are scanned.
4421
4422 See also "hide files" and "case sensitive"
4423
4424 .B Default
4425         No files or directories are vetoed.
4426
4427 .B Examples
4428     Example 1.
4429     Veto any files containing the word Security, 
4430     any ending in .tmp, and any directory containing the
4431     word root.
4432
4433         veto files = /*Security*/*.tmp/*root*/
4434
4435     Example 2.
4436     Veto the Apple specific files that a NetAtalk server
4437     creates.
4438
4439     veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
4440
4441 .SS veto oplock files (S)
4442 This parameter is only valid when the 'oplocks' parameter is turned on
4443 for a share. It allows the Samba administrator to selectively turn off
4444 the granting of oplocks on selected files that match a wildcarded list,
4445 similar to the wildcarded list used in the 'veto files' parameter.
4446
4447 .B Default
4448     No files are vetoed for oplock grants.
4449
4450 .B Examples
4451 You might want to do this on files that you know will be heavily
4452 contended for by clients. A good example of this is in the NetBench
4453 SMB benchmark program, which causes heavy client contention for files
4454 ending in .SEM. To cause Samba not to grant oplocks on these files
4455 you would use the line (either in the [global] section or in the section
4456 for the particular NetBench share :
4457
4458      veto oplock files = /*.SEM/
4459
4460 .SS volume (S)
4461 This allows you to override the volume label returned for a
4462 share. Useful for CDROMs with installation programs that insist on a
4463 particular volume label.
4464
4465 The default is the name of the share
4466
4467 .SS wide links (S)
4468 This parameter controls whether or not links in the UNIX file system may be
4469 followed by the server. Links that point to areas within the directory tree
4470 exported by the server are always allowed; this parameter controls access 
4471 only to areas that are outside the directory tree being exported.
4472
4473 .B Default:
4474         wide links = yes
4475
4476 .B Example:
4477         wide links = no
4478
4479 .SS wins proxy (G)
4480
4481 This is a boolean that controls if nmbd will respond to broadcast name
4482 queries on behalf of other hosts. You may need to set this to no for
4483 some older clients.
4484
4485 .B Default:
4486         wins proxy = no
4487 .SS wins server (G)
4488
4489 This specifies the DNS name (or IP address) of the WINS server that Samba 
4490 should register with. If you have a WINS server on your network then you
4491 should set this to the WINS servers name.
4492
4493 You should point this at your WINS server if you have a multi-subnetted
4494 network.
4495 .B Default:
4496         wins server = 
4497
4498 .SS wins support (G)
4499
4500 This boolean controls if the nmbd process in Samba will act as a WINS server. 
4501 You should not set this to true unless you have a multi-subnetted network and
4502 you wish a particular nmbd to be your WINS server. Note that you
4503 should *NEVER* set this to true on more than one machine in your
4504 network.
4505
4506 .B Default:
4507         wins support = no
4508
4509 .SS workgroup (G)
4510
4511 This controls what workgroup your server will appear to be in when
4512 queried by clients. 
4513
4514 .B Default:
4515         set in the Makefile
4516
4517 .B Example:
4518         workgroup = MYGROUP
4519
4520 .SS writable (S)
4521 A synonym for this parameter is 'write ok'. An inverted synonym is 'read only'.
4522
4523 If this parameter is 'no', then users of a service may not create or modify
4524 files in the service's directory.
4525
4526 Note that a printable service ('printable = yes') will ALWAYS allow 
4527 writing to the directory (user privileges permitting), but only via
4528 spooling operations.
4529
4530 .B Default:
4531         writable = no
4532
4533 .B Examples:
4534         read only = no
4535         writable = yes
4536         write ok = yes
4537 .SS write list (S)
4538 This is a list of users that are given read-write access to a
4539 service. If the connecting user is in this list then they will be
4540 given write access, no matter what the "read only" option is set
4541 to. The list can include group names using the @group syntax.
4542
4543 Note that if a user is in both the read list and the write list then
4544 they will be given write access.
4545
4546 See also the "read list" option
4547
4548 .B Default:
4549      write list =
4550
4551 .B Example:
4552      write list = admin, root, @staff
4553
4554 .SS write ok (S)
4555 See
4556 .B writable
4557 and
4558 .B read only.
4559 .SS write raw (G)
4560 This parameter controls whether or not the server will support raw writes when
4561 transferring data from clients.
4562
4563 .B Default:
4564         write raw = yes
4565
4566 .B Example:
4567         write raw = no
4568
4569 .SH NOTE ABOUT USERNAME/PASSWORD VALIDATION
4570 There are a number of ways in which a user can connect to a
4571 service. The server follows the following steps in determining if it
4572 will allow a connection to a specified service. If all the steps fail
4573 then the connection request is rejected. If one of the steps pass then
4574 the following steps are not checked.
4575
4576 If the service is marked "guest only = yes" then steps 1 to 5 are skipped
4577
4578 Step 1: If the client has passed a username/password pair and that
4579 username/password pair is validated by the UNIX system's password
4580 programs then the connection is made as that username. Note that this
4581 includes the \e\eserver\eservice%username method of passing a username.
4582
4583 Step 2: If the client has previously registered a username with the
4584 system and now supplies a correct password for that username then the
4585 connection is allowed.
4586
4587 Step 3: The client's netbios name and any previously used user names
4588 are checked against the supplied password, if they match then the
4589 connection is allowed as the corresponding user.
4590
4591 Step 4: If the client has previously validated a username/password
4592 pair with the server and the client has&