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