at any _ characters in the name of the service used in the
default service will get mapped to a /. This allows for interesting
things.


.B Example:
 	default service = pub
        
        [pub]
             path = /%S
          

.SS deny hosts (S)
A synonym for this parameter is 'hosts deny'.

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

.B Default:
 	none (ie., no hosts specifically excluded)

.B Example:
  	deny hosts = 150.203.4. badhost.mynet.edu.au
.SS 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 "./". 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 NOT be setuid or setgid and should be owned by
(and writable only by) root!

.B Default:
 	By default internal routines for determining the disk capacity
and remaining space will be used.

.B Example:
 	dfree command = /usr/local/smb/dfree

	Where the script dfree (which must be made executable) could be

 	#!/bin/sh
 	df $1 | tail -1 | awk '{print $2" "$4}'

	or perhaps (on Sys V)

	#!/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.
.SS directory (S)
See
.B path.
.SS dont descend (S)
There are certain directories on some systems (eg., the /proc tree under
Linux) that are either not of interest to clients or are infinitely deep
(recursive). This parameter allows you to specify a comma-delimited list
of directories that the server should always show as empty.

Note that Samba can be very fussy about the exact format of the "dont
descend" entries. For example you ma need "./proc" instead of just
"/proc". Experimentation is the best policy :-)

.B Default:
 	none (ie., all directories are OK to descend)

.B Example:
  	dont descend = /proc,/dev

.SS encrypt passwords (G)

This boolean controls whether encrypted passwords will be negotiated
with the cient. Note that this option has no effect if you haven't
compiled in the necessary des libraries and encryption code. It
defaults to no.

.SS exec (S)

This is an alias for preexec


.SS force group (S)
This specifies a group name that all connections to this service
should be made as. This may be useful for sharing files.

.B Default:
       no forced group

.B Example:
       force group = agroup

.SS force user (S)
This specifies a user name that all connections to this service
should be made as. This may be useful for sharing files. You should
also use it carefully as using it incorrectly can cause security
problems.

This user name only gets used once a connection is established. Thus
clients still need to connect as a valid user and supply a valid
password. Once connected, all file operations will be performed as the
"forced user", not matter what username the client connected as.

.B Default:
       no forced user

.B Example:
       force user = auser

.SS guest account (S)
This is a username which will be used for access to services which are
specified as 'guest ok' (see below). Whatever privileges this user has
will be available to any client connecting to the guest
service. Typically this user will exist in the password file, but will
not have a valid login. If a username is specified in a given service,
the specified username overrides this one.

One some systems the account "nobody" may not be able to print. Use
another account in this case. You should test this by trying to log in
as your guest user (perhaps by using the "su -" command) and trying to
print using lpr.

Note that as of version 1.9 of Samba this option may be set
differently for each service.

.B Default:
 	specified at compile time

.B Example:
 	guest account = nobody
.SS getwd cache (G)
This is a tuning option. When this is enabled a cacheing algorithm will
be used to reduce the time taken for getwd() calls. This can have a
significant impact on performance, especially when widelinks is False.

.B Default:
 	getwd cache = No

.B Example:
 	getwd cache = Yes
.SS guest ok (S)
See
.B public.
.SS guest only (S)
If this parameter is 'yes' for a service, then only guest connections to the
service are permitted. This parameter will have no affect if "guest ok" or
"public" is not set for the service.

See the section below on user/password validation for more information about
this option.

.B Default:
 	guest only = no

.B Example:
 	guest only = yes
.SS hide dot files (S)
This is a boolean parameter that controls whether files starting with
a dot appear as hidden files.

.B Default:
	hide dot files = yes

.B Example:
	hide dot files = no
.SS hosts allow (S)
See
.B allow hosts.
.SS hosts deny (S)
See
.B deny hosts.

.SS group (S)
This is an alias for "force group" and is only kept for compatability
with old versions of Samba. It may be removed in future versions.

.SS hosts equiv (G)
If this global parameter is a non-null string, it specifies the name of
a file to read for the names of hosts and users who will be allowed access
without specifying a password.

This is not be confused with 
.B allow hosts
which is about hosts access to services and is more useful for guest services.
.B hosts equiv
may be useful for NT clients which will not supply passwords to samba.

NOTE: The use of hosts.equiv can be a major security hole. This is
because you are trusting the PC to supply the correct username. It is
very easy to get a PC to supply a false username. I recommend that the
hosts.equiv option be only used if you really know what you are doing,
or perhaps on a home network where you trust your wife and kids :-)

.B Default
	No host equivalences

.B Example
	hosts equiv = /etc/hosts.equiv

.SS invalid users (S)
This is a list of users that should not be allowed to login to this
service. This is really a "paranoid" check to absolutely ensure an
improper setting does not breach your security.

A name starting with @ is interpreted as a unix group.

The current servicename is substituted for %S. This is useful in the
[homes] section.

See also "valid users"

.B Default
	No invalid users

.B Example
	invalid users = root fred admin @wheel

.SS include (G)

This allows you to inlcude one config file inside another. the file is
included literally, as though typed in place.

It takes the standard substitutions, except %u, %P and %S

.SS keep alive (G)
The value of the parameter (an integer) represents the number of seconds 
between 'keepalive' packets. If this parameter is zero, no keepalive packets
will be sent. Keepalive packets, if sent, allow the server to tell whether a
client is still present and responding.

Keepalives should, in general, not be needed if the socket being used
has the SO_KEEPALIVE attribute set on it (see "socket
options"). Basically you should only use this option if you strike
difficulties.

.B Default:
 	keep alive = 0

.B Example:
 	keep alive = 60
.SS load printers (G)
A boolean variable that controls whether all printers in the printcap
will be loaded for browsing by default. 

.B Default:
	load printers = no

.B Example:
	load printers = yes

.SS lock directory (G)
This options specifies the directory where lock files will be placed.
The lock files are used to implement the "max connections" option.

.B Default:
	lock directory = /tmp/samba

.B Example: 
	lock directory = /usr/local/samba/locks
.SS locking (S)
This controls whether or not locking will be performed by the server in 
response to lock requests from the client.

If "locking = no", all lock and unlock requests will appear to succeed and 
all lock queries will indicate that the queried lock is clear.

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

This option may be particularly useful for read-only filesystems which
do not need locking (such as cdrom drives).

Be careful about disabling locking either globally or in a specific
service, as lack of locking may result in data corruption.

.B Default:
 	locking = yes

.B Example:
 	locking = no

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

.B Example:
	log file = /usr/local/samba/log.%m

.SS log level (G)
see "debug level"

.SS lpq cache time (G)

This controls how long lpq info will be cached for to prevent the lpq
command being called too often. A separate cache is kept for each
variation of the lpq command used by the system, so if you use
different lpq commands for different users then they won't share cache
information.

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

The default is 10 seconds, meaning that the cached results of a
previous identical lpq command will be used if the cached data is less
than 10 seconds old. A large value may be advisable if your lpq
command is very slow.

A value of 0 will disable cacheing completely.

.B Default:
	lpq cache time = 10

.B Example:
	lpq cache time = 30

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

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

Currently four styles of printer status information are supported;
BSD, SYSV, AIX and HPUX. This covers most unix systems. You control
which type is expected using the "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 %p is given then the printername is put in it's place. Otherwise
it is placed at the end of the command.

Note that it is good practice to include the absolute path in the lpq
command as the PATH may not be available to the server.

.B Default:
        depends on the setting of "printing ="

.B Example:
 	lpq command = /usr/bin/lpq %p

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

Currently four styles of printer control are supported; BSD, SYSV, AIX
and HPUX. This covers most unix systems. You control which type is
expected using the "printing =" option.

If a %p is given then the printername is put in it's place. A %j is
replaced with the job number (an integer).

Note that it is good practice to include the absolute path in the lprm
command as the PATH may not be available to the server.

.B Default:
        depends on the setting of "printing ="

.B Example 1:
 	lprm command = /usr/bin/lprm -P%p %j

.B Example 1:
 	lprm command = /usr/bin/cancel %p-%j

.SS magic output (S)
This parameter specifies the name of a file which will contain output
created by a magic script (see
.I magic script
below).

Warning: If two clients use the same magic script in the same directory the
output file content is undefined.
.B Default:
 	magic output = <magic script name>.out

.B Example:
 	magic output = myfile.txt
.SS magic script (S)
This parameter specifies the name of a file which, if opened, will be
executed by the server when the file is closed. This allows a Unix script
to be sent to the Samba host and executed on behalf of the connected user.

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
.I magic output
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 "as is" on the host, which
for some hosts and some shells will require filtering at the DOS end.

Magic scripts are EXPERIMENTAL and should NOT be relied upon.
.B Default:
 	None. Magic scripts disabled.

.B Example:
 	magic script = user.csh
.SS mangled map (S)
This is for those who want to directly map UNIX file names which are
not representable on DOS.  The mangling of names is not always what is
needed.  In particular you may have documents with file extensiosn
that differ between dos and unix. For example, under unix it is common
to use .html for HTML files, whereas under dos .htm is more commonly
used.

So to map 'html' to 'htm' you put:

  mangled map = (*.html *.htm)

One very useful case is to remove the annoying ;1 off the ends of
filenames on some CDROMS (only visible under some unixes). To do this
use a map of (*;1 *)

.B default:
	no mangled map

.B Example:
	mangled map = (*;1 *)

.SS mangle case (S)

See the section on "NAME MANGLING"

.SS mangled names (S)
This controls whether non-DOS names under Unix should be mapped to
DOS-compatible names ("mangled") and made visible, or whether non-DOS names
should simply be ignored.

See the section on "NAME MANGLING" for details on how to control the
mangling process.

If mangling is used then the mangling algorithm is as follows:
.RS
- the first (up to) five alphanumeric characters before the rightmost dot of
the filename are preserved, forced to upper case, and appear as the first (up
to) five characters of the mangled name.

- a tilde ("~") is appended to the first part of the mangled name, followed
by a two-character unique sequence, based on the origonal root name 
(i.e., the original filename minus its final extension). The final
extension is included in the hash calculation only if it contains any upper
case characters or is longer than three characters.

Note that the character to use may be specified using the "mangling
char" option, if you don't like ~.

- the first three alphanumeric characters of the final extension are preserved,
forced to upper case and appear as the extension of the mangled name. The 
final extension is defined as that part of the original filename after the
rightmost dot. If there are no dots in the filename, the mangled name will
have no extension (except in the case of hidden files - see below).

- files whose Unix name begins with a dot will be presented as DOS hidden
files. The mangled name will be created as for other filenames, but with the
leading dot removed and "___" as its extension regardless of actual original
extension (that's three underscores).
.RE

The two-digit hash value consists of upper case alphanumeric characters.

This algorithm can cause name collisions only if files in a directory share
the same first five alphanumeric characters. The probability of such a clash 
is 1/1300.

The name mangling (if enabled) allows a file to be copied between Unix
directories from DOS while retaining the long Unix filename. Unix files can
be renamed to a new extension from DOS and will retain the same basename. 
Mangled names do not change between sessions.

.B Default:
 	mangled names = yes

.B Example:
 	mangled names = no
.SS mangling char (S)
This controls what character is used as the "magic" character in name
mangling. The default is a ~ but this may interfere with some
software. Use this option to set it to whatever you prefer.

.B Default:
 	mangling char = ~

.B Example:
 	mangling char = ^

.SS max log file (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 .old extension.

A size of 0 means no limit.

.B Default:
	max log size = 5000

.B Example:
 	max log size = 1000

.SS max xmit (G)

This option controls the maximum packet size that will be negotiated
by Samba. The default is 65535, which is the maximum. In some cases
you may find you get better performance with a smaller value. A value
below 2048 is likely to cause problems.

.B Default:
	max xmit = 65535

.B Example:
 	max xmit = 8192

.SS mangled stack (G)
This parameter controls the number of mangled names that should be cached in
the Samba server.

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!

.B Default:
 	mangled stack = 50

.B Example:
 	mangled stack = 100

.SS map archive (S)
This controls whether the DOS archive attribute should be mapped to Unix
execute bits.  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...

.B Default:
      map archive = yes

.B Example:
      map archive = no

.SS map hidden (S)
This controls whether DOS style hidden files should be mapped to Unix
execute bits.

.B Default:
 	map hidden = no

.B Example:
 	map hidden = yes
.SS map system (S)
This controls whether DOS style system files should be mapped to Unix
execute bits.

.B Default:
 	map system = no

.B Example:
 	map system = yes
.SS max connections (S)
This option allows the number of simultaneous connections to a
service to be limited. If "max connections" is greater than 0 then
connections will be refused if this number of connections to the
service are already open. A value of zero mean an unlimited number of
connections may be made.

Record lock files are used to implement this feature. The lock files
will be stored in the directory specified by the "lock directory" option.

.B Default:
	max connections = 0

.B Example:
	max connections = 10
.SS only user (S)
This is a boolean option that controls whether connections with
usernames not in the user= list will be allowed. By default this
option is disabled so a client can supply a username to be used by
the server.

Note that this also means Samba won't try to deduce usernames from the
service name. This can be annoying for the [homes] section. To get
around this you could use "user = %S" which means your "user" list
will be just the service name, which for home directories is the name
of the user.

.B Default: 
	only user = False

.B Example: 
	only user = True

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

What I use is:

   message command = csh -c 'xedit %s;rm %s' &

This delivers the message using xedit, then removes it
afterwards. NOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN
IMMEDIATELY. That's why I have the & on the end. If it doesn't return
immediately then your PCs may freeze when sending messages (they
should recover after 30secs, hopefully).

All messages are delivered as the global guest user. The command takes
the standard substitutions, although %u won't work (%U may be better
in this case).

Apart from the standard substitutions, some additional ones apply. In
particular:

%s = the filename containing the message

%t = the destination that the message was sent to (probably the server
name)

%f = who the message is from

You could make this command send mail, or whatever else takes your
fancy. Please let me know of any really interesting ideas you have.

Here's a way of sending the messages as mail to root:

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 "message command = rm %s".

For the really adventurous, try something like this:

message command = csh -c 'csh < %s |& /usr/local/samba/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 :-)

.B Default:
	no message command

.B Example:
        message command = csh -c 'xedit %s;rm %s' &

.SS 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 no limit.

.B Default:
	min print space = 0

.B Example:
	min print space = 2000

.SS null passwords (G)
Allow or disallow access to accounts that have null passwords. 

.B Default:
	null passwords = no

.B Example:
	null passwords = yes

.SS packet size (G)
The maximum transmit packet size during a raw read. This option is no
longer implemented as of version 1.7.00, and is kept only so old
configuration files do not become invalid.

.SS passwd chat (G)
This string coontrols the "chat" conversation that takes places
between smbd and the local password changing program to change the
users password. The string describes a sequence of response-receive
pairs that smbd uses to determine what to send to the passwd program
and what to expect back. If the expected output is not received then
the password is not changed.

This chat sequence is often quite site specific, deppending on what
local methods are used for password control (such as NIS+ etc).

The string can contain the macros %o and %n which are substituted for
the old and new passwords respectively. It can aso contain the
standard macros \n \r \t and \s to give line-feed, carriage-return,
tab and space.

The string can also contain a * which matches any sequence of
characters.

Double quotes can be used to collect strings with spaces in them into
a single string.

If the send string in any part of the chat sequence is a fullstop "."
then no string is sent. Similarly, is the expect string is a fullstop
then no string is expected.

.B Example:
	passwd chat = "*Enter OLD password*" %o\n "*Enter NEW password*" %n\n \
                      "*Reenter NEW password*" %n\n "*Password changed*"

.B Default:
	passwd chat = *old*password* %o\n *new*password* %n\n *new*password* %n\n *changed*

.SS passwd program (G)
The name of a program that can be used to set user passwords.

This is only necessary if you have enabled remote password changing at
compile time. Any occurances of %u will be replaced with the user
name.

Also note that many passwd programs insist in "reasonable" passwords,
such as a minimum length, or the inclusion of mixed case chars and
digits. This can pose a problem as some clients (such as Windows for
Workgroups) uppercase the password before sending it. 

.B Default:
	passwd program = /bin/passwd

.B Example:
	passwd program = /sbin/passwd %u

.SS password level (G)
Some client/server conbinations have difficulty with mixed-case passwords.
One offending client is Windows for Workgroups, which for some reason forces
passwords to upper case when using the LANMAN1 protocol, but leaves them alone
when using COREPLUS!

This parameter defines the maximum number of characters that may be upper case
in passwords.

For example, say the password given was "FRED". If
.B password level
is set to 1 (one), the following combinations would be tried if "FRED" failed:
"Fred", "fred", "fRed", "frEd", "freD". If
.B password level was set to 2 (two), the following combinations would also be
tried: "FRed", "FrEd", "FreD", "fREd", "fReD", "frED". And so on.

The higher value this parameter is set to the more likely it is that a mixed
case password will be matched against a single case password. However, you
should be aware that use of this parameter reduces security and increases the
time taken to process a new connection.

A value of zero will cause only two attempts to be made - the password as is
and the password in all-lower case.

If you find the connections are taking too long with this option then
you probably have a slow crypt() routine. Samba now comes with a fast
"ufc crypt" that you can select in the Makefile. You should also make
sure the PASSWORD_LENGTH option is correct for your system in local.h
and includes.h. On most systems only the first 8 chars of a password
are significant so PASSWORD_LENGTH should be 8, but on some longer
passwords are significant. The inlcudes.h file tries to select the
right length for your system.

.B Default:
 	password level = 0

.B Example:
 	password level = 4

.SS password server (G)

By specifying the name of another SMB server (such as a WinNT box)
with this option, and using "security = server" you can get Samba to
do all it's username/password validation via a remote server.

This options sets the name of the password server to use. It must be a
netbios name, so if the machines netbios name is different from it's
internet name then you may have to add it's netbios name to
/etc/hosts.

The password server much be a machine capable of using the "LM1.2X002"
or the "LM NT 0.12" protocol, and it must be in user level security
mode. 

NOTE: Using a password server means your unix box (running Samba) is
only as secure as your password server. DO NOT CHOOSE A PASSWORD
SERVER THAT YOU DON'T COMPLETELY TRUST.

Never point a Samba server at itself for password serving. This will
cause a loop and could lock up your Samba server!

The name of the password server takes the standard substitutions, but
probably the only useful one is %m, which means the Samba server will
use the incoming client as the password server. If you use this then
you better trust your clients, and you better restrict them with hosts
allow!

.SS path (S)
A synonym for this parameter is 'directory'.

This parameter specifies a directory to which the user of the service is to
be given access. In the case of printable services, this is where print data 
will spool prior to being submitted to the host for printing.

For a printable service offering guest access, the service should be readonly
and the path should be world-writable and have the sticky bit set. This is not
mandatory of course, but you probably won't get the results you expect if you
do otherwise.

Any occurances of %u in the path will be replaced with the username
that the client is connecting as. Any occurances of %m will be
replaced by the name of the machine they are connecting from. These
replacements are very useful for setting up pseudo home directories
for users.

Note that this path will be based on 'root dir' if one was specified.
.B Default:
 	none

.B Example:
 	path = /home/fred+ 

.SS postexec (S)

This option specifies a command to be run whenever the service is
disconnected. It takes the usual substitutions. The command may be run
as the root on some systems.

An interesting example may be do unmount server resources:

postexec = /etc/umount /cdrom

See also preexec

.B Default:
      none (no command executed)

.B Example:
      postexec = echo \"%u disconnected from %S from %m (%I)\" >> /tmp/log

.SS postscript (S)
This parameter forces a printer to interpret the print files as
postscript. This is done by adding a %! to the start of print output. 

This is most useful when you have lots of PCs that persist in putting
a control-D at the start of print jobs, which then confuses your
printer.

.B Default: 
	postscript = False

.B Example: 
	postscript = True

.SS preexec (S)

This option specifies a command to be run whenever the service is
connected to. It takes the usual substitutions.

An interesting example is to send the users a welcome message every
time they log in. Maybe a message of the day? Here is an example:

preexec = csh -c 'echo \"Welcome to %S!\" | \
       /usr/local/samba/smbclient -M %m -I %I' &

Of course, this could get annoying after a while :-)

See also postexec

.B Default:
	none (no command executed)

.B Example:
	preexec = echo \"%u connected to %S from %m (%I)\" >> /tmp/log


.SS preload
This is an alias for "auto services"

.SS preserve case (S)

This controls if new filenames are created with the case that the
client passes, or if they are forced to be the "default" case.

.B Default:
       preserve case = no

See the section on "NAME MANGLING" for a fuller discussion.

.SS print command (S)
After a print job has finished spooling to a service, this command will be
used via a system() call to process the spool file. Typically the command 
specified will submit the spool file to the host's printing subsystem, but
there is no requirement that this be the case. The server will not remove the
spool file, so whatever command you specify should remove the spool file when
it has been processed, otherwise you will need to manually remove old spool
files.

The print command is simply a text string. It will be used verbatim,
with two exceptions: All occurrences of "%s" will be replaced by the
appropriate spool file name, and all occurrences of "%p" will be
replaced by the appropriate printer name. The spool file name is
generated automatically by the server, the printer name is discussed
below.

The full path name will be used for the filename if %s is not preceded
by a /. If you don't like this (it can stuff up some lpq output) then
use %f instead. Any occurances of %f get replaced by the spool
filename without the full path at the front.

The print command MUST contain at least one occurrence of "%s" or %f -
the "%p" is optional. At the time a job is submitted, if no printer
name is supplied the "%p" will be silently removed from the printer
command.

If specified in the [global] section, the print command given will be used
for any printable service that does not have its own print command specified.

If there is neither a specified print command for a printable service nor a 
global print command, spool files will be created but not processed and (most
importantly) not removed.

Note that printing may fail on some unixes from the "nobody"
account. If this happens then create an alternative guest account that
can print and set the "guest account" in the [global] section.

You can form quite complex print commands by realising that they are
just passed to a shell. For example the following will log a print
job, print the file, then remove it. Note that ; is the usual
separator for command in shell scripts.

print command = echo Printing %s >> /tmp/print.log; lpr -P %p %s; rm %s

You may have to vary this command considerably depending on how you
normally print files on your system.

.B Default:
        print command = lpr -r -P %p %s

.B Example:
 	print command = /usr/local/samba/myprintscript %p %s
.SS print ok (S)
See
.B printable.
.SS printable (S)
A synonym for this parameter is 'print ok'.

If this parameter is 'yes', then clients may open, write to and submit spool 
files on the directory specified for the service.

Note that a printable service will ALWAYS allow writing to the service path
(user privileges permitting) via the spooling of print data. The 'read only'
parameter controls only non-printing access to the resource.

.B Default:
 	printable = no

.B Example:
 	printable = yes

.SS printing (G)
This parameters controls how printer status information is interpreted
on your system, and also affects the default values for the "print
command", "lpq command" and "lprm command".

Currently three printing styles are supported. They are "printing =
bsd", "printing = sysv", "printing = hpux" and "printing = aix".

To see what the defaults are for the other print commands when using
these three options use the "testparm" program.


.SS printcap name (G)
This parameter may be used to override the compiled-in default printcap
name used by the server (usually /etc/printcap). See the discussion of the
[printers] section above for reasons why you might want to do this.

For those of you without a printcap (say on SysV) you can just create a
minimal file that looks like a printcap and set "printcap name =" in
[global] to point at it.

A minimal printcap file would look something like this:

print1|My Printer 1
print2|My Printer 2
print3|My Printer 3
print4|My Printer 4
print5|My Printer 5

where the | separates aliases of a printer. The fact that the second
alias has a space in it gives a hint to Samba that it's a comment.

NOTE: Under AIX the default printcap name is "/etc/qconfig". Samba
will assume the file is in AIX "qconfig" format if the string
"/qconfig" appears in the printcap filename.

.B Default:
 	printcap name = /etc/printcap

.B Example:
 	printcap name = /etc/myprintcap
.SS printer (S)
A synonym for this parameter is 'printer name'.

This parameter specifies the name of the printer to which print jobs spooled
through a printable service will be sent.

If specified in the [global] section, the printer name given will be used
for any printable service that does not have its own printer name specified.

.B Default:
 	none (but may be 'lp' on many systems)

.B Example:
 	printer name = laserwriter
.SS printer name (S)
See
.B printer.
.SS protocol (G)
The value of the parameter (a string) is the highest protocol level that will
be supported by the server. 

Possible values are CORE, COREPLUS, LANMAN1, LANMAN2 and NT1. The relative
merits of each are discussed in the README file.

.B Default:
	protocol = NT1

.B Example:
	protocol = LANMAN1
.SS public (S)
A synonym for this parameter is 'guest ok'.

If this parameter is 'yes' for a service, then no password is required
to connect to the service. Privileges will be those of the guest
account.

See the section below on user/password validation for more information about
this option.

.B Default:
 	public = no

.B Example:
 	public = yes
.SS read list (S)
This is a list of users that are given read-only access to a
service. If the connecting user is in this list then they will
not be given write access, no matter what the "read only" option
is set to. The list can include group names using the @group syntax.

See also the "write list" option

.B Default:
     read list =

.B Example:
     read list = mary, @students

.SS read only (S)
See
.B writable
and
.B write ok.
Note that this is an inverted synonym for writable and write ok.
.SS read prediction (G)
This options enables or disables the read prediction code used to
speed up reads from the server. When enabled the server will try to
pre-read data from the last accessed file that was opened read-only
while waiting for packets.

.SS Default:
	read prediction = False

.SS Example:
	read prediction = True
.SS read raw (G)
This parameter controls whether or not the server will support raw reads when
transferring data to clients.

If enabled, raw reads allow reads of 65535 bytes in one packet. This
typically provides a major performance benefit.

However, some clients either negotiate the allowable block size incorrectly
or are incapable of supporting larger block sizes, and for these clients you
may need to disable raw reads.

In general this parameter should be viewed as a system tuning tool and left
severely alone. See also
.B write raw.

.B Default:
 	read raw = yes

.B Example:
 	read raw = no
.SS read size (G)

The option "read size" affects the overlap of disk reads/writes with
network reads/writes. If the amount of data being transferred in
several of the SMB commands (currently SMBwrite, SMBwriteX and
SMBreadbraw) is larger than this value then the server begins writing
the data before it has received the whole packet from the network, or
in the case of SMBreadbraw, it begins writing to the network before
all the data has been read from disk.

This overlapping works best when the speeds of disk and network access
are similar, having very little effect when the speed of one is much
greater than the other.

The default value is 2048, but very little experimentation has been
done yet to determine the optimal value, and it is likely that the best
value will vary greatly between systems anyway. A value over 65536 is
pointless and will cause you to allocate memory unnecessarily.

.B Default:
	read size = 2048

.B Example:
	read size = 8192

.SS revalidate (S)

This options controls whether Samba will allow a previously validated
username/password pair to be used to attach to a share. Thus if you
connect to \\\\server\\share1 then to \\\\server\\share2 it won't
automatically allow the client to request connection to the second
share as the same username as the first without a password.

If "revalidate" is True then the client will be denied automatic
access as the same username.

.B Default:
	revalidate = False

.B Example:
	revalidate = True

.SS root (G)
See
.B root directory.
.SS root dir (G)
See
.B root directory.
.SS root directory (G)
Synonyms for this parameter are 'root dir' and 'root'.

The server will chroot() to this directory on startup. This is not 
strictly necessary for secure operation. Even without it the server
will deny access to files not in one of the service entries. It may 
also check for, and deny access to, soft links to other parts of the 
filesystem, or attempts to use .. in file names to access other 
directories (depending on the setting of the "wide links" parameter).

Adding a "root dir" entry other than "/" adds an extra level of security, 
but at a price. It absolutely ensures that no access is given to files not
in the sub-tree specified in the "root dir" option, *including* some files 
needed for complete operation of the server. To maintain full operability
of the server you will need to mirror some system files into the "root dir"
tree. In particular you will need to mirror /etc/passwd (or a subset of it),
and any binaries or configuration files needed for printing (if required). 
The set of files that must be mirrored is operating system dependent.

.B Default:
 	root directory = /

.B Example:
 	root directory = /homes/smb
.SS security (G)
This option does affects how clients respond to Samba.

The option sets the "security mode bit" in replies to protocol negotiations
to turn share level security on or off. Clients decide based on this bit 
whether (and how) to transfer user and password information to the server.

The default is "security=SHARE", mainly because that was the only
option at one stage.

The alternatives are "security = user" or "security = server". 

If your PCs use usernames that are the same as their usernames on the
unix machine then you will want to use "security = user". If you
mostly use usernames that don't exist on the unix box then use
"security = share".

There is a bug in WfWg that may affect your decision. When in user
level security a WfWg client will totally ignore the password you type
in the "connect drive" dialog box. This makes it very difficult (if
not impossible) to connect to a Samba service as anyone except the
user that you are logged into WfWg as.

If you use "security = server" then Samba will try to validate the
username/password by passing it to another SMB server, such as an NT
box. If this fails it will revert to "security = USER".

See the "password server" option for more details.

.B Default:
 	security = SHARE

.B Example:
 	security = USER
.SS server string (G)
This controls what string will show up in the printer comment box in
print manager and next to the IPC connection in "net view". It can be
any string that you wish to show to your users.

Note that it DOES NOT affect the string that appears in browse
lists. That is controlled by a nmbd command line option instead.

A %v will be replaced with the Samba version number.

A %h will be replaced with the hostname.

.B Default:
	server string = Samba %v

.B Example:
	server string = University of GNUs Samba Server

.SS smbrun (G)
This sets the full path to the smbrun binary. This defaults to the
value in the Makefile.

You must get this path right for many services to work correctly.

.B Default: taken from Makefile

.B Example:
	smbrun = /usr/local/samba/bin/smbrun

.SS short preserve case (S)

This controls if new short filenames are created with the case that
the client passes, or if they are forced to be the "default" case.

.B Default:
       short preserve case = no

See the section on "NAME MANGLING" for a fuller discussion.

.SS root preexec (S)

This is the same as preexec except that the command is run as
root. This is useful for mounting filesystems (such as cdroms) before
a connection is finalised.

.SS root postexec (S)

This is the same as postexec except that the command is run as
root. This is useful for unmounting filesystems (such as cdroms) after
a connection is closed.

.SS set directory (S)
If 'set directory = no', then users of the service may not use the setdir
command to change directory.

The setdir comand is only implemented in the Digital Pathworks client. See the
Pathworks documentation for details.
.B Default:
 	set directory = no

.B Example:
 	set directory = yes

.SS share modes (S)

This enables or disables the honouring of the "share modes" during a
file open. These modes are used by clients to gain exclusive read or
write access to a file. 

These open modes are not directly supported by unix, so they are
simulated using lock files in the "lock directory". The "lock
directory" specified in smb.conf must be readable by all users.

The share modes that are enabled by this option are DENY_DOS,
DENY_ALL, DENY_READ, DENY_WRITE, DENY_NONE and DENY_FCB.

Enabling this option gives full share compatability but may cost a bit
of processing time on the unix server. They are enabled by default.

.B Default:
	share modes = yes

.B Example:
	share modes = no

.SS socket options (G)
This option (which can also be invoked with the -O command line
option) allows you to set socket options to be used when talking with
the client.

Socket options are controls on the networking layer of the operating
systems which allow the connection to be tuned.

This option will typically be used to tune your Samba server for
optimal performance for your local network. There is no way that Samba
can know what the optimal parameters are for your net, so you must
experiment and choose them yourself. I strongly suggest you read the
appropriate documentation for your operating system first (perhaps
"man setsockopt" will help).

You may find that on some systems Samba will say "Unknown socket
option" when you supply an option. This means you either mis-typed it
or you need to add an include file to includes.h for your OS. If the
latter is the case please send the patch to me
(Andrew.Tridgell@anu.edu.au).

Any of the supported socket options may be combined in any way you
like, as long as your OS allows it.

This is the list of socket options currently settable using this
option:

  SO_KEEPALIVE

  SO_REUSEADDR

  SO_BROADCAST

  TCP_NODELAY

  IPTOS_LOWDELAY

  IPTOS_THROUGHPUT

  SO_SNDBUF *

  SO_RCVBUF *

  SO_SNDLOWAT *

  SO_RCVLOWAT *

Those marked with a * take an integer argument. The others can
optionally take a 1 or 0 argument to enable or disable the option, by
default they will be enabled if you don't specify 1 or 0.

To specify an argument use the syntax SOME_OPTION=VALUE for example
SO_SNDBUF=8192. Note that you must not have any spaces before or after
the = sign.

If you are on a local network then a sensible option might be

socket options = IPTOS_LOWDELAY

If you have an almost unloaded local network and you don't mind a lot
of extra CPU usage in the server then you could try

socket options = IPTOS_LOWDELAY TCP_NODELAY

If you are on a wide area network then perhaps try setting
IPTOS_THROUGHPUT. 

Note that several of the options may cause your Samba server to fail
completely. Use these options with caution!

.B Default:
	no socket options

.B Example:
	socket options = IPTOS_LOWDELAY	




.SS status (G)
This enables or disables logging of connections to a status file that
smbstatus can read.

With this disabled smbstatus won't be able to tell you what
connections are active.

.B Default:
	status = yes

.B Example:
	status = no

.SS strip dot (G)
This is a boolean that controls whether to strup trailing dots off
filenames. This helps with some CDROMs that have filenames ending in a
single dot.

NOTE: This option is now obsolete, and may be removed in future. You
should use the "mangled map" option instead as it is much more
general. 

.SS strict locking (S)
This is a boolean that controls the handling of file locking in the
server. When this is set to yes the server will check every read and
write access for file locks, and deny access if locks exist. This can
be slow on some systems.

When strict locking is "no" the server does file lock checks only when
the client explicitly asks for them. 

Well behaved clients always ask for lock checks when it is important,
so in the vast majority of cases "strict locking = no" is preferable.

.B Default:
	strict locking = no

.B Example:
	strict locking = yes

.SS sync always (S)

This is a boolean parameter that controls whether writes will always
be written to stable storage before the write call returns. If this is
false then the server will be guided by the clients request in each
write call (clients can set a bit indicating that a particular write
should be synchronous). If this is true then every write will be
followed by a fsync() call to ensure the data is written to disk.

.B Default:
	sync always = no

.B Example:
	sync always = yes

.SS time offset (G)
This parameter is a setting in minutes to add to the normal GMT to
local time conversion. This is useful if you are serving a lot of PCs
that have incorrect daylight saving time handling.

.B Default:
	time offset = 0

.B Example:
	time offset = 60

.SS user (S)
See
.B username.
.SS username (S)
A synonym for this parameter is 'user'.

Multiple users may be specified in a comma-delimited list, in which case the
supplied password will be tested against each username in turn (left to right).

The username= line is needed only when the PC is unable to supply it's own
username. This is the case for the coreplus protocol or where your
users have different WfWg usernames to unix usernames. In both these
cases you may also be better using the \\\\server\\share%user syntax
instead. 

The username= line is not a great solution in many cases as it means Samba
will try to validate the supplied password against each of the
usernames in the username= line in turn. This is slow and a bad idea for
lots of users in case of duplicate passwords. You may get timeouts or
security breaches using this parameter unwisely.

Samba relies on the underlying unix security. This parameter does not
restrict who can login, it just offers hints to the Samba server as to
what usernames might correspond to the supplied password. Users can
login as whoever they please and they will be able to do no more
damage than if they started a telnet session. The daemon runs as the
user that they log in as, so they cannot do anything that user cannot
do.

To restrict a service to a particular set of users you can use the
"valid users=" line.

If any of the usernames begin with a @ then the name will be looked up
in the groups file and will expand to a list of all users in the group
of that name. Note that searching though a groups file can take quite
some time, and some clients may time out during the search.

See the section below on username/password validation for more information
on how this parameter determines access to the services.

.B Default:
 	The guest account if a guest service, else the name of the service.

.B Examples:
 	username = fred
 	username = fred, mary, jack, jane, @users, @pcgroup

.SS username map (G)

This option allows you to to specify a file containing a mapping of
usernames from the clients to the server. This can be used for several
purposes. The most common is to map usernames that users use on dos or
windows machines to those that the unix box uses. The other is to map
multiple users to a single username so that they can more easily share
files.

The map file is parsed line by line. Each line should contain a single
unix username on the left then a '=' followed by a list of usernames
on the right. The list of usernames on the right may contain names of
the form @group in which case they will match any unix username in
that group. The special client name '*' is a wildcard and matches any
name.

The file is processed on each line by taking the supplied username and
comparing it with each username on the right hand side of the '='
signs. If the supplied name matrches any of the names on the right
hand side then it is replaced with the name on the left. Processing
then continues with the next line.

If any line begins with a '#' or a ';' then it is ignored

For example to map from he name "admin" or "administrator" to the unix
name "root" you would use

	root = admin administrator

Or to map anyone in the unix group "system" to the unix name "sys" you
would use

	sys = @system

You can have as many mappings as you like in a username map file.

Note that the remapping is applied to all occurances of
usernames. Thus if you connect to "\\\\server\\fred" and "fred" is
remapped to "mary" then you will actually be connecting to
"\\\\server\\mary" and will need to supply a password suitable for
"mary" not "fred". The only exception to this is the username passwed
to the "password server" (if you have one). The password server will
receive whatever username the client supplies without modification.

Also note that no reverse mapping is done. The main effect this has is
with printing. Users who have been mapped may have trouble deleting
print jobs as PrintManager under WfWg will think they don't own the
print job.

.B Default
	no username map

.B Example
	username map = /usr/local/samba/lib/users.map

.SS valid chars (S)

The option allows you to specify additional characters that should be
considered valid by the server in filenames. This is particularly
useful for national character sets, such as adding u-umlaut or a-ring.

The option takes a list of characters in either integer or character
form with spaces between them. If you give two characters with a colon
between them then it will be taken as an lowercase:uppercase pair.

If you have an editor capable of entering the characters into the
config file then it is probably easiest to use this method. Otherwise
you can specify the characters in octal, decimal or hexidecimal form
using the usual C notation.

For example to add the single character 'Z' to the charset (which is a
pointless thing to do as it's already there) you could do one of the
following

valid chars = Z
valid chars = z:Z
valid chars = 0132:0172

The last two examples above actually add two characters, and alters
the uppercase and lowercase mappings appropriately.

.B Default
	Samba defaults to using a reasonable set of valid characters
	for english systems

.B Example
        valid chars = 0345:0305 0366:0326 0344:0304

The above example allows filenames to have the swedish characters in
them. 

.SS valid users (S)
This is a list of users that should be allowed to login to this
service. A name starting with @ is interpreted as a unix group.

If this is empty (the default) then any user can login. If a username
is in both this list and the "invalid users" list then access is
denied for that user.

The current servicename is substituted for %S. This is useful in the
[homes] section.

See also "invalid users"

.B Default
	No valid users list. (anyone can login)

.B Example
	valid users = greg, @pcusers

.SS wide links (S)
This parameter controls whether or not links in the Unix file system may be
followed by the server. Links that point to areas within the directory tree
exported by the server are always allowed; this parameter controls access 
only to areas that are outside the directory tree being exported.

.B Default:
 	wide links = yes

.B Example:
 	wide links = no

.SS workgroup (G)

This controls what workgroup your server will appear to be in when
queried by clients. This can be different to the workgroup specified
in the nmbd configuration, but it is probably best if you set them to
the same value.

.B Default:
 	set in the Makefile

.B Example:
 	workgroup = MYGROUP

.SS write ok (S)
See
.B writable
and
.B read only.
.SS writable (S)
A synonym for this parameter is 'write ok'. An inverted synonym is 'read only'.

If this parameter is 'no', then users of a service may not create or modify
files in the service's directory.

Note that a printable service ('printable = yes') will ALWAYS allow 
writing to the directory (user privileges permitting), but only via
spooling operations.

.B Default:
 	writable = no

.B Examples:
 	read only = no
 	writable = yes
 	write ok = yes
.SS write list (S)
This is a list of users that are given read-write access to a
service. If the connecting user is in this list then they will be
given write access, no matter what the "read only" option is set
to. The list can include group names using the @group syntax.

Note that if a user is in both the read list and the write list then
they will be given write access.

See also the "read list" option

.B Default:
     write list =

.B Example:
     write list = admin, root, @staff

.SS write raw (G)
This parameter controls whether or not the server will support raw writes when
transferring data from clients.

.B Default:
 	write raw = yes

.B Example:
 	write raw = no
.SH NOTE ABOUT USERNAME/PASSWORD VALIDATION
There are a number of ways in which a user can connect to a
service. The server follows the following steps in determining if it
will allow a connection to a specified service. If all the steps fail
then the connection request is rejected. If one of the steps pass then
the following steps are not checked.

If the service is marked "guest only = yes" then steps 1 to 5 are skipped

Step 1: If the client has passed a username/password pair and that
username/password pair is validated by the unix systems password
programs then the connection is made as that username. Note that this
includes the \\\\server\\service%username method of passing a username.

Step 2: If the client has previously registered a username with the
system and now supplies a correct password for that username then the
connection is allowed.

Step 3: The clients netbios name and any previously used user names
are checked against the supplied password, if they match then the
connection is allowed as the corresponding user.

Step 4: If the client has previously validated a username/password
pair with the server and the client has passed the validation token
then that username is used. This step is skipped if "revalidate = yes" 
for this service.

Step 5: If a "user = " field is given in the smb.conf file for the
service and the client has supplied a password, and that password
matches (according to the unix systems password checking) with one of
the usernames from the user= field then the connection is made as the
username in the "user=" line. If one of the username in the user= list
begins with a @ then that name expands to a list of names in the group
of the same name.

Step 6: If the service is a guest service then a connection is made as
the username given in the "guest account =" for the service,
irrespective of the supplied password.


.SH WARNINGS
Although the configuration file permits service names to contain spaces, 
your client software may not. Spaces will be ignored in comparisons anyway,
so it shouldn't be a problem - but be aware of the possibility.

On a similar note, many clients - especially DOS clients - limit service
names to eight characters. Smbd has no such limitation, but attempts
to connect from such clients will fail if they truncate the service names.
For this reason you should probably keep your service names down to eight 
characters in length.

Use of the [homes] and [printers] special sections make life for an 
administrator easy, but the various combinations of default attributes can be
tricky. Take extreme care when designing these sections. In particular,
ensure that the permissions on spool directories are correct.
.SH VERSION
This man page is (mostly) correct for version 1.9.00 of the Samba suite, plus some
of the recent patches to it. These notes will necessarily lag behind 
development of the software, so it is possible that your version of 
the server has extensions or parameter semantics that differ from or are not 
covered by this man page. Please notify these to the address below for 
rectification.

Prior to version 1.5.21 of the Samba suite, the configuration file was
radically different (more primitive). If you are using a version earlier than
1.8.05, it is STRONGLY recommended that you upgrade.
.SH OPTIONS
Not applicable.

.SH FILES
Not applicable.

.SH ENVIRONMENT VARIABLES
Not applicable.

.SH SEE ALSO
.B smbd(8),
.B smbclient(1),
.B nmbd(8),
.B testparm(1), 
.B testprns(1),
.B lpq(1),
.B hosts_access(5)
.SH DIAGNOSTICS
[This section under construction]

Most diagnostics issued by the server are logged in a specified log file. The
log file name is specified at compile time, but may be overridden on the
smbd (see smbd(8)) command line.

The number and nature of diagnostics available depends on the debug level used
by the server. If you have problems, set the debug level to 3 and peruse the
log files.

Most messages are reasonably self-explanatory. Unfortunately, at time of
creation of this man page the source code is still too fluid to warrant
describing each and every diagnostic. At this stage your best bet is still
to grep the source code and inspect the conditions that gave rise to the 
diagnostics you are seeing.

.SH BUGS
None known.

Please send bug reports, comments and so on to:

.RS 3
.B Andrew.Tridgell@anu.edu.au (Andrew Tridgell)

.RS 3
or to the mailing list
.RE

.B samba@listproc.anu.edu.au

.RE
You may also like to subscribe to the announcement channel

.RS 3
samba-announce@listproc.anu.edu.au
.RE

To subscribe to these lists send a message to
listproc@listproc.anu.edu.au with a body of "subscribe samba Your
Name" or "subscribe samba-announce Your Name".

Errors or suggestions for improvements to the Samba man pages should be 
mailed to:

.RS 3
.B Andrew.Tridgell@anu.edu.au (Andrew Tridgell)
.RE

.TH SMBCLIENT 1 17/1/1995 smbclient smbclient
.SH NAME
smbclient \- ftp-like Lan Manager client program
.SH SYNOPSIS
.B smbclient
.B servicename
[
.B password
] [
.B -A
] [
.B -E
] [
.B -L
.I host
] [
.B -M
.I host
] [
.B -I
.I IP number
] [
.B -N
] [
.B -P
] [
.B -U
.I username
] [
.B -d
.I debuglevel
] [
.B -l
.I log basename
] [
.B -n
.I netbios name
] [
.B -O
.I socket options
] [
.B -p
.I port number
]
.SH DESCRIPTION
This program is part of the Samba suite.

.B smbclient
is a client that can 'talk' to a Lan Manager server. It offers
an interface similar to that of the 
.B ftp
program (see
.B ftp(1)). Operations include things like getting files from the
server to the local machine, putting files from the local machine to
the server, retrieving directory information from the server and so on.

NOTE: Ricky Poulten (poultenr@logica.co.uk) has written a "tar"
extension to smbclient that allows you to back up and restore your
lan-manager compatible network using smbclient.

You can fetch the tar extension from the "contributed" section on
nimbus. ftp://nimbus.anu.edu.au/pub/tridge/samba/contributed/


.SH OPTIONS
.B servicename
.RS 3
.B servicename
is the name of the service you want to use on the server. A service
name takes the form
.B "\\\\\\\\server\\\\service"
where
.B server
is the netbios name of the Lan Manager server offering the desired service and
.B service
is the name of the service offered. Thus to connect to the service "printer" 
on the Lan Manager server "lanman", you would use the servicename

.RS 10
.B "\\\\\\\\lanman\\\\printer"
.RE

Note that the server name required is NOT necessarily the host name of the
server! The name required is a Lan Manager server name, which may or may not
be the same as the hostname of the machine running the server.
.RE

.B password
.RS 3
.B
password
is the password required to access the specified service on the
specified server. If supplied, the
.B -N
option (suppress password prompt) is assumed.

There is no default password. If no password is supplied on the command line
(either here or using the 
.B -U
option (see below)) and 
.B -N
is not specified, the client will prompt for a password, even if the desired 
service does not require one. (If prompted for a password and none is 
required, simply press ENTER to provide a null password.)

Note: Some servers (including OS/2 and Windows for Workgroups) insist
on an uppercase password. Lowercase or mixed case passwords may be
rejected by these servers.

Be cautious about including passwords in scripts.
.RE

.B -A

.RS 3
This parameter, if specified, causes the maximum debug level to be selected.
Be warned that this generates prodigious amounts of debug data. There is also
a security issue involved, as at the maximum debug level cleartext passwords
may be written to some log files.
.RE

.B -L

.RS 3
This option allows you to look at what services are available on a
server. You use it as "smbclient -L host" and a list should appear.
The -I option may be useful if your netbios names don't match your 
tcp/ip host names or if you are trying to reach a host on another
network. For example:

smbclient -L ftp -I ftp.microsoft.com

will list the shares available on microsofts public server.
.RE

.B -M

.RS 3
This options allows you to send messages, using the "WinPopup"
protocol, to another computer. Once a connection is established you
then type your message, pressing ^D (control-D) to end.

If the receiving computer is running WinPopup the user will receive
the message and probably a beep. If they are not running WinPopup the
message will be lost, and no error message will occur.

The message is also automatically truncated if the message is over
1600 bytes, as this is the limit of the protocol.

One useful trick is to cat the message through smbclient. For example:

cat mymessage.txt | smbclient -M FRED

will send the message in the file "mymessage.txt" to the machine FRED.

You may also find the -U and -I options useful, as they allow you to
control the FROM and TO parts of the message. 

Samba currently has no way of receiving WinPopup messages.

Note: Copy WinPopup into the startup group on your WfWg PCs if you
want them to always be able to receive messages.
.RE

.B -E

.RS 3
This parameter, if specified, causes the client to write messages to the
standard error stream (stderr) rather than to the standard output stream.

By default, the client writes messages to standard output - typically the
user's tty.
.RE

.B -I
.I IP number

.RS 3
.I IP number
represents the IP number of the server to connect to. It should
be specified in standard "a.b.c.d" notation.

Normally the client will attempt to locate the specified Lan Manager server
by looking it up - that is, broadcasting a request for the given server to
identify itself. Using this parameter will force the client to assume that
the server is on the machine with the specified IP number.

There is no default for this parameter. If not supplied, it will be determined
automatically by the client as described above.
.RE

.B -N

.RS 3
If specified, this parameter suppresses the normal password prompt from the
client to the user. This is useful when accessing a service that does not
require a password.

Unless a password is specified on the command line or this parameter is
specified, the client will request a password.
.RE

.B -O
.I socket options
.RS 3

See the socket options section of smb.conf(5) for details

.RE
.B -P

.RS 3
If specified, the service requested will be connected to as a printer service
rather than as a normal filespace service. Operations such as put and get
will not be applicable for such a connection.

By default, services will be connected to as NON-printer services.
.RE

.B -U
.I username

.RS 3
.I username
is the user name that will be used by the client to make a connection,
assuming your server is running a protocol that allows for usernames.

Some servers are fussy about the case of this name, and some insist
that it must be a valid netbios name.

If no 
.I username
is supplied, it will default to an uppercase version of the 
environment variable 
.B USER
or
.B LOGNAME
in that order.
If no 
.I username
is supplied and neither environment variable exists the user name will
be empty.

If the service you are connecting to requires a password, it can be supplied
using the
.B -U
option, by appending a percent symbol ("%") then the password to 
.I username.
For example, to attach to a service as user "fred" with password "secret", you
would specify
.B -U
.I fred%secret
on the command line. Note that there are no spaces around the percent symbol.

If you specify the password as part of
.I username
then the 
.B -N
option (suppress password prompt) is assumed.

If you specify the password as a parameter AND as part of
.I username
then the password as part of
.I username
will take precedence. Putting nothing before or nothing after the percent 
symbol will cause an empty username or an empty password to be used,
respectively.

Note: Some servers (including OS/2 and Windows for Workgroups) insist
on an uppercase password. Lowercase or mixed case passwords may be
rejected by these servers.

Be cautious about including passwords in scripts.
.RE

.B -d
.I debuglevel
.RS 3

debuglevel is an integer from 0 to 5.

The default value if this parameter is not specified is zero.

The higher this value, the more detail will be logged to the log files about
the activities of the client. At level 0, only critical errors and serious 
warnings will be logged. Level 1 is a reasonable level for day to day running
- it generates a small amount of information about operations carried out.

Levels above 1 will generate considerable amounts of log data, and should 
only be used when investigating a problem. Levels above 3 are designed for 
use only by developers and generate HUGE amounts of log data, most of which 
is extremely cryptic.
.RE

.B -l
.I log basename

.RS 3
If specified,
.I log basename
specifies a base filename into which operational data from the running client
will be logged.

The default base name is specified at compile time.

The base name is used to generate actual log file names. For example, if the
name specified was "log", the following files would be used for log data:

.RS 3
log.client.debug (containing debugging information)

log.client.in (containing inbound transaction data)

log.client.out (containing outbound transaction data)
.RE

The log files generated are never removed by the client.
.RE
.RE

.B -n
.I netbios name

.RS 3
By default, the client will use the local machine's hostname (in
uppercase) as its netbios name. This parameter allows you to override
the host name and use whatever netbios name you wish.
.RE

.B -p
.I port number
.RS 3

port number is a positive integer value.

The default value if this parameter is not specified is 139.

This number is the port number that will be used when making connections to
the server. The standard (well-known) port number for the server is 139, 
hence the default.

This parameter is not normally specified.
.RE

.SH OPERATIONS
Once the client is running, the user is presented with a prompt, "smb: \\>".
The backslash ("\\") indicates the current working directory on the server,
and will change if the current working directory is changed.

The prompt indicates that the client is ready and waiting to carry out a user
command. Each command is a single word, optionally followed by parameters
specific to that command. Command and parameters are space-delimited unless
these notes specifically state otherwise. All commands are case-insensitive.
Parameters to commands may or may not be case sensitive, depending on the
command.

You can specify file names which have spaces in them by quoting the
name with double quotes, for example "a long file name".

Parameters shown in square brackets (eg., "[parameter]") are optional. If not
given, the command will use suitable defaults. Parameters shown in angle
brackets (eg., "<parameter>") are required.

Note that all commands operating on the server are actually performed by
issuing a request to the server. Thus the behaviour may vary from server to
server, depending on how the server was implemented.

The commands available are given here in alphabetical order.

.B ?
.RS 3
.B Parameters:
.RS 3
.I [command]

.RE
.B Description:
.RS 3
If
.I command
is specified, the
.B ?
command will display a brief informative message about the specified command.

If no command is specified, a list of available commands will be displayed.
.RE
.RE

.B !
.RS 3
.B Parameters:
.RS 3
.I [shell command]

.RE
.B Description:
.RS 3
If
.I shell command
is specified, the
.B !
command will execute a shell locally and run the specified shell command. If
no command is specified, a shell will be run.
.RE
.RE

.B cd
.RS 3
.B Parameters:
.RS 3
.I [directory name]

.RE
.B Description:
.RS 3
If
.I directory name
is specified, the current working directory
.B on the server
will be changed to the directory specified. This operation will fail if for
any reason the specified directory is inaccessible.

If no directory name is specified, the current working directory
.B on the server
will be reported.
.RE
.RE

.B del
.RS 3
.B Parameters:
.RS 3
.I <mask>

.RE
.B Description:
.RS 3
The client will request that the server attempt to delete all files matching
.I mask
from the current working directory
.B on the server.
.RE
.RE

.B dir
.RS 3
.B Parameters:
.RS 3
.I <mask>

.RE
.B Description:
.RS 3
A list of the files matching
.I mask
in the current working directory
.B on the server
will be retrieved from the server and displayed.
.RE
.RE

.B exit
.RS 3
.B Parameters:
.RS 3
None.

.RE
.B Description:
.RS 3
Terminate the connection with the server and exit from the program.
.RE
.RE

.B get
.RS 3
.B Parameters:
.RS 3
.I <remote file name> [local file name]

.RE
.B Description:
.RS 3
Copy the file called
.I remote file name
from the server to the machine running the client. If specified, name the
local copy
.I local file name.
Note that all transfers in smbclient are binary. See also the
.B lowercase
command.
.RE
.RE

.B help
.RS 3
.B Parameters:
.RS 3
.I [command]

.RE
.B Description:
.RS 3
See the
.B ?
command above.
.RE
.RE

.B lcd
.RS 3
.B Parameters:
.RS 3
.I [directory name]

.RE
.B Description:
.RS 3
If
.I directory name
is specified, the current working directory
.B on the local machine
will be changed to the directory specified. This operation will fail if for
any reason the specified directory is inaccessible.

If no directory name is specified, the name of the current working directory
.B on the local machine
will be reported.
.RE
.RE

.B lowercase
.RS 3
.B Parameters:
.RS 3
None.

.RE
.B Description:
.RS 3
Toggle lowercasing of filenames for the
.B get
and
.B mget
commands.

When lowercasing is toggled ON, local filenames are converted to lowercase
when using the
.B get
and
.B mget
commands. This is often useful when copying (say) MSDOS files from a server,
because lowercase filenames are the norm on Unix systems.
.RE
.RE

.B ls
.RS 3
.B Parameters:
.RS 3
.I <mask>

.RE
.B Description:
.RS 3
See the
.B dir
command above.
.RE
.RE

.B mask
.RS 3
.B Parameters:
.RS 3
.I <mask>

.RE
.B Description:
.RS 3
This command allows the user to set up a mask which will be used during
recursive operation of the
.B mget
and
.B mput
commands.

The masks specified to the
.B mget
and
.B mput
commands act as filters for directories
rather than files when recursion is toggled ON.

The mask specified with the
.B mask
command is necessary to filter files within those directories. For example,
if the mask specified in an
.B mget
command is "source*"
.I and
the mask specified with the
.B mask
command is "*.c"
.I and
recursion is toggled ON, the
.B mget
command will retrieve all files matching "*.c" in all directories below
and including all directories matching "source*" in the current working 
directory.

Note that the value for
.I mask
defaults to blank (equivalent to "*") and remains so until the
.B mask
command is used to change it. It retains the most recently specified value
indefinitely. To avoid unexpected results it would be wise to change the
value of
.I mask
back to "*" after using the
.B mget
or
.B mput
commands.
.RE
.RE

.B md
.RS 3
.B Parameters:
.RS 3
.I <directory name>

.RE
.B Description:
.RS 3
See the
.B mkdir
command.
.RE
.RE

.B mget
.RS 3
.B Parameters:
.RS 3
.I <mask>

.RE
.B Description:
.RS 3
Copy all files matching
.I mask
from the server to the machine running the client.

Note that
.I mask
is interpreted differently during recursive operation and non-recursive
operation - refer to the
.B recurse
and
.B mask
commands for more information. Note that all transfers in smbclient are 
binary. See also the
.B lowercase
command.
.RE
.RE

.B mkdir
.RS 3
.B Parameters:
.RS 3
.I <directory name>

.RE
.B Description:
.RS 3
Create a new directory 
.B on the server
(user access privileges permitting) with the specified name.
.RE
.RE

.B mput
.RS 3
.B Parameters:
.RS 3
.I <mask>

.RE
.B Description:
.RS 3
Copy all files matching
.I mask
in the current working directory
.B on the local machine
to the current working directory on the server.

Note that
.I mask
is interpreted differently during recursive operation and non-recursive
operation - refer to the
.B recurse
and
.B mask
commands for more information. Note that all transfers in smbclient are 
binary.
.RE
.RE

.B print
.RS 3
.B Parameters:
.RS 3
.I <file name>

.RE
.B Description:
.RS 3
Print the specified file
.B from the local machine
through a printable service on the server.

See also the
.B printmode
command.
.RE
.RE

.B printmode
.RS 3
.B Parameters:
.RS 3
.I <graphics or text>

.RE
.B Description:
.RS 3
Set the print mode to suit either binary data (such as graphical information)
or text. Subsequent
.B print
commands will use the currently set print mode.
.RE
.RE

.B prompt
.RS 3
.B Parameters:
.RS 3
None.

.RE
.B Description:
.RS 3
Toggle prompting for filenames during operation of the
.B mget
and
.B mput
commands.

When toggled ON, the user will be prompted to confirm the transfer of each
file during these commands. When toggled OFF, all specified files will be
transferred without prompting.
.RE
.RE

.B put
.RS 3
.B Parameters:
.RS 3
.I <local file name> [remote file name]

.RE
.B Description:
.RS 3
Copy the file called
.I local file name
from the machine running the client to the server. If specified, name the
remote copy
.I remote file name.
Note that all transfers in smbclient are binary. See also the
.B lowercase
command.
.RE
.RE

.B queue
.RS 3
.B Parameters:
.RS 3
None.

.RE
.B Description:
.RS 3
Displays the print queue, showing the job id, name, size and current status.
.RE
.RE

.B quit
.RS 3
.B Parameters:
.RS 3
None.

.RE
.B Description:
.RS 3
See the
.B exit
command.
.RE
.RE

.B rd
.RS 3
.B Parameters:
.RS 3
.I <directory name>

.RE
.B Description:
.RS 3
See the
.B rmdir
command.
.RE
.RE

.B recurse
.RS 3
.B Parameters:
.RS 3
None.

.RE
.B Description:
.RS 3
Toggle directory recursion for the commands
.B mget
and
.B mput
.

When toggled ON, these commands will process all directories in the source
directory (ie., the directory they are copying
.I from
) and will recurse into any that match the mask specified to the command. Only
files that match the mask specified using the
.B mask
command will be retrieved. See also the
.mask
command.

When recursion is toggled OFF, only files from the current working
directory on the source machine that match the mask specified to the
.B mget
or
.B mput
commands will be copied, and any mask specified using the
.B mask
command will be ignored.
.RE
.RE

.B rm
.RS 3
.B Parameters:
.RS 3
.I <mask>

.RE
.B Description:
.RS 3
Remove all files matching
.I mask
from the current working directory
.B on the server.
.RE
.RE

.B rmdir
.RS 3
.B Parameters:
.RS 3
.I <directory name>

.RE
.B Description:
.RS 3
Remove the specified directory (user access privileges permitting)
.B from the server.
.RE
.RE


.SH NOTES
Some servers are fussy about the case of supplied usernames, passwords, share
names (aka service names) and machine names. If you fail to connect try
giving all parameters in uppercase.

It is often necessary to use the
.B -n
option when connecting to some types
of servers. For example OS/2 LanManager insists on a valid netbios name
being used, so you need to supply a valid name that would be known to
the server.

.B smbclient
supports long file names where the server supports the LANMAN2
protocol.

.SH FILES
Not applicable.

.SH ENVIRONMENT VARIABLES
.B USER
.RS 3
The variable USER may contain the username of the pers