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