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