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