7 CONTENT=
"Modular DocBook HTML Stylesheet Version 1.57"></HEAD
27 >smb.conf
--
The configuration file for the Samba suite
</DIV
39 > file is a configuration
40 file for the Samba suite.
<TT
44 runtime configuration information for the Samba programs. The
48 > file is designed to be configured and
49 administered by the
<A
57 > program. The complete description of the file format and
58 possible parameters held within are here for reference purposes.
</P
68 >The file consists of sections and parameters. A section
69 begins with the name of the section in square brackets and continues
70 until the next section begins. Sections contain parameters of the
86 >The file is line-based - that is, each newline-terminated
87 line represents either a comment, a section name or a parameter.
</P
89 >Section and parameter names are not case sensitive.
</P
91 >Only the first equals sign in a parameter is significant.
92 Whitespace before or after the first equals sign is discarded.
93 Leading, trailing and internal whitespace in section and parameter
94 names is irrelevant. Leading and trailing whitespace in a parameter
95 value is discarded. Internal whitespace within a parameter value
96 is retained verbatim.
</P
98 >Any line beginning with a semicolon (';') or a hash ('#')
99 character is ignored, as are lines containing only whitespace.
</P
101 >Any line ending in a '\' is continued
102 on the next line in the customary UNIX fashion.
</P
104 >The values following the equals sign in parameters are all
105 either a string (no quotes needed) or a boolean, which may be given
106 as yes/no,
0/
1 or true/false. Case is not significant in boolean
107 values, but is preserved in string values. Some items such as
108 create modes are numeric.
</P
116 >SECTION DESCRIPTIONS
</H2
118 >Each section in the configuration file (except for the
119 [global] section) describes a shared resource (known
120 as a
"share"). The section name is the name of the
121 shared resource and the parameters within the section define
122 the shares attributes.
</P
124 >There are three special sections, [global],
125 [homes] and [printers], which are
127 >special sections
</EM
129 following notes apply to ordinary section descriptions.
</P
131 >A share consists of a directory to which access is being
132 given plus a description of the access rights which are granted
133 to the user of the service. Some housekeeping options are
136 >Sections are either file share services (used by the
137 client as an extension of their native file systems) or
138 printable services (used by the client to access print services
139 on the host running the server).
</P
141 >Sections may be designated
<EM
144 in which case no password is required to access them. A specified
147 > is used to define access
148 privileges in this case.
</P
150 >Sections other than guest services will require a password
151 to access them. The client provides the username. As older clients
152 only provide passwords and not usernames, you may specify a list
153 of usernames to check against the password using the
"user="
154 option in the share definition. For modern clients such as
155 Windows
95/
98/ME/NT/
2000, this should not be necessary.
</P
157 >Note that the access rights granted by the server are
158 masked by the access rights granted to the specified or guest
159 UNIX user by the host system. The server does not grant more
160 access than the host system grants.
</P
162 >The following sample section defines a file space share.
163 The user has write access to the path
<TT
167 The share is accessed via the share name
"foo":
</P
177 CLASS=
"COMPUTEROUTPUT"
188 >The following sample section defines a printable share.
189 The share is readonly, but printable. That is, the only write
190 access permitted is via calls to open, write to and close a
194 access will be permitted as the default guest user (specified
205 CLASS=
"COMPUTEROUTPUT"
207 path = /usr/spool/public
224 >SPECIAL SECTIONS
</H2
231 >The [global] section
</H3
233 >parameters in this section apply to the server
234 as a whole, or are defaults for sections which do not
235 specifically define certain items. See the notes
236 under PARAMETERS for more information.
</P
244 >The [homes] section
</H3
246 >If a section called homes is included in the
247 configuration file, services connecting clients to their
248 home directories can be created on the fly by the server.
</P
250 >When the connection request is made, the existing
251 sections are scanned. If a match is found, it is used. If no
252 match is found, the requested section name is treated as a
253 user name and looked up in the local password file. If the
254 name exists and the correct password has been given, a share is
255 created by cloning the [homes] section.
</P
257 >Some modifications are then made to the newly
264 >The share name is changed from homes to
265 the located username.
</P
269 >If no path was given, the path is set to
270 the user's home directory.
</P
274 >If you decide to use a
<EM
277 in your [homes] section then you may find it useful
278 to use the %S macro. For example :
</P
283 >path=/data/pchome/%S
</B
287 >would be useful if you have different home directories
288 for your PCs than for UNIX access.
</P
290 >This is a fast and simple way to give a large number
291 of clients access to their home directories with a minimum
294 >A similar process occurs if the requested section
295 name is
"homes", except that the share name is not
296 changed to that of the requesting user. This method of using
297 the [homes] section works well if different users share
300 >The [homes] section can specify all the parameters
301 a normal service section can specify, though some make more sense
302 than others. The following is a typical and suitable [homes]
313 CLASS=
"COMPUTEROUTPUT"
323 >An important point is that if guest access is specified
324 in the [homes] section, all home directories will be
325 visible to all clients
<EM
326 >without a password
</EM
328 In the very unlikely event that this is actually desirable, it
329 would be wise to also specify
<EM
337 auto home directories will be inherited from the global browseable
338 flag, not the [homes] browseable flag. This is useful as
339 it means setting browseable=no in the [homes] section
340 will hide the [homes] share but make any auto home
341 directories visible.
</P
349 >The [printers] section
</H3
351 >This section works like [homes],
354 >If a [printers] section occurs in the
355 configuration file, users are able to connect to any printer
356 specified in the local host's printcap file.
</P
358 >When a connection request is made, the existing sections
359 are scanned. If a match is found, it is used. If no match is found,
360 but a [homes] section exists, it is used as described
361 above. Otherwise, the requested section name is treated as a
362 printer name and the appropriate printcap file is scanned to see
363 if the requested section name is a valid printer share name. If
364 a match is found, a new printer share is created by cloning
365 the [printers] section.
</P
367 >A few modifications are then made to the newly created
374 >The share name is set to the located printer
379 >If no printer name was given, the printer name
380 is set to the located printer name
</P
384 >If the share does not permit guest access and
385 no username was given, the username is set to the located
390 >Note that the [printers] service MUST be
391 printable - if you specify otherwise, the server will refuse
392 to load the configuration file.
</P
394 >Typically the path specified would be that of a
395 world-writeable spool directory with the sticky bit set on
396 it. A typical [printers] entry would look like
407 CLASS=
"COMPUTEROUTPUT"
409 path = /usr/spool/public
418 >All aliases given for a printer in the printcap file
419 are legitimate printer names as far as the server is concerned.
420 If your printing subsystem doesn't work like that, you will have
421 to set up a pseudo-printcap. This is a file consisting of one or
422 more lines like this:
</P
432 CLASS=
"COMPUTEROUTPUT"
433 > alias|alias|alias|alias...
441 >Each alias should be an acceptable printer name for
442 your printing subsystem. In the [global] section, specify
443 the new file as your printcap. The server will then only recognize
444 names found in your pseudo-printcap, which of course can contain
445 whatever aliases you like. The same technique could be used
446 simply to limit access to a subset of your local printers.
</P
448 >An alias, by the way, is defined as any component of the
449 first entry of a printcap record. Records are separated by newlines,
450 components (if there are more than one) are separated by vertical
451 bar symbols ('|').
</P
453 >NOTE: On SYSV systems which use lpstat to determine what
454 printers are defined on the system you may be able to use
455 "printcap name = lpstat" to automatically obtain a list
456 of printers. See the
"printcap name" option
468 >parameters define the specific attributes of sections.
</P
470 >Some parameters are specific to the [global] section
473 >). Some parameters are usable
474 in all sections (e.g.,
<EM
477 are permissible only in normal sections. For the purposes of the
478 following descriptions the [homes] and [printers]
479 sections will be considered normal. The letter
<EM
482 in parentheses indicates that a parameter is specific to the
483 [global] section. The letter
<EM
486 indicates that a parameter can be specified in a service specific
487 section. Note that all
<EM
489 > parameters can also be specified in
490 the [global] section - in which case they will define
491 the default behavior for all services.
</P
493 >parameters are arranged here in alphabetical order - this may
494 not create best bedfellows, but at least you can find them! Where
495 there are synonyms, the preferred synonym is described, others refer
496 to the preferred synonym.
</P
504 >VARIABLE SUBSTITUTIONS
</H2
506 >Many of the strings that are settable in the config file
507 can take substitutions. For example the option
"path =
508 /tmp/%u" would be interpreted as
"path =
509 /tmp/john" if the user connected with the username john.
</P
511 >These substitutions are mostly noted in the descriptions below,
512 but there are some general substitutions which apply whenever they
513 might be relevant. These are:
</P
523 >the name of the current service, if any.
</P
529 >the root directory of the current service,
536 >user name of the current service, if any.
</P
542 >primary group name of %u.
</P
548 >session user name (the user name that the client
549 wanted, not necessarily the same as the one they got).
</P
555 >primary group name of %U.
</P
561 >the home directory of the user given
568 >the Samba version.
</P
574 >the Internet hostname that Samba is running
581 >the NetBIOS name of the client machine
588 >the NetBIOS name of the server. This allows you
589 to change your config based on what the client calls you. Your
590 server can have a
"dual personality".
</P
596 >the Internet name of the client machine.
603 >the name of your NIS home directory server.
604 This is obtained from your NIS auto.map entry. If you have
605 not compiled Samba with the
<EM
606 >--with-automount
</EM
608 option then this value will be the same as %.
</P
614 >the path of the service's home directory,
615 obtained from your NIS auto.map entry. The NIS auto.map entry
616 is split up as
"%N:%p".
</P
622 >the selected protocol level after
623 protocol negotiation. It can be one of CORE, COREPLUS,
624 LANMAN1, LANMAN2 or NT1.
</P
630 >The process id of the current server
637 >the architecture of the remote
638 machine. Only some are recognized, and those may not be
639 100% reliable. It currently recognizes Samba, WfWg,
640 WinNT and Win95. Anything else will be known as
641 "UNKNOWN". If it gets it wrong then sending a level
643 HREF=
"mailto:samba@samba.org"
647 > should allow it to be fixed.
</P
653 >The IP address of the client machine.
</P
659 >the current date and time.
</P
670 >The value of the environment variable
681 >There are some quite creative things that can be done
682 with these substitutions and other smb.conf options.
</P
692 >Samba supports
"name mangling" so that DOS and
693 Windows clients can use files that don't conform to the
8.3 format.
694 It can also be set to adjust the case of
8.3 format filenames.
</P
696 >There are several options that control the way mangling is
697 performed, and they are grouped here rather than listed separately.
698 For the defaults look at the output of the testparm program.
</P
700 >All of these options can be set separately for each service
701 (or globally, of course).
</P
703 >The options are:
</P
710 >mangle case= yes/no
</DT
713 > controls if names that have characters that
714 aren't of the
"default" case are mangled. For example,
715 if this is yes then a name like
"Mail" would be mangled.
721 >case sensitive = yes/no
</DT
724 >controls whether filenames are case sensitive. If
725 they aren't then Samba must do a filename search and match on passed
731 >default case = upper/lower
</DT
734 >controls what the default case is for new
735 filenames. Default
<EM
740 >preserve case = yes/no
</DT
743 >controls if new files are created with the
744 case that the client passes, or if they are forced to be the
745 "default" case. Default
<EM
751 >short preserve case = yes/no
</DT
754 >controls if new files which conform to
8.3 syntax,
755 that is all in upper case and of suitable length, are created
756 upper case, or if they are forced to be the
"default"
757 case. This option can be use with
"preserve case = yes"
758 to permit long filenames to retain their case, while short names
759 are lowered. Default
<EM
766 >By default, Samba
2.2 has the same semantics as a Windows
767 NT server, in that it is case insensitive but case preserving.
</P
775 >NOTE ABOUT USERNAME/PASSWORD VALIDATION
</H2
777 >There are a number of ways in which a user can connect
778 to a service. The server uses the following steps in determining
779 if it will allow a connection to a specified service. If all the
780 steps fail, then the connection request is rejected. However, if one of the
781 steps succeeds, then the following steps are not checked.
</P
783 >If the service is marked
"guest only = yes" then
784 steps
1 to
5 are skipped.
</P
791 >If the client has passed a username/password
792 pair and that username/password pair is validated by the UNIX
793 system's password programs then the connection is made as that
794 username. Note that this includes the
805 >If the client has previously registered a username
806 with the system and now supplies a correct password for that
807 username then the connection is allowed.
</P
811 >The client's netbios name and any previously
812 used user names are checked against the supplied password, if
813 they match then the connection is allowed as the corresponding
818 >If the client has previously validated a
819 username/password pair with the server and the client has passed
820 the validation token then that username is used.
</P
824 >If a
"user = " field is given in the
828 > file for the service and the client
829 has supplied a password, and that password matches (according to
830 the UNIX system's password checking) with one of the usernames
831 from the
"user=" field then the connection is made as
832 the username in the
"user=" line. If one
833 of the username in the
"user=" list begins with a
834 '@' then that name expands to a list of names in
835 the group of the same name.
</P
839 >If the service is a guest service then a
840 connection is made as the username given in the
"guest
841 account =" for the service, irrespective of the
842 supplied password.
</P
852 >COMPLETE LIST OF GLOBAL PARAMETERS
</H2
854 >Here is a list of all global parameters. See the section of
855 each parameter for details. Note that some are synonyms.
</P
862 HREF=
"#ADDPRINTERCOMMAND"
866 >add printer command
</I
874 HREF=
"#ADDSHARECOMMAND"
878 >add share command
</I
886 HREF=
"#ADDUSERSCRIPT"
898 HREF=
"#ALLOWTRUSTEDDOMAINS"
902 >allow trusted domains
</I
922 HREF=
"#ANNOUNCEVERSION"
946 HREF=
"#BINDINTERFACESONLY"
950 >bind interfaces only
</I
970 HREF=
"#CHANGENOTIFYTIMEOUT"
974 >change notify timeout
</I
982 HREF=
"#CHANGESHARECOMMAND"
986 >change share command
</I
1006 HREF=
"#CLIENTCODEPAGE"
1010 >client code page
</I
1018 HREF=
"#CODEPAGEDIRECTORY"
1022 >code page directory
</I
1030 HREF=
"#CODINGSYSTEM"
1066 HREF=
"#DEBUGHIRESTIMESTAMP"
1070 >debug hires timestamp
</I
1090 HREF=
"#DEBUGTIMESTAMP"
1138 HREF=
"#DEFAULTSERVICE"
1150 HREF=
"#DELETEPRINTERCOMMAND"
1154 >delete printer command
</I
1162 HREF=
"#DELETESHARECOMMAND"
1166 >delete share command
</I
1174 HREF=
"#DELETEUSERSCRIPT"
1178 >delete user script
</I
1186 HREF=
"#DFREECOMMAND"
1210 HREF=
"#DOMAINADMINGROUP"
1214 >domain admin group
</I
1222 HREF=
"#DOMAINGUESTGROUP"
1226 >domain guest group
</I
1234 HREF=
"#DOMAINLOGONS"
1246 HREF=
"#DOMAINMASTER"
1258 HREF=
"#ENCRYPTPASSWORDS"
1262 >encrypt passwords
</I
1270 HREF=
"#ENHANCEDBROWSING"
1274 >enhanced browsing
</I
1282 HREF=
"#ENUMPORTSCOMMAND"
1286 >enumports command
</I
1306 HREF=
"#HIDELOCALUSERS"
1310 >hide local users
</I
1378 HREF=
"#KERNELOPLOCKS"
1426 HREF=
"#LOADPRINTERS"
1462 HREF=
"#LOCKDIRECTORY"
1546 HREF=
"#LPQCACHETIME"
1558 HREF=
"#MACHINEPASSWORDTIMEOUT"
1562 >machine password timeout
</I
1570 HREF=
"#MANGLEDSTACK"
1630 HREF=
"#MAXOPENFILES"
1654 HREF=
"#MAXSMBDPROCESSES"
1658 >max smbd processes
</I
1702 HREF=
"#MESSAGECOMMAND"
1714 HREF=
"#MINPASSWDLENGTH"
1718 >min passwd length
</I
1726 HREF=
"#MINPASSWORDLENGTH"
1730 >min password length
</I
1762 HREF=
"#NAMERESOLVEORDER"
1766 >name resolve order
</I
1774 HREF=
"#NETBIOSALIASES"
1798 HREF=
"#NETBIOSSCOPE"
1822 HREF=
"#NTACLSUPPORT"
1834 HREF=
"#NTPIPESUPPORT"
1846 HREF=
"#NTSMBSUPPORT"
1858 HREF=
"#NULLPASSWORDS"
1870 HREF=
"#OBEYPAMRESTRICTIONS"
1874 >obey pam restrictions
</I
1882 HREF=
"#OPLOCKBREAKWAITTIME"
1886 >oplock break wait time
</I
1906 HREF=
"#OS2DRIVERMAP"
1918 HREF=
"#PAMPASSWORDCHANGE"
1922 >pam password change
</I
1954 HREF=
"#PASSWDCHATDEBUG"
1958 >passwd chat debug
</I
1966 HREF=
"#PASSWDPROGRAM"
1978 HREF=
"#PASSWORDLEVEL"
1990 HREF=
"#PASSWORDSERVER"
2002 HREF=
"#PREFEREDMASTER"
2014 HREF=
"#PREFERREDMASTER"
2018 >preferred master
</I
2050 HREF=
"#PRINTCAPNAME"
2062 HREF=
"#PRINTERDRIVERFILE"
2066 >printer driver file
</I
2122 HREF=
"#REMOTEANNOUNCE"
2134 HREF=
"#REMOTEBROWSESYNC"
2138 >remote browse sync
</I
2146 HREF=
"#RESTRICTANONYMOUS"
2150 >restrict anonymous
</I
2182 HREF=
"#ROOTDIRECTORY"
2206 HREF=
"#SERVERSTRING"
2218 HREF=
"#SHOWADDPRINTERWIZARD"
2222 >show add printer wizard
</I
2230 HREF=
"#SMBPASSWDFILE"
2242 HREF=
"#SOCKETADDRESS"
2254 HREF=
"#SOCKETOPTIONS"
2266 HREF=
"#SOURCEENVIRONMENT"
2270 >source environment
</I
2290 HREF=
"#SSLCACERTDIR"
2302 HREF=
"#SSLCACERTFILE"
2326 HREF=
"#SSLCLIENTCERT"
2338 HREF=
"#SSLCLIENTKEY"
2350 HREF=
"#SSLCOMPATIBILITY"
2354 >ssl compatibility
</I
2374 HREF=
"#SSLHOSTSRESIGN"
2378 >ssl hosts resign
</I
2386 HREF=
"#SSLREQUIRECLIENTCERT"
2390 >ssl require clientcert
</I
2398 HREF=
"#SSLREQUIRESERVERCERT"
2402 >ssl require servercert
</I
2410 HREF=
"#SSLSERVERCERT"
2422 HREF=
"#SSLSERVERKEY"
2458 HREF=
"#STATCACHESIZE"
2506 HREF=
"#TEMPLATEHOMEDIR"
2510 >template homedir
</I
2518 HREF=
"#TEMPLATESHELL"
2554 HREF=
"#TIMESTAMPLOGS"
2566 HREF=
"#TOTALPRINTJOBS"
2570 >total print jobs
</I
2578 HREF=
"#UNIXPASSWORDSYNC"
2582 >unix password sync
</I
2590 HREF=
"#UPDATEENCRYPTED"
2594 >update encrypted
</I
2614 HREF=
"#USERNAMELEVEL"
2638 HREF=
"#UTMPDIRECTORY"
2662 HREF=
"#WINBINDCACHETIME"
2666 >winbind cache time
</I
2686 HREF=
"#WINBINDSEPARATOR"
2690 >winbind separator
</I
2787 >COMPLETE LIST OF SERVICE PARAMETERS
</H2
2789 >Here is a list of all service parameters. See the section on
2790 each parameter for details. Note that some are synonyms.
</P
2833 HREF=
"#BLOCKINGLOCKS"
2869 HREF=
"#CASESENSITIVE"
2881 HREF=
"#CASESIGNAMES"
2953 HREF=
"#DELETEREADONLY"
2965 HREF=
"#DELETEVETOFILES"
2969 >delete veto files
</I
3001 HREF=
"#DIRECTORYMASK"
3013 HREF=
"#DIRECTORYMODE"
3025 HREF=
"#DIRECTORYSECURITYMASK"
3029 >directory security mask
</I
3061 HREF=
"#DOSFILETIMERESOLUTION"
3065 >dos filetime resolution
</I
3073 HREF=
"#DOSFILETIMES"
3097 HREF=
"#FAKEDIRECTORYCREATETIMES"
3101 >fake directory create times
</I
3121 HREF=
"#FOLLOWSYMLINKS"
3133 HREF=
"#FORCECREATEMODE"
3137 >force create mode
</I
3145 HREF=
"#FORCEDIRECTORYMODE"
3149 >force directory mode
</I
3157 HREF=
"#FORCEDIRECTORYSECURITYMODE"
3161 >force directory security mode
</I
3181 HREF=
"#FORCESECURITYMODE"
3185 >force security mode
</I
3229 HREF=
"#GUESTACCOUNT"
3265 HREF=
"#HIDEDOTFILES"
3325 HREF=
"#INHERITPERMISSIONS"
3329 >inherit permissions
</I
3337 HREF=
"#INVALIDUSERS"
3349 HREF=
"#LEVEL2OPLOCKS"
3373 HREF=
"#LPPAUSECOMMAND"
3397 HREF=
"#LPRESUMECOMMAND"
3401 >lpresume command
</I
3469 HREF=
"#MANGLEDNAMES"
3481 HREF=
"#MANGLINGCHAR"
3529 HREF=
"#MAXCONNECTIONS"
3541 HREF=
"#MAXPRINTJOBS"
3553 HREF=
"#MINPRINTSPACE"
3601 HREF=
"#OPLOCKCONTENTIONLIMIT"
3605 >oplock contention limit
</I
3637 HREF=
"#POSIXLOCKING"
3685 HREF=
"#PREEXECCLOSE"
3697 HREF=
"#PRESERVECASE"
3709 HREF=
"#PRINTCOMMAND"
3757 HREF=
"#PRINTERADMIN"
3769 HREF=
"#PRINTERDRIVER"
3781 HREF=
"#PRINTERDRIVERLOCATION"
3785 >printer driver location
</I
3829 HREF=
"#QUEUEPAUSECOMMAND"
3833 >queuepause command
</I
3841 HREF=
"#QUEUERESUMECOMMAND"
3845 >queueresume command
</I
3877 HREF=
"#ROOTPOSTEXEC"
3901 HREF=
"#ROOTPREEXECCLOSE"
3905 >root preexec close
</I
3913 HREF=
"#SECURITYMASK"
3925 HREF=
"#SETDIRECTORY"
3949 HREF=
"#SHORTPRESERVECASE"
3953 >short preserve case
</I
3973 HREF=
"#STRICTLOCKING"
4081 HREF=
"#VETOOPLOCKFILES"
4085 >veto oplock files
</I
4153 HREF=
"#WRITECACHESIZE"
4157 >write cache size
</I
4206 >EXPLANATION OF EACH PARAMETER
</H2
4210 CLASS=
"VARIABLELIST"
4214 NAME=
"ADDPRINTERCOMMAND"
4216 >add printer command (G)
</DT
4219 >With the introduction of MS-RPC based printing
4220 support for Windows NT/
2000 clients in Samba
2.2, The MS Add
4221 Printer Wizard (APW) icon is now also available in the
4222 "Printers..." folder displayed a share listing. The APW
4223 allows for printers to be add remotely to a Samba or Windows
4224 NT/
2000 print server.
</P
4226 >For a Samba host this means that the printer must be
4227 physically added to underlying printing system. The
<TT
4233 > defines a script to be run which
4234 will perform the necessary operations for adding the printer
4235 to the print system and to add the appropriate service definition
4239 > file in order that it can be
4253 >add printer command
</I
4256 automatically invoked with the following parameter (in
4311 >Windows
9x driver location
</I
4318 >All parameters are filled in from the PRINTER_INFO_2 structure sent
4319 by the Windows NT/
2000 client with one exception. The
"Windows 9x
4320 driver location" parameter is included for backwards compatibility
4321 only. The remaining fields in the structure are generated from answers
4322 to the APW questions.
</P
4327 >add printer command
</I
4333 > will reparse the
<TT
4336 > to determine if the share defined by the APW
4337 exists. If the sharename is still invalid, then
<B
4341 > will return an ACCESS_DENIED error to the client.
</P
4344 HREF=
"#DELETEPRINTERCOMMAND"
4348 > delete printer command
</I
4361 HREF=
"#SHOWADDPRINTERWIZARD"
4377 >addprinter command = /usr/bin/addprinter
4383 NAME=
"ADDSHARECOMMAND"
4385 >add share command (G)
</DT
4388 >Samba
2.2.0 introduced the ability to dynamically
4389 add and delete shares via the Windows NT
4.0 Server Manager. The
4393 >add share command
</I
4395 > is used to define an
4396 external program or script which will add a new service definition
4400 >. In order to successfully
4404 >add share command
</I
4410 requires that the administrator be connected using a root account (i.e.
4417 > will automatically invoke the
4421 >add share command
</I
4423 > with four parameters.
4449 > - the name of the new
4460 > - path to an **existing**
4471 > - comment string to associate
4477 > This parameter is only used for add file shares. To add printer shares,
4479 HREF=
"#ADDPRINTERCOMMAND"
4491 HREF=
"#CHANGESHARECOMMAND"
4500 HREF=
"#DELETESHARECOMMAND"
4517 >add share command = /usr/local/bin/addshare
</B
4522 NAME=
"ADDUSERSCRIPT"
4524 >add user script (G)
</DT
4527 >This is the full pathname to a script that will
4535 > under special circumstances described below.
</P
4537 >Normally, a Samba server requires that UNIX users are
4538 created for all users accessing files on this server. For sites
4539 that use Windows NT account databases as their primary user database
4540 creating these users and keeping the user list in sync with the
4541 Windows NT PDC is an onerous task. This option allows
<A
4545 > to create the required UNIX users
4548 > when a user accesses the Samba server.
</P
4550 >In order to use this option,
<A
4563 > security=domain
</I
4571 must be set to a full pathname for a script that will create a UNIX
4572 user given one argument of
<TT
4577 >, which expands into
4578 the UNIX user name to create.
</P
4580 >When the Windows user attempts to access the Samba server,
4581 at login (session setup in the SMB protocol) time,
<A
4591 attempts to authenticate the given user with the given password. If the
4592 authentication succeeds then
<B
4596 attempts to find a UNIX user in the UNIX password database to map the
4597 Windows user into. If this lookup fails, and
<TT
4607 call the specified script
<EM
4615 > argument to be the user name to create.
</P
4617 >If this script successfully creates the user then
<B
4621 > will continue on as though the UNIX user
4622 already existed. In this way, UNIX users are dynamically created to
4623 match existing Windows NT accounts.
</P
4634 HREF=
"#PASSWORDSERVER"
4643 HREF=
"#DELETEUSERSCRIPT"
4655 >add user script =
<empty string
>
4661 >add user script = /usr/local/samba/bin/add_user
4669 >admin users (S)
</DT
4672 >This is a list of users who will be granted
4673 administrative privileges on the share. This means that they
4674 will do all file operations as the super-user (root).
</P
4676 >You should use this option very carefully, as any user in
4677 this list will be able to do anything they like on the share,
4678 irrespective of file permissions.
</P
4686 >admin users = jason
</B
4693 >allow hosts (S)
</DT
4708 NAME=
"ALLOWTRUSTEDDOMAINS"
4710 >allow trusted domains (G)
</DT
4713 >This option only takes effect when the
<A
4729 If it is set to no, then attempts to connect to a resource from
4730 a domain or workgroup other than the one which smbd is running
4731 in will fail, even if that domain is trusted by the remote server
4732 doing the authentication.
</P
4734 >This is useful if you only want your Samba server to
4735 serve resources to users in the domain it is a member of. As
4736 an example, suppose that there are two domains DOMA and DOMB. DOMB
4737 is trusted by DOMA, which contains the Samba server. Under normal
4738 circumstances, a user with an account in DOMB can then access the
4739 resources of a UNIX account with the same account name on the
4740 Samba server even if they do not have an account in DOMA. This
4741 can make implementing a security boundary difficult.
</P
4745 >allow trusted domains = yes
</B
4752 >announce as (G)
</DT
4755 >This specifies what type of server
4764 will announce itself as, to a network neighborhood browse
4765 list. By default this is set to Windows NT. The valid options
4766 are :
"NT Server" (which can also be written as
"NT"),
4767 "NT Workstation",
"Win95" or
"WfW" meaning Windows NT Server,
4768 Windows NT Workstation, Windows
95 and Windows for Workgroups
4769 respectively. Do not change this parameter unless you have a
4770 specific need to stop Samba appearing as an NT server as this
4771 may prevent Samba servers from participating as browser servers
4776 >announce as = NT Server
</B
4781 >announce as = Win95
</B
4786 NAME=
"ANNOUNCEVERSION"
4788 >annouce version (G)
</DT
4791 >This specifies the major and minor version numbers
4792 that nmbd will use when announcing itself as a server. The default
4793 is
4.2. Do not change this parameter unless you have a specific
4794 need to set a Samba server to be a downlevel server.
</P
4798 >announce version =
4.2</B
4803 >announce version =
2.0</B
4810 >auto services (G)
</DT
4813 >This is a synonym for the
<A
4830 >This parameter lets you
"turn off" a service. If
4839 attempts to connect to the service will fail. Such failures are
4849 NAME=
"BINDINTERFACESONLY"
4851 >bind interfaces only (G)
</DT
4854 >This global parameter allows the Samba admin
4855 to limit what interfaces on a machine will serve smb requests. If
4856 affects file service
<A
4868 >For name service it causes
<B
4872 to ports
137 and
138 on the interfaces listed in the
<A
4879 > also binds to the
"all addresses" interface (
0.0.0.0)
4880 on ports
137 and
138 for the purposes of reading broadcast messages.
4881 If this option is not set then
<B
4885 name requests on all of these sockets. If
<TT
4895 source address of any packets coming in on the broadcast sockets
4896 and discard any that don't match the broadcast addresses of the
4897 interfaces in the
<TT
4903 As unicast packets are received on the other sockets it allows
4907 > to refuse to serve names to machines that
4908 send packets that arrive through any interfaces not listed in the
4914 > list. IP Source address spoofing
4915 does defeat this simple check, however so it must not be used
4916 seriously as a security feature for
<B
4921 >For file service it causes
<A
4926 to bind only to the interface list given in the
<A
4929 > parameter. This restricts the networks that
4933 > will serve to packets coming in those
4934 interfaces. Note that you should not use this parameter for machines
4935 that are serving PPP or other intermittent or non-broadcast network
4936 interfaces as it will not cope with non-permanent interfaces.
</P
4941 >bind interfaces only
</I
4944 unless the network address
<EM
4953 HREF=
"smbpasswd.8.html"
4968 not work as expected due to the reasons covered below.
</P
4970 >To change a users SMB password, the
<B
4974 by default connects to the
<EM
4975 >localhost -
127.0.0.1</EM
4977 address as an SMB client to issue the password change request. If
4981 >bind interfaces only
</I
4983 > is set then unless the
4992 > parameter list then
<B
4995 > will fail to connect in it's default mode.
4999 > can be forced to use the primary IP interface
5000 of the local host by using its
<A
5001 HREF=
"smbpasswd.8.html#minusr"
5015 > parameter, with
<TT
5021 to the IP name of the primary interface of the local host.
</P
5026 > status page tries to connect with
5036 > to determine if they are running.
5046 "not running" even if they really are. This can prevent
<B
5049 > from starting/stopping/restarting
<B
5060 >bind interfaces only = no
</B
5065 NAME=
"BLOCKINGLOCKS"
5067 >blocking locks (S)
</DT
5070 >This parameter controls the behavior of
<A
5074 > when given a request by a client
5075 to obtain a byte range lock on a region of an open file, and the
5076 request has a time limit associated with it.
</P
5078 >If this parameter is set and the lock range requested
5079 cannot be immediately satisfied, Samba
2.2 will internally
5080 queue the lock request, and periodically attempt to obtain
5081 the lock until the timeout period expires.
</P
5083 >If this parameter is set to
<TT
5087 Samba
2.2 will behave as previous versions of Samba would and
5088 will fail the lock request immediately if the lock range
5089 cannot be obtained.
</P
5093 >blocking locks = yes
</B
5117 >browse list (G)
</DT
5120 >This controls whether
<A
5127 > will serve a browse list to
5135 >. You should never need to change
5140 >browse list = yes
</B
5150 >This controls whether this share is seen in
5151 the list of available shares in a net view and in the browse list.
</P
5155 >browseable = yes
</B
5160 NAME=
"CASESENSITIVE"
5162 >case sensitive (S)
</DT
5165 >See the discussion in the section
<A
5172 >case sensitive = no
</B
5179 >casesignames (S)
</DT
5183 HREF=
"#CASESENSITIVE"
5190 NAME=
"CHANGENOTIFYTIMEOUT"
5192 >change notify timeout (G)
</DT
5195 >This SMB allows a client to tell a server to
5196 "watch" a particular directory for any changes and only reply to
5197 the SMB request when a change has occurred. Such constant scanning of
5198 a directory is expensive under UNIX, hence an
<A
5205 > daemon only performs such a scan
5206 on each requested directory once every
<TT
5216 >change notify timeout =
60</B
5221 >change notify timeout =
300</B
5224 >Would change the scan time to every
5 minutes.
</P
5228 NAME=
"CHANGESHARECOMMAND"
5230 >change share command (G)
</DT
5233 >Samba
2.2.0 introduced the ability to dynamically
5234 add and delete shares via the Windows NT
4.0 Server Manager. The
5238 >change share command
</I
5240 > is used to define an
5241 external program or script which will modify an existing service definition
5245 >. In order to successfully
5249 >change share command
</I
5255 requires that the administrator be connected using a root account (i.e.
5262 > will automatically invoke the
5266 >change share command
</I
5268 > with four parameters.
5294 > - the name of the new
5305 > - path to an **existing**
5316 > - comment string to associate
5322 > This parameter is only used modify existing file shares definitions. To modify
5323 printer shares, use the
"Printers..." folder as seen when browsing the Samba host.
5327 HREF=
"#ADDSHARECOMMAND"
5336 HREF=
"#DELETESHARECOMMAND"
5353 >change share command = /usr/local/bin/addshare
</B
5360 >character set (G)
</DT
5363 >This allows a smbd to map incoming filenames
5364 from a DOS Code page (see the
<A
5365 HREF=
"#CLIENTCODEPAGE"
5368 > parameter) to several built in UNIX character sets.
5369 The built in code page translations are:
</P
5378 > : Western European
5379 UNIX character set. The parameter
<TT
5382 >client code page
</I
5387 > be set to code page
850 if the
5393 > parameter is set to
5397 > in order for the conversion to the
5398 UNIX character set to be done correctly.
</P
5405 > : Eastern European
5406 UNIX character set. The parameter
<TT
5414 > be set to code page
852 if
5424 > in order for the conversion
5425 to the UNIX character set to be done correctly.
</P
5432 > : Russian Cyrillic
5433 UNIX character set. The parameter
<TT
5441 > be set to code page
5451 > in order for the conversion
5452 to the UNIX character set to be done correctly.
</P
5460 character set. The parameter
<TT
5468 > be set to code page
5478 > in order for the conversion
5479 to the UNIX character set to be done correctly.
</P
5486 > : Alternate mapping
5487 for Russian Cyrillic UNIX character set. The parameter
5491 >client code page
</I
5496 be set to code page
866 if the
<TT
5502 parameter is set to
<TT
5506 conversion to the UNIX character set to be done correctly.
</P
5512 >. These MSDOS code page to UNIX character
5513 set mappings should be dynamic, like the loading of MS DOS code pages,
5516 >Normally this parameter is not set, meaning no filename
5517 translation is done.
</P
5521 >character set =
<empty string
></B
5526 >character set = ISO8859-
1</B
5531 NAME=
"CLIENTCODEPAGE"
5533 >client code page (G)
</DT
5536 >This parameter specifies the DOS code page
5537 that the clients accessing Samba are using. To determine what code
5538 page a Windows or DOS client is using, open a DOS command prompt
5539 and type the command
<B
5543 the code page. The default for USA MS-DOS, Windows
95, and
5544 Windows NT releases is code page
437. The default for western
5545 European releases of the above operating systems is code page
850.
</P
5547 >This parameter tells
<A
5561 > files to dynamically load on startup. These files,
5562 described more fully in the manual page
<A
5563 HREF=
"make_smbcodepage.1.html"
5567 >make_smbcodepage(
1)
</B
5572 > how to map lower to upper case characters to provide
5573 the case insensitivity of filenames that Windows clients expect.
</P
5575 >Samba currently ships with the following code page files :
</P
5581 >Code Page
437 - MS-DOS Latin US
</P
5585 >Code Page
737 - Windows '
95 Greek
</P
5589 >Code Page
850 - MS-DOS Latin
1</P
5593 >Code Page
852 - MS-DOS Latin
2</P
5597 >Code Page
861 - MS-DOS Icelandic
</P
5601 >Code Page
866 - MS-DOS Cyrillic
</P
5605 >Code Page
932 - MS-DOS Japanese SJIS
</P
5609 >Code Page
936 - MS-DOS Simplified Chinese
</P
5613 >Code Page
949 - MS-DOS Korean Hangul
</P
5617 >Code Page
950 - MS-DOS Traditional Chinese
</P
5621 >Thus this parameter may have any of the values
437,
737,
850,
852,
5622 861,
932,
936,
949, or
950. If you don't find the codepage you need,
5623 read the comments in one of the other codepage files and the
5626 >make_smbcodepage(
1)
</B
5627 > man page and write one. Please
5628 remember to donate it back to the Samba user community.
</P
5630 >This parameter co-operates with the
<TT
5636 > parameter in determining what characters are
5637 valid in filenames and how capitalization is done. If you set both
5638 this parameter and the
<TT
5647 >client code page
</I
5652 > be set before the
<TT
5658 > parameter in the
<TT
5668 augment the character settings in the
<TT
5671 >client code page
</I
5679 >client code page
</I
5694 HREF=
"#CODEPAGEDIRECTORY"
5698 >code page directory
</I
5705 >client code page =
850</B
5710 >client code page =
936</B
5715 NAME=
"CODEPAGEDIRECTORY"
5717 >code page directory (G)
</DT
5720 >Define the location of the various client code page
5724 HREF=
"#CLIENTCODEPAGE"
5736 >code page directory = ${prefix}/lib/codepages
5742 >code page directory = /usr/share/samba/codepages
5750 >codingsystem (G)
</DT
5753 >This parameter is used to determine how incoming
5754 Shift-JIS Japanese characters are mapped from the incoming
<A
5755 HREF=
"#CLIENTCODEPAGE"
5759 >client code page
</I
5763 > used by the client, into file names in the UNIX filesystem.
5767 >client code page
</I
5770 932 (Japanese Shift-JIS). The options are :
</P
5779 > - Shift-JIS. Does no
5780 conversion of the incoming filename.
</P
5786 >JIS8, J8BB, J8BH, J8@B,
5788 > - Convert from incoming Shift-JIS to eight
5789 bit JIS code with different shift-in, shift out codes.
</P
5795 >JIS7, J7BB, J7BH, J7@B, J7@J,
5797 > - Convert from incoming Shift-JIS to seven bit
5798 JIS code with different shift-in, shift out codes.
</P
5804 >JUNET, JUBB, JUBH, JU@B, JU@J, JU@H
</TT
5806 - Convert from incoming Shift-JIS to JUNET code with different shift-in,
5814 > - Convert an incoming
5815 Shift-JIS character to EUC code.
</P
5822 > - Convert an incoming
5823 Shift-JIS character to a
3 byte hex representation, i.e.
5834 > - Convert an incoming
5835 Shift-JIS character to the
3 byte hex representation used by
5836 the Columbia AppleTalk Program (CAP), i.e.
<TT
5840 This is used for compatibility between Samba and CAP.
</P
5846 >coding system =
<empty value
></B
5857 >This is a text field that is seen next to a share
5858 when a client does a queries the server, either via the network
5859 neighborhood or via
<B
5862 > to list what shares
5865 >If you want to set the string that is displayed next to the
5866 machine name then see the
<A
5867 HREF=
"#SERVERSTRING"
5877 >No comment string
</EM
5882 >comment = Fred's Files
</B
5889 >config file (G)
</DT
5892 >This allows you to override the config file
5893 to use, instead of the default (usually
<TT
5897 There is a chicken and egg problem here as this option is set
5898 in the config file!
</P
5900 >For this reason, if the name of the config file has changed
5901 when the parameters are loaded then it will reload them from
5902 the new config file.
</P
5904 >This option takes the usual substitutions, which can
5907 >If the config file doesn't exist then it won't be loaded
5908 (allowing you to special case the config files of just a few
5913 >config file = /usr/local/samba/lib/smb.conf.%m
5924 >This parameter allows you to
"clone" service
5925 entries. The specified service is simply duplicated under the
5926 current service's name. Any parameters specified in the current
5927 section will override those in the section being copied.
</P
5929 >This feature lets you set up a 'template' service and
5930 create similar services easily. Note that the service being
5931 copied must occur earlier in the configuration file than the
5932 service doing the copying.
</P
5940 >copy = otherservice
</B
5947 >create mask (S)
</DT
5950 >A synonym for this parameter is
5962 >When a file is created, the necessary permissions are
5963 calculated according to the mapping from DOS modes to UNIX
5964 permissions, and the resulting UNIX mode is then bit-wise 'AND'ed
5965 with this parameter. This parameter may be thought of as a bit-wise
5966 MASK for the UNIX modes of a file. Any bit
<EM
5969 set here will be removed from the modes set on a file when it is
5972 >The default value of this parameter removes the
5973 'group' and 'other' write and execute bits from the UNIX modes.
</P
5975 >Following this Samba will bit-wise 'OR' the UNIX mode created
5976 from this parameter with the value of the
<A
5977 HREF=
"#FORCECREATEMODE"
5981 >force create mode
</I
5985 parameter which is set to
000 by default.
</P
5987 >This parameter does not affect directory modes. See the
5989 HREF=
"#DIRECTORYMODE"
6000 HREF=
"#FORCECREATEMODE"
6008 > parameter for forcing particular mode
6009 bits to be set on created files. See also the
<A
6010 HREF=
"#DIRECTORYMODE"
6017 > parameter for masking
6018 mode bits on created directories. See also the <A
6019 HREF="#INHERITPERMISSIONS
"
6023 >inherit permissions</I
6028 >Note that this parameter does not apply to permissions
6029 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
6030 a mask on access control lists also, they need to set the <A
6031 HREF="#SECURITYMASK
"
6042 >create mask = 0744</B
6047 >create mask = 0775</B
6054 >create mode (S)</DT
6057 >This is a synonym for <A
6074 >The value of the parameter (a decimal integer)
6075 represents the number of minutes of inactivity before a connection
6076 is considered dead, and it is disconnected. The deadtime only takes
6077 effect if the number of open files is zero.</P
6079 >This is useful to stop a server's resources being
6080 exhausted by a large number of inactive connections.</P
6082 >Most clients have an auto-reconnect feature when a
6083 connection is broken so in most cases this parameter should be
6084 transparent to users.</P
6086 >Using this parameter with a timeout of a few minutes
6087 is recommended for most systems.</P
6089 >A deadtime of zero indicates that no auto-disconnection
6090 should be performed.</P
6104 NAME="DEBUGHIRESTIMESTAMP
"
6106 >debug hires timestamp (G)</DT
6109 >Sometimes the timestamps in the log messages
6110 are needed with a resolution of higher that seconds, this
6111 boolean parameter adds microsecond resolution to the timestamp
6112 message header when turned on.</P
6114 >Note that the parameter <A
6115 HREF="#DEBUGTIMESTAMP
"
6119 > debug timestamp</I
6122 > must be on for this to have an
6127 >debug hires timestamp = no</B
6137 >When using only one log file for more then one
6138 forked smbd-process there may be hard to follow which process
6139 outputs which message. This boolean parameter is adds the process-id
6140 to the timestamp message headers in the logfile when turned on.</P
6142 >Note that the parameter <A
6143 HREF="#DEBUGTIMESTAMP
"
6147 > debug timestamp</I
6150 > must be on for this to have an
6160 NAME="DEBUGTIMESTAMP
"
6162 >debug timestamp (G)</DT
6165 >Samba 2.2 debug log messages are timestamped
6166 by default. If you are running at a high <A
6175 can be distracting. This boolean parameter allows timestamping
6176 to be turned off.</P
6180 >debug timestamp = yes</B
6190 >Samba is sometimes run as root and sometime
6191 run as the connected user, this boolean parameter inserts the
6192 current euid, egid, uid and gid to the timestamp message headers
6193 in the log file if turned on.</P
6195 >Note that the parameter <A
6196 HREF="#DEBUGTIMESTAMP
"
6200 > debug timestamp</I
6203 > must be on for this to have an
6236 HREF="#DEFAULTSERVICE
"
6240 > default service</I
6249 >default case (S)</DT
6252 >See the section on <A
6256 HREF="#SHORTPRESERVECASE
"
6260 >short preserve case"</I
6267 >default case = lower
</B
6272 NAME=
"DEFAULTSERVICE"
6274 >default service (G)
</DT
6277 >This parameter specifies the name of a service
6278 which will be connected to if the service actually requested cannot
6279 be found. Note that the square brackets are
<EM
6282 given in the parameter value (see example below).
</P
6284 >There is no default value for this parameter. If this
6285 parameter is not given, attempting to connect to a nonexistent
6286 service results in an error.
</P
6288 >Typically the default service would be a
<A
6306 >Also note that the apparent service name will be changed
6307 to equal that of the requested service, this is very useful as it
6308 allows you to use macros like
<TT
6314 a wildcard service.
</P
6316 >Note also that any
"_" characters in the name of the service
6317 used in the default service will get mapped to a
"/". This allows for
6318 interesting things.
</P
6329 CLASS=
"PROGRAMLISTING"
6331 default service = pub
6343 NAME=
"DELETEPRINTERCOMMAND"
6345 >delete printer command (G)
</DT
6348 >With the introduction of MS-RPC based printer
6349 support for Windows NT/
2000 clients in Samba
2.2, it is now
6350 possible to delete printer at run time by issuing the
6351 DeletePrinter() RPC call.
</P
6353 >For a Samba host this means that the printer must be
6354 physically deleted from underlying printing system. The
<TT
6357 > deleteprinter command
</I
6359 > defines a script to be run which
6360 will perform the necessary operations for removing the printer
6361 from the print system and from
<TT
6370 >delete printer command
</I
6373 automatically called with only one parameter:
<TT
6383 >delete printer command
</I
6389 > will reparse the
<TT
6392 > to associated printer no longer exists.
6393 If the sharename is still valid, then
<B
6397 > will return an ACCESS_DENIED error to the client.
</P
6400 HREF=
"#ADDPRINTERCOMMAND"
6404 > add printer command
</I
6417 HREF=
"#SHOWADDPRINTERWIZARD"
6433 >deleteprinter command = /usr/bin/removeprinter
6439 NAME=
"DELETEREADONLY"
6441 >delete readonly (S)
</DT
6444 >This parameter allows readonly files to be deleted.
6445 This is not normal DOS semantics, but is allowed by UNIX.
</P
6447 >This option may be useful for running applications such
6448 as rcs, where UNIX file ownership prevents changing file
6449 permissions, and DOS semantics prevent deletion of a read only file.
</P
6453 >delete readonly = no
</B
6458 NAME=
"DELETESHARECOMMAND"
6460 >delete share command (G)
</DT
6463 >Samba
2.2.0 introduced the ability to dynamically
6464 add and delete shares via the Windows NT
4.0 Server Manager. The
6468 >delete share command
</I
6470 > is used to define an
6471 external program or script which will remove an existing service
6475 >. In order to successfully
6479 >delete share command
</I
6485 requires that the administrator be connected using a root account (i.e.
6492 > will automatically invoke the
6496 >delete share command
</I
6498 > with two parameters.
6525 the existing service.
6530 > This parameter is only used to remove file shares. To delete printer shares,
6532 HREF=
"#DELETEPRINTERCOMMAND"
6544 HREF=
"#ADDSHARECOMMAND"
6553 HREF=
"#CHANGESHARECOMMAND"
6570 >delete share command = /usr/local/bin/delshare
</B
6575 NAME=
"DELETEUSERSCRIPT"
6577 >delete user script (G)
</DT
6580 >This is the full pathname to a script that will
6590 > under special circumstances
6593 >Normally, a Samba server requires that UNIX users are
6594 created for all users accessing files on this server. For sites
6595 that use Windows NT account databases as their primary user database
6596 creating these users and keeping the user list in sync with the
6597 Windows NT PDC is an onerous task. This option allows
<B
6600 > to delete the required UNIX users
<EM
6603 > when a user accesses the Samba server and the
6604 Windows NT user no longer exists.
</P
6606 >In order to use this option,
<B
6621 > must be set to a full pathname for a script
6622 that will delete a UNIX user given one argument of
<TT
6628 >, which expands into the UNIX user name to delete.
6631 > that this is different to the
<A
6632 HREF=
"#ADDUSERSCRIPT"
6640 which will work with the
<TT
6651 >. The reason for this
6652 is only when Samba is a domain member does it get the information
6653 on an attempted user logon that a user no longer exists. In the
6659 > mode a missing user
6660 is treated the same as an invalid password logon attempt. Deleting
6661 the user in this circumstance would not be a good idea.
</P
6663 >When the Windows user attempts to access the Samba server,
6666 > (session setup in the SMB protocol)
6671 HREF=
"#PASSWORDSERVER"
6678 > and attempts to authenticate
6679 the given user with the given password. If the authentication fails
6680 with the specific Domain error code meaning that the user no longer
6684 > attempts to find a UNIX user in
6685 the UNIX password database that matches the Windows user account. If
6686 this lookup succeeds, and
<TT
6689 >delete user script
</I
6695 > will all the specified script
6698 >, expanding any
<TT
6704 argument to be the user name to delete.
</P
6706 >This script should delete the given UNIX username. In this way,
6707 UNIX users are dynamically deleted to match existing Windows NT
6711 HREF=
"#SECURITYEQUALSDOMAIN"
6715 HREF=
"#PASSWORDSERVER"
6724 HREF=
"#ADDUSERSCRIPT"
6736 >delete user script =
<empty string
>
6742 >delete user script = /usr/local/samba/bin/del_user
6748 NAME=
"DELETEVETOFILES"
6750 >delete veto files (S)
</DT
6753 >This option is used when Samba is attempting to
6754 delete a directory that contains one or more vetoed directories
6764 option). If this option is set to False (the default) then if a vetoed
6765 directory contains any non-vetoed files or directories then the
6766 directory delete will fail. This is usually what you want.
</P
6768 >If this option is set to
<TT
6772 will attempt to recursively delete any files and directories within
6773 the vetoed directory. This can be useful for integration with file
6774 serving systems such as NetAtalk which create meta-files within
6775 directories you might normally veto DOS/Windows users from seeing
6783 >delete veto files = yes
</B
6785 directories to be transparently deleted when the parent directory
6786 is deleted (so long as the user has permissions to do so).
</P
6801 >delete veto files = no
</B
6826 >dfree command (G)
</DT
6835 only be used on systems where a problem occurs with the internal
6836 disk space calculations. This has been known to happen with Ultrix,
6837 but may occur with other operating systems. The symptom that was
6838 seen was an error of
"Abort Retry Ignore" at the end of each
6839 directory listing.
</P
6841 >This setting allows the replacement of the internal routines to
6842 calculate the total disk space and amount available with an external
6843 routine. The example below gives a possible script that might fulfill
6846 >The external program will be passed a single parameter indicating
6847 a directory in the filesystem being queried. This will typically consist
6851 >. The script should return two
6852 integers in ASCII. The first should be the total disk space in blocks,
6853 and the second should be the number of available blocks. An optional
6854 third return value can give the block size in bytes. The default
6855 blocksize is
1024 bytes.
</P
6857 >Note: Your script should
<EM
6860 setgid and should be owned by (and writeable only by) root!
</P
6863 >By default internal routines for
6864 determining the disk capacity and remaining space will be used.
6870 >dfree command = /usr/local/samba/bin/dfree
6874 >Where the script dfree (which must be made executable) could be:
</P
6883 CLASS=
"PROGRAMLISTING"
6886 df $
1 | tail -
1 | awk '{print $
2" "$
4}'
6893 >or perhaps (on Sys V based systems):
</P
6902 CLASS=
"PROGRAMLISTING"
6905 /usr/bin/df -k $
1 | tail -
1 | awk '{print $
3" "$
5}'
6912 >Note that you may have to replace the command names
6913 with full path names on some systems.
</P
6935 NAME=
"DIRECTORYMASK"
6937 >directory mask (S)
</DT
6940 >This parameter is the octal modes which are
6941 used when converting DOS modes to UNIX modes when creating UNIX
6944 >When a directory is created, the necessary permissions are
6945 calculated according to the mapping from DOS modes to UNIX permissions,
6946 and the resulting UNIX mode is then bit-wise 'AND'ed with this
6947 parameter. This parameter may be thought of as a bit-wise MASK for
6948 the UNIX modes of a directory. Any bit
<EM
6951 here will be removed from the modes set on a directory when it is
6954 >The default value of this parameter removes the 'group'
6955 and 'other' write bits from the UNIX mode, allowing only the
6956 user who owns the directory to modify it.
</P
6958 >Following this Samba will bit-wise 'OR' the UNIX mode
6959 created from this parameter with the value of the
<A
6960 HREF=
"#FORCEDIRECTORYMODE"
6964 >force directory mode
6968 > parameter. This parameter is set to
000 by
6969 default (i.e. no extra mode bits are added).
</P
6971 >Note that this parameter does not apply to permissions
6972 set by Windows NT/
2000 ACL editors. If the administrator wishes to enforce
6973 a mask on access control lists also, they need to set the
<A
6974 HREF=
"#DIRECTORYSECURITYMASK"
6978 >directory security mask
</I
6984 HREF=
"#FORCEDIRECTORYMODE"
6992 > parameter to cause particular mode
6993 bits to always be set on created directories.
</P
7004 > parameter for masking mode bits on created files,
7006 HREF=
"#DIRECTORYSECURITYMASK"
7016 >Also refer to the
<A
7017 HREF=
"#INHERITPERMISSIONS"
7021 > inherit permissions
</I
7028 >directory mask =
0755</B
7033 >directory mask =
0775</B
7038 NAME=
"DIRECTORYMODE"
7040 >directory mode (S)
</DT
7044 HREF=
"#DIRECTORYMASK"
7055 NAME=
"DIRECTORYSECURITYMASK"
7057 >directory security mask (S)
</DT
7060 >This parameter controls what UNIX permission bits
7061 can be modified when a Windows NT client is manipulating the UNIX
7062 permission on a directory using the native NT security dialog
7065 >This parameter is applied as a mask (AND'ed with) to
7066 the changed permission bits, thus preventing any bits not in
7067 this mask from being modified. Essentially, zero bits in this
7068 mask may be treated as a set of bits the user is not allowed
7071 >If not set explicitly this parameter is set to
0777
7072 meaning a user is allowed to modify all the user/group/world
7073 permissions on a directory.
</P
7077 > that users who can access the
7078 Samba server through other means can easily bypass this restriction,
7079 so it is primarily useful for standalone
"appliance" systems.
7080 Administrators of most normal systems will probably want to leave
7081 it as the default of
0777.
</P
7084 HREF=
"#FORCEDIRECTORYSECURITYMODE"
7088 > force directory security mode
</I
7092 HREF=
"#SECURITYMASK"
7101 HREF=
"#FORCESECURITYMODE"
7105 >force security mode
7113 >directory security mask =
0777</B
7118 >directory security mask =
0700</B
7133 when acting as a WINS server and finding that a NetBIOS name has not
7134 been registered, should treat the NetBIOS name word-for-word as a DNS
7135 name and do a lookup with the DNS server for that name on behalf of
7136 the name-querying client.
</P
7138 >Note that the maximum length for a NetBIOS name is
15
7139 characters, so the DNS name (or DNS alias) can likewise only be
7140 15 characters, maximum.
</P
7145 > spawns a second copy of itself to do the
7146 DNS name lookup requests, as doing a name lookup is a blocking
7149 >See also the parameter
<A
7166 NAME=
"DOMAINADMINGROUP"
7168 >domain admin group (G)
</DT
7171 >This parameter is intended as a temporary solution
7172 to enable users to be a member of the
"Domain Admins" group when
7173 a Samba host is acting as a PDC. A complete solution will be provided
7174 by a system for mapping Windows NT/
2000 groups onto UNIX groups.
7175 Please note that this parameter has a somewhat confusing name. It
7176 accepts a list of usernames and of group names in standard
7184 HREF=
"#DOMAINGUESTGROUP"
7193 HREF=
"#DOMAINLOGONS"
7205 >no domain administrators
</EM
7210 >domain admin group = root @wheel
</B
7215 NAME=
"DOMAINGUESTGROUP"
7217 >domain guest group (G)
</DT
7220 >This parameter is intended as a temporary solution
7221 to enable users to be a member of the
"Domain Guests" group when
7222 a Samba host is acting as a PDC. A complete solution will be provided
7223 by a system for mapping Windows NT/
2000 groups onto UNIX groups.
7224 Please note that this parameter has a somewhat confusing name. It
7225 accepts a list of usernames and of group names in standard
7233 HREF=
"#DOMAINADMINGROUP"
7242 HREF=
"#DOMAINLOGONS"
7254 >no domain guests
</EM
7259 >domain guest group = nobody @guest
</B
7266 >domain logons (G)
</DT
7269 >If set to true, the Samba server will serve
7270 Windows
95/
98 Domain logons for the
<A
7278 > it is in. Samba
2.2 also
7279 has limited capability to act as a domain controller for Windows
7280 NT
4 Domains. For more details on setting up this feature see
7281 the file DOMAINS.txt in the Samba documentation directory
<TT
7285 > shipped with the source code.
</P
7289 >domain logons = no
</B
7296 >domain master (G)
</DT
7306 > to enable WAN-wide browse list
7307 collation. Setting this option causes
<B
7311 claim a special domain specific NetBIOS name that identifies
7312 it as a domain master browser for its given
<A
7320 >. Local master browsers
7326 > on broadcast-isolated
7327 subnets will give this
<B
7330 > their local browse lists,
7339 for a complete copy of the browse list for the whole wide area
7340 network. Browser clients will then contact their local master browser,
7341 and will receive the domain-wide browse list, instead of just the list
7342 for their broadcast-isolated subnet.
</P
7344 >Note that Windows NT Primary Domain Controllers expect to be
7345 able to claim this
<TT
7351 NetBIOS name that identifies them as domain master browsers for
7357 > by default (i.e. there is no
7358 way to prevent a Windows NT PDC from attempting to do this). This
7359 means that if this parameter is set and
<B
7363 the special name for a
<TT
7369 NT PDC is able to do so then cross subnet browsing will behave
7370 strangely and may fail.
</P
7373 HREF=
"#DOMAINLOGONS"
7376 >domain logons = yes
</B
7379 >, then the default behavior is to enable the
<TT
7391 not enabled (the default setting), then neither will
<TT
7397 > be enabled by default.
</P
7401 >domain master = auto
</B
7408 >dont descend (S)
</DT
7411 >There are certain directories on some systems
7415 > tree under Linux) that are either not
7416 of interest to clients or are infinitely deep (recursive). This
7417 parameter allows you to specify a comma-delimited list of directories
7418 that the server should always show as empty.
</P
7420 >Note that Samba can be very fussy about the exact format
7421 of the
"dont descend" entries. For example you may need
<TT
7424 > instead of just
<TT
7428 Experimentation is the best policy :-)
</P
7431 >none (i.e., all directories are OK
7437 >dont descend = /proc,/dev
</B
7444 >dos filemode (S)
</DT
7447 > The default behavior in Samba is to provide
7448 UNIX-like behavor where only the owner of a file/directory is
7449 able to change the permissions on it. However, this behavior
7450 is often confusing to DOS/Windows users. Enabling this parameter
7451 allows a user who has write access to the file (by whatever
7452 means) to modify the permissions on it. Note that a user
7453 belonging to the group owning the file will not be allowed to
7454 change permissions if the group is only granted read access.
7455 Ownership of the file/directory is not changed, only the permissions
7460 >dos filemode = no
</B
7465 NAME=
"DOSFILETIMERESOLUTION"
7467 >dos filetime resolution (S)
</DT
7470 >Under the DOS and Windows FAT filesystem, the finest
7471 granularity on time resolution is two seconds. Setting this parameter
7472 for a share causes Samba to round the reported time down to the
7473 nearest two second boundary when a query call that requires one second
7474 resolution is made to
<A
7484 >This option is mainly used as a compatibility option for Visual
7485 C++ when used against Samba shares. If oplocks are enabled on a
7486 share, Visual C++ uses two different time reading calls to check if a
7487 file has changed since it was last read. One of these calls uses a
7488 one-second granularity, the other uses a two second granularity. As
7489 the two second call rounds any odd second down, then if the file has a
7490 timestamp of an odd number of seconds then the two timestamps will not
7491 match and Visual C++ will keep reporting the file has changed. Setting
7492 this option causes the two timestamps to match, and Visual C++ is
7497 >dos filetime resolution = no
</B
7504 >dos filetimes (S)
</DT
7507 >Under DOS and Windows, if a user can write to a
7508 file they can change the timestamp on it. Under POSIX semantics,
7509 only the owner of the file or root may change the timestamp. By
7510 default, Samba runs with POSIX semantics and refuses to change the
7511 timestamp on a file if the user
<B
7515 on behalf of is not the file owner. Setting this option to
<TT
7518 > allows DOS semantics and smbd will change the file
7519 timestamp as DOS requires.
</P
7523 >dos filetimes = no
</B
7528 NAME=
"ENCRYPTPASSWORDS"
7530 >encrypt passwords (G)
</DT
7533 >This boolean controls whether encrypted passwords
7534 will be negotiated with the client. Note that Windows NT
4.0 SP3 and
7535 above and also Windows
98 will by default expect encrypted passwords
7536 unless a registry entry is changed. To use encrypted passwords in
7537 Samba see the file ENCRYPTION.txt in the Samba documentation
7541 > shipped with the source code.
</P
7543 >In order for encrypted passwords to work correctly
7552 have access to a local
<A
7553 HREF=
"smbpasswd.5.html"
7561 HREF=
"smbpasswd.8.html"
7567 > program for information on how to set up
7568 and maintain this file), or set the
<A
7570 >security=[serve|domain]
</A
7575 > to authenticate against another
7580 >encrypt passwords = no
</B
7585 NAME=
"ENHANCEDBROWSING"
7587 >enhanced browsing (G)
</DT
7590 >This option enables a couple of enhancements to
7591 cross-subnet browse propogation that have been added in Samba
7592 but which are not standard in Microsoft implementations.
7594 >These enhancements are currently only available in
7595 the HEAD Samba CVS tree (not Samba
2.2.x).
</EM
7598 >The first enhancement to browse propogation consists of a regular
7599 wildcard query to a Samba WINS server for all Domain Master Browsers,
7600 followed by a browse synchronisation with each of the returned
7601 DMBs. The second enhancement consists of a regular randomised browse
7602 synchronisation with all currently known DMBs.
</P
7604 >You may wish to disable this option if you have a problem with empty
7605 workgroups not disappearing from browse lists. Due to the restrictions
7606 of the browse protocols these enhancements can cause a empty workgroup
7607 to stay around forever which can be annoying.
</P
7609 >In general you should leave this option enabled as it makes
7610 cross-subnet browse propogation much more reliable.
</P
7614 >enhanced browsing = yes
</B
7619 NAME=
"ENUMPORTSCOMMAND"
7621 >enumports command (G)
</DT
7624 >The concept of a
"port" is fairly foreign
7625 to UNIX hosts. Under Windows NT/
2000 print servers, a port
7626 is associated with a port monitor and generally takes the form of
7627 a local port (i.e. LPT1:, COM1:, FILE:) or a remote port
7628 (i.e. LPD Port Monitor, etc...). By default, Samba has only one
7631 >"Samba Printer Port"</TT
7633 Windows NT/
2000, all printers must have a valid port name.
7634 If you wish to have a list of ports displayed (
<B
7638 > does not use a port name for anything) other than
7641 >"Samba Printer Port"</TT
7646 >enumports command
</I
7649 a program which should generate a list of ports, one per line,
7650 to standard output. This listing will then be used in response
7651 to the level
1 and
2 EnumPorts() RPC.
</P
7654 >no enumports command
</EM
7659 >enumports command = /usr/bin/listports
7670 >This is a synonym for
<A
7682 NAME=
"FAKEDIRECTORYCREATETIMES"
7684 >fake directory create times (S)
</DT
7687 >NTFS and Windows VFAT file systems keep a create
7688 time for all files and directories. This is not the same as the
7689 ctime - status change time - that Unix keeps, so Samba by default
7690 reports the earliest of the various times Unix does keep. Setting
7691 this parameter for a share causes Samba to always report midnight
7692 1-
1-
1980 as the create time for directories.
</P
7694 >This option is mainly used as a compatibility option for
7695 Visual C++ when used against Samba shares. Visual C++ generated
7696 makefiles have the object directory as a dependency for each object
7697 file, and a make rule to create the directory. Also, when NMAKE
7698 compares timestamps it uses the creation time when examining a
7699 directory. Thus the object directory will be created if it does not
7700 exist, but once it does exist it will always have an earlier
7701 timestamp than the object files it contains.
</P
7703 >However, Unix time semantics mean that the create time
7704 reported by Samba will be updated whenever a file is created or
7705 or deleted in the directory. NMAKE finds all object files in
7706 the object directory. The timestamp of the last one built is then
7707 compared to the timestamp of the object dircetory. If the
7708 directory's timestamp if newer, then all object files
7709 will be rebuilt. Enabling this option
7710 ensures directories always predate their contents and an NMAKE build
7711 will proceed as expected.
</P
7715 >fake directory create times = no
</B
7722 >fake oplocks (S)
</DT
7725 >Oplocks are the way that SMB clients get permission
7726 from a server to locally cache file operations. If a server grants
7727 an oplock (opportunistic lock) then the client is free to assume
7728 that it is the only one accessing the file and it will aggressively
7729 cache file data. With some oplock types the client may even cache
7730 file open/close operations. This can give enormous performance benefits.
7735 >fake oplocks = yes
</B
7744 always grant oplock requests no matter how many clients are using
7747 >It is generally much better to use the real
<A
7756 than this parameter.
</P
7758 >If you enable this option on all read-only shares or
7759 shares that you know will only be accessed from one client at a
7760 time such as physically read-only media like CDROMs, you will see
7761 a big performance improvement on many operations. If you enable
7762 this option on shares where multiple clients may be accessing the
7763 files read-write at the same time you can get data corruption. Use
7764 this option carefully!
</P
7768 >fake oplocks = no
</B
7773 NAME=
"FOLLOWSYMLINKS"
7775 >follow symlinks (S)
</DT
7778 >This parameter allows the Samba administrator
7787 from following symbolic links in a particular share. Setting this
7791 > prevents any file or directory
7792 that is a symbolic link from being followed (the user will get an
7793 error). This option is very useful to stop users from adding a
7794 symbolic link to
<TT
7798 directory for instance. However it will slow filename lookups
7801 >This option is enabled (i.e.
<B
7805 follow symbolic links) by default.
</P
7809 >follow symlinks = yes
</B
7814 NAME=
"FORCECREATEMODE"
7816 >force create mode (S)
</DT
7819 >This parameter specifies a set of UNIX mode bit
7820 permissions that will
<EM
7823 file created by Samba. This is done by bitwise 'OR'ing these bits onto
7824 the mode bits of a file that is being created or having its
7825 permissions changed. The default for this parameter is (in octal)
7826 000. The modes in this parameter are bitwise 'OR'ed onto the file
7827 mode after the mask set in the
<TT
7833 parameter is applied.
</P
7835 >Note that by default this parameter does not apply to permissions
7836 set by Windows NT/
2000 ACL editors. If the administrator wishes to enforce
7837 this mask on access control lists also, they need to set the
<A
7838 HREF=
"#RESTRICTACLWITHMASK"
7848 >See also the parameter
<A
7857 > for details on masking mode bits on files.
</P
7860 HREF=
"#INHERITPERMISSIONS"
7872 >force create mode =
000</B
7877 >force create mode =
0755</B
7880 >would force all created files to have read and execute
7881 permissions set for 'group' and 'other' as well as the
7882 read/write/execute bits set for the 'user'.
</P
7886 NAME=
"FORCEDIRECTORYMODE"
7888 >force directory mode (S)
</DT
7891 >This parameter specifies a set of UNIX mode bit
7892 permissions that will
<EM
7894 > be set on a directory
7895 created by Samba. This is done by bitwise 'OR'ing these bits onto the
7896 mode bits of a directory that is being created. The default for this
7897 parameter is (in octal)
0000 which will not add any extra permission
7898 bits to a created directory. This operation is done after the mode
7899 mask in the parameter
<TT
7907 >Note that by default this parameter does not apply to permissions
7908 set by Windows NT/
2000 ACL editors. If the administrator wishes to enforce
7909 this mask on access control lists also, they need to set the
<A
7910 HREF=
"#RESTRICTACLWITHMASK"
7920 >See also the parameter
<A
7921 HREF=
"#DIRECTORYMASK"
7928 > for details on masking mode bits
7929 on created directories.
</P
7932 HREF=
"#INHERITPERMISSIONS"
7936 > inherit permissions
</I
7943 >force directory mode =
000</B
7948 >force directory mode =
0755</B
7951 >would force all created directories to have read and execute
7952 permissions set for 'group' and 'other' as well as the
7953 read/write/execute bits set for the 'user'.
</P
7957 NAME=
"FORCEDIRECTORYSECURITYMODE"
7960 security mode (S)
</DT
7963 >This parameter controls what UNIX permission bits
7964 can be modified when a Windows NT client is manipulating the UNIX
7965 permission on a directory using the native NT security dialog box.
</P
7967 >This parameter is applied as a mask (OR'ed with) to the
7968 changed permission bits, thus forcing any bits in this mask that
7969 the user may have modified to be on. Essentially, one bits in this
7970 mask may be treated as a set of bits that, when modifying security
7971 on a directory, the user has always set to be 'on'.
</P
7973 >If not set explicitly this parameter is
000, which
7974 allows a user to modify all the user/group/world permissions on a
7975 directory without restrictions.
</P
7979 > that users who can access the
7980 Samba server through other means can easily bypass this restriction,
7981 so it is primarily useful for standalone
"appliance" systems.
7982 Administrators of most normal systems will probably want to leave
7986 HREF=
"#DIRECTORYSECURITYMASK"
7990 > directory security mask
</I
7994 HREF=
"#SECURITYMASK"
8003 HREF=
"#FORCESECURITYMODE"
8007 >force security mode
8015 >force directory security mode =
0</B
8020 >force directory security mode =
700</B
8027 >force group (S)
</DT
8030 >This specifies a UNIX group name that will be
8031 assigned as the default primary group for all users connecting
8032 to this service. This is useful for sharing files by ensuring
8033 that all access to files on service will use the named group for
8034 their permissions checking. Thus, by assigning permissions for this
8035 group to the files and directories within this service the Samba
8036 administrator can restrict or allow sharing of these files.
</P
8038 >In Samba
2.0.5 and above this parameter has extended
8039 functionality in the following way. If the group name listed here
8040 has a '+' character prepended to it then the current user accessing
8041 the share only has the primary group default assigned to this group
8042 if they are already assigned as a member of that group. This allows
8043 an administrator to decide that only users who are already in a
8044 particular group will create files with group ownership set to that
8045 group. This gives a finer granularity of ownership assignment. For
8046 example, the setting
<TT
8048 >force group = +sys
</TT
8050 that only users who are already in group sys will have their default
8051 primary group assigned to sys when accessing this Samba share. All
8052 other users will retain their ordinary primary group.
</P
8063 > parameter is also set the group specified in
8069 > will override the primary group
8089 >no forced group
</EM
8094 >force group = agroup
</B
8099 NAME=
"FORCESECURITYMODE"
8101 >force security mode (S)
</DT
8104 >This parameter controls what UNIX permission
8105 bits can be modified when a Windows NT client is manipulating
8106 the UNIX permission on a file using the native NT security dialog
8109 >This parameter is applied as a mask (OR'ed with) to the
8110 changed permission bits, thus forcing any bits in this mask that
8111 the user may have modified to be on. Essentially, one bits in this
8112 mask may be treated as a set of bits that, when modifying security
8113 on a file, the user has always set to be 'on'.
</P
8115 >If not set explicitly this parameter is set to
0,
8116 and allows a user to modify all the user/group/world permissions on a file,
8117 with no restrictions.
</P
8121 > that users who can access
8122 the Samba server through other means can easily bypass this restriction,
8123 so it is primarily useful for standalone
"appliance" systems.
8124 Administrators of most normal systems will probably want to leave
8125 this set to
0000.
</P
8128 HREF=
"#FORCEDIRECTORYSECURITYMODE"
8132 > force directory security mode
</I
8137 HREF=
"#DIRECTORYSECURITYMASK"
8146 HREF=
"#SECURITYMASK"
8157 >force security mode =
0</B
8162 >force security mode =
700</B
8172 >This specifies a UNIX user name that will be
8173 assigned as the default user for all users connecting to this service.
8174 This is useful for sharing files. You should also use it carefully
8175 as using it incorrectly can cause security problems.
</P
8177 >This user name only gets used once a connection is established.
8178 Thus clients still need to connect as a valid user and supply a
8179 valid password. Once connected, all file operations will be performed
8180 as the
"forced user", no matter what username the client connected
8181 as. This can be very useful.
</P
8183 >In Samba
2.0.5 and above this parameter also causes the
8184 primary group of the forced user to be used as the primary group
8185 for all file activity. Prior to
2.0.5 the primary group was left
8186 as the primary group of the connecting user (this was a bug).
</P
8205 >force user = auser
</B
8215 >This parameter allows the administrator to
8216 configure the string that specifies the type of filesystem a share
8217 is using that is reported by
<A
8225 > when a client queries the filesystem type
8226 for a share. The default type is
<TT
8230 compatibility with Windows NT but this can be changed to other
8254 >getwd cache (G)
</DT
8257 >This is a tuning option. When this is enabled a
8258 caching algorithm will be used to reduce the time taken for getwd()
8259 calls. This can have a significant impact on performance, especially
8269 >parameter is set to
<TT
8276 >getwd cache = yes
</B
8301 >guest account (S)
</DT
8304 >This is a username which will be used for access
8305 to services which are specified as
<A
8313 > (see below). Whatever privileges this
8314 user has will be available to any client connecting to the guest service.
8315 Typically this user will exist in the password file, but will not
8316 have a valid login. The user account
"ftp" is often a good choice
8317 for this parameter. If a username is specified in a given service,
8318 the specified username overrides this one.
</P
8320 >One some systems the default guest account
"nobody" may not
8321 be able to print. Use another account in this case. You should test
8322 this by trying to log in as your guest user (perhaps by using the
8326 > command) and trying to print using the
8327 system print command such as
<B
8336 >specified at compile time, usually
8342 >guest account = ftp
</B
8352 >If this parameter is
<TT
8356 a service, then no password is required to connect to the service.
8357 Privileges will be those of the
<A
8358 HREF=
"#GUESTACCOUNT"
8367 >See the section below on
<A
8375 > for more information about this option.
8390 >If this parameter is
<TT
8394 a service, then only guest connections to the service are permitted.
8395 This parameter will have no effect if
<A
8403 > is not set for the service.
</P
8405 >See the section below on
<A
8413 > for more information about this option.
8425 >hide dot files (S)
</DT
8428 >This is a boolean parameter that controls whether
8429 files starting with a dot appear as hidden files.
</P
8433 >hide dot files = yes
</B
8443 >This is a list of files or directories that are not
8444 visible but are accessible. The DOS 'hidden' attribute is applied
8445 to any files or directories that match.
</P
8447 >Each entry in the list must be separated by a '/',
8448 which allows spaces to be included in the entry. '*'
8449 and '?' can be used to specify multiple files or directories
8450 as in DOS wildcards.
</P
8452 >Each entry must be a Unix path, not a DOS path and must
8453 not include the Unix directory separator '/'.
</P
8455 >Note that the case sensitivity option is applicable
8458 >Setting this parameter will affect the performance of Samba,
8459 as it will be forced to check all files and directories for a match
8460 as they are scanned.
</P
8463 HREF=
"#HIDEDOTFILES"
8480 HREF=
"#CASESENSITIVE"
8490 >no file are hidden
</EM
8496 /.*/DesktopFolderDB/TrashFor%m/resource.frk/
</B
8499 >The above example is based on files that the Macintosh
8500 SMB client (DAVE) available from
<A
8501 HREF=
"http://www.thursby.com"
8505 > creates for internal use, and also still hides
8506 all files beginning with a dot.
</P
8510 NAME=
"HIDELOCALUSERS"
8512 >hide local users(G)
</DT
8515 >This parameter toggles the hiding of local UNIX
8516 users (root, wheel, floppy, etc) from remote clients.
</P
8520 >hide local users = no
</B
8527 >homedir map (G)
</DT
8555 > then this parameter
8556 specifies the NIS (or YP) map from which the server for the user's
8557 home directory should be extracted. At present, only the Sun
8558 auto.home map format is understood. The form of the map is:
</P
8562 >username server:/some/file/system
</B
8565 >and the program will extract the servername from before
8566 the first ':'. There should probably be a better parsing system
8567 that copes with different map formats and also Amd (another
8568 automounter) maps.
</P
8572 >A working NIS client is required on
8573 the system for this option to work.
</P
8585 HREF=
"#DOMAINLOGONS"
8597 >homedir map =
<empty string
></B
8602 >homedir map = amd.homedir
</B
8612 >This boolean parameter is only available
8613 if Samba has been configured and compiled with the
<B
8616 > option. If set to
<TT
8620 Samba will act as a Dfs server, and allow Dfs-aware clients
8621 to browse Dfs trees hosted on the server.
</P
8631 > share level parameter. For
8632 more information on setting up a Dfs tree on Samba,
8634 HREF=
"msdfs_setup.html"
8636 >msdfs_setup.html
</A
8649 >hosts allow (S)
</DT
8652 >A synonym for this parameter is
<TT
8660 >This parameter is a comma, space, or tab delimited
8661 set of hosts which are permitted to access a service.
</P
8663 >If specified in the [global] section then it will
8664 apply to all services, regardless of whether the individual
8665 service has a different setting.
</P
8667 >You can specify the hosts by name or IP number. For
8668 example, you could restrict access to only the hosts on a
8669 Class C subnet with something like
<B
8671 >allow hosts =
150.203.5.
8673 >. The full syntax of the list is described in the man
8676 >hosts_access(
5)
</TT
8677 >. Note that this man
8678 page may not be present on your system, so a brief description will
8679 be given here also.
</P
8681 >Note that the localhost address
127.0.0.1 will always
8682 be allowed access unless specifically denied by a
<A
8692 >You can also specify hosts by network/netmask pairs and
8693 by netgroup names if your system supports netgroups. The
8696 > keyword can also be used to limit a
8697 wildcard list. The following examples may provide some help:
</P
8699 >Example
1: allow all IPs in
150.203.*.*; except one
</P
8703 >hosts allow =
150.203. EXCEPT
150.203.6.66</B
8706 >Example
2: allow hosts that match the given network/netmask
</P
8710 >hosts allow =
150.203.15.0/
255.255.255.0</B
8713 >Example
3: allow a couple of hosts
</P
8717 >hosts allow = lapland, arvidsjaur
</B
8720 >Example
4: allow only hosts in NIS netgroup
"foonet", but
8721 deny access from one particular host
</P
8725 >hosts allow = @foonet
</B
8730 >hosts deny = pirate
</B
8733 >Note that access still requires suitable user-level passwords.
</P
8736 HREF=
"testparm.1.html"
8743 > for a way of testing your host access to see if it does
8747 >none (i.e., all hosts permitted access)
8753 >allow hosts =
150.203.5. myhost.mynet.edu.au
8764 >The opposite of
<TT
8770 - hosts listed here are
<EM
8772 > permitted access to
8773 services unless the specific services have their own lists to override
8774 this one. Where the lists conflict, the
<TT
8780 list takes precedence.
</P
8783 >none (i.e., no hosts specifically excluded)
8789 >hosts deny =
150.203.4. badhost.mynet.edu.au
8797 >hosts equiv (G)
</DT
8800 >If this global parameter is a non-null string,
8801 it specifies the name of a file to read for the names of hosts
8802 and users who will be allowed access without specifying a password.
8805 >This is not be confused with
<A
8813 > which is about hosts
8814 access to services and is more useful for guest services.
<TT
8819 > may be useful for NT clients which will
8820 not supply passwords to samba.
</P
8830 > can be a major security hole. This is because you are
8831 trusting the PC to supply the correct username. It is very easy to
8832 get a PC to supply a false username. I recommend that the
8838 > option be only used if you really
8839 know what you are doing, or perhaps on a home network where you trust
8840 your spouse and kids. And only if you
<EM
8846 >no host equivalences
</EM
8851 >hosts equiv = /etc/hosts.equiv
</B
8861 >This allows you to include one config file
8862 inside another. The file is included literally, as though typed
8865 >It takes the standard substitutions, except
<TT
8885 >no file included
</EM
8890 >include = /usr/local/samba/lib/admin_smb.conf
8896 NAME=
"INHERITPERMISSIONS"
8898 >inherit permissions (S)
</DT
8901 >The permissions on new files and directories
8902 are normally governed by
<A
8911 HREF=
"#DIRECTORYMASK"
8919 HREF=
"#FORCECREATEMODE"
8923 >force create mode
</I
8928 HREF=
"#FORCEDIRECTORYMODE"
8936 > but the boolean inherit
8937 permissions parameter overrides this.
</P
8939 >New directories inherit the mode of the parent directory,
8940 including bits such as setgid.
</P
8942 >New files inherit their read/write bits from the parent
8943 directory. Their execute bits continue to be determined by
8973 >Note that the setuid bit is
<EM
8976 inheritance (the code explicitly prohibits this).
</P
8978 >This can be particularly useful on large systems with
8979 many users, perhaps several thousand,to allow a single [homes]
8980 share to be used flexibly by each user.
</P
8992 HREF=
"#DIRECTORYMASK"
9000 HREF=
"#FORCECREATEMODE"
9004 >force create mode
</I
9008 HREF=
"#FORCEDIRECTORYMODE"
9012 >force directory mode
</I
9020 >inherit permissions = no
</B
9030 >This option allows you to override the default
9031 network interfaces list that Samba will use for browsing, name
9032 registration and other NBT traffic. By default Samba will query
9033 the kernel for the list of all active interfaces and use any
9034 interfaces except
127.0.0.1 that are broadcast capable.
</P
9036 >The option takes a list of interface strings. Each string
9037 can be in any of the following forms:
</P
9043 >a network interface name (such as eth0).
9044 This may include shell-like wildcards so eth* will match
9045 any interface starting with the substring
"eth"</P
9049 >an IP address. In this case the netmask is
9050 determined from the list of interfaces obtained from the
9055 >an IP/mask pair.
</P
9059 >a broadcast/mask pair.
</P
9063 >The
"mask" parameters can either be a bit length (such
9064 as
24 for a C class network) or a full netmask in dotted
9067 >The
"IP" parameters above can either be a full dotted
9068 decimal IP address or a hostname which will be looked up via
9069 the OS's normal hostname resolution mechanisms.
</P
9071 >For example, the following line:
</P
9075 >interfaces = eth0
192.168.2.10/
24 192.168.3.10/
255.255.255.0
9079 >would configure three network interfaces corresponding
9080 to the eth0 device and IP addresses
192.168.2.10 and
192.168.3.10.
9081 The netmasks of the latter two interfaces would be set to
255.255.255.0.
</P
9084 HREF=
"#BINDINTERFACESONLY"
9095 >all active interfaces except
127.0.0.1
9096 that are broadcast capable
</EM
9103 >invalid users (S)
</DT
9106 >This is a list of users that should not be allowed
9107 to login to this service. This is really a
<EM
9110 check to absolutely ensure an improper setting does not breach
9113 >A name starting with a '@' is interpreted as an NIS
9114 netgroup first (if your system supports NIS), and then as a UNIX
9115 group if the name was not found in the NIS netgroup database.
</P
9117 >A name starting with '+' is interpreted only
9118 by looking in the UNIX group database. A name starting with
9119 '
&' is interpreted only by looking in the NIS netgroup database
9120 (this requires NIS to be working on your system). The characters
9121 '+' and '
&' may be used at the start of the name in either order
9128 UNIX group database, followed by the NIS netgroup database, and
9134 > means check the NIS
9135 netgroup database, followed by the UNIX group database (the
9136 same as the '@' prefix).</P
9138 >The current servicename is substituted for <TT
9144 This is useful in the [homes] section.</P
9158 >no invalid users</EM
9163 >invalid users = root fred admin @wheel
9174 >The value of the parameter (an integer) represents
9175 the number of seconds between <TT
9181 packets. If this parameter is zero, no keepalive packets will be
9182 sent. Keepalive packets, if sent, allow the server to tell whether
9183 a client is still present and responding.</P
9185 >Keepalives should, in general, not be needed if the socket
9186 being used has the SO_KEEPALIVE attribute set on it (see <A
9187 HREF="#SOCKETOPTIONS
"
9195 Basically you should only use this option if you strike difficulties.</P
9209 NAME="KERNELOPLOCKS
"
9211 >kernel oplocks (G)</DT
9214 >For UNIXes that support kernel based <A
9223 (currently only IRIX and the Linux 2.4 kernel), this parameter
9224 allows the use of them to be turned on or off.</P
9226 >Kernel oplocks support allows Samba <TT
9232 > to be broken whenever a local UNIX process or NFS operation
9233 accesses a file that <A
9241 > has oplocked. This allows complete data consistency between
9242 SMB/CIFS, NFS and local file access (and is a <EM
9245 cool feature :-).</P
9247 >This parameter defaults to <TT
9251 that have the support, and <TT
9255 don't. You should never need to touch this parameter.</P
9267 HREF="#LEVEL2OPLOCKS
"
9279 >kernel oplocks = yes</B
9286 >lanman auth (G)</DT
9289 >This parameter determines whether or not smbd will
9290 attempt to authentication users using the LANMAN password hash.
9291 If disabled, only clients which support NT password hashes (e.g. Windows
9292 NT/2000 clients, smbclient, etc... but not Windows 95/98 or the MS DOS
9293 network client) will be able to connect to the Samba host.</P
9297 >lanman auth = yes</B
9302 NAME="LEVEL2OPLOCKS
"
9304 >level2 oplocks (S)</DT
9307 >This parameter controls whether Samba supports
9308 level2 (read-only) oplocks on a share.</P
9310 >Level2, or read-only oplocks allow Windows NT clients
9311 that have an oplock on a file to downgrade from a read-write oplock
9312 to a read-only oplock once a second client opens the file (instead
9313 of releasing all oplocks on a second open, as in traditional,
9314 exclusive oplocks). This allows all openers of the file that
9315 support level2 oplocks to cache the file for read-ahead only (ie.
9316 they may not cache writes or lock requests) and increases performance
9317 for many accesses of files that are not commonly written (such as
9318 application .EXE files).</P
9320 >Once one of the clients which have a read-only oplock
9321 writes to the file all clients are notified (no reply is needed
9322 or waited for) and told to break their oplocks to "none
" and
9323 delete any read-ahead caches.</P
9325 >It is recommended that this parameter be turned on
9326 to speed access to shared executables.</P
9328 >For more discussions on level2 oplocks see the CIFS spec.</P
9331 HREF="#KERNELOPLOCKS
"
9339 > are supported then level2 oplocks are
9340 not granted (even if this parameter is set to <TT
9353 > parameter must be set to "true
" on this share in order for
9354 this parameter to have any effect.</P
9378 >level2 oplocks = yes</B
9385 >lm announce (G)</DT
9388 >This parameter determines if <A
9395 > will produce Lanman announce
9396 broadcasts that are needed by OS/2 clients in order for them to see
9397 the Samba server in their browse list. This parameter can have three
9408 >. The default is <TT
9415 > Samba will never produce these
9416 broadcasts. If set to <TT
9419 > Samba will produce
9420 Lanman announce broadcasts at a frequency set by the parameter
9430 Samba will not send Lanman announce broadcasts by default but will
9431 listen for them. If it hears such a broadcast on the wire it will
9432 then start sending them at a frequency set by the parameter
9453 >lm announce = auto</B
9458 >lm announce = yes</B
9465 >lm interval (G)</DT
9468 >If Samba is set to produce Lanman announce
9469 broadcasts needed by OS/2 clients (see the <A
9477 > parameter) then this
9478 parameter defines the frequency in seconds with which they will be
9479 made. If this is set to zero then no Lanman announcements will be
9480 made despite the setting of the <TT
9501 >lm interval = 60</B
9506 >lm interval = 120</B
9513 >load printers (G)</DT
9516 >A boolean variable that controls whether all
9517 printers in the printcap will be loaded for browsing by default.
9526 >load printers = yes</B
9533 >local master (G)</DT
9536 >This option allows <A
9543 > to try and become a local master browser
9544 on a subnet. If set to <TT
9550 > will not attempt to become a local master browser
9551 on a subnet and will also lose in all browsing elections. By
9552 default this value is set to true. Setting this value to true doesn't
9553 mean that Samba will <EM
9556 browser on a subnet, just that <B
9561 > in elections for local master browser.</P
9563 >Setting this value to False will cause <B
9569 > to become a local master browser.</P
9573 >local master = yes</B
9584 HREF="#LOCKDIRECTORY
"
9595 NAME="LOCKDIRECTORY
"
9597 >lock directory (G)</DT
9600 >This option specifies the directory where lock
9601 files will be placed. The lock files are used to implement the
9603 HREF="#MAXCONNECTIONS
"
9615 >lock directory = ${prefix}/var/locks</B
9620 >lock directory = /var/run/samba/locks</B
9631 >This controls whether or not locking will be
9632 performed by the server in response to lock requests from the
9638 >, all lock and unlock
9639 requests will appear to succeed and all lock queries will report
9640 that the file in question is available for locking.</P
9645 >, real locking will be performed
9650 > be useful for read-only
9651 filesystems which <EM
9653 > not need locking (such as
9654 cdrom drives), although setting this parameter of <TT
9658 is not really recommended even in this case.</P
9660 >Be careful about disabling locking either globally or in a
9661 specific service, as lack of locking may result in data corruption.
9662 You should never need to set this parameter.</P
9676 >This option allows you to override the name
9677 of the Samba log file (also known as the debug file).</P
9679 >This option takes the standard substitutions, allowing
9680 you to have separate log files for each user or machine.</P
9684 >log file = /usr/local/samba/var/log.%m
9695 >The value of the parameter (an integer) allows
9696 the debug level (logging level) to be specified in the
9700 > file. This is to give greater
9701 flexibility in the configuration of the system.</P
9703 >The default will be the log level specified on
9704 the command line or level zero if none was specified.</P
9715 >logon drive (G)</DT
9718 >This parameter specifies the local path to
9719 which the home directory will be connected (see <A
9728 and is only used by NT Workstations. </P
9730 >Note that this option is only useful if Samba is set up as a
9735 >logon drive = z:</B
9740 >logon drive = h:</B
9750 >This parameter specifies the home directory
9751 location when a Win95/98 or NT Workstation logs into a Samba PDC.
9752 It allows you to do </P
9760 >NET USE H: /HOME</B
9765 >from a command prompt, for example.</P
9767 >This option takes the standard substitutions, allowing
9768 you to have separate logon scripts for each user or machine.</P
9770 >This parameter can be used with Win9X workstations to ensure
9771 that roaming profiles are stored in a subdirectory of the user's
9772 home directory. This is done in the following way:</P
9776 >logon home = \\%N\%U\profile</B
9779 >This tells Samba to return the above string, with
9780 substitutions made when a client requests the info, generally
9781 in a NetUserGetInfo request. Win9X clients truncate the info to
9782 \\server\share when a user does <B
9786 but use the whole string when dealing with profiles.
</P
9788 >Note that in prior versions of Samba, the
<A
9796 > was returned rather than
9806 > but allowed profiles outside the home directory.
9807 The current implementation is correct, and can be used for
9808 profiles if you use the above trick.
</P
9810 >This option is only useful if Samba is set up as a logon
9815 >logon home =
"\\%N\%U"</B
9820 >logon home =
"\\remote_smb_server\%U"</B
9831 >This parameter specifies the home directory
9832 where roaming profiles (NTuser.dat etc files for Windows NT) are
9833 stored. Contrary to previous versions of these manual pages, it has
9834 nothing to do with Win
9X roaming profiles. To find out how to
9835 handle roaming profiles for Win
9X system, see the
<A
9845 >This option takes the standard substitutions, allowing you
9846 to have separate logon scripts for each user or machine. It also
9847 specifies the directory from which the
"Application Data",
9857 >network neighborhood
</TT
9862 and other folders, and their contents, are loaded and displayed on
9863 your Windows NT client.
</P
9865 >The share and the path must be readable by the user for
9866 the preferences and directories to be loaded onto the Windows NT
9867 client. The share must be writeable when the logs in for the first
9868 time, in order that the Windows NT client can create the NTuser.dat
9869 and other directories.
</P
9871 >Thereafter, the directories and any of the contents can,
9872 if required, be made read-only. It is not advisable that the
9873 NTuser.dat file be made read-only - rename it to NTuser.man to
9874 achieve the desired effect (a
<EM
9879 >Windows clients can sometimes maintain a connection to
9880 the [homes] share, even though there is no user logged in.
9881 Therefore, it is vital that the logon path does not include a
9882 reference to the homes share (i.e. setting this parameter to
9883 \%N\%U\profile_path will cause problems).
</P
9885 >This option takes the standard substitutions, allowing
9886 you to have separate logon scripts for each user or machine.
</P
9888 >Note that this option is only useful if Samba is set up
9889 as a logon server.
</P
9893 >logon path = \\%N\%U\profile
</B
9898 >logon path = \\PROFILESERVER\PROFILE\%U
</B
9905 >logon script (G)
</DT
9908 >This parameter specifies the batch file (.bat) or
9909 NT command file (.cmd) to be downloaded and run on a machine when
9910 a user successfully logs in. The file must contain the DOS
9911 style cr/lf line endings. Using a DOS-style editor to create the
9912 file is recommended.
</P
9914 >The script must be a relative path to the [netlogon]
9915 service. If the [netlogon] service specifies a
<A
9925 >/usr/local/samba/netlogon
9929 >logon script = STARTUP.BAT
</B
9931 the file that will be downloaded is:
</P
9935 >/usr/local/samba/netlogon/STARTUP.BAT
</TT
9938 >The contents of the batch file is entirely your choice. A
9939 suggested command would be to add
<B
9941 >NET TIME \\SERVER /SET
9943 >, to force every machine to synchronize clocks with
9944 the same time server. Another use would be to add
<B
9947 U: \\SERVER\UTILS
</B
9948 > for commonly used utilities, or
<B
9950 > NET USE Q: \\SERVER\ISO9001_QA
</B
9953 >Note that it is particularly important not to allow write
9954 access to the [netlogon] share, or to grant users write permission
9955 on the batch files in a secure environment, as this would allow
9956 the batch files to be arbitrarily modified and security to be
9959 >This option takes the standard substitutions, allowing you
9960 to have separate logon scripts for each user or machine.
</P
9962 >This option is only useful if Samba is set up as a logon
9966 >no logon script defined
</EM
9971 >logon script = scripts\%U.bat
</B
9976 NAME=
"LPPAUSECOMMAND"
9978 >lppause command (S)
</DT
9981 >This parameter specifies the command to be
9982 executed on the server host in order to stop printing or spooling
9983 a specific print job.
</P
9985 >This command should be a program or script which takes
9986 a printer name and job number to pause the print job. One way
9987 of implementing this is by using job priorities, where jobs
9988 having a too low priority won't be sent to the printer.
</P
9995 > is given then the printername
9996 is put in its place. A
<TT
10002 the job number (an integer). On HPUX (see
<TT
10014 to the lpq command, the job will show up with the correct status, i.e.
10015 if the job priority is lower than the set fence priority it will
10016 have the PAUSED status, whereas if the priority is equal or higher it
10017 will have the SPOOLED or PRINTING status.
</P
10019 >Note that it is good practice to include the absolute path
10020 in the lppause command as the PATH may not be available to the server.
</P
10033 >Default: Currently no default value is given to
10034 this string, unless the value of the
<TT
10043 >, in which case the default is :
</P
10047 >lp -i %p-%j -H hold
</B
10050 >or if the value of the
<TT
10059 >, then the default is:
</P
10063 >qstat -s -j%j -h
</B
10066 >Example for HPUX:
<B
10068 >lppause command = /usr/bin/lpalt
10074 NAME=
"LPQCACHETIME"
10076 >lpq cache time (G)
</DT
10079 >This controls how long lpq info will be cached
10080 for to prevent the
<B
10083 > command being called too
10084 often. A separate cache is kept for each variation of the
<B
10087 > command used by the system, so if you use different
10091 > commands for different users then they won't
10092 share cache information.
</P
10094 >The cache files are stored in
<TT
10098 where xxxx is a hash of the
<B
10101 > command in use.
</P
10103 >The default is
10 seconds, meaning that the cached results
10104 of a previous identical
<B
10107 > command will be used
10108 if the cached data is less than
10 seconds old. A large value may
10109 be advisable if your
<B
10112 > command is very slow.
</P
10114 >A value of
0 will disable caching completely.
</P
10129 >lpq cache time =
10</B
10134 >lpq cache time =
30</B
10141 >lpq command (S)
</DT
10144 >This parameter specifies the command to be
10145 executed on the server host in order to obtain
<B
10149 >-style printer status information.
</P
10151 >This command should be a program or script which
10152 takes a printer name as its only parameter and outputs printer
10153 status information.
</P
10155 >Currently eight styles of printer status information
10156 are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX and SOFTQ.
10157 This covers most UNIX systems. You control which type is expected
10165 >Some clients (notably Windows for Workgroups) may not
10166 correctly send the connection number for the printer they are
10167 requesting status information about. To get around this, the
10168 server reports on the first printer service connected to by the
10169 client. This only happens if the connection number sent is invalid.
</P
10176 > is given then the printername
10177 is put in its place. Otherwise it is placed at the end of the
10180 >Note that it is good practice to include the absolute path
10190 > may not be available to the server.
</P
10204 >depends on the setting of
<TT
10214 >lpq command = /usr/bin/lpq -P%p
</B
10219 NAME=
"LPRESUMECOMMAND"
10221 >lpresume command (S)
</DT
10224 >This parameter specifies the command to be
10225 executed on the server host in order to restart or continue
10226 printing or spooling a specific print job.
</P
10228 >This command should be a program or script which takes
10229 a printer name and job number to resume the print job. See
10231 HREF=
"#LPPAUSECOMMAND"
10246 > is given then the printername
10247 is put in its place. A
<TT
10253 the job number (an integer).
</P
10255 >Note that it is good practice to include the absolute path
10259 >lpresume command
</I
10261 > as the PATH may not
10262 be available to the server.
</P
10275 >Default: Currently no default value is given
10276 to this string, unless the value of the
<TT
10285 >, in which case the default is :
</P
10289 >lp -i %p-%j -H resume
</B
10292 >or if the value of the
<TT
10301 >, then the default is:
</P
10305 >qstat -s -j%j -r
</B
10308 >Example for HPUX:
<B
10310 >lpresume command = /usr/bin/lpalt
10318 >lprm command (S)
</DT
10321 >This parameter specifies the command to be
10322 executed on the server host in order to delete a print job.
</P
10324 >This command should be a program or script which takes
10325 a printer name and job number, and deletes the print job.
</P
10332 > is given then the printername
10333 is put in its place. A
<TT
10339 the job number (an integer).
</P
10341 >Note that it is good practice to include the absolute
10347 > as the PATH may not be
10348 available to the server.
</P
10362 >depends on the setting of
<TT
10373 >lprm command = /usr/bin/lprm -P%p %j
10379 >lprm command = /usr/bin/cancel %p-%j
10385 NAME=
"MACHINEPASSWORDTIMEOUT"
10387 >machine password timeout (G)
</DT
10390 >If a Samba server is a member of an Windows
10391 NT Domain (see the
<A
10392 HREF=
"#SECURITYEQUALSDOMAIN"
10393 >security=domain
</A
10395 parameter) then periodically a running
<A
10399 > process will try and change the MACHINE ACCOUNT
10400 PASSWORD stored in the TDB called
<TT
10402 >private/secrets.tdb
10404 >. This parameter specifies how often this password
10405 will be changed, in seconds. The default is one week (expressed in
10406 seconds), the same as a Windows NT Domain member server.
</P
10409 HREF=
"smbpasswd.8.html"
10417 HREF=
"#SECURITYEQUALSDOMAIN"
10418 > security=domain
</A
10423 >machine password timeout =
604800</B
10430 >magic output (S)
</DT
10433 >This parameter specifies the name of a file
10434 which will contain output created by a magic script (see the
10436 HREF=
"#MAGICSCRIPT"
10444 parameter below).
</P
10446 >Warning: If two clients use the same
<TT
10452 > in the same directory the output file content
10457 >magic output =
<magic script name
>.out
10463 >magic output = myfile.txt
</B
10470 >magic script (S)
</DT
10473 >This parameter specifies the name of a file which,
10474 if opened, will be executed by the server when the file is closed.
10475 This allows a UNIX script to be sent to the Samba host and
10476 executed on behalf of the connected user.
</P
10478 >Scripts executed in this way will be deleted upon
10479 completion assuming that the user has the appripriate level
10480 of priviledge and the ile permissions allow the deletion.
</P
10482 >If the script generates output, output will be sent to
10483 the file specified by the
<A
10484 HREF=
"#MAGICOUTPUT"
10491 > parameter (see above).
</P
10493 >Note that some shells are unable to interpret scripts
10494 containing CR/LF instead of CR as
10495 the end-of-line marker. Magic scripts must be executable
10498 > on the host, which for some hosts and
10499 some shells will require filtering at the DOS end.
</P
10501 >Magic scripts are
<EM
10506 > be relied upon.
</P
10509 >None. Magic scripts disabled.
</EM
10514 >magic script = user.csh
</B
10521 >mangle case (S)
</DT
10524 >See the section on
<A
10531 >mangle case = no
</B
10538 >mangled map (S)
</DT
10541 >This is for those who want to directly map UNIX
10542 file names which can not be represented on Windows/DOS. The mangling
10543 of names is not always what is needed. In particular you may have
10544 documents with file extensions that differ between DOS and UNIX.
10545 For example, under UNIX it is common to use
<TT
10549 for HTML files, whereas under Windows/DOS
<TT
10553 is more commonly used.
</P
10566 >mangled map = (*.html *.htm)
</B
10569 >One very useful case is to remove the annoying
<TT
10573 > off the ends of filenames on some CDROMS (only visible
10574 under some UNIXes). To do this use a map of (*;
1 *;).
</P
10577 >no mangled map
</EM
10582 >mangled map = (*;
1 *;)
</B
10587 NAME=
"MANGLEDNAMES"
10589 >mangled names (S)
</DT
10592 >This controls whether non-DOS names under UNIX
10593 should be mapped to DOS-compatible names (
"mangled") and made visible,
10594 or whether non-DOS names should simply be ignored.
</P
10596 >See the section on
<A
10599 > for details on how to control the mangling process.
</P
10601 >If mangling is used then the mangling algorithm is as follows:
</P
10607 >The first (up to) five alphanumeric characters
10608 before the rightmost dot of the filename are preserved, forced
10609 to upper case, and appear as the first (up to) five characters
10610 of the mangled name.
</P
10614 >A tilde
"~" is appended to the first part of the mangled
10615 name, followed by a two-character unique sequence, based on the
10616 original root name (i.e., the original filename minus its final
10617 extension). The final extension is included in the hash calculation
10618 only if it contains any upper case characters or is longer than three
10621 >Note that the character to use may be specified using
10623 HREF=
"#MANGLINGCHAR"
10631 > option, if you don't like '~'.
</P
10635 >The first three alphanumeric characters of the final
10636 extension are preserved, forced to upper case and appear as the
10637 extension of the mangled name. The final extension is defined as that
10638 part of the original filename after the rightmost dot. If there are no
10639 dots in the filename, the mangled name will have no extension (except
10640 in the case of
"hidden files" - see below).
</P
10644 >Files whose UNIX name begins with a dot will be
10645 presented as DOS hidden files. The mangled name will be created as
10646 for other filenames, but with the leading dot removed and
"___" as
10647 its extension regardless of actual original extension (that's three
10652 >The two-digit hash value consists of upper case
10653 alphanumeric characters.
</P
10655 >This algorithm can cause name collisions only if files
10656 in a directory share the same first five alphanumeric characters.
10657 The probability of such a clash is
1/
1300.
</P
10659 >The name mangling (if enabled) allows a file to be
10660 copied between UNIX directories from Windows/DOS while retaining
10661 the long UNIX filename. UNIX files can be renamed to a new extension
10662 from Windows/DOS and will retain the same basename. Mangled names
10663 do not change between sessions.
</P
10667 >mangled names = yes
</B
10672 NAME=
"MANGLEDSTACK"
10674 >mangled stack (G)
</DT
10677 >This parameter controls the number of mangled names
10678 that should be cached in the Samba server
<A
10684 >This stack is a list of recently mangled base names
10685 (extensions are only maintained if they are longer than
3 characters
10686 or contains upper case characters).
</P
10688 >The larger this value, the more likely it is that mangled
10689 names can be successfully converted to correct long UNIX names.
10690 However, large stack sizes will slow most directory access. Smaller
10691 stacks save memory in the server (each stack element costs
256 bytes).
10694 >It is not possible to absolutely guarantee correct long
10695 file names, so be prepared for some surprises!
</P
10699 >mangled stack =
50</B
10704 >mangled stack =
100</B
10709 NAME=
"MANGLINGCHAR"
10711 >mangling char (S)
</DT
10714 >This controls what character is used as
10720 >. The default is a '~'
10721 but this may interfere with some software. Use this option to set
10722 it to whatever you prefer.
</P
10726 >mangling char = ~
</B
10731 >mangling char = ^
</B
10738 >map archive (S)
</DT
10741 >This controls whether the DOS archive attribute
10742 should be mapped to the UNIX owner execute bit. The DOS archive bit
10743 is set when a file has been modified since its last backup. One
10744 motivation for this option it to keep Samba/your PC from making
10745 any file it touches from becoming executable under UNIX. This can
10746 be quite annoying for shared source code, documents, etc...
</P
10748 >Note that this requires the
<TT
10754 parameter to be set such that owner execute bit is not masked out
10755 (i.e. it must include
100). See the parameter
<A
10767 >map archive = yes
</B
10774 >map hidden (S)
</DT
10777 >This controls whether DOS style hidden files
10778 should be mapped to the UNIX world execute bit.
</P
10780 >Note that this requires the
<TT
10786 to be set such that the world execute bit is not masked out (i.e.
10787 it must include
001). See the parameter
<A
10799 >map hidden = no
</B
10806 >map system (S)
</DT
10809 >This controls whether DOS style system files
10810 should be mapped to the UNIX group execute bit.
</P
10812 >Note that this requires the
<TT
10818 to be set such that the group execute bit is not masked out (i.e.
10819 it must include
010). See the parameter
<A
10831 >map system = no
</B
10838 >map to guest (G)
</DT
10841 >This parameter is only useful in
<A
10844 > modes other than
<TT
10862 >This parameter can take three different values, which tell
10867 > what to do with user
10868 login requests that don't match a valid UNIX user in some way.
</P
10870 >The three settings are :
</P
10879 > - Means user login
10880 requests with an invalid password are rejected. This is the
10889 logins with an invalid password are rejected, unless the username
10890 does not exist, in which case it is treated as a guest login and
10892 HREF=
"#GUESTACCOUNT"
10906 > - Means user logins
10907 with an invalid password are treated as a guest login and mapped
10909 HREF=
"#GUESTACCOUNT"
10912 this can cause problems as it means that any user incorrectly typing
10913 their password will be silently logged on as
"guest" - and
10914 will not know the reason they cannot access files they think
10915 they should - there will have been no message given to them
10916 that they got their password wrong. Helpdesk services will
10919 > you if you set the
<TT
10925 > parameter this way :-).
</P
10929 >Note that this parameter is needed to set up
"Guest"
10930 share services when using
<TT
10936 share. This is because in these modes the name of the resource being
10939 > sent to the server until after
10940 the server has successfully authenticated the client so the server
10941 cannot make authentication decisions at the correct time (connection
10942 to the share) for
"Guest" shares.
</P
10944 >For people familiar with the older Samba releases, this
10945 parameter maps to the old compile-time setting of the
<TT
10947 > GUEST_SESSSETUP
</TT
10948 > value in local.h.
</P
10952 >map to guest = Never
</B
10957 >map to guest = Bad User
</B
10962 NAME=
"MAXCONNECTIONS"
10964 >max connections (S)
</DT
10967 >This option allows the number of simultaneous
10968 connections to a service to be limited. If
<TT
10974 > is greater than
0 then connections will be refused if
10975 this number of connections to the service are already open. A value
10976 of zero mean an unlimited number of connections may be made.
</P
10978 >Record lock files are used to implement this feature. The
10979 lock files will be stored in the directory specified by the
<A
10980 HREF=
"#LOCKDIRECTORY"
10992 >max connections =
0</B
10997 >max connections =
10</B
11004 >max disk size (G)
</DT
11007 >This option allows you to put an upper limit
11008 on the apparent size of disks. If you set this option to
100
11009 then all shares will appear to be not larger than
100 MB in
11012 >Note that this option does not limit the amount of
11013 data you can put on the disk. In the above case you could still
11014 store much more than
100 MB on the disk, but if a client ever asks
11015 for the amount of free disk space or the total disk size then the
11016 result will be bounded by the amount specified in
<TT
11024 >This option is primarily useful to work around bugs
11025 in some pieces of software that can't handle very large disks,
11026 particularly disks over
1GB in size.
</P
11033 > of
0 means no limit.
</P
11037 >max disk size =
0</B
11042 >max disk size =
1000</B
11049 >max log size (G)
</DT
11052 >This option (an integer in kilobytes) specifies
11053 the max size the log file should grow to. Samba periodically checks
11054 the size and if it is exceeded it will rename the file, adding
11060 >A size of
0 means no limit.
</P
11064 >max log size =
5000</B
11069 >max log size =
1000</B
11079 >This option controls the maximum number of
11080 outstanding simultaneous SMB operations that samba tells the client
11081 it will allow. You should never need to set this parameter.
</P
11090 NAME=
"MAXOPENFILES"
11092 >max open files (G)
</DT
11095 >This parameter limits the maximum number of
11096 open files that one
<A
11101 serving process may have open for a client at any one time. The
11102 default for this parameter is set very high (
10,
000) as Samba uses
11103 only one bit per unopened file.
</P
11105 >The limit of the number of open files is usually set
11106 by the UNIX per-process file descriptor limit rather than
11107 this parameter so you should never need to touch this parameter.
</P
11111 >max open files =
10000</B
11116 NAME=
"MAXPRINTJOBS"
11118 >max print jobs (S)
</DT
11121 >This parameter limits the maximum number of
11122 jobs allowable in a Samba printer queue at any given moment.
11123 If this number is exceeded,
<A
11130 > will remote
"Out of Space" to the client.
11132 HREF=
"#TOTALPRINTJOBS"
11145 >max print jobs =
1000</B
11150 >max print jobs =
5000</B
11157 >max protocol (G)
</DT
11160 >The value of the parameter (a string) is the highest
11161 protocol level that will be supported by the server.
</P
11163 >Possible values are :
</P
11172 >: Earliest version. No
11173 concept of user names.
</P
11180 >: Slight improvements on
11181 CORE for efficiency.
</P
11190 > version of the protocol. Long filename
11198 >: Updates to Lanman1 protocol.
11206 >: Current up to date version of
11207 the protocol. Used by Windows NT. Known as CIFS.
</P
11211 >Normally this option should not be set as the automatic
11212 negotiation phase in the SMB protocol takes care of choosing
11213 the appropriate protocol.
</P
11216 HREF=
"#MINPROTOCOL"
11228 >max protocol = NT1
</B
11233 >max protocol = LANMAN1
</B
11238 NAME=
"MAXSMBDPROCESSES"
11240 >max smbd processes (G)
</DT
11243 >This parameter limits the maximum number of
11252 processes concurrently running on a system and is intended
11253 as a stop gap to prevent degrading service to clients in the event
11254 that the server has insufficient resources to handle more than this
11255 number of connections. Remember that under normal operating
11256 conditions, each user will have an smbd associated with him or her
11257 to handle connections to all shares from a given host.
11262 >max smbd processes =
0</B
11267 >max smbd processes =
1000</B
11277 >This option tells
<A
11282 what the default 'time to live' of NetBIOS names should be (in seconds)
11286 > is requesting a name using either a
11287 broadcast packet or from a WINS server. You should never need to
11288 change this parameter. The default is
3 days.
</P
11292 >max ttl =
259200</B
11299 >max wins ttl (G)
</DT
11302 >This option tells
<A
11307 > when acting as a WINS server (
<A
11308 HREF=
"#WINSSUPPORT"
11312 >wins support=yes
</I
11315 >) what the maximum
11316 'time to live' of NetBIOS names that
<B
11320 will grant will be (in seconds). You should never need to change this
11321 parameter. The default is
6 days (
518400 seconds).
</P
11336 >max wins ttl = 518400</B
11346 >This option controls the maximum packet size
11347 that will be negotiated by Samba. The default is 65535, which
11348 is the maximum. In some cases you may find you get better performance
11349 with a smaller value. A value below 2048 is likely to cause problems.
11354 >max xmit = 65535</B
11359 >max xmit = 8192</B
11364 NAME="MESSAGECOMMAND
"
11366 >message command (G)</DT
11369 >This specifies what command to run when the
11370 server receives a WinPopup style message.</P
11372 >This would normally be a command that would
11373 deliver the message somehow. How this is to be done is
11374 up to your imagination.</P
11380 >message command = csh -c 'xedit %s;rm %s' &</B
11384 >This delivers the message using <B
11388 removes it afterwards. <EM
11389 >NOTE THAT IT IS VERY IMPORTANT
11390 THAT THIS COMMAND RETURN IMMEDIATELY</EM
11392 have the '&' on the end. If it doesn't return immediately then
11393 your PCs may freeze when sending messages (they should recover
11394 after 30secs, hopefully).</P
11396 >All messages are delivered as the global guest user.
11397 The command takes the standard substitutions, although <TT
11410 >Apart from the standard substitutions, some additional
11411 ones apply. In particular:</P
11422 > = the filename containing
11432 > = the destination that
11433 the message was sent to (probably the server name).</P
11442 > = who the message
11447 >You could make this command send mail, or whatever else
11448 takes your fancy. Please let us know of any really interesting
11451 >Here's a way of sending the messages as mail to root:</P
11455 >message command = /bin/mail -s 'message from %f on
11456 %m' root < %s; rm %s</B
11459 >If you don't have a message command then the message
11460 won't be delivered and Samba will tell the sender there was
11461 an error. Unfortunately WfWg totally ignores the error code
11462 and carries on regardless, saying that the message was delivered.
11465 >If you want to silently delete it then try:</P
11469 >message command = rm %s</B
11473 >no message command</EM
11478 >message command = csh -c 'xedit %s;
11484 NAME="MINPASSWDLENGTH
"
11486 >min passwd length (G)</DT
11490 HREF="#MINPASSWORDLENGTH
"
11494 >min password length</I
11501 NAME="MINPASSWORDLENGTH
"
11503 >min password length (G)</DT
11506 >This option sets the minimum length in characters
11507 of a plaintext password that <B
11510 > will accept when performing
11511 UNIX password changing.</P
11514 HREF="#UNIXPASSWORDSYNC
"
11523 HREF="#PASSWDPROGRAM
"
11531 HREF="#PASSWDCHATDEBUG
"
11535 >passwd chat debug</I
11543 >min password length = 5</B
11548 NAME="MINPRINTSPACE
"
11550 >min print space (S)</DT
11553 >This sets the minimum amount of free disk
11554 space that must be available before a user will be able to spool
11555 a print job. It is specified in kilobytes. The default is 0, which
11556 means a user can always spool a print job.</P
11571 >min print space = 0</B
11576 >min print space = 2000</B
11583 >min protocol (G)</DT
11586 >The value of the parameter (a string) is the
11587 lowest SMB protocol dialect than Samba will support. Please refer
11589 HREF="#MAXPROTOCOL
"
11597 parameter for a list of valid protocol names and a brief description
11598 of each. You may also wish to refer to the C source code in
11601 >source/smbd/negprot.c</TT
11602 > for a listing of known protocol
11603 dialects supported by clients.</P
11605 >If you are viewing this parameter as a security measure, you should
11606 also refer to the <A
11615 > parameter. Otherwise, you should never need
11616 to change this parameter.</P
11620 >min protocol = CORE</B
11625 >min protocol = NT1</B
11633 >min wins ttl (G)</DT
11636 >This option tells <A
11641 when acting as a WINS server (<A
11642 HREF="#WINSSUPPORT
"
11646 > wins support = yes</I
11649 >) what the minimum 'time to live'
11650 of NetBIOS names that <B
11653 > will grant will be (in
11654 seconds). You should never need to change this parameter. The default
11655 is 6 hours (21600 seconds).</P
11659 >min wins ttl = 21600</B
11666 >msdfs root (S)</DT
11669 >This boolean parameter is only available if
11670 Samba is configured and compiled with the <B
11673 > option. If set to <TT
11677 Samba treats the share as a Dfs root and allows clients to browse
11678 the distributed file system tree rooted at the share directory.
11679 Dfs links are specified in the share directory by symbolic
11680 links of the form <TT
11682 >msdfs:serverA\shareA,serverB\shareB
11684 > and so on. For more information on setting up a Dfs tree
11685 on Samba, refer to <A
11686 HREF="msdfs_setup.html
"
11705 >msdfs root = no</B
11710 NAME="NAMERESOLVEORDER
"
11712 >name resolve order (G)</DT
11715 >This option is used by the programs in the Samba
11716 suite to determine what naming services to use and in what order
11717 to resolve host names to IP addresses. The option takes a space
11718 separated string of name resolution options.</P
11720 >The options are :"lmhosts
", "host
", "wins
" and "bcast
". They
11721 cause names to be resolved as follows :</P
11731 address in the Samba lmhosts file. If the line in lmhosts has
11732 no name type attached to the NetBIOS name (see the <A
11733 HREF="lmhosts
.5.html
"
11736 > for details) then
11737 any name type matches for lookup.</P
11744 > : Do a standard host
11745 name to IP address resolution, using the system <TT
11749 >, NIS, or DNS lookups. This method of name resolution
11750 is operating system depended for instance on IRIX or Solaris this
11751 may be controlled by the <TT
11753 >/etc/nsswitch.conf</TT
11755 file). Note that this method is only used if the NetBIOS name
11756 type being queried is the 0x20 (server) name type, otherwise
11764 > : Query a name with
11765 the IP address listed in the <A
11773 > parameter. If no WINS server has
11774 been specified this method will be ignored.</P
11781 > : Do a broadcast on
11782 each of the known local interfaces listed in the <A
11791 parameter. This is the least reliable of the name resolution
11792 methods as it depends on the target host being on a locally
11793 connected subnet.</P
11799 >name resolve order = lmhosts host wins bcast
11805 >name resolve order = lmhosts bcast host
11809 >This will cause the local lmhosts file to be examined
11810 first, followed by a broadcast attempt, followed by a normal
11811 system hostname lookup.</P
11815 NAME="NETBIOSALIASES
"
11817 >netbios aliases (G)</DT
11820 >This is a list of NetBIOS names that <A
11824 > will advertise as additional
11825 names by which the Samba server is known. This allows one machine
11826 to appear in browse lists under multiple names. If a machine is
11827 acting as a browse server or logon server none
11828 of these names will be advertised as either browse server or logon
11829 servers, only the primary name of the machine will be advertised
11830 with these capabilities.</P
11833 HREF="#NETBIOSNAME
"
11844 >empty string (no additional names)</EM
11849 >netbios aliases = TEST TEST1 TEST2</B
11856 >netbios name (G)</DT
11859 >This sets the NetBIOS name by which a Samba
11860 server is known. By default it is the same as the first component
11861 of the host's DNS name. If a machine is a browse server or
11862 logon server this name (or the first component
11863 of the hosts DNS name) will be the name that these services are
11864 advertised under.</P
11867 HREF="#NETBIOSALIASES
"
11878 >machine DNS name</EM
11883 >netbios name = MYNAME</B
11888 NAME="NETBIOSSCOPE
"
11890 >netbios scope (G)</DT
11893 >This sets the NetBIOS scope that Samba will
11894 operate under. This should not be set unless every machine
11895 on your LAN also sets this value.</P
11901 >nis homedir (G)</DT
11904 >Get the home share server from a NIS map. For
11905 UNIX systems that use an automounter, the user's home directory
11906 will often be mounted on a workstation on demand from a remote
11909 >When the Samba logon server is not the actual home directory
11910 server, but is mounting the home directories via NFS then two
11911 network hops would be required to access the users home directory
11912 if the logon server told the client to use itself as the SMB server
11913 for home directories (one over SMB and one over NFS). This can
11916 >This option allows Samba to return the home share as
11917 being on a different server to the logon server and as
11918 long as a Samba daemon is running on the home directory server,
11919 it will be mounted on the Samba client directly from the directory
11920 server. When Samba is returning the home share to the client, it
11921 will consult the NIS map specified in <A
11929 > and return the server
11932 >Note that for this option to work there must be a working
11933 NIS system and the Samba server with this option must also
11934 be a logon server.</P
11938 >nis homedir = no</B
11943 NAME="NTACLSUPPORT
"
11945 >nt acl support (G)</DT
11948 >This boolean parameter controls whether
11953 > will attempt to map
11954 UNIX permissions into Windows NT access control lists.</P
11958 >nt acl support = yes</B
11963 NAME="NTPIPESUPPORT
"
11965 >nt pipe support (G)</DT
11968 >This boolean parameter controls whether
11973 > will allow Windows NT
11974 clients to connect to the NT SMB specific <TT
11978 pipes. This is a developer debugging option and can be left
11983 >nt pipe support = yes</B
11988 NAME="NTSMBSUPPORT
"
11990 >nt smb support (G)</DT
11993 >This boolean parameter controls whether <A
11997 > will negotiate NT specific SMB
11998 support with Windows NT clients. Although this is a developer
11999 debugging option and should be left alone, benchmarking has discovered
12000 that Windows NT clients give faster performance with this option
12004 >. This is still being investigated.
12005 If this option is set to <TT
12008 > then Samba offers
12009 exactly the same SMB calls that versions prior to Samba 2.0 offered.
12010 This information may be of use if any users are having problems
12011 with NT SMB support.</P
12013 >You should not need to ever disable this parameter.</P
12017 >nt smb support = yes</B
12022 NAME="NULLPASSWORDS
"
12024 >null passwords (G)</DT
12027 >Allow or disallow client access to accounts
12028 that have null passwords. </P
12031 HREF="smbpasswd
.5.html
"
12038 >null passwords = no</B
12043 NAME="OBEYPAMRESTRICTIONS
"
12045 >obey pam restrictions (G)</DT
12048 >When Samba 2.2 is configure to enable PAM support
12049 (i.e. --with-pam), this parameter will control whether or not Samba
12050 should obey PAM's account and session management directives. The
12051 default behavior is to use PAM for clear text authentication only
12052 and to ignore any account or session management. Note that Samba
12053 always ignores PAM for authentication in the case of <A
12054 HREF="#ENCRYPTPASSWORDS
"
12058 >encrypt passwords = yes</I
12062 >. The reason is that PAM modules cannot support the challenge/response
12063 authentication mechanism needed in the presence of SMB password encryption.
12068 >obey pam restrictions = no</B
12078 >This is a boolean option that controls whether
12079 connections with usernames not in the <TT
12085 list will be allowed. By default this option is disabled so that a
12086 client can supply a username to be used by the server. Enabling
12087 this parameter will force the server to only user the login
12093 > list and is only really
12095 HREF="#SECURITYEQUALSSHARE
"
12100 >Note that this also means Samba won't try to deduce
12101 usernames from the service name. This can be annoying for
12102 the [homes] section. To get around this you could use <B
12106 > which means your <TT
12112 will be just the service name, which for home directories is the
12113 name of the user.</P
12135 >only guest (S)</DT
12150 NAME="OPLOCKBREAKWAITTIME
"
12152 >oplock break wait time (G)</DT
12155 >This is a tuning parameter added due to bugs in
12156 both Windows 9x and WinNT. If Samba responds to a client too
12157 quickly when that client issues an SMB that can cause an oplock
12158 break request, then the network client can fail and not respond
12159 to the break request. This tuning parameter (which is set in milliseconds)
12160 is the amount of time Samba will wait before sending an oplock break
12161 request to such (broken) clients.</P
12164 >DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
12165 AND UNDERSTOOD THE SAMBA OPLOCK CODE</EM
12170 >oplock break wait time = 0</B
12175 NAME="OPLOCKCONTENTIONLIMIT
"
12177 >oplock contention limit (S)</DT
12188 improve the efficiency of the granting of oplocks under multiple
12189 client contention for the same file.</P
12191 >In brief it specifies a number, which causes smbd not to
12192 grant an oplock even when requested if the approximate number of
12193 clients contending for an oplock on the same file goes over this
12194 limit. This causes <B
12197 > to behave in a similar
12198 way to Windows NT.</P
12201 >DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
12202 AND UNDERSTOOD THE SAMBA OPLOCK CODE</EM
12207 >oplock contention limit = 2</B
12217 >This boolean option tells smbd whether to
12218 issue oplocks (opportunistic locks) to file open requests on this
12219 share. The oplock code can dramatically (approx. 30% or more) improve
12220 the speed of access to files on Samba servers. It allows the clients
12221 to aggressively cache files locally and you may want to disable this
12222 option for unreliable network environments (it is turned on by
12223 default in Windows NT Servers). For more information see the file
12233 >Oplocks may be selectively turned off on certain files with a
12235 HREF="#VETOOPLOCKFILES
"
12239 > veto oplock files</I
12242 > parameter. On some systems
12243 oplocks are recognized by the underlying operating system. This
12244 allows data synchronization between all access to oplocked files,
12245 whether it be via Samba or NFS or a local UNIX process. See the
12251 > parameter for details.</P
12254 HREF="#KERNELOPLOCKS
"
12263 HREF="#LEVEL2OPLOCKS
"
12267 > level2 oplocks</I
12284 >This integer value controls what level Samba
12285 advertises itself as for browse elections. The value of this
12286 parameter determines whether <A
12291 has a chance of becoming a local master browser for the <TT
12296 > in the local broadcast area.</P
12300 >By default, Samba will win
12301 a local master browsing election over all Microsoft operating
12302 systems except a Windows NT 4.0/2000 Domain Controller. This
12303 means that a misconfigured Samba host can effectively isolate
12304 a subnet for browsing purposes. See <TT
12326 NAME="OS2DRIVERMAP
"
12328 >os2 driver map (G)</DT
12331 >The parameter is used to define the absolute
12332 path to a file containing a mapping of Windows NT printer driver
12333 names to OS/2 printer driver names. The format is:</P
12335 ><nt driver name> = <os2 driver
12336 name>.<device name></P
12338 >For example, a valid entry using the HP LaserJet 5
12339 printer driver woudl appear as <B
12341 >HP LaserJet 5L = LASERJET.HP
12345 >The need for the file is due to the printer driver namespace
12346 problem described in the <A
12347 HREF="printer_driver2.html
"
12351 >. For more details on OS/2 clients, please
12353 HREF="OS2-Client-HOWTO.html
"
12357 > containing in the Samba documentation.</P
12361 >os2 driver map = <empty string>
12367 NAME="PAMPASSWORDCHANGE
"
12369 >pam password change (G)</DT
12372 >With the addition of better PAM support in Samba 2.2,
12373 this parameter, it is possible to use PAM's password change control
12374 flag for Samba. If enabled, then PAM will be used for password
12375 changes when requested by an SMB client, and the <A
12384 be changed to work with the pam prompts.
12389 >pam password change = no</B
12396 >panic action (G)</DT
12399 >This is a Samba developer option that allows a
12400 system command to be called when either <A
12409 crashes. This is usually used to draw attention to the fact that
12410 a problem occurred.</P
12414 >panic action = <empty string></B
12419 >panic action = "/bin/sleep
90000"</B
12426 >passwd chat (G)</DT
12429 >This string controls the <EM
12432 conversation that takes places between <A
12436 > and the local password changing
12437 program to change the users password. The string describes a
12438 sequence of response-receive pairs that <A
12442 > uses to determine what to send to the
12444 HREF="#PASSWDPROGRAM
"
12452 > and what to expect back. If the expected output is not
12453 received then the password is not changed.</P
12455 >This chat sequence is often quite site specific, depending
12456 on what local methods are used for password control (such as NIS
12459 >The string can contain the macros <TT
12470 > which are substituted for the old
12471 and new passwords respectively. It can also contain the standard
12484 > to give line-feed,
12485 carriage-return, tab and space.</P
12487 >The string can also contain a '*' which matches
12488 any sequence of characters.</P
12490 >Double quotes can be used to collect strings with spaces
12491 in them into a single string.</P
12493 >If the send string in any part of the chat sequence
12494 is a fullstop ".
", then no string is sent. Similarly,
12495 if the expect string is a fullstop then no string is expected.</P
12497 >Note that if the <A
12498 HREF="#UNIXPASSWORDSYNC
"
12506 > parameter is set to true, then this
12507 sequence is called <EM
12509 > when the SMB password
12510 in the smbpasswd file is being changed, without access to the old
12511 password cleartext. In this case the old password cleartext is set
12512 to "" (the empty string).</P
12515 HREF="#PAMPASSWORDCHANGE
"
12523 > parameter is set to true, then the
12524 chat sequence should consist of three elements. The first element should
12525 match the pam prompt for the old password, the second element should match
12526 the pam prompt for the first request for the new password, and the final
12527 element should match the pam prompt for the second request for the new password.
12528 These matches are done case insentively. Under most conditions this change
12529 is done as root so the prompt for the old password will never be matched.
12533 HREF="#UNIXPASSWORDSYNC
"
12542 HREF="#PASSWDPROGRAM
"
12546 > passwd program</I
12550 HREF="#PASSWDCHATDEBUG
"
12554 >passwd chat debug</I
12558 HREF="#PAMPASSWORDCHANGE
"
12562 >pam password change</I
12569 >passwd chat = *new*password* %n\n
12570 *new*password* %n\n *changed*</B
12575 >passwd chat = "*Enter OLD password*
" %o\n
12576 "*Enter NEW password*
" %n\n "*Reenter NEW password*
" %n\n "*Password
12582 NAME="PASSWDCHATDEBUG
"
12584 >passwd chat debug (G)</DT
12587 >This boolean specifies if the passwd chat script
12588 parameter is run in <EM
12590 > mode. In this mode the
12591 strings passed to and received from the passwd chat are printed
12606 of 100. This is a dangerous option as it will allow plaintext passwords
12607 to be seen in the <B
12610 > log. It is available to help
12611 Samba admins debug their <TT
12617 when calling the <TT
12623 be turned off after this has been done. This parameter is off by
12636 HREF="#PASSWDPROGRAM
"
12648 >passwd chat debug = no</B
12653 NAME="PASSWDPROGRAM
"
12655 >passwd program (G)</DT
12658 >The name of a program that can be used to set
12659 UNIX user passwords. Any occurrences of <TT
12665 will be replaced with the user name. The user name is checked for
12666 existence before calling the password changing program.</P
12668 >Also note that many passwd programs insist in <EM
12671 > passwords, such as a minimum length, or the inclusion
12672 of mixed case chars and digits. This can pose a problem as some clients
12673 (such as Windows for Workgroups) uppercase the password before sending
12684 > parameter is set to <TT
12688 > then this program is called <EM
12691 before the SMB password in the <A
12692 HREF="smbpasswd
.5.html
"
12696 > file is changed. If this UNIX password change fails, then
12700 > will fail to change the SMB password also
12701 (this is by design).</P
12706 >unix password sync</I
12709 is set this parameter <EM
12710 >MUST USE ABSOLUTE PATHS</EM
12714 > programs called, and must be examined
12715 for security implications. Note that by default <TT
12727 HREF="#UNIXPASSWORDSYNC
"
12739 >passwd program = /bin/passwd</B
12744 >passwd program = /sbin/npasswd %u</B
12750 NAME="PASSWORDLEVEL
"
12752 >password level (G)</DT
12755 >Some client/server combinations have difficulty
12756 with mixed-case passwords. One offending client is Windows for
12757 Workgroups, which for some reason forces passwords to upper
12758 case when using the LANMAN1 protocol, but leaves them alone when
12759 using COREPLUS! Another problem child is the Windows 95/98
12760 family of operating systems. These clients upper case clear
12761 text passwords even when NT LM 0.12 selected by the protocol
12762 negotiation request/response.</P
12764 >This parameter defines the maximum number of characters
12765 that may be upper case in passwords.</P
12767 >For example, say the password given was "FRED
". If <TT
12770 > password level</I
12772 > is set to 1, the following combinations
12773 would be tried if "FRED
" failed:</P
12775 >"Fred
", "fred
", "fRed
", "frEd
","freD
"</P
12783 the following combinations would also be tried: </P
12785 >"FRed
", "FrEd
", "FreD
", "fREd
", "fReD
", "frED
", ..</P
12789 >The higher value this parameter is set to the more likely
12790 it is that a mixed case password will be matched against a single
12791 case password. However, you should be aware that use of this
12792 parameter reduces security and increases the time taken to
12793 process a new connection.</P
12795 >A value of zero will cause only two attempts to be
12796 made - the password as is and the password in all-lower case.</P
12800 >password level = 0</B
12805 >password level = 4</B
12810 NAME="PASSWORDSERVER
"
12812 >password server (G)</DT
12815 >By specifying the name of another SMB server (such
12816 as a WinNT box) with this option, and using <B
12822 >security = server</B
12823 > you can get Samba
12824 to do all its username/password validation via a remote server.</P
12826 >This option sets the name of the password server to use.
12827 It must be a NetBIOS name, so if the machine's NetBIOS name is
12828 different from its Internet name then you may have to add its NetBIOS
12829 name to the lmhosts file which is stored in the same directory
12835 >The name of the password server is looked up using the
12837 HREF="#NAMERESOLVEORDER
"
12845 > and so may resolved
12846 by any method and order described in that parameter.</P
12848 >The password server much be a machine capable of using
12849 the "LM1.2X002
" or the "NT LM
0.12" protocol, and it must be in
12850 user level security mode.</P
12854 > Using a password server
12855 means your UNIX box (running Samba) is only as secure as your
12856 password server. <EM
12857 >DO NOT CHOOSE A PASSWORD SERVER THAT
12858 YOU DON'T COMPLETELY TRUST</EM
12861 >Never point a Samba server at itself for password
12862 serving. This will cause a loop and could lock up your Samba
12865 >The name of the password server takes the standard
12866 substitutions, but probably the only useful one is <TT
12872 >, which means the Samba server will use the incoming
12873 client as the password server. If you use this then you better
12874 trust your clients, and you had better restrict them with hosts allow!</P
12881 > parameter is set to
12885 >, then the list of machines in this
12886 option must be a list of Primary or Backup Domain controllers for the
12887 Domain or the character '*', as the Samba server is effectively
12888 in that domain, and will use cryptographically authenticated RPC calls
12889 to authenticate the user logging on. The advantage of using <B
12891 > security = domain</B
12892 > is that if you list several hosts in the
12896 >password server</I
12902 > will try each in turn till it finds one that responds. This
12903 is useful in case your primary server goes down.</P
12908 >password server</I
12911 to the character '*', then Samba will attempt to auto-locate the
12912 Primary or Backup Domain controllers to authenticate against by
12913 doing a query for the name <TT
12915 >WORKGROUP<1C></TT
12917 and then contacting each server returned in the list of IP
12918 addresses from the name resolution source. </P
12929 >, then there are different
12930 restrictions that <B
12932 >security = domain</B
12940 >You may list several password servers in
12944 >password server</I
12946 > parameter, however if an
12950 > makes a connection to a password server,
12951 and then the password server fails, no more users will be able
12952 to be authenticated from this <B
12956 restriction of the SMB/CIFS protocol when in <B
12960 > mode and cannot be fixed in Samba.</P
12964 >If you are using a Windows NT server as your
12965 password server then you will have to ensure that your users
12966 are able to login from the Samba server, as when in <B
12968 > security=server</B
12969 > mode the network logon will appear to
12970 come from there rather than from the users workstation.</P
12987 >password server = <empty string></B
12993 >password server = NT-PDC, NT-BDC1, NT-BDC2
12999 >password server = *</B
13009 >This parameter specifies a directory to which
13010 the user of the service is to be given access. In the case of
13011 printable services, this is where print data will spool prior to
13012 being submitted to the host for printing.</P
13014 >For a printable service offering guest access, the service
13015 should be readonly and the path should be world-writeable and
13016 have the sticky bit set. This is not mandatory of course, but
13017 you probably won't get the results you expect if you do
13020 >Any occurrences of <TT
13026 will be replaced with the UNIX username that the client is using
13027 on this connection. Any occurrences of <TT
13033 will be replaced by the NetBIOS name of the machine they are
13034 connecting from. These replacements are very useful for setting
13035 up pseudo home directories for users.</P
13037 >Note that this path will be based on <A
13045 > if one was specified.</P
13053 >path = /home/fred</B
13058 NAME="POSIXLOCKING
"
13060 >posix locking (S)</DT
13071 daemon maintains an database of file locks obtained by SMB clients.
13072 The default behavior is to map this internal database to POSIX
13073 locks. This means that file locks obtained by SMB clients are
13074 consistent with those seen by POSIX compliant applications accessing
13075 the files via a non-SMB method (e.g. NFS or local file access).
13076 You should never need to disable this parameter.</P
13080 >posix locking = yes</B
13090 >This option specifies a command to be run
13091 whenever the service is disconnected. It takes the usual
13092 substitutions. The command may be run as the root on some
13095 >An interesting example may be do unmount server
13100 >postexec = /etc/umount /cdrom</B
13115 >none (no command executed)</EM
13121 >postexec = echo \"%u disconnected from %S
13122 from %m (%I)\
" >> /tmp/log</B
13129 >postscript (S)</DT
13132 >This parameter forces a printer to interpret
13133 the print files as postscript. This is done by adding a <TT
13137 > to the start of print output.</P
13139 >This is most useful when you have lots of PCs that persist
13140 in putting a control-D at the start of print jobs, which then
13141 confuses your printer.</P
13145 >postscript = no</B
13155 >This option specifies a command to be run whenever
13156 the service is connected to. It takes the usual substitutions.</P
13158 >An interesting example is to send the users a welcome
13159 message every time they log in. Maybe a message of the day? Here
13164 >preexec = csh -c 'echo \"Welcome to %S!\
" |
13165 /usr/local/samba/bin/smbclient -M %m -I %I' & </B
13168 >Of course, this could get annoying after a while :-)</P
13171 HREF="#PREEXECCLOSE
"
13191 >none (no command executed)</EM
13196 >preexec = echo \"%u connected to %S from %m
13197 (%I)\
" >> /tmp/log</B
13202 NAME="PREEXECCLOSE
"
13204 >preexec close (S)</DT
13207 >This boolean option controls whether a non-zero
13208 return code from <A
13217 > should close the service being connected to.</P
13221 >preexec close = no</B
13226 NAME="PREFERREDMASTER
"
13228 >preferred master (G)</DT
13231 >This boolean parameter controls if <A
13235 > is a preferred master browser
13236 for its workgroup.</P
13238 >If this is set to true, on startup, <B
13242 will force an election, and it will have a slight advantage in
13243 winning the election. It is recommended that this parameter is
13244 used in conjunction with <B
13247 HREF="#DOMAINMASTER
"
13258 > can guarantee becoming a domain master.</P
13260 >Use this option with caution, because if there are several
13261 hosts (whether Samba servers, Windows 95 or NT) that are preferred
13262 master browsers on the same subnet, they will each periodically
13263 and continuously attempt to become the local master browser.
13264 This will result in unnecessary broadcast traffic and reduced browsing
13280 >preferred master = auto</B
13285 NAME="PREFEREDMASTER
"
13287 >prefered master (G)</DT
13291 HREF="#PREFERREDMASTER
"
13295 > preferred master</I
13298 > for people who cannot spell :-).</P
13307 >This is a list of services that you want to be
13308 automatically added to the browse lists. This is most useful
13309 for homes and printers services that would otherwise not be
13312 >Note that if you just want all printers in your
13313 printcap file loaded then the <A
13314 HREF="#LOADPRINTERS
"
13321 > option is easier.</P
13324 >no preloaded services</EM
13329 >preload = fred lp colorlp</B
13334 NAME="PRESERVECASE
"
13336 >preserve case (S)</DT
13339 > This controls if new filenames are created
13340 with the case that the client passes, or if they are forced to
13342 HREF="#DEFAULTCASE
"
13354 >preserve case = yes</B
13357 >See the section on <A
13361 > for a fuller discussion.</P
13365 NAME="PRINTCOMMAND
"
13367 >print command (S)</DT
13370 >After a print job has finished spooling to
13371 a service, this command will be used via a <B
13375 call to process the spool file. Typically the command specified will
13376 submit the spool file to the host's printing subsystem, but there
13377 is no requirement that this be the case. The server will not remove
13378 the spool file, so whatever command you specify should remove the
13379 spool file when it has been processed, otherwise you will need to
13380 manually remove old spool files.</P
13382 >The print command is simply a text string. It will be used
13383 verbatim, with two exceptions: All occurrences of <TT
13394 > will be replaced by the
13395 appropriate spool file name, and all occurrences of <TT
13401 > will be replaced by the appropriate printer name. The
13402 spool file name is generated automatically by the server, the printer
13403 name is discussed below.</P
13405 >The print command <EM
13408 one occurrence of <TT
13424 > is optional. At the time
13425 a job is submitted, if no printer name is supplied the <TT
13431 > will be silently removed from the printer command.</P
13433 >If specified in the [global] section, the print command given
13434 will be used for any printable service that does not have its own
13435 print command specified.</P
13437 >If there is neither a specified print command for a
13438 printable service nor a global print command, spool files will
13439 be created but not processed and (most importantly) not removed.</P
13441 >Note that printing may fail on some UNIXes from the
13445 > account. If this happens then create
13446 an alternative guest account that can print and set the <A
13447 HREF="#GUESTACCOUNT
"
13455 in the [global] section.</P
13457 >You can form quite complex print commands by realizing
13458 that they are just passed to a shell. For example the following
13459 will log a print job, print the file, then remove it. Note that
13460 ';' is the usual separator for command in shell scripts.</P
13464 >print command = echo Printing %s >>
13465 /tmp/print.log; lpr -P %p %s; rm %s</B
13468 >You may have to vary this command considerably depending
13469 on how you normally print files on your system. The default for
13470 the parameter varies depending on the setting of the <A
13482 >printing= BSD, AIX, QNX, LPRNG
13488 >print command = lpr -r -P%p %s</B
13493 >printing= SYS or HPUX :</B
13498 >print command = lp -c -d%p %s; rm %s</B
13503 >printing=SOFTQ :</B
13508 >print command = lp -d%p -s %s; rm %s</B
13513 >print command = /usr/local/samba/bin/myprintscript
13541 >If this parameter is <TT
13545 clients may open, write to and submit spool files on the directory
13546 specified for the service. </P
13548 >Note that a printable service will ALWAYS allow writing
13549 to the service path (user privileges permitting) via the spooling
13550 of print data. The <A
13559 > parameter controls only non-printing access to
13575 HREF="#PRINTCAPNAME
"
13586 NAME="PRINTCAPNAME
"
13588 >printcap name (G)</DT
13591 >This parameter may be used to override the
13592 compiled-in default printcap name used by the server (usually <TT
13594 > /etc/printcap</TT
13595 >). See the discussion of the <A
13598 > section above for reasons
13599 why you might want to do this.</P
13601 >On System V systems that use <B
13605 list available printers you can use <B
13607 >printcap name = lpstat
13609 > to automatically obtain lists of available printers. This
13610 is the default for systems that define SYSV at configure time in
13611 Samba (this includes most System V based systems). If <TT
13620 these systems then Samba will launch <B
13624 attempt to parse the output to obtain a printer list.</P
13626 >A minimal printcap file would look something like this:</P
13635 CLASS="PROGRAMLISTING
"
13636 > print1|My Printer 1
13637 print2|My Printer 2
13638 print3|My Printer 3
13639 print4|My Printer 4
13640 print5|My Printer 5
13647 >where the '|' separates aliases of a printer. The fact
13648 that the second alias has a space in it gives a hint to Samba
13649 that it's a comment.</P
13653 >: Under AIX the default printcap
13657 >. Samba will assume the
13661 > format if the string
13665 > appears in the printcap filename.</P
13669 >printcap name = /etc/printcap</B
13674 >printcap name = /etc/myprintcap</B
13679 NAME="PRINTERADMIN
"
13681 >printer admin (S)</DT
13684 >This is a list of users that can do anything to
13685 printers via the remote administration interfaces offered by MS-RPC
13686 (usually using a NT workstation). Note that the root user always
13687 has admin rights.</P
13691 >printer admin = <empty string></B
13697 >printer admin = admin, @staff</B
13702 NAME="PRINTERDRIVER
"
13704 >printer driver (S)</DT
13709 >This is a depreciated
13710 parameter and will be removed in the next major release
13711 following version 2.2. Please see the instructions in
13714 >PRINTER_DRIVER2.txt</TT
13719 > of the Samba distribution for more information
13720 on the new method of loading printer drivers onto a Samba server.
13723 >This option allows you to control the string
13724 that clients receive when they ask the server for the printer driver
13725 associated with a printer. If you are using Windows95 or Windows NT
13726 then you can use this to automate the setup of printers on your
13729 >You need to set this parameter to the exact string (case
13730 sensitive) that describes the appropriate printer driver for your
13731 system. If you don't know the exact string to use then you should
13732 first try with no <A
13733 HREF="#PRINTERDRIVER
"
13737 > printer driver</I
13740 > option set and the client will
13741 give you a list of printer drivers. The appropriate strings are
13742 shown in a scroll box after you have chosen the printer manufacturer.</P
13745 HREF="#PRINTERDRIVERFILE
"
13757 >printer driver = HP LaserJet 4L</B
13762 NAME="PRINTERDRIVERFILE
"
13764 >printer driver file (G)</DT
13769 >This is a depreciated
13770 parameter and will be removed in the next major release
13771 following version 2.2. Please see the instructions in
13774 >PRINTER_DRIVER2.txt</TT
13779 > of the Samba distribution for more information
13780 on the new method of loading printer drivers onto a Samba server.
13783 >This parameter tells Samba where the printer driver
13784 definition file, used when serving drivers to Windows 95 clients, is
13785 to be found. If this is not set, the default is :</P
13790 CLASS="REPLACEABLE
"
13792 >SAMBA_INSTALL_DIRECTORY</I
13795 /lib/printers.def</TT
13798 >This file is created from Windows 95 <TT
13802 > files found on the Windows 95 client system. For more
13803 details on setting up serving of printer drivers to Windows 95
13804 clients, see the documentation file in the <TT
13810 >PRINTER_DRIVER.txt</TT
13814 HREF="#PRINTERDRIVERLOCATION
"
13818 > printer driver location</I
13824 >None (set in compile).</EM
13829 >printer driver file =
13830 /usr/local/samba/printers/drivers.def</B
13835 NAME="PRINTERDRIVERLOCATION
"
13837 >printer driver location (S)</DT
13842 >This is a depreciated
13843 parameter and will be removed in the next major release
13844 following version 2.2. Please see the instructions in
13847 >PRINTER_DRIVER2.txt</TT
13852 > of the Samba distribution for more information
13853 on the new method of loading printer drivers onto a Samba server.
13856 >This parameter tells clients of a particular printer
13857 share where to find the printer driver files for the automatic
13858 installation of drivers for Windows 95 machines. If Samba is set up
13859 to serve printer drivers to Windows 95 machines, this should be set to</P
13863 >\\MACHINE\PRINTER$</B
13866 >Where MACHINE is the NetBIOS name of your Samba server,
13867 and PRINTER$ is a share you set up for serving printer driver
13868 files. For more details on setting this up see the documentation
13874 > PRINTER_DRIVER.txt</TT
13878 HREF="#PRINTERDRIVERFILE
"
13882 > printer driver file</I
13894 >printer driver location = \\MACHINE\PRINTER$
13902 >printer name (S)</DT
13905 >This parameter specifies the name of the printer
13906 to which print jobs spooled through a printable service will be sent.</P
13908 >If specified in the [global] section, the printer
13909 name given will be used for any printable service that does
13910 not have its own printer name specified.</P
13913 >none (but may be <TT
13917 on many systems)</EM
13922 >printer name = laserwriter</B
13933 HREF="#PRINTERNAME
"
13949 >This parameters controls how printer status
13950 information is interpreted on your system. It also affects the
13951 default values for the <TT
13971 >lpresume command</I
13979 > if specified in the
13980 [global]f> section.</P
13982 >Currently eight printing styles are supported. They are
14016 >To see what the defaults are for the other print
14017 commands when using the various options use the <A
14018 HREF="testparm
.1.html
"
14023 >This option can be set on a per printer basis</P
14025 >See also the discussion in the <A
14038 HREF="#MAXPROTOCOL
"
14067 NAME="QUEUEPAUSECOMMAND
"
14069 >queuepause command (S)</DT
14072 >This parameter specifies the command to be
14073 executed on the server host in order to pause the printerqueue.</P
14075 >This command should be a program or script which takes
14076 a printer name as its only parameter and stops the printerqueue,
14077 such that no longer jobs are submitted to the printer.</P
14079 >This command is not supported by Windows for Workgroups,
14080 but can be issued from the Printer's window under Windows 95
14088 > is given then the printername
14089 is put in its place. Otherwise it is placed at the end of the command.
14092 >Note that it is good practice to include the absolute
14093 path in the command as the PATH may not be available to the
14097 >depends on the setting of <TT
14108 >queuepause command = disable %p</B
14113 NAME="QUEUERESUMECOMMAND
"
14115 >queueresume command (S)</DT
14118 >This parameter specifies the command to be
14119 executed on the server host in order to resume the printerqueue. It
14120 is the command to undo the behavior that is caused by the
14121 previous parameter (<A
14122 HREF="#QUEUEPAUSECOMMAND
"
14126 > queuepause command</I
14131 >This command should be a program or script which takes
14132 a printer name as its only parameter and resumes the printerqueue,
14133 such that queued jobs are resubmitted to the printer.</P
14135 >This command is not supported by Windows for Workgroups,
14136 but can be issued from the Printer's window under Windows 95
14144 > is given then the printername
14145 is put in its place. Otherwise it is placed at the end of the
14148 >Note that it is good practice to include the absolute
14149 path in the command as the PATH may not be available to the
14153 >depends on the setting of <A
14167 >queuepause command = enable %p
14178 >This boolean parameter controls whether <A
14182 > will support the "Read
14183 Block Multiplex
" SMB. This is now rarely used and defaults to
14187 >. You should never need to set this
14202 >This is a list of users that are given read-only
14203 access to a service. If the connecting user is in this list then
14204 they will not be given write access, no matter what the <A
14213 option is set to. The list can include group names using the
14214 syntax described in the <A
14215 HREF="#INVALIDUSERS
"
14232 > parameter and the <A
14233 HREF="#INVALIDUSERS
"
14245 >read list = <empty string></B
14250 >read list = mary, @students</B
14260 >Note that this is an inverted synonym for <A
14277 >This parameter controls whether or not the server
14278 will support the raw read SMB requests when transferring data
14281 >If enabled, raw reads allow reads of 65535 bytes in
14282 one packet. This typically provides a major performance benefit.
14285 >However, some clients either negotiate the allowable
14286 block size incorrectly or are incapable of supporting larger block
14287 sizes, and for these clients you may need to disable raw reads.</P
14289 >In general this parameter should be viewed as a system tuning
14290 tool and left severely alone. See also <A
14318 affects the overlap of disk reads/writes with network reads/writes.
14319 If the amount of data being transferred in several of the SMB
14320 commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger
14321 than this value then the server begins writing the data before it
14322 has received the whole packet from the network, or in the case of
14323 SMBreadbraw, it begins writing to the network before all the data
14324 has been read from disk.</P
14326 >This overlapping works best when the speeds of disk and
14327 network access are similar, having very little effect when the
14328 speed of one is much greater than the other.</P
14330 >The default value is 16384, but very little experimentation
14331 has been done yet to determine the optimal value, and it is likely
14332 that the best value will vary greatly between systems anyway.
14333 A value over 65536 is pointless and will cause you to allocate
14334 memory unnecessarily.</P
14338 >read size = 16384</B
14343 >read size = 8192</B
14348 NAME="REMOTEANNOUNCE
"
14350 >remote announce (G)</DT
14353 >This option allows you to setup <A
14357 > to periodically announce itself
14358 to arbitrary IP addresses with an arbitrary workgroup name.</P
14360 >This is useful if you want your Samba server to appear
14361 in a remote workgroup for which the normal browse propagation
14362 rules don't work. The remote workgroup can be anywhere that you
14363 can send IP packets to.</P
14369 >remote announce = 192.168.2.255/SERVERS
14370 192.168.4.255/STAFF</B
14373 >the above line would cause nmbd to announce itself
14374 to the two given IP addresses using the given workgroup names.
14375 If you leave out the workgroup name then the one given in
14385 parameter is used instead.</P
14387 >The IP addresses you choose would normally be the broadcast
14388 addresses of the remote networks, but can also be the IP addresses
14389 of known browse masters if your network config is that stable.</P
14391 >See the documentation file <TT
14402 >remote announce = <empty string>
14408 NAME="REMOTEBROWSESYNC
"
14410 >remote browse sync (G)</DT
14413 >This option allows you to setup <A
14417 > to periodically request
14418 synchronization of browse lists with the master browser of a samba
14419 server that is on a remote segment. This option will allow you to
14420 gain browse lists for multiple workgroups across routed networks. This
14421 is done in a manner that does not work with any non-samba servers.</P
14423 >This is useful if you want your Samba server and all local
14424 clients to appear in a remote workgroup for which the normal browse
14425 propagation rules don't work. The remote workgroup can be anywhere
14426 that you can send IP packets to.</P
14432 >remote browse sync = 192.168.2.255 192.168.4.255
14436 >the above line would cause <B
14440 the master browser on the specified subnets or addresses to
14441 synchronize their browse lists with the local server.</P
14443 >The IP addresses you choose would normally be the broadcast
14444 addresses of the remote networks, but can also be the IP addresses
14445 of known browse masters if your network config is that stable. If
14446 a machine IP address is given Samba makes NO attempt to validate
14447 that the remote machine is available, is listening, nor that it
14448 is in fact the browse master on it's segment.</P
14452 >remote browse sync = <empty string>
14458 NAME="RESTRICTACLWITHMASK
"
14460 >restrict acl with mask (S)</DT
14463 >This is a boolean parameter. If set to false (default), then
14464 Creation of files with access control lists (ACLS) and modification of ACLs
14465 using the Windows NT/2000 ACL editor will be applied directly to the file
14468 >If set to True, then all requests to set an ACL on a file will have the
14479 HREF="#FORCECREATEMODE
"
14483 >force create mode</I
14487 applied before setting the ACL, and all requests to set an ACL on a directory will
14488 have the parameters <A
14489 HREF="#DIRECTORYMASK
"
14498 HREF="#FORCEDIRECTORYMODE
"
14506 > applied before setting the ACL.
14519 HREF="#FORCECREATEMODE
"
14523 >force create mode</I
14528 HREF="#DIRECTORYMASK
"
14537 HREF="#FORCEDIRECTORYMODE
"
14541 >force directory mode</I
14549 >restrict acl with mask = no</B
14554 NAME="RESTRICTANONYMOUS
"
14556 >restrict anonymous (G)</DT
14559 >This is a boolean parameter. If it is true, then
14560 anonymous access to the server will be restricted, namely in the
14561 case where the server is expecting the client to send a username,
14562 but it doesn't. Setting it to true will force these anonymous
14563 connections to be denied, and the client will be required to always
14564 supply a username and password when connecting. Use of this parameter
14565 is only recommended for homogeneous NT client environments.</P
14567 >This parameter makes the use of macro expansions that rely
14568 on the username (%U, %G, etc) consistent. NT 4.0
14569 likes to use anonymous connections when refreshing the share list,
14570 and this is a way to work around that.</P
14572 >When restrict anonymous is true, all anonymous connections
14573 are denied no matter what they are for. This can effect the ability
14574 of a machine to access the samba Primary Domain Controller to revalidate
14575 it's machine account after someone else has logged on the client
14576 interactively. The NT client will display a message saying that
14577 the machine's account in the domain doesn't exist or the password is
14578 bad. The best way to deal with this is to reboot NT client machines
14579 between interactive logons, using "Shutdown and Restart
", rather
14580 than "Close all programs and logon as a different user
".</P
14584 >restrict anonymous = no</B
14595 HREF="#ROOTDIRECTORY
"
14599 >root directory"</I
14612 HREF=
"#ROOTDIRECTORY"
14616 >root directory
"</I
14623 NAME="ROOTDIRECTORY
"
14625 >root directory (G)</DT
14628 >The server will <B
14632 Change it's root directory) to this directory on startup. This is
14633 not strictly necessary for secure operation. Even without it the
14634 server will deny access to files not in one of the service entries.
14635 It may also check for, and deny access to, soft links to other
14636 parts of the filesystem, or attempts to use "..
" in file names
14637 to access other directories (depending on the setting of the <A
14654 than "/
" adds an extra level of security, but at a price. It
14655 absolutely ensures that no access is given to files not in the
14656 sub-tree specified in the <TT
14664 > some files needed for
14665 complete operation of the server. To maintain full operability
14666 of the server you will need to mirror some system files
14672 > tree. In particular
14673 you will need to mirror <TT
14677 subset of it), and any binaries or configuration files needed for
14678 printing (if required). The set of files that must be mirrored is
14679 operating system dependent.</P
14683 >root directory = /</B
14688 >root directory = /homes/smb</B
14693 NAME="ROOTPOSTEXEC
"
14695 >root postexec (S)</DT
14698 >This is the same as the <TT
14704 parameter except that the command is run as root. This
14705 is useful for unmounting filesystems
14706 (such as cdroms) after a connection is closed.</P
14720 >root postexec = <empty string>
14728 >root preexec (S)</DT
14731 >This is the same as the <TT
14737 parameter except that the command is run as root. This
14738 is useful for mounting filesystems (such as cdroms) after a
14739 connection is closed.</P
14750 HREF="#PREEXECCLOSE
"
14761 >root preexec = <empty string>
14767 NAME="ROOTPREEXECCLOSE
"
14769 >root preexec close (S)</DT
14772 >This is the same as the <TT
14778 > parameter except that the command is run as root.</P
14789 HREF="#PREEXECCLOSE
"
14800 >root preexec close = no</B
14810 >This option affects how clients respond to
14811 Samba and is one of the most important settings in the <TT
14816 >The option sets the "security mode bit
" in replies to
14817 protocol negotiations with <A
14822 > to turn share level security on or off. Clients decide
14823 based on this bit whether (and how) to transfer user and password
14824 information to the server.</P
14828 >security = user</B
14830 the most common setting needed when talking to Windows 98 and
14833 >The alternatives are <B
14835 >security = share</B
14839 >security = server</B
14846 >In versions of Samba prior to 2..0, the default was
14849 >security = share</B
14850 > mainly because that was
14851 the only option at one stage.</P
14853 >There is a bug in WfWg that has relevance to this
14854 setting. When in user or server level security a WfWg client
14855 will totally ignore the password you type in the "connect
14856 drive
" dialog box. This makes it very difficult (if not impossible)
14857 to connect to a Samba service as anyone except the user that
14858 you are logged into WfWg as.</P
14860 >If your PCs use usernames that are the same as their
14861 usernames on the UNIX machine then you will want to use
14864 >security = user</B
14865 >. If you mostly use usernames
14866 that don't exist on the UNIX box then use <B
14872 >You should also use <B
14874 >security = share</B
14876 want to mainly setup shares without a password (guest shares). This
14877 is commonly used for a shared printer server. It is more difficult
14878 to setup guest shares with <B
14880 >security = user</B
14891 >parameter for details.</P
14893 >It is possible to use <B
14898 > where it is offers both user and share
14899 level security under different <A
14900 HREF="#NETBIOSALIASES
"
14904 >NetBIOS aliases</I
14909 >The different settings will now be explained.</P
14912 NAME="SECURITYEQUALSSHARE
"
14919 >When clients connect to a share level security server then
14920 need not log onto the server with a valid username and password before
14921 attempting to connect to a shared resource (although modern clients
14922 such as Windows 95/98 and Windows NT will send a logon request with
14923 a username but no password when talking to a <B
14927 > server). Instead, the clients send authentication information
14928 (passwords) on a per-share basis, at the time they attempt to connect
14937 uses a valid UNIX user to act on behalf of the client, even in
14940 >security = share</B
14941 > level security.</P
14943 >As clients are not required to send a username to the server
14944 in share level security, <B
14948 techniques to determine the correct UNIX user to use on behalf
14951 >A list of possible UNIX usernames to match with the given
14952 client password is constructed using the following methods :</P
14967 > parameter is set, then all the other
14968 stages are missed and only the <A
14969 HREF="#GUESTACCOUNT
"
14976 > username is checked.
14981 >Is a username is sent with the share connection
14982 request, then this username (after mapping - see <A
14983 HREF="#USERNAMEMAP
"
14991 is added as a potential username.</P
14995 >If the client did a previous <EM
14998 > request (the SessionSetup SMB call) then the
14999 username sent in this SMB will be added as a potential username.
15004 >The name of the service the client requested is
15005 added as a potential username.</P
15009 >The NetBIOS name of the client is added to
15010 the list as a potential username.</P
15014 >Any users on the <A
15022 > list are added as potential usernames.
15033 not set, then this list is then tried with the supplied password.
15034 The first user for whom the password matches will be used as the
15043 set, or no username can be determined then if the share is marked
15044 as available to the <TT
15050 guest user will be used, otherwise access is denied.</P
15052 >Note that it can be <EM
15055 in share-level security as to which UNIX username will eventually
15056 be used in granting access.</P
15058 >See also the section <A
15060 > NOTE ABOUT USERNAME/PASSWORD VALIDATION</A
15064 NAME="SECURITYEQUALSUSER
"
15071 >This is the default security setting in Samba 2.2.
15072 With user-level security a client must first "log=on
" with a
15073 valid username and password (which can be mapped using the <A
15074 HREF="#USERNAMEMAP
"
15082 parameter). Encrypted passwords (see the <A
15083 HREF="#ENCRYPTPASSWORDS
"
15087 >encrypted passwords</I
15090 > parameter) can also
15091 be used in this security mode. Parameters such as <A
15107 > if set are then applied and
15108 may change the UNIX user to use on this connection, but only after
15109 the user has been successfully authenticated.</P
15113 > that the name of the resource being
15116 > sent to the server until after
15117 the server has successfully authenticated the client. This is why
15118 guest shares don't work in user level security without allowing
15119 the server to automatically map unknown users into the <A
15120 HREF="#GUESTACCOUNT
"
15137 > parameter for details on doing this.</P
15139 >See also the section <A
15141 > NOTE ABOUT USERNAME/PASSWORD VALIDATION</A
15145 NAME="SECURITYEQUALSSERVER
"
15152 >In this mode Samba will try to validate the username/password
15153 by passing it to another SMB server, such as an NT box. If this
15154 fails it will revert to <B
15156 >security = user</B
15158 that if encrypted passwords have been negotiated then Samba cannot
15159 revert back to checking the UNIX password file, it must have a valid
15163 > file to check users against. See the
15164 documentation file in the <TT
15170 >ENCRYPTION.txt</TT
15171 > for details on how to set this
15176 > that from the clients point of
15179 >security = server</B
15180 > is the same as <B
15182 > security = user</B
15183 >. It only affects how the server deals
15184 with the authentication, it does not in any way affect what the
15189 > that the name of the resource being
15192 > sent to the server until after
15193 the server has successfully authenticated the client. This is why
15194 guest shares don't work in user level security without allowing
15195 the server to automatically map unknown users into the <A
15196 HREF="#GUESTACCOUNT
"
15213 > parameter for details on doing this.</P
15215 >See also the section <A
15217 > NOTE ABOUT USERNAME/PASSWORD VALIDATION</A
15221 HREF="#PASSWORDSERVER
"
15229 > parameter and the <A
15230 HREF="#ENCRYPTPASSWORDS
"
15234 >encrypted passwords</I
15241 NAME="SECURITYEQUALSDOMAIN
"
15248 >This mode will only work correctly if <A
15249 HREF="smbpasswd
.8.html
"
15252 > has been used to add this
15253 machine into a Windows NT Domain. It expects the <A
15254 HREF="#ENCRYPTPASSWORDS
"
15258 >encrypted passwords</I
15262 > parameter to be set to <TT
15266 mode Samba will try to validate the username/password by passing
15267 it to a Windows NT Primary or Backup Domain Controller, in exactly
15268 the same way that a Windows NT Server would do.</P
15272 > that a valid UNIX user must still
15273 exist as well as the account on the Domain Controller to allow
15274 Samba to have a valid UNIX account to map file access to.</P
15278 > that from the clients point
15281 >security = domain</B
15282 > is the same as <B
15286 >. It only affects how the server deals with the authentication,
15287 it does not in any way affect what the client sees.</P
15291 > that the name of the resource being
15294 > sent to the server until after
15295 the server has successfully authenticated the client. This is why
15296 guest shares don't work in user level security without allowing
15297 the server to automatically map unknown users into the <A
15298 HREF="#GUESTACCOUNT
"
15315 > parameter for details on doing this.</P
15319 > There is currently a bug in the
15320 implementation of <B
15322 >security = domain</B
15324 to multi-byte character set usernames. The communication with a
15325 Domain Controller must be done in UNICODE and Samba currently
15326 does not widen multi-byte user names to UNICODE correctly, thus
15327 a multi-byte username will not be recognized correctly at the
15328 Domain Controller. This issue will be addressed in a future release.</P
15330 >See also the section <A
15332 > NOTE ABOUT USERNAME/PASSWORD VALIDATION</A
15336 HREF="#PASSWORDSERVER
"
15344 > parameter and the <A
15345 HREF="#ENCRYPTPASSWORDS
"
15349 >encrypted passwords</I
15357 >security = USER</B
15362 >security = DOMAIN</B
15367 NAME="SECURITYMASK
"
15369 >security mask (S)</DT
15372 >This parameter controls what UNIX permission
15373 bits can be modified when a Windows NT client is manipulating
15374 the UNIX permission on a file using the native NT security
15377 >This parameter is applied as a mask (AND'ed with) to
15378 the changed permission bits, thus preventing any bits not in
15379 this mask from being modified. Essentially, zero bits in this
15380 mask may be treated as a set of bits the user is not allowed
15383 >If not set explicitly this parameter is 0777, allowing
15384 a user to modify all the user/group/world permissions on a file.
15389 > that users who can access the
15390 Samba server through other means can easily bypass this
15391 restriction, so it is primarily useful for standalone
15392 "appliance
" systems. Administrators of most normal systems will
15393 probably want to leave it set to 0777.</P
15396 HREF="#FORCEDIRECTORYSECURITYMODE
"
15400 >force directory security mode</I
15405 HREF="#DIRECTORYSECURITYMASK
"
15414 HREF="#FORCESECURITYMODE
"
15418 >force security mode</I
15425 >security mask = 0777</B
15430 >security mask = 0770</B
15435 NAME="SERVERSTRING
"
15437 >server string (G)</DT
15440 >This controls what string will show up in the
15441 printer comment box in print manager and next to the IPC connection
15445 >. It can be any string that you wish
15446 to show to your users.
</P
15448 >It also sets what will appear in browse lists next
15449 to the machine name.
</P
15456 > will be replaced with the Samba
15464 > will be replaced with the
15469 >server string = Samba %v
</B
15474 >server string = University of GNUs Samba
15480 NAME=
"SETDIRECTORY"
15482 >set directory (S)
</DT
15487 >set directory = no
</B
15489 users of the service may not use the setdir command to change
15495 > command is only implemented
15496 in the Digital Pathworks client. See the Pathworks documentation
15501 >set directory = no
</B
15508 >share modes (S)
</DT
15511 >This enables or disables the honoring of
15517 > during a file open. These
15518 modes are used by clients to gain exclusive read or write access
15521 >These open modes are not directly supported by UNIX, so
15522 they are simulated using shared memory, or lock files if your
15523 UNIX doesn't support shared memory (almost all do).
</P
15525 >The share modes that are enabled by this option are
15549 >This option gives full share compatibility and enabled
15554 > turn this parameter
15555 off as many Windows applications will break if you do so.
</P
15559 >share modes = yes
</B
15564 NAME=
"SHORTPRESERVECASE"
15566 >short preserve case (S)
</DT
15569 >This boolean parameter controls if new files
15570 which conform to
8.3 syntax, that is all in upper case and of
15571 suitable length, are created upper case, or if they are forced
15573 HREF=
"#DEFAULTCASE"
15581 >. This option can be use with
<A
15582 HREF=
"#PRESERVECASE"
15585 >preserve case = yes
</B
15588 > to permit long filenames to retain their case, while short
15589 names are lowered.
</P
15591 >See the section on
<A
15598 >short preserve case = yes
</B
15603 NAME=
"SHOWADDPRINTERWIZARD"
15605 >show add printer wizard (G)
</DT
15608 >With the introduction of MS-RPC based printing support
15609 for Windows NT/
2000 client in Samba
2.2, a
"Printers..." folder will
15610 appear on Samba hosts in the share listing. Normally this folder will
15611 contain an icon for the MS Add Printer Wizard (APW). However, it is
15612 possible to disable this feature regardless of the level of privilege
15613 of the connected user.
</P
15615 >Under normal circumstances, the Windows NT/
2000 client will
15616 open a handle on the printer server with OpenPrinterEx() asking for
15617 Administrator privileges. If the user does not have administrative
15618 access on the print server (i.e is not root or a member of the
15624 > group), the OpenPrinterEx()
15625 call fails and the clients another open call with a request for
15626 a lower privilege level. This should succeed, however the APW
15627 icon will not be displayed.
</P
15632 >show add printer wizard
</I
15635 parameter will always cause the OpenPrinterEx() on the server
15636 to fail. Thus the APW icon will never be displayed.
<EM
15638 >This does not prevent the same user from having
15639 administrative privilege on an individual printer.
</P
15642 HREF=
"#ADDPRINTERCOMMAND"
15651 HREF=
"#DELETEPRINTERCOMMAND"
15655 >deleteprinter command
</I
15659 HREF=
"#PRINTERADMIN"
15670 >show add printer wizard = yes
</B
15675 NAME=
"SMBPASSWDFILE"
15677 >smb passwd file (G)
</DT
15680 >This option sets the path to the encrypted
15681 smbpasswd file. By default the path to the smbpasswd file
15682 is compiled into Samba.
</P
15686 >smb passwd file = ${prefix}/private/smbpasswd
15692 >smb passwd file = /etc/samba/smbpasswd
15698 NAME=
"SOCKETADDRESS"
15700 >socket address (G)
</DT
15703 >This option allows you to control what
15704 address Samba will listen for connections on. This is used to
15705 support multiple virtual interfaces on the one server, each
15706 with a different configuration.
</P
15708 >By default samba will accept connections on any
15713 >socket address =
192.168.2.20</B
15719 NAME=
"SOCKETOPTIONS"
15721 >socket options (G)
</DT
15724 >This option allows you to set socket options
15725 to be used when talking with the client.
</P
15727 >Socket options are controls on the networking layer
15728 of the operating systems which allow the connection to be
15731 >This option will typically be used to tune your Samba
15732 server for optimal performance for your local network. There is
15733 no way that Samba can know what the optimal parameters are for
15734 your net, so you must experiment and choose them yourself. We
15735 strongly suggest you read the appropriate documentation for your
15736 operating system first (perhaps
<B
15742 >You may find that on some systems Samba will say
15743 "Unknown socket option" when you supply an option. This means you
15744 either incorrectly typed it or you need to add an include file
15745 to includes.h for your OS. If the latter is the case please
15746 send the patch to
<A
15747 HREF=
"mailto:samba@samba.org"
15749 > samba@samba.org
</A
15752 >Any of the supported socket options may be combined
15753 in any way you like, as long as your OS allows it.
</P
15755 >This is the list of socket options currently settable
15756 using this option:
</P
15782 >IPTOS_THROUGHPUT
</P
15802 >Those marked with a
<EM
15805 argument. The others can optionally take a
1 or
0 argument to enable
15806 or disable the option, by default they will be enabled if you
15807 don't specify
1 or
0.
</P
15809 >To specify an argument use the syntax SOME_OPTION=VALUE
15813 >. Note that you must
15814 not have any spaces before or after the = sign.
</P
15816 >If you are on a local network then a sensible option
15821 >socket options = IPTOS_LOWDELAY
</B
15824 >If you have a local network then you could try:
</P
15828 >socket options = IPTOS_LOWDELAY TCP_NODELAY
</B
15831 >If you are on a wide area network then perhaps try
15832 setting IPTOS_THROUGHPUT.
</P
15834 >Note that several of the options may cause your Samba
15835 server to fail completely. Use these options with caution!
</P
15839 >socket options = TCP_NODELAY
</B
15844 >socket options = IPTOS_LOWDELAY
</B
15849 NAME=
"SOURCEENVIRONMENT"
15851 >source environment (G)
</DT
15854 >This parameter causes Samba to set environment
15855 variables as per the content of the file named.
</P
15857 >If the value of this parameter starts with a
"|" character
15858 then Samba will treat that value as a pipe command to open and
15859 will set the environment variables from the output of the pipe.
</P
15861 >The contents of the file or the output of the pipe should
15862 be formatted as the output of the standard Unix
<B
15866 > command. This is of the form :
</P
15868 >Example environment entry:
</P
15872 >SAMBA_NETBIOS_NAME=myhostname
</B
15876 >No default value
</EM
15881 >source environment = |/etc/smb.conf.sh
15887 >source environment =
15888 /usr/local/smb_env_vars
</B
15898 >This variable is part of SSL-enabled Samba. This
15899 is only available if the SSL libraries have been compiled on your
15900 system and the configure option
<B
15904 given at configure time.
</P
15908 > that for export control reasons
15911 > enabled by default in any
15912 current binary version of Samba.
</P
15914 >This variable enables or disables the entire SSL mode. If
15918 >, the SSL enabled samba behaves
15919 exactly like the non-SSL samba. If set to
<TT
15923 it depends on the variables
<A
15932 HREF=
"#SSLHOSTSRESIGN"
15936 >ssl hosts resign
</I
15940 connection will be required.
</P
15949 NAME=
"SSLCACERTDIR"
15951 >ssl CA certDir (G)
</DT
15954 >This variable is part of SSL-enabled Samba. This
15955 is only available if the SSL libraries have been compiled on your
15956 system and the configure option
<B
15960 given at configure time.
</P
15964 > that for export control reasons
15967 > enabled by default in any
15968 current binary version of Samba.
</P
15970 >This variable defines where to look up the Certification
15971 Authorities. The given directory should contain one file for
15972 each CA that samba will trust. The file name must be the hash
15973 value over the
"Distinguished Name" of the CA. How this directory
15974 is set up is explained later in this document. All files within the
15975 directory that don't fit into this naming scheme are ignored. You
15976 don't need this variable if you don't verify client certificates.
</P
15980 >ssl CA certDir = /usr/local/ssl/certs
15986 NAME=
"SSLCACERTFILE"
15988 >ssl CA certFile (G)
</DT
15991 >This variable is part of SSL-enabled Samba. This
15992 is only available if the SSL libraries have been compiled on your
15993 system and the configure option
<B
15997 given at configure time.
</P
16001 > that for export control reasons
16004 > enabled by default in any
16005 current binary version of Samba.
</P
16007 >This variable is a second way to define the trusted CAs.
16008 The certificates of the trusted CAs are collected in one big
16009 file and this variable points to the file. You will probably
16010 only use one of the two ways to define your CAs. The first choice is
16011 preferable if you have many CAs or want to be flexible, the second
16012 is preferable if you only have one CA and want to keep things
16013 simple (you won't need to create the hashed file names). You
16014 don't need this variable if you don't verify client certificates.
</P
16018 >ssl CA certFile = /usr/local/ssl/certs/trustedCAs.pem
16026 >ssl ciphers (G)
</DT
16029 >This variable is part of SSL-enabled Samba. This
16030 is only available if the SSL libraries have been compiled on your
16031 system and the configure option
<B
16035 given at configure time.
</P
16039 > that for export control reasons
16042 > enabled by default in any
16043 current binary version of Samba.
</P
16045 >This variable defines the ciphers that should be offered
16046 during SSL negotiation. You should not set this variable unless
16047 you know what you are doing.
</P
16051 NAME=
"SSLCLIENTCERT"
16053 >ssl client cert (G)
</DT
16056 >This variable is part of SSL-enabled Samba. This
16057 is only available if the SSL libraries have been compiled on your
16058 system and the configure option
<B
16062 given at configure time.
</P
16066 > that for export control reasons
16069 > enabled by default in any
16070 current binary version of Samba.
</P
16072 >The certificate in this file is used by
<A
16073 HREF=
"smbclient.1.html"
16079 > if it exists. It's needed
16080 if the server requires a client certificate.
</P
16084 >ssl client cert = /usr/local/ssl/certs/smbclient.pem
16090 NAME=
"SSLCLIENTKEY"
16092 >ssl client key (G)
</DT
16095 >This variable is part of SSL-enabled Samba. This
16096 is only available if the SSL libraries have been compiled on your
16097 system and the configure option
<B
16101 given at configure time.
</P
16105 > that for export control reasons
16108 > enabled by default in any
16109 current binary version of Samba.
</P
16111 >This is the private key for
<A
16112 HREF=
"smbclient.1.html"
16118 >. It's only needed if the
16119 client should have a certificate.
</P
16123 >ssl client key = /usr/local/ssl/private/smbclient.pem
16129 NAME=
"SSLCOMPATIBILITY"
16131 >ssl compatibility (G)
</DT
16134 >This variable is part of SSL-enabled Samba. This
16135 is only available if the SSL libraries have been compiled on your
16136 system and the configure option
<B
16140 given at configure time.
</P
16144 > that for export control reasons
16147 > enabled by default in any
16148 current binary version of Samba.
</P
16150 >This variable defines whether SSLeay should be configured
16151 for bug compatibility with other SSL implementations. This is
16152 probably not desirable because currently no clients with SSL
16153 implementations other than SSLeay exist.
</P
16157 >ssl compatibility = no
</B
16168 HREF=
"#SSLHOSTSRESIGN"
16172 > ssl hosts resign
</I
16179 NAME=
"SSLHOSTSRESIGN"
16181 >ssl hosts resign (G)
</DT
16184 >This variable is part of SSL-enabled Samba. This
16185 is only available if the SSL libraries have been compiled on your
16186 system and the configure option
<B
16190 given at configure time.
</P
16194 > that for export control reasons
16197 > enabled by default in any
16198 current binary version of Samba.
</P
16200 >These two variables define whether samba will go
16201 into SSL mode or not. If none of them is defined, samba will
16202 allow only SSL connections. If the
<A
16211 hosts (by IP-address, IP-address range, net group or name),
16212 only these hosts will be forced into SSL mode. If the
<TT
16215 > ssl hosts resign
</I
16217 > variable lists hosts, only these
16218 hosts will NOT be forced into SSL mode. The syntax for these two
16219 variables is the same as for the
<A
16235 > pair of variables, only
16236 that the subject of the decision is different: It's not the access
16237 right but whether SSL is used or not.
</P
16239 >The example below requires SSL connections from all hosts
16240 outside the local net (which is
192.168.*.*).
</P
16244 >ssl hosts =
<empty string
></B
16249 >ssl hosts resign =
<empty string
></B
16254 >ssl hosts resign =
192.168.
</B
16259 NAME=
"SSLREQUIRECLIENTCERT"
16261 >ssl require clientcert (G)
</DT
16264 >This variable is part of SSL-enabled Samba. This
16265 is only available if the SSL libraries have been compiled on your
16266 system and the configure option
<B
16270 given at configure time.
</P
16274 > that for export control reasons
16277 > enabled by default in any
16278 current binary version of Samba.
</P
16280 >If this variable is set to
<TT
16284 server will not tolerate connections from clients that don't
16285 have a valid certificate. The directory/file given in
<A
16286 HREF=
"#SSLCACERTDIR"
16295 HREF=
"#SSLCACERTFILE"
16303 > will be used to look up the CAs that issued
16304 the client's certificate. If the certificate can't be verified
16305 positively, the connection will be terminated. If this variable
16309 >, clients don't need certificates.
16310 Contrary to web applications you really
<EM
16313 require client certificates. In the web environment the client's
16314 data is sensitive (credit card numbers) and the server must prove
16315 to be trustworthy. In a file server environment the server's data
16316 will be sensitive and the clients must prove to be trustworthy.
</P
16320 >ssl require clientcert = no
</B
16325 NAME=
"SSLREQUIRESERVERCERT"
16327 >ssl require servercert (G)
</DT
16330 >This variable is part of SSL-enabled Samba. This
16331 is only available if the SSL libraries have been compiled on your
16332 system and the configure option
<B
16336 given at configure time.
</P
16340 > that for export control reasons
16343 > enabled by default in any
16344 current binary version of Samba.
</P
16346 >If this variable is set to
<TT
16351 HREF=
"smbclient.1.html"
16358 > will request a certificate from the server. Same as
16360 HREF=
"#SSLREQUIRECLIENTCERT"
16368 > for the server.
</P
16372 >ssl require servercert = no
</B
16378 NAME=
"SSLSERVERCERT"
16380 >ssl server cert (G)
</DT
16383 >This variable is part of SSL-enabled Samba. This
16384 is only available if the SSL libraries have been compiled on your
16385 system and the configure option
<B
16389 given at configure time.
</P
16393 > that for export control reasons
16396 > enabled by default in any
16397 current binary version of Samba.
</P
16399 >This is the file containing the server's certificate.
16402 > have a certificate. The
16403 file may also contain the server's private key. See later for
16404 how certificates and private keys are created.
</P
16408 >ssl server cert =
<empty string
>
16414 NAME=
"SSLSERVERKEY"
16416 >ssl server key (G)
</DT
16419 >This variable is part of SSL-enabled Samba. This
16420 is only available if the SSL libraries have been compiled on your
16421 system and the configure option
<B
16425 given at configure time.
</P
16429 > that for export control reasons
16432 > enabled by default in any
16433 current binary version of Samba.
</P
16435 >This file contains the private key of the server. If
16436 this variable is not defined, the key is looked up in the
16437 certificate file (it may be appended to the certificate).
16440 > have a private key
16441 and the certificate
<EM
16444 match this private key.
</P
16448 >ssl server key =
<empty string
>
16456 >ssl version (G)
</DT
16459 >This variable is part of SSL-enabled Samba. This
16460 is only available if the SSL libraries have been compiled on your
16461 system and the configure option
<B
16465 given at configure time.
</P
16469 > that for export control reasons
16472 > enabled by default in any
16473 current binary version of Samba.
</P
16475 >This enumeration variable defines the versions of the
16476 SSL protocol that will be used.
<TT
16480 dynamic negotiation of SSL v2 or v3,
<TT
16487 > results in SSL v3 and
16491 > results in TLS v1. TLS (Transport Layer
16492 Security) is the new standard for SSL.
</P
16496 >ssl version =
"ssl2or3"</B
16503 >stat cache (G)
</DT
16506 >This parameter determines if
<A
16510 > will use a cache in order to
16511 speed up case insensitive name mappings. You should never need
16512 to change this parameter.
</P
16516 >stat cache = yes
</B
16521 NAME=
"STATCACHESIZE"
16523 >stat cache size (G)
</DT
16526 >This parameter determines the number of
16533 never need to change this parameter.
</P
16537 >stat cache size =
50</B
16547 >This enables or disables logging of connections
16548 to a status file that
<A
16549 HREF=
"smbstatus.1.html"
16555 >With this disabled
<B
16559 to tell you what connections are active. You should never need to
16560 change this parameter.
</P
16569 NAME=
"STRICTLOCKING"
16571 >strict locking (S)
</DT
16574 >This is a boolean that controls the handling of
16575 file locking in the server. When this is set to
<TT
16579 the server will check every read and write access for file locks, and
16580 deny access if locks exist. This can be slow on some systems.
</P
16582 >When strict locking is
<TT
16585 > the server does file
16586 lock checks only when the client explicitly asks for them.
</P
16588 >Well behaved clients always ask for lock checks when it
16589 is important, so in the vast majority of cases
<B
16593 > is preferable.
</P
16597 >strict locking = no
</B
16604 >strict sync (S)
</DT
16607 >Many Windows applications (including the Windows
16608 98 explorer shell) seem to confuse flushing buffer contents to
16609 disk with doing a sync to disk. Under UNIX, a sync call forces
16610 the process to be suspended until the kernel has ensured that
16611 all outstanding data in kernel disk buffers has been safely stored
16612 onto stable storage. This is very slow and should only be done
16613 rarely. Setting this parameter to
<TT
16617 default) means that smbd ignores the Windows applications requests for
16618 a sync call. There is only a possibility of losing data if the
16619 operating system itself that Samba is running on crashes, so there is
16620 little danger in this default setting. In addition, this fixes many
16621 performance problems that people have reported with the new Windows98
16622 explorer shell file copies.
</P
16637 >strict sync = no
</B
16647 >This is a boolean that controls whether to
16648 strip trailing dots off UNIX filenames. This helps with some
16649 CDROMs that have filenames ending in a single dot.
</P
16660 >sync always (S)
</DT
16663 >This is a boolean parameter that controls
16664 whether writes will always be written to stable storage before
16665 the write call returns. If this is false then the server will be
16666 guided by the client's request in each write call (clients can
16667 set a bit indicating that a particular write should be synchronous).
16668 If this is true then every write will be followed by a
<B
16672 > call to ensure the data is written to disk. Note that
16678 > parameter must be set to
16682 > in order for this parameter to have
16698 >sync always = no
</B
16708 >This parameter maps how Samba debug messages
16709 are logged onto the system syslog logging levels. Samba debug
16710 level zero maps onto syslog
<TT
16714 level one maps onto
<TT
16721 >, debug level three
16722 maps onto LOG_INFO. All higher levels are mapped to
<TT
16727 >This parameter sets the threshold for sending messages
16728 to syslog. Only messages with debug level less than this value
16729 will be sent to syslog.
</P
16740 >syslog only (G)
</DT
16743 >If this parameter is set then Samba debug
16744 messages are logged into the system syslog only, and not to
16745 the debug log files.
</P
16749 >syslog only = no
</B
16754 NAME=
"TEMPLATEHOMEDIR"
16756 >template homedir (G)
</DT
16761 > this parameter is
16762 only available in Samba
3.0.
</P
16764 >When filling out the user information for a Windows NT
16766 HREF=
"winbindd.8.html"
16770 uses this parameter to fill in the home directory for that user.
16776 > is present it is substituted
16777 with the user's Windows NT domain name. If the string
<TT
16783 > is present it is substituted with the user's Windows
16788 >template homedir = /home/%D/%U
</B
16793 NAME=
"TEMPLATESHELL"
16795 >template shell (G)
</DT
16800 > this parameter is
16801 only available in Samba
3.0.
</P
16803 >When filling out the user information for a Windows NT
16805 HREF=
"winbindd.8.html"
16809 uses this parameter to fill in the login shell for that user.
</P
16813 >template shell = /bin/false
</B
16820 >time offset (G)
</DT
16823 >This parameter is a setting in minutes to add
16824 to the normal GMT to local time conversion. This is useful if
16825 you are serving a lot of PCs that have incorrect daylight
16826 saving time handling.
</P
16830 >time offset =
0</B
16835 >time offset =
60</B
16842 >time server (G)
</DT
16845 >This parameter determines if
<A
16850 > advertises itself as a time server to Windows
16855 >time server = no
</B
16860 NAME=
"TIMESTAMPLOGS"
16862 >timestamp logs (G)
</DT
16866 HREF=
"#DEBUGTIMESTAMP"
16870 > debug timestamp
</I
16877 NAME=
"TOTALPRINTJOBS"
16879 >total print jobs (G)
</DT
16882 >This parameter accepts an integer value which defines
16883 a limit on the maximum number of print jobs that will be accepted
16884 system wide at any given time. If a print job is submitted
16885 by a client which will exceed this number, then smbd will return an
16886 error indicating that no space is available on the server. The
16887 default value of
0 means that no such limit exists. This parameter
16888 can be used to prevent a server from exceeding its capacity and is
16889 designed as a printing throttle. See also
16891 HREF=
"#MAXPRINTJOBS"
16903 >total print jobs =
0</B
16908 >total print jobs =
5000</B
16913 NAME=
"UNIXPASSWORDSYNC"
16915 >unix password sync (G)
</DT
16918 >This boolean parameter controls whether Samba
16919 attempts to synchronize the UNIX password with the SMB password
16920 when the encrypted SMB password in the smbpasswd file is changed.
16921 If this is set to true the program specified in the
<TT
16927 >parameter is called
<EM
16930 to allow the new UNIX password to be set without access to the
16931 old UNIX password (as the SMB password has change code has no
16932 access to the old password cleartext, only the new).
</P
16935 HREF=
"#PASSWDPROGRAM"
16955 >unix password sync = no
</B
16960 NAME=
"UPDATEENCRYPTED"
16962 >update encrypted (G)
</DT
16965 >This boolean parameter allows a user logging
16966 on with a plaintext password to have their encrypted (hashed)
16967 password in the smbpasswd file to be updated automatically as
16968 they log on. This option allows a site to migrate from plaintext
16969 password authentication (users authenticate with plaintext
16970 password over the wire, and are checked against a UNIX account
16971 database) to encrypted password authentication (the SMB
16972 challenge/response authentication mechanism) without forcing
16973 all users to re-enter their passwords via smbpasswd at the time the
16974 change is made. This is a convenience option to allow the change over
16975 to encrypted passwords to be made over a longer period. Once all users
16976 have encrypted representations of their passwords in the smbpasswd
16977 file this parameter should be set to
<TT
16982 >In order for this parameter to work correctly the
<A
16983 HREF=
"#ENCRYPTPASSWORDS"
16987 >encrypt passwords
</I
16991 > parameter must be set to
<TT
16995 this parameter is set to
<TT
17000 >Note that even when this parameter is set a user
17001 authenticating to
<B
17004 > must still enter a valid
17005 password in order to connect correctly, and to update their hashed
17006 (smbpasswd) passwords.
</P
17010 >update encrypted = no
</B
17017 >use rhosts (G)
</DT
17020 >If this global parameter is a true, it specifies
17021 that the UNIX users
<TT
17024 > file in their home directory
17025 will be read to find the names of hosts and users who will be allowed
17026 access without specifying a password.
</P
17036 > can be a major security hole. This is because you are
17037 trusting the PC to supply the correct username. It is very easy to
17038 get a PC to supply a false username. I recommend that the
<TT
17043 > option be only used if you really know what
17048 >use rhosts = no
</B
17092 >Multiple users may be specified in a comma-delimited
17093 list, in which case the supplied password will be tested against
17094 each username in turn (left to right).
</P
17101 > line is needed only when
17102 the PC is unable to supply its own username. This is the case
17103 for the COREPLUS protocol or where your users have different WfWg
17104 usernames to UNIX usernames. In both these cases you may also be
17105 better using the \\server\share%user syntax instead.
</P
17112 > line is not a great
17113 solution in many cases as it means Samba will try to validate
17114 the supplied password against each of the usernames in the
17120 > line in turn. This is slow and
17121 a bad idea for lots of users in case of duplicate passwords.
17122 You may get timeouts or security breaches using this parameter
17125 >Samba relies on the underlying UNIX security. This
17126 parameter does not restrict who can login, it just offers hints
17127 to the Samba server as to what usernames might correspond to the
17128 supplied password. Users can login as whoever they please and
17129 they will be able to do no more damage than if they started a
17130 telnet session. The daemon runs as the user that they log in as,
17131 so they cannot do anything that user cannot do.
</P
17133 >To restrict a service to a particular set of users you
17145 >If any of the usernames begin with a '@' then the name
17146 will be looked up first in the yp netgroups list (if Samba
17147 is compiled with netgroup support), followed by a lookup in
17148 the UNIX groups database and will expand to a list of all users
17149 in the group of that name.
</P
17151 >If any of the usernames begin with a '+' then the name
17152 will be looked up only in the UNIX groups database and will
17153 expand to a list of all users in the group of that name.
</P
17155 >If any of the usernames begin with a '
&'then the name
17156 will be looked up only in the yp netgroups database (if Samba
17157 is compiled with netgroup support) and will expand to a list
17158 of all users in the netgroup group of that name.
</P
17160 >Note that searching though a groups database can take
17161 quite some time, and some clients may time out during the
17164 >See the section
<A
17167 USERNAME/PASSWORD VALIDATION
</A
17168 > for more information on how
17169 this parameter determines access to the services.
</P
17173 >The guest account if a guest service,
17174 else
<empty string
>.
</B
17179 >username = fred, mary, jack, jane,
17180 @users, @pcgroup
</B
17185 NAME=
"USERNAMELEVEL"
17187 >username level (G)
</DT
17190 >This option helps Samba to try and 'guess' at
17191 the real UNIX username, as many DOS clients send an all-uppercase
17192 username. By default Samba tries all lowercase, followed by the
17193 username with the first letter capitalized, and fails if the
17194 username is not found on the UNIX machine.
</P
17196 >If this parameter is set to non-zero the behavior changes.
17197 This parameter is a number that specifies the number of uppercase
17198 combinations to try while trying to determine the UNIX user name. The
17199 higher the number the more combinations will be tried, but the slower
17200 the discovery of usernames will be. Use this parameter when you have
17201 strange usernames on your UNIX machine, such as
<TT
17209 >username level =
0</B
17214 >username level =
5</B
17221 >username map (G)
</DT
17224 >This option allows you to specify a file containing
17225 a mapping of usernames from the clients to the server. This can be
17226 used for several purposes. The most common is to map usernames
17227 that users use on DOS or Windows machines to those that the UNIX
17228 box uses. The other is to map multiple users to a single username
17229 so that they can more easily share files.
</P
17231 >The map file is parsed line by line. Each line should
17232 contain a single UNIX username on the left then a '=' followed
17233 by a list of usernames on the right. The list of usernames on the
17234 right may contain names of the form @group in which case they
17235 will match any UNIX username in that group. The special client
17236 name '*' is a wildcard and matches any name. Each line of the
17237 map file may be up to
1023 characters long.
</P
17239 >The file is processed on each line by taking the
17240 supplied username and comparing it with each username on the right
17241 hand side of the '=' signs. If the supplied name matches any of
17242 the names on the right hand side then it is replaced with the name
17243 on the left. Processing then continues with the next line.
</P
17245 >If any line begins with a '#' or a ';' then it is
17248 >If any line begins with an '!' then the processing
17249 will stop after that line if a mapping was done by the line.
17250 Otherwise mapping continues with every line being processed.
17251 Using '!' is most useful when you have a wildcard mapping line
17252 later in the file.
</P
17254 >For example to map from the name
<TT
17261 > to the UNIX name
<TT
17264 > you would use:
</P
17268 >root = admin administrator
</B
17271 >Or to map anyone in the UNIX group
<TT
17275 to the UNIX name
<TT
17278 > you would use:
</P
17285 >You can have as many mappings as you like in a username
17288 >If your system supports the NIS NETGROUP option then
17289 the netgroup database is checked before the
<TT
17293 > database for matching groups.
</P
17295 >You can map Windows usernames that have spaces in them
17296 by using double quotes around the name. For example:
</P
17300 >tridge =
"Andrew Tridgell"</B
17303 >would map the windows username
"Andrew Tridgell" to the
17304 unix username
"tridge".
</P
17306 >The following example would map mary and fred to the
17307 unix user sys, and map the rest to guest. Note the use of the
17308 '!' to tell Samba to stop processing if it gets a match on
17318 CLASS=
"PROGRAMLISTING"
17327 >Note that the remapping is applied to all occurrences
17328 of usernames. Thus if you connect to \\server\fred and
<TT
17331 > is remapped to
<TT
17335 will actually be connecting to \\server\mary and will need to
17336 supply a password suitable for
<TT
17343 >. The only exception to this is the
17344 username passed to the
<A
17345 HREF=
"#PASSWORDSERVER"
17349 > password server
</I
17352 > (if you have one). The password
17353 server will receive whatever username the client supplies without
17356 >Also note that no reverse mapping is done. The main effect
17357 this has is with printing. Users who have been mapped may have
17358 trouble deleting print jobs as PrintManager under WfWg will think
17359 they don't own the print job.
</P
17362 >no username map
</EM
17367 >username map = /usr/local/samba/lib/users.map
17378 >This boolean parameter is only available if
17379 Samba has been configured and compiled with the option
<B
17382 >. If set to True then Samba will attempt
17383 to add utmp or utmpx records (depending on the UNIX system) whenever a
17384 connection is made to a Samba server. Sites may use this to record the
17385 user connecting to a Samba share.
</P
17388 HREF=
"#UTMPDIRECTORY"
17392 > utmp directory
</I
17404 NAME=
"UTMPDIRECTORY"
17406 >utmp directory(G)
</DT
17409 >This parameter is only available if Samba has
17410 been configured and compiled with the option
<B
17413 >. It specifies a directory pathname that is
17414 used to store the utmp or utmpx files (depending on the UNIX system) that
17415 record user connections to a Samba server. See also the
<A
17423 > parameter. By default this is
17424 not set, meaning the system will use whatever utmp file the
17425 native system is set to use (usually
17432 >no utmp directory
</EM
17439 >valid chars (G)
</DT
17442 >The option allows you to specify additional
17443 characters that should be considered valid by the server in
17444 filenames. This is particularly useful for national character
17445 sets, such as adding u-umlaut or a-ring.
</P
17447 >The option takes a list of characters in either integer
17448 or character form with spaces between them. If you give two
17449 characters with a colon between them then it will be taken as
17450 an lowercase:uppercase pair.
</P
17452 >If you have an editor capable of entering the characters
17453 into the config file then it is probably easiest to use this
17454 method. Otherwise you can specify the characters in octal,
17455 decimal or hexadecimal form using the usual C notation.
</P
17457 >For example to add the single character 'Z' to the charset
17458 (which is a pointless thing to do as it's already there) you could
17459 do one of the following
</P
17468 CLASS=
"PROGRAMLISTING"
17471 valid chars =
0132:
0172
17478 >The last two examples above actually add two characters,
17479 and alter the uppercase and lowercase mappings appropriately.
</P
17483 > specify this parameter
17487 >client code page
</I
17490 have both set. If
<TT
17493 >client code page
</I
17501 > parameter the
<TT
17507 > settings will be overwritten.
</P
17510 HREF=
"#CLIENTCODEPAGE"
17521 >Samba defaults to using a reasonable set
17522 of valid characters for English systems
</EM
17527 >valid chars =
0345:
0305 0366:
0326 0344:
0304
17531 >The above example allows filenames to have the Swedish
17532 characters in them.
</P
17536 > It is actually quite difficult to
17537 correctly produce a
<TT
17543 a particular system. To automate the process
<A
17544 HREF=
"mailto:tino@augsburg.net"
17546 >tino@augsburg.net
</A
17548 a package called
<B
17551 > which will automatically
17552 produce a complete
<TT
17558 a given client system. Look in the
<TT
17560 >examples/validchars/
17562 > subdirectory of your Samba source code distribution
17563 for this package.
</P
17569 >valid users (S)
</DT
17572 >This is a list of users that should be allowed
17573 to login to this service. Names starting with '@', '+' and '
&'
17574 are interpreted using the same rules as described in the
17582 >If this is empty (the default) then any user can login.
17583 If a username is in both this list and the
<TT
17589 > list then access is denied for that user.
</P
17591 >The current servicename is substituted for
<TT
17597 >. This is useful in the [homes] section.
</P
17600 HREF=
"#INVALIDUSERS"
17611 >No valid users list (anyone can login)
17617 >valid users = greg, @pcusers
</B
17627 >This is a list of files and directories that
17628 are neither visible nor accessible. Each entry in the list must
17629 be separated by a '/', which allows spaces to be included
17630 in the entry. '*' and '?' can be used to specify multiple files
17631 or directories as in DOS wildcards.
</P
17633 >Each entry must be a unix path, not a DOS path and
17636 > include the unix directory
17645 is applicable in vetoing files.
</P
17647 >One feature of the veto files parameter that it is important
17648 to be aware of, is that if a directory contains nothing but files
17649 that match the veto files parameter (which means that Windows/DOS
17650 clients cannot ever see them) is deleted, the veto files within
17652 >are automatically deleted
</EM
17654 with it, if the user has UNIX permissions to do so.
</P
17656 >Setting this parameter will affect the performance
17657 of Samba, as it will be forced to check all files and directories
17658 for a match as they are scanned.
</P
17670 HREF=
"#CASESENSITIVE"
17674 > case sensitive
</I
17680 >No files or directories are vetoed.
17691 CLASS=
"PROGRAMLISTING"
17692 > ; Veto any files containing the word Security,
17693 ; any ending in .tmp, and any directory containing the
17695 veto files = /*Security*/*.tmp/*root*/
17697 ; Veto the Apple specific files that a NetAtalk server
17699 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
17708 NAME=
"VETOOPLOCKFILES"
17710 >veto oplock files (S)
</DT
17713 >This parameter is only valid when the
<A
17722 parameter is turned on for a share. It allows the Samba administrator
17723 to selectively turn off the granting of oplocks on selected files that
17724 match a wildcarded list, similar to the wildcarded list used in the
17737 >No files are vetoed for oplock
17741 >You might want to do this on files that you know will
17742 be heavily contended for by clients. A good example of this
17743 is in the NetBench SMB benchmark program, which causes heavy
17744 client contention for files ending in
<TT
17748 To cause Samba not to grant oplocks on these files you would use
17749 the line (either in the [global] section or in the section for
17750 the particular NetBench share :
</P
17754 >veto oplock files = /*;.SEM/
17762 >vfs object (S)
</DT
17765 >This parameter specifies a shared object file that
17766 is used for Samba VFS I/O operations. By default, normal
17767 disk I/O operations are used but these can be overloaded
17768 with a VFS object. The Samba VFS layer is new to Samba
2.2 and
17769 must be enabled at compile time with --with-vfs.
</P
17779 >vfs options (S)
</DT
17782 >This parameter allows parameters to be passed
17783 to the vfs layer at initialisation time. The Samba VFS layer
17784 is new to Samba
2.2 and must be enabled at compile time
17785 with --with-vfs. See also
<A
17806 > This allows you to override the volume label
17807 returned for a share. Useful for CDROMs with installation programs
17808 that insist on a particular volume label.
</P
17811 >the name of the share
</EM
17818 >wide links (S)
</DT
17821 >This parameter controls whether or not links
17822 in the UNIX file system may be followed by the server. Links
17823 that point to areas within the directory tree exported by the
17824 server are always allowed; this parameter controls access only
17825 to areas that are outside the directory tree being exported.
</P
17827 >Note that setting this parameter can have a negative
17828 effect on your server performance due to the extra system calls
17829 that Samba has to do in order to perform the link checks.
</P
17833 >wide links = yes
</B
17838 NAME=
"WINBINDCACHETIME"
17840 >winbind cache time
</DT
17845 > this parameter is only
17846 available in Samba
3.0.
</P
17848 >This parameter specifies the number of seconds the
17850 HREF=
"winbindd.8.html"
17853 > daemon will cache
17854 user and group information before querying a Windows NT server
17859 >winbind cache type =
15</B
17871 > this parameter is only
17872 available in Samba
3.0.
</P
17874 >The winbind gid parameter specifies the range of group
17875 ids that are allocated by the
<A
17876 HREF=
"winbindd.8.html"
17879 > daemon. This range of group ids should have no
17880 existing local or nis groups within it as strange conflicts can
17881 occur otherwise.
</P
17885 >winbind gid =
<empty string
>
17891 >winbind gid =
10000-
20000</B
17896 NAME=
"WINBINDSEPARATOR"
17898 >winbind separator
</DT
17903 > this parameter is only
17904 available in Samba
3.0.
</P
17906 >This parameter allows an admin to define the character
17907 used when listing a username of the form of
<TT
17908 CLASS=
"REPLACEABLE"
17914 CLASS=
"REPLACEABLE"
17919 is only applicable when using the
<TT
17921 >pam_winbind.so
</TT
17925 >nss_winbind.so
</TT
17926 > modules for UNIX services.
17931 >winbind separator = \
</B
17936 >winbind separator = +
</B
17948 > this parameter is only
17949 available in Samba
3.0.
</P
17951 >The winbind gid parameter specifies the range of group
17952 ids that are allocated by the
<A
17953 HREF=
"winbindd.8.html"
17956 > daemon. This range of ids should have no
17957 existing local or nis users within it as strange conflicts can
17958 occur otherwise.
</P
17962 >winbind uid =
<empty string
>
17968 >winbind uid =
10000-
20000</B
17978 >When Samba is running as a WINS server this
17979 allows you to call an external program for all changes to the
17980 WINS database. The primary use for this option is to allow the
17981 dynamic update of external name resolution databases such as
17984 >The wins hook parameter specifies the name of a script
17985 or executable that will be called as follows:
</P
17989 >wins_hook operation name nametype ttl IP_list
17997 >The first argument is the operation and is one
17998 of
"add",
"delete", or
"refresh". In most cases the operation can
17999 be ignored as the rest of the parameters provide sufficient
18000 information. Note that
"refresh" may sometimes be called when the
18001 name has not previously been added, in that case it should be treated
18006 >The second argument is the netbios name. If the
18007 name is not a legal name then the wins hook is not called.
18008 Legal names contain only letters, digits, hyphens, underscores
18013 >The third argument is the netbios name
18014 type as a
2 digit hexadecimal number.
</P
18018 >The fourth argument is the TTL (time to live)
18019 for the name in seconds.
</P
18023 >The fifth and subsequent arguments are the IP
18024 addresses currently registered for that name. If this list is
18025 empty then the name should be deleted.
</P
18029 >An example script that calls the BIND dynamic DNS update
18033 > is provided in the examples
18034 directory of the Samba source code.
</P
18040 >wins proxy (G)
</DT
18043 >This is a boolean that controls if
<A
18047 > will respond to broadcast name
18048 queries on behalf of other hosts. You may need to set this
18052 > for some older clients.
</P
18056 >wins proxy = no
</B
18063 >wins server (G)
</DT
18066 >This specifies the IP address (or DNS name: IP
18067 address for preference) of the WINS server that
<A
18071 > should register with. If you have a WINS server on
18072 your network then you should set this to the WINS server's IP.
</P
18074 >You should point this at your WINS server if you have a
18075 multi-subnetted network.
</P
18079 >. You need to set up Samba to point
18080 to a WINS server if you have multiple subnets and wish cross-subnet
18081 browsing to work correctly.
</P
18083 >See the documentation file
<TT
18087 in the docs/ directory of your Samba source distribution.
</P
18095 >wins server =
192.9.200.1</B
18102 >wins support (G)
</DT
18105 >This boolean controls if the
<A
18110 > process in Samba will act as a WINS server. You should
18111 not set this to true unless you have a multi-subnetted network and
18112 you wish a particular
<B
18115 > to be your WINS server.
18116 Note that you should
<EM
18119 on more than one machine in your network.
</P
18123 >wins support = no
</B
18133 >This controls what workgroup your server will
18134 appear to be in when queried by clients. Note that this parameter
18135 also controls the Domain name used with the
<A
18136 HREF=
"#SECURITYEQUALSDOMAIN"
18139 >security=domain
</B
18145 >set at compile time to WORKGROUP
</EM
18150 >workgroup = MYGROUP
</B
18168 > for people who can't spell :-).
</P
18172 NAME=
"WRITECACHESIZE"
18174 >write cache size (S)
</DT
18177 >If this integer parameter is set to non-zero value,
18178 Samba will create an in-memory cache for each oplocked file
18182 non-oplocked files). All writes that the client does not request
18183 to be flushed directly to disk will be stored in this cache if possible.
18184 The cache is flushed onto disk when a write comes in whose offset
18185 would not fit into the cache or when the file is closed by the client.
18186 Reads for the file are also served from this cache if the data is stored
18189 >This cache allows Samba to batch client writes into a more
18190 efficient write size for RAID disks (ie. writes may be tuned to
18191 be the RAID stripe size) and can improve performance on systems
18192 where the disk subsystem is a bottleneck but there is free
18193 memory for userspace programs.
</P
18195 >The integer parameter specifies the size of this cache
18196 (per oplocked file) in bytes.
</P
18200 >write cache size =
0</B
18205 >write cache size =
262144</B
18208 >for a
256k cache size per file.
</P
18214 >write list (S)
</DT
18217 >This is a list of users that are given read-write
18218 access to a service. If the connecting user is in this list then
18219 they will be given write access, no matter what the
<A
18228 option is set to. The list can include group names using the
18231 >Note that if a user is in both the read list and the
18232 write list then they will be given write access.
</P
18247 >write list =
<empty string
>
18253 >write list = admin, root, @staff
18281 >This parameter controls whether or not the server
18282 will support raw writes SMB's when transferring data from clients.
18283 You should never need to change this parameter.
</P
18287 >write raw = yes
</B
18297 >An inverted synonym is
<A
18307 >If this parameter is
<TT
18311 of a service may not create or modify files in the service's
18314 >Note that a printable service (
<B
18316 >printable = yes
</B
18320 > allow writing to the directory
18321 (user privileges permitting), but only via spooling operations.
</P
18339 >Although the configuration file permits service names
18340 to contain spaces, your client software may not. Spaces will
18341 be ignored in comparisons anyway, so it shouldn't be a
18342 problem - but be aware of the possibility.
</P
18344 >On a similar note, many clients - especially DOS clients -
18345 limit service names to eight characters.
<A
18350 > has no such limitation, but attempts to connect from such
18351 clients will fail if they truncate the service names. For this reason
18352 you should probably keep your service names down to eight characters
18355 >Use of the [homes] and [printers] special sections make life
18356 for an administrator easy, but the various combinations of default
18357 attributes can be tricky. Take extreme care when designing these
18358 sections. In particular, ensure that the permissions on spool
18359 directories are correct.
</P
18369 >This man page is correct for version
2.2 of
18370 the Samba suite.
</P
18381 HREF=
"samba.7.html"
18386 HREF=
"smbpasswd.8.html"
18418 HREF=
"smbclient.1.html"
18426 HREF=
"nmblookup.1.html"
18434 HREF=
"testparm.1.html"
18442 HREF=
"testprns.1.html"
18459 >The original Samba software and related utilities
18460 were created by Andrew Tridgell. Samba is now developed
18461 by the Samba Team as an Open Source project similar
18462 to the way the Linux kernel is developed.
</P
18464 >The original Samba man pages were written by Karl Auer.
18465 The man page sources were converted to YODL format (another
18466 excellent piece of Open Source software, available at
18468 HREF=
"ftp://ftp.icce.rug.nl/pub/unix/"
18470 > ftp://ftp.icce.rug.nl/pub/unix/
</A
18471 >) and updated for the Samba
2.0
18472 release by Jeremy Allison. The conversion to DocBook for
18473 Samba
2.2 was done by Gerald Carter
</P