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