preparing for release of 2.0.5a
[Samba/gbeck.git] / docs / manpages / smb.conf.5
blobcfb456699a6a38d26ba0e64286dab24af3668a35
1 .TH SMB.CONF 5 "22 Jul 1999" "smb.conf 2.0.5a"
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 
89 .DS 
93         [foo]
94                 path = /home/bar
95                 writeable = true
98 .DE 
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 
109 .DS 
112         [aprinter]
113                 path = /usr/spool/public
114                 read only = true
115                 printable = true
116                 guest ok = true
118 .DE 
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 
178 .DS 
181         [homes]
182                 writeable = yes
184 .DE 
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 
240 .DS 
243         [printers]
244                 path = /usr/spool/public
245                 writeable = no
246                 guest ok = yes
247                 printable = yes 
249 .DE 
252 .IP 
253 All aliases given for a printer in the printcap file are legitimate
254 printer names as far as the server is concerned\&. If your printing
255 subsystem doesn\'t work like that, you will have to set up a
256 pseudo-printcap\&. This is a file consisting of one or more lines like
257 this:
258 .IP 
260 .DS 
262         alias|alias|alias|alias\&.\&.\&.    
263 .DE 
266 .IP 
267 Each alias should be an acceptable printer name for your printing
268 subsystem\&. In the \fB[global]\fP section, specify the new
269 file as your printcap\&.  The server will then only recognize names
270 found in your pseudo-printcap, which of course can contain whatever
271 aliases you like\&. The same technique could be used simply to limit
272 access to a subset of your local printers\&.
273 .IP 
274 An alias, by the way, is defined as any component of the first entry
275 of a printcap record\&. Records are separated by newlines, components
276 (if there are more than one) are separated by vertical bar symbols
277 ("|")\&.
278 .IP 
279 NOTE: On SYSV systems which use lpstat to determine what printers are
280 defined on the system you may be able to use \fB"printcap name =
281 lpstat"\fP to automatically obtain a list of
282 printers\&. See the \fB"printcap name"\fP option for
283 more details\&.
284 .IP 
285 .PP 
286 .SH "PARAMETERS" 
287 .PP 
288 Parameters define the specific attributes of sections\&.
289 .PP 
290 Some parameters are specific to the \fB[global]\fP section
291 (e\&.g\&., \fBsecurity\fP)\&.  Some parameters are usable in
292 all sections (e\&.g\&., \fBcreate mode\fP)\&. All others are
293 permissible only in normal sections\&. For the purposes of the following
294 descriptions the \fB[homes]\fP and
295 \fB[printers]\fP sections will be considered normal\&.
296 The letter \f(CW\'G\'\fP in parentheses indicates that a parameter is
297 specific to the \fB[global]\fP section\&. The letter \f(CW\'S\'\fP
298 indicates that a parameter can be specified in a service specific
299 section\&. Note that all \f(CW\'S\'\fP parameters can also be specified in the
300 \fB[global]\fP section - in which case they will define
301 the default behavior for all services\&.
302 .PP 
303 Parameters are arranged here in alphabetical order - this may not
304 create best bedfellows, but at least you can find them! Where there
305 are synonyms, the preferred synonym is described, others refer to the
306 preferred synonym\&.
307 .PP 
308 .SH "VARIABLE SUBSTITUTIONS" 
309 .PP 
310 Many of the strings that are settable in the config file can take
311 substitutions\&. For example the option \fB\f(CW"path =
312 /tmp/%u"\fP\fP would be interpreted as \f(CW"path = /tmp/john"\fP if
313 the user connected with the username john\&.
314 .PP 
315 These substitutions are mostly noted in the descriptions below, but
316 there are some general substitutions which apply whenever they might
317 be relevant\&. These are:
318 .PP 
319 .IP 
320 .IP o 
321 \fB%S\fP = the name of the current service, if any\&.
322 .IP 
323 .IP o 
324 \fB%P\fP = the root directory of the current service, if any\&.
325 .IP 
326 .IP o 
327 \fB%u\fP = user name of the current service, if any\&.
328 .IP 
329 .IP o 
330 \fB%g\fP = primary group name of \fB%u\fP\&.
331 .IP 
332 .IP o 
333 \fB%U\fP = session user name (the user name that
334 the client wanted, not necessarily the same as the one they got)\&.
335 .IP 
336 .IP o 
337 \fB%G\fP = primary group name of \fB%U\fP\&.
338 .IP 
339 .IP o 
340 \fB%H\fP = the home directory of the user given by \fB%u\fP\&.
341 .IP 
342 .IP o 
343 \fB%v\fP = the Samba version\&.
344 .IP 
345 .IP o 
346 \fB%h\fP = the internet hostname that Samba is running on\&.
347 .IP 
348 .IP o 
349 \fB%m\fP = the NetBIOS name of the client machine (very useful)\&.
350 .IP 
351 .IP o 
352 \fB%L\fP = the NetBIOS name of the server\&. This allows you to change your
353 config based on what the client calls you\&. Your server can have a "dual
354 personality"\&.
355 .IP 
356 .IP o 
357 \fB%M\fP = the internet name of the client machine\&.
358 .IP 
359 .IP o 
360 \fB%N\fP = the name of your NIS home directory server\&.  This is
361 obtained from your NIS auto\&.map entry\&.  If you have not compiled Samba
362 with the \fB--with-automount\fP option then this value will be the same
363 as \fB%L\fP\&.
364 .IP 
365 .IP o 
366 \fB%p\fP = the path of the service\'s home directory, obtained from your NIS
367 auto\&.map entry\&. The NIS auto\&.map entry is split up as "%N:%p"\&.
368 .IP 
369 .IP o 
370 \fB%R\fP = the selected protocol level after protocol
371 negotiation\&. It can be one of CORE, COREPLUS, LANMAN1, LANMAN2 or NT1\&.
372 .IP 
373 .IP o 
374 \fB%d\fP = The process id of the current server process\&.
375 .IP 
376 .IP o 
377 \fB%a\fP = the architecture of the remote
378 machine\&. Only some are recognized, and those may not be 100%
379 reliable\&. It currently recognizes Samba, WfWg, WinNT and
380 Win95\&. Anything else will be known as "UNKNOWN"\&. If it gets it wrong
381 then sending a level 3 log to \fIsamba-bugs@samba\&.org\fP
382 should allow it to be fixed\&.
383 .IP 
384 .IP o 
385 \fB%I\fP = The IP address of the client machine\&.
386 .IP 
387 .IP o 
388 \fB%T\fP = the current date and time\&.
389 .IP 
390 .PP 
391 There are some quite creative things that can be done with these
392 substitutions and other smb\&.conf options\&.
393 .PP 
394 .SH "NAME MANGLING" 
395 .PP 
396 Samba supports \fI"name mangling"\fP so that DOS and Windows clients can
397 use files that don\'t conform to the 8\&.3 format\&. It can also be set to
398 adjust the case of 8\&.3 format filenames\&.
399 .PP 
400 There are several options that control the way mangling is performed,
401 and they are grouped here rather than listed separately\&. For the
402 defaults look at the output of the testparm program\&.
403 .PP 
404 All of these options can be set separately for each service (or
405 globally, of course)\&.
406 .PP 
407 The options are:
408 .PP 
409 \fB"mangle case = yes/no"\fP controls if names that have characters that
410 aren\'t of the "default" case are mangled\&. For example, if this is yes
411 then a name like \f(CW"Mail"\fP would be mangled\&. Default \fIno\fP\&.
412 .PP 
413 \fB"case sensitive = yes/no"\fP controls whether filenames are case
414 sensitive\&. If they aren\'t then Samba must do a filename search and
415 match on passed names\&. Default \fIno\fP\&.
416 .PP 
417 \fB"default case = upper/lower"\fP controls what the default case is for new
418 filenames\&. Default \fIlower\fP\&.
419 .PP 
420 \fB"preserve case = yes/no"\fP controls if new files are created with the
421 case that the client passes, or if they are forced to be the \f(CW"default"\fP
422 case\&. Default \fIYes\fP\&.
423 .PP 
424 .PP 
425 \fB"short preserve case = yes/no"\fP controls if new files which conform
426 to 8\&.3 syntax, that is all in upper case and of suitable length, are
427 created upper case, or if they are forced to be the \f(CW"default"\fP
428 case\&. This option can be use with \fB"preserve case =
429 yes"\fP to permit long filenames to retain their
430 case, while short names are lowered\&. Default \fIYes\fP\&.
431 .PP 
432 By default, Samba 2\&.0 has the same semantics as a Windows NT
433 server, in that it is case insensitive but case preserving\&.
434 .PP 
435 .SH "NOTE ABOUT USERNAME/PASSWORD VALIDATION" 
436 .PP 
437 There are a number of ways in which a user can connect to a
438 service\&. The server follows the following steps in determining if it
439 will allow a connection to a specified service\&. If all the steps fail
440 then the connection request is rejected\&. If one of the steps pass then
441 the following steps are not checked\&.
442 .PP 
443 If the service is marked \fB"guest only = yes"\fP then
444 steps 1 to 5 are skipped\&.
445 .PP 
446 .IP 
447 .IP 1\&. 
448 Step 1: If the client has passed a username/password pair and
449 that username/password pair is validated by the UNIX system\'s password
450 programs then the connection is made as that username\&. Note that this
451 includes the \f(CW\e\eserver\eservice%username\fP method of passing a
452 username\&.
453 .IP 
454 .IP 2\&. 
455 Step 2: If the client has previously registered a username with
456 the system and now supplies a correct password for that username then
457 the connection is allowed\&.
458 .IP 
459 .IP 3\&. 
460 Step 3: The client\'s netbios name and any previously used user
461 names are checked against the supplied password, if they match then
462 the connection is allowed as the corresponding user\&.
463 .IP 
464 .IP 4\&. 
465 Step 4: If the client has previously validated a
466 username/password pair with the server and the client has passed the
467 validation token then that username is used\&. This step is skipped if
468 \fB"revalidate = yes"\fP for this service\&.
469 .IP 
470 .IP 5\&. 
471 Step 5: If a \fB"user = "\fP field is given in the
472 smb\&.conf file for the service and the client has supplied a password,
473 and that password matches (according to the UNIX system\'s password
474 checking) with one of the usernames from the \fBuser=\fP
475 field then the connection is made as the username in the
476 \fB"user="\fP line\&. If one of the username in the
477 \fBuser=\fP list begins with a \f(CW\'@\'\fP then that name
478 expands to a list of names in the group of the same name\&.
479 .IP 
480 .IP 6\&. 
481 Step 6: If the service is a guest service then a connection is
482 made as the username given in the \fB"guest account
483 ="\fP for the service, irrespective of the supplied
484 password\&.
485 .IP 
486 .PP 
487 .SH "COMPLETE LIST OF GLOBAL PARAMETERS" 
488 .PP 
489 Here is a list of all global parameters\&. See the section of each
490 parameter for details\&.  Note that some are synonyms\&.
491 .PP 
492 .IP 
493 .IP o 
494 \fBadd user script\fP
495 .IP 
496 .IP o 
497 \fBallow trusted domains\fP
498 .IP 
499 .IP o 
500 \fBannounce as\fP
501 .IP 
502 .IP o 
503 \fBannounce version\fP
504 .IP 
505 .IP o 
506 \fBauto services\fP
507 .IP 
508 .IP o 
509 \fBbind interfaces only\fP
510 .IP 
511 .IP o 
512 \fBbrowse list\fP
513 .IP 
514 .IP o 
515 \fBchange notify timeout\fP
516 .IP 
517 .IP o 
518 \fBcharacter set\fP
519 .IP 
520 .IP o 
521 \fBclient code page\fP
522 .IP 
523 .IP o 
524 \fBcoding system\fP
525 .IP 
526 .IP o 
527 \fBconfig file\fP
528 .IP 
529 .IP o 
530 \fBdeadtime\fP
531 .IP 
532 .IP o 
533 \fBdebug timestamp\fP
534 .IP 
535 .IP o 
536 \fBdebuglevel\fP
537 .IP 
538 .IP o 
539 \fBdefault\fP
540 .IP 
541 .IP o 
542 \fBdefault service\fP
543 .IP 
544 .IP o 
545 \fBdelete user script\fP
546 .IP 
547 .IP o 
548 \fBdfree command\fP
549 .IP 
550 .IP o 
551 \fBdns proxy\fP
552 .IP 
553 .IP o 
554 \fBdomain admin group\fP
555 .IP 
556 .IP o 
557 \fBdomain admin users\fP
558 .IP 
559 .IP o 
560 \fBdomain controller\fP
561 .IP 
562 .IP o 
563 \fBdomain groups\fP
564 .IP 
565 .IP o 
566 \fBdomain guest group\fP
567 .IP 
568 .IP o 
569 \fBdomain guest users\fP
570 .IP 
571 .IP o 
572 \fBdomain logons\fP
573 .IP 
574 .IP o 
575 \fBdomain master\fP
576 .IP 
577 .IP o 
578 \fBencrypt passwords\fP
579 .IP 
580 .IP o 
581 \fBgetwd cache\fP
582 .IP 
583 .IP o 
584 \fBhomedir map\fP
585 .IP 
586 .IP o 
587 \fBhosts equiv\fP
588 .IP 
589 .IP o 
590 \fBinterfaces\fP
591 .IP 
592 .IP o 
593 \fBkeepalive\fP
594 .IP 
595 .IP o 
596 \fBkernel oplocks\fP
597 .IP 
598 .IP o 
599 \fBldap filter\fP
600 .IP 
601 .IP o 
602 \fBldap port\fP
603 .IP 
604 .IP o 
605 \fBldap root\fP
606 .IP 
607 .IP o 
608 \fBldap root passwd\fP
609 .IP 
610 .IP o 
611 \fBldap server\fP
612 .IP 
613 .IP o 
614 \fBldap suffix\fP
615 .IP 
616 .IP o 
617 \fBlm announce\fP
618 .IP 
619 .IP o 
620 \fBlm interval\fP
621 .IP 
622 .IP o 
623 \fBload printers\fP
624 .IP 
625 .IP o 
626 \fBlocal master\fP
627 .IP 
628 .IP o 
629 \fBlock dir\fP
630 .IP 
631 .IP o 
632 \fBlock directory\fP
633 .IP 
634 .IP o 
635 \fBlog file\fP
636 .IP 
637 .IP o 
638 \fBlog level\fP
639 .IP 
640 .IP o 
641 \fBlogon drive\fP
642 .IP 
643 .IP o 
644 \fBlogon home\fP
645 .IP 
646 .IP o 
647 \fBlogon path\fP
648 .IP 
649 .IP o 
650 \fBlogon script\fP
651 .IP 
652 .IP o 
653 \fBlpq cache time\fP
654 .IP 
655 .IP o 
656 \fBmachine password timeout\fP
657 .IP 
658 .IP o 
659 \fBmangled stack\fP
660 .IP 
661 .IP o 
662 \fBmap to guest\fP
663 .IP 
664 .IP o 
665 \fBmax disk size\fP
666 .IP 
667 .IP o 
668 \fBmax log size\fP
669 .IP 
670 .IP o 
671 \fBmax mux\fP
672 .IP 
673 .IP o 
674 \fBmax open files\fP
675 .IP 
676 .IP o 
677 \fBmax packet\fP
678 .IP 
679 .IP o 
680 \fBmax ttl\fP
681 .IP 
682 .IP o 
683 \fBmax wins ttl\fP
684 .IP 
685 .IP o 
686 \fBmax xmit\fP
687 .IP 
688 .IP o 
689 \fBmessage command\fP
690 .IP 
691 .IP o 
692 \fBmin passwd length\fP
693 .IP 
694 .IP o 
695 \fBmin wins ttl\fP
696 .IP 
697 .IP o 
698 \fBname resolve order\fP
699 .IP 
700 .IP o 
701 \fBnetbios aliases\fP
702 .IP 
703 .IP o 
704 \fBnetbios name\fP
705 .IP 
706 .IP o 
707 \fBnis homedir\fP
708 .IP 
709 .IP o 
710 \fBnt acl support\fP
711 .IP 
712 .IP o 
713 \fBnt pipe support\fP
714 .IP 
715 .IP o 
716 \fBnt smb support\fP
717 .IP 
718 .IP o 
719 \fBnull passwords\fP
720 .IP 
721 .IP o 
722 \fBole locking compatibility\fP
723 .IP 
724 .IP o 
725 \fBoplock break wait time\fP
726 .IP 
727 .IP o 
728 \fBos level\fP
729 .IP 
730 .IP o 
731 \fBpacket size\fP
732 .IP 
733 .IP o 
734 \fBpanic action\fP
735 .IP 
736 .IP o 
737 \fBpasswd chat\fP
738 .IP 
739 .IP o 
740 \fBpasswd chat debug\fP
741 .IP 
742 .IP o 
743 \fBpasswd program\fP
744 .IP 
745 .IP o 
746 \fBpassword level\fP
747 .IP 
748 .IP o 
749 \fBpassword server\fP
750 .IP 
751 .IP o 
752 \fBprefered master\fP
753 .IP 
754 .IP o 
755 \fBpreferred master\fP
756 .IP 
757 .IP o 
758 \fBpreload\fP
759 .IP 
760 .IP o 
761 \fBprintcap\fP
762 .IP 
763 .IP o 
764 \fBprintcap name\fP
765 .IP 
766 .IP o 
767 \fBprinter driver file\fP
768 .IP 
769 .IP o 
770 \fBprotocol\fP
771 .IP 
772 .IP o 
773 \fBread bmpx\fP
774 .IP 
775 .IP o 
776 \fBread prediction\fP
777 .IP 
778 .IP o 
779 \fBread raw\fP
780 .IP 
781 .IP o 
782 \fBread size\fP
783 .IP 
784 .IP o 
785 \fBremote announce\fP
786 .IP 
787 .IP o 
788 \fBremote browse sync\fP
789 .IP 
790 .IP o 
791 \fBrestrict anonymous\fP
792 .IP 
793 .IP o 
794 \fBroot\fP
795 .IP 
796 .IP o 
797 \fBroot dir\fP
798 .IP 
799 .IP o 
800 \fBroot directory\fP
801 .IP 
802 .IP o 
803 \fBsecurity\fP
804 .IP 
805 .IP o 
806 \fBserver string\fP
807 .IP 
808 .IP o 
809 \fBshared mem size\fP
810 .IP 
811 .IP o 
812 \fBsmb passwd file\fP
813 .IP 
814 .IP o 
815 \fBsmbrun\fP
816 .IP 
817 .IP o 
818 \fBsocket address\fP
819 .IP 
820 .IP o 
821 \fBsocket options\fP
822 .IP 
823 .IP o 
824 \fBssl\fP
825 .IP 
826 .IP o 
827 \fBssl CA certDir\fP
828 .IP 
829 .IP o 
830 \fBssl CA certFile\fP
831 .IP 
832 .IP o 
833 \fBssl ciphers\fP
834 .IP 
835 .IP o 
836 \fBssl client cert\fP
837 .IP 
838 .IP o 
839 \fBssl client key\fP
840 .IP 
841 .IP o 
842 \fBssl compatibility\fP
843 .IP 
844 .IP o 
845 \fBssl hosts\fP
846 .IP 
847 .IP o 
848 \fBssl hosts resign\fP
849 .IP 
850 .IP o 
851 \fBssl require clientcert\fP
852 .IP 
853 .IP o 
854 \fBssl require servercert\fP
855 .IP 
856 .IP o 
857 \fBssl server cert\fP
858 .IP 
859 .IP o 
860 \fBssl server key\fP
861 .IP 
862 .IP o 
863 \fBssl version\fP
864 .IP 
865 .IP o 
866 \fBstat cache\fP
867 .IP 
868 .IP o 
869 \fBstat cache size\fP
870 .IP 
871 .IP o 
872 \fBstrip dot\fP
873 .IP 
874 .IP o 
875 \fBsyslog\fP
876 .IP 
877 .IP o 
878 \fBsyslog only\fP
879 .IP 
880 .IP o 
881 \fBtime offset\fP
882 .IP 
883 .IP o 
884 \fBtime server\fP
885 .IP 
886 .IP o 
887 \fBtimestamp logs\fP
888 .IP 
889 .IP o 
890 \fBunix password sync\fP
891 .IP 
892 .IP o 
893 \fBunix realname\fP
894 .IP 
895 .IP o 
896 \fBupdate encrypted\fP
897 .IP 
898 .IP o 
899 \fBuse rhosts\fP
900 .IP 
901 .IP o 
902 \fBusername level\fP
903 .IP 
904 .IP o 
905 \fBusername map\fP
906 .IP 
907 .IP o 
908 \fBvalid chars\fP
909 .IP 
910 .IP o 
911 \fBwins proxy\fP
912 .IP 
913 .IP o 
914 \fBwins server\fP
915 .IP 
916 .IP o 
917 \fBwins support\fP
918 .IP 
919 .IP o 
920 \fBworkgroup\fP
921 .IP 
922 .IP o 
923 \fBwrite raw\fP
924 .IP 
925 .PP 
926 .SH "COMPLETE LIST OF SERVICE PARAMETERS" 
927 .PP 
928 Here is a list of all service parameters\&. See the section of each
929 parameter for details\&. Note that some are synonyms\&.
930 .PP 
931 .IP 
932 .IP o 
933 \fBadmin users\fP
934 .IP 
935 .IP o 
936 \fBallow hosts\fP
937 .IP 
938 .IP o 
939 \fBalternate permissions\fP
940 .IP 
941 .IP o 
942 \fBavailable\fP
943 .IP 
944 .IP o 
945 \fBblocking locks\fP
946 .IP 
947 .IP o 
948 \fBbrowsable\fP
949 .IP 
950 .IP o 
951 \fBbrowseable\fP
952 .IP 
953 .IP o 
954 \fBcase sensitive\fP
955 .IP 
956 .IP o 
957 \fBcasesignames\fP
958 .IP 
959 .IP o 
960 \fBcomment\fP
961 .IP 
962 .IP o 
963 \fBcopy\fP
964 .IP 
965 .IP o 
966 \fBcreate mask\fP
967 .IP 
968 .IP o 
969 \fBcreate mode\fP
970 .IP 
971 .IP o 
972 \fBdefault case\fP
973 .IP 
974 .IP o 
975 \fBdelete readonly\fP
976 .IP 
977 .IP o 
978 \fBdelete veto files\fP
979 .IP 
980 .IP o 
981 \fBdeny hosts\fP
982 .IP 
983 .IP o 
984 \fBdirectory\fP
985 .IP 
986 .IP o 
987 \fBdirectory mask\fP
988 .IP 
989 .IP o 
990 \fBdirectory mode\fP
991 .IP 
992 .IP o 
993 \fBdirectory security mask\fP
994 .IP 
995 .IP o 
996 \fBdont descend\fP
997 .IP 
998 .IP o 
999 \fBdos filetime resolution\fP
1000 .IP 
1001 .IP o 
1002 \fBdos filetimes\fP
1003 .IP 
1004 .IP o 
1005 \fBexec\fP
1006 .IP 
1007 .IP o 
1008 \fBfake directory create times\fP
1009 .IP 
1010 .IP o 
1011 \fBfake oplocks\fP
1012 .IP 
1013 .IP o 
1014 \fBfollow symlinks\fP
1015 .IP 
1016 .IP o 
1017 \fBforce create mode\fP
1018 .IP 
1019 .IP o 
1020 \fBforce directory mode\fP
1021 .IP 
1022 .IP o 
1023 \fBforce directory security mode\fP
1024 .IP 
1025 .IP o 
1026 \fBforce group\fP
1027 .IP 
1028 .IP o 
1029 \fBforce security mode\fP
1030 .IP 
1031 .IP o 
1032 \fBforce user\fP
1033 .IP 
1034 .IP o 
1035 \fBfstype\fP
1036 .IP 
1037 .IP o 
1038 \fBgroup\fP
1039 .IP 
1040 .IP o 
1041 \fBguest account\fP
1042 .IP 
1043 .IP o 
1044 \fBguest ok\fP
1045 .IP 
1046 .IP o 
1047 \fBguest only\fP
1048 .IP 
1049 .IP o 
1050 \fBhide dot files\fP
1051 .IP 
1052 .IP o 
1053 \fBhide files\fP
1054 .IP 
1055 .IP o 
1056 \fBhosts allow\fP
1057 .IP 
1058 .IP o 
1059 \fBhosts deny\fP
1060 .IP 
1061 .IP o 
1062 \fBinclude\fP
1063 .IP 
1064 .IP o 
1065 \fBinvalid users\fP
1066 .IP 
1067 .IP o 
1068 \fBlevel2 oplocks\fP
1069 .IP 
1070 .IP o 
1071 \fBlocking\fP
1072 .IP 
1073 .IP o 
1074 \fBlppause command\fP
1075 .IP 
1076 .IP o 
1077 \fBlpq command\fP
1078 .IP 
1079 .IP o 
1080 \fBlpresume command\fP
1081 .IP 
1082 .IP o 
1083 \fBlprm command\fP
1084 .IP 
1085 .IP o 
1086 \fBmagic output\fP
1087 .IP 
1088 .IP o 
1089 \fBmagic script\fP
1090 .IP 
1091 .IP o 
1092 \fBmangle case\fP
1093 .IP 
1094 .IP o 
1095 \fBmangle locks\fP
1096 .IP 
1097 .IP o 
1098 \fBmangled map\fP
1099 .IP 
1100 .IP o 
1101 \fBmangled names\fP
1102 .IP 
1103 .IP o 
1104 \fBmangling char\fP
1105 .IP 
1106 .IP o 
1107 \fBmap archive\fP
1108 .IP 
1109 .IP o 
1110 \fBmap hidden\fP
1111 .IP 
1112 .IP o 
1113 \fBmap system\fP
1114 .IP 
1115 .IP o 
1116 \fBmax connections\fP
1117 .IP 
1118 .IP o 
1119 \fBmin print space\fP
1120 .IP 
1121 .IP o 
1122 \fBonly guest\fP
1123 .IP 
1124 .IP o 
1125 \fBonly user\fP
1126 .IP 
1127 .IP o 
1128 \fBoplocks\fP
1129 .IP 
1130 .IP o 
1131 \fBoplock contention limit\fP
1132 .IP 
1133 .IP o 
1134 \fBpath\fP
1135 .IP 
1136 .IP o 
1137 \fBpostexec\fP
1138 .IP 
1139 .IP o 
1140 \fBpostscript\fP
1141 .IP 
1142 .IP o 
1143 \fBpreexec\fP
1144 .IP 
1145 .IP o 
1146 \fBpreserve case\fP
1147 .IP 
1148 .IP o 
1149 \fBprint command\fP
1150 .IP 
1151 .IP o 
1152 \fBprint ok\fP
1153 .IP 
1154 .IP o 
1155 \fBprintable\fP
1156 .IP 
1157 .IP o 
1158 \fBprinter\fP
1159 .IP 
1160 .IP o 
1161 \fBprinter driver\fP
1162 .IP 
1163 .IP o 
1164 \fBprinter driver location\fP
1165 .IP 
1166 .IP o 
1167 \fBprinter name\fP
1168 .IP 
1169 .IP o 
1170 \fBprinting\fP
1171 .IP 
1172 .IP o 
1173 \fBpublic\fP
1174 .IP 
1175 .IP o 
1176 \fBqueuepause command\fP
1177 .IP 
1178 .IP o 
1179 \fBqueueresume command\fP
1180 .IP 
1181 .IP o 
1182 \fBread list\fP
1183 .IP 
1184 .IP o 
1185 \fBread only\fP
1186 .IP 
1187 .IP o 
1188 \fBrevalidate\fP
1189 .IP 
1190 .IP o 
1191 \fBroot postexec\fP
1192 .IP 
1193 .IP o 
1194 \fBroot preexec\fP
1195 .IP 
1196 .IP o 
1197 \fBsecurity mask\fP
1198 .IP 
1199 .IP o 
1200 \fBset directory\fP
1201 .IP 
1202 .IP o 
1203 \fBshare modes\fP
1204 .IP 
1205 .IP o 
1206 \fBshort preserve case\fP
1207 .IP 
1208 .IP o 
1209 \fBstatus\fP
1210 .IP 
1211 .IP o 
1212 \fBstrict locking\fP
1213 .IP 
1214 .IP o 
1215 \fBstrict sync\fP
1216 .IP 
1217 .IP o 
1218 \fBsync always\fP
1219 .IP 
1220 .IP o 
1221 \fBuser\fP
1222 .IP 
1223 .IP o 
1224 \fBusername\fP
1225 .IP 
1226 .IP o 
1227 \fBusers\fP
1228 .IP 
1229 .IP o 
1230 \fBvalid users\fP
1231 .IP 
1232 .IP o 
1233 \fBveto files\fP
1234 .IP 
1235 .IP o 
1236 \fBveto oplock files\fP
1237 .IP 
1238 .IP o 
1239 \fBvolume\fP
1240 .IP 
1241 .IP o 
1242 \fBwide links\fP
1243 .IP 
1244 .IP o 
1245 \fBwritable\fP
1246 .IP 
1247 .IP o 
1248 \fBwrite list\fP
1249 .IP 
1250 .IP o 
1251 \fBwrite ok\fP
1252 .IP 
1253 .IP o 
1254 \fBwriteable\fP
1255 .IP 
1256 .PP 
1257 .SH "EXPLANATION OF EACH PARAMETER" 
1258 .PP 
1259 .IP 
1260 .IP "\fBadd user script (G)\fP" 
1261 .IP 
1262 This is the full pathname to a script that will be run \fIAS ROOT\fP by
1263 \fBsmbd (8)\fP under special circumstances decribed
1264 below\&.
1265 .IP 
1266 Normally, a Samba server requires that UNIX users are created for all
1267 users accessing files on this server\&. For sites that use Windows NT
1268 account databases as their primary user database creating these users
1269 and keeping the user list in sync with the Windows NT PDC is an
1270 onerous task\&. This option allows \fBsmbd\fP to create
1271 the required UNIX users \fION DEMAND\fP when a user accesses the Samba
1272 server\&.
1273 .IP 
1274 In order to use this option, \fBsmbd\fP must be set to
1275 \fBsecurity=server\fP or
1276 \fBsecurity=domain\fP and \fB"add user script"\fP
1277 must be set to a full pathname for a script that will create a UNIX user
1278 given one argument of \fB%u\fP, which expands into the UNIX user name to
1279 create\&.
1280 .IP 
1281 When the Windows user attempts to access the Samba server, at
1282 \fI"login"\fP(session setup in the SMB protocol) time,
1283 \fBsmbd\fP contacts the \fBpassword
1284 server\fP and attempts to authenticate the given user
1285 with the given password\&. If the authentication succeeds then
1286 \fBsmbd\fP attempts to find a UNIX user in the UNIX
1287 password database to map the Windows user into\&. If this lookup fails,
1288 and \fB"add user script"\fP is set then \fBsmbd\fP will
1289 call the specified script \fIAS ROOT\fP, expanding any \fB%u\fP argument
1290 to be the user name to create\&.
1291 .IP 
1292 If this script successfully creates the user then
1293 \fBsmbd\fP will continue on as though the UNIX user
1294 already existed\&. In this way, UNIX users are dynamically created to
1295 match existing Windows NT accounts\&.
1296 .IP 
1297 See also \fBsecurity=server\fP,
1298 \fBsecurity=domain\fP, \fBpassword
1299 server\fP, \fBdelete user
1300 script\fP\&.
1301 .IP 
1302 \fBDefault:\fP
1303 \f(CW   add user script = <empty string>\fP
1304 .IP 
1305 \fBExample:\fP
1306 \f(CW   add user script = /usr/local/samba/bin/add_user %u\fP
1307 .IP 
1308 .IP "\fBadmin users (S)\fP" 
1309 .IP 
1310 This is a list of users who will be granted administrative privileges
1311 on the share\&. This means that they will do all file operations as the
1312 super-user (root)\&.
1313 .IP 
1314 You should use this option very carefully, as any user in this list
1315 will be able to do anything they like on the share, irrespective of
1316 file permissions\&.
1317 .IP 
1318 \fBDefault:\fP 
1319 .br 
1320 \f(CW   no admin users\fP
1321 .IP 
1322 \fBExample:\fP 
1323 .br 
1324 \f(CW   admin users = jason\fP
1325 .IP 
1326 .IP "\fBallow hosts (S)\fP" 
1327 .IP 
1328 Synonym for \fBhosts allow\fP\&.
1329 .IP 
1330 .IP "\fBallow trusted domains (G)\fP" 
1331 .IP 
1332 This option only takes effect when the \fBsecurity\fP
1333 option is set to \fBserver\fP or \fBdomain\fP\&.  If it is set to no,
1334 then attempts to connect to a resource from a domain or workgroup other than
1335 the one which smbd is running in will fail, even if that domain
1336 is trusted by the remote server doing the authentication\&.
1337 .IP 
1338 This is useful if you only want your Samba server to serve resources
1339 to users in the domain it is a member of\&. As an example, suppose that there are
1340 two domains DOMA and DOMB\&.  DOMB is trusted by DOMA, which contains
1341 the Samba server\&.  Under normal circumstances, a user with an account
1342 in DOMB can then access the resources of a UNIX account with the same
1343 account name on the Samba server even if they do not have an account
1344 in DOMA\&.  This can make implementing a security boundary difficult\&.
1345 .IP 
1346 \fBDefault:\fP
1347 \f(CW     allow trusted domains = Yes\fP
1348 .IP 
1349 \fBExample:\fP
1350 \f(CW     allow trusted domains = No\fP
1351 .IP 
1352 .IP "\fBalternate permissions (S)\fP" 
1353 .IP 
1354 This is a deprecated parameter\&. It no longer has any effect in Samba2\&.0\&.
1355 In previous versions of Samba it affected the way the DOS "read only"
1356 attribute was mapped for a file\&. In Samba2\&.0 a file is marked "read only"
1357 if the UNIX file does not have the \'w\' bit set for the owner of the file,
1358 regardless if the owner of the file is the currently logged on user or not\&.
1359 .IP 
1360 .IP "\fBannounce as (G)\fP" 
1361 .IP 
1362 This specifies what type of server \fBnmbd\fP will
1363 announce itself as, to a network neighborhood browse list\&. By default
1364 this is set to Windows NT\&. The valid options are : "NT", which is a
1365 synonym for "NT Server", "NT Server", "NT Workstation", "Win95" or
1366 "WfW" meaning Windows NT Server, Windows NT Workstation, Windows 95
1367 and Windows for Workgroups respectively\&. Do not change this parameter
1368 unless you have a specific need to stop Samba appearing as an NT server
1369 as this may prevent Samba servers from participating as browser servers correctly\&.
1370 .IP 
1371 \fBDefault:\fP
1372 \f(CW   announce as = NT Server\fP
1373 .IP 
1374 \fBExample\fP
1375 \f(CW   announce as = Win95\fP
1376 .IP 
1377 .IP "\fBannounce version (G)\fP" 
1378 .IP 
1379 This specifies the major and minor version numbers that nmbd will use
1380 when announcing itself as a server\&. The default is 4\&.2\&.  Do not change
1381 this parameter unless you have a specific need to set a Samba server
1382 to be a downlevel server\&.
1383 .IP 
1384 \fBDefault:\fP
1385 \f(CW   announce version = 4\&.2\fP
1386 .IP 
1387 \fBExample:\fP
1388 \f(CW   announce version = 2\&.0\fP
1389 .IP 
1390 .IP "\fBauto services (G)\fP" 
1391 .IP 
1392 This is a list of services that you want to be automatically added to
1393 the browse lists\&. This is most useful for homes and printers services
1394 that would otherwise not be visible\&.
1395 .IP 
1396 Note that if you just want all printers in your printcap file loaded
1397 then the \fB"load printers"\fP option is easier\&.
1398 .IP 
1399 \fBDefault:\fP
1400 \f(CW   no auto services\fP
1401 .IP 
1402 \fBExample:\fP
1403 \f(CW   auto services = fred lp colorlp\fP
1404 .IP 
1405 .IP "\fBavailable (S)\fP" 
1406 .IP 
1407 This parameter lets you \fI\'turn off\'\fP a service\&. If \f(CW\'available = no\'\fP,
1408 then \fIALL\fP attempts to connect to the service will fail\&. Such failures
1409 are logged\&.
1410 .IP 
1411 \fBDefault:\fP
1412 \f(CW   available = yes\fP
1413 .IP 
1414 \fBExample:\fP
1415 \f(CW   available = no\fP
1416 .IP 
1417 .IP "\fBbind interfaces only (G)\fP" 
1418 .IP 
1419 This global parameter allows the Samba admin to limit what interfaces
1420 on a machine will serve smb requests\&. If affects file service
1421 \fBsmbd\fP and name service \fBnmbd\fP
1422 in slightly different ways\&.
1423 .IP 
1424 For name service it causes \fBnmbd\fP to bind to ports
1425 137 and 138 on the interfaces listed in the
1426 \fB\'interfaces\'\fP
1427 parameter\&. \fBnmbd\fP also binds to the \'all
1428 addresses\' interface (0\&.0\&.0\&.0) on ports 137 and 138 for the purposes
1429 of reading broadcast messages\&. If this option is not set then
1430 \fBnmbd\fP will service name requests on all of these
1431 sockets\&. If \fB"bind interfaces only"\fP is set then
1432 \fBnmbd\fP will check the source address of any
1433 packets coming in on the broadcast sockets and discard any that don\'t
1434 match the broadcast addresses of the interfaces in the
1435 \fB\'interfaces\'\fP parameter list\&. As unicast packets
1436 are received on the other sockets it allows \fBnmbd\fP
1437 to refuse to serve names to machines that send packets that arrive
1438 through any interfaces not listed in the
1439 \fB"interfaces"\fP list\&.  IP Source address spoofing
1440 does defeat this simple check, however so it must not be used
1441 seriously as a security feature for \fBnmbd\fP\&.
1442 .IP 
1443 For file service it causes \fBsmbd\fP to bind only to
1444 the interface list given in the \fB\'interfaces\'\fP
1445 parameter\&. This restricts the networks that \fBsmbd\fP
1446 will serve to packets coming in those interfaces\&.  Note that you
1447 should not use this parameter for machines that are serving PPP or
1448 other intermittent or non-broadcast network interfaces as it will not
1449 cope with non-permanent interfaces\&.
1450 .IP 
1451 If \fB"bind interfaces only"\fP is set then unless the network address
1452 \fI127\&.0\&.0\&.1\fP is added to the \fB\'interfaces\'\fP parameter
1453 list \fBsmbpasswd\fP and
1454 \fBswat\fP may not work as expected due to the
1455 reasons covered below\&.
1456 .IP 
1457 To change a users SMB password, the \fBsmbpasswd\fP
1458 by default connects to the \fI"localhost" - 127\&.0\&.0\&.1\fP address as an SMB
1459 client to issue the password change request\&. If \fB"bind interfaces only"\fP
1460 is set then unless the network address \fI127\&.0\&.0\&.1\fP is added to the
1461 \fB\'interfaces\'\fP parameter list then
1462 \fBsmbpasswd\fP will fail to connect in it\'s
1463 default mode\&. \fBsmbpasswd\fP can be forced to
1464 use the primary IP interface of the local host by using its
1465 \fB"-r remote machine"\fP parameter, with
1466 \fB"remote machine"\fP set to the IP name of the primary interface
1467 of the local host\&.
1468 .IP 
1469 The \fBswat\fP status page tries to connect with
1470 \fBsmbd\fP and \fBnmbd\fP at the address 
1471 \fI127\&.0\&.0\&.1\fP to determine if they are running\&.  Not adding \fI127\&.0\&.0\&.1\fP  will cause
1472 \fBsmbd\fP and \fBnmbd\fP to always show
1473 "not running" even if they really are\&.  This can prevent
1474 \fBswat\fP from starting/stopping/restarting
1475 \fBsmbd\fP and \fBnmbd\fP\&.
1476 .IP 
1477 \fBDefault:\fP
1478 \f(CW   bind interfaces only = False\fP
1479 .IP 
1480 \fBExample:\fP
1481 \f(CW   bind interfaces only = True\fP
1482 .IP 
1483 .IP "\fBblocking locks (S)\fP" 
1484 .IP 
1485 This parameter controls the behavior of \fBsmbd\fP when
1486 given a request by a client to obtain a byte range lock on a region
1487 of an open file, and the request has a time limit associated with it\&.
1488 .IP 
1489 If this parameter is set and the lock range requested cannot be
1490 immediately satisfied, Samba 2\&.0 will internally queue the lock 
1491 request, and periodically attempt to obtain the lock until the
1492 timeout period expires\&.
1493 .IP 
1494 If this parameter is set to "False", then Samba 2\&.0 will behave
1495 as previous versions of Samba would and will fail the lock
1496 request immediately if the lock range cannot be obtained\&.
1497 .IP 
1498 This parameter can be set per share\&.
1499 .IP 
1500 \fBDefault:\fP
1501 \f(CW   blocking locks = True\fP
1502 .IP 
1503 \fBExample:\fP
1504 \f(CW   blocking locks = False\fP
1505 .IP 
1506 .IP "\fBbrowsable (S)\fP" 
1507 .IP 
1508 Synonym for \fBbrowseable\fP\&.
1509 .IP 
1510 .IP "\fBbrowse list(G)\fP" 
1511 .IP 
1512 This controls whether \fBsmbd\fP will serve a browse
1513 list to a client doing a NetServerEnum call\&. Normally set to true\&. You
1514 should never need to change this\&.
1515 .IP 
1516 \fBDefault:\fP
1517 \f(CW   browse list = Yes\fP
1518 .IP 
1519 .IP "\fBbrowseable\fP" 
1520 .IP 
1521 This controls whether this share is seen in the list of available
1522 shares in a net view and in the browse list\&.
1523 .IP 
1524 \fBDefault:\fP
1525 \f(CW   browseable = Yes\fP
1526 .IP 
1527 \fBExample:\fP
1528 \f(CW   browseable = No\fP
1529 .IP 
1530 .IP "\fBcase sensitive (G)\fP" 
1531 .IP 
1532 See the discussion in the section \fBNAME MANGLING\fP\&.
1533 .IP 
1534 .IP "\fBcasesignames (G)\fP" 
1535 .IP 
1536 Synonym for \fB"case sensitive"\fP\&.
1537 .IP 
1538 .IP "\fBchange notify timeout (G)\fP" 
1539 .IP 
1540 One of the new NT SMB requests that Samba 2\&.0 supports is the
1541 "ChangeNotify" requests\&. This SMB allows a client to tell a server to
1542 \fI"watch"\fP a particular directory for any changes and only reply to
1543 the SMB request when a change has occurred\&. Such constant scanning of
1544 a directory is expensive under UNIX, hence an
1545 \fBsmbd\fP daemon only performs such a scan on each
1546 requested directory once every \fBchange notify timeout\fP seconds\&.
1547 .IP 
1548 \fBchange notify timeout\fP is specified in units of seconds\&.
1549 .IP 
1550 \fBDefault:\fP
1551 \f(CW   change notify timeout = 60\fP
1552 .IP 
1553 \fBExample:\fP
1554 \f(CW   change notify timeout = 300\fP
1555 .IP 
1556 Would change the scan time to every 5 minutes\&.
1557 .IP 
1558 .IP "\fBcharacter set (G)\fP" 
1559 .IP 
1560 This allows a smbd to map incoming filenames from a DOS Code page (see
1561 the \fBclient code page\fP parameter) to several
1562 built in UNIX character sets\&. The built in code page translations are:
1563 .IP 
1564 .IP 
1565 .IP o 
1566 \fBISO8859-1\fP Western European UNIX character set\&. The parameter
1567 \fBclient code page\fP \fIMUST\fP be set to code
1568 page 850 if the \fBcharacter set\fP parameter is set to iso8859-1
1569 in order for the conversion to the UNIX character set to be done
1570 correctly\&.
1571 .IP 
1572 .IP o 
1573 \fBISO8859-2\fP Eastern European UNIX character set\&. The parameter
1574 \fBclient code page\fP \fIMUST\fP be set to code
1575 page 852 if the \fBcharacter set\fP parameter is set to ISO8859-2
1576 in order for the conversion to the UNIX character set to be done
1577 correctly\&. 
1578 .IP 
1579 .IP o 
1580 \fBISO8859-5\fP Russian Cyrillic UNIX character set\&. The parameter
1581 \fBclient code page\fP \fIMUST\fP be set to code
1582 page 866 if the \fBcharacter set\fP parameter is set to ISO8859-2
1583 in order for the conversion to the UNIX character set to be done
1584 correctly\&. 
1585 .IP 
1586 .IP o 
1587 \fBKOI8-R\fP Alternate mapping for Russian Cyrillic UNIX
1588 character set\&. The parameter \fBclient code
1589 page\fP \fIMUST\fP be set to code page 866 if the
1590 \fBcharacter set\fP parameter is set to KOI8-R in order for the
1591 conversion to the UNIX character set to be done correctly\&.
1592 .IP 
1593 .IP 
1594 \fIBUG\fP\&. These MSDOS code page to UNIX character set mappings should
1595 be dynamic, like the loading of MS DOS code pages, not static\&.
1596 .IP 
1597 See also \fBclient code page\fP\&.  Normally this
1598 parameter is not set, meaning no filename translation is done\&.
1599 .IP 
1600 \fBDefault:\fP
1601 \f(CW   character set = <empty string>\fP
1602 .IP 
1603 \fBExample:\fP
1604 \f(CW   character set = ISO8859-1\fP
1605 .IP 
1606 .IP "\fBclient code page (G)\fP" 
1607 .IP 
1608 This parameter specifies the DOS code page that the clients accessing
1609 Samba are using\&. To determine what code page a Windows or DOS client
1610 is using, open a DOS command prompt and type the command "chcp"\&. This
1611 will output the code page\&. The default for USA MS-DOS, Windows 95, and
1612 Windows NT releases is code page 437\&. The default for western european
1613 releases of the above operating systems is code page 850\&.
1614 .IP 
1615 This parameter tells \fBsmbd\fP which of the
1616 \f(CWcodepage\&.XXX\fP files to dynamically load on startup\&. These files,
1617 described more fully in the manual page \fBmake_smbcodepage
1618 (1)\fP, tell \fBsmbd\fP how
1619 to map lower to upper case characters to provide the case insensitivity
1620 of filenames that Windows clients expect\&.
1621 .IP 
1622 Samba currently ships with the following code page files :
1623 .IP 
1624 .IP 
1625 .IP o 
1626 \fBCode Page 437 - MS-DOS Latin US\fP
1627 .IP 
1628 .IP o 
1629 \fBCode Page 737 - Windows \'95 Greek\fP
1630 .IP 
1631 .IP o 
1632 \fBCode Page 850 - MS-DOS Latin 1\fP
1633 .IP 
1634 .IP o 
1635 \fBCode Page 852 - MS-DOS Latin 2\fP
1636 .IP 
1637 .IP o 
1638 \fBCode Page 861 - MS-DOS Icelandic\fP
1639 .IP 
1640 .IP o 
1641 \fBCode Page 866 - MS-DOS Cyrillic\fP
1642 .IP 
1643 .IP o 
1644 \fBCode Page 932 - MS-DOS Japanese SJIS\fP
1645 .IP 
1646 .IP o 
1647 \fBCode Page 936 - MS-DOS Simplified Chinese\fP
1648 .IP 
1649 .IP o 
1650 \fBCode Page 949 - MS-DOS Korean Hangul\fP
1651 .IP 
1652 .IP o 
1653 \fBCode Page 950 - MS-DOS Traditional Chinese\fP
1654 .IP 
1655 .IP 
1656 Thus this parameter may have any of the values 437, 737, 850, 852,
1657 861, 932, 936, 949, or 950\&.  If you don\'t find the codepage you need,
1658 read the comments in one of the other codepage files and the
1659 \fBmake_smbcodepage (1)\fP man page and
1660 write one\&. Please remember to donate it back to the Samba user
1661 community\&.
1662 .IP 
1663 This parameter co-operates with the \fB"valid
1664 chars"\fP parameter in determining what characters are
1665 valid in filenames and how capitalization is done\&. If you set both
1666 this parameter and the \fB"valid chars"\fP parameter
1667 the \fB"client code page"\fP parameter \fIMUST\fP be set before the
1668 \fB"valid chars"\fP parameter in the \fBsmb\&.conf\fP
1669 file\&. The \fB"valid chars"\fP string will then augment
1670 the character settings in the "client code page" parameter\&.
1671 .IP 
1672 If not set, \fB"client code page"\fP defaults to 850\&.
1673 .IP 
1674 See also : \fB"valid chars"\fP
1675 .IP 
1676 \fBDefault:\fP
1677 \f(CW   client code page = 850\fP
1678 .IP 
1679 \fBExample:\fP
1680 \f(CW   client code page = 936\fP
1681 .IP 
1682 .IP "\fBcodingsystem (G)\fP" 
1683 .IP 
1684 This parameter is used to determine how incoming Shift-JIS Japanese
1685 characters are mapped from the incoming \fB"client code
1686 page"\fP used by the client, into file names in the
1687 UNIX filesystem\&. Only useful if \fB"client code
1688 page"\fP is set to 932 (Japanese Shift-JIS)\&.
1689 .IP 
1690 The options are :
1691 .IP 
1692 .IP 
1693 .IP o 
1694 \fBSJIS\fP  Shift-JIS\&. Does no conversion of the incoming filename\&.
1695 .IP 
1696 .IP o 
1697 \fBJIS8, J8BB, J8BH, J8@B, J8@J, J8@H \fP Convert from incoming
1698 Shift-JIS to eight bit JIS code with different shift-in, shift out
1699 codes\&.
1700 .IP 
1701 .IP o 
1702 \fBJIS7, J7BB, J7BH, J7@B, J7@J, J7@H \fP Convert from incoming
1703 Shift-JIS to seven bit JIS code with different shift-in, shift out
1704 codes\&.
1705 .IP 
1706 .IP o 
1707 \fBJUNET, JUBB, JUBH, JU@B, JU@J, JU@H \fP Convert from incoming
1708 Shift-JIS to JUNET code with different shift-in, shift out codes\&.
1709 .IP 
1710 .IP o 
1711 \fBEUC\fP  Convert an incoming Shift-JIS character to EUC code\&.
1712 .IP 
1713 .IP o 
1714 \fBHEX\fP Convert an incoming Shift-JIS character to a 3 byte hex
1715 representation, i\&.e\&. \f(CW:AB\fP\&.
1716 .IP 
1717 .IP o 
1718 \fBCAP\fP Convert an incoming Shift-JIS character to the 3 byte hex
1719 representation used by the Columbia AppleTalk Program (CAP),
1720 i\&.e\&. \f(CW:AB\fP\&.  This is used for compatibility between Samba and CAP\&.
1721 .IP 
1722 .IP 
1723 .IP "\fBcomment (S)\fP" 
1724 .IP 
1725 This is a text field that is seen next to a share when a client does a
1726 queries the server, either via the network neighborhood or via "net
1727 view" to list what shares are available\&.
1728 .IP 
1729 If you want to set the string that is displayed next to the machine
1730 name then see the server string command\&.
1731 .IP 
1732 \fBDefault:\fP
1733 \f(CW   No comment string\fP
1734 .IP 
1735 \fBExample:\fP
1736 \f(CW   comment = Fred\'s Files\fP
1737 .IP 
1738 .IP "\fBconfig file (G)\fP" 
1739 .IP 
1740 This allows you to override the config file to use, instead of the
1741 default (usually \fBsmb\&.conf\fP)\&. There is a chicken and egg problem
1742 here as this option is set in the config file!
1743 .IP 
1744 For this reason, if the name of the config file has changed when the
1745 parameters are loaded then it will reload them from the new config
1746 file\&.
1747 .IP 
1748 This option takes the usual substitutions, which can be very useful\&.
1749 .IP 
1750 If the config file doesn\'t exist then it won\'t be loaded (allowing you
1751 to special case the config files of just a few clients)\&.
1752 .IP 
1753 \fBExample:\fP
1754 \f(CW   config file = /usr/local/samba/lib/smb\&.conf\&.%m\fP
1755 .IP 
1756 .IP "\fBcopy (S)\fP" 
1757 .IP 
1758 This parameter allows you to \fI\'clone\'\fP service entries\&. The specified
1759 service is simply duplicated under the current service\'s name\&. Any
1760 parameters specified in the current section will override those in the
1761 section being copied\&.
1762 .IP 
1763 This feature lets you set up a \'template\' service and create similar
1764 services easily\&. Note that the service being copied must occur earlier
1765 in the configuration file than the service doing the copying\&.
1766 .IP 
1767 \fBDefault:\fP
1768 \f(CW   none\fP
1769 .IP 
1770 \fBExample:\fP
1771 \f(CW   copy = otherservice\fP
1772 .IP 
1773 .IP "\fBcreate mask (S)\fP" 
1774 .IP 
1775 A synonym for this parameter is \fB\'create mode\'\fP\&.
1776 .IP 
1777 When a file is created, the necessary permissions are calculated
1778 according to the mapping from DOS modes to UNIX permissions, and the
1779 resulting UNIX mode is then bit-wise \'AND\'ed with this parameter\&.
1780 This parameter may be thought of as a bit-wise MASK for the UNIX modes
1781 of a file\&. Any bit \fI*not*\fP set here will be removed from the modes set
1782 on a file when it is created\&.
1783 .IP 
1784 The default value of this parameter removes the \'group\' and \'other\'
1785 write and execute bits from the UNIX modes\&.
1786 .IP 
1787 Following this Samba will bit-wise \'OR\' the UNIX mode created from
1788 this parameter with the value of the "force create mode" parameter
1789 which is set to 000 by default\&.
1790 .IP 
1791 This parameter does not affect directory modes\&. See the parameter
1792 \fB\'directory mode\'\fP for details\&.
1793 .IP 
1794 See also the \fB"force create mode"\fP parameter
1795 for forcing particular mode bits to be set on created files\&. See also
1796 the \fB"directory mode"\fP parameter for masking
1797 mode bits on created directories\&.
1798 .IP 
1799 \fBDefault:\fP
1800 \f(CW   create mask = 0744\fP
1801 .IP 
1802 \fBExample:\fP
1803 \f(CW   create mask = 0775\fP
1804 .IP 
1805 .IP "\fBcreate mode (S)\fP" 
1806 .IP 
1807 This is a synonym for \fBcreate mask\fP\&.
1808 .IP 
1809 .IP "\fBdeadtime (G)\fP" 
1810 .IP 
1811 The value of the parameter (a decimal integer) represents the number
1812 of minutes of inactivity before a connection is considered dead, and
1813 it is disconnected\&. The deadtime only takes effect if the number of
1814 open files is zero\&.
1815 .IP 
1816 This is useful to stop a server\'s resources being exhausted by a large
1817 number of inactive connections\&.
1818 .IP 
1819 Most clients have an auto-reconnect feature when a connection is
1820 broken so in most cases this parameter should be transparent to users\&.
1821 .IP 
1822 Using this parameter with a timeout of a few minutes is recommended
1823 for most systems\&.
1824 .IP 
1825 A deadtime of zero indicates that no auto-disconnection should be
1826 performed\&.
1827 .IP 
1828 \fBDefault:\fP
1829 \f(CW   deadtime = 0\fP
1830 .IP 
1831 \fBExample:\fP
1832 \f(CW   deadtime = 15\fP
1833 .IP 
1834 .IP "\fBdebug timestamp (G)\fP" 
1835 .IP 
1836 Samba2\&.0 debug log messages are timestamped by default\&. If you are
1837 running at a high \fB"debug level"\fP these timestamps
1838 can be distracting\&. This boolean parameter allows them to be turned
1839 off\&.
1840 .IP 
1841 \fBDefault:\fP
1842 \f(CW   debug timestamp = Yes\fP
1843 .IP 
1844 \fBExample:\fP
1845 \f(CW   debug timestamp = No\fP
1846 .IP 
1847 .IP "\fBdebug level (G)\fP" 
1848 .IP 
1849 The value of the parameter (an integer) allows the debug level
1850 (logging level) to be specified in the \fBsmb\&.conf\fP file\&. This is to
1851 give greater flexibility in the configuration of the system\&.
1852 .IP 
1853 The default will be the debug level specified on the command line
1854 or level zero if none was specified\&.
1855 .IP 
1856 \fBExample:\fP
1857 \f(CW   debug level = 3\fP
1858 .IP 
1859 .IP "\fBdefault (G)\fP" 
1860 .IP 
1861 A synonym for \fBdefault service\fP\&.
1862 .IP 
1863 .IP "\fBdefault case (S)\fP" 
1864 .IP 
1865 See the section on \fB"NAME MANGLING"\fP\&. Also note
1866 the \fB"short preserve case"\fP parameter\&.
1867 .IP 
1868 .IP "\fBdefault service (G)\fP" 
1869 .IP 
1870 This parameter specifies the name of a service which will be connected
1871 to if the service actually requested cannot be found\&. Note that the
1872 square brackets are \fINOT\fP given in the parameter value (see example
1873 below)\&.
1874 .IP 
1875 There is no default value for this parameter\&. If this parameter is not
1876 given, attempting to connect to a nonexistent service results in an
1877 error\&.
1878 .IP 
1879 Typically the default service would be a \fBguest ok\fP,
1880 \fBread-only\fP service\&.
1881 .IP 
1882 Also note that the apparent service name will be changed to equal that
1883 of the requested service, this is very useful as it allows you to use
1884 macros like \fB%S\fP to make a wildcard service\&.
1885 .IP 
1886 Note also that any \f(CW\'_\'\fP characters in the name of the service used
1887 in the default service will get mapped to a \f(CW\'/\'\fP\&. This allows for
1888 interesting things\&.
1889 .IP 
1890 \fBExample:\fP
1892 .DS 
1895         default service = pub
1896         
1897         [pub]
1898                 path = /%S
1900 .DE 
1903 .IP 
1904 .IP "\fBdelete user script (G)\fP" 
1905 .IP 
1906 This is the full pathname to a script that will be run \fIAS ROOT\fP by
1907 \fBsmbd (8)\fP under special circumstances decribed
1908 below\&.
1909 .IP 
1910 Normally, a Samba server requires that UNIX users are created for all
1911 users accessing files on this server\&. For sites that use Windows NT
1912 account databases as their primary user database creating these users
1913 and keeping the user list in sync with the Windows NT PDC is an
1914 onerous task\&. This option allows \fBsmbd\fP to delete
1915 the required UNIX users \fION DEMAND\fP when a user accesses the Samba
1916 server and the Windows NT user no longer exists\&.
1917 .IP 
1918 In order to use this option, \fBsmbd\fP must be set to
1919 \fBsecurity=domain\fP and \fB"delete user
1920 script"\fP must be set to a full pathname for a script that will delete
1921 a UNIX user given one argument of \fB%u\fP, which expands into the UNIX
1922 user name to delete\&. \fINOTE\fP that this is different to the
1923 \fBadd user script\fP which will work with the
1924 \fBsecurity=server\fP option as well as
1925 \fBsecurity=domain\fP\&. The reason for this
1926 is only when Samba is a domain member does it get the information
1927 on an attempted user logon that a user no longer exists\&. In the
1928 \fBsecurity=server\fP mode a missing user
1929 is treated the same as an invalid password logon attempt\&. Deleting
1930 the user in this circumstance would not be a good idea\&.
1931 .IP 
1932 When the Windows user attempts to access the Samba server, at
1933 \fI"login"\fP(session setup in the SMB protocol) time,
1934 \fBsmbd\fP contacts the \fBpassword
1935 server\fP and attempts to authenticate the given user
1936 with the given password\&. If the authentication fails with the specific
1937 Domain error code meaning that the user no longer exists then
1938 \fBsmbd\fP attempts to find a UNIX user in the UNIX
1939 password database that matches the Windows user account\&. If this lookup succeeds,
1940 and \fB"delete user script"\fP is set then \fBsmbd\fP will
1941 call the specified script \fIAS ROOT\fP, expanding any \fB%u\fP argument
1942 to be the user name to delete\&.
1943 .IP 
1944 This script should delete the given UNIX username\&. In this way, UNIX
1945 users are dynamically deleted to match existing Windows NT accounts\&.
1946 .IP 
1947 See also \fBsecurity=domain\fP,
1948 \fBpassword server\fP, \fBadd user
1949 script\fP\&.
1950 .IP 
1951 \fBDefault:\fP
1952 \f(CW   delete user script = <empty string>\fP
1953 .IP 
1954 \fBExample:\fP
1955 \f(CW   delete user script = /usr/local/samba/bin/del_user %u\fP
1956 .IP 
1957 .IP "\fBdelete readonly (S)\fP" 
1958 .IP 
1959 This parameter allows readonly files to be deleted\&.  This is not
1960 normal DOS semantics, but is allowed by UNIX\&.
1961 .IP 
1962 This option may be useful for running applications such as rcs, where
1963 UNIX file ownership prevents changing file permissions, and DOS
1964 semantics prevent deletion of a read only file\&.
1965 .IP 
1966 \fBDefault:\fP
1967 \f(CW   delete readonly = No\fP
1968 .IP 
1969 \fBExample:\fP
1970 \f(CW   delete readonly = Yes\fP
1971 .IP 
1972 .IP "\fBdelete veto files (S)\fP" 
1973 .IP 
1974 This option is used when Samba is attempting to delete a directory
1975 that contains one or more vetoed directories (see the \fB\'veto
1976 files\'\fP option)\&.  If this option is set to False (the
1977 default) then if a vetoed directory contains any non-vetoed files or
1978 directories then the directory delete will fail\&. This is usually what
1979 you want\&.
1980 .IP 
1981 If this option is set to True, then Samba will attempt to recursively
1982 delete any files and directories within the vetoed directory\&. This can
1983 be useful for integration with file serving systems such as \fBNetAtalk\fP,
1984 which create meta-files within directories you might normally veto
1985 DOS/Windows users from seeing (e\&.g\&. \f(CW\&.AppleDouble\fP)
1986 .IP 
1987 Setting \f(CW\'delete veto files = True\'\fP allows these directories to be 
1988 transparently deleted when the parent directory is deleted (so long
1989 as the user has permissions to do so)\&.
1990 .IP 
1991 See also the \fBveto files\fP parameter\&.
1992 .IP 
1993 \fBDefault:\fP
1994 \f(CW   delete veto files = False\fP
1995 .IP 
1996 \fBExample:\fP
1997 \f(CW   delete veto files = True\fP
1998 .IP 
1999 .IP "\fBdeny hosts (S)\fP" 
2000 .IP 
2001 Synonym for \fBhosts deny\fP\&.
2002 .IP 
2003 .IP "\fBdfree command (G)\fP" 
2004 .IP 
2005 The dfree command setting should only be used on systems where a
2006 problem occurs with the internal disk space calculations\&. This has
2007 been known to happen with Ultrix, but may occur with other operating
2008 systems\&. The symptom that was seen was an error of "Abort Retry
2009 Ignore" at the end of each directory listing\&.
2010 .IP 
2011 This setting allows the replacement of the internal routines to
2012 calculate the total disk space and amount available with an external
2013 routine\&. The example below gives a possible script that might fulfill
2014 this function\&.
2015 .IP 
2016 The external program will be passed a single parameter indicating a
2017 directory in the filesystem being queried\&. This will typically consist
2018 of the string \f(CW"\&./"\fP\&. The script should return two integers in
2019 ascii\&. The first should be the total disk space in blocks, and the
2020 second should be the number of available blocks\&. An optional third
2021 return value can give the block size in bytes\&. The default blocksize
2022 is 1024 bytes\&.
2023 .IP 
2024 Note: Your script should \fINOT\fP be setuid or setgid and should be
2025 owned by (and writeable only by) root!
2026 .IP 
2027 \fBDefault:\fP
2028 \f(CW   By default internal routines for determining the disk capacity
2029 and remaining space will be used\&.\fP
2030 .IP 
2031 \fBExample:\fP
2032 \f(CW   dfree command = /usr/local/samba/bin/dfree\fP
2033 .IP 
2034 Where the script dfree (which must be made executable) could be:
2035 .IP 
2037 .DS 
2040         #!/bin/sh
2041         df $1 | tail -1 | awk \'{print $2" "$4}\'
2043 .DE 
2046 .IP 
2047 or perhaps (on Sys V based systems):
2048 .IP 
2050 .DS 
2053         #!/bin/sh
2054         /usr/bin/df -k $1 | tail -1 | awk \'{print $3" "$5}\'
2056 .DE 
2059 .IP 
2060 Note that you may have to replace the command names with full
2061 path names on some systems\&.
2062 .IP 
2063 .IP "\fBdirectory (S)\fP" 
2064 .IP 
2065 Synonym for \fBpath\fP\&.
2066 .IP 
2067 .IP "\fBdirectory mask (S)\fP" 
2068 .IP 
2069 This parameter is the octal modes which are used when converting DOS
2070 modes to UNIX modes when creating UNIX directories\&.
2071 .IP 
2072 When a directory is created, the necessary permissions are calculated
2073 according to the mapping from DOS modes to UNIX permissions, and the
2074 resulting UNIX mode is then bit-wise \'AND\'ed with this parameter\&.
2075 This parameter may be thought of as a bit-wise MASK for the UNIX modes
2076 of a directory\&. Any bit \fI*not*\fP set here will be removed from the
2077 modes set on a directory when it is created\&.
2078 .IP 
2079 The default value of this parameter removes the \'group\' and \'other\'
2080 write bits from the UNIX mode, allowing only the user who owns the
2081 directory to modify it\&.
2082 .IP 
2083 Following this Samba will bit-wise \'OR\' the UNIX mode created from
2084 this parameter with the value of the "force directory mode"
2085 parameter\&. This parameter is set to 000 by default (i\&.e\&. no extra mode
2086 bits are added)\&.
2087 .IP 
2088 See the \fB"force directory mode"\fP parameter
2089 to cause particular mode bits to always be set on created directories\&.
2090 .IP 
2091 See also the \fB"create mode"\fP parameter for masking
2092 mode bits on created files, and the \fB"directory security mask"\fP
2093 parameter\&.
2094 .IP 
2095 \fBDefault:\fP
2096 \f(CW   directory mask = 0755\fP
2097 .IP 
2098 \fBExample:\fP
2099 \f(CW   directory mask = 0775\fP
2100 .IP 
2101 .IP "\fBdirectory mode (S)\fP" 
2102 .IP 
2103 Synonym for \fBdirectory mask\fP\&.
2104 .IP 
2105 .IP "\fBdirectory security mask (S)\fP" 
2106 .IP 
2107 This parameter controls what UNIX permission bits can be modified
2108 when a Windows NT client is manipulating the UNIX permission on a
2109 directory using the native NT security dialog box\&.
2110 .IP 
2111 This parameter is applied as a mask (AND\'ed with) to the changed
2112 permission bits, thus preventing any bits not in this mask from
2113 being modified\&. Essentially, zero bits in this mask may be treated
2114 as a set of bits the user is not allowed to change\&.
2115 .IP 
2116 If not set explicitly this parameter is set to the same value as the
2117 \fBdirectory mask\fP parameter\&. To allow a user to
2118 modify all the user/group/world permissions on a directory, set this
2119 parameter to 0777\&.
2120 .IP 
2121 \fINote\fP that users who can access the Samba server through other
2122 means can easily bypass this restriction, so it is primarily
2123 useful for standalone "appliance" systems\&.  Administrators of
2124 most normal systems will probably want to set it to 0777\&.
2125 .IP 
2126 See also the \fBforce directory security
2127 mode\fP, \fBsecurity
2128 mask\fP, \fBforce security mode\fP
2129 parameters\&.
2130 .IP 
2131 \fBDefault:\fP
2132 \f(CW   directory security mask = <same as directory mask>\fP
2133 .IP 
2134 \fBExample:\fP
2135 \f(CW   directory security mask = 0777\fP
2136 .IP 
2137 .IP "\fBdns proxy (G)\fP" 
2138 .IP 
2139 Specifies that \fBnmbd\fP when acting as a WINS
2140 server and finding that a NetBIOS name has not been registered, should
2141 treat the NetBIOS name word-for-word as a DNS name and do a lookup
2142 with the DNS server for that name on behalf of the name-querying
2143 client\&.
2144 .IP 
2145 Note that the maximum length for a NetBIOS name is 15 characters, so
2146 the DNS name (or DNS alias) can likewise only be 15 characters,
2147 maximum\&.
2148 .IP 
2149 \fBnmbd\fP spawns a second copy of itself to do the
2150 DNS name lookup requests, as doing a name lookup is a blocking action\&.
2151 .IP 
2152 See also the parameter \fBwins support\fP\&.
2153 .IP 
2154 \fBDefault:\fP
2155 \f(CW   dns proxy = yes\fP
2156 .IP 
2157 \fBdomain admin group (G)\fP
2158 .IP 
2159 This is an \fBEXPERIMENTAL\fP parameter that is part of the unfinished
2160 Samba NT Domain Controller Code\&. It may be removed in a later release\&.
2161 To work with the latest code builds that may have more support for
2162 Samba NT Domain Controller functionality please subscribe to the
2163 mailing list \fBSamba-ntdom\fP available by sending email to
2164 \fIlistproc@samba\&.org\fP
2165 .IP 
2166 .IP "\fBdomain admin users (G)\fP" 
2167 .IP 
2168 This is an \fBEXPERIMENTAL\fP parameter that is part of the unfinished
2169 Samba NT Domain Controller Code\&. It may be removed in a later release\&.
2170 To work with the latest code builds that may have more support for
2171 Samba NT Domain Controller functionality please subscribe to the
2172 mailing list \fBSamba-ntdom\fP available by sending email to
2173 \fIlistproc@samba\&.org\fP
2174 .IP 
2175 .IP "\fBdomain controller (G)\fP" 
2176 .IP 
2177 This is a \fBDEPRECATED\fP parameter\&. It is currently not used within
2178 the Samba source and should be removed from all current smb\&.conf
2179 files\&. It is left behind for compatibility reasons\&.
2180 .IP 
2181 .IP "\fBdomain groups (G)\fP" 
2182 .IP 
2183 This is an \fBEXPERIMENTAL\fP parameter that is part of the unfinished
2184 Samba NT Domain Controller Code\&. It may be removed in a later release\&.
2185 To work with the latest code builds that may have more support for
2186 Samba NT Domain Controller functionality please subscribe to the
2187 mailing list \fBSamba-ntdom\fP available by sending email to
2188 \fIlistproc@samba\&.org\fP
2189 .IP 
2190 .IP "\fBdomain guest group (G)\fP" 
2191 .IP 
2192 This is an \fBEXPERIMENTAL\fP parameter that is part of the unfinished
2193 Samba NT Domain Controller Code\&. It may be removed in a later release\&.
2194 To work with the latest code builds that may have more support for
2195 Samba NT Domain Controller functionality please subscribe to the
2196 mailing list \fBSamba-ntdom\fP available by sending email to
2197 \fIlistproc@samba\&.org\fP
2198 .IP 
2199 .IP "\fBdomain guest users (G)\fP" 
2200 .IP 
2201 This is an \fBEXPERIMENTAL\fP parameter that is part of the unfinished
2202 Samba NT Domain Controller Code\&. It may be removed in a later release\&.
2203 To work with the latest code builds that may have more support for
2204 Samba NT Domain Controller functionality please subscribe to the
2205 mailing list \fBSamba-ntdom\fP available by sending email to
2206 \fIlistproc@samba\&.org\fP
2207 .IP 
2208 .IP "\fBdomain logons (G)\fP" 
2209 .IP 
2210 If set to true, the Samba server will serve Windows 95/98 Domain
2211 logons for the \fBworkgroup\fP it is in\&. For more
2212 details on setting up this feature see the file DOMAINS\&.txt in the
2213 Samba documentation directory \f(CWdocs/\fP shipped with the source code\&.
2214 .IP 
2215 Note that Win95/98 Domain logons are \fINOT\fP the same as Windows
2216 NT Domain logons\&. NT Domain logons require a Primary Domain Controller
2217 (PDC) for the Domain\&. It is intended that in a future release Samba
2218 will be able to provide this functionality for Windows NT clients
2219 also\&.
2220 .IP 
2221 \fBDefault:\fP
2222 \f(CW   domain logons = no\fP
2223 .IP 
2224 .IP "\fBdomain master (G)\fP" 
2225 .IP 
2226 Tell \fBnmbd\fP to enable WAN-wide browse list
2227 collation\&. Setting this option causes \fBnmbd\fP to
2228 claim a special domain specific NetBIOS name that identifies it as a
2229 domain master browser for its given
2230 \fBworkgroup\fP\&. Local master browsers in the same
2231 \fBworkgroup\fP on broadcast-isolated subnets will give
2232 this \fBnmbd\fP their local browse lists, and then
2233 ask \fBsmbd\fP for a complete copy of the browse list
2234 for the whole wide area network\&.  Browser clients will then contact
2235 their local master browser, and will receive the domain-wide browse
2236 list, instead of just the list for their broadcast-isolated subnet\&.
2237 .IP 
2238 Note that Windows NT Primary Domain Controllers expect to be able to
2239 claim this \fBworkgroup\fP specific special NetBIOS
2240 name that identifies them as domain master browsers for that
2241 \fBworkgroup\fP by default (i\&.e\&. there is no way to
2242 prevent a Windows NT PDC from attempting to do this)\&. This means that
2243 if this parameter is set and \fBnmbd\fP claims the
2244 special name for a \fBworkgroup\fP before a Windows NT
2245 PDC is able to do so then cross subnet browsing will behave strangely
2246 and may fail\&.
2247 .IP 
2248 \fBDefault:\fP
2249 \f(CW   domain master = no\fP
2250 .IP 
2251 .IP "\fBdont descend (S)\fP" 
2252 .IP 
2253 There are certain directories on some systems (e\&.g\&., the \f(CW/proc\fP tree
2254 under Linux) that are either not of interest to clients or are
2255 infinitely deep (recursive)\&. This parameter allows you to specify a
2256 comma-delimited list of directories that the server should always show
2257 as empty\&.
2258 .IP 
2259 Note that Samba can be very fussy about the exact format of the "dont
2260 descend" entries\&. For example you may need \f(CW"\&./proc"\fP instead of
2261 just \f(CW"/proc"\fP\&. Experimentation is the best policy :-)
2262 .IP 
2263 \fBDefault:\fP
2264 \f(CW   none (i\&.e\&., all directories are OK to descend)\fP
2265 .IP 
2266 \fBExample:\fP
2267 \f(CW   dont descend = /proc,/dev\fP
2268 .IP 
2269 .IP "\fBdos filetime resolution (S)\fP" 
2270 .IP 
2271 Under the DOS and Windows FAT filesystem, the finest granularity on
2272 time resolution is two seconds\&. Setting this parameter for a share
2273 causes Samba to round the reported time down to the nearest two second
2274 boundary when a query call that requires one second resolution is made
2275 to \fBsmbd\fP\&.
2276 .IP 
2277 This option is mainly used as a compatibility option for Visual C++
2278 when used against Samba shares\&. If oplocks are enabled on a share,
2279 Visual C++ uses two different time reading calls to check if a file
2280 has changed since it was last read\&. One of these calls uses a
2281 one-second granularity, the other uses a two second granularity\&. As
2282 the two second call rounds any odd second down, then if the file has a
2283 timestamp of an odd number of seconds then the two timestamps will not
2284 match and Visual C++ will keep reporting the file has changed\&. Setting
2285 this option causes the two timestamps to match, and Visual C++ is
2286 happy\&.
2287 .IP 
2288 \fBDefault:\fP
2289 \f(CW   dos filetime resolution = False\fP
2290 .IP 
2291 \fBExample:\fP
2292 \f(CW   dos filetime resolution = True\fP
2293 .IP 
2294 .IP "\fBdos filetimes (S)\fP" 
2295 .IP 
2296 Under DOS and Windows, if a user can write to a file they can change
2297 the timestamp on it\&. Under POSIX semantics, only the owner of the file
2298 or root may change the timestamp\&. By default, Samba runs with POSIX
2299 semantics and refuses to change the timestamp on a file if the user
2300 smbd is acting on behalf of is not the file owner\&. Setting this option
2301 to True allows DOS semantics and smbd will change the file timestamp as
2302 DOS requires\&.
2303 .IP 
2304 \fBDefault:\fP
2305 \f(CW   dos filetimes = False\fP
2306 .IP 
2307 \fBExample:\fP
2308 \f(CW   dos filetimes = True\fP
2309 .IP 
2310 .IP "\fBencrypt passwords (G)\fP" 
2311 .IP 
2312 This boolean controls whether encrypted passwords will be negotiated
2313 with the client\&. Note that Windows NT 4\&.0 SP3 and above and also
2314 Windows 98 will by default expect encrypted passwords unless a
2315 registry entry is changed\&. To use encrypted passwords in Samba see the
2316 file ENCRYPTION\&.txt in the Samba documentation directory \f(CWdocs/\fP
2317 shipped with the source code\&.
2318 .IP 
2319 In order for encrypted passwords to work correctly
2320 \fBsmbd\fP must either have access to a local
2321 \fBsmbpasswd (5)\fP file (see the
2322 \fBsmbpasswd (8)\fP program for information on
2323 how to set up and maintain this file), or set the
2324 \fBsecurity=\fP parameter to either
2325 \fB"server"\fP or
2326 \fB"domain"\fP which causes
2327 \fBsmbd\fP to authenticate against another server\&.
2328 .IP 
2329 .IP "\fBexec (S)\fP" 
2330 .IP 
2331 This is a synonym for \fBpreexec\fP\&.
2332 .IP 
2333 .IP "\fBfake directory create times (S)\fP" 
2334 .IP 
2335 NTFS and Windows VFAT file systems keep a create time for all files
2336 and directories\&. This is not the same as the ctime - status change
2337 time - that Unix keeps, so Samba by default reports the earliest of
2338 the various times Unix does keep\&. Setting this parameter for a share
2339 causes Samba to always report midnight 1-1-1980 as the create time for
2340 directories\&.
2341 .IP 
2342 This option is mainly used as a compatibility option for Visual C++
2343 when used against Samba shares\&. Visual C++ generated makefiles have
2344 the object directory as a dependency for each object file, and a make
2345 rule to create the directory\&. Also, when NMAKE compares timestamps it
2346 uses the creation time when examining a directory\&. Thus the object
2347 directory will be created if it does not exist, but once it does exist
2348 it will always have an earlier timestamp than the object files it
2349 contains\&.
2350 .IP 
2351 However, Unix time semantics mean that the create time reported by
2352 Samba will be updated whenever a file is created or deleted in the
2353 directory\&. NMAKE therefore finds all object files in the object
2354 directory bar the last one built are out of date compared to the
2355 directory and rebuilds them\&. Enabling this option ensures directories
2356 always predate their contents and an NMAKE build will proceed as
2357 expected\&.
2358 .IP 
2359 \fBDefault:\fP
2360 \f(CW   fake directory create times = False\fP
2361 .IP 
2362 \fBExample:\fP
2363 \f(CW   fake directory create times = True\fP
2364 .IP 
2365 .IP "\fBfake oplocks (S)\fP" 
2366 .IP 
2367 Oplocks are the way that SMB clients get permission from a server to
2368 locally cache file operations\&. If a server grants an oplock
2369 (opportunistic lock) then the client is free to assume that it is the
2370 only one accessing the file and it will aggressively cache file
2371 data\&. With some oplock types the client may even cache file open/close
2372 operations\&. This can give enormous performance benefits\&.
2373 .IP 
2374 When you set \f(CW"fake oplocks = yes"\fP \fBsmbd\fP will
2375 always grant oplock requests no matter how many clients are using the
2376 file\&.
2377 .IP 
2378 It is generally much better to use the real \fBoplocks\fP
2379 support rather than this parameter\&.
2380 .IP 
2381 If you enable this option on all read-only shares or shares that you
2382 know will only be accessed from one client at a time such as
2383 physically read-only media like CDROMs, you will see a big performance
2384 improvement on many operations\&. If you enable this option on shares
2385 where multiple clients may be accessing the files read-write at the
2386 same time you can get data corruption\&. Use this option carefully!
2387 .IP 
2388 This option is disabled by default\&.
2389 .IP 
2390 .IP "\fBfollow symlinks (S)\fP" 
2391 .IP 
2392 This parameter allows the Samba administrator to stop
2393 \fBsmbd\fP from following symbolic links in a
2394 particular share\&. Setting this parameter to \fI"No"\fP prevents any file
2395 or directory that is a symbolic link from being followed (the user
2396 will get an error)\&.  This option is very useful to stop users from
2397 adding a symbolic link to \f(CW/etc/passwd\fP in their home directory for
2398 instance\&.  However it will slow filename lookups down slightly\&.
2399 .IP 
2400 This option is enabled (i\&.e\&. \fBsmbd\fP will follow
2401 symbolic links) by default\&.
2402 .IP 
2403 .IP "\fBforce create mode (S)\fP" 
2404 .IP 
2405 This parameter specifies a set of UNIX mode bit permissions that will
2406 \fI*always*\fP be set on a file created by Samba\&. This is done by
2407 bitwise \'OR\'ing these bits onto the mode bits of a file that is being
2408 created\&. The default for this parameter is (in octal) 000\&. The modes
2409 in this parameter are bitwise \'OR\'ed onto the file mode after the mask
2410 set in the \fB"create mask"\fP parameter is applied\&.
2411 .IP 
2412 See also the parameter \fB"create mask"\fP for details
2413 on masking mode bits on created files\&.
2414 .IP 
2415 \fBDefault:\fP
2416 \f(CW   force create mode = 000\fP
2417 .IP 
2418 \fBExample:\fP
2419 \f(CW   force create mode = 0755\fP
2420 .IP 
2421 would force all created files to have read and execute permissions set
2422 for \'group\' and \'other\' as well as the read/write/execute bits set for
2423 the \'user\'\&.
2424 .IP 
2425 .IP "\fBforce directory mode (S)\fP" 
2426 .IP 
2427 This parameter specifies a set of UNIX mode bit permissions that will
2428 \fI*always*\fP be set on a directory created by Samba\&. This is done by
2429 bitwise \'OR\'ing these bits onto the mode bits of a directory that is
2430 being created\&. The default for this parameter is (in octal) 0000 which
2431 will not add any extra permission bits to a created directory\&. This
2432 operation is done after the mode mask in the parameter
2433 \fB"directory mask"\fP is applied\&.
2434 .IP 
2435 See also the parameter \fB"directory mask"\fP for
2436 details on masking mode bits on created directories\&.
2437 .IP 
2438 \fBDefault:\fP
2439 \f(CW   force directory mode = 000\fP
2440 .IP 
2441 \fBExample:\fP
2442 \f(CW   force directory mode = 0755\fP
2443 .IP 
2444 would force all created directories to have read and execute
2445 permissions set for \'group\' and \'other\' as well as the
2446 read/write/execute bits set for the \'user\'\&.
2447 .IP 
2448 .IP "\fBforce directory security mode (S)\fP" 
2449 .IP 
2450 This parameter controls what UNIX permission bits can be modified when
2451 a Windows NT client is manipulating the UNIX permission on a directory
2452 using the native NT security dialog box\&.
2453 .IP 
2454 This parameter is applied as a mask (OR\'ed with) to the changed
2455 permission bits, thus forcing any bits in this mask that the user may
2456 have modified to be on\&. Essentially, one bits in this mask may be
2457 treated as a set of bits that, when modifying security on a directory,
2458 the user has always set to be \'on\'\&.
2459 .IP 
2460 If not set explicitly this parameter is set to the same value as the
2461 \fBforce directory mode\fP parameter\&. To allow
2462 a user to modify all the user/group/world permissions on a directory,
2463 with restrictions set this parameter to 000\&.
2464 .IP 
2465 \fINote\fP that users who can access the Samba server through other
2466 means can easily bypass this restriction, so it is primarily
2467 useful for standalone "appliance" systems\&.  Administrators of
2468 most normal systems will probably want to set it to 0000\&.
2469 .IP 
2470 See also the \fBdirectory security mask\fP,
2471 \fBsecurity mask\fP, \fBforce security
2472 mode\fP parameters\&.
2473 .IP 
2474 \fBDefault:\fP
2475 \f(CW   force directory security mode = <same as force directory mode>\fP
2476 .IP 
2477 \fBExample:\fP
2478 \f(CW   force directory security mode = 0\fP
2479 .IP 
2480 .IP "\fBforce group (S)\fP" 
2481 .IP 
2482 This specifies a UNIX group name that will be assigned as the default
2483 primary group for all users connecting to this service\&. This is useful
2484 for sharing files by ensuring that all access to files on service will
2485 use the named group for their permissions checking\&. Thus, by assigning
2486 permissions for this group to the files and directories within this
2487 service the Samba administrator can restrict or allow sharing of these
2488 files\&.
2489 .IP 
2490 In Samba 2\&.0\&.5 and above this parameter has extended functionality in the following
2491 way\&. If the group name listed here has a \'+\' character prepended to it
2492 then the current user accessing the share only has the primary group 
2493 default assigned to this group if they are already assigned as a member
2494 of that group\&. This allows an administrator to decide that only users
2495 who are already in a particular group will create files with group 
2496 ownership set to that group\&. This gives a finer granularity of ownership
2497 assignment\&. For example, the setting \f(CWforce group = +sys\fP means
2498 that only users who are already in group sys will have their default
2499 primary group assigned to sys when accessing this Samba share\&. All
2500 other users will retain their ordinary primary group\&.
2501 .IP 
2502 If the \fB"force user"\fP parameter is also set the
2503 group specified in \fBforce group\fP will override the primary group
2504 set in \fB"force user"\fP\&.
2505 .IP 
2506 See also \fB"force user"\fP
2507 .IP 
2508 \fBDefault:\fP
2509 \f(CW   no forced group\fP
2510 .IP 
2511 \fBExample:\fP
2512 \f(CW   force group = agroup\fP
2513 .IP 
2514 .IP "\fBforce security mode (S)\fP" 
2515 .IP 
2516 This parameter controls what UNIX permission bits can be modified when
2517 a Windows NT client is manipulating the UNIX permission on a file
2518 using the native NT security dialog box\&.
2519 .IP 
2520 This parameter is applied as a mask (OR\'ed with) to the changed
2521 permission bits, thus forcing any bits in this mask that the user may
2522 have modified to be on\&. Essentially, one bits in this mask may be
2523 treated as a set of bits that, when modifying security on a file, the
2524 user has always set to be \'on\'\&.
2525 .IP 
2526 If not set explicitly this parameter is set to the same value as the
2527 \fBforce create mode\fP parameter\&. To allow
2528 a user to modify all the user/group/world permissions on a file,
2529 with no restrictions set this parameter to 000\&.
2530 .IP 
2531 \fINote\fP that users who can access the Samba server through other
2532 means can easily bypass this restriction, so it is primarily
2533 useful for standalone "appliance" systems\&.  Administrators of
2534 most normal systems will probably want to set it to 0000\&.
2535 .IP 
2536 See also the \fBforce directory security
2537 mode\fP, \fBdirectory security
2538 mask\fP, \fBsecurity mask\fP
2539 parameters\&.
2540 .IP 
2541 \fBDefault:\fP
2542 \f(CW   force security mode = <same as force create mode>\fP
2543 .IP 
2544 \fBExample:\fP
2545 \f(CW   force security mode = 0\fP
2546 .IP 
2547 .IP "\fBforce user (S)\fP" 
2548 .IP 
2549 This specifies a UNIX user name that will be assigned as the default
2550 user for all users connecting to this service\&. This is useful for
2551 sharing files\&. You should also use it carefully as using it
2552 incorrectly can cause security problems\&.
2553 .IP 
2554 This user name only gets used once a connection is established\&. Thus
2555 clients still need to connect as a valid user and supply a valid
2556 password\&. Once connected, all file operations will be performed as the
2557 \f(CW"forced user"\fP, no matter what username the client connected as\&.
2558 .IP 
2559 This can be very useful\&.
2560 .IP 
2561 In Samba 2\&.0\&.5 and above this parameter also causes the primary
2562 group of the forced user to be used as the primary group for all
2563 file activity\&. Prior to 2\&.0\&.5 the primary group was left as the
2564 primary group of the connecting user (this was a bug)\&.
2565 .IP 
2566 See also \fB"force group"\fP
2567 .IP 
2568 \fBDefault:\fP
2569 \f(CW   no forced user\fP
2570 .IP 
2571 \fBExample:\fP
2572 \f(CW   force user = auser\fP
2573 .IP 
2574 .IP "\fBfstype (S)\fP" 
2575 .IP 
2576 This parameter allows the administrator to configure the string that
2577 specifies the type of filesystem a share is using that is reported by
2578 \fBsmbd\fP when a client queries the filesystem type
2579 for a share\&. The default type is \fB"NTFS"\fP for compatibility with
2580 Windows NT but this can be changed to other strings such as "Samba" or
2581 "FAT" if required\&.
2582 .IP 
2583 \fBDefault:\fP
2584 \f(CW   fstype = NTFS\fP
2585 .IP 
2586 \fBExample:\fP
2587 \f(CW   fstype = Samba\fP
2588 .IP 
2589 .IP "\fBgetwd cache (G)\fP" 
2590 .IP 
2591 This is a tuning option\&. When this is enabled a caching algorithm
2592 will be used to reduce the time taken for getwd() calls\&. This can have
2593 a significant impact on performance, especially when the
2594 \fBwidelinks\fP parameter is set to False\&.
2595 .IP 
2596 \fBDefault:\fP
2597 \f(CW   getwd cache = No\fP
2598 .IP 
2599 \fBExample:\fP
2600 \f(CW   getwd cache = Yes\fP
2601 .IP 
2602 .IP "\fBgroup (S)\fP" 
2603 .IP 
2604 Synonym for \fB"force group"\fP\&.
2605 .IP 
2606 .IP "\fBguest account (S)\fP" 
2607 .IP 
2608 This is a username which will be used for access to services which are
2609 specified as \fB\'guest ok\'\fP (see below)\&. Whatever
2610 privileges this user has will be available to any client connecting to
2611 the guest service\&. Typically this user will exist in the password
2612 file, but will not have a valid login\&. The user account \fB"ftp"\fP is
2613 often a good choice for this parameter\&. If a username is specified in
2614 a given service, the specified username overrides this one\&.
2615 .IP 
2616 One some systems the default guest account "nobody" may not be able to
2617 print\&. Use another account in this case\&. You should test this by
2618 trying to log in as your guest user (perhaps by using the \f(CW"su -"\fP
2619 command) and trying to print using the system print command such as
2620 \fBlpr (1)\fP or \fBlp (1)\fP\&.
2621 .IP 
2622 \fBDefault:\fP
2623 \f(CW   specified at compile time, usually "nobody"\fP
2624 .IP 
2625 \fBExample:\fP
2626 \f(CW   guest account = ftp\fP
2627 .IP 
2628 .IP "\fBguest ok (S)\fP" 
2629 .IP 
2630 If this parameter is \fI\'yes\'\fP for a service, then no password is
2631 required to connect to the service\&. Privileges will be those of the
2632 \fBguest account\fP\&.
2633 .IP 
2634 See the section below on \fBsecurity\fP for more
2635 information about this option\&.
2636 .IP 
2637 \fBDefault:\fP
2638 \f(CW   guest ok = no\fP
2639 .IP 
2640 \fBExample:\fP
2641 \f(CW   guest ok = yes\fP
2642 .IP 
2643 .IP "\fBguest only (S)\fP" 
2644 .IP 
2645 If this parameter is \fI\'yes\'\fP for a service, then only guest
2646 connections to the service are permitted\&. This parameter will have no
2647 affect if \fB"guest ok"\fP or \fB"public"\fP
2648 is not set for the service\&.
2649 .IP 
2650 See the section below on \fBsecurity\fP for more
2651 information about this option\&.
2652 .IP 
2653 \fBDefault:\fP
2654 \f(CW   guest only = no\fP
2655 .IP 
2656 \fBExample:\fP
2657 \f(CW   guest only = yes\fP
2658 .IP 
2659 .IP "\fBhide dot files (S)\fP" 
2660 .IP 
2661 This is a boolean parameter that controls whether files starting with
2662 a dot appear as hidden files\&.
2663 .IP 
2664 \fBDefault:\fP
2665 \f(CW   hide dot files = yes\fP
2666 .IP 
2667 \fBExample:\fP
2668 \f(CW   hide dot files = no\fP
2669 .IP 
2670 .IP "\fBhide files(S)\fP" 
2671 .IP 
2672 This is a list of files or directories that are not visible but are
2673 accessible\&.  The DOS \'hidden\' attribute is applied to any files or
2674 directories that match\&.
2675 .IP 
2676 Each entry in the list must be separated by a \f(CW\'/\'\fP, which allows
2677 spaces to be included in the entry\&.  \f(CW\'*\'\fP and \f(CW\'?\'\fP can be used
2678 to specify multiple files or directories as in DOS wildcards\&.
2679 .IP 
2680 Each entry must be a Unix path, not a DOS path and must not include the 
2681 Unix directory separator \f(CW\'/\'\fP\&.
2682 .IP 
2683 Note that the case sensitivity option is applicable in hiding files\&.
2684 .IP 
2685 Setting this parameter will affect the performance of Samba, as it
2686 will be forced to check all files and directories for a match as they
2687 are scanned\&.
2688 .IP 
2689 See also \fB"hide dot files"\fP, \fB"veto
2690 files"\fP and \fB"case sensitive"\fP\&.
2691 .IP 
2692 \fBDefault\fP
2694 .DS 
2697         No files or directories are hidden by this option (dot files are
2698         hidden by default because of the "hide dot files" option)\&.
2700 .DE 
2703 .IP 
2704 \fBExample\fP
2705 \f(CW   hide files = /\&.*/DesktopFolderDB/TrashFor%m/resource\&.frk/\fP
2706 .IP 
2707 The above example is based on files that the Macintosh SMB client
2708 (DAVE) available from \fBThursby\fP creates for
2709 internal use, and also still hides all files beginning with a dot\&.
2710 .IP 
2711 .IP "\fBhomedir map (G)\fP" 
2712 .IP 
2713 If \fB"nis homedir"\fP is true, and
2714 \fBsmbd\fP is also acting as a Win95/98 \fBlogon
2715 server\fP then this parameter specifies the NIS (or YP)
2716 map from which the server for the user\'s home directory should be
2717 extracted\&.  At present, only the Sun auto\&.home map format is
2718 understood\&. The form of the map is:
2719 .IP 
2720 \f(CWusername   server:/some/file/system\fP
2721 .IP 
2722 and the program will extract the servername from before the first
2723 \f(CW\':\'\fP\&.  There should probably be a better parsing system that copes
2724 with different map formats and also Amd (another automounter) maps\&.
2725 .IP 
2726 NB: A working NIS is required on the system for this option to work\&.
2727 .IP 
2728 See also \fB"nis homedir"\fP, \fBdomain
2729 logons\fP\&.
2730 .IP 
2731 \fBDefault:\fP
2732 \f(CW   homedir map = auto\&.home\fP
2733 .IP 
2734 \fBExample:\fP
2735 \f(CW   homedir map = amd\&.homedir\fP
2736 .IP 
2737 .IP "\fBhosts allow (S)\fP" 
2738 .IP 
2739 A synonym for this parameter is \fB\'allow hosts\'\fP
2740 .IP 
2741 This parameter is a comma, space, or tab delimited set of hosts which
2742 are permitted to access a service\&.
2743 .IP 
2744 If specified in the \fB[global]\fP section then it will
2745 apply to all services, regardless of whether the individual service
2746 has a different setting\&.
2747 .IP 
2748 You can specify the hosts by name or IP number\&. For example, you could
2749 restrict access to only the hosts on a Class C subnet with something
2750 like \f(CW"allow hosts = 150\&.203\&.5\&."\fP\&. The full syntax of the list is
2751 described in the man page \fBhosts_access (5)\fP\&. Note that this man
2752 page may not be present on your system, so a brief description will
2753 be given here also\&.
2754 .IP 
2755 Note that the localhost address 127\&.0\&.0\&.1 will always be allowed
2756 access unless specifically denied by a "hosts deny" option\&.
2757 .IP 
2758 You can also specify hosts by network/netmask pairs and by netgroup
2759 names if your system supports netgroups\&. The \fIEXCEPT\fP keyword can also
2760 be used to limit a wildcard list\&. The following examples may provide
2761 some help:
2762 .IP 
2763 \fBExample 1\fP: allow all IPs in 150\&.203\&.*\&.* except one
2764 .IP 
2765 \f(CW   hosts allow = 150\&.203\&. EXCEPT 150\&.203\&.6\&.66\fP
2766 .IP 
2767 \fBExample 2\fP: allow hosts that match the given network/netmask
2768 .IP 
2769 \f(CW   hosts allow = 150\&.203\&.15\&.0/255\&.255\&.255\&.0\fP
2770 .IP 
2771 \fBExample 3\fP: allow a couple of hosts
2772 .IP 
2773 \f(CW   hosts allow = lapland, arvidsjaur\fP
2774 .IP 
2775 \fBExample 4\fP: allow only hosts in NIS netgroup "foonet", but 
2776 deny access from one particular host
2777 .IP 
2778 \f(CW   hosts allow = @foonet\fP
2779 .IP 
2780 \f(CW   hosts deny = pirate\fP
2781 .IP 
2782 Note that access still requires suitable user-level passwords\&.
2783 .IP 
2784 See \fBtestparm (1)\fP for a way of testing your
2785 host access to see if it does what you expect\&.
2786 .IP 
2787 \fBDefault:\fP
2788 \f(CW   none (i\&.e\&., all hosts permitted access)\fP
2789 .IP 
2790 \fBExample:\fP
2791 \f(CW   allow hosts = 150\&.203\&.5\&. myhost\&.mynet\&.edu\&.au\fP
2792 .IP 
2793 .IP "\fBhosts deny (S)\fP" 
2794 .IP 
2795 The opposite of \fB\'hosts allow\'\fP - hosts listed
2796 here are \fINOT\fP permitted access to services unless the specific
2797 services have their own lists to override this one\&. Where the lists
2798 conflict, the \fB\'allow\'\fP list takes precedence\&.
2799 .IP 
2800 \fBDefault:\fP
2801 \f(CW   none (i\&.e\&., no hosts specifically excluded)\fP
2802 .IP 
2803 \fBExample:\fP
2804 \f(CW   hosts deny = 150\&.203\&.4\&. badhost\&.mynet\&.edu\&.au\fP
2805 .IP 
2806 .IP "\fBhosts equiv (G)\fP" 
2807 .IP 
2808 If this global parameter is a non-null string, it specifies the name
2809 of a file to read for the names of hosts and users who will be allowed
2810 access without specifying a password\&.
2811 .IP 
2812 This is not be confused with \fBhosts allow\fP which
2813 is about hosts access to services and is more useful for guest
2814 services\&. \fBhosts equiv\fP may be useful for NT clients which will not
2815 supply passwords to samba\&.
2816 .IP 
2817 NOTE: The use of \fBhosts equiv\fP can be a major security hole\&. This is
2818 because you are trusting the PC to supply the correct username\&. It is
2819 very easy to get a PC to supply a false username\&. I recommend that the
2820 \fBhosts equiv\fP option be only used if you really know what you are
2821 doing, or perhaps on a home network where you trust your spouse and
2822 kids\&. And only if you \fIreally\fP trust them :-)\&.
2823 .IP 
2824 \fBDefault\fP
2825 \f(CW   No host equivalences\fP
2826 .IP 
2827 \fBExample\fP
2828 \f(CW   hosts equiv = /etc/hosts\&.equiv\fP
2829 .IP 
2830 .IP "\fBinclude (G)\fP" 
2831 .IP 
2832 This allows you to include one config file inside another\&.  The file
2833 is included literally, as though typed in place\&.
2834 .IP 
2835 It takes the standard substitutions, except \fB%u\fP,
2836 \fB%P\fP and \fB%S\fP\&.
2837 .IP 
2838 .IP "\fBinterfaces (G)\fP" 
2839 .IP 
2840 This option allows you to setup multiple network interfaces, so that
2841 Samba can properly handle browsing on all interfaces\&.
2842 .IP 
2843 The option takes a list of ip/netmask pairs\&. The netmask may either be
2844 a bitmask, or a bitlength\&.
2845 .IP 
2846 For example, the following line:
2847 .IP 
2848 \f(CWinterfaces = 192\&.168\&.2\&.10/24 192\&.168\&.3\&.10/24\fP
2849 .IP 
2850 would configure two network interfaces with IP addresses 192\&.168\&.2\&.10
2851 and 192\&.168\&.3\&.10\&. The netmasks of both interfaces would be set to
2852 255\&.255\&.255\&.0\&.
2853 .IP 
2854 You could produce an equivalent result by using:
2855 .IP 
2856 \f(CWinterfaces = 192\&.168\&.2\&.10/255\&.255\&.255\&.0 192\&.168\&.3\&.10/255\&.255\&.255\&.0\fP
2857 .IP 
2858 if you prefer that format\&.
2859 .IP 
2860 If this option is not set then Samba will attempt to find a primary
2861 interface, but won\'t attempt to configure more than one interface\&.
2862 .IP 
2863 See also \fB"bind interfaces only"\fP\&.
2864 .IP 
2865 .IP "\fBinvalid users (S)\fP" 
2866 .IP 
2867 This is a list of users that should not be allowed to login to this
2868 service\&. This is really a \fI"paranoid"\fP check to absolutely ensure an
2869 improper setting does not breach your security\&.
2870 .IP 
2871 A name starting with a \f(CW\'@\'\fP is interpreted as an NIS netgroup first
2872 (if your system supports NIS), and then as a UNIX group if the name
2873 was not found in the NIS netgroup database\&.
2874 .IP 
2875 A name starting with \f(CW\'+\'\fP is interpreted only by looking in the
2876 UNIX group database\&. A name starting with \f(CW\'&\'\fP is interpreted only
2877 by looking in the NIS netgroup database (this requires NIS to be
2878 working on your system)\&. The characters \f(CW\'+\'\fP and \f(CW\'&\'\fP may be
2879 used at the start of the name in either order so the value
2880 \f(CW"+&group"\fP means check the UNIX group database, followed by the NIS
2881 netgroup database, and the value \f(CW"&+group"\fP means check the NIS
2882 netgroup database, followed by the UNIX group database (the same as
2883 the \f(CW\'@\'\fP prefix)\&.
2884 .IP 
2885 The current servicename is substituted for
2886 \fB%S\fP\&. This is useful in the \fB[homes]\fP
2887 section\&.
2888 .IP 
2889 See also \fB"valid users"\fP\&.
2890 .IP 
2891 \fBDefault:\fP
2892 \f(CW   No invalid users\fP
2893 .IP 
2894 \fBExample:\fP
2895 \f(CW   invalid users = root fred admin @wheel\fP
2896 .IP 
2897 .IP "\fBkeepalive (G)\fP" 
2898 .IP 
2899 The value of the parameter (an integer) represents the number of
2900 seconds between \fB\'keepalive\'\fP packets\&. If this parameter is zero, no
2901 keepalive packets will be sent\&. Keepalive packets, if sent, allow the
2902 server to tell whether a client is still present and responding\&.
2903 .IP 
2904 Keepalives should, in general, not be needed if the socket being used
2905 has the SO_KEEPALIVE attribute set on it (see \fB"socket
2906 options"\fP)\&. Basically you should only use this option
2907 if you strike difficulties\&.
2908 .IP 
2909 \fBDefault:\fP
2910 \f(CW   keepalive = 0\fP
2911 .IP 
2912 \fBExample:\fP
2913 \f(CW   keepalive = 60\fP
2914 .IP 
2915 .IP "\fBkernel oplocks (G)\fP" 
2916 .IP 
2917 For UNIXs that support kernel based \fBoplocks\fP
2918 (currently only IRIX but hopefully also Linux and FreeBSD soon) this
2919 parameter allows the use of them to be turned on or off\&.
2920 .IP 
2921 Kernel oplocks support allows Samba \fBoplocks\fP to be
2922 broken whenever a local UNIX process or NFS operation accesses a file
2923 that \fBsmbd\fP has oplocked\&. This allows complete
2924 data consistency between SMB/CIFS, NFS and local file access (and is a
2925 \fIvery\fP cool feature :-)\&.
2926 .IP 
2927 This parameter defaults to \fI"On"\fP on systems that have the support,
2928 and \fI"off"\fP on systems that don\'t\&. You should never need to touch
2929 this parameter\&.
2930 .IP 
2931 See also the \fB"oplocks"\fP and \fB"level2 oplocks"\fP
2932 parameters\&.
2933 .IP 
2934 .IP "\fBldap filter (G)\fP" 
2935 .IP 
2936 This parameter is part of the \fIEXPERIMENTAL\fP Samba support for a
2937 password database stored on an LDAP server back-end\&. These options
2938 are only available if your version of Samba was configured with
2939 the \fB--with-ldap\fP option\&.
2940 .IP 
2941 This parameter specifies an LDAP search filter used to search for a
2942 user name in the LDAP database\&. It must contain the string
2943 \fB%u\fP which will be replaced with the user being
2944 searched for\&.
2945 .IP 
2946 \fBDefault:\fP
2947 \f(CW   empty string\&.\fP
2948 .IP 
2949 .IP "\fBldap port (G)\fP" 
2950 .IP 
2951 This parameter is part of the \fIEXPERIMENTAL\fP Samba support for a
2952 password database stored on an LDAP server back-end\&. These options
2953 are only available if your version of Samba was configured with
2954 the \fB--with-ldap\fP option\&.
2955 .IP 
2956 This parameter specifies the TCP port number to use to contact
2957 the LDAP server on\&.
2958 .IP 
2959 \fBDefault:\fP
2960 \f(CW   ldap port = 389\&.\fP
2961 .IP 
2962 .IP "\fBldap root (G)\fP" 
2963 .IP 
2964 This parameter is part of the \fIEXPERIMENTAL\fP Samba support for a
2965 password database stored on an LDAP server back-end\&. These options
2966 are only available if your version of Samba was configured with
2967 the \fB--with-ldap\fP option\&.
2968 .IP 
2969 This parameter specifies the entity to bind to the LDAP server
2970 as (essentially the LDAP username) in order to be able to perform
2971 queries and modifications on the LDAP database\&.
2972 .IP 
2973 See also \fBldap root passwd\fP\&.
2974 .IP 
2975 \fBDefault:\fP
2976 \f(CW   empty string (no user defined)\fP
2977 .IP 
2978 .IP "\fBldap root passwd (G)\fP" 
2979 .IP 
2980 This parameter is part of the \fIEXPERIMENTAL\fP Samba support for a
2981 password database stored on an LDAP server back-end\&. These options
2982 are only available if your version of Samba was configured with
2983 the \fB--with-ldap\fP option\&.
2984 .IP 
2985 This parameter specifies the password for the entity to bind to the
2986 LDAP server as (the password for this LDAP username) in order to be
2987 able to perform queries and modifications on the LDAP database\&.
2988 .IP 
2989 \fIBUGS:\fP This parameter should \fINOT\fP be a readable parameter
2990 in the \fBsmb\&.conf\fP file and will be removed once a correct
2991 storage place is found\&.
2992 .IP 
2993 See also \fBldap root\fP\&.
2994 .IP 
2995 \fBDefault:\fP
2996 \f(CW   empty string\&.\fP
2997 .IP 
2998 .IP "\fBldap server (G)\fP" 
2999 .IP 
3000 This parameter is part of the \fIEXPERIMENTAL\fP Samba support for a
3001 password database stored on an LDAP server back-end\&. These options
3002 are only available if your version of Samba was configured with
3003 the \fB--with-ldap\fP option\&.
3004 .IP 
3005 This parameter specifies the DNS name of the LDAP server to use
3006 for SMB/CIFS authentication purposes\&.
3007 .IP 
3008 \fBDefault:\fP
3009 \f(CW   ldap server = localhost\fP
3010 .IP 
3011 .IP "\fBldap suffix (G)\fP" 
3012 .IP 
3013 This parameter is part of the \fIEXPERIMENTAL\fP Samba support for a
3014 password database stored on an LDAP server back-end\&. These options
3015 are only available if your version of Samba was configured with
3016 the \fB--with-ldap\fP option\&.
3017 .IP 
3018 This parameter specifies the \f(CW"dn"\fP or LDAP \fI"distinguished name"\fP
3019 that tells \fBsmbd\fP to start from when searching
3020 for an entry in the LDAP password database\&.
3021 .IP 
3022 \fBDefault:\fP
3023 \f(CW   empty string\&.\fP
3024 .IP 
3025 .IP "\fBlevel2 oplocks (S)\fP" 
3026 .IP 
3027 This parameter (new in Samba 2\&.0\&.5) controls whether Samba supports
3028 level2 (read-only) oplocks on a share\&. In Samba 2\&.0\&.4 this parameter
3029 defaults to "False" as the code is new, but will default to "True"
3030 in a later release\&.
3031 .IP 
3032 Level2, or read-only oplocks allow Windows NT clients that have an
3033 oplock on a file to downgrade from a read-write oplock to a read-only
3034 oplock once a second client opens the file (instead of releasing all
3035 oplocks on a second open, as in traditional, exclusive oplocks)\&. This
3036 allows all openers of the file that support level2 oplocks to cache
3037 the file for read-ahead only (ie\&. they may not cache writes or lock
3038 requests) and increases performance for many acesses of files that
3039 are not commonly written (such as application \&.EXE files)\&.
3040 .IP 
3041 Once one of the clients which have a read-only oplock writes to
3042 the file all clients are notified (no reply is needed or waited
3043 for) and told to break their oplocks to "none" and delete any
3044 read-ahead caches\&.
3045 .IP 
3046 It is recommended that this parameter be turned on to speed access
3047 to shared executables (and also to test the code :-)\&.
3048 .IP 
3049 For more discussions on level2 oplocks see the CIFS spec\&.
3050 .IP 
3051 Currently, if \fB"kernel oplocks"\fP are supported
3052 then level2 oplocks are not granted (even if this parameter is set
3053 to \f(CW"true"\fP)\&. Note also, the \fB"oplocks"\fP parameter must
3054 be set to "true" on this share in order for this parameter to have any
3055 effect\&.
3056 .IP 
3057 See also the \fB"oplocks"\fP and \fB"kernel oplocks"\fP parameters\&.
3058 .IP 
3059 \fBDefault:\fP
3060 \f(CW level2 oplocks = False\fP
3061 .IP 
3062 \fBExample:\fP
3063 \f(CW level2 oplocks = True\fP
3064 .IP 
3065 .IP "\fBlm announce (G)\fP" 
3066 .IP 
3067 This parameter determines if \fBnmbd\fP will produce
3068 Lanman announce broadcasts that are needed by \fBOS/2\fP clients in order
3069 for them to see the Samba server in their browse list\&. This parameter
3070 can have three values, \f(CW"true"\fP, \f(CW"false"\fP, or \f(CW"auto"\fP\&. The
3071 default is \f(CW"auto"\fP\&.  If set to \f(CW"false"\fP Samba will never produce
3072 these broadcasts\&. If set to \f(CW"true"\fP Samba will produce Lanman
3073 announce broadcasts at a frequency set by the parameter \fB"lm
3074 interval"\fP\&. If set to \f(CW"auto"\fP Samba will not send Lanman
3075 announce broadcasts by default but will listen for them\&. If it hears
3076 such a broadcast on the wire it will then start sending them at a
3077 frequency set by the parameter \fB"lm interval"\fP\&.
3078 .IP 
3079 See also \fB"lm interval"\fP\&.
3080 .IP 
3081 \fBDefault:\fP
3082 \f(CW   lm announce = auto\fP
3083 .IP 
3084 \fBExample:\fP
3085 \f(CW   lm announce = true\fP
3086 .IP 
3087 .IP "\fBlm interval (G)\fP" 
3088 .IP 
3089 If Samba is set to produce Lanman announce broadcasts needed by
3090 \fBOS/2\fP clients (see the \fB"lm announce"\fP
3091 parameter) then this parameter defines the frequency in seconds with
3092 which they will be made\&.  If this is set to zero then no Lanman
3093 announcements will be made despite the setting of the \fB"lm
3094 announce"\fP parameter\&.
3095 .IP 
3096 See also \fB"lm announce"\fP\&.
3097 .IP 
3098 \fBDefault:\fP
3099 \f(CW   lm interval = 60\fP
3100 .IP 
3101 \fBExample:\fP
3102 \f(CW   lm interval = 120\fP
3103 .IP 
3104 .IP "\fBload printers (G)\fP" 
3105 .IP 
3106 A boolean variable that controls whether all printers in the printcap
3107 will be loaded for browsing by default\&. See the
3108 \fB"printers"\fP section for more details\&.
3109 .IP 
3110 \fBDefault:\fP
3111 \f(CW   load printers = yes\fP
3112 .IP 
3113 \fBExample:\fP
3114 \f(CW   load printers = no\fP
3115 .IP 
3116 .IP "\fBlocal master (G)\fP" 
3117 .IP 
3118 This option allows \fBnmbd\fP to try and become a
3119 local master browser on a subnet\&. If set to False then
3120 \fBnmbd\fP will not attempt to become a local master
3121 browser on a subnet and will also lose in all browsing elections\&. By
3122 default this value is set to true\&. Setting this value to true doesn\'t
3123 mean that Samba will \fIbecome\fP the local master browser on a subnet,
3124 just that \fBnmbd\fP will \fIparticipate\fP in
3125 elections for local master browser\&.
3126 .IP 
3127 Setting this value to False will cause \fBnmbd\fP
3128 \fInever\fP to become a local master browser\&.
3129 .IP 
3130 \fBDefault:\fP
3131 \f(CW   local master = yes\fP
3132 .IP 
3133 .IP "\fBlock dir (G)\fP" 
3134 .IP 
3135 Synonym for \fB"lock directory"\fP\&.
3136 .IP 
3137 .IP "\fBlock directory (G)\fP" 
3138 .IP 
3139 This option specifies the directory where lock files will be placed\&.
3140 The lock files are used to implement the \fB"max
3141 connections"\fP option\&.
3142 .IP 
3143 \fBDefault:\fP
3144 \f(CW   lock directory = /tmp/samba\fP
3145 .IP 
3146 \fBExample:\fP
3147 \f(CW   lock directory = /usr/local/samba/var/locks\fP
3148 .IP 
3149 .IP "\fBlocking (S)\fP" 
3150 .IP 
3151 This controls whether or not locking will be performed by the server
3152 in response to lock requests from the client\&.
3153 .IP 
3154 If \f(CW"locking = no"\fP, all lock and unlock requests will appear to
3155 succeed and all lock queries will indicate that the queried lock is
3156 clear\&.
3157 .IP 
3158 If \f(CW"locking = yes"\fP, real locking will be performed by the server\&.
3159 .IP 
3160 This option \fImay\fP be useful for read-only filesystems which \fImay\fP
3161 not need locking (such as cdrom drives), although setting this
3162 parameter of \f(CW"no"\fP is not really recommended even in this case\&.
3163 .IP 
3164 Be careful about disabling locking either globally or in a specific
3165 service, as lack of locking may result in data corruption\&. You should
3166 never need to set this parameter\&.
3167 .IP 
3168 \fBDefault:\fP
3169 \f(CW   locking = yes\fP
3170 .IP 
3171 \fBExample:\fP
3172 \f(CW   locking = no\fP
3173 .IP 
3174 .IP "\fBlog file (G)\fP" 
3175 .IP 
3176 This options allows you to override the name of the Samba log file
3177 (also known as the debug file)\&.
3178 .IP 
3179 This option takes the standard substitutions, allowing you to have
3180 separate log files for each user or machine\&.
3181 .IP 
3182 \fBExample:\fP
3183 \f(CW   log file = /usr/local/samba/var/log\&.%m\fP
3184 .IP 
3185 .IP "\fBlog level (G)\fP" 
3186 .IP 
3187 Synonym for \fB"debug level"\fP\&.
3188 .IP 
3189 .IP "\fBlogon drive (G)\fP" 
3190 .IP 
3191 This parameter specifies the local path to which the home directory
3192 will be connected (see \fB"logon home"\fP) and is only
3193 used by NT Workstations\&. 
3194 .IP 
3195 Note that this option is only useful if Samba is set up as a
3196 \fBlogon server\fP\&.
3197 .IP 
3198 \fBExample:\fP
3199 \f(CW   logon drive = h:\fP
3200 .IP 
3201 .IP "\fBlogon home (G)\fP" 
3202 .IP 
3203 This parameter specifies the home directory location when a Win95/98 or
3204 NT Workstation logs into a Samba PDC\&.  It allows you to do 
3205 .IP 
3206 \f(CW"NET USE H: /HOME"\fP
3207 .IP 
3208 from a command prompt, for example\&.
3209 .IP 
3210 This option takes the standard substitutions, allowing you to have
3211 separate logon scripts for each user or machine\&.
3212 .IP 
3213 Note that this option is only useful if Samba is set up as a
3214 \fBlogon server\fP\&.
3215 .IP 
3216 \fBExample:\fP
3217 \f(CW   logon home = "\e\eremote_smb_server\e%U"\fP
3218 .IP 
3219 \fBDefault:\fP
3220 \f(CW   logon home = "\e\e%N\e%U"\fP
3221 .IP 
3222 .IP "\fBlogon path (G)\fP" 
3223 .IP 
3224 This parameter specifies the home directory where roaming profiles
3225 (USER\&.DAT / USER\&.MAN files for Windows 95/98) are stored\&.
3226 .IP 
3227 This option takes the standard substitutions, allowing you to have
3228 separate logon scripts for each user or machine\&.  It also specifies
3229 the directory from which the \f(CW"desktop"\fP, \f(CW"start menu"\fP,
3230 \f(CW"network neighborhood"\fP and \f(CW"programs"\fP folders, and their
3231 contents, are loaded and displayed on your Windows 95/98 client\&.
3232 .IP 
3233 The share and the path must be readable by the user for the
3234 preferences and directories to be loaded onto the Windows 95/98
3235 client\&.  The share must be writeable when the logs in for the first
3236 time, in order that the Windows 95/98 client can create the user\&.dat
3237 and other directories\&.
3238 .IP 
3239 Thereafter, the directories and any of the contents can, if required, be
3240 made read-only\&.  It is not advisable that the USER\&.DAT file be made
3241 read-only - rename it to USER\&.MAN to achieve the desired effect (a
3242 \fIMAN\fPdatory profile)\&.
3243 .IP 
3244 Windows clients can sometimes maintain a connection to the [homes]
3245 share, even though there is no user logged in\&.  Therefore, it is vital
3246 that the logon path does not include a reference to the homes share
3247 (i\&.e\&. setting this parameter to \f(CW\e\e%N\eHOMES\eprofile_path\fP will cause
3248 problems)\&.
3249 .IP 
3250 This option takes the standard substitutions, allowing you to have
3251 separate logon scripts for each user or machine\&.
3252 .IP 
3253 Note that this option is only useful if Samba is set up as a
3254 \fBlogon server\fP\&.
3255 .IP 
3256 \fBDefault:\fP
3257 \f(CW   logon path = \e\e%N\e%U\eprofile\fP
3258 .IP 
3259 \fBExample:\fP
3260 \f(CW   logon path = \e\ePROFILESERVER\eHOME_DIR\e%U\ePROFILE\fP
3261 .IP 
3262 .IP "\fBlogon script (G)\fP" 
3263 .IP 
3264 This parameter specifies the batch file (\&.bat) or NT command file
3265 (\&.cmd) to be downloaded and run on a machine when a user successfully
3266 logs in\&.  The file must contain the DOS style cr/lf line endings\&.
3267 Using a DOS-style editor to create the file is recommended\&.
3268 .IP 
3269 The script must be a relative path to the \f(CW[netlogon]\fP service\&.  If
3270 the \f(CW[netlogon]\fP service specifies a \fBpath\fP of
3271 /usr/local/samba/netlogon, and logon script = STARTUP\&.BAT, then the
3272 file that will be downloaded is:
3273 .IP 
3274 \f(CW/usr/local/samba/netlogon/STARTUP\&.BAT\fP
3275 .IP 
3276 The contents of the batch file is entirely your choice\&.  A suggested
3277 command would be to add \f(CWNET TIME \e\eSERVER /SET /YES\fP, to force every
3278 machine to synchronize clocks with the same time server\&.  Another use
3279 would be to add \f(CWNET USE U: \e\eSERVER\eUTILS\fP for commonly used
3280 utilities, or \f(CWNET USE Q: \e\eSERVER\eISO9001_QA\fP for example\&.
3281 .IP 
3282 Note that it is particularly important not to allow write access to
3283 the \f(CW[netlogon]\fP share, or to grant users write permission on the
3284 batch files in a secure environment, as this would allow the batch
3285 files to be arbitrarily modified and security to be breached\&.
3286 .IP 
3287 This option takes the standard substitutions, allowing you to have
3288 separate logon scripts for each user or machine\&.
3289 .IP 
3290 Note that this option is only useful if Samba is set up as a
3291 \fBlogon server\fP\&.
3292 .IP 
3293 \fBExample:\fP
3294 \f(CW   logon script = scripts\e%U\&.bat\fP
3295 .IP 
3296 .IP "\fBlppause command (S)\fP" 
3297 .IP 
3298 This parameter specifies the command to be executed on the server host
3299 in order to stop printing or spooling a specific print job\&.
3300 .IP 
3301 This command should be a program or script which takes a printer name
3302 and job number to pause the print job\&. One way of implementing this is
3303 by using job priorities, where jobs having a too low priority won\'t be
3304 sent to the printer\&.
3305 .IP 
3306 If a \f(CW"%p"\fP is given then the printername is put in its place\&. A
3307 \f(CW"%j"\fP is replaced with the job number (an integer)\&.  On HPUX (see
3308 \fBprinting=hpux\fP), if the \f(CW"-p%p"\fP option is added
3309 to the lpq command, the job will show up with the correct status,
3310 i\&.e\&. if the job priority is lower than the set fence priority it will
3311 have the PAUSED status, whereas if the priority is equal or higher it
3312 will have the SPOOLED or PRINTING status\&.
3313 .IP 
3314 Note that it is good practice to include the absolute path in the
3315 lppause command as the PATH may not be available to the server\&.
3316 .IP 
3317 See also the \fB"printing"\fP parameter\&.
3318 .IP 
3319 \fBDefault:\fP
3320 Currently no default value is given to this string, unless the
3321 value of the \fB"printing"\fP parameter is \f(CWSYSV\fP, in
3322 which case the default is :
3323 .IP 
3324 \f(CW   lp -i %p-%j -H hold\fP
3325 .IP 
3326 or if the value of the \fB"printing"\fP parameter is \f(CWsoftq\fP,
3327 then the default is:
3328 .IP 
3329 \f(CW   qstat -s -j%j -h\fP
3330 .IP 
3331 \fBExample for HPUX:\fP
3332 lppause command = /usr/bin/lpalt %p-%j -p0
3333 .IP 
3334 .IP "\fBlpq cache time (G)\fP" 
3335 .IP 
3336 This controls how long lpq info will be cached for to prevent the
3337 \fBlpq\fP command being called too often\&. A separate cache is kept for
3338 each variation of the \fBlpq\fP command used by the system, so if you
3339 use different \fBlpq\fP commands for different users then they won\'t
3340 share cache information\&.
3341 .IP 
3342 The cache files are stored in \f(CW/tmp/lpq\&.xxxx\fP where xxxx is a hash of
3343 the \fBlpq\fP command in use\&.
3344 .IP 
3345 The default is 10 seconds, meaning that the cached results of a
3346 previous identical \fBlpq\fP command will be used if the cached data is
3347 less than 10 seconds old\&. A large value may be advisable if your
3348 \fBlpq\fP command is very slow\&.
3349 .IP 
3350 A value of 0 will disable caching completely\&.
3351 .IP 
3352 See also the \fB"printing"\fP parameter\&.
3353 .IP 
3354 \fBDefault:\fP
3355 \f(CW   lpq cache time = 10\fP
3356 .IP 
3357 \fBExample:\fP
3358 \f(CW   lpq cache time = 30\fP
3359 .IP 
3360 .IP "\fBlpq command (S)\fP" 
3361 .IP 
3362 This parameter specifies the command to be executed on the server host
3363 in order to obtain \f(CW"lpq"\fP-style printer status information\&.
3364 .IP 
3365 This command should be a program or script which takes a printer name
3366 as its only parameter and outputs printer status information\&.
3367 .IP 
3368 Currently eight styles of printer status information are supported;
3369 BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX and SOFTQ\&. This covers most UNIX
3370 systems\&. You control which type is expected using the
3371 \fB"printing ="\fP option\&.
3372 .IP 
3373 Some clients (notably Windows for Workgroups) may not correctly send
3374 the connection number for the printer they are requesting status
3375 information about\&. To get around this, the server reports on the first
3376 printer service connected to by the client\&. This only happens if the
3377 connection number sent is invalid\&.
3378 .IP 
3379 If a \f(CW%p\fP is given then the printername is put in its place\&. Otherwise
3380 it is placed at the end of the command\&.
3381 .IP 
3382 Note that it is good practice to include the absolute path in the \fBlpq
3383 command\fP as the PATH may not be available to the server\&.
3384 .IP 
3385 See also the \fB"printing"\fP parameter\&.
3386 .IP 
3387 \fBDefault:\fP
3388 \f(CW        depends on the setting of printing =\fP
3389 .IP 
3390 \fBExample:\fP
3391 \f(CW   lpq command = /usr/bin/lpq %p\fP
3392 .IP 
3393 .IP "\fBlpresume command (S)\fP" 
3394 .IP 
3395 This parameter specifies the command to be executed on the server host
3396 in order to restart or continue printing or spooling a specific print
3397 job\&.
3398 .IP 
3399 This command should be a program or script which takes a printer name
3400 and job number to resume the print job\&. See also the \fB"lppause
3401 command"\fP parameter\&.
3402 .IP 
3403 If a \f(CW%p\fP is given then the printername is put in its place\&. A
3404 \f(CW%j\fP is replaced with the job number (an integer)\&.
3405 .IP 
3406 Note that it is good practice to include the absolute path in the \fBlpresume
3407 command\fP as the PATH may not be available to the server\&.
3408 .IP 
3409 See also the \fB"printing"\fP parameter\&.
3410 .IP 
3411 \fBDefault:\fP
3412 .IP 
3413 Currently no default value is given to this string, unless the
3414 value of the \fB"printing"\fP parameter is \f(CWSYSV\fP, in
3415 which case the default is :
3416 .IP 
3417 \f(CW   lp -i %p-%j -H resume\fP
3418 .IP 
3419 or if the value of the \fB"printing"\fP parameter is \f(CWsoftq\fP,
3420 then the default is:
3421 .IP 
3422 \f(CW   qstat -s -j%j -r\fP
3423 .IP 
3424 \fBExample for HPUX:\fP
3425 \f(CW        lpresume command = /usr/bin/lpalt %p-%j -p2\fP
3426 .IP 
3427 .IP "\fBlprm command (S)\fP" 
3428 .IP 
3429 This parameter specifies the command to be executed on the server host
3430 in order to delete a print job\&.
3431 .IP 
3432 This command should be a program or script which takes a printer name
3433 and job number, and deletes the print job\&.
3434 .IP 
3435 If a \f(CW%p\fP is given then the printername is put in its place\&. A
3436 \f(CW%j\fP is replaced with the job number (an integer)\&.
3437 .IP 
3438 Note that it is good practice to include the absolute path in the
3439 \fBlprm command\fP as the PATH may not be available to the server\&.
3440 .IP 
3441 See also the \fB"printing"\fP parameter\&.
3442 .IP 
3443 \fBDefault:\fP
3444 \f(CW   depends on the setting of "printing ="\fP
3445 .IP 
3446 \fBExample 1:\fP
3447 \f(CW   lprm command = /usr/bin/lprm -P%p %j\fP
3448 .IP 
3449 \fBExample 2:\fP
3450 \f(CW   lprm command = /usr/bin/cancel %p-%j\fP
3451 .IP 
3452 .IP "\fBmachine password timeout (G)\fP" 
3453 .IP 
3454 If a Samba server is a member of an Windows NT Domain (see the
3455 \fB"security=domain"\fP) parameter) then
3456 periodically a running \fBsmbd\fP process will try and
3457 change the \fBMACHINE ACCOUNT PASWORD\fP stored in the file called
3458 \f(CW<Domain>\&.<Machine>\&.mac\fP where \f(CW<Domain>\fP is the name of the
3459 Domain we are a member of and \f(CW<Machine>\fP is the primary
3460 \fB"NetBIOS name"\fP of the machine
3461 \fBsmbd\fP is running on\&. This parameter specifies how
3462 often this password will be changed, in seconds\&. The default is one
3463 week (expressed in seconds), the same as a Windows NT Domain member
3464 server\&.
3465 .IP 
3466 See also \fBsmbpasswd (8)\fP, and the
3467 \fB"security=domain"\fP) parameter\&.
3468 .IP 
3469 \fBDefault:\fP
3470 \f(CW   machine password timeout = 604800\fP
3471 .IP 
3472 .IP "\fBmagic output (S)\fP" 
3473 .IP 
3474 This parameter specifies the name of a file which will contain output
3475 created by a magic script (see the \fB"magic
3476 script"\fP parameter below)\&.
3477 .IP 
3478 Warning: If two clients use the same \fB"magic
3479 script"\fP in the same directory the output file content
3480 is undefined\&.
3481 .IP 
3482 \fBDefault:\fP
3483 \f(CW   magic output = <magic script name>\&.out\fP
3484 .IP 
3485 \fBExample:\fP
3486 \f(CW   magic output = myfile\&.txt\fP
3487 .IP 
3488 .IP "\fBmagic script (S)\fP" 
3489 .IP 
3490 This parameter specifies the name of a file which, if opened, will be
3491 executed by the server when the file is closed\&. This allows a UNIX
3492 script to be sent to the Samba host and executed on behalf of the
3493 connected user\&.
3494 .IP 
3495 Scripts executed in this way will be deleted upon completion,
3496 permissions permitting\&.
3497 .IP 
3498 If the script generates output, output will be sent to the file
3499 specified by the \fB"magic output"\fP parameter (see
3500 above)\&.
3501 .IP 
3502 Note that some shells are unable to interpret scripts containing
3503 carriage-return-linefeed instead of linefeed as the end-of-line
3504 marker\&. Magic scripts must be executable \fI"as is"\fP on the host,
3505 which for some hosts and some shells will require filtering at the DOS
3506 end\&.
3507 .IP 
3508 Magic scripts are \fIEXPERIMENTAL\fP and should \fINOT\fP be relied upon\&.
3509 .IP 
3510 \fBDefault:\fP
3511 \f(CW   None\&. Magic scripts disabled\&.\fP
3512 .IP 
3513 \fBExample:\fP
3514 \f(CW   magic script = user\&.csh\fP
3515 .IP 
3516 .IP "\fBmangle case (S)\fP" 
3517 .IP 
3518 See the section on \fB"NAME MANGLING"\fP\&.
3519 .IP 
3520 .IP "\fBmangle locks (S)\fP" 
3521 .IP 
3522 This option is new with Samba 2\&.0\&.4 and above\&. It only has an effect on locking
3523 when Samba is running on a 32-bit platform such as Linux (2\&.0, 2\&.2) on x86 but not on
3524 64-bit platforms such as IRIX, Solaris 2\&.7 and above, AIX 4\&.2 etc\&.
3525 .IP 
3526 This option was introduced as NT clients have a bug in that they still send 64-bit
3527 lock requests to servers like Samba on 32-bit platforms that have explicitly 
3528 told the client that they do not support 64-bit file access\&.
3529 .IP 
3530 If this option is set to "True" (the default) on a 32-bit system then Samba
3531 will truncate any lock length greater than 31 bits (the POSIX limit on 32-bit
3532 systems) and then attempt to mangle the lock offset from a 64-bit value to a
3533 high 32 bit value\&. It does this by examining the number of bits set in the
3534 top 32 bits, looking at the lower 31 bits starting from the 31st bit going
3535 downward (the POSIX limit on 32-bit systems) for a range of zero bits that
3536 this can be mapped into and then mapping the upper set bits into the lower
3537 set bits\&.
3538 .IP 
3539 If no space can be found then a locking error is returned to the client\&.
3540 .IP 
3541 Note that this option has \fBNO\fP effect on 64 bit systems\&. It should not
3542 be turned off on 32 bit systems unless it can be shown that this is causing
3543 a locking problem for a client application\&.
3544 .IP 
3545 \fBDefault:\fP
3546 \f(CW           mangle locks = Yes\fP
3547 .IP 
3548 \fBExample:\fP
3549 \f(CW           mangle locks = No\fP
3550 .IP 
3551 .IP "\fBmangled map (S)\fP" 
3552 .IP 
3553 This is for those who want to directly map UNIX file names which can
3554 not be represented on Windows/DOS\&.  The mangling of names is not always
3555 what is needed\&.  In particular you may have documents with file
3556 extensions that differ between DOS and UNIX\&. For example, under UNIX
3557 it is common to use \f(CW"\&.html"\fP for HTML files, whereas under
3558 Windows/DOS \f(CW"\&.htm"\fP is more commonly used\&.
3559 .IP 
3560 So to map \f(CW"html"\fP to \f(CW"htm"\fP you would use:
3561 .IP 
3562 \f(CW  mangled map = (*\&.html *\&.htm)\fP
3563 .IP 
3564 One very useful case is to remove the annoying \f(CW";1"\fP off the ends
3565 of filenames on some CDROMS (only visible under some UNIXs)\&. To do
3566 this use a map of (*;1 *)\&.
3567 .IP 
3568 \fBdefault:\fP
3569 \f(CW   no mangled map\fP
3570 .IP 
3571 \fBExample:\fP
3572 \f(CW   mangled map = (*;1 *)\fP
3573 .IP 
3574 .IP "\fBmangled names (S)\fP" 
3575 .IP 
3576 This controls whether non-DOS names under UNIX should be mapped to
3577 DOS-compatible names ("mangled") and made visible, or whether non-DOS
3578 names should simply be ignored\&.
3579 .IP 
3580 See the section on \fB"NAME MANGLING"\fP for details
3581 on how to control the mangling process\&.
3582 .IP 
3583 If mangling is used then the mangling algorithm is as follows:
3584 .IP 
3585 .IP 
3586 .IP o 
3587 The first (up to) five alphanumeric characters before the
3588 rightmost dot of the filename are preserved, forced to upper case, and
3589 appear as the first (up to) five characters of the mangled name\&.
3590 .IP 
3591 .IP o 
3592 A tilde \f(CW"~"\fP is appended to the first part of the mangled
3593 name, followed by a two-character unique sequence, based on the
3594 original root name (i\&.e\&., the original filename minus its final
3595 extension)\&. The final extension is included in the hash calculation
3596 only if it contains any upper case characters or is longer than three
3597 characters\&.
3598 .IP 
3599 Note that the character to use may be specified using the
3600 \fB"mangling char"\fP option, if you don\'t like
3601 \f(CW\'~\'\fP\&.
3602 .IP 
3603 .IP o 
3604 The first three alphanumeric characters of the final extension
3605 are preserved, forced to upper case and appear as the extension of the
3606 mangled name\&. The final extension is defined as that part of the
3607 original filename after the rightmost dot\&. If there are no dots in the
3608 filename, the mangled name will have no extension (except in the case
3609 of \fB"hidden files"\fP - see below)\&.
3610 .IP 
3611 .IP o 
3612 Files whose UNIX name begins with a dot will be presented as DOS
3613 hidden files\&. The mangled name will be created as for other filenames,
3614 but with the leading dot removed and \f(CW"___"\fP as its extension regardless
3615 of actual original extension (that\'s three underscores)\&.
3616 .IP 
3617 .IP 
3618 The two-digit hash value consists of upper case alphanumeric
3619 characters\&.
3620 .IP 
3621 This algorithm can cause name collisions only if files in a directory
3622 share the same first five alphanumeric characters\&. The probability of
3623 such a clash is 1/1300\&.
3624 .IP 
3625 The name mangling (if enabled) allows a file to be copied between UNIX
3626 directories from Windows/DOS while retaining the long UNIX
3627 filename\&. UNIX files can be renamed to a new extension from
3628 Windows/DOS and will retain the same basename\&. Mangled names do not
3629 change between sessions\&.
3630 .IP 
3631 \fBDefault:\fP
3632 \f(CW   mangled names = yes\fP
3633 .IP 
3634 \fBExample:\fP
3635 \f(CW   mangled names = no\fP
3636 .IP 
3637 .IP "\fBmangling char (S)\fP" 
3638 .IP 
3639 This controls what character is used as the \fI"magic"\fP character in
3640 \fBname mangling\fP\&. The default is a \f(CW\'~\'\fP but
3641 this may interfere with some software\&. Use this option to set it to
3642 whatever you prefer\&.
3643 .IP 
3644 \fBDefault:\fP
3645 \f(CW   mangling char = ~\fP
3646 .IP 
3647 \fBExample:\fP
3648 \f(CW   mangling char = ^\fP
3649 .IP 
3650 .IP "\fBmangled stack (G)\fP" 
3651 .IP 
3652 This parameter controls the number of mangled names that should be
3653 cached in the Samba server \fBsmbd\fP\&.
3654 .IP 
3655 This stack is a list of recently mangled base names (extensions are
3656 only maintained if they are longer than 3 characters or contains upper
3657 case characters)\&.
3658 .IP 
3659 The larger this value, the more likely it is that mangled names can be
3660 successfully converted to correct long UNIX names\&. However, large
3661 stack sizes will slow most directory access\&. Smaller stacks save
3662 memory in the server (each stack element costs 256 bytes)\&.
3663 .IP 
3664 It is not possible to absolutely guarantee correct long file names, so
3665 be prepared for some surprises!
3666 .IP 
3667 \fBDefault:\fP
3668 \f(CW   mangled stack = 50\fP
3669 .IP 
3670 \fBExample:\fP
3671 \f(CW   mangled stack = 100\fP
3672 .IP 
3673 .IP "\fBmap archive (S)\fP" 
3674 .IP 
3675 This controls whether the DOS archive attribute should be mapped to
3676 the UNIX owner execute bit\&.  The DOS archive bit is set when a file
3677 has been modified since its last backup\&.  One motivation for this
3678 option it to keep Samba/your PC from making any file it touches from
3679 becoming executable under UNIX\&.  This can be quite annoying for shared
3680 source code, documents, etc\&.\&.\&.
3681 .IP 
3682 Note that this requires the \fB"create mask"\fP
3683 parameter to be set such that owner execute bit is not masked out
3684 (i\&.e\&. it must include 100)\&. See the parameter \fB"create
3685 mask"\fP for details\&.
3686 .IP 
3687 \fBDefault:\fP
3688 \f(CW      map archive = yes\fP
3689 .IP 
3690 \fBExample:\fP
3691 \f(CW      map archive = no\fP
3692 .IP 
3693 .IP "\fBmap hidden (S)\fP" 
3694 .IP 
3695 This controls whether DOS style hidden files should be mapped to the
3696 UNIX world execute bit\&.
3697 .IP 
3698 Note that this requires the \fB"create mask"\fP to be
3699 set such that the world execute bit is not masked out (i\&.e\&. it must
3700 include 001)\&. See the parameter \fB"create mask"\fP
3701 for details\&.
3702 .IP 
3703 \fBDefault:\fP
3704 \f(CW   map hidden = no\fP
3705 .IP 
3706 \fBExample:\fP
3707 \f(CW   map hidden = yes\fP
3708 .IP 
3709 .IP "\fBmap system (S)\fP" 
3710 .IP 
3711 This controls whether DOS style system files should be mapped to the
3712 UNIX group execute bit\&.
3713 .IP 
3714 Note that this requires the \fB"create mask"\fP to be
3715 set such that the group execute bit is not masked out (i\&.e\&. it must
3716 include 010)\&. See the parameter \fB"create mask"\fP
3717 for details\&.
3718 .IP 
3719 \fBDefault:\fP
3720 \f(CW   map system = no\fP
3721 .IP 
3722 \fBExample:\fP
3723 \f(CW   map system = yes\fP
3724 .IP 
3725 .IP "\fBmap to guest (G)\fP" 
3726 .IP 
3727 This parameter is only useful in \fBsecurity\fP modes
3728 other than \fB"security=share"\fP - i\&.e\&. user,
3729 server, and domain\&.
3730 .IP 
3731 This parameter can take three different values, which tell
3732 \fBsmbd\fP what to do with user login requests that
3733 don\'t match a valid UNIX user in some way\&.
3734 .IP 
3735 The three settings are :
3736 .IP 
3737 .IP 
3738 .IP o 
3739 \fB"Never"\fP - Means user login requests with an invalid password
3740 are rejected\&. This is the default\&.
3741 .IP 
3742 .IP o 
3743 \fB"Bad User"\fP - Means user logins with an invalid password are
3744 rejected, unless the username does not exist, in which case it is
3745 treated as a guest login and mapped into the \fB"guest
3746 account"\fP\&.
3747 .IP 
3748 .IP o 
3749 \fB"Bad Password"\fP - Means user logins with an invalid
3750 password are treated as a guest login and mapped into the
3751 \fB"guest account"\fP\&. Note that this can
3752 cause problems as it means that any user incorrectly typing their
3753 password will be silently logged on a \fB"guest"\fP - and 
3754 will not know the reason they cannot access files they think
3755 they should - there will have been no message given to them
3756 that they got their password wrong\&. Helpdesk services will
3757 \fI*hate*\fP you if you set the \fB"map to guest"\fP parameter
3758 this way :-)\&.
3759 .IP 
3760 .IP 
3761 Note that this parameter is needed to set up \fB"Guest"\fP share
3762 services when using \fBsecurity\fP modes other than
3763 share\&. This is because in these modes the name of the resource being
3764 requested is \fI*not*\fP sent to the server until after the server has
3765 successfully authenticated the client so the server cannot make
3766 authentication decisions at the correct time (connection to the
3767 share) for \fB"Guest"\fP shares\&.
3768 .IP 
3769 For people familiar with the older Samba releases, this parameter
3770 maps to the old compile-time setting of the GUEST_SESSSETUP value
3771 in local\&.h\&.
3772 .IP 
3773 \fBDefault:\fP
3774 \f(CW   map to guest = Never\fP
3775 \fBExample\fP:
3776 \f(CW   map to guest = Bad User\fP
3777 .IP 
3778 .IP "\fBmax connections (S)\fP" 
3779 .IP 
3780 This option allows the number of simultaneous connections to a service
3781 to be limited\&. If \fB"max connections"\fP is greater than 0 then
3782 connections will be refused if this number of connections to the
3783 service are already open\&. A value of zero mean an unlimited number of
3784 connections may be made\&.
3785 .IP 
3786 Record lock files are used to implement this feature\&. The lock files
3787 will be stored in the directory specified by the \fB"lock
3788 directory"\fP option\&.
3789 .IP 
3790 \fBDefault:\fP
3791 \f(CW   max connections = 0\fP
3792 .IP 
3793 \fBExample:\fP
3794 \f(CW   max connections = 10\fP
3795 .IP 
3796 .IP "\fBmax disk size (G)\fP" 
3797 .IP 
3798 This option allows you to put an upper limit on the apparent size of
3799 disks\&. If you set this option to 100 then all shares will appear to be
3800 not larger than 100 MB in size\&.
3801 .IP 
3802 Note that this option does not limit the amount of data you can put on
3803 the disk\&. In the above case you could still store much more than 100
3804 MB on the disk, but if a client ever asks for the amount of free disk
3805 space or the total disk size then the result will be bounded by the
3806 amount specified in \fB"max disk size"\fP\&.
3807 .IP 
3808 This option is primarily useful to work around bugs in some pieces of
3809 software that can\'t handle very large disks, particularly disks over
3810 1GB in size\&.
3811 .IP 
3812 A \fB"max disk size"\fP of 0 means no limit\&.
3813 .IP 
3814 \fBDefault:\fP
3815 \f(CW   max disk size = 0\fP
3816 .IP 
3817 \fBExample:\fP
3818 \f(CW   max disk size = 1000\fP
3819 .IP 
3820 .IP "\fBmax log size (G)\fP" 
3821 .IP 
3822 This option (an integer in kilobytes) specifies the max size the log
3823 file should grow to\&. Samba periodically checks the size and if it is
3824 exceeded it will rename the file, adding a \f(CW"\&.old"\fP extension\&.
3825 .IP 
3826 A size of 0 means no limit\&.
3827 .IP 
3828 \fBDefault:\fP
3829 \f(CW   max log size = 5000\fP
3830 .IP 
3831 \fBExample:\fP
3832 \f(CW   max log size = 1000\fP
3833 .IP 
3834 .IP "\fBmax mux (G)\fP" 
3835 .IP 
3836 This option controls the maximum number of outstanding simultaneous
3837 SMB operations that samba tells the client it will allow\&. You should
3838 never need to set this parameter\&.
3839 .IP 
3840 \fBDefault:\fP
3841 \f(CW   max mux = 50\fP
3842 .IP 
3843 .IP "\fBmax open files (G)\fP" 
3844 .IP 
3845 This parameter limits the maximum number of open files that one
3846 \fBsmbd\fP file serving process may have open for
3847 a client at any one time\&. The default for this parameter is set
3848 very high (10,000) as Samba uses only one bit per unopened file\&.
3849 .IP 
3850 The limit of the number of open files is usually set by the
3851 UNIX per-process file descriptor limit rather than this parameter
3852 so you should never need to touch this parameter\&.
3853 .IP 
3854 \fBDefault:\fP
3855 \f(CW   max open files = 10000\fP
3856 .IP 
3857 .IP "\fBmax packet (G)\fP" 
3858 .IP 
3859 Synonym for (packetsize)\&.
3860 .IP 
3861 .IP "\fBmax ttl (G)\fP" 
3862 .IP 
3863 This option tells \fBnmbd\fP what the default \'time
3864 to live\' of NetBIOS names should be (in seconds) when
3865 \fBnmbd\fP is requesting a name using either a
3866 broadcast packet or from a WINS server\&. You should never need to
3867 change this parameter\&. The default is 3 days\&.
3868 .IP 
3869 \fBDefault:\fP
3870 \f(CW   max ttl = 259200\fP
3871 .IP 
3872 .IP "\fBmax wins ttl (G)\fP" 
3873 .IP 
3874 This option tells \fBnmbd\fP when acting as a WINS
3875 server \fB(wins support =true)\fP what the maximum
3876 \'time to live\' of NetBIOS names that \fBnmbd\fP will
3877 grant will be (in seconds)\&. You should never need to change this
3878 parameter\&.  The default is 6 days (518400 seconds)\&.
3879 .IP 
3880 See also the \fB"min wins ttl"\fP parameter\&.
3881 .IP 
3882 \fBDefault:\fP
3883 \f(CW        max wins ttl = 518400\fP
3884 .IP 
3885 .IP "\fBmax xmit (G)\fP" 
3886 .IP 
3887 This option controls the maximum packet size that will be negotiated
3888 by Samba\&. The default is 65535, which is the maximum\&. In some cases
3889 you may find you get better performance with a smaller value\&. A value
3890 below 2048 is likely to cause problems\&.
3891 .IP 
3892 \fBDefault:\fP
3893 \f(CW   max xmit = 65535\fP
3894 .IP 
3895 \fBExample:\fP
3896 \f(CW   max xmit = 8192\fP
3897 .IP 
3898 .IP "\fBmessage command (G)\fP" 
3899 .IP 
3900 This specifies what command to run when the server receives a WinPopup
3901 style message\&.
3902 .IP 
3903 This would normally be a command that would deliver the message
3904 somehow\&. How this is to be done is up to your imagination\&.
3905 .IP 
3906 An example is:
3907 .IP 
3908 \f(CW   message command = csh -c \'xedit %s;rm %s\' &\fP
3909 .IP 
3910 This delivers the message using \fBxedit\fP, then removes it
3911 afterwards\&. \fINOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN
3912 IMMEDIATELY\fP\&. That\'s why I have the \f(CW\'&\'\fP on the end\&. If it doesn\'t
3913 return immediately then your PCs may freeze when sending messages
3914 (they should recover after 30secs, hopefully)\&.
3915 .IP 
3916 All messages are delivered as the global guest user\&. The command takes
3917 the standard substitutions, although \fB%u\fP won\'t work
3918 (\fB%U\fP may be better in this case)\&.
3919 .IP 
3920 Apart from the standard substitutions, some additional ones apply\&. In
3921 particular:
3922 .IP 
3923 .IP 
3924 .IP o 
3925 \f(CW"%s"\fP = the filename containing the message\&.
3926 .IP 
3927 .IP o 
3928 \f(CW"%t"\fP = the destination that the message was sent to (probably the server
3929 name)\&.
3930 .IP 
3931 .IP o 
3932 \f(CW"%f"\fP = who the message is from\&.
3933 .IP 
3934 .IP 
3935 You could make this command send mail, or whatever else takes your
3936 fancy\&. Please let us know of any really interesting ideas you have\&.
3937 .IP 
3938 Here\'s a way of sending the messages as mail to root:
3939 .IP 
3940 \f(CWmessage command = /bin/mail -s \'message from %f on %m\' root < %s; rm %s\fP
3941 .IP 
3942 If you don\'t have a message command then the message won\'t be
3943 delivered and Samba will tell the sender there was an
3944 error\&. Unfortunately WfWg totally ignores the error code and carries
3945 on regardless, saying that the message was delivered\&.
3946 .IP 
3947 If you want to silently delete it then try:
3948 .IP 
3949 \f(CW"message command = rm %s"\fP\&.
3950 .IP 
3951 \fBDefault:\fP
3952 \f(CW   no message command\fP
3953 .IP 
3954 \fBExample:\fP
3955 \f(CW        message command = csh -c \'xedit %s;rm %s\' &\fP
3956 .IP 
3957 .IP "\fBmin print space (S)\fP" 
3958 .IP 
3959 This sets the minimum amount of free disk space that must be available
3960 before a user will be able to spool a print job\&. It is specified in
3961 kilobytes\&. The default is 0, which means a user can always spool a print
3962 job\&.
3963 .IP 
3964 See also the \fBprinting\fP parameter\&.
3965 .IP 
3966 \fBDefault:\fP
3967 \f(CW   min print space = 0\fP
3968 .IP 
3969 \fBExample:\fP
3970 \f(CW   min print space = 2000\fP
3971 .IP 
3972 .IP "\fBmin passwd length (G)\fP" 
3973 .IP 
3974 This option sets the minimum length in characters of a plaintext password
3975 than smbd will accept when performing UNIX password changing\&.
3976 .IP 
3977 See also \fB"unix password sync"\fP,
3978 \fB"passwd program"\fP and \fB"passwd chat
3979 debug"\fP\&.
3980 .IP 
3981 \fBDefault:\fP
3982 \f(CW   min passwd length = 5\fP
3983 .IP 
3984 .IP "\fBmin wins ttl (G)\fP" 
3985 .IP 
3986 This option tells \fBnmbd\fP when acting as a WINS
3987 server \fB(wins support = true)\fP what the minimum
3988 \'time to live\' of NetBIOS names that \fBnmbd\fP will
3989 grant will be (in seconds)\&. You should never need to change this
3990 parameter\&.  The default is 6 hours (21600 seconds)\&.
3991 .IP 
3992 \fBDefault:\fP
3993 \f(CW   min wins ttl = 21600\fP
3994 .IP 
3995 .IP "\fBname resolve order (G)\fP" 
3996 .IP 
3997 This option is used by the programs in the Samba suite to determine
3998 what naming services and in what order to resolve host names to IP
3999 addresses\&. The option takes a space separated string of different name
4000 resolution options\&.
4001 .IP 
4002 The options are :"lmhosts", "host", "wins" and "bcast"\&. They cause
4003 names to be resolved as follows :
4004 .IP 
4005 .IP 
4006 .IP o 
4007 \fBlmhosts\fP : Lookup an IP address in the Samba lmhosts file\&.
4008 If the line in lmhosts has no name type attached to the NetBIOS
4009 name (see the \fBlmhosts (5)\fP for details) then
4010 any name type matches for lookup\&.
4011 .IP 
4012 .IP o 
4013 \fBhost\fP : Do a standard host name to IP address resolution,
4014 using the system /etc/hosts, NIS, or DNS lookups\&. This method of name
4015 resolution is operating system depended for instance on IRIX or
4016 Solaris this may be controlled by the \fI/etc/nsswitch\&.conf\fP file)\&.
4017 Note that this method is only used if the NetBIOS name type being
4018 queried is the 0x20 (server) name type, otherwise it is ignored\&.
4019 .IP 
4020 .IP o 
4021 \fBwins\fP : Query a name with the IP address listed in the
4022 \fBwins server\fP parameter\&. If no WINS server has
4023 been specified this method will be ignored\&.
4024 .IP 
4025 .IP o 
4026 \fBbcast\fP : Do a broadcast on each of the known local interfaces
4027 listed in the \fBinterfaces\fP parameter\&. This is the
4028 least reliable of the name resolution methods as it depends on the
4029 target host being on a locally connected subnet\&.
4030 .IP 
4031 .IP 
4032 \fBDefault:\fP
4033 \f(CW   name resolve order = lmhosts host wins bcast\fP
4034 .IP 
4035 \fBExample:\fP
4036 \f(CW   name resolve order = lmhosts bcast host\fP
4037 .IP 
4038 This will cause the local lmhosts file to be examined first, followed
4039 by a broadcast attempt, followed by a normal system hostname lookup\&.
4040 .IP 
4041 .IP "\fBnetbios aliases (G)\fP" 
4042 .IP 
4043 This is a list of NetBIOS names that \fBnmbd\fP will
4044 advertise as additional names by which the Samba server is known\&. This
4045 allows one machine to appear in browse lists under multiple names\&. If
4046 a machine is acting as a \fBbrowse server\fP or
4047 \fBlogon server\fP none of these names will be
4048 advertised as either browse server or logon servers, only the primary
4049 name of the machine will be advertised with these capabilities\&.
4050 .IP 
4051 See also \fB"netbios name"\fP\&.
4052 .IP 
4053 \fBDefault:\fP
4054 \f(CW   empty string (no additional names)\fP
4055 .IP 
4056 \fBExample:\fP
4057 \f(CW   netbios aliases = TEST TEST1 TEST2\fP
4058 .IP 
4059 .IP "\fBnetbios name (G)\fP" 
4060 .IP 
4061 This sets the NetBIOS name by which a Samba server is known\&. By
4062 default it is the same as the first component of the host\'s DNS name\&.
4063 If a machine is a \fBbrowse server\fP or
4064 \fBlogon server\fP this name (or the first component
4065 of the hosts DNS name) will be the name that these services are
4066 advertised under\&.
4067 .IP 
4068 See also \fB"netbios aliases"\fP\&.
4069 .IP 
4070 \fBDefault:\fP
4071 \f(CW   Machine DNS name\&.\fP
4072 .IP 
4073 \fBExample:\fP
4074 \f(CW   netbios name = MYNAME\fP
4075 .IP 
4076 .IP "\fBnis homedir (G)\fP" 
4077 .IP 
4078 Get the home share server from a NIS map\&. For UNIX systems that use an
4079 automounter, the user\'s home directory will often be mounted on a
4080 workstation on demand from a remote server\&. 
4081 .IP 
4082 When the Samba logon server is not the actual home directory server,
4083 but is mounting the home directories via NFS then two network hops
4084 would be required to access the users home directory if the logon
4085 server told the client to use itself as the SMB server for home
4086 directories (one over SMB and one over NFS)\&. This can be very
4087 slow\&.
4088 .IP 
4089 This option allows Samba to return the home share as being on a
4090 different server to the logon server and as long as a Samba daemon is
4091 running on the home directory server, it will be mounted on the Samba
4092 client directly from the directory server\&. When Samba is returning the
4093 home share to the client, it will consult the NIS map specified in
4094 \fB"homedir map"\fP and return the server listed
4095 there\&.
4096 .IP 
4097 Note that for this option to work there must be a working NIS
4098 system and the Samba server with this option must also be a
4099 \fBlogon server\fP\&.
4100 .IP 
4101 \fBDefault:\fP
4102 \f(CW   nis homedir = false\fP
4103 .IP 
4104 \fBExample:\fP
4105 \f(CW   nis homedir = true\fP
4106 .IP 
4107 .IP "\fBnt acl support (G)\fP" 
4108 .IP 
4109 This boolean parameter controls whether \fBsmbd\fP
4110 will attempt to map UNIX permissions into Windows NT access control lists\&.
4111 .IP 
4112 \fBDefault:\fP
4113 \f(CW   nt acl support = yes\fP
4114 .IP 
4115 \fBExample:\fP
4116 \f(CW   nt acl support = no\fP
4117 .IP 
4118 .IP "\fBnt pipe support (G)\fP" 
4119 .IP 
4120 This boolean parameter controls whether \fBsmbd\fP
4121 will allow Windows NT clients to connect to the NT SMB specific
4122 \f(CWIPC$\fP pipes\&. This is a developer debugging option and can be left
4123 alone\&.
4124 .IP 
4125 \fBDefault:\fP
4126 \f(CW   nt pipe support = yes\fP
4127 .IP 
4128 .IP "\fBnt smb support (G)\fP" 
4129 .IP 
4130 This boolean parameter controls whether \fBsmbd\fP
4131 will negotiate NT specific SMB support with Windows NT
4132 clients\&. Although this is a developer debugging option and should be
4133 left alone, benchmarking has discovered that Windows NT clients give
4134 faster performance with this option set to \f(CW"no"\fP\&. This is still
4135 being investigated\&. If this option is set to \f(CW"no"\fP then Samba
4136 offers exactly the same SMB calls that versions prior to Samba2\&.0
4137 offered\&. This information may be of use if any users are having
4138 problems with NT SMB support\&.
4139 .IP 
4140 \fBDefault:\fP
4141 \f(CW   nt support = yes\fP
4142 .IP 
4143 .IP "\fBnull passwords (G)\fP" 
4144 .IP 
4145 Allow or disallow client access to accounts that have null passwords\&. 
4146 .IP 
4147 See also \fBsmbpasswd (5)\fP\&.
4148 .IP 
4149 \fBDefault:\fP
4150 \f(CW   null passwords = no\fP
4151 .IP 
4152 \fBExample:\fP
4153 \f(CW   null passwords = yes\fP
4154 .IP 
4155 .IP "\fBole locking compatibility (G)\fP" 
4156 .IP 
4157 This parameter allows an administrator to turn off the byte range lock
4158 manipulation that is done within Samba to give compatibility for OLE
4159 applications\&. Windows OLE applications use byte range locking as a
4160 form of inter-process communication, by locking ranges of bytes around
4161 the 2^32 region of a file range\&. This can cause certain UNIX lock
4162 managers to crash or otherwise cause problems\&. Setting this parameter
4163 to \f(CW"no"\fP means you trust your UNIX lock manager to handle such cases
4164 correctly\&.
4165 .IP 
4166 \fBDefault:\fP
4167 \f(CW   ole locking compatibility = yes\fP
4168 .IP 
4169 \fBExample:\fP
4170 \f(CW   ole locking compatibility = no\fP
4171 .IP 
4172 .IP "\fBonly guest (S)\fP" 
4173 .IP 
4174 A synonym for \fB"guest only"\fP\&.
4175 .IP 
4176 .IP "\fBonly user (S)\fP" 
4177 .IP 
4178 This is a boolean option that controls whether connections with
4179 usernames not in the \fBuser=\fP list will be allowed\&. By
4180 default this option is disabled so a client can supply a username to
4181 be used by the server\&.
4182 .IP 
4183 Note that this also means Samba won\'t try to deduce usernames from the
4184 service name\&. This can be annoying for the \fB[homes]\fP
4185 section\&. To get around this you could use "\fBuser\fP =
4186 \fB%S\fP" which means your \fB"user"\fP list
4187 will be just the service name, which for home directories is the name
4188 of the user\&.
4189 .IP 
4190 See also the \fBuser\fP parameter\&.
4191 .IP 
4192 \fBDefault:\fP
4193 \f(CW   only user = False\fP
4194 .IP 
4195 \fBExample:\fP
4196 \f(CW   only user = True\fP
4197 .IP 
4198 .IP "\fBoplocks (S)\fP" 
4199 .IP 
4200 This boolean option tells smbd whether to issue oplocks (opportunistic
4201 locks) to file open requests on this share\&. The oplock code can
4202 dramatically (approx\&. 30% or more) improve the speed of access to files
4203 on Samba servers\&. It allows the clients to aggressively cache files
4204 locally and you may want to disable this option for unreliable network
4205 environments (it is turned on by default in Windows NT Servers)\&.  For
4206 more information see the file Speed\&.txt in the Samba docs/ directory\&.
4207 .IP 
4208 Oplocks may be selectively turned off on certain files on a per share basis\&.
4209 See the \'veto oplock files\' parameter\&. On some systems oplocks are recognized
4210 by the underlying operating system\&. This allows data synchronization between
4211 all access to oplocked files, whether it be via Samba or NFS or a local
4212 UNIX process\&. See the \fBkernel oplocks\fP parameter
4213 for details\&.
4214 .IP 
4215 See also the \fB"kernel oplocks"\fP and
4216 \fB"level2 oplocks"\fP parameters\&.
4217 .IP 
4218 \fBDefault:\fP
4219 \f(CW   oplocks = True\fP
4220 .IP 
4221 \fBExample:\fP
4222 \f(CW   oplocks = False\fP
4223 .IP 
4224 .IP "\fBoplock break wait time (G)\fP" 
4225 .IP 
4226 This is a tuning parameter added due to bugs in both Windows 9x and WinNT\&.
4227 If Samba responds to a client too quickly when that client issues an SMB that
4228 can cause an oplock break request, then the client redirector can fail and
4229 not respond to the break request\&. This tuning parameter (which is set in
4230 milliseconds) is the amount of time Samba will wait before sending an
4231 oplock break request to such (broken) clients\&.
4232 .IP 
4233 \fIDO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA
4234 OPLOCK CODE\fP\&.
4235 .IP 
4236 \fBDefault:\fP
4237 \f(CW   oplock break wait time = 10\fP
4238 .IP 
4239 .IP "\fBoplock contention limit (S)\fP" 
4240 .IP 
4241 This is a \fIvery\fP advanced \fBsmbd\fP tuning option to improve
4242 the efficiency of the granting of oplocks under multiple client contention for the same file\&.
4243 .IP 
4244 In brief it specifies a number, which causes smbd not to grant an oplock even
4245 when requested if the approximate number of clients contending for an oplock on
4246 the same file goes over this limit\&. This causes \fBsmbd\fP to
4247 behave in a similar way to Windows NT\&.
4248 .IP 
4249 \fIDO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA
4250 OPLOCK CODE\fP\&.
4251 .IP 
4252 \fBDefault:\fP
4253 \f(CW oplock contention limit = 2\fP
4254 .IP 
4255 .IP "\fBos level (G)\fP" 
4256 .IP 
4257 This integer value controls what level Samba advertises itself as for
4258 browse elections\&. The value of this parameter determines whether
4259 \fBnmbd\fP has a chance of becoming a local master
4260 browser for the \fBWORKGROUP\fP in the local broadcast
4261 area\&. The default is zero, which means \fBnmbd\fP will
4262 lose elections to Windows machines\&. See BROWSING\&.txt in the Samba
4263 docs/ directory for details\&.
4264 .IP 
4265 \fBDefault:\fP
4266 \f(CW   os level = 0\fP
4267 .IP 
4268 \fBExample:\fP
4269 \f(CW   os level = 65    ; This will win against any NT Server\fP
4270 .IP 
4271 .IP "\fBpacket size (G)\fP" 
4272 .IP 
4273 This is a deprecated parameter that how no effect on the current
4274 Samba code\&. It is left in the parameter list to prevent breaking
4275 old \fBsmb\&.conf\fP files\&.
4276 .IP 
4277 .IP "\fBpanic action (G)\fP" 
4278 .IP 
4279 This is a Samba developer option that allows a system command to be
4280 called when either \fBsmbd\fP or
4281 \fBnmbd\fP crashes\&. This is usually used to draw
4282 attention to the fact that a problem occurred\&.
4283 .IP 
4284 \fBDefault:\fP
4285 \f(CW   panic action = <empty string>\fP
4286 .IP 
4287 .IP "\fBpasswd chat (G)\fP" 
4288 .IP 
4289 This string controls the \fI"chat"\fP conversation that takes places
4290 between \fBsmbd\fP and the local password changing
4291 program to change the users password\&. The string describes a sequence
4292 of response-receive pairs that \fBsmbd\fP uses to
4293 determine what to send to the \fBpasswd\fP program
4294 and what to expect back\&. If the expected output is not received then
4295 the password is not changed\&.
4296 .IP 
4297 This chat sequence is often quite site specific, depending on what
4298 local methods are used for password control (such as NIS etc)\&.
4299 .IP 
4300 The string can contain the macros \f(CW"%o"\fP and \f(CW"%n"\fP which are
4301 substituted for the old and new passwords respectively\&. It can also
4302 contain the standard macros \f(CW"\en"\fP, \f(CW"\er"\fP, \f(CW"\et"\fP and \f(CW"\es"\fP
4303 to give line-feed, carriage-return, tab and space\&.
4304 .IP 
4305 The string can also contain a \f(CW\'*\'\fP which matches any sequence of
4306 characters\&.
4307 .IP 
4308 Double quotes can be used to collect strings with spaces in them into
4309 a single string\&.
4310 .IP 
4311 If the send string in any part of the chat sequence is a fullstop
4312 \f(CW"\&."\fP  then no string is sent\&. Similarly, is the expect string is a
4313 fullstop then no string is expected\&.
4314 .IP 
4315 Note that if the \fB"unix password sync"\fP
4316 parameter is set to true, then this sequence is called \fI*AS ROOT*\fP
4317 when the SMB password in the smbpasswd file is being changed, without
4318 access to the old password cleartext\&. In this case the old password
4319 cleartext is set to \f(CW""\fP (the empty string)\&.
4320 .IP 
4321 See also \fB"unix password sync"\fP,
4322 \fB"passwd program"\fP and \fB"passwd chat
4323 debug"\fP\&.
4324 .IP 
4325 \fBExample:\fP 
4327 .DS 
4329  passwd chat = "*Enter OLD password*" %o\en "*Enter NEW password*" %n\en "*Reenter NEW password*" %n\en "*Password changed*"
4331 .DE 
4334 .IP 
4335 \fBDefault:\fP
4337 .DS 
4339        passwd chat = *old*password* %o\en *new*password* %n\en *new*password* %n\en *changed*
4340 .DE 
4343 .IP 
4344 .IP "\fBpasswd chat debug (G)\fP" 
4345 .IP 
4346 This boolean specifies if the passwd chat script parameter is run in
4347 \f(CW"debug"\fP mode\&. In this mode the strings passed to and received from
4348 the passwd chat are printed in the \fBsmbd\fP log with
4349 a \fB"debug level"\fP of 100\&. This is a dangerous
4350 option as it will allow plaintext passwords to be seen in the
4351 \fBsmbd\fP log\&. It is available to help Samba admins
4352 debug their \fB"passwd chat"\fP scripts when calling
4353 the \fB"passwd program"\fP and should be turned off
4354 after this has been done\&. This parameter is off by default\&.
4355 .IP 
4356 See also \fB"passwd chat"\fP, \fB"passwd
4357 program"\fP\&.
4358 .IP 
4359 \fBExample:\fP
4360 \f(CW     passwd chat debug = True\fP
4361 .IP 
4362 \fBDefault:\fP
4363 \f(CW     passwd chat debug = False\fP
4364 .IP 
4365 .IP "\fBpasswd program (G)\fP" 
4366 .IP 
4367 The name of a program that can be used to set UNIX user passwords\&.
4368 Any occurrences of \fB%u\fP will be replaced with the
4369 user name\&. The user name is checked for existence before calling the
4370 password changing program\&.
4371 .IP 
4372 Also note that many passwd programs insist in \fI"reasonable"\fP
4373 passwords, such as a minimum length, or the inclusion of mixed case
4374 chars and digits\&. This can pose a problem as some clients (such as
4375 Windows for Workgroups) uppercase the password before sending it\&.
4376 .IP 
4377 \fINote\fP that if the \fB"unix password sync"\fP
4378 parameter is set to \f(CW"True"\fP then this program is called \fI*AS
4379 ROOT*\fP before the SMB password in the
4380 \fBsmbpasswd\fP file is changed\&. If this UNIX
4381 password change fails, then \fBsmbd\fP will fail to
4382 change the SMB password also (this is by design)\&.
4383 .IP 
4384 If the \fB"unix password sync"\fP parameter is
4385 set this parameter \fIMUST USE ABSOLUTE PATHS\fP for \fIALL\fP programs
4386 called, and must be examined for security implications\&. Note that by
4387 default \fB"unix password sync"\fP is set to
4388 \f(CW"False"\fP\&.
4389 .IP 
4390 See also \fB"unix password sync"\fP\&.
4391 .IP 
4392 \fBDefault:\fP
4393 \f(CW   passwd program = /bin/passwd\fP
4394 .IP 
4395 \fBExample:\fP
4396 \f(CW   passwd program = /sbin/passwd %u\fP
4397 .IP 
4398 .IP "\fBpassword level (G)\fP" 
4399 .IP 
4400 Some client/server combinations have difficulty with mixed-case
4401 passwords\&.  One offending client is Windows for Workgroups, which for
4402 some reason forces passwords to upper case when using the LANMAN1
4403 protocol, but leaves them alone when using COREPLUS!
4404 .IP 
4405 This parameter defines the maximum number of characters that may be
4406 upper case in passwords\&.
4407 .IP 
4408 For example, say the password given was \f(CW"FRED"\fP\&. If \fBpassword
4409 level\fP is set to 1, the following combinations would be tried if
4410 \f(CW"FRED"\fP failed:
4411 .IP 
4412 \f(CW"Fred"\fP, \f(CW"fred"\fP, \f(CW"fRed"\fP, \f(CW"frEd"\fP, \f(CW"freD"\fP
4413 .IP 
4414 If \fBpassword level\fP was set to 2, the following combinations would
4415 also be tried: 
4416 .IP 
4417 \f(CW"FRed"\fP, \f(CW"FrEd"\fP, \f(CW"FreD"\fP, \f(CW"fREd"\fP, \f(CW"fReD"\fP,
4418 \f(CW"frED"\fP, \f(CW\&.\&.\fP
4419 .IP 
4420 And so on\&.
4421 .IP 
4422 The higher value this parameter is set to the more likely it is that a
4423 mixed case password will be matched against a single case
4424 password\&. However, you should be aware that use of this parameter
4425 reduces security and increases the time taken to process a new
4426 connection\&.
4427 .IP 
4428 A value of zero will cause only two attempts to be made - the password
4429 as is and the password in all-lower case\&.
4430 .IP 
4431 \fBDefault:\fP
4432 \f(CW   password level = 0\fP
4433 .IP 
4434 \fBExample:\fP
4435 \f(CW   password level = 4\fP
4436 .IP 
4437 .IP "\fBpassword server (G)\fP" 
4438 .IP 
4439 By specifying the name of another SMB server (such as a WinNT box)
4440 with this option, and using \fB"security = domain"\fP or
4441 \fB"security = server"\fP you can get Samba to do all
4442 its username/password validation via a remote server\&.
4443 .IP 
4444 This options sets the name of the password server to use\&. It must be a
4445 NetBIOS name, so if the machine\'s NetBIOS name is different from its
4446 internet name then you may have to add its NetBIOS name to the lmhosts 
4447 file which is stored in the same directory as the \fBsmb\&.conf\fP file\&.
4448 .IP 
4449 The name of the password server is looked up using the parameter
4450 \fB"name resolve order="\fP and so may resolved
4451 by any method and order described in that parameter\&.
4452 .IP 
4453 The password server much be a machine capable of using the "LM1\&.2X002"
4454 or the "LM NT 0\&.12" protocol, and it must be in user level security
4455 mode\&. 
4456 .IP 
4457 NOTE: Using a password server means your UNIX box (running Samba) is
4458 only as secure as your password server\&. \fIDO NOT CHOOSE A PASSWORD
4459 SERVER THAT YOU DON\'T COMPLETELY TRUST\fP\&.
4460 .IP 
4461 Never point a Samba server at itself for password serving\&. This will
4462 cause a loop and could lock up your Samba server!
4463 .IP 
4464 The name of the password server takes the standard substitutions, but
4465 probably the only useful one is \fB%m\fP, which means
4466 the Samba server will use the incoming client as the password
4467 server\&. If you use this then you better trust your clients, and you
4468 better restrict them with hosts allow!
4469 .IP 
4470 If the \fB"security"\fP parameter is set to
4471 \fB"domain"\fP, then the list of machines in this option must be a list
4472 of Primary or Backup Domain controllers for the
4473 \fBDomain\fP, as the Samba server is cryptographicly
4474 in that domain, and will use cryptographicly authenticated RPC calls
4475 to authenticate the user logging on\&. The advantage of using
4476 \fB"security=domain"\fP is that if you list
4477 several hosts in the \fB"password server"\fP option then
4478 \fBsmbd\fP will try each in turn till it finds one
4479 that responds\&. This is useful in case your primary server goes down\&.
4480 .IP 
4481 If the \fB"security"\fP parameter is set to
4482 \fB"server"\fP, then there are different
4483 restrictions that \fB"security=domain"\fP
4484 doesn\'t suffer from:
4485 .IP 
4486 .IP 
4487 .IP o 
4488 You may list several password servers in the \fB"password server"\fP
4489 parameter, however if an \fBsmbd\fP makes a connection
4490 to a password server, and then the password server fails, no more
4491 users will be able to be authenticated from this
4492 \fBsmbd\fP\&.  This is a restriction of the SMB/CIFS
4493 protocol when in \fB"security=server"\fP mode
4494 and cannot be fixed in Samba\&.
4495 .IP 
4496 .IP o 
4497 If you are using a Windows NT server as your password server then
4498 you will have to ensure that your users are able to login from the
4499 Samba server, as when in
4500 \fB"security=server"\fP mode the network
4501 logon will appear to come from there rather than from the users
4502 workstation\&.
4503 .IP 
4504 .IP 
4505 See also the \fB"security"\fP parameter\&.
4506 .IP 
4507 \fBDefault:\fP
4508 \f(CW   password server = <empty string>\fP
4509 .IP 
4510 \fBExample:\fP
4511 \f(CW   password server = NT-PDC, NT-BDC1, NT-BDC2\fP
4512 .IP 
4513 .IP "\fBpath (S)\fP" 
4514 .IP 
4515 This parameter specifies a directory to which the user of the service
4516 is to be given access\&. In the case of printable services, this is
4517 where print data will spool prior to being submitted to the host for
4518 printing\&.
4519 .IP 
4520 For a printable service offering guest access, the service should be
4521 readonly and the path should be world-writeable and have the sticky bit
4522 set\&. This is not mandatory of course, but you probably won\'t get the
4523 results you expect if you do otherwise\&.
4524 .IP 
4525 Any occurrences of \fB%u\fP in the path will be replaced
4526 with the UNIX username that the client is using on this
4527 connection\&. Any occurrences of \fB%m\fP will be replaced
4528 by the NetBIOS name of the machine they are connecting from\&. These
4529 replacements are very useful for setting up pseudo home directories
4530 for users\&.
4531 .IP 
4532 Note that this path will be based on \fB"root dir"\fP if
4533 one was specified\&.
4534 .IP 
4535 \fBDefault:\fP
4536 \f(CW   none\fP
4537 .IP 
4538 \fBExample:\fP
4539 \f(CW   path = /home/fred\fP
4540 .IP 
4541 .IP "\fBpostexec (S)\fP" 
4542 .IP 
4543 This option specifies a command to be run whenever the service is
4544 disconnected\&. It takes the usual substitutions\&. The command may be run
4545 as the root on some systems\&.
4546 .IP 
4547 An interesting example may be do unmount server resources:
4548 .IP 
4549 \f(CWpostexec = /etc/umount /cdrom\fP
4550 .IP 
4551 See also \fBpreexec\fP\&.
4552 .IP 
4553 \fBDefault:\fP
4554 \f(CW      none (no command executed)\fP
4555 .IP 
4556 \fBExample:\fP
4557 \f(CW      postexec = echo "%u disconnected from %S from %m (%I)" >> /tmp/log\fP
4558 .IP 
4559 .IP "\fBpostscript (S)\fP" 
4560 .IP 
4561 This parameter forces a printer to interpret the print files as
4562 postscript\&. This is done by adding a \f(CW%!\fP to the start of print output\&.
4563 .IP 
4564 This is most useful when you have lots of PCs that persist in putting
4565 a control-D at the start of print jobs, which then confuses your
4566 printer\&.
4567 .IP 
4568 \fBDefault:\fP
4569 \f(CW   postscript = False\fP
4570 .IP 
4571 \fBExample:\fP
4572 \f(CW   postscript = True\fP
4573 .IP 
4574 .IP "\fBpreexec (S)\fP" 
4575 .IP 
4576 This option specifies a command to be run whenever the service is
4577 connected to\&. It takes the usual substitutions\&.
4578 .IP 
4579 An interesting example is to send the users a welcome message every
4580 time they log in\&. Maybe a message of the day? Here is an example:
4581 .IP 
4583 .DS 
4586         preexec = csh -c \'echo \e"Welcome to %S!\e" | /usr/local/samba/bin/smbclient -M %m -I %I\' &
4588 .DE 
4591 .IP 
4592 Of course, this could get annoying after a while :-)
4593 .IP 
4594 See also \fBpostexec\fP\&.
4595 .IP 
4596 \fBDefault:\fP
4597 \f(CW   none (no command executed)\fP
4598 .IP 
4599 \fBExample:\fP
4600 \f(CW        preexec = echo \e"%u connected to %S from %m (%I)\e" >> /tmp/log\fP
4601 .IP 
4602 .IP "\fBpreferred master (G)\fP" 
4603 .IP 
4604 This boolean parameter controls if \fBnmbd\fP is a
4605 preferred master browser for its workgroup\&.
4606 .IP 
4607 If this is set to true, on startup, \fBnmbd\fP will
4608 force an election, and it will have a slight advantage in winning the
4609 election\&.  It is recommended that this parameter is used in
4610 conjunction with \fB"domain master = yes"\fP, so
4611 that \fBnmbd\fP can guarantee becoming a domain
4612 master\&.
4613 .IP 
4614 Use this option with caution, because if there are several hosts
4615 (whether Samba servers, Windows 95 or NT) that are preferred master
4616 browsers on the same subnet, they will each periodically and
4617 continuously attempt to become the local master browser\&.  This will
4618 result in unnecessary broadcast traffic and reduced browsing
4619 capabilities\&.
4620 .IP 
4621 See also \fBos level\fP\&.
4622 .IP 
4623 \fBDefault:\fP
4624 \f(CW   preferred master = no\fP
4625 .IP 
4626 \fBExample:\fP
4627 \f(CW   preferred master = yes\fP
4628 .IP 
4629 .IP "\fBprefered master (G)\fP" 
4630 .IP 
4631 Synonym for \fB"preferred master"\fP for people
4632 who cannot spell :-)\&.
4633 .IP 
4634 .IP "\fBpreload\fP" 
4635 Synonym for \fB"auto services"\fP\&.
4636 .IP 
4637 .IP "\fBpreserve case (S)\fP" 
4638 .IP 
4639 This controls if new filenames are created with the case that the
4640 client passes, or if they are forced to be the \f(CW"default"\fP case\&.
4641 .IP 
4642 \fBDefault:\fP
4643 \f(CW       preserve case = yes\fP
4644 .IP 
4645 See the section on \fB"NAME MANGLING"\fP for a
4646 fuller discussion\&.
4647 .IP 
4648 .IP "\fBprint command (S)\fP" 
4649 .IP 
4650 After a print job has finished spooling to a service, this command
4651 will be used via a \f(CWsystem()\fP call to process the spool
4652 file\&. Typically the command specified will submit the spool file to
4653 the host\'s printing subsystem, but there is no requirement that this
4654 be the case\&. The server will not remove the spool file, so whatever
4655 command you specify should remove the spool file when it has been
4656 processed, otherwise you will need to manually remove old spool files\&.
4657 .IP 
4658 The print command is simply a text string\&. It will be used verbatim,
4659 with two exceptions: All occurrences of \f(CW"%s"\fP will be replaced by
4660 the appropriate spool file name, and all occurrences of \f(CW"%p"\fP will
4661 be replaced by the appropriate printer name\&. The spool file name is
4662 generated automatically by the server, the printer name is discussed
4663 below\&.
4664 .IP 
4665 The full path name will be used for the filename if \f(CW"%s"\fP is not
4666 preceded by a \f(CW\'/\'\fP\&. If you don\'t like this (it can stuff up some
4667 lpq output) then use \f(CW"%f"\fP instead\&. Any occurrences of \f(CW"%f"\fP get
4668 replaced by the spool filename without the full path at the front\&.
4669 .IP 
4670 The print command \fIMUST\fP contain at least one occurrence of \f(CW"%s"\fP
4671 or \f(CW"%f"\fP - the \f(CW"%p"\fP is optional\&. At the time a job is
4672 submitted, if no printer name is supplied the \f(CW"%p"\fP will be
4673 silently removed from the printer command\&.
4674 .IP 
4675 If specified in the \fB"[global]"\fP section, the print
4676 command given will be used for any printable service that does not
4677 have its own print command specified\&.
4678 .IP 
4679 If there is neither a specified print command for a printable service
4680 nor a global print command, spool files will be created but not
4681 processed and (most importantly) not removed\&.
4682 .IP 
4683 Note that printing may fail on some UNIXs from the \f(CW"nobody"\fP
4684 account\&. If this happens then create an alternative guest account that
4685 can print and set the \fB"guest account"\fP in the
4686 \fB"[global]"\fP section\&.
4687 .IP 
4688 You can form quite complex print commands by realizing that they are
4689 just passed to a shell\&. For example the following will log a print
4690 job, print the file, then remove it\&. Note that \f(CW\';\'\fP is the usual
4691 separator for command in shell scripts\&.
4692 .IP 
4693 \f(CWprint command = echo Printing %s >> /tmp/print\&.log; lpr -P %p %s; rm %s\fP
4694 .IP 
4695 You may have to vary this command considerably depending on how you
4696 normally print files on your system\&. The default for the parameter
4697 varies depending on the setting of the \fB"printing="\fP
4698 parameter\&.
4699 .IP 
4700 \fBDefault:\fP
4701 For \fB"printing="\fP BSD, AIX, QNX, LPRNG or PLP :
4702 \f(CW   print command = lpr -r -P%p %s\fP
4703 .IP 
4704 For \fB"printing="\fP SYS or HPUX :
4705 \f(CW   print command = lp -c -d%p %s; rm %s\fP
4706 .IP 
4707 For \fB"printing="\fP SOFTQ :
4708 \f(CW   print command = lp -d%p -s %s; rm %s\fP
4709 .IP 
4710 \fBExample:\fP
4711 \f(CW   print command = /usr/local/samba/bin/myprintscript %p %s\fP
4712 .IP 
4713 .IP "\fBprint ok (S)\fP" 
4714 .IP 
4715 Synonym for \fBprintable\fP\&.
4716 .IP 
4717 .IP "\fBprintable (S)\fP" 
4718 .IP 
4719 If this parameter is \f(CW"yes"\fP, then clients may open, write to and
4720 submit spool files on the directory specified for the service\&.
4721 .IP 
4722 Note that a printable service will ALWAYS allow writing to the service
4723 path (user privileges permitting) via the spooling of print data\&. The
4724 \fB"read only"\fP parameter controls only non-printing
4725 access to the resource\&.
4726 .IP 
4727 \fBDefault:\fP
4728 \f(CW   printable = no\fP
4729 .IP 
4730 \fBExample:\fP
4731 \f(CW   printable = yes\fP
4732 .IP 
4733 .IP "\fBprintcap (G)\fP" 
4734 .IP 
4735 Synonym for \fBprintcapname\fP\&.
4736 .IP 
4737 .IP "\fBprintcap name (G)\fP" 
4738 .IP 
4739 This parameter may be used to override the compiled-in default
4740 printcap name used by the server (usually /etc/printcap)\&. See the
4741 discussion of the \fB[printers]\fP section above for
4742 reasons why you might want to do this\&.
4743 .IP 
4744 On System V systems that use \fBlpstat\fP to list available printers you
4745 can use \f(CW"printcap name = lpstat"\fP to automatically obtain lists of
4746 available printers\&. This is the default for systems that define SYSV
4747 at configure time in Samba (this includes most System V based
4748 systems)\&. If \fB"printcap name"\fP is set to \fBlpstat\fP on these systems
4749 then Samba will launch \f(CW"lpstat -v"\fP and attempt to parse the output
4750 to obtain a printer list\&.
4751 .IP 
4752 A minimal printcap file would look something like this:
4753 .IP 
4755 .DS 
4758         print1|My Printer 1
4759         print2|My Printer 2
4760         print3|My Printer 3
4761         print4|My Printer 4
4762         print5|My Printer 5
4764 .DE 
4767 .IP 
4768 where the \f(CW\'|\'\fP separates aliases of a printer\&. The fact that the
4769 second alias has a space in it gives a hint to Samba that it\'s a
4770 comment\&.
4771 .IP 
4772 \fINOTE\fP: Under AIX the default printcap name is
4773 \f(CW"/etc/qconfig"\fP\&. Samba will assume the file is in AIX \f(CW"qconfig"\fP
4774 format if the string \f(CW"/qconfig"\fP appears in the printcap filename\&.
4775 .IP 
4776 \fBDefault:\fP
4777 \f(CW   printcap name = /etc/printcap\fP
4778 .IP 
4779 \fBExample:\fP
4780 \f(CW   printcap name = /etc/myprintcap\fP
4781 .IP 
4782 .IP "\fBprinter (S)\fP" 
4783 .IP 
4784 This parameter specifies the name of the printer to which print jobs
4785 spooled through a printable service will be sent\&.
4786 .IP 
4787 If specified in the \fB[global]\fP section, the printer
4788 name given will be used for any printable service that does not have
4789 its own printer name specified\&.
4790 .IP 
4791 \fBDefault:\fP
4792 none (but may be \f(CW"lp"\fP on many systems)
4793 .IP 
4794 \fBExample:\fP
4795 printer name = laserwriter
4796 .IP 
4797 .IP "\fBprinter driver (S)\fP" 
4798 .IP 
4799 This option allows you to control the string that clients receive when
4800 they ask the server for the printer driver associated with a
4801 printer\&. If you are using Windows95 or WindowsNT then you can use this
4802 to automate the setup of printers on your system\&.
4803 .IP 
4804 You need to set this parameter to the exact string (case sensitive)
4805 that describes the appropriate printer driver for your system\&. If you
4806 don\'t know the exact string to use then you should first try with no
4807 \fB"printer driver"\fP option set and the client will give you a list of
4808 printer drivers\&. The appropriate strings are shown in a scrollbox
4809 after you have chosen the printer manufacturer\&.
4810 .IP 
4811 See also \fB"printer driver file"\fP\&.
4812 .IP 
4813 \fBExample:\fP
4814 printer driver = HP LaserJet 4L
4815 .IP 
4816 .IP "\fBprinter driver file (G)\fP" 
4817 .IP 
4818 This parameter tells Samba where the printer driver definition file,
4819 used when serving drivers to Windows 95 clients, is to be found\&. If
4820 this is not set, the default is :
4821 .IP 
4822 \f(CWSAMBA_INSTALL_DIRECTORY/lib/printers\&.def\fP
4823 .IP 
4824 This file is created from Windows 95 \f(CW"msprint\&.def"\fP files found on
4825 the Windows 95 client system\&. For more details on setting up serving
4826 of printer drivers to Windows 95 clients, see the documentation file
4827 in the docs/ directory, PRINTER_DRIVER\&.txt\&.
4828 .IP 
4829 \fBDefault:\fP
4830 \f(CW   None (set in compile)\&.\fP
4831 .IP 
4832 \fBExample:\fP
4833 \f(CW   printer driver file = /usr/local/samba/printers/drivers\&.def\fP
4834 .IP 
4835 See also \fB"printer driver location"\fP\&.
4836 .IP 
4837 .IP "\fBprinter driver location (S)\fP" 
4838 .IP 
4839 This parameter tells clients of a particular printer share where to
4840 find the printer driver files for the automatic installation of
4841 drivers for Windows 95 machines\&. If Samba is set up to serve printer
4842 drivers to Windows 95 machines, this should be set to
4843 .IP 
4844 \f(CW\e\eMACHINE\eaPRINTER$\fP
4845 .IP 
4846 Where MACHINE is the NetBIOS name of your Samba server, and PRINTER$
4847 is a share you set up for serving printer driver files\&. For more
4848 details on setting this up see the documentation file in the docs/
4849 directory, PRINTER_DRIVER\&.txt\&.
4850 .IP 
4851 \fBDefault:\fP
4852 \f(CW   None\fP
4853 .IP 
4854 \fBExample:\fP
4855 \f(CW   printer driver location = \e\eMACHINE\ePRINTER$\fP
4856 .IP 
4857 See also \fB"printer driver file"\fP\&.
4858 .IP 
4859 .IP "\fBprinter name (S)\fP" 
4860 .IP 
4861 Synonym for \fBprinter\fP\&.
4862 .IP 
4863 .IP "\fBprinting (S)\fP" 
4864 .IP 
4865 This parameters controls how printer status information is interpreted
4866 on your system, and also affects the default values for the
4867 \fB"print command"\fP, \fB"lpq
4868 command"\fP \fB"lppause command"\fP,
4869 \fB"lpresume command"\fP, and \fB"lprm
4870 command"\fP\&.
4871 .IP 
4872 Currently eight printing styles are supported\&. They are
4873 \fB"printing=BSD"\fP, \fB"printing=AIX"\fP, \fB"printing=LPRNG"\fP,
4874 \fB"printing=PLP"\fP,
4875 \fB"printing=SYSV"\fP,\fB"printing="HPUX"\fP,\fB"printing=QNX"\fP and
4876 \fB"printing=SOFTQ"\fP\&.
4877 .IP 
4878 To see what the defaults are for the other print commands when using
4879 these three options use the \fB"testparm"\fP program\&.
4880 .IP 
4881 This option can be set on a per printer basis
4882 .IP 
4883 See also the discussion in the \fB[printers]\fP section\&.
4884 .IP 
4885 .IP "\fBprotocol (G)\fP" 
4886 .IP 
4887 The value of the parameter (a string) is the highest protocol level
4888 that will be supported by the server\&.
4889 .IP 
4890 Possible values are :
4891 .IP 
4892 .IP 
4893 .IP o 
4894 CORE: Earliest version\&. No concept of user names\&.
4895 .IP 
4896 .IP o 
4897 COREPLUS: Slight improvements on CORE for efficiency\&.
4898 .IP 
4899 .IP o 
4900 LANMAN1: First \fI"modern"\fP version of the protocol\&. Long
4901 filename support\&.
4902 .IP 
4903 .IP o 
4904 LANMAN2: Updates to Lanman1 protocol\&.
4905 .IP 
4906 .IP o 
4907 NT1: Current up to date version of the protocol\&. Used by Windows
4908 NT\&. Known as CIFS\&.
4909 .IP 
4910 .IP 
4911 Normally this option should not be set as the automatic negotiation
4912 phase in the SMB protocol takes care of choosing the appropriate
4913 protocol\&.
4914 .IP 
4915 \fBDefault:\fP
4916 \f(CW   protocol = NT1\fP
4917 .IP 
4918 \fBExample:\fP
4919 \f(CW   protocol = LANMAN1\fP
4920 .IP 
4921 .IP "\fBpublic (S)\fP" 
4922 .IP 
4923 Synonym for \fB"guest ok"\fP\&.
4924 .IP 
4925 .IP "\fBqueuepause command (S)\fP" 
4926 .IP 
4927 This parameter specifies the command to be executed on the server host
4928 in order to pause the printerqueue\&.
4929 .IP 
4930 This command should be a program or script which takes a printer name
4931 as its only parameter and stops the printerqueue, such that no longer
4932 jobs are submitted to the printer\&.
4933 .IP 
4934 This command is not supported by Windows for Workgroups, but can be
4935 issued from the Printer\'s window under Windows 95 & NT\&.
4936 .IP 
4937 If a \f(CW"%p"\fP is given then the printername is put in its
4938 place\&. Otherwise it is placed at the end of the command\&.
4939 .IP 
4940 Note that it is good practice to include the absolute path in the
4941 command as the PATH may not be available to the server\&.
4942 .IP 
4943 \fBDefault:\fP
4944 \f(CW        depends on the setting of "printing ="\fP
4945 .IP 
4946 \fBExample:\fP
4947 \f(CW      queuepause command = disable %p\fP
4948 .IP 
4949 .IP "\fBqueueresume command (S)\fP" 
4950 .IP 
4951 This parameter specifies the command to be executed on the server host
4952 in order to resume the printerqueue\&. It is the command to undo the
4953 behavior that is caused by the previous parameter
4954 (\fB"queuepause command\fP)\&.
4955 .IP 
4956 This command should be a program or script which takes a printer name
4957 as its only parameter and resumes the printerqueue, such that queued
4958 jobs are resubmitted to the printer\&.
4959 .IP 
4960 This command is not supported by Windows for Workgroups, but can be
4961 issued from the Printer\'s window under Windows 95 & NT\&.
4962 .IP 
4963 If a \f(CW"%p"\fP is given then the printername is put in its
4964 place\&. Otherwise it is placed at the end of the command\&.
4965 .IP 
4966 Note that it is good practice to include the absolute path in the
4967 command as the PATH may not be available to the server\&.
4968 .IP 
4969 \fBDefault:\fP
4970 \f(CW        depends on the setting of "printing ="\fP
4971 .IP 
4972 \fBExample:\fP
4973 \f(CW      queuepause command = enable %p\fP
4974 .IP 
4975 .IP "\fBread bmpx (G)\fP" 
4976 .IP 
4977 This boolean parameter controls whether \fBsmbd\fP
4978 will support the "Read Block Multiplex" SMB\&. This is now rarely used
4979 and defaults to off\&. You should never need to set this parameter\&.
4980 .IP 
4981 \fBDefault:\fP
4982 read bmpx = No
4983 .IP 
4984 .IP "\fBread list (S)\fP" 
4985 .IP 
4986 This is a list of users that are given read-only access to a
4987 service\&. If the connecting user is in this list then they will not be
4988 given write access, no matter what the \fB"read only"\fP
4989 option is set to\&. The list can include group names using the syntax
4990 described in the \fB"invalid users"\fP parameter\&.
4991 .IP 
4992 See also the \fB"write list"\fP parameter and
4993 the \fB"invalid users"\fP parameter\&.
4994 .IP 
4995 \fBDefault:\fP
4996 \f(CW   read list = <empty string>\fP
4997 .IP 
4998 \fBExample:\fP
4999 \f(CW   read list = mary, @students\fP
5000 .IP 
5001 .IP "\fBread only (S)\fP" 
5002 .IP 
5003 Note that this is an inverted synonym for
5004 \fB"writeable"\fP and \fB"write ok"\fP\&.
5005 .IP 
5006 See also \fB"writeable"\fP and \fB"write
5007 ok"\fP\&.
5008 .IP 
5009 .IP "\fBread prediction (G)\fP" 
5010 .IP 
5011 \fINOTE\fP: This code is currently disabled in Samba2\&.0 and
5012 may be removed at a later date\&. Hence this parameter has
5013 no effect\&.
5014 .IP 
5015 This options enables or disables the read prediction code used to
5016 speed up reads from the server\&. When enabled the server will try to
5017 pre-read data from the last accessed file that was opened read-only
5018 while waiting for packets\&.
5019 .IP 
5020 \fBDefault:\fP
5021 \f(CW   read prediction = False\fP
5022 .IP 
5023 .IP "\fBread raw (G)\fP" 
5024 .IP 
5025 This parameter controls whether or not the server will support the raw
5026 read SMB requests when transferring data to clients\&.
5027 .IP 
5028 If enabled, raw reads allow reads of 65535 bytes in one packet\&. This
5029 typically provides a major performance benefit\&.
5030 .IP 
5031 However, some clients either negotiate the allowable block size
5032 incorrectly or are incapable of supporting larger block sizes, and for
5033 these clients you may need to disable raw reads\&.
5034 .IP 
5035 In general this parameter should be viewed as a system tuning tool and left
5036 severely alone\&. See also \fB"write raw"\fP\&.
5037 .IP 
5038 \fBDefault:\fP
5039 \f(CW   read raw = yes\fP
5040 .IP 
5041 .IP "\fBread size (G)\fP" 
5042 .IP 
5043 The option \fB"read size"\fP affects the overlap of disk reads/writes
5044 with network reads/writes\&. If the amount of data being transferred in
5045 several of the SMB commands (currently SMBwrite, SMBwriteX and
5046 SMBreadbraw) is larger than this value then the server begins writing
5047 the data before it has received the whole packet from the network, or
5048 in the case of SMBreadbraw, it begins writing to the network before
5049 all the data has been read from disk\&.
5050 .IP 
5051 This overlapping works best when the speeds of disk and network access
5052 are similar, having very little effect when the speed of one is much
5053 greater than the other\&.
5054 .IP 
5055 The default value is 16384, but very little experimentation has been
5056 done yet to determine the optimal value, and it is likely that the
5057 best value will vary greatly between systems anyway\&. A value over
5058 65536 is pointless and will cause you to allocate memory
5059 unnecessarily\&.
5060 .IP 
5061 \fBDefault:\fP
5062 \f(CW   read size = 16384\fP
5063 .IP 
5064 \fBExample:\fP
5065 \f(CW   read size = 8192\fP
5066 .IP 
5067 .IP "\fBremote announce (G)\fP" 
5068 .IP 
5069 This option allows you to setup \fBnmbd\fP to
5070 periodically announce itself to arbitrary IP addresses with an
5071 arbitrary workgroup name\&.
5072 .IP 
5073 This is useful if you want your Samba server to appear in a remote
5074 workgroup for which the normal browse propagation rules don\'t
5075 work\&. The remote workgroup can be anywhere that you can send IP
5076 packets to\&.
5077 .IP 
5078 For example:
5079 .IP 
5080 \f(CW   remote announce = 192\&.168\&.2\&.255/SERVERS 192\&.168\&.4\&.255/STAFF\fP
5081 .IP 
5082 the above line would cause nmbd to announce itself to the two given IP
5083 addresses using the given workgroup names\&. If you leave out the
5084 workgroup name then the one given in the
5085 \fB"workgroup"\fP parameter is used instead\&.
5086 .IP 
5087 The IP addresses you choose would normally be the broadcast addresses
5088 of the remote networks, but can also be the IP addresses of known
5089 browse masters if your network config is that stable\&.
5090 .IP 
5091 See the documentation file BROWSING\&.txt in the docs/ directory\&.
5092 .IP 
5093 \fBDefault:\fP
5094 \f(CW   remote announce = <empty string>\fP
5095 .IP 
5096 \fBExample:\fP
5097 \f(CW   remote announce = 192\&.168\&.2\&.255/SERVERS 192\&.168\&.4\&.255/STAFF\fP
5098 .IP 
5099 .IP "\fBremote browse sync (G)\fP" 
5100 .IP 
5101 This option allows you to setup \fBnmbd\fP to
5102 periodically request synchronization of browse lists with the master
5103 browser of a samba server that is on a remote segment\&. This option
5104 will allow you to gain browse lists for multiple workgroups across
5105 routed networks\&. This is done in a manner that does not work with any
5106 non-samba servers\&.
5107 .IP 
5108 This is useful if you want your Samba server and all local clients to
5109 appear in a remote workgroup for which the normal browse propagation
5110 rules don\'t work\&. The remote workgroup can be anywhere that you can
5111 send IP packets to\&.
5112 .IP 
5113 For example:
5114 .IP 
5115 \f(CW   remote browse sync = 192\&.168\&.2\&.255 192\&.168\&.4\&.255\fP
5116 .IP 
5117 the above line would cause \fBnmbd\fP to request the
5118 master browser on the specified subnets or addresses to synchronize
5119 their browse lists with the local server\&.
5120 .IP 
5121 The IP addresses you choose would normally be the broadcast addresses
5122 of the remote networks, but can also be the IP addresses of known
5123 browse masters if your network config is that stable\&. If a machine IP
5124 address is given Samba makes NO attempt to validate that the remote
5125 machine is available, is listening, nor that it is in fact the browse
5126 master on it\'s segment\&.
5127 .IP 
5128 \fBDefault:\fP
5129 \f(CW   remote browse sync = <empty string>\fP
5130 .IP 
5131 \fBExample:\fP
5132 \f(CW   remote browse sync = 192\&.168\&.2\&.255 192\&.168\&.4\&.255\fP
5133 .IP 
5134 .IP "\fBrestrict anonymous (G)\fP" 
5135 .IP 
5136 This is a boolean parameter\&.  If it is true, then anonymous access
5137 to the server will be restricted, namely in the case where the server
5138 is expecting the client to send a username, but it doesn\'t\&.  Setting
5139 it to true will force these anonymous connections to be denied, and
5140 the client will be required to always supply a username and password
5141 when connecting\&. Use of this parameter is only recommened for homogenous 
5142 NT client environments\&.
5143 .IP 
5144 This parameter makes the use of macro expansions that rely
5145 on the username (%U, %G, etc) consistant\&.  NT 4\&.0 likes to use
5146 anonymous connections when refreshing the share list, and this
5147 is a way to work around that\&.
5148 .IP 
5149 When restrict anonymous is true, all anonymous connections are denied
5150 no matter what they are for\&.  This can effect the ability of a machine
5151 to access the samba Primary Domain Controller to revalidate it\'s machine
5152 account after someone else has logged on the client interactively\&.  The
5153 NT client will display a message saying that the machine\'s account in 
5154 the domain doesn\'t exist or the password is bad\&.  The best way to deal 
5155 with this is to reboot NT client machines between interactive logons, 
5156 using "Shutdown and Restart", rather than "Close all programs and logon 
5157 as a different user"\&.
5158 .IP 
5159 \fBDefault:\fP
5160 \f(CW     restrict anonymous = false\fP
5161 .IP 
5162 \fBExample:\fP
5163 \f(CW     restrict anonymous = true\fP
5164 .IP 
5165 .IP "\fBrevalidate (S)\fP" 
5166 .IP 
5167 Note that this option only works with
5168 \fB"security=share"\fP and will be ignored if
5169 this is not the case\&.
5170 .IP 
5171 This option controls whether Samba will allow a previously validated
5172 username/password pair to be used to attach to a share\&. Thus if you
5173 connect to \f(CW\e\eserver\eshare1\fP then to \f(CW\e\eserver\eshare2\fP it won\'t
5174 automatically allow the client to request connection to the second
5175 share as the same username as the first without a password\&.
5176 .IP 
5177 If \fB"revalidate"\fP is \f(CW"True"\fP then the client will be denied
5178 automatic access as the same username\&.
5179 .IP 
5180 \fBDefault:\fP
5181 \f(CW   revalidate = False\fP
5182 .IP 
5183 \fBExample:\fP
5184 \f(CW   revalidate = True\fP
5185 .IP 
5186 .IP "\fBroot (G)\fP" 
5187 .IP 
5188 Synonym for \fB"root directory"\fP\&.
5189 .IP 
5190 .IP "\fBroot dir (G)\fP" 
5191 .IP 
5192 Synonym for \fB"root directory"\fP\&.
5193 .IP 
5194 .IP "\fBroot directory (G)\fP" 
5195 .IP 
5196 The server will \f(CW"chroot()"\fP (i\&.e\&. Change it\'s root directory) to
5197 this directory on startup\&. This is not strictly necessary for secure
5198 operation\&. Even without it the server will deny access to files not in
5199 one of the service entries\&. It may also check for, and deny access to,
5200 soft links to other parts of the filesystem, or attempts to use
5201 \f(CW"\&.\&."\fP in file names to access other directories (depending on the
5202 setting of the \fB"wide links"\fP parameter)\&.
5203 .IP 
5204 Adding a \fB"root directory"\fP entry other than \f(CW"/"\fP adds an extra
5205 level of security, but at a price\&. It absolutely ensures that no
5206 access is given to files not in the sub-tree specified in the \fB"root
5207 directory"\fP option, \fI*including*\fP some files needed for complete
5208 operation of the server\&. To maintain full operability of the server
5209 you will need to mirror some system files into the \fB"root
5210 directory"\fP tree\&. In particular you will need to mirror /etc/passwd
5211 (or a subset of it), and any binaries or configuration files needed
5212 for printing (if required)\&. The set of files that must be mirrored is
5213 operating system dependent\&.
5214 .IP 
5215 \fBDefault:\fP
5216 \f(CW   root directory = /\fP
5217 .IP 
5218 \fBExample:\fP
5219 \f(CW   root directory = /homes/smb\fP
5220 .IP 
5221 .IP "\fBroot postexec (S)\fP" 
5222 .IP 
5223 This is the same as the \fB"postexec"\fP parameter
5224 except that the command is run as root\&. This is useful for unmounting
5225 filesystems (such as cdroms) after a connection is closed\&.
5226 .IP 
5227 See also \fB"postexec"\fP\&.
5228 .IP 
5229 .IP "\fBroot preexec (S)\fP" 
5230 .IP 
5231 This is the same as the \fB"preexec"\fP parameter except
5232 that the command is run as root\&. This is useful for mounting
5233 filesystems (such as cdroms) before a connection is finalized\&.
5234 .IP 
5235 See also \fB"preexec"\fP\&.
5236 .IP 
5237 .IP "\fBsecurity (G)\fP" 
5238 .IP 
5239 This option affects how clients respond to Samba and is one of the most
5240 important settings in the \fBsmb\&.conf\fP file\&.
5241 .IP 
5242 The option sets the \f(CW"security mode bit"\fP in replies to protocol
5243 negotiations with \fBsmbd\fP to turn share level
5244 security on or off\&. Clients decide based on this bit whether (and how)
5245 to transfer user and password information to the server\&.
5246 .IP 
5247 The default is "security=user", as this is
5248 the most common setting needed when talking to Windows 98 and Windows
5249 NT\&.
5250 .IP 
5251 The alternatives are \fB"security = share"\fP,
5252 \fB"security = server"\fP or
5253 \fB"security=domain"\fP\&.
5254 .IP 
5255 \fI*****NOTE THAT THIS DEFAULT IS DIFFERENT IN SAMBA2\&.0 THAN FOR
5256 PREVIOUS VERSIONS OF SAMBA *******\fP\&.
5257 .IP 
5258 In previous versions of Samba the default was
5259 \fB"security=share"\fP mainly because that was
5260 the only option at one stage\&.
5261 .IP 
5262 There is a bug in WfWg that has relevance to this setting\&. When in
5263 user or server level security a WfWg client will totally ignore the
5264 password you type in the "connect drive" dialog box\&. This makes it
5265 very difficult (if not impossible) to connect to a Samba service as
5266 anyone except the user that you are logged into WfWg as\&.
5267 .IP 
5268 If your PCs use usernames that are the same as their usernames on the
5269 UNIX machine then you will want to use \fB"security = user"\fP\&. If you
5270 mostly use usernames that don\'t exist on the UNIX box then use
5271 \fB"security = share"\fP\&.
5272 .IP 
5273 You should also use \fBsecurity=share\fP if
5274 you want to mainly setup shares without a password (guest
5275 shares)\&. This is commonly used for a shared printer server\&. It is more
5276 difficult to setup guest shares with
5277 \fBsecurity=user\fP, see the \fB"map to
5278 guest"\fPparameter for details\&.
5279 .IP 
5280 It is possible to use \fBsmbd\fP in a \fI"hybrid
5281 mode"\fP where it is offers both user and share level security under
5282 different \fBNetBIOS aliases\fP\&. See the
5283 \fBNetBIOS aliases\fP and the
5284 \fBinclude\fP parameters for more information\&.
5285 .IP 
5286 The different settings will now be explained\&.
5287 .IP 
5288 .IP 
5289 .IP "\fB"security=share"\fP" 
5290 When clients connect to a share level
5291 security server then need not log onto the server with a valid
5292 username and password before attempting to connect to a shared
5293 resource (although modern clients such as Windows 95/98 and Windows NT
5294 will send a logon request with a username but no password when talking
5295 to a \fBsecurity=share\fP server)\&. Instead, the clients send
5296 authentication information (passwords) on a per-share basis, at the
5297 time they attempt to connect to that share\&.
5298 .IP 
5299 Note that \fBsmbd\fP \fI*ALWAYS*\fP uses a valid UNIX
5300 user to act on behalf of the client, even in \fB"security=share"\fP
5301 level security\&.
5302 .IP 
5303 As clients are not required to send a username to the server
5304 in share level security, \fBsmbd\fP uses several
5305 techniques to determine the correct UNIX user to use on behalf
5306 of the client\&.
5307 .IP 
5308 A list of possible UNIX usernames to match with the given
5309 client password is constructed using the following methods :
5310 .IP 
5311 .IP 
5312 .IP o 
5313 If the \fB"guest only"\fP parameter is set, then
5314 all the other stages are missed and only the \fB"guest
5315 account"\fP username is checked\&.
5316 .IP 
5317 .IP o 
5318 Is a username is sent with the share connection request, then
5319 this username (after mapping - see \fB"username
5320 map"\fP), is added as a potential username\&.
5321 .IP 
5322 .IP o 
5323 If the client did a previous \fI"logon"\fP request (the
5324 SessionSetup SMB call) then the username sent in this SMB
5325 will be added as a potential username\&.
5326 .IP 
5327 .IP o 
5328 The name of the service the client requested is added
5329 as a potential username\&.
5330 .IP 
5331 .IP o 
5332 The NetBIOS name of the client is added to the list as a
5333 potential username\&.
5334 .IP 
5335 .IP o 
5336 Any users on the \fB"user"\fP list are added
5337 as potential usernames\&.
5338 .IP 
5339 .IP 
5340 If the \fB"guest only"\fP parameter is not set, then
5341 this list is then tried with the supplied password\&. The first user for
5342 whom the password matches will be used as the UNIX user\&.
5343 .IP 
5344 If the \fB"guest only"\fP parameter is set, or no
5345 username can be determined then if the share is marked as available to
5346 the \fB"guest account"\fP, then this guest user will
5347 be used, otherwise access is denied\&.
5348 .IP 
5349 Note that it can be \fI*very*\fP confusing in share-level security as to
5350 which UNIX username will eventually be used in granting access\&.
5351 .IP 
5352 See also the section \fB"NOTE ABOUT USERNAME/PASSWORD
5353 VALIDATION"\fP\&.
5354 .IP 
5355 .IP "\fB"security=user"\fP" 
5356 .IP 
5357 This is the default security setting in Samba2\&.0\&. With user-level
5358 security a client must first \f(CW"log-on"\fP with a valid username and
5359 password (which can be mapped using the \fB"username
5360 map"\fP parameter)\&. Encrypted passwords (see the
5361 \fB"encrypted passwords"\fP parameter) can also
5362 be used in this security mode\&. Parameters such as
5363 \fB"user"\fP and \fB"guest only"\fP, if set
5364 are then applied and may change the UNIX user to use on this
5365 connection, but only after the user has been successfully
5366 authenticated\&.
5367 .IP 
5368 \fINote\fP that the name of the resource being requested is
5369 \fI*not*\fP sent to the server until after the server has successfully
5370 authenticated the client\&. This is why guest shares don\'t work in user
5371 level security without allowing the server to automatically map unknown
5372 users into the \fB"guest account"\fP\&. See the
5373 \fB"map to guest"\fP parameter for details on
5374 doing this\&.
5375 .IP 
5376 See also the section \fB"NOTE ABOUT USERNAME/PASSWORD
5377 VALIDATION"\fP\&.
5378 .IP 
5379 .IP "\fB"security=server"\fP" 
5380 .IP 
5381 In this mode Samba will try to validate the username/password by
5382 passing it to another SMB server, such as an NT box\&. If this fails it
5383 will revert to \fB"security = user"\fP, but note that if encrypted
5384 passwords have been negotiated then Samba cannot revert back to
5385 checking the UNIX password file, it must have a valid smbpasswd file
5386 to check users against\&. See the documentation file in the docs/
5387 directory ENCRYPTION\&.txt for details on how to set this up\&.
5388 .IP 
5389 \fINote\fP that from the clients point of view \fB"security=server"\fP is
5390 the same as \fB"security=user"\fP\&. It only
5391 affects how the server deals with the authentication, it does not in
5392 any way affect what the client sees\&.
5393 .IP 
5394 \fINote\fP that the name of the resource being requested is
5395 \fI*not*\fP sent to the server until after the server has successfully
5396 authenticated the client\&. This is why guest shares don\'t work in server
5397 level security without allowing the server to automatically map unknown
5398 users into the \fB"guest account"\fP\&. See the
5399 \fB"map to guest"\fP parameter for details on
5400 doing this\&.
5401 .IP 
5402 See also the section \fB"NOTE ABOUT USERNAME/PASSWORD
5403 VALIDATION"\fP\&.
5404 .IP 
5405 See also the \fB"password server"\fP parameter\&.
5406 and the \fB"encrypted passwords"\fP parameter\&.
5407 .IP 
5408 .IP "\fB"security=domain"\fP" 
5409 .IP 
5410 This mode will only work correctly if
5411 \fBsmbpasswd\fP has been used to add this machine
5412 into a Windows NT Domain\&. It expects the \fB"encrypted
5413 passwords"\fP parameter to be set to \f(CW"true"\fP\&. In
5414 this mode Samba will try to validate the username/password by passing
5415 it to a Windows NT Primary or Backup Domain Controller, in exactly the
5416 same way that a Windows NT Server would do\&.
5417 .IP 
5418 \fINote\fP that a valid UNIX user must still exist as well as the
5419 account on the Domain Controller to allow Samba to have a valid
5420 UNIX account to map file access to\&.
5421 .IP 
5422 \fINote\fP that from the clients point of view \fB"security=domain"\fP is
5423 the same as \fB"security=user"\fP\&. It only
5424 affects how the server deals with the authentication, it does not in
5425 any way affect what the client sees\&.
5426 .IP 
5427 \fINote\fP that the name of the resource being requested is
5428 \fI*not*\fP sent to the server until after the server has successfully
5429 authenticated the client\&. This is why guest shares don\'t work in domain
5430 level security without allowing the server to automatically map unknown
5431 users into the \fB"guest account"\fP\&. See the
5432 \fB"map to guest"\fP parameter for details on
5433 doing this\&.
5434 .IP 
5435 \fIBUG:\fP There is currently a bug in the implementation of
5436 \fB"security=domain\fP with respect to multi-byte character
5437 set usernames\&. The communication with a Domain Controller
5438 must be done in UNICODE and Samba currently does not widen
5439 multi-byte user names to UNICODE correctly, thus a multi-byte
5440 username will not be recognized correctly at the Domain Controller\&.
5441 This issue will be addressed in a future release\&.
5442 .IP 
5443 See also the section \fB"NOTE ABOUT USERNAME/PASSWORD
5444 VALIDATION"\fP\&.
5445 .IP 
5446 See also the \fB"password server"\fP parameter\&.
5447 and the \fB"encrypted passwords"\fP parameter\&.
5448 .IP 
5449 .IP 
5450 \fBDefault:\fP
5451 \f(CW   security = USER\fP
5452 .IP 
5453 \fBExample:\fP
5454 \f(CW   security = DOMAIN\fP
5455 .IP 
5456 .IP "\fBsecurity mask (S)\fP" 
5457 .IP 
5458 This parameter controls what UNIX permission bits can be modified
5459 when a Windows NT client is manipulating the UNIX permission on a
5460 file using the native NT security dialog box\&.
5461 .IP 
5462 This parameter is applied as a mask (AND\'ed with) to the changed
5463 permission bits, thus preventing any bits not in this mask from
5464 being modified\&. Essentially, zero bits in this mask may be treated
5465 as a set of bits the user is not allowed to change\&.
5466 .IP 
5467 If not set explicitly this parameter is set to the same value as the
5468 \fBcreate mask\fP parameter\&. To allow a user to
5469 modify all the user/group/world permissions on a file, set this
5470 parameter to 0777\&.
5471 .IP 
5472 \fINote\fP that users who can access the Samba server through other
5473 means can easily bypass this restriction, so it is primarily
5474 useful for standalone "appliance" systems\&.  Administrators of
5475 most normal systems will probably want to set it to 0777\&.
5476 .IP 
5477 See also the \fBforce directory security
5478 mode\fP, \fBdirectory security
5479 mask\fP, \fBforce security
5480 mode\fP parameters\&.
5481 .IP 
5482 \fBDefault:\fP
5483 \f(CW   security mask = <same as create mask>\fP
5484 .IP 
5485 \fBExample:\fP
5486 \f(CW   security mask = 0777\fP
5487 .IP 
5488 .IP "\fBserver string (G)\fP" 
5489 .IP 
5490 This controls what string will show up in the printer comment box in
5491 print manager and next to the IPC connection in \f(CW"net view"\fP\&. It can be
5492 any string that you wish to show to your users\&.
5493 .IP 
5494 It also sets what will appear in browse lists next to the machine
5495 name\&.
5496 .IP 
5497 A \f(CW"%v"\fP will be replaced with the Samba version number\&.
5498 .IP 
5499 A \f(CW"%h"\fP will be replaced with the hostname\&.
5500 .IP 
5501 \fBDefault:\fP
5502 \f(CW   server string = Samba %v\fP
5503 .IP 
5504 \fBExample:\fP
5505 \f(CW   server string = University of GNUs Samba Server\fP
5506 .IP 
5507 .IP "\fBset directory (S)\fP" 
5508 .IP 
5509 If \f(CW"set directory = no"\fP, then users of the service may not use the
5510 setdir command to change directory\&.
5511 .IP 
5512 The setdir command is only implemented in the Digital Pathworks
5513 client\&. See the Pathworks documentation for details\&.
5514 .IP 
5515 \fBDefault:\fP
5516 \f(CW   set directory = no\fP
5517 .IP 
5518 \fBExample:\fP
5519 \f(CW   set directory = yes\fP
5520 .IP 
5521 .IP "\fBshare modes (S)\fP" 
5522 .IP 
5523 This enables or disables the honoring of the \f(CW"share modes"\fP during a
5524 file open\&. These modes are used by clients to gain exclusive read or
5525 write access to a file\&.
5526 .IP 
5527 These open modes are not directly supported by UNIX, so they are
5528 simulated using shared memory, or lock files if your UNIX doesn\'t
5529 support shared memory (almost all do)\&.
5530 .IP 
5531 The share modes that are enabled by this option are DENY_DOS,
5532 DENY_ALL, DENY_READ, DENY_WRITE, DENY_NONE and DENY_FCB\&.
5533 .IP 
5534 This option gives full share compatibility and enabled by default\&.
5535 .IP 
5536 You should \fI*NEVER*\fP turn this parameter off as many Windows
5537 applications will break if you do so\&.
5538 .IP 
5539 \fBDefault:\fP
5540 \f(CW   share modes = yes\fP
5541 .IP 
5542 .IP "\fBshared mem size (G)\fP" 
5543 .IP 
5544 It specifies the size of the shared memory (in bytes) to use between
5545 \fBsmbd\fP processes\&. This parameter defaults to one
5546 megabyte of shared memory\&. It is possible that if you have a large
5547 server with many files open simultaneously that you may need to
5548 increase this parameter\&. Signs that this parameter is set too low are
5549 users reporting strange problems trying to save files (locking errors)
5550 and error messages in the smbd log looking like \f(CW"ERROR
5551 smb_shm_alloc : alloc of XX bytes failed"\fP\&.
5552 .IP 
5553 If your OS refuses the size that Samba asks for then Samba will try a
5554 smaller size, reducing by a factor of 0\&.8 until the OS accepts it\&.
5555 .IP 
5556 \fBDefault:\fP
5557 \f(CW   shared mem size = 1048576\fP
5558 .IP 
5559 \fBExample:\fP
5560 \f(CW   shared mem size = 5242880 ; Set to 5mb for a large number of files\&.\fP
5561 .IP 
5562 .IP "\fBshort preserve case (G)\fP" 
5563 .IP 
5564 This boolean parameter controls if new files which conform to 8\&.3
5565 syntax, that is all in upper case and of suitable length, are created
5566 upper case, or if they are forced to be the \f(CW"default"\fP case\&. This
5567 option can be use with \fB"preserve case
5568 =yes"\fP to permit long filenames to retain their
5569 case, while short names are lowered\&. Default \fIYes\fP\&.
5570 .IP 
5571 See the section on \fBNAME MANGLING\fP\&.
5572 .IP 
5573 \fBDefault:\fP
5574 \f(CW   short preserve case = yes\fP
5575 .IP 
5576 .IP "\fBsmb passwd file (G)\fP" 
5577 .IP 
5578 This option sets the path to the encrypted smbpasswd file\&.  By default
5579 the path to the smbpasswd file is compiled into Samba\&.
5580 .IP 
5581 \fBDefault:\fP
5582 \f(CW   smb passwd file= <compiled default>\fP
5583 .IP 
5584 \fBExample:\fP
5585 \f(CW   smb passwd file = /usr/samba/private/smbpasswd\fP
5586 .IP 
5587 .IP "\fBsmbrun (G)\fP" 
5588 .IP 
5589 This sets the full path to the \fBsmbrun\fP binary\&. This defaults to the
5590 value in the Makefile\&.
5591 .IP 
5592 You must get this path right for many services to work correctly\&.
5593 .IP 
5594 You should not need to change this parameter so long as Samba
5595 is installed correctly\&.
5596 .IP 
5597 \fBDefault:\fP
5598 \f(CW   smbrun=<compiled default>\fP
5599 .IP 
5600 \fBExample:\fP
5601 \f(CW   smbrun = /usr/local/samba/bin/smbrun\fP
5602 .IP 
5603 .IP "\fBsocket address (G)\fP" 
5604 .IP 
5605 This option allows you to control what address Samba will listen for
5606 connections on\&. This is used to support multiple virtual interfaces on
5607 the one server, each with a different configuration\&.
5608 .IP 
5609 By default samba will accept connections on any address\&.
5610 .IP 
5611 \fBExample:\fP
5612 \f(CW   socket address = 192\&.168\&.2\&.20\fP
5613 .IP 
5614 .IP "\fBsocket options (G)\fP" 
5615 .IP 
5616 This option allows you to set socket options to be used when talking
5617 with the client\&.
5618 .IP 
5619 Socket options are controls on the networking layer of the operating
5620 systems which allow the connection to be tuned\&.
5621 .IP 
5622 This option will typically be used to tune your Samba server for
5623 optimal performance for your local network\&. There is no way that Samba
5624 can know what the optimal parameters are for your net, so you must
5625 experiment and choose them yourself\&. We strongly suggest you read the
5626 appropriate documentation for your operating system first (perhaps
5627 \fB"man setsockopt"\fP will help)\&.
5628 .IP 
5629 You may find that on some systems Samba will say "Unknown socket
5630 option" when you supply an option\&. This means you either incorrectly 
5631 typed it or you need to add an include file to includes\&.h for your OS\&. 
5632 If the latter is the case please send the patch to
5633 \fIsamba-bugs@samba\&.org\fP\&.
5634 .IP 
5635 Any of the supported socket options may be combined in any way you
5636 like, as long as your OS allows it\&.
5637 .IP 
5638 This is the list of socket options currently settable using this
5639 option:
5640 .IP 
5641 .IP 
5642 .IP o 
5643 SO_KEEPALIVE
5644 .IP 
5645 .IP o 
5646 SO_REUSEADDR
5647 .IP 
5648 .IP o 
5649 SO_BROADCAST
5650 .IP 
5651 .IP o 
5652 TCP_NODELAY
5653 .IP 
5654 .IP o 
5655 IPTOS_LOWDELAY
5656 .IP 
5657 .IP o 
5658 IPTOS_THROUGHPUT
5659 .IP 
5660 .IP o 
5661 SO_SNDBUF *
5662 .IP 
5663 .IP o 
5664 SO_RCVBUF *
5665 .IP 
5666 .IP o 
5667 SO_SNDLOWAT *
5668 .IP 
5669 .IP o 
5670 SO_RCVLOWAT *
5671 .IP 
5672 .IP 
5673 Those marked with a \f(CW*\fP take an integer argument\&. The others can
5674 optionally take a 1 or 0 argument to enable or disable the option, by
5675 default they will be enabled if you don\'t specify 1 or 0\&.
5676 .IP 
5677 To specify an argument use the syntax SOME_OPTION=VALUE for example
5678 \f(CWSO_SNDBUF=8192\fP\&. Note that you must not have any spaces before or after
5679 the = sign\&.
5680 .IP 
5681 If you are on a local network then a sensible option might be
5682 .IP 
5683 \f(CWsocket options = IPTOS_LOWDELAY\fP
5684 .IP 
5685 If you have a local network then you could try:
5686 .IP 
5687 \f(CWsocket options = IPTOS_LOWDELAY TCP_NODELAY\fP
5688 .IP 
5689 If you are on a wide area network then perhaps try setting
5690 IPTOS_THROUGHPUT\&. 
5691 .IP 
5692 Note that several of the options may cause your Samba server to fail
5693 completely\&. Use these options with caution!
5694 .IP 
5695 \fBDefault:\fP
5696 \f(CW   socket options = TCP_NODELAY\fP
5697 .IP 
5698 \fBExample:\fP
5699 \f(CW   socket options = IPTOS_LOWDELAY\fP
5700 .IP 
5701 .IP "\fBssl (G)\fP" 
5702 .IP 
5703 This variable is part of SSL-enabled Samba\&. This is only available if
5704 the SSL libraries have been compiled on your system and the configure
5705 option \f(CW"--with-ssl"\fP was given at configure time\&.
5706 .IP 
5707 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5708 enabled by default in any current binary version of Samba\&.
5709 .IP 
5710 This variable enables or disables the entire SSL mode\&. If it is set to
5711 "no", the SSL enabled samba behaves exactly like the non-SSL samba\&. If
5712 set to "yes", it depends on the variables \fB"ssl
5713 hosts"\fP and \fB"ssl hosts resign"\fP
5714 whether an SSL connection will be required\&.
5715 .IP 
5716 \fBDefault:\fP
5717 \f(CW   ssl=no\fP
5718 \fBExample:\fP
5719 \f(CW   ssl=yes\fP
5720 .IP 
5721 .IP "\fBssl CA certDir (G)\fP" 
5722 .IP 
5723 This variable is part of SSL-enabled Samba\&. This is only available if
5724 the SSL libraries have been compiled on your system and the configure
5725 option \f(CW"--with-ssl"\fP was given at configure time\&.
5726 .IP 
5727 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5728 enabled by default in any current binary version of Samba\&.
5729 .IP 
5730 This variable defines where to look up the Certification
5731 Authorities\&. The given directory should contain one file for each CA
5732 that samba will trust\&.  The file name must be the hash value over the
5733 "Distinguished Name" of the CA\&. How this directory is set up is
5734 explained later in this document\&. All files within the directory that
5735 don\'t fit into this naming scheme are ignored\&. You don\'t need this
5736 variable if you don\'t verify client certificates\&.
5737 .IP 
5738 \fBDefault:\fP
5739 \f(CW   ssl CA certDir = /usr/local/ssl/certs\fP
5740 .IP 
5741 .IP "\fBssl CA certFile (G)\fP" 
5742 .IP 
5743 This variable is part of SSL-enabled Samba\&. This is only available if
5744 the SSL libraries have been compiled on your system and the configure
5745 option \f(CW"--with-ssl"\fP was given at configure time\&.
5746 .IP 
5747 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5748 enabled by default in any current binary version of Samba\&.
5749 .IP 
5750 This variable is a second way to define the trusted CAs\&. The
5751 certificates of the trusted CAs are collected in one big file and this
5752 variable points to the file\&. You will probably only use one of the two
5753 ways to define your CAs\&. The first choice is preferable if you have
5754 many CAs or want to be flexible, the second is preferable if you only
5755 have one CA and want to keep things simple (you won\'t need to create
5756 the hashed file names)\&. You don\'t need this variable if you don\'t
5757 verify client certificates\&.
5758 .IP 
5759 \fBDefault:\fP
5760 \f(CW   ssl CA certFile = /usr/local/ssl/certs/trustedCAs\&.pem\fP
5761 .IP 
5762 .IP "\fBssl ciphers (G)\fP" 
5763 .IP 
5764 This variable is part of SSL-enabled Samba\&. This is only available if
5765 the SSL libraries have been compiled on your system and the configure
5766 option \f(CW"--with-ssl"\fP was given at configure time\&.
5767 .IP 
5768 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5769 enabled by default in any current binary version of Samba\&.
5770 .IP 
5771 This variable defines the ciphers that should be offered during SSL
5772 negotiation\&. You should not set this variable unless you know what you
5773 are doing\&.
5774 .IP 
5775 .IP "\fBssl client cert (G)\fP" 
5776 .IP 
5777 This variable is part of SSL-enabled Samba\&. This is only available if
5778 the SSL libraries have been compiled on your system and the configure
5779 option \f(CW"--with-ssl"\fP was given at configure time\&.
5780 .IP 
5781 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5782 enabled by default in any current binary version of Samba\&.
5783 .IP 
5784 The certificate in this file is used by
5785 \fBsmbclient\fP if it exists\&. It\'s needed if the
5786 server requires a client certificate\&.
5787 .IP 
5788 \fBDefault:\fP
5789 \f(CW   ssl client cert = /usr/local/ssl/certs/smbclient\&.pem\fP
5790 .IP 
5791 .IP "\fBssl client key (G)\fP" 
5792 .IP 
5793 This variable is part of SSL-enabled Samba\&. This is only available if
5794 the SSL libraries have been compiled on your system and the configure
5795 option \f(CW"--with-ssl"\fP was given at configure time\&.
5796 .IP 
5797 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5798 enabled by default in any current binary version of Samba\&.
5799 .IP 
5800 This is the private key for \fBsmbclient\fP\&. It\'s
5801 only needed if the client should have a certificate\&.
5802 .IP 
5803 \fBDefault:\fP
5804 \f(CW   ssl client key = /usr/local/ssl/private/smbclient\&.pem\fP
5805 .IP 
5806 .IP "\fBssl compatibility (G)\fP" 
5807 .IP 
5808 This variable is part of SSL-enabled Samba\&. This is only available if
5809 the SSL libraries have been compiled on your system and the configure
5810 option \f(CW"--with-ssl"\fP was given at configure time\&.
5811 .IP 
5812 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5813 enabled by default in any current binary version of Samba\&.
5814 .IP 
5815 This variable defines whether SSLeay should be configured for bug
5816 compatibility with other SSL implementations\&. This is probably not
5817 desirable because currently no clients with SSL implementations other
5818 than SSLeay exist\&.
5819 .IP 
5820 \fBDefault:\fP
5821 \f(CW   ssl compatibility = no\fP
5822 .IP 
5823 .IP "\fBssl hosts (G)\fP" 
5824 .IP 
5825 See \fB"ssl hosts resign"\fP\&.
5826 .IP 
5827 .IP "\fBssl hosts resign (G)\fP" 
5828 .IP 
5829 This variable is part of SSL-enabled Samba\&. This is only available if
5830 the SSL libraries have been compiled on your system and the configure
5831 option \f(CW"--with-ssl"\fP was given at configure time\&.
5832 .IP 
5833 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5834 enabled by default in any current binary version of Samba\&.
5835 .IP 
5836 These two variables define whether samba will go into SSL mode or
5837 not\&. If none of them is defined, samba will allow only SSL
5838 connections\&. If the \fB"ssl hosts"\fP variable lists
5839 hosts (by IP-address, IP-address range, net group or name), only these
5840 hosts will be forced into SSL mode\&. If the \fB"ssl hosts resign"\fP
5841 variable lists hosts, only these hosts will NOT be forced into SSL
5842 mode\&. The syntax for these two variables is the same as for the
5843 \fB"hosts allow"\fP and \fB"hosts
5844 deny"\fP pair of variables, only that the subject of the
5845 decision is different: It\'s not the access right but whether SSL is
5846 used or not\&. See the \fB"allow hosts"\fP parameter for
5847 details\&. The example below requires SSL connections from all hosts
5848 outside the local net (which is 192\&.168\&.*\&.*)\&.
5849 .IP 
5850 \fBDefault:\fP
5851 \f(CW   ssl hosts = <empty string>\fP
5852 \f(CW   ssl hosts resign = <empty string>\fP
5853 .IP 
5854 \fBExample:\fP
5855 \f(CW   ssl hosts resign = 192\&.168\&.\fP
5856 .IP 
5857 .IP "\fBssl require clientcert (G)\fP" 
5858 .IP 
5859 This variable is part of SSL-enabled Samba\&. This is only available if
5860 the SSL libraries have been compiled on your system and the configure
5861 option \f(CW"--with-ssl"\fP was given at configure time\&.
5862 .IP 
5863 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5864 enabled by default in any current binary version of Samba\&.
5865 .IP 
5866 If this variable is set to \f(CW"yes"\fP, the server will not tolerate
5867 connections from clients that don\'t have a valid certificate\&. The
5868 directory/file given in \fB"ssl CA certDir"\fP and
5869 \fB"ssl CA certFile"\fP will be used to look up the
5870 CAs that issued the client\'s certificate\&. If the certificate can\'t be
5871 verified positively, the connection will be terminated\&.  If this
5872 variable is set to \f(CW"no"\fP, clients don\'t need certificates\&. Contrary
5873 to web applications you really \fI*should*\fP require client
5874 certificates\&. In the web environment the client\'s data is sensitive
5875 (credit card numbers) and the server must prove to be trustworthy\&. In
5876 a file server environment the server\'s data will be sensitive and the
5877 clients must prove to be trustworthy\&.
5878 .IP 
5879 \fBDefault:\fP
5880 \f(CW   ssl require clientcert = no\fP
5881 .IP 
5882 .IP "\fBssl require servercert (G)\fP" 
5883 .IP 
5884 This variable is part of SSL-enabled Samba\&. This is only available if
5885 the SSL libraries have been compiled on your system and the configure
5886 option \f(CW"--with-ssl"\fP was given at configure time\&.
5887 .IP 
5888 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5889 enabled by default in any current binary version of Samba\&.
5890 .IP 
5891 If this variable is set to \f(CW"yes"\fP, the
5892 \fBsmbclient\fP will request a certificate from
5893 the server\&. Same as \fB"ssl require
5894 clientcert"\fP for the server\&.
5895 .IP 
5896 \fBDefault:\fP
5897 \f(CW   ssl require servercert = no\fP
5898 .IP 
5899 .IP "\fBssl server cert (G)\fP" 
5900 .IP 
5901 This variable is part of SSL-enabled Samba\&. This is only available if
5902 the SSL libraries have been compiled on your system and the configure
5903 option \f(CW"--with-ssl"\fP was given at configure time\&.
5904 .IP 
5905 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5906 enabled by default in any current binary version of Samba\&.
5907 .IP 
5908 This is the file containing the server\'s certificate\&. The server _must_
5909 have a certificate\&. The file may also contain the server\'s private key\&.
5910 See later for how certificates and private keys are created\&.
5911 .IP 
5912 \fBDefault:\fP
5913 \f(CW   ssl server cert = <empty string>\fP
5914 .IP 
5915 .IP "\fBssl server key (G)\fP" 
5916 .IP 
5917 This variable is part of SSL-enabled Samba\&. This is only available if
5918 the SSL libraries have been compiled on your system and the configure
5919 option \f(CW"--with-ssl"\fP was given at configure time\&.
5920 .IP 
5921 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5922 enabled by default in any current binary version of Samba\&.
5923 .IP 
5924 This file contains the private key of the server\&. If this variable is
5925 not defined, the key is looked up in the certificate file (it may be
5926 appended to the certificate)\&. The server \fI*must*\fP have a private key
5927 and the certificate \fI*must*\fP match this private key\&.
5928 .IP 
5929 \fBDefault:\fP
5930 \f(CW   ssl server key = <empty string>\fP
5931 .IP 
5932 .IP "\fBssl version (G)\fP" 
5933 .IP 
5934 This variable is part of SSL-enabled Samba\&. This is only available if
5935 the SSL libraries have been compiled on your system and the configure
5936 option \f(CW"--with-ssl"\fP was given at configure time\&.
5937 .IP 
5938 \fINote\fP that for export control reasons this code is \fI**NOT**\fP
5939 enabled by default in any current binary version of Samba\&.
5940 .IP 
5941 This enumeration variable defines the versions of the SSL protocol
5942 that will be used\&. \f(CW"ssl2or3"\fP allows dynamic negotiation of SSL v2
5943 or v3, \f(CW"ssl2"\fP results in SSL v2, \f(CW"ssl3"\fP results in SSL v3 and
5944 "tls1" results in TLS v1\&. TLS (Transport Layer Security) is the
5945 (proposed?) new standard for SSL\&.
5946 .IP 
5947 \fBDefault:\fP
5948 \f(CW   ssl version = "ssl2or3"\fP
5949 .IP 
5950 .IP "\fBstat cache (G)\fP" 
5951 .IP 
5952 This parameter determines if \fBsmbd\fP will use a
5953 cache in order to speed up case insensitive name mappings\&. You should
5954 never need to change this parameter\&.
5955 .IP 
5956 \fBDefault:\fP
5957 \f(CW   stat cache = yes\fP
5958 .IP 
5959 .IP "\fBstat cache size (G)\fP" 
5960 .IP 
5961 This parameter determines the number of entries in the \fBstat
5962 cache\fP\&.  You should never need to change this parameter\&.
5963 .IP 
5964 \fBDefault:\fP
5965 \f(CW   stat cache size = 50\fP
5966 .IP 
5967 .IP "\fBstatus (G)\fP" 
5968 .IP 
5969 This enables or disables logging of connections to a status file that
5970 \fBsmbstatus\fP can read\&.
5971 .IP 
5972 With this disabled \fBsmbstatus\fP won\'t be able
5973 to tell you what connections are active\&. You should never need to
5974 change this parameter\&.
5975 .IP 
5976 \fBDefault:\fP
5977 status = yes
5978 .IP 
5979 .IP "\fBstrict locking (S)\fP" 
5980 .IP 
5981 This is a boolean that controls the handling of file locking in the
5982 server\&. When this is set to \f(CW"yes"\fP the server will check every read and
5983 write access for file locks, and deny access if locks exist\&. This can
5984 be slow on some systems\&.
5985 .IP 
5986 When strict locking is \f(CW"no"\fP the server does file lock checks only
5987 when the client explicitly asks for them\&.
5988 .IP 
5989 Well behaved clients always ask for lock checks when it is important,
5990 so in the vast majority of cases \fB"strict locking = no"\fP is
5991 preferable\&.
5992 .IP 
5993 \fBDefault:\fP
5994 \f(CW   strict locking = no\fP
5995 .IP 
5996 \fBExample:\fP
5997 \f(CW   strict locking = yes\fP
5998 .IP 
5999 .IP "\fBstrict sync (S)\fP" 
6000 .IP 
6001 Many Windows applications (including the Windows 98 explorer shell)
6002 seem to confuse flushing buffer contents to disk with doing a sync to
6003 disk\&. Under UNIX, a sync call forces the process to be suspended until
6004 the kernel has ensured that all outstanding data in kernel disk
6005 buffers has been safely stored onto stable storage\&. This is very slow
6006 and should only be done rarely\&. Setting this parameter to "no" (the
6007 default) means that smbd ignores the Windows applications requests for
6008 a sync call\&. There is only a possibility of losing data if the
6009 operating system itself that Samba is running on crashes, so there is
6010 little danger in this default setting\&. In addition, this fixes many
6011 performance problems that people have reported with the new Windows98
6012 explorer shell file copies\&.
6013 .IP 
6014 See also the \fB"sync always"\fP parameter\&.
6015 .IP 
6016 \fBDefault:\fP
6017 \f(CW   strict sync = no\fP
6018 .IP 
6019 \fBExample:\fP
6020 \f(CW   strict sync = yes\fP
6021 .IP 
6022 .IP "\fBstrip dot (G)\fP" 
6023 .IP 
6024 This is a boolean that controls whether to strip trailing dots off
6025 UNIX filenames\&. This helps with some CDROMs that have filenames ending
6026 in a single dot\&.
6027 .IP 
6028 \fBDefault:\fP
6029 \f(CW   strip dot = no\fP
6030 .IP 
6031 \fBExample:\fP
6032 \f(CW   strip dot = yes\fP
6033 .IP 
6034 .IP "\fBsync always (S)\fP" 
6035 .IP 
6036 This is a boolean parameter that controls whether writes will always
6037 be written to stable storage before the write call returns\&. If this is
6038 false then the server will be guided by the client\'s request in each
6039 write call (clients can set a bit indicating that a particular write
6040 should be synchronous)\&. If this is true then every write will be
6041 followed by a fsync() call to ensure the data is written to disk\&.
6042 Note that the \fB"strict sync"\fP parameter must be
6043 set to \f(CW"yes"\fP in order for this parameter to have any affect\&.
6044 .IP 
6045 See also the \fB"strict sync"\fP parameter\&.
6046 .IP 
6047 \fBDefault:\fP
6048 \f(CW   sync always = no\fP
6049 .IP 
6050 \fBExample:\fP
6051 \f(CW   sync always = yes\fP
6052 .IP 
6053 .IP "\fBsyslog (G)\fP" 
6054 .IP 
6055 This parameter maps how Samba debug messages are logged onto the
6056 system syslog logging levels\&. Samba debug level zero maps onto syslog
6057 LOG_ERR, debug level one maps onto LOG_WARNING, debug level two maps
6058 onto LOG_NOTICE, debug level three maps onto LOG_INFO\&. All higher 
6059 levels are mapped to LOG_DEBUG\&.
6060 .IP 
6061 This paramter sets the threshold for sending messages to syslog\&. 
6062 Only messages with debug level less than this value will be sent 
6063 to syslog\&.
6064 .IP 
6065 \fBDefault:\fP
6066 \f(CW   syslog = 1\fP
6067 .IP 
6068 .IP "\fBsyslog only (G)\fP" 
6069 .IP 
6070 If this parameter is set then Samba debug messages are logged into the
6071 system syslog only, and not to the debug log files\&.
6072 .IP 
6073 \fBDefault:\fP
6074 \f(CW   syslog only = no\fP
6075 .IP 
6076 .IP "\fBtime offset (G)\fP" 
6077 .IP 
6078 This parameter is a setting in minutes to add to the normal GMT to
6079 local time conversion\&. This is useful if you are serving a lot of PCs
6080 that have incorrect daylight saving time handling\&.
6081 .IP 
6082 \fBDefault:\fP
6083 \f(CW   time offset = 0\fP
6084 .IP 
6085 \fBExample:\fP
6086 \f(CW   time offset = 60\fP
6087 .IP 
6088 .IP 
6089 .IP "\fBtime server (G)\fP" 
6090 .IP 
6091 This parameter determines if \fBnmbd\fP advertises
6092 itself as a time server to Windows clients\&. The default is False\&.
6093 .IP 
6094 \fBDefault:\fP
6095 \f(CW   time server = False\fP
6096 .IP 
6097 \fBExample:\fP
6098 \f(CW   time server = True\fP
6099 .IP 
6100 .IP "\fBtimestamp logs (G)\fP" 
6101 .IP 
6102 Samba2\&.0 will a timestamps to all log entries by default\&. This
6103 can be distracting if you are attempting to debug a problem\&. This
6104 parameter allows the timestamping to be turned off\&.
6105 .IP 
6106 \fBDefault:\fP
6107 \f(CW   timestamp logs = True\fP
6108 .IP 
6109 \fBExample:\fP
6110 \f(CW   timestamp logs = False\fP
6111 .IP 
6112 .IP "\fBunix password sync (G)\fP" 
6113 .IP 
6114 This boolean parameter controls whether Samba attempts to synchronize
6115 the UNIX password with the SMB password when the encrypted SMB
6116 password in the smbpasswd file is changed\&. If this is set to true the
6117 program specified in the \fB"passwd program"\fP
6118 parameter is called \fI*AS ROOT*\fP - to allow the new UNIX password to be
6119 set without access to the old UNIX password (as the SMB password has
6120 change code has no access to the old password cleartext, only the
6121 new)\&. By default this is set to \f(CW"false"\fP\&.
6122 .IP 
6123 See also \fB"passwd program"\fP, \fB"passwd
6124 chat"\fP\&.
6125 .IP 
6126 \fBDefault:\fP
6127 \f(CW   unix password sync = False\fP
6128 .IP 
6129 \fBExample:\fP
6130 \f(CW   unix password sync = True\fP
6131 .IP 
6132 .IP "\fBunix realname (G)\fP" 
6133 .IP 
6134 This boolean parameter when set causes samba to supply the real name
6135 field from the unix password file to the client\&. This is useful for
6136 setting up mail clients and WWW browsers on systems used by more than
6137 one person\&.
6138 .IP 
6139 \fBDefault:\fP
6140 \f(CW   unix realname = no\fP
6141 .IP 
6142 \fBExample:\fP
6143 \f(CW   unix realname = yes\fP
6144 .IP 
6145 .IP "\fBupdate encrypted (G)\fP" 
6146 .IP 
6147 This boolean parameter allows a user logging on with a plaintext
6148 password to have their encrypted (hashed) password in the smbpasswd
6149 file to be updated automatically as they log on\&. This option allows a
6150 site to migrate from plaintext password authentication (users
6151 authenticate with plaintext password over the wire, and are checked
6152 against a UNIX account database) to encrypted password authentication
6153 (the SMB challenge/response authentication mechanism) without forcing
6154 all users to re-enter their passwords via smbpasswd at the time the
6155 change is made\&. This is a convenience option to allow the change over
6156 to encrypted passwords to be made over a longer period\&. Once all users
6157 have encrypted representations of their passwords in the smbpasswd
6158 file this parameter should be set to \f(CW"off"\fP\&.
6159 .IP 
6160 In order for this parameter to work correctly the \fB"encrypt
6161 passwords"\fP parameter must be set to \f(CW"no"\fP when
6162 this parameter is set to \f(CW"yes"\fP\&.
6163 .IP 
6164 Note that even when this parameter is set a user authenticating to
6165 smbd must still enter a valid password in order to connect correctly,
6166 and to update their hashed (smbpasswd) passwords\&.
6167 .IP 
6168 \fBDefault:\fP
6169 \f(CW   update encrypted = no\fP
6170 .IP 
6171 \fBExample:\fP
6172 \f(CW   update encrypted = yes\fP
6173 .IP 
6174 .IP "\fBuse rhosts (G)\fP" 
6175 .IP 
6176 If this global parameter is a true, it specifies that the UNIX users
6177 \f(CW"\&.rhosts"\fP file in their home directory will be read to find the
6178 names of hosts and users who will be allowed access without specifying
6179 a password\&.
6180 .IP 
6181 NOTE: The use of \fBuse rhosts\fP can be a major security hole\&. This is
6182 because you are trusting the PC to supply the correct username\&. It is
6183 very easy to get a PC to supply a false username\&. I recommend that the
6184 \fBuse rhosts\fP option be only used if you really know what you are
6185 doing\&.
6186 .IP 
6187 \fBDefault:\fP
6188 \f(CW   use rhosts = no\fP
6189 .IP 
6190 \fBExample:\fP
6191 \f(CW   use rhosts = yes\fP
6192 .IP 
6193 .IP "\fBuser (S)\fP" 
6194 .IP 
6195 Synonym for \fB"username"\fP\&.
6196 .IP 
6197 .IP "\fBusers (S)\fP" 
6198 .IP 
6199 Synonym for \fB"username"\fP\&.
6200 .IP 
6201 .IP "\fBusername (S)\fP" 
6202 .IP 
6203 Multiple users may be specified in a comma-delimited list, in which
6204 case the supplied password will be tested against each username in
6205 turn (left to right)\&.
6206 .IP 
6207 The \fBusername=\fP line is needed only when the PC is unable to supply
6208 its own username\&. This is the case for the COREPLUS protocol or where
6209 your users have different WfWg usernames to UNIX usernames\&. In both
6210 these cases you may also be better using the \f(CW\e\eserver\eshare%user\fP
6211 syntax instead\&.
6212 .IP 
6213 The \fBusername=\fP line is not a great solution in many cases as it
6214 means Samba will try to validate the supplied password against each of
6215 the usernames in the username= line in turn\&. This is slow and a bad
6216 idea for lots of users in case of duplicate passwords\&. You may get
6217 timeouts or security breaches using this parameter unwisely\&.
6218 .IP 
6219 Samba relies on the underlying UNIX security\&. This parameter does not
6220 restrict who can login, it just offers hints to the Samba server as to
6221 what usernames might correspond to the supplied password\&. Users can
6222 login as whoever they please and they will be able to do no more
6223 damage than if they started a telnet session\&. The daemon runs as the
6224 user that they log in as, so they cannot do anything that user cannot
6225 do\&.
6226 .IP 
6227 To restrict a service to a particular set of users you can use the
6228 \fB"valid users="\fP parameter\&.
6229 .IP 
6230 If any of the usernames begin with a \f(CW\'@\'\fP then the name will be
6231 looked up first in the yp netgroups list (if Samba is compiled with
6232 netgroup support), followed by a lookup in the UNIX groups database
6233 and will expand to a list of all users in the group of that name\&.
6234 .IP 
6235 If any of the usernames begin with a \f(CW\'+\'\fP then the name will be
6236 looked up only in the UNIX groups database and will expand to a list
6237 of all users in the group of that name\&.
6238 .IP 
6239 If any of the usernames begin with a \f(CW\'&\'\fP then the name will be
6240 looked up only in the yp netgroups database (if Samba is compiled with
6241 netgroup support) and will expand to a list of all users in the
6242 netgroup group of that name\&.
6243 .IP 
6244 Note that searching though a groups database can take quite some time,
6245 and some clients may time out during the search\&.
6246 .IP 
6247 See the section \fB"NOTE ABOUT USERNAME/PASSWORD
6248 VALIDATION"\fP for more
6249 information on how this parameter determines access to the services\&.
6250 .IP 
6251 \fBDefault:\fP
6252 \f(CW   The guest account if a guest service, else the name of the service\&.\fP
6253 .IP 
6254 \fBExamples:\fP
6256 .DS 
6259         username = fred
6260         username = fred, mary, jack, jane, @users, @pcgroup
6262 .DE 
6265 .IP 
6266 .IP "\fBusername level (G)\fP" 
6267 .IP 
6268 This option helps Samba to try and \'guess\' at the real UNIX username,
6269 as many DOS clients send an all-uppercase username\&. By default Samba
6270 tries all lowercase, followed by the username with the first letter
6271 capitalized, and fails if the username is not found on the UNIX
6272 machine\&.
6273 .IP 
6274 If this parameter is set to non-zero the behavior changes\&. This
6275 parameter is a number that specifies the number of uppercase
6276 combinations to try whilst trying to determine the UNIX user name\&. The
6277 higher the number the more combinations will be tried, but the slower
6278 the discovery of usernames will be\&. Use this parameter when you have
6279 strange usernames on your UNIX machine, such as \f(CW"AstrangeUser"\fP\&.
6280 .IP 
6281 \fBDefault:\fP
6282 \f(CW   username level = 0\fP
6283 .IP 
6284 \fBExample:\fP
6285 \f(CW   username level = 5\fP
6286 .IP 
6287 .IP "\fBusername map (G)\fP" 
6288 .IP 
6289 This option allows you to specify a file containing a mapping of
6290 usernames from the clients to the server\&. This can be used for several
6291 purposes\&. The most common is to map usernames that users use on DOS or
6292 Windows machines to those that the UNIX box uses\&. The other is to map
6293 multiple users to a single username so that they can more easily share
6294 files\&.
6295 .IP 
6296 The map file is parsed line by line\&. Each line should contain a single
6297 UNIX username on the left then a \f(CW\'=\'\fP followed by a list of
6298 usernames on the right\&. The list of usernames on the right may contain
6299 names of the form @group in which case they will match any UNIX
6300 username in that group\&. The special client name \f(CW\'*\'\fP is a wildcard
6301 and matches any name\&. Each line of the map file may be up to 1023
6302 characters long\&.
6303 .IP 
6304 The file is processed on each line by taking the supplied username and
6305 comparing it with each username on the right hand side of the \f(CW\'=\'\fP
6306 signs\&. If the supplied name matches any of the names on the right hand
6307 side then it is replaced with the name on the left\&. Processing then
6308 continues with the next line\&.
6309 .IP 
6310 If any line begins with a \f(CW\'#\'\fP or a \f(CW\';\'\fP then it is ignored
6311 .IP 
6312 If any line begins with an \f(CW\'!\'\fP then the processing will stop after
6313 that line if a mapping was done by the line\&. Otherwise mapping
6314 continues with every line being processed\&. Using \f(CW\'!\'\fP is most
6315 useful when you have a wildcard mapping line later in the file\&.
6316 .IP 
6317 For example to map from the name \f(CW"admin"\fP or \f(CW"administrator"\fP to
6318 the UNIX name \f(CW"root"\fP you would use:
6319 .IP 
6320 \f(CW   root = admin administrator\fP
6321 .IP 
6322 Or to map anyone in the UNIX group \f(CW"system"\fP to the UNIX name
6323 \f(CW"sys"\fP you would use:
6324 .IP 
6325 \f(CW   sys = @system\fP
6326 .IP 
6327 You can have as many mappings as you like in a username map file\&.
6328 .IP 
6329 If your system supports the NIS NETGROUP option then the netgroup
6330 database is checked before the \f(CW/etc/group\fP database for matching
6331 groups\&.
6332 .IP 
6333 You can map Windows usernames that have spaces in them by using double
6334 quotes around the name\&. For example:
6335 .IP 
6336 \f(CW   tridge = "Andrew Tridgell"\fP
6337 .IP 
6338 would map the windows username \f(CW"Andrew Tridgell"\fP to the unix
6339 username tridge\&.
6340 .IP 
6341 The following example would map mary and fred to the unix user sys,
6342 and map the rest to guest\&. Note the use of the \f(CW\'!\'\fP to tell Samba
6343 to stop processing if it gets a match on that line\&.
6344 .IP 
6346 .DS 
6349         !sys = mary fred
6350         guest = *
6352 .DE 
6355 .IP 
6356 Note that the remapping is applied to all occurrences of
6357 usernames\&. Thus if you connect to \f(CW"\e\eserver\efred"\fP and \f(CW"fred"\fP
6358 is remapped to \f(CW"mary"\fP then you will actually be connecting to
6359 \f(CW"\e\eserver\emary"\fP and will need to supply a password suitable for
6360 \f(CW"mary"\fP not \f(CW"fred"\fP\&. The only exception to this is the username
6361 passed to the \fB"password server"\fP (if you have
6362 one)\&. The password server will receive whatever username the client
6363 supplies without modification\&.
6364 .IP 
6365 Also note that no reverse mapping is done\&. The main effect this has is
6366 with printing\&. Users who have been mapped may have trouble deleting
6367 print jobs as PrintManager under WfWg will think they don\'t own the
6368 print job\&.
6369 .IP 
6370 \fBDefault:\fP
6371 \f(CW   no username map\fP
6372 .IP 
6373 \fBExample:\fP
6374 \f(CW   username map = /usr/local/samba/lib/users\&.map\fP
6375 .IP 
6376 .IP "\fBvalid chars (S)\fP" 
6377 .IP 
6378 The option allows you to specify additional characters that should be
6379 considered valid by the server in filenames\&. This is particularly
6380 useful for national character sets, such as adding u-umlaut or a-ring\&.
6381 .IP 
6382 The option takes a list of characters in either integer or character
6383 form with spaces between them\&. If you give two characters with a colon
6384 between them then it will be taken as an lowercase:uppercase pair\&.
6385 .IP 
6386 If you have an editor capable of entering the characters into the
6387 config file then it is probably easiest to use this method\&. Otherwise
6388 you can specify the characters in octal, decimal or hexadecimal form
6389 using the usual C notation\&.
6390 .IP 
6391 For example to add the single character \f(CW\'Z\'\fP to the charset (which
6392 is a pointless thing to do as it\'s already there) you could do one of
6393 the following
6394 .IP 
6396 .DS 
6399         valid chars = Z
6400         valid chars = z:Z
6401         valid chars = 0132:0172
6403 .DE 
6406 .IP 
6407 The last two examples above actually add two characters, and alter the
6408 uppercase and lowercase mappings appropriately\&.
6409 .IP 
6410 Note that you MUST specify this parameter after the \fB"client
6411 code page"\fP parameter if you have both set\&. If
6412 \fB"client code page"\fP is set after the
6413 \fB"valid chars"\fP parameter the \fB"valid chars"\fP settings will be
6414 overwritten\&.
6415 .IP 
6416 See also the \fB"client code page"\fP parameter\&.
6417 .IP 
6418 \fBDefault:\fP
6420 .DS 
6423         Samba defaults to using a reasonable set of valid characters
6424         for English systems
6426 .DE 
6429 .IP 
6430 \fBExample\fP
6431 \f(CW   valid chars = 0345:0305 0366:0326 0344:0304\fP
6432 .IP 
6433 The above example allows filenames to have the Swedish characters in
6434 them\&.
6435 .IP 
6436 NOTE: It is actually quite difficult to correctly produce a \fB"valid
6437 chars"\fP line for a particular system\&. To automate the process
6438 \fItino@augsburg\&.net\fP has written a package called \fB"validchars"\fP
6439 which will automatically produce a complete \fB"valid chars"\fP line for
6440 a given client system\&. Look in the examples/validchars/ subdirectory
6441 of your Samba source code distribution for this package\&.
6442 .IP 
6443 .IP "\fBvalid users (S)\fP" 
6444 .IP 
6445 This is a list of users that should be allowed to login to this
6446 service\&. Names starting with \f(CW\'@\'\fP, \f(CW\'+\'\fP and \f(CW\'&\'\fP are
6447 interpreted using the same rules as described in the \fB"invalid
6448 users"\fP parameter\&.
6449 .IP 
6450 If this is empty (the default) then any user can login\&. If a username
6451 is in both this list and the \fB"invalid users"\fP
6452 list then access is denied for that user\&.
6453 .IP 
6454 The current servicename is substituted for
6455 \fB"%S"\fP\&. This is useful in the
6456 \fB[homes]\fP section\&.
6457 .IP 
6458 See also \fB"invalid users"\fP\&.
6459 .IP 
6460 \fBDefault:\fP
6461 \f(CW   No valid users list\&. (anyone can login)\fP
6462 .IP 
6463 \fBExample:\fP
6464 \f(CW   valid users = greg, @pcusers\fP
6465 .IP 
6466 .IP "\fBveto files(S)\fP" 
6467 .IP 
6468 This is a list of files and directories that are neither visible nor
6469 accessible\&.  Each entry in the list must be separated by a \f(CW\'/\'\fP,
6470 which allows spaces to be included in the entry\&. \f(CW\'*\'\fP and \f(CW\'?\'\fP 
6471 can be used to specify multiple files or directories as in DOS
6472 wildcards\&.
6473 .IP 
6474 Each entry must be a unix path, not a DOS path and must \fI*not*\fP include the 
6475 unix directory separator \f(CW\'/\'\fP\&.
6476 .IP 
6477 Note that the \fB"case sensitive"\fP option is
6478 applicable in vetoing files\&.
6479 .IP 
6480 One feature of the veto files parameter that it is important to be
6481 aware of, is that if a directory contains nothing but files that match
6482 the veto files parameter (which means that Windows/DOS clients cannot
6483 ever see them) is deleted, the veto files within that directory *are
6484 automatically deleted* along with it, if the user has UNIX permissions
6485 to do so\&.
6486 .IP 
6487 Setting this parameter will affect the performance of Samba, as it
6488 will be forced to check all files and directories for a match as they
6489 are scanned\&.
6490 .IP 
6491 See also \fB"hide files"\fP and \fB"case
6492 sensitive"\fP\&.
6493 .IP 
6494 \fBDefault:\fP
6495 \f(CW   No files or directories are vetoed\&.\fP
6496 .IP 
6497 \fBExamples:\fP
6498 .IP 
6499 Example 1\&.
6500 .IP 
6502 .DS 
6506     Veto any files containing the word Security, 
6507     any ending in \&.tmp, and any directory containing the
6508     word root\&.
6510         veto files = /*Security*/*\&.tmp/*root*/
6512 .DE 
6515 .IP 
6516 Example 2\&.
6517 .IP 
6519 .DS 
6522     Veto the Apple specific files that a NetAtalk server
6523     creates\&.
6525     veto files = /\&.AppleDouble/\&.bin/\&.AppleDesktop/Network Trash Folder/
6527 .DE 
6530 .IP 
6531 .IP "\fBveto oplock files (S)\fP" 
6532 .IP 
6533 This parameter is only valid when the \fB"oplocks"\fP
6534 parameter is turned on for a share\&. It allows the Samba administrator
6535 to selectively turn off the granting of oplocks on selected files that
6536 match a wildcarded list, similar to the wildcarded list used in the
6537 \fB"veto files"\fP parameter\&.
6538 .IP 
6539 \fBDefault:\fP
6540 \f(CW   No files are vetoed for oplock grants\&.\fP
6541 .IP 
6542 \fBExamples:\fP
6543 .IP 
6544 You might want to do this on files that you know will be heavily
6545 contended for by clients\&. A good example of this is in the NetBench
6546 SMB benchmark program, which causes heavy client contention for files
6547 ending in \f(CW"\&.SEM"\fP\&. To cause Samba not to grant oplocks on these
6548 files you would use the line (either in the \fB[global]\fP
6549 section or in the section for the particular NetBench share :
6550 .IP 
6551 \f(CW     veto oplock files = /*\&.SEM/\fP
6552 .IP 
6553 .IP "\fBvolume (S)\fP" 
6554 .IP 
6555 This allows you to override the volume label returned for a
6556 share\&. Useful for CDROMs with installation programs that insist on a
6557 particular volume label\&.
6558 .IP 
6559 The default is the name of the share\&.
6560 .IP 
6561 .IP "\fBwide links (S)\fP" 
6562 .IP 
6563 This parameter controls whether or not links in the UNIX file system
6564 may be followed by the server\&. Links that point to areas within the
6565 directory tree exported by the server are always allowed; this
6566 parameter controls access only to areas that are outside the directory
6567 tree being exported\&.
6568 .IP 
6569 Note that setting this parameter can have a negative effect on your
6570 server performance due to the extra system calls that Samba has to
6571 do in order to perform the link checks\&.
6572 .IP 
6573 \fBDefault:\fP
6574 \f(CW   wide links = yes\fP
6575 .IP 
6576 \fBExample:\fP
6577 \f(CW   wide links = no\fP
6578 .IP 
6579 .IP "\fBwins proxy (G)\fP" 
6580 .IP 
6581 This is a boolean that controls if \fBnmbd\fP will
6582 respond to broadcast name queries on behalf of other hosts\&. You may
6583 need to set this to \f(CW"yes"\fP for some older clients\&.
6584 .IP 
6585 \fBDefault:\fP
6586 \f(CW   wins proxy = no\fP
6587 .IP 
6588 .IP "\fBwins server (G)\fP" 
6589 .IP 
6590 This specifies the IP address (or DNS name: IP address for preference)
6591 of the WINS server that \fBnmbd\fP should register with\&.
6592 If you have a WINS server on your network then you should set this to
6593 the WINS server\'s IP\&.        
6594 .IP 
6595 You should point this at your WINS server if you have a
6596 multi-subnetted network\&.
6597 .IP 
6598 \fINOTE\fP\&. You need to set up Samba to point to a WINS server if you
6599 have multiple subnets and wish cross-subnet browsing to work correctly\&.
6600 .IP 
6601 See the documentation file BROWSING\&.txt in the docs/ directory of your
6602 Samba source distribution\&.
6603 .IP 
6604 \fBDefault:\fP
6605 \f(CW   wins server = \fP
6606 .IP 
6607 \fBExample:\fP
6608 \f(CW   wins server = 192\&.9\&.200\&.1\fP
6609 .IP 
6610 .IP "\fBwins support (G)\fP" 
6611 .IP 
6612 This boolean controls if the \fBnmbd\fP process in
6613 Samba will act as a WINS server\&. You should not set this to true
6614 unless you have a multi-subnetted network and you wish a particular
6615 \fBnmbd\fP to be your WINS server\&. Note that you
6616 should \fI*NEVER*\fP set this to true on more than one machine in your
6617 network\&.
6618 .IP 
6619 \fBDefault:\fP
6620 \f(CW   wins support = no\fP
6621 .IP 
6622 .IP "\fBworkgroup (G)\fP" 
6623 .IP 
6624 This controls what workgroup your server will appear to be in when
6625 queried by clients\&. Note that this parameter also controls the Domain
6626 name used with the \fB"security=domain"\fP
6627 setting\&.
6628 .IP 
6629 \fBDefault:\fP
6630 \f(CW   set at compile time to WORKGROUP\fP
6631 .IP 
6632 \fBExample:\fP
6633 workgroup = MYGROUP
6634 .IP 
6635 .IP "\fBwritable (S)\fP" 
6636 .IP 
6637 Synonym for \fB"writeable"\fP for people who can\'t spell :-)\&.
6638 .IP 
6639 .IP "\fBwrite list (S)\fP" 
6640 .IP 
6641 This is a list of users that are given read-write access to a
6642 service\&. If the connecting user is in this list then they will be
6643 given write access, no matter what the \fB"read only"\fP
6644 option is set to\&. The list can include group names using the @group
6645 syntax\&.
6646 .IP 
6647 Note that if a user is in both the read list and the write list then
6648 they will be given write access\&.
6649 .IP 
6650 See also the \fB"read list"\fP option\&.
6651 .IP 
6652 \fBDefault:\fP
6653 \f(CW     write list = <empty string>\fP
6654 .IP 
6655 \fBExample:\fP
6656 \f(CW   write list = admin, root, @staff\fP
6657 .IP 
6658 .IP "\fBwrite ok (S)\fP" 
6659 .IP 
6660 Synonym for \fBwriteable\fP\&.
6661 .IP 
6662 .IP "\fBwrite raw (G)\fP" 
6663 .IP 
6664 This parameter controls whether or not the server will support raw
6665 writes SMB\'s when transferring data from clients\&. You should never
6666 need to change this parameter\&.
6667 .IP 
6668 \fBDefault:\fP
6669 \f(CW   write raw = yes\fP
6670 .IP 
6671 .IP "\fBwriteable\fP" 
6672 .IP 
6673 An inverted synonym is \fB"read only"\fP\&.
6674 .IP 
6675 If this parameter is \f(CW"no"\fP, then users of a service may not create
6676 or modify files in the service\'s directory\&.
6677 .IP 
6678 Note that a printable service \fB("printable = yes")\fP
6679 will \fI*ALWAYS*\fP allow writing to the directory (user privileges
6680 permitting), but only via spooling operations\&.
6681 .IP 
6682 \fBDefault:\fP
6683 \f(CW   writeable = no\fP
6684 .IP 
6685 \fBExamples:\fP
6687 .DS 
6690         read only = no
6691         writeable = yes
6692         write ok = yes
6694 .DE 
6697 .IP 
6698 .PP 
6699 .SH "WARNINGS" 
6700 .PP 
6701 Although the configuration file permits service names to contain
6702 spaces, your client software may not\&. Spaces will be ignored in
6703 comparisons anyway, so it shouldn\'t be a problem - but be aware of the
6704 possibility\&.
6705 .PP 
6706 On a similar note, many clients - especially DOS clients - limit
6707 service names to eight characters\&. \fBSmbd\fP has no
6708 such limitation, but attempts to connect from such clients will fail
6709 if they truncate the service names\&.  For this reason you should
6710 probably keep your service names down to eight characters in length\&.
6711 .PP 
6712 Use of the \fB[homes]\fP and \fB[printers]\fP
6713 special sections make life for an administrator easy, but the various
6714 combinations of default attributes can be tricky\&. Take extreme care
6715 when designing these sections\&. In particular, ensure that the
6716 permissions on spool directories are correct\&.
6717 .PP 
6718 .SH "VERSION" 
6719 .PP 
6720 This man page is correct for version 2\&.0 of the Samba suite\&.
6721 .PP 
6722 .SH "SEE ALSO" 
6723 .PP 
6724 \fBsmbd (8)\fP, \fBsmbclient (1)\fP,
6725 \fBnmbd (8)\fP, \fBtestparm (1)\fP,
6726 \fBtestprns (1)\fP, \fBSamba\fP,
6727 \fBnmblookup (1)\fP, \fBsmbpasswd (5)\fP,
6728 \fBsmbpasswd (8)\fP\&.
6729 .PP 
6730 .SH "AUTHOR" 
6731 .PP 
6732 The original Samba software and related utilities were created by
6733 Andrew Tridgell \fIsamba-bugs@samba\&.org\fP\&. Samba is now developed
6734 by the Samba Team as an Open Source project similar to the way the
6735 Linux kernel is developed\&.
6736 .PP 
6737 The original Samba man pages were written by Karl Auer\&. The man page
6738 sources were converted to YODL format (another excellent piece of Open
6739 Source software, available at
6740 \fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP)
6741 and updated for the Samba2\&.0 release by Jeremy Allison\&.
6742 \fIsamba-bugs@samba\&.org\fP\&.
6743 .PP 
6744 See \fBsamba (7)\fP to find out how to get a full
6745 list of contributors and details on how to submit bug reports,
6746 comments etc\&.