mailto(samba-bugs@samba.anu.edu.au)
-manpage(smb.conf)(5)(23 Oct 1998)(Samba)(SAMBA)
+manpage(smb.conf htmlcommand((5)))(5)(23 Oct 1998)(Samba)(SAMBA)
label(NAME)
manpagename(smb.conf)(The configuration file for the Samba suite)
preserved in string values. Some items such as create modes are
numeric.
-label(SERVICEDESCRIPTIONS)
-manpagesection(SERVICE DESCRIPTIONS)
+label(SECTIONDESCRIPTIONS)
+manpagesection(SECTION DESCRIPTIONS)
-Each section in the configuration file describes a service. The
-section name is the service name and the parameters within the section
-define the service's attributes.
+Each section in the configuration file (except for the
+link(bf([global]))(global) section) describes a shared resource (known
+as a em("share")). The section name is the name of the shared resource
+and the parameters within the section define the shares attributes.
There are three special sections, link(bf([global]))(global),
link(bf([homes]))(homes) and link(bf([printers]))(printers), which are
-described under link(bf('special sections'))(specialsections). The
-following notes apply to ordinary service descriptions.
+described under link(bf('special sections'))(SPECIALSECTIONS). The
+following notes apply to ordinary section descriptions.
-A service consists of a directory to which access is being given plus
+A share consists of a directory to which access is being given plus
a description of the access rights which are granted to the user of
the service. Some housekeeping options are also specifiable.
-Services are either filespace services (used by the client as an
+Sections are either filespace services (used by the client as an
extension of their native file systems) or printable services (used by
the client to access print services on the host running the server).
-Services may be guest services, in which case no password is required
-to access them. A specified UNIX guest account is used to define
-access privileges in this case.
+Sections may be designated link(bf(guest))(guestok) services, in which
+case no password is required to access them. A specified UNIX
+link(bf(guest account))(guestaccount) is used to define access
+privileges in this case.
-Services other than guest services will require a password to access
+Sections other than guest services will require a password to access
them. The client provides the username. As older clients only provide
passwords and not usernames, you may specify a list of usernames to
check against the password using the link(bf("user="))(user) option in
-the service definition. For modern clients such as Windows 95/98 and
-Windows NT, this should not be neccessary.
+the share definition. For modern clients such as Windows 95/98 and
+Windows NT, this should not be necessary.
Note that the access rights granted by the server are masked by the
access rights granted to the specified or guest UNIX user by the host
system. The server does not grant more access than the host system
grants.
-The following sample section defines a file space service. The user
-has write access to the path tt(/home/bar). The service is accessed via
-the service name "foo":
+The following sample section defines a file space share. The user has
+write access to the path tt(/home/bar). The share is accessed via
+the share name "foo":
verb(
[foo]
path = /home/bar
- writable = true
+ writeable = true
)
-The following sample section defines a printable service. The service
+The following sample section defines a printable share. The share
is readonly, but printable. That is, the only write access permitted
is via calls to open, write to and close a spool file. The
link(bf('guest ok'))(guestok) parameter means access will be permitted
path = /usr/spool/public
read only = true
printable = true
- public = true
+ guest ok = true
)
label(SPECIALSECTIONS)
dit(bf(The [global] section))
Parameters in this section apply to the server as a whole, or are
-defaults for services which do not specifically define certain
-items. See the notes under link(bf('Parameters'))(Parameters) for more
+defaults for sections which do not specifically define certain
+items. See the notes under link(bf('PARAMETERS'))(PARAMETERS) for more
information.
label(homes)
services connecting clients to their home directories can be created
on the fly by the server.
-When the connection request is made, the existing services are
+When the connection request is made, the existing sections are
scanned. If a match is found, it is used. If no match is found, the
-requested service name is treated as a user name and looked up in the
-local passwords file. If the name exists and the correct password has
-been given, a service is created by cloning the [homes] section.
+requested section name is treated as a user name and looked up in the
+local password file. If the name exists and the correct password has
+been given, a share is created by cloning the [homes] section.
-Some modifications are then made to the newly created section:
+Some modifications are then made to the newly created share:
startit()
-it() The service name is changed from tt('homes') to the located
+it() The share name is changed from tt('homes') to the located
username
it() If no path was given, the path is set to the user's home
This is a fast and simple way to give a large number of clients access
to their home directories with a minimum of fuss.
-A similar process occurs if the requested service name is tt("homes"),
-except that the service name is not changed to that of the requesting
+A similar process occurs if the requested section name is tt("homes"),
+except that the share name is not changed to that of the requesting
user. This method of using the [homes] section works well if different
users share a client PC.
verb(
[homes]
- writable = yes
+ writeable = yes
)
An important point is that if guest access is specified in the [homes]
Note that the link(bf(browseable))(browseable) flag for auto home
directories will be inherited from the global browseable flag, not the
[homes] browseable flag. This is useful as it means setting
-browseable=no in the [homes] section will hide the [homes] service but
+browseable=no in the [homes] section will hide the [homes] share but
make any auto home directories visible.
label(printers)
able to connect to any printer specified in the local host's printcap
file.
-When a connection request is made, the existing services are
+When a connection request is made, the existing sections are
scanned. If a match is found, it is used. If no match is found, but a
link(bf([homes]))(homes) section exists, it is used as described
-above. Otherwise, the requested service name is treated as a printer
+above. Otherwise, the requested section name is treated as a printer
name and the appropriate printcap file is scanned to see if the
-requested service name is a valid printer name. If a match is found, a
-new service is created by cloning the [printers] section.
+requested section name is a valid printer share name. If a match is
+found, a new printer share is created by cloning the [printers]
+section.
-A few modifications are then made to the newly created section:
+A few modifications are then made to the newly created share:
startit()
-it() The service name is set to the located printer name
+it() The share name is set to the located printer name
it() If no printer name was given, the printer name is set to the
located printer name
-it() If the service does not permit guest access and no username was
+it() If the share does not permit guest access and no username was
given, the username is set to the located printer name.
endit()
Note that the [printers] service MUST be printable - if you specify
otherwise, the server will refuse to load the configuration file.
-Typically the path specified would be that of a world-writable spool
+Typically the path specified would be that of a world-writeable spool
directory with the sticky bit set on it. A typical [printers] entry
would look like this:
verb(
[printers]
path = /usr/spool/public
- writable = no
- public = yes
+ writeable = no
+ guest ok = yes
printable = yes
)
Each alias should be an acceptable printer name for your printing
subsystem. In the link(bf([global]))(global) section, specify the new
-file as your printcap. The server will then only recognise names
+file as your printcap. The server will then only recognize names
found in your pseudo-printcap, which of course can contain whatever
aliases you like. The same technique could be used simply to limit
access to a subset of your local printers.
defined on the system you may be able to use link(bf("printcap name =
lpstat"))(printcapname) to automatically obtain a list of
printers. See the link(bf("printcap name"))(printcapname) option for
-more detils.
+more details.
enddit()
label(PARAMETERS)
manpagesection(PARAMETERS)
-Parameters define the specific attributes of services.
+Parameters define the specific attributes of sections.
Some parameters are specific to the link(bf([global]))(global) section
-(eg., link(bf(security))(security)). Some parameters are usable in
-all sections (eg., link(bf(create mode))(createmode)). All others are
+(e.g., link(bf(security))(security)). Some parameters are usable in
+all sections (e.g., link(bf(create mode))(createmode)). All others are
permissible only in normal sections. For the purposes of the following
descriptions the link(bf([homes]))(homes) and
link(bf([printers]))(printers) sections will be considered normal.
indicates that a parameter can be specified in a service specific
section. Note that all tt('S') parameters can also be specified in the
link(bf([global]))(global) section - in which case they will define
-the default behaviour for all services.
+the default behavior for all services.
Parameters are arranged here in alphabetical order - this may not
create best bedfellows, but at least you can find them! Where there
it() bf(%h) = the internet hostname that Samba is running on.
label(percentm)
-it() bf(%m) = the netbios name of the client machine (very useful).
+it() bf(%m) = the NetBIOS name of the client machine (very useful).
label(percentL)
-it() bf(%L) = the netbios name of the server. This allows you to change your
+it() bf(%L) = the NetBIOS name of the server. This allows you to change your
config based on what the client calls you. Your server can have a "dual
personality".
label(percentd)
it() bf(%d) = The process id of the current server process.
-label(percenta)
-it() bf(%a) = the architecture of the remote machine. Only some are recognised,
-and those may not be 100% reliable. It currently recognises Samba,
-WfWg, WinNT and Win95. Anything else will be known as "UNKNOWN". If it
-gets it wrong then sending a level 3 log to
-email(samba-bugs@samba.anu.edu.au) should allow it to be fixed.
+label(percenta)
+it() bf(%a) = the architecture of the remote
+machine. Only some are recognized, and those may not be 100%
+reliable. It currently recognizes Samba, WfWg, WinNT and
+Win95. Anything else will be known as "UNKNOWN". If it gets it wrong
+then sending a level 3 log to email(samba-bugs@samba.anu.edu.au)
+should allow it to be fixed.
label(percentI)
it() bf(%I) = The IP address of the client machine.
By default, Samba 2.0 has the same semantics as a Windows NT
server, in that it is case insensitive but case preserving.
+label(NOTEABOUTUSERNAMEPASSWORDVALIDATION)
+manpagesection(NOTE ABOUT USERNAME/PASSWORD VALIDATION)
+
+There are a number of ways in which a user can connect to a
+service. The server follows the following steps in determining if it
+will allow a connection to a specified service. If all the steps fail
+then the connection request is rejected. If one of the steps pass then
+the following steps are not checked.
+
+If the service is marked link(bf("guest only = yes"))(guestonly) then
+steps 1 to 5 are skipped.
+
+starteit()
+
+eit() Step 1: If the client has passed a username/password pair and
+that username/password pair is validated by the UNIX system's password
+programs then the connection is made as that username. Note that this
+includes the tt(\\server\service%username) method of passing a
+username.
+
+eit() Step 2: If the client has previously registered a username with
+the system and now supplies a correct password for that username then
+the connection is allowed.
+
+eit() Step 3: The client's netbios name and any previously used user
+names are checked against the supplied password, if they match then
+the connection is allowed as the corresponding user.
+
+eit() Step 4: If the client has previously validated a
+username/password pair with the server and the client has passed the
+validation token then that username is used. This step is skipped if
+link(bf("revalidate = yes"))(revalidate) for this service.
+
+eit() Step 5: If a link(bf("user = "))(user) field is given in the
+smb.conf file for the service and the client has supplied a password,
+and that password matches (according to the UNIX system's password
+checking) with one of the usernames from the link(bf(user=))(user)
+field then the connection is made as the username in the
+link(bf("user="))(user) line. If one of the username in the
+link(bf(user=))(user) list begins with a tt('@') then that name
+expands to a list of names in the group of the same name.
+
+eit() Step 6: If the service is a guest service then a connection is
+made as the username given in the link(bf("guest account
+="))(guestaccount) for the service, irrespective of the supplied
+password.
+
+endeit()
+
label(COMPLETELISTOFGLOBALPARAMETERS)
manpagesection(COMPLETE LIST OF GLOBAL PARAMETERS)
it() link(bf(dfree command))(dfreecommand)
-it() link(bf(dns proxy))(dns proxy)
+it() link(bf(dns proxy))(dnsproxy)
it() link(bf(domain admin group))(domainadmingroup)
it() link(bf(domain master))(domainmaster)
-it() link(bf(domain sid))(domainsid)
-
it() link(bf(encrypt passwords))(encryptpasswords)
it() link(bf(getwd cache))(getwdcache)
it() link(bf(netbios name))(netbiosname)
-it() link(bf(networkstation user login))(networkstationuserlogin)
-
-it() link(bf(NIS homedir))(NIShomedir)
+it() link(bf(nis homedir))(nishomedir)
it() link(bf(nt pipe support))(ntpipesupport)
it() link(bf(map system))(mapsystem)
+it() link(bf(map to guest))(maptoguest)
+
it() link(bf(max connections))(maxconnections)
it() link(bf(min print space))(minprintspace)
it() link(bf(volume))(volume)
-it() link(bf(wide links))(wide links)
+it() link(bf(wide links))(widelinks)
it() link(bf(writable))(writable)
-it() link(bf(write list))(write list)
+it() link(bf(write list))(writelist)
-it() link(bf(write ok))(write ok)
+it() link(bf(write ok))(writeok)
it() link(bf(writeable))(writeable)
file permissions.
bf(Default:) nl()
- no admin users
+tt( no admin users)
bf(Example:) nl()
- admin users = jason
+tt( admin users = jason)
label(allow hosts)
dit(bf(allow hosts (S)))
Note that access still requires suitable user-level passwords.
-See utl(bf(testparm (1)))(testparm.1.html) for a way of testing your
+See url(bf(testparm (1)))(testparm.1.html) for a way of testing your
host access to see if it does what you expect.
bf(Default:)
- none (i.e., all hosts permitted access)
+tt( none (i.e., all hosts permitted access))
bf(Example:)
- allow hosts = 150.203.5. localhost myhost.mynet.edu.au
+tt( allow hosts = 150.203.5. localhost myhost.mynet.edu.au)
label(alternatepermissions)
dit(bf(alternate permissions (S)))
This specifies what type of server url(bf(nmbd))(nmbd.8.html) will
announce itself as, to a network neighborhood browse list. By default
this is set to Windows NT. The valid options are : "NT", "Win95" or
-"WfW" meaining Windows NT, Windows 95 and Windows for Workgroups
+"WfW" meaning Windows NT, Windows 95 and Windows for Workgroups
respectively. Do not change this parameter unless you have a specific
need to stop Samba appearing as an NT server as this may prevent Samba
servers from participating as browser servers correctly.
bf(Default:)
- announce as = NT
+tt( announce as = NT)
bf(Example)
- announce as = Win95
+tt( announce as = Win95)
label(announceversion)
dit(bf(announce version (G)))
to be a downlevel server.
bf(Default:)
- announce version = 4.2
+tt( announce version = 4.2)
bf(Example:)
- announce version = 2.0
+tt( announce version = 2.0)
label(autoservices)
then the link(bf("load printers"))(loadprinters) option is easier.
bf(Default:)
- no auto services
+tt( no auto services)
bf(Example:)
- auto services = fred lp colorlp
+tt( auto services = fred lp colorlp)
label(available)
dit(bf(available (S)))
are logged.
bf(Default:)
- available = yes
+tt( available = yes)
bf(Example:)
- available = no
+tt( available = no)
label(bindinterfacesonly)
dit(bf(bind interfaces only (G)))
For name service it causes url(bf(nmbd))(nmbd.8.html) to bind to ports
137 and 138 on the interfaces listed in the
-link(bf('interfaces'))(interfaces) parameter. nmbd also binds to the
-'all addresses' interface (0.0.0.0) on ports 137 and 138 for the
-purposes of reading broadcast messages. If this option is not set then
-nmbd will service name requests on all of these sockets. If bf("bind
-interfaces only") is set then nmbd will check the source address of
-any packets coming in on the broadcast sockets and discard any that
-don't match the broadcast addresses of the interfaces in the
+link(bf('interfaces'))(interfaces)
+parameter. url(bf(nmbd))(nmbd.8.html) also binds to the 'all
+addresses' interface (0.0.0.0) on ports 137 and 138 for the purposes
+of reading broadcast messages. If this option is not set then
+url(bf(nmbd))(nmbd.8.html) will service name requests on all of these
+sockets. If bf("bind interfaces only") is set then
+url(bf(nmbd))(nmbd.8.html) will check the source address of any
+packets coming in on the broadcast sockets and discard any that don't
+match the broadcast addresses of the interfaces in the
link(bf('interfaces'))(interfaces) parameter list. As unicast packets
-are received on the other sockets it allows nmbd to refuse to serve
-names to machines that send packets that arrive through any interfaces
-not listed in the 'interfaces' list. IP Source address spoofing does
-defeat this simple check, however so it must not be used seriously as
-a security feature for nmbd.
-
-For file service it causes smbd to bind only to the interface list
-given in the link(bf('interfaces'))(interfaces) parameter. This
-restricts the networks that smbd will serve to packets coming in those
-interfaces. Note that you should not use this parameter for machines
-that are serving PPP or other intermittant or non-broadcast network
-interfaces as it will not cope with non-permanent interfaces.
+are received on the other sockets it allows url(bf(nmbd))(nmbd.8.html)
+to refuse to serve names to machines that send packets that arrive
+through any interfaces not listed in the
+link(bf("interfaces"))(interfaces) list. IP Source address spoofing
+does defeat this simple check, however so it must not be used
+seriously as a security feature for url(bf(nmbd))(nmbd.8.html).
+
+For file service it causes url(bf(smbd))(smbd.8.html) to bind only to
+the interface list given in the link(bf('interfaces'))(interfaces)
+parameter. This restricts the networks that url(bf(smbd))(smbd.8.html)
+will serve to packets coming in those interfaces. Note that you
+should not use this parameter for machines that are serving PPP or
+other intermittent or non-broadcast network interfaces as it will not
+cope with non-permanent interfaces.
In addition, to change a users SMB password, the
url(bf(smbpasswd))(smbpasswd.8.html) by default connects to the
of the local host.
bf(Default:)
- bind interfaces only = False
+tt( bind interfaces only = False)
bf(Example:)
- bind interfaces only = True
+tt( bind interfaces only = True)
label(blockinglocks)
dit(bf(blocking locks (S)))
This parameter can be set per share.
bf(Default:)
- blocking locks = True
+tt( blocking locks = True)
bf(Example:)
- blocking locks = False
+tt( blocking locks = False)
label(browsable)
-dit(bf(broweable (S)))
-
-This controls whether this share is seen in the list of available
-shares in a net view and in the browse list.
-
- bf(Default:)
- browsable = Yes
+dit(bf(browseable (S)))
- bf(Example:)
- browsable = No
+Synonym for link(bf(browseable))(browseable).
label(browselist)
dit(bf(browse list(G)))
should never need to change this.
bf(Default:)
- browse list = Yes
+tt( browse list = Yes)
label(browseable)
dit(bf(browseable))
-Synonym for link(bf(browsable))(browsable).
+This controls whether this share is seen in the list of available
+shares in a net view and in the browse list.
+
+ bf(Default:)
+tt( browseable = Yes)
+
+ bf(Example:)
+tt( browseable = No)
label(casesensitive)
dit(bf(case sensitive (G)))
bf(change notify timeout) is specified in units of seconds.
bf(Default:)
- change notify timeout = 60
+tt( change notify timeout = 60)
bf(Example:)
- change notify timeout = 300
+tt( change notify timeout = 300)
- Would change the scan time to every 5 minutes.
+Would change the scan time to every 5 minutes.
label(characterset)
dit(bf(character set (G)))
parameter is not set, meaning no filename translation is done.
bf(Default:)
- character set =
+tt( character set = <empty string>)
bf(Example:)
- character set = ISO8859-1
+tt( character set = ISO8859-1)
label(clientcodepage)
dit(bf(client code page (G)))
to map lower to upper case characters to provide the case insensitivity
of filenames that Windows clients expect.
-Samba currenly ships with the following code page files :
+Samba currently ships with the following code page files :
startit()
See also : link(bf("valid chars"))(validchars)
bf(Default:)
-
- client code page = 850
+tt( client code page = 850)
bf(Example:)
-
- client code page = 936
+tt( client code page = 936)
label(codingsystem)
dit(bf(codingsystem (G)))
startit()
-it() bf(SJIS)) Shift-JIS. Does no conversion of the incoming filename.
+it() bf(SJIS) Shift-JIS. Does no conversion of the incoming filename.
-it() bf(JIS8, J8BB, J8BH, J8@B, J8@J, J8@H )) Convert from incoming
+it() bf(JIS8, J8BB, J8BH, J8@B, J8@J, J8@H ) Convert from incoming
Shift-JIS to eight bit JIS code with different shift-in, shift out
codes.
-it() bf(JIS7, J7BB, J7BH, J7@B, J7@J, J7@H )) Convert from incoming
+it() bf(JIS7, J7BB, J7BH, J7@B, J7@J, J7@H ) Convert from incoming
Shift-JIS to seven bit JIS code with different shift-in, shift out
codes.
-it() bf(JUNET, JUBB, JUBH, JU@B, JU@J, JU@H )) Convert from incoming
+it() bf(JUNET, JUBB, JUBH, JU@B, JU@J, JU@H ) Convert from incoming
Shift-JIS to JUNET code with different shift-in, shift out codes.
it() bf(EUC) Convert an incoming Shift-JIS character to EUC code.
it() bf(HEX) Convert an incoming Shift-JIS character to a 3 byte hex
-representation, ie. tt(:AB).
+representation, i.e. tt(:AB).
it() bf(CAP) Convert an incoming Shift-JIS character to the 3 byte hex
-representation used by the Columbia Appletalk Program (CAP),
-ie. tt(:AB). This is used for compatibility between Samba and CAP.
+representation used by the Columbia AppleTalk Program (CAP),
+i.e. tt(:AB). This is used for compatibility between Samba and CAP.
endit()
name then see the server string command.
bf(Default:)
-
- No comment string
+tt( No comment string)
bf(Example:)
-
- comment = Fred's Files
+tt( comment = Fred's Files)
label(configfile)
dit(bf(config file (G)))
to special case the config files of just a few clients).
bf(Example:)
-
tt( config file = /usr/local/samba/lib/smb.conf.%m)
label(copy)
in the configuration file than the service doing the copying.
bf(Default:)
- none
+tt( none)
bf(Example:)
- copy = otherservice
+tt( copy = otherservice)
-label(createmode)
+label(createmask)
dit(bf(create mask (S)))
A synonym for this parameter is link(bf('create mode'))(createmode).
-When a file is created, the neccessary permissions are calculated
+When a file is created, the necessary permissions are calculated
according to the mapping from DOS modes to UNIX permissions, and the
resulting UNIX mode is then bit-wise 'AND'ed with this parameter.
This parameter may be thought of as a bit-wise MASK for the UNIX modes
mode bits on created directories.
bf(Default:)
- create mask = 0744
+tt( create mask = 0744)
bf(Example:)
- create mask = 0775
+tt( create mask = 0775)
label(createmode)
dit(bf(create mode (S)))
performed.
bf(Default:)
- deadtime = 0
+tt( deadtime = 0)
bf(Example:)
- deadtime = 15
+tt( deadtime = 15)
-label(debug timestamp (G))
+label(debugtimestamp)
+dit(bf(debug timestamp (G)))
-Samba2.0 debug log messages are timestamped by default. If you
-are running at a high debug level these timestamps can be
-distracting. This boolean parameter allows them to be turned
+Samba2.0 debug log messages are timestamped by default. If you are
+running at a high link(bf("debug level"))(debuglevel) these timestamps
+can be distracting. This boolean parameter allows them to be turned
off.
bf(Default:)
- debug timestamp = Yes
+tt( debug timestamp = Yes)
bf(Example:)
- debug timestamp = No
+tt( debug timestamp = No)
label(debuglevel)
dit(bf(debug level (G)))
or level zero if none was specified.
bf(Example:)
- debug level = 3
+tt( debug level = 3)
label(default)
dit(bf(default (G)))
given, attempting to connect to a nonexistent service results in an
error.
-Typically the default service would be a public, read-only service.
+Typically the default service would be a link(bf(guest ok))(guestok),
+link(bf(read-only))(readonly) service.
Also note that the apparent service name will be changed to equal that
of the requested service, this is very useful as it allows you to use
bf(Example:)
-
verb(
- default service = pub
+ default service = pub
- [pub]
- path = /%S
+ [pub]
+ path = /%S
)
label(deletereadonly)
semantics prevent deletion of a read only file.
bf(Default:)
- delete readonly = No
+tt( delete readonly = No)
bf(Example:)
- delete readonly = Yes
+tt( delete readonly = Yes)
label(deletevetofiles)
dit(bf(delete veto files (S)))
delete any files and directories within the vetoed directory. This can
be useful for integration with file serving systems such as bf(NetAtalk),
which create meta-files within directories you might normally veto
-DOS/Windows users from seeing (eg. tt(.AppleDouble))
+DOS/Windows users from seeing (e.g. tt(.AppleDouble))
Setting tt('delete veto files = True') allows these directories to be
transparently deleted when the parent directory is deleted (so long
See also the link(bf(veto files))(vetofiles) parameter.
bf(Default:)
- delete veto files = False
+tt( delete veto files = False)
bf(Example:)
- delete veto files = True
+tt( delete veto files = True)
label(denyhosts)
dit(bf(deny hosts (S)))
conflict, the link(bf('allow'))(allowhosts) list takes precedence.
bf(Default:)
- none (i.e., no hosts specifically excluded)
+tt( none (i.e., no hosts specifically excluded))
bf(Example:)
- deny hosts = 150.203.4. badhost.mynet.edu.au
+tt( deny hosts = 150.203.4. badhost.mynet.edu.au)
label(dfreecommand)
dit(bf(dfree command (G)))
is 1024 bytes.
Note: Your script should em(NOT) be setuid or setgid and should be
-owned by (and writable only by) root!
+owned by (and writeable only by) root!
bf(Default:)
- By default internal routines for determining the disk capacity
-and remaining space will be used.
+tt( By default internal routines for determining the disk capacity
+and remaining space will be used.)
bf(Example:)
- dfree command = /usr/local/samba/bin/dfree
+tt( dfree command = /usr/local/samba/bin/dfree)
- Where the script dfree (which must be made executable) could be:
+Where the script dfree (which must be made executable) could be:
verb(
#!/bin/sh
df $1 | tail -1 | awk '{print $2" "$4}'
)
- or perhaps (on Sys V based systems):
+or perhaps (on Sys V based systems):
verb(
#!/bin/sh
This parameter is the octal modes which are used when converting DOS
modes to UNIX modes when creating UNIX directories.
-When a directory is created, the neccessary permissions are calculated
+When a directory is created, the necessary permissions are calculated
according to the mapping from DOS modes to UNIX permissions, and the
resulting UNIX mode is then bit-wise 'AND'ed with this parameter.
This parameter may be thought of as a bit-wise MASK for the UNIX modes
Following this Samba will bit-wise 'OR' the UNIX mode created from
this parameter with the value of the "force directory mode"
-parameter. This parameter is set to 000 by default (ie. no extra mode
+parameter. This parameter is set to 000 by default (i.e. no extra mode
bits are added).
See the link(bf("force directory mode"))(forcedirectorymode) parameter
mode bits on created files.
bf(Default:)
- directory mask = 0755
+tt( directory mask = 0755)
bf(Example:)
- directory mask = 0775
+tt( directory mask = 0775)
label(directorymode)
dit(bf(directory mode (S)))
label(dnsproxy)
dit(bf(dns proxy (G)))
-Specifies that link(bf(nmbd))(nmbd.8.html) when acting as a WINS
+Specifies that url(bf(nmbd))(nmbd.8.html) when acting as a WINS
server and finding that a NetBIOS name has not been registered, should
treat the NetBIOS name word-for-word as a DNS name and do a lookup
with the DNS server for that name on behalf of the name-querying
the DNS name (or DNS alias) can likewise only be 15 characters,
maximum.
-link(bf(nmbd))(nmbd.8.html) spawns a second copy of itself to do the
+url(bf(nmbd))(nmbd.8.html) spawns a second copy of itself to do the
DNS name lookup requests, as doing a name lookup is a blocking action.
See also the parameter link(bf(wins support))(winssupport).
bf(Default:)
- dns proxy = yes
+tt( dns proxy = yes)
label(domainadmingroup)
bf(domain admin group (G))
This is an bf(EXPERIMENTAL) parameter that is part of the unfinished
Samba NT Domain Controller Code. It may be removed in a later release.
To work with the latest code builds that may have more support for
-Samba NT Domain Controller functionality please subscibe to the
+Samba NT Domain Controller functionality please subscribe to the
mailing list bf(Samba-ntdom) available by sending email to
email(listproc@samba.anu.edu.au)
label(domainadminusers)
-dit(bf(domain admin users)
+dit(bf(domain admin users (G)))
This is an bf(EXPERIMENTAL) parameter that is part of the unfinished
Samba NT Domain Controller Code. It may be removed in a later release.
To work with the latest code builds that may have more support for
-Samba NT Domain Controller functionality please subscibe to the
+Samba NT Domain Controller functionality please subscribe to the
mailing list bf(Samba-ntdom) available by sending email to
email(listproc@samba.anu.edu.au)
This is an bf(EXPERIMENTAL) parameter that is part of the unfinished
Samba NT Domain Controller Code. It may be removed in a later release.
To work with the latest code builds that may have more support for
-Samba NT Domain Controller functionality please subscibe to the
+Samba NT Domain Controller functionality please subscribe to the
mailing list bf(Samba-ntdom) available by sending email to
email(listproc@samba.anu.edu.au)
This is an bf(EXPERIMENTAL) parameter that is part of the unfinished
Samba NT Domain Controller Code. It may be removed in a later release.
To work with the latest code builds that may have more support for
-Samba NT Domain Controller functionality please subscibe to the
+Samba NT Domain Controller functionality please subscribe to the
mailing list bf(Samba-ntdom) available by sending email to
email(listproc@samba.anu.edu.au)
This is an bf(EXPERIMENTAL) parameter that is part of the unfinished
Samba NT Domain Controller Code. It may be removed in a later release.
To work with the latest code builds that may have more support for
-Samba NT Domain Controller functionality please subscibe to the
+Samba NT Domain Controller functionality please subscribe to the
mailing list bf(Samba-ntdom) available by sending email to
email(listproc@samba.anu.edu.au)
Note that Win95/98 Domain logons are em(NOT) the same as Windows
NT Domain logons. NT Domain logons require a Primary Domain Controller
-(PDC) for the Domain. It is inteded that in a future release Samba
+(PDC) for the Domain. It is intended that in a future release Samba
will be able to provide this functionality for Windows NT clients
also.
bf(Default:)
- domain logons = no
+tt( domain logons = no)
label(domainmaster)
dit(bf(domain master (G)))
-Tell link(bf(nmbd))(nmbd.8.html) to enable WAN-wide browse list
-collation.Setting this option causes link(bf(nmbd))(nmbd.8.html) to
+Tell url(bf(nmbd))(nmbd.8.html) to enable WAN-wide browse list
+collation. Setting this option causes url(bf(nmbd))(nmbd.8.html) to
claim a special domain specific NetBIOS name that identifies it as a
domain master browser for its given
link(bf(workgroup))(workgroup). Local master browsers in the same
link(bf(workgroup))(workgroup) on broadcast-isolated subnets will give
-this link(bf(nmbd))(nmbd.8.html) their local browse lists, and then
-ask link(bf(smbd))(smbd.8.html) for a complete copy of the browse list
+this url(bf(nmbd))(nmbd.8.html) their local browse lists, and then
+ask url(bf(smbd))(smbd.8.html) for a complete copy of the browse list
for the whole wide area network. Browser clients will then contact
their local master browser, and will receive the domain-wide browse
list, instead of just the list for their broadcast-isolated subnet.
Note that Windows NT Primary Domain Controllers expect to be able to
claim this link(bf(workgroup))(workgroup) specific special NetBIOS
name that identifies them as domain master browsers for that
-link(bf(workgroup))(workgroup) by default (ie. there is no way to
+link(bf(workgroup))(workgroup) by default (i.e. there is no way to
prevent a Windows NT PDC from attempting to do this). This means that
-if this parameter is set and link(bf(nmbd))(nmbd.8.html) claims the
+if this parameter is set and url(bf(nmbd))(nmbd.8.html) claims the
special name for a link(bf(workgroup))(workgroup) before a Windows NT
PDC is able to do so then cross subnet browsing will behave strangely
and may fail.
bf(Default:)
- domain master = no
-
-.SS dont descend (S)
-There are certain directories on some systems (eg., the /proc tree under
-Linux) that are either not of interest to clients or are infinitely deep
-(recursive). This parameter allows you to specify a comma-delimited list
-of directories that the server should always show as empty.
+tt( domain master = no)
-Note that Samba can be very fussy about the exact format of the "dont
-descend" entries. For example you may need "./proc" instead of just
-"/proc". Experimentation is the best policy :-)
+label(dont descend)
+dit(bf(dont descend (S)))
-.B Default:
- none (i.e., all directories are OK to descend)
+There are certain directories on some systems (e.g., the tt(/proc) tree
+under Linux) that are either not of interest to clients or are
+infinitely deep (recursive). This parameter allows you to specify a
+comma-delimited list of directories that the server should always show
+as empty.
-.B Example:
- dont descend = /proc,/dev
+Note that Samba can be very fussy about the exact format of the "dont
+descend" entries. For example you may need tt("./proc") instead of
+just tt("/proc"). Experimentation is the best policy :-)
-.SS dos filetimes (S)
-Under DOS and Windows, if a user can write to a file they can change
-the timestamp on it. Under POSIX semantics, only the owner of the file
-or root may change the timestamp. By default, Samba runs with POSIX
-semantics and refuses to change the timestamp on a file if the user
-smbd is acting on behalf of is not the file owner. Setting this option
-to True allows DOS semantics and smbd will change the file timstamp as
-DOS requires. This is a correct implementation of a previous compile-time
-options (UTIME_WORKAROUND) which was broken and is now removed.
+ bf(Default:)
+tt( none (i.e., all directories are OK to descend))
-.B Default:
- dos filetimes = False
+ bf(Example:)
+tt( dont descend = /proc,/dev)
-.B Example:
- dos filetimes = True
+label(dosfiletimeresolution)
+dit(bf(dos filetime resolution (S)))
-.SS dos filetime resolution (S)
-Under the DOS and Windows FAT filesystem, the finest granulatity on
+Under the DOS and Windows FAT filesystem, the finest granularity on
time resolution is two seconds. Setting this parameter for a share
-causes Samba to round the reported time down to the nearest two
-second boundary when a query call that requires one second resolution
-is made to smbd.
+causes Samba to round the reported time down to the nearest two second
+boundary when a query call that requires one second resolution is made
+to url(bf(smbd))(smbd.8.html).
-This option is mainly used as a compatibility option for Visual C++
+This option is mainly used as a compatibility option for Visual C++
when used against Samba shares. If oplocks are enabled on a share,
-Visual C++ uses two different time reading calls to check if a file
-has changed since it was last read. One of these calls uses a one-second
-granularity, the other uses a two second granularity. As the two second
-call rounds any odd second down, then if the file has a timestamp of an
-odd number of seconds then the two timestamps will not match and Visual
-C++ will keep reporting the file has changed. Setting this option causes
-the two timestamps to match, and Visual C++ is happy.
+Visual C++ uses two different time reading calls to check if a file
+has changed since it was last read. One of these calls uses a
+one-second granularity, the other uses a two second granularity. As
+the two second call rounds any odd second down, then if the file has a
+timestamp of an odd number of seconds then the two timestamps will not
+match and Visual C++ will keep reporting the file has changed. Setting
+this option causes the two timestamps to match, and Visual C++ is
+happy.
-.B Default:
- dos filetime resolution = False
+ bf(Default:)
+tt( dos filetime resolution = False)
-.B Example:
- dos filetime resolution = True
+ bf(Example:)
+tt( dos filetime resolution = True)
-.SS encrypt passwords (G)
+label(dos filetimes)
+dit(bf(dos filetimes (S)))
-This boolean controls whether encrypted passwords will be negotiated
-with the client. Note that Windows NT 4.0 SP3 and above will by default
-expect encrypted passwords unless a registry entry is changed. To use
-encrypted passwords in Samba see the file docs/ENCRYPTION.txt.
+Under DOS and Windows, if a user can write to a file they can change
+the timestamp on it. Under POSIX semantics, only the owner of the file
+or root may change the timestamp. By default, Samba runs with POSIX
+semantics and refuses to change the timestamp on a file if the user
+smbd is acting on behalf of is not the file owner. Setting this option
+to True allows DOS semantics and smbd will change the file timestamp as
+DOS requires.
+
+ bf(Default:)
+tt( dos filetimes = False)
+
+ bf(Example:)
+tt( dos filetimes = True)
-.SS exec (S)
+label(encryptpasswords)
+dit(bf(encrypt passwords (G)))
-This is an alias for preexec
+This boolean controls whether encrypted passwords will be negotiated
+with the client. Note that Windows NT 4.0 SP3 and above and also
+Windows 98 will by default expect encrypted passwords unless a
+registry entry is changed. To use encrypted passwords in Samba see the
+file ENCRYPTION.txt in the Samba documentation directory tt(docs/)
+shipped with the source code.
+
+In order for encrypted passwords to work correctly
+url(bf(smbd))(smbd.8.html) must either have access to a local
+url(bf(smbpasswd (5)))(smbpasswd.5.html) file (see the
+url(bf(smbpasswd (8)))(smbpasswd.8.html) program for information on
+how to set up and maintain this file), or set the
+link(bf(security=))(security) parameter to either
+link(bf("server"))(securityequalserver) or
+link(bf("domain"))(securityequaldomain) which causes
+url(bf(smbd))(smbd.8.html) to authenticate against another server.
+
+label(exec)
+dit(bf(exec (S)))
+
+This is a synonym for link(bf(preexec))(preexec).
+
+label(fake directory create times)
+dit(bf(fake directory create times (S)))
-.SS fake directory create times (S)
NTFS and Windows VFAT file systems keep a create time for all files
and directories. This is not the same as the ctime - status change
-time - that Unix keeps, so Samba by default reports the earliest
-of the various times Unix does keep. Setting this parameter for a
-share causes Samba to always report midnight 1-1-1980 as
-the create time for directories.
-
-This option is mainly used as a compatibility option for Visual C++
-when used against Samba shares. Visual C++ generated makefiles
-have the object directory as a dependency for each object file,
-and a make rule to create the directory. Also, when NMAKE
-compares timestamps it uses the creation time when examining
-a directory. Thus the object directory will be created if it does
-not exist, but once it does exist it will always have an earlier
-timestamp than the object files it contains.
-
-However, Unix time semantics mean that the create time reported
-by Samba will be updated whenever a file is created or deleted
-in the directory. NMAKE therefore finds all object files in the
-object directory bar the last one built are out of date compared
-to the directory and rebuilds them. Enabling this option ensures
-directories always predate their contents and an NMAKE build will
-proceed as expected.
-
-.B Default:
- fake directory create times = False
-
-.B Example:
- fake directory create times = True
-
-.SS fake oplocks (S)
+time - that Unix keeps, so Samba by default reports the earliest of
+the various times Unix does keep. Setting this parameter for a share
+causes Samba to always report midnight 1-1-1980 as the create time for
+directories.
+
+This option is mainly used as a compatibility option for Visual C++
+when used against Samba shares. Visual C++ generated makefiles have
+the object directory as a dependency for each object file, and a make
+rule to create the directory. Also, when NMAKE compares timestamps it
+uses the creation time when examining a directory. Thus the object
+directory will be created if it does not exist, but once it does exist
+it will always have an earlier timestamp than the object files it
+contains.
+
+However, Unix time semantics mean that the create time reported by
+Samba will be updated whenever a file is created or deleted in the
+directory. NMAKE therefore finds all object files in the object
+directory bar the last one built are out of date compared to the
+directory and rebuilds them. Enabling this option ensures directories
+always predate their contents and an NMAKE build will proceed as
+expected.
+
+ bf(Default:)
+tt( fake directory create times = False)
+
+ bf(Example:)
+tt( fake directory create times = True)
+
+label(fakeoplocks)
+dit(bf(fake oplocks (S)))
Oplocks are the way that SMB clients get permission from a server to
locally cache file operations. If a server grants an oplock
data. With some oplock types the client may even cache file open/close
operations. This can give enormous performance benefits.
-When you set "fake oplocks = yes" Samba will always grant oplock
-requests no matter how many clients are using the file.
+When you set tt("fake oplocks = yes") url(bf(smbd))(smbd.8.html) will
+always grant oplock requests no matter how many clients are using the
+file.
-By enabling this option on all read-only shares or shares that you know
-will only be accessed from one client at a time you will see a big
-performance improvement on many operations. If you enable this option
-on shares where multiple clients may be accessing the files read-write
-at the same time you can get data corruption. Use this option
-carefully!
+It is generally much better to use the real link(bf(oplocks))(oplocks)
+support rather than this parameter.
-It is generally much better to use the real oplock support except for
-physically read-only media such as CDROMs.
+If you enable this option on all read-only shares or shares that you
+know will only be accessed from one client at a time such as
+physically read-only media like CDROMs, you will see a big performance
+improvement on many operations. If you enable this option on shares
+where multiple clients may be accessing the files read-write at the
+same time you can get data corruption. Use this option carefully!
This option is disabled by default.
-.SS follow symlinks (S)
+label(followsymlinks)
+dit(bf(follow symlinks (S)))
+
+This parameter allows the Samba administrator to stop
+url(bf(smbd))(smbd.8.html) from following symbolic links in a
+particular share. Setting this parameter to em("No") prevents any file
+or directory that is a symbolic link from being followed (the user
+will get an error). This option is very useful to stop users from
+adding a symbolic link to tt(/etc/passwd) in their home directory for
+instance. However it will slow filename lookups down slightly.
+
+This option is enabled (i.e. url(bf(smbd))(smbd.8.html) will follow
+symbolic links) by default.
-This parameter allows the Samba administrator to stop smbd from
-following symbolic links in a particular share. Setting this
-parameter to "No" prevents any file or directory that is a
-symbolic link from being followed (the user will get an error).
-This option is very useful to stop users from adding a symbolic
-link to /etc/pasword in their home directory for instance.
-However it will slow filename lookups down slightly.
+label(forcecreatemode)
+dit(bf(force create mode (S)))
-This option is enabled (ie. smbd will follow symbolic links)
-by default.
+This parameter specifies a set of UNIX mode bit permissions that will
+em(*always*) be set on a file created by Samba. This is done by
+bitwise 'OR'ing these bits onto the mode bits of a file that is being
+created. The default for this parameter is (in octal) 000. The modes
+in this parameter are bitwise 'OR'ed onto the file mode after the mask
+set in the link(bf("create mask"))(createmask) parameter is applied.
-.SS force create mode (S)
-This parameter specifies a set of UNIX mode bit permissions that
-will *always* be set on a file created by Samba. This is done
-by bitwise 'OR'ing these bits onto the mode bits of a file that
-is being created. The default for this parameter is (in octel)
-000. The modes in this parameter are bitwise 'OR'ed onto the
-file mode after the mask set in the "create mask" parameter
-is applied.
+See also the parameter link(bf("create mask"))(createmask) for details
+on masking mode bits on created files.
-See also the parameter "create mask" for details on masking mode
-bits on created files.
+ bf(Default:)
+tt( force create mode = 000)
+
+ bf(Example:)
+tt( force create mode = 0755)
+
+would force all created files to have read and execute permissions set
+for 'group' and 'other' as well as the read/write/execute bits set for
+the 'user'.
-.B Default:
- force create mode = 000
+label(forcedirectorymode)
+dit(bf(force directory mode (S)))
-.B Example:
- force create mode = 0755
+This parameter specifies a set of UNIX mode bit permissions that will
+em(*always*) be set on a directory created by Samba. This is done by
+bitwise 'OR'ing these bits onto the mode bits of a directory that is
+being created. The default for this parameter is (in octal) 0000 which
+will not add any extra permission bits to a created directory. This
+operation is done after the mode mask in the parameter
+link(bf("directory mask"))(directorymask) is applied.
-would force all created files to have read and execute permissions
-set for 'group' and 'other' as well as the read/write/execute bits
-set for the 'user'.
+See also the parameter link(bf("directory mask"))(directorymask) for
+details on masking mode bits on created directories.
-.SS force directory mode (S)
-This parameter specifies a set of UNIX mode bit permissions that
-will *always* be set on a directory created by Samba. This is done
-by bitwise 'OR'ing these bits onto the mode bits of a directory that
-is being created. The default for this parameter is (in octel)
-0000 which will not add any extra permission bits to a created
-directory. This operation is done after the mode mask in the parameter
-"directory mask" is applied.
+ bf(Default:)
+tt( force directory mode = 000)
-See also the parameter "directory mask" for details on masking mode
-bits on created directories.
+ bf(Example:)
+tt( force directory mode = 0755)
-.B Default:
- force directory mode = 000
+would force all created directories to have read and execute
+permissions set for 'group' and 'other' as well as the
+read/write/execute bits set for the 'user'.
-.B Example:
- force directory mode = 0755
+label(forcegroup)
+dit(bf(force group (S)))
-would force all created directories to have read and execute permissions
-set for 'group' and 'other' as well as the read/write/execute bits
-set for the 'user'.
+This specifies a UNIX group name that will be assigned as the default
+primary group for all users connecting to this service. This is useful
+for sharing files by ensuring that all access to files on service will
+use the named group for their permissions checking. Thus, by assigning
+permissions for this group to the files and directories within this
+service the Samba administrator can restrict or allow sharing of these
+files.
-.SS force group (S)
-This specifies a group name that all connections to this service
-should be made as. This may be useful for sharing files.
+ bf(Default:)
+tt( no forced group)
-.B Default:
- no forced group
+ bf(Example:)
+tt( force group = agroup)
-.B Example:
- force group = agroup
+label(forceuser)
+dit(bf(force user (S)))
-.SS force user (S)
-This specifies a user name that all connections to this service
-should be made as. This may be useful for sharing files. You should
-also use it carefully as using it incorrectly can cause security
-problems.
+This specifies a UNIX user name that will be assigned as the default
+user for all users connecting to this service. This is useful for
+sharing files. You should also use it carefully as using it
+incorrectly can cause security problems.
This user name only gets used once a connection is established. Thus
clients still need to connect as a valid user and supply a valid
password. Once connected, all file operations will be performed as the
-"forced user", not matter what username the client connected as.
+tt("forced user"), no matter what username the client connected as.
+
+This can be very useful.
+
+ bf(Default:)
+tt( no forced user)
+
+ bf(Example:)
+tt( force user = auser)
+
+label(fstype)
+dit(bf(fstype (S)))
+
+This parameter allows the administrator to configure the string that
+specifies the type of filesystem a share is using that is reported by
+url(bf(smbd))(smbd.8.html) when a client queries the filesystem type
+for a share. The default type is bf("NTFS") for compatibility with
+Windows NT but this can be changed to other strings such as "Samba" or
+"FAT" if required.
-.B Default:
- no forced user
+ bf(Default:)
+tt( fstype = NTFS)
+
+ bf(Example:)
+tt( fstype = Samba)
+
+label(getwdcache)
+dit(bf(getwd cache (G)))
-.B Example:
- force user = auser
+This is a tuning option. When this is enabled a caching algorithm
+will be used to reduce the time taken for getwd() calls. This can have
+a significant impact on performance, especially when the
+link(bf(widelinks))(widelinks) parameter is set to False.
-.SS getwd cache (G)
-This is a tuning option. When this is enabled a cacheing algorithm will
-be used to reduce the time taken for getwd() calls. This can have a
-significant impact on performance, especially when widelinks is False.
+ bf(Default:)
+tt( getwd cache = No)
+
+ bf(Example:)
+tt( getwd cache = Yes)
-.B Default:
- getwd cache = No
+label(group)
+dit(bf(group (S)))
-.B Example:
- getwd cache = Yes
+Synonym for link(bf("force group"))(forcegroup).
-.SS group (S)
-This is an alias for "force group" and is only kept for compatibility
-with old versions of Samba. It may be removed in future versions.
+label(guestaccount)
+dit(bf(guest account (S)))
-.SS guest account (S)
This is a username which will be used for access to services which are
-specified as 'guest ok' (see below). Whatever privileges this user has
-will be available to any client connecting to the guest
-service. Typically this user will exist in the password file, but will
-not have a valid login. If a username is specified in a given service,
-the specified username overrides this one.
-
-One some systems the account "nobody" may not be able to print. Use
-another account in this case. You should test this by trying to log in
-as your guest user (perhaps by using the "su \-" command) and trying to
-print using
-.BR lpr .
-
-Note that as of version 1.9 of Samba this option may be set
-differently for each service.
-
-.B Default:
- specified at compile time
-
-.B Example:
- guest account = nobody
-.SS guest ok (S)
-See
-.B public.
-.SS guest only (S)
-If this parameter is 'yes' for a service, then only guest connections to the
-service are permitted. This parameter will have no affect if "guest ok" or
-"public" is not set for the service.
-
-See the section below on user/password validation for more information about
-this option.
-
-.B Default:
- guest only = no
-
-.B Example:
- guest only = yes
-.SS hide dot files (S)
+specified as link(bf('guest ok'))(guestok) (see below). Whatever
+privileges this user has will be available to any client connecting to
+the guest service. Typically this user will exist in the password
+file, but will not have a valid login. The user account bf("ftp") is
+often a good choice for this parameter. If a username is specified in
+a given service, the specified username overrides this one.
+
+One some systems the default guest account "nobody" may not be able to
+print. Use another account in this case. You should test this by
+trying to log in as your guest user (perhaps by using the tt("su -")
+command) and trying to print using the system print command such as
+bf(lpr (1)) or bf(lp (1)).
+
+ bf(Default:)
+tt( specified at compile time, usually "nobody")
+
+ bf(Example:)
+tt( guest account = ftp)
+
+label(guestok)
+dit(bf(guest ok (S)))
+
+If this parameter is em('yes') for a service, then no password is
+required to connect to the service. Privileges will be those of the
+link(bf(guest account))(guestaccount).
+
+See the section below on link(bf(security))(security) for more
+information about this option.
+
+ bf(Default:)
+tt( guest ok = no)
+
+ bf(Example:)
+tt( guest ok = yes)
+
+label(guestonly)
+dit(bf(guest only (S)))
+
+If this parameter is em('yes') for a service, then only guest
+connections to the service are permitted. This parameter will have no
+affect if link(bf("guest ok"))(guestok) or link(bf("public"))(public)
+is not set for the service.
+
+See the section below on link(bf(security))(security) for more
+information about this option.
+
+ bf(Default:)
+tt( guest only = no)
+
+ bf(Example:)
+tt( guest only = yes)
+
+label(hidedotfiles)
+dit(bf(hide dot files (S)))
+
This is a boolean parameter that controls whether files starting with
a dot appear as hidden files.
-.B Default:
- hide dot files = yes
+ bf(Default:)
+tt( hide dot files = yes)
+
+ bf(Example:)
+tt( hide dot files = no)
-.B Example:
- hide dot files = no
+label(hidefiles)
+dit(bf(hide files(S)))
-.SS hide files(S)
This is a list of files or directories that are not visible but are
accessible. The DOS 'hidden' attribute is applied to any files or
directories that match.
-Each entry in the list must be separated by a "/", which allows spaces
-to be included in the entry. '*' and '?' can be used to specify multiple
-files or directories as in DOS wildcards.
+Each entry in the list must be separated by a tt('/'), which allows
+spaces to be included in the entry. tt('*') and tt('?') can be used
+to specify multiple files or directories as in DOS wildcards.
-Each entry must be a unix path, not a DOS path and must not include the
-unix directory separator "/".
+Each entry must be a Unix path, not a DOS path and must not include the
+Unix directory separator tt('/').
Note that the case sensitivity option is applicable in hiding files.
-Setting this parameter will affect the performance of Samba, as
-it will be forced to check all files and directories for a match
-as they are scanned.
+Setting this parameter will affect the performance of Samba, as it
+will be forced to check all files and directories for a match as they
+are scanned.
-See also "hide dot files", "veto files" and "case sensitive"
+See also link(bf("hide dot files"))(hidedotfiles), link(bf("veto
+files"))(vetofiles) and link(bf("case sensitive"))(casesensitive).
-.B Default
+ bf(Default)
+verb(
No files or directories are hidden by this option (dot files are
- hidden by default because of the "hide dot files" option).
+ hidden by default because of the "hide dot files" option).
+)
-.B Example
- hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
+ bf(Example)
+tt( hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/)
+
+The above example is based on files that the Macintosh SMB client
+(DAVE) available from url(bf(Thursby))(www.thursby.com) creates for
+internal use, and also still hides all files beginning with a dot.
+
+label(homedirmap)
+dit(bf(homedir map (G)))
+
+If link(bf("nis homedir"))(nishomedir) is true, and
+url(bf(smbd))(smbd.8.html) is also acting as a Win95/98 link(bf(logon
+server))(domainlogons) then this parameter specifies the NIS (or YP)
+map from which the server for the user's home directory should be
+extracted. At present, only the Sun auto.home map format is
+understood. The form of the map is:
-The above example is based on files that the Macintosh client (DAVE)
-creates for internal use, and also still hides all files beginning with
-a dot.
+tt(username server:/some/file/system)
-.SS homedir map (G)
-If "nis homedir" is true, this parameter specifies the NIS (or YP) map
-from which the server for the user's home directory should be extracted.
-At present, only the Sun auto.home map format is understood. The form of
-the map is:
+and the program will extract the servername from before the first
+tt(':'). There should probably be a better parsing system that copes
+with different map formats and also Amd (another automounter) maps.
+
+NB: A working NIS is required on the system for this option to work.
+
+See also link(bf("nis homedir"))(nishomedir), link(bf(domain
+logons))(domainlogons).
+
+ bf(Default:)
+tt( homedir map = auto.home)
-username server:/some/file/system
+ bf(Example:)
+tt( homedir map = amd.homedir)
-and the program will extract the servername from before the first ':'.
-There should probably be a better parsing system that copes with different
-map formats and also Amd (another automounter) maps.
+label(hostsallow)
+dit(bf(hosts allow (S)))
-NB: The -DNETGROUP option is required in the Makefile for option to work
-and on some architectures the line -lrpcsvc needs to be added to the
-LIBSM variable. This is required for Solaris 2, FreeBSD and HPUX.
+Synonym for link(bf(allow hosts))(allowhosts).
-See also "nis homedir"
+label(hostsdeny)
+dit(bf(hosts deny (S)))
-.B Default:
- homedir map = auto.home
+Synonym for link(bf(denyhosts))(denyhosts).
-.B Example:
- homedir map = amd.homedir
-.SS hosts allow (S)
-See
-.B allow hosts.
-.SS hosts deny (S)
-See
-.B deny hosts.
+label(hostsequiv)
+dit(bf(hosts equiv (G)))
-.SS hosts equiv (G)
-If this global parameter is a non-null string, it specifies the name of
-a file to read for the names of hosts and users who will be allowed access
-without specifying a password.
+If this global parameter is a non-null string, it specifies the name
+of a file to read for the names of hosts and users who will be allowed
+access without specifying a password.
-This is not be confused with
-.B allow hosts
-which is about hosts access to services and is more useful for guest services.
-.B hosts equiv
-may be useful for NT clients which will not supply passwords to samba.
+This is not be confused with link(bf(allow hosts))(allowhosts) which
+is about hosts access to services and is more useful for guest
+services. bf(hosts equiv) may be useful for NT clients which will not
+supply passwords to samba.
-NOTE: The use of hosts.equiv can be a major security hole. This is
+NOTE: The use of bf(hosts equiv) can be a major security hole. This is
because you are trusting the PC to supply the correct username. It is
very easy to get a PC to supply a false username. I recommend that the
-hosts.equiv option be only used if you really know what you are doing,
-or perhaps on a home network where you trust your wife and kids :-)
+bf(hosts equiv) option be only used if you really know what you are
+doing, or perhaps on a home network where you trust your spouse and
+kids. And only if you em(really) trust them :-).
-.B Default
- No host equivalences
+ bf(Default)
+tt( No host equivalences)
-.B Example
- hosts equiv = /etc/hosts.equiv
+ bf(Example)
+tt( hosts equiv = /etc/hosts.equiv)
-.SS include (G)
+label(include)
+dit(bf(include (G)))
-This allows you to include one config file inside another. The file is
-included literally, as though typed in place.
+This allows you to include one config file inside another. The file
+is included literally, as though typed in place.
-It takes the standard substitutions, except %u, %P and %S
+It takes the standard substitutions, except link(bf(%u))(percentu),
+link(bf(%P))(percentP) and link(bf(%S))(percentS).
-.SS interfaces (G)
+label(interfaces)
+dit(bf(interfaces (G)))
This option allows you to setup multiple network interfaces, so that
Samba can properly handle browsing on all interfaces.
The option takes a list of ip/netmask pairs. The netmask may either be
-a bitmask, or a bitlength.
+a bitmask, or a bitlength.
For example, the following line:
-interfaces = 192.168.2.10/24 192.168.3.10/24
+tt(interfaces = 192.168.2.10/24 192.168.3.10/24)
would configure two network interfaces with IP addresses 192.168.2.10
and 192.168.3.10. The netmasks of both interfaces would be set to
-255.255.255.0.
+255.255.255.0.
You could produce an equivalent result by using:
-interfaces = 192.168.2.10/255.255.255.0 192.168.3.10/255.255.255.0
+tt(interfaces = 192.168.2.10/255.255.255.0 192.168.3.10/255.255.255.0)
if you prefer that format.
If this option is not set then Samba will attempt to find a primary
interface, but won't attempt to configure more than one interface.
-.SS invalid users (S)
+See also link(bf("bind interfaces only"))(bindinterfacesonly).
+
+label(invalidusers)
+dit(bf(invalid users (S)))
+
This is a list of users that should not be allowed to login to this
-service. This is really a "paranoid" check to absolutely ensure an
+service. This is really a em("paranoid") check to absolutely ensure an
improper setting does not breach your security.
-A name starting with @ is interpreted as a yp netgroup first (if this
-has been compiled into Samba), and then as a UNIX group if the name
-was not found in the yp netgroup database.
+A name starting with a tt('@') is interpreted as an NIS netgroup first
+(if your system supports NIS), and then as a UNIX group if the name
+was not found in the NIS netgroup database.
-A name starting with + is interpreted only by looking in the UNIX
-group database. A name starting with & is interpreted only by looking
-in the yp netgroup database (this has no effect if Samba is compiled
-without netgroup support).
+A name starting with tt('+') is interpreted only by looking in the
+UNIX group database. A name starting with tt('&') is interpreted only
+by looking in the NIS netgroup database (this requires NIS to be
+working on your system). The characters tt('+') and tt('&') may be
+used at the start of the name in either order so the value
+tt("+&group") means check the UNIX group database, followed by the NIS
+netgroup database, and the value tt("&+group") means check the NIS
+netgroup database, followed by the UNIX group database (the same as
+the tt('@') prefix).
-The current servicename is substituted for %S. This is useful in the
-[homes] section.
+The current servicename is substituted for
+link(bf(%S))(percentS). This is useful in the link(bf([homes]))(homes)
+section.
-See also "valid users"
+See also link(bf("valid users"))(validusers).
-.B Default
- No invalid users
+ bf(Default:)
+tt( No invalid users)
+
+ bf(Example:)
+tt( invalid users = root fred admin @wheel)
-.B Example
- invalid users = root fred admin @wheel
+label(keepalive)
+dit(bf(keepalive (G)))
-.SS keepalive (G)
-The value of the parameter (an integer) represents the number of seconds
-between 'keepalive' packets. If this parameter is zero, no keepalive packets
-will be sent. Keepalive packets, if sent, allow the server to tell whether a
-client is still present and responding.
+The value of the parameter (an integer) represents the number of
+seconds between bf('keepalive') packets. If this parameter is zero, no
+keepalive packets will be sent. Keepalive packets, if sent, allow the
+server to tell whether a client is still present and responding.
Keepalives should, in general, not be needed if the socket being used
-has the SO_KEEPALIVE attribute set on it (see "socket
-options"). Basically you should only use this option if you strike
-difficulties.
+has the SO_KEEPALIVE attribute set on it (see link(bf("socket
+options"))(socketoptions)). Basically you should only use this option
+if you strike difficulties.
-.B Default:
- keep alive = 0
+ bf(Default:)
+tt( keep alive = 0)
-.B Example:
- keep alive = 60
+ bf(Example:)
+tt( keep alive = 60)
-.SS lm announce (G)
+label(kerneloplocks)
+dit(bf(kernel oplocks (G)))
-This parameter determines if Samba will produce Lanman announce
-broadcasts that are needed by OS/2 clients in order for them to
-see the Samba server in their browse list. This parameter can
-have three values, true, false, or auto. The default is auto.
-If set to False Samba will never produce these broadcasts. If
-set to true Samba will produce Lanman announce broadcasts at
-a frequency set by the parameter 'lm interval'. If set to auto
-Samba will not send Lanman announce broadcasts by default but
-will listen for them. If it hears such a broadcast on the wire
-it will then start sending them at a frequency set by the parameter
-'lm interval'.
+For UNIXs that support kernel based link(bf(oplocks))(oplocks)
+(currently only IRIX but hopefully also Linux and FreeBSD soon) this
+parameter allows the use of them to be turned on or off.
-See also "lm interval".
+Kernel oplocks support allows Samba link(bf(oplocks))(oplocks) to be
+broken whenever a local UNIX process or NFS operation accesses a file
+that url(bf(smbd))(smbd.8.html) has oplocked. This allows complete
+data consistency between SMB/CIFS, NFS and local file access (and is a
+em(very) cool feature :-).
-.B Default:
- lm announce = auto
+This parameter defaults to em("On") on systems that have the support,
+and em("off") on systems that don't. You should never need to touch
+this parameter.
-.B Example:
- lm announce = true
+label(ldapfilter)
+dit(bf(ldap filter (G)))
-.SS lm interval (G)
+This parameter is part of the em(EXPERIMENTAL) Samba support for a
+password database stored on an LDAP server back-end. These options
+are only available if your version of Samba was configured with
+the bf(--with-ldap) option.
-If Samba is set to produce Lanman announce broadcasts needed
-by OS/2 clients (see the "lm announce" parameter) this parameter
-defines the frequency in seconds with which they will be made.
-If this is set to zero then no Lanman announcements will be
-made despite the setting of the "lm announce" parameter.
+This parameter specifies an LDAP search filter used to search for a
+user name in the LDAP database. It must contain the string
+link(bf(%u))(percentU) which will be replaced with the user being
+searched for.
-See also "lm announce".
+ bf(Default:)
+tt( empty string.)
-.B Default:
- lm interval = 60
+label(ldapport)
+dit(bf(ldap port (G)))
-.B Example:
- lm interval = 120
+This parameter is part of the em(EXPERIMENTAL) Samba support for a
+password database stored on an LDAP server back-end. These options
+are only available if your version of Samba was configured with
+the bf(--with-ldap) option.
-.SS load printers (G)
-A boolean variable that controls whether all printers in the printcap
-will be loaded for browsing by default.
+This parameter specifies the TCP port number to use to contact
+the LDAP server on.
-.B Default:
- load printers = yes
+ bf(Default:)
+tt( ldap port = 389.)
-.B Example:
- load printers = no
+label(ldaproot)
+dit(bf(ldap root (G)))
-.SS local master (G)
-This option allows the nmbd to become a local master browser on a
-subnet. If set to False then nmbd will not attempt to become a local
-master browser on a subnet and will also lose in all browsing elections.
-By default this value is set to true. Setting this value to true doesn't
-mean that Samba will become the local master browser on a subnet, just
-that the nmbd will participate in elections for local master browser.
+This parameter is part of the em(EXPERIMENTAL) Samba support for a
+password database stored on an LDAP server back-end. These options
+are only available if your version of Samba was configured with
+the bf(--with-ldap) option.
-.B Default:
- local master = yes
+This parameter specifies the entity to bind to the LDAP server
+as (essentially the LDAP username) in order to be able to perform
+queries and modifications on the LDAP database.
-.SS lock directory (G)
-This option specifies the directory where lock files will be placed.
-The lock files are used to implement the "max connections" option.
+See also link(bf(ldap root passwd))(ldaprootpasswd).
-.B Default:
- lock directory = /tmp/samba
+ bf(Default:)
+tt( empty string (no user defined))
-.B Example:
- lock directory = /usr/local/samba/var/locks
+label(ldaprootpasswd)
+dit(bf(ldap root passwd (G)))
-.SS locking (S)
-This controls whether or not locking will be performed by the server in
-response to lock requests from the client.
+This parameter is part of the em(EXPERIMENTAL) Samba support for a
+password database stored on an LDAP server back-end. These options
+are only available if your version of Samba was configured with
+the bf(--with-ldap) option.
-If "locking = no", all lock and unlock requests will appear to succeed and
-all lock queries will indicate that the queried lock is clear.
+This parameter specifies the password for the entity to bind to the
+LDAP server as (the password for this LDAP username) in order to be
+able to perform queries and modifications on the LDAP database.
-If "locking = yes", real locking will be performed by the server.
+em(BUGS:) This parameter should em(NOT) be a readable parameter
+in the bf(smb.conf) file and will be removed once a correct
+storage place is found.
-This option may be particularly useful for read-only filesystems which
-do not need locking (such as cdrom drives).
+See also link(bf(ldap root))(ldaproot).
-Be careful about disabling locking either globally or in a specific
-service, as lack of locking may result in data corruption.
+ bf(Default:)
+tt( empty string.)
-.B Default:
- locking = yes
+label(ldapserver)
+dit(bf(ldap server (G)))
-.B Example:
- locking = no
+This parameter is part of the em(EXPERIMENTAL) Samba support for a
+password database stored on an LDAP server back-end. These options
+are only available if your version of Samba was configured with
+the bf(--with-ldap) option.
-.SS log file (G)
+This parameter specifies the DNS name of the LDAP server to use
+for SMB/CIFS authentication purposes.
-This options allows you to override the name of the Samba log file
-(also known as the debug file).
+ bf(Default:)
+tt( ldap server = localhost)
-This option takes the standard substitutions, allowing you to have
-separate log files for each user or machine.
+label(ldapsuffix)
+dit(bf(ldap suffix (G)))
-.B Example:
- log file = /usr/local/samba/var/log.%m
+This parameter is part of the em(EXPERIMENTAL) Samba support for a
+password database stored on an LDAP server back-end. These options
+are only available if your version of Samba was configured with
+the bf(--with-ldap) option.
-.SS log level (G)
-see "debug level"
+This parameter specifies the tt("dn") or LDAP em("distinguished name")
+that tells url(bf(smbd))(smbd.8.html) to start from when searching
+for an entry in the LDAP password database.
-.SS logon drive (G)
+ bf(Default:)
+tt( empty string.)
-This parameter specifies the local path to which the home directory
-will be connected (see "logon home") and is only used by NT Workstations.
+label(lmannounce)
+dit(bf(lm announce (G)))
-.B Example:
- logon drive = h:
+This parameter determines if url(bf(nmbd))(nmbd.8.html) will produce
+Lanman announce broadcasts that are needed by bf(OS/2) clients in order
+for them to see the Samba server in their browse list. This parameter
+can have three values, tt("true"), tt("false"), or tt("auto"). The
+default is tt("auto"). If set to tt("false") Samba will never produce
+these broadcasts. If set to tt("true") Samba will produce Lanman
+announce broadcasts at a frequency set by the parameter link(bf("lm
+interval"))(lminterval). If set to tt("auto") Samba will not send Lanman
+announce broadcasts by default but will listen for them. If it hears
+such a broadcast on the wire it will then start sending them at a
+frequency set by the parameter link(bf("lm interval"))(lminterval).
-.SS logon home (G)
+See also link(bf("lm interval"))(lminterval).
-This parameter specifies the home directory location when a Win95 or
-NT Workstation logs into a Samba PDC. It allows you to do "NET USE
-H: /HOME" from a command prompt, for example.
+ bf(Default:)
+tt( lm announce = auto)
-.B
-This option takes the standard substitutions, allowing you to have
-separate logon scripts for each user or machine.
+ bf(Example:)
+tt( lm announce = true)
-.B Example:
- logon home = "\\\\remote_smb_server\\%U"
+label(lminterval)
+dit(bf(lm interval (G)))
-.B Default:
- logon home = "\\\\%N\\%U"
+If Samba is set to produce Lanman announce broadcasts needed by
+bf(OS/2) clients (see the link(bf("lm announce"))(lmannounce)
+parameter) then this parameter defines the frequency in seconds with
+which they will be made. If this is set to zero then no Lanman
+announcements will be made despite the setting of the link(bf("lm
+announce"))(lmannounce) parameter.
-.SS logon path (G)
+See also link(bf("lm announce"))(lmannounce).
-This parameter specifies the home directory where roaming profiles
-(USER.DAT / USER.MAN files for Windows 95) are stored.
+ bf(Default:)
+tt( lm interval = 60)
-This option takes the standard substitutions, allowing you to have
-separate logon scripts for each user or machine. It also specifies
-the directory from which the "desktop", "start menu", "nethood" and
-"programs" folders, and their contents, are loaded and displayed
-on your Windows 95 client.
+ bf(Example:)
+tt( lm interval = 120)
-The share and the path must be readable by the user for the preferences
-and directories to be loaded onto the Windows 95 client. The share
-must be writeable when the logs in for the first time, in order that
-the Windows 95 client can create the user.dat and other directories.
+label(loadprinters)
+dit(bf(load printers (G)))
-Thereafter, the directories and any of contents can, if required,
-be made read-only. It is not adviseable that the USER.DAT file be made
-read-only - rename it to USER.MAN to achieve the desired effect
-(a MANdatory profile).
+A boolean variable that controls whether all printers in the printcap
+will be loaded for browsing by default. See the
+link(bf("printers"))(printers) section for more details.
-Windows clients can sometimes maintain a connection to the [homes]
-share, even though there is no user logged in. Therefore, it is
-vital that the logon path does not include a reference to the
-homes share (i.e \\\\%N\\HOMES\profile_path will cause problems).
+ bf(Default:)
+tt( load printers = yes)
-.B
-This option takes the standard substitutions, allowing you to have
-separate logon scripts for each user or machine.
+ bf(Example:)
+tt( load printers = no)
-.B Default:
- logon path = \\\\%N\\%U\\profile
+label(localmaster)
+dit(bf(local master (G)))
-.B Example:
- logon path = \\\\PROFILESERVER\\HOME_DIR\\%U\\PROFILE
+This option allows url(bf(nmbd))(nmbd.8.html) to try and become a
+local master browser on a subnet. If set to False then
+url(bf(nmbd))(nmbd.8.html) will not attempt to become a local master
+browser on a subnet and will also lose in all browsing elections. By
+default this value is set to true. Setting this value to true doesn't
+mean that Samba will em(become) the local master browser on a subnet,
+just that url(bf(nmbd))(nmbd.8.html) will em(participate) in
+elections for local master browser.
-.SS logon script (G)
+Setting this value to False will cause url(bf(nmbd))(nmbd.8.html)
+em(never) to become a local master browser.
-This parameter specifies the batch file (.bat) or NT command file (.cmd)
-to be downloaded and run on a machine when a user successfully logs in.
-The file must contain the DOS style cr/lf line endings. Using a DOS-style
-editor to create the file is recommended.
+ bf(Default:)
+tt( local master = yes)
-The script must be a relative path to the [netlogon] service. If the
-[netlogon] service specifies a path of /usr/local/samba/netlogon, and
-logon script = STARTUP.BAT, then file that will be downloaded is:
+label(lock dir)
+dit(bf(lock dir (G)))
-.B /usr/local/samba/netlogon/STARTUP.BAT
+Synonym for link(bf("lock directory"))(lockdirectory).
-The contents of the batch file is entirely your choice. A suggested
-command would be to add NET TIME \\\\SERVER /SET /YES, to force every
-machine to synchronise clocks with the same time server. Another use
-would be to add NET USE U: \\\\SERVER\\UTILS for commonly used utilities,
-or NET USE Q: \\\\SERVER\\ISO9001_QA.
+label(lockdirectory)
+dit(bf(lock directory (G)))
-Note that it is particularly important not to allow write access to
-the [netlogon] share, or to grant users write permission on the
-batch files in a secure environment, as this would allow the batch
-files to be arbitrarily modified.
+This option specifies the directory where lock files will be placed.
+The lock files are used to implement the link(bf("max
+connections"))(maxconnections) option.
-.B
-This option takes the standard substitutions, allowing you to have
-separate logon scripts for each user or machine.
+ bf(Default:)
+tt( lock directory = /tmp/samba)
-.B Example:
- logon script = scripts\\%U.bat
-
-.SS lppause command (S)
-This parameter specifies the command to be executed on the server host in
-order to stop printing or spooling a specific print job.
-
-This command should be a program or script which takes a printer name and
-job number to pause the print job. Currently I don't know of any print
-spooler system that can do this with a simple option, except for the PPR
-system from Trinity College (ppr\-dist.trincoll.edu/pub/ppr). One way
-of implementing this is by using job priorities, where jobs having a too
-low priority won't be sent to the printer. See also the
-.B lppause
-command.
-
-If a %p is given then the printername is put in its place. A %j is
-replaced with the job number (an integer).
-On HPUX (see printing=hpux), if the -p%p option is added to the lpq
-command, the job will show up with the correct status, i.e. if the job
-priority is lower than the set fence priority it will have the PAUSED
-status, whereas if the priority is equal or higher it will have the
-SPOOLED or PRINTING status.
-
-Note that it is good practice to include the absolute path in the lppause
-command as the PATH may not be available to the server.
+ bf(Example:)
+tt( lock directory = /usr/local/samba/var/locks)
-.B Default:
- Currently no default value is given to this string
+label(locking)
+dit(bf(locking (S)))
-.B Example for HPUX:
- lppause command = /usr/bin/lpalt %p-%j -p0
+This controls whether or not locking will be performed by the server
+in response to lock requests from the client.
-.SS lpq cache time (G)
+If tt("locking = no"), all lock and unlock requests will appear to
+succeed and all lock queries will indicate that the queried lock is
+clear.
-This controls how long lpq info will be cached for to prevent the lpq
-command being called too often. A separate cache is kept for each
-variation of the lpq command used by the system, so if you use
-different lpq commands for different users then they won't share cache
-information.
+If tt("locking = yes"), real locking will be performed by the server.
-The cache files are stored in /tmp/lpq.xxxx where xxxx is a hash
-of the lpq command in use.
+This option em(may) be useful for read-only filesystems which em(may)
+not need locking (such as cdrom drives), although setting this
+parameter of tt("no") is not really recommended even in this case.
-The default is 10 seconds, meaning that the cached results of a
-previous identical lpq command will be used if the cached data is less
-than 10 seconds old. A large value may be advisable if your lpq
-command is very slow.
+Be careful about disabling locking either globally or in a specific
+service, as lack of locking may result in data corruption. You should
+never need to set this parameter.
-A value of 0 will disable cacheing completely.
+ bf(Default:)
+tt( locking = yes)
-.B Default:
- lpq cache time = 10
+ bf(Example:)
+tt( locking = no)
-.B Example:
- lpq cache time = 30
+label(logfile)
+dit(bf(log file (G)))
-.SS lpq command (S)
-This parameter specifies the command to be executed on the server host in
-order to obtain "lpq"-style printer status information.
+This options allows you to override the name of the Samba log file
+(also known as the debug file).
-This command should be a program or script which takes a printer name
-as its only parameter and outputs printer status information.
+This option takes the standard substitutions, allowing you to have
+separate log files for each user or machine.
-Currently six styles of printer status information are supported; BSD,
-SYSV, AIX, HPUX, QNX, LPRNG and PLP. This covers most UNIX systems. You
-control which type is expected using the "printing =" option.
+ bf(Example:)
+tt( log file = /usr/local/samba/var/log.%m)
-Some clients (notably Windows for Workgroups) may not correctly send the
-connection number for the printer they are requesting status information
-about. To get around this, the server reports on the first printer service
-connected to by the client. This only happens if the connection number sent
-is invalid.
+label(loglevel)
+dit(bf(log level (G)))
-If a %p is given then the printername is put in its place. Otherwise
-it is placed at the end of the command.
+Synonym for link(bf("debug level"))(debuglevel).
-Note that it is good practice to include the absolute path in the lpq
-command as the PATH may not be available to the server.
+label(logondrive)
+dit(bf(logon drive (G)))
-.B Default:
- depends on the setting of "printing ="
+This parameter specifies the local path to which the home directory
+will be connected (see link(bf("logon home"))(logonhome)) and is only
+used by NT Workstations.
-.B Example:
- lpq command = /usr/bin/lpq %p
+Note that this option is only useful if Samba is set up as a
+link(bf(logon server))(domainlogons).
-.SS lpresume command (S)
-This parameter specifies the command to be executed on the server host in
-order to restart or continue printing or spooling a specific print job.
+ bf(Example:)
+tt( logon drive = h:)
-This command should be a program or script which takes a printer name and
-job number to resume the print job. See also the lppause command.
+label(logonhome)
+dit(bf(logon home (G)))
-If a %p is given then the printername is put in its place. A %j is
-replaced with the job number (an integer).
+This parameter specifies the home directory location when a Win95/98 or
+NT Workstation logs into a Samba PDC. It allows you to do
-Note that it is good practice to include the absolute path in the lpresume
-command as the PATH may not be available to the server.
+tt("NET USE H: /HOME")
-.B Default:
- Currently no default value is given to this string
+from a command prompt, for example.
-.B Example for HPUX:
- lpresume command = /usr/bin/lpalt %p-%j -p2
+This option takes the standard substitutions, allowing you to have
+separate logon scripts for each user or machine.
-.SS lprm command (S)
-This parameter specifies the command to be executed on the server host in
-order to delete a print job.
+Note that this option is only useful if Samba is set up as a
+link(bf(logon server))(domainlogons).
-This command should be a program or script which takes a printer name
-and job number, and deletes the print job.
+ bf(Example:)
+tt( logon home = "\\remote_smb_server\%U")
-Currently seven styles of printer control are supported; BSD, SYSV, AIX
-HPUX, QNX, LPRNG and PLP. This covers most UNIX systems. You control
-which type is expected using the "printing =" option.
+ bf(Default:)
+tt( logon home = "\\%N\%U")
-If a %p is given then the printername is put in its place. A %j is
-replaced with the job number (an integer).
+label(logonpath)
+dit(bf(logon path (G)))
-Note that it is good practice to include the absolute path in the lprm
-command as the PATH may not be available to the server.
+This parameter specifies the home directory where roaming profiles
+(USER.DAT / USER.MAN files for Windows 95/98) are stored.
-.B Default:
- depends on the setting of "printing ="
+This option takes the standard substitutions, allowing you to have
+separate logon scripts for each user or machine. It also specifies
+the directory from which the tt("desktop"), tt("start menu"),
+tt("network neighborhood") and tt("programs") folders, and their
+contents, are loaded and displayed on your Windows 95/98 client.
-.B Example 1:
- lprm command = /usr/bin/lprm -P%p %j
+The share and the path must be readable by the user for the
+preferences and directories to be loaded onto the Windows 95/98
+client. The share must be writeable when the logs in for the first
+time, in order that the Windows 95/98 client can create the user.dat
+and other directories.
-.B Example 2:
- lprm command = /usr/bin/cancel %p-%j
+Thereafter, the directories and any of the contents can, if required, be
+made read-only. It is not advisable that the USER.DAT file be made
+read-only - rename it to USER.MAN to achieve the desired effect (a
+em(MAN)datory profile).
-.SS magic output (S)
-This parameter specifies the name of a file which will contain output
-created by a magic script (see
-.I magic script
-below).
+Windows clients can sometimes maintain a connection to the [homes]
+share, even though there is no user logged in. Therefore, it is vital
+that the logon path does not include a reference to the homes share
+(i.e. setting this parameter to tt(\\%N\HOMES\profile_path) will cause
+problems).
-Warning: If two clients use the same magic script in the same directory the
-output file content is undefined.
-.B Default:
- magic output = <magic script name>.out
+This option takes the standard substitutions, allowing you to have
+separate logon scripts for each user or machine.
-.B Example:
- magic output = myfile.txt
-.SS magic script (S)
-This parameter specifies the name of a file which, if opened, will be
-executed by the server when the file is closed. This allows a UNIX script
-to be sent to the Samba host and executed on behalf of the connected user.
+Note that this option is only useful if Samba is set up as a
+link(bf(logon server))(domainlogons).
-Scripts executed in this way will be deleted upon completion, permissions
-permitting.
+ bf(Default:)
+tt( logon path = \\%N\%U\profile)
-If the script generates output, output will be sent to the file specified by
-the
-.I magic output
-parameter (see above).
+ bf(Example:)
+tt( logon path = \\PROFILESERVER\HOME_DIR\%U\PROFILE)
-Note that some shells are unable to interpret scripts containing
-carriage-return-linefeed instead of linefeed as the end-of-line
-marker. Magic scripts must be executable "as is" on the host, which
-for some hosts and some shells will require filtering at the DOS end.
+label(logonscript)
+dit(bf(logon script (G)))
-Magic scripts are EXPERIMENTAL and should NOT be relied upon.
+This parameter specifies the batch file (.bat) or NT command file
+(.cmd) to be downloaded and run on a machine when a user successfully
+logs in. The file must contain the DOS style cr/lf line endings.
+Using a DOS-style editor to create the file is recommended.
-.B Default:
- None. Magic scripts disabled.
+The script must be a relative path to the tt([netlogon]) service. If
+the tt([netlogon]) service specifies a link(bf(path))(path) of
+/usr/local/samba/netlogon, and logon script = STARTUP.BAT, then the
+file that will be downloaded is:
-.B Example:
- magic script = user.csh
+tt(/usr/local/samba/netlogon/STARTUP.BAT)
-.SS mangle case (S)
+The contents of the batch file is entirely your choice. A suggested
+command would be to add tt(NET TIME \\SERVER /SET /YES), to force every
+machine to synchronize clocks with the same time server. Another use
+would be to add tt(NET USE U: \\SERVER\UTILS) for commonly used
+utilities, or tt(NET USE Q: \\SERVER\ISO9001_QA) for example.
-See the section on "NAME MANGLING"
+Note that it is particularly important not to allow write access to
+the tt([netlogon]) share, or to grant users write permission on the
+batch files in a secure environment, as this would allow the batch
+files to be arbitrarily modified and security to be breached.
-.SS mangled map (S)
-This is for those who want to directly map UNIX file names which are
-not representable on DOS. The mangling of names is not always what is
-needed. In particular you may have documents with file extensions
-that differ between DOS and UNIX. For example, under UNIX it is common
-to use .html for HTML files, whereas under DOS .htm is more commonly
-used.
+This option takes the standard substitutions, allowing you to have
+separate logon scripts for each user or machine.
-So to map 'html' to 'htm' you put:
+Note that this option is only useful if Samba is set up as a
+link(bf(logon server))(domainlogons).
- mangled map = (*.html *.htm)
+ bf(Example:)
+tt( logon script = scripts\%U.bat)
-One very useful case is to remove the annoying ;1 off the ends of
-filenames on some CDROMS (only visible under some UNIXes). To do this
-use a map of (*;1 *)
+label(lppausecommand)
+dit(bf(lppause command (S)))
-.B default:
- no mangled map
+This parameter specifies the command to be executed on the server host
+in order to stop printing or spooling a specific print job.
-.B Example:
- mangled map = (*;1 *)
+This command should be a program or script which takes a printer name
+and job number to pause the print job. One way of implementing this is
+by using job priorities, where jobs having a too low priority won't be
+sent to the printer.
-.SS mangled names (S)
-This controls whether non-DOS names under UNIX should be mapped to
-DOS-compatible names ("mangled") and made visible, or whether non-DOS names
-should simply be ignored.
+If a tt("%p") is given then the printername is put in its place. A
+tt("%j") is replaced with the job number (an integer). On HPUX (see
+link(bf(printing=hpux))(printing)), if the tt("-p%p") option is added
+to the lpq command, the job will show up with the correct status,
+i.e. if the job priority is lower than the set fence priority it will
+have the PAUSED status, whereas if the priority is equal or higher it
+will have the SPOOLED or PRINTING status.
-See the section on "NAME MANGLING" for details on how to control the
-mangling process.
+Note that it is good practice to include the absolute path in the
+lppause command as the PATH may not be available to the server.
-If mangling is used then the mangling algorithm is as follows:
-.RS
-- the first (up to) five alphanumeric characters before the rightmost dot of
-the filename are preserved, forced to upper case, and appear as the first (up
-to) five characters of the mangled name.
-
-- a tilde ("~") is appended to the first part of the mangled name, followed
-by a two-character unique sequence, based on the original root name
-(i.e., the original filename minus its final extension). The final
-extension is included in the hash calculation only if it contains any upper
-case characters or is longer than three characters.
-
-Note that the character to use may be specified using the "mangling
-char" option, if you don't like ~.
-
-- the first three alphanumeric characters of the final extension are preserved,
-forced to upper case and appear as the extension of the mangled name. The
-final extension is defined as that part of the original filename after the
-rightmost dot. If there are no dots in the filename, the mangled name will
-have no extension (except in the case of hidden files - see below).
-
-- files whose UNIX name begins with a dot will be presented as DOS hidden
-files. The mangled name will be created as for other filenames, but with the
-leading dot removed and "___" as its extension regardless of actual original
-extension (that's three underscores).
-.RE
-
-The two-digit hash value consists of upper case alphanumeric characters.
-
-This algorithm can cause name collisions only if files in a directory share
-the same first five alphanumeric characters. The probability of such a clash
-is 1/1300.
+See also the link(bf("printing"))(printing) parameter.
-The name mangling (if enabled) allows a file to be copied between UNIX
-directories from DOS while retaining the long UNIX filename. UNIX files can
-be renamed to a new extension from DOS and will retain the same basename.
-Mangled names do not change between sessions.
+ bf(Default:)
+ Currently no default value is given to this string, unless the
+value of the link(bf("printing"))(printing) parameter is tt(SYSV), in
+which case the default is :
-.B Default:
- mangled names = yes
+tt( lp -i %p-%j -H hold)
-.B Example:
- mangled names = no
-.SS mangling char (S)
-This controls what character is used as the "magic" character in name
-mangling. The default is a ~ but this may interfere with some
-software. Use this option to set it to whatever you prefer.
+or if the value of the link(bf("printing"))(printing) parameter is tt(softq),
+then the default is:
-.B Default:
- mangling char = ~
+tt( qstat -s -j%j -h)
+
+ bf(Example for HPUX:)
+ lppause command = /usr/bin/lpalt %p-%j -p0
-.B Example:
- mangling char = ^
+label(lpqcachetime)
+dit(bf(lpq cache time (G)))
-.SS mangled stack (G)
-This parameter controls the number of mangled names that should be cached in
-the Samba server.
+This controls how long lpq info will be cached for to prevent the
+bf(lpq) command being called too often. A separate cache is kept for
+each variation of the bf(lpq) command used by the system, so if you
+use different bf(lpq) commands for different users then they won't
+share cache information.
-This stack is a list of recently mangled base names (extensions are only
-maintained if they are longer than 3 characters or contains upper case
-characters).
+The cache files are stored in tt(/tmp/lpq.xxxx) where xxxx is a hash of
+the bf(lpq) command in use.
-The larger this value, the more likely it is that mangled names can be
-successfully converted to correct long UNIX names. However, large stack
-sizes will slow most directory access. Smaller stacks save memory in the
-server (each stack element costs 256 bytes).
+The default is 10 seconds, meaning that the cached results of a
+previous identical bf(lpq) command will be used if the cached data is
+less than 10 seconds old. A large value may be advisable if your
+bf(lpq) command is very slow.
-It is not possible to absolutely guarantee correct long file names, so
-be prepared for some surprises!
+A value of 0 will disable caching completely.
-.B Default:
- mangled stack = 50
+See also the link(bf("printing"))(printing) parameter.
-.B Example:
- mangled stack = 100
+ bf(Default:)
+tt( lpq cache time = 10)
-.SS map archive (S)
-This controls whether the DOS archive attribute should be mapped to the
-UNIX owner execute bit. The DOS archive bit is set when a file has been modified
-since its last backup. One motivation for this option it to keep Samba/your
-PC from making any file it touches from becoming executable under UNIX.
-This can be quite annoying for shared source code, documents, etc...
+ bf(Example:)
+tt( lpq cache time = 30)
-Note that this requires the 'create mask' to be set such that owner
-execute bit is not masked out (ie. it must include 100). See the
-parameter "create mask" for details.
+label(lpqcommand)
+dit(bf(lpq command (S)))
-.B Default:
- map archive = yes
+This parameter specifies the command to be executed on the server host
+in order to obtain tt("lpq")-style printer status information.
-.B Example:
- map archive = no
+This command should be a program or script which takes a printer name
+as its only parameter and outputs printer status information.
-.SS map hidden (S)
-This controls whether DOS style hidden files should be mapped to the
-UNIX world execute bit.
+Currently eight styles of printer status information are supported;
+BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX and SOFTQ. This covers most UNIX
+systems. You control which type is expected using the
+link(bf("printing ="))(printing) option.
-Note that this requires the 'create mask' to be set such that the world
-execute bit is not masked out (ie. it must include 001).
-See the parameter "create mask" for details.
+Some clients (notably Windows for Workgroups) may not correctly send
+the connection number for the printer they are requesting status
+information about. To get around this, the server reports on the first
+printer service connected to by the client. This only happens if the
+connection number sent is invalid.
-.B Default:
- map hidden = no
+If a tt(%p) is given then the printername is put in its place. Otherwise
+it is placed at the end of the command.
-.B Example:
- map hidden = yes
-.SS map system (S)
-This controls whether DOS style system files should be mapped to the
-UNIX group execute bit.
+Note that it is good practice to include the absolute path in the bf(lpq
+command) as the PATH may not be available to the server.
-Note that this requires the 'create mask' to be set such that the group
-execute bit is not masked out (ie. it must include 010). See the parameter
-"create mask" for details.
+See also the link(bf("printing"))(printing) parameter.
-.B Default:
- map system = no
+ bf(Default:)
+tt( depends on the setting of printing =)
-.B Example:
- map system = yes
-.SS max connections (S)
-This option allows the number of simultaneous connections to a
-service to be limited. If "max connections" is greater than 0 then
-connections will be refused if this number of connections to the
-service are already open. A value of zero mean an unlimited number of
-connections may be made.
+ bf(Example:)
+tt( lpq command = /usr/bin/lpq %p)
-Record lock files are used to implement this feature. The lock files
-will be stored in the directory specified by the "lock directory" option.
+label(lpresumecommand)
+dit(bf(lpresume command (S)))
-.B Default:
- max connections = 0
+This parameter specifies the command to be executed on the server host
+in order to restart or continue printing or spooling a specific print
+job.
-.B Example:
- max connections = 10
+This command should be a program or script which takes a printer name
+and job number to resume the print job. See also the link(bf("lppause
+command"))(lppausecommand) parameter.
-.SS max disk size (G)
-This option allows you to put an upper limit on the apparent size of
-disks. If you set this option to 100 then all shares will appear to be
-not larger than 100 MB in size.
+If a tt(%p) is given then the printername is put in its place. A
+tt(%j) is replaced with the job number (an integer).
-Note that this option does not limit the amount of data you can put on
-the disk. In the above case you could still store much more than 100
-MB on the disk, but if a client ever asks for the amount of free disk
-space or the total disk size then the result will be bounded by the
-amount specified in "max disk size".
+Note that it is good practice to include the absolute path in the bf(lpresume
+command) as the PATH may not be available to the server.
-This option is primarily useful to work around bugs in some pieces of
-software that can't handle very large disks, particularly disks over
-1GB in size.
+See also the link(bf("printing"))(printing) parameter.
-A "max disk size" of 0 means no limit.
+ bf(Default:)
-.B Default:
- max disk size = 0
+ Currently no default value is given to this string, unless the
+value of the link(bf("printing"))(printing) parameter is tt(SYSV), in
+which case the default is :
-.B Example:
- max disk size = 1000
+tt( lp -i %p-%j -H resume)
-.SS max log size (G)
+or if the value of the link(bf("printing"))(printing) parameter is tt(softq),
+then the default is:
-This option (an integer in kilobytes) specifies the max size the log
-file should grow to. Samba periodically checks the size and if it is
-exceeded it will rename the file, adding a .old extension.
+tt( qstat -s -j%j -r)
+
+ bf(Example for HPUX:)
+tt( lpresume command = /usr/bin/lpalt %p-%j -p2)
-A size of 0 means no limit.
+label(lprmcommand)
+dit(bf(lprm command (S)))
-.B Default:
- max log size = 5000
+This parameter specifies the command to be executed on the server host
+in order to delete a print job.
-.B Example:
- max log size = 1000
+This command should be a program or script which takes a printer name
+and job number, and deletes the print job.
-.SS max mux (G)
+If a tt(%p) is given then the printername is put in its place. A
+tt(%j) is replaced with the job number (an integer).
-This option controls the maximum number of outstanding simultaneous SMB
-operations that samba tells the client it will allow. You should never need
-to set this parameter.
+Note that it is good practice to include the absolute path in the
+bf(lprm command) as the PATH may not be available to the server.
-.B Default:
- max mux = 50
+See also the link(bf("printing"))(printing) parameter.
-.SS max packet (G)
+ bf(Default:)
+tt( depends on the setting of "printing =")
-A synonym for this parameter is 'packet size'.
+ bf(Example 1:)
+tt( lprm command = /usr/bin/lprm -P%p %j)
-.SS max ttl (G)
+ bf(Example 2:)
+tt( lprm command = /usr/bin/cancel %p-%j)
-This option tells nmbd what the default 'time to live' of NetBIOS
-names should be (in seconds) when nmbd is requesting a name using
-either a broadcast or from a WINS server. You should never need to
-change this parameter.
+label(machinepasswordtimeout)
+dit(bf(machine password timeout (G)))
-.B Default:
- max ttl = 14400
+If a Samba server is a member of an Windows NT Domain (see the
+link(bf("security=domain"))(securityequaldomain)) parameter) then
+periodically a running url(bf(smbd))(smbd.8.html) process will try and
+change the bf(MACHINE ACCOUNT PASWORD) stored in the file called
+tt(<Domain>.<Machine>.mac) where tt(<Domain>) is the name of the
+Domain we are a member of and tt(<Machine>) is the primary
+link(bf("NetBIOS name"))(netbiosname) of the machine
+url(bf(smbd))(smbd.8.html) is running on. This parameter specifies how
+often this password will be changed, in seconds. The default is one
+week (expressed in seconds), the same as a Windows NT Domain member
+server.
-.SS max wins ttl (G)
+See also url(bf(smbpasswd (8)))(smbpasswd.8.html), and the
+link(bf("security=domain"))(securityequaldomain)) parameter.
-This option tells nmbd when acting as a WINS server (wins support = true)
-what the maximum 'time to live' of NetBIOS names that nmbd will grant will
-be (in seconds). You should never need to change this parameter.
-The default is 3 days (259200 seconds).
+ bf(Default:)
+tt( machine password timeout = 604800)
-.B Default:
- max wins ttl = 259200
+label(magicoutput)
+dit(bf(magic output (S)))
-.SS max xmit (G)
+This parameter specifies the name of a file which will contain output
+created by a magic script (see the link(bf("magic
+script"))(magicscript) parameter below).
+
+Warning: If two clients use the same link(bf("magic
+script"))(magicscript) in the same directory the output file content
+is undefined.
+
+ bf(Default:)
+tt( magic output = <magic script name>.out)
+
+ bf(Example:)
+tt( magic output = myfile.txt)
+
+label(magicscript)
+dit(bf(magic script (S)))
+
+This parameter specifies the name of a file which, if opened, will be
+executed by the server when the file is closed. This allows a UNIX
+script to be sent to the Samba host and executed on behalf of the
+connected user.
+
+Scripts executed in this way will be deleted upon completion,
+permissions permitting.
+
+If the script generates output, output will be sent to the file
+specified by the link(bf("magic output"))(magicoutput) parameter (see
+above).
+
+Note that some shells are unable to interpret scripts containing
+carriage-return-linefeed instead of linefeed as the end-of-line
+marker. Magic scripts must be executable em("as is") on the host,
+which for some hosts and some shells will require filtering at the DOS
+end.
+
+Magic scripts are em(EXPERIMENTAL) and should em(NOT) be relied upon.
+
+ bf(Default:)
+tt( None. Magic scripts disabled.)
+
+ bf(Example:)
+tt( magic script = user.csh)
+
+label(manglecase)
+dit(bf(mangle case (S)))
+
+See the section on link(bf("NAME MANGLING"))(NAMEMANGLING).
+
+label(mangledmap)
+dit(bf(mangled map (S)))
+
+This is for those who want to directly map UNIX file names which can
+not be represented on Windows/DOS. The mangling of names is not always
+what is needed. In particular you may have documents with file
+extensions that differ between DOS and UNIX. For example, under UNIX
+it is common to use tt(".html") for HTML files, whereas under
+Windows/DOS tt(".htm") is more commonly used.
+
+So to map tt("html") to tt("htm") you would use:
+
+tt( mangled map = (*.html *.htm))
+
+One very useful case is to remove the annoying tt(";1") off the ends
+of filenames on some CDROMS (only visible under some UNIXs). To do
+this use a map of (*;1 *).
+
+ bf(default:)
+tt( no mangled map)
+
+ bf(Example:)
+tt( mangled map = (*;1 *))
+
+label(manglednames)
+dit(bf(mangled names (S)))
+
+This controls whether non-DOS names under UNIX should be mapped to
+DOS-compatible names ("mangled") and made visible, or whether non-DOS
+names should simply be ignored.
+
+See the section on link(bf("NAME MANGLING"))(NAMEMANGLING) for details
+on how to control the mangling process.
+
+If mangling is used then the mangling algorithm is as follows:
+
+startit()
+
+it() The first (up to) five alphanumeric characters before the
+rightmost dot of the filename are preserved, forced to upper case, and
+appear as the first (up to) five characters of the mangled name.
+
+it() A tilde tt("~") is appended to the first part of the mangled
+name, followed by a two-character unique sequence, based on the
+original root name (i.e., the original filename minus its final
+extension). The final extension is included in the hash calculation
+only if it contains any upper case characters or is longer than three
+characters.
+
+Note that the character to use may be specified using the
+link(bf("mangling char"))(manglingchar) option, if you don't like
+tt('~').
+
+it() The first three alphanumeric characters of the final extension
+are preserved, forced to upper case and appear as the extension of the
+mangled name. The final extension is defined as that part of the
+original filename after the rightmost dot. If there are no dots in the
+filename, the mangled name will have no extension (except in the case
+of link(bf("hidden files"))(hidefiles) - see below).
+
+it() Files whose UNIX name begins with a dot will be presented as DOS
+hidden files. The mangled name will be created as for other filenames,
+but with the leading dot removed and tt("___") as its extension regardless
+of actual original extension (that's three underscores).
+
+endit()
+
+The two-digit hash value consists of upper case alphanumeric
+characters.
+
+This algorithm can cause name collisions only if files in a directory
+share the same first five alphanumeric characters. The probability of
+such a clash is 1/1300.
+
+The name mangling (if enabled) allows a file to be copied between UNIX
+directories from Windows/DOS while retaining the long UNIX
+filename. UNIX files can be renamed to a new extension from
+Windows/DOS and will retain the same basename. Mangled names do not
+change between sessions.
+
+ bf(Default:)
+tt( mangled names = yes)
+
+ bf(Example:)
+tt( mangled names = no)
+
+label(manglingchar)
+dit(bf(mangling char (S)))
+
+This controls what character is used as the em("magic") character in
+link(bf(name mangling))(manglednames). The default is a tt('~') but
+this may interfere with some software. Use this option to set it to
+whatever you prefer.
+
+ bf(Default:)
+tt( mangling char = ~)
+
+ bf(Example:)
+tt( mangling char = ^)
+
+label(mangledstack)
+dit(bf(mangled stack (G)))
+
+This parameter controls the number of mangled names that should be
+cached in the Samba server url(bf(smbd))(smbd.8.html).
+
+This stack is a list of recently mangled base names (extensions are
+only maintained if they are longer than 3 characters or contains upper
+case characters).
+
+The larger this value, the more likely it is that mangled names can be
+successfully converted to correct long UNIX names. However, large
+stack sizes will slow most directory access. Smaller stacks save
+memory in the server (each stack element costs 256 bytes).
+
+It is not possible to absolutely guarantee correct long file names, so
+be prepared for some surprises!
+
+ bf(Default:)
+tt( mangled stack = 50)
+
+ bf(Example:)
+tt( mangled stack = 100)
+
+label(maparchive)
+dit(bf(map archive (S)))
+
+This controls whether the DOS archive attribute should be mapped to
+the UNIX owner execute bit. The DOS archive bit is set when a file
+has been modified since its last backup. One motivation for this
+option it to keep Samba/your PC from making any file it touches from
+becoming executable under UNIX. This can be quite annoying for shared
+source code, documents, etc...
+
+Note that this requires the link(bf("create mask"))(createmask)
+parameter to be set such that owner execute bit is not masked out
+(i.e. it must include 100). See the parameter link(bf("create
+mask"))(createmask) for details.
+
+ bf(Default:)
+tt( map archive = yes)
+
+ bf(Example:)
+tt( map archive = no)
+
+label(maphidden)
+dit(bf(map hidden (S)))
+
+This controls whether DOS style hidden files should be mapped to the
+UNIX world execute bit.
+
+Note that this requires the link(bf("create mask"))(createmask) to be
+set such that the world execute bit is not masked out (i.e. it must
+include 001). See the parameter link(bf("create mask"))(createmask)
+for details.
+
+ bf(Default:)
+tt( map hidden = no)
+
+ bf(Example:)
+tt( map hidden = yes)
+
+label(mapsystem)
+dit(bf(map system (S)))
+
+This controls whether DOS style system files should be mapped to the
+UNIX group execute bit.
+
+Note that this requires the link(bf("create mask"))(createmask) to be
+set such that the group execute bit is not masked out (i.e. it must
+include 010). See the parameter link(bf("create mask"))(createmask)
+for details.
+
+ bf(Default:)
+tt( map system = no)
+
+ bf(Example:)
+tt( map system = yes)
+
+label(maptoguest)
+dit(bf(map to guest (G)))
+
+This parameter is only useful in link(bf(security))(security) modes
+other than link(bf("security=share"))(securityequalshare) - i.e. user,
+server, and domain.
+
+This parameter can take three different values, which tell
+url(bf(smbd))(smbd.8.html) what to do with user login requests that
+don't match a valid UNIX user in some way.
+
+The three settings are :
+
+startit()
+
+it() bf("Never") - Means user login requests with an invalid password
+are rejected. This is the default.
+
+it() bf("Bad User") - Means user logins with an invalid password are
+rejected, unless the username does not exist, in which case it is
+treated as a guest login and mapped into the link(bf("guest
+account"))(guestaccount).
+
+it() bf("Bad Password") - Means user logins with an invalid
+password are treated as a guest login and mapped into the
+link(bf("guest account"))(guestaccount). Note that this can
+cause problems as it means that any user incorrectly typing their
+password will be silently logged on a bf("guest") - and
+will not know the reason they cannot access files they think
+they should - there will have been no message given to them
+that they got their password wrong. Helpdesk services will
+em(*hate*) you if you set the bf("map to guest") parameter
+this way :-).
+
+endit()
+
+Note that this parameter is needed to set up bf("Guest") share
+services when using link(bf(security))(security) modes other than
+share. This is because in these modes the name of the resource being
+requested is em(*not*) sent to the server until after the server has
+successfully authenticated the client so the server cannot make
+authentication decisions at the correct time (connection to the
+share) for bf("Guest") shares.
+
+For people familiar with the older Samba releases, this parameter
+maps to the old compile-time setting of the GUEST_SESSSETUP value
+in local.h.
+
+ bf(Default:)
+tt( map to guest = Never)
+ bf(Example):
+tt( map to guest = Bad User)
+
+label(maxconnections)
+dit(bf(max connections (S)))
+
+This option allows the number of simultaneous connections to a service
+to be limited. If bf("max connections") is greater than 0 then
+connections will be refused if this number of connections to the
+service are already open. A value of zero mean an unlimited number of
+connections may be made.
+
+Record lock files are used to implement this feature. The lock files
+will be stored in the directory specified by the link(bf("lock
+directory"))(lockdirectory) option.
+
+ bf(Default:)
+tt( max connections = 0)
+
+ bf(Example:)
+tt( max connections = 10)
+
+label(maxdisksize)
+dit(bf(max disk size (G)))
+
+This option allows you to put an upper limit on the apparent size of
+disks. If you set this option to 100 then all shares will appear to be
+not larger than 100 MB in size.
+
+Note that this option does not limit the amount of data you can put on
+the disk. In the above case you could still store much more than 100
+MB on the disk, but if a client ever asks for the amount of free disk
+space or the total disk size then the result will be bounded by the
+amount specified in bf("max disk size").
+
+This option is primarily useful to work around bugs in some pieces of
+software that can't handle very large disks, particularly disks over
+1GB in size.
+
+A bf("max disk size") of 0 means no limit.
+
+ bf(Default:)
+tt( max disk size = 0)
+
+ bf(Example:)
+tt( max disk size = 1000)
+
+label(maxlogsize)
+dit(bf(max log size (G)))
+
+This option (an integer in kilobytes) specifies the max size the log
+file should grow to. Samba periodically checks the size and if it is
+exceeded it will rename the file, adding a tt(".old") extension.
+
+A size of 0 means no limit.
+
+ bf(Default:)
+tt( max log size = 5000)
+
+ bf(Example:)
+tt( max log size = 1000)
+
+label(maxmux)
+dit(bf(max mux (G)))
+
+This option controls the maximum number of outstanding simultaneous
+SMB operations that samba tells the client it will allow. You should
+never need to set this parameter.
+
+ bf(Default:)
+tt( max mux = 50)
+
+label(maxopenfiles)
+dit(bf(maxopenfiles (G)))
+
+This parameter limits the maximum number of open files that one
+url(bf(smbd))(smbd.8.html) file serving process may have open for
+a client at any one time. The default for this parameter is set
+very high (10,000) as Samba uses only one bit per unopened file.
+
+The limit of the number of open files is usually set by the
+UNIX per-process file descriptor limit rather than this parameter
+so you should never need to touch this parameter.
+
+ bf(Default:)
+tt( max open files = 10000)
+
+label(maxpacket)
+dit(bf(max packet (G)))
+
+Synonym for label(bf("packet size"))(packetsize).
+
+label(maxttl)
+dit(bf(max ttl (G)))
+
+This option tells url(bf(nmbd))(nmbd.8.html) what the default 'time
+to live' of NetBIOS names should be (in seconds) when
+url(bf(nmbd))(nmbd.8.html) is requesting a name using either a
+broadcast packet or from a WINS server. You should never need to
+change this parameter. The default is 3 days.
+
+ bf(Default:)
+tt( max ttl = 259200)
+
+label(maxwinsttl)
+dit(bf(max wins ttl (G)))
+
+This option tells url(bf(nmbd))(nmbd.8.html) when acting as a WINS
+server link(bf((wins support =true)))(winssupport) what the maximum
+'time to live' of NetBIOS names that url(bf(nmbd))(nmbd.8.html) will
+grant will be (in seconds). You should never need to change this
+parameter. The default is 6 days (518400 seconds).
+
+See also the link(bf("min wins ttl"))(minwinsttl) parameter.
+
+ bf(Default:)
+tt( max wins ttl = 518400)
+
+label(maxxmit)
+dit(bf(max xmit (G)))
This option controls the maximum packet size that will be negotiated
by Samba. The default is 65535, which is the maximum. In some cases
you may find you get better performance with a smaller value. A value
below 2048 is likely to cause problems.
-.B Default:
- max xmit = 65535
+ bf(Default:)
+tt( max xmit = 65535)
+
+ bf(Example:)
+tt( max xmit = 8192)
+
+label(messagecommand)
+dit(bf(message command (G)))
+
+This specifies what command to run when the server receives a WinPopup
+style message.
+
+This would normally be a command that would deliver the message
+somehow. How this is to be done is up to your imagination.
+
+An example is:
+
+tt( message command = csh -c 'xedit %s;rm %s' &)
+
+This delivers the message using bf(xedit), then removes it
+afterwards. em(NOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN
+IMMEDIATELY). That's why I have the tt('&') on the end. If it doesn't
+return immediately then your PCs may freeze when sending messages
+(they should recover after 30secs, hopefully).
+
+All messages are delivered as the global guest user. The command takes
+the standard substitutions, although link(bf(%u))(percentu) won't work
+(link(bf(%U))(percentU) may be better in this case).
+
+Apart from the standard substitutions, some additional ones apply. In
+particular:
+
+startit()
+
+it() tt("%s") = the filename containing the message.
+
+it() tt("%t") = the destination that the message was sent to (probably the server
+name).
+
+it() tt("%f") = who the message is from.
+
+endit()
+
+You could make this command send mail, or whatever else takes your
+fancy. Please let us know of any really interesting ideas you have.
+
+Here's a way of sending the messages as mail to root:
+
+tt(message command = /bin/mail -s 'message from %f on %m' root < %s; rm %s)
+
+If you don't have a message command then the message won't be
+delivered and Samba will tell the sender there was an
+error. Unfortunately WfWg totally ignores the error code and carries
+on regardless, saying that the message was delivered.
+
+If you want to silently delete it then try:
+
+tt("message command = rm %s").
+
+For the really adventurous, try something like this:
+
+tt(message command = csh -c 'csh < %s |& /usr/local/samba/bin/smbclient -M %m; rm %s' &)
+
+this would execute the command as a script on the server, then give
+them the result in a WinPopup message. Note that this could cause a
+loop if you send a message from the server using smbclient! You better
+wrap the above in a script that checks for this :-)
+
+ bf(Default:)
+tt( no message command)
+
+ bf(Example:)
+tt( message command = csh -c 'xedit %s;rm %s' &)
+
+label(minprintspace)
+dit(bf(min print space (S)))
+
+This sets the minimum amount of free disk space that must be available
+before a user will be able to spool a print job. It is specified in
+kilobytes. The default is 0, which means a user can always spool a print
+job.
+
+See also the link(bf(printing))(printing) parameter.
+
+ bf(Default:)
+tt( min print space = 0)
+
+ bf(Example:)
+tt( min print space = 2000)
+
+label(minwinsttl)
+dit(bf(min wins ttl (G)))
+
+This option tells url(bf(nmbd))(nmbd.8.html) when acting as a WINS
+server link(bf((wins support = true)))(winssupport) what the minimum
+'time to live' of NetBIOS names that url(bf(nmbd))(nmbd.8.html) will
+grant will be (in seconds). You should never need to change this
+parameter. The default is 6 hours (21600 seconds).
+
+ bf(Default:)
+tt( min wins ttl = 21600)
+
+
+label(nameresolveorder)
+dit(bf(name resolve order (G)))
+
+This option is used by the programs in the Samba suite to determine
+what naming services and in what order to resolve host names to IP
+addresses. The option takes a space separated string of different name
+resolution options.
+
+The options are :"lmhosts", "host", "wins" and "bcast". They cause
+names to be resolved as follows :
+
+startit()
+
+it() bf(lmhosts) : Lookup an IP address in the Samba lmhosts file.
+
+it() bf(host) : Do a standard host name to IP address resolution,
+using the system /etc/hosts, NIS, or DNS lookups. This method of name
+resolution is operating system depended for instance on IRIX or
+Solaris this may be controlled by the em(/etc/nsswitch.conf) file).
+
+it() bf(wins) : Query a name with the IP address listed in the
+link(bf(wins server))(winsserver) parameter. If no WINS server has
+been specified this method will be ignored.
+
+it() bf(bcast) : Do a broadcast on each of the known local interfaces
+listed in the link(bf(interfaces))(interfaces) parameter. This is the
+least reliable of the name resolution methods as it depends on the
+target host being on a locally connected subnet.
+
+endit()
+
+ bf(Default:)
+tt( name resolve order = lmhosts host wins bcast)
+
+ bf(Example:)
+tt( name resolve order = lmhosts bcast host)
+
+This will cause the local lmhosts file to be examined first, followed
+by a broadcast attempt, followed by a normal system hostname lookup.
+
+label(netbiosaliases)
+dit(bf(netbios aliases (G)))
+
+This is a list of NetBIOS names that url(bf(nmbd))(nmbd.8.html) will
+advertise as additional names by which the Samba server is known. This
+allows one machine to appear in browse lists under multiple names. If
+a machine is acting as a link(bf(browse server))(localmaster) or
+link(bf(logon server))(domainlogons) none of these names will be
+advertised as either browse server or logon servers, only the primary
+name of the machine will be advertised with these capabilities.
+
+See also link(bf("netbios name"))(netbiosname).
+
+ bf(Default:)
+tt( empty string (no additional names))
+
+ bf(Example:)
+tt( netbios aliases = TEST TEST1 TEST2)
+
+label(netbiosname)
+dit(bf(netbios name (G)))
+
+This sets the NetBIOS name by which a Samba server is known. By
+default it is the same as the first component of the host's DNS name.
+If a machine is a link(bf(browse server))(localmaster) or
+link(bf(logon server))(domainlogons) this name (or the first component
+of the hosts DNS name) will be the name that these services are
+advertised under.
+
+See also link(bf("netbios aliases"))(netbiosaliases).
+
+ bf(Default:)
+tt( Machine DNS name.)
+
+ bf(Example:)
+tt( netbios name = MYNAME)
+
+label(nishomedir)
+dit(bf(nis homedir (G)))
+
+Get the home share server from a NIS map. For UNIX systems that use an
+automounter, the user's home directory will often be mounted on a
+workstation on demand from a remote server.
+
+When the Samba logon server is not the actual home directory server,
+but is mounting the home directories via NFS then two network hops
+would be required to access the users home directory if the logon
+server told the client to use itself as the SMB server for home
+directories (one over SMB and one over NFS). This can be very
+slow.
+
+This option allows Samba to return the home share as being on a
+different server to the logon server and as long as a Samba daemon is
+running on the home directory server, it will be mounted on the Samba
+client directly from the directory server. When Samba is returning the
+home share to the client, it will consult the NIS map specified in
+link(bf("homedir map"))(homedirmap) and return the server listed
+there.
+
+Note that for this option to work there must be a working NIS
+system and the Samba server with this option must also be a
+link(bf(logon server))(domainlogons).
+
+ bf(Default:)
+tt( nis homedir = false)
+
+ bf(Example:)
+tt( nis homedir = true)
+
+label(ntpipesupport)
+dit(bf(nt pipe support (G)))
+
+This boolean parameter controls whether url(bf(smbd))(smbd.8.html)
+will allow Windows NT clients to connect to the NT SMB specific
+tt(IPC$) pipes. This is a developer debugging option and can be left
+alone.
+
+ bf(Default:)
+tt( nt pipe support = yes)
+
+label(ntsmbsupport)
+dit(bf(nt smb support (G)))
+
+This boolean parameter controls whether url(bf(smbd))(smbd.8.html)
+will negotiate NT specific SMB support with Windows NT
+clients. Although this is a developer debugging option and should be
+left alone, benchmarking has discovered that Windows NT clients give
+faster performance with this option set to tt("no"). This is still
+being investigated. If this option is set to tt("no") then Samba
+offers exactly the same SMB calls that versions prior to Samba2.0
+offered. This information may be of use if any users are having
+problems with NT SMB support.
+
+ bf(Default:)
+tt( nt support = yes)
+
+label(nullpasswords)
+dit(bf(null passwords (G)))
+
+Allow or disallow client access to accounts that have null passwords.
+
+See also url(bf(smbpasswd (5)))(smbpasswd.5.html).
+
+ bf(Default:)
+tt( null passwords = no)
+
+ bf(Example:)
+tt( null passwords = yes)
+
+label(olelockingcompatibility)
+dit(bf(ole locking compatibility (G)))
+
+This parameter allows an administrator to turn off the byte range lock
+manipulation that is done within Samba to give compatibility for OLE
+applications. Windows OLE applications use byte range locking as a
+form of inter-process communication, by locking ranges of bytes around
+the 2^32 region of a file range. This can cause certain UNIX lock
+managers to crash or otherwise cause problems. Setting this parameter
+to tt("no") means you trust your UNIX lock manager to handle such cases
+correctly.
+
+ bf(Default:)
+tt( ole locking compatibility = yes)
+
+ bf(Example:)
+tt( ole locking compatibility = no)
+
+label(onlyguest)
+dit(bf(only guest (S)))
+
+A synonym for link(bf("guest only"))(guestonly).
+
+label(onlyuser)
+dit(bf(only user (S)))
+
+This is a boolean option that controls whether connections with
+usernames not in the link(bf(user=))(user) list will be allowed. By
+default this option is disabled so a client can supply a username to
+be used by the server.
+
+Note that this also means Samba won't try to deduce usernames from the
+service name. This can be annoying for the link(bf([homes]))(homes)
+section. To get around this you could use "link(bf(user))(user) =
+link(bf(%S))(percentS)" which means your link(bf("user"))(user) list
+will be just the service name, which for home directories is the name
+of the user.
+
+See also the link(bf(user))(user) parameter.
+
+ bf(Default:)
+tt( only user = False)
+
+ bf(Example:)
+tt( only user = True)
+
+label(oplocks)
+dit(bf(oplocks (S)))
+
+This boolean option tells smbd whether to issue oplocks (opportunistic
+locks) to file open requests on this share. The oplock code can
+dramatically (approx. 30% or more) improve the speed of access to files
+on Samba servers. It allows the clients to aggressively cache files
+locally and you may want to disable this option for unreliable network
+environments (it is turned on by default in Windows NT Servers). For
+more information see the file Speed.txt in the Samba docs/ directory.
+
+Oplocks may be selectively turned off on certain files on a per share basis.
+See the 'veto oplock files' parameter. On some systems oplocks are recognized
+by the underlying operating system. This allows data synchronization between
+all access to oplocked files, whether it be via Samba or NFS or a local
+UNIX process. See the link(bf(kernel oplocks))(kerneloplocks) parameter
+for details.
+
+ bf(Default:)
+tt( oplocks = True)
+
+ bf(Example:)
+tt( oplocks = False)
+
+label(oslevel)
+dit(bf(os level (G)))
+
+This integer value controls what level Samba advertises itself as for
+browse elections. The value of this parameter determines whether
+url(bf(nmbd))(nmbd.8.html) has a chance of becoming a local master
+browser for the link(bf(WORKGROUP))(workgroup) in the local broadcast
+area. The default is zero, which means url(bf(nmbd))(nmbd.8.html) will
+lose elections to Windows machines. See BROWSING.txt in the Samba
+docs/ directory for details.
+
+ bf(Default:)
+tt( os level = 0)
+
+ bf(Example:)
+tt( os level = 65 ; This will win against any NT Server)
+
+label(packetsize)
+dit(bf(packet size (G)))
+
+This is a deprecated parameter that how no effect on the current
+Samba code. It is left in the parameter list to prevent breaking
+old bf(smb.conf) files.
+
+label(panicaction)
+dit(bf(panic action (G)))
+
+This is a Samba developer option that allows a system command to be
+called when either url(bf(smbd))(smbd.8.html) or
+url(bf(nmbd))(nmbd.8.html) crashes. This is usually used to draw
+attention to the fact that a problem occurred.
+
+ bf(Default:)
+tt( panic action = <empty string>)
+
+label(passwdchat)
+dit(bf(passwd chat (G)))
+
+This string controls the em("chat") conversation that takes places
+between url(bf(smbd))(smbd.8.html) and the local password changing
+program to change the users password. The string describes a sequence
+of response-receive pairs that url(bf(smbd))(smbd.8.html) uses to
+determine what to send to the link(bf(passwd))(passwdprogram) program
+and what to expect back. If the expected output is not received then
+the password is not changed.
+
+This chat sequence is often quite site specific, depending on what
+local methods are used for password control (such as NIS etc).
+
+The string can contain the macros tt("%o") and tt("%n") which are
+substituted for the old and new passwords respectively. It can also
+contain the standard macros tt("\n"), tt("\r"), tt("\t") and tt("\s")
+to give line-feed, carriage-return, tab and space.
+
+The string can also contain a tt('*') which matches any sequence of
+characters.
+
+Double quotes can be used to collect strings with spaces in them into
+a single string.
+
+If the send string in any part of the chat sequence is a fullstop
+tt(".") then no string is sent. Similarly, is the expect string is a
+fullstop then no string is expected.
+
+Note that if the link(bf("unix password sync"))(unixpasswordsync)
+parameter is set to true, then this sequence is called em(*AS ROOT*)
+when the SMB password in the smbpasswd file is being changed, without
+access to the old password cleartext. In this case the old password
+cleartext is set to tt("") (the empty string).
+
+See also link(bf("unix password sync"))(unixpasswordsync),
+link(bf("passwd program"))(passwdprogram) and link(bf("passwd chat
+debug"))(passwdchatdebug).
+
+ bf(Example:)
+verb( passwd chat = "*Enter OLD password*" %o\n "*Enter NEW password*" %n\n \
+ "*Reenter NEW password*" %n\n "*Password changed*"
+)
+
+ bf(Default:)
+verb( passwd chat = *old*password* %o\n *new*password* %n\n *new*password* %n\n *changed*)
+
+label(passwdchatdebug)
+dit(bf(passwd chat debug (G)))
+
+This boolean specifies if the passwd chat script parameter is run in
+tt("debug") mode. In this mode the strings passed to and received from
+the passwd chat are printed in the url(bf(smbd))(smbd.8.html) log with
+a link(bf("debug level"))(debuglevel) of 100. This is a dangerous
+option as it will allow plaintext passwords to be seen in the
+url(bf(smbd))(smbd.8.html) log. It is available to help Samba admins
+debug their link(bf("passwd chat"))(passwdchat) scripts when calling
+the link(bf("passwd program"))(passwdprogram) and should be turned off
+after this has been done. This parameter is off by default.
+
+See also link(bf("passwd chat"))(passwdchat"), link(bf("passwd
+program"))(passwdprogram).
+
+ bf(Example:)
+tt( passwd chat debug = True)
+
+ bf(Default:)
+tt( passwd chat debug = False)
+
+label(passwdprogram)
+dit(bf(passwd program (G)))
+
+The name of a program that can be used to set UNIX user passwords.
+Any occurrences of link(bf(%u))(percentu) will be replaced with the
+user name. The user name is checked for existence before calling the
+password changing program.
+
+Also note that many passwd programs insist in em("reasonable")
+passwords, such as a minimum length, or the inclusion of mixed case
+chars and digits. This can pose a problem as some clients (such as
+Windows for Workgroups) uppercase the password before sending it.
+
+em(Note) that if the link(bf("unix password sync"))(unixpasswordsync)
+parameter is set to tt("True") then this program is called em(*AS
+ROOT*) before the SMB password in the
+url(bf(smbpasswd))(smbpasswd.5.html) file is changed. If this UNIX
+password change fails, then url(bf(smbd))(smbd.8.html) will fail to
+change the SMB password also (this is by design).
+
+If the link(bf("unix password sync"))(unixpasswordsync) parameter is
+set this parameter em(MUST USE ABSOLUTE PATHS) for em(ALL) programs
+called, and must be examined for security implications. Note that by
+default link(bf("unix password sync"))(unixpasswordsync) is set to
+tt("False").
+
+See also link(bf("unix password sync"))(unixpasswordsync).
+
+ bf(Default:)
+tt( passwd program = /bin/passwd)
+
+ bf(Example:)
+tt( passwd program = /sbin/passwd %u)
+
+label(passwordlevel)
+dit(bf(password level (G)))
+
+Some client/server combinations have difficulty with mixed-case
+passwords. One offending client is Windows for Workgroups, which for
+some reason forces passwords to upper case when using the LANMAN1
+protocol, but leaves them alone when using COREPLUS!
+
+This parameter defines the maximum number of characters that may be
+upper case in passwords.
+
+For example, say the password given was tt("FRED"). If bf(password
+level) is set to 1, the following combinations would be tried if
+tt("FRED") failed:
+
+tt("Fred"), tt("fred"), tt("fRed"), tt("frEd"), tt("freD")
+
+If bf(password level) was set to 2, the following combinations would
+also be tried:
+
+tt("FRed"), tt("FrEd"), tt("FreD"), tt("fREd"), tt("fReD"),
+tt("frED"), tt(..)
+
+And so on.
+
+The higher value this parameter is set to the more likely it is that a
+mixed case password will be matched against a single case
+password. However, you should be aware that use of this parameter
+reduces security and increases the time taken to process a new
+connection.
+
+A value of zero will cause only two attempts to be made - the password
+as is and the password in all-lower case.
+
+ bf(Default:)
+tt( password level = 0)
+
+ bf(Example:)
+tt( password level = 4)
+
+label(passwordserver)
+dit(bf(password server (G)))
+
+By specifying the name of another SMB server (such as a WinNT box)
+with this option, and using link(bf("security = domain"))(security) or
+link(bf("security = server"))(security) you can get Samba to do all
+its username/password validation via a remote server.
+
+This options sets the name of the password server to use. It must be a
+NetBIOS name, so if the machine's NetBIOS name is different from its
+internet name then you may have to add its NetBIOS name to the lmhosts
+file which is stored in the same directory as the bf(smb.conf) file.
+
+The name of the password server is looked up using the parameter
+link(bf("name resolve order="))(nameresolveorder) and so may resolved
+by any method and order described in that parameter.
+
+The password server much be a machine capable of using the "LM1.2X002"
+or the "LM NT 0.12" protocol, and it must be in user level security
+mode.
+
+NOTE: Using a password server means your UNIX box (running Samba) is
+only as secure as your password server. em(DO NOT CHOOSE A PASSWORD
+SERVER THAT YOU DON'T COMPLETELY TRUST).
+
+Never point a Samba server at itself for password serving. This will
+cause a loop and could lock up your Samba server!
+
+The name of the password server takes the standard substitutions, but
+probably the only useful one is link(bf(%m))(percentm), which means
+the Samba server will use the incoming client as the password
+server. If you use this then you better trust your clients, and you
+better restrict them with hosts allow!
+
+If the link(bf("security"))(security) parameter is set to
+bf("domain"), then the list of machines in this option must be a list
+of Primary or Backup Domain controllers for the
+link(bf(Domain))(workgroup), as the Samba server is cryptographicly
+in that domain, and will use cryptographicly authenticated RPC calls
+to authenticate the user logging on. The advantage of using
+link(bf("security=domain"))(securityequaldomain) is that if you list
+several hosts in the bf("password server") option then
+url(bf(smbd))(smbd.8.html) will try each in turn till it finds one
+that responds. This is useful in case your primary server goes down.
+
+If the link(bf("security"))(security) parameter is set to
+link(bf("server"))(securityequalserver), then there are different
+restrictions that link(bf("security=domain"))(securityequaldomain)
+doesn't suffer from:
+
+startit()
+
+it() You may list several password servers in the bf("password server")
+parameter, however if an url(bf(smbd))(smbd.8.html) makes a connection
+to a password server, and then the password server fails, no more
+users will be able to be authenticated from this
+url(bf(smbd))(smbd.8.html). This is a restriction of the SMB/CIFS
+protocol when in link(bf("security=server"))(securityequalserver) mode
+and cannot be fixed in Samba.
+
+it() If you are using a Windows NT server as your password server then
+you will have to ensure that your users are able to login from the
+Samba server, as when in
+link(bf("security=server"))(securityequalserver) mode the network
+logon will appear to come from there rather than from the users
+workstation.
+
+endit()
+
+See also the link(bf("security"))(security) parameter.
+
+ bf(Default:)
+tt( password server = <empty string>)
+
+ bf(Example:)
+tt( password server = NT-PDC, NT-BDC1, NT-BDC2)
+
+label(path)
+dit(bf(path (S)))
+
+This parameter specifies a directory to which the user of the service
+is to be given access. In the case of printable services, this is
+where print data will spool prior to being submitted to the host for
+printing.
+
+For a printable service offering guest access, the service should be
+readonly and the path should be world-writeable and have the sticky bit
+set. This is not mandatory of course, but you probably won't get the
+results you expect if you do otherwise.
+
+Any occurrences of link(bf(%u))(percentu) in the path will be replaced
+with the UNIX username that the client is using on this
+connection. Any occurrences of link(bf(%m))(percentm) will be replaced
+by the NetBIOS name of the machine they are connecting from. These
+replacements are very useful for setting up pseudo home directories
+for users.
+
+Note that this path will be based on link(bf("root dir"))(rootdir) if
+one was specified.
+
+ bf(Default:)
+tt( none)
+
+ bf(Example:)
+tt( path = /home/fred)
+
+label(postexec)
+dit(bf(postexec (S)))
+
+This option specifies a command to be run whenever the service is
+disconnected. It takes the usual substitutions. The command may be run
+as the root on some systems.
+
+An interesting example may be do unmount server resources:
+
+tt(postexec = /etc/umount /cdrom)
+
+See also link(bf(preexec))(preexec).
+
+ bf(Default:)
+tt( none (no command executed))
+
+ bf(Example:)
+tt( postexec = echo "%u disconnected from %S from %m (%I)" >> /tmp/log)
+
+label(postscript)
+dit(bf(postscript (S)))
+
+This parameter forces a printer to interpret the print files as
+postscript. This is done by adding a tt(%!) to the start of print output.
+
+This is most useful when you have lots of PCs that persist in putting
+a control-D at the start of print jobs, which then confuses your
+printer.
+
+ bf(Default:)
+tt( postscript = False)
+
+ bf(Example:)
+tt( postscript = True)
+
+label(preexec)
+dit(bf(preexec (S)))
+
+This option specifies a command to be run whenever the service is
+connected to. It takes the usual substitutions.
+
+An interesting example is to send the users a welcome message every
+time they log in. Maybe a message of the day? Here is an example:
+
+verb(
+ preexec = csh -c 'echo \"Welcome to %S!\" | \
+ /usr/local/samba/bin/smbclient -M %m -I %I' &
+)
+
+Of course, this could get annoying after a while :-)
+
+See also link(bf(postexec))(postexec).
+
+ bf(Default:)
+tt( none (no command executed))
+
+ bf(Example:)
+tt( preexec = echo \"%u connected to %S from %m (%I)\" >> /tmp/log)
+
+label(preferredmaster)
+dit(bf(preferred master (G)))
+
+This boolean parameter controls if url(bf(nmbd))(nmbd.8.html) is a
+preferred master browser for its workgroup.
+
+If this is set to true, on startup, url(bf(nmbd))(nmbd.8.html) will
+force an election, and it will have a slight advantage in winning the
+election. It is recommended that this parameter is used in
+conjunction with link(bf("domain master = yes"))(domainmaster), so
+that url(bf(nmbd))(nmbd.8.html) can guarantee becoming a domain
+master.
+
+Use this option with caution, because if there are several hosts
+(whether Samba servers, Windows 95 or NT) that are preferred master
+browsers on the same subnet, they will each periodically and
+continuously attempt to become the local master browser. This will
+result in unnecessary broadcast traffic and reduced browsing
+capabilities.
+
+See also link(bf(os level))(oslevel).
+
+ bf(Default:)
+tt( preferred master = no)
+
+ bf(Example:)
+tt( preferred master = yes)
+
+label(preferedmaster)
+dit(bf(prefered master (G)))
+
+Synonym for link(bf("preferred master"))(preferredmaster) for people
+who cannot spell :-).
+
+label(preload)
+dit(bf(preload))
+Synonym for link(bf("auto services"))(autoservices).
+
+label(preservecase)
+dit(bf(preserve case (S)))
+
+This controls if new filenames are created with the case that the
+client passes, or if they are forced to be the tt("default") case.
+
+ bf(Default:)
+tt( preserve case = yes)
-.B Example:
- max xmit = 8192
+See the section on link(bf("NAME MANGLING"))(NAMEMANGLING) for a
+fuller discussion.
-.SS message command (G)
+label(printcommand)
+dit(bf(print command (S)))
-This specifies what command to run when the server receives a WinPopup
-style message.
+After a print job has finished spooling to a service, this command
+will be used via a tt(system()) call to process the spool
+file. Typically the command specified will submit the spool file to
+the host's printing subsystem, but there is no requirement that this
+be the case. The server will not remove the spool file, so whatever
+command you specify should remove the spool file when it has been
+processed, otherwise you will need to manually remove old spool files.
-This would normally be a command that would deliver the message
-somehow. How this is to be done is up to your imagination.
+The print command is simply a text string. It will be used verbatim,
+with two exceptions: All occurrences of tt("%s") will be replaced by
+the appropriate spool file name, and all occurrences of tt("%p") will
+be replaced by the appropriate printer name. The spool file name is
+generated automatically by the server, the printer name is discussed
+below.
-What I use is:
+The full path name will be used for the filename if tt("%s") is not
+preceded by a tt('/'). If you don't like this (it can stuff up some
+lpq output) then use tt("%f") instead. Any occurrences of tt("%f") get
+replaced by the spool filename without the full path at the front.
- message command = csh -c 'xedit %s;rm %s' &
+The print command em(MUST) contain at least one occurrence of tt("%s")
+or tt("%f") - the tt("%p") is optional. At the time a job is
+submitted, if no printer name is supplied the tt("%p") will be
+silently removed from the printer command.
-This delivers the message using xedit, then removes it
-afterwards. NOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN
-IMMEDIATELY. That's why I have the & on the end. If it doesn't return
-immediately then your PCs may freeze when sending messages (they
-should recover after 30secs, hopefully).
+If specified in the link(bf("[global]"))(global) section, the print
+command given will be used for any printable service that does not
+have its own print command specified.
-All messages are delivered as the global guest user. The command takes
-the standard substitutions, although %u won't work (%U may be better
-in this case).
+If there is neither a specified print command for a printable service
+nor a global print command, spool files will be created but not
+processed and (most importantly) not removed.
-Apart from the standard substitutions, some additional ones apply. In
-particular:
+Note that printing may fail on some UNIXs from the tt("nobody")
+account. If this happens then create an alternative guest account that
+can print and set the link(bf("guest account"))(guestaccount) in the
+link(bf("[global]"))(global) section.
-%s = the filename containing the message
+You can form quite complex print commands by realizing that they are
+just passed to a shell. For example the following will log a print
+job, print the file, then remove it. Note that tt(';') is the usual
+separator for command in shell scripts.
-%t = the destination that the message was sent to (probably the server
-name)
+tt(print command = echo Printing %s >> /tmp/print.log; lpr -P %p %s; rm %s)
-%f = who the message is from
+You may have to vary this command considerably depending on how you
+normally print files on your system. The default for the parameter
+varies depending on the setting of the link(bf("printing="))(printing)
+parameter.
-You could make this command send mail, or whatever else takes your
-fancy. Please let me know of any really interesting ideas you have.
+ bf(Default:)
+ For link(bf("printing="))(printing) BSD, AIX, QNX, LPRNG or PLP :
+tt( print command = lpr -r -P%p %s)
-Here's a way of sending the messages as mail to root:
+ For link(bf("printing="))(printing) SYS or HPUX :
+tt( print command = lp -c -d%p %s; rm %s)
-message command = /bin/mail -s 'message from %f on %m' root < %s; rm %s
+ For link(bf("printing="))(printing) SOFTQ :
+tt( print command = lp -d%p -s %s; rm %s)
-If you don't have a message command then the message won't be
-delivered and Samba will tell the sender there was an
-error. Unfortunately WfWg totally ignores the error code and carries
-on regardless, saying that the message was delivered.
+ bf(Example:)
+tt( print command = /usr/local/samba/bin/myprintscript %p %s)
-If you want to silently delete it then try "message command = rm %s".
+label(printok)
+dit(bf(print ok (S)))
-For the really adventurous, try something like this:
+Synonym for link(bf(printable))(printable).
-message command = csh -c 'csh < %s |& /usr/local/samba/bin/smbclient \e
- -M %m; rm %s' &
+label(printable)
+dit(bf(printable (S)))
-this would execute the command as a script on the server, then give
-them the result in a WinPopup message. Note that this could cause a
-loop if you send a message from the server using smbclient! You better
-wrap the above in a script that checks for this :-)
+If this parameter is tt("yes"), then clients may open, write to and
+submit spool files on the directory specified for the service.
-.B Default:
- no message command
+Note that a printable service will ALWAYS allow writing to the service
+path (user privileges permitting) via the spooling of print data. The
+link(bf("read only"))(readonly) parameter controls only non-printing
+access to the resource.
-.B Example:
- message command = csh -c 'xedit %s;rm %s' &
+ bf(Default:)
+tt( printable = no)
-.SS min print space (S)
+ bf(Example:)
+tt( printable = yes)
-This sets the minimum amount of free disk space that must be available
-before a user will be able to spool a print job. It is specified in
-kilobytes. The default is 0, which means no limit.
+label(printcap)
+dit(bf(printcap (G)))
-.B Default:
- min print space = 0
+Synonym for link(bf(printcapname))(printcapname).
-.B Example:
- min print space = 2000
+label(printcapname)
+dit(bf(printcap name (G)))
-.SS min wins ttl (G)
+This parameter may be used to override the compiled-in default
+printcap name used by the server (usually /etc/printcap). See the
+discussion of the link(bf([printers]))(printers) section above for
+reasons why you might want to do this.
-This option tells nmbd when acting as a WINS server (wins support = true)
-what the minimum 'time to live' of NetBIOS names that nmbd will grant will
-be (in seconds). You should never need to change this parameter.
-The default is 6 hours (21600 seconds).
+On System V systems that use bf(lpstat) to list available printers you
+can use tt("printcap name = lpstat") to automatically obtain lists of
+available printers. This is the default for systems that define SYSV
+at configure time in Samba (this includes most System V based
+systems). If bf("printcap name") is set to bf(lpstat) on these systems
+then Samba will launch tt("lpstat -v") and attempt to parse the output
+to obtain a printer list.
-.B Default:
- min wins ttl = 21600
+A minimal printcap file would look something like this:
-.SS name resolve order (G)
+verb(
+ print1|My Printer 1
+ print2|My Printer 2
+ print3|My Printer 3
+ print4|My Printer 4
+ print5|My Printer 5
+)
-This option is used by the programs smbd, nmbd and smbclient to determine
-what naming services and in what order to resolve host names to IP addresses.
-This option is most useful in smbclient. The option takes a space separated
-string of different name resolution options. These are "lmhosts", "host",
-"wins" and "bcast". They cause names to be resolved as follows :
+where the tt('|') separates aliases of a printer. The fact that the
+second alias has a space in it gives a hint to Samba that it's a
+comment.
-lmhosts : Lookup an IP address in the Samba lmhosts file.
-host : Do a standard host name to IP address resolution, using the
- system /etc/hosts, NIS, or DNS lookups. This method of name
- resolution is operating system depended (for instance on Solaris
- this may be controlled by the /etc/nsswitch.conf file).
-wins : Query a name with the IP address listed in the "wins server ="
- parameter. If no WINS server has been specified this method will
- be ignored.
-bcast : Do a broadcast on each of the known local interfaces listed in
- the "interfaces =" parameter. This is the least reliable of the
- name resolution methods as it depends on the target host being
- on a locally connected subnet.
+em(NOTE): Under AIX the default printcap name is
+tt("/etc/qconfig"). Samba will assume the file is in AIX tt("qconfig")
+format if the string tt("/qconfig") appears in the printcap filename.
-The default order is lmhosts, host, wins, bcast and these name resolution
-methods will be attempted in this order.
+ bf(Default:)
+tt( printcap name = /etc/printcap)
-This option was first introduced in Samba 1.9.18p4.
+ bf(Example:)
+tt( printcap name = /etc/myprintcap)
-.B Default:
- name resolve order = lmhosts host wins bcast
+label(printer)
+dit(bf(printer (S)))
-.Example:
- name resolve order = lmhosts bcast host
+This parameter specifies the name of the printer to which print jobs
+spooled through a printable service will be sent.
-This will cause the local lmhosts file to be examined first, followed
-by a broadcast attempt, followed by a normal system hostname lookup.
+If specified in the link(bf([global]))(global) section, the printer
+name given will be used for any printable service that does not have
+its own printer name specified.
-.SS netbios aliases (G)
+ bf(Default:)
+ none (but may be tt("lp") on many systems)
-This is a list of names that nmbd will advertise as additional
-names by which the Samba server is known. This allows one machine
-to appear in browse lists under multiple names. If a machine is
-acting as a browse server or logon server none of these names
-will be advertised as either browse server or logon servers, only
-the primary name of the machine will be advertised with these
-capabilities.
+ bf(Example:)
+ printer name = laserwriter
-See also 'netbios name'.
+label(printerdriver)
+dit(bf(printer driver (S)))
-.B Example:
- netbios aliases = TEST TEST1 TEST2
+This option allows you to control the string that clients receive when
+they ask the server for the printer driver associated with a
+printer. If you are using Windows95 or WindowsNT then you can use this
+to automate the setup of printers on your system.
-.SS netbios name (G)
+You need to set this parameter to the exact string (case sensitive)
+that describes the appropriate printer driver for your system. If you
+don't know the exact string to use then you should first try with no
+bf("printer driver") option set and the client will give you a list of
+printer drivers. The appropriate strings are shown in a scrollbox
+after you have chosen the printer manufacturer.
-This sets the NetBIOS name by which a Samba server is known. By
-default it is the same as the first component of the host's DNS name.
-If a machine is a browse server or logon server this name (or the
-first component of the hosts DNS name) will be the name that these
-services are advertised under.
-
-See also 'netbios aliases'.
-
-.B Example:
- netbios name = MYNAME
-
-.SS nis homedir (G)
-Get the home share server from a NIS (or YP) map. For unix systems that
-use an automounter, the user's home directory will often be mounted on
-a workstation on demand from a remote server. When the Samba logon server
-is not the actual home directory server, two network hops are required
-to access the home directory and this can be very slow especially with
-writing via Samba to an NFS mounted directory. This option allows samba
-to return the home share as being on a different server to the logon
-server and as long as a samba daemon is running on the home directory
-server, it will be mounted on the Samba client directly from the directory
-server. When Samba is returning the home share to the client, it will
-consult the NIS (or YP) map specified in "homedir map" and return the
-server listed there.
-
-.B Default:
- nis homedir = false
-
-.B Example:
- nis homedir = true
-
-.SS networkstation user login (G)
-This global parameter (new for 1.9.18p3) affects server level security.
-With this set (recommended) samba will do a full NetWkstaUserLogon to
-confirm that the client really should have login rights. This can cause
-problems with machines in trust relationships in which case you can
-disable it here, but be warned, we have heard that some NT machines
-will then allow anyone in with any password! Make sure you test it.
-
-In Samba 1.9.18p5 this parameter is of limited use, as smbd now
-explicitly tests for this NT bug and will refuse to use a password
-server that has the problem. The parameter now defaults to off,
-and it should not be neccessary to set this parameter to on. It will
-be removed in a future Samba release.
-
-.B Default:
- networkstation user login = no
-
-.B Example:
- networkstation user login = yes
-
-.SS null passwords (G)
-Allow or disallow access to accounts that have null passwords.
-
-.B Default:
- null passwords = no
-
-.B Example:
- null passwords = yes
-
-.SS ole locking compatibility (G)
-
-This parameter allows an administrator to turn off the byte range
-lock manipulation that is done within Samba to give compatibility
-for OLE applications. Windows OLE applications use byte range locking
-as a form of inter-process communication, by locking ranges of bytes
-around the 2^32 region of a file range. This can cause certain UNIX
-lock managers to crash or otherwise cause problems. Setting this
-parameter to "no" means you trust your UNIX lock manager to handle
-such cases correctly.
-
-.B Default:
- ole locking compatibility = yes
-
-.B Example:
- ole locking compatibility = no
-
-
-.SS only guest (S)
-A synonym for this command is 'guest only'.
-
-.SS only user (S)
-This is a boolean option that controls whether connections with
-usernames not in the user= list will be allowed. By default this
-option is disabled so a client can supply a username to be used by
-the server.
+See also link(bf("printer driver file"))(printerdriverfile).
-Note that this also means Samba won't try to deduce usernames from the
-service name. This can be annoying for the [homes] section. To get
-around this you could use "user = %S" which means your "user" list
-will be just the service name, which for home directories is the name
-of the user.
+ bf(Example:)
+ printer driver = HP LaserJet 4L
-.B Default:
- only user = False
+label(printerdriverfile)
+dit(bf(printer driver file (G)))
-.B Example:
- only user = True
+This parameter tells Samba where the printer driver definition file,
+used when serving drivers to Windows 95 clients, is to be found. If
+this is not set, the default is :
-.SS oplocks (S)
-This boolean option tells smbd whether to issue oplocks (opportunistic
-locks) to file open requests on this share. The oplock code was introduced in
-Samba 1.9.18 and can dramatically (approx 30% or more) improve the speed
-of access to files on Samba servers. It allows the clients to agressively
-cache files locally and you may want to disable this option for unreliable
-network environments (it is turned on by default in Windows NT Servers).
-For more information see the file Speed.txt in the Samba docs/ directory.
+tt(SAMBA_INSTALL_DIRECTORY/lib/printers.def)
-Oplocks may be selectively turned off on certain files on a per share basis.
-See the 'veto oplock files' parameter.
+This file is created from Windows 95 tt("msprint.def") files found on
+the Windows 95 client system. For more details on setting up serving
+of printer drivers to Windows 95 clients, see the documentation file
+in the docs/ directory, PRINTER_DRIVER.txt.
-.B Default:
- oplocks = True
+ bf(Default:)
+tt( None (set in compile).)
-.B Example:
- oplocks = False
+ bf(Example:)
+tt( printer driver file = /usr/local/samba/printers/drivers.def)
+See also link(bf("printer driver location"))(printerdriverlocation).
-.SS os level (G)
-This integer value controls what level Samba advertises itself as for
-browse elections. See BROWSING.txt for details.
-
-.SS packet size (G)
-The maximum transmit packet size during a raw read. This option is no
-longer implemented as of version 1.7.00, and is kept only so old
-configuration files do not become invalid.
-
-.SS passwd chat (G)
-This string controls the "chat" conversation that takes places
-between smbd and the local password changing program to change the
-users password. The string describes a sequence of response-receive
-pairs that smbd uses to determine what to send to the passwd program
-and what to expect back. If the expected output is not received then
-the password is not changed.
+label(printerdriverlocation)
+dit(bf(printer driver location (S)))
-This chat sequence is often quite site specific, depending on what
-local methods are used for password control (such as NIS+ etc).
+This parameter tells clients of a particular printer share where to
+find the printer driver files for the automatic installation of
+drivers for Windows 95 machines. If Samba is set up to serve printer
+drivers to Windows 95 machines, this should be set to
-The string can contain the macros %o and %n which are substituted for
-the old and new passwords respectively. It can also contain the
-standard macros \en \er \et and \es to give line-feed, carriage-return,
-tab and space.
+tt(\\MACHINE\aPRINTER$)
-The string can also contain a * which matches any sequence of
-characters.
+Where MACHINE is the NetBIOS name of your Samba server, and PRINTER$
+is a share you set up for serving printer driver files. For more
+details on setting this up see the documentation file in the docs/
+directory, PRINTER_DRIVER.txt.
-Double quotes can be used to collect strings with spaces in them into
-a single string.
+ bf(Default:)
+tt( None)
-If the send string in any part of the chat sequence is a fullstop "."
-then no string is sent. Similarly, is the expect string is a fullstop
-then no string is expected.
+ bf(Example:)
+tt( printer driver location = \\MACHINE\PRINTER$)
-Note that if the 'unix password sync' parameter is set to true,
-then this sequence is called *AS ROOT* when the SMB password in the
-smbpasswd file is being changed, without access to the old password
-cleartext. In this case the old password cleartext is set to ""
-(the empty string).
+See also link(bf("printer driver file"))(printerdriverfile).
-See also 'unix password sync' and 'passwd chat debug'
+label(printername)
+dit(bf(printer name (S)))
-.B Example:
- passwd chat = "*Enter OLD password*" %o\en "*Enter NEW password*" %n\en \e
- "*Reenter NEW password*" %n\en "*Password changed*"
+Synonym for link(bf(printer))(printer).
+label(printing)
+dit(bf(printing (S)))
-.B Default:
- passwd chat = *old*password* %o\en *new*password* %n\en *new*password* %n\en *changed*
+This parameters controls how printer status information is interpreted
+on your system, and also affects the default values for the
+link(bf("print command"))(printcommand), link(bf("lpq
+command"))(lpqcommand) link(bf("lppause command"))(lppausecommand),
+link(bf("lpresume command"))(lpresumecommand), and link(bf("lprm
+command"))(lprmcommand).
+
+Currently eight printing styles are supported. They are
+bf("printing=BSD"), bf("printing=AIX"), bf("printing=LPRNG"),
+bf("printing=PLP"),
+bf("printing=SYSV"),bf("printing="HPUX"),bf("printing=QNX") and
+bf("printing=SOFTQ").
-.SS passwd chat debug (G)
+To see what the defaults are for the other print commands when using
+these three options use the url(bf("testparm"))(testparm) program.
-This boolean specifies if the passwd chat script parameter is run
-in 'debug' mode. In this mode the strings passed to and received
-from the passwd chat are printed in the smbd log with a debug level
-of 100. This is a dangerous option as it will allow plaintext passwords
-to be seen in the smbd log. It is available to help Samba admins
-debug their passwd chat scripts and should be turned off after
-this has been done. This parameter is off by default.
+This option can be set on a per printer basis
-.B Example:
- passwd chat debug = True
+See also the discussion in the link(bf([printers]))(printers) section.
-.B Default:
- passwd chat debug = False
+label(protocol)
+dit(bf(protocol (G)))
-.SS passwd program (G)
-The name of a program that can be used to set user passwords.
+The value of the parameter (a string) is the highest protocol level
+that will be supported by the server.
-This is only available if you have enabled remote password changing at
-compile time (see the comments in the Makefile for details). Any occurrences
-of %u will be replaced with the user name. The user name is checked
-for existance before calling the password changing program.
+Possible values are :
-Also note that many passwd programs insist in "reasonable" passwords,
-such as a minimum length, or the inclusion of mixed case chars and
-digits. This can pose a problem as some clients (such as Windows for
-Workgroups) uppercase the password before sending it.
+startit()
-Note that if the 'unix password sync' parameter is set to true,
-then this sequence is called *AS ROOT* when the SMB password in the
-smbpasswd file is being changed. If the 'unix passwd sync' parameter
-is set this parameter MUST USE ABSOLUTE PATHS for ALL programs called,
-and must be examined for security implications. Note that by default
-'unix password sync' is set to False.
+it() CORE: Earliest version. No concept of user names.
-See also 'unix password sync'
+it() COREPLUS: Slight improvements on CORE for efficiency.
-.B Default:
- passwd program = /bin/passwd
+it() LANMAN1: First em("modern") version of the protocol. Long
+filename support.
-.B Example:
- passwd program = /sbin/passwd %u
+it() LANMAN2: Updates to Lanman1 protocol.
-.SS password level (G)
-Some client/server combinations have difficulty with mixed-case passwords.
-One offending client is Windows for Workgroups, which for some reason forces
-passwords to upper case when using the LANMAN1 protocol, but leaves them alone
-when using COREPLUS!
+it() NT1: Current up to date version of the protocol. Used by Windows
+NT. Known as CIFS.
-This parameter defines the maximum number of characters that may be upper case
-in passwords.
+endit()
-For example, say the password given was "FRED". If
-.B password level
-is set to 1 (one), the following combinations would be tried if "FRED" failed:
-"Fred", "fred", "fRed", "frEd", "freD". If
-.B password level was set to 2 (two), the following combinations would also be
-tried: "FRed", "FrEd", "FreD", "fREd", "fReD", "frED". And so on.
+Normally this option should not be set as the automatic negotiation
+phase in the SMB protocol takes care of choosing the appropriate
+protocol.
-The higher value this parameter is set to the more likely it is that a mixed
-case password will be matched against a single case password. However, you
-should be aware that use of this parameter reduces security and increases the
-time taken to process a new connection.
+ bf(Default:)
+tt( protocol = NT1)
-A value of zero will cause only two attempts to be made - the password as is
-and the password in all-lower case.
+ bf(Example:)
+tt( protocol = LANMAN1)
-If you find the connections are taking too long with this option then
-you probably have a slow crypt() routine. Samba now comes with a fast
-"ufc crypt" that you can select in the Makefile. You should also make
-sure the PASSWORD_LENGTH option is correct for your system in local.h
-and includes.h. On most systems only the first 8 chars of a password
-are significant so PASSWORD_LENGTH should be 8, but on some longer
-passwords are significant. The includes.h file tries to select the
-right length for your system.
+label(public)
+dit(bf(public (S)))
-.B Default:
- password level = 0
+Synonym for link(bf("guest ok"))(guestok).
-.B Example:
- password level = 4
+label(queuepausecommand)
+dit(bf(queuepause command (S)))
-.SS password server (G)
+This parameter specifies the command to be executed on the server host
+in order to pause the printerqueue.
-By specifying the name of another SMB server (such as a WinNT box)
-with this option, and using "security = server" you can get Samba to
-do all its username/password validation via a remote server.
+This command should be a program or script which takes a printer name
+as its only parameter and stops the printerqueue, such that no longer
+jobs are submitted to the printer.
-This options sets the name of the password server to use. It must be a
-netbios name, so if the machine's netbios name is different from its
-internet name then you may have to add its netbios name to
-/etc/hosts.
+This command is not supported by Windows for Workgroups, but can be
+issued from the Printer's window under Windows 95 & NT.
-Note that with Samba 1.9.18p4 and above the name of the password
-server is looked up using the parameter "name resolve order=" and
-so may resolved by any method and order described in that parameter.
+If a tt("%p") is given then the printername is put in its
+place. Otherwise it is placed at the end of the command.
-The password server much be a machine capable of using the "LM1.2X002"
-or the "LM NT 0.12" protocol, and it must be in user level security
-mode.
+Note that it is good practice to include the absolute path in the
+command as the PATH may not be available to the server.
-NOTE: Using a password server means your UNIX box (running Samba) is
-only as secure as your password server. DO NOT CHOOSE A PASSWORD
-SERVER THAT YOU DON'T COMPLETELY TRUST.
+ bf(Default:)
+tt( depends on the setting of "printing =")
-Never point a Samba server at itself for password serving. This will
-cause a loop and could lock up your Samba server!
+ bf(Example:)
+tt( queuepause command = disable %p)
-The name of the password server takes the standard substitutions, but
-probably the only useful one is %m, which means the Samba server will
-use the incoming client as the password server. If you use this then
-you better trust your clients, and you better restrict them with hosts
-allow!
-
-If you list several hosts in the "password server" option then smbd
-will try each in turn till it finds one that responds. This is useful
-in case your primary server goes down.
-
-If you are using a WindowsNT server as your password server then you
-will have to ensure that your users are able to login from the Samba
-server, as the network logon will appear to come from there rather
-than from the users workstation.
-
-.SS path (S)
-A synonym for this parameter is 'directory'.
-
-This parameter specifies a directory to which the user of the service is to
-be given access. In the case of printable services, this is where print data
-will spool prior to being submitted to the host for printing.
-
-For a printable service offering guest access, the service should be readonly
-and the path should be world-writable and have the sticky bit set. This is not
-mandatory of course, but you probably won't get the results you expect if you
-do otherwise.
-
-Any occurrences of %u in the path will be replaced with the username
-that the client is connecting as. Any occurrences of %m will be
-replaced by the name of the machine they are connecting from. These
-replacements are very useful for setting up pseudo home directories
-for users.
+label(queueresumecommand)
+dit(bf(queueresume command (S)))
-Note that this path will be based on 'root dir' if one was specified.
-.B Default:
- none
+This parameter specifies the command to be executed on the server host
+in order to resume the printerqueue. It is the command to undo the
+behavior that is caused by the previous parameter
+(link(bf("queuepause command))(queuepausecommand)).
+
+This command should be a program or script which takes a printer name
+as its only parameter and resumes the printerqueue, such that queued
+jobs are resubmitted to the printer.
-.B Example:
- path = /home/fred+
+This command is not supported by Windows for Workgroups, but can be
+issued from the Printer's window under Windows 95 & NT.
-.SS postexec (S)
+If a tt("%p") is given then the printername is put in its
+place. Otherwise it is placed at the end of the command.
-This option specifies a command to be run whenever the service is
-disconnected. It takes the usual substitutions. The command may be run
-as the root on some systems.
+Note that it is good practice to include the absolute path in the
+command as the PATH may not be available to the server.
-An interesting example may be do unmount server resources:
+ bf(Default:)
+tt( depends on the setting of "printing =")
-postexec = /etc/umount /cdrom
+ bf(Example:)
+tt( queuepause command = enable %p)
-See also preexec
+label(read bmpx)
+dit(bf(read bmpx (G)))
-.B Default:
- none (no command executed)
+This boolean parameter controls whether url(bf(smbd))(smbd.8.html)
+will support the "Read Block Multiplex" SMB. This is now rarely used
+and defaults to off. You should never need to set this parameter.
-.B Example:
- postexec = echo \e"%u disconnected from %S from %m (%I)\e" >> /tmp/log
+ bf(Default:)
+ read bmpx = No
-.SS postscript (S)
-This parameter forces a printer to interpret the print files as
-postscript. This is done by adding a %! to the start of print output.
+label(readlist)
+dit(bf(read list (S)))
-This is most useful when you have lots of PCs that persist in putting
-a control-D at the start of print jobs, which then confuses your
-printer.
+This is a list of users that are given read-only access to a
+service. If the connecting user is in this list then they will not be
+given write access, no matter what the link(bf("read only"))(readonly)
+option is set to. The list can include group names using the syntax
+described in the link(bf("invalid users"))(invalidusers) parameter.
-.B Default:
- postscript = False
+See also the link(bf("write list"))(writelist) parameter and
+the link(bf("invalid users"))(invalidusers) parameter.
-.B Example:
- postscript = True
+ bf(Default:)
+tt( read list = <empty string>)
-.SS preexec (S)
+ bf(Example:)
+tt( read list = mary, @students)
-This option specifies a command to be run whenever the service is
-connected to. It takes the usual substitutions.
+label(readonly)
+dit(bf(read only (S)))
-An interesting example is to send the users a welcome message every
-time they log in. Maybe a message of the day? Here is an example:
+Note that this is an inverted synonym for
+link(bf("writeable"))(writeable) and link(bf("write ok"))(writeok).
-preexec = csh -c 'echo \e"Welcome to %S!\e" | \e
- /usr/local/samba/bin/smbclient -M %m -I %I' &
+See also link(bf("writeable"))(writeable) and link(bf("write
+ok"))(writeok).
-Of course, this could get annoying after a while :-)
+label(readprediction)
+dit(bf(read prediction (G)))
+
+em(NOTE): This code is currently disabled in Samba2.0 and
+may be removed at a later date. Hence this parameter has
+no effect.
+
+This options enables or disables the read prediction code used to
+speed up reads from the server. When enabled the server will try to
+pre-read data from the last accessed file that was opened read-only
+while waiting for packets.
-See also postexec
+ bf(Default:)
+tt( read prediction = False)
-.B Default:
- none (no command executed)
+label(readraw)
+dit(bf(read raw (G)))
-.B Example:
- preexec = echo \e"%u connected to %S from %m (%I)\e" >> /tmp/log
+This parameter controls whether or not the server will support the raw
+read SMB requests when transferring data to clients.
-.SS preferred master (G)
-This boolean parameter controls if Samba is a preferred master browser
-for its workgroup.
-If this is set to true, on startup, samba will force an election,
-and it will have a slight advantage in winning the election.
-It is recommended that this parameter is used in conjunction
-with domain master = yes, so that samba can guarantee becoming
-a domain master.
+If enabled, raw reads allow reads of 65535 bytes in one packet. This
+typically provides a major performance benefit.
-Use this option with caution, because if there are several hosts
-(whether samba servers, Windows 95 or NT) that are preferred master
-browsers on the same subnet, they will each periodically and continuously
-attempt to become the local master browser. This will result in
-unnecessary broadcast traffic and reduced browsing capabilities.
+However, some clients either negotiate the allowable block size
+incorrectly or are incapable of supporting larger block sizes, and for
+these clients you may need to disable raw reads.
-See
-.B os level = nn
+In general this parameter should be viewed as a system tuning tool and left
+severely alone. See also link(bf("write raw"))(writeraw).
-.B Default:
- preferred master = no
+ bf(Default:)
+tt( read raw = yes)
-.SS preload
-This is an alias for "auto services"
+label(readsize)
+dit(bf(read size (G)))
-.SS preserve case (S)
+The option bf("read size") affects the overlap of disk reads/writes
+with network reads/writes. If the amount of data being transferred in
+several of the SMB commands (currently SMBwrite, SMBwriteX and
+SMBreadbraw) is larger than this value then the server begins writing
+the data before it has received the whole packet from the network, or
+in the case of SMBreadbraw, it begins writing to the network before
+all the data has been read from disk.
-This controls if new filenames are created with the case that the
-client passes, or if they are forced to be the "default" case.
+This overlapping works best when the speeds of disk and network access
+are similar, having very little effect when the speed of one is much
+greater than the other.
-.B Default:
- preserve case = no
+The default value is 2048, but very little experimentation has been
+done yet to determine the optimal value, and it is likely that the
+best value will vary greatly between systems anyway. A value over
+65536 is pointless and will cause you to allocate memory
+unnecessarily.
-See the section on "NAME MANGLING" for a fuller discussion.
+ bf(Default:)
+tt( read size = 2048)
-.SS print command (S)
-After a print job has finished spooling to a service, this command will be
-used via a system() call to process the spool file. Typically the command
-specified will submit the spool file to the host's printing subsystem, but
-there is no requirement that this be the case. The server will not remove the
-spool file, so whatever command you specify should remove the spool file when
-it has been processed, otherwise you will need to manually remove old spool
-files.
+ bf(Example:)
+tt( read size = 8192)
-The print command is simply a text string. It will be used verbatim,
-with two exceptions: All occurrences of "%s" will be replaced by the
-appropriate spool file name, and all occurrences of "%p" will be
-replaced by the appropriate printer name. The spool file name is
-generated automatically by the server, the printer name is discussed
-below.
+label(remoteannounce)
+dit(bf(remote announce (G)))
-The full path name will be used for the filename if %s is not preceded
-by a /. If you don't like this (it can stuff up some lpq output) then
-use %f instead. Any occurrences of %f get replaced by the spool
-filename without the full path at the front.
+This option allows you to setup url(bf(nmbd))(nmbd.8.html) to
+periodically announce itself to arbitrary IP addresses with an
+arbitrary workgroup name.
-The print command MUST contain at least one occurrence of "%s" or %f -
-the "%p" is optional. At the time a job is submitted, if no printer
-name is supplied the "%p" will be silently removed from the printer
-command.
+This is useful if you want your Samba server to appear in a remote
+workgroup for which the normal browse propagation rules don't
+work. The remote workgroup can be anywhere that you can send IP
+packets to.
-If specified in the [global] section, the print command given will be used
-for any printable service that does not have its own print command specified.
+For example:
-If there is neither a specified print command for a printable service nor a
-global print command, spool files will be created but not processed and (most
-importantly) not removed.
+tt( remote announce = 192.168.2.255/SERVERS 192.168.4.255/STAFF)
-Note that printing may fail on some UNIXes from the "nobody"
-account. If this happens then create an alternative guest account that
-can print and set the "guest account" in the [global] section.
+the above line would cause nmbd to announce itself to the two given IP
+addresses using the given workgroup names. If you leave out the
+workgroup name then the one given in the
+link(bf("workgroup"))(workgroup) parameter is used instead.
-You can form quite complex print commands by realising that they are
-just passed to a shell. For example the following will log a print
-job, print the file, then remove it. Note that ; is the usual
-separator for command in shell scripts.
+The IP addresses you choose would normally be the broadcast addresses
+of the remote networks, but can also be the IP addresses of known
+browse masters if your network config is that stable.
-print command = echo Printing %s >> /tmp/print.log; lpr -P %p %s; rm %s
+See the documentation file BROWSING.txt in the docs/ directory.
-You may have to vary this command considerably depending on how you
-normally print files on your system.
+ bf(Default:)
+tt( remote announce = <empty string>)
-.B Default:
- print command = lpr -r -P %p %s
+ bf(Example:)
+tt( remote announce = 192.168.2.255/SERVERS 192.168.4.255/STAFF)
-.B Example:
- print command = /usr/local/samba/bin/myprintscript %p %s
-.SS print ok (S)
-See
-.B printable.
-.SS printable (S)
-A synonym for this parameter is 'print ok'.
+label(remotebrowsesync)
+dit(bf(remote browse sync (G)))
-If this parameter is 'yes', then clients may open, write to and submit spool
-files on the directory specified for the service.
+This option allows you to setup url(bf(nmbd))(nmbd.8.html) to
+periodically request synchronization of browse lists with the master
+browser of a samba server that is on a remote segment. This option
+will allow you to gain browse lists for multiple workgroups across
+routed networks. This is done in a manner that does not work with any
+non-samba servers.
-Note that a printable service will ALWAYS allow writing to the service path
-(user privileges permitting) via the spooling of print data. The 'read only'
-parameter controls only non-printing access to the resource.
+This is useful if you want your Samba server and all local clients to
+appear in a remote workgroup for which the normal browse propagation
+rules don't work. The remote workgroup can be anywhere that you can
+send IP packets to.
-.B Default:
- printable = no
+For example:
-.B Example:
- printable = yes
+tt( remote browse sync = 192.168.2.255 192.168.4.255)
-.SS printcap name (G)
-This parameter may be used to override the compiled-in default printcap
-name used by the server (usually /etc/printcap). See the discussion of the
-[printers] section above for reasons why you might want to do this.
+the above line would cause url(bf(nmbd))(nmbd.8.html) to request the
+master browser on the specified subnets or addresses to synchronize
+their browse lists with the local server.
-On SystemV systems that use lpstat to list available printers you
-can use "printcap name = lpstat" to automatically obtain lists of
-available printers. This is the default for systems that define
-SYSV at compile time in Samba (this includes most SystemV based
-systems). If "printcap name" is set to lpstat on these systems then
-Samba will launch "lpstat -v" and attempt to parse the output to
-obtain a printer list.
+The IP addresses you choose would normally be the broadcast addresses
+of the remote networks, but can also be the IP addresses of known
+browse masters if your network config is that stable. If a machine IP
+address is given Samba makes NO attempt to validate that the remote
+machine is available, is listening, nor that it is in fact the browse
+master on it's segment.
-A minimal printcap file would look something like this:
+ bf(Default:)
+tt( remote browse sync = <empty string>)
-print1|My Printer 1
-.br
-print2|My Printer 2
-.br
-print3|My Printer 3
-.br
-print4|My Printer 4
-.br
-print5|My Printer 5
+ bf(Example:)
+tt( remote browse sync = 192.168.2.255 192.168.4.255)
-where the | separates aliases of a printer. The fact that the second
-alias has a space in it gives a hint to Samba that it's a comment.
+label(revalidate)
+dit(bf(revalidate (S)))
-NOTE: Under AIX the default printcap name is "/etc/qconfig". Samba
-will assume the file is in AIX "qconfig" format if the string
-"/qconfig" appears in the printcap filename.
+Note that this option only works with
+link(bf("security=share"))(securityequalshare) and will be ignored if
+this is not the case.
-.B Default:
- printcap name = /etc/printcap
+This option controls whether Samba will allow a previously validated
+username/password pair to be used to attach to a share. Thus if you
+connect to tt(\\server\share1) then to tt(\\server\share2) it won't
+automatically allow the client to request connection to the second
+share as the same username as the first without a password.
-.B Example:
- printcap name = /etc/myprintcap
+If bf("revalidate") is tt("True") then the client will be denied
+automatic access as the same username.
-.SS printer (S)
-A synonym for this parameter is 'printer name'.
+ bf(Default:)
+tt( revalidate = False)
-This parameter specifies the name of the printer to which print jobs spooled
-through a printable service will be sent.
+ bf(Example:)
+tt( revalidate = True)
-If specified in the [global] section, the printer name given will be used
-for any printable service that does not have its own printer name specified.
+label(root)
+dit(bf(root (G)))
-.B Default:
- none (but may be 'lp' on many systems)
+Synonym for link(bf("root directory"))(rootdirectory).
-.B Example:
- printer name = laserwriter
+label(rootdir)
+dit(bf(root dir (G)))
-.SS printer driver (S)
-This option allows you to control the string that clients receive when
-they ask the server for the printer driver associated with a
-printer. If you are using Windows95 or WindowsNT then you can use this
-to automate the setup of printers on your system.
+Synonym for link(bf("root directory"))(rootdirectory).
-You need to set this parameter to the exact string (case sensitive)
-that describes the appropriate printer driver for your system.
-If you don't know the exact string to use then you should first try
-with no "printer driver" option set and the client will give you a
-list of printer drivers. The appropriate strings are shown in a
-scrollbox after you have chosen the printer manufacturer.
+label(rootdirectory)
+dit(bf(root directory (G)))
-.B Example:
- printer driver = HP LaserJet 4L
+The server will tt("chroot()") (i.e. Change it's root directory) to
+this directory on startup. This is not strictly necessary for secure
+operation. Even without it the server will deny access to files not in
+one of the service entries. It may also check for, and deny access to,
+soft links to other parts of the filesystem, or attempts to use
+tt("..") in file names to access other directories (depending on the
+setting of the link(bf("wide links"))(widelinks) parameter).
-.SS printer name (S)
-See
-.B printer.
+Adding a bf("root directory") entry other than tt("/") adds an extra
+level of security, but at a price. It absolutely ensures that no
+access is given to files not in the sub-tree specified in the bf("root
+directory") option, em(*including*) some files needed for complete
+operation of the server. To maintain full operability of the server
+you will need to mirror some system files into the bf("root
+directory") tree. In particular you will need to mirror /etc/passwd
+(or a subset of it), and any binaries or configuration files needed
+for printing (if required). The set of files that must be mirrored is
+operating system dependent.
-.SS printer driver file (G)
-This parameter tells Samba where the printer driver definition file,
-used when serving drivers to Windows 95 clients, is to be found. If
-this is not set, the default is :
+ bf(Default:)
+tt( root directory = /)
-SAMBA_INSTALL_DIRECTORY/lib/printers.def
+bf(Example:)
+tt( root directory = /homes/smb)
-This file is created from Windows 95 'msprint.def' files found on the
-Windows 95 client system. For more details on setting up serving of
-printer drivers to Windows 95 clients, see the documentation file
-docs/PRINTER_DRIVER.txt.
+label(rootpostexec)
+dit(bf(root postexec (S)))
-.B Default:
- None (set in compile).
+This is the same as the link(bf("postexec"))(postexec) parameter
+except that the command is run as root. This is useful for unmounting
+filesystems (such as cdroms) after a connection is closed.
-.B Example:
- printer driver file = /usr/local/samba/printers/drivers.def
+See also link(bf("postexec"))(postexec).
-Related parameters.
-.B printer driver location
+label(rootpreexec)
+dit(bf(root preexec (S)))
-.SS printer driver location (S)
-This parameter tells clients of a particular printer share where
-to find the printer driver files for the automatic installation
-of drivers for Windows 95 machines. If Samba is set up to serve
-printer drivers to Windows 95 machines, this should be set to
+This is the same as the link(bf("preexec"))(preexec) parameter except
+that the command is run as root. This is useful for mounting
+filesystems (such as cdroms) before a connection is finalized.
-\e\eMACHINE\ePRINTER$
+See also link(bf("preexec"))(preexec).
-Where MACHINE is the NetBIOS name of your Samba server, and PRINTER$
-is a share you set up for serving printer driver files. For more
-details on setting this up see the documentation file
-docs/PRINTER_DRIVER.txt.
+label(security)
+dit(bf(security (G)))
-.B Default:
- None
+This option affects how clients respond to Samba and is one of the most
+important settings in the bf(smb.conf) file.
-.B Example:
- printer driver location = \e\eMACHINE\ePRINTER$
+The option sets the tt("security mode bit") in replies to protocol
+negotiations with url(bf(smbd))(smbd.8.html) to turn share level
+security on or off. Clients decide based on this bit whether (and how)
+to transfer user and password information to the server.
-Related paramerers.
-.B printer driver file
+The default is link("security=user")(securityequaluser), as this is
+the most common setting needed when talking to Windows 98 and Windows
+NT.
+The alternatives are link(bf("security = share"))(securityequalshare),
+link(bf("security = server"))(securityequalserver) or
+link(bf("security=domain"))(securityequaldomain).
-.SS printing (S)
-This parameters controls how printer status information is interpreted
-on your system, and also affects the default values for the "print
-command", "lpq command" and "lprm command".
+em(*****NOTE THAT THIS DEFAULT IS DIFFERENT IN SAMBA2.0 THAN FOR
+PREVIOUS VERSIONS OF SAMBA *******).
-Currently six printing styles are supported. They are "printing =
-bsd", "printing = sysv", "printing = hpux", "printing = aix",
-"printing = qnx" and "printing = plp".
+In previous versions of Samba the default was
+link(bf("security=share"))(securityequalshare) mainly because that was
+the only option at one stage.
-To see what the defaults are for the other print commands when using
-these three options use the "testparm" program.
+There is a bug in WfWg that has relevance to this setting. When in
+user or server level security a WfWg client will totally ignore the
+password you type in the "connect drive" dialog box. This makes it
+very difficult (if not impossible) to connect to a Samba service as
+anyone except the user that you are logged into WfWg as.
-As of version 1.9.18 of Samba this option can be set on a per printer basis
+If your PCs use usernames that are the same as their usernames on the
+UNIX machine then you will want to use bf("security = user"). If you
+mostly use usernames that don't exist on the UNIX box then use
+bf("security = share").
-.SS protocol (G)
-The value of the parameter (a string) is the highest protocol level that will
-be supported by the server.
+You should also use link(bf(security=share))(securityequalshare) if
+you want to mainly setup shares without a password (guest
+shares). This is commonly used for a shared printer server. It is more
+difficult to setup guest shares with
+link(bf(security=user))(securityequaluser), see the link(bf("map to
+guest"))(maptoguest)parameter for details.
-Possible values are CORE, COREPLUS, LANMAN1, LANMAN2 and NT1. The relative
-merits of each are discussed in the README file.
+It is possible to use url(bf(smbd))(smbd.8.html) in a em("hybrid
+mode") where it is offers both user and share level security under
+different link(bf(NetBIOS aliases))(netbiosaliases). See the
+link(bf(NetBIOS aliases))(netbiosaliases) and the
+link(bf(include))(include) parameters for more information.
-Normally this option should not be set as the automatic negotiation
-phase in the SMB protocol takes care of choosing the appropriate protocol.
+The different settings will now be explained.
-.B Default:
- protocol = NT1
+startdit()
-.B Example:
- protocol = LANMAN1
+label(securityequalshare)
+dit(bf("security=share")) When clients connect to a share level
+security server then need not log onto the server with a valid
+username and password before attempting to connect to a shared
+resource (although modern clients such as Windows 95/98 and Windows NT
+will send a logon request with a username but no password when talking
+to a bf(security=share) server). Instead, the clients send
+authentication information (passwords) on a per-share basis, at the
+time they attempt to connect to that share.
-.SS public (S)
-A synonym for this parameter is 'guest ok'.
+Note that url(bf(smbd))(smbd.8.html) em(*ALWAYS*) uses a valid UNIX
+user to act on behalf of the client, even in bf("security=share")
+level security.
-If this parameter is 'yes' for a service, then no password is required
-to connect to the service. Privileges will be those of the guest
-account.
+As clients are not required to send a username to the server
+in share level security, url(bf(smbd))(smbd.8.html) uses several
+techniques to determine the correct UNIX user to use on behalf
+of the client.
-See the section below on user/password validation for more information about
-this option.
+A list of possible UNIX usernames to match with the given
+client password is constructed using the following methods :
-.B Default:
- public = no
+startit()
-.B Example:
- public = yes
+it() If the link(bf("guest only"))(guestonly) parameter is set, then
+all the other stages are missed and only the link(bf("guest
+account"))(guestaccount) username is checked.
-.SS queuepause command (S)
-This parameter specifies the command to be executed on the server host in
-order to pause the printerqueue.
+it() Is a username is sent with the share connection request, then
+this username (after mapping - see link(bf("username
+map"))(usernamemap)), is added as a potential username.
-This command should be a program or script which takes a printer name
-as its only parameter and stops the printerqueue, such that no longer
-jobs are submitted to the printer.
+it() If the client did a previous em("logon") request (the
+SessionSetup SMB call) then the username sent in this SMB
+will be added as a potential username.
-This command is not supported by Windows for Workgroups, but can be
-issued from the Printer's window under Windows 95 & NT.
+it() The name of the service the client requested is added
+as a potential username.
-If a %p is given then the printername is put in its place. Otherwise
-it is placed at the end of the command.
+it() The NetBIOS name of the client is added to the list as a
+potential username.
-Note that it is good practice to include the absolute path in the
-command as the PATH may not be available to the server.
+it() Any users on the link(bf("user"))(user) list are added
+as potential usernames.
-.B Default:
- depends on the setting of "printing ="
+endit()
-.B Example:
- queuepause command = disable %p
+If the link(bf("guest only"))(guestonly) parameter is not set, then
+this list is then tried with the supplied password. The first user for
+whom the password matches will be used as the UNIX user.
+
+If the link(bf("guest only"))(guestonly) parameter is set, or no
+username can be determined then if the share is marked as available to
+the link(bf("guest account"))(guestaccount), then this guest user will
+be used, otherwise access is denied.
+
+Note that it can be em(*very*) confusing in share-level security as to
+which UNIX username will eventually be used in granting access.
+
+See also the section link(bf("NOTE ABOUT USERNAME/PASSWORD
+VALIDATION"))(NOTEABOUTUSERNAMEPASSWORDVALIDATION).
+
+label(securityequaluser)
+dit(bf("security=user"))
+
+This is the default security setting in Samba2.0. With user-level
+security a client must first tt("log-on") with a valid username and
+password (which can be mapped using the link(bf("username
+map"))(usernamemap) parameter). Encrypted passwords (see the
+link(bf("encrypted passwords"))(encryptpasswords) parameter) can also
+be used in this security mode. Parameters such as
+link(bf("user"))(user) and link(bf("guest only"))(guestonly), if set
+are then applied and may change the UNIX user to use on this
+connection, but only after the user has been successfully
+authenticated.
+
+em(Note) that the name of the resource being requested is
+em(*not*) sent to the server until after the server has successfully
+authenticated the client. This is why guest shares don't work in user
+level security without allowing the server to automatically map unknown
+users into the link(bf("guest account"))(guestaccount). See the
+link(bf("map to guest"))(maptoguest) parameter for details on
+doing this.
+
+See also the section link(bf("NOTE ABOUT USERNAME/PASSWORD
+VALIDATION"))(NOTEABOUTUSERNAMEPASSWORDVALIDATION).
+
+label(securityequalserver)
+dit(bf("security=server"))
+
+In this mode Samba will try to validate the username/password by
+passing it to another SMB server, such as an NT box. If this fails it
+will revert to bf("security = user"), but note that if encrypted
+passwords have been negotiated then Samba cannot revert back to
+checking the UNIX password file, it must have a valid smbpasswd file
+to check users against. See the documentation file in the docs/
+directory ENCRYPTION.txt for details on how to set this up.
+
+em(Note) that from the clients point of view bf("security=server") is
+the same as link(bf("security=user"))(securityequaluser). It only
+affects how the server deals with the authentication, it does not in
+any way affect what the client sees.
+
+em(Note) that the name of the resource being requested is
+em(*not*) sent to the server until after the server has successfully
+authenticated the client. This is why guest shares don't work in server
+level security without allowing the server to automatically map unknown
+users into the link(bf("guest account"))(guestaccount). See the
+link(bf("map to guest"))(maptoguest) parameter for details on
+doing this.
+
+See also the section link(bf("NOTE ABOUT USERNAME/PASSWORD
+VALIDATION"))(NOTEABOUTUSERNAMEPASSWORDVALIDATION).
+
+See also the link(bf("password server"))(passwordserver) parameter.
+and the link(bf("encrypted passwords"))(encryptpasswords) parameter.
+
+label(securityequaldomain)
+dit(bf("security=domain"))
+
+This mode will only work correctly if
+url(bf(smbpasswd))(smbpasswd.8.html) has been used to add this machine
+into a Windows NT Domain. It expects the link(bf("encrypted
+passwords"))(encryptpasswords) parameter to be set to tt("true"). In
+this mode Samba will try to validate the username/password by passing
+it to a Windows NT Primary or Backup Domain Controller, in exactly the
+same way that a Windows NT Server would do.
+
+em(Note) that a valid UNIX user must still exist as well as the
+account on the Domain Controller to allow Samba to have a valid
+UNIX account to map file access to.
+
+em(Note) that from the clients point of view bf("security=domain") is
+the same as link(bf("security=user"))(securityequaluser). It only
+affects how the server deals with the authentication, it does not in
+any way affect what the client sees.
+
+em(Note) that the name of the resource being requested is
+em(*not*) sent to the server until after the server has successfully
+authenticated the client. This is why guest shares don't work in domain
+level security without allowing the server to automatically map unknown
+users into the link(bf("guest account"))(guestaccount). See the
+link(bf("map to guest"))(maptoguest) parameter for details on
+doing this.
+
+e,(BUG:) There is currently a bug in the implementation of
+bf("security=domain) with respect to multi-byte character
+set usernames. The communication with a Domain Controller
+must be done in UNICODE and Samba currently does not widen
+multi-byte user names to UNICODE correctly, thus a multi-byte
+username will not be recognized correctly at the Domain Controller.
+This issue will be addressed in a future release.
+
+See also the section link(bf("NOTE ABOUT USERNAME/PASSWORD
+VALIDATION"))(NOTEABOUTUSERNAMEPASSWORDVALIDATION).
+
+See also the link(bf("password server"))(passwordserver) parameter.
+and the link(bf("encrypted passwords"))(encryptpasswords) parameter.
-.SS queueresume command (S)
-This parameter specifies the command to be executed on the server host in
-order to resume the printerqueue. It is the command to undo the behaviour
-that is caused by the previous parameter (queuepause command).
-
-This command should be a program or script which takes a printer name
-as its only parameter and resumes the printerqueue, such that queued
-jobs are resubmitted to the printer.
+enddit()
-This command is not supported by Windows for Workgroups, but can be
-issued from the Printer's window under Windows 95 & NT.
+ bf(Default:)
+tt( security = USER)
-If a %p is given then the printername is put in its place. Otherwise
-it is placed at the end of the command.
+ bf(Example:)
+tt( security = DOMAIN)
-Note that it is good practice to include the absolute path in the
-command as the PATH may not be available to the server.
+label(serverstring)
+dit(bf(server string (G)))
+
+This controls what string will show up in the printer comment box in
+print manager and next to the IPC connection in tt("net view"). It can be
+any string that you wish to show to your users.
+
+It also sets what will appear in browse lists next to the machine
+name.
+
+A tt("%v") will be replaced with the Samba version number.
+
+A tt("%h") will be replaced with the hostname.
+
+ bf(Default:)
+tt( server string = Samba %v)
+
+ bf(Example:)
+tt( server string = University of GNUs Samba Server)
+
+label(setdirectory)
+dit(bf(set directory (S)))
+
+If tt("set directory = no"), then users of the service may not use the
+setdir command to change directory.
+
+The setdir command is only implemented in the Digital Pathworks
+client. See the Pathworks documentation for details.
+
+ bf(Default:)
+tt( set directory = no)
+
+ bf(Example:)
+tt( set directory = yes)
+
+label(sharemodes)
+dit(bf(share modes (S)))
+
+This enables or disables the honoring of the tt("share modes") during a
+file open. These modes are used by clients to gain exclusive read or
+write access to a file.
+
+These open modes are not directly supported by UNIX, so they are
+simulated using shared memory, or lock files if your UNIX doesn't
+support shared memory (almost all do).
+
+The share modes that are enabled by this option are DENY_DOS,
+DENY_ALL, DENY_READ, DENY_WRITE, DENY_NONE and DENY_FCB.
+
+This option gives full share compatibility and enabled by default.
+
+You should em(*NEVER*) turn this parameter off as many Windows
+applications will break if you do so.
+
+ bf(Default:)
+tt( share modes = yes)
+
+label(sharedmemsize)
+dit(bf(shared mem size (G)))
+
+It specifies the size of the shared memory (in bytes) to use between
+url(bf(smbd))(smbd.8.html) processes. This parameter defaults to one
+megabyte of shared memory. It is possible that if you have a large
+server with many files open simultaneously that you may need to
+increase this parameter. Signs that this parameter is set too low are
+users reporting strange problems trying to save files (locking errors)
+and error messages in the smbd log looking like tt("ERROR
+smb_shm_alloc : alloc of XX bytes failed").
+
+ bf(Default:)
+tt( shared mem size = 1048576)
+
+ bf(Example:)
+tt( shared mem size = 5242880 ; Set to 5mb for a large number of files.)
+
+label(shortpreservecase)
+dit(bf(short preserve case (G)))
+
+This boolean parameter controls if new files which conform to 8.3
+syntax, that is all in upper case and of suitable length, are created
+upper case, or if they are forced to be the tt("default") case. This
+option can be use with link(bf("preserve case
+=yes"))(preservecaseoption) to permit long filenames to retain their
+case, while short names are lowered. Default em(Yes).
-.B Default:
- depends on the setting of "printing ="
+See the section on link(bf(NAME MANGLING))(NAMEMANGLING).
-.B Example:
- queuepause command = enable %p
+ bf(Default:)
+tt( short preserve case = yes)
-.SS read list (S)
-This is a list of users that are given read-only access to a
-service. If the connecting user is in this list then they will
-not be given write access, no matter what the "read only" option
-is set to. The list can include group names using the @group syntax.
+label(smbpasswdfile)
+dit(bf(smb passwd file (G)))
-See also the "write list" option
+This option sets the path to the encrypted smbpasswd file. By default
+the path to the smbpasswd file is compiled into Samba.
-.B Default:
- read list =
+ bf(Default:)
+tt( smb passwd file= <compiled default>)
-.B Example:
- read list = mary, @students
+ bf(Example:)
+tt( smb passwd file = /usr/samba/private/smbpasswd)
-.SS read only (S)
-See
-.B writable
-and
-.B write ok.
-Note that this is an inverted synonym for writable and write ok.
-.SS read prediction (G)
-This options enables or disables the read prediction code used to
-speed up reads from the server. When enabled the server will try to
-pre-read data from the last accessed file that was opened read-only
-while waiting for packets.
+label(smbrun)
+dit(bf(smbrun (G)))
-.SS Default:
- read prediction = False
+This sets the full path to the bf(smbrun) binary. This defaults to the
+value in the Makefile.
-.SS Example:
- read prediction = True
-.SS read raw (G)
-This parameter controls whether or not the server will support raw reads when
-transferring data to clients.
+You must get this path right for many services to work correctly.
-If enabled, raw reads allow reads of 65535 bytes in one packet. This
-typically provides a major performance benefit.
+You should not need to change this parameter so long as Samba
+is installed correctly.
-However, some clients either negotiate the allowable block size incorrectly
-or are incapable of supporting larger block sizes, and for these clients you
-may need to disable raw reads.
+ bf(Default:)
+tt( smbrun=<compiled default>)
-In general this parameter should be viewed as a system tuning tool and left
-severely alone. See also
-.B write raw.
+ bf(Example:)
+tt( smbrun = /usr/local/samba/bin/smbrun)
-.B Default:
- read raw = yes
+label(socketaddress)
+dit(bf(socket address (G)))
-.B Example:
- read raw = no
-.SS read size (G)
+This option allows you to control what address Samba will listen for
+connections on. This is used to support multiple virtual interfaces on
+the one server, each with a different configuration.
-The option "read size" affects the overlap of disk reads/writes with
-network reads/writes. If the amount of data being transferred in
-several of the SMB commands (currently SMBwrite, SMBwriteX and
-SMBreadbraw) is larger than this value then the server begins writing
-the data before it has received the whole packet from the network, or
-in the case of SMBreadbraw, it begins writing to the network before
-all the data has been read from disk.
+By default samba will accept connections on any address.
-This overlapping works best when the speeds of disk and network access
-are similar, having very little effect when the speed of one is much
-greater than the other.
+ bf(Example:)
+tt( socket address = 192.168.2.20)
-The default value is 2048, but very little experimentation has been
-done yet to determine the optimal value, and it is likely that the best
-value will vary greatly between systems anyway. A value over 65536 is
-pointless and will cause you to allocate memory unnecessarily.
+label(socketoptions)
+dit(bf(socket options (G)))
-.B Default:
- read size = 2048
+This option allows you to set socket options to be used when talking
+with the client.
-.B Example:
- read size = 8192
+Socket options are controls on the networking layer of the operating
+systems which allow the connection to be tuned.
-.SS remote announce (G)
+This option will typically be used to tune your Samba server for
+optimal performance for your local network. There is no way that Samba
+can know what the optimal parameters are for your net, so you must
+experiment and choose them yourself. We strongly suggest you read the
+appropriate documentation for your operating system first (perhaps
+bf("man setsockopt") will help).
-This option allows you to setup nmbd to periodically announce itself
-to arbitrary IP addresses with an arbitrary workgroup name.
+You may find that on some systems Samba will say "Unknown socket
+option" when you supply an option. This means you either incorrectly
+typed it or you need to add an include file to includes.h for your OS.
+If the latter is the case please send the patch to
+email(samba-bugs@samba.anu.edu.au).
-This is useful if you want your Samba server to appear in a remote
-workgroup for which the normal browse propagation rules don't
-work. The remote workgroup can be anywhere that you can send IP
-packets to.
+Any of the supported socket options may be combined in any way you
+like, as long as your OS allows it.
-For example:
+This is the list of socket options currently settable using this
+option:
- remote announce = 192.168.2.255/SERVERS 192.168.4.255/STAFF
+startit()
-the above line would cause nmbd to announce itself to the two given IP
-addresses using the given workgroup names. If you leave out the
-workgroup name then the one given in the "workgroup" option is used
-instead.
+it() SO_KEEPALIVE
-The IP addresses you choose would normally be the broadcast addresses
-of the remote networks, but can also be the IP addresses of known
-browse masters if your network config is that stable.
+it() SO_REUSEADDR
-This option replaces similar functionality from the nmbd lmhosts file.
+it() SO_BROADCAST
-.SS remote browse sync (G)
+it() TCP_NODELAY
-This option allows you to setup nmbd to periodically request synchronisation
-of browse lists with the master browser of a samba server that is on a remote
-segment. This option will allow you to gain browse lists for multiple
-workgroups across routed networks. This is done in a manner that does not work
-with any non-samba servers.
+it() IPTOS_LOWDELAY
-This is useful if you want your Samba server and all local clients
-to appear in a remote workgroup for which the normal browse propagation
-rules don't work. The remote workgroup can be anywhere that you can send IP
-packets to.
+it() IPTOS_THROUGHPUT
-For example:
+it() SO_SNDBUF *
- remote browse sync = 192.168.2.255 192.168.4.255
+it() SO_RCVBUF *
-the above line would cause nmbd to request the master browser on the
-specified subnets or addresses to synchronise their browse lists with
-the local server.
+it() SO_SNDLOWAT *
-The IP addresses you choose would normally be the broadcast addresses
-of the remote networks, but can also be the IP addresses of known
-browse masters if your network config is that stable. If a machine IP
-address is given Samba makes NO attempt to validate that the remote
-machine is available, is listening, nor that it is in fact the browse
-master on it's segment.
+it() SO_RCVLOWAT *
+endit()
-.SS revalidate (S)
+Those marked with a tt(*) take an integer argument. The others can
+optionally take a 1 or 0 argument to enable or disable the option, by
+default they will be enabled if you don't specify 1 or 0.
-This option controls whether Samba will allow a previously validated
-username/password pair to be used to attach to a share. Thus if you
-connect to \e\eserver\eshare1 then to \e\eserver\eshare2 it won't
-automatically allow the client to request connection to the second
-share as the same username as the first without a password.
+To specify an argument use the syntax SOME_OPTION=VALUE for example
+tt(SO_SNDBUF=8192). Note that you must not have any spaces before or after
+the = sign.
-Note that this option only works with security=share and will
-be ignored if this is not the case.
+If you are on a local network then a sensible option might be
-If "revalidate" is True then the client will be denied automatic
-access as the same username.
+tt(socket options = IPTOS_LOWDELAY)
-.B Default:
- revalidate = False
+If you have a local network then you could try:
-.B Example:
- revalidate = True
+tt(socket options = IPTOS_LOWDELAY TCP_NODELAY)
-.SS root (G)
-See
-.B root directory.
-.SS root dir (G)
-See
-.B root directory.
-.SS root directory (G)
-Synonyms for this parameter are 'root dir' and 'root'.
+If you are on a wide area network then perhaps try setting
+IPTOS_THROUGHPUT.
-The server will chroot() to this directory on startup. This is not
-strictly necessary for secure operation. Even without it the server
-will deny access to files not in one of the service entries. It may
-also check for, and deny access to, soft links to other parts of the
-filesystem, or attempts to use .. in file names to access other
-directories (depending on the setting of the "wide links" parameter).
+Note that several of the options may cause your Samba server to fail
+completely. Use these options with caution!
-Adding a "root dir" entry other than "/" adds an extra level of security,
-but at a price. It absolutely ensures that no access is given to files not
-in the sub-tree specified in the "root dir" option, *including* some files
-needed for complete operation of the server. To maintain full operability
-of the server you will need to mirror some system files into the "root dir"
-tree. In particular you will need to mirror /etc/passwd (or a subset of it),
-and any binaries or configuration files needed for printing (if required).
-The set of files that must be mirrored is operating system dependent.
+ bf(Default:)
+tt( socket options = TCP_NODELAY)
-.B Default:
- root directory = /
+ bf(Example:)
+tt( socket options = IPTOS_LOWDELAY)
-.B Example:
- root directory = /homes/smb
-.SS root postexec (S)
+label(ssl)
+dit(bf(ssl (G)))
-This is the same as postexec except that the command is run as
-root. This is useful for unmounting filesystems (such as cdroms) after
-a connection is closed.
+This variable is part of SSL-enabled Samba. This is only available if
+the SSL libraries have been compiled on your system and the configure
+option tt("--with-ssl") was given at configure time.
-.SS root preexec (S)
+em(Note) that for export control reasons this code is em(**NOT**)
+enabled by default in any current binary version of Samba.
-This is the same as preexec except that the command is run as
-root. This is useful for mounting filesystems (such as cdroms) before
-a connection is finalised.
+This variable enables or disables the entire SSL mode. If it is set to
+"no", the SSL enabled samba behaves exactly like the non-SSL samba. If
+set to "yes", it depends on the variables link(bf("ssl
+hosts"))(sslhosts) and link(bf("ssl hosts resign"))(sslhostsresign)
+whether an SSL connection will be required.
-.SS security (G)
-This option affects how clients respond to Samba.
+ bf(Default:)
+tt( ssl=no)
+ bf(Example:)
+tt( ssl=yes)
-The option sets the "security mode bit" in replies to protocol negotiations
-to turn share level security on or off. Clients decide based on this bit
-whether (and how) to transfer user and password information to the server.
+label(sslCAcertDir)
+dit(bf(ssl CA certDir (G)))
-The default is "security=SHARE", mainly because that was the only
-option at one stage.
+This variable is part of SSL-enabled Samba. This is only available if
+the SSL libraries have been compiled on your system and the configure
+option tt("--with-ssl") was given at configure time.
-The alternatives are "security = user" or "security = server".
+em(Note) that for export control reasons this code is em(**NOT**)
+enabled by default in any current binary version of Samba.
-If your PCs use usernames that are the same as their usernames on the
-UNIX machine then you will want to use "security = user". If you
-mostly use usernames that don't exist on the UNIX box then use
-"security = share".
-
-There is a bug in WfWg that may affect your decision. When in user
-level security a WfWg client will totally ignore the password you type
-in the "connect drive" dialog box. This makes it very difficult (if
-not impossible) to connect to a Samba service as anyone except the
-user that you are logged into WfWg as.
-
-If you use "security = server" then Samba will try to validate the
-username/password by passing it to another SMB server, such as an NT
-box. If this fails it will revert to "security = USER", but note that
-if encrypted passwords have been negotiated then Samba cannot revert
-back to checking the UNIX password file, it must have a valid
-smbpasswd file to check users against. See the documentation
-docs/ENCRYPTION.txt for details on how to set this up.
-
-See the "password server" option for more details.
-
-.B Default:
- security = SHARE
-
-.B Example:
- security = USER
-.SS server string (G)
-This controls what string will show up in the printer comment box in
-print manager and next to the IPC connection in "net view". It can be
-any string that you wish to show to your users.
+This variable defines where to look up the Certification
+Authorities. The given directory should contain one file for each CA
+that samba will trust. The file name must be the hash value over the
+"Distinguished Name" of the CA. How this directory is set up is
+explained later in this document. All files within the directory that
+don't fit into this naming scheme are ignored. You don't need this
+variable if you don't verify client certificates.
-It also sets what will appear in browse lists next to the machine name.
+ bf(Default:)
+tt( ssl CA certDir = /usr/local/ssl/certs)
-A %v will be replaced with the Samba version number.
+label(sslCAcertFile)
+dit(bf(ssl CA certFile (G)))
-A %h will be replaced with the hostname.
+This variable is part of SSL-enabled Samba. This is only available if
+the SSL libraries have been compiled on your system and the configure
+option tt("--with-ssl") was given at configure time.
-.B Default:
- server string = Samba %v
+em(Note) that for export control reasons this code is em(**NOT**)
+enabled by default in any current binary version of Samba.
-.B Example:
- server string = University of GNUs Samba Server
+This variable is a second way to define the trusted CAs. The
+certificates of the trusted CAs are collected in one big file and this
+variable points to the file. You will probably only use one of the two
+ways to define your CAs. The first choice is preferable if you have
+many CAs or want to be flexible, the second is preferable if you only
+have one CA and want to keep things simple (you won't need to create
+the hashed file names). You don't need this variable if you don't
+verify client certificates.
-.SS set directory (S)
-If 'set directory = no', then users of the service may not use the setdir
-command to change directory.
+ bf(Default:)
+tt( ssl CA certFile = /usr/local/ssl/certs/trustedCAs.pem)
-The setdir command is only implemented in the Digital Pathworks client. See the
-Pathworks documentation for details.
+label(sslciphers)
+dit(bf(ssl ciphers (G)))
-.B Default:
- set directory = no
+This variable is part of SSL-enabled Samba. This is only available if
+the SSL libraries have been compiled on your system and the configure
+option tt("--with-ssl") was given at configure time.
-.B Example:
- set directory = yes
+em(Note) that for export control reasons this code is em(**NOT**)
+enabled by default in any current binary version of Samba.
-.SS shared file entries (G)
-This parameter has been removed (as of Samba 1.9.18 and above). The new
-System V shared memory code prohibits the user from allocating the
-share hash bucket size directly.
+This variable defines the ciphers that should be offered during SSL
+negotiation. You should not set this variable unless you know what you
+are doing.
-.SS shared mem size (G)
-This parameter is only useful when Samba has been compiled with FAST_SHARE_MODES.
-It specifies the size of the shared memory (in bytes) to use between smbd
-processes. You should never change this parameter unless you have studied
-the source and know what you are doing. This parameter defaults to 1024
-multiplied by the setting of the maximum number of open files in the
-file local.h in the Samba source code. MAX_OPEN_FILES is normally set
-to 100, so this parameter defaults to 102400 bytes.
+label(sslclientcert)
+dit(bf(ssl client cert (G)))
-.B Default
- shared mem size = 102400
+This variable is part of SSL-enabled Samba. This is only available if
+the SSL libraries have been compiled on your system and the configure
+option tt("--with-ssl") was given at configure time.
-.SS smb passwd file (G)
-This option sets the path to the encrypted smbpasswd file. This is a *VERY
-DANGEROUS OPTION* if the smb.conf is user writable. By default the path
-to the smbpasswd file is compiled into Samba.
+em(Note) that for export control reasons this code is em(**NOT**)
+enabled by default in any current binary version of Samba.
-.SS smbrun (G)
-This sets the full path to the smbrun binary. This defaults to the
-value in the Makefile.
+The certificate in this file is used by
+url(bf(smbclient))(smbclient.1.html) if it exists. It's needed if the
+server requires a client certificate.
-You must get this path right for many services to work correctly.
+ bf(Default:)
+tt( ssl client cert = /usr/local/ssl/certs/smbclient.pem)
-.B Default:
-taken from Makefile
+label(sslclientkey)
+dit(bf(ssl client key (G)))
-.B Example:
- smbrun = /usr/local/samba/bin/smbrun
+This variable is part of SSL-enabled Samba. This is only available if
+the SSL libraries have been compiled on your system and the configure
+option tt("--with-ssl") was given at configure time.
-.SS share modes (S)
+em(Note) that for export control reasons this code is em(**NOT**)
+enabled by default in any current binary version of Samba.
-This enables or disables the honouring of the "share modes" during a
-file open. These modes are used by clients to gain exclusive read or
-write access to a file.
+This is the private key for url(bf(smbclient))(smbclient.1.html). It's
+only needed if the client should have a certificate.
-These open modes are not directly supported by UNIX, so they are
-simulated using lock files in the "lock directory". The "lock
-directory" specified in smb.conf must be readable by all users.
+ bf(Default:)
+tt( ssl client key = /usr/local/ssl/private/smbclient.pem)
-The share modes that are enabled by this option are DENY_DOS,
-DENY_ALL, DENY_READ, DENY_WRITE, DENY_NONE and DENY_FCB.
+label(sslcompatibility)
+dit(bf(ssl compatibility (G)))
-Enabling this option gives full share compatibility but may cost a bit
-of processing time on the UNIX server. They are enabled by default.
+This variable is part of SSL-enabled Samba. This is only available if
+the SSL libraries have been compiled on your system and the configure
+option tt("--with-ssl") was given at configure time.
-.B Default:
- share modes = yes
+em(Note) that for export control reasons this code is em(**NOT**)
+enabled by default in any current binary version of Samba.
-.B Example:
- share modes = no
+This variable defines whether SSLeay should be configured for bug
+compatibility with other SSL implementations. This is probably not
+desirable because currently no clients with SSL implementations other
+than SSLeay exist.
-.SS short preserve case (S)
+ bf(Default:)
+tt( ssl compatibility = no)
-This controls if new short filenames are created with the case that
-the client passes, or if they are forced to be the "default" case.
+label(sslhosts)
+dit(bf(ssl hosts (G)))
-.B Default:
- short preserve case = no
+See link(bf("ssl hosts resign"))(sslhostsresign).
-See the section on "NAME MANGLING" for a fuller discussion.
+label(sslhostsresign)
+dit(bf(ssl hosts resign (G)))
-.SS socket address (G)
+This variable is part of SSL-enabled Samba. This is only available if
+the SSL libraries have been compiled on your system and the configure
+option tt("--with-ssl") was given at configure time.
-This option allows you to control what address Samba will listen for
-connections on. This is used to support multiple virtual interfaces on
-the one server, each with a different configuration.
+em(Note) that for export control reasons this code is em(**NOT**)
+enabled by default in any current binary version of Samba.
-By default samba will accept connections on any address.
+These two variables define whether samba will go into SSL mode or
+not. If none of them is defined, samba will allow only SSL
+connections. If the link(bf("ssl hosts"))(sslhosts) variable lists
+hosts (by IP-address, IP-address range, net group or name), only these
+hosts will be forced into SSL mode. If the bf("ssl hosts resign")
+variable lists hosts, only these hosts will NOT be forced into SSL
+mode. The syntax for these two variables is the same as for the
+link(bf("hosts allow"))(hostsallow) and link(bf("hosts
+deny"))(hostsdeny) pair of variables, only that the subject of the
+decision is different: It's not the access right but whether SSL is
+used or not. See the link(bf("allow hosts"))(allowhosts) parameter for
+details. The example below requires SSL connections from all hosts
+outside the local net (which is 192.168.*.*).
-.B Example:
- socket address = 192.168.2.20
+ bf(Default:)
+tt( ssl hosts = <empty string>)
+tt( ssl hosts resign = <empty string>)
-.SS socket options (G)
-This option (which can also be invoked with the -O command line
-option) allows you to set socket options to be used when talking with
-the client.
+ bf(Example:)
+tt( ssl hosts resign = 192.168.)
+
+label(sslrequireclientcert)
+dit(bf(ssl require clientcert (G)))
+
+This variable is part of SSL-enabled Samba. This is only available if
+the SSL libraries have been compiled on your system and the configure
+option tt("--with-ssl") was given at configure time.
+
+em(Note) that for export control reasons this code is em(**NOT**)
+enabled by default in any current binary version of Samba.
+
+If this variable is set to tt("yes"), the server will not tolerate
+connections from clients that don't have a valid certificate. The
+directory/file given in link(bf("ssl CA certDir"))(sslCAcertDir) and
+link(bf("ssl CA certFile"))(sslCAcertFile) will be used to look up the
+CAs that issued the client's certificate. If the certificate can't be
+verified positively, the connection will be terminated. If this
+variable is set to tt("no"), clients don't need certificates. Contrary
+to web applications you really em(*should*) require client
+certificates. In the web environment the client's data is sensitive
+(credit card numbers) and the server must prove to be trustworthy. In
+a file server environment the server's data will be sensitive and the
+clients must prove to be trustworthy.
-Socket options are controls on the networking layer of the operating
-systems which allow the connection to be tuned.
+ bf(Default:)
+tt( ssl require clientcert = no)
-This option will typically be used to tune your Samba server for
-optimal performance for your local network. There is no way that Samba
-can know what the optimal parameters are for your net, so you must
-experiment and choose them yourself. I strongly suggest you read the
-appropriate documentation for your operating system first (perhaps
-"man setsockopt" will help).
+label(sslrequireservercert)
+dit(bf(ssl require servercert (G)))
-You may find that on some systems Samba will say "Unknown socket
-option" when you supply an option. This means you either mis-typed it
-or you need to add an include file to includes.h for your OS. If the
-latter is the case please send the patch to me
-(samba-bugs@samba.anu.edu.au).
+This variable is part of SSL-enabled Samba. This is only available if
+the SSL libraries have been compiled on your system and the configure
+option tt("--with-ssl") was given at configure time.
-Any of the supported socket options may be combined in any way you
-like, as long as your OS allows it.
+em(Note) that for export control reasons this code is em(**NOT**)
+enabled by default in any current binary version of Samba.
-This is the list of socket options currently settable using this
-option:
+If this variable is set to tt("yes"), the
+url(bf(smbclient))(smbclient.1.html) will request a certificate from
+the server. Same as link(bf("ssl require
+clientcert"))(sslrequireclientcert) for the server.
- SO_KEEPALIVE
+ bf(Default:)
+tt( ssl require servercert = no)
- SO_REUSEADDR
+label(sslservercert)
+dit(bf(ssl server cert (G)))
- SO_BROADCAST
+This variable is part of SSL-enabled Samba. This is only available if
+the SSL libraries have been compiled on your system and the configure
+option tt("--with-ssl") was given at configure time.
- TCP_NODELAY
+em(Note) that for export control reasons this code is em(**NOT**)
+enabled by default in any current binary version of Samba.
- IPTOS_LOWDELAY
+This is the file containing the server's certificate. The server _must_
+have a certificate. The file may also contain the server's private key.
+See later for how certificates and private keys are created.
- IPTOS_THROUGHPUT
+ bf(Default:)
+tt( ssl server cert = <empty string>)
- SO_SNDBUF *
+label(sslserverkey)
+dit(bf(ssl server key (G)))
- SO_RCVBUF *
+This variable is part of SSL-enabled Samba. This is only available if
+the SSL libraries have been compiled on your system and the configure
+option tt("--with-ssl") was given at configure time.
- SO_SNDLOWAT *
+em(Note) that for export control reasons this code is em(**NOT**)
+enabled by default in any current binary version of Samba.
- SO_RCVLOWAT *
+This file contains the private key of the server. If this variable is
+not defined, the key is looked up in the certificate file (it may be
+appended to the certificate). The server em(*must*) have a private key
+and the certificate em(*must*) match this private key.
-Those marked with a * take an integer argument. The others can
-optionally take a 1 or 0 argument to enable or disable the option, by
-default they will be enabled if you don't specify 1 or 0.
+ bf(Default:)
+tt( ssl server key = <empty string>)
-To specify an argument use the syntax SOME_OPTION=VALUE for example
-SO_SNDBUF=8192. Note that you must not have any spaces before or after
-the = sign.
+label(sslversion)
+dit(bf(ssl version (G)))
-If you are on a local network then a sensible option might be
+This variable is part of SSL-enabled Samba. This is only available if
+the SSL libraries have been compiled on your system and the configure
+option tt("--with-ssl") was given at configure time.
-socket options = IPTOS_LOWDELAY
+em(Note) that for export control reasons this code is em(**NOT**)
+enabled by default in any current binary version of Samba.
-If you have an almost unloaded local network and you don't mind a lot
-of extra CPU usage in the server then you could try
+This enumeration variable defines the versions of the SSL protocol
+that will be used. tt("ssl2or3") allows dynamic negotiation of SSL v2
+or v3, tt("ssl2") results in SSL v2, tt("ssl3") results in SSL v3 and
+"tls1" results in TLS v1. TLS (Transport Layer Security) is the
+(proposed?) new standard for SSL.
-socket options = IPTOS_LOWDELAY TCP_NODELAY
+ bf(Default:)
+tt( ssl version = "ssl2or3")
-If you are on a wide area network then perhaps try setting
-IPTOS_THROUGHPUT.
+label(statcache)
+dit(bf(stat cache (G)))
-Note that several of the options may cause your Samba server to fail
-completely. Use these options with caution!
+This parameter determines if url(bf(smbd))(smbd.8.html) will use a
+cache in order to speed up case insensitive name mappings. You should
+never need to change this parameter.
-.B Default:
- no socket options
+ bf(Default:)
+tt( stat cache = yes)
-.B Example:
- socket options = IPTOS_LOWDELAY
+label(statcachesize)
+dit(bf(stat cache size (G)))
+This parameter determines the number of entries in the link(bf(stat
+cache))(statcache). You should never need to change this parameter.
+ bf(Default:)
+tt( stat cache size = 50)
+label(status)
+dit(bf(status (G)))
-.SS status (G)
This enables or disables logging of connections to a status file that
-.B smbstatus
-can read.
+url(bf(smbstatus))(smbstatus.1.html) can read.
-With this disabled
-.B smbstatus
-won't be able to tell you what
-connections are active.
+With this disabled url(bf(smbstatus))(smbstatus.1.html) won't be able
+to tell you what connections are active. You should never need to
+change this parameter.
-.B Default:
+ bf(Default:)
status = yes
-.B Example:
- status = no
+label(strictlocking)
+dit(bf(strict locking (S)))
-.SS strict locking (S)
This is a boolean that controls the handling of file locking in the
-server. When this is set to yes the server will check every read and
+server. When this is set to tt("yes") the server will check every read and
write access for file locks, and deny access if locks exist. This can
be slow on some systems.
-When strict locking is "no" the server does file lock checks only when
-the client explicitly asks for them.
+When strict locking is tt("no") the server does file lock checks only
+when the client explicitly asks for them.
Well behaved clients always ask for lock checks when it is important,
-so in the vast majority of cases "strict locking = no" is preferable.
-
-.B Default:
- strict locking = no
+so in the vast majority of cases bf("strict locking = no") is
+preferable.
-.B Example:
- strict locking = yes
-
-.SS strict sync (S)
-Many Windows applications (including the Windows 98 explorer
-shell) seem to confuse flushing buffer contents to disk with
-doing a sync to disk. Under UNIX, a sync call forces the process
-to be suspended until the kernel has ensured that all outstanding
-data in kernel disk buffers has been safely stored onto stable
-storate. This is very slow and should only be done rarely. Setting
-this parameter to "no" (the default) means that smbd ignores the
-Windows applications requests for a sync call. There is only a
-possibility of losing data if the operating system itself that
-Samba is running on crashes, so there is little danger in this
-default setting. In addition, this fixes many performace problems
-that people have reported with the new Windows98 explorer shell
-file copies.
+ bf(Default:)
+tt( strict locking = no)
-See also the "sync always" parameter.
+ bf(Example:)
+tt( strict locking = yes)
+
+label(strictsync)
+dit(bf(strict sync (S)))
+
+Many Windows applications (including the Windows 98 explorer shell)
+seem to confuse flushing buffer contents to disk with doing a sync to
+disk. Under UNIX, a sync call forces the process to be suspended until
+the kernel has ensured that all outstanding data in kernel disk
+buffers has been safely stored onto stable storage. This is very slow
+and should only be done rarely. Setting this parameter to "no" (the
+default) means that smbd ignores the Windows applications requests for
+a sync call. There is only a possibility of losing data if the
+operating system itself that Samba is running on crashes, so there is
+little danger in this default setting. In addition, this fixes many
+performance problems that people have reported with the new Windows98
+explorer shell file copies.
+
+See also the link(bf("sync always"))(syncalways) parameter.
-.B Default:
- strict sync = no
+ bf(Default:)
+tt( strict sync = no)
-.B Example:
- strict sync = yes
+ bf(Example:)
+tt( strict sync = yes)
+label(stripdot)
+dit(bf(strip dot (G)))
-.SS strip dot (G)
This is a boolean that controls whether to strip trailing dots off
-UNIX filenames. This helps with some CDROMs that have filenames ending in a
-single dot.
-
-.B Default:
- strip dot = no
-
-.B Example:
- strip dot = yes
-
-.SS syslog (G)
-This parameter maps how Samba debug messages are logged onto the
-system syslog logging levels. Samba debug level zero maps onto
-syslog LOG_ERR, debug level one maps onto LOG_WARNING, debug
-level two maps to LOG_NOTICE, debug level three maps onto LOG_INFO.
-The paramter sets the threshold for doing the mapping, all Samba
-debug messages above this threashold are mapped to syslog LOG_DEBUG
-messages.
-
-.B Default:
+UNIX filenames. This helps with some CDROMs that have filenames ending
+in a single dot.
- syslog = 1
-
-.SS syslog only (G)
-If this parameter is set then Samba debug messages are logged into
-the system syslog only, and not to the debug log files.
+ bf(Default:)
+tt( strip dot = no)
-.B Default:
- syslog only = no
+ bf(Example:)
+tt( strip dot = yes)
-.SS sync always (S)
+label(syncalways)
+dit(bf(sync always (S)))
This is a boolean parameter that controls whether writes will always
be written to stable storage before the write call returns. If this is
write call (clients can set a bit indicating that a particular write
should be synchronous). If this is true then every write will be
followed by a fsync() call to ensure the data is written to disk.
-Note that the "strict sync" parameter must be set to "yes" in
-order for this parameter to have any affect.
+Note that the link(bf("strict sync"))(strictsync) parameter must be
+set to tt("yes") in order for this parameter to have any affect.
+
+See also the link(bf("strict sync"))(strictsync) parameter.
+
+ bf(Default:)
+tt( sync always = no)
-See also the "strict sync" parameter.
+ bf(Example:)
+tt( sync always = yes)
+
+label(syslog)
+dit(bf(syslog (G)))
+
+This parameter maps how Samba debug messages are logged onto the
+system syslog logging levels. Samba debug level zero maps onto syslog
+LOG_ERR, debug level one maps onto LOG_WARNING, debug level two maps
+to LOG_NOTICE, debug level three maps onto LOG_INFO. The parameter
+sets the threshold for doing the mapping, all Samba debug messages
+above this threshold are mapped to syslog LOG_DEBUG messages.
+
+ bf(Default:)
+tt( syslog = 1)
+
+label(syslogonly)
+dit(bf(syslog only (G)))
+
+If this parameter is set then Samba debug messages are logged into the
+system syslog only, and not to the debug log files.
-.B Default:
- sync always = no
+ bf(Default:)
+tt( syslog only = no)
-.B Example:
- sync always = yes
+label(timeoffset)
+dit(bf(time offset (G)))
-.SS time offset (G)
This parameter is a setting in minutes to add to the normal GMT to
local time conversion. This is useful if you are serving a lot of PCs
that have incorrect daylight saving time handling.
-.B Default:
- time offset = 0
+ bf(Default:)
+tt( time offset = 0)
+
+ bf(Example:)
+tt( time offset = 60)
+
+label(timeserver)
+
+dit(bf(time server (G)))
+
+This parameter determines if url(bf(nmbd))(nmbd.8.html) advertises
+itself as a time server to Windows clients. The default is False.
+
+ bf(Default:)
+tt( time server = False)
+
+ bf(Example:)
+tt( time server = True)
+
+label(timestamplogs)
+dit(bf(timestamp logs (G)))
-.B Example:
- time offset = 60
+Samba2.0 will a timestamps to all log entries by default. This
+can be distracting if you are attempting to debug a problem. This
+parameter allows the timestamping to be turned off.
+
+ bf(Default:)
+tt( timestamp logs = True)
+
+ bf(Example:)
+tt( timestamp logs = False)
-.SS time server (G)
-This parameter determines if nmbd advertises itself as a time server
-to Windows clients. The default is False.
+label(unixpasswordsync)
+dit(bf(unix password sync (G)))
-.B Default:
- time server = False
+This boolean parameter controls whether Samba attempts to synchronize
+the UNIX password with the SMB password when the encrypted SMB
+password in the smbpasswd file is changed. If this is set to true the
+program specified in the link(bf("passwd program"))(passwdprogram)
+parameter is called em(*AS ROOT*) - to allow the new UNIX password to be
+set without access to the old UNIX password (as the SMB password has
+change code has no access to the old password cleartext, only the
+new). By default this is set to tt("false").
-.B Example:
- time server = True
+See also link(bf("passwd program"))(passwdprogram), link(bf("passwd
+chat"))(passwdchat).
-.SS unix password sync (G)
-This boolean parameter controlls whether Samba attempts to synchronise
-the UNIX password with the SMB password when the encrypted SMB password
-in the smbpasswd file is changed. If this is set to true the 'passwd program'
-program is called *AS ROOT* - to allow the new UNIX password to be set
-without access to the old UNIX password (as the SMB password has change
-code has no access to the old password cleartext, only the new). By
-default this is set to false.
+ bf(Default:)
+tt( unix password sync = False)
-See also 'passwd program', 'passwd chat'
+ bf(Example:)
+tt( unix password sync = True)
-.B Default:
- unix password sync = False
+label(unixrealname)
+dit(bf(unix realname (G)))
-.B Example:
- unix password sync = True
+This boolean parameter when set causes samba to supply the real name
+field from the unix password file to the client. This is useful for
+setting up mail clients and WWW browsers on systems used by more than
+one person.
-.SS unix realname (G)
-This boolean parameter when set causes samba to supply the real name field
-from the unix password file to the client. This is useful for setting up
-mail clients and WWW browsers on systems used by more than one person.
+ bf(Default:)
+tt( unix realname = no)
-.B Default:
- unix realname = no
+ bf(Example:)
+tt( unix realname = yes)
-.B Example:
- unix realname = yes
+label(updateencrypted)
+dit(bf(update encrypted (G)))
-.SS update encrypted (G)
This boolean parameter allows a user logging on with a plaintext
password to have their encrypted (hashed) password in the smbpasswd
-file to be updated automatically as they log on. This option allows
-a site to migrate from plaintext password authentication (users
+file to be updated automatically as they log on. This option allows a
+site to migrate from plaintext password authentication (users
authenticate with plaintext password over the wire, and are checked
against a UNIX account database) to encrypted password authentication
(the SMB challenge/response authentication mechanism) without forcing
-all users to re-enter their passwords via smbpasswd at the time the change
-is made. This is a convenience option to allow the change over to
-encrypted passwords to be made over a longer period. Once all users
+all users to re-enter their passwords via smbpasswd at the time the
+change is made. This is a convenience option to allow the change over
+to encrypted passwords to be made over a longer period. Once all users
have encrypted representations of their passwords in the smbpasswd
-file this parameter should be set to "off".
+file this parameter should be set to tt("off").
-In order for this parameter to work correctly the "encrypt passwords"
-must be set to "no" when this parameter is set to "yes".
+In order for this parameter to work correctly the link(bf("encrypt
+passwords"))(encryptpasswords) parameter must be set to tt("no") when
+this parameter is set to tt("yes").
Note that even when this parameter is set a user authenticating to
smbd must still enter a valid password in order to connect correctly,
and to update their hashed (smbpasswd) passwords.
-.B Default:
- update encrypted = no
+ bf(Default:)
+tt( update encrypted = no)
+
+ bf(Example:)
+tt( update encrypted = yes)
+
+label(userhosts)
+dit(bf(use rhosts (G)))
-.B Example:
- update encrypted = yes
+If this global parameter is a true, it specifies that the UNIX users
+tt(".rhosts") file in their home directory will be read to find the
+names of hosts and users who will be allowed access without specifying
+a password.
-.SS user (S)
-See
-.B username.
-.SS username (S)
-A synonym for this parameter is 'user'.
+NOTE: The use of bf(use rhosts) can be a major security hole. This is
+because you are trusting the PC to supply the correct username. It is
+very easy to get a PC to supply a false username. I recommend that the
+bf(use rhosts) option be only used if you really know what you are
+doing.
+
+ bf(Default:)
+tt( use rhosts = no)
+
+ bf(Example:)
+tt( use rhosts = yes)
+
+label(user)
+dit(bf(user (S)))
+
+Synonym for link(bf("username"))(username).
-Multiple users may be specified in a comma-delimited list, in which case the
-supplied password will be tested against each username in turn (left to right).
+label(users)
+dit(bf(users (S)))
-The username= line is needed only when the PC is unable to supply its own
-username. This is the case for the coreplus protocol or where your
-users have different WfWg usernames to UNIX usernames. In both these
-cases you may also be better using the \e\eserver\eshare%user syntax
-instead.
+Synonym for link(bf("username"))(username).
-The username= line is not a great solution in many cases as it means Samba
-will try to validate the supplied password against each of the
-usernames in the username= line in turn. This is slow and a bad idea for
-lots of users in case of duplicate passwords. You may get timeouts or
-security breaches using this parameter unwisely.
+label(username)
+dit(bf(username (S)))
+
+Multiple users may be specified in a comma-delimited list, in which
+case the supplied password will be tested against each username in
+turn (left to right).
+
+The bf(username=) line is needed only when the PC is unable to supply
+its own username. This is the case for the COREPLUS protocol or where
+your users have different WfWg usernames to UNIX usernames. In both
+these cases you may also be better using the tt(\\server\share%user)
+syntax instead.
+
+The bf(username=) line is not a great solution in many cases as it
+means Samba will try to validate the supplied password against each of
+the usernames in the username= line in turn. This is slow and a bad
+idea for lots of users in case of duplicate passwords. You may get
+timeouts or security breaches using this parameter unwisely.
Samba relies on the underlying UNIX security. This parameter does not
restrict who can login, it just offers hints to the Samba server as to
do.
To restrict a service to a particular set of users you can use the
-"valid users=" line.
+link(bf("valid users="))(validusers) parameter.
-If any of the usernames begin with a @ then the name will be looked up
-first in the yp netgroups list (if Samba is compiled with netgroup support),
-followed by a lookup in the UNIX groups database and will expand to a list of
-all users in the group of that name.
+If any of the usernames begin with a tt('@') then the name will be
+looked up first in the yp netgroups list (if Samba is compiled with
+netgroup support), followed by a lookup in the UNIX groups database
+and will expand to a list of all users in the group of that name.
-If any of the usernames begin with a + then the name will be looked up only
-in the UNIX groups database and will expand to a list of all users in the
-group of that name.
+If any of the usernames begin with a tt('+') then the name will be
+looked up only in the UNIX groups database and will expand to a list
+of all users in the group of that name.
-If any of the usernames begin with a & then the name will be looked up only
-in the yp netgroups database (if Samba is compiled with netgroup support) and
-will expand to a list of all users in the netgroup group of that name.
+If any of the usernames begin with a tt('&') then the name will be
+looked up only in the yp netgroups database (if Samba is compiled with
+netgroup support) and will expand to a list of all users in the
+netgroup group of that name.
-Note that searching though a groups database can take quite
-some time, and some clients may time out during the search.
+Note that searching though a groups database can take quite some time,
+and some clients may time out during the search.
-See the section below on username/password validation for more information
-on how this parameter determines access to the services.
+See the section link(bf("NOTE ABOUT USERNAME/PASSWORD
+VALIDATION"))(NOTEABOUTUSERNAMEPASSWORDVALIDATION) for more
+information on how this parameter determines access to the services.
-.B Default:
- The guest account if a guest service, else the name of the service.
+ bf(Default:)
+tt( The guest account if a guest service, else the name of the service.)
-.B Examples:
+ bf(Examples:)
+verb(
username = fred
username = fred, mary, jack, jane, @users, @pcgroup
+)
-.SS username level (G)
+label(usernamelevel)
+dit(bf(username level (G)))
This option helps Samba to try and 'guess' at the real UNIX username,
as many DOS clients send an all-uppercase username. By default Samba
tries all lowercase, followed by the username with the first letter
-capitalized, and fails if the username is not found on the UNIX machine.
+capitalized, and fails if the username is not found on the UNIX
+machine.
-If this parameter is set to non-zero the behaviour changes. This
-parameter is a number that specifies the number of uppercase combinations
-to try whilst trying to determine the UNIX user name. The higher the number
-the more combinations will be tried, but the slower the discovery
-of usernames will be. Use this parameter when you have strange
-usernames on your UNIX machine, such as 'AstrangeUser'.
+If this parameter is set to non-zero the behavior changes. This
+parameter is a number that specifies the number of uppercase
+combinations to try whilst trying to determine the UNIX user name. The
+higher the number the more combinations will be tried, but the slower
+the discovery of usernames will be. Use this parameter when you have
+strange usernames on your UNIX machine, such as tt("AstrangeUser").
-.B Default:
- username level = 0
+ bf(Default:)
+tt( username level = 0)
-.B Example:
- username level = 5
+ bf(Example:)
+tt( username level = 5)
-.SS username map (G)
+label(usernamemap)
+dit(bf(username map (G)))
-This option allows you to to specify a file containing a mapping of
+This option allows you to specify a file containing a mapping of
usernames from the clients to the server. This can be used for several
purposes. The most common is to map usernames that users use on DOS or
Windows machines to those that the UNIX box uses. The other is to map
files.
The map file is parsed line by line. Each line should contain a single
-UNIX username on the left then a '=' followed by a list of usernames
-on the right. The list of usernames on the right may contain names of
-the form @group in which case they will match any UNIX username in
-that group. The special client name '*' is a wildcard and matches any
-name. Each line of the map file may be up to 1023 characters long.
+UNIX username on the left then a tt('=') followed by a list of
+usernames on the right. The list of usernames on the right may contain
+names of the form @group in which case they will match any UNIX
+username in that group. The special client name tt('*') is a wildcard
+and matches any name. Each line of the map file may be up to 1023
+characters long.
The file is processed on each line by taking the supplied username and
-comparing it with each username on the right hand side of the '='
-signs. If the supplied name matches any of the names on the right
-hand side then it is replaced with the name on the left. Processing
-then continues with the next line.
+comparing it with each username on the right hand side of the tt('=')
+signs. If the supplied name matches any of the names on the right hand
+side then it is replaced with the name on the left. Processing then
+continues with the next line.
-If any line begins with a '#' or a ';' then it is ignored
+If any line begins with a tt('#') or a tt(';') then it is ignored
-If any line begins with an ! then the processing will stop after that
-line if a mapping was done by the line. Otherwise mapping continues
-with every line being processed. Using ! is most useful when you have
-a wildcard mapping line later in the file.
+If any line begins with an tt('!') then the processing will stop after
+that line if a mapping was done by the line. Otherwise mapping
+continues with every line being processed. Using tt('!') is most
+useful when you have a wildcard mapping line later in the file.
-For example to map from the name "admin" or "administrator" to the UNIX
-name "root" you would use
+For example to map from the name tt("admin") or tt("administrator") to
+the UNIX name tt("root") you would use:
- root = admin administrator
-Or to map anyone in the UNIX group "system" to the UNIX name "sys" you
-would use
+tt( root = admin administrator)
- sys = @system
+Or to map anyone in the UNIX group tt("system") to the UNIX name
+tt("sys") you would use:
+
+tt( sys = @system)
You can have as many mappings as you like in a username map file.
-If Samba has been compiled with the -DNETGROUP compile option
-then the netgroup database is checked before the /etc/group
-database for matching groups.
+If your system supports the NIS NETGROUP option then the netgroup
+database is checked before the tt(/etc/group) database for matching
+groups.
You can map Windows usernames that have spaces in them by using double
quotes around the name. For example:
- tridge = "Andrew Tridgell"
+tt( tridge = "Andrew Tridgell")
-would map the windows username "Andrew Tridgell" to the unix username
-tridge.
+would map the windows username tt("Andrew Tridgell") to the unix
+username tridge.
The following example would map mary and fred to the unix user sys,
-and map the rest to guest. Note the use of the ! to tell Samba to stop
-processing if it gets a match on that line.
+and map the rest to guest. Note the use of the tt('!') to tell Samba
+to stop processing if it gets a match on that line.
+verb(
!sys = mary fred
guest = *
-
+)
Note that the remapping is applied to all occurrences of
-usernames. Thus if you connect to "\e\eserver\efred" and "fred" is
-remapped to "mary" then you will actually be connecting to
-"\e\eserver\emary" and will need to supply a password suitable for
-"mary" not "fred". The only exception to this is the username passed
-to the "password server" (if you have one). The password server will
-receive whatever username the client supplies without modification.
+usernames. Thus if you connect to tt("\\server\fred") and tt("fred")
+is remapped to tt("mary") then you will actually be connecting to
+tt("\\server\mary") and will need to supply a password suitable for
+tt("mary") not tt("fred"). The only exception to this is the username
+passed to the link(bf("password server"))(passwordserver) (if you have
+one). The password server will receive whatever username the client
+supplies without modification.
Also note that no reverse mapping is done. The main effect this has is
with printing. Users who have been mapped may have trouble deleting
print jobs as PrintManager under WfWg will think they don't own the
print job.
-.B Default
- no username map
+ bf(Default:)
+tt( no username map)
-.B Example
- username map = /usr/local/samba/lib/users.map
+ bf(Example:)
+tt( username map = /usr/local/samba/lib/users.map)
-.SS valid chars (S)
+label(validchars)
+dit(bf(valid chars (S)))
The option allows you to specify additional characters that should be
considered valid by the server in filenames. This is particularly
you can specify the characters in octal, decimal or hexadecimal form
using the usual C notation.
-For example to add the single character 'Z' to the charset (which is a
-pointless thing to do as it's already there) you could do one of the
-following
+For example to add the single character tt('Z') to the charset (which
+is a pointless thing to do as it's already there) you could do one of
+the following
-valid chars = Z
-valid chars = z:Z
-valid chars = 0132:0172
+verb(
+ valid chars = Z
+ valid chars = z:Z
+ valid chars = 0132:0172
+)
-The last two examples above actually add two characters, and alter
-the uppercase and lowercase mappings appropriately.
+The last two examples above actually add two characters, and alter the
+uppercase and lowercase mappings appropriately.
-Note that you MUST specify this parameter after the "client code page"
-parameter if you have both set. If "client code page" is set after
-the "valid chars" parameter the "valid chars" settings will be
+Note that you MUST specify this parameter after the link(bf("client
+code page"))(clientcodepage) parameter if you have both set. If
+link(bf("client code page"))(clientcodepage) is set after the
+bf("valid chars") parameter the bf("valid chars") settings will be
overwritten.
-See also the "client code page" parameter.
+See also the link(bf("client code page"))(clientcodepage) parameter.
-.B Default
-.br
+ bf(Default:)
+verb(
Samba defaults to using a reasonable set of valid characters
-.br
- for english systems
+ for English systems
+)
+
+ bf(Example)
+tt( valid chars = 0345:0305 0366:0326 0344:0304)
-.B Example
- valid chars = 0345:0305 0366:0326 0344:0304
+The above example allows filenames to have the Swedish characters in
+them.
-The above example allows filenames to have the swedish characters in
-them.
+NOTE: It is actually quite difficult to correctly produce a bf("valid
+chars") line for a particular system. To automate the process
+email(tino@augsburg.net) has written a package called bf("validchars")
+which will automatically produce a complete bf("valid chars") line for
+a given client system. Look in the examples/validchars/ subdirectory
+of your Samba source code distribution for this package.
-NOTE: It is actually quite difficult to correctly produce a "valid
-chars" line for a particular system. To automate the process
-tino@augsburg.net has written a package called "validchars" which will
-automatically produce a complete "valid chars" line for a given client
-system. Look in the examples subdirectory for this package.
+label(validusers)
+dit(bf(valid users (S)))
-.SS valid users (S)
This is a list of users that should be allowed to login to this
-service. A name starting with @ is interpreted as a UNIX group.
+service. Names starting with tt('@'), tt('+') and tt('&') are
+interpreted using the same rules as described in the link(bf("invalid
+users"))(invalidusers) parameter.
If this is empty (the default) then any user can login. If a username
-is in both this list and the "invalid users" list then access is
-denied for that user.
+is in both this list and the link(bf("invalid users"))(invalidusers)
+list then access is denied for that user.
-The current servicename is substituted for %S. This is useful in the
-[homes] section.
+The current servicename is substituted for
+link(bf("%S"))(percentS). This is useful in the
+link(bf([homes]))(homes) section.
-See also "invalid users"
+See also link(bf("invalid users"))(invalidusers).
-.B Default
- No valid users list. (anyone can login)
+ bf(Default:)
+tt( No valid users list. (anyone can login))
-.B Example
- valid users = greg, @pcusers
+ bf(Example:)
+tt( valid users = greg, @pcusers)
+label(vetofiles)
+dit(bf(veto files(S)))
-.SS veto files(S)
This is a list of files and directories that are neither visible nor
-accessible. Each entry in the list must be separated by a "/", which
-allows spaces to be included in the entry. '*' and '?' can be used to
-specify multiple files or directories as in DOS wildcards.
+accessible. Each entry in the list must be separated by a tt('/'),
+which allows spaces to be included in the entry. tt('*') and tt('?')
+can be used to specify multiple files or directories as in DOS
+wildcards.
-Each entry must be a unix path, not a DOS path and must not include the
-unix directory separator "/".
+Each entry must be a unix path, not a DOS path and must em(*not*) include the
+unix directory separator tt('/').
-Note that the case sensitivity option is applicable in vetoing files.
+Note that the link(bf("case sensitive"))(casesensitive) option is
+applicable in vetoing files.
One feature of the veto files parameter that it is important to be
-aware of, is that if a directory contains nothing but files that
-match the veto files parameter (which means that Windows/DOS clients
-cannot ever see them) is deleted, the veto files within that directory
-*are automatically deleted* along with it, if the user has UNIX permissions
+aware of, is that if a directory contains nothing but files that match
+the veto files parameter (which means that Windows/DOS clients cannot
+ever see them) is deleted, the veto files within that directory *are
+automatically deleted* along with it, if the user has UNIX permissions
to do so.
-Setting this parameter will affect the performance of Samba, as
-it will be forced to check all files and directories for a match
-as they are scanned.
+Setting this parameter will affect the performance of Samba, as it
+will be forced to check all files and directories for a match as they
+are scanned.
+
+See also link(bf("hide files"))(hidefiles) and link(bf("case
+sensitive"))(casesensitive).
-See also "hide files" and "case sensitive"
+ bf(Default:)
+tt( No files or directories are vetoed.)
-.B Default
- No files or directories are vetoed.
+ bf(Examples:)
-.B Examples
Example 1.
+
+verb(
+
Veto any files containing the word Security,
any ending in .tmp, and any directory containing the
word root.
veto files = /*Security*/*.tmp/*root*/
+)
Example 2.
+
+verb(
Veto the Apple specific files that a NetAtalk server
creates.
veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
+)
-.SS veto oplock files (S)
-This parameter is only valid when the 'oplocks' parameter is turned on
-for a share. It allows the Samba administrator to selectively turn off
-the granting of oplocks on selected files that match a wildcarded list,
-similar to the wildcarded list used in the 'veto files' parameter.
+label(vetooplockfiles)
+dit(bf(veto oplock files (S)))
-.B Default
- No files are vetoed for oplock grants.
+This parameter is only valid when the link(bf("oplocks"))(oplocks)
+parameter is turned on for a share. It allows the Samba administrator
+to selectively turn off the granting of oplocks on selected files that
+match a wildcarded list, similar to the wildcarded list used in the
+link(bf("veto files"))(vetofiles) parameter.
+
+ bf(Default:)
+tt( No files are vetoed for oplock grants.)
+
+ bf(Examples:)
-.B Examples
You might want to do this on files that you know will be heavily
contended for by clients. A good example of this is in the NetBench
SMB benchmark program, which causes heavy client contention for files
-ending in .SEM. To cause Samba not to grant oplocks on these files
-you would use the line (either in the [global] section or in the section
-for the particular NetBench share :
+ending in tt(".SEM"). To cause Samba not to grant oplocks on these
+files you would use the line (either in the link(bf([global]))(global)
+section or in the section for the particular NetBench share :
+
+tt( veto oplock files = /*.SEM/)
- veto oplock files = /*.SEM/
+label(volume)
+dit(bf(volume (S)))
-.SS volume (S)
This allows you to override the volume label returned for a
share. Useful for CDROMs with installation programs that insist on a
particular volume label.
-The default is the name of the share
+The default is the name of the share.
-.SS wide links (S)
-This parameter controls whether or not links in the UNIX file system may be
-followed by the server. Links that point to areas within the directory tree
-exported by the server are always allowed; this parameter controls access
-only to areas that are outside the directory tree being exported.
+label(widelinks)
+dit(bf(wide links (S)))
-.B Default:
- wide links = yes
+This parameter controls whether or not links in the UNIX file system
+may be followed by the server. Links that point to areas within the
+directory tree exported by the server are always allowed; this
+parameter controls access only to areas that are outside the directory
+tree being exported.
-.B Example:
- wide links = no
+ bf(Default:)
+tt( wide links = yes)
-.SS wins proxy (G)
+ bf(Example:)
+tt( wide links = no)
-This is a boolean that controls if nmbd will respond to broadcast name
-queries on behalf of other hosts. You may need to set this to no for
-some older clients.
+label(winsproxy)
+dit(bf(wins proxy (G)))
-.B Default:
- wins proxy = no
-.SS wins server (G)
+This is a boolean that controls if url(bf(nmbd))(nmbd.8.html) will
+respond to broadcast name queries on behalf of other hosts. You may
+need to set this to tt("yes") for some older clients.
-This specifies the DNS name (or IP address) of the WINS server that Samba
-should register with. If you have a WINS server on your network then you
-should set this to the WINS servers name.
+ bf(Default:)
+tt( wins proxy = no)
-You should point this at your WINS server if you have a multi-subnetted
-network.
-.B Default:
- wins server =
+label(winsserver)
+dit(bf(wins server (G)))
-.SS wins support (G)
+This specifies the DNS name (or IP address) of the WINS server that
+url(bf(nmbd))(nmbd.8.html) should register with. If you have a WINS
+server on your network then you should set this to the WINS servers
+name.
-This boolean controls if the nmbd process in Samba will act as a WINS server.
-You should not set this to true unless you have a multi-subnetted network and
-you wish a particular nmbd to be your WINS server. Note that you
-should *NEVER* set this to true on more than one machine in your
+You should point this at your WINS server if you have a
+multi-subnetted network.
+
+em(NOTE). You need to set up Samba to point to a WINS server if you
+have multiple subnets and wish cross-subnet browsing to work correctly.
+
+See the documentation file BROWSING.txt in the docs/ directory of your
+Samba source distribution.
+
+ bf(Default:)
+tt( wins server = )
+
+ bf(Example:)
+tt( wins server = 192.9.200.1)
+
+label(winssupport)
+dit(bf(wins support (G)))
+
+This boolean controls if the url(bf(nmbd))(nmbd.8.html) process in
+Samba will act as a WINS server. You should not set this to true
+unless you have a multi-subnetted network and you wish a particular
+url(bf(nmbd))(nmbd.8.html) to be your WINS server. Note that you
+should em(*NEVER*) set this to true on more than one machine in your
network.
-.B Default:
- wins support = no
+ bf(Default:)
+tt( wins support = no)
-.SS workgroup (G)
+label(workgroup)
+dit(bf(workgroup (G)))
This controls what workgroup your server will appear to be in when
-queried by clients.
+queried by clients. Note that this parameter also controls the Domain
+name used with the link(bf("security=domain"))(securityequaldomain)
+setting.
-.B Default:
- set in the Makefile
+ bf(Default:)
+tt( set at compile time to WORKGROUP)
-.B Example:
+ bf(Example:)
workgroup = MYGROUP
-.SS writable (S)
-A synonym for this parameter is 'write ok'. An inverted synonym is 'read only'.
-
-If this parameter is 'no', then users of a service may not create or modify
-files in the service's directory.
+label(writable)
+dit(bf(writable (S)))
-Note that a printable service ('printable = yes') will ALWAYS allow
-writing to the directory (user privileges permitting), but only via
-spooling operations.
+Synonym for link(bf("writeable"))(writeable) for people who can't spell :-).
-.B Default:
- writable = no
+label(writelist)
+dit(bf(write list (S)))
-.B Examples:
- read only = no
- writable = yes
- write ok = yes
-.SS write list (S)
This is a list of users that are given read-write access to a
service. If the connecting user is in this list then they will be
-given write access, no matter what the "read only" option is set
-to. The list can include group names using the @group syntax.
+given write access, no matter what the link(bf("read only"))(readonly)
+option is set to. The list can include group names using the @group
+syntax.
Note that if a user is in both the read list and the write list then
they will be given write access.
-See also the "read list" option
+See also the link(bf("read list"))(readlist) option.
+
+ bf(Default:)
+tt( write list = <empty string>)
+
+ bf(Example:)
+tt( write list = admin, root, @staff)
-.B Default:
- write list =
+label(writeok)
+dit(bf(write ok (S)))
-.B Example:
- write list = admin, root, @staff
+Synonym for link(bf(writeable))(writeable).
-.SS write ok (S)
-See
-.B writable
-and
-.B read only.
-.SS write raw (G)
-This parameter controls whether or not the server will support raw writes when
-transferring data from clients.
+label(writeraw)
+dit(bf(write raw (G)))
-.B Default:
- write raw = yes
+This parameter controls whether or not the server will support raw
+writes SMB's when transferring data from clients. You should never
+need to change this parameter.
-.B Example:
- write raw = no
+ bf(Default:)
+tt( write raw = yes)
-.SH NOTE ABOUT USERNAME/PASSWORD VALIDATION
-There are a number of ways in which a user can connect to a
-service. The server follows the following steps in determining if it
-will allow a connection to a specified service. If all the steps fail
-then the connection request is rejected. If one of the steps pass then
-the following steps are not checked.
+label(writeable)
+dit(bf(writeable))
-If the service is marked "guest only = yes" then steps 1 to 5 are skipped
+An inverted synonym is link(bf("read only"))(readonly).
-Step 1: If the client has passed a username/password pair and that
-username/password pair is validated by the UNIX system's password
-programs then the connection is made as that username. Note that this
-includes the \e\eserver\eservice%username method of passing a username.
-
-Step 2: If the client has previously registered a username with the
-system and now supplies a correct password for that username then the
-connection is allowed.
-
-Step 3: The client's netbios name and any previously used user names
-are checked against the supplied password, if they match then the
-connection is allowed as the corresponding user.
-
-Step 4: If the client has previously validated a username/password
-pair with the server and the client has passed the validation token
-then that username is used. This step is skipped if "revalidate = yes"
-for this service.
-
-Step 5: If a "user = " field is given in the smb.conf file for the
-service and the client has supplied a password, and that password
-matches (according to the UNIX system's password checking) with one of
-the usernames from the user= field then the connection is made as the
-username in the "user=" line. If one of the username in the user= list
-begins with a @ then that name expands to a list of names in the group
-of the same name.
-
-Step 6: If the service is a guest service then a connection is made as
-the username given in the "guest account =" for the service,
-irrespective of the supplied password.
-.SH WARNINGS
-Although the configuration file permits service names to contain spaces,
-your client software may not. Spaces will be ignored in comparisons anyway,
-so it shouldn't be a problem - but be aware of the possibility.
-
-On a similar note, many clients - especially DOS clients - limit service
-names to eight characters. Smbd has no such limitation, but attempts
-to connect from such clients will fail if they truncate the service names.
-For this reason you should probably keep your service names down to eight
-characters in length.
-
-Use of the [homes] and [printers] special sections make life for an
-administrator easy, but the various combinations of default attributes can be
-tricky. Take extreme care when designing these sections. In particular,
-ensure that the permissions on spool directories are correct.
-.SH VERSION
-This man page is (mostly) correct for version 1.9.18 of the Samba suite, plus some
-of the recent patches to it. These notes will necessarily lag behind
-development of the software, so it is possible that your version of
-the server has extensions or parameter semantics that differ from or are not
-covered by this man page. Please notify these to the address below for
-rectification.
-
-Prior to version 1.5.21 of the Samba suite, the configuration file was
-radically different (more primitive). If you are using a version earlier than
-1.8.05, it is STRONGLY recommended that you upgrade.
-.SH OPTIONS
-Not applicable.
-.SH FILES
-Not applicable.
-.SH ENVIRONMENT VARIABLES
-Not applicable.
-.SH SEE ALSO
-.BR smbd (8),
-.BR smbclient (1),
-.BR nmbd (8),
-.BR testparm (1),
-.BR testprns (1),
-.BR lpq (1),
-.BR hosts_access (5)
-.SH DIAGNOSTICS
-[This section under construction]
-
-Most diagnostics issued by the server are logged in a specified log file. The
-log file name is specified at compile time, but may be overridden on the
-smbd command line (see
-.BR smbd (8)).
-
-The number and nature of diagnostics available depends on the debug level used
-by the server. If you have problems, set the debug level to 3 and peruse the
-log files.
-
-Most messages are reasonably self-explanatory. Unfortunately, at time of
-creation of this man page the source code is still too fluid to warrant
-describing each and every diagnostic. At this stage your best bet is still
-to grep the source code and inspect the conditions that gave rise to the
-diagnostics you are seeing.
-.SH BUGS
-None known.
-
-Please send bug reports, comments and so on to:
-
-.RS 3
-.B samba-bugs@samba.anu.edu.au (Andrew Tridgell)
-
-.RS 3
-or to the mailing list:
-.RE
-
-.B samba@listproc.anu.edu.au
-
-.RE
-You may also like to subscribe to the announcement channel:
-
-.RS 3
-.B samba-announce@listproc.anu.edu.au
-.RE
-
-To subscribe to these lists send a message to
-listproc@listproc.anu.edu.au with a body of "subscribe samba Your
-Name" or "subscribe samba-announce Your Name".
-
-Errors or suggestions for improvements to the Samba man pages should be
-mailed to:
-
-.RS 3
-.B samba-bugs@samba.anu.edu.au (Andrew Tridgell)
-.RE
+If this parameter is tt("no"), then users of a service may not create
+or modify files in the service's directory.
+
+Note that a printable service link(bf(("printable = yes")))(printable)
+will em(*ALWAYS*) allow writing to the directory (user privileges
+permitting), but only via spooling operations.
+
+ bf(Default:)
+tt( writeable = no)
+
+ bf(Examples:)
+verb(
+ read only = no
+ writeable = yes
+ write ok = yes
+)
+label(WARNINGS)
+manpagesection(WARNINGS)
+
+Although the configuration file permits service names to contain
+spaces, your client software may not. Spaces will be ignored in
+comparisons anyway, so it shouldn't be a problem - but be aware of the
+possibility.
+
+On a similar note, many clients - especially DOS clients - limit
+service names to eight characters. url(bf(Smbd))(smbd.8.html) has no
+such limitation, but attempts to connect from such clients will fail
+if they truncate the service names. For this reason you should
+probably keep your service names down to eight characters in length.
+
+Use of the link(bf([homes]))(homes) and link(bf([printers]))(printers)
+special sections make life for an administrator easy, but the various
+combinations of default attributes can be tricky. Take extreme care
+when designing these sections. In particular, ensure that the
+permissions on spool directories are correct.
+
+label(VERSION)
+manpagesection(VERSION)
+
+This man page is correct for version 2.0 of the Samba suite.
+
+label(SEEALSO)
+manpagesection(SEE ALSO)
+
+url(bf(smbd (8)))(smbd.8.html), url(bf(smbclient (1)))(smbclient.1.html),
+url(bf(nmbd (8)))(nmbd.8.html), url(bf(testparm (1)))(testparm.1.html),
+url(bf(testprns (1)))(testprns.1.html), url(bf(Samba))(samba.7.html),
+url(bf(nmblookup (1)))(nmblookup.1.html), url(bf(smbpasswd (5)))(smbpasswd.5.html),
+url(bf(smbpasswd (8)))(smbpasswd.8.html).
+
+label(AUTHOR)
+manpageauthor()
+
+The original Samba software and related utilities were created by
+Andrew Tridgell email(samba-bugs@samba.anu.edu.au). Samba is now developed
+by the Samba Team as an Open Source project similar to the way the
+Linux kernel is developed.
+
+The original Samba man pages were written by Karl Auer. The man page
+sources were converted to YODL format (another excellent piece of Open
+Source software, available at
+url(bf(ftp://ftp.icce.rug.nl/pub/unix/))(ftp://ftp.icce.rug.nl/pub/unix/))
+and updated for the Samba2.0 release by Jeremy Allison.
+email(samba-bugs@samba.anu.edu.au).
+
+See url(bf(samba (7)))(samba.7.html) to find out how to get a full
+list of contributors and details on how to submit bug reports,
+comments etc.
git.samba.org / samba.git / blobdiff