1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//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
126 described under <SPAN
133 following notes apply to ordinary section descriptions.</P
135 >A share consists of a directory to which access is being
136 given plus a description of the access rights which are granted
137 to the user of the service. Some housekeeping options are
140 >Sections are either file share services (used by the
141 client as an extension of their native file systems) or
142 printable services (used by the client to access print services
143 on the host running the server).</P
145 >Sections may be designated <SPAN
152 in which case no password is required to access them. A specified
159 > is used to define access
160 privileges in this case.</P
162 >Sections other than guest services will require a password
163 to access them. The client provides the username. As older clients
164 only provide passwords and not usernames, you may specify a list
165 of usernames to check against the password using the "user ="
166 option in the share definition. For modern clients such as
167 Windows 95/98/ME/NT/2000, this should not be necessary.</P
169 >Note that the access rights granted by the server are
170 masked by the access rights granted to the specified or guest
171 UNIX user by the host system. The server does not grant more
172 access than the host system grants.</P
174 >The following sample section defines a file space share.
175 The user has write access to the path <TT
179 The share is accessed via the share name "foo":</P
183 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
194 spool file. The <SPAN
201 access will be permitted as the default guest user (specified
206 CLASS="COMPUTEROUTPUT"
208 path = /usr/spool/public
222 >SPECIAL SECTIONS</H2
229 >The [global] section</H3
231 >parameters in this section apply to the server
232 as a whole, or are defaults for sections which do not
233 specifically define certain items. See the notes
234 under PARAMETERS for more information.</P
242 >The [homes] section</H3
244 >If a section called homes is included in the
245 configuration file, services connecting clients to their
246 home directories can be created on the fly by the server.</P
248 >When the connection request is made, the existing
249 sections are scanned. If a match is found, it is used. If no
250 match is found, the requested section name is treated as a
251 user name and looked up in the local password file. If the
252 name exists and the correct password has been given, a share is
253 created by cloning the [homes] section.</P
255 >Some modifications are then made to the newly
262 >The share name is changed from homes to
263 the located username.</P
267 >If no path was given, the path is set to
268 the user's home directory.</P
272 >If you decide to use a <SPAN
279 in your [homes] section then you may find it useful
280 to use the %S macro. For example :</P
285 >path = /data/pchome/%S</B
289 >would be useful if you have different home directories
290 for your PCs than for UNIX access.</P
292 >This is a fast and simple way to give a large number
293 of clients access to their home directories with a minimum
296 >A similar process occurs if the requested section
297 name is "homes", except that the share name is not
298 changed to that of the requesting user. This method of using
299 the [homes] section works well if different users share
302 >The [homes] section can specify all the parameters
303 a normal service section can specify, though some make more sense
304 than others. The following is a typical and suitable [homes]
309 CLASS="COMPUTEROUTPUT"
316 >An important point is that if guest access is specified
317 in the [homes] section, all home directories will be
318 visible to all clients <SPAN
322 >without a password</I
325 In the very unlikely event that this is actually desirable, it
326 would be wise to also specify <SPAN
342 auto home directories will be inherited from the global browseable
343 flag, not the [homes] browseable flag. This is useful as
344 it means setting <SPAN
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
412 CLASS="COMPUTEROUTPUT"
414 path = /usr/spool/public
420 >All aliases given for a printer in the printcap file
421 are legitimate printer names as far as the server is concerned.
422 If your printing subsystem doesn't work like that, you will have
423 to set up a pseudo-printcap. This is a file consisting of one or
424 more lines like this:</P
428 CLASS="COMPUTEROUTPUT"
429 > alias|alias|alias|alias...
434 >Each alias should be an acceptable printer name for
435 your printing subsystem. In the [global] section, specify
436 the new file as your printcap. The server will then only recognize
437 names found in your pseudo-printcap, which of course can contain
438 whatever aliases you like. The same technique could be used
439 simply to limit access to a subset of your local printers.</P
441 >An alias, by the way, is defined as any component of the
442 first entry of a printcap record. Records are separated by newlines,
443 components (if there are more than one) are separated by vertical
444 bar symbols ('|').</P
446 >NOTE: On SYSV systems which use lpstat to determine what
447 printers are defined on the system you may be able to use
448 "printcap name = lpstat" to automatically obtain a list
449 of printers. See the "printcap name" option
461 >parameters define the specific attributes of sections.</P
463 >Some parameters are specific to the [global] section
470 >). Some parameters are usable
471 in all sections (e.g., <SPAN
478 are permissible only in normal sections. For the purposes of the
479 following descriptions the [homes] and [printers]
480 sections will be considered normal. The letter <SPAN
487 in parentheses indicates that a parameter is specific to the
488 [global] section. The letter <SPAN
495 indicates that a parameter can be specified in a service specific
496 section. Note that all <SPAN
502 > parameters can also be specified in
503 the [global] section - in which case they will define
504 the default behavior for all services.</P
506 >parameters are arranged here in alphabetical order - this may
507 not create best bedfellows, but at least you can find them! Where
508 there are synonyms, the preferred synonym is described, others refer
509 to the preferred synonym.</P
517 >VARIABLE SUBSTITUTIONS</H2
519 >Many of the strings that are settable in the config file
520 can take substitutions. For example the option "path =
521 /tmp/%u" would be interpreted as "path =
522 /tmp/john" if the user connected with the username john.</P
524 >These substitutions are mostly noted in the descriptions below,
525 but there are some general substitutions which apply whenever they
526 might be relevant. These are:</P
536 >the name of the current service, if any.</P
542 >the root directory of the current service,
549 >user name of the current service, if any.</P
555 >primary group name of %u.</P
561 >session user name (the user name that the client
562 wanted, not necessarily the same as the one they got).</P
568 >primary group name of %U.</P
574 >the home directory of the user given
581 >the Samba version.</P
587 >the Internet hostname that Samba is running
594 >the NetBIOS name of the client machine
601 >the NetBIOS name of the server. This allows you
602 to change your config based on what the client calls you. Your
603 server can have a "dual personality".</P
605 >Note that this parameter is not available when Samba listens
606 on port 445, as clients no longer send this information </P
612 >the Internet name of the client machine.
619 >the name of your NIS home directory server.
620 This is obtained from your NIS auto.map entry. If you have
621 not compiled Samba with the <SPAN
628 option then this value will be the same as %L.</P
634 >the path of the service's home directory,
635 obtained from your NIS auto.map entry. The NIS auto.map entry
636 is split up as "%N:%p".</P
642 >the selected protocol level after
643 protocol negotiation. It can be one of CORE, COREPLUS,
644 LANMAN1, LANMAN2 or NT1.</P
650 >The process id of the current server
657 >the architecture of the remote
658 machine. Only some are recognized, and those may not be
659 100% reliable. It currently recognizes Samba, WfWg, Win95,
660 WinNT and Win2k. Anything else will be known as
661 "UNKNOWN". If it gets it wrong then sending a level
663 HREF="mailto:samba@samba.org"
667 > should allow it to be fixed.</P
673 >The IP address of the client machine.</P
679 >the current date and time.</P
690 >The value of the environment variable
701 >There are some quite creative things that can be done
702 with these substitutions and other smb.conf options.</P
712 >Samba supports "name mangling" so that DOS and
713 Windows clients can use files that don't conform to the 8.3 format.
714 It can also be set to adjust the case of 8.3 format filenames.</P
716 >There are several options that control the way mangling is
717 performed, and they are grouped here rather than listed separately.
718 For the defaults look at the output of the testparm program. </P
720 >All of these options can be set separately for each service
721 (or globally, of course). </P
723 >The options are: </P
730 >mangle case = yes/no</DT
733 > controls if names that have characters that
734 aren't of the "default" case are mangled. For example,
735 if this is yes then a name like "Mail" would be mangled.
745 >case sensitive = yes/no</DT
748 >controls whether filenames are case sensitive. If
749 they aren't then Samba must do a filename search and match on passed
759 >default case = upper/lower</DT
762 >controls what the default case is for new
763 filenames. Default <SPAN
772 >preserve case = yes/no</DT
775 >controls if new files are created with the
776 case that the client passes, or if they are forced to be the
777 "default" case. Default <SPAN
787 >short preserve case = yes/no</DT
790 >controls if new files which conform to 8.3 syntax,
791 that is all in upper case and of suitable length, are created
792 upper case, or if they are forced to be the "default"
793 case. This option can be use with "preserve case = yes"
794 to permit long filenames to retain their case, while short names
795 are lowercased. Default <SPAN
806 >By default, Samba 2.2 has the same semantics as a Windows
807 NT server, in that it is case insensitive but case preserving.</P
815 >NOTE ABOUT USERNAME/PASSWORD VALIDATION</H2
817 >There are a number of ways in which a user can connect
818 to a service. The server uses the following steps in determining
819 if it will allow a connection to a specified service. If all the
820 steps fail, then the connection request is rejected. However, if one of the
821 steps succeeds, then the following steps are not checked.</P
823 >If the service is marked "guest only = yes" and the
824 server is running with share-level security ("security = share")
825 then steps 1 to 5 are skipped.</P
832 >If the client has passed a username/password
833 pair and that username/password pair is validated by the UNIX
834 system's password programs then the connection is made as that
835 username. Note that this includes the
846 >If the client has previously registered a username
847 with the system and now supplies a correct password for that
848 username then the connection is allowed.</P
852 >The client's NetBIOS name and any previously
853 used user names are checked against the supplied password, if
854 they match then the connection is allowed as the corresponding
859 >If the client has previously validated a
860 username/password pair with the server and the client has passed
861 the validation token then that username is used. </P
865 >If a "user = " field is given in the
869 > file for the service and the client
870 has supplied a password, and that password matches (according to
871 the UNIX system's password checking) with one of the usernames
872 from the "user =" field then the connection is made as
873 the username in the "user =" line. If one
874 of the username in the "user =" list begins with a
875 '@' then that name expands to a list of names in
876 the group of the same name.</P
880 >If the service is a guest service then a
881 connection is made as the username given in the "guest
882 account =" for the service, irrespective of the
883 supplied password.</P
893 >COMPLETE LIST OF GLOBAL PARAMETERS</H2
895 >Here is a list of all global parameters. See the section of
896 each parameter for details. Note that some are synonyms.</P
903 HREF="index.html#ABORTSHUTDOWNSCRIPT"
907 >abort shutdown script</I
915 HREF="index.html#ADDGROUPSCRIPT"
927 HREF="index.html#ADDPRINTERCOMMAND"
931 >addprinter command</I
939 HREF="index.html#ADDSHARECOMMAND"
943 >add share command</I
951 HREF="index.html#ADDUSERSCRIPT"
963 HREF="index.html#ADDUSERTOGROUPSCRIPT"
967 >add user to group script</I
975 HREF="index.html#ADDMACHINESCRIPT"
979 >add machine script</I
987 HREF="index.html#DELETEGROUPSCRIPT"
991 >delete group script</I
999 HREF="index.html#ADSSERVER"
1011 HREF="index.html#ALGORITHMICRIDBASE"
1015 >algorithmic rid base</I
1023 HREF="index.html#ALLOWTRUSTEDDOMAINS"
1027 >allow trusted domains</I
1035 HREF="index.html#ANNOUNCEAS"
1047 HREF="index.html#ANNOUNCEVERSION"
1051 >announce version</I
1059 HREF="index.html#AUTHMETHODS"
1071 HREF="index.html#AUTOSERVICES"
1083 HREF="index.html#BINDINTERFACESONLY"
1087 >bind interfaces only</I
1095 HREF="index.html#BROWSELIST"
1107 HREF="index.html#CHANGENOTIFYTIMEOUT"
1111 >change notify timeout</I
1119 HREF="index.html#CHANGESHARECOMMAND"
1123 >change share command</I
1131 HREF="index.html#CONFIGFILE"
1143 HREF="index.html#DEADTIME"
1155 HREF="index.html#DEBUGHIRESTIMESTAMP"
1159 >debug hires timestamp</I
1167 HREF="index.html#DEBUGPID"
1179 HREF="index.html#DEBUGTIMESTAMP"
1191 HREF="index.html#DEBUGUID"
1203 HREF="index.html#DEBUGLEVEL"
1215 HREF="index.html#DEFAULT"
1227 HREF="index.html#DEFAULTSERVICE"
1239 HREF="index.html#DELETEPRINTERCOMMAND"
1243 >deleteprinter command</I
1251 HREF="index.html#DELETESHARECOMMAND"
1255 >delete share command</I
1263 HREF="index.html#DELETEUSERSCRIPT"
1267 >delete user script</I
1275 HREF="index.html#DELETEUSERFROMGROUPSCRIPT"
1279 >delete user from group script</I
1287 HREF="index.html#DFREECOMMAND"
1299 HREF="index.html#DISABLENETBIOS"
1311 HREF="index.html#DISABLESPOOLSS"
1323 HREF="index.html#DISPLAYCHARSET"
1335 HREF="index.html#DNSPROXY"
1347 HREF="index.html#DOMAINADMINGROUP"
1351 >domain admin group</I
1359 HREF="index.html#DOMAINGUESTGROUP"
1363 >domain guest group</I
1371 HREF="index.html#DOMAINLOGONS"
1383 HREF="index.html#DOMAINMASTER"
1395 HREF="index.html#DOSCHARSET"
1407 HREF="index.html#ENCRYPTPASSWORDS"
1411 >encrypt passwords</I
1419 HREF="index.html#ENHANCEDBROWSING"
1423 >enhanced browsing</I
1431 HREF="index.html#ENUMPORTSCOMMAND"
1435 >enumports command</I
1443 HREF="index.html#GETWDCACHE"
1455 HREF="index.html#HIDELOCALUSERS"
1459 >hide local users</I
1467 HREF="index.html#HIDEUNREADABLE"
1479 HREF="index.html#HIDEUNWRITEABLEFILES"
1483 >hide unwriteable files</I
1491 HREF="index.html#HOMEDIRMAP"
1503 HREF="index.html#HOSTMSDFS"
1515 HREF="index.html#HOSTNAMELOOKUPS"
1519 >hostname lookups</I
1527 HREF="index.html#HOSTSEQUIV"
1539 HREF="index.html#INTERFACES"
1551 HREF="index.html#KEEPALIVE"
1563 HREF="index.html#KERNELOPLOCKS"
1575 HREF="index.html#LANMANAUTH"
1587 HREF="index.html#LARGEREADWRITE"
1599 HREF="index.html#LDAPADMINDN"
1611 HREF="index.html#LDAPFILTER"
1623 HREF="index.html#LDAPSSL"
1635 HREF="index.html#LDAPSUFFIX"
1647 HREF="index.html#LDAPUSERSUFFIX"
1659 HREF="index.html#LDAPMACHINESUFFIX"
1671 HREF="index.html#LMANNOUNCE"
1683 HREF="index.html#LMINTERVAL"
1695 HREF="index.html#LOADPRINTERS"
1707 HREF="index.html#LOCALMASTER"
1719 HREF="index.html#LOCKDIR"
1731 HREF="index.html#LOCKDIRECTORY"
1743 HREF="index.html#LOCKSPINCOUNT"
1755 HREF="index.html#LOCKSPINTIME"
1767 HREF="index.html#PIDDIRECTORY"
1779 HREF="index.html#LOGFILE"
1791 HREF="index.html#LOGLEVEL"
1803 HREF="index.html#LOGONDRIVE"
1815 HREF="index.html#LOGONHOME"
1827 HREF="index.html#LOGONPATH"
1839 HREF="index.html#LOGONSCRIPT"
1851 HREF="index.html#LPQCACHETIME"
1863 HREF="index.html#MACHINEPASSWORDTIMEOUT"
1867 >machine password timeout</I
1875 HREF="index.html#MANGLEDSTACK"
1887 HREF="index.html#MAPTOGUEST"
1899 HREF="index.html#MAXDISKSIZE"
1911 HREF="index.html#MAXLOGSIZE"
1923 HREF="index.html#MAXMUX"
1935 HREF="index.html#MAXOPENFILES"
1947 HREF="index.html#MAXPROTOCOL"
1959 HREF="index.html#MAXSMBDPROCESSES"
1963 >max smbd processes</I
1971 HREF="index.html#MAXTTL"
1983 HREF="index.html#MAXWINSTTL"
1995 HREF="index.html#MAXXMIT"
2007 HREF="index.html#MESSAGECOMMAND"
2019 HREF="index.html#MINPASSWDLENGTH"
2023 >min passwd length</I
2031 HREF="index.html#MINPASSWORDLENGTH"
2035 >min password length</I
2043 HREF="index.html#MINPROTOCOL"
2055 HREF="index.html#MINWINSTTL"
2067 HREF="index.html#NAMECACHETIMEOUT"
2071 >name cache timeout</I
2079 HREF="index.html#NAMERESOLVEORDER"
2083 >name resolve order</I
2091 HREF="index.html#NETBIOSALIASES"
2103 HREF="index.html#NETBIOSNAME"
2115 HREF="index.html#NETBIOSSCOPE"
2127 HREF="index.html#NISHOMEDIR"
2139 HREF="index.html#NTLMAUTH"
2151 HREF="index.html#NONUNIXACCOUNTRANGE"
2155 >non unix account range</I
2163 HREF="index.html#NTPIPESUPPORT"
2175 HREF="index.html#NTSTATUSSUPPORT"
2179 >nt status support</I
2187 HREF="index.html#NULLPASSWORDS"
2199 HREF="index.html#OBEYPAMRESTRICTIONS"
2203 >obey pam restrictions</I
2211 HREF="index.html#OPLOCKBREAKWAITTIME"
2215 >oplock break wait time</I
2223 HREF="index.html#OSLEVEL"
2235 HREF="index.html#OS2DRIVERMAP"
2247 HREF="index.html#PAMPASSWORDCHANGE"
2251 >pam password change</I
2259 HREF="index.html#PANICACTION"
2271 HREF="index.html#PARANOIDSERVERSECURITY"
2275 >paranoid server security</I
2283 HREF="index.html#PASSDBBACKEND"
2295 HREF="index.html#PASSWDCHAT"
2307 HREF="index.html#PASSWDCHATDEBUG"
2311 >passwd chat debug</I
2319 HREF="index.html#PASSWDPROGRAM"
2331 HREF="index.html#PASSWORDLEVEL"
2343 HREF="index.html#PASSWORDSERVER"
2355 HREF="index.html#PREFEREDMASTER"
2367 HREF="index.html#PREFERREDMASTER"
2371 >preferred master</I
2379 HREF="index.html#PRELOAD"
2391 HREF="index.html#PRINTCAP"
2403 HREF="index.html#PRINTCAPNAME"
2415 HREF="index.html#PRINTERDRIVERFILE"
2419 >printer driver file</I
2427 HREF="index.html#PRIVATEDIR"
2439 HREF="index.html#PROTOCOL"
2451 HREF="index.html#READBMPX"
2463 HREF="index.html#READRAW"
2475 HREF="index.html#READSIZE"
2487 HREF="index.html#REALM"
2499 HREF="index.html#REMOTEANNOUNCE"
2511 HREF="index.html#REMOTEBROWSESYNC"
2515 >remote browse sync</I
2523 HREF="index.html#RESTRICTANONYMOUS"
2527 >restrict anonymous</I
2535 HREF="index.html#ROOT"
2547 HREF="index.html#ROOTDIR"
2559 HREF="index.html#ROOTDIRECTORY"
2571 HREF="index.html#SECURITY"
2583 HREF="index.html#SERVERSTRING"
2595 HREF="index.html#SHOWADDPRINTERWIZARD"
2599 >show add printer wizard</I
2607 HREF="index.html#SHUTDOWNSCRIPT"
2619 HREF="index.html#SMBPASSWDFILE"
2631 HREF="index.html#SMBPORTS"
2643 HREF="index.html#SOCKETADDRESS"
2655 HREF="index.html#SOCKETOPTIONS"
2667 HREF="index.html#SOURCEENVIRONMENT"
2671 >source environment</I
2679 HREF="index.html#SPNEGO"
2691 HREF="index.html#STATCACHE"
2703 HREF="index.html#STATCACHESIZE"
2715 HREF="index.html#STRIPDOT"
2727 HREF="index.html#SYSLOG"
2739 HREF="index.html#SYSLOGONLY"
2751 HREF="index.html#TEMPLATEHOMEDIR"
2755 >template homedir</I
2763 HREF="index.html#TEMPLATESHELL"
2775 HREF="index.html#TIMEOFFSET"
2787 HREF="index.html#TIMESERVER"
2799 HREF="index.html#TIMESTAMPLOGS"
2811 HREF="index.html#TOTALPRINTJOBS"
2815 >total print jobs</I
2823 HREF="index.html#UNICODE"
2835 HREF="index.html#UNIXCHARSET"
2847 HREF="index.html#UNIXEXTENSIONS"
2859 HREF="index.html#UNIXPASSWORDSYNC"
2863 >unix password sync</I
2871 HREF="index.html#UPDATEENCRYPTED"
2875 >update encrypted</I
2883 HREF="index.html#USEMMAP"
2895 HREF="index.html#USERHOSTS"
2907 HREF="index.html#USERNAMELEVEL"
2919 HREF="index.html#USERNAMEMAP"
2931 HREF="index.html#UTMP"
2943 HREF="index.html#UTMPDIRECTORY"
2955 HREF="index.html#WTMPDIRECTORY"
2967 HREF="index.html#WINBINDCACHETIME"
2971 >winbind cache time</I
2979 HREF="index.html#WINBINDENUMUSERS"
2983 >winbind enum users</I
2991 HREF="index.html#WINBINDENUMGROUPS"
2995 >winbind enum groups</I
3003 HREF="index.html#WINBINDGID"
3015 HREF="index.html#WINBINDSEPARATOR"
3019 >winbind separator</I
3027 HREF="index.html#WINBINDUID"
3039 HREF="index.html#WINBINDUSEDEFAULTDOMAIN"
3043 >winbind use default domain</I
3051 HREF="index.html#WINSHOOK"
3063 HREF="index.html#WINSPARTNERS"
3075 HREF="index.html#WINSPROXY"
3087 HREF="index.html#WINSSERVER"
3099 HREF="index.html#WINSSUPPORT"
3111 HREF="index.html#WORKGROUP"
3123 HREF="index.html#WRITERAW"
3140 >COMPLETE LIST OF SERVICE PARAMETERS</H2
3142 >Here is a list of all service parameters. See the section on
3143 each parameter for details. Note that some are synonyms.</P
3150 HREF="index.html#ADMINUSERS"
3162 HREF="index.html#ALLOWHOSTS"
3174 HREF="index.html#AVAILABLE"
3186 HREF="index.html#BLOCKINGLOCKS"
3198 HREF="index.html#BLOCKSIZE"
3210 HREF="index.html#BROWSABLE"
3222 HREF="index.html#BROWSEABLE"
3234 HREF="index.html#CASESENSITIVE"
3246 HREF="index.html#CASESIGNAMES"
3258 HREF="index.html#COMMENT"
3270 HREF="index.html#COPY"
3282 HREF="index.html#CREATEMASK"
3294 HREF="index.html#CREATEMODE"
3306 HREF="index.html#CSCPOLICY"
3318 HREF="index.html#DEFAULTCASE"
3330 HREF="index.html#DEFAULTDEVMODE"
3342 HREF="index.html#DELETEREADONLY"
3354 HREF="index.html#DELETEVETOFILES"
3358 >delete veto files</I
3366 HREF="index.html#DENYHOSTS"
3378 HREF="index.html#DIRECTORY"
3390 HREF="index.html#DIRECTORYMASK"
3402 HREF="index.html#DIRECTORYMODE"
3414 HREF="index.html#DIRECTORYSECURITYMASK"
3418 >directory security mask</I
3426 HREF="index.html#DONTDESCEND"
3438 HREF="index.html#DOSFILEMODE"
3450 HREF="index.html#DOSFILETIMERESOLUTION"
3454 >dos filetime resolution</I
3462 HREF="index.html#DOSFILETIMES"
3474 HREF="index.html#EXEC"
3486 HREF="index.html#FAKEDIRECTORYCREATETIMES"
3490 >fake directory create times</I
3498 HREF="index.html#FAKEOPLOCKS"
3510 HREF="index.html#FOLLOWSYMLINKS"
3522 HREF="index.html#FORCECREATEMODE"
3526 >force create mode</I
3534 HREF="index.html#FORCEDIRECTORYMODE"
3538 >force directory mode</I
3546 HREF="index.html#FORCEDIRECTORYSECURITYMODE"
3550 >force directory security mode</I
3558 HREF="index.html#FORCEGROUP"
3570 HREF="index.html#FORCESECURITYMODE"
3574 >force security mode</I
3582 HREF="index.html#FORCEUSER"
3594 HREF="index.html#FSTYPE"
3606 HREF="index.html#GROUP"
3618 HREF="index.html#GUESTACCOUNT"
3630 HREF="index.html#GUESTOK"
3642 HREF="index.html#GUESTONLY"
3654 HREF="index.html#HIDEDOTFILES"
3666 HREF="index.html#HIDEFILES"
3678 HREF="index.html#HOSTSALLOW"
3690 HREF="index.html#HOSTSDENY"
3702 HREF="index.html#INCLUDE"
3714 HREF="index.html#INHERITACLS"
3726 HREF="index.html#INHERITPERMISSIONS"
3730 >inherit permissions</I
3738 HREF="index.html#INVALIDUSERS"
3750 HREF="index.html#LEVEL2OPLOCKS"
3762 HREF="index.html#LOCKING"
3774 HREF="index.html#LPPAUSECOMMAND"
3786 HREF="index.html#LPQCOMMAND"
3798 HREF="index.html#LPRESUMECOMMAND"
3802 >lpresume command</I
3810 HREF="index.html#LPRMCOMMAND"
3822 HREF="index.html#MAGICOUTPUT"
3834 HREF="index.html#MAGICSCRIPT"
3846 HREF="index.html#MANGLECASE"
3858 HREF="index.html#MANGLEDMAP"
3870 HREF="index.html#MANGLEDNAMES"
3882 HREF="index.html#MANGLINGCHAR"
3894 HREF="index.html#MANGLINGMETHOD"
3906 HREF="index.html#MAPARCHIVE"
3918 HREF="index.html#MAPHIDDEN"
3930 HREF="index.html#MAPSYSTEM"
3942 HREF="index.html#MAXCONNECTIONS"
3954 HREF="index.html#MAXPRINTJOBS"
3966 HREF="index.html#MINPRINTSPACE"
3978 HREF="index.html#MSDFSROOT"
3990 HREF="index.html#NTACLSUPPORT"
4002 HREF="index.html#ONLYGUEST"
4014 HREF="index.html#ONLYUSER"
4026 HREF="index.html#OPLOCKCONTENTIONLIMIT"
4030 >oplock contention limit</I
4038 HREF="index.html#OPLOCKS"
4050 HREF="index.html#PATH"
4062 HREF="index.html#POSIXLOCKING"
4074 HREF="index.html#POSTEXEC"
4086 HREF="index.html#POSTSCRIPT"
4098 HREF="index.html#PREEXEC"
4110 HREF="index.html#PREEXECCLOSE"
4122 HREF="index.html#PRESERVECASE"
4134 HREF="index.html#PRINTCOMMAND"
4146 HREF="index.html#PRINTOK"
4158 HREF="index.html#PRINTABLE"
4170 HREF="index.html#PRINTER"
4182 HREF="index.html#PRINTERADMIN"
4194 HREF="index.html#PRINTERDRIVER"
4206 HREF="index.html#PRINTERDRIVERLOCATION"
4210 >printer driver location</I
4218 HREF="index.html#PRINTERNAME"
4230 HREF="index.html#PRINTING"
4242 HREF="index.html#PUBLIC"
4254 HREF="index.html#QUEUEPAUSECOMMAND"
4258 >queuepause command</I
4266 HREF="index.html#QUEUERESUMECOMMAND"
4270 >queueresume command</I
4278 HREF="index.html#READLIST"
4290 HREF="index.html#READONLY"
4302 HREF="index.html#ROOTPOSTEXEC"
4314 HREF="index.html#ROOTPREEXEC"
4326 HREF="index.html#ROOTPREEXECCLOSE"
4330 >root preexec close</I
4338 HREF="index.html#SECURITYMASK"
4350 HREF="index.html#SETDIRECTORY"
4362 HREF="index.html#SHAREMODES"
4374 HREF="index.html#SHORTPRESERVECASE"
4378 >short preserve case</I
4386 HREF="index.html#STATUS"
4398 HREF="index.html#STRICTALLOCATE"
4410 HREF="index.html#STRICTLOCKING"
4422 HREF="index.html#STRICTSYNC"
4434 HREF="index.html#SYNCALWAYS"
4446 HREF="index.html#USECLIENTDRIVER"
4450 >use client driver</I
4458 HREF="index.html#USER"
4470 HREF="index.html#USERNAME"
4482 HREF="index.html#USERS"
4494 HREF="index.html#VALIDUSERS"
4506 HREF="index.html#VETOFILES"
4518 HREF="index.html#VETOOPLOCKFILES"
4522 >veto oplock files</I
4530 HREF="index.html#VFSPATH"
4542 HREF="index.html#VFSOBJECT"
4554 HREF="index.html#VFSOPTIONS"
4566 HREF="index.html#VOLUME"
4578 HREF="index.html#WIDELINKS"
4590 HREF="index.html#WRITABLE"
4602 HREF="index.html#WRITECACHESIZE"
4606 >write cache size</I
4614 HREF="index.html#WRITELIST"
4626 HREF="index.html#WRITEOK"
4638 HREF="index.html#WRITEABLE"
4655 >EXPLANATION OF EACH PARAMETER</H2
4659 CLASS="VARIABLELIST"
4663 NAME="ABORTSHUTDOWNSCRIPT"
4665 >abort shutdown script (G)</DT
4672 >This parameter only exists in the HEAD cvs branch</I
4675 This a full path name to a script called by
4684 should stop a shutdown procedure issued by the <A
4685 HREF="index.html#SHUTDOWNSCRIPT"
4694 >This command will be run as user.</P
4706 >abort shutdown script = /sbin/shutdown -c</B
4711 NAME="ADDPRINTERCOMMAND"
4713 >addprinter command (G)</DT
4716 >With the introduction of MS-RPC based printing
4717 support for Windows NT/2000 clients in Samba 2.2, The MS Add
4718 Printer Wizard (APW) icon is now also available in the
4719 "Printers..." folder displayed a share listing. The APW
4720 allows for printers to be add remotely to a Samba or Windows
4721 NT/2000 print server.</P
4723 >For a Samba host this means that the printer must be
4724 physically added to the underlying printing system. The <TT
4730 > defines a script to be run which
4731 will perform the necessary operations for adding the printer
4732 to the print system and to add the appropriate service definition
4736 > file in order that it can be
4750 >addprinter command</I
4753 automatically invoked with the following parameter (in
4808 >Windows 9x driver location</I
4815 >All parameters are filled in from the PRINTER_INFO_2 structure sent
4816 by the Windows NT/2000 client with one exception. The "Windows 9x
4817 driver location" parameter is included for backwards compatibility
4818 only. The remaining fields in the structure are generated from answers
4819 to the APW questions.</P
4824 >addprinter command</I
4830 > will reparse the <TT
4833 > to determine if the share defined by the APW
4834 exists. If the sharename is still invalid, then <B
4838 > will return an ACCESS_DENIED error to the client.</P
4841 HREF="index.html#DELETEPRINTERCOMMAND"
4845 > deleteprinter command</I
4849 HREF="index.html#PRINTING"
4858 HREF="index.html#SHOWADDPRINTERWIZARD"
4878 >addprinter command = /usr/bin/addprinter
4884 NAME="ADDSHARECOMMAND"
4886 >add share command (G)</DT
4889 >Samba 2.2.0 introduced the ability to dynamically
4890 add and delete shares via the Windows NT 4.0 Server Manager. The
4894 >add share command</I
4896 > is used to define an
4897 external program or script which will add a new service definition
4901 >. In order to successfully
4905 >add share command</I
4911 requires that the administrator be connected using a root account (i.e.
4918 > will automatically invoke the
4922 >add share command</I
4924 > with four parameters.
4950 > - the name of the new
4961 > - path to an **existing**
4972 > - comment string to associate
4978 > This parameter is only used for add file shares. To add printer shares,
4980 HREF="index.html#ADDPRINTERCOMMAND"
4992 HREF="index.html#CHANGESHARECOMMAND"
5001 HREF="index.html#DELETESHARECOMMAND"
5022 >add share command = /usr/local/bin/addshare</B
5027 NAME="ADDMACHINESCRIPT"
5029 >add machine script (G)</DT
5032 >This is the full pathname to a script that will
5037 > when a machine is added
5038 to it's domain using the administrator username and password method. </P
5040 >This option is only required when using sam back-ends tied to the
5041 Unix uid method of RID calculation such as smbpasswd. This option is only
5042 available in Samba 3.0.</P
5046 >add machine script = <empty string>
5052 >add machine script = /usr/sbin/adduser -n -g machines -c Machine -d /dev/null -s /bin/false %u
5063 >If this option is specified, samba does
5064 not try to figure out what ads server to use itself, but
5065 uses the specified ads server. Either one DNS name or IP
5066 address can be used.</P
5075 >ads server = 192.168.1.2</B
5080 NAME="ADDUSERSCRIPT"
5082 >add user script (G)</DT
5085 >This is the full pathname to a script that will
5097 > under special circumstances described below.</P
5099 >Normally, a Samba server requires that UNIX users are
5100 created for all users accessing files on this server. For sites
5101 that use Windows NT account databases as their primary user database
5102 creating these users and keeping the user list in sync with the
5103 Windows NT PDC is an onerous task. This option allows <A
5107 > to create the required UNIX users
5114 > when a user accesses the Samba server.</P
5116 >In order to use this option, <A
5130 >security = share</I
5139 must be set to a full pathname for a script that will create a UNIX
5140 user given one argument of <TT
5145 >, which expands into
5146 the UNIX user name to create.</P
5148 >When the Windows user attempts to access the Samba server,
5149 at login (session setup in the SMB protocol) time, <A
5159 attempts to authenticate the given user with the given password. If the
5160 authentication succeeds then <B
5164 attempts to find a UNIX user in the UNIX password database to map the
5165 Windows user into. If this lookup fails, and <TT
5175 call the specified script <SPAN
5187 > argument to be the user name to create.</P
5189 >If this script successfully creates the user then <B
5193 > will continue on as though the UNIX user
5194 already existed. In this way, UNIX users are dynamically created to
5195 match existing Windows NT accounts.</P
5198 HREF="index.html#SECURITY"
5206 HREF="index.html#PASSWORDSERVER"
5215 HREF="index.html#DELETEUSERSCRIPT"
5227 >add user script = <empty string>
5233 >add user script = /usr/local/samba/bin/add_user
5239 NAME="ADDGROUPSCRIPT"
5241 >add group script (G)</DT
5244 >This is the full pathname to a script that will
5255 > when a new group is requested. It will expand any <TT
5260 > to the group name passed. This script is only useful for installations using the Windows NT domain administration tools.
5267 >admin users (S)</DT
5270 >This is a list of users who will be granted
5271 administrative privileges on the share. This means that they
5272 will do all file operations as the super-user (root).</P
5274 >You should use this option very carefully, as any user in
5275 this list will be able to do anything they like on the share,
5276 irrespective of file permissions.</P
5288 >admin users = jason</B
5293 NAME="ADDUSERTOGROUPSCRIPT"
5295 >add user to group script (G)</DT
5298 >Full path to the script that will be called when
5299 a user is added to a group using the Windows NT domain administration
5300 tools. It will be run by <A
5317 replaced with the group name and any <TT
5323 be replaced with the user name.
5328 >add user to group script = </B
5333 >add user to group script = /usr/sbin/adduser %u %g</B
5340 >allow hosts (S)</DT
5344 HREF="index.html#HOSTSALLOW"
5355 NAME="ALGORITHMICRIDBASE"
5357 >algorithmic rid base (G)</DT
5360 >This determines how Samba will use its
5361 algorithmic mapping from uids/gid to the RIDs needed to construct
5362 NT Security Identifiers.</P
5364 >Setting this option to a larger value could be useful to sites
5365 transitioning from WinNT and Win2k, as existing user and
5366 group rids would otherwise clash with sytem users etc.
5369 >All UIDs and GIDs must be able to be resolved into SIDs for
5370 the correct operation of ACLs on the server. As such the algorithmic
5371 mapping can't be 'turned off', but pushing it 'out of the way' should
5372 resolve the issues. Users and groups can then be assigned 'low' RIDs
5373 in arbitary-rid supporting backends. </P
5377 >algorithmic rid base = 1000</B
5382 >algorithmic rid base = 100000</B
5387 NAME="ALLOWTRUSTEDDOMAINS"
5389 >allow trusted domains (G)</DT
5392 >This option only takes effect when the <A
5393 HREF="index.html#SECURITY"
5408 If it is set to no, then attempts to connect to a resource from
5409 a domain or workgroup other than the one which <A
5414 in will fail, even if that domain is trusted by the remote server
5415 doing the authentication.</P
5417 >This is useful if you only want your Samba server to
5418 serve resources to users in the domain it is a member of. As
5419 an example, suppose that there are two domains DOMA and DOMB. DOMB
5420 is trusted by DOMA, which contains the Samba server. Under normal
5421 circumstances, a user with an account in DOMB can then access the
5422 resources of a UNIX account with the same account name on the
5423 Samba server even if they do not have an account in DOMA. This
5424 can make implementing a security boundary difficult.</P
5428 >allow trusted domains = yes</B
5435 >announce as (G)</DT
5438 >This specifies what type of server
5447 will announce itself as, to a network neighborhood browse
5448 list. By default this is set to Windows NT. The valid options
5449 are : "NT Server" (which can also be written as "NT"),
5450 "NT Workstation", "Win95" or "WfW" meaning Windows NT Server,
5451 Windows NT Workstation, Windows 95 and Windows for Workgroups
5452 respectively. Do not change this parameter unless you have a
5453 specific need to stop Samba appearing as an NT server as this
5454 may prevent Samba servers from participating as browser servers
5459 >announce as = NT Server</B
5464 >announce as = Win95</B
5469 NAME="ANNOUNCEVERSION"
5471 >announce version (G)</DT
5474 >This specifies the major and minor version numbers
5475 that nmbd will use when announcing itself as a server. The default
5476 is 4.2. Do not change this parameter unless you have a specific
5477 need to set a Samba server to be a downlevel server.</P
5481 >announce version = 4.5</B
5486 >announce version = 2.0</B
5493 >auto services (G)</DT
5496 >This is a synonym for the <A
5497 HREF="index.html#PRELOAD"
5510 >auth methods (G)</DT
5513 >This option allows the administrator to chose what
5514 authentication methods <B
5517 > will use when authenticating
5518 a user. This option defaults to sensible values based on <A
5519 HREF="index.html#SECURITY"
5528 Each entry in the list attempts to authenticate the user in turn, until
5529 the user authenticates. In practice only one method will ever actually
5530 be able to complete the authentication.
5535 >auth methods = <empty string></B
5540 >auth methods = guest sam ntdomain</B
5550 >This parameter lets you "turn off" a service. If
5563 attempts to connect to the service will fail. Such failures are
5573 NAME="BINDINTERFACESONLY"
5575 >bind interfaces only (G)</DT
5578 >This global parameter allows the Samba admin
5579 to limit what interfaces on a machine will serve SMB requests. If
5580 affects file service <A
5592 >For name service it causes <B
5596 to ports 137 and 138 on the interfaces listed in the <A
5597 HREF="index.html#INTERFACES"
5603 > also binds to the "all addresses" interface (0.0.0.0)
5604 on ports 137 and 138 for the purposes of reading broadcast messages.
5605 If this option is not set then <B
5609 name requests on all of these sockets. If <TT
5619 source address of any packets coming in on the broadcast sockets
5620 and discard any that don't match the broadcast addresses of the
5621 interfaces in the <TT
5627 As unicast packets are received on the other sockets it allows
5631 > to refuse to serve names to machines that
5632 send packets that arrive through any interfaces not listed in the
5638 > list. IP Source address spoofing
5639 does defeat this simple check, however so it must not be used
5640 seriously as a security feature for <B
5645 >For file service it causes <A
5650 to bind only to the interface list given in the <A
5651 HREF="index.html#INTERFACES"
5653 > parameter. This restricts the networks that
5657 > will serve to packets coming in those
5658 interfaces. Note that you should not use this parameter for machines
5659 that are serving PPP or other intermittent or non-broadcast network
5660 interfaces as it will not cope with non-permanent interfaces.</P
5665 >bind interfaces only</I
5668 unless the network address <SPAN
5681 HREF="smbpasswd.8.html"
5696 not work as expected due to the reasons covered below.</P
5698 >To change a users SMB password, the <B
5702 by default connects to the <SPAN
5706 >localhost - 127.0.0.1</I
5709 address as an SMB client to issue the password change request. If
5713 >bind interfaces only</I
5715 > is set then unless the
5716 network address <SPAN
5728 > parameter list then <B
5731 > will fail to connect in it's default mode.
5735 > can be forced to use the primary IP interface
5736 of the local host by using its <A
5737 HREF="smbpasswd.8.html#minusr"
5751 > parameter, with <TT
5757 to the IP name of the primary interface of the local host.</P
5762 > status page tries to connect with
5776 > to determine if they are running.
5790 "not running" even if they really are. This can prevent <B
5793 > from starting/stopping/restarting <B
5804 >bind interfaces only = no</B
5809 NAME="BLOCKINGLOCKS"
5811 >blocking locks (S)</DT
5814 >This parameter controls the behavior of <A
5818 > when given a request by a client
5819 to obtain a byte range lock on a region of an open file, and the
5820 request has a time limit associated with it.</P
5822 >If this parameter is set and the lock range requested
5823 cannot be immediately satisfied, Samba 2.2 will internally
5824 queue the lock request, and periodically attempt to obtain
5825 the lock until the timeout period expires.</P
5827 >If this parameter is set to <TT
5831 Samba 2.2 will behave as previous versions of Samba would and
5832 will fail the lock request immediately if the lock range
5833 cannot be obtained.</P
5837 >blocking locks = yes</B
5847 >This parameter controls the behavior of
5852 > when reporting disk free
5853 sizes. By default, this reports a disk block size of 1024 bytes.
5856 >Changing this parameter may have some effect on the
5857 efficiency of client writes, this is not yet confirmed. This
5858 parameter was added to allow advanced administrators to change
5859 it (usually to a higher value) and test the effect it has on
5860 client write performance without re-compiling the code. As this
5861 is an experimental option it may be removed in a future release.
5864 >Changing this option does not change the disk free reporting
5865 size, just the block size unit reported to the client.</P
5869 >block size = 1024</B
5874 >block size = 65536</B
5885 HREF="index.html#BROWSEABLE"
5898 >browse list (G)</DT
5901 >This controls whether <A
5908 > will serve a browse list to
5916 >. You should never need to change
5921 >browse list = yes</B
5931 >This controls whether this share is seen in
5932 the list of available shares in a net view and in the browse list.</P
5936 >browseable = yes</B
5941 NAME="CASESENSITIVE"
5943 >case sensitive (S)</DT
5946 >See the discussion in the section <A
5947 HREF="index.html#AEN203"
5953 >case sensitive = no</B
5960 >casesignames (S)</DT
5964 HREF="index.html#CASESENSITIVE"
5971 NAME="CHANGENOTIFYTIMEOUT"
5973 >change notify timeout (G)</DT
5976 >This SMB allows a client to tell a server to
5977 "watch" a particular directory for any changes and only reply to
5978 the SMB request when a change has occurred. Such constant scanning of
5979 a directory is expensive under UNIX, hence an <A
5986 > daemon only performs such a scan
5987 on each requested directory once every <TT
5997 >change notify timeout = 60</B
6002 >change notify timeout = 300</B
6005 >Would change the scan time to every 5 minutes.</P
6009 NAME="CHANGESHARECOMMAND"
6011 >change share command (G)</DT
6014 >Samba 2.2.0 introduced the ability to dynamically
6015 add and delete shares via the Windows NT 4.0 Server Manager. The
6019 >change share command</I
6021 > is used to define an
6022 external program or script which will modify an existing service definition
6026 >. In order to successfully
6030 >change share command</I
6036 requires that the administrator be connected using a root account (i.e.
6043 > will automatically invoke the
6047 >change share command</I
6049 > with four parameters.
6075 > - the name of the new
6086 > - path to an **existing**
6097 > - comment string to associate
6103 > This parameter is only used modify existing file shares definitions. To modify
6104 printer shares, use the "Printers..." folder as seen when browsing the Samba host.
6108 HREF="index.html#ADDSHARECOMMAND"
6117 HREF="index.html#DELETESHARECOMMAND"
6138 >change share command = /usr/local/bin/addshare</B
6148 >This is a text field that is seen next to a share
6149 when a client does a queries the server, either via the network
6150 neighborhood or via <B
6153 > to list what shares
6156 >If you want to set the string that is displayed next to the
6157 machine name then see the <A
6158 HREF="index.html#SERVERSTRING"
6171 >No comment string</I
6177 >comment = Fred's Files</B
6184 >config file (G)</DT
6187 >This allows you to override the config file
6188 to use, instead of the default (usually <TT
6192 There is a chicken and egg problem here as this option is set
6193 in the config file!</P
6195 >For this reason, if the name of the config file has changed
6196 when the parameters are loaded then it will reload them from
6197 the new config file.</P
6199 >This option takes the usual substitutions, which can
6202 >If the config file doesn't exist then it won't be loaded
6203 (allowing you to special case the config files of just a few
6208 >config file = /usr/local/samba/lib/smb.conf.%m
6219 >This parameter allows you to "clone" service
6220 entries. The specified service is simply duplicated under the
6221 current service's name. Any parameters specified in the current
6222 section will override those in the section being copied.</P
6224 >This feature lets you set up a 'template' service and
6225 create similar services easily. Note that the service being
6226 copied must occur earlier in the configuration file than the
6227 service doing the copying.</P
6239 >copy = otherservice</B
6246 >create mask (S)</DT
6249 >A synonym for this parameter is
6251 HREF="index.html#CREATEMODE"
6261 >When a file is created, the necessary permissions are
6262 calculated according to the mapping from DOS modes to UNIX
6263 permissions, and the resulting UNIX mode is then bit-wise 'AND'ed
6264 with this parameter. This parameter may be thought of as a bit-wise
6265 MASK for the UNIX modes of a file. Any bit <SPAN
6272 set here will be removed from the modes set on a file when it is
6275 >The default value of this parameter removes the
6276 'group' and 'other' write and execute bits from the UNIX modes.</P
6278 >Following this Samba will bit-wise 'OR' the UNIX mode created
6279 from this parameter with the value of the <A
6280 HREF="index.html#FORCECREATEMODE"
6284 >force create mode</I
6288 parameter which is set to 000 by default.</P
6290 >This parameter does not affect directory modes. See the
6292 HREF="index.html#DIRECTORYMODE"
6303 HREF="index.html#FORCECREATEMODE"
6311 > parameter for forcing particular mode
6312 bits to be set on created files. See also the <A
6313 HREF="index.html#DIRECTORYMODE"
6320 > parameter for masking
6321 mode bits on created directories. See also the <A
6322 HREF="index.html#INHERITPERMISSIONS"
6326 >inherit permissions</I
6331 >Note that this parameter does not apply to permissions
6332 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
6333 a mask on access control lists also, they need to set the <A
6334 HREF="index.html#SECURITYMASK"
6345 >create mask = 0744</B
6350 >create mask = 0775</B
6357 >create mode (S)</DT
6360 >This is a synonym for <A
6361 HREF="index.html#CREATEMASK"
6377 >This stands for <SPAN
6381 >client-side caching
6384 >, and specifies how clients capable of offline
6385 caching will cache the files in the share. The valid values
6386 are: manual, documents, programs, disable.</P
6388 >These values correspond to those used on Windows
6391 >For example, shares containing roaming profiles can have
6392 offline caching disabled using <B
6394 >csc policy = disable
6400 >csc policy = manual</B
6405 >csc policy = programs</B
6415 >The value of the parameter (a decimal integer)
6416 represents the number of minutes of inactivity before a connection
6417 is considered dead, and it is disconnected. The deadtime only takes
6418 effect if the number of open files is zero.</P
6420 >This is useful to stop a server's resources being
6421 exhausted by a large number of inactive connections.</P
6423 >Most clients have an auto-reconnect feature when a
6424 connection is broken so in most cases this parameter should be
6425 transparent to users.</P
6427 >Using this parameter with a timeout of a few minutes
6428 is recommended for most systems.</P
6430 >A deadtime of zero indicates that no auto-disconnection
6431 should be performed.</P
6445 NAME="DEBUGHIRESTIMESTAMP"
6447 >debug hires timestamp (G)</DT
6450 >Sometimes the timestamps in the log messages
6451 are needed with a resolution of higher that seconds, this
6452 boolean parameter adds microsecond resolution to the timestamp
6453 message header when turned on.</P
6455 >Note that the parameter <A
6456 HREF="index.html#DEBUGTIMESTAMP"
6460 > debug timestamp</I
6463 > must be on for this to have an
6468 >debug hires timestamp = no</B
6478 >When using only one log file for more then one
6483 >-process there may be hard to follow which process
6484 outputs which message. This boolean parameter is adds the process-id
6485 to the timestamp message headers in the logfile when turned on.</P
6487 >Note that the parameter <A
6488 HREF="index.html#DEBUGTIMESTAMP"
6492 > debug timestamp</I
6495 > must be on for this to have an
6505 NAME="DEBUGTIMESTAMP"
6507 >debug timestamp (G)</DT
6510 >Samba 2.2 debug log messages are timestamped
6511 by default. If you are running at a high <A
6512 HREF="index.html#DEBUGLEVEL"
6520 can be distracting. This boolean parameter allows timestamping
6521 to be turned off.</P
6525 >debug timestamp = yes</B
6535 >Samba is sometimes run as root and sometime
6536 run as the connected user, this boolean parameter inserts the
6537 current euid, egid, uid and gid to the timestamp message headers
6538 in the log file if turned on.</P
6540 >Note that the parameter <A
6541 HREF="index.html#DEBUGTIMESTAMP"
6545 > debug timestamp</I
6548 > must be on for this to have an
6564 HREF="index.html#LOGLEVEL"
6581 HREF="index.html#DEFAULTSERVICE"
6585 > default service</I
6594 >default case (S)</DT
6597 >See the section on <A
6598 HREF="index.html#AEN203"
6601 HREF="index.html#SHORTPRESERVECASE"
6605 >short preserve case</I
6612 >default case = lower</B
6617 NAME="DEFAULTDEVMODE"
6619 >default devmode (S)</DT
6622 >This parameter is only applicable to <A
6623 HREF="index.html#PRINTOK"
6625 > services. When smbd is serving
6626 Printer Drivers to Windows NT/2k/XP clients, each printer on the Samba
6627 server has a Device Mode which defines things such as paper size and
6628 orientation and duplex settings. The device mode can only correctly be
6629 generated by the printer driver itself (which can only be executed on a
6630 Win32 platform). Because smbd is unable to execute the driver code
6631 to generate the device mode, the default behavior is to set this field
6635 >Most problems with serving printer drivers to Windows NT/2k/XP clients
6636 can be traced to a problem with the generated device mode. Certain drivers
6637 will do things such as crashing the client's Explorer.exe with a NULL devmode.
6638 However, other printer drivers can cause the client's spooler service
6639 (spoolsv.exe) to die if the devmode was not created by the driver itself
6640 (i.e. smbd generates a default devmode).
6643 >This parameter should be used with care and tested with the printer
6644 driver in question. It is better to leave the device mode to NULL
6645 and let the Windows client set the correct values. Because drivers do not
6646 do this all the time, setting <B
6648 >default devmode = yes</B
6650 will instruct smbd to generate a default one.
6653 >For more information on Windows NT/2k printing and Device Modes,
6655 HREF="http://msdn.microsoft.com/"
6657 >MSDN documentation</A
6663 >default devmode = no</B
6668 NAME="DEFAULTSERVICE"
6670 >default service (G)</DT
6673 >This parameter specifies the name of a service
6674 which will be connected to if the service actually requested cannot
6675 be found. Note that the square brackets are <SPAN
6682 given in the parameter value (see example below).</P
6684 >There is no default value for this parameter. If this
6685 parameter is not given, attempting to connect to a nonexistent
6686 service results in an error.</P
6688 >Typically the default service would be a <A
6689 HREF="index.html#GUESTOK"
6697 HREF="index.html#READONLY"
6706 >Also note that the apparent service name will be changed
6707 to equal that of the requested service, this is very useful as it
6708 allows you to use macros like <TT
6714 a wildcard service.</P
6716 >Note also that any "_" characters in the name of the service
6717 used in the default service will get mapped to a "/". This allows for
6718 interesting things.</P
6723 CLASS="PROGRAMLISTING"
6725 default service = pub
6734 NAME="DELETEGROUPSCRIPT"
6736 >delete group script (G)</DT
6739 >This is the full pathname to a script that will
6750 > when a group is requested to be deleted. It will expand any <TT
6755 > to the group name passed. This script is only useful for installations using the Windows NT domain administration tools.
6760 NAME="DELETEPRINTERCOMMAND"
6762 >deleteprinter command (G)</DT
6765 >With the introduction of MS-RPC based printer
6766 support for Windows NT/2000 clients in Samba 2.2, it is now
6767 possible to delete printer at run time by issuing the
6768 DeletePrinter() RPC call.</P
6770 >For a Samba host this means that the printer must be
6771 physically deleted from underlying printing system. The <TT
6774 > deleteprinter command</I
6776 > defines a script to be run which
6777 will perform the necessary operations for removing the printer
6778 from the print system and from <TT
6787 >deleteprinter command</I
6790 automatically called with only one parameter: <TT
6800 >deleteprinter command</I
6806 > will reparse the <TT
6809 > to associated printer no longer exists.
6810 If the sharename is still valid, then <B
6814 > will return an ACCESS_DENIED error to the client.</P
6817 HREF="index.html#ADDPRINTERCOMMAND"
6821 > addprinter command</I
6825 HREF="index.html#PRINTING"
6834 HREF="index.html#SHOWADDPRINTERWIZARD"
6854 >deleteprinter command = /usr/bin/removeprinter
6860 NAME="DELETEREADONLY"
6862 >delete readonly (S)</DT
6865 >This parameter allows readonly files to be deleted.
6866 This is not normal DOS semantics, but is allowed by UNIX.</P
6868 >This option may be useful for running applications such
6869 as rcs, where UNIX file ownership prevents changing file
6870 permissions, and DOS semantics prevent deletion of a read only file.</P
6874 >delete readonly = no</B
6879 NAME="DELETESHARECOMMAND"
6881 >delete share command (G)</DT
6884 >Samba 2.2.0 introduced the ability to dynamically
6885 add and delete shares via the Windows NT 4.0 Server Manager. The
6889 >delete share command</I
6891 > is used to define an
6892 external program or script which will remove an existing service
6896 >. In order to successfully
6900 >delete share command</I
6906 requires that the administrator be connected using a root account (i.e.
6913 > will automatically invoke the
6917 >delete share command</I
6919 > with two parameters.
6946 the existing service.
6951 > This parameter is only used to remove file shares. To delete printer shares,
6953 HREF="index.html#DELETEPRINTERCOMMAND"
6965 HREF="index.html#ADDSHARECOMMAND"
6974 HREF="index.html#CHANGESHARECOMMAND"
6995 >delete share command = /usr/local/bin/delshare</B
7000 NAME="DELETEUSERSCRIPT"
7002 >delete user script (G)</DT
7005 >This is the full pathname to a script that will
7014 when managing user's with remote RPC (NT) tools.
7017 >This script is called when a remote client removes a user
7018 from the server, normally using 'User Manager for Domains' or
7025 >This script should delete the given UNIX username.
7030 >delete user script = <empty string>
7036 >delete user script = /usr/local/samba/bin/del_user
7042 NAME="DELETEUSERFROMGROUPSCRIPT"
7044 >delete user from group script (G)</DT
7047 >Full path to the script that will be called when
7048 a user is removed from a group using the Windows NT domain administration
7049 tools. It will be run by <A
7066 replaced with the group name and any <TT
7072 be replaced with the user name.
7077 >delete user from group script = </B
7082 >delete user from group script = /usr/sbin/deluser %u %g</B
7087 NAME="DELETEVETOFILES"
7089 >delete veto files (S)</DT
7092 >This option is used when Samba is attempting to
7093 delete a directory that contains one or more vetoed directories
7095 HREF="index.html#VETOFILES"
7103 option). If this option is set to <TT
7106 > (the default) then if a vetoed
7107 directory contains any non-vetoed files or directories then the
7108 directory delete will fail. This is usually what you want.</P
7110 >If this option is set to <TT
7114 will attempt to recursively delete any files and directories within
7115 the vetoed directory. This can be useful for integration with file
7116 serving systems such as NetAtalk which create meta-files within
7117 directories you might normally veto DOS/Windows users from seeing
7125 >delete veto files = yes</B
7127 directories to be transparently deleted when the parent directory
7128 is deleted (so long as the user has permissions to do so).</P
7131 HREF="index.html#VETOFILES"
7143 >delete veto files = no</B
7154 HREF="index.html#HOSTSDENY"
7168 >dfree command (G)</DT
7177 only be used on systems where a problem occurs with the internal
7178 disk space calculations. This has been known to happen with Ultrix,
7179 but may occur with other operating systems. The symptom that was
7180 seen was an error of "Abort Retry Ignore" at the end of each
7181 directory listing.</P
7183 >This setting allows the replacement of the internal routines to
7184 calculate the total disk space and amount available with an external
7185 routine. The example below gives a possible script that might fulfill
7188 >The external program will be passed a single parameter indicating
7189 a directory in the filesystem being queried. This will typically consist
7193 >. The script should return two
7194 integers in ASCII. The first should be the total disk space in blocks,
7195 and the second should be the number of available blocks. An optional
7196 third return value can give the block size in bytes. The default
7197 blocksize is 1024 bytes.</P
7199 >Note: Your script should <SPAN
7206 setgid and should be owned by (and writeable only by) root!</P
7212 >By default internal routines for
7213 determining the disk capacity and remaining space will be used.
7220 >dfree command = /usr/local/samba/bin/dfree
7224 >Where the script dfree (which must be made executable) could be:</P
7227 CLASS="PROGRAMLISTING"
7230 df $1 | tail -1 | awk '{print $2" "$4}'
7234 >or perhaps (on Sys V based systems):</P
7237 CLASS="PROGRAMLISTING"
7240 /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
7244 >Note that you may have to replace the command names
7245 with full path names on some systems.</P
7255 HREF="index.html#PATH"
7267 NAME="DIRECTORYMASK"
7269 >directory mask (S)</DT
7272 >This parameter is the octal modes which are
7273 used when converting DOS modes to UNIX modes when creating UNIX
7276 >When a directory is created, the necessary permissions are
7277 calculated according to the mapping from DOS modes to UNIX permissions,
7278 and the resulting UNIX mode is then bit-wise 'AND'ed with this
7279 parameter. This parameter may be thought of as a bit-wise MASK for
7280 the UNIX modes of a directory. Any bit <SPAN
7287 here will be removed from the modes set on a directory when it is
7290 >The default value of this parameter removes the 'group'
7291 and 'other' write bits from the UNIX mode, allowing only the
7292 user who owns the directory to modify it.</P
7294 >Following this Samba will bit-wise 'OR' the UNIX mode
7295 created from this parameter with the value of the <A
7296 HREF="index.html#FORCEDIRECTORYMODE"
7300 >force directory mode
7304 > parameter. This parameter is set to 000 by
7305 default (i.e. no extra mode bits are added).</P
7307 >Note that this parameter does not apply to permissions
7308 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
7309 a mask on access control lists also, they need to set the <A
7310 HREF="index.html#DIRECTORYSECURITYMASK"
7314 >directory security mask</I
7320 HREF="index.html#FORCEDIRECTORYMODE"
7328 > parameter to cause particular mode
7329 bits to always be set on created directories.</P
7332 HREF="index.html#CREATEMODE"
7340 > parameter for masking mode bits on created files,
7342 HREF="index.html#DIRECTORYSECURITYMASK"
7352 >Also refer to the <A
7353 HREF="index.html#INHERITPERMISSIONS"
7357 > inherit permissions</I
7364 >directory mask = 0755</B
7369 >directory mask = 0775</B
7374 NAME="DIRECTORYMODE"
7376 >directory mode (S)</DT
7380 HREF="index.html#DIRECTORYMASK"
7391 NAME="DIRECTORYSECURITYMASK"
7393 >directory security mask (S)</DT
7396 >This parameter controls what UNIX permission bits
7397 can be modified when a Windows NT client is manipulating the UNIX
7398 permission on a directory using the native NT security dialog
7401 >This parameter is applied as a mask (AND'ed with) to
7402 the changed permission bits, thus preventing any bits not in
7403 this mask from being modified. Essentially, zero bits in this
7404 mask may be treated as a set of bits the user is not allowed
7407 >If not set explicitly this parameter is set to 0777
7408 meaning a user is allowed to modify all the user/group/world
7409 permissions on a directory.</P
7417 > that users who can access the
7418 Samba server through other means can easily bypass this restriction,
7419 so it is primarily useful for standalone "appliance" systems.
7420 Administrators of most normal systems will probably want to leave
7421 it as the default of <TT
7427 HREF="index.html#FORCEDIRECTORYSECURITYMODE"
7431 > force directory security mode</I
7435 HREF="index.html#SECURITYMASK"
7444 HREF="index.html#FORCESECURITYMODE"
7448 >force security mode
7456 >directory security mask = 0777</B
7461 >directory security mask = 0700</B
7466 NAME="DISABLENETBIOS"
7468 >disable netbios (G)</DT
7471 >Enabling this parameter will disable netbios support
7472 in Samba. Netbios is the only available form of browsing in
7473 all windows versions except for 2000 and XP. </P
7475 >Note that clients that only support netbios won't be able to
7476 see your samba server when netbios support is disabled.
7481 >disable netbios = no</B
7486 >disable netbios = yes</B
7491 NAME="DISABLESPOOLSS"
7493 >disable spoolss (G)</DT
7496 >Enabling this parameter will disable Samba's support
7497 for the SPOOLSS set of MS-RPC's and will yield identical behavior
7498 as Samba 2.0.x. Windows NT/2000 clients will downgrade to using
7499 Lanman style printing commands. Windows 9x/ME will be uneffected by
7500 the parameter. However, this will also disable the ability to upload
7501 printer drivers to a Samba server via the Windows NT Add Printer
7502 Wizard or by using the NT printer properties dialog window. It will
7503 also disable the capability of Windows NT/2000 clients to download
7504 print drivers from the Samba host upon demand.
7509 >Be very careful about enabling this parameter.</I
7515 HREF="index.html#USECLIENTDRIVER"
7516 >use client driver</A
7522 >disable spoolss = no</B
7527 NAME="DISPLAYCHARSET"
7529 >display charset (G)</DT
7532 >Specifies the charset that samba will use
7533 to print messages to stdout and stderr and SWAT will use.
7534 Should generally be the same as the <B
7542 >display charset = ASCII</B
7547 >display charset = UTF8</B
7562 when acting as a WINS server and finding that a NetBIOS name has not
7563 been registered, should treat the NetBIOS name word-for-word as a DNS
7564 name and do a lookup with the DNS server for that name on behalf of
7565 the name-querying client.</P
7567 >Note that the maximum length for a NetBIOS name is 15
7568 characters, so the DNS name (or DNS alias) can likewise only be
7569 15 characters, maximum.</P
7574 > spawns a second copy of itself to do the
7575 DNS name lookup requests, as doing a name lookup is a blocking
7578 >See also the parameter <A
7579 HREF="index.html#WINSSUPPORT"
7595 NAME="DOMAINADMINGROUP"
7597 >domain admin group (G)</DT
7600 >This parameter is intended as a temporary solution
7601 to enable users to be a member of the "Domain Admins" group when
7602 a Samba host is acting as a PDC. A complete solution will be provided
7603 by a system for mapping Windows NT/2000 groups onto UNIX groups.
7604 Please note that this parameter has a somewhat confusing name. It
7605 accepts a list of usernames and of group names in standard
7613 HREF="index.html#DOMAINGUESTGROUP"
7622 HREF="index.html#DOMAINLOGONS"
7637 >no domain administrators</I
7643 >domain admin group = root @wheel</B
7648 NAME="DOMAINGUESTGROUP"
7650 >domain guest group (G)</DT
7653 >This parameter is intended as a temporary solution
7654 to enable users to be a member of the "Domain Guests" group when
7655 a Samba host is acting as a PDC. A complete solution will be provided
7656 by a system for mapping Windows NT/2000 groups onto UNIX groups.
7657 Please note that this parameter has a somewhat confusing name. It
7658 accepts a list of usernames and of group names in standard
7666 HREF="index.html#DOMAINADMINGROUP"
7675 HREF="index.html#DOMAINLOGONS"
7690 >no domain guests</I
7696 >domain guest group = nobody @guest</B
7703 >domain logons (G)</DT
7709 >, the Samba server will serve
7710 Windows 95/98 Domain logons for the <A
7711 HREF="index.html#WORKGROUP"
7718 > it is in. Samba 2.2 also
7719 has limited capability to act as a domain controller for Windows
7720 NT 4 Domains. For more details on setting up this feature see
7721 the Samba-PDC-HOWTO included in the <TT
7725 directory shipped with the source code.</P
7729 >domain logons = no</B
7736 >domain master (G)</DT
7746 > to enable WAN-wide browse list
7747 collation. Setting this option causes <B
7751 claim a special domain specific NetBIOS name that identifies
7752 it as a domain master browser for its given <A
7753 HREF="index.html#WORKGROUP"
7760 >. Local master browsers
7766 > on broadcast-isolated
7767 subnets will give this <B
7770 > their local browse lists,
7779 for a complete copy of the browse list for the whole wide area
7780 network. Browser clients will then contact their local master browser,
7781 and will receive the domain-wide browse list, instead of just the list
7782 for their broadcast-isolated subnet.</P
7784 >Note that Windows NT Primary Domain Controllers expect to be
7785 able to claim this <TT
7791 NetBIOS name that identifies them as domain master browsers for
7797 > by default (i.e. there is no
7798 way to prevent a Windows NT PDC from attempting to do this). This
7799 means that if this parameter is set and <B
7803 the special name for a <TT
7809 NT PDC is able to do so then cross subnet browsing will behave
7810 strangely and may fail.</P
7813 HREF="index.html#DOMAINLOGONS"
7816 >domain logons = yes</B
7819 >, then the default behavior is to enable the <TT
7831 not enabled (the default setting), then neither will <TT
7837 > be enabled by default.</P
7841 >domain master = auto</B
7848 >dont descend (S)</DT
7851 >There are certain directories on some systems
7855 > tree under Linux) that are either not
7856 of interest to clients or are infinitely deep (recursive). This
7857 parameter allows you to specify a comma-delimited list of directories
7858 that the server should always show as empty.</P
7860 >Note that Samba can be very fussy about the exact format
7861 of the "dont descend" entries. For example you may need <TT
7864 > instead of just <TT
7868 Experimentation is the best policy :-) </P
7874 >none (i.e., all directories are OK
7881 >dont descend = /proc,/dev</B
7888 >dos charset (G)</DT
7891 >DOS SMB clients assume the server has
7892 the same charset as they do. This option specifies which
7893 charset Samba should talk to DOS clients.
7896 >The default depends on which charsets you have instaled.
7897 Samba tries to use charset 850 but falls back to ASCII in
7898 case it is not available. Run <A
7899 HREF="testparm.1.html"
7903 > to check the default on your system.
7910 >dos filemode (S)</DT
7913 > The default behavior in Samba is to provide
7914 UNIX-like behavior where only the owner of a file/directory is
7915 able to change the permissions on it. However, this behavior
7916 is often confusing to DOS/Windows users. Enabling this parameter
7917 allows a user who has write access to the file (by whatever
7918 means) to modify the permissions on it. Note that a user
7919 belonging to the group owning the file will not be allowed to
7920 change permissions if the group is only granted read access.
7921 Ownership of the file/directory is not changed, only the permissions
7926 >dos filemode = no</B
7931 NAME="DOSFILETIMERESOLUTION"
7933 >dos filetime resolution (S)</DT
7936 >Under the DOS and Windows FAT filesystem, the finest
7937 granularity on time resolution is two seconds. Setting this parameter
7938 for a share causes Samba to round the reported time down to the
7939 nearest two second boundary when a query call that requires one second
7940 resolution is made to <A
7950 >This option is mainly used as a compatibility option for Visual
7951 C++ when used against Samba shares. If oplocks are enabled on a
7952 share, Visual C++ uses two different time reading calls to check if a
7953 file has changed since it was last read. One of these calls uses a
7954 one-second granularity, the other uses a two second granularity. As
7955 the two second call rounds any odd second down, then if the file has a
7956 timestamp of an odd number of seconds then the two timestamps will not
7957 match and Visual C++ will keep reporting the file has changed. Setting
7958 this option causes the two timestamps to match, and Visual C++ is
7963 >dos filetime resolution = no</B
7970 >dos filetimes (S)</DT
7973 >Under DOS and Windows, if a user can write to a
7974 file they can change the timestamp on it. Under POSIX semantics,
7975 only the owner of the file or root may change the timestamp. By
7976 default, Samba runs with POSIX semantics and refuses to change the
7977 timestamp on a file if the user <B
7981 on behalf of is not the file owner. Setting this option to <TT
7984 > allows DOS semantics and <A
7988 > will change the file
7989 timestamp as DOS requires.</P
7993 >dos filetimes = no</B
7998 NAME="ENCRYPTPASSWORDS"
8000 >encrypt passwords (G)</DT
8003 >This boolean controls whether encrypted passwords
8004 will be negotiated with the client. Note that Windows NT 4.0 SP3 and
8005 above and also Windows 98 will by default expect encrypted passwords
8006 unless a registry entry is changed. To use encrypted passwords in
8007 Samba see the file ENCRYPTION.txt in the Samba documentation
8011 > shipped with the source code.</P
8013 >In order for encrypted passwords to work correctly
8022 have access to a local <A
8023 HREF="smbpasswd.5.html"
8031 HREF="smbpasswd.8.html"
8037 > program for information on how to set up
8038 and maintain this file), or set the <A
8039 HREF="index.html#SECURITY"
8040 >security = [server|domain|ads]</A
8045 > to authenticate against another
8050 >encrypt passwords = yes</B
8055 NAME="ENHANCEDBROWSING"
8057 >enhanced browsing (G)</DT
8060 >This option enables a couple of enhancements to
8061 cross-subnet browse propagation that have been added in Samba
8062 but which are not standard in Microsoft implementations.
8065 >The first enhancement to browse propagation consists of a regular
8066 wildcard query to a Samba WINS server for all Domain Master Browsers,
8067 followed by a browse synchronization with each of the returned
8068 DMBs. The second enhancement consists of a regular randomised browse
8069 synchronization with all currently known DMBs.</P
8071 >You may wish to disable this option if you have a problem with empty
8072 workgroups not disappearing from browse lists. Due to the restrictions
8073 of the browse protocols these enhancements can cause a empty workgroup
8074 to stay around forever which can be annoying.</P
8076 >In general you should leave this option enabled as it makes
8077 cross-subnet browse propagation much more reliable.</P
8081 >enhanced browsing = yes</B
8086 NAME="ENUMPORTSCOMMAND"
8088 >enumports command (G)</DT
8091 >The concept of a "port" is fairly foreign
8092 to UNIX hosts. Under Windows NT/2000 print servers, a port
8093 is associated with a port monitor and generally takes the form of
8094 a local port (i.e. LPT1:, COM1:, FILE:) or a remote port
8095 (i.e. LPD Port Monitor, etc...). By default, Samba has only one
8098 >"Samba Printer Port"</TT
8100 Windows NT/2000, all printers must have a valid port name.
8101 If you wish to have a list of ports displayed (<B
8105 > does not use a port name for anything) other than
8108 >"Samba Printer Port"</TT
8113 >enumports command</I
8116 a program which should generate a list of ports, one per line,
8117 to standard output. This listing will then be used in response
8118 to the level 1 and 2 EnumPorts() RPC.</P
8124 >no enumports command</I
8130 >enumports command = /usr/bin/listports
8141 >This is a synonym for <A
8142 HREF="index.html#PREEXEC"
8153 NAME="FAKEDIRECTORYCREATETIMES"
8155 >fake directory create times (S)</DT
8158 >NTFS and Windows VFAT file systems keep a create
8159 time for all files and directories. This is not the same as the
8160 ctime - status change time - that Unix keeps, so Samba by default
8161 reports the earliest of the various times Unix does keep. Setting
8162 this parameter for a share causes Samba to always report midnight
8163 1-1-1980 as the create time for directories.</P
8165 >This option is mainly used as a compatibility option for
8166 Visual C++ when used against Samba shares. Visual C++ generated
8167 makefiles have the object directory as a dependency for each object
8168 file, and a make rule to create the directory. Also, when NMAKE
8169 compares timestamps it uses the creation time when examining a
8170 directory. Thus the object directory will be created if it does not
8171 exist, but once it does exist it will always have an earlier
8172 timestamp than the object files it contains.</P
8174 >However, Unix time semantics mean that the create time
8175 reported by Samba will be updated whenever a file is created or
8176 or deleted in the directory. NMAKE finds all object files in
8177 the object directory. The timestamp of the last one built is then
8178 compared to the timestamp of the object directory. If the
8179 directory's timestamp if newer, then all object files
8180 will be rebuilt. Enabling this option
8181 ensures directories always predate their contents and an NMAKE build
8182 will proceed as expected.</P
8186 >fake directory create times = no</B
8193 >fake oplocks (S)</DT
8196 >Oplocks are the way that SMB clients get permission
8197 from a server to locally cache file operations. If a server grants
8198 an oplock (opportunistic lock) then the client is free to assume
8199 that it is the only one accessing the file and it will aggressively
8200 cache file data. With some oplock types the client may even cache
8201 file open/close operations. This can give enormous performance benefits.
8206 >fake oplocks = yes</B
8215 always grant oplock requests no matter how many clients are using
8218 >It is generally much better to use the real <A
8219 HREF="index.html#OPLOCKS"
8227 than this parameter.</P
8229 >If you enable this option on all read-only shares or
8230 shares that you know will only be accessed from one client at a
8231 time such as physically read-only media like CDROMs, you will see
8232 a big performance improvement on many operations. If you enable
8233 this option on shares where multiple clients may be accessing the
8234 files read-write at the same time you can get data corruption. Use
8235 this option carefully!</P
8239 >fake oplocks = no</B
8244 NAME="FOLLOWSYMLINKS"
8246 >follow symlinks (S)</DT
8249 >This parameter allows the Samba administrator
8258 from following symbolic links in a particular share. Setting this
8262 > prevents any file or directory
8263 that is a symbolic link from being followed (the user will get an
8264 error). This option is very useful to stop users from adding a
8265 symbolic link to <TT
8269 directory for instance. However it will slow filename lookups
8272 >This option is enabled (i.e. <B
8276 follow symbolic links) by default.</P
8280 >follow symlinks = yes</B
8285 NAME="FORCECREATEMODE"
8287 >force create mode (S)</DT
8290 >This parameter specifies a set of UNIX mode bit
8291 permissions that will <SPAN
8298 file created by Samba. This is done by bitwise 'OR'ing these bits onto
8299 the mode bits of a file that is being created or having its
8300 permissions changed. The default for this parameter is (in octal)
8301 000. The modes in this parameter are bitwise 'OR'ed onto the file
8302 mode after the mask set in the <TT
8308 parameter is applied.</P
8310 >See also the parameter <A
8311 HREF="index.html#CREATEMASK"
8319 > for details on masking mode bits on files.</P
8322 HREF="index.html#INHERITPERMISSIONS"
8334 >force create mode = 000</B
8339 >force create mode = 0755</B
8342 >would force all created files to have read and execute
8343 permissions set for 'group' and 'other' as well as the
8344 read/write/execute bits set for the 'user'.</P
8348 NAME="FORCEDIRECTORYMODE"
8350 >force directory mode (S)</DT
8353 >This parameter specifies a set of UNIX mode bit
8354 permissions that will <SPAN
8360 > be set on a directory
8361 created by Samba. This is done by bitwise 'OR'ing these bits onto the
8362 mode bits of a directory that is being created. The default for this
8363 parameter is (in octal) 0000 which will not add any extra permission
8364 bits to a created directory. This operation is done after the mode
8365 mask in the parameter <TT
8373 >See also the parameter <A
8374 HREF="index.html#DIRECTORYMASK"
8381 > for details on masking mode bits
8382 on created directories.</P
8385 HREF="index.html#INHERITPERMISSIONS"
8389 > inherit permissions</I
8396 >force directory mode = 000</B
8401 >force directory mode = 0755</B
8404 >would force all created directories to have read and execute
8405 permissions set for 'group' and 'other' as well as the
8406 read/write/execute bits set for the 'user'.</P
8410 NAME="FORCEDIRECTORYSECURITYMODE"
8412 >force directory security mode (S)</DT
8415 >This parameter controls what UNIX permission bits
8416 can be modified when a Windows NT client is manipulating the UNIX
8417 permission on a directory using the native NT security dialog box.</P
8419 >This parameter is applied as a mask (OR'ed with) to the
8420 changed permission bits, thus forcing any bits in this mask that
8421 the user may have modified to be on. Essentially, one bits in this
8422 mask may be treated as a set of bits that, when modifying security
8423 on a directory, the user has always set to be 'on'.</P
8425 >If not set explicitly this parameter is 000, which
8426 allows a user to modify all the user/group/world permissions on a
8427 directory without restrictions.</P
8435 > that users who can access the
8436 Samba server through other means can easily bypass this restriction,
8437 so it is primarily useful for standalone "appliance" systems.
8438 Administrators of most normal systems will probably want to leave
8442 HREF="index.html#DIRECTORYSECURITYMASK"
8446 > directory security mask</I
8450 HREF="index.html#SECURITYMASK"
8459 HREF="index.html#FORCESECURITYMODE"
8463 >force security mode
8471 >force directory security mode = 0</B
8476 >force directory security mode = 700</B
8483 >force group (S)</DT
8486 >This specifies a UNIX group name that will be
8487 assigned as the default primary group for all users connecting
8488 to this service. This is useful for sharing files by ensuring
8489 that all access to files on service will use the named group for
8490 their permissions checking. Thus, by assigning permissions for this
8491 group to the files and directories within this service the Samba
8492 administrator can restrict or allow sharing of these files.</P
8494 >In Samba 2.0.5 and above this parameter has extended
8495 functionality in the following way. If the group name listed here
8496 has a '+' character prepended to it then the current user accessing
8497 the share only has the primary group default assigned to this group
8498 if they are already assigned as a member of that group. This allows
8499 an administrator to decide that only users who are already in a
8500 particular group will create files with group ownership set to that
8501 group. This gives a finer granularity of ownership assignment. For
8502 example, the setting <TT
8504 >force group = +sys</TT
8506 that only users who are already in group sys will have their default
8507 primary group assigned to sys when accessing this Samba share. All
8508 other users will retain their ordinary primary group.</P
8511 HREF="index.html#FORCEUSER"
8519 > parameter is also set the group specified in
8525 > will override the primary group
8534 HREF="index.html#FORCEUSER"
8554 >force group = agroup</B
8559 NAME="FORCESECURITYMODE"
8561 >force security mode (S)</DT
8564 >This parameter controls what UNIX permission
8565 bits can be modified when a Windows NT client is manipulating
8566 the UNIX permission on a file using the native NT security dialog
8569 >This parameter is applied as a mask (OR'ed with) to the
8570 changed permission bits, thus forcing any bits in this mask that
8571 the user may have modified to be on. Essentially, one bits in this
8572 mask may be treated as a set of bits that, when modifying security
8573 on a file, the user has always set to be 'on'.</P
8575 >If not set explicitly this parameter is set to 0,
8576 and allows a user to modify all the user/group/world permissions on a file,
8577 with no restrictions.</P
8585 > that users who can access
8586 the Samba server through other means can easily bypass this restriction,
8587 so it is primarily useful for standalone "appliance" systems.
8588 Administrators of most normal systems will probably want to leave
8589 this set to 0000.</P
8592 HREF="index.html#FORCEDIRECTORYSECURITYMODE"
8596 > force directory security mode</I
8601 HREF="index.html#DIRECTORYSECURITYMASK"
8610 HREF="index.html#SECURITYMASK"
8621 >force security mode = 0</B
8626 >force security mode = 700</B
8636 >This specifies a UNIX user name that will be
8637 assigned as the default user for all users connecting to this service.
8638 This is useful for sharing files. You should also use it carefully
8639 as using it incorrectly can cause security problems.</P
8641 >This user name only gets used once a connection is established.
8642 Thus clients still need to connect as a valid user and supply a
8643 valid password. Once connected, all file operations will be performed
8644 as the "forced user", no matter what username the client connected
8645 as. This can be very useful.</P
8647 >In Samba 2.0.5 and above this parameter also causes the
8648 primary group of the forced user to be used as the primary group
8649 for all file activity. Prior to 2.0.5 the primary group was left
8650 as the primary group of the connecting user (this was a bug).</P
8653 HREF="index.html#FORCEGROUP"
8673 >force user = auser</B
8683 >This parameter allows the administrator to
8684 configure the string that specifies the type of filesystem a share
8685 is using that is reported by <A
8693 > when a client queries the filesystem type
8694 for a share. The default type is <TT
8698 compatibility with Windows NT but this can be changed to other
8722 >getwd cache (G)</DT
8725 >This is a tuning option. When this is enabled a
8726 caching algorithm will be used to reduce the time taken for getwd()
8727 calls. This can have a significant impact on performance, especially
8729 HREF="index.html#WIDELINKS"
8737 >parameter is set to <TT
8744 >getwd cache = yes</B
8755 HREF="index.html#FORCEGROUP"
8769 >guest account (S)</DT
8772 >This is a username which will be used for access
8773 to services which are specified as <A
8774 HREF="index.html#GUESTOK"
8781 > (see below). Whatever privileges this
8782 user has will be available to any client connecting to the guest service.
8783 Typically this user will exist in the password file, but will not
8784 have a valid login. The user account "ftp" is often a good choice
8785 for this parameter. If a username is specified in a given service,
8786 the specified username overrides this one.</P
8788 >One some systems the default guest account "nobody" may not
8789 be able to print. Use another account in this case. You should test
8790 this by trying to log in as your guest user (perhaps by using the
8794 > command) and trying to print using the
8795 system print command such as <B
8803 >This paramater does not accept % marcos, becouse
8804 many parts of the system require this value to be
8805 constant for correct operation</P
8811 >specified at compile time, usually
8818 >guest account = ftp</B
8828 >If this parameter is <TT
8832 a service, then no password is required to connect to the service.
8833 Privileges will be those of the <A
8834 HREF="index.html#GUESTACCOUNT"
8843 >See the section below on <A
8844 HREF="index.html#SECURITY"
8851 > for more information about this option.
8866 >If this parameter is <TT
8870 a service, then only guest connections to the service are permitted.
8871 This parameter will have no effect if <A
8872 HREF="index.html#GUESTOK"
8879 > is not set for the service.</P
8881 >See the section below on <A
8882 HREF="index.html#SECURITY"
8889 > for more information about this option.
8901 >hide dot files (S)</DT
8904 >This is a boolean parameter that controls whether
8905 files starting with a dot appear as hidden files.</P
8909 >hide dot files = yes</B
8919 >This is a list of files or directories that are not
8920 visible but are accessible. The DOS 'hidden' attribute is applied
8921 to any files or directories that match.</P
8923 >Each entry in the list must be separated by a '/',
8924 which allows spaces to be included in the entry. '*'
8925 and '?' can be used to specify multiple files or directories
8926 as in DOS wildcards.</P
8928 >Each entry must be a Unix path, not a DOS path and must
8929 not include the Unix directory separator '/'.</P
8931 >Note that the case sensitivity option is applicable
8934 >Setting this parameter will affect the performance of Samba,
8935 as it will be forced to check all files and directories for a match
8936 as they are scanned.</P
8939 HREF="index.html#HIDEDOTFILES"
8948 HREF="index.html#VETOFILES"
8956 HREF="index.html#CASESENSITIVE"
8969 >no file are hidden</I
8976 /.*/DesktopFolderDB/TrashFor%m/resource.frk/</B
8979 >The above example is based on files that the Macintosh
8980 SMB client (DAVE) available from <A
8981 HREF="http://www.thursby.com"
8985 > creates for internal use, and also still hides
8986 all files beginning with a dot.</P
8990 NAME="HIDELOCALUSERS"
8992 >hide local users(G)</DT
8995 >This parameter toggles the hiding of local UNIX
8996 users (root, wheel, floppy, etc) from remote clients.</P
9000 >hide local users = no</B
9005 NAME="HIDEUNREADABLE"
9007 >hide unreadable (G)</DT
9010 >This parameter prevents clients from seeing the
9011 existance of files that cannot be read. Defaults to off.</P
9015 >hide unreadable = no</B
9020 NAME="HIDEUNWRITEABLEFILES"
9022 >hide unwriteable files (G)</DT
9025 >This parameter prevents clients from seeing
9026 the existance of files that cannot be written to. Defaults to off.
9027 Note that unwriteable directories are shown as usual.
9032 >hide unwriteable = no</B
9039 >homedir map (G)</DT
9043 HREF="index.html#NISHOMEDIR"
9067 > then this parameter
9068 specifies the NIS (or YP) map from which the server for the user's
9069 home directory should be extracted. At present, only the Sun
9070 auto.home map format is understood. The form of the map is:</P
9074 >username server:/some/file/system</B
9077 >and the program will extract the servername from before
9078 the first ':'. There should probably be a better parsing system
9079 that copes with different map formats and also Amd (another
9080 automounter) maps.</P
9088 >A working NIS client is required on
9089 the system for this option to work.</P
9092 HREF="index.html#NISHOMEDIR"
9101 HREF="index.html#DOMAINLOGONS"
9113 >homedir map = <empty string></B
9118 >homedir map = amd.homedir</B
9128 >This boolean parameter is only available
9129 if Samba has been configured and compiled with the <B
9132 > option. If set to <TT
9136 Samba will act as a Dfs server, and allow Dfs-aware clients
9137 to browse Dfs trees hosted on the server.</P
9140 HREF="index.html#MSDFSROOT"
9147 > share level parameter. For
9148 more information on setting up a Dfs tree on Samba,
9150 HREF="msdfs_setup.html"
9152 >msdfs_setup.html</A
9163 NAME="HOSTNAMELOOKUPS"
9165 >hostname lookups (G)</DT
9168 >Specifies whether samba should use (expensive)
9169 hostname lookups or use the ip addresses instead. An example place
9170 where hostname lookups are currently used is when checking
9182 >hostname lookups = yes</B
9187 >hostname lookups = no</B
9194 >hosts allow (S)</DT
9197 >A synonym for this parameter is <TT
9205 >This parameter is a comma, space, or tab delimited
9206 set of hosts which are permitted to access a service.</P
9208 >If specified in the [global] section then it will
9209 apply to all services, regardless of whether the individual
9210 service has a different setting.</P
9212 >You can specify the hosts by name or IP number. For
9213 example, you could restrict access to only the hosts on a
9214 Class C subnet with something like <B
9216 >allow hosts = 150.203.5.
9218 >. The full syntax of the list is described in the man
9221 >hosts_access(5)</TT
9222 >. Note that this man
9223 page may not be present on your system, so a brief description will
9224 be given here also.</P
9226 >Note that the localhost address 127.0.0.1 will always
9227 be allowed access unless specifically denied by a <A
9228 HREF="index.html#HOSTSDENY"
9237 >You can also specify hosts by network/netmask pairs and
9238 by netgroup names if your system supports netgroups. The
9245 > keyword can also be used to limit a
9246 wildcard list. The following examples may provide some help:</P
9248 >Example 1: allow all IPs in 150.203.*.*; except one</P
9252 >hosts allow = 150.203. EXCEPT 150.203.6.66</B
9255 >Example 2: allow hosts that match the given network/netmask</P
9259 >hosts allow = 150.203.15.0/255.255.255.0</B
9262 >Example 3: allow a couple of hosts</P
9266 >hosts allow = lapland, arvidsjaur</B
9269 >Example 4: allow only hosts in NIS netgroup "foonet", but
9270 deny access from one particular host</P
9274 >hosts allow = @foonet</B
9279 >hosts deny = pirate</B
9282 >Note that access still requires suitable user-level passwords.</P
9285 HREF="testparm.1.html"
9292 > for a way of testing your host access to see if it does
9299 >none (i.e., all hosts permitted access)
9306 >allow hosts = 150.203.5. myhost.mynet.edu.au
9317 >The opposite of <TT
9323 - hosts listed here are <SPAN
9329 > permitted access to
9330 services unless the specific services have their own lists to override
9331 this one. Where the lists conflict, the <TT
9337 list takes precedence.</P
9343 >none (i.e., no hosts specifically excluded)
9350 >hosts deny = 150.203.4. badhost.mynet.edu.au
9358 >hosts equiv (G)</DT
9361 >If this global parameter is a non-null string,
9362 it specifies the name of a file to read for the names of hosts
9363 and users who will be allowed access without specifying a password.
9366 >This is not be confused with <A
9367 HREF="index.html#HOSTSALLOW"
9374 > which is about hosts
9375 access to services and is more useful for guest services. <TT
9380 > may be useful for NT clients which will
9381 not supply passwords to Samba.</P
9395 > can be a major security hole. This is because you are
9396 trusting the PC to supply the correct username. It is very easy to
9397 get a PC to supply a false username. I recommend that the
9403 > option be only used if you really
9404 know what you are doing, or perhaps on a home network where you trust
9405 your spouse and kids. And only if you <SPAN
9418 >no host equivalences</I
9424 >hosts equiv = /etc/hosts.equiv</B
9434 >This allows you to include one config file
9435 inside another. The file is included literally, as though typed
9438 >It takes the standard substitutions, except <TT
9461 >no file included</I
9467 >include = /usr/local/samba/lib/admin_smb.conf
9475 >inherit acls (S)</DT
9478 >This parameter can be used to ensure
9479 that if default acls exist on parent directories,
9480 they are always honored when creating a subdirectory.
9481 The default behavior is to use the mode specified
9482 when creating the directory. Enabling this option
9483 sets the mode to 0777, thus guaranteeing that
9484 default directory acls are propagated.
9489 >inherit acls = no</B
9495 NAME="INHERITPERMISSIONS"
9497 >inherit permissions (S)</DT
9500 >The permissions on new files and directories
9501 are normally governed by <A
9502 HREF="index.html#CREATEMASK"
9510 HREF="index.html#DIRECTORYMASK"
9518 HREF="index.html#FORCECREATEMODE"
9522 >force create mode</I
9527 HREF="index.html#FORCEDIRECTORYMODE"
9535 > but the boolean inherit
9536 permissions parameter overrides this.</P
9538 >New directories inherit the mode of the parent directory,
9539 including bits such as setgid.</P
9541 >New files inherit their read/write bits from the parent
9542 directory. Their execute bits continue to be determined by
9544 HREF="index.html#MAPARCHIVE"
9553 HREF="index.html#MAPHIDDEN"
9562 HREF="index.html#MAPSYSTEM"
9572 >Note that the setuid bit is <SPAN
9579 inheritance (the code explicitly prohibits this).</P
9581 >This can be particularly useful on large systems with
9582 many users, perhaps several thousand, to allow a single [homes]
9583 share to be used flexibly by each user.</P
9586 HREF="index.html#CREATEMASK"
9595 HREF="index.html#DIRECTORYMASK"
9603 HREF="index.html#FORCECREATEMODE"
9607 >force create mode</I
9611 HREF="index.html#FORCEDIRECTORYMODE"
9615 >force directory mode</I
9623 >inherit permissions = no</B
9633 >This option allows you to override the default
9634 network interfaces list that Samba will use for browsing, name
9635 registration and other NBT traffic. By default Samba will query
9636 the kernel for the list of all active interfaces and use any
9637 interfaces except 127.0.0.1 that are broadcast capable.</P
9639 >The option takes a list of interface strings. Each string
9640 can be in any of the following forms:</P
9646 >a network interface name (such as eth0).
9647 This may include shell-like wildcards so eth* will match
9648 any interface starting with the substring "eth"</P
9652 >an IP address. In this case the netmask is
9653 determined from the list of interfaces obtained from the
9658 >an IP/mask pair. </P
9662 >a broadcast/mask pair.</P
9666 >The "mask" parameters can either be a bit length (such
9667 as 24 for a C class network) or a full netmask in dotted
9670 >The "IP" parameters above can either be a full dotted
9671 decimal IP address or a hostname which will be looked up via
9672 the OS's normal hostname resolution mechanisms.</P
9674 >For example, the following line:</P
9678 >interfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0
9682 >would configure three network interfaces corresponding
9683 to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10.
9684 The netmasks of the latter two interfaces would be set to 255.255.255.0.</P
9687 HREF="index.html#BINDINTERFACESONLY"
9701 >all active interfaces except 127.0.0.1
9702 that are broadcast capable</I
9710 >invalid users (S)</DT
9713 >This is a list of users that should not be allowed
9714 to login to this service. This is really a <SPAN
9721 check to absolutely ensure an improper setting does not breach
9724 >A name starting with a '@' is interpreted as an NIS
9725 netgroup first (if your system supports NIS), and then as a UNIX
9726 group if the name was not found in the NIS netgroup database.</P
9728 >A name starting with '+' is interpreted only
9729 by looking in the UNIX group database. A name starting with
9730 '&' is interpreted only by looking in the NIS netgroup database
9731 (this requires NIS to be working on your system). The characters
9732 '+' and '&' may be used at the start of the name in either order
9739 UNIX group database, followed by the NIS netgroup database, and
9745 > means check the NIS
9746 netgroup database, followed by the UNIX group database (the
9747 same as the '@' prefix).</P
9749 >The current servicename is substituted for <TT
9755 This is useful in the [homes] section.</P
9758 HREF="index.html#VALIDUSERS"
9772 >no invalid users</I
9778 >invalid users = root fred admin @wheel
9789 >The value of the parameter (an integer) represents
9790 the number of seconds between <TT
9796 packets. If this parameter is zero, no keepalive packets will be
9797 sent. Keepalive packets, if sent, allow the server to tell whether
9798 a client is still present and responding.</P
9800 >Keepalives should, in general, not be needed if the socket
9801 being used has the SO_KEEPALIVE attribute set on it (see <A
9802 HREF="index.html#SOCKETOPTIONS"
9810 Basically you should only use this option if you strike difficulties.</P
9824 NAME="KERNELOPLOCKS"
9826 >kernel oplocks (G)</DT
9829 >For UNIXes that support kernel based <A
9830 HREF="index.html#OPLOCKS"
9838 (currently only IRIX and the Linux 2.4 kernel), this parameter
9839 allows the use of them to be turned on or off.</P
9841 >Kernel oplocks support allows Samba <TT
9847 > to be broken whenever a local UNIX process or NFS operation
9848 accesses a file that <A
9856 > has oplocked. This allows complete data consistency between
9857 SMB/CIFS, NFS and local file access (and is a <SPAN
9864 cool feature :-).</P
9866 >This parameter defaults to <TT
9869 >, but is translated
9870 to a no-op on systems that no not have the necessary kernel support.
9871 You should never need to touch this parameter.</P
9874 HREF="index.html#OPLOCKS"
9883 HREF="index.html#LEVEL2OPLOCKS"
9895 >kernel oplocks = yes</B
9902 >lanman auth (G)</DT
9905 >This parameter determines whether or not <A
9910 attempt to authenticate users using the LANMAN password hash.
9911 If disabled, only clients which support NT password hashes (e.g. Windows
9912 NT/2000 clients, smbclient, etc... but not Windows 95/98 or the MS DOS
9913 network client) will be able to connect to the Samba host.</P
9917 >lanman auth = yes</B
9922 NAME="LARGEREADWRITE"
9924 >large readwrite (G)</DT
9927 >This parameter determines whether or not <A
9932 supports the new 64k streaming read and write varient SMB requests introduced
9933 with Windows 2000. Note that due to Windows 2000 client redirector bugs
9934 this requires Samba to be running on a 64-bit capable operating system such
9935 as IRIX, Solaris or a Linux 2.4 kernel. Can improve performance by 10% with
9936 Windows 2000 clients. Defaults to on. Not as tested as some other Samba
9942 >large readwrite = yes</B
9949 >ldap admin dn (G)</DT
9957 > defines the Distinguished
9958 Name (DN) name used by Samba to contact the ldap server when retreiving
9959 user account information. The <TT
9965 > is used in conjunction with the admin dn password
9968 >private/secrets.tdb</TT
9971 HREF="smbpasswd.8.html"
9978 page for more information on how to accmplish this.
9993 >ldap filter (G)</DT
9996 >This parameter specifies the RFC 2254 compliant LDAP search filter.
9997 The default is to match the login name with the <TT
10001 attribute for all entries matching the <TT
10005 objectclass. Note that this filter should only return one entry.
10010 >ldap filter = (&(uid=%u)(objectclass=sambaAccount))</B
10020 >This option is used to define whether or not Samba should
10021 use SSL when connecting to the ldap server
10029 Samba's previous SSL support which was enabled by specifying the
10033 > option to the <TT
10045 > can be set to one of three values:
10049 > - Always use SSL when contacting the
10059 Never use SSL when querying the directory, or (c) <TT
10063 - Use the LDAPv3 StartTLS extended operation
10064 (RFC2830) for communicating with the directory server.
10076 >ldap suffix (G)</DT
10089 NAME="LDAPUSERSUFFIX"
10091 >ldap user suffix (G)</DT
10094 >It specifies where users are added to the tree.
10107 NAME="LDAPMACHINESUFFIX"
10109 >ldap machine suffix (G)</DT
10112 >It specifies where machines should be
10113 added to the ldap tree.
10126 NAME="LEVEL2OPLOCKS"
10128 >level2 oplocks (S)</DT
10131 >This parameter controls whether Samba supports
10132 level2 (read-only) oplocks on a share.</P
10134 >Level2, or read-only oplocks allow Windows NT clients
10135 that have an oplock on a file to downgrade from a read-write oplock
10136 to a read-only oplock once a second client opens the file (instead
10137 of releasing all oplocks on a second open, as in traditional,
10138 exclusive oplocks). This allows all openers of the file that
10139 support level2 oplocks to cache the file for read-ahead only (ie.
10140 they may not cache writes or lock requests) and increases performance
10141 for many accesses of files that are not commonly written (such as
10142 application .EXE files).</P
10144 >Once one of the clients which have a read-only oplock
10145 writes to the file all clients are notified (no reply is needed
10146 or waited for) and told to break their oplocks to "none" and
10147 delete any read-ahead caches.</P
10149 >It is recommended that this parameter be turned on
10150 to speed access to shared executables.</P
10152 >For more discussions on level2 oplocks see the CIFS spec.</P
10155 HREF="index.html#KERNELOPLOCKS"
10163 > are supported then level2 oplocks are
10164 not granted (even if this parameter is set to <TT
10169 HREF="index.html#OPLOCKS"
10177 > parameter must be set to <TT
10180 > on this share in order for
10181 this parameter to have any effect.</P
10184 HREF="index.html#OPLOCKS"
10193 HREF="index.html#OPLOCKS"
10205 >level2 oplocks = yes</B
10212 >lm announce (G)</DT
10215 >This parameter determines if <A
10222 > will produce Lanman announce
10223 broadcasts that are needed by OS/2 clients in order for them to see
10224 the Samba server in their browse list. This parameter can have three
10235 >. The default is <TT
10242 > Samba will never produce these
10243 broadcasts. If set to <TT
10246 > Samba will produce
10247 Lanman announce broadcasts at a frequency set by the parameter
10257 Samba will not send Lanman announce broadcasts by default but will
10258 listen for them. If it hears such a broadcast on the wire it will
10259 then start sending them at a frequency set by the parameter
10268 HREF="index.html#LMINTERVAL"
10280 >lm announce = auto</B
10285 >lm announce = yes</B
10292 >lm interval (G)</DT
10295 >If Samba is set to produce Lanman announce
10296 broadcasts needed by OS/2 clients (see the <A
10297 HREF="index.html#LMANNOUNCE"
10304 > parameter) then this
10305 parameter defines the frequency in seconds with which they will be
10306 made. If this is set to zero then no Lanman announcements will be
10307 made despite the setting of the <TT
10316 HREF="index.html#LMANNOUNCE"
10328 >lm interval = 60</B
10333 >lm interval = 120</B
10338 NAME="LOADPRINTERS"
10340 >load printers (G)</DT
10343 >A boolean variable that controls whether all
10344 printers in the printcap will be loaded for browsing by default.
10346 HREF="index.html#AEN79"
10353 >load printers = yes</B
10360 >local master (G)</DT
10363 >This option allows <A
10370 > to try and become a local master browser
10371 on a subnet. If set to <TT
10377 > will not attempt to become a local master browser
10378 on a subnet and will also lose in all browsing elections. By
10379 default this value is set to <TT
10382 >. Setting this value to <TT
10386 mean that Samba will <SPAN
10393 browser on a subnet, just that <B
10402 > in elections for local master browser.</P
10404 >Setting this value to <TT
10417 > to become a local master browser.</P
10421 >local master = yes</B
10432 HREF="index.html#LOCKDIRECTORY"
10436 > lock directory</I
10443 NAME="LOCKDIRECTORY"
10445 >lock directory (G)</DT
10448 >This option specifies the directory where lock
10449 files will be placed. The lock files are used to implement the
10451 HREF="index.html#MAXCONNECTIONS"
10455 >max connections</I
10463 >lock directory = ${prefix}/var/locks</B
10468 >lock directory = /var/run/samba/locks</B
10474 NAME="LOCKSPINCOUNT"
10476 >lock spin count (G)</DT
10479 >This parameter controls the number of times
10480 that smbd should attempt to gain a byte range lock on the
10481 behalf of a client request. Experiments have shown that
10482 Windows 2k servers do not reply with a failure if the lock
10483 could not be immediately granted, but try a few more times
10484 in case the lock could later be aquired. This behavior
10485 is used to support PC database formats such as MS Access
10491 >lock spin count = 2</B
10497 NAME="LOCKSPINTIME"
10499 >lock spin time (G)</DT
10502 >The time in microseconds that smbd should
10503 pause before attempting to gain a failed lock. See
10505 HREF="index.html#LOCKSPINCOUNT"
10513 > for more details.
10518 >lock spin time = 10</B
10529 >This controls whether or not locking will be
10530 performed by the server in response to lock requests from the
10536 >, all lock and unlock
10537 requests will appear to succeed and all lock queries will report
10538 that the file in question is available for locking.</P
10543 >, real locking will be performed
10552 > be useful for read-only
10553 filesystems which <SPAN
10559 > not need locking (such as
10560 CDROM drives), although setting this parameter of <TT
10564 is not really recommended even in this case.</P
10566 >Be careful about disabling locking either globally or in a
10567 specific service, as lack of locking may result in data corruption.
10568 You should never need to set this parameter.</P
10582 >This option allows you to override the name
10583 of the Samba log file (also known as the debug file).</P
10585 >This option takes the standard substitutions, allowing
10586 you to have separate log files for each user or machine.</P
10590 >log file = /usr/local/samba/var/log.%m
10601 >The value of the parameter (a astring) allows
10602 the debug level (logging level) to be specified in the
10606 > file. This parameter has been
10607 extended since 2.2.x series, now it allow to specify the debug
10608 level for multiple debug classes. This is to give greater
10609 flexibility in the configuration of the system.</P
10611 >The default will be the log level specified on
10612 the command line or level zero if none was specified.</P
10616 >log level = 3 passdb:5 auth:10 winbind:2
10624 >logon drive (G)</DT
10627 >This parameter specifies the local path to
10628 which the home directory will be connected (see <A
10629 HREF="index.html#LOGONHOME"
10637 and is only used by NT Workstations. </P
10639 >Note that this option is only useful if Samba is set up as a
10644 >logon drive = z:</B
10649 >logon drive = h:</B
10656 >logon home (G)</DT
10659 >This parameter specifies the home directory
10660 location when a Win95/98 or NT Workstation logs into a Samba PDC.
10661 It allows you to do </P
10669 >NET USE H: /HOME</B
10674 >from a command prompt, for example.</P
10676 >This option takes the standard substitutions, allowing
10677 you to have separate logon scripts for each user or machine.</P
10679 >This parameter can be used with Win9X workstations to ensure
10680 that roaming profiles are stored in a subdirectory of the user's
10681 home directory. This is done in the following way:</P
10685 >logon home = \\%N\%U\profile</B
10688 >This tells Samba to return the above string, with
10689 substitutions made when a client requests the info, generally
10690 in a NetUserGetInfo request. Win9X clients truncate the info to
10691 \\server\share when a user does <B
10695 but use the whole string when dealing with profiles.</P
10697 >Note that in prior versions of Samba, the <A
10698 HREF="index.html#LOGONPATH"
10705 > was returned rather than
10715 > but allowed profiles outside the home directory.
10716 The current implementation is correct, and can be used for
10717 profiles if you use the above trick.</P
10719 >This option is only useful if Samba is set up as a logon
10724 >logon home = "\\%N\%U"</B
10729 >logon home = "\\remote_smb_server\%U"</B
10737 >logon path (G)</DT
10740 >This parameter specifies the home directory
10741 where roaming profiles (NTuser.dat etc files for Windows NT) are
10742 stored. Contrary to previous versions of these manual pages, it has
10743 nothing to do with Win 9X roaming profiles. To find out how to
10744 handle roaming profiles for Win 9X system, see the <A
10745 HREF="index.html#LOGONHOME"
10754 >This option takes the standard substitutions, allowing you
10755 to have separate logon scripts for each user or machine. It also
10756 specifies the directory from which the "Application Data",
10766 >network neighborhood</TT
10771 and other folders, and their contents, are loaded and displayed on
10772 your Windows NT client.</P
10774 >The share and the path must be readable by the user for
10775 the preferences and directories to be loaded onto the Windows NT
10776 client. The share must be writeable when the user logs in for the first
10777 time, in order that the Windows NT client can create the NTuser.dat
10778 and other directories.</P
10780 >Thereafter, the directories and any of the contents can,
10781 if required, be made read-only. It is not advisable that the
10782 NTuser.dat file be made read-only - rename it to NTuser.man to
10783 achieve the desired effect (a <SPAN
10792 >Windows clients can sometimes maintain a connection to
10793 the [homes] share, even though there is no user logged in.
10794 Therefore, it is vital that the logon path does not include a
10795 reference to the homes share (i.e. setting this parameter to
10796 \%N\%U\profile_path will cause problems).</P
10798 >This option takes the standard substitutions, allowing
10799 you to have separate logon scripts for each user or machine.</P
10801 >Note that this option is only useful if Samba is set up
10802 as a logon server.</P
10806 >logon path = \\%N\%U\profile</B
10811 >logon path = \\PROFILESERVER\PROFILE\%U</B
10818 >logon script (G)</DT
10821 >This parameter specifies the batch file (.bat) or
10822 NT command file (.cmd) to be downloaded and run on a machine when
10823 a user successfully logs in. The file must contain the DOS
10824 style CR/LF line endings. Using a DOS-style editor to create the
10825 file is recommended.</P
10827 >The script must be a relative path to the [netlogon]
10828 service. If the [netlogon] service specifies a <A
10829 HREF="index.html#PATH"
10838 >/usr/local/samba/netlogon
10842 >logon script = STARTUP.BAT</B
10844 the file that will be downloaded is:</P
10848 >/usr/local/samba/netlogon/STARTUP.BAT</TT
10851 >The contents of the batch file are entirely your choice. A
10852 suggested command would be to add <B
10854 >NET TIME \\SERVER /SET
10856 >, to force every machine to synchronize clocks with
10857 the same time server. Another use would be to add <B
10860 U: \\SERVER\UTILS</B
10861 > for commonly used utilities, or <B
10863 > NET USE Q: \\SERVER\ISO9001_QA</B
10866 >Note that it is particularly important not to allow write
10867 access to the [netlogon] share, or to grant users write permission
10868 on the batch files in a secure environment, as this would allow
10869 the batch files to be arbitrarily modified and security to be
10872 >This option takes the standard substitutions, allowing you
10873 to have separate logon scripts for each user or machine.</P
10875 >This option is only useful if Samba is set up as a logon
10882 >no logon script defined</I
10888 >logon script = scripts\%U.bat</B
10893 NAME="LPPAUSECOMMAND"
10895 >lppause command (S)</DT
10898 >This parameter specifies the command to be
10899 executed on the server host in order to stop printing or spooling
10900 a specific print job.</P
10902 >This command should be a program or script which takes
10903 a printer name and job number to pause the print job. One way
10904 of implementing this is by using job priorities, where jobs
10905 having a too low priority won't be sent to the printer.</P
10912 > is given then the printer name
10913 is put in its place. A <TT
10919 the job number (an integer). On HPUX (see <TT
10931 to the lpq command, the job will show up with the correct status, i.e.
10932 if the job priority is lower than the set fence priority it will
10933 have the PAUSED status, whereas if the priority is equal or higher it
10934 will have the SPOOLED or PRINTING status.</P
10936 >Note that it is good practice to include the absolute path
10937 in the lppause command as the PATH may not be available to the server.</P
10940 HREF="index.html#PRINTING"
10950 >Default: Currently no default value is given to
10951 this string, unless the value of the <TT
10960 >, in which case the default is :</P
10964 >lp -i %p-%j -H hold</B
10967 >or if the value of the <TT
10976 >, then the default is:</P
10980 >qstat -s -j%j -h</B
10983 >Example for HPUX: <B
10985 >lppause command = /usr/bin/lpalt
10991 NAME="LPQCACHETIME"
10993 >lpq cache time (G)</DT
10996 >This controls how long lpq info will be cached
10997 for to prevent the <B
11000 > command being called too
11001 often. A separate cache is kept for each variation of the <B
11004 > command used by the system, so if you use different
11008 > commands for different users then they won't
11009 share cache information.</P
11011 >The cache files are stored in <TT
11015 where xxxx is a hash of the <B
11018 > command in use.</P
11020 >The default is 10 seconds, meaning that the cached results
11021 of a previous identical <B
11024 > command will be used
11025 if the cached data is less than 10 seconds old. A large value may
11026 be advisable if your <B
11029 > command is very slow.</P
11031 >A value of 0 will disable caching completely.</P
11034 HREF="index.html#PRINTING"
11046 >lpq cache time = 10</B
11051 >lpq cache time = 30</B
11058 >lpq command (S)</DT
11061 >This parameter specifies the command to be
11062 executed on the server host in order to obtain <B
11066 >-style printer status information.</P
11068 >This command should be a program or script which
11069 takes a printer name as its only parameter and outputs printer
11070 status information.</P
11072 >Currently nine styles of printer status information
11073 are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ.
11074 This covers most UNIX systems. You control which type is expected
11082 >Some clients (notably Windows for Workgroups) may not
11083 correctly send the connection number for the printer they are
11084 requesting status information about. To get around this, the
11085 server reports on the first printer service connected to by the
11086 client. This only happens if the connection number sent is invalid.</P
11093 > is given then the printer name
11094 is put in its place. Otherwise it is placed at the end of the
11097 >Note that it is good practice to include the absolute path
11107 > may not be available to the server. When compiled with
11108 the CUPS libraries, no <TT
11114 needed because smbd will make a library call to obtain the
11115 print queue listing.</P
11118 HREF="index.html#PRINTING"
11132 >depends on the setting of <TT
11143 >lpq command = /usr/bin/lpq -P%p</B
11148 NAME="LPRESUMECOMMAND"
11150 >lpresume command (S)</DT
11153 >This parameter specifies the command to be
11154 executed on the server host in order to restart or continue
11155 printing or spooling a specific print job.</P
11157 >This command should be a program or script which takes
11158 a printer name and job number to resume the print job. See
11160 HREF="index.html#LPPAUSECOMMAND"
11175 > is given then the printer name
11176 is put in its place. A <TT
11182 the job number (an integer).</P
11184 >Note that it is good practice to include the absolute path
11188 >lpresume command</I
11190 > as the PATH may not
11191 be available to the server.</P
11194 HREF="index.html#PRINTING"
11204 >Default: Currently no default value is given
11205 to this string, unless the value of the <TT
11214 >, in which case the default is :</P
11218 >lp -i %p-%j -H resume</B
11221 >or if the value of the <TT
11230 >, then the default is:</P
11234 >qstat -s -j%j -r</B
11237 >Example for HPUX: <B
11239 >lpresume command = /usr/bin/lpalt
11247 >lprm command (S)</DT
11250 >This parameter specifies the command to be
11251 executed on the server host in order to delete a print job.</P
11253 >This command should be a program or script which takes
11254 a printer name and job number, and deletes the print job.</P
11261 > is given then the printer name
11262 is put in its place. A <TT
11268 the job number (an integer).</P
11270 >Note that it is good practice to include the absolute
11276 > as the PATH may not be
11277 available to the server.</P
11280 HREF="index.html#PRINTING"
11294 >depends on the setting of <TT
11306 >lprm command = /usr/bin/lprm -P%p %j
11312 >lprm command = /usr/bin/cancel %p-%j
11318 NAME="MACHINEPASSWORDTIMEOUT"
11320 >machine password timeout (G)</DT
11323 >If a Samba server is a member of a Windows
11324 NT Domain (see the <A
11325 HREF="index.html#SECURITYEQUALSDOMAIN"
11326 >security = domain</A
11328 parameter) then periodically a running <A
11332 > process will try and change the MACHINE ACCOUNT
11333 PASSWORD stored in the TDB called <TT
11335 >private/secrets.tdb
11337 >. This parameter specifies how often this password
11338 will be changed, in seconds. The default is one week (expressed in
11339 seconds), the same as a Windows NT Domain member server.</P
11342 HREF="smbpasswd.8.html"
11350 HREF="index.html#SECURITYEQUALSDOMAIN"
11351 > security = domain</A
11356 >machine password timeout = 604800</B
11363 >magic output (S)</DT
11366 >This parameter specifies the name of a file
11367 which will contain output created by a magic script (see the
11369 HREF="index.html#MAGICSCRIPT"
11377 parameter below).</P
11379 >Warning: If two clients use the same <TT
11385 > in the same directory the output file content
11390 >magic output = <magic script name>.out
11396 >magic output = myfile.txt</B
11403 >magic script (S)</DT
11406 >This parameter specifies the name of a file which,
11407 if opened, will be executed by the server when the file is closed.
11408 This allows a UNIX script to be sent to the Samba host and
11409 executed on behalf of the connected user.</P
11411 >Scripts executed in this way will be deleted upon
11412 completion assuming that the user has the appropriate level
11413 of privilege and the file permissions allow the deletion.</P
11415 >If the script generates output, output will be sent to
11416 the file specified by the <A
11417 HREF="index.html#MAGICOUTPUT"
11424 > parameter (see above).</P
11426 >Note that some shells are unable to interpret scripts
11427 containing CR/LF instead of CR as
11428 the end-of-line marker. Magic scripts must be executable
11435 > on the host, which for some hosts and
11436 some shells will require filtering at the DOS end.</P
11438 >Magic scripts are <SPAN
11451 > be relied upon.</P
11457 >None. Magic scripts disabled.</I
11463 >magic script = user.csh</B
11470 >mangle case (S)</DT
11473 >See the section on <A
11474 HREF="index.html#AEN203"
11480 >mangle case = no</B
11487 >mangled map (S)</DT
11490 >This is for those who want to directly map UNIX
11491 file names which cannot be represented on Windows/DOS. The mangling
11492 of names is not always what is needed. In particular you may have
11493 documents with file extensions that differ between DOS and UNIX.
11494 For example, under UNIX it is common to use <TT
11498 for HTML files, whereas under Windows/DOS <TT
11502 is more commonly used.</P
11515 >mangled map = (*.html *.htm)</B
11518 >One very useful case is to remove the annoying <TT
11522 > off the ends of filenames on some CDROMs (only visible
11523 under some UNIXes). To do this use a map of (*;1 *;).</P
11535 >mangled map = (*;1 *;)</B
11540 NAME="MANGLEDNAMES"
11542 >mangled names (S)</DT
11545 >This controls whether non-DOS names under UNIX
11546 should be mapped to DOS-compatible names ("mangled") and made visible,
11547 or whether non-DOS names should simply be ignored.</P
11549 >See the section on <A
11550 HREF="index.html#AEN203"
11552 > for details on how to control the mangling process.</P
11554 >If mangling is used then the mangling algorithm is as follows:</P
11560 >The first (up to) five alphanumeric characters
11561 before the rightmost dot of the filename are preserved, forced
11562 to upper case, and appear as the first (up to) five characters
11563 of the mangled name.</P
11567 >A tilde "~" is appended to the first part of the mangled
11568 name, followed by a two-character unique sequence, based on the
11569 original root name (i.e., the original filename minus its final
11570 extension). The final extension is included in the hash calculation
11571 only if it contains any upper case characters or is longer than three
11574 >Note that the character to use may be specified using
11576 HREF="index.html#MANGLINGCHAR"
11584 > option, if you don't like '~'.</P
11588 >The first three alphanumeric characters of the final
11589 extension are preserved, forced to upper case and appear as the
11590 extension of the mangled name. The final extension is defined as that
11591 part of the original filename after the rightmost dot. If there are no
11592 dots in the filename, the mangled name will have no extension (except
11593 in the case of "hidden files" - see below).</P
11597 >Files whose UNIX name begins with a dot will be
11598 presented as DOS hidden files. The mangled name will be created as
11599 for other filenames, but with the leading dot removed and "___" as
11600 its extension regardless of actual original extension (that's three
11605 >The two-digit hash value consists of upper case
11606 alphanumeric characters.</P
11608 >This algorithm can cause name collisions only if files
11609 in a directory share the same first five alphanumeric characters.
11610 The probability of such a clash is 1/1300.</P
11612 >The name mangling (if enabled) allows a file to be
11613 copied between UNIX directories from Windows/DOS while retaining
11614 the long UNIX filename. UNIX files can be renamed to a new extension
11615 from Windows/DOS and will retain the same basename. Mangled names
11616 do not change between sessions.</P
11620 >mangled names = yes</B
11625 NAME="MANGLINGMETHOD"
11627 >mangling method (G)</DT
11630 > controls the algorithm used for the generating
11631 the mangled names. Can take two different values, "hash" and
11632 "hash2". "hash" is the default and is the algorithm that has been
11633 used in Samba for many years. "hash2" is a newer and considered
11634 a better algorithm (generates less collisions) in the names.
11635 However, many Win32 applications store the mangled names and so
11636 changing to the new algorithm must not be done
11637 lightly as these applications may break unless reinstalled.
11638 New installations of Samba may set the default to hash2.</P
11642 >mangling method = hash</B
11647 >mangling method = hash2</B
11652 NAME="MANGLEDSTACK"
11654 >mangled stack (G)</DT
11657 >This parameter controls the number of mangled names
11658 that should be cached in the Samba server <A
11664 >This stack is a list of recently mangled base names
11665 (extensions are only maintained if they are longer than 3 characters
11666 or contains upper case characters).</P
11668 >The larger this value, the more likely it is that mangled
11669 names can be successfully converted to correct long UNIX names.
11670 However, large stack sizes will slow most directory accesses. Smaller
11671 stacks save memory in the server (each stack element costs 256 bytes).
11674 >It is not possible to absolutely guarantee correct long
11675 filenames, so be prepared for some surprises!</P
11679 >mangled stack = 50</B
11684 >mangled stack = 100</B
11689 NAME="MANGLINGCHAR"
11691 >mangling char (S)</DT
11694 >This controls what character is used as
11702 HREF="index.html#AEN203"
11704 >. The default is a '~'
11705 but this may interfere with some software. Use this option to set
11706 it to whatever you prefer.</P
11710 >mangling char = ~</B
11715 >mangling char = ^</B
11722 >map archive (S)</DT
11725 >This controls whether the DOS archive attribute
11726 should be mapped to the UNIX owner execute bit. The DOS archive bit
11727 is set when a file has been modified since its last backup. One
11728 motivation for this option it to keep Samba/your PC from making
11729 any file it touches from becoming executable under UNIX. This can
11730 be quite annoying for shared source code, documents, etc...</P
11732 >Note that this requires the <TT
11738 parameter to be set such that owner execute bit is not masked out
11739 (i.e. it must include 100). See the parameter <A
11740 HREF="index.html#CREATEMASK"
11751 >map archive = yes</B
11758 >map hidden (S)</DT
11761 >This controls whether DOS style hidden files
11762 should be mapped to the UNIX world execute bit.</P
11764 >Note that this requires the <TT
11770 to be set such that the world execute bit is not masked out (i.e.
11771 it must include 001). See the parameter <A
11772 HREF="index.html#CREATEMASK"
11783 >map hidden = no</B
11790 >map system (S)</DT
11793 >This controls whether DOS style system files
11794 should be mapped to the UNIX group execute bit.</P
11796 >Note that this requires the <TT
11802 to be set such that the group execute bit is not masked out (i.e.
11803 it must include 010). See the parameter <A
11804 HREF="index.html#CREATEMASK"
11815 >map system = no</B
11822 >map to guest (G)</DT
11825 >This parameter is only useful in <A
11826 HREF="index.html#SECURITY"
11828 > modes other than <TT
11831 >security = share</I
11846 >This parameter can take three different values, which tell
11851 > what to do with user
11852 login requests that don't match a valid UNIX user in some way.</P
11854 >The three settings are :</P
11863 > - Means user login
11864 requests with an invalid password are rejected. This is the
11873 logins with an invalid password are rejected, unless the username
11874 does not exist, in which case it is treated as a guest login and
11876 HREF="index.html#GUESTACCOUNT"
11890 > - Means user logins
11891 with an invalid password are treated as a guest login and mapped
11893 HREF="index.html#GUESTACCOUNT"
11896 this can cause problems as it means that any user incorrectly typing
11897 their password will be silently logged on as "guest" - and
11898 will not know the reason they cannot access files they think
11899 they should - there will have been no message given to them
11900 that they got their password wrong. Helpdesk services will
11907 > you if you set the <TT
11913 > parameter this way :-).</P
11917 >Note that this parameter is needed to set up "Guest"
11918 share services when using <TT
11924 share. This is because in these modes the name of the resource being
11931 > sent to the server until after
11932 the server has successfully authenticated the client so the server
11933 cannot make authentication decisions at the correct time (connection
11934 to the share) for "Guest" shares.</P
11936 >For people familiar with the older Samba releases, this
11937 parameter maps to the old compile-time setting of the <TT
11939 > GUEST_SESSSETUP</TT
11940 > value in local.h.</P
11944 >map to guest = Never</B
11949 >map to guest = Bad User</B
11954 NAME="MAXCONNECTIONS"
11956 >max connections (S)</DT
11959 >This option allows the number of simultaneous
11960 connections to a service to be limited. If <TT
11966 > is greater than 0 then connections will be refused if
11967 this number of connections to the service are already open. A value
11968 of zero mean an unlimited number of connections may be made.</P
11970 >Record lock files are used to implement this feature. The
11971 lock files will be stored in the directory specified by the <A
11972 HREF="index.html#LOCKDIRECTORY"
11984 >max connections = 0</B
11989 >max connections = 10</B
11996 >max disk size (G)</DT
11999 >This option allows you to put an upper limit
12000 on the apparent size of disks. If you set this option to 100
12001 then all shares will appear to be not larger than 100 MB in
12004 >Note that this option does not limit the amount of
12005 data you can put on the disk. In the above case you could still
12006 store much more than 100 MB on the disk, but if a client ever asks
12007 for the amount of free disk space or the total disk size then the
12008 result will be bounded by the amount specified in <TT
12016 >This option is primarily useful to work around bugs
12017 in some pieces of software that can't handle very large disks,
12018 particularly disks over 1GB in size.</P
12025 > of 0 means no limit.</P
12029 >max disk size = 0</B
12034 >max disk size = 1000</B
12041 >max log size (G)</DT
12044 >This option (an integer in kilobytes) specifies
12045 the max size the log file should grow to. Samba periodically checks
12046 the size and if it is exceeded it will rename the file, adding
12052 >A size of 0 means no limit.</P
12056 >max log size = 5000</B
12061 >max log size = 1000</B
12071 >This option controls the maximum number of
12072 outstanding simultaneous SMB operations that Samba tells the client
12073 it will allow. You should never need to set this parameter.</P
12082 NAME="MAXOPENFILES"
12084 >max open files (G)</DT
12087 >This parameter limits the maximum number of
12088 open files that one <A
12093 serving process may have open for a client at any one time. The
12094 default for this parameter is set very high (10,000) as Samba uses
12095 only one bit per unopened file.</P
12097 >The limit of the number of open files is usually set
12098 by the UNIX per-process file descriptor limit rather than
12099 this parameter so you should never need to touch this parameter.</P
12103 >max open files = 10000</B
12108 NAME="MAXPRINTJOBS"
12110 >max print jobs (S)</DT
12113 >This parameter limits the maximum number of
12114 jobs allowable in a Samba printer queue at any given moment.
12115 If this number is exceeded, <A
12122 > will remote "Out of Space" to the client.
12124 HREF="index.html#TOTALPRINTJOBS"
12137 >max print jobs = 1000</B
12142 >max print jobs = 5000</B
12149 >max protocol (G)</DT
12152 >The value of the parameter (a string) is the highest
12153 protocol level that will be supported by the server.</P
12155 >Possible values are :</P
12164 >: Earliest version. No
12165 concept of user names.</P
12172 >: Slight improvements on
12173 CORE for efficiency.</P
12186 > version of the protocol. Long filename
12194 >: Updates to Lanman1 protocol.
12202 >: Current up to date version of
12203 the protocol. Used by Windows NT. Known as CIFS.</P
12207 >Normally this option should not be set as the automatic
12208 negotiation phase in the SMB protocol takes care of choosing
12209 the appropriate protocol.</P
12212 HREF="index.html#MINPROTOCOL"
12224 >max protocol = NT1</B
12229 >max protocol = LANMAN1</B
12234 NAME="MAXSMBDPROCESSES"
12236 >max smbd processes (G)</DT
12239 >This parameter limits the maximum number of
12248 processes concurrently running on a system and is intended
12249 as a stopgap to prevent degrading service to clients in the event
12250 that the server has insufficient resources to handle more than this
12251 number of connections. Remember that under normal operating
12252 conditions, each user will have an <A
12256 > associated with him or her
12257 to handle connections to all shares from a given host.
12262 >max smbd processes = 0</B
12267 >max smbd processes = 1000</B
12277 >This option tells <A
12282 what the default 'time to live' of NetBIOS names should be (in seconds)
12286 > is requesting a name using either a
12287 broadcast packet or from a WINS server. You should never need to
12288 change this parameter. The default is 3 days.</P
12292 >max ttl = 259200</B
12299 >max wins ttl (G)</DT
12302 >This option tells <A
12307 > when acting as a WINS server (<A
12308 HREF="index.html#WINSSUPPORT"
12312 >wins support = yes</I
12315 >) what the maximum
12316 'time to live' of NetBIOS names that <B
12320 will grant will be (in seconds). You should never need to change this
12321 parameter. The default is 6 days (518400 seconds).</P
12324 HREF="index.html#MINWINSTTL"
12336 >max wins ttl = 518400</B
12346 >This option controls the maximum packet size
12347 that will be negotiated by Samba. The default is 65535, which
12348 is the maximum. In some cases you may find you get better performance
12349 with a smaller value. A value below 2048 is likely to cause problems.
12354 >max xmit = 65535</B
12359 >max xmit = 8192</B
12364 NAME="MESSAGECOMMAND"
12366 >message command (G)</DT
12369 >This specifies what command to run when the
12370 server receives a WinPopup style message.</P
12372 >This would normally be a command that would
12373 deliver the message somehow. How this is to be done is
12374 up to your imagination.</P
12380 >message command = csh -c 'xedit %s;rm %s' &</B
12384 >This delivers the message using <B
12388 removes it afterwards. <SPAN
12392 >NOTE THAT IT IS VERY IMPORTANT
12393 THAT THIS COMMAND RETURN IMMEDIATELY</I
12396 have the '&' on the end. If it doesn't return immediately then
12397 your PCs may freeze when sending messages (they should recover
12398 after 30 seconds, hopefully).</P
12400 >All messages are delivered as the global guest user.
12401 The command takes the standard substitutions, although <TT
12414 >Apart from the standard substitutions, some additional
12415 ones apply. In particular:</P
12426 > = the filename containing
12436 > = the destination that
12437 the message was sent to (probably the server name).</P
12446 > = who the message
12451 >You could make this command send mail, or whatever else
12452 takes your fancy. Please let us know of any really interesting
12455 >Here's a way of sending the messages as mail to root:</P
12459 >message command = /bin/mail -s 'message from %f on
12460 %m' root < %s; rm %s</B
12463 >If you don't have a message command then the message
12464 won't be delivered and Samba will tell the sender there was
12465 an error. Unfortunately WfWg totally ignores the error code
12466 and carries on regardless, saying that the message was delivered.
12469 >If you want to silently delete it then try:</P
12473 >message command = rm %s</B
12480 >no message command</I
12486 >message command = csh -c 'xedit %s;
12492 NAME="MINPASSWDLENGTH"
12494 >min passwd length (G)</DT
12498 HREF="index.html#MINPASSWORDLENGTH"
12502 >min password length</I
12509 NAME="MINPASSWORDLENGTH"
12511 >min password length (G)</DT
12514 >This option sets the minimum length in characters
12515 of a plaintext password that <B
12518 > will accept when performing
12519 UNIX password changing.</P
12522 HREF="index.html#UNIXPASSWORDSYNC"
12531 HREF="index.html#PASSWDPROGRAM"
12539 HREF="index.html#PASSWDCHATDEBUG"
12543 >passwd chat debug</I
12551 >min password length = 5</B
12556 NAME="MINPRINTSPACE"
12558 >min print space (S)</DT
12561 >This sets the minimum amount of free disk
12562 space that must be available before a user will be able to spool
12563 a print job. It is specified in kilobytes. The default is 0, which
12564 means a user can always spool a print job.</P
12567 HREF="index.html#PRINTING"
12579 >min print space = 0</B
12584 >min print space = 2000</B
12591 >min protocol (G)</DT
12594 >The value of the parameter (a string) is the
12595 lowest SMB protocol dialect than Samba will support. Please refer
12597 HREF="index.html#MAXPROTOCOL"
12605 parameter for a list of valid protocol names and a brief description
12606 of each. You may also wish to refer to the C source code in
12609 >source/smbd/negprot.c</TT
12610 > for a listing of known protocol
12611 dialects supported by clients.</P
12613 >If you are viewing this parameter as a security measure, you should
12614 also refer to the <A
12615 HREF="index.html#LANMANAUTH"
12623 > parameter. Otherwise, you should never need
12624 to change this parameter.</P
12628 >min protocol = CORE</B
12633 >min protocol = NT1</B
12641 >min wins ttl (G)</DT
12644 >This option tells <A
12649 when acting as a WINS server (<A
12650 HREF="index.html#WINSSUPPORT"
12654 > wins support = yes</I
12657 >) what the minimum 'time to live'
12658 of NetBIOS names that <B
12661 > will grant will be (in
12662 seconds). You should never need to change this parameter. The default
12663 is 6 hours (21600 seconds).</P
12667 >min wins ttl = 21600</B
12674 >msdfs root (S)</DT
12677 >This boolean parameter is only available if
12678 Samba is configured and compiled with the <B
12681 > option. If set to <TT
12685 Samba treats the share as a Dfs root and allows clients to browse
12686 the distributed file system tree rooted at the share directory.
12687 Dfs links are specified in the share directory by symbolic
12688 links of the form <TT
12690 >msdfs:serverA\shareA,serverB\shareB
12692 > and so on. For more information on setting up a Dfs tree
12693 on Samba, refer to <A
12694 HREF="msdfs_setup.html"
12701 HREF="index.html#HOSTMSDFS"
12713 >msdfs root = no</B
12718 NAME="NAMECACHETIMEOUT"
12720 >name cache timeout (G)</DT
12723 >Specifies the number of seconds it takes before
12724 entries in samba's hostname resolve cache time out. If
12725 the timeout is set to 0. the caching is disabled.
12730 >name cache timeout = 660</B
12735 >name cache timeout = 0</B
12740 NAME="NAMERESOLVEORDER"
12742 >name resolve order (G)</DT
12745 >This option is used by the programs in the Samba
12746 suite to determine what naming services to use and in what order
12747 to resolve host names to IP addresses. The option takes a space
12748 separated string of name resolution options.</P
12750 >The options are :"lmhosts", "host", "wins" and "bcast". They
12751 cause names to be resolved as follows :</P
12761 address in the Samba lmhosts file. If the line in lmhosts has
12762 no name type attached to the NetBIOS name (see the <A
12763 HREF="lmhosts.5.html"
12766 > for details) then
12767 any name type matches for lookup.</P
12774 > : Do a standard host
12775 name to IP address resolution, using the system <TT
12779 >, NIS, or DNS lookups. This method of name resolution
12780 is operating system depended for instance on IRIX or Solaris this
12781 may be controlled by the <TT
12783 >/etc/nsswitch.conf</TT
12785 file. Note that this method is only used if the NetBIOS name
12786 type being queried is the 0x20 (server) name type, otherwise
12794 > : Query a name with
12795 the IP address listed in the <A
12796 HREF="index.html#WINSSERVER"
12803 > parameter. If no WINS server has
12804 been specified this method will be ignored.</P
12811 > : Do a broadcast on
12812 each of the known local interfaces listed in the <A
12813 HREF="index.html#INTERFACES"
12821 parameter. This is the least reliable of the name resolution
12822 methods as it depends on the target host being on a locally
12823 connected subnet.</P
12829 >name resolve order = lmhosts host wins bcast
12835 >name resolve order = lmhosts bcast host
12839 >This will cause the local lmhosts file to be examined
12840 first, followed by a broadcast attempt, followed by a normal
12841 system hostname lookup.</P
12845 NAME="NETBIOSALIASES"
12847 >netbios aliases (G)</DT
12850 >This is a list of NetBIOS names that <A
12854 > will advertise as additional
12855 names by which the Samba server is known. This allows one machine
12856 to appear in browse lists under multiple names. If a machine is
12857 acting as a browse server or logon server none
12858 of these names will be advertised as either browse server or logon
12859 servers, only the primary name of the machine will be advertised
12860 with these capabilities.</P
12863 HREF="index.html#NETBIOSNAME"
12877 >empty string (no additional names)</I
12883 >netbios aliases = TEST TEST1 TEST2</B
12890 >netbios name (G)</DT
12893 >This sets the NetBIOS name by which a Samba
12894 server is known. By default it is the same as the first component
12895 of the host's DNS name. If a machine is a browse server or
12896 logon server this name (or the first component
12897 of the hosts DNS name) will be the name that these services are
12898 advertised under.</P
12901 HREF="index.html#NETBIOSALIASES"
12915 >machine DNS name</I
12921 >netbios name = MYNAME</B
12926 NAME="NETBIOSSCOPE"
12928 >netbios scope (G)</DT
12931 >This sets the NetBIOS scope that Samba will
12932 operate under. This should not be set unless every machine
12933 on your LAN also sets this value.</P
12939 >nis homedir (G)</DT
12942 >Get the home share server from a NIS map. For
12943 UNIX systems that use an automounter, the user's home directory
12944 will often be mounted on a workstation on demand from a remote
12947 >When the Samba logon server is not the actual home directory
12948 server, but is mounting the home directories via NFS then two
12949 network hops would be required to access the users home directory
12950 if the logon server told the client to use itself as the SMB server
12951 for home directories (one over SMB and one over NFS). This can
12954 >This option allows Samba to return the home share as
12955 being on a different server to the logon server and as
12956 long as a Samba daemon is running on the home directory server,
12957 it will be mounted on the Samba client directly from the directory
12958 server. When Samba is returning the home share to the client, it
12959 will consult the NIS map specified in <A
12960 HREF="index.html#HOMEDIRMAP"
12967 > and return the server
12970 >Note that for this option to work there must be a working
12971 NIS system and the Samba server with this option must also
12972 be a logon server.</P
12976 >nis homedir = no</B
12981 NAME="NONUNIXACCOUNTRANGE"
12983 >non unix account range (G)</DT
12986 >The non unix account range parameter specifies
12987 the range of 'user ids' that are allocated by the various 'non unix
12988 account' passdb backends. These backends allow
12989 the storage of passwords for users who don't exist in /etc/passwd.
12990 This is most often used for machine account creation.
12991 This range of ids should have no existing local or NIS users within
12992 it as strange conflicts can occur otherwise.</P
12994 >NOTE: These userids never appear on the system and Samba will never
12995 'become' these users. They are used only to ensure that the algorithmic
12996 RID mapping does not conflict with normal users.
13001 >non unix account range = <empty string>
13007 >non unix account range = 10000-20000</B
13012 NAME="NTACLSUPPORT"
13014 >nt acl support (S)</DT
13017 >This boolean parameter controls whether
13022 > will attempt to map
13023 UNIX permissions into Windows NT access control lists.
13024 This parameter was formally a global parameter in releases
13029 >nt acl support = yes</B
13034 NAME="NTPIPESUPPORT"
13036 >nt pipe support (G)</DT
13039 >This boolean parameter controls whether
13044 > will allow Windows NT
13045 clients to connect to the NT SMB specific <TT
13049 pipes. This is a developer debugging option and can be left
13054 >nt pipe support = yes</B
13059 NAME="NTSTATUSSUPPORT"
13061 >nt status support (G)</DT
13064 >This boolean parameter controls whether <A
13068 > will negotiate NT specific status
13069 support with Windows NT/2k/XP clients. This is a developer
13070 debugging option and should be left alone.
13071 If this option is set to <TT
13074 > then Samba offers
13075 exactly the same DOS error codes that versions prior to Samba 2.2.3
13078 >You should not need to ever disable this parameter.</P
13082 >nt status support = yes</B
13087 NAME="NULLPASSWORDS"
13089 >null passwords (G)</DT
13092 >Allow or disallow client access to accounts
13093 that have null passwords. </P
13096 HREF="smbpasswd.5.html"
13103 >null passwords = no</B
13108 NAME="OBEYPAMRESTRICTIONS"
13110 >obey pam restrictions (G)</DT
13113 >When Samba 2.2 is configured to enable PAM support
13114 (i.e. --with-pam), this parameter will control whether or not Samba
13115 should obey PAM's account and session management directives. The
13116 default behavior is to use PAM for clear text authentication only
13117 and to ignore any account or session management. Note that Samba
13118 always ignores PAM for authentication in the case of <A
13119 HREF="index.html#ENCRYPTPASSWORDS"
13123 >encrypt passwords = yes</I
13127 >. The reason is that PAM modules cannot support the challenge/response
13128 authentication mechanism needed in the presence of SMB password encryption.
13133 >obey pam restrictions = no</B
13143 >This is a boolean option that controls whether
13144 connections with usernames not in the <TT
13150 list will be allowed. By default this option is disabled so that a
13151 client can supply a username to be used by the server. Enabling
13152 this parameter will force the server to only user the login
13158 > list and is only really
13160 HREF="index.html#SECURITYEQUALSSHARE"
13165 >Note that this also means Samba won't try to deduce
13166 usernames from the service name. This can be annoying for
13167 the [homes] section. To get around this you could use <B
13171 > which means your <TT
13177 will be just the service name, which for home directories is the
13178 name of the user.</P
13181 HREF="index.html#USER"
13200 >only guest (S)</DT
13204 HREF="index.html#GUESTONLY"
13215 NAME="OPLOCKBREAKWAITTIME"
13217 >oplock break wait time (G)</DT
13220 >This is a tuning parameter added due to bugs in
13221 both Windows 9x and WinNT. If Samba responds to a client too
13222 quickly when that client issues an SMB that can cause an oplock
13223 break request, then the network client can fail and not respond
13224 to the break request. This tuning parameter (which is set in milliseconds)
13225 is the amount of time Samba will wait before sending an oplock break
13226 request to such (broken) clients.</P
13232 >DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
13233 AND UNDERSTOOD THE SAMBA OPLOCK CODE</I
13239 >oplock break wait time = 0</B
13244 NAME="OPLOCKCONTENTIONLIMIT"
13246 >oplock contention limit (S)</DT
13261 improve the efficiency of the granting of oplocks under multiple
13262 client contention for the same file.</P
13264 >In brief it specifies a number, which causes <A
13269 grant an oplock even when requested if the approximate number of
13270 clients contending for an oplock on the same file goes over this
13271 limit. This causes <B
13274 > to behave in a similar
13275 way to Windows NT.</P
13281 >DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
13282 AND UNDERSTOOD THE SAMBA OPLOCK CODE</I
13288 >oplock contention limit = 2</B
13298 >This boolean option tells <B
13302 issue oplocks (opportunistic locks) to file open requests on this
13303 share. The oplock code can dramatically (approx. 30% or more) improve
13304 the speed of access to files on Samba servers. It allows the clients
13305 to aggressively cache files locally and you may want to disable this
13306 option for unreliable network environments (it is turned on by
13307 default in Windows NT Servers). For more information see the file
13317 >Oplocks may be selectively turned off on certain files with a
13319 HREF="index.html#VETOOPLOCKFILES"
13323 > veto oplock files</I
13326 > parameter. On some systems
13327 oplocks are recognized by the underlying operating system. This
13328 allows data synchronization between all access to oplocked files,
13329 whether it be via Samba or NFS or a local UNIX process. See the
13335 > parameter for details.</P
13338 HREF="index.html#KERNELOPLOCKS"
13347 HREF="index.html#LEVEL2OPLOCKS"
13351 > level2 oplocks</I
13368 >This parameter determines whether or not <A
13373 attempt to authenticate users using the NTLM password hash.
13374 If disabled, only the lanman password hashes will be used.
13377 >Please note that at least this option or <B
13380 > should be enabled in order to be able to log in.
13385 >ntlm auth = yes</B
13395 >This integer value controls what level Samba
13396 advertises itself as for browse elections. The value of this
13397 parameter determines whether <A
13402 has a chance of becoming a local master browser for the <TT
13407 > in the local broadcast area.</P
13415 >By default, Samba will win
13416 a local master browsing election over all Microsoft operating
13417 systems except a Windows NT 4.0/2000 Domain Controller. This
13418 means that a misconfigured Samba host can effectively isolate
13419 a subnet for browsing purposes. See <TT
13441 NAME="OS2DRIVERMAP"
13443 >os2 driver map (G)</DT
13446 >The parameter is used to define the absolute
13447 path to a file containing a mapping of Windows NT printer driver
13448 names to OS/2 printer driver names. The format is:</P
13450 ><nt driver name> = <os2 driver
13451 name>.<device name></P
13453 >For example, a valid entry using the HP LaserJet 5
13454 printer driver would appear as <B
13456 >HP LaserJet 5L = LASERJET.HP
13460 >The need for the file is due to the printer driver namespace
13461 problem described in the <A
13462 HREF="printer_driver2.html"
13466 >. For more details on OS/2 clients, please
13468 HREF="OS2-Client-HOWTO.html"
13472 > containing in the Samba documentation.</P
13476 >os2 driver map = <empty string>
13482 NAME="PAMPASSWORDCHANGE"
13484 >pam password change (G)</DT
13487 >With the addition of better PAM support in Samba 2.2,
13488 this parameter, it is possible to use PAM's password change control
13489 flag for Samba. If enabled, then PAM will be used for password
13490 changes when requested by an SMB client instead of the program listed in
13492 HREF="index.html#PASSWDPROGRAM"
13500 It should be possible to enable this without changing your
13502 HREF="index.html#PASSWDCHAT"
13510 parameter for most setups.
13515 >pam password change = no</B
13522 >panic action (G)</DT
13525 >This is a Samba developer option that allows a
13526 system command to be called when either <A
13535 crashes. This is usually used to draw attention to the fact that
13536 a problem occurred.</P
13540 >panic action = <empty string></B
13545 >panic action = "/bin/sleep 90000"</B
13550 NAME="PARANOIDSERVERSECURITY"
13552 >paranoid server security (G)</DT
13555 >Some version of NT 4.x allow non-guest
13556 users with a bad passowrd. When this option is enabled, samba will not
13557 use a broken NT 4.x server as password server, but instead complain
13558 to the logs and exit.
13563 >paranoid server security = yes</B
13568 NAME="PASSDBBACKEND"
13570 >passdb backend (G)</DT
13573 >This option allows the administrator to chose which backends to retrieve and store passwords with. This allows (for example) both
13574 smbpasswd and tdbsam to be used without a recompile.
13575 Multiple backends can be specified, seperated by spaces. The backends will be searched in the order they are specified. New users are always added to the first backend specified.
13576 Experimental backends must still be selected
13577 (eg --with-tdbsam) at configure time.
13580 >This parameter is in two parts, the backend's name, and a 'location'
13581 string that has meaning only to that particular backed. These are separated
13582 by a : character.</P
13584 >Available backends can include:
13593 > - The default smbpasswd
13594 backend. Takes a path to the smbpasswd file as an optional argument.</P
13602 backend, but with support for 'not unix accounts'.
13603 Takes a path to the smbpasswd file as an optional argument.</P
13606 HREF="index.html#NONUNIXACCOUNTRANGE"
13610 >non unix account range</I
13620 > - The TDB based password storage
13621 backend. Takes a path to the TDB as an optional argument (defaults to passdb.tdb
13623 HREF="index.html#PRIVATEDIR"
13637 > - The TDB based password storage
13638 backend, with non unix account support. Takes a path to the TDB as an optional argument (defaults to passdb.tdb
13640 HREF="index.html#PRIVATEDIR"
13650 HREF="index.html#NONUNIXACCOUNTRANGE"
13654 >non unix account range</I
13664 > - The LDAP based passdb
13665 backend. Takes an LDAP URL as an optional argument (defaults to
13668 >ldap://localhost</B
13676 > - The LDAP based passdb
13677 backend, with non unix account support. Takes an LDAP URL as an optional argument (defaults to
13680 >ldap://localhost</B
13684 HREF="index.html#NONUNIXACCOUNTRANGE"
13688 >non unix account range</I
13698 > - The NIS+ based passdb backend. Takes name NIS domain as an optional argument. Only works with sun NIS+ servers. </P
13705 > - Allows Samba to load an
13706 arbitary passdb backend from the .so specified as a compulsary argument.
13709 >Any characters after the (optional) second : are passed to the plugin
13710 for its own processing</P
13717 > - Allows samba to map all (other) available unix users</P
13719 >This backend uses the standard unix database for retrieving users. Users included
13720 in this pdb are NOT listed in samba user listings and users included in this pdb won't be
13721 able to login. The use of this backend is to always be able to display the owner of a file
13722 on the samba server - even when the user doesn't have a 'real' samba account in one of the
13723 other passdb backends.
13726 >This backend should always be the last backend listed, since it contains all users in
13727 the unix passdb and might 'override' mappings if specified earlier. It's meant to only return
13728 accounts for users that aren't covered by the previous backends.</P
13736 >passdb backend = smbpasswd unixsam</B
13741 >passdb backend = tdbsam:/etc/samba/private/passdb.tdb smbpasswd:/etc/samba/smbpasswd unixsam</B
13746 >passdb backend = ldapsam_nua:ldaps://ldap.example.com unixsam</B
13751 >passdb backend = plugin:/usr/local/samba/lib/my_passdb.so:my_plugin_args tdbsam:/etc/samba/private/passdb.tdb</B
13758 >passwd chat (G)</DT
13761 >This string controls the <SPAN
13768 conversation that takes places between <A
13772 > and the local password changing
13773 program to change the user's password. The string describes a
13774 sequence of response-receive pairs that <A
13778 > uses to determine what to send to the
13780 HREF="index.html#PASSWDPROGRAM"
13788 > and what to expect back. If the expected output is not
13789 received then the password is not changed.</P
13791 >This chat sequence is often quite site specific, depending
13792 on what local methods are used for password control (such as NIS
13795 >Note that this parameter only is only used if the <A
13796 HREF="index.html#UNIXPASSWORDSYNC"
13804 > parameter is set to <TT
13808 sequence is then called <SPAN
13814 > when the SMB password
13815 in the smbpasswd file is being changed, without access to the old
13816 password cleartext. This means that root must be able to reset the user's password
13817 without knowing the text of the previous password. In the presence of NIS/YP,
13818 this means that the <A
13819 HREF="index.html#PASSWDPROGRAM"
13822 executed on the NIS master.
13825 >The string can contain the macro <TT
13830 > which is substituted
13831 for the new password. The chat sequence can also contain the standard
13844 > to give line-feed,
13845 carriage-return, tab and space. The chat sequence string can also contain
13846 a '*' which matches any sequence of characters.
13847 Double quotes can be used to collect strings with spaces
13848 in them into a single string.</P
13850 >If the send string in any part of the chat sequence
13851 is a full stop ".", then no string is sent. Similarly,
13852 if the expect string is a full stop then no string is expected.</P
13855 HREF="index.html#PAMPASSWORDCHANGE"
13863 > parameter is set to true, the chat pairs
13864 may be matched in any order, and success is determined by the PAM result,
13865 not any particular output. The \n macro is ignored for PAM conversions.
13869 HREF="index.html#UNIXPASSWORDSYNC"
13878 HREF="index.html#PASSWDPROGRAM"
13882 > passwd program</I
13886 HREF="index.html#PASSWDCHATDEBUG"
13890 >passwd chat debug</I
13894 HREF="index.html#PAMPASSWORDCHANGE"
13898 >pam password change</I
13905 >passwd chat = *new*password* %n\n
13906 *new*password* %n\n *changed*</B
13911 >passwd chat = "*Enter OLD password*" %o\n
13912 "*Enter NEW password*" %n\n "*Reenter NEW password*" %n\n "*Password
13918 NAME="PASSWDCHATDEBUG"
13920 >passwd chat debug (G)</DT
13923 >This boolean specifies if the passwd chat script
13924 parameter is run in <SPAN
13930 > mode. In this mode the
13931 strings passed to and received from the passwd chat are printed
13938 HREF="index.html#DEBUGLEVEL"
13946 of 100. This is a dangerous option as it will allow plaintext passwords
13947 to be seen in the <B
13950 > log. It is available to help
13951 Samba admins debug their <TT
13957 when calling the <TT
13963 be turned off after this has been done. This option has no effect if the
13965 HREF="index.html#PAMPASSWORDCHANGE"
13969 >pam password change</I
13973 paramter is set. This parameter is off by default.</P
13976 HREF="index.html#PASSWDCHAT"
13985 HREF="index.html#PAMPASSWORDCHANGE"
13989 >pam password change</I
13994 HREF="index.html#PASSWDPROGRAM"
14006 >passwd chat debug = no</B
14011 NAME="PASSWDPROGRAM"
14013 >passwd program (G)</DT
14016 >The name of a program that can be used to set
14017 UNIX user passwords. Any occurrences of <TT
14023 will be replaced with the user name. The user name is checked for
14024 existence before calling the password changing program.</P
14026 >Also note that many passwd programs insist in <SPAN
14033 > passwords, such as a minimum length, or the inclusion
14034 of mixed case chars and digits. This can pose a problem as some clients
14035 (such as Windows for Workgroups) uppercase the password before sending
14050 > parameter is set to <TT
14054 > then this program is called <SPAN
14061 before the SMB password in the <A
14062 HREF="smbpasswd.5.html"
14066 > file is changed. If this UNIX password change fails, then
14070 > will fail to change the SMB password also
14071 (this is by design).</P
14076 >unix password sync</I
14079 is set this parameter <SPAN
14083 >MUST USE ABSOLUTE PATHS</I
14092 > programs called, and must be examined
14093 for security implications. Note that by default <TT
14105 HREF="index.html#UNIXPASSWORDSYNC"
14117 >passwd program = /bin/passwd</B
14122 >passwd program = /sbin/npasswd %u</B
14128 NAME="PASSWORDLEVEL"
14130 >password level (G)</DT
14133 >Some client/server combinations have difficulty
14134 with mixed-case passwords. One offending client is Windows for
14135 Workgroups, which for some reason forces passwords to upper
14136 case when using the LANMAN1 protocol, but leaves them alone when
14137 using COREPLUS! Another problem child is the Windows 95/98
14138 family of operating systems. These clients upper case clear
14139 text passwords even when NT LM 0.12 selected by the protocol
14140 negotiation request/response.</P
14142 >This parameter defines the maximum number of characters
14143 that may be upper case in passwords.</P
14145 >For example, say the password given was "FRED". If <TT
14148 > password level</I
14150 > is set to 1, the following combinations
14151 would be tried if "FRED" failed:</P
14153 >"Fred", "fred", "fRed", "frEd","freD"</P
14161 the following combinations would also be tried: </P
14163 >"FRed", "FrEd", "FreD", "fREd", "fReD", "frED", ..</P
14167 >The higher value this parameter is set to the more likely
14168 it is that a mixed case password will be matched against a single
14169 case password. However, you should be aware that use of this
14170 parameter reduces security and increases the time taken to
14171 process a new connection.</P
14173 >A value of zero will cause only two attempts to be
14174 made - the password as is and the password in all-lower case.</P
14178 >password level = 0</B
14183 >password level = 4</B
14188 NAME="PASSWORDSERVER"
14190 >password server (G)</DT
14193 >By specifying the name of another SMB server (such
14194 as a WinNT box) with this option, and using <B
14200 >security = server</B
14201 > you can get Samba
14202 to do all its username/password validation via a remote server.</P
14204 >This option sets the name of the password server to use.
14205 It must be a NetBIOS name, so if the machine's NetBIOS name is
14206 different from its Internet name then you may have to add its NetBIOS
14207 name to the lmhosts file which is stored in the same directory
14213 >The name of the password server is looked up using the
14215 HREF="index.html#NAMERESOLVEORDER"
14223 > and so may resolved
14224 by any method and order described in that parameter.</P
14226 >The password server much be a machine capable of using
14227 the "LM1.2X002" or the "NT LM 0.12" protocol, and it must be in
14228 user level security mode.</P
14236 > Using a password server
14237 means your UNIX box (running Samba) is only as secure as your
14238 password server. <SPAN
14242 >DO NOT CHOOSE A PASSWORD SERVER THAT
14243 YOU DON'T COMPLETELY TRUST</I
14247 >Never point a Samba server at itself for password
14248 serving. This will cause a loop and could lock up your Samba
14251 >The name of the password server takes the standard
14252 substitutions, but probably the only useful one is <TT
14258 >, which means the Samba server will use the incoming
14259 client as the password server. If you use this then you better
14260 trust your clients, and you had better restrict them with hosts allow!</P
14267 > parameter is set to
14271 >, then the list of machines in this
14272 option must be a list of Primary or Backup Domain controllers for the
14273 Domain or the character '*', as the Samba server is effectively
14274 in that domain, and will use cryptographically authenticated RPC calls
14275 to authenticate the user logging on. The advantage of using <B
14277 > security = domain</B
14278 > is that if you list several hosts in the
14282 >password server</I
14288 > will try each in turn till it finds one that responds. This
14289 is useful in case your primary server goes down.</P
14294 >password server</I
14297 to the character '*', then Samba will attempt to auto-locate the
14298 Primary or Backup Domain controllers to authenticate against by
14299 doing a query for the name <TT
14301 >WORKGROUP<1C></TT
14303 and then contacting each server returned in the list of IP
14304 addresses from the name resolution source. </P
14315 >, then there are different
14316 restrictions that <B
14318 >security = domain</B
14326 >You may list several password servers in
14330 >password server</I
14332 > parameter, however if an
14336 > makes a connection to a password server,
14337 and then the password server fails, no more users will be able
14338 to be authenticated from this <B
14342 restriction of the SMB/CIFS protocol when in <B
14346 > mode and cannot be fixed in Samba.</P
14350 >If you are using a Windows NT server as your
14351 password server then you will have to ensure that your users
14352 are able to login from the Samba server, as when in <B
14354 > security = server</B
14355 > mode the network logon will appear to
14356 come from there rather than from the users workstation.</P
14361 HREF="index.html#SECURITY"
14373 >password server = <empty string></B
14379 >password server = NT-PDC, NT-BDC1, NT-BDC2
14385 >password server = *</B
14395 >This parameter specifies a directory to which
14396 the user of the service is to be given access. In the case of
14397 printable services, this is where print data will spool prior to
14398 being submitted to the host for printing.</P
14400 >For a printable service offering guest access, the service
14401 should be readonly and the path should be world-writeable and
14402 have the sticky bit set. This is not mandatory of course, but
14403 you probably won't get the results you expect if you do
14406 >Any occurrences of <TT
14412 will be replaced with the UNIX username that the client is using
14413 on this connection. Any occurrences of <TT
14419 will be replaced by the NetBIOS name of the machine they are
14420 connecting from. These replacements are very useful for setting
14421 up pseudo home directories for users.</P
14423 >Note that this path will be based on <A
14424 HREF="index.html#ROOTDIR"
14431 > if one was specified.</P
14443 >path = /home/fred</B
14448 NAME="PIDDIRECTORY"
14450 >pid directory (G)</DT
14453 >This option specifies the directory where pid
14454 files will be placed. </P
14458 >pid directory = ${prefix}/var/locks</B
14463 >pid directory = /var/run/</B
14469 NAME="POSIXLOCKING"
14471 >posix locking (S)</DT
14482 daemon maintains an database of file locks obtained by SMB clients.
14483 The default behavior is to map this internal database to POSIX
14484 locks. This means that file locks obtained by SMB clients are
14485 consistent with those seen by POSIX compliant applications accessing
14486 the files via a non-SMB method (e.g. NFS or local file access).
14487 You should never need to disable this parameter.</P
14491 >posix locking = yes</B
14501 >This option specifies a command to be run
14502 whenever the service is disconnected. It takes the usual
14503 substitutions. The command may be run as the root on some
14506 >An interesting example may be to unmount server
14511 >postexec = /etc/umount /cdrom</B
14515 HREF="index.html#PREEXEC"
14529 >none (no command executed)</I
14536 >postexec = echo \"%u disconnected from %S
14537 from %m (%I)\" >> /tmp/log</B
14544 >postscript (S)</DT
14547 >This parameter forces a printer to interpret
14548 the print files as PostScript. This is done by adding a <TT
14552 > to the start of print output.</P
14554 >This is most useful when you have lots of PCs that persist
14555 in putting a control-D at the start of print jobs, which then
14556 confuses your printer.</P
14560 >postscript = no</B
14570 >This option specifies a command to be run whenever
14571 the service is connected to. It takes the usual substitutions.</P
14573 >An interesting example is to send the users a welcome
14574 message every time they log in. Maybe a message of the day? Here
14579 >preexec = csh -c 'echo \"Welcome to %S!\" |
14580 /usr/local/samba/bin/smbclient -M %m -I %I' & </B
14583 >Of course, this could get annoying after a while :-)</P
14586 HREF="index.html#PREEXECCLOSE"
14595 HREF="index.html#POSTEXEC"
14609 >none (no command executed)</I
14615 >preexec = echo \"%u connected to %S from %m
14616 (%I)\" >> /tmp/log</B
14621 NAME="PREEXECCLOSE"
14623 >preexec close (S)</DT
14626 >This boolean option controls whether a non-zero
14627 return code from <A
14628 HREF="index.html#PREEXEC"
14636 > should close the service being connected to.</P
14640 >preexec close = no</B
14645 NAME="PREFERREDMASTER"
14647 >preferred master (G)</DT
14650 >This boolean parameter controls if <A
14654 > is a preferred master browser
14655 for its workgroup.</P
14657 >If this is set to <TT
14664 will force an election, and it will have a slight advantage in
14665 winning the election. It is recommended that this parameter is
14666 used in conjunction with <B
14669 HREF="index.html#DOMAINMASTER"
14680 > can guarantee becoming a domain master.</P
14682 >Use this option with caution, because if there are several
14683 hosts (whether Samba servers, Windows 95 or NT) that are preferred
14684 master browsers on the same subnet, they will each periodically
14685 and continuously attempt to become the local master browser.
14686 This will result in unnecessary broadcast traffic and reduced browsing
14690 HREF="index.html#OSLEVEL"
14702 >preferred master = auto</B
14707 NAME="PREFEREDMASTER"
14709 >prefered master (G)</DT
14713 HREF="index.html#PREFERREDMASTER"
14717 > preferred master</I
14720 > for people who cannot spell :-).</P
14729 >This is a list of services that you want to be
14730 automatically added to the browse lists. This is most useful
14731 for homes and printers services that would otherwise not be
14734 >Note that if you just want all printers in your
14735 printcap file loaded then the <A
14736 HREF="index.html#LOADPRINTERS"
14743 > option is easier.</P
14749 >no preloaded services</I
14755 >preload = fred lp colorlp</B
14760 NAME="PRESERVECASE"
14762 >preserve case (S)</DT
14765 > This controls if new filenames are created
14766 with the case that the client passes, or if they are forced to
14768 HREF="index.html#DEFAULTCASE"
14780 >preserve case = yes</B
14783 >See the section on <A
14784 HREF="index.html#AEN203"
14787 > for a fuller discussion.</P
14791 NAME="PRINTCOMMAND"
14793 >print command (S)</DT
14796 >After a print job has finished spooling to
14797 a service, this command will be used via a <B
14801 call to process the spool file. Typically the command specified will
14802 submit the spool file to the host's printing subsystem, but there
14803 is no requirement that this be the case. The server will not remove
14804 the spool file, so whatever command you specify should remove the
14805 spool file when it has been processed, otherwise you will need to
14806 manually remove old spool files.</P
14808 >The print command is simply a text string. It will be used
14809 verbatim after macro substitutions have been made:</P
14811 >s, %p - the path to the spool
14814 >%p - the appropriate printer
14818 name as transmitted by the client.</P
14820 >%c - The number of printed pages
14821 of the spooled job (if known).</P
14823 >%z - the size of the spooled
14824 print job (in bytes)</P
14826 >The print command <SPAN
14833 one occurrence of <TT
14849 > is optional. At the time
14850 a job is submitted, if no printer name is supplied the <TT
14856 > will be silently removed from the printer command.</P
14858 >If specified in the [global] section, the print command given
14859 will be used for any printable service that does not have its own
14860 print command specified.</P
14862 >If there is neither a specified print command for a
14863 printable service nor a global print command, spool files will
14864 be created but not processed and (most importantly) not removed.</P
14866 >Note that printing may fail on some UNIXes from the
14870 > account. If this happens then create
14871 an alternative guest account that can print and set the <A
14872 HREF="index.html#GUESTACCOUNT"
14880 in the [global] section.</P
14882 >You can form quite complex print commands by realizing
14883 that they are just passed to a shell. For example the following
14884 will log a print job, print the file, then remove it. Note that
14885 ';' is the usual separator for command in shell scripts.</P
14889 >print command = echo Printing %s >>
14890 /tmp/print.log; lpr -P %p %s; rm %s</B
14893 >You may have to vary this command considerably depending
14894 on how you normally print files on your system. The default for
14895 the parameter varies depending on the setting of the <A
14896 HREF="index.html#PRINTING"
14907 >printing = BSD, AIX, QNX, LPRNG
14913 >print command = lpr -r -P%p %s</B
14918 >printing = SYSV or HPUX :</B
14923 >print command = lp -c -d%p %s; rm %s</B
14928 >printing = SOFTQ :</B
14933 >print command = lp -d%p -s %s; rm %s</B
14936 >For printing = CUPS : If SAMBA is compiled against
14938 HREF="index.html#PRINTING"
14939 >printcap = cups</A
14941 uses the CUPS API to
14942 submit jobs, etc. Otherwise it maps to the System V
14943 commands with the -oraw option for printing, i.e. it
14946 >lp -c -d%p -oraw; rm %s</B
14950 >printing = cups</B
14952 and if SAMBA is compiled against libcups, any manually
14953 set print command will be ignored.</P
14957 >print command = /usr/local/samba/bin/myprintscript
14969 HREF="index.html#PRINTABLE"
14985 >If this parameter is <TT
14989 clients may open, write to and submit spool files on the directory
14990 specified for the service. </P
14992 >Note that a printable service will ALWAYS allow writing
14993 to the service path (user privileges permitting) via the spooling
14994 of print data. The <A
14995 HREF="index.html#WRITEABLE"
15003 > parameter controls only non-printing access to
15019 HREF="index.html#PRINTCAPNAME"
15030 NAME="PRINTCAPNAME"
15032 >printcap name (G)</DT
15035 >This parameter may be used to override the
15036 compiled-in default printcap name used by the server (usually <TT
15038 > /etc/printcap</TT
15039 >). See the discussion of the <A
15040 HREF="index.html#AEN79"
15042 > section above for reasons
15043 why you might want to do this.</P
15045 >To use the CUPS printing interface set <B
15047 >printcap name = cups
15049 >. This should be supplemented by an addtional setting
15051 HREF="index.html#PRINTING"
15052 >printing = cups</A
15056 >printcap name = cups</B
15058 "dummy" printcap created by CUPS, as specified in your CUPS
15059 configuration file.
15062 >On System V systems that use <B
15066 list available printers you can use <B
15068 >printcap name = lpstat
15070 > to automatically obtain lists of available printers. This
15071 is the default for systems that define SYSV at configure time in
15072 Samba (this includes most System V based systems). If <TT
15081 these systems then Samba will launch <B
15085 attempt to parse the output to obtain a printer list.</P
15087 >A minimal printcap file would look something like this:</P
15090 CLASS="PROGRAMLISTING"
15091 > print1|My Printer 1
15092 print2|My Printer 2
15093 print3|My Printer 3
15094 print4|My Printer 4
15095 print5|My Printer 5
15099 >where the '|' separates aliases of a printer. The fact
15100 that the second alias has a space in it gives a hint to Samba
15101 that it's a comment.</P
15109 >: Under AIX the default printcap
15113 >. Samba will assume the
15117 > format if the string
15121 > appears in the printcap filename.</P
15125 >printcap name = /etc/printcap</B
15130 >printcap name = /etc/myprintcap</B
15135 NAME="PRINTERADMIN"
15137 >printer admin (S)</DT
15140 >This is a list of users that can do anything to
15141 printers via the remote administration interfaces offered by MS-RPC
15142 (usually using a NT workstation). Note that the root user always
15143 has admin rights.</P
15147 >printer admin = <empty string></B
15153 >printer admin = admin, @staff</B
15158 NAME="PRINTERDRIVER"
15160 >printer driver (S)</DT
15169 >This is a deprecated
15170 parameter and will be removed in the next major release
15171 following version 2.2. Please see the instructions in
15173 HREF="printer_driver2.html"
15175 >Samba 2.2. Printing
15177 > for more information
15178 on the new method of loading printer drivers onto a Samba server.
15181 >This option allows you to control the string
15182 that clients receive when they ask the server for the printer driver
15183 associated with a printer. If you are using Windows95 or Windows NT
15184 then you can use this to automate the setup of printers on your
15187 >You need to set this parameter to the exact string (case
15188 sensitive) that describes the appropriate printer driver for your
15189 system. If you don't know the exact string to use then you should
15190 first try with no <A
15191 HREF="index.html#PRINTERDRIVER"
15195 > printer driver</I
15198 > option set and the client will
15199 give you a list of printer drivers. The appropriate strings are
15200 shown in a scroll box after you have chosen the printer manufacturer.</P
15203 HREF="index.html#PRINTERDRIVERFILE"
15215 >printer driver = HP LaserJet 4L</B
15220 NAME="PRINTERDRIVERFILE"
15222 >printer driver file (G)</DT
15231 >This is a deprecated
15232 parameter and will be removed in the next major release
15233 following version 2.2. Please see the instructions in
15235 HREF="printer_driver2.html"
15237 >Samba 2.2. Printing
15239 > for more information
15240 on the new method of loading printer drivers onto a Samba server.
15243 >This parameter tells Samba where the printer driver
15244 definition file, used when serving drivers to Windows 95 clients, is
15245 to be found. If this is not set, the default is :</P
15250 CLASS="REPLACEABLE"
15252 >SAMBA_INSTALL_DIRECTORY</I
15255 /lib/printers.def</TT
15258 >This file is created from Windows 95 <TT
15262 > files found on the Windows 95 client system. For more
15263 details on setting up serving of printer drivers to Windows 95
15264 clients, see the outdated documentation file in the <TT
15270 >PRINTER_DRIVER.txt</TT
15274 HREF="index.html#PRINTERDRIVERLOCATION"
15278 > printer driver location</I
15287 >None (set in compile).</I
15293 >printer driver file =
15294 /usr/local/samba/printers/drivers.def</B
15299 NAME="PRINTERDRIVERLOCATION"
15301 >printer driver location (S)</DT
15310 >This is a deprecated
15311 parameter and will be removed in the next major release
15312 following version 2.2. Please see the instructions in
15314 HREF="printer_driver2.html"
15316 >Samba 2.2. Printing
15318 > for more information
15319 on the new method of loading printer drivers onto a Samba server.
15322 >This parameter tells clients of a particular printer
15323 share where to find the printer driver files for the automatic
15324 installation of drivers for Windows 95 machines. If Samba is set up
15325 to serve printer drivers to Windows 95 machines, this should be set to</P
15329 >\\MACHINE\PRINTER$</B
15332 >Where MACHINE is the NetBIOS name of your Samba server,
15333 and PRINTER$ is a share you set up for serving printer driver
15334 files. For more details on setting this up see the outdated documentation
15340 > PRINTER_DRIVER.txt</TT
15344 HREF="index.html#PRINTERDRIVERFILE"
15348 > printer driver file</I
15360 >printer driver location = \\MACHINE\PRINTER$
15368 >printer name (S)</DT
15371 >This parameter specifies the name of the printer
15372 to which print jobs spooled through a printable service will be sent.</P
15374 >If specified in the [global] section, the printer
15375 name given will be used for any printable service that does
15376 not have its own printer name specified.</P
15382 >none (but may be <TT
15386 on many systems)</I
15392 >printer name = laserwriter</B
15403 HREF="index.html#PRINTERNAME"
15419 >This parameters controls how printer status
15420 information is interpreted on your system. It also affects the
15421 default values for the <TT
15441 >lpresume command</I
15449 > if specified in the
15450 [global] section.</P
15452 >Currently nine printing styles are supported. They are
15486 >To see what the defaults are for the other print
15487 commands when using the various options use the <A
15488 HREF="testparm.1.html"
15493 >This option can be set on a per printer basis</P
15495 >See also the discussion in the <A
15496 HREF="index.html#AEN79"
15504 >private dir (G)</DT
15507 >This parameters defines the directory
15508 smbd will use for storing such files as <TT
15520 >private dir = ${prefix}/private</B
15531 HREF="index.html#MAXPROTOCOL"
15548 HREF="index.html#GUESTOK"
15560 NAME="QUEUEPAUSECOMMAND"
15562 >queuepause command (S)</DT
15565 >This parameter specifies the command to be
15566 executed on the server host in order to pause the printer queue.</P
15568 >This command should be a program or script which takes
15569 a printer name as its only parameter and stops the printer queue,
15570 such that no longer jobs are submitted to the printer.</P
15572 >This command is not supported by Windows for Workgroups,
15573 but can be issued from the Printers window under Windows 95
15581 > is given then the printer name
15582 is put in its place. Otherwise it is placed at the end of the command.
15585 >Note that it is good practice to include the absolute
15586 path in the command as the PATH may not be available to the
15593 >depends on the setting of <TT
15605 >queuepause command = disable %p</B
15610 NAME="QUEUERESUMECOMMAND"
15612 >queueresume command (S)</DT
15615 >This parameter specifies the command to be
15616 executed on the server host in order to resume the printer queue. It
15617 is the command to undo the behavior that is caused by the
15618 previous parameter (<A
15619 HREF="index.html#QUEUEPAUSECOMMAND"
15623 > queuepause command</I
15628 >This command should be a program or script which takes
15629 a printer name as its only parameter and resumes the printer queue,
15630 such that queued jobs are resubmitted to the printer.</P
15632 >This command is not supported by Windows for Workgroups,
15633 but can be issued from the Printers window under Windows 95
15641 > is given then the printer name
15642 is put in its place. Otherwise it is placed at the end of the
15645 >Note that it is good practice to include the absolute
15646 path in the command as the PATH may not be available to the
15653 >depends on the setting of <A
15654 HREF="index.html#PRINTING"
15668 >queuepause command = enable %p
15679 >This boolean parameter controls whether <A
15683 > will support the "Read
15684 Block Multiplex" SMB. This is now rarely used and defaults to
15688 >. You should never need to set this
15703 >This is a list of users that are given read-only
15704 access to a service. If the connecting user is in this list then
15705 they will not be given write access, no matter what the <A
15706 HREF="index.html#WRITEABLE"
15714 option is set to. The list can include group names using the
15715 syntax described in the <A
15716 HREF="index.html#INVALIDUSERS"
15726 HREF="index.html#WRITELIST"
15733 > parameter and the <A
15734 HREF="index.html#INVALIDUSERS"
15746 >read list = <empty string></B
15751 >read list = mary, @students</B
15761 >Note that this is an inverted synonym for <A
15762 HREF="index.html#WRITEABLE"
15778 >This parameter controls whether or not the server
15779 will support the raw read SMB requests when transferring data
15782 >If enabled, raw reads allow reads of 65535 bytes in
15783 one packet. This typically provides a major performance benefit.
15786 >However, some clients either negotiate the allowable
15787 block size incorrectly or are incapable of supporting larger block
15788 sizes, and for these clients you may need to disable raw reads.</P
15790 >In general this parameter should be viewed as a system tuning
15791 tool and left severely alone. See also <A
15792 HREF="index.html#WRITERAW"
15819 affects the overlap of disk reads/writes with network reads/writes.
15820 If the amount of data being transferred in several of the SMB
15821 commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger
15822 than this value then the server begins writing the data before it
15823 has received the whole packet from the network, or in the case of
15824 SMBreadbraw, it begins writing to the network before all the data
15825 has been read from disk.</P
15827 >This overlapping works best when the speeds of disk and
15828 network access are similar, having very little effect when the
15829 speed of one is much greater than the other.</P
15831 >The default value is 16384, but very little experimentation
15832 has been done yet to determine the optimal value, and it is likely
15833 that the best value will vary greatly between systems anyway.
15834 A value over 65536 is pointless and will cause you to allocate
15835 memory unnecessarily.</P
15839 >read size = 16384</B
15844 >read size = 8192</B
15854 > This option specifies the kerberos realm to use. The realm is
15855 used as the ADS equivalent of the NT4<B
15859 is usually set to the DNS name of the kerberos server.
15869 >realm = mysambabox.mycompany.com</B
15874 NAME="REMOTEANNOUNCE"
15876 >remote announce (G)</DT
15879 >This option allows you to setup <A
15883 > to periodically announce itself
15884 to arbitrary IP addresses with an arbitrary workgroup name.</P
15886 >This is useful if you want your Samba server to appear
15887 in a remote workgroup for which the normal browse propagation
15888 rules don't work. The remote workgroup can be anywhere that you
15889 can send IP packets to.</P
15895 >remote announce = 192.168.2.255/SERVERS
15896 192.168.4.255/STAFF</B
15899 >the above line would cause <B
15902 > to announce itself
15903 to the two given IP addresses using the given workgroup names.
15904 If you leave out the workgroup name then the one given in
15906 HREF="index.html#WORKGROUP"
15914 parameter is used instead.</P
15916 >The IP addresses you choose would normally be the broadcast
15917 addresses of the remote networks, but can also be the IP addresses
15918 of known browse masters if your network config is that stable.</P
15920 >See the documentation file <TT
15931 >remote announce = <empty string>
15937 NAME="REMOTEBROWSESYNC"
15939 >remote browse sync (G)</DT
15942 >This option allows you to setup <A
15946 > to periodically request
15947 synchronization of browse lists with the master browser of a Samba
15948 server that is on a remote segment. This option will allow you to
15949 gain browse lists for multiple workgroups across routed networks. This
15950 is done in a manner that does not work with any non-Samba servers.</P
15952 >This is useful if you want your Samba server and all local
15953 clients to appear in a remote workgroup for which the normal browse
15954 propagation rules don't work. The remote workgroup can be anywhere
15955 that you can send IP packets to.</P
15961 >remote browse sync = 192.168.2.255 192.168.4.255
15965 >the above line would cause <B
15969 the master browser on the specified subnets or addresses to
15970 synchronize their browse lists with the local server.</P
15972 >The IP addresses you choose would normally be the broadcast
15973 addresses of the remote networks, but can also be the IP addresses
15974 of known browse masters if your network config is that stable. If
15975 a machine IP address is given Samba makes NO attempt to validate
15976 that the remote machine is available, is listening, nor that it
15977 is in fact the browse master on its segment.</P
15981 >remote browse sync = <empty string>
15987 NAME="RESTRICTANONYMOUS"
15989 >restrict anonymous (G)</DT
15992 >This is a boolean parameter. If it is <TT
15996 anonymous access to the server will be restricted, namely in the
15997 case where the server is expecting the client to send a username,
15998 but it doesn't. Setting it to <TT
16001 > will force these anonymous
16002 connections to be denied, and the client will be required to always
16003 supply a username and password when connecting. Use of this parameter
16004 is only recommended for homogeneous NT client environments.</P
16006 >This parameter makes the use of macro expansions that rely
16007 on the username (%U, %G, etc) consistent. NT 4.0
16008 likes to use anonymous connections when refreshing the share list,
16009 and this is a way to work around that.</P
16011 >When restrict anonymous is <TT
16014 >, all anonymous connections
16015 are denied no matter what they are for. This can effect the ability
16016 of a machine to access the Samba Primary Domain Controller to revalidate
16017 its machine account after someone else has logged on the client
16018 interactively. The NT client will display a message saying that
16019 the machine's account in the domain doesn't exist or the password is
16020 bad. The best way to deal with this is to reboot NT client machines
16021 between interactive logons, using "Shutdown and Restart", rather
16022 than "Close all programs and logon as a different user".</P
16026 >restrict anonymous = no</B
16037 HREF="index.html#ROOTDIRECTORY"
16041 >root directory"</I
16054 HREF="index.html#ROOTDIRECTORY"
16058 >root directory"</I
16065 NAME="ROOTDIRECTORY"
16067 >root directory (G)</DT
16070 >The server will <B
16074 Change its root directory) to this directory on startup. This is
16075 not strictly necessary for secure operation. Even without it the
16076 server will deny access to files not in one of the service entries.
16077 It may also check for, and deny access to, soft links to other
16078 parts of the filesystem, or attempts to use ".." in file names
16079 to access other directories (depending on the setting of the <A
16080 HREF="index.html#WIDELINKS"
16096 than "/" adds an extra level of security, but at a price. It
16097 absolutely ensures that no access is given to files not in the
16098 sub-tree specified in the <TT
16110 > some files needed for
16111 complete operation of the server. To maintain full operability
16112 of the server you will need to mirror some system files
16118 > tree. In particular
16119 you will need to mirror <TT
16123 subset of it), and any binaries or configuration files needed for
16124 printing (if required). The set of files that must be mirrored is
16125 operating system dependent.</P
16129 >root directory = /</B
16134 >root directory = /homes/smb</B
16139 NAME="ROOTPOSTEXEC"
16141 >root postexec (S)</DT
16144 >This is the same as the <TT
16150 parameter except that the command is run as root. This
16151 is useful for unmounting filesystems
16152 (such as CDROMs) after a connection is closed.</P
16155 HREF="index.html#POSTEXEC"
16166 >root postexec = <empty string>
16174 >root preexec (S)</DT
16177 >This is the same as the <TT
16183 parameter except that the command is run as root. This
16184 is useful for mounting filesystems (such as CDROMs) when a
16185 connection is opened.</P
16188 HREF="index.html#PREEXEC"
16196 HREF="index.html#PREEXECCLOSE"
16207 >root preexec = <empty string>
16213 NAME="ROOTPREEXECCLOSE"
16215 >root preexec close (S)</DT
16218 >This is the same as the <TT
16224 > parameter except that the command is run as root.</P
16227 HREF="index.html#PREEXEC"
16235 HREF="index.html#PREEXECCLOSE"
16246 >root preexec close = no</B
16256 >This option affects how clients respond to
16257 Samba and is one of the most important settings in the <TT
16262 >The option sets the "security mode bit" in replies to
16263 protocol negotiations with <A
16268 > to turn share level security on or off. Clients decide
16269 based on this bit whether (and how) to transfer user and password
16270 information to the server.</P
16274 >security = user</B
16276 the most common setting needed when talking to Windows 98 and
16279 >The alternatives are <B
16281 >security = share</B
16285 >security = server</B
16292 >In versions of Samba prior to 2.0.0, the default was
16295 >security = share</B
16296 > mainly because that was
16297 the only option at one stage.</P
16299 >There is a bug in WfWg that has relevance to this
16300 setting. When in user or server level security a WfWg client
16301 will totally ignore the password you type in the "connect
16302 drive" dialog box. This makes it very difficult (if not impossible)
16303 to connect to a Samba service as anyone except the user that
16304 you are logged into WfWg as.</P
16306 >If your PCs use usernames that are the same as their
16307 usernames on the UNIX machine then you will want to use
16310 >security = user</B
16311 >. If you mostly use usernames
16312 that don't exist on the UNIX box then use <B
16318 >You should also use <B
16320 >security = share</B
16322 want to mainly setup shares without a password (guest shares). This
16323 is commonly used for a shared printer server. It is more difficult
16324 to setup guest shares with <B
16326 >security = user</B
16329 HREF="index.html#MAPTOGUEST"
16337 >parameter for details.</P
16339 >It is possible to use <B
16348 > where it is offers both user and share
16349 level security under different <A
16350 HREF="index.html#NETBIOSALIASES"
16354 >NetBIOS aliases</I
16359 >The different settings will now be explained.</P
16362 NAME="SECURITYEQUALSSHARE"
16373 >When clients connect to a share level security server they
16374 need not log onto the server with a valid username and password before
16375 attempting to connect to a shared resource (although modern clients
16376 such as Windows 95/98 and Windows NT will send a logon request with
16377 a username but no password when talking to a <B
16381 > server). Instead, the clients send authentication information
16382 (passwords) on a per-share basis, at the time they attempt to connect
16395 uses a valid UNIX user to act on behalf of the client, even in
16398 >security = share</B
16399 > level security.</P
16401 >As clients are not required to send a username to the server
16402 in share level security, <B
16406 techniques to determine the correct UNIX user to use on behalf
16409 >A list of possible UNIX usernames to match with the given
16410 client password is constructed using the following methods :</P
16417 HREF="index.html#GUESTONLY"
16425 > parameter is set, then all the other
16426 stages are missed and only the <A
16427 HREF="index.html#GUESTACCOUNT"
16434 > username is checked.
16439 >Is a username is sent with the share connection
16440 request, then this username (after mapping - see <A
16441 HREF="index.html#USERNAMEMAP"
16449 is added as a potential username.</P
16453 >If the client did a previous <SPAN
16460 > request (the SessionSetup SMB call) then the
16461 username sent in this SMB will be added as a potential username.
16466 >The name of the service the client requested is
16467 added as a potential username.</P
16471 >The NetBIOS name of the client is added to
16472 the list as a potential username.</P
16476 >Any users on the <A
16477 HREF="index.html#USER"
16484 > list are added as potential usernames.
16495 not set, then this list is then tried with the supplied password.
16496 The first user for whom the password matches will be used as the
16505 set, or no username can be determined then if the share is marked
16506 as available to the <TT
16512 guest user will be used, otherwise access is denied.</P
16514 >Note that it can be <SPAN
16521 in share-level security as to which UNIX username will eventually
16522 be used in granting access.</P
16524 >See also the section <A
16525 HREF="index.html#AEN236"
16526 > NOTE ABOUT USERNAME/PASSWORD VALIDATION</A
16530 NAME="SECURITYEQUALSUSER"
16541 >This is the default security setting in Samba 2.2.
16542 With user-level security a client must first "log-on" with a
16543 valid username and password (which can be mapped using the <A
16544 HREF="index.html#USERNAMEMAP"
16552 parameter). Encrypted passwords (see the <A
16553 HREF="index.html#ENCRYPTPASSWORDS"
16557 >encrypted passwords</I
16560 > parameter) can also
16561 be used in this security mode. Parameters such as <A
16562 HREF="index.html#USER"
16570 HREF="index.html#GUESTONLY"
16577 > if set are then applied and
16578 may change the UNIX user to use on this connection, but only after
16579 the user has been successfully authenticated.</P
16587 > that the name of the resource being
16594 > sent to the server until after
16595 the server has successfully authenticated the client. This is why
16596 guest shares don't work in user level security without allowing
16597 the server to automatically map unknown users into the <A
16598 HREF="index.html#GUESTACCOUNT"
16607 HREF="index.html#MAPTOGUEST"
16615 > parameter for details on doing this.</P
16617 >See also the section <A
16618 HREF="index.html#AEN236"
16619 > NOTE ABOUT USERNAME/PASSWORD VALIDATION</A
16623 NAME="SECURITYEQUALSSERVER"
16634 >In this mode Samba will try to validate the username/password
16635 by passing it to another SMB server, such as an NT box. If this
16636 fails it will revert to <B
16638 >security = user</B
16640 that if encrypted passwords have been negotiated then Samba cannot
16641 revert back to checking the UNIX password file, it must have a valid
16645 > file to check users against. See the
16646 documentation file in the <TT
16652 >ENCRYPTION.txt</TT
16653 > for details on how to set this
16662 > that from the client's point of
16665 >security = server</B
16666 > is the same as <B
16668 > security = user</B
16669 >. It only affects how the server deals
16670 with the authentication, it does not in any way affect what the
16679 > that the name of the resource being
16686 > sent to the server until after
16687 the server has successfully authenticated the client. This is why
16688 guest shares don't work in user level security without allowing
16689 the server to automatically map unknown users into the <A
16690 HREF="index.html#GUESTACCOUNT"
16699 HREF="index.html#MAPTOGUEST"
16707 > parameter for details on doing this.</P
16709 >See also the section <A
16710 HREF="index.html#AEN236"
16711 > NOTE ABOUT USERNAME/PASSWORD VALIDATION</A
16715 HREF="index.html#PASSWORDSERVER"
16723 > parameter and the <A
16724 HREF="index.html#ENCRYPTPASSWORDS"
16728 >encrypted passwords</I
16735 NAME="SECURITYEQUALSDOMAIN"
16746 >This mode will only work correctly if <A
16747 HREF="smbpasswd.8.html"
16750 > has been used to add this
16751 machine into a Windows NT Domain. It expects the <A
16752 HREF="index.html#ENCRYPTPASSWORDS"
16756 >encrypted passwords</I
16760 > parameter to be set to <TT
16764 mode Samba will try to validate the username/password by passing
16765 it to a Windows NT Primary or Backup Domain Controller, in exactly
16766 the same way that a Windows NT Server would do.</P
16774 > that a valid UNIX user must still
16775 exist as well as the account on the Domain Controller to allow
16776 Samba to have a valid UNIX account to map file access to.</P
16784 > that from the client's point
16787 >security = domain</B
16788 > is the same as <B
16792 >. It only affects how the server deals with the authentication,
16793 it does not in any way affect what the client sees.</P
16801 > that the name of the resource being
16808 > sent to the server until after
16809 the server has successfully authenticated the client. This is why
16810 guest shares don't work in user level security without allowing
16811 the server to automatically map unknown users into the <A
16812 HREF="index.html#GUESTACCOUNT"
16821 HREF="index.html#MAPTOGUEST"
16829 > parameter for details on doing this.</P
16837 > There is currently a bug in the
16838 implementation of <B
16840 >security = domain</B
16842 to multi-byte character set usernames. The communication with a
16843 Domain Controller must be done in UNICODE and Samba currently
16844 does not widen multi-byte user names to UNICODE correctly, thus
16845 a multi-byte username will not be recognized correctly at the
16846 Domain Controller. This issue will be addressed in a future release.</P
16848 >See also the section <A
16849 HREF="index.html#AEN236"
16850 > NOTE ABOUT USERNAME/PASSWORD VALIDATION</A
16854 HREF="index.html#PASSWORDSERVER"
16862 > parameter and the <A
16863 HREF="index.html#ENCRYPTPASSWORDS"
16867 >encrypted passwords</I
16875 >security = USER</B
16880 >security = DOMAIN</B
16885 NAME="SECURITYMASK"
16887 >security mask (S)</DT
16890 >This parameter controls what UNIX permission
16891 bits can be modified when a Windows NT client is manipulating
16892 the UNIX permission on a file using the native NT security
16895 >This parameter is applied as a mask (AND'ed with) to
16896 the changed permission bits, thus preventing any bits not in
16897 this mask from being modified. Essentially, zero bits in this
16898 mask may be treated as a set of bits the user is not allowed
16901 >If not set explicitly this parameter is 0777, allowing
16902 a user to modify all the user/group/world permissions on a file.
16911 > that users who can access the
16912 Samba server through other means can easily bypass this
16913 restriction, so it is primarily useful for standalone
16914 "appliance" systems. Administrators of most normal systems will
16915 probably want to leave it set to <TT
16921 HREF="index.html#FORCEDIRECTORYSECURITYMODE"
16925 >force directory security mode</I
16930 HREF="index.html#DIRECTORYSECURITYMASK"
16939 HREF="index.html#FORCESECURITYMODE"
16943 >force security mode</I
16950 >security mask = 0777</B
16955 >security mask = 0770</B
16960 NAME="SERVERSTRING"
16962 >server string (G)</DT
16965 >This controls what string will show up in the
16966 printer comment box in print manager and next to the IPC connection
16970 >. It can be any string that you wish
16971 to show to your users.</P
16973 >It also sets what will appear in browse lists next
16974 to the machine name.</P
16981 > will be replaced with the Samba
16989 > will be replaced with the
16994 >server string = Samba %v</B
16999 >server string = University of GNUs Samba
17005 NAME="SETDIRECTORY"
17007 >set directory (S)</DT
17012 >set directory = no</B
17014 users of the service may not use the setdir command to change
17020 > command is only implemented
17021 in the Digital Pathworks client. See the Pathworks documentation
17026 >set directory = no</B
17033 >share modes (S)</DT
17036 >This enables or disables the honoring of
17042 > during a file open. These
17043 modes are used by clients to gain exclusive read or write access
17046 >These open modes are not directly supported by UNIX, so
17047 they are simulated using shared memory, or lock files if your
17048 UNIX doesn't support shared memory (almost all do).</P
17050 >The share modes that are enabled by this option are
17074 >This option gives full share compatibility and enabled
17083 > turn this parameter
17084 off as many Windows applications will break if you do so.</P
17088 >share modes = yes</B
17093 NAME="SHORTPRESERVECASE"
17095 >short preserve case (S)</DT
17098 >This boolean parameter controls if new files
17099 which conform to 8.3 syntax, that is all in upper case and of
17100 suitable length, are created upper case, or if they are forced
17102 HREF="index.html#DEFAULTCASE"
17110 >. This option can be use with <A
17111 HREF="index.html#PRESERVECASE"
17114 >preserve case = yes</B
17117 > to permit long filenames to retain their case, while short
17118 names are lowered. </P
17120 >See the section on <A
17121 HREF="index.html#AEN203"
17127 >short preserve case = yes</B
17132 NAME="SHOWADDPRINTERWIZARD"
17134 >show add printer wizard (G)</DT
17137 >With the introduction of MS-RPC based printing support
17138 for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will
17139 appear on Samba hosts in the share listing. Normally this folder will
17140 contain an icon for the MS Add Printer Wizard (APW). However, it is
17141 possible to disable this feature regardless of the level of privilege
17142 of the connected user.</P
17144 >Under normal circumstances, the Windows NT/2000 client will
17145 open a handle on the printer server with OpenPrinterEx() asking for
17146 Administrator privileges. If the user does not have administrative
17147 access on the print server (i.e is not root or a member of the
17153 > group), the OpenPrinterEx()
17154 call fails and the client makes another open call with a request for
17155 a lower privilege level. This should succeed, however the APW
17156 icon will not be displayed.</P
17161 >show add printer wizard</I
17164 parameter will always cause the OpenPrinterEx() on the server
17165 to fail. Thus the APW icon will never be displayed. <SPAN
17171 >This does not prevent the same user from having
17172 administrative privilege on an individual printer.</P
17175 HREF="index.html#ADDPRINTERCOMMAND"
17184 HREF="index.html#DELETEPRINTERCOMMAND"
17188 >deleteprinter command</I
17192 HREF="index.html#PRINTERADMIN"
17203 >show add printer wizard = yes</B
17208 NAME="SHUTDOWNSCRIPT"
17210 >shutdown script (G)</DT
17217 >This parameter only exists in the HEAD cvs branch</I
17220 This a full path name to a script called by
17229 should start a shutdown procedure.</P
17231 >This command will be run as the user connected to the
17234 >%m %t %r %f parameters are expanded</P
17241 > will be substituted with the
17242 shutdown message sent to the server.</P
17249 > will be substituted with the
17250 number of seconds to wait before effectively starting the
17251 shutdown procedure.</P
17258 > will be substituted with the
17265 >. It means reboot after shutdown
17274 > will be substituted with the
17281 >. It means force the shutdown
17282 even if applications do not respond for NT.</P
17294 >abort shutdown script = /usr/local/samba/sbin/shutdown %m %t %r %f</B
17297 >Shutdown script example:
17299 CLASS="PROGRAMLISTING"
17306 /sbin/shutdown $3 $4 +$time $1 &
17309 Shutdown does not return so we need to launch it in background.
17313 HREF="index.html#ABORTSHUTDOWNSCRIPT"
17317 >abort shutdown script</I
17324 NAME="SMBPASSWDFILE"
17326 >smb passwd file (G)</DT
17329 >This option sets the path to the encrypted
17330 smbpasswd file. By default the path to the smbpasswd file
17331 is compiled into Samba.</P
17335 >smb passwd file = ${prefix}/private/smbpasswd
17341 >smb passwd file = /etc/samba/smbpasswd
17352 >Specifies which ports the server should listen on
17358 >smb ports = 445 139</B
17363 NAME="SOCKETADDRESS"
17365 >socket address (G)</DT
17368 >This option allows you to control what
17369 address Samba will listen for connections on. This is used to
17370 support multiple virtual interfaces on the one server, each
17371 with a different configuration.</P
17373 >By default Samba will accept connections on any
17378 >socket address = 192.168.2.20</B
17384 NAME="SOCKETOPTIONS"
17386 >socket options (G)</DT
17389 >This option allows you to set socket options
17390 to be used when talking with the client.</P
17392 >Socket options are controls on the networking layer
17393 of the operating systems which allow the connection to be
17396 >This option will typically be used to tune your Samba
17397 server for optimal performance for your local network. There is
17398 no way that Samba can know what the optimal parameters are for
17399 your net, so you must experiment and choose them yourself. We
17400 strongly suggest you read the appropriate documentation for your
17401 operating system first (perhaps <B
17407 >You may find that on some systems Samba will say
17408 "Unknown socket option" when you supply an option. This means you
17409 either incorrectly typed it or you need to add an include file
17410 to includes.h for your OS. If the latter is the case please
17411 send the patch to <A
17412 HREF="mailto:samba@samba.org"
17414 > samba@samba.org</A
17417 >Any of the supported socket options may be combined
17418 in any way you like, as long as your OS allows it.</P
17420 >This is the list of socket options currently settable
17421 using this option:</P
17447 >IPTOS_THROUGHPUT</P
17467 >Those marked with a <SPAN
17474 argument. The others can optionally take a 1 or 0 argument to enable
17475 or disable the option, by default they will be enabled if you
17476 don't specify 1 or 0.</P
17478 >To specify an argument use the syntax SOME_OPTION = VALUE
17481 >SO_SNDBUF = 8192</B
17482 >. Note that you must
17483 not have any spaces before or after the = sign.</P
17485 >If you are on a local network then a sensible option
17490 >socket options = IPTOS_LOWDELAY</B
17493 >If you have a local network then you could try:</P
17497 >socket options = IPTOS_LOWDELAY TCP_NODELAY</B
17500 >If you are on a wide area network then perhaps try
17501 setting IPTOS_THROUGHPUT. </P
17503 >Note that several of the options may cause your Samba
17504 server to fail completely. Use these options with caution!</P
17508 >socket options = TCP_NODELAY</B
17513 >socket options = IPTOS_LOWDELAY</B
17518 NAME="SOURCEENVIRONMENT"
17520 >source environment (G)</DT
17523 >This parameter causes Samba to set environment
17524 variables as per the content of the file named.</P
17526 >If the value of this parameter starts with a "|" character
17527 then Samba will treat that value as a pipe command to open and
17528 will set the environment variables from the output of the pipe.</P
17530 >The contents of the file or the output of the pipe should
17531 be formatted as the output of the standard Unix <B
17535 > command. This is of the form :</P
17537 >Example environment entry:</P
17541 >SAMBA_NETBIOS_NAME = myhostname</B
17548 >No default value</I
17554 >source environment = |/etc/smb.conf.sh
17560 >source environment =
17561 /usr/local/smb_env_vars</B
17568 >use spnego (G)</DT
17571 > 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
17577 >use spnego = yes</I
17585 >stat cache (G)</DT
17588 >This parameter determines if <A
17592 > will use a cache in order to
17593 speed up case insensitive name mappings. You should never need
17594 to change this parameter.</P
17598 >stat cache = yes</B
17603 NAME="STATCACHESIZE"
17605 >stat cache size (G)</DT
17608 >This parameter determines the number of
17615 never need to change this parameter.</P
17619 >stat cache size = 50</B
17629 >This enables or disables logging of connections
17630 to a status file that <A
17631 HREF="smbstatus.1.html"
17637 >With this disabled <B
17641 to tell you what connections are active. You should never need to
17642 change this parameter.</P
17651 NAME="STRICTALLOCATE"
17653 >strict allocate (S)</DT
17656 >This is a boolean that controls the handling of
17657 disk space allocation in the server. When this is set to <TT
17661 the server will change from UNIX behaviour of not committing real
17662 disk storage blocks when a file is extended to the Windows behaviour
17663 of actually forcing the disk system to allocate real storage blocks
17664 when a file is created or extended to be a given size. In UNIX
17665 terminology this means that Samba will stop creating sparse files.
17666 This can be slow on some systems.</P
17668 >When strict allocate is <TT
17671 > the server does sparse
17672 disk block allocation when a file is extended.</P
17674 >Setting this to <TT
17677 > can help Samba return
17678 out of quota messages on systems that are restricting the disk quota
17683 >strict allocate = no</B
17688 NAME="STRICTLOCKING"
17690 >strict locking (S)</DT
17693 >This is a boolean that controls the handling of
17694 file locking in the server. When this is set to <TT
17698 the server will check every read and write access for file locks, and
17699 deny access if locks exist. This can be slow on some systems.</P
17701 >When strict locking is <TT
17704 > the server does file
17705 lock checks only when the client explicitly asks for them.</P
17707 >Well-behaved clients always ask for lock checks when it
17708 is important, so in the vast majority of cases <B
17712 > is preferable.</P
17716 >strict locking = no</B
17723 >strict sync (S)</DT
17726 >Many Windows applications (including the Windows
17727 98 explorer shell) seem to confuse flushing buffer contents to
17728 disk with doing a sync to disk. Under UNIX, a sync call forces
17729 the process to be suspended until the kernel has ensured that
17730 all outstanding data in kernel disk buffers has been safely stored
17731 onto stable storage. This is very slow and should only be done
17732 rarely. Setting this parameter to <TT
17736 default) means that <A
17740 > ignores the Windows applications requests for
17741 a sync call. There is only a possibility of losing data if the
17742 operating system itself that Samba is running on crashes, so there is
17743 little danger in this default setting. In addition, this fixes many
17744 performance problems that people have reported with the new Windows98
17745 explorer shell file copies.</P
17748 HREF="index.html#SYNCALWAYS"
17760 >strict sync = no</B
17770 >This is a boolean that controls whether to
17771 strip trailing dots off UNIX filenames. This helps with some
17772 CDROMs that have filenames ending in a single dot.</P
17783 >sync always (S)</DT
17786 >This is a boolean parameter that controls
17787 whether writes will always be written to stable storage before
17788 the write call returns. If this is <TT
17791 > then the server will be
17792 guided by the client's request in each write call (clients can
17793 set a bit indicating that a particular write should be synchronous).
17797 > then every write will be followed by a <B
17801 > call to ensure the data is written to disk. Note that
17807 > parameter must be set to
17811 > in order for this parameter to have
17815 HREF="index.html#STRICTSYNC"
17827 >sync always = no</B
17837 >This parameter maps how Samba debug messages
17838 are logged onto the system syslog logging levels. Samba debug
17839 level zero maps onto syslog <TT
17843 level one maps onto <TT
17850 >, debug level three
17851 maps onto LOG_INFO. All higher levels are mapped to <TT
17856 >This parameter sets the threshold for sending messages
17857 to syslog. Only messages with debug level less than this value
17858 will be sent to syslog.</P
17869 >syslog only (G)</DT
17872 >If this parameter is set then Samba debug
17873 messages are logged into the system syslog only, and not to
17874 the debug log files.</P
17878 >syslog only = no</B
17883 NAME="TEMPLATEHOMEDIR"
17885 >template homedir (G)</DT
17888 >When filling out the user information for a Windows NT
17890 HREF="winbindd.8.html"
17894 uses this parameter to fill in the home directory for that user.
17900 > is present it is substituted
17901 with the user's Windows NT domain name. If the string <TT
17907 > is present it is substituted with the user's Windows
17912 >template homedir = /home/%D/%U</B
17917 NAME="TEMPLATESHELL"
17919 >template shell (G)</DT
17922 >When filling out the user information for a Windows NT
17924 HREF="winbindd.8.html"
17928 uses this parameter to fill in the login shell for that user.</P
17932 >template shell = /bin/false</B
17939 >time offset (G)</DT
17942 >This parameter is a setting in minutes to add
17943 to the normal GMT to local time conversion. This is useful if
17944 you are serving a lot of PCs that have incorrect daylight
17945 saving time handling.</P
17949 >time offset = 0</B
17954 >time offset = 60</B
17961 >time server (G)</DT
17964 >This parameter determines if <A
17969 > advertises itself as a time server to Windows
17974 >time server = no</B
17979 NAME="TIMESTAMPLOGS"
17981 >timestamp logs (G)</DT
17985 HREF="index.html#DEBUGTIMESTAMP"
17989 > debug timestamp</I
17996 NAME="TOTALPRINTJOBS"
17998 >total print jobs (G)</DT
18001 >This parameter accepts an integer value which defines
18002 a limit on the maximum number of print jobs that will be accepted
18003 system wide at any given time. If a print job is submitted
18004 by a client which will exceed this number, then <A
18009 error indicating that no space is available on the server. The
18010 default value of 0 means that no such limit exists. This parameter
18011 can be used to prevent a server from exceeding its capacity and is
18012 designed as a printing throttle. See also
18014 HREF="index.html#MAXPRINTJOBS"
18026 >total print jobs = 0</B
18031 >total print jobs = 5000</B
18041 >Specifies whether Samba should try
18042 to use unicode on the wire by default.
18054 >unix charset (G)</DT
18057 >Specifies the charset the unix machine
18058 Samba runs on uses. Samba needs to know this in order to be able to
18059 convert text to the charsets other SMB clients use.
18064 >unix charset = ASCII</B
18069 NAME="UNIXEXTENSIONS"
18071 >unix extensions(G)</DT
18074 >This boolean parameter controls whether Samba
18075 implments the CIFS UNIX extensions, as defined by HP.
18076 These extensions enable Samba to better serve UNIX CIFS clients
18077 by supporting features such as symbolic links, hard links, etc...
18078 These extensions require a similarly enabled client, and are of
18079 no current use to Windows clients.</P
18083 >unix extensions = no</B
18088 NAME="UNIXPASSWORDSYNC"
18090 >unix password sync (G)</DT
18093 >This boolean parameter controls whether Samba
18094 attempts to synchronize the UNIX password with the SMB password
18095 when the encrypted SMB password in the smbpasswd file is changed.
18096 If this is set to <TT
18099 > the program specified in the <TT
18105 >parameter is called <SPAN
18112 to allow the new UNIX password to be set without access to the
18113 old UNIX password (as the SMB password change code has no
18114 access to the old password cleartext, only the new).</P
18117 HREF="index.html#PASSWDPROGRAM"
18126 HREF="index.html#PASSWDCHAT"
18137 >unix password sync = no</B
18142 NAME="UPDATEENCRYPTED"
18144 >update encrypted (G)</DT
18147 >This boolean parameter allows a user logging
18148 on with a plaintext password to have their encrypted (hashed)
18149 password in the smbpasswd file to be updated automatically as
18150 they log on. This option allows a site to migrate from plaintext
18151 password authentication (users authenticate with plaintext
18152 password over the wire, and are checked against a UNIX account
18153 database) to encrypted password authentication (the SMB
18154 challenge/response authentication mechanism) without forcing
18155 all users to re-enter their passwords via smbpasswd at the time the
18156 change is made. This is a convenience option to allow the change over
18157 to encrypted passwords to be made over a longer period. Once all users
18158 have encrypted representations of their passwords in the smbpasswd
18159 file this parameter should be set to <TT
18164 >In order for this parameter to work correctly the <A
18165 HREF="index.html#ENCRYPTPASSWORDS"
18169 >encrypt passwords</I
18173 > parameter must be set to <TT
18177 this parameter is set to <TT
18182 >Note that even when this parameter is set a user
18183 authenticating to <B
18186 > must still enter a valid
18187 password in order to connect correctly, and to update their hashed
18188 (smbpasswd) passwords.</P
18192 >update encrypted = no</B
18197 NAME="USECLIENTDRIVER"
18199 >use client driver (S)</DT
18202 >This parameter applies only to Windows NT/2000
18203 clients. It has no affect on Windows 95/98/ME clients. When
18204 serving a printer to Windows NT/2000 clients without first installing
18205 a valid printer driver on the Samba host, the client will be required
18206 to install a local printer driver. From this point on, the client
18207 will treat the print as a local printer and not a network printer
18208 connection. This is much the same behavior that will occur
18211 >disable spoolss = yes</B
18214 >The differentiating
18215 factor is that under normal circumstances, the NT/2000 client will
18216 attempt to open the network printer using MS-RPC. The problem is that
18217 because the client considers the printer to be local, it will attempt
18218 to issue the OpenPrinterEx() call requesting access rights associated
18219 with the logged on user. If the user possesses local administator rights
18220 but not root privilegde on the Samba host (often the case), the OpenPrinterEx()
18221 call will fail. The result is that the client will now display an "Access
18222 Denied; Unable to connect" message in the printer queue window (even though
18223 jobs may successfully be printed). </P
18225 >If this parameter is enabled for a printer, then any attempt
18226 to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped
18227 to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx()
18228 call to succeed. <SPAN
18232 >This parameter MUST not be able enabled
18233 on a print share which has valid print driver installed on the Samba
18239 HREF="index.html#DISABLESPOOLSS"
18240 >disable spoolss</A
18246 >use client driver = no</B
18256 >This global parameter determines if the tdb internals of Samba can
18257 depend on mmap working correctly on the running system. Samba requires a coherent
18258 mmap/read-write system memory cache. Currently only HPUX does not have such a
18259 coherent cache, and so this parameter is set to <TT
18263 default on HPUX. On all other systems this parameter should be left alone. This
18264 parameter is provided to help the Samba developers track down problems with
18265 the tdb internal code.
18277 >use rhosts (G)</DT
18280 >If this global parameter is <TT
18284 that the UNIX user's <TT
18287 > file in their home directory
18288 will be read to find the names of hosts and users who will be allowed
18289 access without specifying a password.</P
18303 > can be a major security hole. This is because you are
18304 trusting the PC to supply the correct username. It is very easy to
18305 get a PC to supply a false username. I recommend that the <TT
18310 > option be only used if you really know what
18315 >use rhosts = no</B
18326 HREF="index.html#USERNAME"
18343 HREF="index.html#USERNAME"
18359 >Multiple users may be specified in a comma-delimited
18360 list, in which case the supplied password will be tested against
18361 each username in turn (left to right).</P
18368 > line is needed only when
18369 the PC is unable to supply its own username. This is the case
18370 for the COREPLUS protocol or where your users have different WfWg
18371 usernames to UNIX usernames. In both these cases you may also be
18372 better using the \\server\share%user syntax instead.</P
18379 > line is not a great
18380 solution in many cases as it means Samba will try to validate
18381 the supplied password against each of the usernames in the
18387 > line in turn. This is slow and
18388 a bad idea for lots of users in case of duplicate passwords.
18389 You may get timeouts or security breaches using this parameter
18392 >Samba relies on the underlying UNIX security. This
18393 parameter does not restrict who can login, it just offers hints
18394 to the Samba server as to what usernames might correspond to the
18395 supplied password. Users can login as whoever they please and
18396 they will be able to do no more damage than if they started a
18397 telnet session. The daemon runs as the user that they log in as,
18398 so they cannot do anything that user cannot do.</P
18400 >To restrict a service to a particular set of users you
18402 HREF="index.html#VALIDUSERS"
18412 >If any of the usernames begin with a '@' then the name
18413 will be looked up first in the NIS netgroups list (if Samba
18414 is compiled with netgroup support), followed by a lookup in
18415 the UNIX groups database and will expand to a list of all users
18416 in the group of that name.</P
18418 >If any of the usernames begin with a '+' then the name
18419 will be looked up only in the UNIX groups database and will
18420 expand to a list of all users in the group of that name.</P
18422 >If any of the usernames begin with a '&'then the name
18423 will be looked up only in the NIS netgroups database (if Samba
18424 is compiled with netgroup support) and will expand to a list
18425 of all users in the netgroup group of that name.</P
18427 >Note that searching though a groups database can take
18428 quite some time, and some clients may time out during the
18431 >See the section <A
18432 HREF="index.html#AEN236"
18434 USERNAME/PASSWORD VALIDATION</A
18435 > for more information on how
18436 this parameter determines access to the services.</P
18440 >The guest account if a guest service,
18441 else <empty string>.</B
18446 >username = fred, mary, jack, jane,
18447 @users, @pcgroup</B
18452 NAME="USERNAMELEVEL"
18454 >username level (G)</DT
18457 >This option helps Samba to try and 'guess' at
18458 the real UNIX username, as many DOS clients send an all-uppercase
18459 username. By default Samba tries all lowercase, followed by the
18460 username with the first letter capitalized, and fails if the
18461 username is not found on the UNIX machine.</P
18463 >If this parameter is set to non-zero the behavior changes.
18464 This parameter is a number that specifies the number of uppercase
18465 combinations to try while trying to determine the UNIX user name. The
18466 higher the number the more combinations will be tried, but the slower
18467 the discovery of usernames will be. Use this parameter when you have
18468 strange usernames on your UNIX machine, such as <TT
18476 >username level = 0</B
18481 >username level = 5</B
18488 >username map (G)</DT
18491 >This option allows you to specify a file containing
18492 a mapping of usernames from the clients to the server. This can be
18493 used for several purposes. The most common is to map usernames
18494 that users use on DOS or Windows machines to those that the UNIX
18495 box uses. The other is to map multiple users to a single username
18496 so that they can more easily share files.</P
18498 >The map file is parsed line by line. Each line should
18499 contain a single UNIX username on the left then a '=' followed
18500 by a list of usernames on the right. The list of usernames on the
18501 right may contain names of the form @group in which case they
18502 will match any UNIX username in that group. The special client
18503 name '*' is a wildcard and matches any name. Each line of the
18504 map file may be up to 1023 characters long.</P
18506 >The file is processed on each line by taking the
18507 supplied username and comparing it with each username on the right
18508 hand side of the '=' signs. If the supplied name matches any of
18509 the names on the right hand side then it is replaced with the name
18510 on the left. Processing then continues with the next line.</P
18512 >If any line begins with a '#' or a ';' then it is
18515 >If any line begins with an '!' then the processing
18516 will stop after that line if a mapping was done by the line.
18517 Otherwise mapping continues with every line being processed.
18518 Using '!' is most useful when you have a wildcard mapping line
18519 later in the file.</P
18521 >For example to map from the name <TT
18528 > to the UNIX name <TT
18531 > you would use:</P
18535 >root = admin administrator</B
18538 >Or to map anyone in the UNIX group <TT
18542 to the UNIX name <TT
18545 > you would use:</P
18552 >You can have as many mappings as you like in a username
18555 >If your system supports the NIS NETGROUP option then
18556 the netgroup database is checked before the <TT
18560 > database for matching groups.</P
18562 >You can map Windows usernames that have spaces in them
18563 by using double quotes around the name. For example:</P
18567 >tridge = "Andrew Tridgell"</B
18570 >would map the windows username "Andrew Tridgell" to the
18571 unix username "tridge".</P
18573 >The following example would map mary and fred to the
18574 unix user sys, and map the rest to guest. Note the use of the
18575 '!' to tell Samba to stop processing if it gets a match on
18579 CLASS="PROGRAMLISTING"
18585 >Note that the remapping is applied to all occurrences
18586 of usernames. Thus if you connect to \\server\fred and <TT
18589 > is remapped to <TT
18593 will actually be connecting to \\server\mary and will need to
18594 supply a password suitable for <TT
18601 >. The only exception to this is the
18602 username passed to the <A
18603 HREF="index.html#PASSWORDSERVER"
18607 > password server</I
18610 > (if you have one). The password
18611 server will receive whatever username the client supplies without
18614 >Also note that no reverse mapping is done. The main effect
18615 this has is with printing. Users who have been mapped may have
18616 trouble deleting print jobs as PrintManager under WfWg will think
18617 they don't own the print job.</P
18623 >no username map</I
18629 >username map = /usr/local/samba/lib/users.map
18640 >This boolean parameter is only available if
18641 Samba has been configured and compiled with the option <B
18647 > then Samba will attempt
18648 to add utmp or utmpx records (depending on the UNIX system) whenever a
18649 connection is made to a Samba server. Sites may use this to record the
18650 user connecting to a Samba share.</P
18652 >Due to the requirements of the utmp record, we
18653 are required to create a unique identifier for the
18654 incoming user. Enabling this option creates an n^2
18655 algorithm to find this number. This may impede
18656 performance on large installations. </P
18659 HREF="index.html#UTMPDIRECTORY"
18663 > utmp directory</I
18675 NAME="UTMPDIRECTORY"
18677 >utmp directory(G)</DT
18680 >This parameter is only available if Samba has
18681 been configured and compiled with the option <B
18684 >. It specifies a directory pathname that is
18685 used to store the utmp or utmpx files (depending on the UNIX system) that
18686 record user connections to a Samba server. See also the <A
18687 HREF="index.html#UTMP"
18694 > parameter. By default this is
18695 not set, meaning the system will use whatever utmp file the
18696 native system is set to use (usually
18706 >no utmp directory</I
18712 >utmp directory = /var/run/utmp</B
18717 NAME="WTMPDIRECTORY"
18719 >wtmp directory(G)</DT
18722 >This parameter is only available if Samba has
18723 been configured and compiled with the option <B
18726 >. It specifies a directory pathname that is
18727 used to store the wtmp or wtmpx files (depending on the UNIX system) that
18728 record user connections to a Samba server. The difference with
18729 the utmp directory is the fact that user info is kept after a user
18733 HREF="index.html#UTMP"
18740 > parameter. By default this is
18741 not set, meaning the system will use whatever utmp file the
18742 native system is set to use (usually
18752 >no wtmp directory</I
18758 >wtmp directory = /var/log/wtmp</B
18765 >valid users (S)</DT
18768 >This is a list of users that should be allowed
18769 to login to this service. Names starting with '@', '+' and '&'
18770 are interpreted using the same rules as described in the
18778 >If this is empty (the default) then any user can login.
18779 If a username is in both this list and the <TT
18785 > list then access is denied for that user.</P
18787 >The current servicename is substituted for <TT
18793 >. This is useful in the [homes] section.</P
18796 HREF="index.html#INVALIDUSERS"
18810 >No valid users list (anyone can login)
18817 >valid users = greg, @pcusers</B
18827 >This is a list of files and directories that
18828 are neither visible nor accessible. Each entry in the list must
18829 be separated by a '/', which allows spaces to be included
18830 in the entry. '*' and '?' can be used to specify multiple files
18831 or directories as in DOS wildcards.</P
18833 >Each entry must be a unix path, not a DOS path and
18840 > include the unix directory
18849 is applicable in vetoing files.</P
18851 >One feature of the veto files parameter that it
18852 is important to be aware of is Samba's behaviour when
18853 trying to delete a directory. If a directory that is
18854 to be deleted contains nothing but veto files this
18855 deletion will <SPAN
18861 > unless you also set
18865 >delete veto files</I
18875 >Setting this parameter will affect the performance
18876 of Samba, as it will be forced to check all files and directories
18877 for a match as they are scanned.</P
18880 HREF="index.html#HIDEFILES"
18889 HREF="index.html#CASESENSITIVE"
18893 > case sensitive</I
18902 >No files or directories are vetoed.
18908 CLASS="PROGRAMLISTING"
18909 >; Veto any files containing the word Security,
18910 ; any ending in .tmp, and any directory containing the
18912 veto files = /*Security*/*.tmp/*root*/
18914 ; Veto the Apple specific files that a NetAtalk server
18916 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/</PRE
18921 NAME="VETOOPLOCKFILES"
18923 >veto oplock files (S)</DT
18926 >This parameter is only valid when the <A
18927 HREF="index.html#OPLOCKS"
18935 parameter is turned on for a share. It allows the Samba administrator
18936 to selectively turn off the granting of oplocks on selected files that
18937 match a wildcarded list, similar to the wildcarded list used in the
18939 HREF="index.html#VETOFILES"
18953 >No files are vetoed for oplock
18958 >You might want to do this on files that you know will
18959 be heavily contended for by clients. A good example of this
18960 is in the NetBench SMB benchmark program, which causes heavy
18961 client contention for files ending in <TT
18965 To cause Samba not to grant oplocks on these files you would use
18966 the line (either in the [global] section or in the section for
18967 the particular NetBench share :</P
18971 >veto oplock files = /*.SEM/
18982 >This parameter specifies the directory
18983 to look in for vfs modules. The name of every <B
18987 > will be prepended by this directory
18997 >vfs path = /usr/lib/samba/vfs</B
19004 >vfs object (S)</DT
19007 >This parameter specifies a shared object file that
19008 is used for Samba VFS I/O operations. By default, normal
19009 disk I/O operations are used but these can be overloaded
19010 with a VFS object. The Samba VFS layer is new to Samba 2.2 and
19011 must be enabled at compile time with --with-vfs.</P
19025 >vfs options (S)</DT
19028 >This parameter allows parameters to be passed
19029 to the vfs layer at initialization time. The Samba VFS layer
19030 is new to Samba 2.2 and must be enabled at compile time
19031 with --with-vfs. See also <A
19032 HREF="index.html#VFSOBJECT"
19056 > This allows you to override the volume label
19057 returned for a share. Useful for CDROMs with installation programs
19058 that insist on a particular volume label.</P
19064 >the name of the share</I
19072 >wide links (S)</DT
19075 >This parameter controls whether or not links
19076 in the UNIX file system may be followed by the server. Links
19077 that point to areas within the directory tree exported by the
19078 server are always allowed; this parameter controls access only
19079 to areas that are outside the directory tree being exported.</P
19081 >Note that setting this parameter can have a negative
19082 effect on your server performance due to the extra system calls
19083 that Samba has to do in order to perform the link checks.</P
19087 >wide links = yes</B
19092 NAME="WINBINDCACHETIME"
19094 >winbind cache time (G)</DT
19097 >This parameter specifies the number of seconds the
19099 HREF="winbindd.8.html"
19102 > daemon will cache
19103 user and group information before querying a Windows NT server
19108 >winbind cache type = 15</B
19113 NAME="WINBINDENUMUSERS"
19115 >winbind enum users (G)</DT
19118 >On large installations using
19120 HREF="winbindd.8.html"
19124 necessary to suppress the enumeration of users through the
19136 > group of system calls. If
19140 >winbind enum users</I
19143 false, calls to the <B
19147 will not return any data. </P
19156 enumeration may cause some programs to behave oddly. For
19157 example, the finger program relies on having access to the
19158 full user list when searching for matching
19163 >winbind enum users = yes </B
19168 NAME="WINBINDENUMGROUPS"
19170 >winbind enum groups (G)</DT
19173 >On large installations using
19175 HREF="winbindd.8.html"
19179 necessary to suppress the enumeration of groups through the
19191 > group of system calls. If
19195 >winbind enum groups</I
19198 false, calls to the <B
19202 call will not return any data. </P
19210 > Turning off group
19211 enumeration may cause some programs to behave oddly.
19216 >winbind enum groups = yes </B
19224 >winbind gid (G)</DT
19227 >The winbind gid parameter specifies the range of group
19228 ids that are allocated by the <A
19229 HREF="winbindd.8.html"
19232 > daemon. This range of group ids should have no
19233 existing local or NIS groups within it as strange conflicts can
19234 occur otherwise.</P
19238 >winbind gid = <empty string>
19244 >winbind gid = 10000-20000</B
19249 NAME="WINBINDSEPARATOR"
19251 >winbind separator (G)</DT
19254 >This parameter allows an admin to define the character
19255 used when listing a username of the form of <TT
19256 CLASS="REPLACEABLE"
19262 CLASS="REPLACEABLE"
19267 is only applicable when using the <TT
19269 >pam_winbind.so</TT
19273 >nss_winbind.so</TT
19274 > modules for UNIX services.
19277 >Please note that setting this parameter to + causes problems
19278 with group membership at least on glibc systems, as the character +
19279 is used as a special character for NIS in /etc/group.</P
19283 >winbind separator = '\'</B
19288 >winbind separator = +</B
19295 >winbind uid (G)</DT
19298 >The winbind gid parameter specifies the range of group
19299 ids that are allocated by the <A
19300 HREF="winbindd.8.html"
19303 > daemon. This range of ids should have no
19304 existing local or NIS users within it as strange conflicts can
19305 occur otherwise.</P
19309 >winbind uid = <empty string>
19315 >winbind uid = 10000-20000</B
19319 >winbind use default domain, <A
19320 NAME="WINBINDUSEDEFAULTDOMAIN"
19322 >winbind use default domain</DT
19325 >This parameter specifies whether the <A
19326 HREF="winbindd.8.html"
19330 daemon should operate on users without domain component in their username.
19331 Users without a domain component are treated as is part of the winbindd server's
19332 own domain. While this does not benifit Windows users, it makes SSH, FTP and e-mail
19333 function in a way much closer to the way they would in a native unix system.</P
19337 >winbind use default domain = <falseg>
19343 >winbind use default domain = true</B
19353 >When Samba is running as a WINS server this
19354 allows you to call an external program for all changes to the
19355 WINS database. The primary use for this option is to allow the
19356 dynamic update of external name resolution databases such as
19359 >The wins hook parameter specifies the name of a script
19360 or executable that will be called as follows:</P
19364 >wins_hook operation name nametype ttl IP_list
19372 >The first argument is the operation and is one
19373 of "add", "delete", or "refresh". In most cases the operation can
19374 be ignored as the rest of the parameters provide sufficient
19375 information. Note that "refresh" may sometimes be called when the
19376 name has not previously been added, in that case it should be treated
19381 >The second argument is the NetBIOS name. If the
19382 name is not a legal name then the wins hook is not called.
19383 Legal names contain only letters, digits, hyphens, underscores
19388 >The third argument is the NetBIOS name
19389 type as a 2 digit hexadecimal number. </P
19393 >The fourth argument is the TTL (time to live)
19394 for the name in seconds.</P
19398 >The fifth and subsequent arguments are the IP
19399 addresses currently registered for that name. If this list is
19400 empty then the name should be deleted.</P
19404 >An example script that calls the BIND dynamic DNS update
19408 > is provided in the examples
19409 directory of the Samba source code. </P
19415 >wins proxy (G)</DT
19418 >This is a boolean that controls if <A
19422 > will respond to broadcast name
19423 queries on behalf of other hosts. You may need to set this
19427 > for some older clients.</P
19431 >wins proxy = no</B
19438 >wins server (G)</DT
19441 >This specifies the IP address (or DNS name: IP
19442 address for preference) of the WINS server that <A
19446 > should register with. If you have a WINS server on
19447 your network then you should set this to the WINS server's IP.</P
19449 >You should point this at your WINS server if you have a
19450 multi-subnetted network.</P
19458 >. You need to set up Samba to point
19459 to a WINS server if you have multiple subnets and wish cross-subnet
19460 browsing to work correctly.</P
19462 >See the documentation file <TT
19466 in the docs/ directory of your Samba source distribution.</P
19478 >wins server = 192.9.200.1</B
19485 >wins support (G)</DT
19488 >This boolean controls if the <A
19493 > process in Samba will act as a WINS server. You should
19494 not set this to <TT
19497 > unless you have a multi-subnetted network and
19498 you wish a particular <B
19501 > to be your WINS server.
19502 Note that you should <SPAN
19512 on more than one machine in your network.</P
19516 >wins support = no</B
19526 >This controls what workgroup your server will
19527 appear to be in when queried by clients. Note that this parameter
19528 also controls the Domain name used with the <A
19529 HREF="index.html#SECURITYEQUALSDOMAIN"
19532 >security = domain</B
19541 >set at compile time to WORKGROUP</I
19547 >workgroup = MYGROUP</B
19558 HREF="index.html#WRITEABLE"
19565 > for people who can't spell :-).</P
19569 NAME="WRITECACHESIZE"
19571 >write cache size (S)</DT
19574 >If this integer parameter is set to non-zero value,
19575 Samba will create an in-memory cache for each oplocked file
19583 non-oplocked files). All writes that the client does not request
19584 to be flushed directly to disk will be stored in this cache if possible.
19585 The cache is flushed onto disk when a write comes in whose offset
19586 would not fit into the cache or when the file is closed by the client.
19587 Reads for the file are also served from this cache if the data is stored
19590 >This cache allows Samba to batch client writes into a more
19591 efficient write size for RAID disks (i.e. writes may be tuned to
19592 be the RAID stripe size) and can improve performance on systems
19593 where the disk subsystem is a bottleneck but there is free
19594 memory for userspace programs.</P
19596 >The integer parameter specifies the size of this cache
19597 (per oplocked file) in bytes.</P
19601 >write cache size = 0</B
19606 >write cache size = 262144</B
19609 >for a 256k cache size per file.</P
19615 >write list (S)</DT
19618 >This is a list of users that are given read-write
19619 access to a service. If the connecting user is in this list then
19620 they will be given write access, no matter what the <A
19621 HREF="index.html#WRITEABLE"
19629 option is set to. The list can include group names using the
19632 >Note that if a user is in both the read list and the
19633 write list then they will be given write access.</P
19636 HREF="index.html#READLIST"
19648 >write list = <empty string>
19654 >write list = admin, root, @staff
19660 NAME="WINSPARTNERS"
19662 >wins partners (G)</DT
19665 >A space separated list of partners' IP addresses for
19666 WINS replication. WINS partners are always defined as push/pull
19667 partners as defining only one way WINS replication is unreliable.
19668 WINS replication is currently experimental and unreliable between
19674 >wins partners = </B
19679 >wins partners = 192.168.0.1 172.16.1.2</B
19690 HREF="index.html#WRITEABLE"
19706 >This parameter controls whether or not the server
19707 will support raw write SMB's when transferring data from clients.
19708 You should never need to change this parameter.</P
19712 >write raw = yes</B
19722 >An inverted synonym is <A
19723 HREF="index.html#READONLY"
19732 >If this parameter is <TT
19736 of a service may not create or modify files in the service's
19739 >Note that a printable service (<B
19741 >printable = yes</B
19749 > allow writing to the directory
19750 (user privileges permitting), but only via spooling operations.</P
19768 >Although the configuration file permits service names
19769 to contain spaces, your client software may not. Spaces will
19770 be ignored in comparisons anyway, so it shouldn't be a
19771 problem - but be aware of the possibility.</P
19773 >On a similar note, many clients - especially DOS clients -
19774 limit service names to eight characters. <A
19779 > has no such limitation, but attempts to connect from such
19780 clients will fail if they truncate the service names. For this reason
19781 you should probably keep your service names down to eight characters
19784 >Use of the [homes] and [printers] special sections make life
19785 for an administrator easy, but the various combinations of default
19786 attributes can be tricky. Take extreme care when designing these
19787 sections. In particular, ensure that the permissions on spool
19788 directories are correct.</P
19798 >This man page is correct for version 2.2 of
19799 the Samba suite.</P
19810 HREF="samba.7.html"
19815 HREF="smbpasswd.8.html"
19847 HREF="smbclient.1.html"
19855 HREF="nmblookup.1.html"
19863 HREF="testparm.1.html"
19871 HREF="testprns.1.html"
19888 >The original Samba software and related utilities
19889 were created by Andrew Tridgell. Samba is now developed
19890 by the Samba Team as an Open Source project similar
19891 to the way the Linux kernel is developed.</P
19893 >The original Samba man pages were written by Karl Auer.
19894 The man page sources were converted to YODL format (another
19895 excellent piece of Open Source software, available at
19897 HREF="ftp://ftp.icce.rug.nl/pub/unix/"
19899 > ftp://ftp.icce.rug.nl/pub/unix/</A
19900 >) and updated for the Samba 2.0
19901 release by Jeremy Allison. The conversion to DocBook for
19902 Samba 2.2 was done by Gerald Carter</P
git.samba.org / sfrench / samba-autobuild / .git / blob