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