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