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