1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
19 NAME="SMB.CONF">smb.conf</H1
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
130 following notes apply to ordinary section descriptions.</P
132 >A share consists of a directory to which access is being
133 given plus a description of the access rights which are granted
134 to the user of the service. Some housekeeping options are
137 >Sections are either file share services (used by the
138 client as an extension of their native file systems) or
139 printable services (used by the client to access print services
140 on the host running the server).</P
142 >Sections may be designated <I
146 in which case no password is required to access them. A specified
150 > is used to define access
151 privileges in this case.</P
153 >Sections other than guest services will require a password
154 to access them. The client provides the username. As older clients
155 only provide passwords and not usernames, you may specify a list
156 of usernames to check against the password using the "user ="
157 option in the share definition. For modern clients such as
158 Windows 95/98/ME/NT/2000, this should not be necessary.</P
160 >Note that the access rights granted by the server are
161 masked by the access rights granted to the specified or guest
162 UNIX user by the host system. The server does not grant more
163 access than the host system grants.</P
165 >The following sample section defines a file space share.
166 The user has write access to the path <TT
170 The share is accessed via the share name "foo":</P
180 CLASS="COMPUTEROUTPUT"
191 >The following sample section defines a printable share.
192 The share is readonly, but printable. That is, the only write
193 access permitted is via calls to open, write to and close a
198 access will be permitted as the default guest user (specified
209 CLASS="COMPUTEROUTPUT"
211 path = /usr/spool/public
228 >SPECIAL SECTIONS</H2
235 >The [global] section</H3
237 >parameters in this section apply to the server
238 as a whole, or are defaults for sections which do not
239 specifically define certain items. See the notes
240 under PARAMETERS for more information.</P
248 >The [homes] section</H3
250 >If a section called homes is included in the
251 configuration file, services connecting clients to their
252 home directories can be created on the fly by the server.</P
254 >When the connection request is made, the existing
255 sections are scanned. If a match is found, it is used. If no
256 match is found, the requested section name is treated as a
257 user name and looked up in the local password file. If the
258 name exists and the correct password has been given, a share is
259 created by cloning the [homes] section.</P
261 >Some modifications are then made to the newly
268 >The share name is changed from homes to
269 the located username.</P
273 >If no path was given, the path is set to
274 the user's home directory.</P
278 >If you decide to use a <I
282 in your [homes] section then you may find it useful
283 to use the %S macro. For example :</P
288 >path = /data/pchome/%S</B
292 >would be useful if you have different home directories
293 for your PCs than for UNIX access.</P
295 >This is a fast and simple way to give a large number
296 of clients access to their home directories with a minimum
299 >A similar process occurs if the requested section
300 name is "homes", except that the share name is not
301 changed to that of the requesting user. This method of using
302 the [homes] section works well if different users share
305 >The [homes] section can specify all the parameters
306 a normal service section can specify, though some make more sense
307 than others. The following is a typical and suitable [homes]
318 CLASS="COMPUTEROUTPUT"
328 >An important point is that if guest access is specified
329 in the [homes] section, all home directories will be
330 visible to all clients <I
332 >without a password</I
334 In the very unlikely event that this is actually desirable, it
335 would be wise to also specify <I
345 auto home directories will be inherited from the global browseable
346 flag, not the [homes] browseable flag. This is useful as
351 the [homes] section will hide the [homes] share but make
352 any auto home directories visible.</P
360 >The [printers] section</H3
362 >This section works like [homes],
365 >If a [printers] section occurs in the
366 configuration file, users are able to connect to any printer
367 specified in the local host's printcap file.</P
369 >When a connection request is made, the existing sections
370 are scanned. If a match is found, it is used. If no match is found,
371 but a [homes] section exists, it is used as described
372 above. Otherwise, the requested section name is treated as a
373 printer name and the appropriate printcap file is scanned to see
374 if the requested section name is a valid printer share name. If
375 a match is found, a new printer share is created by cloning
376 the [printers] section.</P
378 >A few modifications are then made to the newly created
385 >The share name is set to the located printer
390 >If no printer name was given, the printer name
391 is set to the located printer name</P
395 >If the share does not permit guest access and
396 no username was given, the username is set to the located
401 >Note that the [printers] service MUST be
402 printable - if you specify otherwise, the server will refuse
403 to load the configuration file.</P
405 >Typically the path specified would be that of a
406 world-writeable spool directory with the sticky bit set on
407 it. A typical [printers] entry would look like
418 CLASS="COMPUTEROUTPUT"
420 path = /usr/spool/public
429 >All aliases given for a printer in the printcap file
430 are legitimate printer names as far as the server is concerned.
431 If your printing subsystem doesn't work like that, you will have
432 to set up a pseudo-printcap. This is a file consisting of one or
433 more lines like this:</P
443 CLASS="COMPUTEROUTPUT"
444 > alias|alias|alias|alias...
452 >Each alias should be an acceptable printer name for
453 your printing subsystem. In the [global] section, specify
454 the new file as your printcap. The server will then only recognize
455 names found in your pseudo-printcap, which of course can contain
456 whatever aliases you like. The same technique could be used
457 simply to limit access to a subset of your local printers.</P
459 >An alias, by the way, is defined as any component of the
460 first entry of a printcap record. Records are separated by newlines,
461 components (if there are more than one) are separated by vertical
462 bar symbols ('|').</P
464 >NOTE: On SYSV systems which use lpstat to determine what
465 printers are defined on the system you may be able to use
466 "printcap name = lpstat" to automatically obtain a list
467 of printers. See the "printcap name" option
479 >parameters define the specific attributes of sections.</P
481 >Some parameters are specific to the [global] section
485 >). Some parameters are usable
486 in all sections (e.g., <I
490 are permissible only in normal sections. For the purposes of the
491 following descriptions the [homes] and [printers]
492 sections will be considered normal. The letter <I
496 in parentheses indicates that a parameter is specific to the
497 [global] section. The letter <I
501 indicates that a parameter can be specified in a service specific
502 section. Note that all <I
505 > parameters can also be specified in
506 the [global] section - in which case they will define
507 the default behavior for all services.</P
509 >parameters are arranged here in alphabetical order - this may
510 not create best bedfellows, but at least you can find them! Where
511 there are synonyms, the preferred synonym is described, others refer
512 to the preferred synonym.</P
520 >VARIABLE SUBSTITUTIONS</H2
522 >Many of the strings that are settable in the config file
523 can take substitutions. For example the option "path =
524 /tmp/%u" would be interpreted as "path =
525 /tmp/john" if the user connected with the username john.</P
527 >These substitutions are mostly noted in the descriptions below,
528 but there are some general substitutions which apply whenever they
529 might be relevant. These are:</P
539 >session user name (the user name that the client
540 wanted, not necessarily the same as the one they got).</P
546 >primary group name of %U.</P
552 >the Internet hostname that Samba is running
559 >the NetBIOS name of the client machine
566 >the NetBIOS name of the server. This allows you
567 to change your config based on what the client calls you. Your
568 server can have a "dual personality".</P
570 >Note that this parameter is not available when Samba listens
571 on port 445, as clients no longer send this information </P
577 >the Internet name of the client machine.
584 >the selected protocol level after
585 protocol negotiation. It can be one of CORE, COREPLUS,
586 LANMAN1, LANMAN2 or NT1.</P
592 >The process id of the current server
599 >the architecture of the remote
600 machine. Only some are recognized, and those may not be
601 100% reliable. It currently recognizes Samba, WfWg, Win95,
602 WinNT and Win2k. Anything else will be known as
603 "UNKNOWN". If it gets it wrong then sending a level
605 HREF="mailto:samba@samba.org"
609 > should allow it to be fixed.</P
615 >The IP address of the client machine.</P
621 >the current date and time.</P
627 >Name of the domain or workgroup of the current user.</P
638 >The value of the environment variable
649 >The following substitutes apply only to some configuration options(only those
650 that are used when a connection has been established):</P
660 >the name of the current service, if any.</P
666 >the root directory of the current service,
673 >user name of the current service, if any.</P
679 >primary group name of %u.</P
685 >the home directory of the user given
692 >the name of your NIS home directory server.
693 This is obtained from your NIS auto.map entry. If you have
694 not compiled Samba with the <I
698 option then this value will be the same as %L.</P
704 >the path of the service's home directory,
705 obtained from your NIS auto.map entry. The NIS auto.map entry
706 is split up as "%N:%p".</P
711 >There are some quite creative things that can be done
712 with these substitutions and other smb.conf options.</P
722 >Samba supports "name mangling" so that DOS and
723 Windows clients can use files that don't conform to the 8.3 format.
724 It can also be set to adjust the case of 8.3 format filenames.</P
726 >There are several options that control the way mangling is
727 performed, and they are grouped here rather than listed separately.
728 For the defaults look at the output of the testparm program. </P
730 >All of these options can be set separately for each service
731 (or globally, of course). </P
733 >The options are: </P
740 >mangle case = yes/no</DT
743 > controls if names that have characters that
744 aren't of the "default" case are mangled. For example,
745 if this is yes then a name like "Mail" would be mangled.
752 >case sensitive = yes/no</DT
755 >controls whether filenames are case sensitive. If
756 they aren't then Samba must do a filename search and match on passed
763 >default case = upper/lower</DT
766 >controls what the default case is for new
767 filenames. Default <I
773 >preserve case = yes/no</DT
776 >controls if new files are created with the
777 case that the client passes, or if they are forced to be the
778 "default" case. Default <I
785 >short preserve case = yes/no</DT
788 >controls if new files which conform to 8.3 syntax,
789 that is all in upper case and of suitable length, are created
790 upper case, or if they are forced to be the "default"
791 case. This option can be use with "preserve case = yes"
792 to permit long filenames to retain their case, while short names
793 are lowercased. Default <I
801 >By default, Samba 3.0 has the same semantics as a Windows
802 NT server, in that it is case insensitive but case preserving.</P
810 >NOTE ABOUT USERNAME/PASSWORD VALIDATION</H2
812 >There are a number of ways in which a user can connect
813 to a service. The server uses the following steps in determining
814 if it will allow a connection to a specified service. If all the
815 steps fail, then the connection request is rejected. However, if one of the
816 steps succeeds, then the following steps are not checked.</P
818 >If the service is marked "guest only = yes" and the
819 server is running with share-level security ("security = share")
820 then steps 1 to 5 are skipped.</P
827 >If the client has passed a username/password
828 pair and that username/password pair is validated by the UNIX
829 system's password programs then the connection is made as that
830 username. Note that this includes the
841 >If the client has previously registered a username
842 with the system and now supplies a correct password for that
843 username then the connection is allowed.</P
847 >The client's NetBIOS name and any previously
848 used user names are checked against the supplied password, if
849 they match then the connection is allowed as the corresponding
854 >If the client has previously validated a
855 username/password pair with the server and the client has passed
856 the validation token then that username is used. </P
860 >If a "user = " field is given in the
864 > file for the service and the client
865 has supplied a password, and that password matches (according to
866 the UNIX system's password checking) with one of the usernames
867 from the "user =" field then the connection is made as
868 the username in the "user =" line. If one
869 of the username in the "user =" list begins with a
870 '@' then that name expands to a list of names in
871 the group of the same name.</P
875 >If the service is a guest service then a
876 connection is made as the username given in the "guest
877 account =" for the service, irrespective of the
878 supplied password.</P
888 >COMPLETE LIST OF GLOBAL PARAMETERS</H2
890 >Here is a list of all global parameters. See the section of
891 each parameter for details. Note that some are synonyms.</P
898 HREF="#ABORTSHUTDOWNSCRIPT"
902 >abort shutdown script</I
910 HREF="#ADDGROUPSCRIPT"
922 HREF="#ADDPRINTERCOMMAND"
926 >addprinter command</I
934 HREF="#ADDSHARECOMMAND"
938 >add share command</I
946 HREF="#ADDUSERSCRIPT"
958 HREF="#ADDUSERTOGROUPSCRIPT"
962 >add user to group script</I
970 HREF="#ADDMACHINESCRIPT"
974 >add machine script</I
982 HREF="#DELETEGROUPSCRIPT"
986 >delete group script</I
1006 HREF="#ALGORITHMICRIDBASE"
1010 >algorithmic rid base</I
1018 HREF="#ALLOWTRUSTEDDOMAINS"
1022 >allow trusted domains</I
1042 HREF="#ANNOUNCEVERSION"
1046 >announce version</I
1066 HREF="#AUTOSERVICES"
1078 HREF="#BINDINTERFACESONLY"
1082 >bind interfaces only</I
1102 HREF="#CHANGENOTIFYTIMEOUT"
1106 >change notify timeout</I
1114 HREF="#CHANGESHARECOMMAND"
1118 >change share command</I
1150 HREF="#DEBUGHIRESTIMESTAMP"
1154 >debug hires timestamp</I
1174 HREF="#DEBUGTIMESTAMP"
1222 HREF="#DEFAULTSERVICE"
1234 HREF="#DELETEPRINTERCOMMAND"
1238 >deleteprinter command</I
1246 HREF="#DELETESHARECOMMAND"
1250 >delete share command</I
1258 HREF="#DELETEUSERSCRIPT"
1262 >delete user script</I
1270 HREF="#DELETEUSERFROMGROUPSCRIPT"
1274 >delete user from group script</I
1282 HREF="#DFREECOMMAND"
1294 HREF="#DISABLENETBIOS"
1306 HREF="#DISABLESPOOLSS"
1318 HREF="#DISPLAYCHARSET"
1342 HREF="#DOMAINLOGONS"
1354 HREF="#DOMAINMASTER"
1378 HREF="#ENCRYPTPASSWORDS"
1382 >encrypt passwords</I
1390 HREF="#ENHANCEDBROWSING"
1394 >enhanced browsing</I
1402 HREF="#ENUMPORTSCOMMAND"
1406 >enumports command</I
1426 HREF="#HIDELOCALUSERS"
1430 >hide local users</I
1438 HREF="#HIDEUNREADABLE"
1450 HREF="#HIDEUNWRITEABLEFILES"
1454 >hide unwriteable files</I
1462 HREF="#HIDESPECIALFILES"
1466 >hide special files</I
1498 HREF="#HOSTNAMELOOKUPS"
1502 >hostname lookups</I
1546 HREF="#KERNELOPLOCKS"
1570 HREF="#LARGEREADWRITE"
1594 HREF="#LDAPDELETEDN"
1606 HREF="#LDAPDELONLYSAMATTR"
1610 >ldap del only sam attr</I
1678 HREF="#LDAPUSERSUFFIX"
1682 >ldap user suffix</I
1690 HREF="#LDAPMACHINESUFFIX"
1694 >ldap machine suffix</I
1702 HREF="#LDAPPASSWDSYNC"
1706 >ldap passwd sync</I
1714 HREF="#LDAPTRUSTIDS"
1750 HREF="#LOADPRINTERS"
1786 HREF="#LOCKDIRECTORY"
1798 HREF="#LOCKSPINCOUNT"
1810 HREF="#LOCKSPINTIME"
1822 HREF="#PIDDIRECTORY"
1906 HREF="#LPQCACHETIME"
1918 HREF="#MACHINEPASSWORDTIMEOUT"
1922 >machine password timeout</I
1930 HREF="#MANGLEDSTACK"
1990 HREF="#MAXOPENFILES"
2014 HREF="#MAXSMBDPROCESSES"
2018 >max smbd processes</I
2062 HREF="#MESSAGECOMMAND"
2074 HREF="#MINPASSWDLENGTH"
2078 >min passwd length</I
2086 HREF="#MINPASSWORDLENGTH"
2090 >min password length</I
2122 HREF="#NAMECACHETIMEOUT"
2126 >name cache timeout</I
2134 HREF="#NAMERESOLVEORDER"
2138 >name resolve order</I
2146 HREF="#NETBIOSALIASES"
2170 HREF="#NETBIOSSCOPE"
2206 HREF="#NONUNIXACCOUNTRANGE"
2210 >non unix account range</I
2218 HREF="#NTPIPESUPPORT"
2230 HREF="#NTSTATUSSUPPORT"
2234 >nt status support</I
2242 HREF="#NULLPASSWORDS"
2254 HREF="#OBEYPAMRESTRICTIONS"
2258 >obey pam restrictions</I
2266 HREF="#OPLOCKBREAKWAITTIME"
2270 >oplock break wait time</I
2290 HREF="#OS2DRIVERMAP"
2302 HREF="#PAMPASSWORDCHANGE"
2306 >pam password change</I
2326 HREF="#PARANOIDSERVERSECURITY"
2330 >paranoid server security</I
2338 HREF="#PASSDBBACKEND"
2362 HREF="#PASSWDCHATDEBUG"
2366 >passwd chat debug</I
2374 HREF="#PASSWDPROGRAM"
2386 HREF="#PASSWORDLEVEL"
2398 HREF="#PASSWORDSERVER"
2410 HREF="#PREFEREDMASTER"
2422 HREF="#PREFERREDMASTER"
2426 >preferred master</I
2458 HREF="#PRINTCAPNAME"
2470 HREF="#PRINTERDRIVERFILE"
2474 >printer driver file</I
2554 HREF="#REMOTEANNOUNCE"
2566 HREF="#REMOTEBROWSESYNC"
2570 >remote browse sync</I
2578 HREF="#RESTRICTANONYMOUS"
2582 >restrict anonymous</I
2614 HREF="#ROOTDIRECTORY"
2638 HREF="#SERVERSTRING"
2650 HREF="#SHOWADDPRINTERWIZARD"
2654 >show add printer wizard</I
2662 HREF="#SHUTDOWNSCRIPT"
2674 HREF="#SMBPASSWDFILE"
2698 HREF="#SOCKETADDRESS"
2710 HREF="#SOCKETOPTIONS"
2722 HREF="#SOURCEENVIRONMENT"
2726 >source environment</I
2758 HREF="#STATCACHESIZE"
2806 HREF="#TEMPLATEHOMEDIR"
2810 >template homedir</I
2818 HREF="#TEMPLATESHELL"
2854 HREF="#TIMESTAMPLOGS"
2866 HREF="#TOTALPRINTJOBS"
2870 >total print jobs</I
2902 HREF="#UNIXEXTENSIONS"
2914 HREF="#UNIXPASSWORDSYNC"
2918 >unix password sync</I
2926 HREF="#UPDATEENCRYPTED"
2930 >update encrypted</I
2974 HREF="#USERNAMELEVEL"
3010 HREF="#UTMPDIRECTORY"
3022 HREF="#WTMPDIRECTORY"
3034 HREF="#WINBINDCACHETIME"
3038 >winbind cache time</I
3046 HREF="#WINBINDENUMUSERS"
3050 >winbind enum users</I
3058 HREF="#WINBINDENUMGROUPS"
3062 >winbind enum groups</I
3082 HREF="#WINBINDSEPARATOR"
3086 >winbind separator</I
3106 HREF="#WINBINDUSEDEFAULTDOMAIN"
3110 >winbind use default domain</I
3130 HREF="#WINSPARTNERS"
3207 >COMPLETE LIST OF SERVICE PARAMETERS</H2
3209 >Here is a list of all service parameters. See the section on
3210 each parameter for details. Note that some are synonyms.</P
3253 HREF="#BLOCKINGLOCKS"
3301 HREF="#CASESENSITIVE"
3313 HREF="#CASESIGNAMES"
3397 HREF="#DEFAULTDEVMODE"
3409 HREF="#DELETEREADONLY"
3421 HREF="#DELETEVETOFILES"
3425 >delete veto files</I
3457 HREF="#DIRECTORYMASK"
3469 HREF="#DIRECTORYMODE"
3481 HREF="#DIRECTORYSECURITYMASK"
3485 >directory security mask</I
3517 HREF="#DOSFILETIMERESOLUTION"
3521 >dos filetime resolution</I
3529 HREF="#DOSFILETIMES"
3553 HREF="#FAKEDIRECTORYCREATETIMES"
3557 >fake directory create times</I
3577 HREF="#FOLLOWSYMLINKS"
3589 HREF="#FORCECREATEMODE"
3593 >force create mode</I
3601 HREF="#FORCEDIRECTORYMODE"
3605 >force directory mode</I
3613 HREF="#FORCEDIRECTORYSECURITYMODE"
3617 >force directory security mode</I
3637 HREF="#FORCESECURITYMODE"
3641 >force security mode</I
3685 HREF="#GUESTACCOUNT"
3721 HREF="#HIDEDOTFILES"
3793 HREF="#INHERITPERMISSIONS"
3797 >inherit permissions</I
3805 HREF="#INVALIDUSERS"
3817 HREF="#LEVEL2OPLOCKS"
3841 HREF="#LPPAUSECOMMAND"
3865 HREF="#LPRESUMECOMMAND"
3869 >lpresume command</I
3937 HREF="#MANGLEDNAMES"
3949 HREF="#MANGLINGCHAR"
3961 HREF="#MANGLINGMETHOD"
4009 HREF="#MAXCONNECTIONS"
4021 HREF="#MAXPRINTJOBS"
4033 HREF="#MINPRINTSPACE"
4069 HREF="#NTACLSUPPORT"
4105 HREF="#OPLOCKCONTENTIONLIMIT"
4109 >oplock contention limit</I
4141 HREF="#POSIXLOCKING"
4189 HREF="#PREEXECCLOSE"
4201 HREF="#PRESERVECASE"
4213 HREF="#PRINTCOMMAND"
4261 HREF="#PRINTERADMIN"
4273 HREF="#PRINTERDRIVER"
4285 HREF="#PRINTERDRIVERLOCATION"
4289 >printer driver location</I
4333 HREF="#QUEUEPAUSECOMMAND"
4337 >queuepause command</I
4345 HREF="#QUEUERESUMECOMMAND"
4349 >queueresume command</I
4381 HREF="#ROOTPOSTEXEC"
4405 HREF="#ROOTPREEXECCLOSE"
4409 >root preexec close</I
4417 HREF="#SECURITYMASK"
4429 HREF="#SETDIRECTORY"
4453 HREF="#SHORTPRESERVECASE"
4457 >short preserve case</I
4465 HREF="#STRICTALLOCATE"
4477 HREF="#STRICTLOCKING"
4513 HREF="#USECLIENTDRIVER"
4517 >use client driver</I
4585 HREF="#VETOOPLOCKFILES"
4589 >veto oplock files</I
4669 HREF="#WRITECACHESIZE"
4673 >write cache size</I
4722 >EXPLANATION OF EACH PARAMETER</H2
4726 CLASS="VARIABLELIST"
4730 NAME="ABORTSHUTDOWNSCRIPT"
4732 >abort shutdown script (G)</DT
4737 >This parameter only exists in the HEAD cvs branch</I
4739 This a full path name to a script called by
4748 should stop a shutdown procedure issued by the <A
4749 HREF="#SHUTDOWNSCRIPT"
4758 >This command will be run as user.</P
4767 >abort shutdown script = /sbin/shutdown -c</B
4772 NAME="ADDPRINTERCOMMAND"
4774 >addprinter command (G)</DT
4777 >With the introduction of MS-RPC based printing
4778 support for Windows NT/2000 clients in Samba 2.2, The MS Add
4779 Printer Wizard (APW) icon is now also available in the
4780 "Printers..." folder displayed a share listing. The APW
4781 allows for printers to be add remotely to a Samba or Windows
4782 NT/2000 print server.</P
4784 >For a Samba host this means that the printer must be
4785 physically added to the underlying printing system. The <TT
4791 > defines a script to be run which
4792 will perform the necessary operations for adding the printer
4793 to the print system and to add the appropriate service definition
4797 > file in order that it can be
4811 >addprinter command</I
4814 automatically invoked with the following parameter (in
4869 >Windows 9x driver location</I
4876 >All parameters are filled in from the PRINTER_INFO_2 structure sent
4877 by the Windows NT/2000 client with one exception. The "Windows 9x
4878 driver location" parameter is included for backwards compatibility
4879 only. The remaining fields in the structure are generated from answers
4880 to the APW questions.</P
4885 >addprinter command</I
4891 > will reparse the <TT
4894 > to determine if the share defined by the APW
4895 exists. If the sharename is still invalid, then <B
4899 > will return an ACCESS_DENIED error to the client.</P
4902 HREF="#DELETEPRINTERCOMMAND"
4906 > deleteprinter command</I
4919 HREF="#SHOWADDPRINTERWIZARD"
4936 >addprinter command = /usr/bin/addprinter
4942 NAME="ADDSHARECOMMAND"
4944 >add share command (G)</DT
4947 >Samba 2.2.0 introduced the ability to dynamically
4948 add and delete shares via the Windows NT 4.0 Server Manager. The
4952 >add share command</I
4954 > is used to define an
4955 external program or script which will add a new service definition
4959 >. In order to successfully
4963 >add share command</I
4969 requires that the administrator be connected using a root account (i.e.
4976 > will automatically invoke the
4980 >add share command</I
4982 > with four parameters.
5008 > - the name of the new
5019 > - path to an **existing**
5030 > - comment string to associate
5036 > This parameter is only used for add file shares. To add printer shares,
5038 HREF="#ADDPRINTERCOMMAND"
5050 HREF="#CHANGESHARECOMMAND"
5059 HREF="#DELETESHARECOMMAND"
5077 >add share command = /usr/local/bin/addshare</B
5082 NAME="ADDMACHINESCRIPT"
5084 >add machine script (G)</DT
5087 >This is the full pathname to a script that will
5092 > when a machine is added
5093 to it's domain using the administrator username and password method. </P
5095 >This option is only required when using sam back-ends tied to the
5096 Unix uid method of RID calculation such as smbpasswd. This option is only
5097 available in Samba 3.0.</P
5101 >add machine script = <empty string>
5107 >add machine script = /usr/sbin/adduser -n -g machines -c Machine -d /dev/null -s /bin/false %u
5118 >If this option is specified, samba does
5119 not try to figure out what ads server to use itself, but
5120 uses the specified ads server. Either one DNS name or IP
5121 address can be used.</P
5130 >ads server = 192.168.1.2</B
5135 NAME="ADDUSERSCRIPT"
5137 >add user script (G)</DT
5140 >This is the full pathname to a script that will
5149 > under special circumstances described below.</P
5151 >Normally, a Samba server requires that UNIX users are
5152 created for all users accessing files on this server. For sites
5153 that use Windows NT account databases as their primary user database
5154 creating these users and keeping the user list in sync with the
5155 Windows NT PDC is an onerous task. This option allows <A
5159 > to create the required UNIX users
5163 > when a user accesses the Samba server.</P
5165 >In order to use this option, <A
5176 >security = share</I
5185 must be set to a full pathname for a script that will create a UNIX
5186 user given one argument of <TT
5191 >, which expands into
5192 the UNIX user name to create.</P
5194 >When the Windows user attempts to access the Samba server,
5195 at login (session setup in the SMB protocol) time, <A
5205 attempts to authenticate the given user with the given password. If the
5206 authentication succeeds then <B
5210 attempts to find a UNIX user in the UNIX password database to map the
5211 Windows user into. If this lookup fails, and <TT
5221 call the specified script <I
5230 > argument to be the user name to create.</P
5232 >If this script successfully creates the user then <B
5236 > will continue on as though the UNIX user
5237 already existed. In this way, UNIX users are dynamically created to
5238 match existing Windows NT accounts.</P
5249 HREF="#PASSWORDSERVER"
5258 HREF="#DELETEUSERSCRIPT"
5270 >add user script = <empty string>
5276 >add user script = /usr/local/samba/bin/add_user
5282 NAME="ADDGROUPSCRIPT"
5284 >add group script (G)</DT
5287 >This is the full pathname to a script that will
5295 > when a new group is
5296 requested. It will expand any
5302 > to the group name passed.
5303 This script is only useful for installations using the
5304 Windows NT domain administration tools. The script is
5305 free to create a group with an arbitrary name to
5306 circumvent unix group name restrictions. In that case
5307 the script must print the numeric gid of the created
5315 >admin users (S)</DT
5318 >This is a list of users who will be granted
5319 administrative privileges on the share. This means that they
5320 will do all file operations as the super-user (root).</P
5322 >You should use this option very carefully, as any user in
5323 this list will be able to do anything they like on the share,
5324 irrespective of file permissions.</P
5333 >admin users = jason</B
5338 NAME="ADDUSERTOGROUPSCRIPT"
5340 >add user to group script (G)</DT
5343 >Full path to the script that will be called when
5344 a user is added to a group using the Windows NT domain administration
5345 tools. It will be run by <A
5359 replaced with the group name and any <TT
5365 be replaced with the user name.
5370 >add user to group script = </B
5375 >add user to group script = /usr/sbin/adduser %u %g</B
5382 >allow hosts (S)</DT
5397 NAME="ALGORITHMICRIDBASE"
5399 >algorithmic rid base (G)</DT
5402 >This determines how Samba will use its
5403 algorithmic mapping from uids/gid to the RIDs needed to construct
5404 NT Security Identifiers.</P
5406 >Setting this option to a larger value could be useful to sites
5407 transitioning from WinNT and Win2k, as existing user and
5408 group rids would otherwise clash with sytem users etc.
5411 >All UIDs and GIDs must be able to be resolved into SIDs for
5412 the correct operation of ACLs on the server. As such the algorithmic
5413 mapping can't be 'turned off', but pushing it 'out of the way' should
5414 resolve the issues. Users and groups can then be assigned 'low' RIDs
5415 in arbitary-rid supporting backends. </P
5419 >algorithmic rid base = 1000</B
5424 >algorithmic rid base = 100000</B
5429 NAME="ALLOWTRUSTEDDOMAINS"
5431 >allow trusted domains (G)</DT
5434 >This option only takes effect when the <A
5450 If it is set to no, then attempts to connect to a resource from
5451 a domain or workgroup other than the one which <A
5456 in will fail, even if that domain is trusted by the remote server
5457 doing the authentication.</P
5459 >This is useful if you only want your Samba server to
5460 serve resources to users in the domain it is a member of. As
5461 an example, suppose that there are two domains DOMA and DOMB. DOMB
5462 is trusted by DOMA, which contains the Samba server. Under normal
5463 circumstances, a user with an account in DOMB can then access the
5464 resources of a UNIX account with the same account name on the
5465 Samba server even if they do not have an account in DOMA. This
5466 can make implementing a security boundary difficult.</P
5470 >allow trusted domains = yes</B
5477 >announce as (G)</DT
5480 >This specifies what type of server
5489 will announce itself as, to a network neighborhood browse
5490 list. By default this is set to Windows NT. The valid options
5491 are : "NT Server" (which can also be written as "NT"),
5492 "NT Workstation", "Win95" or "WfW" meaning Windows NT Server,
5493 Windows NT Workstation, Windows 95 and Windows for Workgroups
5494 respectively. Do not change this parameter unless you have a
5495 specific need to stop Samba appearing as an NT server as this
5496 may prevent Samba servers from participating as browser servers
5501 >announce as = NT Server</B
5506 >announce as = Win95</B
5511 NAME="ANNOUNCEVERSION"
5513 >announce version (G)</DT
5516 >This specifies the major and minor version numbers
5517 that nmbd will use when announcing itself as a server. The default
5518 is 4.9. Do not change this parameter unless you have a specific
5519 need to set a Samba server to be a downlevel server.</P
5523 >announce version = 4.9</B
5528 >announce version = 2.0</B
5535 >auto services (G)</DT
5538 >This is a synonym for the <A
5552 >auth methods (G)</DT
5555 >This option allows the administrator to chose what
5556 authentication methods <B
5559 > will use when authenticating
5560 a user. This option defaults to sensible values based on <A
5570 Each entry in the list attempts to authenticate the user in turn, until
5571 the user authenticates. In practice only one method will ever actually
5572 be able to complete the authentication.
5577 >auth methods = <empty string></B
5582 >auth methods = guest sam ntdomain</B
5592 >This parameter lets you "turn off" a service. If
5602 attempts to connect to the service will fail. Such failures are
5612 NAME="BINDINTERFACESONLY"
5614 >bind interfaces only (G)</DT
5617 >This global parameter allows the Samba admin
5618 to limit what interfaces on a machine will serve SMB requests. It
5619 affects file service <A
5631 >For name service it causes <B
5635 to ports 137 and 138 on the interfaces listed in the <A
5642 > also binds to the "all addresses" interface (0.0.0.0)
5643 on ports 137 and 138 for the purposes of reading broadcast messages.
5644 If this option is not set then <B
5648 name requests on all of these sockets. If <TT
5658 source address of any packets coming in on the broadcast sockets
5659 and discard any that don't match the broadcast addresses of the
5660 interfaces in the <TT
5666 As unicast packets are received on the other sockets it allows
5670 > to refuse to serve names to machines that
5671 send packets that arrive through any interfaces not listed in the
5677 > list. IP Source address spoofing
5678 does defeat this simple check, however, so it must not be used
5679 seriously as a security feature for <B
5684 >For file service it causes <A
5689 to bind only to the interface list given in the <A
5692 > parameter. This restricts the networks that
5696 > will serve to packets coming in those
5697 interfaces. Note that you should not use this parameter for machines
5698 that are serving PPP or other intermittent or non-broadcast network
5699 interfaces as it will not cope with non-permanent interfaces.</P
5704 >bind interfaces only</I
5707 unless the network address <I
5717 HREF="smbpasswd.8.html"
5732 not work as expected due to the reasons covered below.</P
5734 >To change a users SMB password, the <B
5738 by default connects to the <I
5740 >localhost - 127.0.0.1</I
5742 address as an SMB client to issue the password change request. If
5746 >bind interfaces only</I
5748 > is set then unless the
5758 > parameter list then <B
5761 > will fail to connect in it's default mode.
5765 > can be forced to use the primary IP interface
5766 of the local host by using its <A
5767 HREF="smbpasswd.8.html#minusr"
5781 > parameter, with <TT
5787 to the IP name of the primary interface of the local host.</P
5792 > status page tries to connect with
5803 > to determine if they are running.
5814 "not running" even if they really are. This can prevent <B
5817 > from starting/stopping/restarting <B
5828 >bind interfaces only = no</B
5833 NAME="BLOCKINGLOCKS"
5835 >blocking locks (S)</DT
5838 >This parameter controls the behavior of <A
5842 > when given a request by a client
5843 to obtain a byte range lock on a region of an open file, and the
5844 request has a time limit associated with it.</P
5846 >If this parameter is set and the lock range requested
5847 cannot be immediately satisfied, samba will internally
5848 queue the lock request, and periodically attempt to obtain
5849 the lock until the timeout period expires.</P
5851 >If this parameter is set to <TT
5855 samba will behave as previous versions of Samba would and
5856 will fail the lock request immediately if the lock range
5857 cannot be obtained.</P
5861 >blocking locks = yes</B
5871 >This parameter controls the behavior of
5876 > when reporting disk free
5877 sizes. By default, this reports a disk block size of 1024 bytes.
5880 >Changing this parameter may have some effect on the
5881 efficiency of client writes, this is not yet confirmed. This
5882 parameter was added to allow advanced administrators to change
5883 it (usually to a higher value) and test the effect it has on
5884 client write performance without re-compiling the code. As this
5885 is an experimental option it may be removed in a future release.
5888 >Changing this option does not change the disk free reporting
5889 size, just the block size unit reported to the client.</P
5893 >block size = 1024</B
5898 >block size = 65536</B
5922 >browse list (G)</DT
5925 >This controls whether <A
5932 > will serve a browse list to
5940 >. You should never need to change
5945 >browse list = yes</B
5955 >This controls whether this share is seen in
5956 the list of available shares in a net view and in the browse list.</P
5960 >browseable = yes</B
5965 NAME="CASESENSITIVE"
5967 >case sensitive (S)</DT
5970 >See the discussion in the section <A
5977 >case sensitive = no</B
5984 >casesignames (S)</DT
5988 HREF="#CASESENSITIVE"
5995 NAME="CHANGENOTIFYTIMEOUT"
5997 >change notify timeout (G)</DT
6000 >This SMB allows a client to tell a server to
6001 "watch" a particular directory for any changes and only reply to
6002 the SMB request when a change has occurred. Such constant scanning of
6003 a directory is expensive under UNIX, hence an <A
6010 > daemon only performs such a scan
6011 on each requested directory once every <TT
6021 >change notify timeout = 60</B
6026 >change notify timeout = 300</B
6029 >Would change the scan time to every 5 minutes.</P
6033 NAME="CHANGESHARECOMMAND"
6035 >change share command (G)</DT
6038 >Samba 2.2.0 introduced the ability to dynamically
6039 add and delete shares via the Windows NT 4.0 Server Manager. The
6043 >change share command</I
6045 > is used to define an
6046 external program or script which will modify an existing service definition
6050 >. In order to successfully
6054 >change share command</I
6060 requires that the administrator be connected using a root account (i.e.
6067 > will automatically invoke the
6071 >change share command</I
6073 > with four parameters.
6099 > - the name of the new
6110 > - path to an **existing**
6121 > - comment string to associate
6127 > This parameter is only used modify existing file shares definitions. To modify
6128 printer shares, use the "Printers..." folder as seen when browsing the Samba host.
6132 HREF="#ADDSHARECOMMAND"
6141 HREF="#DELETESHARECOMMAND"
6159 >change share command = /usr/local/bin/addshare</B
6169 >This is a text field that is seen next to a share
6170 when a client does a queries the server, either via the network
6171 neighborhood or via <B
6174 > to list what shares
6177 >If you want to set the string that is displayed next to the
6178 machine name then see the <A
6179 HREF="#SERVERSTRING"
6190 >No comment string</I
6195 >comment = Fred's Files</B
6202 >config file (G)</DT
6205 >This allows you to override the config file
6206 to use, instead of the default (usually <TT
6210 There is a chicken and egg problem here as this option is set
6211 in the config file!</P
6213 >For this reason, if the name of the config file has changed
6214 when the parameters are loaded then it will reload them from
6215 the new config file.</P
6217 >This option takes the usual substitutions, which can
6220 >If the config file doesn't exist then it won't be loaded
6221 (allowing you to special case the config files of just a few
6226 >config file = /usr/local/samba/lib/smb.conf.%m
6237 >This parameter allows you to "clone" service
6238 entries. The specified service is simply duplicated under the
6239 current service's name. Any parameters specified in the current
6240 section will override those in the section being copied.</P
6242 >This feature lets you set up a 'template' service and
6243 create similar services easily. Note that the service being
6244 copied must occur earlier in the configuration file than the
6245 service doing the copying.</P
6254 >copy = otherservice</B
6261 >create mask (S)</DT
6264 >A synonym for this parameter is
6276 >When a file is created, the necessary permissions are
6277 calculated according to the mapping from DOS modes to UNIX
6278 permissions, and the resulting UNIX mode is then bit-wise 'AND'ed
6279 with this parameter. This parameter may be thought of as a bit-wise
6280 MASK for the UNIX modes of a file. Any bit <I
6284 set here will be removed from the modes set on a file when it is
6287 >The default value of this parameter removes the
6288 'group' and 'other' write and execute bits from the UNIX modes.</P
6290 >Following this Samba will bit-wise 'OR' the UNIX mode created
6291 from this parameter with the value of the <A
6292 HREF="#FORCECREATEMODE"
6296 >force create mode</I
6300 parameter which is set to 000 by default.</P
6302 >This parameter does not affect directory modes. See the
6304 HREF="#DIRECTORYMODE"
6315 HREF="#FORCECREATEMODE"
6323 > parameter for forcing particular mode
6324 bits to be set on created files. See also the <A
6325 HREF="#DIRECTORYMODE"
6332 > parameter for masking
6333 mode bits on created directories. See also the <A
6334 HREF="#INHERITPERMISSIONS"
6338 >inherit permissions</I
6343 >Note that this parameter does not apply to permissions
6344 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
6345 a mask on access control lists also, they need to set the <A
6346 HREF="#SECURITYMASK"
6357 >create mask = 0744</B
6362 >create mask = 0775</B
6369 >create mode (S)</DT
6372 >This is a synonym for <A
6391 >client-side caching
6393 >, and specifies how clients capable of offline
6394 caching will cache the files in the share. The valid values
6395 are: manual, documents, programs, disable.</P
6397 >These values correspond to those used on Windows
6400 >For example, shares containing roaming profiles can have
6401 offline caching disabled using <B
6403 >csc policy = disable
6409 >csc policy = manual</B
6414 >csc policy = programs</B
6424 >The value of the parameter (a decimal integer)
6425 represents the number of minutes of inactivity before a connection
6426 is considered dead, and it is disconnected. The deadtime only takes
6427 effect if the number of open files is zero.</P
6429 >This is useful to stop a server's resources being
6430 exhausted by a large number of inactive connections.</P
6432 >Most clients have an auto-reconnect feature when a
6433 connection is broken so in most cases this parameter should be
6434 transparent to users.</P
6436 >Using this parameter with a timeout of a few minutes
6437 is recommended for most systems.</P
6439 >A deadtime of zero indicates that no auto-disconnection
6440 should be performed.</P
6454 NAME="DEBUGHIRESTIMESTAMP"
6456 >debug hires timestamp (G)</DT
6459 >Sometimes the timestamps in the log messages
6460 are needed with a resolution of higher that seconds, this
6461 boolean parameter adds microsecond resolution to the timestamp
6462 message header when turned on.</P
6464 >Note that the parameter <A
6465 HREF="#DEBUGTIMESTAMP"
6469 > debug timestamp</I
6472 > must be on for this to have an
6477 >debug hires timestamp = no</B
6487 >When using only one log file for more then one
6492 >-process there may be hard to follow which process
6493 outputs which message. This boolean parameter is adds the process-id
6494 to the timestamp message headers in the logfile when turned on.</P
6496 >Note that the parameter <A
6497 HREF="#DEBUGTIMESTAMP"
6501 > debug timestamp</I
6504 > must be on for this to have an
6514 NAME="DEBUGTIMESTAMP"
6516 >debug timestamp (G)</DT
6519 >Samba debug log messages are timestamped
6520 by default. If you are running at a high <A
6529 can be distracting. This boolean parameter allows timestamping
6530 to be turned off.</P
6534 >debug timestamp = yes</B
6544 >Samba is sometimes run as root and sometime
6545 run as the connected user, this boolean parameter inserts the
6546 current euid, egid, uid and gid to the timestamp message headers
6547 in the log file if turned on.</P
6549 >Note that the parameter <A
6550 HREF="#DEBUGTIMESTAMP"
6554 > debug timestamp</I
6557 > must be on for this to have an
6590 HREF="#DEFAULTSERVICE"
6594 > default service</I
6603 >default case (S)</DT
6606 >See the section on <A
6610 HREF="#SHORTPRESERVECASE"
6614 >short preserve case</I
6621 >default case = lower</B
6626 NAME="DEFAULTDEVMODE"
6628 >default devmode (S)</DT
6631 >This parameter is only applicable to <A
6634 > services. When smbd is serving
6635 Printer Drivers to Windows NT/2k/XP clients, each printer on the Samba
6636 server has a Device Mode which defines things such as paper size and
6637 orientation and duplex settings. The device mode can only correctly be
6638 generated by the printer driver itself (which can only be executed on a
6639 Win32 platform). Because smbd is unable to execute the driver code
6640 to generate the device mode, the default behavior is to set this field
6644 >Most problems with serving printer drivers to Windows NT/2k/XP clients
6645 can be traced to a problem with the generated device mode. Certain drivers
6646 will do things such as crashing the client's Explorer.exe with a NULL devmode.
6647 However, other printer drivers can cause the client's spooler service
6648 (spoolsv.exe) to die if the devmode was not created by the driver itself
6649 (i.e. smbd generates a default devmode).
6652 >This parameter should be used with care and tested with the printer
6653 driver in question. It is better to leave the device mode to NULL
6654 and let the Windows client set the correct values. Because drivers do not
6655 do this all the time, setting <B
6657 >default devmode = yes</B
6659 will instruct smbd to generate a default one.
6662 >For more information on Windows NT/2k printing and Device Modes,
6664 HREF="http://msdn.microsoft.com/"
6666 >MSDN documentation</A
6672 >default devmode = no</B
6677 NAME="DEFAULTSERVICE"
6679 >default service (G)</DT
6682 >This parameter specifies the name of a service
6683 which will be connected to if the service actually requested cannot
6684 be found. Note that the square brackets are <I
6688 given in the parameter value (see example below).</P
6690 >There is no default value for this parameter. If this
6691 parameter is not given, attempting to connect to a nonexistent
6692 service results in an error.</P
6694 >Typically the default service would be a <A
6712 >Also note that the apparent service name will be changed
6713 to equal that of the requested service, this is very useful as it
6714 allows you to use macros like <TT
6720 a wildcard service.</P
6722 >Note also that any "_" characters in the name of the service
6723 used in the default service will get mapped to a "/". This allows for
6724 interesting things.</P
6735 CLASS="PROGRAMLISTING"
6737 default service = pub
6749 NAME="DELETEGROUPSCRIPT"
6751 >delete group script (G)</DT
6754 >This is the full pathname to a script that will
6762 > when a group is requested to be deleted. It will expand any <TT
6767 > to the group name passed. This script is only useful for installations using the Windows NT domain administration tools.
6772 NAME="DELETEPRINTERCOMMAND"
6774 >deleteprinter command (G)</DT
6777 >With the introduction of MS-RPC based printer
6778 support for Windows NT/2000 clients in Samba 2.2, it is now
6779 possible to delete printer at run time by issuing the
6780 DeletePrinter() RPC call.</P
6782 >For a Samba host this means that the printer must be
6783 physically deleted from underlying printing system. The <TT
6786 > deleteprinter command</I
6788 > defines a script to be run which
6789 will perform the necessary operations for removing the printer
6790 from the print system and from <TT
6799 >deleteprinter command</I
6802 automatically called with only one parameter: <TT
6812 >deleteprinter command</I
6818 > will reparse the <TT
6821 > to associated printer no longer exists.
6822 If the sharename is still valid, then <B
6826 > will return an ACCESS_DENIED error to the client.</P
6829 HREF="#ADDPRINTERCOMMAND"
6833 > addprinter command</I
6846 HREF="#SHOWADDPRINTERWIZARD"
6863 >deleteprinter command = /usr/bin/removeprinter
6869 NAME="DELETEREADONLY"
6871 >delete readonly (S)</DT
6874 >This parameter allows readonly files to be deleted.
6875 This is not normal DOS semantics, but is allowed by UNIX.</P
6877 >This option may be useful for running applications such
6878 as rcs, where UNIX file ownership prevents changing file
6879 permissions, and DOS semantics prevent deletion of a read only file.</P
6883 >delete readonly = no</B
6888 NAME="DELETESHARECOMMAND"
6890 >delete share command (G)</DT
6893 >Samba 2.2.0 introduced the ability to dynamically
6894 add and delete shares via the Windows NT 4.0 Server Manager. The
6898 >delete share command</I
6900 > is used to define an
6901 external program or script which will remove an existing service
6905 >. In order to successfully
6909 >delete share command</I
6915 requires that the administrator be connected using a root account (i.e.
6922 > will automatically invoke the
6926 >delete share command</I
6928 > with two parameters.
6955 the existing service.
6960 > This parameter is only used to remove file shares. To delete printer shares,
6962 HREF="#DELETEPRINTERCOMMAND"
6974 HREF="#ADDSHARECOMMAND"
6983 HREF="#CHANGESHARECOMMAND"
7001 >delete share command = /usr/local/bin/delshare</B
7006 NAME="DELETEUSERSCRIPT"
7008 >delete user script (G)</DT
7011 >This is the full pathname to a script that will
7020 when managing user's with remote RPC (NT) tools.
7023 >This script is called when a remote client removes a user
7024 from the server, normally using 'User Manager for Domains' or
7031 >This script should delete the given UNIX username.
7036 >delete user script = <empty string>
7042 >delete user script = /usr/local/samba/bin/del_user
7048 NAME="DELETEUSERFROMGROUPSCRIPT"
7050 >delete user from group script (G)</DT
7053 >Full path to the script that will be called when
7054 a user is removed from a group using the Windows NT domain administration
7055 tools. It will be run by <A
7069 replaced with the group name and any <TT
7075 be replaced with the user name.
7080 >delete user from group script = </B
7085 >delete user from group script = /usr/sbin/deluser %u %g</B
7090 NAME="DELETEVETOFILES"
7092 >delete veto files (S)</DT
7095 >This option is used when Samba is attempting to
7096 delete a directory that contains one or more vetoed directories
7106 option). If this option is set to <TT
7109 > (the default) then if a vetoed
7110 directory contains any non-vetoed files or directories then the
7111 directory delete will fail. This is usually what you want.</P
7113 >If this option is set to <TT
7117 will attempt to recursively delete any files and directories within
7118 the vetoed directory. This can be useful for integration with file
7119 serving systems such as NetAtalk which create meta-files within
7120 directories you might normally veto DOS/Windows users from seeing
7128 >delete veto files = yes</B
7130 directories to be transparently deleted when the parent directory
7131 is deleted (so long as the user has permissions to do so).</P
7146 >delete veto files = no</B
7171 >dfree command (G)</DT
7180 only be used on systems where a problem occurs with the internal
7181 disk space calculations. This has been known to happen with Ultrix,
7182 but may occur with other operating systems. The symptom that was
7183 seen was an error of "Abort Retry Ignore" at the end of each
7184 directory listing.</P
7186 >This setting allows the replacement of the internal routines to
7187 calculate the total disk space and amount available with an external
7188 routine. The example below gives a possible script that might fulfill
7191 >The external program will be passed a single parameter indicating
7192 a directory in the filesystem being queried. This will typically consist
7196 >. The script should return two
7197 integers in ASCII. The first should be the total disk space in blocks,
7198 and the second should be the number of available blocks. An optional
7199 third return value can give the block size in bytes. The default
7200 blocksize is 1024 bytes.</P
7202 >Note: Your script should <I
7206 setgid and should be owned by (and writeable only by) root!</P
7210 >By default internal routines for
7211 determining the disk capacity and remaining space will be used.
7217 >dfree command = /usr/local/samba/bin/dfree
7221 >Where the script dfree (which must be made executable) could be:</P
7230 CLASS="PROGRAMLISTING"
7233 df $1 | tail -1 | awk '{print $2" "$4}'
7240 >or perhaps (on Sys V based systems):</P
7249 CLASS="PROGRAMLISTING"
7252 /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
7259 >Note that you may have to replace the command names
7260 with full path names on some systems.</P
7282 NAME="DIRECTORYMASK"
7284 >directory mask (S)</DT
7287 >This parameter is the octal modes which are
7288 used when converting DOS modes to UNIX modes when creating UNIX
7291 >When a directory is created, the necessary permissions are
7292 calculated according to the mapping from DOS modes to UNIX permissions,
7293 and the resulting UNIX mode is then bit-wise 'AND'ed with this
7294 parameter. This parameter may be thought of as a bit-wise MASK for
7295 the UNIX modes of a directory. Any bit <I
7299 here will be removed from the modes set on a directory when it is
7302 >The default value of this parameter removes the 'group'
7303 and 'other' write bits from the UNIX mode, allowing only the
7304 user who owns the directory to modify it.</P
7306 >Following this Samba will bit-wise 'OR' the UNIX mode
7307 created from this parameter with the value of the <A
7308 HREF="#FORCEDIRECTORYMODE"
7312 >force directory mode
7316 > parameter. This parameter is set to 000 by
7317 default (i.e. no extra mode bits are added).</P
7319 >Note that this parameter does not apply to permissions
7320 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
7321 a mask on access control lists also, they need to set the <A
7322 HREF="#DIRECTORYSECURITYMASK"
7326 >directory security mask</I
7332 HREF="#FORCEDIRECTORYMODE"
7340 > parameter to cause particular mode
7341 bits to always be set on created directories.</P
7352 > parameter for masking mode bits on created files,
7354 HREF="#DIRECTORYSECURITYMASK"
7364 >Also refer to the <A
7365 HREF="#INHERITPERMISSIONS"
7369 > inherit permissions</I
7376 >directory mask = 0755</B
7381 >directory mask = 0775</B
7386 NAME="DIRECTORYMODE"
7388 >directory mode (S)</DT
7392 HREF="#DIRECTORYMASK"
7403 NAME="DIRECTORYSECURITYMASK"
7405 >directory security mask (S)</DT
7408 >This parameter controls what UNIX permission bits
7409 can be modified when a Windows NT client is manipulating the UNIX
7410 permission on a directory using the native NT security dialog
7413 >This parameter is applied as a mask (AND'ed with) to
7414 the changed permission bits, thus preventing any bits not in
7415 this mask from being modified. Essentially, zero bits in this
7416 mask may be treated as a set of bits the user is not allowed
7419 >If not set explicitly this parameter is set to 0777
7420 meaning a user is allowed to modify all the user/group/world
7421 permissions on a directory.</P
7426 > that users who can access the
7427 Samba server through other means can easily bypass this restriction,
7428 so it is primarily useful for standalone "appliance" systems.
7429 Administrators of most normal systems will probably want to leave
7430 it as the default of <TT
7436 HREF="#FORCEDIRECTORYSECURITYMODE"
7440 > force directory security mode</I
7444 HREF="#SECURITYMASK"
7453 HREF="#FORCESECURITYMODE"
7457 >force security mode
7465 >directory security mask = 0777</B
7470 >directory security mask = 0700</B
7475 NAME="DISABLENETBIOS"
7477 >disable netbios (G)</DT
7480 >Enabling this parameter will disable netbios support
7481 in Samba. Netbios is the only available form of browsing in
7482 all windows versions except for 2000 and XP. </P
7484 >Note that clients that only support netbios won't be able to
7485 see your samba server when netbios support is disabled.
7490 >disable netbios = no</B
7495 >disable netbios = yes</B
7500 NAME="DISABLESPOOLSS"
7502 >disable spoolss (G)</DT
7505 >Enabling this parameter will disable Samba's support
7506 for the SPOOLSS set of MS-RPC's and will yield identical behavior
7507 as Samba 2.0.x. Windows NT/2000 clients will downgrade to using
7508 Lanman style printing commands. Windows 9x/ME will be uneffected by
7509 the parameter. However, this will also disable the ability to upload
7510 printer drivers to a Samba server via the Windows NT Add Printer
7511 Wizard or by using the NT printer properties dialog window. It will
7512 also disable the capability of Windows NT/2000 clients to download
7513 print drivers from the Samba host upon demand.
7516 >Be very careful about enabling this parameter.</I
7521 HREF="#USECLIENTDRIVER"
7522 >use client driver</A
7528 >disable spoolss = no</B
7533 NAME="DISPLAYCHARSET"
7535 >display charset (G)</DT
7538 >Specifies the charset that samba will use
7539 to print messages to stdout and stderr and SWAT will use.
7540 Should generally be the same as the <B
7548 >display charset = ASCII</B
7553 >display charset = UTF8</B
7568 when acting as a WINS server and finding that a NetBIOS name has not
7569 been registered, should treat the NetBIOS name word-for-word as a DNS
7570 name and do a lookup with the DNS server for that name on behalf of
7571 the name-querying client.</P
7573 >Note that the maximum length for a NetBIOS name is 15
7574 characters, so the DNS name (or DNS alias) can likewise only be
7575 15 characters, maximum.</P
7580 > spawns a second copy of itself to do the
7581 DNS name lookup requests, as doing a name lookup is a blocking
7584 >See also the parameter <A
7603 >domain logons (G)</DT
7609 >, the Samba server will serve
7610 Windows 95/98 Domain logons for the <A
7618 > it is in. Samba 2.2
7619 has limited capability to act as a domain controller for Windows
7620 NT 4 Domains. For more details on setting up this feature see
7621 the Samba-PDC-HOWTO included in the <TT
7625 directory shipped with the source code.</P
7629 >domain logons = no</B
7636 >domain master (G)</DT
7646 > to enable WAN-wide browse list
7647 collation. Setting this option causes <B
7651 claim a special domain specific NetBIOS name that identifies
7652 it as a domain master browser for its given <A
7660 >. Local master browsers
7666 > on broadcast-isolated
7667 subnets will give this <B
7670 > their local browse lists,
7679 for a complete copy of the browse list for the whole wide area
7680 network. Browser clients will then contact their local master browser,
7681 and will receive the domain-wide browse list, instead of just the list
7682 for their broadcast-isolated subnet.</P
7684 >Note that Windows NT Primary Domain Controllers expect to be
7685 able to claim this <TT
7691 NetBIOS name that identifies them as domain master browsers for
7697 > by default (i.e. there is no
7698 way to prevent a Windows NT PDC from attempting to do this). This
7699 means that if this parameter is set and <B
7703 the special name for a <TT
7709 NT PDC is able to do so then cross subnet browsing will behave
7710 strangely and may fail.</P
7713 HREF="#DOMAINLOGONS"
7716 >domain logons = yes</B
7719 >, then the default behavior is to enable the <TT
7731 not enabled (the default setting), then neither will <TT
7737 > be enabled by default.</P
7741 >domain master = auto</B
7748 >dont descend (S)</DT
7751 >There are certain directories on some systems
7755 > tree under Linux) that are either not
7756 of interest to clients or are infinitely deep (recursive). This
7757 parameter allows you to specify a comma-delimited list of directories
7758 that the server should always show as empty.</P
7760 >Note that Samba can be very fussy about the exact format
7761 of the "dont descend" entries. For example you may need <TT
7764 > instead of just <TT
7768 Experimentation is the best policy :-) </P
7772 >none (i.e., all directories are OK
7778 >dont descend = /proc,/dev</B
7785 >dos charset (G)</DT
7788 >DOS SMB clients assume the server has
7789 the same charset as they do. This option specifies which
7790 charset Samba should talk to DOS clients.
7793 >The default depends on which charsets you have instaled.
7794 Samba tries to use charset 850 but falls back to ASCII in
7795 case it is not available. Run <A
7796 HREF="testparm.1.html"
7800 > to check the default on your system.
7807 >dos filemode (S)</DT
7810 > The default behavior in Samba is to provide
7811 UNIX-like behavior where only the owner of a file/directory is
7812 able to change the permissions on it. However, this behavior
7813 is often confusing to DOS/Windows users. Enabling this parameter
7814 allows a user who has write access to the file (by whatever
7815 means) to modify the permissions on it. Note that a user
7816 belonging to the group owning the file will not be allowed to
7817 change permissions if the group is only granted read access.
7818 Ownership of the file/directory is not changed, only the permissions
7823 >dos filemode = no</B
7828 NAME="DOSFILETIMERESOLUTION"
7830 >dos filetime resolution (S)</DT
7833 >Under the DOS and Windows FAT filesystem, the finest
7834 granularity on time resolution is two seconds. Setting this parameter
7835 for a share causes Samba to round the reported time down to the
7836 nearest two second boundary when a query call that requires one second
7837 resolution is made to <A
7847 >This option is mainly used as a compatibility option for Visual
7848 C++ when used against Samba shares. If oplocks are enabled on a
7849 share, Visual C++ uses two different time reading calls to check if a
7850 file has changed since it was last read. One of these calls uses a
7851 one-second granularity, the other uses a two second granularity. As
7852 the two second call rounds any odd second down, then if the file has a
7853 timestamp of an odd number of seconds then the two timestamps will not
7854 match and Visual C++ will keep reporting the file has changed. Setting
7855 this option causes the two timestamps to match, and Visual C++ is
7860 >dos filetime resolution = no</B
7867 >dos filetimes (S)</DT
7870 >Under DOS and Windows, if a user can write to a
7871 file they can change the timestamp on it. Under POSIX semantics,
7872 only the owner of the file or root may change the timestamp. By
7873 default, Samba runs with POSIX semantics and refuses to change the
7874 timestamp on a file if the user <B
7878 on behalf of is not the file owner. Setting this option to <TT
7881 > allows DOS semantics and <A
7885 > will change the file
7886 timestamp as DOS requires.</P
7890 >dos filetimes = no</B
7895 NAME="ENCRYPTPASSWORDS"
7897 >encrypt passwords (G)</DT
7900 >This boolean controls whether encrypted passwords
7901 will be negotiated with the client. Note that Windows NT 4.0 SP3 and
7902 above and also Windows 98 will by default expect encrypted passwords
7903 unless a registry entry is changed. To use encrypted passwords in
7904 Samba see the file ENCRYPTION.txt in the Samba documentation
7908 > shipped with the source code.</P
7910 >In order for encrypted passwords to work correctly
7919 have access to a local <A
7920 HREF="smbpasswd.5.html"
7928 HREF="smbpasswd.8.html"
7934 > program for information on how to set up
7935 and maintain this file), or set the <A
7937 >security = [server|domain|ads]</A
7942 > to authenticate against another
7947 >encrypt passwords = yes</B
7952 NAME="ENHANCEDBROWSING"
7954 >enhanced browsing (G)</DT
7957 >This option enables a couple of enhancements to
7958 cross-subnet browse propagation that have been added in Samba
7959 but which are not standard in Microsoft implementations.
7962 >The first enhancement to browse propagation consists of a regular
7963 wildcard query to a Samba WINS server for all Domain Master Browsers,
7964 followed by a browse synchronization with each of the returned
7965 DMBs. The second enhancement consists of a regular randomised browse
7966 synchronization with all currently known DMBs.</P
7968 >You may wish to disable this option if you have a problem with empty
7969 workgroups not disappearing from browse lists. Due to the restrictions
7970 of the browse protocols these enhancements can cause a empty workgroup
7971 to stay around forever which can be annoying.</P
7973 >In general you should leave this option enabled as it makes
7974 cross-subnet browse propagation much more reliable.</P
7978 >enhanced browsing = yes</B
7983 NAME="ENUMPORTSCOMMAND"
7985 >enumports command (G)</DT
7988 >The concept of a "port" is fairly foreign
7989 to UNIX hosts. Under Windows NT/2000 print servers, a port
7990 is associated with a port monitor and generally takes the form of
7991 a local port (i.e. LPT1:, COM1:, FILE:) or a remote port
7992 (i.e. LPD Port Monitor, etc...). By default, Samba has only one
7995 >"Samba Printer Port"</TT
7997 Windows NT/2000, all printers must have a valid port name.
7998 If you wish to have a list of ports displayed (<B
8002 > does not use a port name for anything) other than
8005 >"Samba Printer Port"</TT
8010 >enumports command</I
8013 a program which should generate a list of ports, one per line,
8014 to standard output. This listing will then be used in response
8015 to the level 1 and 2 EnumPorts() RPC.</P
8019 >no enumports command</I
8024 >enumports command = /usr/bin/listports
8035 >This is a synonym for <A
8047 NAME="FAKEDIRECTORYCREATETIMES"
8049 >fake directory create times (S)</DT
8052 >NTFS and Windows VFAT file systems keep a create
8053 time for all files and directories. This is not the same as the
8054 ctime - status change time - that Unix keeps, so Samba by default
8055 reports the earliest of the various times Unix does keep. Setting
8056 this parameter for a share causes Samba to always report midnight
8057 1-1-1980 as the create time for directories.</P
8059 >This option is mainly used as a compatibility option for
8060 Visual C++ when used against Samba shares. Visual C++ generated
8061 makefiles have the object directory as a dependency for each object
8062 file, and a make rule to create the directory. Also, when NMAKE
8063 compares timestamps it uses the creation time when examining a
8064 directory. Thus the object directory will be created if it does not
8065 exist, but once it does exist it will always have an earlier
8066 timestamp than the object files it contains.</P
8068 >However, Unix time semantics mean that the create time
8069 reported by Samba will be updated whenever a file is created or
8070 or deleted in the directory. NMAKE finds all object files in
8071 the object directory. The timestamp of the last one built is then
8072 compared to the timestamp of the object directory. If the
8073 directory's timestamp if newer, then all object files
8074 will be rebuilt. Enabling this option
8075 ensures directories always predate their contents and an NMAKE build
8076 will proceed as expected.</P
8080 >fake directory create times = no</B
8087 >fake oplocks (S)</DT
8090 >Oplocks are the way that SMB clients get permission
8091 from a server to locally cache file operations. If a server grants
8092 an oplock (opportunistic lock) then the client is free to assume
8093 that it is the only one accessing the file and it will aggressively
8094 cache file data. With some oplock types the client may even cache
8095 file open/close operations. This can give enormous performance benefits.
8100 >fake oplocks = yes</B
8109 always grant oplock requests no matter how many clients are using
8112 >It is generally much better to use the real <A
8121 than this parameter.</P
8123 >If you enable this option on all read-only shares or
8124 shares that you know will only be accessed from one client at a
8125 time such as physically read-only media like CDROMs, you will see
8126 a big performance improvement on many operations. If you enable
8127 this option on shares where multiple clients may be accessing the
8128 files read-write at the same time you can get data corruption. Use
8129 this option carefully!</P
8133 >fake oplocks = no</B
8138 NAME="FOLLOWSYMLINKS"
8140 >follow symlinks (S)</DT
8143 >This parameter allows the Samba administrator
8152 from following symbolic links in a particular share. Setting this
8156 > prevents any file or directory
8157 that is a symbolic link from being followed (the user will get an
8158 error). This option is very useful to stop users from adding a
8159 symbolic link to <TT
8163 directory for instance. However it will slow filename lookups
8166 >This option is enabled (i.e. <B
8170 follow symbolic links) by default.</P
8174 >follow symlinks = yes</B
8179 NAME="FORCECREATEMODE"
8181 >force create mode (S)</DT
8184 >This parameter specifies a set of UNIX mode bit
8185 permissions that will <I
8189 file created by Samba. This is done by bitwise 'OR'ing these bits onto
8190 the mode bits of a file that is being created or having its
8191 permissions changed. The default for this parameter is (in octal)
8192 000. The modes in this parameter are bitwise 'OR'ed onto the file
8193 mode after the mask set in the <TT
8199 parameter is applied.</P
8201 >See also the parameter <A
8210 > for details on masking mode bits on files.</P
8213 HREF="#INHERITPERMISSIONS"
8225 >force create mode = 000</B
8230 >force create mode = 0755</B
8233 >would force all created files to have read and execute
8234 permissions set for 'group' and 'other' as well as the
8235 read/write/execute bits set for the 'user'.</P
8239 NAME="FORCEDIRECTORYMODE"
8241 >force directory mode (S)</DT
8244 >This parameter specifies a set of UNIX mode bit
8245 permissions that will <I
8248 > be set on a directory
8249 created by Samba. This is done by bitwise 'OR'ing these bits onto the
8250 mode bits of a directory that is being created. The default for this
8251 parameter is (in octal) 0000 which will not add any extra permission
8252 bits to a created directory. This operation is done after the mode
8253 mask in the parameter <TT
8261 >See also the parameter <A
8262 HREF="#DIRECTORYMASK"
8269 > for details on masking mode bits
8270 on created directories.</P
8273 HREF="#INHERITPERMISSIONS"
8277 > inherit permissions</I
8284 >force directory mode = 000</B
8289 >force directory mode = 0755</B
8292 >would force all created directories to have read and execute
8293 permissions set for 'group' and 'other' as well as the
8294 read/write/execute bits set for the 'user'.</P
8298 NAME="FORCEDIRECTORYSECURITYMODE"
8300 >force directory security mode (S)</DT
8303 >This parameter controls what UNIX permission bits
8304 can be modified when a Windows NT client is manipulating the UNIX
8305 permission on a directory using the native NT security dialog box.</P
8307 >This parameter is applied as a mask (OR'ed with) to the
8308 changed permission bits, thus forcing any bits in this mask that
8309 the user may have modified to be on. Essentially, one bits in this
8310 mask may be treated as a set of bits that, when modifying security
8311 on a directory, the user has always set to be 'on'.</P
8313 >If not set explicitly this parameter is 000, which
8314 allows a user to modify all the user/group/world permissions on a
8315 directory without restrictions.</P
8320 > that users who can access the
8321 Samba server through other means can easily bypass this restriction,
8322 so it is primarily useful for standalone "appliance" systems.
8323 Administrators of most normal systems will probably want to leave
8327 HREF="#DIRECTORYSECURITYMASK"
8331 > directory security mask</I
8335 HREF="#SECURITYMASK"
8344 HREF="#FORCESECURITYMODE"
8348 >force security mode
8356 >force directory security mode = 0</B
8361 >force directory security mode = 700</B
8368 >force group (S)</DT
8371 >This specifies a UNIX group name that will be
8372 assigned as the default primary group for all users connecting
8373 to this service. This is useful for sharing files by ensuring
8374 that all access to files on service will use the named group for
8375 their permissions checking. Thus, by assigning permissions for this
8376 group to the files and directories within this service the Samba
8377 administrator can restrict or allow sharing of these files.</P
8379 >In Samba 2.0.5 and above this parameter has extended
8380 functionality in the following way. If the group name listed here
8381 has a '+' character prepended to it then the current user accessing
8382 the share only has the primary group default assigned to this group
8383 if they are already assigned as a member of that group. This allows
8384 an administrator to decide that only users who are already in a
8385 particular group will create files with group ownership set to that
8386 group. This gives a finer granularity of ownership assignment. For
8387 example, the setting <TT
8389 >force group = +sys</TT
8391 that only users who are already in group sys will have their default
8392 primary group assigned to sys when accessing this Samba share. All
8393 other users will retain their ordinary primary group.</P
8404 > parameter is also set the group specified in
8410 > will override the primary group
8436 >force group = agroup</B
8441 NAME="FORCESECURITYMODE"
8443 >force security mode (S)</DT
8446 >This parameter controls what UNIX permission
8447 bits can be modified when a Windows NT client is manipulating
8448 the UNIX permission on a file using the native NT security dialog
8451 >This parameter is applied as a mask (OR'ed with) to the
8452 changed permission bits, thus forcing any bits in this mask that
8453 the user may have modified to be on. Essentially, one bits in this
8454 mask may be treated as a set of bits that, when modifying security
8455 on a file, the user has always set to be 'on'.</P
8457 >If not set explicitly this parameter is set to 0,
8458 and allows a user to modify all the user/group/world permissions on a file,
8459 with no restrictions.</P
8464 > that users who can access
8465 the Samba server through other means can easily bypass this restriction,
8466 so it is primarily useful for standalone "appliance" systems.
8467 Administrators of most normal systems will probably want to leave
8468 this set to 0000.</P
8471 HREF="#FORCEDIRECTORYSECURITYMODE"
8475 > force directory security mode</I
8480 HREF="#DIRECTORYSECURITYMASK"
8489 HREF="#SECURITYMASK"
8500 >force security mode = 0</B
8505 >force security mode = 700</B
8515 >This specifies a UNIX user name that will be
8516 assigned as the default user for all users connecting to this service.
8517 This is useful for sharing files. You should also use it carefully
8518 as using it incorrectly can cause security problems.</P
8520 >This user name only gets used once a connection is established.
8521 Thus clients still need to connect as a valid user and supply a
8522 valid password. Once connected, all file operations will be performed
8523 as the "forced user", no matter what username the client connected
8524 as. This can be very useful.</P
8526 >In Samba 2.0.5 and above this parameter also causes the
8527 primary group of the forced user to be used as the primary group
8528 for all file activity. Prior to 2.0.5 the primary group was left
8529 as the primary group of the connecting user (this was a bug).</P
8549 >force user = auser</B
8559 >This parameter allows the administrator to
8560 configure the string that specifies the type of filesystem a share
8561 is using that is reported by <A
8569 > when a client queries the filesystem type
8570 for a share. The default type is <TT
8574 compatibility with Windows NT but this can be changed to other
8598 >getwd cache (G)</DT
8601 >This is a tuning option. When this is enabled a
8602 caching algorithm will be used to reduce the time taken for getwd()
8603 calls. This can have a significant impact on performance, especially
8613 >parameter is set to <TT
8620 >getwd cache = yes</B
8645 >guest account (S)</DT
8648 >This is a username which will be used for access
8649 to services which are specified as <A
8657 > (see below). Whatever privileges this
8658 user has will be available to any client connecting to the guest service.
8659 Typically this user will exist in the password file, but will not
8660 have a valid login. The user account "ftp" is often a good choice
8661 for this parameter. If a username is specified in a given service,
8662 the specified username overrides this one.</P
8664 >One some systems the default guest account "nobody" may not
8665 be able to print. Use another account in this case. You should test
8666 this by trying to log in as your guest user (perhaps by using the
8670 > command) and trying to print using the
8671 system print command such as <B
8679 >This parameter does not accept % macros, because
8680 many parts of the system require this value to be
8681 constant for correct operation.</P
8685 >specified at compile time, usually
8691 >guest account = ftp</B
8701 >If this parameter is <TT
8705 a service, then no password is required to connect to the service.
8706 Privileges will be those of the <A
8707 HREF="#GUESTACCOUNT"
8716 >See the section below on <A
8724 > for more information about this option.
8739 >If this parameter is <TT
8743 a service, then only guest connections to the service are permitted.
8744 This parameter will have no effect if <A
8752 > is not set for the service.</P
8754 >See the section below on <A
8762 > for more information about this option.
8774 >hide dot files (S)</DT
8777 >This is a boolean parameter that controls whether
8778 files starting with a dot appear as hidden files.</P
8782 >hide dot files = yes</B
8792 >This is a list of files or directories that are not
8793 visible but are accessible. The DOS 'hidden' attribute is applied
8794 to any files or directories that match.</P
8796 >Each entry in the list must be separated by a '/',
8797 which allows spaces to be included in the entry. '*'
8798 and '?' can be used to specify multiple files or directories
8799 as in DOS wildcards.</P
8801 >Each entry must be a Unix path, not a DOS path and must
8802 not include the Unix directory separator '/'.</P
8804 >Note that the case sensitivity option is applicable
8807 >Setting this parameter will affect the performance of Samba,
8808 as it will be forced to check all files and directories for a match
8809 as they are scanned.</P
8812 HREF="#HIDEDOTFILES"
8829 HREF="#CASESENSITIVE"
8840 >no file are hidden</I
8846 /.*/DesktopFolderDB/TrashFor%m/resource.frk/</B
8849 >The above example is based on files that the Macintosh
8850 SMB client (DAVE) available from <A
8851 HREF="http://www.thursby.com"
8855 > creates for internal use, and also still hides
8856 all files beginning with a dot.</P
8860 NAME="HIDELOCALUSERS"
8862 >hide local users(G)</DT
8865 >This parameter toggles the hiding of local UNIX
8866 users (root, wheel, floppy, etc) from remote clients.</P
8870 >hide local users = no</B
8875 NAME="HIDEUNREADABLE"
8877 >hide unreadable (G)</DT
8880 >This parameter prevents clients from seeing the
8881 existance of files that cannot be read. Defaults to off.</P
8885 >hide unreadable = no</B
8890 NAME="HIDEUNWRITEABLEFILES"
8892 >hide unwriteable files (G)</DT
8895 >This parameter prevents clients from seeing
8896 the existance of files that cannot be written to. Defaults to off.
8897 Note that unwriteable directories are shown as usual.
8902 >hide unwriteable = no</B
8907 NAME="HIDESPECIALFILES"
8909 >hide special files (G)</DT
8912 >This parameter prevents clients from seeing
8913 special files such as sockets, devices and fifo's in directory
8919 >hide special files = no</B
8926 >homedir map (G)</DT
8954 > then this parameter
8955 specifies the NIS (or YP) map from which the server for the user's
8956 home directory should be extracted. At present, only the Sun
8957 auto.home map format is understood. The form of the map is:</P
8961 >username server:/some/file/system</B
8964 >and the program will extract the servername from before
8965 the first ':'. There should probably be a better parsing system
8966 that copes with different map formats and also Amd (another
8967 automounter) maps.</P
8972 >A working NIS client is required on
8973 the system for this option to work.</P
8985 HREF="#DOMAINLOGONS"
8997 >homedir map = <empty string></B
9002 >homedir map = amd.homedir</B
9012 >This boolean parameter is only available
9013 if Samba has been configured and compiled with the <B
9016 > option. If set to <TT
9020 Samba will act as a Dfs server, and allow Dfs-aware clients
9021 to browse Dfs trees hosted on the server.</P
9031 > share level parameter. For
9032 more information on setting up a Dfs tree on Samba,
9034 HREF="msdfs_setup.html"
9036 >msdfs_setup.html</A
9047 NAME="HOSTNAMELOOKUPS"
9049 >hostname lookups (G)</DT
9052 >Specifies whether samba should use (expensive)
9053 hostname lookups or use the ip addresses instead. An example place
9054 where hostname lookups are currently used is when checking
9066 >hostname lookups = yes</B
9071 >hostname lookups = no</B
9078 >hosts allow (S)</DT
9081 >A synonym for this parameter is <TT
9089 >This parameter is a comma, space, or tab delimited
9090 set of hosts which are permitted to access a service.</P
9092 >If specified in the [global] section then it will
9093 apply to all services, regardless of whether the individual
9094 service has a different setting.</P
9096 >You can specify the hosts by name or IP number. For
9097 example, you could restrict access to only the hosts on a
9098 Class C subnet with something like <B
9100 >allow hosts = 150.203.5.
9102 >. The full syntax of the list is described in the man
9105 >hosts_access(5)</TT
9106 >. Note that this man
9107 page may not be present on your system, so a brief description will
9108 be given here also.</P
9110 >Note that the localhost address 127.0.0.1 will always
9111 be allowed access unless specifically denied by a <A
9121 >You can also specify hosts by network/netmask pairs and
9122 by netgroup names if your system supports netgroups. The
9126 > keyword can also be used to limit a
9127 wildcard list. The following examples may provide some help:</P
9129 >Example 1: allow all IPs in 150.203.*.*; except one</P
9133 >hosts allow = 150.203. EXCEPT 150.203.6.66</B
9136 >Example 2: allow hosts that match the given network/netmask</P
9140 >hosts allow = 150.203.15.0/255.255.255.0</B
9143 >Example 3: allow a couple of hosts</P
9147 >hosts allow = lapland, arvidsjaur</B
9150 >Example 4: allow only hosts in NIS netgroup "foonet", but
9151 deny access from one particular host</P
9155 >hosts allow = @foonet</B
9160 >hosts deny = pirate</B
9163 >Note that access still requires suitable user-level passwords.</P
9166 HREF="testparm.1.html"
9173 > for a way of testing your host access to see if it does
9178 >none (i.e., all hosts permitted access)
9184 >allow hosts = 150.203.5. myhost.mynet.edu.au
9195 >The opposite of <TT
9201 - hosts listed here are <I
9204 > permitted access to
9205 services unless the specific services have their own lists to override
9206 this one. Where the lists conflict, the <TT
9212 list takes precedence.</P
9216 >none (i.e., no hosts specifically excluded)
9222 >hosts deny = 150.203.4. badhost.mynet.edu.au
9230 >hosts equiv (G)</DT
9233 >If this global parameter is a non-null string,
9234 it specifies the name of a file to read for the names of hosts
9235 and users who will be allowed access without specifying a password.
9238 >This is not be confused with <A
9246 > which is about hosts
9247 access to services and is more useful for guest services. <TT
9252 > may be useful for NT clients which will
9253 not supply passwords to Samba.</P
9264 > can be a major security hole. This is because you are
9265 trusting the PC to supply the correct username. It is very easy to
9266 get a PC to supply a false username. I recommend that the
9272 > option be only used if you really
9273 know what you are doing, or perhaps on a home network where you trust
9274 your spouse and kids. And only if you <I
9282 >no host equivalences</I
9287 >hosts equiv = /etc/hosts.equiv</B
9297 >This allows you to include one config file
9298 inside another. The file is included literally, as though typed
9301 >It takes the standard substitutions, except <TT
9322 >no file included</I
9327 >include = /usr/local/samba/lib/admin_smb.conf
9335 >inherit acls (S)</DT
9338 >This parameter can be used to ensure
9339 that if default acls exist on parent directories,
9340 they are always honored when creating a subdirectory.
9341 The default behavior is to use the mode specified
9342 when creating the directory. Enabling this option
9343 sets the mode to 0777, thus guaranteeing that
9344 default directory acls are propagated.
9349 >inherit acls = no</B
9355 NAME="INHERITPERMISSIONS"
9357 >inherit permissions (S)</DT
9360 >The permissions on new files and directories
9361 are normally governed by <A
9370 HREF="#DIRECTORYMASK"
9378 HREF="#FORCECREATEMODE"
9382 >force create mode</I
9387 HREF="#FORCEDIRECTORYMODE"
9395 > but the boolean inherit
9396 permissions parameter overrides this.</P
9398 >New directories inherit the mode of the parent directory,
9399 including bits such as setgid.</P
9401 >New files inherit their read/write bits from the parent
9402 directory. Their execute bits continue to be determined by
9432 >Note that the setuid bit is <I
9436 inheritance (the code explicitly prohibits this).</P
9438 >This can be particularly useful on large systems with
9439 many users, perhaps several thousand, to allow a single [homes]
9440 share to be used flexibly by each user.</P
9452 HREF="#DIRECTORYMASK"
9460 HREF="#FORCECREATEMODE"
9464 >force create mode</I
9468 HREF="#FORCEDIRECTORYMODE"
9472 >force directory mode</I
9480 >inherit permissions = no</B
9490 >This option allows you to override the default
9491 network interfaces list that Samba will use for browsing, name
9492 registration and other NBT traffic. By default Samba will query
9493 the kernel for the list of all active interfaces and use any
9494 interfaces except 127.0.0.1 that are broadcast capable.</P
9496 >The option takes a list of interface strings. Each string
9497 can be in any of the following forms:</P
9503 >a network interface name (such as eth0).
9504 This may include shell-like wildcards so eth* will match
9505 any interface starting with the substring "eth"</P
9509 >an IP address. In this case the netmask is
9510 determined from the list of interfaces obtained from the
9515 >an IP/mask pair. </P
9519 >a broadcast/mask pair.</P
9523 >The "mask" parameters can either be a bit length (such
9524 as 24 for a C class network) or a full netmask in dotted
9527 >The "IP" parameters above can either be a full dotted
9528 decimal IP address or a hostname which will be looked up via
9529 the OS's normal hostname resolution mechanisms.</P
9531 >For example, the following line:</P
9535 >interfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0
9539 >would configure three network interfaces corresponding
9540 to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10.
9541 The netmasks of the latter two interfaces would be set to 255.255.255.0.</P
9544 HREF="#BINDINTERFACESONLY"
9556 >all active interfaces except 127.0.0.1
9557 that are broadcast capable</I
9564 >invalid users (S)</DT
9567 >This is a list of users that should not be allowed
9568 to login to this service. This is really a <I
9572 check to absolutely ensure an improper setting does not breach
9575 >A name starting with a '@' is interpreted as an NIS
9576 netgroup first (if your system supports NIS), and then as a UNIX
9577 group if the name was not found in the NIS netgroup database.</P
9579 >A name starting with '+' is interpreted only
9580 by looking in the UNIX group database. A name starting with
9581 '&' is interpreted only by looking in the NIS netgroup database
9582 (this requires NIS to be working on your system). The characters
9583 '+' and '&' may be used at the start of the name in either order
9590 UNIX group database, followed by the NIS netgroup database, and
9596 > means check the NIS
9597 netgroup database, followed by the UNIX group database (the
9598 same as the '@' prefix).</P
9600 >The current servicename is substituted for <TT
9606 This is useful in the [homes] section.</P
9621 >no invalid users</I
9626 >invalid users = root fred admin @wheel
9637 >The value of the parameter (an integer) represents
9638 the number of seconds between <TT
9644 packets. If this parameter is zero, no keepalive packets will be
9645 sent. Keepalive packets, if sent, allow the server to tell whether
9646 a client is still present and responding.</P
9648 >Keepalives should, in general, not be needed if the socket
9649 being used has the SO_KEEPALIVE attribute set on it (see <A
9650 HREF="#SOCKETOPTIONS"
9658 Basically you should only use this option if you strike difficulties.</P
9672 NAME="KERNELOPLOCKS"
9674 >kernel oplocks (G)</DT
9677 >For UNIXes that support kernel based <A
9686 (currently only IRIX and the Linux 2.4 kernel), this parameter
9687 allows the use of them to be turned on or off.</P
9689 >Kernel oplocks support allows Samba <TT
9695 > to be broken whenever a local UNIX process or NFS operation
9696 accesses a file that <A
9704 > has oplocked. This allows complete data consistency between
9705 SMB/CIFS, NFS and local file access (and is a <I
9709 cool feature :-).</P
9711 >This parameter defaults to <TT
9714 >, but is translated
9715 to a no-op on systems that no not have the necessary kernel support.
9716 You should never need to touch this parameter.</P
9728 HREF="#LEVEL2OPLOCKS"
9740 >kernel oplocks = yes</B
9747 >lanman auth (G)</DT
9750 >This parameter determines whether or not <A
9755 attempt to authenticate users using the LANMAN password hash.
9756 If disabled, only clients which support NT password hashes (e.g. Windows
9757 NT/2000 clients, smbclient, etc... but not Windows 95/98 or the MS DOS
9758 network client) will be able to connect to the Samba host.</P
9762 >lanman auth = yes</B
9767 NAME="LARGEREADWRITE"
9769 >large readwrite (G)</DT
9772 >This parameter determines whether or not <A
9777 supports the new 64k streaming read and write varient SMB requests introduced
9778 with Windows 2000. Note that due to Windows 2000 client redirector bugs
9779 this requires Samba to be running on a 64-bit capable operating system such
9780 as IRIX, Solaris or a Linux 2.4 kernel. Can improve performance by 10% with
9781 Windows 2000 clients. Defaults to on. Not as tested as some other Samba
9787 >large readwrite = yes</B
9794 >ldap admin dn (G)</DT
9802 > defines the Distinguished
9803 Name (DN) name used by Samba to contact the ldap server when retreiving
9804 user account information. The <TT
9810 > is used in conjunction with the admin dn password
9813 >private/secrets.tdb</TT
9816 HREF="smbpasswd.8.html"
9823 page for more information on how to accomplish this.
9830 >>ldap del only sam attr (G)</DT
9833 > This parameter specifies whether a delete
9834 operation in the ldapsam deletes the complete entry or only the attributes
9840 >ldap delete dn = no</I
9845 NAME="LDAPDELONLYSAMATTR"
9847 >>ldap del only sam attr (G)</DT
9850 > Inverted synonym for <A
9851 HREF="#LDAPDELETEDN"
9865 >ldap filter (G)</DT
9868 >This parameter specifies the RFC 2254 compliant LDAP search filter.
9869 The default is to match the login name with the <TT
9873 attribute for all entries matching the <TT
9877 objectclass. Note that this filter should only return one entry.
9882 >ldap filter = (&(uid=%u)(objectclass=sambaAccount))</B
9892 >This parameter is only available if Samba has been
9893 configure to include the <B
9900 > This option is used to control the tcp port number used to contact
9910 The default is to use the stand LDAPS port 636.
9921 >ldap port = 636 ; if ldap ssl = on</B
9926 >ldap port = 389 ; if ldap ssl = off</B
9933 >ldap server (G)</DT
9936 >This parameter is only available if Samba has been
9937 configure to include the <B
9944 > This parameter should contain the FQDN of the ldap directory
9945 server which should be queried to locate user account information.
9950 >ldap server = localhost</B
9960 >This option is used to define whether or not Samba should
9961 use SSL when connecting to the ldap server
9966 Samba's previous SSL support which was enabled by specifying the
9982 > can be set to one of three values:
9994 > = Never use SSL when querying the directory.</P
10003 > = Use the LDAPv3 StartTLS extended operation
10004 (RFC2830) for communicating with the directory server.</P
10014 Use SSL on the ldaps port when contacting the
10021 available when the backwards-compatiblity <B
10023 > --with-ldapsam</B
10024 > option is specified
10025 to configure. See <A
10026 HREF="#PASSDBBACKEND"
10039 >ldap ssl = start_tls</B
10046 >ldap suffix (G)</DT
10049 >Specifies where user and machine accounts are added to the tree. Can be overriden by <B
10051 >ldap user suffix</B
10054 >ldap machine suffix</B
10055 >. It also used as the base dn for all ldap searches. </P
10064 NAME="LDAPUSERSUFFIX"
10066 >ldap user suffix (G)</DT
10069 >It specifies where users are added to the tree.
10079 NAME="LDAPMACHINESUFFIX"
10081 >ldap machine suffix (G)</DT
10084 >It specifies where machines should be
10085 added to the ldap tree.
10095 NAME="LDAPPASSWDSYNC"
10097 >ldap passwd sync (G)</DT
10100 >This option is used to define whether
10101 or not Samba should sync the LDAP password with the NT
10102 and LM hashes for normal accounts (NOT for
10103 workstation, server or domain trusts) on a password
10110 >ldap passwd sync</I
10112 > can be set to one of three values:
10124 > = Try to update the LDAP, NT and LM passwords and update the pwdLastSet time.</P
10133 > = Update NT and LM passwords and update the pwdLastSet time.</P
10142 > = Only update the LDAP password and let the LDAP server do the rest.</P
10148 >ldap passwd sync = no</B
10153 NAME="LDAPTRUSTIDS"
10155 >ldap trust ids (G)</DT
10158 >Normally, Samba validates each entry
10159 in the LDAP server against getpwnam(). This allows
10160 LDAP to be used for Samba with the unix system using
10161 NIS (for example) and also ensures that Samba does not
10162 present accounts that do not otherwise exist. </P
10164 >This option is used to disable this functionality, and
10165 instead to rely on the presence of the appropriate
10166 attributes in LDAP directly, which can result in a
10167 significant performance boost in some situations.
10168 Setting this option to yes effectivly assumes
10169 that the local machine is running <B
10173 same LDAP server.</P
10177 >ldap trust ids = No</B
10182 NAME="LEVEL2OPLOCKS"
10184 >level2 oplocks (S)</DT
10187 >This parameter controls whether Samba supports
10188 level2 (read-only) oplocks on a share.</P
10190 >Level2, or read-only oplocks allow Windows NT clients
10191 that have an oplock on a file to downgrade from a read-write oplock
10192 to a read-only oplock once a second client opens the file (instead
10193 of releasing all oplocks on a second open, as in traditional,
10194 exclusive oplocks). This allows all openers of the file that
10195 support level2 oplocks to cache the file for read-ahead only (ie.
10196 they may not cache writes or lock requests) and increases performance
10197 for many accesses of files that are not commonly written (such as
10198 application .EXE files).</P
10200 >Once one of the clients which have a read-only oplock
10201 writes to the file all clients are notified (no reply is needed
10202 or waited for) and told to break their oplocks to "none" and
10203 delete any read-ahead caches.</P
10205 >It is recommended that this parameter be turned on
10206 to speed access to shared executables.</P
10208 >For more discussions on level2 oplocks see the CIFS spec.</P
10211 HREF="#KERNELOPLOCKS"
10219 > are supported then level2 oplocks are
10220 not granted (even if this parameter is set to <TT
10233 > parameter must be set to <TT
10236 > on this share in order for
10237 this parameter to have any effect.</P
10261 >level2 oplocks = yes</B
10268 >lm announce (G)</DT
10271 >This parameter determines if <A
10278 > will produce Lanman announce
10279 broadcasts that are needed by OS/2 clients in order for them to see
10280 the Samba server in their browse list. This parameter can have three
10291 >. The default is <TT
10298 > Samba will never produce these
10299 broadcasts. If set to <TT
10302 > Samba will produce
10303 Lanman announce broadcasts at a frequency set by the parameter
10313 Samba will not send Lanman announce broadcasts by default but will
10314 listen for them. If it hears such a broadcast on the wire it will
10315 then start sending them at a frequency set by the parameter
10336 >lm announce = auto</B
10341 >lm announce = yes</B
10348 >lm interval (G)</DT
10351 >If Samba is set to produce Lanman announce
10352 broadcasts needed by OS/2 clients (see the <A
10360 > parameter) then this
10361 parameter defines the frequency in seconds with which they will be
10362 made. If this is set to zero then no Lanman announcements will be
10363 made despite the setting of the <TT
10384 >lm interval = 60</B
10389 >lm interval = 120</B
10394 NAME="LOADPRINTERS"
10396 >load printers (G)</DT
10399 >A boolean variable that controls whether all
10400 printers in the printcap will be loaded for browsing by default.
10409 >load printers = yes</B
10416 >local master (G)</DT
10419 >This option allows <A
10426 > to try and become a local master browser
10427 on a subnet. If set to <TT
10433 > will not attempt to become a local master browser
10434 on a subnet and will also lose in all browsing elections. By
10435 default this value is set to <TT
10438 >. Setting this value to <TT
10442 mean that Samba will <I
10446 browser on a subnet, just that <B
10452 > in elections for local master browser.</P
10454 >Setting this value to <TT
10464 > to become a local master browser.</P
10468 >local master = yes</B
10479 HREF="#LOCKDIRECTORY"
10483 > lock directory</I
10490 NAME="LOCKDIRECTORY"
10492 >lock directory (G)</DT
10495 >This option specifies the directory where lock
10496 files will be placed. The lock files are used to implement the
10498 HREF="#MAXCONNECTIONS"
10502 >max connections</I
10510 >lock directory = ${prefix}/var/locks</B
10515 >lock directory = /var/run/samba/locks</B
10521 NAME="LOCKSPINCOUNT"
10523 >lock spin count (G)</DT
10526 >This parameter controls the number of times
10527 that smbd should attempt to gain a byte range lock on the
10528 behalf of a client request. Experiments have shown that
10529 Windows 2k servers do not reply with a failure if the lock
10530 could not be immediately granted, but try a few more times
10531 in case the lock could later be aquired. This behavior
10532 is used to support PC database formats such as MS Access
10538 >lock spin count = 2</B
10544 NAME="LOCKSPINTIME"
10546 >lock spin time (G)</DT
10549 >The time in microseconds that smbd should
10550 pause before attempting to gain a failed lock. See
10552 HREF="#LOCKSPINCOUNT"
10560 > for more details.
10565 >lock spin time = 10</B
10576 >This controls whether or not locking will be
10577 performed by the server in response to lock requests from the
10583 >, all lock and unlock
10584 requests will appear to succeed and all lock queries will report
10585 that the file in question is available for locking.</P
10590 >, real locking will be performed
10596 > be useful for read-only
10597 filesystems which <I
10600 > not need locking (such as
10601 CDROM drives), although setting this parameter of <TT
10605 is not really recommended even in this case.</P
10607 >Be careful about disabling locking either globally or in a
10608 specific service, as lack of locking may result in data corruption.
10609 You should never need to set this parameter.</P
10623 >This option allows you to override the name
10624 of the Samba log file (also known as the debug file).</P
10626 >This option takes the standard substitutions, allowing
10627 you to have separate log files for each user or machine.</P
10631 >log file = /usr/local/samba/var/log.%m
10642 >The value of the parameter (a astring) allows
10643 the debug level (logging level) to be specified in the
10647 > file. This parameter has been
10648 extended since the 2.2.x series, now it allow to specify the debug
10649 level for multiple debug classes. This is to give greater
10650 flexibility in the configuration of the system.</P
10652 >The default will be the log level specified on
10653 the command line or level zero if none was specified.</P
10657 >log level = 3 passdb:5 auth:10 winbind:2
10665 >logon drive (G)</DT
10668 >This parameter specifies the local path to
10669 which the home directory will be connected (see <A
10678 and is only used by NT Workstations. </P
10680 >Note that this option is only useful if Samba is set up as a
10685 >logon drive = z:</B
10690 >logon drive = h:</B
10697 >logon home (G)</DT
10700 >This parameter specifies the home directory
10701 location when a Win95/98 or NT Workstation logs into a Samba PDC.
10702 It allows you to do </P
10710 >NET USE H: /HOME</B
10715 >from a command prompt, for example.</P
10717 >This option takes the standard substitutions, allowing
10718 you to have separate logon scripts for each user or machine.</P
10720 >This parameter can be used with Win9X workstations to ensure
10721 that roaming profiles are stored in a subdirectory of the user's
10722 home directory. This is done in the following way:</P
10726 >logon home = \\%N\%U\profile</B
10729 >This tells Samba to return the above string, with
10730 substitutions made when a client requests the info, generally
10731 in a NetUserGetInfo request. Win9X clients truncate the info to
10732 \\server\share when a user does <B
10736 but use the whole string when dealing with profiles.</P
10738 >Note that in prior versions of Samba, the <A
10746 > was returned rather than
10756 > but allowed profiles outside the home directory.
10757 The current implementation is correct, and can be used for
10758 profiles if you use the above trick.</P
10760 >This option is only useful if Samba is set up as a logon
10765 >logon home = "\\%N\%U"</B
10770 >logon home = "\\remote_smb_server\%U"</B
10778 >logon path (G)</DT
10781 >This parameter specifies the home directory
10782 where roaming profiles (NTuser.dat etc files for Windows NT) are
10783 stored. Contrary to previous versions of these manual pages, it has
10784 nothing to do with Win 9X roaming profiles. To find out how to
10785 handle roaming profiles for Win 9X system, see the <A
10795 >This option takes the standard substitutions, allowing you
10796 to have separate logon scripts for each user or machine. It also
10797 specifies the directory from which the "Application Data",
10807 >network neighborhood</TT
10812 and other folders, and their contents, are loaded and displayed on
10813 your Windows NT client.</P
10815 >The share and the path must be readable by the user for
10816 the preferences and directories to be loaded onto the Windows NT
10817 client. The share must be writeable when the user logs in for the first
10818 time, in order that the Windows NT client can create the NTuser.dat
10819 and other directories.</P
10821 >Thereafter, the directories and any of the contents can,
10822 if required, be made read-only. It is not advisable that the
10823 NTuser.dat file be made read-only - rename it to NTuser.man to
10824 achieve the desired effect (a <I
10830 >Windows clients can sometimes maintain a connection to
10831 the [homes] share, even though there is no user logged in.
10832 Therefore, it is vital that the logon path does not include a
10833 reference to the homes share (i.e. setting this parameter to
10834 \%N\%U\profile_path will cause problems).</P
10836 >This option takes the standard substitutions, allowing
10837 you to have separate logon scripts for each user or machine.</P
10839 >Note that this option is only useful if Samba is set up
10840 as a logon server.</P
10844 >logon path = \\%N\%U\profile</B
10849 >logon path = \\PROFILESERVER\PROFILE\%U</B
10856 >logon script (G)</DT
10859 >This parameter specifies the batch file (.bat) or
10860 NT command file (.cmd) to be downloaded and run on a machine when
10861 a user successfully logs in. The file must contain the DOS
10862 style CR/LF line endings. Using a DOS-style editor to create the
10863 file is recommended.</P
10865 >The script must be a relative path to the [netlogon]
10866 service. If the [netlogon] service specifies a <A
10876 >/usr/local/samba/netlogon
10880 >logon script = STARTUP.BAT</B
10882 the file that will be downloaded is:</P
10886 >/usr/local/samba/netlogon/STARTUP.BAT</TT
10889 >The contents of the batch file are entirely your choice. A
10890 suggested command would be to add <B
10892 >NET TIME \\SERVER /SET
10894 >, to force every machine to synchronize clocks with
10895 the same time server. Another use would be to add <B
10898 U: \\SERVER\UTILS</B
10899 > for commonly used utilities, or <B
10901 > NET USE Q: \\SERVER\ISO9001_QA</B
10904 >Note that it is particularly important not to allow write
10905 access to the [netlogon] share, or to grant users write permission
10906 on the batch files in a secure environment, as this would allow
10907 the batch files to be arbitrarily modified and security to be
10910 >This option takes the standard substitutions, allowing you
10911 to have separate logon scripts for each user or machine.</P
10913 >This option is only useful if Samba is set up as a logon
10918 >no logon script defined</I
10923 >logon script = scripts\%U.bat</B
10928 NAME="LPPAUSECOMMAND"
10930 >lppause command (S)</DT
10933 >This parameter specifies the command to be
10934 executed on the server host in order to stop printing or spooling
10935 a specific print job.</P
10937 >This command should be a program or script which takes
10938 a printer name and job number to pause the print job. One way
10939 of implementing this is by using job priorities, where jobs
10940 having a too low priority won't be sent to the printer.</P
10947 > is given then the printer name
10948 is put in its place. A <TT
10954 the job number (an integer). On HPUX (see <TT
10966 to the lpq command, the job will show up with the correct status, i.e.
10967 if the job priority is lower than the set fence priority it will
10968 have the PAUSED status, whereas if the priority is equal or higher it
10969 will have the SPOOLED or PRINTING status.</P
10971 >Note that it is good practice to include the absolute path
10972 in the lppause command as the PATH may not be available to the server.</P
10985 >Default: Currently no default value is given to
10986 this string, unless the value of the <TT
10995 >, in which case the default is :</P
10999 >lp -i %p-%j -H hold</B
11002 >or if the value of the <TT
11011 >, then the default is:</P
11015 >qstat -s -j%j -h</B
11018 >Example for HPUX: <B
11020 >lppause command = /usr/bin/lpalt
11026 NAME="LPQCACHETIME"
11028 >lpq cache time (G)</DT
11031 >This controls how long lpq info will be cached
11032 for to prevent the <B
11035 > command being called too
11036 often. A separate cache is kept for each variation of the <B
11039 > command used by the system, so if you use different
11043 > commands for different users then they won't
11044 share cache information.</P
11046 >The cache files are stored in <TT
11050 where xxxx is a hash of the <B
11053 > command in use.</P
11055 >The default is 10 seconds, meaning that the cached results
11056 of a previous identical <B
11059 > command will be used
11060 if the cached data is less than 10 seconds old. A large value may
11061 be advisable if your <B
11064 > command is very slow.</P
11066 >A value of 0 will disable caching completely.</P
11081 >lpq cache time = 10</B
11086 >lpq cache time = 30</B
11093 >lpq command (S)</DT
11096 >This parameter specifies the command to be
11097 executed on the server host in order to obtain <B
11101 >-style printer status information.</P
11103 >This command should be a program or script which
11104 takes a printer name as its only parameter and outputs printer
11105 status information.</P
11107 >Currently nine styles of printer status information
11108 are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ.
11109 This covers most UNIX systems. You control which type is expected
11117 >Some clients (notably Windows for Workgroups) may not
11118 correctly send the connection number for the printer they are
11119 requesting status information about. To get around this, the
11120 server reports on the first printer service connected to by the
11121 client. This only happens if the connection number sent is invalid.</P
11128 > is given then the printer name
11129 is put in its place. Otherwise it is placed at the end of the
11132 >Note that it is good practice to include the absolute path
11142 > may not be available to the server. When compiled with
11143 the CUPS libraries, no <TT
11149 needed because smbd will make a library call to obtain the
11150 print queue listing.</P
11165 >depends on the setting of <TT
11175 >lpq command = /usr/bin/lpq -P%p</B
11180 NAME="LPRESUMECOMMAND"
11182 >lpresume command (S)</DT
11185 >This parameter specifies the command to be
11186 executed on the server host in order to restart or continue
11187 printing or spooling a specific print job.</P
11189 >This command should be a program or script which takes
11190 a printer name and job number to resume the print job. See
11192 HREF="#LPPAUSECOMMAND"
11207 > is given then the printer name
11208 is put in its place. A <TT
11214 the job number (an integer).</P
11216 >Note that it is good practice to include the absolute path
11220 >lpresume command</I
11222 > as the PATH may not
11223 be available to the server.</P
11236 >Default: Currently no default value is given
11237 to this string, unless the value of the <TT
11246 >, in which case the default is :</P
11250 >lp -i %p-%j -H resume</B
11253 >or if the value of the <TT
11262 >, then the default is:</P
11266 >qstat -s -j%j -r</B
11269 >Example for HPUX: <B
11271 >lpresume command = /usr/bin/lpalt
11279 >lprm command (S)</DT
11282 >This parameter specifies the command to be
11283 executed on the server host in order to delete a print job.</P
11285 >This command should be a program or script which takes
11286 a printer name and job number, and deletes the print job.</P
11293 > is given then the printer name
11294 is put in its place. A <TT
11300 the job number (an integer).</P
11302 >Note that it is good practice to include the absolute
11308 > as the PATH may not be
11309 available to the server.</P
11324 >depends on the setting of <TT
11335 >lprm command = /usr/bin/lprm -P%p %j
11341 >lprm command = /usr/bin/cancel %p-%j
11347 NAME="MACHINEPASSWORDTIMEOUT"
11349 >machine password timeout (G)</DT
11352 >If a Samba server is a member of a Windows
11353 NT Domain (see the <A
11354 HREF="#SECURITYEQUALSDOMAIN"
11355 >security = domain</A
11357 parameter) then periodically a running <A
11361 > process will try and change the MACHINE ACCOUNT
11362 PASSWORD stored in the TDB called <TT
11364 >private/secrets.tdb
11366 >. This parameter specifies how often this password
11367 will be changed, in seconds. The default is one week (expressed in
11368 seconds), the same as a Windows NT Domain member server.</P
11371 HREF="smbpasswd.8.html"
11379 HREF="#SECURITYEQUALSDOMAIN"
11380 > security = domain</A
11385 >machine password timeout = 604800</B
11392 >magic output (S)</DT
11395 >This parameter specifies the name of a file
11396 which will contain output created by a magic script (see the
11398 HREF="#MAGICSCRIPT"
11406 parameter below).</P
11408 >Warning: If two clients use the same <TT
11414 > in the same directory the output file content
11419 >magic output = <magic script name>.out
11425 >magic output = myfile.txt</B
11432 >magic script (S)</DT
11435 >This parameter specifies the name of a file which,
11436 if opened, will be executed by the server when the file is closed.
11437 This allows a UNIX script to be sent to the Samba host and
11438 executed on behalf of the connected user.</P
11440 >Scripts executed in this way will be deleted upon
11441 completion assuming that the user has the appropriate level
11442 of privilege and the file permissions allow the deletion.</P
11444 >If the script generates output, output will be sent to
11445 the file specified by the <A
11446 HREF="#MAGICOUTPUT"
11453 > parameter (see above).</P
11455 >Note that some shells are unable to interpret scripts
11456 containing CR/LF instead of CR as
11457 the end-of-line marker. Magic scripts must be executable
11461 > on the host, which for some hosts and
11462 some shells will require filtering at the DOS end.</P
11464 >Magic scripts are <I
11471 > be relied upon.</P
11475 >None. Magic scripts disabled.</I
11480 >magic script = user.csh</B
11487 >mangle case (S)</DT
11490 >See the section on <A
11497 >mangle case = no</B
11504 >mangled map (S)</DT
11507 >This is for those who want to directly map UNIX
11508 file names which cannot be represented on Windows/DOS. The mangling
11509 of names is not always what is needed. In particular you may have
11510 documents with file extensions that differ between DOS and UNIX.
11511 For example, under UNIX it is common to use <TT
11515 for HTML files, whereas under Windows/DOS <TT
11519 is more commonly used.</P
11532 >mangled map = (*.html *.htm)</B
11535 >One very useful case is to remove the annoying <TT
11539 > off the ends of filenames on some CDROMs (only visible
11540 under some UNIXes). To do this use a map of (*;1 *;).</P
11549 >mangled map = (*;1 *;)</B
11554 NAME="MANGLEDNAMES"
11556 >mangled names (S)</DT
11559 >This controls whether non-DOS names under UNIX
11560 should be mapped to DOS-compatible names ("mangled") and made visible,
11561 or whether non-DOS names should simply be ignored.</P
11563 >See the section on <A
11566 > for details on how to control the mangling process.</P
11568 >If mangling is used then the mangling algorithm is as follows:</P
11574 >The first (up to) five alphanumeric characters
11575 before the rightmost dot of the filename are preserved, forced
11576 to upper case, and appear as the first (up to) five characters
11577 of the mangled name.</P
11581 >A tilde "~" is appended to the first part of the mangled
11582 name, followed by a two-character unique sequence, based on the
11583 original root name (i.e., the original filename minus its final
11584 extension). The final extension is included in the hash calculation
11585 only if it contains any upper case characters or is longer than three
11588 >Note that the character to use may be specified using
11590 HREF="#MANGLINGCHAR"
11598 > option, if you don't like '~'.</P
11602 >The first three alphanumeric characters of the final
11603 extension are preserved, forced to upper case and appear as the
11604 extension of the mangled name. The final extension is defined as that
11605 part of the original filename after the rightmost dot. If there are no
11606 dots in the filename, the mangled name will have no extension (except
11607 in the case of "hidden files" - see below).</P
11611 >Files whose UNIX name begins with a dot will be
11612 presented as DOS hidden files. The mangled name will be created as
11613 for other filenames, but with the leading dot removed and "___" as
11614 its extension regardless of actual original extension (that's three
11619 >The two-digit hash value consists of upper case
11620 alphanumeric characters.</P
11622 >This algorithm can cause name collisions only if files
11623 in a directory share the same first five alphanumeric characters.
11624 The probability of such a clash is 1/1300.</P
11626 >The name mangling (if enabled) allows a file to be
11627 copied between UNIX directories from Windows/DOS while retaining
11628 the long UNIX filename. UNIX files can be renamed to a new extension
11629 from Windows/DOS and will retain the same basename. Mangled names
11630 do not change between sessions.</P
11634 >mangled names = yes</B
11639 NAME="MANGLINGMETHOD"
11641 >mangling method (G)</DT
11644 > controls the algorithm used for the generating
11645 the mangled names. Can take two different values, "hash" and
11646 "hash2". "hash" is the default and is the algorithm that has been
11647 used in Samba for many years. "hash2" is a newer and considered
11648 a better algorithm (generates less collisions) in the names.
11649 However, many Win32 applications store the mangled names and so
11650 changing to the new algorithm must not be done
11651 lightly as these applications may break unless reinstalled.</P
11655 >mangling method = hash2</B
11660 >mangling method = hash</B
11665 NAME="MANGLEPREFIX"
11667 >mangle prefix (G)</DT
11670 > controls the number of prefix
11671 characters from the original name used when generating
11672 the mangled names. A larger value will give a weaker
11673 hash and therefore more name collisions. The minimum
11674 value is 1 and the maximum value is 6.</P
11678 >mangle prefix = 1</B
11683 >mangle prefix = 4</B
11688 NAME="MANGLEDSTACK"
11690 >mangled stack (G)</DT
11693 >This parameter controls the number of mangled names
11694 that should be cached in the Samba server <A
11700 >This stack is a list of recently mangled base names
11701 (extensions are only maintained if they are longer than 3 characters
11702 or contains upper case characters).</P
11704 >The larger this value, the more likely it is that mangled
11705 names can be successfully converted to correct long UNIX names.
11706 However, large stack sizes will slow most directory accesses. Smaller
11707 stacks save memory in the server (each stack element costs 256 bytes).
11710 >It is not possible to absolutely guarantee correct long
11711 filenames, so be prepared for some surprises!</P
11715 >mangled stack = 50</B
11720 >mangled stack = 100</B
11725 NAME="MANGLINGCHAR"
11727 >mangling char (S)</DT
11730 >This controls what character is used as
11737 >. The default is a '~'
11738 but this may interfere with some software. Use this option to set
11739 it to whatever you prefer.</P
11743 >mangling char = ~</B
11748 >mangling char = ^</B
11755 >map archive (S)</DT
11758 >This controls whether the DOS archive attribute
11759 should be mapped to the UNIX owner execute bit. The DOS archive bit
11760 is set when a file has been modified since its last backup. One
11761 motivation for this option it to keep Samba/your PC from making
11762 any file it touches from becoming executable under UNIX. This can
11763 be quite annoying for shared source code, documents, etc...</P
11765 >Note that this requires the <TT
11771 parameter to be set such that owner execute bit is not masked out
11772 (i.e. it must include 100). See the parameter <A
11784 >map archive = yes</B
11791 >map hidden (S)</DT
11794 >This controls whether DOS style hidden files
11795 should be mapped to the UNIX world execute bit.</P
11797 >Note that this requires the <TT
11803 to be set such that the world execute bit is not masked out (i.e.
11804 it must include 001). See the parameter <A
11816 >map hidden = no</B
11823 >map system (S)</DT
11826 >This controls whether DOS style system files
11827 should be mapped to the UNIX group execute bit.</P
11829 >Note that this requires the <TT
11835 to be set such that the group execute bit is not masked out (i.e.
11836 it must include 010). See the parameter <A
11848 >map system = no</B
11855 >map to guest (G)</DT
11858 >This parameter is only useful in <A
11861 > modes other than <TT
11864 >security = share</I
11879 >This parameter can take three different values, which tell
11884 > what to do with user
11885 login requests that don't match a valid UNIX user in some way.</P
11887 >The three settings are :</P
11896 > - Means user login
11897 requests with an invalid password are rejected. This is the
11906 logins with an invalid password are rejected, unless the username
11907 does not exist, in which case it is treated as a guest login and
11909 HREF="#GUESTACCOUNT"
11923 > - Means user logins
11924 with an invalid password are treated as a guest login and mapped
11926 HREF="#GUESTACCOUNT"
11929 this can cause problems as it means that any user incorrectly typing
11930 their password will be silently logged on as "guest" - and
11931 will not know the reason they cannot access files they think
11932 they should - there will have been no message given to them
11933 that they got their password wrong. Helpdesk services will
11937 > you if you set the <TT
11943 > parameter this way :-).</P
11947 >Note that this parameter is needed to set up "Guest"
11948 share services when using <TT
11954 share. This is because in these modes the name of the resource being
11958 > sent to the server until after
11959 the server has successfully authenticated the client so the server
11960 cannot make authentication decisions at the correct time (connection
11961 to the share) for "Guest" shares.</P
11963 >For people familiar with the older Samba releases, this
11964 parameter maps to the old compile-time setting of the <TT
11966 > GUEST_SESSSETUP</TT
11967 > value in local.h.</P
11971 >map to guest = Never</B
11976 >map to guest = Bad User</B
11981 NAME="MAXCONNECTIONS"
11983 >max connections (S)</DT
11986 >This option allows the number of simultaneous
11987 connections to a service to be limited. If <TT
11993 > is greater than 0 then connections will be refused if
11994 this number of connections to the service are already open. A value
11995 of zero mean an unlimited number of connections may be made.</P
11997 >Record lock files are used to implement this feature. The
11998 lock files will be stored in the directory specified by the <A
11999 HREF="#LOCKDIRECTORY"
12011 >max connections = 0</B
12016 >max connections = 10</B
12023 >max disk size (G)</DT
12026 >This option allows you to put an upper limit
12027 on the apparent size of disks. If you set this option to 100
12028 then all shares will appear to be not larger than 100 MB in
12031 >Note that this option does not limit the amount of
12032 data you can put on the disk. In the above case you could still
12033 store much more than 100 MB on the disk, but if a client ever asks
12034 for the amount of free disk space or the total disk size then the
12035 result will be bounded by the amount specified in <TT
12043 >This option is primarily useful to work around bugs
12044 in some pieces of software that can't handle very large disks,
12045 particularly disks over 1GB in size.</P
12052 > of 0 means no limit.</P
12056 >max disk size = 0</B
12061 >max disk size = 1000</B
12068 >max log size (G)</DT
12071 >This option (an integer in kilobytes) specifies
12072 the max size the log file should grow to. Samba periodically checks
12073 the size and if it is exceeded it will rename the file, adding
12079 >A size of 0 means no limit.</P
12083 >max log size = 5000</B
12088 >max log size = 1000</B
12098 >This option controls the maximum number of
12099 outstanding simultaneous SMB operations that Samba tells the client
12100 it will allow. You should never need to set this parameter.</P
12109 NAME="MAXOPENFILES"
12111 >max open files (G)</DT
12114 >This parameter limits the maximum number of
12115 open files that one <A
12120 serving process may have open for a client at any one time. The
12121 default for this parameter is set very high (10,000) as Samba uses
12122 only one bit per unopened file.</P
12124 >The limit of the number of open files is usually set
12125 by the UNIX per-process file descriptor limit rather than
12126 this parameter so you should never need to touch this parameter.</P
12130 >max open files = 10000</B
12135 NAME="MAXPRINTJOBS"
12137 >max print jobs (S)</DT
12140 >This parameter limits the maximum number of
12141 jobs allowable in a Samba printer queue at any given moment.
12142 If this number is exceeded, <A
12149 > will remote "Out of Space" to the client.
12151 HREF="#TOTALPRINTJOBS"
12164 >max print jobs = 1000</B
12169 >max print jobs = 5000</B
12176 >max protocol (G)</DT
12179 >The value of the parameter (a string) is the highest
12180 protocol level that will be supported by the server.</P
12182 >Possible values are :</P
12191 >: Earliest version. No
12192 concept of user names.</P
12199 >: Slight improvements on
12200 CORE for efficiency.</P
12210 > version of the protocol. Long filename
12218 >: Updates to Lanman1 protocol.
12226 >: Current up to date version of
12227 the protocol. Used by Windows NT. Known as CIFS.</P
12231 >Normally this option should not be set as the automatic
12232 negotiation phase in the SMB protocol takes care of choosing
12233 the appropriate protocol.</P
12236 HREF="#MINPROTOCOL"
12248 >max protocol = NT1</B
12253 >max protocol = LANMAN1</B
12258 NAME="MAXSMBDPROCESSES"
12260 >max smbd processes (G)</DT
12263 >This parameter limits the maximum number of
12272 processes concurrently running on a system and is intended
12273 as a stopgap to prevent degrading service to clients in the event
12274 that the server has insufficient resources to handle more than this
12275 number of connections. Remember that under normal operating
12276 conditions, each user will have an <A
12280 > associated with him or her
12281 to handle connections to all shares from a given host.
12286 >max smbd processes = 0</B
12291 >max smbd processes = 1000</B
12301 >This option tells <A
12306 what the default 'time to live' of NetBIOS names should be (in seconds)
12310 > is requesting a name using either a
12311 broadcast packet or from a WINS server. You should never need to
12312 change this parameter. The default is 3 days.</P
12316 >max ttl = 259200</B
12323 >max wins ttl (G)</DT
12326 >This option tells <A
12331 > when acting as a WINS server (<A
12332 HREF="#WINSSUPPORT"
12336 >wins support = yes</I
12339 >) what the maximum
12340 'time to live' of NetBIOS names that <B
12344 will grant will be (in seconds). You should never need to change this
12345 parameter. The default is 6 days (518400 seconds).</P
12360 >max wins ttl = 518400</B
12370 >This option controls the maximum packet size
12371 that will be negotiated by Samba. The default is 65535, which
12372 is the maximum. In some cases you may find you get better performance
12373 with a smaller value. A value below 2048 is likely to cause problems.
12378 >max xmit = 65535</B
12383 >max xmit = 8192</B
12388 NAME="MESSAGECOMMAND"
12390 >message command (G)</DT
12393 >This specifies what command to run when the
12394 server receives a WinPopup style message.</P
12396 >This would normally be a command that would
12397 deliver the message somehow. How this is to be done is
12398 up to your imagination.</P
12404 >message command = csh -c 'xedit %s;rm %s' &</B
12408 >This delivers the message using <B
12412 removes it afterwards. <I
12414 >NOTE THAT IT IS VERY IMPORTANT
12415 THAT THIS COMMAND RETURN IMMEDIATELY</I
12417 have the '&' on the end. If it doesn't return immediately then
12418 your PCs may freeze when sending messages (they should recover
12419 after 30 seconds, hopefully).</P
12421 >All messages are delivered as the global guest user.
12422 The command takes the standard substitutions, although <TT
12435 >Apart from the standard substitutions, some additional
12436 ones apply. In particular:</P
12447 > = the filename containing
12457 > = the destination that
12458 the message was sent to (probably the server name).</P
12467 > = who the message
12472 >You could make this command send mail, or whatever else
12473 takes your fancy. Please let us know of any really interesting
12476 >Here's a way of sending the messages as mail to root:</P
12480 >message command = /bin/mail -s 'message from %f on
12481 %m' root < %s; rm %s</B
12484 >If you don't have a message command then the message
12485 won't be delivered and Samba will tell the sender there was
12486 an error. Unfortunately WfWg totally ignores the error code
12487 and carries on regardless, saying that the message was delivered.
12490 >If you want to silently delete it then try:</P
12494 >message command = rm %s</B
12499 >no message command</I
12504 >message command = csh -c 'xedit %s;
12510 NAME="MINPASSWDLENGTH"
12512 >min passwd length (G)</DT
12516 HREF="#MINPASSWORDLENGTH"
12520 >min password length</I
12527 NAME="MINPASSWORDLENGTH"
12529 >min password length (G)</DT
12532 >This option sets the minimum length in characters
12533 of a plaintext password that <B
12536 > will accept when performing
12537 UNIX password changing.</P
12540 HREF="#UNIXPASSWORDSYNC"
12549 HREF="#PASSWDPROGRAM"
12557 HREF="#PASSWDCHATDEBUG"
12561 >passwd chat debug</I
12569 >min password length = 5</B
12574 NAME="MINPRINTSPACE"
12576 >min print space (S)</DT
12579 >This sets the minimum amount of free disk
12580 space that must be available before a user will be able to spool
12581 a print job. It is specified in kilobytes. The default is 0, which
12582 means a user can always spool a print job.</P
12597 >min print space = 0</B
12602 >min print space = 2000</B
12609 >min protocol (G)</DT
12612 >The value of the parameter (a string) is the
12613 lowest SMB protocol dialect than Samba will support. Please refer
12615 HREF="#MAXPROTOCOL"
12623 parameter for a list of valid protocol names and a brief description
12624 of each. You may also wish to refer to the C source code in
12627 >source/smbd/negprot.c</TT
12628 > for a listing of known protocol
12629 dialects supported by clients.</P
12631 >If you are viewing this parameter as a security measure, you should
12632 also refer to the <A
12641 > parameter. Otherwise, you should never need
12642 to change this parameter.</P
12646 >min protocol = CORE</B
12651 >min protocol = NT1</B
12659 >min wins ttl (G)</DT
12662 >This option tells <A
12667 when acting as a WINS server (<A
12668 HREF="#WINSSUPPORT"
12672 > wins support = yes</I
12675 >) what the minimum 'time to live'
12676 of NetBIOS names that <B
12679 > will grant will be (in
12680 seconds). You should never need to change this parameter. The default
12681 is 6 hours (21600 seconds).</P
12685 >min wins ttl = 21600</B
12692 >msdfs proxy (S)</DT
12695 >This parameter indicates that the share is a
12696 stand-in for another CIFS share whose location is specified by
12697 the value of the parameter. When clients attempt to connect to
12698 this share, they are redirected to the proxied share using
12699 the SMB-Dfs protocol.</P
12701 >Only Dfs roots can act as proxy shares. Take a look at the
12721 options to find out how to set up a Dfs root share.</P
12725 >msdfs proxy = \otherserver\someshare</B
12732 >msdfs root (S)</DT
12735 >This boolean parameter is only available if
12736 Samba is configured and compiled with the <B
12739 > option. If set to <TT
12743 Samba treats the share as a Dfs root and allows clients to browse
12744 the distributed file system tree rooted at the share directory.
12745 Dfs links are specified in the share directory by symbolic
12746 links of the form <TT
12748 >msdfs:serverA\shareA,serverB\shareB</TT
12750 and so on. For more information on setting up a Dfs tree
12751 on Samba, refer to <A
12752 HREF="msdfs_setup.html"
12771 >msdfs root = no</B
12776 NAME="NAMECACHETIMEOUT"
12778 >name cache timeout (G)</DT
12781 >Specifies the number of seconds it takes before
12782 entries in samba's hostname resolve cache time out. If
12783 the timeout is set to 0. the caching is disabled.
12788 >name cache timeout = 660</B
12793 >name cache timeout = 0</B
12798 NAME="NAMERESOLVEORDER"
12800 >name resolve order (G)</DT
12803 >This option is used by the programs in the Samba
12804 suite to determine what naming services to use and in what order
12805 to resolve host names to IP addresses. The option takes a space
12806 separated string of name resolution options.</P
12808 >The options are :"lmhosts", "host", "wins" and "bcast". They
12809 cause names to be resolved as follows :</P
12819 address in the Samba lmhosts file. If the line in lmhosts has
12820 no name type attached to the NetBIOS name (see the <A
12821 HREF="lmhosts.5.html"
12824 > for details) then
12825 any name type matches for lookup.</P
12832 > : Do a standard host
12833 name to IP address resolution, using the system <TT
12837 >, NIS, or DNS lookups. This method of name resolution
12838 is operating system depended for instance on IRIX or Solaris this
12839 may be controlled by the <TT
12841 >/etc/nsswitch.conf</TT
12843 file. Note that this method is only used if the NetBIOS name
12844 type being queried is the 0x20 (server) name type, otherwise
12852 > : Query a name with
12853 the IP address listed in the <A
12861 > parameter. If no WINS server has
12862 been specified this method will be ignored.</P
12869 > : Do a broadcast on
12870 each of the known local interfaces listed in the <A
12879 parameter. This is the least reliable of the name resolution
12880 methods as it depends on the target host being on a locally
12881 connected subnet.</P
12887 >name resolve order = lmhosts host wins bcast
12893 >name resolve order = lmhosts bcast host
12897 >This will cause the local lmhosts file to be examined
12898 first, followed by a broadcast attempt, followed by a normal
12899 system hostname lookup.</P
12903 NAME="NETBIOSALIASES"
12905 >netbios aliases (G)</DT
12908 >This is a list of NetBIOS names that <A
12912 > will advertise as additional
12913 names by which the Samba server is known. This allows one machine
12914 to appear in browse lists under multiple names. If a machine is
12915 acting as a browse server or logon server none
12916 of these names will be advertised as either browse server or logon
12917 servers, only the primary name of the machine will be advertised
12918 with these capabilities.</P
12921 HREF="#NETBIOSNAME"
12933 >empty string (no additional names)</I
12938 >netbios aliases = TEST TEST1 TEST2</B
12945 >netbios name (G)</DT
12948 >This sets the NetBIOS name by which a Samba
12949 server is known. By default it is the same as the first component
12950 of the host's DNS name. If a machine is a browse server or
12951 logon server this name (or the first component
12952 of the hosts DNS name) will be the name that these services are
12953 advertised under.</P
12956 HREF="#NETBIOSALIASES"
12968 >machine DNS name</I
12973 >netbios name = MYNAME</B
12978 NAME="NETBIOSSCOPE"
12980 >netbios scope (G)</DT
12983 >This sets the NetBIOS scope that Samba will
12984 operate under. This should not be set unless every machine
12985 on your LAN also sets this value.</P
12991 >nis homedir (G)</DT
12994 >Get the home share server from a NIS map. For
12995 UNIX systems that use an automounter, the user's home directory
12996 will often be mounted on a workstation on demand from a remote
12999 >When the Samba logon server is not the actual home directory
13000 server, but is mounting the home directories via NFS then two
13001 network hops would be required to access the users home directory
13002 if the logon server told the client to use itself as the SMB server
13003 for home directories (one over SMB and one over NFS). This can
13006 >This option allows Samba to return the home share as
13007 being on a different server to the logon server and as
13008 long as a Samba daemon is running on the home directory server,
13009 it will be mounted on the Samba client directly from the directory
13010 server. When Samba is returning the home share to the client, it
13011 will consult the NIS map specified in <A
13019 > and return the server
13022 >Note that for this option to work there must be a working
13023 NIS system and the Samba server with this option must also
13024 be a logon server.</P
13028 >nis homedir = no</B
13033 NAME="NONUNIXACCOUNTRANGE"
13035 >non unix account range (G)</DT
13038 >The non unix account range parameter specifies
13039 the range of 'user ids' that are allocated by the various 'non unix
13040 account' passdb backends. These backends allow
13041 the storage of passwords for users who don't exist in /etc/passwd.
13042 This is most often used for machine account creation.
13043 This range of ids should have no existing local or NIS users within
13044 it as strange conflicts can occur otherwise.</P
13046 >NOTE: These userids never appear on the system and Samba will never
13047 'become' these users. They are used only to ensure that the algorithmic
13048 RID mapping does not conflict with normal users.
13053 >non unix account range = <empty string>
13059 >non unix account range = 10000-20000</B
13064 NAME="NTACLSUPPORT"
13066 >nt acl support (S)</DT
13069 >This boolean parameter controls whether
13074 > will attempt to map
13075 UNIX permissions into Windows NT access control lists.
13076 This parameter was formally a global parameter in releases
13081 >nt acl support = yes</B
13086 NAME="NTPIPESUPPORT"
13088 >nt pipe support (G)</DT
13091 >This boolean parameter controls whether
13096 > will allow Windows NT
13097 clients to connect to the NT SMB specific <TT
13101 pipes. This is a developer debugging option and can be left
13106 >nt pipe support = yes</B
13111 NAME="NTSTATUSSUPPORT"
13113 >nt status support (G)</DT
13116 >This boolean parameter controls whether <A
13120 > will negotiate NT specific status
13121 support with Windows NT/2k/XP clients. This is a developer
13122 debugging option and should be left alone.
13123 If this option is set to <TT
13126 > then Samba offers
13127 exactly the same DOS error codes that versions prior to Samba 2.2.3
13130 >You should not need to ever disable this parameter.</P
13134 >nt status support = yes</B
13139 NAME="NULLPASSWORDS"
13141 >null passwords (G)</DT
13144 >Allow or disallow client access to accounts
13145 that have null passwords. </P
13148 HREF="smbpasswd.5.html"
13155 >null passwords = no</B
13160 NAME="OBEYPAMRESTRICTIONS"
13162 >obey pam restrictions (G)</DT
13165 >When Samba 2.2 is configured to enable PAM support
13166 (i.e. --with-pam), this parameter will control whether or not Samba
13167 should obey PAM's account and session management directives. The
13168 default behavior is to use PAM for clear text authentication only
13169 and to ignore any account or session management. Note that Samba
13170 always ignores PAM for authentication in the case of <A
13171 HREF="#ENCRYPTPASSWORDS"
13175 >encrypt passwords = yes</I
13179 >. The reason is that PAM modules cannot support the challenge/response
13180 authentication mechanism needed in the presence of SMB password encryption.
13185 >obey pam restrictions = no</B
13195 >This is a boolean option that controls whether
13196 connections with usernames not in the <TT
13202 list will be allowed. By default this option is disabled so that a
13203 client can supply a username to be used by the server. Enabling
13204 this parameter will force the server to only use the login
13210 > list and is only really
13212 HREF="#SECURITYEQUALSSHARE"
13217 >Note that this also means Samba won't try to deduce
13218 usernames from the service name. This can be annoying for
13219 the [homes] section. To get around this you could use <B
13223 > which means your <TT
13229 will be just the service name, which for home directories is the
13230 name of the user.</P
13252 >only guest (S)</DT
13267 NAME="OPLOCKBREAKWAITTIME"
13269 >oplock break wait time (G)</DT
13272 >This is a tuning parameter added due to bugs in
13273 both Windows 9x and WinNT. If Samba responds to a client too
13274 quickly when that client issues an SMB that can cause an oplock
13275 break request, then the network client can fail and not respond
13276 to the break request. This tuning parameter (which is set in milliseconds)
13277 is the amount of time Samba will wait before sending an oplock break
13278 request to such (broken) clients.</P
13282 >DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
13283 AND UNDERSTOOD THE SAMBA OPLOCK CODE</I
13288 >oplock break wait time = 0</B
13293 NAME="OPLOCKCONTENTIONLIMIT"
13295 >oplock contention limit (S)</DT
13307 improve the efficiency of the granting of oplocks under multiple
13308 client contention for the same file.</P
13310 >In brief it specifies a number, which causes <A
13315 grant an oplock even when requested if the approximate number of
13316 clients contending for an oplock on the same file goes over this
13317 limit. This causes <B
13320 > to behave in a similar
13321 way to Windows NT.</P
13325 >DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
13326 AND UNDERSTOOD THE SAMBA OPLOCK CODE</I
13331 >oplock contention limit = 2</B
13341 >This boolean option tells <B
13345 issue oplocks (opportunistic locks) to file open requests on this
13346 share. The oplock code can dramatically (approx. 30% or more) improve
13347 the speed of access to files on Samba servers. It allows the clients
13348 to aggressively cache files locally and you may want to disable this
13349 option for unreliable network environments (it is turned on by
13350 default in Windows NT Servers). For more information see the file
13360 >Oplocks may be selectively turned off on certain files with a
13362 HREF="#VETOOPLOCKFILES"
13366 > veto oplock files</I
13369 > parameter. On some systems
13370 oplocks are recognized by the underlying operating system. This
13371 allows data synchronization between all access to oplocked files,
13372 whether it be via Samba or NFS or a local UNIX process. See the
13378 > parameter for details.</P
13381 HREF="#KERNELOPLOCKS"
13390 HREF="#LEVEL2OPLOCKS"
13394 > level2 oplocks</I
13411 >This parameter determines whether or not <A
13416 attempt to authenticate users using the NTLM password hash.
13417 If disabled, only the lanman password hashes will be used.
13420 >Please note that at least this option or <B
13423 > should be enabled in order to be able to log in.
13428 >ntlm auth = yes</B
13438 >This integer value controls what level Samba
13439 advertises itself as for browse elections. The value of this
13440 parameter determines whether <A
13445 has a chance of becoming a local master browser for the <TT
13450 > in the local broadcast area.</P
13455 >By default, Samba will win
13456 a local master browsing election over all Microsoft operating
13457 systems except a Windows NT 4.0/2000 Domain Controller. This
13458 means that a misconfigured Samba host can effectively isolate
13459 a subnet for browsing purposes. See <TT
13481 NAME="OS2DRIVERMAP"
13483 >os2 driver map (G)</DT
13486 >The parameter is used to define the absolute
13487 path to a file containing a mapping of Windows NT printer driver
13488 names to OS/2 printer driver names. The format is:</P
13490 ><nt driver name> = <os2 driver
13491 name>.<device name></P
13493 >For example, a valid entry using the HP LaserJet 5
13494 printer driver would appear as <B
13496 >HP LaserJet 5L = LASERJET.HP
13500 >The need for the file is due to the printer driver namespace
13501 problem described in the <A
13502 HREF="printer_driver2.html"
13506 >. For more details on OS/2 clients, please
13508 HREF="OS2-Client-HOWTO.html"
13512 > containing in the Samba documentation.</P
13516 >os2 driver map = <empty string>
13522 NAME="PAMPASSWORDCHANGE"
13524 >pam password change (G)</DT
13527 >With the addition of better PAM support in Samba 2.2,
13528 this parameter, it is possible to use PAM's password change control
13529 flag for Samba. If enabled, then PAM will be used for password
13530 changes when requested by an SMB client instead of the program listed in
13532 HREF="#PASSWDPROGRAM"
13540 It should be possible to enable this without changing your
13550 parameter for most setups.
13555 >pam password change = no</B
13562 >panic action (G)</DT
13565 >This is a Samba developer option that allows a
13566 system command to be called when either <A
13575 crashes. This is usually used to draw attention to the fact that
13576 a problem occurred.</P
13580 >panic action = <empty string></B
13585 >panic action = "/bin/sleep 90000"</B
13590 NAME="PARANOIDSERVERSECURITY"
13592 >paranoid server security (G)</DT
13595 >Some version of NT 4.x allow non-guest
13596 users with a bad passowrd. When this option is enabled, samba will not
13597 use a broken NT 4.x server as password server, but instead complain
13598 to the logs and exit.
13603 >paranoid server security = yes</B
13608 NAME="PASSDBBACKEND"
13610 >passdb backend (G)</DT
13613 >This option allows the administrator to chose which backends to retrieve and store passwords with. This allows (for example) both
13614 smbpasswd and tdbsam to be used without a recompile.
13615 Multiple backends can be specified, separated by spaces. The backends will be searched in the order they are specified. New users are always added to the first backend specified.
13616 Experimental backends must still be selected
13617 (eg --with-tdbsam) at configure time.
13620 >This parameter is in two parts, the backend's name, and a 'location'
13621 string that has meaning only to that particular backed. These are separated
13622 by a : character.</P
13624 >Available backends can include:
13633 > - The default smbpasswd
13634 backend. Takes a path to the smbpasswd file as an optional argument.</P
13642 backend, but with support for 'not unix accounts'.
13643 Takes a path to the smbpasswd file as an optional argument.</P
13646 HREF="#NONUNIXACCOUNTRANGE"
13650 >non unix account range</I
13660 > - The TDB based password storage
13661 backend. Takes a path to the TDB as an optional argument (defaults to passdb.tdb
13677 > - The TDB based password storage
13678 backend, with non unix account support. Takes a path to the TDB as an optional argument (defaults to passdb.tdb
13690 HREF="#NONUNIXACCOUNTRANGE"
13694 >non unix account range</I
13704 > - The LDAP based passdb
13705 backend. Takes an LDAP URL as an optional argument (defaults to
13708 >ldap://localhost</B
13716 > - The LDAP based passdb
13717 backend, with non unix account support. Takes an LDAP URL as an optional argument (defaults to
13720 >ldap://localhost</B
13723 >Note: In this module, any account without a matching POSIX account is regarded
13727 HREF="#NONUNIXACCOUNTRANGE"
13737 >LDAP connections should be secured where
13738 possible. This may be done using either
13762 > - The NIS+ based passdb backend. Takes name NIS domain as an optional argument. Only works with sun NIS+ servers. </P
13769 > - Allows Samba to load an
13770 arbitary passdb backend from the .so specified as a compulsary argument.
13773 >Any characters after the (optional) second : are passed to the plugin
13774 for its own processing</P
13781 > - (EXPERIMENTAL) Allows samba to map all (other) available unix users</P
13783 >This backend uses the standard unix database for retrieving users. Users included
13784 in this pdb are NOT listed in samba user listings and users included in this pdb won't be
13785 able to login. The use of this backend is to always be able to display the owner of a file
13786 on the samba server - even when the user doesn't have a 'real' samba account in one of the
13787 other passdb backends.
13790 >This backend should always be the last backend listed, since it contains all users in
13791 the unix passdb and might 'override' mappings if specified earlier. It's meant to only return
13792 accounts for users that aren't covered by the previous backends.</P
13800 >passdb backend = smbpasswd guest</B
13805 >passdb backend = tdbsam:/etc/samba/private/passdb.tdb smbpasswd:/etc/samba/smbpasswd </B
13810 >passdb backend = ldapsam_nua:ldaps://ldap.example.com </B
13815 >passdb backend = plugin:/usr/local/samba/lib/my_passdb.so:my_plugin_args tdbsam:/etc/samba/private/passdb.tdb</B
13822 >passwd chat (G)</DT
13825 >This string controls the <I
13829 conversation that takes places between <A
13833 > and the local password changing
13834 program to change the user's password. The string describes a
13835 sequence of response-receive pairs that <A
13839 > uses to determine what to send to the
13841 HREF="#PASSWDPROGRAM"
13849 > and what to expect back. If the expected output is not
13850 received then the password is not changed.</P
13852 >This chat sequence is often quite site specific, depending
13853 on what local methods are used for password control (such as NIS
13856 >Note that this parameter only is only used if the <A
13857 HREF="#UNIXPASSWORDSYNC"
13865 > parameter is set to <TT
13869 sequence is then called <I
13872 > when the SMB password
13873 in the smbpasswd file is being changed, without access to the old
13874 password cleartext. This means that root must be able to reset the user's password
13875 without knowing the text of the previous password. In the presence of NIS/YP,
13876 this means that the <A
13877 HREF="#PASSWDPROGRAM"
13880 executed on the NIS master.
13883 >The string can contain the macro <TT
13888 > which is substituted
13889 for the new password. The chat sequence can also contain the standard
13902 > to give line-feed,
13903 carriage-return, tab and space. The chat sequence string can also contain
13904 a '*' which matches any sequence of characters.
13905 Double quotes can be used to collect strings with spaces
13906 in them into a single string.</P
13908 >If the send string in any part of the chat sequence
13909 is a full stop ".", then no string is sent. Similarly,
13910 if the expect string is a full stop then no string is expected.</P
13913 HREF="#PAMPASSWORDCHANGE"
13921 > parameter is set to <TT
13925 may be matched in any order, and success is determined by the PAM result,
13926 not any particular output. The \n macro is ignored for PAM conversions.
13930 HREF="#UNIXPASSWORDSYNC"
13939 HREF="#PASSWDPROGRAM"
13943 > passwd program</I
13947 HREF="#PASSWDCHATDEBUG"
13951 >passwd chat debug</I
13955 HREF="#PAMPASSWORDCHANGE"
13959 >pam password change</I
13966 >passwd chat = *new*password* %n\n
13967 *new*password* %n\n *changed*</B
13972 >passwd chat = "*Enter OLD password*" %o\n
13973 "*Enter NEW password*" %n\n "*Reenter NEW password*" %n\n "*Password
13979 NAME="PASSWDCHATDEBUG"
13981 >passwd chat debug (G)</DT
13984 >This boolean specifies if the passwd chat script
13985 parameter is run in <I
13988 > mode. In this mode the
13989 strings passed to and received from the passwd chat are printed
14004 of 100. This is a dangerous option as it will allow plaintext passwords
14005 to be seen in the <B
14008 > log. It is available to help
14009 Samba admins debug their <TT
14015 when calling the <TT
14021 be turned off after this has been done. This option has no effect if the
14023 HREF="#PAMPASSWORDCHANGE"
14027 >pam password change</I
14031 paramter is set. This parameter is off by default.</P
14043 HREF="#PAMPASSWORDCHANGE"
14047 >pam password change</I
14052 HREF="#PASSWDPROGRAM"
14064 >passwd chat debug = no</B
14069 NAME="PASSWDPROGRAM"
14071 >passwd program (G)</DT
14074 >The name of a program that can be used to set
14075 UNIX user passwords. Any occurrences of <TT
14081 will be replaced with the user name. The user name is checked for
14082 existence before calling the password changing program.</P
14084 >Also note that many passwd programs insist in <I
14088 > passwords, such as a minimum length, or the inclusion
14089 of mixed case chars and digits. This can pose a problem as some clients
14090 (such as Windows for Workgroups) uppercase the password before sending
14102 > parameter is set to <TT
14106 > then this program is called <I
14110 before the SMB password in the <A
14111 HREF="smbpasswd.5.html"
14115 > file is changed. If this UNIX password change fails, then
14119 > will fail to change the SMB password also
14120 (this is by design).</P
14125 >unix password sync</I
14128 is set this parameter <I
14130 >MUST USE ABSOLUTE PATHS</I
14135 > programs called, and must be examined
14136 for security implications. Note that by default <TT
14148 HREF="#UNIXPASSWORDSYNC"
14160 >passwd program = /bin/passwd</B
14165 >passwd program = /sbin/npasswd %u</B
14171 NAME="PASSWORDLEVEL"
14173 >password level (G)</DT
14176 >Some client/server combinations have difficulty
14177 with mixed-case passwords. One offending client is Windows for
14178 Workgroups, which for some reason forces passwords to upper
14179 case when using the LANMAN1 protocol, but leaves them alone when
14180 using COREPLUS! Another problem child is the Windows 95/98
14181 family of operating systems. These clients upper case clear
14182 text passwords even when NT LM 0.12 selected by the protocol
14183 negotiation request/response.</P
14185 >This parameter defines the maximum number of characters
14186 that may be upper case in passwords.</P
14188 >For example, say the password given was "FRED". If <TT
14191 > password level</I
14193 > is set to 1, the following combinations
14194 would be tried if "FRED" failed:</P
14196 >"Fred", "fred", "fRed", "frEd","freD"</P
14204 the following combinations would also be tried: </P
14206 >"FRed", "FrEd", "FreD", "fREd", "fReD", "frED", ..</P
14210 >The higher value this parameter is set to the more likely
14211 it is that a mixed case password will be matched against a single
14212 case password. However, you should be aware that use of this
14213 parameter reduces security and increases the time taken to
14214 process a new connection.</P
14216 >A value of zero will cause only two attempts to be
14217 made - the password as is and the password in all-lower case.</P
14221 >password level = 0</B
14226 >password level = 4</B
14231 NAME="PASSWORDSERVER"
14233 >password server (G)</DT
14236 >By specifying the name of another SMB server (such
14237 as a WinNT box) with this option, and using <B
14243 >security = server</B
14244 > you can get Samba
14245 to do all its username/password validation via a remote server.</P
14247 >This option sets the name of the password server to use.
14248 It must be a NetBIOS name, so if the machine's NetBIOS name is
14249 different from its Internet name then you may have to add its NetBIOS
14250 name to the lmhosts file which is stored in the same directory
14256 >The name of the password server is looked up using the
14258 HREF="#NAMERESOLVEORDER"
14266 > and so may resolved
14267 by any method and order described in that parameter.</P
14269 >The password server must be a machine capable of using
14270 the "LM1.2X002" or the "NT LM 0.12" protocol, and it must be in
14271 user level security mode.</P
14276 > Using a password server
14277 means your UNIX box (running Samba) is only as secure as your
14278 password server. <I
14280 >DO NOT CHOOSE A PASSWORD SERVER THAT
14281 YOU DON'T COMPLETELY TRUST</I
14284 >Never point a Samba server at itself for password
14285 serving. This will cause a loop and could lock up your Samba
14288 >The name of the password server takes the standard
14289 substitutions, but probably the only useful one is <TT
14295 >, which means the Samba server will use the incoming
14296 client as the password server. If you use this then you better
14297 trust your clients, and you had better restrict them with hosts allow!</P
14304 > parameter is set to
14308 >, then the list of machines in this
14309 option must be a list of Primary or Backup Domain controllers for the
14310 Domain or the character '*', as the Samba server is effectively
14311 in that domain, and will use cryptographically authenticated RPC calls
14312 to authenticate the user logging on. The advantage of using <B
14314 > security = domain</B
14315 > is that if you list several hosts in the
14319 >password server</I
14325 > will try each in turn till it finds one that responds. This
14326 is useful in case your primary server goes down.</P
14331 >password server</I
14334 to the character '*', then Samba will attempt to auto-locate the
14335 Primary or Backup Domain controllers to authenticate against by
14336 doing a query for the name <TT
14338 >WORKGROUP<1C></TT
14340 and then contacting each server returned in the list of IP
14341 addresses from the name resolution source. </P
14343 >If the list of servers contains both names and the '*'
14344 character, the list is treated as a list of preferred
14345 domain controllers, but an auto lookup of all remaining DC's
14346 will be added to the list as well. Samba will not attempt to optimize
14347 this list by locating the closest DC.</P
14358 >, then there are different
14359 restrictions that <B
14361 >security = domain</B
14369 >You may list several password servers in
14373 >password server</I
14375 > parameter, however if an
14379 > makes a connection to a password server,
14380 and then the password server fails, no more users will be able
14381 to be authenticated from this <B
14385 restriction of the SMB/CIFS protocol when in <B
14389 > mode and cannot be fixed in Samba.</P
14393 >If you are using a Windows NT server as your
14394 password server then you will have to ensure that your users
14395 are able to login from the Samba server, as when in <B
14397 > security = server</B
14398 > mode the network logon will appear to
14399 come from there rather than from the users workstation.</P
14416 >password server = <empty string></B
14422 >password server = NT-PDC, NT-BDC1, NT-BDC2, *
14428 >password server = *</B
14438 >This parameter specifies a directory to which
14439 the user of the service is to be given access. In the case of
14440 printable services, this is where print data will spool prior to
14441 being submitted to the host for printing.</P
14443 >For a printable service offering guest access, the service
14444 should be readonly and the path should be world-writeable and
14445 have the sticky bit set. This is not mandatory of course, but
14446 you probably won't get the results you expect if you do
14449 >Any occurrences of <TT
14455 will be replaced with the UNIX username that the client is using
14456 on this connection. Any occurrences of <TT
14462 will be replaced by the NetBIOS name of the machine they are
14463 connecting from. These replacements are very useful for setting
14464 up pseudo home directories for users.</P
14466 >Note that this path will be based on <A
14474 > if one was specified.</P
14483 >path = /home/fred</B
14488 NAME="PIDDIRECTORY"
14490 >pid directory (G)</DT
14493 >This option specifies the directory where pid
14494 files will be placed. </P
14498 >pid directory = ${prefix}/var/locks</B
14503 >pid directory = /var/run/</B
14509 NAME="POSIXLOCKING"
14511 >posix locking (S)</DT
14522 daemon maintains an database of file locks obtained by SMB clients.
14523 The default behavior is to map this internal database to POSIX
14524 locks. This means that file locks obtained by SMB clients are
14525 consistent with those seen by POSIX compliant applications accessing
14526 the files via a non-SMB method (e.g. NFS or local file access).
14527 You should never need to disable this parameter.</P
14531 >posix locking = yes</B
14541 >This option specifies a command to be run
14542 whenever the service is disconnected. It takes the usual
14543 substitutions. The command may be run as the root on some
14546 >An interesting example may be to unmount server
14551 >postexec = /etc/umount /cdrom</B
14567 >none (no command executed)</I
14573 >postexec = echo \"%u disconnected from %S
14574 from %m (%I)\" >> /tmp/log</B
14581 >postscript (S)</DT
14584 >This parameter forces a printer to interpret
14585 the print files as PostScript. This is done by adding a <TT
14589 > to the start of print output.</P
14591 >This is most useful when you have lots of PCs that persist
14592 in putting a control-D at the start of print jobs, which then
14593 confuses your printer.</P
14597 >postscript = no</B
14607 >This option specifies a command to be run whenever
14608 the service is connected to. It takes the usual substitutions.</P
14610 >An interesting example is to send the users a welcome
14611 message every time they log in. Maybe a message of the day? Here
14616 >preexec = csh -c 'echo \"Welcome to %S!\" |
14617 /usr/local/samba/bin/smbclient -M %m -I %I' & </B
14620 >Of course, this could get annoying after a while :-)</P
14623 HREF="#PREEXECCLOSE"
14644 >none (no command executed)</I
14649 >preexec = echo \"%u connected to %S from %m
14650 (%I)\" >> /tmp/log</B
14655 NAME="PREEXECCLOSE"
14657 >preexec close (S)</DT
14660 >This boolean option controls whether a non-zero
14661 return code from <A
14670 > should close the service being connected to.</P
14674 >preexec close = no</B
14679 NAME="PREFERREDMASTER"
14681 >preferred master (G)</DT
14684 >This boolean parameter controls if <A
14688 > is a preferred master browser
14689 for its workgroup.</P
14691 >If this is set to <TT
14698 will force an election, and it will have a slight advantage in
14699 winning the election. It is recommended that this parameter is
14700 used in conjunction with <B
14703 HREF="#DOMAINMASTER"
14714 > can guarantee becoming a domain master.</P
14716 >Use this option with caution, because if there are several
14717 hosts (whether Samba servers, Windows 95 or NT) that are preferred
14718 master browsers on the same subnet, they will each periodically
14719 and continuously attempt to become the local master browser.
14720 This will result in unnecessary broadcast traffic and reduced browsing
14736 >preferred master = auto</B
14741 NAME="PREFEREDMASTER"
14743 >prefered master (G)</DT
14747 HREF="#PREFERREDMASTER"
14751 > preferred master</I
14754 > for people who cannot spell :-).</P
14763 >This is a list of services that you want to be
14764 automatically added to the browse lists. This is most useful
14765 for homes and printers services that would otherwise not be
14768 >Note that if you just want all printers in your
14769 printcap file loaded then the <A
14770 HREF="#LOADPRINTERS"
14777 > option is easier.</P
14781 >no preloaded services</I
14786 >preload = fred lp colorlp</B
14791 NAME="PRESERVECASE"
14793 >preserve case (S)</DT
14796 > This controls if new filenames are created
14797 with the case that the client passes, or if they are forced to
14799 HREF="#DEFAULTCASE"
14811 >preserve case = yes</B
14814 >See the section on <A
14818 > for a fuller discussion.</P
14822 NAME="PRINTCOMMAND"
14824 >print command (S)</DT
14827 >After a print job has finished spooling to
14828 a service, this command will be used via a <B
14832 call to process the spool file. Typically the command specified will
14833 submit the spool file to the host's printing subsystem, but there
14834 is no requirement that this be the case. The server will not remove
14835 the spool file, so whatever command you specify should remove the
14836 spool file when it has been processed, otherwise you will need to
14837 manually remove old spool files.</P
14839 >The print command is simply a text string. It will be used
14840 verbatim after macro substitutions have been made:</P
14842 >s, %p - the path to the spool
14845 >%p - the appropriate printer
14849 name as transmitted by the client.</P
14851 >%c - The number of printed pages
14852 of the spooled job (if known).</P
14854 >%z - the size of the spooled
14855 print job (in bytes)</P
14857 >The print command <I
14861 one occurrence of <TT
14877 > is optional. At the time
14878 a job is submitted, if no printer name is supplied the <TT
14884 > will be silently removed from the printer command.</P
14886 >If specified in the [global] section, the print command given
14887 will be used for any printable service that does not have its own
14888 print command specified.</P
14890 >If there is neither a specified print command for a
14891 printable service nor a global print command, spool files will
14892 be created but not processed and (most importantly) not removed.</P
14894 >Note that printing may fail on some UNIXes from the
14898 > account. If this happens then create
14899 an alternative guest account that can print and set the <A
14900 HREF="#GUESTACCOUNT"
14908 in the [global] section.</P
14910 >You can form quite complex print commands by realizing
14911 that they are just passed to a shell. For example the following
14912 will log a print job, print the file, then remove it. Note that
14913 ';' is the usual separator for command in shell scripts.</P
14917 >print command = echo Printing %s >>
14918 /tmp/print.log; lpr -P %p %s; rm %s</B
14921 >You may have to vary this command considerably depending
14922 on how you normally print files on your system. The default for
14923 the parameter varies depending on the setting of the <A
14935 >printing = BSD, AIX, QNX, LPRNG
14941 >print command = lpr -r -P%p %s</B
14946 >printing = SYSV or HPUX :</B
14951 >print command = lp -c -d%p %s; rm %s</B
14956 >printing = SOFTQ :</B
14961 >print command = lp -d%p -s %s; rm %s</B
14964 >For printing = CUPS : If SAMBA is compiled against
14967 >printcap = cups</A
14969 uses the CUPS API to
14970 submit jobs, etc. Otherwise it maps to the System V
14971 commands with the -oraw option for printing, i.e. it
14974 >lp -c -d%p -oraw; rm %s</B
14978 >printing = cups</B
14980 and if SAMBA is compiled against libcups, any manually
14981 set print command will be ignored.</P
14985 >print command = /usr/local/samba/bin/myprintscript
15013 >If this parameter is <TT
15017 clients may open, write to and submit spool files on the directory
15018 specified for the service. </P
15020 >Note that a printable service will ALWAYS allow writing
15021 to the service path (user privileges permitting) via the spooling
15022 of print data. The <A
15031 > parameter controls only non-printing access to
15047 HREF="#PRINTCAPNAME"
15058 NAME="PRINTCAPNAME"
15060 >printcap name (G)</DT
15063 >This parameter may be used to override the
15064 compiled-in default printcap name used by the server (usually <TT
15066 > /etc/printcap</TT
15067 >). See the discussion of the <A
15070 > section above for reasons
15071 why you might want to do this.</P
15073 >To use the CUPS printing interface set <B
15075 >printcap name = cups
15077 >. This should be supplemented by an addtional setting
15080 >printing = cups</A
15084 >printcap name = cups</B
15086 "dummy" printcap created by CUPS, as specified in your CUPS
15087 configuration file.
15090 >On System V systems that use <B
15094 list available printers you can use <B
15096 >printcap name = lpstat
15098 > to automatically obtain lists of available printers. This
15099 is the default for systems that define SYSV at configure time in
15100 Samba (this includes most System V based systems). If <TT
15109 these systems then Samba will launch <B
15113 attempt to parse the output to obtain a printer list.</P
15115 >A minimal printcap file would look something like this:</P
15124 CLASS="PROGRAMLISTING"
15125 > print1|My Printer 1
15126 print2|My Printer 2
15127 print3|My Printer 3
15128 print4|My Printer 4
15129 print5|My Printer 5
15136 >where the '|' separates aliases of a printer. The fact
15137 that the second alias has a space in it gives a hint to Samba
15138 that it's a comment.</P
15143 >: Under AIX the default printcap
15147 >. Samba will assume the
15151 > format if the string
15155 > appears in the printcap filename.</P
15159 >printcap name = /etc/printcap</B
15164 >printcap name = /etc/myprintcap</B
15169 NAME="PRINTERADMIN"
15171 >printer admin (S)</DT
15174 >This is a list of users that can do anything to
15175 printers via the remote administration interfaces offered by MS-RPC
15176 (usually using a NT workstation). Note that the root user always
15177 has admin rights.</P
15181 >printer admin = <empty string></B
15187 >printer admin = admin, @staff</B
15192 NAME="PRINTERDRIVER"
15194 >printer driver (S)</DT
15200 >This is a deprecated
15201 parameter and will be removed in the next major release
15202 following version 2.2. Please see the instructions in
15204 HREF="printer_driver2.html"
15206 >Samba 2.2. Printing
15208 > for more information
15209 on the new method of loading printer drivers onto a Samba server.
15212 >This option allows you to control the string
15213 that clients receive when they ask the server for the printer driver
15214 associated with a printer. If you are using Windows95 or Windows NT
15215 then you can use this to automate the setup of printers on your
15218 >You need to set this parameter to the exact string (case
15219 sensitive) that describes the appropriate printer driver for your
15220 system. If you don't know the exact string to use then you should
15221 first try with no <A
15222 HREF="#PRINTERDRIVER"
15226 > printer driver</I
15229 > option set and the client will
15230 give you a list of printer drivers. The appropriate strings are
15231 shown in a scroll box after you have chosen the printer manufacturer.</P
15234 HREF="#PRINTERDRIVERFILE"
15246 >printer driver = HP LaserJet 4L</B
15251 NAME="PRINTERDRIVERFILE"
15253 >printer driver file (G)</DT
15259 >This is a deprecated
15260 parameter and will be removed in the next major release
15261 following version 2.2. Please see the instructions in
15263 HREF="printer_driver2.html"
15265 >Samba 2.2. Printing
15267 > for more information
15268 on the new method of loading printer drivers onto a Samba server.
15271 >This parameter tells Samba where the printer driver
15272 definition file, used when serving drivers to Windows 95 clients, is
15273 to be found. If this is not set, the default is :</P
15278 CLASS="REPLACEABLE"
15280 >SAMBA_INSTALL_DIRECTORY</I
15283 /lib/printers.def</TT
15286 >This file is created from Windows 95 <TT
15290 > files found on the Windows 95 client system. For more
15291 details on setting up serving of printer drivers to Windows 95
15292 clients, see the outdated documentation file in the <TT
15298 >PRINTER_DRIVER.txt</TT
15302 HREF="#PRINTERDRIVERLOCATION"
15306 > printer driver location</I
15313 >None (set in compile).</I
15318 >printer driver file =
15319 /usr/local/samba/printers/drivers.def</B
15324 NAME="PRINTERDRIVERLOCATION"
15326 >printer driver location (S)</DT
15332 >This is a deprecated
15333 parameter and will be removed in the next major release
15334 following version 2.2. Please see the instructions in
15336 HREF="printer_driver2.html"
15338 >Samba 2.2. Printing
15340 > for more information
15341 on the new method of loading printer drivers onto a Samba server.
15344 >This parameter tells clients of a particular printer
15345 share where to find the printer driver files for the automatic
15346 installation of drivers for Windows 95 machines. If Samba is set up
15347 to serve printer drivers to Windows 95 machines, this should be set to</P
15351 >\\MACHINE\PRINTER$</B
15354 >Where MACHINE is the NetBIOS name of your Samba server,
15355 and PRINTER$ is a share you set up for serving printer driver
15356 files. For more details on setting this up see the outdated documentation
15362 > PRINTER_DRIVER.txt</TT
15366 HREF="#PRINTERDRIVERFILE"
15370 > printer driver file</I
15382 >printer driver location = \\MACHINE\PRINTER$
15390 >printer name (S)</DT
15393 >This parameter specifies the name of the printer
15394 to which print jobs spooled through a printable service will be sent.</P
15396 >If specified in the [global] section, the printer
15397 name given will be used for any printable service that does
15398 not have its own printer name specified.</P
15402 >none (but may be <TT
15406 on many systems)</I
15411 >printer name = laserwriter</B
15422 HREF="#PRINTERNAME"
15438 >This parameters controls how printer status
15439 information is interpreted on your system. It also affects the
15440 default values for the <TT
15460 >lpresume command</I
15468 > if specified in the
15469 [global] section.</P
15471 >Currently nine printing styles are supported. They are
15505 >To see what the defaults are for the other print
15506 commands when using the various options use the <A
15507 HREF="testparm.1.html"
15512 >This option can be set on a per printer basis</P
15514 >See also the discussion in the <A
15523 >private dir (G)</DT
15526 >This parameters defines the directory
15527 smbd will use for storing such files as <TT
15539 >private dir = ${prefix}/private</B
15550 HREF="#MAXPROTOCOL"
15579 NAME="QUEUEPAUSECOMMAND"
15581 >queuepause command (S)</DT
15584 >This parameter specifies the command to be
15585 executed on the server host in order to pause the printer queue.</P
15587 >This command should be a program or script which takes
15588 a printer name as its only parameter and stops the printer queue,
15589 such that no longer jobs are submitted to the printer.</P
15591 >This command is not supported by Windows for Workgroups,
15592 but can be issued from the Printers window under Windows 95
15600 > is given then the printer name
15601 is put in its place. Otherwise it is placed at the end of the command.
15604 >Note that it is good practice to include the absolute
15605 path in the command as the PATH may not be available to the
15610 >depends on the setting of <TT
15621 >queuepause command = disable %p</B
15626 NAME="QUEUERESUMECOMMAND"
15628 >queueresume command (S)</DT
15631 >This parameter specifies the command to be
15632 executed on the server host in order to resume the printer queue. It
15633 is the command to undo the behavior that is caused by the
15634 previous parameter (<A
15635 HREF="#QUEUEPAUSECOMMAND"
15639 > queuepause command</I
15644 >This command should be a program or script which takes
15645 a printer name as its only parameter and resumes the printer queue,
15646 such that queued jobs are resubmitted to the printer.</P
15648 >This command is not supported by Windows for Workgroups,
15649 but can be issued from the Printers window under Windows 95
15657 > is given then the printer name
15658 is put in its place. Otherwise it is placed at the end of the
15661 >Note that it is good practice to include the absolute
15662 path in the command as the PATH may not be available to the
15667 >depends on the setting of <A
15681 >queuepause command = enable %p
15692 >This boolean parameter controls whether <A
15696 > will support the "Read
15697 Block Multiplex" SMB. This is now rarely used and defaults to
15701 >. You should never need to set this
15716 >This is a list of users that are given read-only
15717 access to a service. If the connecting user is in this list then
15718 they will not be given write access, no matter what the <A
15727 option is set to. The list can include group names using the
15728 syntax described in the <A
15729 HREF="#INVALIDUSERS"
15746 > parameter and the <A
15747 HREF="#INVALIDUSERS"
15759 >read list = <empty string></B
15764 >read list = mary, @students</B
15774 >An inverted synonym is <A
15784 >If this parameter is <TT
15788 of a service may not create or modify files in the service's
15791 >Note that a printable service (<B
15793 >printable = yes</B
15798 > allow writing to the directory
15799 (user privileges permitting), but only via spooling operations.</P
15803 >read only = yes</B
15813 >This parameter controls whether or not the server
15814 will support the raw read SMB requests when transferring data
15817 >If enabled, raw reads allow reads of 65535 bytes in
15818 one packet. This typically provides a major performance benefit.
15821 >However, some clients either negotiate the allowable
15822 block size incorrectly or are incapable of supporting larger block
15823 sizes, and for these clients you may need to disable raw reads.</P
15825 >In general this parameter should be viewed as a system tuning
15826 tool and left severely alone. See also <A
15854 affects the overlap of disk reads/writes with network reads/writes.
15855 If the amount of data being transferred in several of the SMB
15856 commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger
15857 than this value then the server begins writing the data before it
15858 has received the whole packet from the network, or in the case of
15859 SMBreadbraw, it begins writing to the network before all the data
15860 has been read from disk.</P
15862 >This overlapping works best when the speeds of disk and
15863 network access are similar, having very little effect when the
15864 speed of one is much greater than the other.</P
15866 >The default value is 16384, but very little experimentation
15867 has been done yet to determine the optimal value, and it is likely
15868 that the best value will vary greatly between systems anyway.
15869 A value over 65536 is pointless and will cause you to allocate
15870 memory unnecessarily.</P
15874 >read size = 16384</B
15879 >read size = 8192</B
15889 > This option specifies the kerberos realm to use. The realm is
15890 used as the ADS equivalent of the NT4<B
15894 is usually set to the DNS name of the kerberos server.
15904 >realm = mysambabox.mycompany.com</B
15909 NAME="REMOTEANNOUNCE"
15911 >remote announce (G)</DT
15914 >This option allows you to setup <A
15918 > to periodically announce itself
15919 to arbitrary IP addresses with an arbitrary workgroup name.</P
15921 >This is useful if you want your Samba server to appear
15922 in a remote workgroup for which the normal browse propagation
15923 rules don't work. The remote workgroup can be anywhere that you
15924 can send IP packets to.</P
15930 >remote announce = 192.168.2.255/SERVERS
15931 192.168.4.255/STAFF</B
15934 >the above line would cause <B
15937 > to announce itself
15938 to the two given IP addresses using the given workgroup names.
15939 If you leave out the workgroup name then the one given in
15949 parameter is used instead.</P
15951 >The IP addresses you choose would normally be the broadcast
15952 addresses of the remote networks, but can also be the IP addresses
15953 of known browse masters if your network config is that stable.</P
15955 >See the documentation file <TT
15966 >remote announce = <empty string>
15972 NAME="REMOTEBROWSESYNC"
15974 >remote browse sync (G)</DT
15977 >This option allows you to setup <A
15981 > to periodically request
15982 synchronization of browse lists with the master browser of a Samba
15983 server that is on a remote segment. This option will allow you to
15984 gain browse lists for multiple workgroups across routed networks. This
15985 is done in a manner that does not work with any non-Samba servers.</P
15987 >This is useful if you want your Samba server and all local
15988 clients to appear in a remote workgroup for which the normal browse
15989 propagation rules don't work. The remote workgroup can be anywhere
15990 that you can send IP packets to.</P
15996 >remote browse sync = 192.168.2.255 192.168.4.255
16000 >the above line would cause <B
16004 the master browser on the specified subnets or addresses to
16005 synchronize their browse lists with the local server.</P
16007 >The IP addresses you choose would normally be the broadcast
16008 addresses of the remote networks, but can also be the IP addresses
16009 of known browse masters if your network config is that stable. If
16010 a machine IP address is given Samba makes NO attempt to validate
16011 that the remote machine is available, is listening, nor that it
16012 is in fact the browse master on its segment.</P
16016 >remote browse sync = <empty string>
16022 NAME="RESTRICTANONYMOUS"
16024 >restrict anonymous (G)</DT
16027 >This is a integer parameter, and
16028 mirrors as much as possible the functinality the
16031 >RestrictAnonymous</TT
16033 registry key does on NT/Win2k. </P
16037 >restrict anonymous = 0</B
16048 HREF="#ROOTDIRECTORY"
16052 >root directory"</I
16065 HREF="#ROOTDIRECTORY"
16069 >root directory"</I
16076 NAME="ROOTDIRECTORY"
16078 >root directory (G)</DT
16081 >The server will <B
16085 Change its root directory) to this directory on startup. This is
16086 not strictly necessary for secure operation. Even without it the
16087 server will deny access to files not in one of the service entries.
16088 It may also check for, and deny access to, soft links to other
16089 parts of the filesystem, or attempts to use ".." in file names
16090 to access other directories (depending on the setting of the <A
16107 than "/" adds an extra level of security, but at a price. It
16108 absolutely ensures that no access is given to files not in the
16109 sub-tree specified in the <TT
16118 > some files needed for
16119 complete operation of the server. To maintain full operability
16120 of the server you will need to mirror some system files
16126 > tree. In particular
16127 you will need to mirror <TT
16131 subset of it), and any binaries or configuration files needed for
16132 printing (if required). The set of files that must be mirrored is
16133 operating system dependent.</P
16137 >root directory = /</B
16142 >root directory = /homes/smb</B
16147 NAME="ROOTPOSTEXEC"
16149 >root postexec (S)</DT
16152 >This is the same as the <TT
16158 parameter except that the command is run as root. This
16159 is useful for unmounting filesystems
16160 (such as CDROMs) after a connection is closed.</P
16174 >root postexec = <empty string>
16182 >root preexec (S)</DT
16185 >This is the same as the <TT
16191 parameter except that the command is run as root. This
16192 is useful for mounting filesystems (such as CDROMs) when a
16193 connection is opened.</P
16204 HREF="#PREEXECCLOSE"
16215 >root preexec = <empty string>
16221 NAME="ROOTPREEXECCLOSE"
16223 >root preexec close (S)</DT
16226 >This is the same as the <TT
16232 > parameter except that the command is run as root.</P
16243 HREF="#PREEXECCLOSE"
16254 >root preexec close = no</B
16264 >This option affects how clients respond to
16265 Samba and is one of the most important settings in the <TT
16270 >The option sets the "security mode bit" in replies to
16271 protocol negotiations with <A
16276 > to turn share level security on or off. Clients decide
16277 based on this bit whether (and how) to transfer user and password
16278 information to the server.</P
16282 >security = user</B
16284 the most common setting needed when talking to Windows 98 and
16287 >The alternatives are <B
16289 >security = share</B
16293 >security = server</B
16300 >In versions of Samba prior to 2.0.0, the default was
16303 >security = share</B
16304 > mainly because that was
16305 the only option at one stage.</P
16307 >There is a bug in WfWg that has relevance to this
16308 setting. When in user or server level security a WfWg client
16309 will totally ignore the password you type in the "connect
16310 drive" dialog box. This makes it very difficult (if not impossible)
16311 to connect to a Samba service as anyone except the user that
16312 you are logged into WfWg as.</P
16314 >If your PCs use usernames that are the same as their
16315 usernames on the UNIX machine then you will want to use
16318 >security = user</B
16319 >. If you mostly use usernames
16320 that don't exist on the UNIX box then use <B
16326 >You should also use <B
16328 >security = share</B
16330 want to mainly setup shares without a password (guest shares). This
16331 is commonly used for a shared printer server. It is more difficult
16332 to setup guest shares with <B
16334 >security = user</B
16345 >parameter for details.</P
16347 >It is possible to use <B
16353 > where it is offers both user and share
16354 level security under different <A
16355 HREF="#NETBIOSALIASES"
16359 >NetBIOS aliases</I
16364 >The different settings will now be explained.</P
16367 NAME="SECURITYEQUALSSHARE"
16375 >When clients connect to a share level security server they
16376 need not log onto the server with a valid username and password before
16377 attempting to connect to a shared resource (although modern clients
16378 such as Windows 95/98 and Windows NT will send a logon request with
16379 a username but no password when talking to a <B
16383 > server). Instead, the clients send authentication information
16384 (passwords) on a per-share basis, at the time they attempt to connect
16394 uses a valid UNIX user to act on behalf of the client, even in
16397 >security = share</B
16398 > level security.</P
16400 >As clients are not required to send a username to the server
16401 in share level security, <B
16405 techniques to determine the correct UNIX user to use on behalf
16408 >A list of possible UNIX usernames to match with the given
16409 client password is constructed using the following methods :</P
16424 > parameter is set, then all the other
16425 stages are missed and only the <A
16426 HREF="#GUESTACCOUNT"
16433 > username is checked.
16438 >Is a username is sent with the share connection
16439 request, then this username (after mapping - see <A
16440 HREF="#USERNAMEMAP"
16448 is added as a potential username.</P
16452 >If the client did a previous <I
16456 > request (the SessionSetup SMB call) then the
16457 username sent in this SMB will be added as a potential username.
16462 >The name of the service the client requested is
16463 added as a potential username.</P
16467 >The NetBIOS name of the client is added to
16468 the list as a potential username.</P
16472 >Any users on the <A
16480 > list are added as potential usernames.
16491 not set, then this list is then tried with the supplied password.
16492 The first user for whom the password matches will be used as the
16501 set, or no username can be determined then if the share is marked
16502 as available to the <TT
16508 guest user will be used, otherwise access is denied.</P
16510 >Note that it can be <I
16514 in share-level security as to which UNIX username will eventually
16515 be used in granting access.</P
16517 >See also the section <A
16519 > NOTE ABOUT USERNAME/PASSWORD VALIDATION</A
16523 NAME="SECURITYEQUALSUSER"
16531 >This is the default security setting in Samba 2.2.
16532 With user-level security a client must first "log-on" with a
16533 valid username and password (which can be mapped using the <A
16534 HREF="#USERNAMEMAP"
16542 parameter). Encrypted passwords (see the <A
16543 HREF="#ENCRYPTPASSWORDS"
16547 >encrypted passwords</I
16550 > parameter) can also
16551 be used in this security mode. Parameters such as <A
16567 > if set are then applied and
16568 may change the UNIX user to use on this connection, but only after
16569 the user has been successfully authenticated.</P
16574 > that the name of the resource being
16578 > sent to the server until after
16579 the server has successfully authenticated the client. This is why
16580 guest shares don't work in user level security without allowing
16581 the server to automatically map unknown users into the <A
16582 HREF="#GUESTACCOUNT"
16599 > parameter for details on doing this.</P
16601 >See also the section <A
16603 > NOTE ABOUT USERNAME/PASSWORD VALIDATION</A
16607 NAME="SECURITYEQUALSSERVER"
16615 >In this mode Samba will try to validate the username/password
16616 by passing it to another SMB server, such as an NT box. If this
16617 fails it will revert to <B
16619 >security = user</B
16621 that if encrypted passwords have been negotiated then Samba cannot
16622 revert back to checking the UNIX password file, it must have a valid
16626 > file to check users against. See the
16627 documentation file in the <TT
16633 >ENCRYPTION.txt</TT
16634 > for details on how to set this
16640 > that from the client's point of
16643 >security = server</B
16644 > is the same as <B
16646 > security = user</B
16647 >. It only affects how the server deals
16648 with the authentication, it does not in any way affect what the
16654 > that the name of the resource being
16658 > sent to the server until after
16659 the server has successfully authenticated the client. This is why
16660 guest shares don't work in user level security without allowing
16661 the server to automatically map unknown users into the <A
16662 HREF="#GUESTACCOUNT"
16679 > parameter for details on doing this.</P
16681 >See also the section <A
16683 > NOTE ABOUT USERNAME/PASSWORD VALIDATION</A
16687 HREF="#PASSWORDSERVER"
16695 > parameter and the <A
16696 HREF="#ENCRYPTPASSWORDS"
16700 >encrypted passwords</I
16707 NAME="SECURITYEQUALSDOMAIN"
16715 >This mode will only work correctly if <A
16716 HREF="smbpasswd.8.html"
16719 > has been used to add this
16720 machine into a Windows NT Domain. It expects the <A
16721 HREF="#ENCRYPTPASSWORDS"
16725 >encrypted passwords</I
16729 > parameter to be set to <TT
16733 mode Samba will try to validate the username/password by passing
16734 it to a Windows NT Primary or Backup Domain Controller, in exactly
16735 the same way that a Windows NT Server would do.</P
16740 > that a valid UNIX user must still
16741 exist as well as the account on the Domain Controller to allow
16742 Samba to have a valid UNIX account to map file access to.</P
16747 > that from the client's point
16750 >security = domain</B
16751 > is the same as <B
16755 >. It only affects how the server deals with the authentication,
16756 it does not in any way affect what the client sees.</P
16761 > that the name of the resource being
16765 > sent to the server until after
16766 the server has successfully authenticated the client. This is why
16767 guest shares don't work in user level security without allowing
16768 the server to automatically map unknown users into the <A
16769 HREF="#GUESTACCOUNT"
16786 > parameter for details on doing this.</P
16791 > There is currently a bug in the
16792 implementation of <B
16794 >security = domain</B
16796 to multi-byte character set usernames. The communication with a
16797 Domain Controller must be done in UNICODE and Samba currently
16798 does not widen multi-byte user names to UNICODE correctly, thus
16799 a multi-byte username will not be recognized correctly at the
16800 Domain Controller. This issue will be addressed in a future release.</P
16802 >See also the section <A
16804 > NOTE ABOUT USERNAME/PASSWORD VALIDATION</A
16808 HREF="#PASSWORDSERVER"
16816 > parameter and the <A
16817 HREF="#ENCRYPTPASSWORDS"
16821 >encrypted passwords</I
16829 >security = USER</B
16834 >security = DOMAIN</B
16839 NAME="SECURITYMASK"
16841 >security mask (S)</DT
16844 >This parameter controls what UNIX permission
16845 bits can be modified when a Windows NT client is manipulating
16846 the UNIX permission on a file using the native NT security
16849 >This parameter is applied as a mask (AND'ed with) to
16850 the changed permission bits, thus preventing any bits not in
16851 this mask from being modified. Essentially, zero bits in this
16852 mask may be treated as a set of bits the user is not allowed
16855 >If not set explicitly this parameter is 0777, allowing
16856 a user to modify all the user/group/world permissions on a file.
16862 > that users who can access the
16863 Samba server through other means can easily bypass this
16864 restriction, so it is primarily useful for standalone
16865 "appliance" systems. Administrators of most normal systems will
16866 probably want to leave it set to <TT
16872 HREF="#FORCEDIRECTORYSECURITYMODE"
16876 >force directory security mode</I
16881 HREF="#DIRECTORYSECURITYMASK"
16890 HREF="#FORCESECURITYMODE"
16894 >force security mode</I
16901 >security mask = 0777</B
16906 >security mask = 0770</B
16911 NAME="SERVERSTRING"
16913 >server string (G)</DT
16916 >This controls what string will show up in the
16917 printer comment box in print manager and next to the IPC connection
16921 >. It can be any string that you wish
16922 to show to your users.</P
16924 >It also sets what will appear in browse lists next
16925 to the machine name.</P
16932 > will be replaced with the Samba
16940 > will be replaced with the
16945 >server string = Samba %v</B
16950 >server string = University of GNUs Samba
16956 NAME="SETDIRECTORY"
16958 >set directory (S)</DT
16963 >set directory = no</B
16965 users of the service may not use the setdir command to change
16971 > command is only implemented
16972 in the Digital Pathworks client. See the Pathworks documentation
16977 >set directory = no</B
16984 >share modes (S)</DT
16987 >This enables or disables the honoring of
16993 > during a file open. These
16994 modes are used by clients to gain exclusive read or write access
16997 >These open modes are not directly supported by UNIX, so
16998 they are simulated using shared memory, or lock files if your
16999 UNIX doesn't support shared memory (almost all do).</P
17001 >The share modes that are enabled by this option are
17025 >This option gives full share compatibility and enabled
17031 > turn this parameter
17032 off as many Windows applications will break if you do so.</P
17036 >share modes = yes</B
17041 NAME="SHORTPRESERVECASE"
17043 >short preserve case (S)</DT
17046 >This boolean parameter controls if new files
17047 which conform to 8.3 syntax, that is all in upper case and of
17048 suitable length, are created upper case, or if they are forced
17050 HREF="#DEFAULTCASE"
17058 >. This option can be use with <A
17059 HREF="#PRESERVECASE"
17062 >preserve case = yes</B
17065 > to permit long filenames to retain their case, while short
17066 names are lowered. </P
17068 >See the section on <A
17075 >short preserve case = yes</B
17080 NAME="SHOWADDPRINTERWIZARD"
17082 >show add printer wizard (G)</DT
17085 >With the introduction of MS-RPC based printing support
17086 for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will
17087 appear on Samba hosts in the share listing. Normally this folder will
17088 contain an icon for the MS Add Printer Wizard (APW). However, it is
17089 possible to disable this feature regardless of the level of privilege
17090 of the connected user.</P
17092 >Under normal circumstances, the Windows NT/2000 client will
17093 open a handle on the printer server with OpenPrinterEx() asking for
17094 Administrator privileges. If the user does not have administrative
17095 access on the print server (i.e is not root or a member of the
17101 > group), the OpenPrinterEx()
17102 call fails and the client makes another open call with a request for
17103 a lower privilege level. This should succeed, however the APW
17104 icon will not be displayed.</P
17109 >show add printer wizard</I
17112 parameter will always cause the OpenPrinterEx() on the server
17113 to fail. Thus the APW icon will never be displayed. <I
17116 >This does not prevent the same user from having
17117 administrative privilege on an individual printer.</P
17120 HREF="#ADDPRINTERCOMMAND"
17129 HREF="#DELETEPRINTERCOMMAND"
17133 >deleteprinter command</I
17137 HREF="#PRINTERADMIN"
17148 >show add printer wizard = yes</B
17153 NAME="SHUTDOWNSCRIPT"
17155 >shutdown script (G)</DT
17160 >This parameter only exists in the HEAD cvs branch</I
17162 This a full path name to a script called by
17171 should start a shutdown procedure.</P
17173 >This command will be run as the user connected to the
17176 >%m %t %r %f parameters are expanded</P
17183 > will be substituted with the
17184 shutdown message sent to the server.</P
17191 > will be substituted with the
17192 number of seconds to wait before effectively starting the
17193 shutdown procedure.</P
17200 > will be substituted with the
17204 >. It means reboot after shutdown
17213 > will be substituted with the
17217 >. It means force the shutdown
17218 even if applications do not respond for NT.</P
17227 >abort shutdown script = /usr/local/samba/sbin/shutdown %m %t %r %f</B
17230 >Shutdown script example:
17238 CLASS="PROGRAMLISTING"
17245 /sbin/shutdown $3 $4 +$time $1 &
17251 Shutdown does not return so we need to launch it in background.
17255 HREF="#ABORTSHUTDOWNSCRIPT"
17259 >abort shutdown script</I
17266 NAME="SMBPASSWDFILE"
17268 >smb passwd file (G)</DT
17271 >This option sets the path to the encrypted
17272 smbpasswd file. By default the path to the smbpasswd file
17273 is compiled into Samba.</P
17277 >smb passwd file = ${prefix}/private/smbpasswd
17283 >smb passwd file = /etc/samba/smbpasswd
17294 >Specifies which ports the server should listen on
17300 >smb ports = 445 139</B
17305 NAME="SOCKETADDRESS"
17307 >socket address (G)</DT
17310 >This option allows you to control what
17311 address Samba will listen for connections on. This is used to
17312 support multiple virtual interfaces on the one server, each
17313 with a different configuration.</P
17315 >By default Samba will accept connections on any
17320 >socket address = 192.168.2.20</B
17326 NAME="SOCKETOPTIONS"
17328 >socket options (G)</DT
17331 >This option allows you to set socket options
17332 to be used when talking with the client.</P
17334 >Socket options are controls on the networking layer
17335 of the operating systems which allow the connection to be
17338 >This option will typically be used to tune your Samba
17339 server for optimal performance for your local network. There is
17340 no way that Samba can know what the optimal parameters are for
17341 your net, so you must experiment and choose them yourself. We
17342 strongly suggest you read the appropriate documentation for your
17343 operating system first (perhaps <B
17349 >You may find that on some systems Samba will say
17350 "Unknown socket option" when you supply an option. This means you
17351 either incorrectly typed it or you need to add an include file
17352 to includes.h for your OS. If the latter is the case please
17353 send the patch to <A
17354 HREF="mailto:samba@samba.org"
17356 > samba@samba.org</A
17359 >Any of the supported socket options may be combined
17360 in any way you like, as long as your OS allows it.</P
17362 >This is the list of socket options currently settable
17363 using this option:</P
17389 >IPTOS_THROUGHPUT</P
17409 >Those marked with a <I
17413 argument. The others can optionally take a 1 or 0 argument to enable
17414 or disable the option, by default they will be enabled if you
17415 don't specify 1 or 0.</P
17417 >To specify an argument use the syntax SOME_OPTION = VALUE
17420 >SO_SNDBUF = 8192</B
17421 >. Note that you must
17422 not have any spaces before or after the = sign.</P
17424 >If you are on a local network then a sensible option
17429 >socket options = IPTOS_LOWDELAY</B
17432 >If you have a local network then you could try:</P
17436 >socket options = IPTOS_LOWDELAY TCP_NODELAY</B
17439 >If you are on a wide area network then perhaps try
17440 setting IPTOS_THROUGHPUT. </P
17442 >Note that several of the options may cause your Samba
17443 server to fail completely. Use these options with caution!</P
17447 >socket options = TCP_NODELAY</B
17452 >socket options = IPTOS_LOWDELAY</B
17457 NAME="SOURCEENVIRONMENT"
17459 >source environment (G)</DT
17462 >This parameter causes Samba to set environment
17463 variables as per the content of the file named.</P
17465 >If the value of this parameter starts with a "|" character
17466 then Samba will treat that value as a pipe command to open and
17467 will set the environment variables from the output of the pipe.</P
17469 >The contents of the file or the output of the pipe should
17470 be formatted as the output of the standard Unix <B
17474 > command. This is of the form :</P
17476 >Example environment entry:</P
17480 >SAMBA_NETBIOS_NAME = myhostname</B
17485 >No default value</I
17490 >source environment = |/etc/smb.conf.sh
17496 >source environment =
17497 /usr/local/smb_env_vars</B
17504 >use spnego (G)</DT
17507 > This variable controls controls whether samba will try to use Simple and Protected NEGOciation (as specified by rfc2478) with WindowsXP and Windows2000sp2 clients to agree upon an authentication mechanism. As of samba 3.0alpha it must be set to "no" for these clients to join a samba domain controller. It can be set to "yes" to allow samba to participate in an AD domain controlled by a Windows2000 domain controller.</P
17511 >use spnego = yes</I
17518 >stat cache (G)</DT
17521 >This parameter determines if <A
17525 > will use a cache in order to
17526 speed up case insensitive name mappings. You should never need
17527 to change this parameter.</P
17531 >stat cache = yes</B
17536 NAME="STATCACHESIZE"
17538 >stat cache size (G)</DT
17541 >This parameter determines the number of
17548 never need to change this parameter.</P
17552 >stat cache size = 50</B
17557 NAME="STRICTALLOCATE"
17559 >strict allocate (S)</DT
17562 >This is a boolean that controls the handling of
17563 disk space allocation in the server. When this is set to <TT
17567 the server will change from UNIX behaviour of not committing real
17568 disk storage blocks when a file is extended to the Windows behaviour
17569 of actually forcing the disk system to allocate real storage blocks
17570 when a file is created or extended to be a given size. In UNIX
17571 terminology this means that Samba will stop creating sparse files.
17572 This can be slow on some systems.</P
17574 >When strict allocate is <TT
17577 > the server does sparse
17578 disk block allocation when a file is extended.</P
17580 >Setting this to <TT
17583 > can help Samba return
17584 out of quota messages on systems that are restricting the disk quota
17589 >strict allocate = no</B
17594 NAME="STRICTLOCKING"
17596 >strict locking (S)</DT
17599 >This is a boolean that controls the handling of
17600 file locking in the server. When this is set to <TT
17604 the server will check every read and write access for file locks, and
17605 deny access if locks exist. This can be slow on some systems.</P
17607 >When strict locking is <TT
17610 > the server does file
17611 lock checks only when the client explicitly asks for them.</P
17613 >Well-behaved clients always ask for lock checks when it
17614 is important, so in the vast majority of cases <B
17618 > is preferable.</P
17622 >strict locking = no</B
17629 >strict sync (S)</DT
17632 >Many Windows applications (including the Windows
17633 98 explorer shell) seem to confuse flushing buffer contents to
17634 disk with doing a sync to disk. Under UNIX, a sync call forces
17635 the process to be suspended until the kernel has ensured that
17636 all outstanding data in kernel disk buffers has been safely stored
17637 onto stable storage. This is very slow and should only be done
17638 rarely. Setting this parameter to <TT
17642 default) means that <A
17646 > ignores the Windows applications requests for
17647 a sync call. There is only a possibility of losing data if the
17648 operating system itself that Samba is running on crashes, so there is
17649 little danger in this default setting. In addition, this fixes many
17650 performance problems that people have reported with the new Windows98
17651 explorer shell file copies.</P
17666 >strict sync = no</B
17676 >This is a boolean that controls whether to
17677 strip trailing dots off UNIX filenames. This helps with some
17678 CDROMs that have filenames ending in a single dot.</P
17689 >sync always (S)</DT
17692 >This is a boolean parameter that controls
17693 whether writes will always be written to stable storage before
17694 the write call returns. If this is <TT
17697 > then the server will be
17698 guided by the client's request in each write call (clients can
17699 set a bit indicating that a particular write should be synchronous).
17703 > then every write will be followed by a <B
17707 > call to ensure the data is written to disk. Note that
17713 > parameter must be set to
17717 > in order for this parameter to have
17733 >sync always = no</B
17743 >This parameter maps how Samba debug messages
17744 are logged onto the system syslog logging levels. Samba debug
17745 level zero maps onto syslog <TT
17749 level one maps onto <TT
17756 >, debug level three
17757 maps onto LOG_INFO. All higher levels are mapped to <TT
17762 >This parameter sets the threshold for sending messages
17763 to syslog. Only messages with debug level less than this value
17764 will be sent to syslog.</P
17775 >syslog only (G)</DT
17778 >If this parameter is set then Samba debug
17779 messages are logged into the system syslog only, and not to
17780 the debug log files.</P
17784 >syslog only = no</B
17789 NAME="TEMPLATEHOMEDIR"
17791 >template homedir (G)</DT
17794 >When filling out the user information for a Windows NT
17796 HREF="winbindd.8.html"
17800 uses this parameter to fill in the home directory for that user.
17806 > is present it is substituted
17807 with the user's Windows NT domain name. If the string <TT
17813 > is present it is substituted with the user's Windows
17818 >template homedir = /home/%D/%U</B
17823 NAME="TEMPLATESHELL"
17825 >template shell (G)</DT
17828 >When filling out the user information for a Windows NT
17830 HREF="winbindd.8.html"
17834 uses this parameter to fill in the login shell for that user.</P
17838 >template shell = /bin/false</B
17845 >time offset (G)</DT
17848 >This parameter is a setting in minutes to add
17849 to the normal GMT to local time conversion. This is useful if
17850 you are serving a lot of PCs that have incorrect daylight
17851 saving time handling.</P
17855 >time offset = 0</B
17860 >time offset = 60</B
17867 >time server (G)</DT
17870 >This parameter determines if <A
17875 > advertises itself as a time server to Windows
17880 >time server = no</B
17885 NAME="TIMESTAMPLOGS"
17887 >timestamp logs (G)</DT
17891 HREF="#DEBUGTIMESTAMP"
17895 > debug timestamp</I
17902 NAME="TOTALPRINTJOBS"
17904 >total print jobs (G)</DT
17907 >This parameter accepts an integer value which defines
17908 a limit on the maximum number of print jobs that will be accepted
17909 system wide at any given time. If a print job is submitted
17910 by a client which will exceed this number, then <A
17915 error indicating that no space is available on the server. The
17916 default value of 0 means that no such limit exists. This parameter
17917 can be used to prevent a server from exceeding its capacity and is
17918 designed as a printing throttle. See also
17920 HREF="#MAXPRINTJOBS"
17932 >total print jobs = 0</B
17937 >total print jobs = 5000</B
17947 >Specifies whether Samba should try
17948 to use unicode on the wire by default. Note: This does NOT
17949 mean that samba will assume that the unix machine uses unicode!
17961 >unix charset (G)</DT
17964 >Specifies the charset the unix machine
17965 Samba runs on uses. Samba needs to know this in order to be able to
17966 convert text to the charsets other SMB clients use.
17971 >unix charset = ASCII</B
17976 >unix charset = UTF8</B
17981 NAME="UNIXEXTENSIONS"
17983 >unix extensions(G)</DT
17986 >This boolean parameter controls whether Samba
17987 implments the CIFS UNIX extensions, as defined by HP.
17988 These extensions enable Samba to better serve UNIX CIFS clients
17989 by supporting features such as symbolic links, hard links, etc...
17990 These extensions require a similarly enabled client, and are of
17991 no current use to Windows clients.</P
17995 >unix extensions = no</B
18000 NAME="UNIXPASSWORDSYNC"
18002 >unix password sync (G)</DT
18005 >This boolean parameter controls whether Samba
18006 attempts to synchronize the UNIX password with the SMB password
18007 when the encrypted SMB password in the smbpasswd file is changed.
18008 If this is set to <TT
18011 > the program specified in the <TT
18017 >parameter is called <I
18021 to allow the new UNIX password to be set without access to the
18022 old UNIX password (as the SMB password change code has no
18023 access to the old password cleartext, only the new).</P
18026 HREF="#PASSWDPROGRAM"
18046 >unix password sync = no</B
18051 NAME="UPDATEENCRYPTED"
18053 >update encrypted (G)</DT
18056 >This boolean parameter allows a user logging
18057 on with a plaintext password to have their encrypted (hashed)
18058 password in the smbpasswd file to be updated automatically as
18059 they log on. This option allows a site to migrate from plaintext
18060 password authentication (users authenticate with plaintext
18061 password over the wire, and are checked against a UNIX account
18062 database) to encrypted password authentication (the SMB
18063 challenge/response authentication mechanism) without forcing
18064 all users to re-enter their passwords via smbpasswd at the time the
18065 change is made. This is a convenience option to allow the change over
18066 to encrypted passwords to be made over a longer period. Once all users
18067 have encrypted representations of their passwords in the smbpasswd
18068 file this parameter should be set to <TT
18073 >In order for this parameter to work correctly the <A
18074 HREF="#ENCRYPTPASSWORDS"
18078 >encrypt passwords</I
18082 > parameter must be set to <TT
18086 this parameter is set to <TT
18091 >Note that even when this parameter is set a user
18092 authenticating to <B
18095 > must still enter a valid
18096 password in order to connect correctly, and to update their hashed
18097 (smbpasswd) passwords.</P
18101 >update encrypted = no</B
18106 NAME="USECLIENTDRIVER"
18108 >use client driver (S)</DT
18111 >This parameter applies only to Windows NT/2000
18112 clients. It has no affect on Windows 95/98/ME clients. When
18113 serving a printer to Windows NT/2000 clients without first installing
18114 a valid printer driver on the Samba host, the client will be required
18115 to install a local printer driver. From this point on, the client
18116 will treat the print as a local printer and not a network printer
18117 connection. This is much the same behavior that will occur
18120 >disable spoolss = yes</B
18123 >The differentiating
18124 factor is that under normal circumstances, the NT/2000 client will
18125 attempt to open the network printer using MS-RPC. The problem is that
18126 because the client considers the printer to be local, it will attempt
18127 to issue the OpenPrinterEx() call requesting access rights associated
18128 with the logged on user. If the user possesses local administator rights
18129 but not root privilegde on the Samba host (often the case), the OpenPrinterEx()
18130 call will fail. The result is that the client will now display an "Access
18131 Denied; Unable to connect" message in the printer queue window (even though
18132 jobs may successfully be printed). </P
18134 >If this parameter is enabled for a printer, then any attempt
18135 to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped
18136 to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx()
18137 call to succeed. <I
18139 >This parameter MUST not be able enabled
18140 on a print share which has valid print driver installed on the Samba
18145 HREF="#DISABLESPOOLSS"
18146 >disable spoolss</A
18152 >use client driver = no</B
18162 >This global parameter determines if the tdb internals of Samba can
18163 depend on mmap working correctly on the running system. Samba requires a coherent
18164 mmap/read-write system memory cache. Currently only HPUX does not have such a
18165 coherent cache, and so this parameter is set to <TT
18169 default on HPUX. On all other systems this parameter should be left alone. This
18170 parameter is provided to help the Samba developers track down problems with
18171 the tdb internal code.
18183 >use rhosts (G)</DT
18186 >If this global parameter is <TT
18190 that the UNIX user's <TT
18193 > file in their home directory
18194 will be read to find the names of hosts and users who will be allowed
18195 access without specifying a password.</P
18206 > can be a major security hole. This is because you are
18207 trusting the PC to supply the correct username. It is very easy to
18208 get a PC to supply a false username. I recommend that the <TT
18213 > option be only used if you really know what
18218 >use rhosts = no</B
18262 >Multiple users may be specified in a comma-delimited
18263 list, in which case the supplied password will be tested against
18264 each username in turn (left to right).</P
18271 > line is needed only when
18272 the PC is unable to supply its own username. This is the case
18273 for the COREPLUS protocol or where your users have different WfWg
18274 usernames to UNIX usernames. In both these cases you may also be
18275 better using the \\server\share%user syntax instead.</P
18282 > line is not a great
18283 solution in many cases as it means Samba will try to validate
18284 the supplied password against each of the usernames in the
18290 > line in turn. This is slow and
18291 a bad idea for lots of users in case of duplicate passwords.
18292 You may get timeouts or security breaches using this parameter
18295 >Samba relies on the underlying UNIX security. This
18296 parameter does not restrict who can login, it just offers hints
18297 to the Samba server as to what usernames might correspond to the
18298 supplied password. Users can login as whoever they please and
18299 they will be able to do no more damage than if they started a
18300 telnet session. The daemon runs as the user that they log in as,
18301 so they cannot do anything that user cannot do.</P
18303 >To restrict a service to a particular set of users you
18315 >If any of the usernames begin with a '@' then the name
18316 will be looked up first in the NIS netgroups list (if Samba
18317 is compiled with netgroup support), followed by a lookup in
18318 the UNIX groups database and will expand to a list of all users
18319 in the group of that name.</P
18321 >If any of the usernames begin with a '+' then the name
18322 will be looked up only in the UNIX groups database and will
18323 expand to a list of all users in the group of that name.</P
18325 >If any of the usernames begin with a '&'then the name
18326 will be looked up only in the NIS netgroups database (if Samba
18327 is compiled with netgroup support) and will expand to a list
18328 of all users in the netgroup group of that name.</P
18330 >Note that searching though a groups database can take
18331 quite some time, and some clients may time out during the
18334 >See the section <A
18337 USERNAME/PASSWORD VALIDATION</A
18338 > for more information on how
18339 this parameter determines access to the services.</P
18343 >The guest account if a guest service,
18344 else <empty string>.</B
18349 >username = fred, mary, jack, jane,
18350 @users, @pcgroup</B
18355 NAME="USERNAMELEVEL"
18357 >username level (G)</DT
18360 >This option helps Samba to try and 'guess' at
18361 the real UNIX username, as many DOS clients send an all-uppercase
18362 username. By default Samba tries all lowercase, followed by the
18363 username with the first letter capitalized, and fails if the
18364 username is not found on the UNIX machine.</P
18366 >If this parameter is set to non-zero the behavior changes.
18367 This parameter is a number that specifies the number of uppercase
18368 combinations to try while trying to determine the UNIX user name. The
18369 higher the number the more combinations will be tried, but the slower
18370 the discovery of usernames will be. Use this parameter when you have
18371 strange usernames on your UNIX machine, such as <TT
18379 >username level = 0</B
18384 >username level = 5</B
18391 >username map (G)</DT
18394 >This option allows you to specify a file containing
18395 a mapping of usernames from the clients to the server. This can be
18396 used for several purposes. The most common is to map usernames
18397 that users use on DOS or Windows machines to those that the UNIX
18398 box uses. The other is to map multiple users to a single username
18399 so that they can more easily share files.</P
18401 >The map file is parsed line by line. Each line should
18402 contain a single UNIX username on the left then a '=' followed
18403 by a list of usernames on the right. The list of usernames on the
18404 right may contain names of the form @group in which case they
18405 will match any UNIX username in that group. The special client
18406 name '*' is a wildcard and matches any name. Each line of the
18407 map file may be up to 1023 characters long.</P
18409 >The file is processed on each line by taking the
18410 supplied username and comparing it with each username on the right
18411 hand side of the '=' signs. If the supplied name matches any of
18412 the names on the right hand side then it is replaced with the name
18413 on the left. Processing then continues with the next line.</P
18415 >If any line begins with a '#' or a ';' then it is
18418 >If any line begins with an '!' then the processing
18419 will stop after that line if a mapping was done by the line.
18420 Otherwise mapping continues with every line being processed.
18421 Using '!' is most useful when you have a wildcard mapping line
18422 later in the file.</P
18424 >For example to map from the name <TT
18431 > to the UNIX name <TT
18434 > you would use:</P
18438 >root = admin administrator</B
18441 >Or to map anyone in the UNIX group <TT
18445 to the UNIX name <TT
18448 > you would use:</P
18455 >You can have as many mappings as you like in a username
18458 >If your system supports the NIS NETGROUP option then
18459 the netgroup database is checked before the <TT
18463 > database for matching groups.</P
18465 >You can map Windows usernames that have spaces in them
18466 by using double quotes around the name. For example:</P
18470 >tridge = "Andrew Tridgell"</B
18473 >would map the windows username "Andrew Tridgell" to the
18474 unix username "tridge".</P
18476 >The following example would map mary and fred to the
18477 unix user sys, and map the rest to guest. Note the use of the
18478 '!' to tell Samba to stop processing if it gets a match on
18488 CLASS="PROGRAMLISTING"
18497 >Note that the remapping is applied to all occurrences
18498 of usernames. Thus if you connect to \\server\fred and <TT
18501 > is remapped to <TT
18505 will actually be connecting to \\server\mary and will need to
18506 supply a password suitable for <TT
18513 >. The only exception to this is the
18514 username passed to the <A
18515 HREF="#PASSWORDSERVER"
18519 > password server</I
18522 > (if you have one). The password
18523 server will receive whatever username the client supplies without
18526 >Also note that no reverse mapping is done. The main effect
18527 this has is with printing. Users who have been mapped may have
18528 trouble deleting print jobs as PrintManager under WfWg will think
18529 they don't own the print job.</P
18533 >no username map</I
18538 >username map = /usr/local/samba/lib/users.map
18546 >use sendfile (S)</DT
18549 >If this parameter is <TT
18553 was built with the --with-sendfile-support option, and the underlying operating
18554 system supports sendfile system call, then some SMB read calls (mainly ReadAndX
18555 and ReadRaw) will use the more efficient sendfile system call for files that
18556 are exclusively oplocked. This may make more efficient use of the system CPU's
18557 and cause Samba to be faster. This is off by default as it's effects are unknown
18563 >use sendfile = no</B
18573 >This boolean parameter is only available if
18574 Samba has been configured and compiled with the option <B
18580 > then Samba will attempt
18581 to add utmp or utmpx records (depending on the UNIX system) whenever a
18582 connection is made to a Samba server. Sites may use this to record the
18583 user connecting to a Samba share.</P
18585 >Due to the requirements of the utmp record, we
18586 are required to create a unique identifier for the
18587 incoming user. Enabling this option creates an n^2
18588 algorithm to find this number. This may impede
18589 performance on large installations. </P
18592 HREF="#UTMPDIRECTORY"
18596 > utmp directory</I
18608 NAME="UTMPDIRECTORY"
18610 >utmp directory(G)</DT
18613 >This parameter is only available if Samba has
18614 been configured and compiled with the option <B
18617 >. It specifies a directory pathname that is
18618 used to store the utmp or utmpx files (depending on the UNIX system) that
18619 record user connections to a Samba server. See also the <A
18627 > parameter. By default this is
18628 not set, meaning the system will use whatever utmp file the
18629 native system is set to use (usually
18637 >no utmp directory</I
18642 >utmp directory = /var/run/utmp</B
18647 NAME="WTMPDIRECTORY"
18649 >wtmp directory(G)</DT
18652 >This parameter is only available if Samba has
18653 been configured and compiled with the option <B
18656 >. It specifies a directory pathname that is
18657 used to store the wtmp or wtmpx files (depending on the UNIX system) that
18658 record user connections to a Samba server. The difference with
18659 the utmp directory is the fact that user info is kept after a user
18670 > parameter. By default this is
18671 not set, meaning the system will use whatever utmp file the
18672 native system is set to use (usually
18680 >no wtmp directory</I
18685 >wtmp directory = /var/log/wtmp</B
18692 >valid users (S)</DT
18695 >This is a list of users that should be allowed
18696 to login to this service. Names starting with '@', '+' and '&'
18697 are interpreted using the same rules as described in the
18705 >If this is empty (the default) then any user can login.
18706 If a username is in both this list and the <TT
18712 > list then access is denied for that user.</P
18714 >The current servicename is substituted for <TT
18720 >. This is useful in the [homes] section.</P
18723 HREF="#INVALIDUSERS"
18735 >No valid users list (anyone can login)
18741 >valid users = greg, @pcusers</B
18751 >This is a list of files and directories that
18752 are neither visible nor accessible. Each entry in the list must
18753 be separated by a '/', which allows spaces to be included
18754 in the entry. '*' and '?' can be used to specify multiple files
18755 or directories as in DOS wildcards.</P
18757 >Each entry must be a unix path, not a DOS path and
18761 > include the unix directory
18770 is applicable in vetoing files.</P
18772 >One feature of the veto files parameter that it
18773 is important to be aware of is Samba's behaviour when
18774 trying to delete a directory. If a directory that is
18775 to be deleted contains nothing but veto files this
18779 > unless you also set
18783 >delete veto files</I
18793 >Setting this parameter will affect the performance
18794 of Samba, as it will be forced to check all files and directories
18795 for a match as they are scanned.</P
18807 HREF="#CASESENSITIVE"
18811 > case sensitive</I
18818 >No files or directories are vetoed.
18829 CLASS="PROGRAMLISTING"
18830 >; Veto any files containing the word Security,
18831 ; any ending in .tmp, and any directory containing the
18833 veto files = /*Security*/*.tmp/*root*/
18835 ; Veto the Apple specific files that a NetAtalk server
18837 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/</PRE
18845 NAME="VETOOPLOCKFILES"
18847 >veto oplock files (S)</DT
18850 >This parameter is only valid when the <A
18859 parameter is turned on for a share. It allows the Samba administrator
18860 to selectively turn off the granting of oplocks on selected files that
18861 match a wildcarded list, similar to the wildcarded list used in the
18875 >No files are vetoed for oplock
18879 >You might want to do this on files that you know will
18880 be heavily contended for by clients. A good example of this
18881 is in the NetBench SMB benchmark program, which causes heavy
18882 client contention for files ending in <TT
18886 To cause Samba not to grant oplocks on these files you would use
18887 the line (either in the [global] section or in the section for
18888 the particular NetBench share :</P
18892 >veto oplock files = /*.SEM/
18903 >This parameter specifies the directory
18904 to look in for vfs modules. The name of every <B
18908 > will be prepended by this directory
18918 >vfs path = /usr/lib/samba/vfs</B
18925 >vfs object (S)</DT
18928 >This parameter specifies a shared object files that
18929 are used for Samba VFS I/O operations. By default, normal
18930 disk I/O operations are used but these can be overloaded
18931 with one or more VFS objects. </P
18942 >vfs options (S)</DT
18945 >This parameter allows parameters to be passed
18946 to the vfs layer at initialization time.
18969 > This allows you to override the volume label
18970 returned for a share. Useful for CDROMs with installation programs
18971 that insist on a particular volume label.</P
18975 >the name of the share</I
18982 >wide links (S)</DT
18985 >This parameter controls whether or not links
18986 in the UNIX file system may be followed by the server. Links
18987 that point to areas within the directory tree exported by the
18988 server are always allowed; this parameter controls access only
18989 to areas that are outside the directory tree being exported.</P
18991 >Note that setting this parameter can have a negative
18992 effect on your server performance due to the extra system calls
18993 that Samba has to do in order to perform the link checks.</P
18997 >wide links = yes</B
19002 NAME="WINBINDCACHETIME"
19004 >winbind cache time (G)</DT
19007 >This parameter specifies the number of seconds the
19009 HREF="winbindd.8.html"
19012 > daemon will cache
19013 user and group information before querying a Windows NT server
19018 >winbind cache type = 15</B
19023 NAME="WINBINDENUMUSERS"
19025 >winbind enum users (G)</DT
19028 >On large installations using
19030 HREF="winbindd.8.html"
19034 necessary to suppress the enumeration of users through the
19046 > group of system calls. If
19050 >winbind enum users</I
19060 will not return any data. </P
19066 enumeration may cause some programs to behave oddly. For
19067 example, the finger program relies on having access to the
19068 full user list when searching for matching
19073 >winbind enum users = yes </B
19078 NAME="WINBINDENUMGROUPS"
19080 >winbind enum groups (G)</DT
19083 >On large installations using
19085 HREF="winbindd.8.html"
19089 necessary to suppress the enumeration of groups through the
19101 > group of system calls. If
19105 >winbind enum groups</I
19115 call will not return any data. </P
19120 > Turning off group
19121 enumeration may cause some programs to behave oddly.
19126 >winbind enum groups = yes </B
19134 >winbind gid (G)</DT
19137 >The winbind gid parameter specifies the range of group
19138 ids that are allocated by the <A
19139 HREF="winbindd.8.html"
19142 > daemon. This range of group ids should have no
19143 existing local or NIS groups within it as strange conflicts can
19144 occur otherwise.</P
19148 >winbind gid = <empty string>
19154 >winbind gid = 10000-20000</B
19159 NAME="WINBINDSEPARATOR"
19161 >winbind separator (G)</DT
19164 >This parameter allows an admin to define the character
19165 used when listing a username of the form of <TT
19166 CLASS="REPLACEABLE"
19172 CLASS="REPLACEABLE"
19177 is only applicable when using the <TT
19179 >pam_winbind.so</TT
19183 >nss_winbind.so</TT
19184 > modules for UNIX services.
19187 >Please note that setting this parameter to + causes problems
19188 with group membership at least on glibc systems, as the character +
19189 is used as a special character for NIS in /etc/group.</P
19193 >winbind separator = '\'</B
19198 >winbind separator = +</B
19205 >winbind uid (G)</DT
19208 >The winbind gid parameter specifies the range of group
19209 ids that are allocated by the <A
19210 HREF="winbindd.8.html"
19213 > daemon. This range of ids should have no
19214 existing local or NIS users within it as strange conflicts can
19215 occur otherwise.</P
19219 >winbind uid = <empty string>
19225 >winbind uid = 10000-20000</B
19229 >winbind use default domain, <A
19230 NAME="WINBINDUSEDEFAULTDOMAIN"
19232 >winbind use default domain (G)</DT
19235 >This parameter specifies whether the <A
19236 HREF="winbindd.8.html"
19240 daemon should operate on users without domain component in their username.
19241 Users without a domain component are treated as is part of the winbindd server's
19242 own domain. While this does not benifit Windows users, it makes SSH, FTP and e-mail
19243 function in a way much closer to the way they would in a native unix system.</P
19247 >winbind use default domain = <no>
19253 >winbind use default domain = yes</B
19263 >When Samba is running as a WINS server this
19264 allows you to call an external program for all changes to the
19265 WINS database. The primary use for this option is to allow the
19266 dynamic update of external name resolution databases such as
19269 >The wins hook parameter specifies the name of a script
19270 or executable that will be called as follows:</P
19274 >wins_hook operation name nametype ttl IP_list
19282 >The first argument is the operation and is one
19283 of "add", "delete", or "refresh". In most cases the operation can
19284 be ignored as the rest of the parameters provide sufficient
19285 information. Note that "refresh" may sometimes be called when the
19286 name has not previously been added, in that case it should be treated
19291 >The second argument is the NetBIOS name. If the
19292 name is not a legal name then the wins hook is not called.
19293 Legal names contain only letters, digits, hyphens, underscores
19298 >The third argument is the NetBIOS name
19299 type as a 2 digit hexadecimal number. </P
19303 >The fourth argument is the TTL (time to live)
19304 for the name in seconds.</P
19308 >The fifth and subsequent arguments are the IP
19309 addresses currently registered for that name. If this list is
19310 empty then the name should be deleted.</P
19314 >An example script that calls the BIND dynamic DNS update
19318 > is provided in the examples
19319 directory of the Samba source code. </P
19325 >wins proxy (G)</DT
19328 >This is a boolean that controls if <A
19332 > will respond to broadcast name
19333 queries on behalf of other hosts. You may need to set this
19337 > for some older clients.</P
19341 >wins proxy = no</B
19348 >wins server (G)</DT
19351 >This specifies the IP address (or DNS name: IP
19352 address for preference) of the WINS server that <A
19356 > should register with. If you have a WINS server on
19357 your network then you should set this to the WINS server's IP.</P
19359 >You should point this at your WINS server if you have a
19360 multi-subnetted network.</P
19365 >. You need to set up Samba to point
19366 to a WINS server if you have multiple subnets and wish cross-subnet
19367 browsing to work correctly.</P
19369 >See the documentation file <TT
19373 in the docs/ directory of your Samba source distribution.</P
19382 >wins server = 192.9.200.1</B
19389 >wins support (G)</DT
19392 >This boolean controls if the <A
19397 > process in Samba will act as a WINS server. You should
19398 not set this to <TT
19401 > unless you have a multi-subnetted network and
19402 you wish a particular <B
19405 > to be your WINS server.
19406 Note that you should <I
19413 on more than one machine in your network.</P
19417 >wins support = no</B
19427 >This controls what workgroup your server will
19428 appear to be in when queried by clients. Note that this parameter
19429 also controls the Domain name used with the <A
19430 HREF="#SECURITYEQUALSDOMAIN"
19433 >security = domain</B
19440 >set at compile time to WORKGROUP</I
19445 >workgroup = MYGROUP</B
19463 > for people who can't spell :-).</P
19467 NAME="WRITECACHESIZE"
19469 >write cache size (S)</DT
19472 >If this integer parameter is set to non-zero value,
19473 Samba will create an in-memory cache for each oplocked file
19478 non-oplocked files). All writes that the client does not request
19479 to be flushed directly to disk will be stored in this cache if possible.
19480 The cache is flushed onto disk when a write comes in whose offset
19481 would not fit into the cache or when the file is closed by the client.
19482 Reads for the file are also served from this cache if the data is stored
19485 >This cache allows Samba to batch client writes into a more
19486 efficient write size for RAID disks (i.e. writes may be tuned to
19487 be the RAID stripe size) and can improve performance on systems
19488 where the disk subsystem is a bottleneck but there is free
19489 memory for userspace programs.</P
19491 >The integer parameter specifies the size of this cache
19492 (per oplocked file) in bytes.</P
19496 >write cache size = 0</B
19501 >write cache size = 262144</B
19504 >for a 256k cache size per file.</P
19510 >write list (S)</DT
19513 >This is a list of users that are given read-write
19514 access to a service. If the connecting user is in this list then
19515 they will be given write access, no matter what the <A
19524 option is set to. The list can include group names using the
19527 >Note that if a user is in both the read list and the
19528 write list then they will be given write access.</P
19543 >write list = <empty string>
19549 >write list = admin, root, @staff
19555 NAME="WINSPARTNERS"
19557 >wins partners (G)</DT
19560 >A space separated list of partners' IP addresses for
19561 WINS replication. WINS partners are always defined as push/pull
19562 partners as defining only one way WINS replication is unreliable.
19563 WINS replication is currently experimental and unreliable between
19569 >wins partners = </B
19574 >wins partners = 192.168.0.1 172.16.1.2</B
19584 >Inverted synonym for <A
19601 >This parameter controls whether or not the server
19602 will support raw write SMB's when transferring data from clients.
19603 You should never need to change this parameter.</P
19607 >write raw = yes</B
19617 >Inverted synonym for <A
19638 >Although the configuration file permits service names
19639 to contain spaces, your client software may not. Spaces will
19640 be ignored in comparisons anyway, so it shouldn't be a
19641 problem - but be aware of the possibility.</P
19643 >On a similar note, many clients - especially DOS clients -
19644 limit service names to eight characters. <A
19649 > has no such limitation, but attempts to connect from such
19650 clients will fail if they truncate the service names. For this reason
19651 you should probably keep your service names down to eight characters
19654 >Use of the [homes] and [printers] special sections make life
19655 for an administrator easy, but the various combinations of default
19656 attributes can be tricky. Take extreme care when designing these
19657 sections. In particular, ensure that the permissions on spool
19658 directories are correct.</P
19668 >This man page is correct for version 3.0 of
19669 the Samba suite.</P
19680 HREF="samba.7.html"
19685 HREF="smbpasswd.8.html"
19717 HREF="smbclient.1.html"
19725 HREF="nmblookup.1.html"
19733 HREF="testparm.1.html"
19741 HREF="testprns.1.html"
19758 >The original Samba software and related utilities
19759 were created by Andrew Tridgell. Samba is now developed
19760 by the Samba Team as an Open Source project similar
19761 to the way the Linux kernel is developed.</P
19763 >The original Samba man pages were written by Karl Auer.
19764 The man page sources were converted to YODL format (another
19765 excellent piece of Open Source software, available at
19767 HREF="ftp://ftp.icce.rug.nl/pub/unix/"
19769 > ftp://ftp.icce.rug.nl/pub/unix/</A
19770 >) and updated for the Samba 2.0
19771 release by Jeremy Allison. The conversion to DocBook for
19772 Samba 2.2 was done by Gerald Carter</P
git.samba.org / ira / wip.git / blob