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