This is finished but still doesn't compile in YODL.

[kai/samba.git] / docs / yodldocs / smb.conf.5.yo

mailto(samba-bugs@samba.anu.edu.au) 

manpage(smb.conf)(5)(23 Oct 1998)(Samba)(SAMBA)

label(NAME)
manpagename(smb.conf)(The configuration file for the Samba suite)

label(SYNOPSIS)
manpagesynopsis() 

bf(smb.conf) The bf(smb.conf) file is a configuration file for the
Samba suite. bf(smb.conf) contains runtime configuration information
for the Samba programs. The bf(smb.conf) file is designed to be
configured and administered by the url(bf(swat (8)))(swat.8.html)
program. The complete description of the file format and possible
parameters held within are here for reference purposes.

label(FILEFORMAT)
manpagesection(FILE FORMAT)

The file consists of sections and parameters. A section begins with
the name of the section in square brackets and continues until the
next section begins. Sections contain parameters of the form 

tt('name = value')

The file is line-based - that is, each newline-terminated line
represents either a comment, a section name or a parameter.

Section and parameter names are not case sensitive.

Only the first equals sign in a parameter is significant. Whitespace
before or after the first equals sign is discarded. Leading, trailing
and internal whitespace in section and parameter names is
irrelevant. Leading and trailing whitespace in a parameter value is
discarded. Internal whitespace within a parameter value is retained
verbatim.

Any line beginning with a semicolon (';') or a hash ('#') character is
ignored, as are lines containing only whitespace.

Any line ending in a tt('\') is "continued" on the next line in the
customary UNIX fashion.

The values following the equals sign in parameters are all either a
string (no quotes needed) or a boolean, which may be given as yes/no,
0/1 or true/false. Case is not significant in boolean values, but is
preserved in string values. Some items such as create modes are
numeric.

label(SECTIONDESCRIPTIONS)
manpagesection(SECTION DESCRIPTIONS)

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 section descriptions.

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.

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).

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.

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 share definition. For modern clients such as Windows 95/98 and
Windows NT, this should not be neccessary.

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 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

)

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
as the default guest user (specified elsewhere):

verb(
        [aprinter]
                path = /usr/spool/public
                read only = true
                printable = true
                guest ok = true
)

label(SPECIALSECTIONS)
manpagesection(SPECIAL SECTIONS)

startdit()

label(global)
dit(bf(The [global] section))

Parameters in this section apply to the server as a whole, or are
defaults for sections which do not specifically define certain
items. See the notes under link(bf('Parameters'))(Parameters) for more
information.

label(homes)
dit(bf(The [homes] section))

If a section called tt('homes') is included in the configuration file,
services connecting clients to their home directories can be created
on the fly by the server.

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 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 share:

startit()

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
directory.

endit()

If you decide to use a link(bf(path=))(path) line in your [homes]
section then you may find it useful to use the link(bf(%S))(percentS)
macro. For example :

tt(path=/data/pchome/%S)

would be useful if you have different home directories for your PCs
than for UNIX access.

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 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.

The [homes] section can specify all the parameters a normal service
section can specify, though some make more sense than others. The
following is a typical and suitable [homes] section:

verb(
        [homes]
                writable = yes
)

An important point is that if guest access is specified in the [homes]
section, all home directories will be visible to all clients
bf(without a password). In the very unlikely event that this is
actually desirable, it would be wise to also specify link(bf(read only
access))(readonly).

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] share but
make any auto home directories visible.

label(printers)
dit(bf(The [printers] section))

This section works like link(bf([homes]))(homes), but for printers.

If a [printers] section occurs in the configuration file, users are
able to connect to any printer specified in the local host's printcap
file.

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 section name is treated as a printer
name and the appropriate printcap file is scanned to see if the
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 share:

startit()

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 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
directory with the sticky bit set on it. A typical [printers] entry
would look like this:

verb(
        [printers]
                path = /usr/spool/public
                writable = no
                guest ok = yes
                printable = yes 
)

All aliases given for a printer in the printcap file are legitimate
printer names as far as the server is concerned. If your printing
subsystem doesn't work like that, you will have to set up a
pseudo-printcap. This is a file consisting of one or more lines like
this:

verb(        alias|alias|alias|alias...    )

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
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.

An alias, by the way, is defined as any component of the first entry
of a printcap record. Records are separated by newlines, components
(if there are more than one) are separated by vertical bar symbols
("|").

NOTE: On SYSV systems which use lpstat to determine what printers are
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.

enddit()

label(PARAMETERS)
manpagesection(PARAMETERS)

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
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.
The letter tt('G') in parentheses indicates that a parameter is
specific to the link(bf([global]))(global) section. The letter tt('S')
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.

Parameters are arranged here in alphabetical order - this may not
create best bedfellows, but at least you can find them! Where there
are synonyms, the preferred synonym is described, others refer to the
preferred synonym.

label(VARIABLESUBSTITUTIONS)
manpagesection(VARIABLE SUBSTITUTIONS)

Many of the strings that are settable in the config file can take
substitutions. For example the option link(bf(tt("path =
/tmp/%u")))(path) would be interpreted as tt("path = /tmp/john") if
the user connected with the username john.

These substitutions are mostly noted in the descriptions below, but
there are some general substitutions which apply whenever they might
be relevant. These are:

startit()

label(percentS) 
it() bf(%S) = the name of the current service, if any.

label(percentP)
it() bf(%P) = the root directory of the current service, if any.

label(percentu)
it() bf(%u) = user name of the current service, if any.

label(percentg)
it() bf(%g) = primary group name of link(bf(%u))(percentu).

label(percentU) 
it() bf(%U) = session user name (the user name that
the client wanted, not necessarily the same as the one they got).

label(percentG)
it() bf(%G) = primary group name of link(bf(%U))(percentU).

label(percentH)
it() bf(%H) = the home directory of the user given by link(bf(%u))(percentu).

label(percentv)
it() bf(%v) = the Samba version.

label(percenth)
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).

label(percentL)
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(percentM) 
it() bf(%M) = the internet name of the client machine.

label(percentN)
it() bf(%N) = the name of your NIS home directory server.  This is
obtained from your NIS auto.map entry.  If you have not compiled Samba
with the bf(--with-automount) option then this value will be the same
as link(bf(%L))(percentL).

label(percentp)
it() bf(%p) = the path of the service's home directory, obtained from your NIS
auto.map entry. The NIS auto.map entry is split up as "%N:%p".

label(percentR) 
it() bf(%R) = the selected protocol level after protocol
negotiation. It can be one of CORE, COREPLUS, LANMAN1, LANMAN2 or NT1.

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(percentI)
it() bf(%I) = The IP address of the client machine.

label(percentT)
it() bf(%T) = the current date and time.

endit()

There are some quite creative things that can be done with these
substitutions and other smb.conf options.

label(NAMEMANGLING)
manpagesection(NAME MANGLING)

Samba supports em("name mangling") so that DOS and Windows clients can
use files that don't conform to the 8.3 format. It can also be set to
adjust the case of 8.3 format filenames.

There are several options that control the way mangling is performed,
and they are grouped here rather than listed separately. For the
defaults look at the output of the testparm program.

All of these options can be set separately for each service (or
globally, of course).

The options are:

label(manglecaseoption)
bf("mangle case = yes/no") controls if names that have characters that
aren't of the "default" case are mangled. For example, if this is yes
then a name like tt("Mail") would be mangled. Default em(no).

label(casesensitiveoption)
bf("case sensitive = yes/no") controls whether filenames are case
sensitive. If they aren't then Samba must do a filename search and
match on passed names. Default em(no).

label(defaultcaseoption)
bf("default case = upper/lower") controls what the default case is for new
filenames. Default em(lower).

label(preservecaseoption)
bf("preserve case = yes/no") controls if new files are created with the
case that the client passes, or if they are forced to be the tt("default")
case. Default em(Yes).

label(shortpreservecaseoption)

bf("short preserve case = yes/no") 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).

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)

Here is a list of all global parameters. See the section of each
parameter for details.  Note that some are synonyms.

startit()

it() link(bf(announce as))(announceas)

it() link(bf(announce version))(announceversion)

it() link(bf(auto services))(autoservices)

it() link(bf(bind interfaces only))(bindinterfacesonly)

it() link(bf(browse list))(browselist)

it() link(bf(change notify timeout))(changenotifytimeout)

it() link(bf(character set))(characterset)

it() link(bf(client code page))(clientcodepage)

it() link(bf(coding system))(codingsystem)

it() link(bf(config file))(configfile)

it() link(bf(deadtime))(deadtime)

it() link(bf(debug timestamp))(debugtimestamp)

it() link(bf(debuglevel))(debuglevel)

it() link(bf(default))(default)

it() link(bf(default service))(defaultservice)

it() link(bf(dfree command))(dfreecommand)

it() link(bf(dns proxy))(dns proxy)

it() link(bf(domain admin group))(domainadmingroup)

it() link(bf(domain admin users))(domainadminusers)

it() link(bf(domain controller))(domaincontroller)

it() link(bf(domain groups))(domaingroups)

it() link(bf(domain guest group))(domainguestgroup)

it() link(bf(domain guest users))(domainguestusers)

it() link(bf(domain logons))(domainlogons)

it() link(bf(domain master))(domainmaster)

it() link(bf(encrypt passwords))(encryptpasswords)

it() link(bf(getwd cache))(getwdcache)

it() link(bf(homedir map))(homedirmap)

it() link(bf(hosts equiv))(hostsequiv)

it() link(bf(interfaces))(interfaces)

it() link(bf(keepalive))(keepalive)

it() link(bf(kernel oplocks))(kerneloplocks)

it() link(bf(ldap filter))(ldapfilter)

it() link(bf(ldap port))(ldapport)

it() link(bf(ldap root))(ldaproot)

it() link(bf(ldap root passwd))(ldaprootpasswd)

it() link(bf(ldap server))(ldapserver)

it() link(bf(ldap suffix))(ldapsuffix)

it() link(bf(lm announce))(lmannounce)

it() link(bf(lm interval))(lminterval)

it() link(bf(load printers))(loadprinters)

it() link(bf(local master))(localmaster)

it() link(bf(lock dir))(lockdir)

it() link(bf(lock directory))(lockdirectory)

it() link(bf(log file))(logfile)

it() link(bf(log level))(loglevel)

it() link(bf(logon drive))(logondrive)

it() link(bf(logon home))(logonhome)

it() link(bf(logon path))(logonpath)

it() link(bf(logon script))(logonscript)

it() link(bf(lpq cache time))(lpqcachetime)

it() link(bf(machine password timeout))(machinepasswordtimeout)

it() link(bf(mangled stack))(mangledstack)

it() link(bf(max disk size))(maxdisksize)

it() link(bf(max log size))(maxlogsize)

it() link(bf(max mux))(maxmux)

it() link(bf(max open files))(maxopenfiles)

it() link(bf(max packet))(maxpacket)

it() link(bf(max ttl))(maxttl)

it() link(bf(max wins ttl))(maxwinsttl)

it() link(bf(max xmit))(maxxmit)

it() link(bf(message command))(messagecommand)

it() link(bf(min wins ttl))(minwinsttl)

it() link(bf(name resolve order))(nameresolveorder)

it() link(bf(netbios aliases))(netbiosaliases)

it() link(bf(netbios name))(netbiosname)

it() link(bf(networkstation user login))(networkstationuserlogin)

it() link(bf(NIS homedir))(NIShomedir)

it() link(bf(nt pipe support))(ntpipesupport)

it() link(bf(nt smb support))(ntsmbsupport)

it() link(bf(null passwords))(nullpasswords)

it() link(bf(ole locking compatibility))(olelockingcompatibility)

it() link(bf(os level))(oslevel)

it() link(bf(packet size))(packetsize)

it() link(bf(panic action))(panicaction)

it() link(bf(passwd chat))(passwdchat)

it() link(bf(passwd chat debug))(passwdchatdebug)

it() link(bf(passwd program))(passwdprogram)

it() link(bf(password level))(passwordlevel)

it() link(bf(password server))(passwordserver)

it() link(bf(prefered master))(preferedmaster)

it() link(bf(preferred master))(preferredmaster)

it() link(bf(preload))(preload)

it() link(bf(printcap))(printcap)

it() link(bf(printcap name))(printcapname)

it() link(bf(printer driver file))(printerdriverfile)

it() link(bf(protocol))(protocol)

it() link(bf(read bmpx))(readbmpx)

it() link(bf(read prediction))(readprediction)

it() link(bf(read raw))(readraw)

it() link(bf(read size))(readsize)

it() link(bf(remote announce))(remoteannounce)

it() link(bf(remote browse sync))(remotebrowsesync)

it() link(bf(root))(root)

it() link(bf(root dir))(rootdir)

it() link(bf(root directory))(rootdirectory)

it() link(bf(security))(security)

it() link(bf(server string))(serverstring)

it() link(bf(shared mem size))(sharedmemsize)

it() link(bf(smb passwd file))(smbpasswdfile)

it() link(bf(smbrun))(smbrun)

it() link(bf(socket address))(socketaddress)

it() link(bf(socket options))(socketoptions)

it() link(bf(ssl))(ssl)

it() link(bf(ssl CA certDir))(sslCAcertDir)

it() link(bf(ssl CA certFile))(sslCAcertFile)

it() link(bf(ssl ciphers))(sslciphers)

it() link(bf(ssl client cert))(sslclientcert)

it() link(bf(ssl client key))(sslclientkey)

it() link(bf(ssl compatibility))(sslcompatibility)

it() link(bf(ssl hosts))(sslhosts)

it() link(bf(ssl hosts resign))(sslhostsresign)

it() link(bf(ssl require clientcert))(sslrequireclientcert)

it() link(bf(ssl require servercert))(sslrequireservercert)

it() link(bf(ssl server cert))(sslservercert)

it() link(bf(ssl server key))(sslserverkey)

it() link(bf(ssl version))(sslversion)

it() link(bf(stat cache))(statcache)

it() link(bf(stat cache size))(statcachesize)

it() link(bf(strip dot))(stripdot)

it() link(bf(syslog))(syslog)

it() link(bf(syslog only))(syslogonly)

it() link(bf(time offset))(timeoffset)

it() link(bf(time server))(timeserver)

it() link(bf(timestamp logs))(timestamplogs)

it() link(bf(unix password sync))(unixpasswordsync)

it() link(bf(unix realname))(unixrealname)

it() link(bf(update encrypted))(updateencrypted)

it() link(bf(use rhosts))(userhosts)

it() link(bf(username level))(usernamelevel)

it() link(bf(username map))(usernamemap)

it() link(bf(valid chars))(validchars)

it() link(bf(wins proxy))(winsproxy)

it() link(bf(wins server))(winsserver)

it() link(bf(wins support))(winssupport)

it() link(bf(workgroup))(workgroup)

it() link(bf(write raw))(writeraw)

endit()

label(COMPLETELISTOFSERVICEPARAMETERS)
manpagesection(COMPLETE LIST OF SERVICE PARAMETERS)

Here is a list of all service parameters. See the section of each
parameter for details. Note that some are synonyms.

startit()

it() link(bf(admin users))(adminusers)

it() link(bf(allow hosts))(allowhosts)

it() link(bf(alternate permissions))(alternatepermissions)

it() link(bf(available))(available)

it() link(bf(blocking locks))(blockinglocks)

it() link(bf(browsable))(browsable)

it() link(bf(browseable))(browseable)

it() link(bf(case sensitive))(casesensitive)

it() link(bf(casesignames))(casesignames)

it() link(bf(comment))(comment)

it() link(bf(copy))(copy)

it() link(bf(create mask))(createmask)

it() link(bf(create mode))(createmode)

it() link(bf(default case))(defaultcase)

it() link(bf(delete readonly))(deletereadonly)

it() link(bf(delete veto files))(deletevetofiles)

it() link(bf(deny hosts))(denyhosts)

it() link(bf(directory))(directory)

it() link(bf(directory mask))(directorymask)

it() link(bf(directory mode))(directorymode)

it() link(bf(dont descend))(dontdescend)

it() link(bf(dos filetime resolution))(dosfiletimeresolution)

it() link(bf(dos filetimes))(dosfiletimes)

it() link(bf(exec))(exec)

it() link(bf(fake directory create times))(fakedirectorycreatetimes)

it() link(bf(fake oplocks))(fakeoplocks)

it() link(bf(follow symlinks))(followsymlinks)

it() link(bf(force create mode))(forcecreatemode)

it() link(bf(force directory mode))(forcedirectorymode)

it() link(bf(force group))(forcegroup)

it() link(bf(force user))(forceuser)

it() link(bf(fstype))(fstype)

it() link(bf(group))(group)

it() link(bf(guest account))(guestaccount)

it() link(bf(guest ok))(guestok)

it() link(bf(guest only))(guestonly)

it() link(bf(hide dot files))(hidedotfiles)

it() link(bf(hide files))(hidefiles)

it() link(bf(hosts allow))(hostsallow)

it() link(bf(hosts deny))(hostsdeny)

it() link(bf(include))(include)

it() link(bf(invalid users))(invalidusers)

it() link(bf(locking))(locking)

it() link(bf(lppause command))(lppausecommand)

it() link(bf(lpq command))(lpqcommand)

it() link(bf(lpresume command))(lpresumecommand)

it() link(bf(lprm command))(lprmcommand)

it() link(bf(magic output))(magicoutput)

it() link(bf(magic script))(magicscript)

it() link(bf(mangle case))(manglecase)

it() link(bf(mangled map))(mangledmap)

it() link(bf(mangled names))(manglednames)

it() link(bf(mangling char))(manglingchar)

it() link(bf(map archive))(maparchive)

it() link(bf(map hidden))(maphidden)

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(only guest))(onlyguest)

it() link(bf(only user))(onlyuser)

it() link(bf(oplocks))(oplocks)

it() link(bf(path))(path)

it() link(bf(postexec))(postexec)

it() link(bf(postscript))(postscript)

it() link(bf(preexec))(preexec)

it() link(bf(preserve case))(preservecase)

it() link(bf(print command))(printcommand)

it() link(bf(print ok))(printok)

it() link(bf(printable))(printable)

it() link(bf(printer))(printer)

it() link(bf(printer driver))(printerdriver)

it() link(bf(printer driver location))(printerdriverlocation)

it() link(bf(printer name))(printername)

it() link(bf(printing))(printing)

it() link(bf(public))(public)

it() link(bf(queuepause command))(queuepausecommand)

it() link(bf(queueresume command))(queueresumecommand)

it() link(bf(read list))(readlist)

it() link(bf(read only))(readonly)

it() link(bf(revalidate))(revalidate)

it() link(bf(root postexec))(rootpostexec)

it() link(bf(root preexec))(rootpreexec)

it() link(bf(set directory))(setdirectory)

it() link(bf(share modes))(sharemodes)

it() link(bf(short preserve case))(shortpreservecase)

it() link(bf(status))(status)

it() link(bf(strict locking))(strictlocking)

it() link(bf(strict sync))(strictsync)

it() link(bf(sync always))(syncalways)

it() link(bf(user))(user)

it() link(bf(username))(username)

it() link(bf(users))(users)

it() link(bf(valid users))(validusers)

it() link(bf(veto files))(vetofiles)

it() link(bf(veto oplock files))(vetooplockfiles)

it() link(bf(volume))(volume)

it() link(bf(wide links))(wide links)

it() link(bf(writable))(writable)

it() link(bf(write list))(write list)

it() link(bf(write ok))(write ok)

it() link(bf(writeable))(writeable)

endit()

label(EXPLANATIONOFEACHPARAMETER)
manpagesection(EXPLANATION OF EACH PARAMETER)

startdit()

label(adminusers)
dit(bf(admin users (S)))

This is a list of users who will be granted administrative privileges
on the share. This means that they will do all file operations as the
super-user (root).

You should use this option very carefully, as any user in this list
will be able to do anything they like on the share, irrespective of
file permissions.

  bf(Default:) nl()
tt(     no admin users)

  bf(Example:) nl()
tt(     admin users = jason)

label(allow hosts)
dit(bf(allow hosts (S)))

A synonym for this parameter is link(bf('hosts allow'))(hostsallow)

This parameter is a comma, space, or tab delimited set of hosts which
are permitted to access a service.

If specified in the link(bf([global]))(global) section then it will
apply to all services, regardless of whether the individual service
has a different setting.

You can specify the hosts by name or IP number. For example, you could
restrict access to only the hosts on a Class C subnet with something
like tt("allow hosts = 150.203.5."). The full syntax of the list is
described in the man page bf(hosts_access (5)). Note that this man
page may not be present on your system, so a brief description will
be given here also.

em(NOTE:) IF you wish to allow the url(bf(smbpasswd
(8)))(smbpasswd.html.8) program to be run by local users to change
their Samba passwords using the local url(bf(smbd (8)))(smbd.8.html)
daemon, then you em(MUST) ensure that the localhost is listed in your
bf(allow hosts) list, as url(bf(smbpasswd (8)))(smbpasswd.html.8) runs
in client-server mode and is seen by the local
url(bf(smbd))(smbd.8.html) process as just another client.

You can also specify hosts by network/netmask pairs and by netgroup
names if your system supports netgroups. The em(EXCEPT) keyword can also
be used to limit a wildcard list. The following examples may provide
some help:

bf(Example 1): allow localhost and all IPs in 150.203.*.* except one

tt(     hosts allow = localhost, 150.203. EXCEPT 150.203.6.66)

bf(Example 2): allow localhost and hosts that match the given network/netmask

tt(     hosts allow = localhost, 150.203.15.0/255.255.255.0)

bf(Example 3): allow a localhost plus a couple of hosts

tt(     hosts allow = localhost, lapland, arvidsjaur)

bf(Example 4): allow only hosts in NIS netgroup "foonet" or localhost, but 
deny access from one particular host

tt(     hosts allow = @foonet, localhost)
tt(     hosts deny = pirate)

Note that access still requires suitable user-level passwords.

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:)
tt(     none (i.e., all hosts permitted access))

  bf(Example:)
tt(     allow hosts = 150.203.5. localhost myhost.mynet.edu.au)

label(alternatepermissions)
dit(bf(alternate permissions (S)))

This is a deprecated parameter. It no longer has any effect in Samba2.0.
In previous versions of Samba it affected the way the DOS "read only"
attribute was mapped for a file. In Samba2.0 a file is marked "read only"
if the UNIX file does not have the 'w' bit set for the owner of the file,
regardless if the owner of the file is the currently logged on user or not.

label(announceas)
dit(bf(announce as (G)))

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
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:)
tt(     announce as = NT)

  bf(Example)
tt(     announce as = Win95)

label(announceversion)
dit(bf(announce version (G)))

This specifies the major and minor version numbers that nmbd will use
when announcing itself as a server. The default is 4.2.  Do not change
this parameter unless you have a specific need to set a Samba server
to be a downlevel server.

  bf(Default:)
tt(     announce version = 4.2)

  bf(Example:)
tt(     announce version = 2.0)


label(autoservices)
dit(bf(auto services (G)))

This is a list of services that you want to be automatically added to
the browse lists. This is most useful for homes and printers services
that would otherwise not be visible.

Note that if you just want all printers in your printcap file loaded
then the link(bf("load printers"))(loadprinters) option is easier.

  bf(Default:)
tt(     no auto services)

  bf(Example:)
tt(     auto services = fred lp colorlp)

label(available)
dit(bf(available (S)))

This parameter lets you em('turn off') a service. If tt('available = no'),
then em(ALL) attempts to connect to the service will fail. Such failures
are logged.

  bf(Default:)
tt(     available = yes)

  bf(Example:)
tt(     available = no)

label(bindinterfacesonly)
dit(bf(bind interfaces only (G)))

This global parameter allows the Samba admin to limit what interfaces
on a machine will serve smb requests. If affects file service
url(bf(smbd))(smbd.8.html) and name service url(bf(nmbd))(nmbd.8.html)
in slightly different ways.

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 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.

In addition, to change a users SMB password, the
url(bf(smbpasswd))(smbpasswd.8.html) by default connects to the
em("localhost" - 127.0.0.1) address as an SMB client to issue the
password change request. If bf("bind interfaces only") is set then
unless the network address em(127.0.0.1) is added to the
link(bf('interfaces'))(interfaces) parameter list then
url(bf(smbpasswd))(smbpasswd.8.html) will fail to connect in it's
default mode. url(bf(smbpasswd))(smbpasswd.8.html) can be forced to
use the primary IP interface of the local host by using its
url(bf("-r remote machine"))(smbpasswd.8.html#minusr) parameter, with
bf("remote machine") set to the IP name of the primary interface
of the local host.

  bf(Default:)
tt(     bind interfaces only = False)

  bf(Example:)
tt(     bind interfaces only = True)

label(blockinglocks)
dit(bf(blocking locks (S)))

This parameter controls the behavior of url(bf(smbd))(smbd.8.html) when
given a request by a client to obtain a byte range lock on a region
of an open file, and the request has a time limit associated with it.

If this parameter is set and the lock range requested cannot be
immediately satisfied, Samba 2.0 will internally queue the lock 
request, and periodically attempt to obtain the lock until the
timeout period expires.

If this parameter is set to "False", then Samba 2.0 will behave
as previous versions of Samba would and will fail the lock
request immediately if the lock range cannot be obtained.

This parameter can be set per share.

  bf(Default:)
tt(     blocking locks = True)

  bf(Example:)
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:)
tt(     browsable = Yes)

  bf(Example:)
tt(     browsable = No)

label(browselist)
dit(bf(browse list(G)))

This controls whether url(bf(smbd))(smbd.8.html) will serve a browse
list to a client doing a NetServerEnum call. Normally set to true. You
should never need to change this.

  bf(Default:)
tt(     browse list = Yes)

label(browseable)
dit(bf(browseable))

Synonym for link(bf(browsable))(browsable).

label(casesensitive)
dit(bf(case sensitive (G)))

See the discussion in the section link(bf(NAME MANGLING))(NAMEMANGLING).

label(casesignames)
dit(bf(casesignames (G)))

Synonym for link(bf("case sensitive"))(casesensitive).

label(changenotifytimeout)
dit(bf(change notify timeout (G)))

One of the new NT SMB requests that Samba 2.0 supports is the
"ChangeNotify" requests. This SMB allows a client to tell a server to
em("watch") a particular directory for any changes and only reply to
the SMB request when a change has occurred. Such constant scanning of
a directory is expensive under UNIX, hence an
url(bf(smbd))(smbd.8.html) daemon only performs such a scan on each
requested directory once every bf(change notify timeout) seconds.

bf(change notify timeout) is specified in units of seconds.

  bf(Default:)
tt(     change notify timeout = 60)

  bf(Example:)
tt(     change notify timeout = 300)

Would change the scan time to every 5 minutes.

label(characterset)
dit(bf(character set (G)))

This allows a smbd to map incoming filenames from a DOS Code page (see
the link(bf(client code page))(clientcodepage) parameter) to several
built in UNIX character sets. The built in code page translations are:

startit()

it() bf(ISO8859-1) Western European UNIX character set. The parameter
link(bf(client code page))(clientcodepage) em(MUST) be set to code
page 850 if the bf(character set) parameter is set to iso8859-1
in order for the conversion to the UNIX character set to be done
correctly.

it() bf(ISO8859-2) Eastern European UNIX character set. The parameter
link(bf(client code page))(clientcodepage) em(MUST) be set to code
page 852 if the bf(character set) parameter is set to ISO8859-2
in order for the conversion to the UNIX character set to be done
correctly. 

it() bf(ISO8859-5) Russian Cyrillic UNIX character set. The parameter
link(bf(client code page))(clientcodepage) em(MUST) be set to code
page 866 if the bf(character set) parameter is set to ISO8859-2
in order for the conversion to the UNIX character set to be done
correctly. 

it() bf(KOI8-R) Alternate mapping for Russian Cyrillic UNIX
character set. The parameter link(bf(client code
page))(clientcodepage) em(MUST) be set to code page 866 if the
bf(character set) parameter is set to KOI8-R in order for the
conversion to the UNIX character set to be done correctly.

endit()

em(BUG). These MSDOS code page to UNIX character set mappings should
be dynamic, like the loading of MS DOS code pages, not static.

See also link(bf(client code page))(clientcodepage).  Normally this
parameter is not set, meaning no filename translation is done.

  bf(Default:)
tt(     character set = <empty string>)

  bf(Example:)
tt(     character set = ISO8859-1)

label(clientcodepage)
dit(bf(client code page (G)))

This parameter specifies the DOS code page that the clients accessing
Samba are using. To determine what code page a Windows or DOS client
is using, open a DOS command prompt and type the command "chcp". This
will output the code page. The default for USA MS-DOS, Windows 95, and
Windows NT releases is code page 437. The default for western european
releases of the above operating systems is code page 850.

This parameter tells url(bf(smbd))(smbd.8.html) which of the
tt(codepage.XXX) files to dynamically load on startup. These files,
described more fully in the manual page url(bf(make_smbcodepage
(1)))(make_smbcodepage.1.html), tell url(bf(smbd))(smbd.8.html) how
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 :

startit()

it() bf(Code Page 437 - MS-DOS Latin US)

it() bf(Code Page 737 - Windows '95 Greek)

it() bf(Code Page 850 - MS-DOS Latin 1)

it() bf(Code Page 852 - MS-DOS Latin 2)

it() bf(Code Page 861 - MS-DOS Icelandic)

it() bf(Code Page 866 - MS-DOS Cyrillic)

it() bf(Code Page 932 - MS-DOS Japanese SJIS)

it() bf(Code Page 936 - MS-DOS Simplified Chinese)

it() bf(Code Page 949 - MS-DOS Korean Hangul)

it() bf(Code Page 950 - MS-DOS Traditional Chinese)

endit()

Thus this parameter may have any of the values 437, 737, 850, 852,
861, 932, 936, 949, or 950.  If you don't find the codepage you need,
read the comments in one of the other codepage files and the
url(bf(make_smbcodepage (1)))(make_smbcodepage.1.html) man page and
write one. Please remember to donate it back to the Samba user
community.

This parameter co-operates with the link(bf("valid
chars"))(validchars) parameter in determining what characters are
valid in filenames and how capitalization is done. If you set both
this parameter and the link(bf("valid chars"))(validchars) parameter
the bf("client code page") parameter em(MUST) be set before the
link(bf("valid chars"))(validchars) parameter in the bf(smb.conf)
file. The link(bf("valid chars"))(validchars) string will then augment
the character settings in the "client code page" parameter.

If not set, bf("client code page") defaults to 850.

See also : link(bf("valid chars"))(validchars)

  bf(Default:)
tt(     client code page = 850)

  bf(Example:)
tt(     client code page = 936)

label(codingsystem)
dit(bf(codingsystem (G)))

This parameter is used to determine how incoming Shift-JIS Japanese
characters are mapped from the incoming link(bf("client code
page"))(clientcodepage) used by the client, into file names in the
UNIX filesystem. Only useful if link(bf("client code
page"))(clientcodepage) is set to 932 (Japanese Shift-JIS).

The options are :

startit()

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
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
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
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).

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.

endit()

label(comment)
dit(bf(comment (S)))

This is a text field that is seen next to a share when a client does a
queries the server, either via the network neighborhood or via "net
view" to list what shares are available.

If you want to set the string that is displayed next to the machine
name then see the server string command.

  bf(Default:)
tt(     No comment string)

  bf(Example:)
tt(     comment = Fred's Files)

label(configfile)
dit(bf(config file (G)))

This allows you to override the config file to use, instead of the
default (usually bf(smb.conf)). There is a chicken and egg problem
here as this option is set in the config file!

For this reason, if the name of the config file has changed when the
parameters are loaded then it will reload them from the new config
file.

This option takes the usual substitutions, which can be very useful.

If the config file doesn't exist then it won't be loaded (allowing you
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)
dit(bf(copy (S)))

This parameter allows you to em('clone') service entries. The specified
service is simply duplicated under the current service's name. Any
parameters specified in the current section will override those in the
section being copied.

This feature lets you set up a 'template' service and create similar
services easily. Note that the service being copied must occur earlier
in the configuration file than the service doing the copying.

  bf(Default:)
tt(     none)

  bf(Example:)
tt(     copy = otherservice)

label(createmode)
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
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
of a file. Any bit em(*not*) set here will be removed from the modes set
on a file when it is created.

The default value of this parameter removes the 'group' and 'other'
write and execute bits from the UNIX modes.

Following this Samba will bit-wise 'OR' the UNIX mode created from
this parameter with the value of the "force create mode" parameter
which is set to 000 by default.

This parameter does not affect directory modes. See the parameter
link(bf('directory mode'))(directorymode) for details.

See also the link(bf("force create mode"))(forcecreatemode) parameter
for forcing particular mode bits to be set on created files. See also
the link(bf("directory mode"))(directorymode) parameter for masking
mode bits on created directories.

  bf(Default:)
tt(     create mask = 0744)

  bf(Example:)
tt(     create mask = 0775)

label(createmode)
dit(bf(create mode (S)))

This is a synonym for link(bf(create mask))(createmask).

label(deadtime)
dit(bf(deadtime (G)))

The value of the parameter (a decimal integer) represents the number
of minutes of inactivity before a connection is considered dead, and
it is disconnected. The deadtime only takes effect if the number of
open files is zero.

This is useful to stop a server's resources being exhausted by a large
number of inactive connections.

Most clients have an auto-reconnect feature when a connection is
broken so in most cases this parameter should be transparent to users.

Using this parameter with a timeout of a few minutes is recommended
for most systems.

A deadtime of zero indicates that no auto-disconnection should be
performed.

  bf(Default:)
tt(     deadtime = 0)

  bf(Example:)
tt(     deadtime = 15)

label(debug timestamp (G))

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:)
tt(     debug timestamp = Yes)

  bf(Example:)
tt(     debug timestamp = No)

label(debuglevel)
dit(bf(debug level (G)))

The value of the parameter (an integer) allows the debug level
(logging level) to be specified in the bf(smb.conf) file. This is to
give greater flexibility in the configuration of the system.

The default will be the debug level specified on the command line
or level zero if none was specified.

  bf(Example:)
tt(     debug level = 3)

label(default)
dit(bf(default (G)))

A synonym for link(bf(default service))(defaultservice).

label(defaultcase)
dit(bf(default case (S)))

See the section on link(bf("NAME MANGLING"))(NAMEMANGLING). Also note
the link(bf("short preserve case"))(shortpreservecase) parameter.

label(default service)
dit(bf(default service (G)))

This parameter specifies the name of a service which will be connected
to if the service actually requested cannot be found. Note that the
square brackets are em(NOT) given in the parameter value (see example
below).

There is no default value for this parameter. If this parameter is not
given, attempting to connect to a nonexistent service results in an
error.

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
macros like link(bf(%S))(percentS) to make a wildcard service.

Note also that any tt('_') characters in the name of the service used
in the default service will get mapped to a tt('/'). This allows for
interesting things.


  bf(Example:)
verb(
        default service = pub
        
        [pub]
                path = /%S
)

label(deletereadonly)
dit(bf(delete readonly (S)))

This parameter allows readonly files to be deleted.  This is not
normal DOS semantics, but is allowed by UNIX.

This option may be useful for running applications such as rcs, where
UNIX file ownership prevents changing file permissions, and DOS
semantics prevent deletion of a read only file.

  bf(Default:)
tt(     delete readonly = No)

  bf(Example:)
tt(     delete readonly = Yes)

label(deletevetofiles)
dit(bf(delete veto files (S)))

This option is used when Samba is attempting to delete a directory
that contains one or more vetoed directories (see the link(bf('veto
files'))(vetofiles) option).  If this option is set to False (the
default) then if a vetoed directory contains any non-vetoed files or
directories then the directory delete will fail. This is usually what
you want.

If this option is set to True, then Samba will attempt to recursively
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))

Setting tt('delete veto files = True') allows these directories to be 
transparently deleted when the parent directory is deleted (so long
as the user has permissions to do so).

See also the link(bf(veto files))(vetofiles) parameter.

  bf(Default:)
tt(     delete veto files = False)

  bf(Example:)
tt(     delete veto files = True)

label(denyhosts)
dit(bf(deny hosts (S)))

The opposite of link(bf('allow hosts'))(allowhosts) - hosts listed
here are em(NOT) permitted access to services unless the specific
services have their own lists to override this one. Where the lists
conflict, the link(bf('allow'))(allowhosts) list takes precedence.

  bf(Default:)
tt(     none (i.e., no hosts specifically excluded))

  bf(Example:)
tt(     deny hosts = 150.203.4. badhost.mynet.edu.au)

label(dfreecommand)
dit(bf(dfree command (G)))

The dfree command setting should only be used on systems where a
problem occurs with the internal disk space calculations. This has
been known to happen with Ultrix, but may occur with other operating
systems. The symptom that was seen was an error of "Abort Retry
Ignore" at the end of each directory listing.

This setting allows the replacement of the internal routines to
calculate the total disk space and amount available with an external
routine. The example below gives a possible script that might fulfill
this function.

The external program will be passed a single parameter indicating a
directory in the filesystem being queried. This will typically consist
of the string tt("./"). The script should return two integers in
ascii. The first should be the total disk space in blocks, and the
second should be the number of available blocks. An optional third
return value can give the block size in bytes. The default blocksize
is 1024 bytes.

Note: Your script should em(NOT) be setuid or setgid and should be
owned by (and writable only by) root!

  bf(Default:)
tt(     By default internal routines for determining the disk capacity
and remaining space will be used.)

  bf(Example:)
tt(     dfree command = /usr/local/samba/bin/dfree)

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):

verb(
        #!/bin/sh
        /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
)

        Note that you may have to replace the command names with full
path names on some systems.

label(directory)
dit(bf(directory (S)))

Synonym for link(bf(path))(path).

label(directorymask)
dit(bf(directory mask (S)))

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
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
of a directory. Any bit em(*not*) set here will be removed from the
modes set on a directory when it is created.

The default value of this parameter removes the 'group' and 'other'
write bits from the UNIX mode, allowing only the user who owns the
directory to modify it.

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
bits are added).

See the link(bf("force directory mode"))(forcedirectorymode) parameter
to cause particular mode bits to always be set on created directories.

See also the link(bf("create mode"))(createmode) parameter for masking
mode bits on created files.

  bf(Default:)
tt(     directory mask = 0755)

  bf(Example:)
tt(     directory mask = 0775)

label(directorymode)
dit(bf(directory mode (S)))

Synonym for link(bf(directory mask))(directorymask).

label(dnsproxy)
dit(bf(dns proxy (G)))

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
client.

Note that the maximum length for a NetBIOS name is 15 characters, so
the DNS name (or DNS alias) can likewise only be 15 characters,
maximum.

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:)
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
mailing list bf(Samba-ntdom) available by sending email to
email(listproc@samba.anu.edu.au)

label(domainadminusers) 
dit(bf(domain admin users)

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
mailing list bf(Samba-ntdom) available by sending email to
email(listproc@samba.anu.edu.au)

label(domain controller)
dit(bf(domain controller (G)))

This is a bf(DEPRECATED) parameter. It is currently not used within
the Samba source and should be removed from all current smb.conf
files. It is left behind for compatibility reasons.

label(domaingroups)
dit(bf(domain groups (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
mailing list bf(Samba-ntdom) available by sending email to
email(listproc@samba.anu.edu.au)

label(domainguestgroup)
dit(bf(domain guest 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
mailing list bf(Samba-ntdom) available by sending email to
email(listproc@samba.anu.edu.au)

label(domainguestusers)
dit(bf(domain guest 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
mailing list bf(Samba-ntdom) available by sending email to
email(listproc@samba.anu.edu.au)

label(domainlogons)
dit(bf(domain logons (G)))

If set to true, the Samba server will serve Windows 95/98 Domain
logons for the link(bf(workgroup))(workgroup) it is in. For more
details on setting up this feature see the file DOMAINS.txt in the
Samba documentation directory tt(docs/) shipped with the source code.

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
will be able to provide this functionality for Windows NT clients
also.

  bf(Default:)
tt(     domain logons = no)

label(domainmaster)
dit(bf(domain master (G)))

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 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
prevent a Windows NT PDC from attempting to do this). This means that
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:)
tt(     domain master = no)

label(dont descend)
dit(bf(dont descend (S)))

There are certain directories on some systems (eg., 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.

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 :-)

  bf(Default:)
tt(     none (i.e., all directories are OK to descend))

  bf(Example:)
tt(     dont descend = /proc,/dev)

label(dosfiletimeresolution)
dit(bf(dos filetime resolution (S)))

Under the DOS and Windows FAT filesystem, the finest granulatity 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 url(bf(smbd))(smbd.8.html).

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.

  bf(Default:)
tt(     dos filetime resolution = False)

  bf(Example:)
tt(     dos filetime resolution = True)

label(dos filetimes)
dit(bf(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.

  bf(Default:)
tt(     dos filetimes = False)

  bf(Example:)
tt(     dos filetimes = True)

label(encryptpasswords)
dit(bf(encrypt passwords (G)))

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 em("server") or
em("domain") 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)))

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.

  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
(opportunistic lock) then the client is free to assume that it is the
only one accessing the file and it will aggressively cache file
data. With some oplock types the client may even cache file open/close
operations. This can give enormous performance benefits.

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.

It is generally much better to use the real link(bf(oplock))(oplock)
support rather than this parameter.

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.

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/pasword) in their home directory for
instance.  However it will slow filename lookups down slightly.

This option is enabled (ie. url(bf(smbd))(smbd.8.html) will follow
symbolic links) by default.

label(forcecreatemode)
dit(bf(force create mode (S)))

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 octel) 000. The modes
in this parameter are bitwise 'OR'ed onto the file mode after the mask
set in the link(bf("create mask"))(createmark) parameter is applied.

See also the parameter link(bf("create mask"))(createmask) 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'.

label(forcedirectorymode)
dit(bf(force directory mode (S)))

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 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
link(bf("directory mask"))(directorymask) is applied.

See also the parameter link(bf("directory mask"))(directorymask) for
details on masking mode bits on created directories.

  bf(Default:)
tt(     force directory mode = 000)

  bf(Example:)
tt(     force directory mode = 0755)

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'.

label(forcegroup)
dit(bf(force group (S)))

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.

  bf(Default:)
tt(     no forced group)

  bf(Example:)
tt(     force group = agroup)

label(forceuser)
dit(bf(force user (S)))

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
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.

  bf(Default:)
tt(     fstype = NTFS)

  bf(Example:)
tt(     fstype = Samba)

label(getwdcache)
dit(bf(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 the
link(bf(widelinks))(widelinks) parameter is set to False.

  bf(Default:)
tt(     getwd cache = No)

  bf(Example:)
tt(     getwd cache = Yes

label(group)
dit(bf(group (S)))

Synonym for link(bf("force group"))(forcegroup).

label(guestaccount)
dit(bf(guest account (S)))

This is a username which will be used for access to services which are
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.

  bf(Default:)
tt(     hide dot files = yes)

  bf(Example:)
tt(     hide dot files = no)


label(hidefiles)
dit(bf(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 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 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.

See also link(bf("hide dot files"))(hidedotfiles), link(bf("veto
files"))(vetofiles) and link(bf("case sensitive"))(casesensitive).

  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).
)

  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:

tt(username     server:/some/file/system)

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)

  bf(Example:)
tt(     homedir map = amd.homedir)

label(hostsallow)
dit(bf(hosts allow (S)))

Synonym for link(bf(allow hosts))(allowhosts).

label(hostsdeny)
dit(bf(hosts deny (S)))

Synonym for link(bf(denyhosts))(denyhosts).

label(hostsequiv)
dit(bf(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.

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 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
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 :-).

  bf(Default)
tt(     No host equivalences)

  bf(Example)
tt(     hosts equiv = /etc/hosts.equiv)

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.

It takes the standard substitutions, except link(bf(%u))(percentu),
link(bf(%P))(percentP) and link(bf(%S))(percentS).

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.

For example, the following line:

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.

You could produce an equivalent result by using:

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.

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 em("paranoid") check to absolutely ensure an
improper setting does not breach your security.

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 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
link(bf(%S))(percentS). This is useful in the link(bf([homes]))(homes)
section.

See also link(bf("valid users"))(validusers).

  bf(Default:)
tt(     No invalid users)

  bf(Example:)
tt(     invalid users = root fred admin @wheel)

label(keepalive)
dit(bf(keepalive (G)))

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 link(bf("socket
options"))(socketoptions)). Basically you should only use this option
if you strike difficulties.

  bf(Default:)
tt(     keep alive = 0)

  bf(Example:)
tt(     keep alive = 60)

label(kerneloplocks)
dit(bf(kernel oplocks (G)))

For UNIXs that support kernel based oplocks (currently only IRIX but
hopefully also Linux and FreeBSD soon) this parameter allows the use
of them to be turned on or off. 

Kernel oplocks support allows Samba 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
consistancy between SMB/CIFS, NFS and local file access (and is a 
em(very) cool feature :-).

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.

label(ldapfilter)
dit(bf(ldap filter (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.

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.

  bf(Default:)
tt(     empty string.)

label(ldapport)
dit(bf(ldap port (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.

This parameter specifies the TCP port number to use to contact
the LDAP server on.

  bf(Default:)
tt(     ldap port = 389.)

label(ldaproot)
dit(bf(ldap root (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.

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.

See also link(bf(ldap root passwd))(ldaprootpasswd).

  bf(Default:)
tt(     empty string (no user defined))

label(ldaprootpasswd)
dit(bf(ldap root passwd (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.

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.

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.

See also link(bf(ldap root))(ldaproot).

  bf(Default:)
tt(     empty string.)

label(ldapserver)
dit(bf(ldap server (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.

This parameter specifies the DNS name of the LDAP server to use
for SMB/CIFS authentication purposes.

  bf(Default:)
tt(     ldap server = localhost)

label(ldapsuffix)
dit(bf(ldap suffix (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.

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.

  bf(Default:)
tt(     empty string.)

label(lmannounce)
dit(bf(lm announce (G)))

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).

See also link(bf("lm interval"))(lminterval).

  bf(Default:)
tt(     lm announce = auto)

  bf(Example:)
tt(     lm announce = true)

label(lminterval)
dit(bf(lm interval (G)))

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.

See also link(bf("lm announce"))(lmannounce).

  bf(Default:)
tt(     lm interval = 60)

  bf(Example:)
tt(     lm interval = 120)

label(loadprinters)
dit(bf(load printers (G)))

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.

  bf(Default:)
tt(     load printers = yes)

  bg(Example:)
tt(     load printers = no)

label(localmaster)
dit(bf(local master (G)))

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.

Setting this value to False will cause url(bf(nmbd))(nmbd.8.html)
em(never) to become a local master browser.

  bf(Default:)
tt(     local master = yes)

label(lockdirectory)
dit(bf(lock directory (G)))

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.

  bf(Default:)
tt(     lock directory = /tmp/samba)

  bf(Example:)
tt(     lock directory = /usr/local/samba/var/locks)

label(locking)
dit(bf(locking (S)))

This controls whether or not locking will be performed by the server
in response to lock requests from the client.

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.

If tt("locking = yes"), real locking will be performed by the server.

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.

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.

  bf(Default:)
tt(     locking = yes)

  bf(Example:)
tt(     locking = no)

label(logfile)
dit(bf(log file (G)))

This options allows you to override the name of the Samba log file
(also known as the debug file).

This option takes the standard substitutions, allowing you to have
separate log files for each user or machine.

  bf(Example:)
tt(     log file = /usr/local/samba/var/log.%m)

label(loglevel)
dit(bf(log level (G)))

Synonym for link(bf("debug level"))(debuglevel).

label(logondrive)
dit(bf(logon drive (G)))

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. 

Note that this option is only useful if Samba is set up as a
link(bf(logon server))(domainlogons).

  bf(Example:)
tt(     logon drive = h:)

label(logonhome)
dit(bf(logon home (G)))

This parameter specifies the home directory location when a Win95/98 or
NT Workstation logs into a Samba PDC.  It allows you to do 

tt("NET USE H: /HOME")

from a command prompt, for example.

This option takes the standard substitutions, allowing you to have
separate logon scripts for each user or machine.

Note that this option is only useful if Samba is set up as a
link(bf(logon server))(domainlogons).

  bf(Example:)
tt(     logon home = "\\remote_smb_server\%U")

  bf(Default:)
tt(     logon home = "\\%N\%U")

label(logonpath)
dit(bf(logon path (G)))

This parameter specifies the home directory where roaming profiles
(USER.DAT / USER.MAN files for Windows 95/98) are stored.

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.

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.

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
em(MAN)datory profile).

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).

This option takes the standard substitutions, allowing you to have
separate logon scripts for each user or machine.

Note that this option is only useful if Samba is set up as a
link(bf(logon server))(domainlogons).

  bf(Default:)
tt(     logon path = \\%N\%U\profile)

  bf(Example:)
tt(     logon path = \\PROFILESERVER\HOME_DIR\%U\PROFILE)

label(logonscript)
dit(bf(logon script (G)))

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.

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:

tt(/usr/local/samba/netlogon/STARTUP.BAT)

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 synchronise 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.

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.

This option takes the standard substitutions, allowing you to have
separate logon scripts for each user or machine.

Note that this option is only useful if Samba is set up as a
link(bf(logon server))(domainlogons).

  bf(Example:)
tt(     logon script = scripts\%U.bat)

label(lppausecommand)
dit(bf(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. One way of implementing this is
by using job priorities, where jobs having a too low priority won't be
sent to the printer.

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.

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.

See also the link(bf("printing"))(printing) parameter.

  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 :

tt(     lp -i %p-%j -H hold)

or if the value of the link(bf("printing"))(printing) parameter is tt(softq),
then the default is:

tt(     qstat -s -j%j -h)
 
  bf(Example for HPUX:)
        lppause command = /usr/bin/lpalt %p-%j -p0

label(lpqcachetime)
dit(bf(lpq cache time (G)))

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.

The cache files are stored in tt(/tmp/lpq.xxxx) where xxxx is a hash of
the bf(lpq) command in use.

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.

A value of 0 will disable cacheing completely.

See also the link(bf("printing"))(printing) parameter.

  bf(Default:)
tt(     lpq cache time = 10)

  bf(Example:)
tt(     lpq cache time = 30)

label(lpqcommand)
dit(bf(lpq command (S)))

This parameter specifies the command to be executed on the server host
in order to obtain tt("lpq")-style printer status information.

This command should be a program or script which takes a printer name
as its only parameter and outputs printer status information.

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.

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.

If a tt(%p) is given then the printername is put in its place. Otherwise
it is placed at the end of the command.

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.

See also the link(bf("printing"))(printing) parameter.

  bf(Default:)
tt(        depends on the setting of printing =)

  bf(Example:)
tt(     lpq command = /usr/bin/lpq %p)

label(lpresumecommand)
dit(bf(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.

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.

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 it is good practice to include the absolute path in the bf(lpresume
command) as the PATH may not be available to the server.

See also the link(bf("printing"))(printing) parameter.

  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 :

tt(     lp -i %p-%j -H resume)

or if the value of the link(bf("printing"))(printing) parameter is tt(softq),
then the default is:

tt(     qstat -s -j%j -r)
 
  bf(Example for HPUX:)
tt(        lpresume command = /usr/bin/lpalt %p-%j -p2)

label(lprmcommand)
dit(bf(lprm command (S)))

This parameter specifies the command to be executed on the server host
in order to delete a print job.

This command should be a program or script which takes a printer name
and job number, and deletes the print job.

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 it is good practice to include the absolute path in the
bf(lprm command) as the PATH may not be available to the server.

See also the link(bf("printing"))(printing) parameter.

  bf(Default:)
tt(     depends on the setting of "printing =")

  bf(Example 1:)
tt(     lprm command = /usr/bin/lprm -P%p %j)

  bf(Example 2:)
tt(     lprm command = /usr/bin/cancel %p-%j)

label(machinepasswordtimeout)
dit(bf(machine password timeout (G)))

If a Samba server is a member of an Windows NT Domain (see the
link(bf("security=domain"))(security)) 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.

See also url(bf(smbpasswd (8)))(smbpasswd.8.html), and the
link(bf("security=domain"))(security)) parameter.

  bf(Default:)
tt(     machine password timeout = 604800)

label(magicoutput)
dit(bf(magic output (S)))

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 are
not representable 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 UNIXes). 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
(ie. 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 (ie. 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 (ie. 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"))(security) - ie. 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 mistyping 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 un-opened 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.

  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 controlls 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 controlls 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 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.

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 recognised
by the underlying operating system. This allows data synchronisation 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 occured.

  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.