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