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