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
342 the [homes] section will hide the [homes] share but make
343 any auto home directories visible.
</P
351 >The [printers] section
</H3
353 >This section works like [homes],
356 >If a [printers] section occurs in the
357 configuration file, users are able to connect to any printer
358 specified in the local host's printcap file.
</P
360 >When a connection request is made, the existing sections
361 are scanned. If a match is found, it is used. If no match is found,
362 but a [homes] section exists, it is used as described
363 above. Otherwise, the requested section name is treated as a
364 printer name and the appropriate printcap file is scanned to see
365 if the requested section name is a valid printer share name. If
366 a match is found, a new printer share is created by cloning
367 the [printers] section.
</P
369 >A few modifications are then made to the newly created
376 >The share name is set to the located printer
381 >If no printer name was given, the printer name
382 is set to the located printer name
</P
386 >If the share does not permit guest access and
387 no username was given, the username is set to the located
392 >Note that the [printers] service MUST be
393 printable - if you specify otherwise, the server will refuse
394 to load the configuration file.
</P
396 >Typically the path specified would be that of a
397 world-writeable spool directory with the sticky bit set on
398 it. A typical [printers] entry would look like
409 CLASS=
"COMPUTEROUTPUT"
411 path = /usr/spool/public
420 >All aliases given for a printer in the printcap file
421 are legitimate printer names as far as the server is concerned.
422 If your printing subsystem doesn't work like that, you will have
423 to set up a pseudo-printcap. This is a file consisting of one or
424 more lines like this:
</P
434 CLASS=
"COMPUTEROUTPUT"
435 > alias|alias|alias|alias...
443 >Each alias should be an acceptable printer name for
444 your printing subsystem. In the [global] section, specify
445 the new file as your printcap. The server will then only recognize
446 names found in your pseudo-printcap, which of course can contain
447 whatever aliases you like. The same technique could be used
448 simply to limit access to a subset of your local printers.
</P
450 >An alias, by the way, is defined as any component of the
451 first entry of a printcap record. Records are separated by newlines,
452 components (if there are more than one) are separated by vertical
453 bar symbols ('|').
</P
455 >NOTE: On SYSV systems which use lpstat to determine what
456 printers are defined on the system you may be able to use
457 "printcap name = lpstat" to automatically obtain a list
458 of printers. See the
"printcap name" option
470 >parameters define the specific attributes of sections.
</P
472 >Some parameters are specific to the [global] section
475 >). Some parameters are usable
476 in all sections (e.g.,
<EM
479 are permissible only in normal sections. For the purposes of the
480 following descriptions the [homes] and [printers]
481 sections will be considered normal. The letter
<EM
484 in parentheses indicates that a parameter is specific to the
485 [global] section. The letter
<EM
488 indicates that a parameter can be specified in a service specific
489 section. Note that all
<EM
491 > parameters can also be specified in
492 the [global] section - in which case they will define
493 the default behavior for all services.
</P
495 >parameters are arranged here in alphabetical order - this may
496 not create best bedfellows, but at least you can find them! Where
497 there are synonyms, the preferred synonym is described, others refer
498 to the preferred synonym.
</P
506 >VARIABLE SUBSTITUTIONS
</H2
508 >Many of the strings that are settable in the config file
509 can take substitutions. For example the option
"path =
510 /tmp/%u" would be interpreted as
"path =
511 /tmp/john" if the user connected with the username john.
</P
513 >These substitutions are mostly noted in the descriptions below,
514 but there are some general substitutions which apply whenever they
515 might be relevant. These are:
</P
525 >the name of the current service, if any.
</P
531 >the root directory of the current service,
538 >user name of the current service, if any.
</P
544 >primary group name of %u.
</P
550 >session user name (the user name that the client
551 wanted, not necessarily the same as the one they got).
</P
557 >primary group name of %U.
</P
563 >the home directory of the user given
570 >the Samba version.
</P
576 >the Internet hostname that Samba is running
583 >the NetBIOS name of the client machine
590 >the NetBIOS name of the server. This allows you
591 to change your config based on what the client calls you. Your
592 server can have a
"dual personality".
</P
598 >the Internet name of the client machine.
605 >the name of your NIS home directory server.
606 This is obtained from your NIS auto.map entry. If you have
607 not compiled Samba with the
<EM
608 >--with-automount
</EM
610 option then this value will be the same as %L.
</P
616 >the path of the service's home directory,
617 obtained from your NIS auto.map entry. The NIS auto.map entry
618 is split up as
"%N:%p".
</P
624 >the selected protocol level after
625 protocol negotiation. It can be one of CORE, COREPLUS,
626 LANMAN1, LANMAN2 or NT1.
</P
632 >The process id of the current server
639 >the architecture of the remote
640 machine. Only some are recognized, and those may not be
641 100% reliable. It currently recognizes Samba, WfWg,
642 WinNT and Win95. Anything else will be known as
643 "UNKNOWN". If it gets it wrong then sending a level
645 HREF=
"mailto:samba@samba.org"
649 > should allow it to be fixed.
</P
655 >The IP address of the client machine.
</P
661 >the current date and time.
</P
672 >The value of the environment variable
683 >There are some quite creative things that can be done
684 with these substitutions and other smb.conf options.
</P
694 >Samba supports
"name mangling" so that DOS and
695 Windows clients can use files that don't conform to the
8.3 format.
696 It can also be set to adjust the case of
8.3 format filenames.
</P
698 >There are several options that control the way mangling is
699 performed, and they are grouped here rather than listed separately.
700 For the defaults look at the output of the testparm program.
</P
702 >All of these options can be set separately for each service
703 (or globally, of course).
</P
705 >The options are:
</P
712 >mangle case = yes/no
</DT
715 > controls if names that have characters that
716 aren't of the
"default" case are mangled. For example,
717 if this is yes then a name like
"Mail" would be mangled.
723 >case sensitive = yes/no
</DT
726 >controls whether filenames are case sensitive. If
727 they aren't then Samba must do a filename search and match on passed
733 >default case = upper/lower
</DT
736 >controls what the default case is for new
737 filenames. Default
<EM
742 >preserve case = yes/no
</DT
745 >controls if new files are created with the
746 case that the client passes, or if they are forced to be the
747 "default" case. Default
<EM
753 >short preserve case = yes/no
</DT
756 >controls if new files which conform to
8.3 syntax,
757 that is all in upper case and of suitable length, are created
758 upper case, or if they are forced to be the
"default"
759 case. This option can be use with
"preserve case = yes"
760 to permit long filenames to retain their case, while short names
761 are lowercased. Default
<EM
768 >By default, Samba
2.2 has the same semantics as a Windows
769 NT server, in that it is case insensitive but case preserving.
</P
777 >NOTE ABOUT USERNAME/PASSWORD VALIDATION
</H2
779 >There are a number of ways in which a user can connect
780 to a service. The server uses the following steps in determining
781 if it will allow a connection to a specified service. If all the
782 steps fail, then the connection request is rejected. However, if one of the
783 steps succeeds, then the following steps are not checked.
</P
785 >If the service is marked
"guest only = yes" then
786 steps
1 to
5 are skipped.
</P
793 >If the client has passed a username/password
794 pair and that username/password pair is validated by the UNIX
795 system's password programs then the connection is made as that
796 username. Note that this includes the
807 >If the client has previously registered a username
808 with the system and now supplies a correct password for that
809 username then the connection is allowed.
</P
813 >The client's NetBIOS name and any previously
814 used user names are checked against the supplied password, if
815 they match then the connection is allowed as the corresponding
820 >If the client has previously validated a
821 username/password pair with the server and the client has passed
822 the validation token then that username is used.
</P
826 >If a
"user = " field is given in the
830 > file for the service and the client
831 has supplied a password, and that password matches (according to
832 the UNIX system's password checking) with one of the usernames
833 from the
"user =" field then the connection is made as
834 the username in the
"user =" line. If one
835 of the username in the
"user =" list begins with a
836 '@' then that name expands to a list of names in
837 the group of the same name.
</P
841 >If the service is a guest service then a
842 connection is made as the username given in the
"guest
843 account =" for the service, irrespective of the
844 supplied password.
</P
854 >COMPLETE LIST OF GLOBAL PARAMETERS
</H2
856 >Here is a list of all global parameters. See the section of
857 each parameter for details. Note that some are synonyms.
</P
864 HREF=
"#ABORTSHUTDOWNSCRIPT"
868 >abort shutdown script
</I
876 HREF=
"#ADDPRINTERCOMMAND"
880 >add printer command
</I
888 HREF=
"#ADDSHARECOMMAND"
892 >add share command
</I
900 HREF=
"#ADDUSERSCRIPT"
912 HREF=
"#ADDMACHINESCRIPT"
916 >add machine script
</I
924 HREF=
"#ALLOWTRUSTEDDOMAINS"
928 >allow trusted domains
</I
948 HREF=
"#ANNOUNCEVERSION"
972 HREF=
"#BINDINTERFACESONLY"
976 >bind interfaces only
</I
996 HREF=
"#CHANGENOTIFYTIMEOUT"
1000 >change notify timeout
</I
1008 HREF=
"#CHANGESHARECOMMAND"
1012 >change share command
</I
1020 HREF=
"#CHARACTERSET"
1032 HREF=
"#CLIENTCODEPAGE"
1036 >client code page
</I
1044 HREF=
"#CODEPAGEDIRECTORY"
1048 >code page directory
</I
1056 HREF=
"#CODINGSYSTEM"
1092 HREF=
"#DEBUGHIRESTIMESTAMP"
1096 >debug hires timestamp
</I
1116 HREF=
"#DEBUGTIMESTAMP"
1164 HREF=
"#DEFAULTSERVICE"
1176 HREF=
"#DELETEPRINTERCOMMAND"
1180 >delete printer command
</I
1188 HREF=
"#DELETESHARECOMMAND"
1192 >delete share command
</I
1200 HREF=
"#DELETEUSERSCRIPT"
1204 >delete user script
</I
1212 HREF=
"#DFREECOMMAND"
1224 HREF=
"#DISABLESPOOLSS"
1248 HREF=
"#DOMAINADMINGROUP"
1252 >domain admin group
</I
1260 HREF=
"#DOMAINGUESTGROUP"
1264 >domain guest group
</I
1272 HREF=
"#DOMAINLOGONS"
1284 HREF=
"#DOMAINMASTER"
1296 HREF=
"#ENCRYPTPASSWORDS"
1300 >encrypt passwords
</I
1308 HREF=
"#ENHANCEDBROWSING"
1312 >enhanced browsing
</I
1320 HREF=
"#ENUMPORTSCOMMAND"
1324 >enumports command
</I
1344 HREF=
"#HIDELOCALUSERS"
1348 >hide local users
</I
1356 HREF=
"#HIDEUNREADABLE"
1428 HREF=
"#KERNELOPLOCKS"
1452 HREF=
"#LARGEREADWRITE"
1488 HREF=
"#LOADPRINTERS"
1524 HREF=
"#LOCKDIRECTORY"
1608 HREF=
"#LPQCACHETIME"
1620 HREF=
"#MACHINEPASSWORDTIMEOUT"
1624 >machine password timeout
</I
1632 HREF=
"#MANGLEDSTACK"
1692 HREF=
"#MAXOPENFILES"
1716 HREF=
"#MAXSMBDPROCESSES"
1720 >max smbd processes
</I
1764 HREF=
"#MESSAGECOMMAND"
1776 HREF=
"#MINPASSWDLENGTH"
1780 >min passwd length
</I
1788 HREF=
"#MINPASSWORDLENGTH"
1792 >min password length
</I
1824 HREF=
"#NAMERESOLVEORDER"
1828 >name resolve order
</I
1836 HREF=
"#NETBIOSALIASES"
1860 HREF=
"#NETBIOSSCOPE"
1884 HREF=
"#NTACLSUPPORT"
1896 HREF=
"#NTPIPESUPPORT"
1908 HREF=
"#NTSMBSUPPORT"
1920 HREF=
"#NULLPASSWORDS"
1932 HREF=
"#OBEYPAMRESTRICTIONS"
1936 >obey pam restrictions
</I
1944 HREF=
"#OPLOCKBREAKWAITTIME"
1948 >oplock break wait time
</I
1968 HREF=
"#OS2DRIVERMAP"
1980 HREF=
"#PAMPASSWORDCHANGE"
1984 >pam password change
</I
2016 HREF=
"#PASSWDCHATDEBUG"
2020 >passwd chat debug
</I
2028 HREF=
"#PASSWDPROGRAM"
2040 HREF=
"#PASSWORDLEVEL"
2052 HREF=
"#PASSWORDSERVER"
2064 HREF=
"#PREFEREDMASTER"
2076 HREF=
"#PREFERREDMASTER"
2080 >preferred master
</I
2112 HREF=
"#PRINTCAPNAME"
2124 HREF=
"#PRINTERDRIVERFILE"
2128 >printer driver file
</I
2184 HREF=
"#REMOTEANNOUNCE"
2196 HREF=
"#REMOTEBROWSESYNC"
2200 >remote browse sync
</I
2208 HREF=
"#RESTRICTANONYMOUS"
2212 >restrict anonymous
</I
2244 HREF=
"#ROOTDIRECTORY"
2268 HREF=
"#SERVERSTRING"
2280 HREF=
"#SHOWADDPRINTERWIZARD"
2284 >show add printer wizard
</I
2292 HREF=
"#SHUTDOWNSCRIPT"
2304 HREF=
"#SMBPASSWDFILE"
2316 HREF=
"#SOCKETADDRESS"
2328 HREF=
"#SOCKETOPTIONS"
2340 HREF=
"#SOURCEENVIRONMENT"
2344 >source environment
</I
2364 HREF=
"#SSLCACERTDIR"
2376 HREF=
"#SSLCACERTFILE"
2400 HREF=
"#SSLCLIENTCERT"
2412 HREF=
"#SSLCLIENTKEY"
2424 HREF=
"#SSLCOMPATIBILITY"
2428 >ssl compatibility
</I
2448 HREF=
"#SSLHOSTSRESIGN"
2452 >ssl hosts resign
</I
2460 HREF=
"#SSLREQUIRECLIENTCERT"
2464 >ssl require clientcert
</I
2472 HREF=
"#SSLREQUIRESERVERCERT"
2476 >ssl require servercert
</I
2484 HREF=
"#SSLSERVERCERT"
2496 HREF=
"#SSLSERVERKEY"
2532 HREF=
"#STATCACHESIZE"
2580 HREF=
"#TEMPLATEHOMEDIR"
2584 >template homedir
</I
2592 HREF=
"#TEMPLATESHELL"
2628 HREF=
"#TIMESTAMPLOGS"
2640 HREF=
"#TOTALPRINTJOBS"
2644 >total print jobs
</I
2652 HREF=
"#UNIXPASSWORDSYNC"
2656 >unix password sync
</I
2664 HREF=
"#UPDATEENCRYPTED"
2668 >update encrypted
</I
2688 HREF=
"#USERNAMELEVEL"
2724 HREF=
"#UTMPDIRECTORY"
2748 HREF=
"#WINBINDCACHETIME"
2752 >winbind cache time
</I
2772 HREF=
"#WINBINDSEPARATOR"
2776 >winbind separator
</I
2873 >COMPLETE LIST OF SERVICE PARAMETERS
</H2
2875 >Here is a list of all service parameters. See the section on
2876 each parameter for details. Note that some are synonyms.
</P
2919 HREF=
"#BLOCKINGLOCKS"
2955 HREF=
"#CASESENSITIVE"
2967 HREF=
"#CASESIGNAMES"
3039 HREF=
"#DELETEREADONLY"
3051 HREF=
"#DELETEVETOFILES"
3055 >delete veto files
</I
3087 HREF=
"#DIRECTORYMASK"
3099 HREF=
"#DIRECTORYMODE"
3111 HREF=
"#DIRECTORYSECURITYMASK"
3115 >directory security mask
</I
3147 HREF=
"#DOSFILETIMERESOLUTION"
3151 >dos filetime resolution
</I
3159 HREF=
"#DOSFILETIMES"
3183 HREF=
"#FAKEDIRECTORYCREATETIMES"
3187 >fake directory create times
</I
3207 HREF=
"#FOLLOWSYMLINKS"
3219 HREF=
"#FORCECREATEMODE"
3223 >force create mode
</I
3231 HREF=
"#FORCEDIRECTORYMODE"
3235 >force directory mode
</I
3243 HREF=
"#FORCEDIRECTORYSECURITYMODE"
3247 >force directory security mode
</I
3267 HREF=
"#FORCESECURITYMODE"
3271 >force security mode
</I
3315 HREF=
"#GUESTACCOUNT"
3351 HREF=
"#HIDEDOTFILES"
3411 HREF=
"#INHERITPERMISSIONS"
3415 >inherit permissions
</I
3423 HREF=
"#INVALIDUSERS"
3435 HREF=
"#LEVEL2OPLOCKS"
3459 HREF=
"#LPPAUSECOMMAND"
3483 HREF=
"#LPRESUMECOMMAND"
3487 >lpresume command
</I
3555 HREF=
"#MANGLEDNAMES"
3567 HREF=
"#MANGLINGCHAR"
3615 HREF=
"#MAXCONNECTIONS"
3627 HREF=
"#MAXPRINTJOBS"
3639 HREF=
"#MINPRINTSPACE"
3687 HREF=
"#OPLOCKCONTENTIONLIMIT"
3691 >oplock contention limit
</I
3723 HREF=
"#POSIXLOCKING"
3771 HREF=
"#PREEXECCLOSE"
3783 HREF=
"#PRESERVECASE"
3795 HREF=
"#PRINTCOMMAND"
3843 HREF=
"#PRINTERADMIN"
3855 HREF=
"#PRINTERDRIVER"
3867 HREF=
"#PRINTERDRIVERLOCATION"
3871 >printer driver location
</I
3915 HREF=
"#QUEUEPAUSECOMMAND"
3919 >queuepause command
</I
3927 HREF=
"#QUEUERESUMECOMMAND"
3931 >queueresume command
</I
3963 HREF=
"#ROOTPOSTEXEC"
3987 HREF=
"#ROOTPREEXECCLOSE"
3991 >root preexec close
</I
3999 HREF=
"#SECURITYMASK"
4011 HREF=
"#SETDIRECTORY"
4023 HREF=
"#SHORTPRESERVECASE"
4027 >short preserve case
</I
4047 HREF=
"#STRICTLOCKING"
4083 HREF=
"#USECLIENTDRIVER"
4087 >use client driver
</I
4155 HREF=
"#VETOOPLOCKFILES"
4159 >veto oplock files
</I
4227 HREF=
"#WRITECACHESIZE"
4231 >write cache size
</I
4280 >EXPLANATION OF EACH PARAMETER
</H2
4284 CLASS=
"VARIABLELIST"
4288 NAME=
"ABORTSHUTDOWNSCRIPT"
4290 >abort shutdown script (G)
</DT
4294 >This parameter only exists in the HEAD cvs branch
</EM
4296 This a full path name to a script called by
4305 should stop a shutdown procedure issued by the
<A
4306 HREF=
"#SHUTDOWNSCRIPT"
4315 >This command will be run as user.
</P
4323 >abort shutdown script = /sbin/shutdown -c
</B
4328 NAME=
"ADDPRINTERCOMMAND"
4330 >add printer command (G)
</DT
4333 >With the introduction of MS-RPC based printing
4334 support for Windows NT/
2000 clients in Samba
2.2, The MS Add
4335 Printer Wizard (APW) icon is now also available in the
4336 "Printers..." folder displayed a share listing. The APW
4337 allows for printers to be add remotely to a Samba or Windows
4338 NT/
2000 print server.
</P
4340 >For a Samba host this means that the printer must be
4341 physically added to the underlying printing system. The
<TT
4347 > defines a script to be run which
4348 will perform the necessary operations for adding the printer
4349 to the print system and to add the appropriate service definition
4353 > file in order that it can be
4367 >add printer command
</I
4370 automatically invoked with the following parameter (in
4425 >Windows
9x driver location
</I
4432 >All parameters are filled in from the PRINTER_INFO_2 structure sent
4433 by the Windows NT/
2000 client with one exception. The
"Windows 9x
4434 driver location" parameter is included for backwards compatibility
4435 only. The remaining fields in the structure are generated from answers
4436 to the APW questions.
</P
4441 >add printer command
</I
4447 > will reparse the
<TT
4450 > to determine if the share defined by the APW
4451 exists. If the sharename is still invalid, then
<B
4455 > will return an ACCESS_DENIED error to the client.
</P
4458 HREF=
"#DELETEPRINTERCOMMAND"
4462 > delete printer command
</I
4475 HREF=
"#SHOWADDPRINTERWIZARD"
4491 >addprinter command = /usr/bin/addprinter
4497 NAME=
"ADDSHARECOMMAND"
4499 >add share command (G)
</DT
4502 >Samba
2.2.0 introduced the ability to dynamically
4503 add and delete shares via the Windows NT
4.0 Server Manager. The
4507 >add share command
</I
4509 > is used to define an
4510 external program or script which will add a new service definition
4514 >. In order to successfully
4518 >add share command
</I
4524 requires that the administrator be connected using a root account (i.e.
4531 > will automatically invoke the
4535 >add share command
</I
4537 > with four parameters.
4563 > - the name of the new
4574 > - path to an **existing**
4585 > - comment string to associate
4591 > This parameter is only used for add file shares. To add printer shares,
4593 HREF=
"#ADDPRINTERCOMMAND"
4605 HREF=
"#CHANGESHARECOMMAND"
4614 HREF=
"#DELETESHARECOMMAND"
4631 >add share command = /usr/local/bin/addshare
</B
4636 NAME=
"ADDMACHINESCRIPT"
4638 >add machine script (G)
</DT
4641 >This is the full pathname to a script that will
4646 > when a machine is added
4647 to it's domain using the administrator username and password method.
</P
4649 >This option is only required when using sam back-ends tied to the
4650 Unix uid method of RID calculation such as smbpasswd. This option is only
4651 available in Samba
3.0.
</P
4655 >add machine script =
<empty string
>
4661 >add machine script = /usr/sbin/adduser -n -g machines -c Machine -d /dev/null -s /bin/false %u
4667 NAME=
"ADDUSERSCRIPT"
4669 >add user script (G)
</DT
4672 >This is the full pathname to a script that will
4680 > under special circumstances described below.
</P
4682 >Normally, a Samba server requires that UNIX users are
4683 created for all users accessing files on this server. For sites
4684 that use Windows NT account databases as their primary user database
4685 creating these users and keeping the user list in sync with the
4686 Windows NT PDC is an onerous task. This option allows
<A
4690 > to create the required UNIX users
4693 > when a user accesses the Samba server.
</P
4695 >In order to use this option,
<A
4703 >security = server
</I
4708 > security = domain
</I
4716 must be set to a full pathname for a script that will create a UNIX
4717 user given one argument of
<TT
4722 >, which expands into
4723 the UNIX user name to create.
</P
4725 >When the Windows user attempts to access the Samba server,
4726 at login (session setup in the SMB protocol) time,
<A
4736 attempts to authenticate the given user with the given password. If the
4737 authentication succeeds then
<B
4741 attempts to find a UNIX user in the UNIX password database to map the
4742 Windows user into. If this lookup fails, and
<TT
4752 call the specified script
<EM
4760 > argument to be the user name to create.
</P
4762 >If this script successfully creates the user then
<B
4766 > will continue on as though the UNIX user
4767 already existed. In this way, UNIX users are dynamically created to
4768 match existing Windows NT accounts.
</P
4779 HREF=
"#PASSWORDSERVER"
4788 HREF=
"#DELETEUSERSCRIPT"
4800 >add user script =
<empty string
>
4806 >add user script = /usr/local/samba/bin/add_user
4814 >admin users (S)
</DT
4817 >This is a list of users who will be granted
4818 administrative privileges on the share. This means that they
4819 will do all file operations as the super-user (root).
</P
4821 >You should use this option very carefully, as any user in
4822 this list will be able to do anything they like on the share,
4823 irrespective of file permissions.
</P
4831 >admin users = jason
</B
4838 >allow hosts (S)
</DT
4853 NAME=
"ALLOWTRUSTEDDOMAINS"
4855 >allow trusted domains (G)
</DT
4858 >This option only takes effect when the
<A
4874 If it is set to no, then attempts to connect to a resource from
4875 a domain or workgroup other than the one which
<A
4880 in will fail, even if that domain is trusted by the remote server
4881 doing the authentication.
</P
4883 >This is useful if you only want your Samba server to
4884 serve resources to users in the domain it is a member of. As
4885 an example, suppose that there are two domains DOMA and DOMB. DOMB
4886 is trusted by DOMA, which contains the Samba server. Under normal
4887 circumstances, a user with an account in DOMB can then access the
4888 resources of a UNIX account with the same account name on the
4889 Samba server even if they do not have an account in DOMA. This
4890 can make implementing a security boundary difficult.
</P
4894 >allow trusted domains = yes
</B
4901 >announce as (G)
</DT
4904 >This specifies what type of server
4913 will announce itself as, to a network neighborhood browse
4914 list. By default this is set to Windows NT. The valid options
4915 are :
"NT Server" (which can also be written as
"NT"),
4916 "NT Workstation",
"Win95" or
"WfW" meaning Windows NT Server,
4917 Windows NT Workstation, Windows
95 and Windows for Workgroups
4918 respectively. Do not change this parameter unless you have a
4919 specific need to stop Samba appearing as an NT server as this
4920 may prevent Samba servers from participating as browser servers
4925 >announce as = NT Server
</B
4930 >announce as = Win95
</B
4935 NAME=
"ANNOUNCEVERSION"
4937 >announce version (G)
</DT
4940 >This specifies the major and minor version numbers
4941 that nmbd will use when announcing itself as a server. The default
4942 is
4.2. Do not change this parameter unless you have a specific
4943 need to set a Samba server to be a downlevel server.
</P
4947 >announce version =
4.5</B
4952 >announce version =
2.0</B
4959 >auto services (G)
</DT
4962 >This is a synonym for the
<A
4979 >This parameter lets you
"turn off" a service. If
4988 attempts to connect to the service will fail. Such failures are
4998 NAME=
"BINDINTERFACESONLY"
5000 >bind interfaces only (G)
</DT
5003 >This global parameter allows the Samba admin
5004 to limit what interfaces on a machine will serve SMB requests. If
5005 affects file service
<A
5017 >For name service it causes
<B
5021 to ports
137 and
138 on the interfaces listed in the
<A
5028 > also binds to the
"all addresses" interface (
0.0.0.0)
5029 on ports
137 and
138 for the purposes of reading broadcast messages.
5030 If this option is not set then
<B
5034 name requests on all of these sockets. If
<TT
5044 source address of any packets coming in on the broadcast sockets
5045 and discard any that don't match the broadcast addresses of the
5046 interfaces in the
<TT
5052 As unicast packets are received on the other sockets it allows
5056 > to refuse to serve names to machines that
5057 send packets that arrive through any interfaces not listed in the
5063 > list. IP Source address spoofing
5064 does defeat this simple check, however so it must not be used
5065 seriously as a security feature for
<B
5070 >For file service it causes
<A
5075 to bind only to the interface list given in the
<A
5078 > parameter. This restricts the networks that
5082 > will serve to packets coming in those
5083 interfaces. Note that you should not use this parameter for machines
5084 that are serving PPP or other intermittent or non-broadcast network
5085 interfaces as it will not cope with non-permanent interfaces.
</P
5090 >bind interfaces only
</I
5093 unless the network address
<EM
5102 HREF=
"smbpasswd.8.html"
5117 not work as expected due to the reasons covered below.
</P
5119 >To change a users SMB password, the
<B
5123 by default connects to the
<EM
5124 >localhost -
127.0.0.1</EM
5126 address as an SMB client to issue the password change request. If
5130 >bind interfaces only
</I
5132 > is set then unless the
5141 > parameter list then
<B
5144 > will fail to connect in it's default mode.
5148 > can be forced to use the primary IP interface
5149 of the local host by using its
<A
5150 HREF=
"smbpasswd.8.html#minusr"
5164 > parameter, with
<TT
5170 to the IP name of the primary interface of the local host.
</P
5175 > status page tries to connect with
5185 > to determine if they are running.
5195 "not running" even if they really are. This can prevent
<B
5198 > from starting/stopping/restarting
<B
5209 >bind interfaces only = no
</B
5214 NAME=
"BLOCKINGLOCKS"
5216 >blocking locks (S)
</DT
5219 >This parameter controls the behavior of
<A
5223 > when given a request by a client
5224 to obtain a byte range lock on a region of an open file, and the
5225 request has a time limit associated with it.
</P
5227 >If this parameter is set and the lock range requested
5228 cannot be immediately satisfied, Samba
2.2 will internally
5229 queue the lock request, and periodically attempt to obtain
5230 the lock until the timeout period expires.
</P
5232 >If this parameter is set to
<TT
5236 Samba
2.2 will behave as previous versions of Samba would and
5237 will fail the lock request immediately if the lock range
5238 cannot be obtained.
</P
5242 >blocking locks = yes
</B
5266 >browse list (G)
</DT
5269 >This controls whether
<A
5276 > will serve a browse list to
5284 >. You should never need to change
5289 >browse list = yes
</B
5299 >This controls whether this share is seen in
5300 the list of available shares in a net view and in the browse list.
</P
5304 >browseable = yes
</B
5309 NAME=
"CASESENSITIVE"
5311 >case sensitive (S)
</DT
5314 >See the discussion in the section
<A
5321 >case sensitive = no
</B
5328 >casesignames (S)
</DT
5332 HREF=
"#CASESENSITIVE"
5339 NAME=
"CHANGENOTIFYTIMEOUT"
5341 >change notify timeout (G)
</DT
5344 >This SMB allows a client to tell a server to
5345 "watch" a particular directory for any changes and only reply to
5346 the SMB request when a change has occurred. Such constant scanning of
5347 a directory is expensive under UNIX, hence an
<A
5354 > daemon only performs such a scan
5355 on each requested directory once every
<TT
5365 >change notify timeout =
60</B
5370 >change notify timeout =
300</B
5373 >Would change the scan time to every
5 minutes.
</P
5377 NAME=
"CHANGESHARECOMMAND"
5379 >change share command (G)
</DT
5382 >Samba
2.2.0 introduced the ability to dynamically
5383 add and delete shares via the Windows NT
4.0 Server Manager. The
5387 >change share command
</I
5389 > is used to define an
5390 external program or script which will modify an existing service definition
5394 >. In order to successfully
5398 >change share command
</I
5404 requires that the administrator be connected using a root account (i.e.
5411 > will automatically invoke the
5415 >change share command
</I
5417 > with four parameters.
5443 > - the name of the new
5454 > - path to an **existing**
5465 > - comment string to associate
5471 > This parameter is only used modify existing file shares definitions. To modify
5472 printer shares, use the
"Printers..." folder as seen when browsing the Samba host.
5476 HREF=
"#ADDSHARECOMMAND"
5485 HREF=
"#DELETESHARECOMMAND"
5502 >change share command = /usr/local/bin/addshare
</B
5509 >character set (G)
</DT
5516 > to map incoming filenames
5517 from a DOS Code page (see the
<A
5518 HREF=
"#CLIENTCODEPAGE"
5521 > parameter) to several built in UNIX character sets.
5522 The built in code page translations are:
</P
5531 > : Western European
5532 UNIX character set. The parameter
<TT
5535 >client code page
</I
5540 > be set to code page
850 if the
5546 > parameter is set to
5550 > in order for the conversion to the
5551 UNIX character set to be done correctly.
</P
5558 > : Eastern European
5559 UNIX character set. The parameter
<TT
5567 > be set to code page
852 if
5577 > in order for the conversion
5578 to the UNIX character set to be done correctly.
</P
5585 > : Russian Cyrillic
5586 UNIX character set. The parameter
<TT
5594 > be set to code page
5604 > in order for the conversion
5605 to the UNIX character set to be done correctly.
</P
5613 character set. The parameter
<TT
5621 > be set to code page
5631 > in order for the conversion
5632 to the UNIX character set to be done correctly.
</P
5639 > : Alternate mapping
5640 for Russian Cyrillic UNIX character set. The parameter
5644 >client code page
</I
5649 be set to code page
866 if the
<TT
5655 parameter is set to
<TT
5659 conversion to the UNIX character set to be done correctly.
</P
5665 >. These MSDOS code page to UNIX character
5666 set mappings should be dynamic, like the loading of MS DOS code pages,
5669 >Normally this parameter is not set, meaning no filename
5670 translation is done.
</P
5674 >character set =
<empty string
></B
5679 >character set = ISO8859-
1</B
5684 NAME=
"CLIENTCODEPAGE"
5686 >client code page (G)
</DT
5689 >This parameter specifies the DOS code page
5690 that the clients accessing Samba are using. To determine what code
5691 page a Windows or DOS client is using, open a DOS command prompt
5692 and type the command
<B
5696 the code page. The default for USA MS-DOS, Windows
95, and
5697 Windows NT releases is code page
437. The default for western
5698 European releases of the above operating systems is code page
850.
</P
5700 >This parameter tells
<A
5714 > files to dynamically load on startup. These files,
5715 described more fully in the manual page
<A
5716 HREF=
"make_smbcodepage.1.html"
5720 >make_smbcodepage(
1)
</B
5725 > how to map lower to upper case characters to provide
5726 the case insensitivity of filenames that Windows clients expect.
</P
5728 >Samba currently ships with the following code page files :
</P
5734 >Code Page
437 - MS-DOS Latin US
</P
5738 >Code Page
737 - Windows '
95 Greek
</P
5742 >Code Page
850 - MS-DOS Latin
1</P
5746 >Code Page
852 - MS-DOS Latin
2</P
5750 >Code Page
861 - MS-DOS Icelandic
</P
5754 >Code Page
866 - MS-DOS Cyrillic
</P
5758 >Code Page
932 - MS-DOS Japanese SJIS
</P
5762 >Code Page
936 - MS-DOS Simplified Chinese
</P
5766 >Code Page
949 - MS-DOS Korean Hangul
</P
5770 >Code Page
950 - MS-DOS Traditional Chinese
</P
5774 >Thus this parameter may have any of the values
437,
737,
850,
852,
5775 861,
932,
936,
949, or
950. If you don't find the codepage you need,
5776 read the comments in one of the other codepage files and the
5779 >make_smbcodepage(
1)
</B
5780 > man page and write one. Please
5781 remember to donate it back to the Samba user community.
</P
5783 >This parameter co-operates with the
<TT
5789 > parameter in determining what characters are
5790 valid in filenames and how capitalization is done. If you set both
5791 this parameter and the
<TT
5800 >client code page
</I
5805 > be set before the
<TT
5811 > parameter in the
<TT
5821 augment the character settings in the
<TT
5824 >client code page
</I
5832 >client code page
</I
5847 HREF=
"#CODEPAGEDIRECTORY"
5851 >code page directory
</I
5858 >client code page =
850</B
5863 >client code page =
936</B
5868 NAME=
"CODEPAGEDIRECTORY"
5870 >code page directory (G)
</DT
5873 >Define the location of the various client code page
5877 HREF=
"#CLIENTCODEPAGE"
5889 >code page directory = ${prefix}/lib/codepages
5895 >code page directory = /usr/share/samba/codepages
5903 >coding system (G)
</DT
5906 >This parameter is used to determine how incoming
5907 Shift-JIS Japanese characters are mapped from the incoming
<A
5908 HREF=
"#CLIENTCODEPAGE"
5912 >client code page
</I
5916 > used by the client, into file names in the UNIX filesystem.
5920 >client code page
</I
5923 932 (Japanese Shift-JIS). The options are :
</P
5932 > - Shift-JIS. Does no
5933 conversion of the incoming filename.
</P
5939 >JIS8, J8BB, J8BH, J8@B,
5941 > - Convert from incoming Shift-JIS to eight
5942 bit JIS code with different shift-in, shift out codes.
</P
5948 >JIS7, J7BB, J7BH, J7@B, J7@J,
5950 > - Convert from incoming Shift-JIS to seven bit
5951 JIS code with different shift-in, shift out codes.
</P
5957 >JUNET, JUBB, JUBH, JU@B, JU@J, JU@H
</TT
5959 - Convert from incoming Shift-JIS to JUNET code with different shift-in,
5967 > - Convert an incoming
5968 Shift-JIS character to EUC code.
</P
5975 > - Convert an incoming
5976 Shift-JIS character to a
3 byte hex representation, i.e.
5987 > - Convert an incoming
5988 Shift-JIS character to the
3 byte hex representation used by
5989 the Columbia AppleTalk Program (CAP), i.e.
<TT
5993 This is used for compatibility between Samba and CAP.
</P
5999 >coding system =
<empty value
></B
6010 >This is a text field that is seen next to a share
6011 when a client does a queries the server, either via the network
6012 neighborhood or via
<B
6015 > to list what shares
6018 >If you want to set the string that is displayed next to the
6019 machine name then see the
<A
6020 HREF=
"#SERVERSTRING"
6030 >No comment string
</EM
6035 >comment = Fred's Files
</B
6042 >config file (G)
</DT
6045 >This allows you to override the config file
6046 to use, instead of the default (usually
<TT
6050 There is a chicken and egg problem here as this option is set
6051 in the config file!
</P
6053 >For this reason, if the name of the config file has changed
6054 when the parameters are loaded then it will reload them from
6055 the new config file.
</P
6057 >This option takes the usual substitutions, which can
6060 >If the config file doesn't exist then it won't be loaded
6061 (allowing you to special case the config files of just a few
6066 >config file = /usr/local/samba/lib/smb.conf.%m
6077 >This parameter allows you to
"clone" service
6078 entries. The specified service is simply duplicated under the
6079 current service's name. Any parameters specified in the current
6080 section will override those in the section being copied.
</P
6082 >This feature lets you set up a 'template' service and
6083 create similar services easily. Note that the service being
6084 copied must occur earlier in the configuration file than the
6085 service doing the copying.
</P
6093 >copy = otherservice
</B
6100 >create mask (S)
</DT
6103 >A synonym for this parameter is
6115 >When a file is created, the necessary permissions are
6116 calculated according to the mapping from DOS modes to UNIX
6117 permissions, and the resulting UNIX mode is then bit-wise 'AND'ed
6118 with this parameter. This parameter may be thought of as a bit-wise
6119 MASK for the UNIX modes of a file. Any bit
<EM
6122 set here will be removed from the modes set on a file when it is
6125 >The default value of this parameter removes the
6126 'group' and 'other' write and execute bits from the UNIX modes.
</P
6128 >Following this Samba will bit-wise 'OR' the UNIX mode created
6129 from this parameter with the value of the
<A
6130 HREF=
"#FORCECREATEMODE"
6134 >force create mode
</I
6138 parameter which is set to
000 by default.
</P
6140 >This parameter does not affect directory modes. See the
6142 HREF=
"#DIRECTORYMODE"
6153 HREF=
"#FORCECREATEMODE"
6161 > parameter for forcing particular mode
6162 bits to be set on created files. See also the
<A
6163 HREF=
"#DIRECTORYMODE"
6170 > parameter for masking
6171 mode bits on created directories. See also the
<A
6172 HREF=
"#INHERITPERMISSIONS"
6176 >inherit permissions
</I
6181 >Note that this parameter does not apply to permissions
6182 set by Windows NT/
2000 ACL editors. If the administrator wishes to enforce
6183 a mask on access control lists also, they need to set the
<A
6184 HREF=
"#SECURITYMASK"
6195 >create mask =
0744</B
6200 >create mask =
0775</B
6207 >create mode (S)
</DT
6210 >This is a synonym for
<A
6227 >The value of the parameter (a decimal integer)
6228 represents the number of minutes of inactivity before a connection
6229 is considered dead, and it is disconnected. The deadtime only takes
6230 effect if the number of open files is zero.
</P
6232 >This is useful to stop a server's resources being
6233 exhausted by a large number of inactive connections.
</P
6235 >Most clients have an auto-reconnect feature when a
6236 connection is broken so in most cases this parameter should be
6237 transparent to users.
</P
6239 >Using this parameter with a timeout of a few minutes
6240 is recommended for most systems.
</P
6242 >A deadtime of zero indicates that no auto-disconnection
6243 should be performed.
</P
6257 NAME=
"DEBUGHIRESTIMESTAMP"
6259 >debug hires timestamp (G)
</DT
6262 >Sometimes the timestamps in the log messages
6263 are needed with a resolution of higher that seconds, this
6264 boolean parameter adds microsecond resolution to the timestamp
6265 message header when turned on.
</P
6267 >Note that the parameter
<A
6268 HREF=
"#DEBUGTIMESTAMP"
6272 > debug timestamp
</I
6275 > must be on for this to have an
6280 >debug hires timestamp = no
</B
6290 >When using only one log file for more then one
6295 >-process there may be hard to follow which process
6296 outputs which message. This boolean parameter is adds the process-id
6297 to the timestamp message headers in the logfile when turned on.
</P
6299 >Note that the parameter
<A
6300 HREF=
"#DEBUGTIMESTAMP"
6304 > debug timestamp
</I
6307 > must be on for this to have an
6317 NAME=
"DEBUGTIMESTAMP"
6319 >debug timestamp (G)
</DT
6322 >Samba
2.2 debug log messages are timestamped
6323 by default. If you are running at a high
<A
6332 can be distracting. This boolean parameter allows timestamping
6333 to be turned off.
</P
6337 >debug timestamp = yes
</B
6347 >Samba is sometimes run as root and sometime
6348 run as the connected user, this boolean parameter inserts the
6349 current euid, egid, uid and gid to the timestamp message headers
6350 in the log file if turned on.
</P
6352 >Note that the parameter
<A
6353 HREF=
"#DEBUGTIMESTAMP"
6357 > debug timestamp
</I
6360 > must be on for this to have an
6393 HREF=
"#DEFAULTSERVICE"
6397 > default service
</I
6406 >default case (S)
</DT
6409 >See the section on
<A
6413 HREF=
"#SHORTPRESERVECASE"
6417 >short preserve case
</I
6424 >default case = lower
</B
6429 NAME=
"DEFAULTSERVICE"
6431 >default service (G)
</DT
6434 >This parameter specifies the name of a service
6435 which will be connected to if the service actually requested cannot
6436 be found. Note that the square brackets are
<EM
6439 given in the parameter value (see example below).
</P
6441 >There is no default value for this parameter. If this
6442 parameter is not given, attempting to connect to a nonexistent
6443 service results in an error.
</P
6445 >Typically the default service would be a
<A
6463 >Also note that the apparent service name will be changed
6464 to equal that of the requested service, this is very useful as it
6465 allows you to use macros like
<TT
6471 a wildcard service.
</P
6473 >Note also that any
"_" characters in the name of the service
6474 used in the default service will get mapped to a
"/". This allows for
6475 interesting things.
</P
6486 CLASS=
"PROGRAMLISTING"
6488 default service = pub
6500 NAME=
"DELETEPRINTERCOMMAND"
6502 >delete printer command (G)
</DT
6505 >With the introduction of MS-RPC based printer
6506 support for Windows NT/
2000 clients in Samba
2.2, it is now
6507 possible to delete printer at run time by issuing the
6508 DeletePrinter() RPC call.
</P
6510 >For a Samba host this means that the printer must be
6511 physically deleted from underlying printing system. The
<TT
6514 > deleteprinter command
</I
6516 > defines a script to be run which
6517 will perform the necessary operations for removing the printer
6518 from the print system and from
<TT
6527 >delete printer command
</I
6530 automatically called with only one parameter:
<TT
6540 >delete printer command
</I
6546 > will reparse the
<TT
6549 > to associated printer no longer exists.
6550 If the sharename is still valid, then
<B
6554 > will return an ACCESS_DENIED error to the client.
</P
6557 HREF=
"#ADDPRINTERCOMMAND"
6561 > add printer command
</I
6574 HREF=
"#SHOWADDPRINTERWIZARD"
6590 >deleteprinter command = /usr/bin/removeprinter
6596 NAME=
"DELETEREADONLY"
6598 >delete readonly (S)
</DT
6601 >This parameter allows readonly files to be deleted.
6602 This is not normal DOS semantics, but is allowed by UNIX.
</P
6604 >This option may be useful for running applications such
6605 as rcs, where UNIX file ownership prevents changing file
6606 permissions, and DOS semantics prevent deletion of a read only file.
</P
6610 >delete readonly = no
</B
6615 NAME=
"DELETESHARECOMMAND"
6617 >delete share command (G)
</DT
6620 >Samba
2.2.0 introduced the ability to dynamically
6621 add and delete shares via the Windows NT
4.0 Server Manager. The
6625 >delete share command
</I
6627 > is used to define an
6628 external program or script which will remove an existing service
6632 >. In order to successfully
6636 >delete share command
</I
6642 requires that the administrator be connected using a root account (i.e.
6649 > will automatically invoke the
6653 >delete share command
</I
6655 > with two parameters.
6682 the existing service.
6687 > This parameter is only used to remove file shares. To delete printer shares,
6689 HREF=
"#DELETEPRINTERCOMMAND"
6701 HREF=
"#ADDSHARECOMMAND"
6710 HREF=
"#CHANGESHARECOMMAND"
6727 >delete share command = /usr/local/bin/delshare
</B
6732 NAME=
"DELETEUSERSCRIPT"
6734 >delete user script (G)
</DT
6737 >This is the full pathname to a script that will
6747 > under special circumstances
6750 >Normally, a Samba server requires that UNIX users are
6751 created for all users accessing files on this server. For sites
6752 that use Windows NT account databases as their primary user database
6753 creating these users and keeping the user list in sync with the
6754 Windows NT PDC is an onerous task. This option allows
<B
6757 > to delete the required UNIX users
<EM
6760 > when a user accesses the Samba server and the
6761 Windows NT user no longer exists.
</P
6763 >In order to use this option,
<B
6770 >security = domain
</I
6778 > must be set to a full pathname for a script
6779 that will delete a UNIX user given one argument of
<TT
6785 >, which expands into the UNIX user name to delete.
6788 > that this is different to the
<A
6789 HREF=
"#ADDUSERSCRIPT"
6797 which will work with the
<TT
6800 >security = server
</I
6806 >security = domain
</I
6808 >. The reason for this
6809 is only when Samba is a domain member does it get the information
6810 on an attempted user logon that a user no longer exists. In the
6814 >security = server
</I
6816 > mode a missing user
6817 is treated the same as an invalid password logon attempt. Deleting
6818 the user in this circumstance would not be a good idea.
</P
6820 >When the Windows user attempts to access the Samba server,
6823 > (session setup in the SMB protocol)
6828 HREF=
"#PASSWORDSERVER"
6835 > and attempts to authenticate
6836 the given user with the given password. If the authentication fails
6837 with the specific Domain error code meaning that the user no longer
6841 > attempts to find a UNIX user in
6842 the UNIX password database that matches the Windows user account. If
6843 this lookup succeeds, and
<TT
6846 >delete user script
</I
6852 > will all the specified script
6855 >, expanding any
<TT
6861 argument to be the user name to delete.
</P
6863 >This script should delete the given UNIX username. In this way,
6864 UNIX users are dynamically deleted to match existing Windows NT
6868 HREF=
"#SECURITYEQUALSDOMAIN"
6869 >security = domain
</A
6872 HREF=
"#PASSWORDSERVER"
6881 HREF=
"#ADDUSERSCRIPT"
6893 >delete user script =
<empty string
>
6899 >delete user script = /usr/local/samba/bin/del_user
6905 NAME=
"DELETEVETOFILES"
6907 >delete veto files (S)
</DT
6910 >This option is used when Samba is attempting to
6911 delete a directory that contains one or more vetoed directories
6921 option). If this option is set to
<TT
6924 > (the default) then if a vetoed
6925 directory contains any non-vetoed files or directories then the
6926 directory delete will fail. This is usually what you want.
</P
6928 >If this option is set to
<TT
6932 will attempt to recursively delete any files and directories within
6933 the vetoed directory. This can be useful for integration with file
6934 serving systems such as NetAtalk which create meta-files within
6935 directories you might normally veto DOS/Windows users from seeing
6943 >delete veto files = yes
</B
6945 directories to be transparently deleted when the parent directory
6946 is deleted (so long as the user has permissions to do so).
</P
6961 >delete veto files = no
</B
6986 >dfree command (G)
</DT
6995 only be used on systems where a problem occurs with the internal
6996 disk space calculations. This has been known to happen with Ultrix,
6997 but may occur with other operating systems. The symptom that was
6998 seen was an error of
"Abort Retry Ignore" at the end of each
6999 directory listing.
</P
7001 >This setting allows the replacement of the internal routines to
7002 calculate the total disk space and amount available with an external
7003 routine. The example below gives a possible script that might fulfill
7006 >The external program will be passed a single parameter indicating
7007 a directory in the filesystem being queried. This will typically consist
7011 >. The script should return two
7012 integers in ASCII. The first should be the total disk space in blocks,
7013 and the second should be the number of available blocks. An optional
7014 third return value can give the block size in bytes. The default
7015 blocksize is
1024 bytes.
</P
7017 >Note: Your script should
<EM
7020 setgid and should be owned by (and writeable only by) root!
</P
7023 >By default internal routines for
7024 determining the disk capacity and remaining space will be used.
7030 >dfree command = /usr/local/samba/bin/dfree
7034 >Where the script dfree (which must be made executable) could be:
</P
7043 CLASS=
"PROGRAMLISTING"
7046 df $
1 | tail -
1 | awk '{print $
2" "$
4}'
7053 >or perhaps (on Sys V based systems):
</P
7062 CLASS=
"PROGRAMLISTING"
7065 /usr/bin/df -k $
1 | tail -
1 | awk '{print $
3" "$
5}'
7072 >Note that you may have to replace the command names
7073 with full path names on some systems.
</P
7095 NAME=
"DIRECTORYMASK"
7097 >directory mask (S)
</DT
7100 >This parameter is the octal modes which are
7101 used when converting DOS modes to UNIX modes when creating UNIX
7104 >When a directory is created, the necessary permissions are
7105 calculated according to the mapping from DOS modes to UNIX permissions,
7106 and the resulting UNIX mode is then bit-wise 'AND'ed with this
7107 parameter. This parameter may be thought of as a bit-wise MASK for
7108 the UNIX modes of a directory. Any bit
<EM
7111 here will be removed from the modes set on a directory when it is
7114 >The default value of this parameter removes the 'group'
7115 and 'other' write bits from the UNIX mode, allowing only the
7116 user who owns the directory to modify it.
</P
7118 >Following this Samba will bit-wise 'OR' the UNIX mode
7119 created from this parameter with the value of the
<A
7120 HREF=
"#FORCEDIRECTORYMODE"
7124 >force directory mode
7128 > parameter. This parameter is set to
000 by
7129 default (i.e. no extra mode bits are added).
</P
7131 >Note that this parameter does not apply to permissions
7132 set by Windows NT/
2000 ACL editors. If the administrator wishes to enforce
7133 a mask on access control lists also, they need to set the
<A
7134 HREF=
"#DIRECTORYSECURITYMASK"
7138 >directory security mask
</I
7144 HREF=
"#FORCEDIRECTORYMODE"
7152 > parameter to cause particular mode
7153 bits to always be set on created directories.
</P
7164 > parameter for masking mode bits on created files,
7166 HREF=
"#DIRECTORYSECURITYMASK"
7176 >Also refer to the
<A
7177 HREF=
"#INHERITPERMISSIONS"
7181 > inherit permissions
</I
7188 >directory mask =
0755</B
7193 >directory mask =
0775</B
7198 NAME=
"DIRECTORYMODE"
7200 >directory mode (S)
</DT
7204 HREF=
"#DIRECTORYMASK"
7215 NAME=
"DIRECTORYSECURITYMASK"
7217 >directory security mask (S)
</DT
7220 >This parameter controls what UNIX permission bits
7221 can be modified when a Windows NT client is manipulating the UNIX
7222 permission on a directory using the native NT security dialog
7225 >This parameter is applied as a mask (AND'ed with) to
7226 the changed permission bits, thus preventing any bits not in
7227 this mask from being modified. Essentially, zero bits in this
7228 mask may be treated as a set of bits the user is not allowed
7231 >If not set explicitly this parameter is set to
0777
7232 meaning a user is allowed to modify all the user/group/world
7233 permissions on a directory.
</P
7237 > that users who can access the
7238 Samba server through other means can easily bypass this restriction,
7239 so it is primarily useful for standalone
"appliance" systems.
7240 Administrators of most normal systems will probably want to leave
7241 it as the default of
<TT
7247 HREF=
"#FORCEDIRECTORYSECURITYMODE"
7251 > force directory security mode
</I
7255 HREF=
"#SECURITYMASK"
7264 HREF=
"#FORCESECURITYMODE"
7268 >force security mode
7276 >directory security mask =
0777</B
7281 >directory security mask =
0700</B
7286 NAME=
"DISABLESPOOLSS"
7288 >disable spoolss (G)
</DT
7291 >Enabling this parameter will disables Samba's support
7292 for the SPOOLSS set of MS-RPC's and will yield identical behavior
7293 as Samba
2.0.x. Windows NT/
2000 clients will downgrade to using
7294 Lanman style printing commands. Windows
9x/ME will be uneffected by
7295 the parameter. However, this will also disable the ability to upload
7296 printer drivers to a Samba server via the Windows NT Add Printer
7297 Wizard or by using the NT printer properties dialog window. It will
7298 also disable the capability of Windows NT/
2000 clients to download
7299 print drivers from the Samba host upon demand.
7301 >Be very careful about enabling this parameter.
</EM
7306 HREF=
"#USECLIENTDRIVER"
7307 >use client driver
</A
7313 >disable spoolss = no
</B
7328 when acting as a WINS server and finding that a NetBIOS name has not
7329 been registered, should treat the NetBIOS name word-for-word as a DNS
7330 name and do a lookup with the DNS server for that name on behalf of
7331 the name-querying client.
</P
7333 >Note that the maximum length for a NetBIOS name is
15
7334 characters, so the DNS name (or DNS alias) can likewise only be
7335 15 characters, maximum.
</P
7340 > spawns a second copy of itself to do the
7341 DNS name lookup requests, as doing a name lookup is a blocking
7344 >See also the parameter
<A
7361 NAME=
"DOMAINADMINGROUP"
7363 >domain admin group (G)
</DT
7366 >This parameter is intended as a temporary solution
7367 to enable users to be a member of the
"Domain Admins" group when
7368 a Samba host is acting as a PDC. A complete solution will be provided
7369 by a system for mapping Windows NT/
2000 groups onto UNIX groups.
7370 Please note that this parameter has a somewhat confusing name. It
7371 accepts a list of usernames and of group names in standard
7379 HREF=
"#DOMAINGUESTGROUP"
7388 HREF=
"#DOMAINLOGONS"
7400 >no domain administrators
</EM
7405 >domain admin group = root @wheel
</B
7410 NAME=
"DOMAINGUESTGROUP"
7412 >domain guest group (G)
</DT
7415 >This parameter is intended as a temporary solution
7416 to enable users to be a member of the
"Domain Guests" group when
7417 a Samba host is acting as a PDC. A complete solution will be provided
7418 by a system for mapping Windows NT/
2000 groups onto UNIX groups.
7419 Please note that this parameter has a somewhat confusing name. It
7420 accepts a list of usernames and of group names in standard
7428 HREF=
"#DOMAINADMINGROUP"
7437 HREF=
"#DOMAINLOGONS"
7449 >no domain guests
</EM
7454 >domain guest group = nobody @guest
</B
7461 >domain logons (G)
</DT
7467 >, the Samba server will serve
7468 Windows
95/
98 Domain logons for the
<A
7476 > it is in. Samba
2.2 also
7477 has limited capability to act as a domain controller for Windows
7478 NT
4 Domains. For more details on setting up this feature see
7479 the file DOMAINS.txt in the Samba documentation directory
<TT
7483 > shipped with the source code.
</P
7487 >domain logons = no
</B
7494 >domain master (G)
</DT
7504 > to enable WAN-wide browse list
7505 collation. Setting this option causes
<B
7509 claim a special domain specific NetBIOS name that identifies
7510 it as a domain master browser for its given
<A
7518 >. Local master browsers
7524 > on broadcast-isolated
7525 subnets will give this
<B
7528 > their local browse lists,
7537 for a complete copy of the browse list for the whole wide area
7538 network. Browser clients will then contact their local master browser,
7539 and will receive the domain-wide browse list, instead of just the list
7540 for their broadcast-isolated subnet.
</P
7542 >Note that Windows NT Primary Domain Controllers expect to be
7543 able to claim this
<TT
7549 NetBIOS name that identifies them as domain master browsers for
7555 > by default (i.e. there is no
7556 way to prevent a Windows NT PDC from attempting to do this). This
7557 means that if this parameter is set and
<B
7561 the special name for a
<TT
7567 NT PDC is able to do so then cross subnet browsing will behave
7568 strangely and may fail.
</P
7571 HREF=
"#DOMAINLOGONS"
7574 >domain logons = yes
</B
7577 >, then the default behavior is to enable the
<TT
7589 not enabled (the default setting), then neither will
<TT
7595 > be enabled by default.
</P
7599 >domain master = auto
</B
7606 >dont descend (S)
</DT
7609 >There are certain directories on some systems
7613 > tree under Linux) that are either not
7614 of interest to clients or are infinitely deep (recursive). This
7615 parameter allows you to specify a comma-delimited list of directories
7616 that the server should always show as empty.
</P
7618 >Note that Samba can be very fussy about the exact format
7619 of the
"dont descend" entries. For example you may need
<TT
7622 > instead of just
<TT
7626 Experimentation is the best policy :-)
</P
7629 >none (i.e., all directories are OK
7635 >dont descend = /proc,/dev
</B
7642 >dos filemode (S)
</DT
7645 > The default behavior in Samba is to provide
7646 UNIX-like behavior where only the owner of a file/directory is
7647 able to change the permissions on it. However, this behavior
7648 is often confusing to DOS/Windows users. Enabling this parameter
7649 allows a user who has write access to the file (by whatever
7650 means) to modify the permissions on it. Note that a user
7651 belonging to the group owning the file will not be allowed to
7652 change permissions if the group is only granted read access.
7653 Ownership of the file/directory is not changed, only the permissions
7658 >dos filemode = no
</B
7663 NAME=
"DOSFILETIMERESOLUTION"
7665 >dos filetime resolution (S)
</DT
7668 >Under the DOS and Windows FAT filesystem, the finest
7669 granularity on time resolution is two seconds. Setting this parameter
7670 for a share causes Samba to round the reported time down to the
7671 nearest two second boundary when a query call that requires one second
7672 resolution is made to
<A
7682 >This option is mainly used as a compatibility option for Visual
7683 C++ when used against Samba shares. If oplocks are enabled on a
7684 share, Visual C++ uses two different time reading calls to check if a
7685 file has changed since it was last read. One of these calls uses a
7686 one-second granularity, the other uses a two second granularity. As
7687 the two second call rounds any odd second down, then if the file has a
7688 timestamp of an odd number of seconds then the two timestamps will not
7689 match and Visual C++ will keep reporting the file has changed. Setting
7690 this option causes the two timestamps to match, and Visual C++ is
7695 >dos filetime resolution = no
</B
7702 >dos filetimes (S)
</DT
7705 >Under DOS and Windows, if a user can write to a
7706 file they can change the timestamp on it. Under POSIX semantics,
7707 only the owner of the file or root may change the timestamp. By
7708 default, Samba runs with POSIX semantics and refuses to change the
7709 timestamp on a file if the user
<B
7713 on behalf of is not the file owner. Setting this option to
<TT
7716 > allows DOS semantics and
<A
7720 > will change the file
7721 timestamp as DOS requires.
</P
7725 >dos filetimes = no
</B
7730 NAME=
"ENCRYPTPASSWORDS"
7732 >encrypt passwords (G)
</DT
7735 >This boolean controls whether encrypted passwords
7736 will be negotiated with the client. Note that Windows NT
4.0 SP3 and
7737 above and also Windows
98 will by default expect encrypted passwords
7738 unless a registry entry is changed. To use encrypted passwords in
7739 Samba see the file ENCRYPTION.txt in the Samba documentation
7743 > shipped with the source code.
</P
7745 >In order for encrypted passwords to work correctly
7754 have access to a local
<A
7755 HREF=
"smbpasswd.5.html"
7763 HREF=
"smbpasswd.8.html"
7769 > program for information on how to set up
7770 and maintain this file), or set the
<A
7772 >security = [server|domain]
</A
7777 > to authenticate against another
7782 >encrypt passwords = no
</B
7787 NAME=
"ENHANCEDBROWSING"
7789 >enhanced browsing (G)
</DT
7792 >This option enables a couple of enhancements to
7793 cross-subnet browse propagation that have been added in Samba
7794 but which are not standard in Microsoft implementations.
7797 >The first enhancement to browse propagation consists of a regular
7798 wildcard query to a Samba WINS server for all Domain Master Browsers,
7799 followed by a browse synchronization with each of the returned
7800 DMBs. The second enhancement consists of a regular randomised browse
7801 synchronization with all currently known DMBs.
</P
7803 >You may wish to disable this option if you have a problem with empty
7804 workgroups not disappearing from browse lists. Due to the restrictions
7805 of the browse protocols these enhancements can cause a empty workgroup
7806 to stay around forever which can be annoying.
</P
7808 >In general you should leave this option enabled as it makes
7809 cross-subnet browse propagation much more reliable.
</P
7813 >enhanced browsing = yes
</B
7818 NAME=
"ENUMPORTSCOMMAND"
7820 >enumports command (G)
</DT
7823 >The concept of a
"port" is fairly foreign
7824 to UNIX hosts. Under Windows NT/
2000 print servers, a port
7825 is associated with a port monitor and generally takes the form of
7826 a local port (i.e. LPT1:, COM1:, FILE:) or a remote port
7827 (i.e. LPD Port Monitor, etc...). By default, Samba has only one
7830 >"Samba Printer Port"</TT
7832 Windows NT/
2000, all printers must have a valid port name.
7833 If you wish to have a list of ports displayed (
<B
7837 > does not use a port name for anything) other than
7840 >"Samba Printer Port"</TT
7845 >enumports command
</I
7848 a program which should generate a list of ports, one per line,
7849 to standard output. This listing will then be used in response
7850 to the level
1 and
2 EnumPorts() RPC.
</P
7853 >no enumports command
</EM
7858 >enumports command = /usr/bin/listports
7869 >This is a synonym for
<A
7881 NAME=
"FAKEDIRECTORYCREATETIMES"
7883 >fake directory create times (S)
</DT
7886 >NTFS and Windows VFAT file systems keep a create
7887 time for all files and directories. This is not the same as the
7888 ctime - status change time - that Unix keeps, so Samba by default
7889 reports the earliest of the various times Unix does keep. Setting
7890 this parameter for a share causes Samba to always report midnight
7891 1-
1-
1980 as the create time for directories.
</P
7893 >This option is mainly used as a compatibility option for
7894 Visual C++ when used against Samba shares. Visual C++ generated
7895 makefiles have the object directory as a dependency for each object
7896 file, and a make rule to create the directory. Also, when NMAKE
7897 compares timestamps it uses the creation time when examining a
7898 directory. Thus the object directory will be created if it does not
7899 exist, but once it does exist it will always have an earlier
7900 timestamp than the object files it contains.
</P
7902 >However, Unix time semantics mean that the create time
7903 reported by Samba will be updated whenever a file is created or
7904 or deleted in the directory. NMAKE finds all object files in
7905 the object directory. The timestamp of the last one built is then
7906 compared to the timestamp of the object directory. If the
7907 directory's timestamp if newer, then all object files
7908 will be rebuilt. Enabling this option
7909 ensures directories always predate their contents and an NMAKE build
7910 will proceed as expected.
</P
7914 >fake directory create times = no
</B
7921 >fake oplocks (S)
</DT
7924 >Oplocks are the way that SMB clients get permission
7925 from a server to locally cache file operations. If a server grants
7926 an oplock (opportunistic lock) then the client is free to assume
7927 that it is the only one accessing the file and it will aggressively
7928 cache file data. With some oplock types the client may even cache
7929 file open/close operations. This can give enormous performance benefits.
7934 >fake oplocks = yes
</B
7943 always grant oplock requests no matter how many clients are using
7946 >It is generally much better to use the real
<A
7955 than this parameter.
</P
7957 >If you enable this option on all read-only shares or
7958 shares that you know will only be accessed from one client at a
7959 time such as physically read-only media like CDROMs, you will see
7960 a big performance improvement on many operations. If you enable
7961 this option on shares where multiple clients may be accessing the
7962 files read-write at the same time you can get data corruption. Use
7963 this option carefully!
</P
7967 >fake oplocks = no
</B
7972 NAME=
"FOLLOWSYMLINKS"
7974 >follow symlinks (S)
</DT
7977 >This parameter allows the Samba administrator
7986 from following symbolic links in a particular share. Setting this
7990 > prevents any file or directory
7991 that is a symbolic link from being followed (the user will get an
7992 error). This option is very useful to stop users from adding a
7993 symbolic link to
<TT
7997 directory for instance. However it will slow filename lookups
8000 >This option is enabled (i.e.
<B
8004 follow symbolic links) by default.
</P
8008 >follow symlinks = yes
</B
8013 NAME=
"FORCECREATEMODE"
8015 >force create mode (S)
</DT
8018 >This parameter specifies a set of UNIX mode bit
8019 permissions that will
<EM
8022 file created by Samba. This is done by bitwise 'OR'ing these bits onto
8023 the mode bits of a file that is being created or having its
8024 permissions changed. The default for this parameter is (in octal)
8025 000. The modes in this parameter are bitwise 'OR'ed onto the file
8026 mode after the mask set in the
<TT
8032 parameter is applied.
</P
8034 >Note that by default this parameter does not apply to permissions
8035 set by Windows NT/
2000 ACL editors. If the administrator wishes to enforce
8036 this mask on access control lists also, they need to set the
<A
8037 HREF=
"#RESTRICTACLWITHMASK"
8050 >See also the parameter
<A
8059 > for details on masking mode bits on files.
</P
8062 HREF=
"#INHERITPERMISSIONS"
8074 >force create mode =
000</B
8079 >force create mode =
0755</B
8082 >would force all created files to have read and execute
8083 permissions set for 'group' and 'other' as well as the
8084 read/write/execute bits set for the 'user'.
</P
8088 NAME=
"FORCEDIRECTORYMODE"
8090 >force directory mode (S)
</DT
8093 >This parameter specifies a set of UNIX mode bit
8094 permissions that will
<EM
8096 > be set on a directory
8097 created by Samba. This is done by bitwise 'OR'ing these bits onto the
8098 mode bits of a directory that is being created. The default for this
8099 parameter is (in octal)
0000 which will not add any extra permission
8100 bits to a created directory. This operation is done after the mode
8101 mask in the parameter
<TT
8109 >Note that by default this parameter does not apply to permissions
8110 set by Windows NT/
2000 ACL editors. If the administrator wishes to enforce
8111 this mask on access control lists also, they need to set the
<A
8112 HREF=
"#RESTRICTACLWITHMASK"
8125 >See also the parameter
<A
8126 HREF=
"#DIRECTORYMASK"
8133 > for details on masking mode bits
8134 on created directories.
</P
8137 HREF=
"#INHERITPERMISSIONS"
8141 > inherit permissions
</I
8148 >force directory mode =
000</B
8153 >force directory mode =
0755</B
8156 >would force all created directories to have read and execute
8157 permissions set for 'group' and 'other' as well as the
8158 read/write/execute bits set for the 'user'.
</P
8162 NAME=
"FORCEDIRECTORYSECURITYMODE"
8165 security mode (S)
</DT
8168 >This parameter controls what UNIX permission bits
8169 can be modified when a Windows NT client is manipulating the UNIX
8170 permission on a directory using the native NT security dialog box.
</P
8172 >This parameter is applied as a mask (OR'ed with) to the
8173 changed permission bits, thus forcing any bits in this mask that
8174 the user may have modified to be on. Essentially, one bits in this
8175 mask may be treated as a set of bits that, when modifying security
8176 on a directory, the user has always set to be 'on'.
</P
8178 >If not set explicitly this parameter is
000, which
8179 allows a user to modify all the user/group/world permissions on a
8180 directory without restrictions.
</P
8184 > that users who can access the
8185 Samba server through other means can easily bypass this restriction,
8186 so it is primarily useful for standalone
"appliance" systems.
8187 Administrators of most normal systems will probably want to leave
8191 HREF=
"#DIRECTORYSECURITYMASK"
8195 > directory security mask
</I
8199 HREF=
"#SECURITYMASK"
8208 HREF=
"#FORCESECURITYMODE"
8212 >force security mode
8220 >force directory security mode =
0</B
8225 >force directory security mode =
700</B
8232 >force group (S)
</DT
8235 >This specifies a UNIX group name that will be
8236 assigned as the default primary group for all users connecting
8237 to this service. This is useful for sharing files by ensuring
8238 that all access to files on service will use the named group for
8239 their permissions checking. Thus, by assigning permissions for this
8240 group to the files and directories within this service the Samba
8241 administrator can restrict or allow sharing of these files.
</P
8243 >In Samba
2.0.5 and above this parameter has extended
8244 functionality in the following way. If the group name listed here
8245 has a '+' character prepended to it then the current user accessing
8246 the share only has the primary group default assigned to this group
8247 if they are already assigned as a member of that group. This allows
8248 an administrator to decide that only users who are already in a
8249 particular group will create files with group ownership set to that
8250 group. This gives a finer granularity of ownership assignment. For
8251 example, the setting
<TT
8253 >force group = +sys
</TT
8255 that only users who are already in group sys will have their default
8256 primary group assigned to sys when accessing this Samba share. All
8257 other users will retain their ordinary primary group.
</P
8268 > parameter is also set the group specified in
8274 > will override the primary group
8294 >no forced group
</EM
8299 >force group = agroup
</B
8304 NAME=
"FORCESECURITYMODE"
8306 >force security mode (S)
</DT
8309 >This parameter controls what UNIX permission
8310 bits can be modified when a Windows NT client is manipulating
8311 the UNIX permission on a file using the native NT security dialog
8314 >This parameter is applied as a mask (OR'ed with) to the
8315 changed permission bits, thus forcing any bits in this mask that
8316 the user may have modified to be on. Essentially, one bits in this
8317 mask may be treated as a set of bits that, when modifying security
8318 on a file, the user has always set to be 'on'.
</P
8320 >If not set explicitly this parameter is set to
0,
8321 and allows a user to modify all the user/group/world permissions on a file,
8322 with no restrictions.
</P
8326 > that users who can access
8327 the Samba server through other means can easily bypass this restriction,
8328 so it is primarily useful for standalone
"appliance" systems.
8329 Administrators of most normal systems will probably want to leave
8330 this set to
0000.
</P
8333 HREF=
"#FORCEDIRECTORYSECURITYMODE"
8337 > force directory security mode
</I
8342 HREF=
"#DIRECTORYSECURITYMASK"
8351 HREF=
"#SECURITYMASK"
8362 >force security mode =
0</B
8367 >force security mode =
700</B
8377 >This specifies a UNIX user name that will be
8378 assigned as the default user for all users connecting to this service.
8379 This is useful for sharing files. You should also use it carefully
8380 as using it incorrectly can cause security problems.
</P
8382 >This user name only gets used once a connection is established.
8383 Thus clients still need to connect as a valid user and supply a
8384 valid password. Once connected, all file operations will be performed
8385 as the
"forced user", no matter what username the client connected
8386 as. This can be very useful.
</P
8388 >In Samba
2.0.5 and above this parameter also causes the
8389 primary group of the forced user to be used as the primary group
8390 for all file activity. Prior to
2.0.5 the primary group was left
8391 as the primary group of the connecting user (this was a bug).
</P
8410 >force user = auser
</B
8420 >This parameter allows the administrator to
8421 configure the string that specifies the type of filesystem a share
8422 is using that is reported by
<A
8430 > when a client queries the filesystem type
8431 for a share. The default type is
<TT
8435 compatibility with Windows NT but this can be changed to other
8459 >getwd cache (G)
</DT
8462 >This is a tuning option. When this is enabled a
8463 caching algorithm will be used to reduce the time taken for getwd()
8464 calls. This can have a significant impact on performance, especially
8474 >parameter is set to
<TT
8481 >getwd cache = yes
</B
8506 >guest account (S)
</DT
8509 >This is a username which will be used for access
8510 to services which are specified as
<A
8518 > (see below). Whatever privileges this
8519 user has will be available to any client connecting to the guest service.
8520 Typically this user will exist in the password file, but will not
8521 have a valid login. The user account
"ftp" is often a good choice
8522 for this parameter. If a username is specified in a given service,
8523 the specified username overrides this one.
</P
8525 >One some systems the default guest account
"nobody" may not
8526 be able to print. Use another account in this case. You should test
8527 this by trying to log in as your guest user (perhaps by using the
8531 > command) and trying to print using the
8532 system print command such as
<B
8541 >specified at compile time, usually
8547 >guest account = ftp
</B
8557 >If this parameter is
<TT
8561 a service, then no password is required to connect to the service.
8562 Privileges will be those of the
<A
8563 HREF=
"#GUESTACCOUNT"
8572 >See the section below on
<A
8580 > for more information about this option.
8595 >If this parameter is
<TT
8599 a service, then only guest connections to the service are permitted.
8600 This parameter will have no effect if
<A
8608 > is not set for the service.
</P
8610 >See the section below on
<A
8618 > for more information about this option.
8630 >hide dot files (S)
</DT
8633 >This is a boolean parameter that controls whether
8634 files starting with a dot appear as hidden files.
</P
8638 >hide dot files = yes
</B
8648 >This is a list of files or directories that are not
8649 visible but are accessible. The DOS 'hidden' attribute is applied
8650 to any files or directories that match.
</P
8652 >Each entry in the list must be separated by a '/',
8653 which allows spaces to be included in the entry. '*'
8654 and '?' can be used to specify multiple files or directories
8655 as in DOS wildcards.
</P
8657 >Each entry must be a Unix path, not a DOS path and must
8658 not include the Unix directory separator '/'.
</P
8660 >Note that the case sensitivity option is applicable
8663 >Setting this parameter will affect the performance of Samba,
8664 as it will be forced to check all files and directories for a match
8665 as they are scanned.
</P
8668 HREF=
"#HIDEDOTFILES"
8685 HREF=
"#CASESENSITIVE"
8695 >no file are hidden
</EM
8701 /.*/DesktopFolderDB/TrashFor%m/resource.frk/
</B
8704 >The above example is based on files that the Macintosh
8705 SMB client (DAVE) available from
<A
8706 HREF=
"http://www.thursby.com"
8710 > creates for internal use, and also still hides
8711 all files beginning with a dot.
</P
8715 NAME=
"HIDELOCALUSERS"
8717 >hide local users(G)
</DT
8720 >This parameter toggles the hiding of local UNIX
8721 users (root, wheel, floppy, etc) from remote clients.
</P
8725 >hide local users = no
</B
8730 NAME=
"HIDEUNREADABLE"
8732 >hide unreadable(G)
</DT
8735 >This parameter prevents clients from seeing the
8736 existance of files that cannot be read. Defaults to off.
</P
8740 >hide unreadable = no
</B
8747 >homedir map (G)
</DT
8775 > then this parameter
8776 specifies the NIS (or YP) map from which the server for the user's
8777 home directory should be extracted. At present, only the Sun
8778 auto.home map format is understood. The form of the map is:
</P
8782 >username server:/some/file/system
</B
8785 >and the program will extract the servername from before
8786 the first ':'. There should probably be a better parsing system
8787 that copes with different map formats and also Amd (another
8788 automounter) maps.
</P
8792 >A working NIS client is required on
8793 the system for this option to work.
</P
8805 HREF=
"#DOMAINLOGONS"
8817 >homedir map =
<empty string
></B
8822 >homedir map = amd.homedir
</B
8832 >This boolean parameter is only available
8833 if Samba has been configured and compiled with the
<B
8836 > option. If set to
<TT
8840 Samba will act as a Dfs server, and allow Dfs-aware clients
8841 to browse Dfs trees hosted on the server.
</P
8851 > share level parameter. For
8852 more information on setting up a Dfs tree on Samba,
8854 HREF=
"msdfs_setup.html"
8856 >msdfs_setup.html
</A
8869 >hosts allow (S)
</DT
8872 >A synonym for this parameter is
<TT
8880 >This parameter is a comma, space, or tab delimited
8881 set of hosts which are permitted to access a service.
</P
8883 >If specified in the [global] section then it will
8884 apply to all services, regardless of whether the individual
8885 service has a different setting.
</P
8887 >You can specify the hosts by name or IP number. For
8888 example, you could restrict access to only the hosts on a
8889 Class C subnet with something like
<B
8891 >allow hosts =
150.203.5.
8893 >. The full syntax of the list is described in the man
8896 >hosts_access(
5)
</TT
8897 >. Note that this man
8898 page may not be present on your system, so a brief description will
8899 be given here also.
</P
8901 >Note that the localhost address
127.0.0.1 will always
8902 be allowed access unless specifically denied by a
<A
8912 >You can also specify hosts by network/netmask pairs and
8913 by netgroup names if your system supports netgroups. The
8916 > keyword can also be used to limit a
8917 wildcard list. The following examples may provide some help:
</P
8919 >Example
1: allow all IPs in
150.203.*.*; except one
</P
8923 >hosts allow =
150.203. EXCEPT
150.203.6.66</B
8926 >Example
2: allow hosts that match the given network/netmask
</P
8930 >hosts allow =
150.203.15.0/
255.255.255.0</B
8933 >Example
3: allow a couple of hosts
</P
8937 >hosts allow = lapland, arvidsjaur
</B
8940 >Example
4: allow only hosts in NIS netgroup
"foonet", but
8941 deny access from one particular host
</P
8945 >hosts allow = @foonet
</B
8950 >hosts deny = pirate
</B
8953 >Note that access still requires suitable user-level passwords.
</P
8956 HREF=
"testparm.1.html"
8963 > for a way of testing your host access to see if it does
8967 >none (i.e., all hosts permitted access)
8973 >allow hosts =
150.203.5. myhost.mynet.edu.au
8984 >The opposite of
<TT
8990 - hosts listed here are
<EM
8992 > permitted access to
8993 services unless the specific services have their own lists to override
8994 this one. Where the lists conflict, the
<TT
9000 list takes precedence.
</P
9003 >none (i.e., no hosts specifically excluded)
9009 >hosts deny =
150.203.4. badhost.mynet.edu.au
9017 >hosts equiv (G)
</DT
9020 >If this global parameter is a non-null string,
9021 it specifies the name of a file to read for the names of hosts
9022 and users who will be allowed access without specifying a password.
9025 >This is not be confused with
<A
9033 > which is about hosts
9034 access to services and is more useful for guest services.
<TT
9039 > may be useful for NT clients which will
9040 not supply passwords to Samba.
</P
9050 > can be a major security hole. This is because you are
9051 trusting the PC to supply the correct username. It is very easy to
9052 get a PC to supply a false username. I recommend that the
9058 > option be only used if you really
9059 know what you are doing, or perhaps on a home network where you trust
9060 your spouse and kids. And only if you
<EM
9066 >no host equivalences
</EM
9071 >hosts equiv = /etc/hosts.equiv
</B
9081 >This allows you to include one config file
9082 inside another. The file is included literally, as though typed
9085 >It takes the standard substitutions, except
<TT
9105 >no file included
</EM
9110 >include = /usr/local/samba/lib/admin_smb.conf
9116 NAME=
"INHERITPERMISSIONS"
9118 >inherit permissions (S)
</DT
9121 >The permissions on new files and directories
9122 are normally governed by
<A
9131 HREF=
"#DIRECTORYMASK"
9139 HREF=
"#FORCECREATEMODE"
9143 >force create mode
</I
9148 HREF=
"#FORCEDIRECTORYMODE"
9156 > but the boolean inherit
9157 permissions parameter overrides this.
</P
9159 >New directories inherit the mode of the parent directory,
9160 including bits such as setgid.
</P
9162 >New files inherit their read/write bits from the parent
9163 directory. Their execute bits continue to be determined by
9193 >Note that the setuid bit is
<EM
9196 inheritance (the code explicitly prohibits this).
</P
9198 >This can be particularly useful on large systems with
9199 many users, perhaps several thousand, to allow a single [homes]
9200 share to be used flexibly by each user.
</P
9212 HREF=
"#DIRECTORYMASK"
9220 HREF=
"#FORCECREATEMODE"
9224 >force create mode
</I
9228 HREF=
"#FORCEDIRECTORYMODE"
9232 >force directory mode
</I
9240 >inherit permissions = no
</B
9250 >This option allows you to override the default
9251 network interfaces list that Samba will use for browsing, name
9252 registration and other NBT traffic. By default Samba will query
9253 the kernel for the list of all active interfaces and use any
9254 interfaces except
127.0.0.1 that are broadcast capable.
</P
9256 >The option takes a list of interface strings. Each string
9257 can be in any of the following forms:
</P
9263 >a network interface name (such as eth0).
9264 This may include shell-like wildcards so eth* will match
9265 any interface starting with the substring
"eth"</P
9269 >an IP address. In this case the netmask is
9270 determined from the list of interfaces obtained from the
9275 >an IP/mask pair.
</P
9279 >a broadcast/mask pair.
</P
9283 >The
"mask" parameters can either be a bit length (such
9284 as
24 for a C class network) or a full netmask in dotted
9287 >The
"IP" parameters above can either be a full dotted
9288 decimal IP address or a hostname which will be looked up via
9289 the OS's normal hostname resolution mechanisms.
</P
9291 >For example, the following line:
</P
9295 >interfaces = eth0
192.168.2.10/
24 192.168.3.10/
255.255.255.0
9299 >would configure three network interfaces corresponding
9300 to the eth0 device and IP addresses
192.168.2.10 and
192.168.3.10.
9301 The netmasks of the latter two interfaces would be set to
255.255.255.0.
</P
9304 HREF=
"#BINDINTERFACESONLY"
9315 >all active interfaces except
127.0.0.1
9316 that are broadcast capable
</EM
9323 >invalid users (S)
</DT
9326 >This is a list of users that should not be allowed
9327 to login to this service. This is really a
<EM
9330 check to absolutely ensure an improper setting does not breach
9333 >A name starting with a '@' is interpreted as an NIS
9334 netgroup first (if your system supports NIS), and then as a UNIX
9335 group if the name was not found in the NIS netgroup database.
</P
9337 >A name starting with '+' is interpreted only
9338 by looking in the UNIX group database. A name starting with
9339 '
&' is interpreted only by looking in the NIS netgroup database
9340 (this requires NIS to be working on your system). The characters
9341 '+' and '
&' may be used at the start of the name in either order
9348 UNIX group database, followed by the NIS netgroup database, and
9354 > means check the NIS
9355 netgroup database, followed by the UNIX group database (the
9356 same as the '@' prefix).
</P
9358 >The current servicename is substituted for
<TT
9364 This is useful in the [homes] section.
</P
9378 >no invalid users
</EM
9383 >invalid users = root fred admin @wheel
9394 >The value of the parameter (an integer) represents
9395 the number of seconds between
<TT
9401 packets. If this parameter is zero, no keepalive packets will be
9402 sent. Keepalive packets, if sent, allow the server to tell whether
9403 a client is still present and responding.
</P
9405 >Keepalives should, in general, not be needed if the socket
9406 being used has the SO_KEEPALIVE attribute set on it (see
<A
9407 HREF=
"#SOCKETOPTIONS"
9415 Basically you should only use this option if you strike difficulties.
</P
9429 NAME=
"KERNELOPLOCKS"
9431 >kernel oplocks (G)
</DT
9434 >For UNIXes that support kernel based
<A
9443 (currently only IRIX and the Linux
2.4 kernel), this parameter
9444 allows the use of them to be turned on or off.
</P
9446 >Kernel oplocks support allows Samba
<TT
9452 > to be broken whenever a local UNIX process or NFS operation
9453 accesses a file that
<A
9461 > has oplocked. This allows complete data consistency between
9462 SMB/CIFS, NFS and local file access (and is a
<EM
9465 cool feature :-).
</P
9467 >This parameter defaults to
<TT
9470 >, but is translated
9471 to a no-op on systems that no not have the necessary kernel support.
9472 You should never need to touch this parameter.
</P
9484 HREF=
"#LEVEL2OPLOCKS"
9496 >kernel oplocks = yes
</B
9503 >lanman auth (G)
</DT
9506 >This parameter determines whether or not
<A
9511 attempt to authenticate users using the LANMAN password hash.
9512 If disabled, only clients which support NT password hashes (e.g. Windows
9513 NT/
2000 clients, smbclient, etc... but not Windows
95/
98 or the MS DOS
9514 network client) will be able to connect to the Samba host.
</P
9518 >lanman auth = yes
</B
9523 NAME=
"LARGEREADWRITE"
9525 >large readwrite (G)
</DT
9528 >This parameter determines whether or not
<A
9533 supports the new
64k streaming read and write varient SMB requests introduced
9534 with Windows
2000. Note that due to Windows
2000 client redirector bugs
9535 this requires Samba to be running on a
64-bit capable operating system such
9536 as IRIX, Solaris or a Linux
2.4 kernel. Can improve performance by
10% with
9537 Windows
2000 clients. Defaults to off. Not as tested as some other Samba
9543 >large readwrite = no
</B
9548 NAME=
"LEVEL2OPLOCKS"
9550 >level2 oplocks (S)
</DT
9553 >This parameter controls whether Samba supports
9554 level2 (read-only) oplocks on a share.
</P
9556 >Level2, or read-only oplocks allow Windows NT clients
9557 that have an oplock on a file to downgrade from a read-write oplock
9558 to a read-only oplock once a second client opens the file (instead
9559 of releasing all oplocks on a second open, as in traditional,
9560 exclusive oplocks). This allows all openers of the file that
9561 support level2 oplocks to cache the file for read-ahead only (ie.
9562 they may not cache writes or lock requests) and increases performance
9563 for many accesses of files that are not commonly written (such as
9564 application .EXE files).
</P
9566 >Once one of the clients which have a read-only oplock
9567 writes to the file all clients are notified (no reply is needed
9568 or waited for) and told to break their oplocks to
"none" and
9569 delete any read-ahead caches.
</P
9571 >It is recommended that this parameter be turned on
9572 to speed access to shared executables.
</P
9574 >For more discussions on level2 oplocks see the CIFS spec.
</P
9577 HREF=
"#KERNELOPLOCKS"
9585 > are supported then level2 oplocks are
9586 not granted (even if this parameter is set to
<TT
9599 > parameter must be set to
<TT
9602 > on this share in order for
9603 this parameter to have any effect.
</P
9627 >level2 oplocks = yes
</B
9634 >lm announce (G)
</DT
9637 >This parameter determines if
<A
9644 > will produce Lanman announce
9645 broadcasts that are needed by OS/
2 clients in order for them to see
9646 the Samba server in their browse list. This parameter can have three
9657 >. The default is
<TT
9664 > Samba will never produce these
9665 broadcasts. If set to
<TT
9668 > Samba will produce
9669 Lanman announce broadcasts at a frequency set by the parameter
9679 Samba will not send Lanman announce broadcasts by default but will
9680 listen for them. If it hears such a broadcast on the wire it will
9681 then start sending them at a frequency set by the parameter
9702 >lm announce = auto
</B
9707 >lm announce = yes
</B
9714 >lm interval (G)
</DT
9717 >If Samba is set to produce Lanman announce
9718 broadcasts needed by OS/
2 clients (see the
<A
9726 > parameter) then this
9727 parameter defines the frequency in seconds with which they will be
9728 made. If this is set to zero then no Lanman announcements will be
9729 made despite the setting of the
<TT
9750 >lm interval =
60</B
9755 >lm interval =
120</B
9762 >load printers (G)
</DT
9765 >A boolean variable that controls whether all
9766 printers in the printcap will be loaded for browsing by default.
9775 >load printers = yes
</B
9782 >local master (G)
</DT
9785 >This option allows
<A
9792 > to try and become a local master browser
9793 on a subnet. If set to
<TT
9799 > will not attempt to become a local master browser
9800 on a subnet and will also lose in all browsing elections. By
9801 default this value is set to
<TT
9804 >. Setting this value to
<TT
9808 mean that Samba will
<EM
9811 browser on a subnet, just that
<B
9816 > in elections for local master browser.
</P
9818 >Setting this value to
<TT
9827 > to become a local master browser.
</P
9831 >local master = yes
</B
9842 HREF=
"#LOCKDIRECTORY"
9853 NAME=
"LOCKDIRECTORY"
9855 >lock directory (G)
</DT
9858 >This option specifies the directory where lock
9859 files will be placed. The lock files are used to implement the
9861 HREF=
"#MAXCONNECTIONS"
9873 >lock directory = ${prefix}/var/locks
</B
9878 >lock directory = /var/run/samba/locks
</B
9889 >This controls whether or not locking will be
9890 performed by the server in response to lock requests from the
9896 >, all lock and unlock
9897 requests will appear to succeed and all lock queries will report
9898 that the file in question is available for locking.
</P
9903 >, real locking will be performed
9908 > be useful for read-only
9909 filesystems which
<EM
9911 > not need locking (such as
9912 CDROM drives), although setting this parameter of
<TT
9916 is not really recommended even in this case.
</P
9918 >Be careful about disabling locking either globally or in a
9919 specific service, as lack of locking may result in data corruption.
9920 You should never need to set this parameter.
</P
9934 >This option allows you to override the name
9935 of the Samba log file (also known as the debug file).
</P
9937 >This option takes the standard substitutions, allowing
9938 you to have separate log files for each user or machine.
</P
9942 >log file = /usr/local/samba/var/log.%m
9953 >The value of the parameter (an integer) allows
9954 the debug level (logging level) to be specified in the
9958 > file. This is to give greater
9959 flexibility in the configuration of the system.
</P
9961 >The default will be the log level specified on
9962 the command line or level zero if none was specified.
</P
9973 >logon drive (G)
</DT
9976 >This parameter specifies the local path to
9977 which the home directory will be connected (see
<A
9986 and is only used by NT Workstations.
</P
9988 >Note that this option is only useful if Samba is set up as a
9993 >logon drive = z:
</B
9998 >logon drive = h:
</B
10005 >logon home (G)
</DT
10008 >This parameter specifies the home directory
10009 location when a Win95/
98 or NT Workstation logs into a Samba PDC.
10010 It allows you to do
</P
10018 >NET USE H: /HOME
</B
10023 >from a command prompt, for example.
</P
10025 >This option takes the standard substitutions, allowing
10026 you to have separate logon scripts for each user or machine.
</P
10028 >This parameter can be used with Win9X workstations to ensure
10029 that roaming profiles are stored in a subdirectory of the user's
10030 home directory. This is done in the following way:
</P
10034 >logon home = \\%N\%U\profile
</B
10037 >This tells Samba to return the above string, with
10038 substitutions made when a client requests the info, generally
10039 in a NetUserGetInfo request. Win9X clients truncate the info to
10040 \\server\share when a user does
<B
10044 but use the whole string when dealing with profiles.
</P
10046 >Note that in prior versions of Samba, the
<A
10054 > was returned rather than
10064 > but allowed profiles outside the home directory.
10065 The current implementation is correct, and can be used for
10066 profiles if you use the above trick.
</P
10068 >This option is only useful if Samba is set up as a logon
10073 >logon home =
"\\%N\%U"</B
10078 >logon home =
"\\remote_smb_server\%U"</B
10086 >logon path (G)
</DT
10089 >This parameter specifies the home directory
10090 where roaming profiles (NTuser.dat etc files for Windows NT) are
10091 stored. Contrary to previous versions of these manual pages, it has
10092 nothing to do with Win
9X roaming profiles. To find out how to
10093 handle roaming profiles for Win
9X system, see the
<A
10103 >This option takes the standard substitutions, allowing you
10104 to have separate logon scripts for each user or machine. It also
10105 specifies the directory from which the
"Application Data",
10115 >network neighborhood
</TT
10120 and other folders, and their contents, are loaded and displayed on
10121 your Windows NT client.
</P
10123 >The share and the path must be readable by the user for
10124 the preferences and directories to be loaded onto the Windows NT
10125 client. The share must be writeable when the user logs in for the first
10126 time, in order that the Windows NT client can create the NTuser.dat
10127 and other directories.
</P
10129 >Thereafter, the directories and any of the contents can,
10130 if required, be made read-only. It is not advisable that the
10131 NTuser.dat file be made read-only - rename it to NTuser.man to
10132 achieve the desired effect (a
<EM
10137 >Windows clients can sometimes maintain a connection to
10138 the [homes] share, even though there is no user logged in.
10139 Therefore, it is vital that the logon path does not include a
10140 reference to the homes share (i.e. setting this parameter to
10141 \%N\%U\profile_path will cause problems).
</P
10143 >This option takes the standard substitutions, allowing
10144 you to have separate logon scripts for each user or machine.
</P
10146 >Note that this option is only useful if Samba is set up
10147 as a logon server.
</P
10151 >logon path = \\%N\%U\profile
</B
10156 >logon path = \\PROFILESERVER\PROFILE\%U
</B
10163 >logon script (G)
</DT
10166 >This parameter specifies the batch file (.bat) or
10167 NT command file (.cmd) to be downloaded and run on a machine when
10168 a user successfully logs in. The file must contain the DOS
10169 style CR/LF line endings. Using a DOS-style editor to create the
10170 file is recommended.
</P
10172 >The script must be a relative path to the [netlogon]
10173 service. If the [netlogon] service specifies a
<A
10183 >/usr/local/samba/netlogon
10187 >logon script = STARTUP.BAT
</B
10189 the file that will be downloaded is:
</P
10193 >/usr/local/samba/netlogon/STARTUP.BAT
</TT
10196 >The contents of the batch file are entirely your choice. A
10197 suggested command would be to add
<B
10199 >NET TIME \\SERVER /SET
10201 >, to force every machine to synchronize clocks with
10202 the same time server. Another use would be to add
<B
10205 U: \\SERVER\UTILS
</B
10206 > for commonly used utilities, or
<B
10208 > NET USE Q: \\SERVER\ISO9001_QA
</B
10211 >Note that it is particularly important not to allow write
10212 access to the [netlogon] share, or to grant users write permission
10213 on the batch files in a secure environment, as this would allow
10214 the batch files to be arbitrarily modified and security to be
10217 >This option takes the standard substitutions, allowing you
10218 to have separate logon scripts for each user or machine.
</P
10220 >This option is only useful if Samba is set up as a logon
10224 >no logon script defined
</EM
10229 >logon script = scripts\%U.bat
</B
10234 NAME=
"LPPAUSECOMMAND"
10236 >lppause command (S)
</DT
10239 >This parameter specifies the command to be
10240 executed on the server host in order to stop printing or spooling
10241 a specific print job.
</P
10243 >This command should be a program or script which takes
10244 a printer name and job number to pause the print job. One way
10245 of implementing this is by using job priorities, where jobs
10246 having a too low priority won't be sent to the printer.
</P
10253 > is given then the printer name
10254 is put in its place. A
<TT
10260 the job number (an integer). On HPUX (see
<TT
10272 to the lpq command, the job will show up with the correct status, i.e.
10273 if the job priority is lower than the set fence priority it will
10274 have the PAUSED status, whereas if the priority is equal or higher it
10275 will have the SPOOLED or PRINTING status.
</P
10277 >Note that it is good practice to include the absolute path
10278 in the lppause command as the PATH may not be available to the server.
</P
10291 >Default: Currently no default value is given to
10292 this string, unless the value of the
<TT
10301 >, in which case the default is :
</P
10305 >lp -i %p-%j -H hold
</B
10308 >or if the value of the
<TT
10317 >, then the default is:
</P
10321 >qstat -s -j%j -h
</B
10324 >Example for HPUX:
<B
10326 >lppause command = /usr/bin/lpalt
10332 NAME=
"LPQCACHETIME"
10334 >lpq cache time (G)
</DT
10337 >This controls how long lpq info will be cached
10338 for to prevent the
<B
10341 > command being called too
10342 often. A separate cache is kept for each variation of the
<B
10345 > command used by the system, so if you use different
10349 > commands for different users then they won't
10350 share cache information.
</P
10352 >The cache files are stored in
<TT
10356 where xxxx is a hash of the
<B
10359 > command in use.
</P
10361 >The default is
10 seconds, meaning that the cached results
10362 of a previous identical
<B
10365 > command will be used
10366 if the cached data is less than
10 seconds old. A large value may
10367 be advisable if your
<B
10370 > command is very slow.
</P
10372 >A value of
0 will disable caching completely.
</P
10387 >lpq cache time =
10</B
10392 >lpq cache time =
30</B
10399 >lpq command (S)
</DT
10402 >This parameter specifies the command to be
10403 executed on the server host in order to obtain
<B
10407 >-style printer status information.
</P
10409 >This command should be a program or script which
10410 takes a printer name as its only parameter and outputs printer
10411 status information.
</P
10413 >Currently eight styles of printer status information
10414 are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX and SOFTQ.
10415 This covers most UNIX systems. You control which type is expected
10423 >Some clients (notably Windows for Workgroups) may not
10424 correctly send the connection number for the printer they are
10425 requesting status information about. To get around this, the
10426 server reports on the first printer service connected to by the
10427 client. This only happens if the connection number sent is invalid.
</P
10434 > is given then the printer name
10435 is put in its place. Otherwise it is placed at the end of the
10438 >Note that it is good practice to include the absolute path
10448 > may not be available to the server.
</P
10462 >depends on the setting of
<TT
10472 >lpq command = /usr/bin/lpq -P%p
</B
10477 NAME=
"LPRESUMECOMMAND"
10479 >lpresume command (S)
</DT
10482 >This parameter specifies the command to be
10483 executed on the server host in order to restart or continue
10484 printing or spooling a specific print job.
</P
10486 >This command should be a program or script which takes
10487 a printer name and job number to resume the print job. See
10489 HREF=
"#LPPAUSECOMMAND"
10504 > is given then the printer name
10505 is put in its place. A
<TT
10511 the job number (an integer).
</P
10513 >Note that it is good practice to include the absolute path
10517 >lpresume command
</I
10519 > as the PATH may not
10520 be available to the server.
</P
10533 >Default: Currently no default value is given
10534 to this string, unless the value of the
<TT
10543 >, in which case the default is :
</P
10547 >lp -i %p-%j -H resume
</B
10550 >or if the value of the
<TT
10559 >, then the default is:
</P
10563 >qstat -s -j%j -r
</B
10566 >Example for HPUX:
<B
10568 >lpresume command = /usr/bin/lpalt
10576 >lprm command (S)
</DT
10579 >This parameter specifies the command to be
10580 executed on the server host in order to delete a print job.
</P
10582 >This command should be a program or script which takes
10583 a printer name and job number, and deletes the print job.
</P
10590 > is given then the printer name
10591 is put in its place. A
<TT
10597 the job number (an integer).
</P
10599 >Note that it is good practice to include the absolute
10605 > as the PATH may not be
10606 available to the server.
</P
10620 >depends on the setting of
<TT
10631 >lprm command = /usr/bin/lprm -P%p %j
10637 >lprm command = /usr/bin/cancel %p-%j
10643 NAME=
"MACHINEPASSWORDTIMEOUT"
10645 >machine password timeout (G)
</DT
10648 >If a Samba server is a member of a Windows
10649 NT Domain (see the
<A
10650 HREF=
"#SECURITYEQUALSDOMAIN"
10651 >security = domain
</A
10653 parameter) then periodically a running
<A
10657 > process will try and change the MACHINE ACCOUNT
10658 PASSWORD stored in the TDB called
<TT
10660 >private/secrets.tdb
10662 >. This parameter specifies how often this password
10663 will be changed, in seconds. The default is one week (expressed in
10664 seconds), the same as a Windows NT Domain member server.
</P
10667 HREF=
"smbpasswd.8.html"
10675 HREF=
"#SECURITYEQUALSDOMAIN"
10676 > security = domain
</A
10681 >machine password timeout =
604800</B
10688 >magic output (S)
</DT
10691 >This parameter specifies the name of a file
10692 which will contain output created by a magic script (see the
10694 HREF=
"#MAGICSCRIPT"
10702 parameter below).
</P
10704 >Warning: If two clients use the same
<TT
10710 > in the same directory the output file content
10715 >magic output =
<magic script name
>.out
10721 >magic output = myfile.txt
</B
10728 >magic script (S)
</DT
10731 >This parameter specifies the name of a file which,
10732 if opened, will be executed by the server when the file is closed.
10733 This allows a UNIX script to be sent to the Samba host and
10734 executed on behalf of the connected user.
</P
10736 >Scripts executed in this way will be deleted upon
10737 completion assuming that the user has the appropriate level
10738 of privilege and the file permissions allow the deletion.
</P
10740 >If the script generates output, output will be sent to
10741 the file specified by the
<A
10742 HREF=
"#MAGICOUTPUT"
10749 > parameter (see above).
</P
10751 >Note that some shells are unable to interpret scripts
10752 containing CR/LF instead of CR as
10753 the end-of-line marker. Magic scripts must be executable
10756 > on the host, which for some hosts and
10757 some shells will require filtering at the DOS end.
</P
10759 >Magic scripts are
<EM
10764 > be relied upon.
</P
10767 >None. Magic scripts disabled.
</EM
10772 >magic script = user.csh
</B
10779 >mangle case (S)
</DT
10782 >See the section on
<A
10789 >mangle case = no
</B
10796 >mangled map (S)
</DT
10799 >This is for those who want to directly map UNIX
10800 file names which cannot be represented on Windows/DOS. The mangling
10801 of names is not always what is needed. In particular you may have
10802 documents with file extensions that differ between DOS and UNIX.
10803 For example, under UNIX it is common to use
<TT
10807 for HTML files, whereas under Windows/DOS
<TT
10811 is more commonly used.
</P
10824 >mangled map = (*.html *.htm)
</B
10827 >One very useful case is to remove the annoying
<TT
10831 > off the ends of filenames on some CDROMs (only visible
10832 under some UNIXes). To do this use a map of (*;
1 *;).
</P
10835 >no mangled map
</EM
10840 >mangled map = (*;
1 *;)
</B
10845 NAME=
"MANGLEDNAMES"
10847 >mangled names (S)
</DT
10850 >This controls whether non-DOS names under UNIX
10851 should be mapped to DOS-compatible names (
"mangled") and made visible,
10852 or whether non-DOS names should simply be ignored.
</P
10854 >See the section on
<A
10857 > for details on how to control the mangling process.
</P
10859 >If mangling is used then the mangling algorithm is as follows:
</P
10865 >The first (up to) five alphanumeric characters
10866 before the rightmost dot of the filename are preserved, forced
10867 to upper case, and appear as the first (up to) five characters
10868 of the mangled name.
</P
10872 >A tilde
"~" is appended to the first part of the mangled
10873 name, followed by a two-character unique sequence, based on the
10874 original root name (i.e., the original filename minus its final
10875 extension). The final extension is included in the hash calculation
10876 only if it contains any upper case characters or is longer than three
10879 >Note that the character to use may be specified using
10881 HREF=
"#MANGLINGCHAR"
10889 > option, if you don't like '~'.
</P
10893 >The first three alphanumeric characters of the final
10894 extension are preserved, forced to upper case and appear as the
10895 extension of the mangled name. The final extension is defined as that
10896 part of the original filename after the rightmost dot. If there are no
10897 dots in the filename, the mangled name will have no extension (except
10898 in the case of
"hidden files" - see below).
</P
10902 >Files whose UNIX name begins with a dot will be
10903 presented as DOS hidden files. The mangled name will be created as
10904 for other filenames, but with the leading dot removed and
"___" as
10905 its extension regardless of actual original extension (that's three
10910 >The two-digit hash value consists of upper case
10911 alphanumeric characters.
</P
10913 >This algorithm can cause name collisions only if files
10914 in a directory share the same first five alphanumeric characters.
10915 The probability of such a clash is
1/
1300.
</P
10917 >The name mangling (if enabled) allows a file to be
10918 copied between UNIX directories from Windows/DOS while retaining
10919 the long UNIX filename. UNIX files can be renamed to a new extension
10920 from Windows/DOS and will retain the same basename. Mangled names
10921 do not change between sessions.
</P
10925 >mangled names = yes
</B
10930 NAME=
"MANGLEDSTACK"
10932 >mangled stack (G)
</DT
10935 >This parameter controls the number of mangled names
10936 that should be cached in the Samba server
<A
10942 >This stack is a list of recently mangled base names
10943 (extensions are only maintained if they are longer than
3 characters
10944 or contains upper case characters).
</P
10946 >The larger this value, the more likely it is that mangled
10947 names can be successfully converted to correct long UNIX names.
10948 However, large stack sizes will slow most directory accesses. Smaller
10949 stacks save memory in the server (each stack element costs
256 bytes).
10952 >It is not possible to absolutely guarantee correct long
10953 filenames, so be prepared for some surprises!
</P
10957 >mangled stack =
50</B
10962 >mangled stack =
100</B
10967 NAME=
"MANGLINGCHAR"
10969 >mangling char (S)
</DT
10972 >This controls what character is used as
10978 >. The default is a '~'
10979 but this may interfere with some software. Use this option to set
10980 it to whatever you prefer.
</P
10984 >mangling char = ~
</B
10989 >mangling char = ^
</B
10996 >map archive (S)
</DT
10999 >This controls whether the DOS archive attribute
11000 should be mapped to the UNIX owner execute bit. The DOS archive bit
11001 is set when a file has been modified since its last backup. One
11002 motivation for this option it to keep Samba/your PC from making
11003 any file it touches from becoming executable under UNIX. This can
11004 be quite annoying for shared source code, documents, etc...
</P
11006 >Note that this requires the
<TT
11012 parameter to be set such that owner execute bit is not masked out
11013 (i.e. it must include
100). See the parameter
<A
11025 >map archive = yes
</B
11032 >map hidden (S)
</DT
11035 >This controls whether DOS style hidden files
11036 should be mapped to the UNIX world execute bit.
</P
11038 >Note that this requires the
<TT
11044 to be set such that the world execute bit is not masked out (i.e.
11045 it must include
001). See the parameter
<A
11057 >map hidden = no
</B
11064 >map system (S)
</DT
11067 >This controls whether DOS style system files
11068 should be mapped to the UNIX group execute bit.
</P
11070 >Note that this requires the
<TT
11076 to be set such that the group execute bit is not masked out (i.e.
11077 it must include
010). See the parameter
<A
11089 >map system = no
</B
11096 >map to guest (G)
</DT
11099 >This parameter is only useful in
<A
11102 > modes other than
<TT
11105 >security = share
</I
11120 >This parameter can take three different values, which tell
11125 > what to do with user
11126 login requests that don't match a valid UNIX user in some way.
</P
11128 >The three settings are :
</P
11137 > - Means user login
11138 requests with an invalid password are rejected. This is the
11147 logins with an invalid password are rejected, unless the username
11148 does not exist, in which case it is treated as a guest login and
11150 HREF=
"#GUESTACCOUNT"
11164 > - Means user logins
11165 with an invalid password are treated as a guest login and mapped
11167 HREF=
"#GUESTACCOUNT"
11170 this can cause problems as it means that any user incorrectly typing
11171 their password will be silently logged on as
"guest" - and
11172 will not know the reason they cannot access files they think
11173 they should - there will have been no message given to them
11174 that they got their password wrong. Helpdesk services will
11177 > you if you set the
<TT
11183 > parameter this way :-).
</P
11187 >Note that this parameter is needed to set up
"Guest"
11188 share services when using
<TT
11194 share. This is because in these modes the name of the resource being
11197 > sent to the server until after
11198 the server has successfully authenticated the client so the server
11199 cannot make authentication decisions at the correct time (connection
11200 to the share) for
"Guest" shares.
</P
11202 >For people familiar with the older Samba releases, this
11203 parameter maps to the old compile-time setting of the
<TT
11205 > GUEST_SESSSETUP
</TT
11206 > value in local.h.
</P
11210 >map to guest = Never
</B
11215 >map to guest = Bad User
</B
11220 NAME=
"MAXCONNECTIONS"
11222 >max connections (S)
</DT
11225 >This option allows the number of simultaneous
11226 connections to a service to be limited. If
<TT
11232 > is greater than
0 then connections will be refused if
11233 this number of connections to the service are already open. A value
11234 of zero mean an unlimited number of connections may be made.
</P
11236 >Record lock files are used to implement this feature. The
11237 lock files will be stored in the directory specified by the
<A
11238 HREF=
"#LOCKDIRECTORY"
11250 >max connections =
0</B
11255 >max connections =
10</B
11262 >max disk size (G)
</DT
11265 >This option allows you to put an upper limit
11266 on the apparent size of disks. If you set this option to
100
11267 then all shares will appear to be not larger than
100 MB in
11270 >Note that this option does not limit the amount of
11271 data you can put on the disk. In the above case you could still
11272 store much more than
100 MB on the disk, but if a client ever asks
11273 for the amount of free disk space or the total disk size then the
11274 result will be bounded by the amount specified in
<TT
11282 >This option is primarily useful to work around bugs
11283 in some pieces of software that can't handle very large disks,
11284 particularly disks over
1GB in size.
</P
11291 > of
0 means no limit.
</P
11295 >max disk size =
0</B
11300 >max disk size =
1000</B
11307 >max log size (G)
</DT
11310 >This option (an integer in kilobytes) specifies
11311 the max size the log file should grow to. Samba periodically checks
11312 the size and if it is exceeded it will rename the file, adding
11318 >A size of
0 means no limit.
</P
11322 >max log size =
5000</B
11327 >max log size =
1000</B
11337 >This option controls the maximum number of
11338 outstanding simultaneous SMB operations that Samba tells the client
11339 it will allow. You should never need to set this parameter.
</P
11348 NAME=
"MAXOPENFILES"
11350 >max open files (G)
</DT
11353 >This parameter limits the maximum number of
11354 open files that one
<A
11359 serving process may have open for a client at any one time. The
11360 default for this parameter is set very high (
10,
000) as Samba uses
11361 only one bit per unopened file.
</P
11363 >The limit of the number of open files is usually set
11364 by the UNIX per-process file descriptor limit rather than
11365 this parameter so you should never need to touch this parameter.
</P
11369 >max open files =
10000</B
11374 NAME=
"MAXPRINTJOBS"
11376 >max print jobs (S)
</DT
11379 >This parameter limits the maximum number of
11380 jobs allowable in a Samba printer queue at any given moment.
11381 If this number is exceeded,
<A
11388 > will remote
"Out of Space" to the client.
11390 HREF=
"#TOTALPRINTJOBS"
11403 >max print jobs =
1000</B
11408 >max print jobs =
5000</B
11415 >max protocol (G)
</DT
11418 >The value of the parameter (a string) is the highest
11419 protocol level that will be supported by the server.
</P
11421 >Possible values are :
</P
11430 >: Earliest version. No
11431 concept of user names.
</P
11438 >: Slight improvements on
11439 CORE for efficiency.
</P
11448 > version of the protocol. Long filename
11456 >: Updates to Lanman1 protocol.
11464 >: Current up to date version of
11465 the protocol. Used by Windows NT. Known as CIFS.
</P
11469 >Normally this option should not be set as the automatic
11470 negotiation phase in the SMB protocol takes care of choosing
11471 the appropriate protocol.
</P
11474 HREF=
"#MINPROTOCOL"
11486 >max protocol = NT1
</B
11491 >max protocol = LANMAN1
</B
11496 NAME=
"MAXSMBDPROCESSES"
11498 >max smbd processes (G)
</DT
11501 >This parameter limits the maximum number of
11510 processes concurrently running on a system and is intended
11511 as a stopgap to prevent degrading service to clients in the event
11512 that the server has insufficient resources to handle more than this
11513 number of connections. Remember that under normal operating
11514 conditions, each user will have an
<A
11518 > associated with him or her
11519 to handle connections to all shares from a given host.
11524 >max smbd processes =
0</B
11529 >max smbd processes =
1000</B
11539 >This option tells
<A
11544 what the default 'time to live' of NetBIOS names should be (in seconds)
11548 > is requesting a name using either a
11549 broadcast packet or from a WINS server. You should never need to
11550 change this parameter. The default is
3 days.
</P
11554 >max ttl =
259200</B
11561 >max wins ttl (G)
</DT
11564 >This option tells
<A
11569 > when acting as a WINS server (
<A
11570 HREF=
"#WINSSUPPORT"
11574 >wins support = yes
</I
11577 >) what the maximum
11578 'time to live' of NetBIOS names that
<B
11582 will grant will be (in seconds). You should never need to change this
11583 parameter. The default is
6 days (
518400 seconds).
</P
11598 >max wins ttl =
518400</B
11608 >This option controls the maximum packet size
11609 that will be negotiated by Samba. The default is
65535, which
11610 is the maximum. In some cases you may find you get better performance
11611 with a smaller value. A value below
2048 is likely to cause problems.
11616 >max xmit =
65535</B
11621 >max xmit =
8192</B
11626 NAME=
"MESSAGECOMMAND"
11628 >message command (G)
</DT
11631 >This specifies what command to run when the
11632 server receives a WinPopup style message.
</P
11634 >This would normally be a command that would
11635 deliver the message somehow. How this is to be done is
11636 up to your imagination.
</P
11642 >message command = csh -c 'xedit %s;rm %s'
&</B
11646 >This delivers the message using
<B
11650 removes it afterwards.
<EM
11651 >NOTE THAT IT IS VERY IMPORTANT
11652 THAT THIS COMMAND RETURN IMMEDIATELY
</EM
11654 have the '
&' on the end. If it doesn't return immediately then
11655 your PCs may freeze when sending messages (they should recover
11656 after
30 seconds, hopefully).
</P
11658 >All messages are delivered as the global guest user.
11659 The command takes the standard substitutions, although
<TT
11672 >Apart from the standard substitutions, some additional
11673 ones apply. In particular:
</P
11684 > = the filename containing
11694 > = the destination that
11695 the message was sent to (probably the server name).
</P
11704 > = who the message
11709 >You could make this command send mail, or whatever else
11710 takes your fancy. Please let us know of any really interesting
11713 >Here's a way of sending the messages as mail to root:
</P
11717 >message command = /bin/mail -s 'message from %f on
11718 %m' root
< %s; rm %s
</B
11721 >If you don't have a message command then the message
11722 won't be delivered and Samba will tell the sender there was
11723 an error. Unfortunately WfWg totally ignores the error code
11724 and carries on regardless, saying that the message was delivered.
11727 >If you want to silently delete it then try:
</P
11731 >message command = rm %s
</B
11735 >no message command
</EM
11740 >message command = csh -c 'xedit %s;
11746 NAME=
"MINPASSWDLENGTH"
11748 >min passwd length (G)
</DT
11752 HREF=
"#MINPASSWORDLENGTH"
11756 >min password length
</I
11763 NAME=
"MINPASSWORDLENGTH"
11765 >min password length (G)
</DT
11768 >This option sets the minimum length in characters
11769 of a plaintext password that
<B
11772 > will accept when performing
11773 UNIX password changing.
</P
11776 HREF=
"#UNIXPASSWORDSYNC"
11785 HREF=
"#PASSWDPROGRAM"
11793 HREF=
"#PASSWDCHATDEBUG"
11797 >passwd chat debug
</I
11805 >min password length =
5</B
11810 NAME=
"MINPRINTSPACE"
11812 >min print space (S)
</DT
11815 >This sets the minimum amount of free disk
11816 space that must be available before a user will be able to spool
11817 a print job. It is specified in kilobytes. The default is
0, which
11818 means a user can always spool a print job.
</P
11833 >min print space =
0</B
11838 >min print space =
2000</B
11845 >min protocol (G)
</DT
11848 >The value of the parameter (a string) is the
11849 lowest SMB protocol dialect than Samba will support. Please refer
11851 HREF=
"#MAXPROTOCOL"
11859 parameter for a list of valid protocol names and a brief description
11860 of each. You may also wish to refer to the C source code in
11863 >source/smbd/negprot.c
</TT
11864 > for a listing of known protocol
11865 dialects supported by clients.
</P
11867 >If you are viewing this parameter as a security measure, you should
11868 also refer to the
<A
11877 > parameter. Otherwise, you should never need
11878 to change this parameter.
</P
11882 >min protocol = CORE
</B
11887 >min protocol = NT1
</B
11895 >min wins ttl (G)
</DT
11898 >This option tells
<A
11903 when acting as a WINS server (
<A
11904 HREF=
"#WINSSUPPORT"
11908 > wins support = yes
</I
11911 >) what the minimum 'time to live'
11912 of NetBIOS names that
<B
11915 > will grant will be (in
11916 seconds). You should never need to change this parameter. The default
11917 is
6 hours (
21600 seconds).
</P
11921 >min wins ttl =
21600</B
11928 >msdfs root (S)
</DT
11931 >This boolean parameter is only available if
11932 Samba is configured and compiled with the
<B
11935 > option. If set to
<TT
11939 Samba treats the share as a Dfs root and allows clients to browse
11940 the distributed file system tree rooted at the share directory.
11941 Dfs links are specified in the share directory by symbolic
11942 links of the form
<TT
11944 >msdfs:serverA\shareA,serverB\shareB
11946 > and so on. For more information on setting up a Dfs tree
11947 on Samba, refer to
<A
11948 HREF=
"msdfs_setup.html"
11967 >msdfs root = no
</B
11972 NAME=
"NAMERESOLVEORDER"
11974 >name resolve order (G)
</DT
11977 >This option is used by the programs in the Samba
11978 suite to determine what naming services to use and in what order
11979 to resolve host names to IP addresses. The option takes a space
11980 separated string of name resolution options.
</P
11982 >The options are :
"lmhosts",
"host",
"wins" and
"bcast". They
11983 cause names to be resolved as follows :
</P
11993 address in the Samba lmhosts file. If the line in lmhosts has
11994 no name type attached to the NetBIOS name (see the
<A
11995 HREF=
"lmhosts.5.html"
11998 > for details) then
11999 any name type matches for lookup.
</P
12006 > : Do a standard host
12007 name to IP address resolution, using the system
<TT
12011 >, NIS, or DNS lookups. This method of name resolution
12012 is operating system depended for instance on IRIX or Solaris this
12013 may be controlled by the
<TT
12015 >/etc/nsswitch.conf
</TT
12017 file). Note that this method is only used if the NetBIOS name
12018 type being queried is the
0x20 (server) name type, otherwise
12026 > : Query a name with
12027 the IP address listed in the
<A
12035 > parameter. If no WINS server has
12036 been specified this method will be ignored.
</P
12043 > : Do a broadcast on
12044 each of the known local interfaces listed in the
<A
12053 parameter. This is the least reliable of the name resolution
12054 methods as it depends on the target host being on a locally
12055 connected subnet.
</P
12061 >name resolve order = lmhosts host wins bcast
12067 >name resolve order = lmhosts bcast host
12071 >This will cause the local lmhosts file to be examined
12072 first, followed by a broadcast attempt, followed by a normal
12073 system hostname lookup.
</P
12077 NAME=
"NETBIOSALIASES"
12079 >netbios aliases (G)
</DT
12082 >This is a list of NetBIOS names that
<A
12086 > will advertise as additional
12087 names by which the Samba server is known. This allows one machine
12088 to appear in browse lists under multiple names. If a machine is
12089 acting as a browse server or logon server none
12090 of these names will be advertised as either browse server or logon
12091 servers, only the primary name of the machine will be advertised
12092 with these capabilities.
</P
12095 HREF=
"#NETBIOSNAME"
12106 >empty string (no additional names)
</EM
12111 >netbios aliases = TEST TEST1 TEST2
</B
12118 >netbios name (G)
</DT
12121 >This sets the NetBIOS name by which a Samba
12122 server is known. By default it is the same as the first component
12123 of the host's DNS name. If a machine is a browse server or
12124 logon server this name (or the first component
12125 of the hosts DNS name) will be the name that these services are
12126 advertised under.
</P
12129 HREF=
"#NETBIOSALIASES"
12140 >machine DNS name
</EM
12145 >netbios name = MYNAME
</B
12150 NAME=
"NETBIOSSCOPE"
12152 >netbios scope (G)
</DT
12155 >This sets the NetBIOS scope that Samba will
12156 operate under. This should not be set unless every machine
12157 on your LAN also sets this value.
</P
12163 >nis homedir (G)
</DT
12166 >Get the home share server from a NIS map. For
12167 UNIX systems that use an automounter, the user's home directory
12168 will often be mounted on a workstation on demand from a remote
12171 >When the Samba logon server is not the actual home directory
12172 server, but is mounting the home directories via NFS then two
12173 network hops would be required to access the users home directory
12174 if the logon server told the client to use itself as the SMB server
12175 for home directories (one over SMB and one over NFS). This can
12178 >This option allows Samba to return the home share as
12179 being on a different server to the logon server and as
12180 long as a Samba daemon is running on the home directory server,
12181 it will be mounted on the Samba client directly from the directory
12182 server. When Samba is returning the home share to the client, it
12183 will consult the NIS map specified in
<A
12191 > and return the server
12194 >Note that for this option to work there must be a working
12195 NIS system and the Samba server with this option must also
12196 be a logon server.
</P
12200 >nis homedir = no
</B
12205 NAME=
"NTACLSUPPORT"
12207 >nt acl support (G)
</DT
12210 >This boolean parameter controls whether
12215 > will attempt to map
12216 UNIX permissions into Windows NT access control lists.
</P
12220 >nt acl support = yes
</B
12225 NAME=
"NTPIPESUPPORT"
12227 >nt pipe support (G)
</DT
12230 >This boolean parameter controls whether
12235 > will allow Windows NT
12236 clients to connect to the NT SMB specific
<TT
12240 pipes. This is a developer debugging option and can be left
12245 >nt pipe support = yes
</B
12250 NAME=
"NTSMBSUPPORT"
12252 >nt smb support (G)
</DT
12255 >This boolean parameter controls whether
<A
12259 > will negotiate NT specific SMB
12260 support with Windows NT clients. Although this is a developer
12261 debugging option and should be left alone, benchmarking has discovered
12262 that Windows NT clients give faster performance with this option
12266 >. This is still being investigated.
12267 If this option is set to
<TT
12270 > then Samba offers
12271 exactly the same SMB calls that versions prior to Samba
2.0 offered.
12272 This information may be of use if any users are having problems
12273 with NT SMB support.
</P
12275 >You should not need to ever disable this parameter.
</P
12279 >nt smb support = yes
</B
12284 NAME=
"NULLPASSWORDS"
12286 >null passwords (G)
</DT
12289 >Allow or disallow client access to accounts
12290 that have null passwords.
</P
12293 HREF=
"smbpasswd.5.html"
12300 >null passwords = no
</B
12305 NAME=
"OBEYPAMRESTRICTIONS"
12307 >obey pam restrictions (G)
</DT
12310 >When Samba
2.2 is configured to enable PAM support
12311 (i.e. --with-pam), this parameter will control whether or not Samba
12312 should obey PAM's account and session management directives. The
12313 default behavior is to use PAM for clear text authentication only
12314 and to ignore any account or session management. Note that Samba
12315 always ignores PAM for authentication in the case of
<A
12316 HREF=
"#ENCRYPTPASSWORDS"
12320 >encrypt passwords = yes
</I
12324 >. The reason is that PAM modules cannot support the challenge/response
12325 authentication mechanism needed in the presence of SMB password encryption.
12330 >obey pam restrictions = no
</B
12340 >This is a boolean option that controls whether
12341 connections with usernames not in the
<TT
12347 list will be allowed. By default this option is disabled so that a
12348 client can supply a username to be used by the server. Enabling
12349 this parameter will force the server to only user the login
12355 > list and is only really
12357 HREF=
"#SECURITYEQUALSSHARE"
12362 >Note that this also means Samba won't try to deduce
12363 usernames from the service name. This can be annoying for
12364 the [homes] section. To get around this you could use
<B
12368 > which means your
<TT
12374 will be just the service name, which for home directories is the
12375 name of the user.
</P
12397 >only guest (S)
</DT
12412 NAME=
"OPLOCKBREAKWAITTIME"
12414 >oplock break wait time (G)
</DT
12417 >This is a tuning parameter added due to bugs in
12418 both Windows
9x and WinNT. If Samba responds to a client too
12419 quickly when that client issues an SMB that can cause an oplock
12420 break request, then the network client can fail and not respond
12421 to the break request. This tuning parameter (which is set in milliseconds)
12422 is the amount of time Samba will wait before sending an oplock break
12423 request to such (broken) clients.
</P
12426 >DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
12427 AND UNDERSTOOD THE SAMBA OPLOCK CODE
</EM
12432 >oplock break wait time =
0</B
12437 NAME=
"OPLOCKCONTENTIONLIMIT"
12439 >oplock contention limit (S)
</DT
12450 improve the efficiency of the granting of oplocks under multiple
12451 client contention for the same file.
</P
12453 >In brief it specifies a number, which causes
<A
12458 grant an oplock even when requested if the approximate number of
12459 clients contending for an oplock on the same file goes over this
12460 limit. This causes
<B
12463 > to behave in a similar
12464 way to Windows NT.
</P
12467 >DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
12468 AND UNDERSTOOD THE SAMBA OPLOCK CODE
</EM
12473 >oplock contention limit =
2</B
12483 >This boolean option tells
<B
12487 issue oplocks (opportunistic locks) to file open requests on this
12488 share. The oplock code can dramatically (approx.
30% or more) improve
12489 the speed of access to files on Samba servers. It allows the clients
12490 to aggressively cache files locally and you may want to disable this
12491 option for unreliable network environments (it is turned on by
12492 default in Windows NT Servers). For more information see the file
12502 >Oplocks may be selectively turned off on certain files with a
12504 HREF=
"#VETOOPLOCKFILES"
12508 > veto oplock files
</I
12511 > parameter. On some systems
12512 oplocks are recognized by the underlying operating system. This
12513 allows data synchronization between all access to oplocked files,
12514 whether it be via Samba or NFS or a local UNIX process. See the
12520 > parameter for details.
</P
12523 HREF=
"#KERNELOPLOCKS"
12532 HREF=
"#LEVEL2OPLOCKS"
12536 > level2 oplocks
</I
12553 >This integer value controls what level Samba
12554 advertises itself as for browse elections. The value of this
12555 parameter determines whether
<A
12560 has a chance of becoming a local master browser for the
<TT
12565 > in the local broadcast area.
</P
12569 >By default, Samba will win
12570 a local master browsing election over all Microsoft operating
12571 systems except a Windows NT
4.0/
2000 Domain Controller. This
12572 means that a misconfigured Samba host can effectively isolate
12573 a subnet for browsing purposes. See
<TT
12595 NAME=
"OS2DRIVERMAP"
12597 >os2 driver map (G)
</DT
12600 >The parameter is used to define the absolute
12601 path to a file containing a mapping of Windows NT printer driver
12602 names to OS/
2 printer driver names. The format is:
</P
12604 ><nt driver name
> =
<os2 driver
12605 name
>.
<device name
></P
12607 >For example, a valid entry using the HP LaserJet
5
12608 printer driver would appear as
<B
12610 >HP LaserJet
5L = LASERJET.HP
12614 >The need for the file is due to the printer driver namespace
12615 problem described in the
<A
12616 HREF=
"printer_driver2.html"
12620 >. For more details on OS/
2 clients, please
12622 HREF=
"OS2-Client-HOWTO.html"
12626 > containing in the Samba documentation.
</P
12630 >os2 driver map =
<empty string
>
12636 NAME=
"PAMPASSWORDCHANGE"
12638 >pam password change (G)
</DT
12641 >With the addition of better PAM support in Samba
2.2,
12642 this parameter, it is possible to use PAM's password change control
12643 flag for Samba. If enabled, then PAM will be used for password
12644 changes when requested by an SMB client insted of the program listed in
12646 HREF=
"#PASSWDPROGRAM"
12654 It should be possible to enable this without changing your
12664 paramater for most setups.
12669 >pam password change = no
</B
12676 >panic action (G)
</DT
12679 >This is a Samba developer option that allows a
12680 system command to be called when either
<A
12689 crashes. This is usually used to draw attention to the fact that
12690 a problem occurred.
</P
12694 >panic action =
<empty string
></B
12699 >panic action =
"/bin/sleep 90000"</B
12706 >passwd chat (G)
</DT
12709 >This string controls the
<EM
12712 conversation that takes places between
<A
12716 > and the local password changing
12717 program to change the user's password. The string describes a
12718 sequence of response-receive pairs that
<A
12722 > uses to determine what to send to the
12724 HREF=
"#PASSWDPROGRAM"
12732 > and what to expect back. If the expected output is not
12733 received then the password is not changed.
</P
12735 >This chat sequence is often quite site specific, depending
12736 on what local methods are used for password control (such as NIS
12739 >The string can contain the macros
<TT
12750 > which are substituted for the old
12751 and new passwords respectively. It can also contain the standard
12764 > to give line-feed,
12765 carriage-return, tab and space.
</P
12767 >The string can also contain a '*' which matches
12768 any sequence of characters.
</P
12770 >Double quotes can be used to collect strings with spaces
12771 in them into a single string.
</P
12773 >If the send string in any part of the chat sequence
12774 is a full stop
".", then no string is sent. Similarly,
12775 if the expect string is a full stop then no string is expected.
</P
12777 >Note that if the
<A
12778 HREF=
"#UNIXPASSWORDSYNC"
12786 > parameter is set to
<TT
12790 sequence is called
<EM
12792 > when the SMB password
12793 in the smbpasswd file is being changed, without access to the old
12794 password cleartext. In this case the old password cleartext is set
12795 to
"" (the empty string).
</P
12798 HREF=
"#PAMPASSWORDCHANGE"
12806 > parameter is set to true, the chat pairs
12807 may be matched in any order, and sucess is determined by the PAM result,
12808 not any particular output. The \n macro is ignored for PAM conversions.
12812 HREF=
"#UNIXPASSWORDSYNC"
12821 HREF=
"#PASSWDPROGRAM"
12825 > passwd program
</I
12829 HREF=
"#PASSWDCHATDEBUG"
12833 >passwd chat debug
</I
12837 HREF=
"#PAMPASSWORDCHANGE"
12841 >pam password change
</I
12848 >passwd chat = *new*password* %n\n
12849 *new*password* %n\n *changed*
</B
12854 >passwd chat =
"*Enter OLD password*" %o\n
12855 "*Enter NEW password*" %n\n
"*Reenter NEW password*" %n\n
"*Password
12861 NAME=
"PASSWDCHATDEBUG"
12863 >passwd chat debug (G)
</DT
12866 >This boolean specifies if the passwd chat script
12867 parameter is run in
<EM
12869 > mode. In this mode the
12870 strings passed to and received from the passwd chat are printed
12885 of
100. This is a dangerous option as it will allow plaintext passwords
12886 to be seen in the
<B
12889 > log. It is available to help
12890 Samba admins debug their
<TT
12896 when calling the
<TT
12902 be turned off after this has been done. This option has no effect if the
12904 HREF=
"#PAMPASSWORDCHANGE"
12908 >pam password change
</I
12912 paramter is set. This parameter is off by default.
</P
12924 HREF=
"#PAMPASSWORDCHANGE"
12928 >pam password change
</I
12933 HREF=
"#PASSWDPROGRAM"
12945 >passwd chat debug = no
</B
12950 NAME=
"PASSWDPROGRAM"
12952 >passwd program (G)
</DT
12955 >The name of a program that can be used to set
12956 UNIX user passwords. Any occurrences of
<TT
12962 will be replaced with the user name. The user name is checked for
12963 existence before calling the password changing program.
</P
12965 >Also note that many passwd programs insist in
<EM
12968 > passwords, such as a minimum length, or the inclusion
12969 of mixed case chars and digits. This can pose a problem as some clients
12970 (such as Windows for Workgroups) uppercase the password before sending
12981 > parameter is set to
<TT
12985 > then this program is called
<EM
12988 before the SMB password in the
<A
12989 HREF=
"smbpasswd.5.html"
12993 > file is changed. If this UNIX password change fails, then
12997 > will fail to change the SMB password also
12998 (this is by design).
</P
13003 >unix password sync
</I
13006 is set this parameter
<EM
13007 >MUST USE ABSOLUTE PATHS
</EM
13011 > programs called, and must be examined
13012 for security implications. Note that by default
<TT
13024 HREF=
"#UNIXPASSWORDSYNC"
13036 >passwd program = /bin/passwd
</B
13041 >passwd program = /sbin/npasswd %u
</B
13047 NAME=
"PASSWORDLEVEL"
13049 >password level (G)
</DT
13052 >Some client/server combinations have difficulty
13053 with mixed-case passwords. One offending client is Windows for
13054 Workgroups, which for some reason forces passwords to upper
13055 case when using the LANMAN1 protocol, but leaves them alone when
13056 using COREPLUS! Another problem child is the Windows
95/
98
13057 family of operating systems. These clients upper case clear
13058 text passwords even when NT LM
0.12 selected by the protocol
13059 negotiation request/response.
</P
13061 >This parameter defines the maximum number of characters
13062 that may be upper case in passwords.
</P
13064 >For example, say the password given was
"FRED". If
<TT
13067 > password level
</I
13069 > is set to
1, the following combinations
13070 would be tried if
"FRED" failed:
</P
13072 >"Fred",
"fred",
"fRed",
"frEd",
"freD"</P
13080 the following combinations would also be tried:
</P
13082 >"FRed",
"FrEd",
"FreD",
"fREd",
"fReD",
"frED", ..
</P
13086 >The higher value this parameter is set to the more likely
13087 it is that a mixed case password will be matched against a single
13088 case password. However, you should be aware that use of this
13089 parameter reduces security and increases the time taken to
13090 process a new connection.
</P
13092 >A value of zero will cause only two attempts to be
13093 made - the password as is and the password in all-lower case.
</P
13097 >password level =
0</B
13102 >password level =
4</B
13107 NAME=
"PASSWORDSERVER"
13109 >password server (G)
</DT
13112 >By specifying the name of another SMB server (such
13113 as a WinNT box) with this option, and using
<B
13119 >security = server
</B
13120 > you can get Samba
13121 to do all its username/password validation via a remote server.
</P
13123 >This option sets the name of the password server to use.
13124 It must be a NetBIOS name, so if the machine's NetBIOS name is
13125 different from its Internet name then you may have to add its NetBIOS
13126 name to the lmhosts file which is stored in the same directory
13132 >The name of the password server is looked up using the
13134 HREF=
"#NAMERESOLVEORDER"
13142 > and so may resolved
13143 by any method and order described in that parameter.
</P
13145 >The password server much be a machine capable of using
13146 the
"LM1.2X002" or the
"NT LM 0.12" protocol, and it must be in
13147 user level security mode.
</P
13151 > Using a password server
13152 means your UNIX box (running Samba) is only as secure as your
13153 password server.
<EM
13154 >DO NOT CHOOSE A PASSWORD SERVER THAT
13155 YOU DON'T COMPLETELY TRUST
</EM
13158 >Never point a Samba server at itself for password
13159 serving. This will cause a loop and could lock up your Samba
13162 >The name of the password server takes the standard
13163 substitutions, but probably the only useful one is
<TT
13169 >, which means the Samba server will use the incoming
13170 client as the password server. If you use this then you better
13171 trust your clients, and you had better restrict them with hosts allow!
</P
13178 > parameter is set to
13182 >, then the list of machines in this
13183 option must be a list of Primary or Backup Domain controllers for the
13184 Domain or the character '*', as the Samba server is effectively
13185 in that domain, and will use cryptographically authenticated RPC calls
13186 to authenticate the user logging on. The advantage of using
<B
13188 > security = domain
</B
13189 > is that if you list several hosts in the
13193 >password server
</I
13199 > will try each in turn till it finds one that responds. This
13200 is useful in case your primary server goes down.
</P
13205 >password server
</I
13208 to the character '*', then Samba will attempt to auto-locate the
13209 Primary or Backup Domain controllers to authenticate against by
13210 doing a query for the name
<TT
13212 >WORKGROUP
<1C
></TT
13214 and then contacting each server returned in the list of IP
13215 addresses from the name resolution source.
</P
13226 >, then there are different
13227 restrictions that
<B
13229 >security = domain
</B
13237 >You may list several password servers in
13241 >password server
</I
13243 > parameter, however if an
13247 > makes a connection to a password server,
13248 and then the password server fails, no more users will be able
13249 to be authenticated from this
<B
13253 restriction of the SMB/CIFS protocol when in
<B
13257 > mode and cannot be fixed in Samba.
</P
13261 >If you are using a Windows NT server as your
13262 password server then you will have to ensure that your users
13263 are able to login from the Samba server, as when in
<B
13265 > security = server
</B
13266 > mode the network logon will appear to
13267 come from there rather than from the users workstation.
</P
13284 >password server =
<empty string
></B
13290 >password server = NT-PDC, NT-BDC1, NT-BDC2
13296 >password server = *
</B
13306 >This parameter specifies a directory to which
13307 the user of the service is to be given access. In the case of
13308 printable services, this is where print data will spool prior to
13309 being submitted to the host for printing.
</P
13311 >For a printable service offering guest access, the service
13312 should be readonly and the path should be world-writeable and
13313 have the sticky bit set. This is not mandatory of course, but
13314 you probably won't get the results you expect if you do
13317 >Any occurrences of
<TT
13323 will be replaced with the UNIX username that the client is using
13324 on this connection. Any occurrences of
<TT
13330 will be replaced by the NetBIOS name of the machine they are
13331 connecting from. These replacements are very useful for setting
13332 up pseudo home directories for users.
</P
13334 >Note that this path will be based on
<A
13342 > if one was specified.
</P
13350 >path = /home/fred
</B
13355 NAME=
"POSIXLOCKING"
13357 >posix locking (S)
</DT
13368 daemon maintains an database of file locks obtained by SMB clients.
13369 The default behavior is to map this internal database to POSIX
13370 locks. This means that file locks obtained by SMB clients are
13371 consistent with those seen by POSIX compliant applications accessing
13372 the files via a non-SMB method (e.g. NFS or local file access).
13373 You should never need to disable this parameter.
</P
13377 >posix locking = yes
</B
13387 >This option specifies a command to be run
13388 whenever the service is disconnected. It takes the usual
13389 substitutions. The command may be run as the root on some
13392 >An interesting example may be to unmount server
13397 >postexec = /etc/umount /cdrom
</B
13412 >none (no command executed)
</EM
13418 >postexec = echo \
"%u disconnected from %S
13419 from %m (%I)\" >> /tmp/log
</B
13426 >postscript (S)
</DT
13429 >This parameter forces a printer to interpret
13430 the print files as PostScript. This is done by adding a
<TT
13434 > to the start of print output.
</P
13436 >This is most useful when you have lots of PCs that persist
13437 in putting a control-D at the start of print jobs, which then
13438 confuses your printer.
</P
13442 >postscript = no
</B
13452 >This option specifies a command to be run whenever
13453 the service is connected to. It takes the usual substitutions.
</P
13455 >An interesting example is to send the users a welcome
13456 message every time they log in. Maybe a message of the day? Here
13461 >preexec = csh -c 'echo \
"Welcome to %S!\" |
13462 /usr/local/samba/bin/smbclient -M %m -I %I'
& </B
13465 >Of course, this could get annoying after a while :-)
</P
13468 HREF=
"#PREEXECCLOSE"
13488 >none (no command executed)
</EM
13493 >preexec = echo \
"%u connected to %S from %m
13494 (%I)\" >> /tmp/log
</B
13499 NAME=
"PREEXECCLOSE"
13501 >preexec close (S)
</DT
13504 >This boolean option controls whether a non-zero
13505 return code from
<A
13514 > should close the service being connected to.
</P
13518 >preexec close = no
</B
13523 NAME=
"PREFERREDMASTER"
13525 >preferred master (G)
</DT
13528 >This boolean parameter controls if
<A
13532 > is a preferred master browser
13533 for its workgroup.
</P
13535 >If this is set to
<TT
13542 will force an election, and it will have a slight advantage in
13543 winning the election. It is recommended that this parameter is
13544 used in conjunction with
<B
13547 HREF=
"#DOMAINMASTER"
13558 > can guarantee becoming a domain master.
</P
13560 >Use this option with caution, because if there are several
13561 hosts (whether Samba servers, Windows
95 or NT) that are preferred
13562 master browsers on the same subnet, they will each periodically
13563 and continuously attempt to become the local master browser.
13564 This will result in unnecessary broadcast traffic and reduced browsing
13580 >preferred master = auto
</B
13585 NAME=
"PREFEREDMASTER"
13587 >prefered master (G)
</DT
13591 HREF=
"#PREFERREDMASTER"
13595 > preferred master
</I
13598 > for people who cannot spell :-).
</P
13607 >This is a list of services that you want to be
13608 automatically added to the browse lists. This is most useful
13609 for homes and printers services that would otherwise not be
13612 >Note that if you just want all printers in your
13613 printcap file loaded then the
<A
13614 HREF=
"#LOADPRINTERS"
13621 > option is easier.
</P
13624 >no preloaded services
</EM
13629 >preload = fred lp colorlp
</B
13634 NAME=
"PRESERVECASE"
13636 >preserve case (S)
</DT
13639 > This controls if new filenames are created
13640 with the case that the client passes, or if they are forced to
13642 HREF=
"#DEFAULTCASE"
13654 >preserve case = yes
</B
13657 >See the section on
<A
13661 > for a fuller discussion.
</P
13665 NAME=
"PRINTCOMMAND"
13667 >print command (S)
</DT
13670 >After a print job has finished spooling to
13671 a service, this command will be used via a
<B
13675 call to process the spool file. Typically the command specified will
13676 submit the spool file to the host's printing subsystem, but there
13677 is no requirement that this be the case. The server will not remove
13678 the spool file, so whatever command you specify should remove the
13679 spool file when it has been processed, otherwise you will need to
13680 manually remove old spool files.
</P
13682 >The print command is simply a text string. It will be used
13683 verbatim, with two exceptions: All occurrences of
<TT
13694 > will be replaced by the
13695 appropriate spool file name, and all occurrences of
<TT
13701 > will be replaced by the appropriate printer name. The
13702 spool file name is generated automatically by the server, the printer
13703 name is discussed below.
</P
13705 >The print command
<EM
13708 one occurrence of
<TT
13724 > is optional. At the time
13725 a job is submitted, if no printer name is supplied the
<TT
13731 > will be silently removed from the printer command.
</P
13733 >If specified in the [global] section, the print command given
13734 will be used for any printable service that does not have its own
13735 print command specified.
</P
13737 >If there is neither a specified print command for a
13738 printable service nor a global print command, spool files will
13739 be created but not processed and (most importantly) not removed.
</P
13741 >Note that printing may fail on some UNIXes from the
13745 > account. If this happens then create
13746 an alternative guest account that can print and set the
<A
13747 HREF=
"#GUESTACCOUNT"
13755 in the [global] section.
</P
13757 >You can form quite complex print commands by realizing
13758 that they are just passed to a shell. For example the following
13759 will log a print job, print the file, then remove it. Note that
13760 ';' is the usual separator for command in shell scripts.
</P
13764 >print command = echo Printing %s
>>
13765 /tmp/print.log; lpr -P %p %s; rm %s
</B
13768 >You may have to vary this command considerably depending
13769 on how you normally print files on your system. The default for
13770 the parameter varies depending on the setting of the
<A
13782 >printing = BSD, AIX, QNX, LPRNG
13788 >print command = lpr -r -P%p %s
</B
13793 >printing = SYS or HPUX :
</B
13798 >print command = lp -c -d%p %s; rm %s
</B
13803 >printing = SOFTQ :
</B
13808 >print command = lp -d%p -s %s; rm %s
</B
13813 >print command = /usr/local/samba/bin/myprintscript
13841 >If this parameter is
<TT
13845 clients may open, write to and submit spool files on the directory
13846 specified for the service.
</P
13848 >Note that a printable service will ALWAYS allow writing
13849 to the service path (user privileges permitting) via the spooling
13850 of print data. The
<A
13859 > parameter controls only non-printing access to
13875 HREF=
"#PRINTCAPNAME"
13886 NAME=
"PRINTCAPNAME"
13888 >printcap name (G)
</DT
13891 >This parameter may be used to override the
13892 compiled-in default printcap name used by the server (usually
<TT
13894 > /etc/printcap
</TT
13895 >). See the discussion of the
<A
13898 > section above for reasons
13899 why you might want to do this.
</P
13901 >On System V systems that use
<B
13905 list available printers you can use
<B
13907 >printcap name = lpstat
13909 > to automatically obtain lists of available printers. This
13910 is the default for systems that define SYSV at configure time in
13911 Samba (this includes most System V based systems). If
<TT
13920 these systems then Samba will launch
<B
13924 attempt to parse the output to obtain a printer list.
</P
13926 >A minimal printcap file would look something like this:
</P
13935 CLASS=
"PROGRAMLISTING"
13936 > print1|My Printer
1
13937 print2|My Printer
2
13938 print3|My Printer
3
13939 print4|My Printer
4
13940 print5|My Printer
5
13947 >where the '|' separates aliases of a printer. The fact
13948 that the second alias has a space in it gives a hint to Samba
13949 that it's a comment.
</P
13953 >: Under AIX the default printcap
13957 >. Samba will assume the
13961 > format if the string
13965 > appears in the printcap filename.
</P
13969 >printcap name = /etc/printcap
</B
13974 >printcap name = /etc/myprintcap
</B
13979 NAME=
"PRINTERADMIN"
13981 >printer admin (S)
</DT
13984 >This is a list of users that can do anything to
13985 printers via the remote administration interfaces offered by MS-RPC
13986 (usually using a NT workstation). Note that the root user always
13987 has admin rights.
</P
13991 >printer admin =
<empty string
></B
13997 >printer admin = admin, @staff
</B
14002 NAME=
"PRINTERDRIVER"
14004 >printer driver (S)
</DT
14009 >This is a deprecated
14010 parameter and will be removed in the next major release
14011 following version
2.2. Please see the instructions in
14013 HREF=
"printer_driver2.html"
14015 >Samba
2.2. Printing
14017 > for more information
14018 on the new method of loading printer drivers onto a Samba server.
14021 >This option allows you to control the string
14022 that clients receive when they ask the server for the printer driver
14023 associated with a printer. If you are using Windows95 or Windows NT
14024 then you can use this to automate the setup of printers on your
14027 >You need to set this parameter to the exact string (case
14028 sensitive) that describes the appropriate printer driver for your
14029 system. If you don't know the exact string to use then you should
14030 first try with no
<A
14031 HREF=
"#PRINTERDRIVER"
14035 > printer driver
</I
14038 > option set and the client will
14039 give you a list of printer drivers. The appropriate strings are
14040 shown in a scroll box after you have chosen the printer manufacturer.
</P
14043 HREF=
"#PRINTERDRIVERFILE"
14055 >printer driver = HP LaserJet
4L</B
14060 NAME=
"PRINTERDRIVERFILE"
14062 >printer driver file (G)
</DT
14067 >This is a deprecated
14068 parameter and will be removed in the next major release
14069 following version
2.2. Please see the instructions in
14071 HREF=
"printer_driver2.html"
14073 >Samba
2.2. Printing
14075 > for more information
14076 on the new method of loading printer drivers onto a Samba server.
14079 >This parameter tells Samba where the printer driver
14080 definition file, used when serving drivers to Windows
95 clients, is
14081 to be found. If this is not set, the default is :
</P
14086 CLASS=
"REPLACEABLE"
14088 >SAMBA_INSTALL_DIRECTORY
</I
14091 /lib/printers.def
</TT
14094 >This file is created from Windows
95 <TT
14098 > files found on the Windows
95 client system. For more
14099 details on setting up serving of printer drivers to Windows
95
14100 clients, see the outdated documentation file in the
<TT
14106 >PRINTER_DRIVER.txt
</TT
14110 HREF=
"#PRINTERDRIVERLOCATION"
14114 > printer driver location
</I
14120 >None (set in compile).
</EM
14125 >printer driver file =
14126 /usr/local/samba/printers/drivers.def
</B
14131 NAME=
"PRINTERDRIVERLOCATION"
14133 >printer driver location (S)
</DT
14138 >This is a deprecated
14139 parameter and will be removed in the next major release
14140 following version
2.2. Please see the instructions in
14142 HREF=
"printer_driver2.html"
14144 >Samba
2.2. Printing
14146 > for more information
14147 on the new method of loading printer drivers onto a Samba server.
14150 >This parameter tells clients of a particular printer
14151 share where to find the printer driver files for the automatic
14152 installation of drivers for Windows
95 machines. If Samba is set up
14153 to serve printer drivers to Windows
95 machines, this should be set to
</P
14157 >\\MACHINE\PRINTER$
</B
14160 >Where MACHINE is the NetBIOS name of your Samba server,
14161 and PRINTER$ is a share you set up for serving printer driver
14162 files. For more details on setting this up see the outdated documentation
14168 > PRINTER_DRIVER.txt
</TT
14172 HREF=
"#PRINTERDRIVERFILE"
14176 > printer driver file
</I
14188 >printer driver location = \\MACHINE\PRINTER$
14196 >printer name (S)
</DT
14199 >This parameter specifies the name of the printer
14200 to which print jobs spooled through a printable service will be sent.
</P
14202 >If specified in the [global] section, the printer
14203 name given will be used for any printable service that does
14204 not have its own printer name specified.
</P
14207 >none (but may be
<TT
14211 on many systems)
</EM
14216 >printer name = laserwriter
</B
14227 HREF=
"#PRINTERNAME"
14243 >This parameters controls how printer status
14244 information is interpreted on your system. It also affects the
14245 default values for the
<TT
14265 >lpresume command
</I
14273 > if specified in the
14274 [global] section.
</P
14276 >Currently eight printing styles are supported. They are
14310 >To see what the defaults are for the other print
14311 commands when using the various options use the
<A
14312 HREF=
"testparm.1.html"
14317 >This option can be set on a per printer basis
</P
14319 >See also the discussion in the
<A
14332 HREF=
"#MAXPROTOCOL"
14361 NAME=
"QUEUEPAUSECOMMAND"
14363 >queuepause command (S)
</DT
14366 >This parameter specifies the command to be
14367 executed on the server host in order to pause the printer queue.
</P
14369 >This command should be a program or script which takes
14370 a printer name as its only parameter and stops the printer queue,
14371 such that no longer jobs are submitted to the printer.
</P
14373 >This command is not supported by Windows for Workgroups,
14374 but can be issued from the Printers window under Windows
95
14382 > is given then the printer name
14383 is put in its place. Otherwise it is placed at the end of the command.
14386 >Note that it is good practice to include the absolute
14387 path in the command as the PATH may not be available to the
14391 >depends on the setting of
<TT
14402 >queuepause command = disable %p
</B
14407 NAME=
"QUEUERESUMECOMMAND"
14409 >queueresume command (S)
</DT
14412 >This parameter specifies the command to be
14413 executed on the server host in order to resume the printer queue. It
14414 is the command to undo the behavior that is caused by the
14415 previous parameter (
<A
14416 HREF=
"#QUEUEPAUSECOMMAND"
14420 > queuepause command
</I
14425 >This command should be a program or script which takes
14426 a printer name as its only parameter and resumes the printer queue,
14427 such that queued jobs are resubmitted to the printer.
</P
14429 >This command is not supported by Windows for Workgroups,
14430 but can be issued from the Printers window under Windows
95
14438 > is given then the printer name
14439 is put in its place. Otherwise it is placed at the end of the
14442 >Note that it is good practice to include the absolute
14443 path in the command as the PATH may not be available to the
14447 >depends on the setting of
<A
14461 >queuepause command = enable %p
14472 >This boolean parameter controls whether
<A
14476 > will support the
"Read
14477 Block Multiplex" SMB. This is now rarely used and defaults to
14481 >. You should never need to set this
14496 >This is a list of users that are given read-only
14497 access to a service. If the connecting user is in this list then
14498 they will not be given write access, no matter what the
<A
14507 option is set to. The list can include group names using the
14508 syntax described in the
<A
14509 HREF=
"#INVALIDUSERS"
14526 > parameter and the
<A
14527 HREF=
"#INVALIDUSERS"
14539 >read list =
<empty string
></B
14544 >read list = mary, @students
</B
14554 >Note that this is an inverted synonym for
<A
14571 >This parameter controls whether or not the server
14572 will support the raw read SMB requests when transferring data
14575 >If enabled, raw reads allow reads of
65535 bytes in
14576 one packet. This typically provides a major performance benefit.
14579 >However, some clients either negotiate the allowable
14580 block size incorrectly or are incapable of supporting larger block
14581 sizes, and for these clients you may need to disable raw reads.
</P
14583 >In general this parameter should be viewed as a system tuning
14584 tool and left severely alone. See also
<A
14612 affects the overlap of disk reads/writes with network reads/writes.
14613 If the amount of data being transferred in several of the SMB
14614 commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger
14615 than this value then the server begins writing the data before it
14616 has received the whole packet from the network, or in the case of
14617 SMBreadbraw, it begins writing to the network before all the data
14618 has been read from disk.
</P
14620 >This overlapping works best when the speeds of disk and
14621 network access are similar, having very little effect when the
14622 speed of one is much greater than the other.
</P
14624 >The default value is
16384, but very little experimentation
14625 has been done yet to determine the optimal value, and it is likely
14626 that the best value will vary greatly between systems anyway.
14627 A value over
65536 is pointless and will cause you to allocate
14628 memory unnecessarily.
</P
14632 >read size =
16384</B
14637 >read size =
8192</B
14642 NAME=
"REMOTEANNOUNCE"
14644 >remote announce (G)
</DT
14647 >This option allows you to setup
<A
14651 > to periodically announce itself
14652 to arbitrary IP addresses with an arbitrary workgroup name.
</P
14654 >This is useful if you want your Samba server to appear
14655 in a remote workgroup for which the normal browse propagation
14656 rules don't work. The remote workgroup can be anywhere that you
14657 can send IP packets to.
</P
14663 >remote announce =
192.168.2.255/SERVERS
14664 192.168.4.255/STAFF
</B
14667 >the above line would cause
<B
14670 > to announce itself
14671 to the two given IP addresses using the given workgroup names.
14672 If you leave out the workgroup name then the one given in
14682 parameter is used instead.
</P
14684 >The IP addresses you choose would normally be the broadcast
14685 addresses of the remote networks, but can also be the IP addresses
14686 of known browse masters if your network config is that stable.
</P
14688 >See the documentation file
<TT
14699 >remote announce =
<empty string
>
14705 NAME=
"REMOTEBROWSESYNC"
14707 >remote browse sync (G)
</DT
14710 >This option allows you to setup
<A
14714 > to periodically request
14715 synchronization of browse lists with the master browser of a Samba
14716 server that is on a remote segment. This option will allow you to
14717 gain browse lists for multiple workgroups across routed networks. This
14718 is done in a manner that does not work with any non-Samba servers.
</P
14720 >This is useful if you want your Samba server and all local
14721 clients to appear in a remote workgroup for which the normal browse
14722 propagation rules don't work. The remote workgroup can be anywhere
14723 that you can send IP packets to.
</P
14729 >remote browse sync =
192.168.2.255 192.168.4.255
14733 >the above line would cause
<B
14737 the master browser on the specified subnets or addresses to
14738 synchronize their browse lists with the local server.
</P
14740 >The IP addresses you choose would normally be the broadcast
14741 addresses of the remote networks, but can also be the IP addresses
14742 of known browse masters if your network config is that stable. If
14743 a machine IP address is given Samba makes NO attempt to validate
14744 that the remote machine is available, is listening, nor that it
14745 is in fact the browse master on its segment.
</P
14749 >remote browse sync =
<empty string
>
14755 NAME=
"RESTRICTACLWITHMASK"
14757 >restrict acl with mask (S)
</DT
14760 >This is a boolean parameter. If set to
<TT
14764 creation of files with access control lists (ACLS) and modification of ACLs
14765 using the Windows NT/
2000 ACL editor will be applied directly to the file
14771 >, then all requests to set an ACL on a file will have the
14782 HREF=
"#FORCECREATEMODE"
14786 >force create mode
</I
14790 applied before setting the ACL, and all requests to set an ACL on a directory will
14791 have the parameters
<A
14792 HREF=
"#DIRECTORYMASK"
14801 HREF=
"#FORCEDIRECTORYMODE"
14809 > applied before setting the ACL.
14822 HREF=
"#FORCECREATEMODE"
14826 >force create mode
</I
14831 HREF=
"#DIRECTORYMASK"
14840 HREF=
"#FORCEDIRECTORYMODE"
14844 >force directory mode
</I
14852 >restrict acl with mask = no
</B
14857 NAME=
"RESTRICTANONYMOUS"
14859 >restrict anonymous (G)
</DT
14862 >This is a boolean parameter. If it is
<TT
14866 anonymous access to the server will be restricted, namely in the
14867 case where the server is expecting the client to send a username,
14868 but it doesn't. Setting it to
<TT
14871 > will force these anonymous
14872 connections to be denied, and the client will be required to always
14873 supply a username and password when connecting. Use of this parameter
14874 is only recommended for homogeneous NT client environments.
</P
14876 >This parameter makes the use of macro expansions that rely
14877 on the username (%U, %G, etc) consistent. NT
4.0
14878 likes to use anonymous connections when refreshing the share list,
14879 and this is a way to work around that.
</P
14881 >When restrict anonymous is
<TT
14884 >, all anonymous connections
14885 are denied no matter what they are for. This can effect the ability
14886 of a machine to access the Samba Primary Domain Controller to revalidate
14887 its machine account after someone else has logged on the client
14888 interactively. The NT client will display a message saying that
14889 the machine's account in the domain doesn't exist or the password is
14890 bad. The best way to deal with this is to reboot NT client machines
14891 between interactive logons, using
"Shutdown and Restart", rather
14892 than
"Close all programs and logon as a different user".
</P
14896 >restrict anonymous = no
</B
14907 HREF=
"#ROOTDIRECTORY"
14911 >root directory
"</I
14924 HREF="#ROOTDIRECTORY
"
14928 >root directory"</I
14935 NAME=
"ROOTDIRECTORY"
14937 >root directory (G)
</DT
14940 >The server will
<B
14944 Change its root directory) to this directory on startup. This is
14945 not strictly necessary for secure operation. Even without it the
14946 server will deny access to files not in one of the service entries.
14947 It may also check for, and deny access to, soft links to other
14948 parts of the filesystem, or attempts to use
".." in file names
14949 to access other directories (depending on the setting of the
<A
14966 than
"/" adds an extra level of security, but at a price. It
14967 absolutely ensures that no access is given to files not in the
14968 sub-tree specified in the
<TT
14976 > some files needed for
14977 complete operation of the server. To maintain full operability
14978 of the server you will need to mirror some system files
14984 > tree. In particular
14985 you will need to mirror
<TT
14989 subset of it), and any binaries or configuration files needed for
14990 printing (if required). The set of files that must be mirrored is
14991 operating system dependent.
</P
14995 >root directory = /
</B
15000 >root directory = /homes/smb
</B
15005 NAME=
"ROOTPOSTEXEC"
15007 >root postexec (S)
</DT
15010 >This is the same as the
<TT
15016 parameter except that the command is run as root. This
15017 is useful for unmounting filesystems
15018 (such as CDROMs) after a connection is closed.
</P
15032 >root postexec =
<empty string
>
15040 >root preexec (S)
</DT
15043 >This is the same as the
<TT
15049 parameter except that the command is run as root. This
15050 is useful for mounting filesystems (such as CDROMs) when a
15051 connection is opened.
</P
15062 HREF=
"#PREEXECCLOSE"
15073 >root preexec =
<empty string
>
15079 NAME=
"ROOTPREEXECCLOSE"
15081 >root preexec close (S)
</DT
15084 >This is the same as the
<TT
15090 > parameter except that the command is run as root.
</P
15101 HREF=
"#PREEXECCLOSE"
15112 >root preexec close = no
</B
15122 >This option affects how clients respond to
15123 Samba and is one of the most important settings in the
<TT
15128 >The option sets the
"security mode bit" in replies to
15129 protocol negotiations with
<A
15134 > to turn share level security on or off. Clients decide
15135 based on this bit whether (and how) to transfer user and password
15136 information to the server.
</P
15140 >security = user
</B
15142 the most common setting needed when talking to Windows
98 and
15145 >The alternatives are
<B
15147 >security = share
</B
15151 >security = server
</B
15158 >In versions of Samba prior to
2.
.0, the default was
15161 >security = share
</B
15162 > mainly because that was
15163 the only option at one stage.
</P
15165 >There is a bug in WfWg that has relevance to this
15166 setting. When in user or server level security a WfWg client
15167 will totally ignore the password you type in the
"connect
15168 drive" dialog box. This makes it very difficult (if not impossible)
15169 to connect to a Samba service as anyone except the user that
15170 you are logged into WfWg as.
</P
15172 >If your PCs use usernames that are the same as their
15173 usernames on the UNIX machine then you will want to use
15176 >security = user
</B
15177 >. If you mostly use usernames
15178 that don't exist on the UNIX box then use
<B
15184 >You should also use
<B
15186 >security = share
</B
15188 want to mainly setup shares without a password (guest shares). This
15189 is commonly used for a shared printer server. It is more difficult
15190 to setup guest shares with
<B
15192 >security = user
</B
15203 >parameter for details.
</P
15205 >It is possible to use
<B
15210 > where it is offers both user and share
15211 level security under different
<A
15212 HREF=
"#NETBIOSALIASES"
15216 >NetBIOS aliases
</I
15221 >The different settings will now be explained.
</P
15224 NAME=
"SECURITYEQUALSSHARE"
15231 >When clients connect to a share level security server they
15232 need not log onto the server with a valid username and password before
15233 attempting to connect to a shared resource (although modern clients
15234 such as Windows
95/
98 and Windows NT will send a logon request with
15235 a username but no password when talking to a
<B
15239 > server). Instead, the clients send authentication information
15240 (passwords) on a per-share basis, at the time they attempt to connect
15249 uses a valid UNIX user to act on behalf of the client, even in
15252 >security = share
</B
15253 > level security.
</P
15255 >As clients are not required to send a username to the server
15256 in share level security,
<B
15260 techniques to determine the correct UNIX user to use on behalf
15263 >A list of possible UNIX usernames to match with the given
15264 client password is constructed using the following methods :
</P
15279 > parameter is set, then all the other
15280 stages are missed and only the
<A
15281 HREF=
"#GUESTACCOUNT"
15288 > username is checked.
15293 >Is a username is sent with the share connection
15294 request, then this username (after mapping - see
<A
15295 HREF=
"#USERNAMEMAP"
15303 is added as a potential username.
</P
15307 >If the client did a previous
<EM
15310 > request (the SessionSetup SMB call) then the
15311 username sent in this SMB will be added as a potential username.
15316 >The name of the service the client requested is
15317 added as a potential username.
</P
15321 >The NetBIOS name of the client is added to
15322 the list as a potential username.
</P
15326 >Any users on the
<A
15334 > list are added as potential usernames.
15345 not set, then this list is then tried with the supplied password.
15346 The first user for whom the password matches will be used as the
15355 set, or no username can be determined then if the share is marked
15356 as available to the
<TT
15362 guest user will be used, otherwise access is denied.
</P
15364 >Note that it can be
<EM
15367 in share-level security as to which UNIX username will eventually
15368 be used in granting access.
</P
15370 >See also the section
<A
15372 > NOTE ABOUT USERNAME/PASSWORD VALIDATION
</A
15376 NAME=
"SECURITYEQUALSUSER"
15383 >This is the default security setting in Samba
2.2.
15384 With user-level security a client must first
"log-on" with a
15385 valid username and password (which can be mapped using the
<A
15386 HREF=
"#USERNAMEMAP"
15394 parameter). Encrypted passwords (see the
<A
15395 HREF=
"#ENCRYPTPASSWORDS"
15399 >encrypted passwords
</I
15402 > parameter) can also
15403 be used in this security mode. Parameters such as
<A
15419 > if set are then applied and
15420 may change the UNIX user to use on this connection, but only after
15421 the user has been successfully authenticated.
</P
15425 > that the name of the resource being
15428 > sent to the server until after
15429 the server has successfully authenticated the client. This is why
15430 guest shares don't work in user level security without allowing
15431 the server to automatically map unknown users into the
<A
15432 HREF=
"#GUESTACCOUNT"
15449 > parameter for details on doing this.
</P
15451 >See also the section
<A
15453 > NOTE ABOUT USERNAME/PASSWORD VALIDATION
</A
15457 NAME=
"SECURITYEQUALSSERVER"
15464 >In this mode Samba will try to validate the username/password
15465 by passing it to another SMB server, such as an NT box. If this
15466 fails it will revert to
<B
15468 >security = user
</B
15470 that if encrypted passwords have been negotiated then Samba cannot
15471 revert back to checking the UNIX password file, it must have a valid
15475 > file to check users against. See the
15476 documentation file in the
<TT
15482 >ENCRYPTION.txt
</TT
15483 > for details on how to set this
15488 > that from the client's point of
15491 >security = server
</B
15492 > is the same as
<B
15494 > security = user
</B
15495 >. It only affects how the server deals
15496 with the authentication, it does not in any way affect what the
15501 > that the name of the resource being
15504 > sent to the server until after
15505 the server has successfully authenticated the client. This is why
15506 guest shares don't work in user level security without allowing
15507 the server to automatically map unknown users into the
<A
15508 HREF=
"#GUESTACCOUNT"
15525 > parameter for details on doing this.
</P
15527 >See also the section
<A
15529 > NOTE ABOUT USERNAME/PASSWORD VALIDATION
</A
15533 HREF=
"#PASSWORDSERVER"
15541 > parameter and the
<A
15542 HREF=
"#ENCRYPTPASSWORDS"
15546 >encrypted passwords
</I
15553 NAME=
"SECURITYEQUALSDOMAIN"
15560 >This mode will only work correctly if
<A
15561 HREF=
"smbpasswd.8.html"
15564 > has been used to add this
15565 machine into a Windows NT Domain. It expects the
<A
15566 HREF=
"#ENCRYPTPASSWORDS"
15570 >encrypted passwords
</I
15574 > parameter to be set to
<TT
15578 mode Samba will try to validate the username/password by passing
15579 it to a Windows NT Primary or Backup Domain Controller, in exactly
15580 the same way that a Windows NT Server would do.
</P
15584 > that a valid UNIX user must still
15585 exist as well as the account on the Domain Controller to allow
15586 Samba to have a valid UNIX account to map file access to.
</P
15590 > that from the client's point
15593 >security = domain
</B
15594 > is the same as
<B
15598 >. It only affects how the server deals with the authentication,
15599 it does not in any way affect what the client sees.
</P
15603 > that the name of the resource being
15606 > sent to the server until after
15607 the server has successfully authenticated the client. This is why
15608 guest shares don't work in user level security without allowing
15609 the server to automatically map unknown users into the
<A
15610 HREF=
"#GUESTACCOUNT"
15627 > parameter for details on doing this.
</P
15631 > There is currently a bug in the
15632 implementation of
<B
15634 >security = domain
</B
15636 to multi-byte character set usernames. The communication with a
15637 Domain Controller must be done in UNICODE and Samba currently
15638 does not widen multi-byte user names to UNICODE correctly, thus
15639 a multi-byte username will not be recognized correctly at the
15640 Domain Controller. This issue will be addressed in a future release.
</P
15642 >See also the section
<A
15644 > NOTE ABOUT USERNAME/PASSWORD VALIDATION
</A
15648 HREF=
"#PASSWORDSERVER"
15656 > parameter and the
<A
15657 HREF=
"#ENCRYPTPASSWORDS"
15661 >encrypted passwords
</I
15669 >security = USER
</B
15674 >security = DOMAIN
</B
15679 NAME=
"SECURITYMASK"
15681 >security mask (S)
</DT
15684 >This parameter controls what UNIX permission
15685 bits can be modified when a Windows NT client is manipulating
15686 the UNIX permission on a file using the native NT security
15689 >This parameter is applied as a mask (AND'ed with) to
15690 the changed permission bits, thus preventing any bits not in
15691 this mask from being modified. Essentially, zero bits in this
15692 mask may be treated as a set of bits the user is not allowed
15695 >If not set explicitly this parameter is
0777, allowing
15696 a user to modify all the user/group/world permissions on a file.
15701 > that users who can access the
15702 Samba server through other means can easily bypass this
15703 restriction, so it is primarily useful for standalone
15704 "appliance" systems. Administrators of most normal systems will
15705 probably want to leave it set to
<TT
15711 HREF=
"#FORCEDIRECTORYSECURITYMODE"
15715 >force directory security mode
</I
15720 HREF=
"#DIRECTORYSECURITYMASK"
15729 HREF=
"#FORCESECURITYMODE"
15733 >force security mode
</I
15740 >security mask =
0777</B
15745 >security mask =
0770</B
15750 NAME=
"SERVERSTRING"
15752 >server string (G)
</DT
15755 >This controls what string will show up in the
15756 printer comment box in print manager and next to the IPC connection
15760 >. It can be any string that you wish
15761 to show to your users.
</P
15763 >It also sets what will appear in browse lists next
15764 to the machine name.
</P
15771 > will be replaced with the Samba
15779 > will be replaced with the
15784 >server string = Samba %v
</B
15789 >server string = University of GNUs Samba
15795 NAME=
"SETDIRECTORY"
15797 >set directory (S)
</DT
15802 >set directory = no
</B
15804 users of the service may not use the setdir command to change
15810 > command is only implemented
15811 in the Digital Pathworks client. See the Pathworks documentation
15816 >set directory = no
</B
15821 NAME=
"SHORTPRESERVECASE"
15823 >short preserve case (S)
</DT
15826 >This boolean parameter controls if new files
15827 which conform to
8.3 syntax, that is all in upper case and of
15828 suitable length, are created upper case, or if they are forced
15830 HREF=
"#DEFAULTCASE"
15838 >. This option can be use with
<A
15839 HREF=
"#PRESERVECASE"
15842 >preserve case = yes
</B
15845 > to permit long filenames to retain their case, while short
15846 names are lowered.
</P
15848 >See the section on
<A
15855 >short preserve case = yes
</B
15860 NAME=
"SHOWADDPRINTERWIZARD"
15862 >show add printer wizard (G)
</DT
15865 >With the introduction of MS-RPC based printing support
15866 for Windows NT/
2000 client in Samba
2.2, a
"Printers..." folder will
15867 appear on Samba hosts in the share listing. Normally this folder will
15868 contain an icon for the MS Add Printer Wizard (APW). However, it is
15869 possible to disable this feature regardless of the level of privilege
15870 of the connected user.
</P
15872 >Under normal circumstances, the Windows NT/
2000 client will
15873 open a handle on the printer server with OpenPrinterEx() asking for
15874 Administrator privileges. If the user does not have administrative
15875 access on the print server (i.e is not root or a member of the
15881 > group), the OpenPrinterEx()
15882 call fails and the client makes another open call with a request for
15883 a lower privilege level. This should succeed, however the APW
15884 icon will not be displayed.
</P
15889 >show add printer wizard
</I
15892 parameter will always cause the OpenPrinterEx() on the server
15893 to fail. Thus the APW icon will never be displayed.
<EM
15895 >This does not prevent the same user from having
15896 administrative privilege on an individual printer.
</P
15899 HREF=
"#ADDPRINTERCOMMAND"
15908 HREF=
"#DELETEPRINTERCOMMAND"
15912 >deleteprinter command
</I
15916 HREF=
"#PRINTERADMIN"
15927 >show add printer wizard = yes
</B
15932 NAME=
"SHUTDOWNSCRIPT"
15934 >shutdown script (G)
</DT
15938 >This parameter only exists in the HEAD cvs branch
</EM
15940 This a full path name to a script called by
15949 should start a shutdown procedure.
</P
15951 >This command will be run as the user connected to the
15954 >%m %t %r %f parameters are expanded
</P
15961 > will be substituted with the
15962 shutdown message sent to the server.
</P
15969 > will be substituted with the
15970 number of seconds to wait before effectively starting the
15971 shutdown procedure.
</P
15978 > will be substituted with the
15981 >. It means reboot after shutdown
15990 > will be substituted with the
15993 >. It means force the shutdown
15994 even if applications do not respond for NT.
</P
16002 >abort shutdown script = /usr/local/samba/sbin/shutdown %m %t %r %f
</B
16005 >Shutdown script example:
16013 CLASS=
"PROGRAMLISTING"
16020 /sbin/shutdown $
3 $
4 +$time $
1 &
16026 Shutdown does not return so we need to launch it in background.
16030 HREF=
"#ABORTSHUTDOWNSCRIPT"
16034 >abort shutdown script
</I
16041 NAME=
"SMBPASSWDFILE"
16043 >smb passwd file (G)
</DT
16046 >This option sets the path to the encrypted
16047 smbpasswd file. By default the path to the smbpasswd file
16048 is compiled into Samba.
</P
16052 >smb passwd file = ${prefix}/private/smbpasswd
16058 >smb passwd file = /etc/samba/smbpasswd
16064 NAME=
"SOCKETADDRESS"
16066 >socket address (G)
</DT
16069 >This option allows you to control what
16070 address Samba will listen for connections on. This is used to
16071 support multiple virtual interfaces on the one server, each
16072 with a different configuration.
</P
16074 >By default Samba will accept connections on any
16079 >socket address =
192.168.2.20</B
16085 NAME=
"SOCKETOPTIONS"
16087 >socket options (G)
</DT
16090 >This option allows you to set socket options
16091 to be used when talking with the client.
</P
16093 >Socket options are controls on the networking layer
16094 of the operating systems which allow the connection to be
16097 >This option will typically be used to tune your Samba
16098 server for optimal performance for your local network. There is
16099 no way that Samba can know what the optimal parameters are for
16100 your net, so you must experiment and choose them yourself. We
16101 strongly suggest you read the appropriate documentation for your
16102 operating system first (perhaps
<B
16108 >You may find that on some systems Samba will say
16109 "Unknown socket option" when you supply an option. This means you
16110 either incorrectly typed it or you need to add an include file
16111 to includes.h for your OS. If the latter is the case please
16112 send the patch to
<A
16113 HREF=
"mailto:samba@samba.org"
16115 > samba@samba.org
</A
16118 >Any of the supported socket options may be combined
16119 in any way you like, as long as your OS allows it.
</P
16121 >This is the list of socket options currently settable
16122 using this option:
</P
16148 >IPTOS_THROUGHPUT
</P
16168 >Those marked with a
<EM
16171 argument. The others can optionally take a
1 or
0 argument to enable
16172 or disable the option, by default they will be enabled if you
16173 don't specify
1 or
0.
</P
16175 >To specify an argument use the syntax SOME_OPTION = VALUE
16178 >SO_SNDBUF =
8192</B
16179 >. Note that you must
16180 not have any spaces before or after the = sign.
</P
16182 >If you are on a local network then a sensible option
16187 >socket options = IPTOS_LOWDELAY
</B
16190 >If you have a local network then you could try:
</P
16194 >socket options = IPTOS_LOWDELAY TCP_NODELAY
</B
16197 >If you are on a wide area network then perhaps try
16198 setting IPTOS_THROUGHPUT.
</P
16200 >Note that several of the options may cause your Samba
16201 server to fail completely. Use these options with caution!
</P
16205 >socket options = TCP_NODELAY
</B
16210 >socket options = IPTOS_LOWDELAY
</B
16215 NAME=
"SOURCEENVIRONMENT"
16217 >source environment (G)
</DT
16220 >This parameter causes Samba to set environment
16221 variables as per the content of the file named.
</P
16223 >If the value of this parameter starts with a
"|" character
16224 then Samba will treat that value as a pipe command to open and
16225 will set the environment variables from the output of the pipe.
</P
16227 >The contents of the file or the output of the pipe should
16228 be formatted as the output of the standard Unix
<B
16232 > command. This is of the form :
</P
16234 >Example environment entry:
</P
16238 >SAMBA_NETBIOS_NAME = myhostname
</B
16242 >No default value
</EM
16247 >source environment = |/etc/smb.conf.sh
16253 >source environment =
16254 /usr/local/smb_env_vars
</B
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 >This variable enables or disables the entire SSL mode. If
16284 >, the SSL-enabled Samba behaves
16285 exactly like the non-SSL Samba. If set to
<TT
16289 it depends on the variables
<A
16298 HREF=
"#SSLHOSTSRESIGN"
16302 >ssl hosts resign
</I
16306 connection will be required.
</P
16315 NAME=
"SSLCACERTDIR"
16317 >ssl CA certDir (G)
</DT
16320 >This variable is part of SSL-enabled Samba. This
16321 is only available if the SSL libraries have been compiled on your
16322 system and the configure option
<B
16326 given at configure time.
</P
16330 > that for export control reasons
16333 > enabled by default in any
16334 current binary version of Samba.
</P
16336 >This variable defines where to look up the Certification
16337 Authorities. The given directory should contain one file for
16338 each CA that Samba will trust. The file name must be the hash
16339 value over the
"Distinguished Name" of the CA. How this directory
16340 is set up is explained later in this document. All files within the
16341 directory that don't fit into this naming scheme are ignored. You
16342 don't need this variable if you don't verify client certificates.
</P
16346 >ssl CA certDir = /usr/local/ssl/certs
16352 NAME=
"SSLCACERTFILE"
16354 >ssl CA certFile (G)
</DT
16357 >This variable is part of SSL-enabled Samba. This
16358 is only available if the SSL libraries have been compiled on your
16359 system and the configure option
<B
16363 given at configure time.
</P
16367 > that for export control reasons
16370 > enabled by default in any
16371 current binary version of Samba.
</P
16373 >This variable is a second way to define the trusted CAs.
16374 The certificates of the trusted CAs are collected in one big
16375 file and this variable points to the file. You will probably
16376 only use one of the two ways to define your CAs. The first choice is
16377 preferable if you have many CAs or want to be flexible, the second
16378 is preferable if you only have one CA and want to keep things
16379 simple (you won't need to create the hashed file names). You
16380 don't need this variable if you don't verify client certificates.
</P
16384 >ssl CA certFile = /usr/local/ssl/certs/trustedCAs.pem
16392 >ssl ciphers (G)
</DT
16395 >This variable is part of SSL-enabled Samba. This
16396 is only available if the SSL libraries have been compiled on your
16397 system and the configure option
<B
16401 given at configure time.
</P
16405 > that for export control reasons
16408 > enabled by default in any
16409 current binary version of Samba.
</P
16411 >This variable defines the ciphers that should be offered
16412 during SSL negotiation. You should not set this variable unless
16413 you know what you are doing.
</P
16417 NAME=
"SSLCLIENTCERT"
16419 >ssl client cert (G)
</DT
16422 >This variable is part of SSL-enabled Samba. This
16423 is only available if the SSL libraries have been compiled on your
16424 system and the configure option
<B
16428 given at configure time.
</P
16432 > that for export control reasons
16435 > enabled by default in any
16436 current binary version of Samba.
</P
16438 >The certificate in this file is used by
<A
16439 HREF=
"smbclient.1.html"
16445 > if it exists. It's needed
16446 if the server requires a client certificate.
</P
16450 >ssl client cert = /usr/local/ssl/certs/smbclient.pem
16456 NAME=
"SSLCLIENTKEY"
16458 >ssl client key (G)
</DT
16461 >This variable is part of SSL-enabled Samba. This
16462 is only available if the SSL libraries have been compiled on your
16463 system and the configure option
<B
16467 given at configure time.
</P
16471 > that for export control reasons
16474 > enabled by default in any
16475 current binary version of Samba.
</P
16477 >This is the private key for
<A
16478 HREF=
"smbclient.1.html"
16484 >. It's only needed if the
16485 client should have a certificate.
</P
16489 >ssl client key = /usr/local/ssl/private/smbclient.pem
16495 NAME=
"SSLCOMPATIBILITY"
16497 >ssl compatibility (G)
</DT
16500 >This variable is part of SSL-enabled Samba. This
16501 is only available if the SSL libraries have been compiled on your
16502 system and the configure option
<B
16506 given at configure time.
</P
16510 > that for export control reasons
16513 > enabled by default in any
16514 current binary version of Samba.
</P
16516 >This variable defines whether SSLeay should be configured
16517 for bug compatibility with other SSL implementations. This is
16518 probably not desirable because currently no clients with SSL
16519 implementations other than SSLeay exist.
</P
16523 >ssl compatibility = no
</B
16534 HREF=
"#SSLHOSTSRESIGN"
16538 > ssl hosts resign
</I
16545 NAME=
"SSLHOSTSRESIGN"
16547 >ssl hosts resign (G)
</DT
16550 >This variable is part of SSL-enabled Samba. This
16551 is only available if the SSL libraries have been compiled on your
16552 system and the configure option
<B
16556 given at configure time.
</P
16560 > that for export control reasons
16563 > enabled by default in any
16564 current binary version of Samba.
</P
16566 >These two variables define whether Samba will go
16567 into SSL mode or not. If none of them is defined, Samba will
16568 allow only SSL connections. If the
<A
16577 hosts (by IP-address, IP-address range, net group or name),
16578 only these hosts will be forced into SSL mode. If the
<TT
16581 > ssl hosts resign
</I
16583 > variable lists hosts, only these
16586 > be forced into SSL mode. The syntax for these two
16587 variables is the same as for the
<A
16603 > pair of variables, only
16604 that the subject of the decision is different: It's not the access
16605 right but whether SSL is used or not.
</P
16607 >The example below requires SSL connections from all hosts
16608 outside the local net (which is
192.168.*.*).
</P
16612 >ssl hosts =
<empty string
></B
16617 >ssl hosts resign =
<empty string
></B
16622 >ssl hosts resign =
192.168.
</B
16627 NAME=
"SSLREQUIRECLIENTCERT"
16629 >ssl require clientcert (G)
</DT
16632 >This variable is part of SSL-enabled Samba. This
16633 is only available if the SSL libraries have been compiled on your
16634 system and the configure option
<B
16638 given at configure time.
</P
16642 > that for export control reasons
16645 > enabled by default in any
16646 current binary version of Samba.
</P
16648 >If this variable is set to
<TT
16652 server will not tolerate connections from clients that don't
16653 have a valid certificate. The directory/file given in
<A
16654 HREF=
"#SSLCACERTDIR"
16663 HREF=
"#SSLCACERTFILE"
16671 > will be used to look up the CAs that issued
16672 the client's certificate. If the certificate can't be verified
16673 positively, the connection will be terminated. If this variable
16677 >, clients don't need certificates.
16678 Contrary to web applications you really
<EM
16681 require client certificates. In the web environment the client's
16682 data is sensitive (credit card numbers) and the server must prove
16683 to be trustworthy. In a file server environment the server's data
16684 will be sensitive and the clients must prove to be trustworthy.
</P
16688 >ssl require clientcert = no
</B
16693 NAME=
"SSLREQUIRESERVERCERT"
16695 >ssl require servercert (G)
</DT
16698 >This variable is part of SSL-enabled Samba. This
16699 is only available if the SSL libraries have been compiled on your
16700 system and the configure option
<B
16704 given at configure time.
</P
16708 > that for export control reasons
16711 > enabled by default in any
16712 current binary version of Samba.
</P
16714 >If this variable is set to
<TT
16719 HREF=
"smbclient.1.html"
16726 > will request a certificate from the server. Same as
16728 HREF=
"#SSLREQUIRECLIENTCERT"
16736 > for the server.
</P
16740 >ssl require servercert = no
</B
16746 NAME=
"SSLSERVERCERT"
16748 >ssl server cert (G)
</DT
16751 >This variable is part of SSL-enabled Samba. This
16752 is only available if the SSL libraries have been compiled on your
16753 system and the configure option
<B
16757 given at configure time.
</P
16761 > that for export control reasons
16764 > enabled by default in any
16765 current binary version of Samba.
</P
16767 >This is the file containing the server's certificate.
16770 > have a certificate. The
16771 file may also contain the server's private key. See later for
16772 how certificates and private keys are created.
</P
16776 >ssl server cert =
<empty string
>
16782 NAME=
"SSLSERVERKEY"
16784 >ssl server key (G)
</DT
16787 >This variable is part of SSL-enabled Samba. This
16788 is only available if the SSL libraries have been compiled on your
16789 system and the configure option
<B
16793 given at configure time.
</P
16797 > that for export control reasons
16800 > enabled by default in any
16801 current binary version of Samba.
</P
16803 >This file contains the private key of the server. If
16804 this variable is not defined, the key is looked up in the
16805 certificate file (it may be appended to the certificate).
16808 > have a private key
16809 and the certificate
<EM
16812 match this private key.
</P
16816 >ssl server key =
<empty string
>
16824 >ssl version (G)
</DT
16827 >This variable is part of SSL-enabled Samba. This
16828 is only available if the SSL libraries have been compiled on your
16829 system and the configure option
<B
16833 given at configure time.
</P
16837 > that for export control reasons
16840 > enabled by default in any
16841 current binary version of Samba.
</P
16843 >This enumeration variable defines the versions of the
16844 SSL protocol that will be used.
<TT
16848 dynamic negotiation of SSL v2 or v3,
<TT
16855 > results in SSL v3 and
16859 > results in TLS v1. TLS (Transport Layer
16860 Security) is the new standard for SSL.
</P
16864 >ssl version =
"ssl2or3"</B
16871 >stat cache (G)
</DT
16874 >This parameter determines if
<A
16878 > will use a cache in order to
16879 speed up case insensitive name mappings. You should never need
16880 to change this parameter.
</P
16884 >stat cache = yes
</B
16889 NAME=
"STATCACHESIZE"
16891 >stat cache size (G)
</DT
16894 >This parameter determines the number of
16901 never need to change this parameter.
</P
16905 >stat cache size =
50</B
16915 >This enables or disables logging of connections
16916 to a status file that
<A
16917 HREF=
"smbstatus.1.html"
16923 >With this disabled
<B
16927 to tell you what connections are active. You should never need to
16928 change this parameter.
</P
16937 NAME=
"STRICTLOCKING"
16939 >strict locking (S)
</DT
16942 >This is a boolean that controls the handling of
16943 file locking in the server. When this is set to
<TT
16947 the server will check every read and write access for file locks, and
16948 deny access if locks exist. This can be slow on some systems.
</P
16950 >When strict locking is
<TT
16953 > the server does file
16954 lock checks only when the client explicitly asks for them.
</P
16956 >Well-behaved clients always ask for lock checks when it
16957 is important, so in the vast majority of cases
<B
16961 > is preferable.
</P
16965 >strict locking = no
</B
16972 >strict sync (S)
</DT
16975 >Many Windows applications (including the Windows
16976 98 explorer shell) seem to confuse flushing buffer contents to
16977 disk with doing a sync to disk. Under UNIX, a sync call forces
16978 the process to be suspended until the kernel has ensured that
16979 all outstanding data in kernel disk buffers has been safely stored
16980 onto stable storage. This is very slow and should only be done
16981 rarely. Setting this parameter to
<TT
16985 default) means that
<A
16989 > ignores the Windows applications requests for
16990 a sync call. There is only a possibility of losing data if the
16991 operating system itself that Samba is running on crashes, so there is
16992 little danger in this default setting. In addition, this fixes many
16993 performance problems that people have reported with the new Windows98
16994 explorer shell file copies.
</P
17009 >strict sync = no
</B
17019 >This is a boolean that controls whether to
17020 strip trailing dots off UNIX filenames. This helps with some
17021 CDROMs that have filenames ending in a single dot.
</P
17032 >sync always (S)
</DT
17035 >This is a boolean parameter that controls
17036 whether writes will always be written to stable storage before
17037 the write call returns. If this is
<TT
17040 > then the server will be
17041 guided by the client's request in each write call (clients can
17042 set a bit indicating that a particular write should be synchronous).
17046 > then every write will be followed by a
<B
17050 > call to ensure the data is written to disk. Note that
17056 > parameter must be set to
17060 > in order for this parameter to have
17076 >sync always = no
</B
17086 >This parameter maps how Samba debug messages
17087 are logged onto the system syslog logging levels. Samba debug
17088 level zero maps onto syslog
<TT
17092 level one maps onto
<TT
17099 >, debug level three
17100 maps onto LOG_INFO. All higher levels are mapped to
<TT
17105 >This parameter sets the threshold for sending messages
17106 to syslog. Only messages with debug level less than this value
17107 will be sent to syslog.
</P
17118 >syslog only (G)
</DT
17121 >If this parameter is set then Samba debug
17122 messages are logged into the system syslog only, and not to
17123 the debug log files.
</P
17127 >syslog only = no
</B
17132 NAME=
"TEMPLATEHOMEDIR"
17134 >template homedir (G)
</DT
17137 >When filling out the user information for a Windows NT
17139 HREF=
"winbindd.8.html"
17143 uses this parameter to fill in the home directory for that user.
17149 > is present it is substituted
17150 with the user's Windows NT domain name. If the string
<TT
17156 > is present it is substituted with the user's Windows
17161 >template homedir = /home/%D/%U
</B
17166 NAME=
"TEMPLATESHELL"
17168 >template shell (G)
</DT
17171 >When filling out the user information for a Windows NT
17173 HREF=
"winbindd.8.html"
17177 uses this parameter to fill in the login shell for that user.
</P
17181 >template shell = /bin/false
</B
17188 >time offset (G)
</DT
17191 >This parameter is a setting in minutes to add
17192 to the normal GMT to local time conversion. This is useful if
17193 you are serving a lot of PCs that have incorrect daylight
17194 saving time handling.
</P
17198 >time offset =
0</B
17203 >time offset =
60</B
17210 >time server (G)
</DT
17213 >This parameter determines if
<A
17218 > advertises itself as a time server to Windows
17223 >time server = no
</B
17228 NAME=
"TIMESTAMPLOGS"
17230 >timestamp logs (G)
</DT
17234 HREF=
"#DEBUGTIMESTAMP"
17238 > debug timestamp
</I
17245 NAME=
"TOTALPRINTJOBS"
17247 >total print jobs (G)
</DT
17250 >This parameter accepts an integer value which defines
17251 a limit on the maximum number of print jobs that will be accepted
17252 system wide at any given time. If a print job is submitted
17253 by a client which will exceed this number, then
<A
17258 error indicating that no space is available on the server. The
17259 default value of
0 means that no such limit exists. This parameter
17260 can be used to prevent a server from exceeding its capacity and is
17261 designed as a printing throttle. See also
17263 HREF=
"#MAXPRINTJOBS"
17275 >total print jobs =
0</B
17280 >total print jobs =
5000</B
17285 NAME=
"UNIXPASSWORDSYNC"
17287 >unix password sync (G)
</DT
17290 >This boolean parameter controls whether Samba
17291 attempts to synchronize the UNIX password with the SMB password
17292 when the encrypted SMB password in the smbpasswd file is changed.
17293 If this is set to
<TT
17296 > the program specified in the
<TT
17302 >parameter is called
<EM
17305 to allow the new UNIX password to be set without access to the
17306 old UNIX password (as the SMB password change code has no
17307 access to the old password cleartext, only the new).
</P
17310 HREF=
"#PASSWDPROGRAM"
17330 >unix password sync = no
</B
17335 NAME=
"UPDATEENCRYPTED"
17337 >update encrypted (G)
</DT
17340 >This boolean parameter allows a user logging
17341 on with a plaintext password to have their encrypted (hashed)
17342 password in the smbpasswd file to be updated automatically as
17343 they log on. This option allows a site to migrate from plaintext
17344 password authentication (users authenticate with plaintext
17345 password over the wire, and are checked against a UNIX account
17346 database) to encrypted password authentication (the SMB
17347 challenge/response authentication mechanism) without forcing
17348 all users to re-enter their passwords via smbpasswd at the time the
17349 change is made. This is a convenience option to allow the change over
17350 to encrypted passwords to be made over a longer period. Once all users
17351 have encrypted representations of their passwords in the smbpasswd
17352 file this parameter should be set to
<TT
17357 >In order for this parameter to work correctly the
<A
17358 HREF=
"#ENCRYPTPASSWORDS"
17362 >encrypt passwords
</I
17366 > parameter must be set to
<TT
17370 this parameter is set to
<TT
17375 >Note that even when this parameter is set a user
17376 authenticating to
<B
17379 > must still enter a valid
17380 password in order to connect correctly, and to update their hashed
17381 (smbpasswd) passwords.
</P
17385 >update encrypted = no
</B
17390 NAME=
"USECLIENTDRIVER"
17392 >use client driver (S)
</DT
17395 >This parameter applies only to Windows NT/
2000
17396 clients. It has no affect on Windows
95/
98/ME clients. When
17397 serving a printer to Windows NT/
2000 clients without first installing
17398 a valid printer driver on the Samba host, the client will be required
17399 to install a local printer driver. From this point on, the client
17400 will treat the print as a local printer and not a network printer
17401 connection. This is much the same behavior that will occur
17404 >disable spoolss = yes
</B
17407 >The differentiating
17408 factor is that under normal circumstances, the NT/
2000 client will
17409 attempt to open the network printer using MS-RPC. The problem is that
17410 because the client considers the printer to be local, it will attempt
17411 to issue the OpenPrinterEx() call requesting access rights associated
17412 with the logged on user. If the user possesses local administator rights
17413 but not root privilegde on the Samba host (often the case), the OpenPrinterEx()
17414 call will fail. The result is that the client will now display an
"Access
17415 Denied; Unable to connect" message in the printer queue window (even though
17416 jobs may successfully be printed).
</P
17418 >If this parameter is enabled for a printer, then any attempt
17419 to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped
17420 to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx()
17421 call to succeed.
<EM
17422 >This parameter MUST not be able enabled
17423 on a print share which has valid print driver installed on the Samba
17428 HREF=
"#DISABLESPOOLSS"
17429 >disable spoolss
</A
17435 >use client driver = no
</B
17442 >use rhosts (G)
</DT
17445 >If this global parameter is
<TT
17449 that the UNIX user's
<TT
17452 > file in their home directory
17453 will be read to find the names of hosts and users who will be allowed
17454 access without specifying a password.
</P
17464 > can be a major security hole. This is because you are
17465 trusting the PC to supply the correct username. It is very easy to
17466 get a PC to supply a false username. I recommend that the
<TT
17471 > option be only used if you really know what
17476 >use rhosts = no
</B
17520 >Multiple users may be specified in a comma-delimited
17521 list, in which case the supplied password will be tested against
17522 each username in turn (left to right).
</P
17529 > line is needed only when
17530 the PC is unable to supply its own username. This is the case
17531 for the COREPLUS protocol or where your users have different WfWg
17532 usernames to UNIX usernames. In both these cases you may also be
17533 better using the \\server\share%user syntax instead.
</P
17540 > line is not a great
17541 solution in many cases as it means Samba will try to validate
17542 the supplied password against each of the usernames in the
17548 > line in turn. This is slow and
17549 a bad idea for lots of users in case of duplicate passwords.
17550 You may get timeouts or security breaches using this parameter
17553 >Samba relies on the underlying UNIX security. This
17554 parameter does not restrict who can login, it just offers hints
17555 to the Samba server as to what usernames might correspond to the
17556 supplied password. Users can login as whoever they please and
17557 they will be able to do no more damage than if they started a
17558 telnet session. The daemon runs as the user that they log in as,
17559 so they cannot do anything that user cannot do.
</P
17561 >To restrict a service to a particular set of users you
17573 >If any of the usernames begin with a '@' then the name
17574 will be looked up first in the NIS netgroups list (if Samba
17575 is compiled with netgroup support), followed by a lookup in
17576 the UNIX groups database and will expand to a list of all users
17577 in the group of that name.
</P
17579 >If any of the usernames begin with a '+' then the name
17580 will be looked up only in the UNIX groups database and will
17581 expand to a list of all users in the group of that name.
</P
17583 >If any of the usernames begin with a '
&'then the name
17584 will be looked up only in the NIS netgroups database (if Samba
17585 is compiled with netgroup support) and will expand to a list
17586 of all users in the netgroup group of that name.
</P
17588 >Note that searching though a groups database can take
17589 quite some time, and some clients may time out during the
17592 >See the section
<A
17595 USERNAME/PASSWORD VALIDATION
</A
17596 > for more information on how
17597 this parameter determines access to the services.
</P
17601 >The guest account if a guest service,
17602 else
<empty string
>.
</B
17607 >username = fred, mary, jack, jane,
17608 @users, @pcgroup
</B
17613 NAME=
"USERNAMELEVEL"
17615 >username level (G)
</DT
17618 >This option helps Samba to try and 'guess' at
17619 the real UNIX username, as many DOS clients send an all-uppercase
17620 username. By default Samba tries all lowercase, followed by the
17621 username with the first letter capitalized, and fails if the
17622 username is not found on the UNIX machine.
</P
17624 >If this parameter is set to non-zero the behavior changes.
17625 This parameter is a number that specifies the number of uppercase
17626 combinations to try while trying to determine the UNIX user name. The
17627 higher the number the more combinations will be tried, but the slower
17628 the discovery of usernames will be. Use this parameter when you have
17629 strange usernames on your UNIX machine, such as
<TT
17637 >username level =
0</B
17642 >username level =
5</B
17649 >username map (G)
</DT
17652 >This option allows you to specify a file containing
17653 a mapping of usernames from the clients to the server. This can be
17654 used for several purposes. The most common is to map usernames
17655 that users use on DOS or Windows machines to those that the UNIX
17656 box uses. The other is to map multiple users to a single username
17657 so that they can more easily share files.
</P
17659 >The map file is parsed line by line. Each line should
17660 contain a single UNIX username on the left then a '=' followed
17661 by a list of usernames on the right. The list of usernames on the
17662 right may contain names of the form @group in which case they
17663 will match any UNIX username in that group. The special client
17664 name '*' is a wildcard and matches any name. Each line of the
17665 map file may be up to
1023 characters long.
</P
17667 >The file is processed on each line by taking the
17668 supplied username and comparing it with each username on the right
17669 hand side of the '=' signs. If the supplied name matches any of
17670 the names on the right hand side then it is replaced with the name
17671 on the left. Processing then continues with the next line.
</P
17673 >If any line begins with a '#' or a ';' then it is
17676 >If any line begins with an '!' then the processing
17677 will stop after that line if a mapping was done by the line.
17678 Otherwise mapping continues with every line being processed.
17679 Using '!' is most useful when you have a wildcard mapping line
17680 later in the file.
</P
17682 >For example to map from the name
<TT
17689 > to the UNIX name
<TT
17692 > you would use:
</P
17696 >root = admin administrator
</B
17699 >Or to map anyone in the UNIX group
<TT
17703 to the UNIX name
<TT
17706 > you would use:
</P
17713 >You can have as many mappings as you like in a username
17716 >If your system supports the NIS NETGROUP option then
17717 the netgroup database is checked before the
<TT
17721 > database for matching groups.
</P
17723 >You can map Windows usernames that have spaces in them
17724 by using double quotes around the name. For example:
</P
17728 >tridge =
"Andrew Tridgell"</B
17731 >would map the windows username
"Andrew Tridgell" to the
17732 unix username
"tridge".
</P
17734 >The following example would map mary and fred to the
17735 unix user sys, and map the rest to guest. Note the use of the
17736 '!' to tell Samba to stop processing if it gets a match on
17746 CLASS=
"PROGRAMLISTING"
17755 >Note that the remapping is applied to all occurrences
17756 of usernames. Thus if you connect to \\server\fred and
<TT
17759 > is remapped to
<TT
17763 will actually be connecting to \\server\mary and will need to
17764 supply a password suitable for
<TT
17771 >. The only exception to this is the
17772 username passed to the
<A
17773 HREF=
"#PASSWORDSERVER"
17777 > password server
</I
17780 > (if you have one). The password
17781 server will receive whatever username the client supplies without
17784 >Also note that no reverse mapping is done. The main effect
17785 this has is with printing. Users who have been mapped may have
17786 trouble deleting print jobs as PrintManager under WfWg will think
17787 they don't own the print job.
</P
17790 >no username map
</EM
17795 >username map = /usr/local/samba/lib/users.map
17806 >This boolean parameter is only available if
17807 Samba has been configured and compiled with the option
<B
17813 > then Samba will attempt
17814 to add utmp or utmpx records (depending on the UNIX system) whenever a
17815 connection is made to a Samba server. Sites may use this to record the
17816 user connecting to a Samba share.
</P
17819 HREF=
"#UTMPDIRECTORY"
17823 > utmp directory
</I
17835 NAME=
"UTMPDIRECTORY"
17837 >utmp directory(G)
</DT
17840 >This parameter is only available if Samba has
17841 been configured and compiled with the option
<B
17844 >. It specifies a directory pathname that is
17845 used to store the utmp or utmpx files (depending on the UNIX system) that
17846 record user connections to a Samba server. See also the
<A
17854 > parameter. By default this is
17855 not set, meaning the system will use whatever utmp file the
17856 native system is set to use (usually
17863 >no utmp directory
</EM
17870 >valid chars (G)
</DT
17873 >The option allows you to specify additional
17874 characters that should be considered valid by the server in
17875 filenames. This is particularly useful for national character
17876 sets, such as adding u-umlaut or a-ring.
</P
17878 >The option takes a list of characters in either integer
17879 or character form with spaces between them. If you give two
17880 characters with a colon between them then it will be taken as
17881 an lowercase:uppercase pair.
</P
17883 >If you have an editor capable of entering the characters
17884 into the config file then it is probably easiest to use this
17885 method. Otherwise you can specify the characters in octal,
17886 decimal or hexadecimal form using the usual C notation.
</P
17888 >For example to add the single character 'Z' to the charset
17889 (which is a pointless thing to do as it's already there) you could
17890 do one of the following
</P
17899 CLASS=
"PROGRAMLISTING"
17902 valid chars =
0132:
0172
17909 >The last two examples above actually add two characters,
17910 and alter the uppercase and lowercase mappings appropriately.
</P
17914 > specify this parameter
17918 >client code page
</I
17921 have both set. If
<TT
17924 >client code page
</I
17932 > parameter the
<TT
17938 > settings will be overwritten.
</P
17941 HREF=
"#CLIENTCODEPAGE"
17952 >Samba defaults to using a reasonable set
17953 of valid characters for English systems
</EM
17958 >valid chars =
0345:
0305 0366:
0326 0344:
0304
17962 >The above example allows filenames to have the Swedish
17963 characters in them.
</P
17967 > It is actually quite difficult to
17968 correctly produce a
<TT
17974 a particular system. To automate the process
<A
17975 HREF=
"mailto:tino@augsburg.net"
17977 >tino@augsburg.net
</A
17979 a package called
<B
17982 > which will automatically
17983 produce a complete
<TT
17989 a given client system. Look in the
<TT
17991 >examples/validchars/
17993 > subdirectory of your Samba source code distribution
17994 for this package.
</P
18000 >valid users (S)
</DT
18003 >This is a list of users that should be allowed
18004 to login to this service. Names starting with '@', '+' and '
&'
18005 are interpreted using the same rules as described in the
18013 >If this is empty (the default) then any user can login.
18014 If a username is in both this list and the
<TT
18020 > list then access is denied for that user.
</P
18022 >The current servicename is substituted for
<TT
18028 >. This is useful in the [homes] section.
</P
18031 HREF=
"#INVALIDUSERS"
18042 >No valid users list (anyone can login)
18048 >valid users = greg, @pcusers
</B
18058 >This is a list of files and directories that
18059 are neither visible nor accessible. Each entry in the list must
18060 be separated by a '/', which allows spaces to be included
18061 in the entry. '*' and '?' can be used to specify multiple files
18062 or directories as in DOS wildcards.
</P
18064 >Each entry must be a unix path, not a DOS path and
18067 > include the unix directory
18076 is applicable in vetoing files.
</P
18078 >One feature of the veto files parameter that it
18079 is important to be aware of is Samba's behaviour when
18080 trying to delete a directory. If a directory that is
18081 to be deleted contains nothing but veto files this
18084 > unless you also set
18088 >delete veto files
</I
18098 >Setting this parameter will affect the performance
18099 of Samba, as it will be forced to check all files and directories
18100 for a match as they are scanned.
</P
18112 HREF=
"#CASESENSITIVE"
18116 > case sensitive
</I
18122 >No files or directories are vetoed.
18133 CLASS=
"PROGRAMLISTING"
18134 > ; Veto any files containing the word Security,
18135 ; any ending in .tmp, and any directory containing the
18137 veto files = /*Security*/*.tmp/*root*/
18139 ; Veto the Apple specific files that a NetAtalk server
18141 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
18150 NAME=
"VETOOPLOCKFILES"
18152 >veto oplock files (S)
</DT
18155 >This parameter is only valid when the
<A
18164 parameter is turned on for a share. It allows the Samba administrator
18165 to selectively turn off the granting of oplocks on selected files that
18166 match a wildcarded list, similar to the wildcarded list used in the
18179 >No files are vetoed for oplock
18183 >You might want to do this on files that you know will
18184 be heavily contended for by clients. A good example of this
18185 is in the NetBench SMB benchmark program, which causes heavy
18186 client contention for files ending in
<TT
18190 To cause Samba not to grant oplocks on these files you would use
18191 the line (either in the [global] section or in the section for
18192 the particular NetBench share :
</P
18196 >veto oplock files = /*.SEM/
18204 >vfs object (S)
</DT
18207 >This parameter specifies a shared object file that
18208 is used for Samba VFS I/O operations. By default, normal
18209 disk I/O operations are used but these can be overloaded
18210 with a VFS object. The Samba VFS layer is new to Samba
2.2 and
18211 must be enabled at compile time with --with-vfs.
</P
18221 >vfs options (S)
</DT
18224 >This parameter allows parameters to be passed
18225 to the vfs layer at initialization time. The Samba VFS layer
18226 is new to Samba
2.2 and must be enabled at compile time
18227 with --with-vfs. See also
<A
18248 > This allows you to override the volume label
18249 returned for a share. Useful for CDROMs with installation programs
18250 that insist on a particular volume label.
</P
18253 >the name of the share
</EM
18260 >wide links (S)
</DT
18263 >This parameter controls whether or not links
18264 in the UNIX file system may be followed by the server. Links
18265 that point to areas within the directory tree exported by the
18266 server are always allowed; this parameter controls access only
18267 to areas that are outside the directory tree being exported.
</P
18269 >Note that setting this parameter can have a negative
18270 effect on your server performance due to the extra system calls
18271 that Samba has to do in order to perform the link checks.
</P
18275 >wide links = yes
</B
18280 NAME=
"WINBINDCACHETIME"
18282 >winbind cache time
</DT
18285 >This parameter specifies the number of seconds the
18287 HREF=
"winbindd.8.html"
18290 > daemon will cache
18291 user and group information before querying a Windows NT server
18296 >winbind cache type =
15</B
18306 >The winbind gid parameter specifies the range of group
18307 ids that are allocated by the
<A
18308 HREF=
"winbindd.8.html"
18311 > daemon. This range of group ids should have no
18312 existing local or NIS groups within it as strange conflicts can
18313 occur otherwise.
</P
18317 >winbind gid =
<empty string
>
18323 >winbind gid =
10000-
20000</B
18328 NAME=
"WINBINDSEPARATOR"
18330 >winbind separator
</DT
18333 >This parameter allows an admin to define the character
18334 used when listing a username of the form of
<TT
18335 CLASS=
"REPLACEABLE"
18341 CLASS=
"REPLACEABLE"
18346 is only applicable when using the
<TT
18348 >pam_winbind.so
</TT
18352 >nss_winbind.so
</TT
18353 > modules for UNIX services.
18358 >winbind separator = \
</B
18363 >winbind separator = +
</B
18373 >The winbind gid parameter specifies the range of group
18374 ids that are allocated by the
<A
18375 HREF=
"winbindd.8.html"
18378 > daemon. This range of ids should have no
18379 existing local or NIS users within it as strange conflicts can
18380 occur otherwise.
</P
18384 >winbind uid =
<empty string
>
18390 >winbind uid =
10000-
20000</B
18400 >When Samba is running as a WINS server this
18401 allows you to call an external program for all changes to the
18402 WINS database. The primary use for this option is to allow the
18403 dynamic update of external name resolution databases such as
18406 >The wins hook parameter specifies the name of a script
18407 or executable that will be called as follows:
</P
18411 >wins_hook operation name nametype ttl IP_list
18419 >The first argument is the operation and is one
18420 of
"add",
"delete", or
"refresh". In most cases the operation can
18421 be ignored as the rest of the parameters provide sufficient
18422 information. Note that
"refresh" may sometimes be called when the
18423 name has not previously been added, in that case it should be treated
18428 >The second argument is the NetBIOS name. If the
18429 name is not a legal name then the wins hook is not called.
18430 Legal names contain only letters, digits, hyphens, underscores
18435 >The third argument is the NetBIOS name
18436 type as a
2 digit hexadecimal number.
</P
18440 >The fourth argument is the TTL (time to live)
18441 for the name in seconds.
</P
18445 >The fifth and subsequent arguments are the IP
18446 addresses currently registered for that name. If this list is
18447 empty then the name should be deleted.
</P
18451 >An example script that calls the BIND dynamic DNS update
18455 > is provided in the examples
18456 directory of the Samba source code.
</P
18462 >wins proxy (G)
</DT
18465 >This is a boolean that controls if
<A
18469 > will respond to broadcast name
18470 queries on behalf of other hosts. You may need to set this
18474 > for some older clients.
</P
18478 >wins proxy = no
</B
18485 >wins server (G)
</DT
18488 >This specifies the IP address (or DNS name: IP
18489 address for preference) of the WINS server that
<A
18493 > should register with. If you have a WINS server on
18494 your network then you should set this to the WINS server's IP.
</P
18496 >You should point this at your WINS server if you have a
18497 multi-subnetted network.
</P
18501 >. You need to set up Samba to point
18502 to a WINS server if you have multiple subnets and wish cross-subnet
18503 browsing to work correctly.
</P
18505 >See the documentation file
<TT
18509 in the docs/ directory of your Samba source distribution.
</P
18517 >wins server =
192.9.200.1</B
18524 >wins support (G)
</DT
18527 >This boolean controls if the
<A
18532 > process in Samba will act as a WINS server. You should
18533 not set this to
<TT
18536 > unless you have a multi-subnetted network and
18537 you wish a particular
<B
18540 > to be your WINS server.
18541 Note that you should
<EM
18547 on more than one machine in your network.
</P
18551 >wins support = no
</B
18561 >This controls what workgroup your server will
18562 appear to be in when queried by clients. Note that this parameter
18563 also controls the Domain name used with the
<A
18564 HREF=
"#SECURITYEQUALSDOMAIN"
18567 >security = domain
</B
18573 >set at compile time to WORKGROUP
</EM
18578 >workgroup = MYGROUP
</B
18596 > for people who can't spell :-).
</P
18600 NAME=
"WRITECACHESIZE"
18602 >write cache size (S)
</DT
18605 >If this integer parameter is set to non-zero value,
18606 Samba will create an in-memory cache for each oplocked file
18610 non-oplocked files). All writes that the client does not request
18611 to be flushed directly to disk will be stored in this cache if possible.
18612 The cache is flushed onto disk when a write comes in whose offset
18613 would not fit into the cache or when the file is closed by the client.
18614 Reads for the file are also served from this cache if the data is stored
18617 >This cache allows Samba to batch client writes into a more
18618 efficient write size for RAID disks (i.e. writes may be tuned to
18619 be the RAID stripe size) and can improve performance on systems
18620 where the disk subsystem is a bottleneck but there is free
18621 memory for userspace programs.
</P
18623 >The integer parameter specifies the size of this cache
18624 (per oplocked file) in bytes.
</P
18628 >write cache size =
0</B
18633 >write cache size =
262144</B
18636 >for a
256k cache size per file.
</P
18642 >write list (S)
</DT
18645 >This is a list of users that are given read-write
18646 access to a service. If the connecting user is in this list then
18647 they will be given write access, no matter what the
<A
18656 option is set to. The list can include group names using the
18659 >Note that if a user is in both the read list and the
18660 write list then they will be given write access.
</P
18675 >write list =
<empty string
>
18681 >write list = admin, root, @staff
18709 >This parameter controls whether or not the server
18710 will support raw write SMB's when transferring data from clients.
18711 You should never need to change this parameter.
</P
18715 >write raw = yes
</B
18725 >An inverted synonym is
<A
18735 >If this parameter is
<TT
18739 of a service may not create or modify files in the service's
18742 >Note that a printable service (
<B
18744 >printable = yes
</B
18748 > allow writing to the directory
18749 (user privileges permitting), but only via spooling operations.
</P
18767 >Although the configuration file permits service names
18768 to contain spaces, your client software may not. Spaces will
18769 be ignored in comparisons anyway, so it shouldn't be a
18770 problem - but be aware of the possibility.
</P
18772 >On a similar note, many clients - especially DOS clients -
18773 limit service names to eight characters.
<A
18778 > has no such limitation, but attempts to connect from such
18779 clients will fail if they truncate the service names. For this reason
18780 you should probably keep your service names down to eight characters
18783 >Use of the [homes] and [printers] special sections make life
18784 for an administrator easy, but the various combinations of default
18785 attributes can be tricky. Take extreme care when designing these
18786 sections. In particular, ensure that the permissions on spool
18787 directories are correct.
</P
18797 >This man page is correct for version
2.2 of
18798 the Samba suite.
</P
18809 HREF=
"samba.7.html"
18814 HREF=
"smbpasswd.8.html"
18846 HREF=
"smbclient.1.html"
18854 HREF=
"nmblookup.1.html"
18862 HREF=
"testparm.1.html"
18870 HREF=
"testprns.1.html"
18887 >The original Samba software and related utilities
18888 were created by Andrew Tridgell. Samba is now developed
18889 by the Samba Team as an Open Source project similar
18890 to the way the Linux kernel is developed.
</P
18892 >The original Samba man pages were written by Karl Auer.
18893 The man page sources were converted to YODL format (another
18894 excellent piece of Open Source software, available at
18896 HREF=
"ftp://ftp.icce.rug.nl/pub/unix/"
18898 > ftp://ftp.icce.rug.nl/pub/unix/
</A
18899 >) and updated for the Samba
2.0
18900 release by Jeremy Allison. The conversion to DocBook for
18901 Samba
2.2 was done by Gerald Carter
</P