summaryrefslogtreecommitdiff
path: root/docs/htmldocs/smbclient.1.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/htmldocs/smbclient.1.html')
-rw-r--r--docs/htmldocs/smbclient.1.html417
1 files changed, 0 insertions, 417 deletions
diff --git a/docs/htmldocs/smbclient.1.html b/docs/htmldocs/smbclient.1.html
deleted file mode 100644
index 1fc9f30a21..0000000000
--- a/docs/htmldocs/smbclient.1.html
+++ /dev/null
@@ -1,417 +0,0 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbclient</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.60.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbclient.1"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>smbclient &#8212; ftp-like client to access SMB/CIFS resources
- on servers</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">smbclient</tt> {servicename} [password] [-b &lt;buffer size&gt;] [-d debuglevel] [-D Directory] [-U username] [-W workgroup] [-M &lt;netbios name&gt;] [-m maxprotocol] [-A authfile] [-N] [-l logfile] [-L &lt;netbios name&gt;] [-I destinationIP] [-E] [-c &lt;command string&gt;] [-i scope] [-O &lt;socket options&gt;] [-p port] [-R &lt;name resolve order&gt;] [-s &lt;smb config file&gt;] [-T&lt;c|x&gt;IXFqgbNan] [-k]</p></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This tool is part of the <a href="Samba.7.html"><span class="citerefentry"><span class="refentrytitle">Samba</span>(7)</span></a> suite.</p><p><b class="command">smbclient</b> is a client that can
- 'talk' to an SMB/CIFS server. It offers an interface
- similar to that of the ftp program (see <a href="ftp.1.html"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a>).
- 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. </p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">servicename</span></dt><dd><p>servicename is the name of the service
- you want to use on the server. A service name takes the form
- <tt class="filename">//server/service</tt> where <i class="parameter"><tt>server
- </tt></i> is the NetBIOS name of the SMB/CIFS server
- offering the desired service and <i class="parameter"><tt>service</tt></i>
- is the name of the service offered. Thus to connect to
- the service "printer" on the SMB/CIFS server "smbserver",
- you would use the servicename <tt class="filename">//smbserver/printer
- </tt></p><p>Note that the server name required is NOT necessarily
- the IP (DNS) host name of the server ! The name required is
- a NetBIOS server name, which may or may not be the
- same as the IP hostname of the machine running the server.
- </p><p>The server name is looked up according to either
- the <i class="parameter"><tt>-R</tt></i> parameter to <b class="command">smbclient</b> or
- using the name resolve order parameter in
- the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file,
- allowing an administrator to change the order and methods
- by which server names are looked up. </p></dd><dt><span class="term">password</span></dt><dd><p>The password required to access the specified
- service on the specified server. If this parameter is
- supplied, the <i class="parameter"><tt>-N</tt></i> option (suppress
- password prompt) is assumed. </p><p>There is no default password. If no password is supplied
- on the command line (either by using this parameter or adding
- a password to the <i class="parameter"><tt>-U</tt></i> option (see
- below)) and the <i class="parameter"><tt>-N</tt></i> option is not
- specified, the client will prompt for a password, even if
- the desired service does not require one. (If no password is
- required, simply press ENTER to provide a null password.)
- </p><p>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.
- </p><p>Be cautious about including passwords in scripts.
- </p></dd><dt><span class="term">-R &lt;name resolve order&gt;</span></dt><dd><p>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.</p><p>The options are :"lmhosts", "host", "wins" and "bcast". They
- cause names to be resolved as follows:</p><div class="itemizedlist"><ul type="disc"><li><p><tt class="constant">lmhosts</tt>: Lookup an IP
- address in the Samba lmhosts file. If the line in lmhosts has
- no name type attached to the NetBIOS name (see
- the <a href="lmhosts.5.html"><span class="citerefentry"><span class="refentrytitle">lmhosts</span>(5)</span></a> for details) then
- any name type matches for lookup.</p></li><li><p><tt class="constant">host</tt>: Do a standard host
- name to IP address resolution, using the system <tt class="filename">/etc/hosts
- </tt>, NIS, or DNS lookups. This method of name resolution
- is operating system dependent, for instance on IRIX or Solaris this
- may be controlled by the <tt class="filename">/etc/nsswitch.conf</tt>
- file). Note that this method is only used if the NetBIOS name
- type being queried is the 0x20 (server) name type, otherwise
- it is ignored.</p></li><li><p><tt class="constant">wins</tt>: Query a name with
- the IP address listed in the <i class="parameter"><tt>wins server</tt></i>
- parameter. If no WINS server has
- been specified this method will be ignored.</p></li><li><p><tt class="constant">bcast</tt>: Do a broadcast on
- each of the known local interfaces listed in the
- <i class="parameter"><tt>interfaces</tt></i>
- parameter. This is the least reliable of the name resolution
- methods as it depends on the target host being on a locally
- connected subnet.</p></li></ul></div><p>If this parameter is not set then the name resolve order
- defined in the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file parameter
- (name resolve order) will be used. </p><p>The default order is lmhosts, host, wins, bcast and without
- this parameter or any entry in the <i class="parameter"><tt>name resolve order
- </tt></i> parameter of the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file the name resolution
- methods will be attempted in this order. </p></dd><dt><span class="term">-M NetBIOS name</span></dt><dd><p>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. </p><p>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. </p><p>The message is also automatically truncated if the message
- is over 1600 bytes, as this is the limit of the protocol.
- </p><p>One useful trick is to cat the message through
- <b class="command">smbclient</b>. For example: <b class="command">
- cat mymessage.txt | smbclient -M FRED </b> will
- send the message in the file <tt class="filename">mymessage.txt</tt>
- to the machine FRED. </p><p>You may also find the <i class="parameter"><tt>-U</tt></i> and
- <i class="parameter"><tt>-I</tt></i> options useful, as they allow you to
- control the FROM and TO parts of the message. </p><p>See the <i class="parameter"><tt>message command</tt></i> parameter in the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> for a description of how to handle incoming
- WinPopup messages in Samba. </p><p><span class="emphasis"><em>Note</em></span>: Copy WinPopup into the startup group
- on your WfWg PCs if you want them to always be able to receive
- messages. </p></dd><dt><span class="term">-p port</span></dt><dd><p>This number is the TCP port number that will be used
- when making connections to the server. The standard (well-known)
- TCP port number for an SMB/CIFS server is 139, which is the
- default. </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
-</p></dd><dt><span class="term">-I IP-address</span></dt><dd><p><i class="replaceable"><tt>IP address</tt></i> is the address of the server to connect to.
- It should be specified in standard "a.b.c.d" notation. </p><p>Normally the client would attempt to locate a named
- SMB/CIFS server by looking it up via the NetBIOS name resolution
- mechanism described above in the <i class="parameter"><tt>name resolve order</tt></i>
- parameter above. Using this parameter will force the client
- to assume that the server is on the machine with the specified IP
- address and the NetBIOS name component of the resource being
- connected to will be ignored. </p><p>There is no default for this parameter. If not supplied,
- it will be determined automatically by the client as described
- above. </p></dd><dt><span class="term">-E</span></dt><dd><p>This parameter causes the client to write messages
- to the standard error stream (stderr) rather than to the standard
- output stream. </p><p>By default, the client writes messages to standard output
- - typically the user's tty. </p></dd><dt><span class="term">-L</span></dt><dd><p>This option allows you to look at what services
- are available on a server. You use it as <b class="command">smbclient -L
- host</b> and a list should appear. The <i class="parameter"><tt>-I
- </tt></i> option may be useful if your NetBIOS names don't
- match your TCP/IP DNS host names or if you are trying to reach a
- host on another network. </p></dd><dt><span class="term">-t terminal code</span></dt><dd><p>This option tells <b class="command">smbclient</b> how to interpret
- filenames coming from the remote server. Usually Asian language
- multibyte UNIX implementations use different character sets than
- SMB/CIFS servers (<span class="emphasis"><em>EUC</em></span> instead of <span class="emphasis"><em>
- SJIS</em></span> for example). Setting this parameter will let
- <b class="command">smbclient</b> convert between the UNIX filenames and
- the SMB filenames correctly. This option has not been seriously tested
- and may have some problems. </p><p>The terminal codes include CWsjis, CWeuc, CWjis7, CWjis8,
- CWjunet, CWhex, CWcap. This is not a complete list, check the Samba
- source code for the complete list. </p></dd><dt><span class="term">-b buffersize</span></dt><dd><p>This option changes the transmit/send buffer
- size when getting or putting a file from/to the server. The default
- is 65520 bytes. Setting this value smaller (to 1200 bytes) has been
- observed to speed up file transfers to and from a Win9x server.
- </p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number.
-</p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></dt><dd><p>The file specified contains the
-configuration details required by the server. The
-information in this file includes server-specific
-information such as what printcap file to use, as well
-as descriptions of all the services that the server is
-to provide. See <tt class="filename">smb.conf</tt> for more information.
-The default configuration file name is determined at
-compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i class="replaceable"><tt>debuglevel</tt></i> is an integer
-from 0 to 10. The default value if this parameter is
-not specified is zero.</p><p>The higher this value, the more detail will be
-logged to the log files about the activities of the
-server. 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.</p><p>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.</p><p>Note that specifying this parameter here will
-override the <a class="indexterm" name="id2799422"></a><i class="parameter"><tt>log level</tt></i> parameter
-in the <tt class="filename">smb.conf</tt> file.</p></dd><dt><span class="term">-l|--logfile=logbasename</span></dt><dd><p>File name for log/debug files. The extension
-<tt class="constant">".client"</tt> will be appended. The log file is
-never removed by the client.
-</p></dd><dt><span class="term">-N</span></dt><dd><p>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. </p><p>Unless a password is specified on the command line or
-this parameter is specified, the client will request a
-password.</p></dd><dt><span class="term">-k</span></dt><dd><p>
-Try to authenticate with kerberos. Only useful in
-an Active Directory environment.
-</p></dd><dt><span class="term">-A|--authfile=filename</span></dt><dd><p>This option allows
-you to specify a file from which to read the username and
-password used in the connection. The format of the file is
-</p><pre class="programlisting">
-username = &lt;value&gt;
-password = &lt;value&gt;
-domain = &lt;value&gt;
-</pre><p>Make certain that the permissions on the file restrict
-access from unwanted users. </p></dd><dt><span class="term">-U|--user=username[%password]</span></dt><dd><p>Sets the SMB username or username and password. </p><p>If %password is not specified, the user will be prompted. The
-client will first check the <tt class="envar">USER</tt> environment variable, then the
-<tt class="envar">LOGNAME</tt> variable and if either exists, the
-string is uppercased. If these environmental variables are not
-found, the username <tt class="constant">GUEST</tt> is used. </p><p>A third option is to use a credentials file which
-contains the plaintext of the username and password. This
-option is mainly provided for scripts where the admin does not
-wish to pass the credentials on the command line or via environment
-variables. If this method is used, make certain that the permissions
-on the file restrict access from unwanted users. See the
-<i class="parameter"><tt>-A</tt></i> for more details. </p><p>Be cautious about including passwords in scripts. Also, on
-many systems the command line of a running process may be seen
-via the <b class="command">ps</b> command. To be safe always allow
-<b class="command">rpcclient</b> to prompt for a password and type
-it in directly. </p></dd><dt><span class="term">-n &lt;primary NetBIOS name&gt;</span></dt><dd><p>This option allows you to override
-the NetBIOS name that Samba uses for itself. This is identical
-to setting the <a class="indexterm" name="id2802383"></a><i class="parameter"><tt>netbios name</tt></i> parameter in the <tt class="filename">smb.conf</tt> file.
-However, a command
-line setting will take precedence over settings in
-<tt class="filename">smb.conf</tt>.</p></dd><dt><span class="term">-i &lt;scope&gt;</span></dt><dd><p>This specifies a NetBIOS scope that
-<b class="command">nmblookup</b> will use to communicate with when
-generating NetBIOS names. For details on the use of NetBIOS
-scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are
-<span class="emphasis"><em>very</em></span> rarely used, only set this parameter
-if you are the system administrator in charge of all the
-NetBIOS systems you communicate with.</p></dd><dt><span class="term">-W|--workgroup=domain</span></dt><dd><p>Set the SMB domain of the username. This
-overrides the default domain which is the domain defined in
-smb.conf. If the domain specified is the same as the servers
-NetBIOS name, it causes the client to log on using the servers local
-SAM (as opposed to the Domain SAM). </p></dd><dt><span class="term">-O socket options</span></dt><dd><p>TCP socket options to set on the client
-socket. See the socket options parameter in
-the <tt class="filename">smb.conf</tt> manual page for the list of valid
-options. </p></dd><dt><span class="term">-T tar options</span></dt><dd><p>smbclient may be used to create <b class="command">tar(1)
- </b> compatible backups of all the files on an SMB/CIFS
- share. The secondary tar flags that can be given to this option
- are : </p><div class="itemizedlist"><ul type="disc"><li><p><i class="parameter"><tt>c</tt></i> - Create a tar file on UNIX.
- Must be followed by the name of a tar file, tape device
- or "-" for standard output. If using standard output you must
- turn the log level to its lowest value -d0 to avoid corrupting
- your tar file. This flag is mutually exclusive with the
- <i class="parameter"><tt>x</tt></i> flag. </p></li><li><p><i class="parameter"><tt>x</tt></i> - Extract (restore) a local
- tar file back to a share. Unless the -D option is given, the tar
- files will be restored from the top level of the share. Must be
- followed by the name of the tar file, device or "-" for standard
- input. Mutually exclusive with the <i class="parameter"><tt>c</tt></i> flag.
- Restored files have their creation times (mtime) set to the
- date saved in the tar file. Directories currently do not get
- their creation dates restored properly. </p></li><li><p><i class="parameter"><tt>I</tt></i> - Include files and directories.
- Is the default behavior when filenames are specified above. Causes
- tar files to be included in an extract or create (and therefore
- everything else to be excluded). See example below. Filename globbing
- works in one of two ways. See r below. </p></li><li><p><i class="parameter"><tt>X</tt></i> - Exclude files and directories.
- Causes tar files to be excluded from an extract or create. See
- example below. Filename globbing works in one of two ways now.
- See <i class="parameter"><tt>r</tt></i> below. </p></li><li><p><i class="parameter"><tt>b</tt></i> - Blocksize. Must be followed
- by a valid (greater than zero) blocksize. Causes tar file to be
- written out in blocksize*TBLOCK (usually 512 byte) blocks.
- </p></li><li><p><i class="parameter"><tt>g</tt></i> - Incremental. Only back up
- files that have the archive bit set. Useful only with the
- <i class="parameter"><tt>c</tt></i> flag. </p></li><li><p><i class="parameter"><tt>q</tt></i> - Quiet. Keeps tar from printing
- diagnostics as it works. This is the same as tarmode quiet.
- </p></li><li><p><i class="parameter"><tt>r</tt></i> - Regular expression include
- or exclude. Uses regular expression matching for
- excluding or excluding files if compiled with HAVE_REGEX_H.
- However this mode can be very slow. If not compiled with
- HAVE_REGEX_H, does a limited wildcard match on '*' and '?'.
- </p></li><li><p><i class="parameter"><tt>N</tt></i> - Newer than. Must be followed
- by the name of a file whose date is compared against files found
- on the share during a create. Only files newer than the file
- specified are backed up to the tar file. Useful only with the
- <i class="parameter"><tt>c</tt></i> flag. </p></li><li><p><i class="parameter"><tt>a</tt></i> - Set archive bit. Causes the
- archive bit to be reset when a file is backed up. Useful with the
- <i class="parameter"><tt>g</tt></i> and <i class="parameter"><tt>c</tt></i> flags.
- </p></li></ul></div><p><span class="emphasis"><em>Tar Long File Names</em></span></p><p><b class="command">smbclient</b>'s tar option now supports long
- file names both on backup and restore. However, the full path
- name of the file must be less than 1024 bytes. Also, when
- a tar archive is created, <b class="command">smbclient</b>'s tar option places all
- files in the archive with relative names, not absolute names.
- </p><p><span class="emphasis"><em>Tar Filenames</em></span></p><p>All file names can be given as DOS path names (with '\\'
- as the component separator) or as UNIX path names (with '/' as
- the component separator). </p><p><span class="emphasis"><em>Examples</em></span></p><p>Restore from tar file <tt class="filename">backup.tar</tt> into myshare on mypc
- (no password on share). </p><p><b class="command">smbclient //mypc/yshare "" -N -Tx backup.tar
- </b></p><p>Restore everything except <tt class="filename">users/docs</tt>
- </p><p><b class="command">smbclient //mypc/myshare "" -N -TXx backup.tar
- users/docs</b></p><p>Create a tar file of the files beneath <tt class="filename">
- users/docs</tt>. </p><p><b class="command">smbclient //mypc/myshare "" -N -Tc
- backup.tar users/docs </b></p><p>Create the same tar file as above, but now use
- a DOS path name. </p><p><b class="command">smbclient //mypc/myshare "" -N -tc backup.tar
- users\edocs </b></p><p>Create a tar file of all the files and directories in
- the share. </p><p><b class="command">smbclient //mypc/myshare "" -N -Tc backup.tar *
- </b></p></dd><dt><span class="term">-D initial directory</span></dt><dd><p>Change to initial directory before starting. Probably
- only of any use with the tar -T option. </p></dd><dt><span class="term">-c command string</span></dt><dd><p>command string is a semicolon-separated list of
- commands to be executed instead of prompting from stdin. <i class="parameter"><tt>
- -N</tt></i> is implied by <i class="parameter"><tt>-c</tt></i>.</p><p>This is particularly useful in scripts and for printing stdin
- to the server, e.g. <b class="command">-c 'print -'</b>. </p></dd></dl></div></div><div class="refsect1" lang="en"><h2>OPERATIONS</h2><p>Once the client is running, the user is presented with
- a prompt : </p><p><tt class="prompt">smb:\&gt; </tt></p><p>The backslash ("\\") indicates the current working directory
- on the server, and will change if the current working directory
- is changed. </p><p>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.
- </p><p>You can specify file names which have spaces in them by quoting
- the name with double quotes, for example "a long file name". </p><p>Parameters shown in square brackets (e.g., "[parameter]") are
- optional. If not given, the command will use suitable defaults. Parameters
- shown in angle brackets (e.g., "&lt;parameter&gt;") are required.
- </p><p>Note that all commands operating on the server are actually
- performed by issuing a request to the server. Thus the behavior may
- vary from server to server, depending on how the server was implemented.
- </p><p>The commands available are given here in alphabetical order. </p><div class="variablelist"><dl><dt><span class="term">? [command]</span></dt><dd><p>If <i class="replaceable"><tt>command</tt></i> is specified, the ? command will display
- a brief informative message about the specified command. If no
- command is specified, a list of available commands will
- be displayed. </p></dd><dt><span class="term">! [shell command]</span></dt><dd><p>If <i class="replaceable"><tt>shell command</tt></i> is specified, the !
- command will execute a shell locally and run the specified shell
- command. If no command is specified, a local shell will be run.
- </p></dd><dt><span class="term">altname file</span></dt><dd><p>The client will request that the server return
- the "alternate" name (the 8.3 name) for a file or directory.
- </p></dd><dt><span class="term">cancel jobid0 [jobid1] ... [jobidN]</span></dt><dd><p>The client will request that the server cancel
- the printjobs identified by the given numeric print job ids.
- </p></dd><dt><span class="term">chmod file mode in octal</span></dt><dd><p>This command depends on the server supporting the CIFS
- UNIX extensions and will fail if the server does not. The client requests that the server
- change the UNIX permissions to the given octal mode, in standard UNIX format.
- </p></dd><dt><span class="term">chown file uid gid</span></dt><dd><p>This command depends on the server supporting the CIFS
- UNIX extensions and will fail if the server does not. The client requests that the server
- change the UNIX user and group ownership to the given decimal values. Note there is
- currently no way to remotely look up the UNIX uid and gid values for a given name.
- This may be addressed in future versions of the CIFS UNIX extensions.
- </p></dd><dt><span class="term">cd [directory name]</span></dt><dd><p>If "directory name" is specified, the current
- working directory on the server will be changed to the directory
- specified. This operation will fail if for any reason the specified
- directory is inaccessible. </p><p>If no directory name is specified, the current working
- directory on the server will be reported. </p></dd><dt><span class="term">del &lt;mask&gt;</span></dt><dd><p>The client will request that the server attempt
- to delete all files matching <i class="replaceable"><tt>mask</tt></i> from the current working
- directory on the server. </p></dd><dt><span class="term">dir &lt;mask&gt;</span></dt><dd><p>A list of the files matching <i class="replaceable"><tt>mask</tt></i> in the current
- working directory on the server will be retrieved from the server
- and displayed. </p></dd><dt><span class="term">exit</span></dt><dd><p>Terminate the connection with the server and exit
- from the program. </p></dd><dt><span class="term">get &lt;remote file name&gt; [local file name]</span></dt><dd><p>Copy the file called <tt class="filename">remote file name</tt> from
- the server to the machine running the client. If specified, name
- the local copy <tt class="filename">local file name</tt>. Note that all transfers in
- <b class="command">smbclient</b> are binary. See also the
- lowercase command. </p></dd><dt><span class="term">help [command]</span></dt><dd><p>See the ? command above. </p></dd><dt><span class="term">lcd [directory name]</span></dt><dd><p>If <i class="replaceable"><tt>directory name</tt></i> is specified, the current
- working directory on the local machine will be changed to
- the directory specified. This operation will fail if for any
- reason the specified directory is inaccessible. </p><p>If no directory name is specified, the name of the
- current working directory on the local machine will be reported.
- </p></dd><dt><span class="term">link source destination</span></dt><dd><p>This command depends on the server supporting the CIFS
- UNIX extensions and will fail if the server does not. The client requests that the server
- create a hard link between the source and destination files. The source file
- must not exist.
- </p></dd><dt><span class="term">lowercase</span></dt><dd><p>Toggle lowercasing of filenames for the get and
- mget commands. </p><p>When lowercasing is toggled ON, local filenames are converted
- to lowercase when using the get and mget commands. This is
- often useful when copying (say) MSDOS files from a server, because
- lowercase filenames are the norm on UNIX systems. </p></dd><dt><span class="term">ls &lt;mask&gt;</span></dt><dd><p>See the dir command above. </p></dd><dt><span class="term">mask &lt;mask&gt;</span></dt><dd><p>This command allows the user to set up a mask
- which will be used during recursive operation of the mget and
- mput commands. </p><p>The masks specified to the mget and mput commands act as
- filters for directories rather than files when recursion is
- toggled ON. </p><p>The mask specified with the mask command is necessary
- to filter files within those directories. For example, if the
- mask specified in an mget command is "source*" and the mask
- specified with the mask command is "*.c" and recursion is
- toggled ON, the mget command will retrieve all files matching
- "*.c" in all directories below and including all directories
- matching "source*" in the current working directory. </p><p>Note that the value for mask defaults to blank (equivalent
- to "*") and remains so until the 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
- mask back to "*" after using the mget or mput commands. </p></dd><dt><span class="term">md &lt;directory name&gt;</span></dt><dd><p>See the mkdir command. </p></dd><dt><span class="term">mget &lt;mask&gt;</span></dt><dd><p>Copy all files matching <i class="replaceable"><tt>mask</tt></i> from the server to
- the machine running the client. </p><p>Note that <i class="replaceable"><tt>mask</tt></i> is interpreted differently during recursive
- operation and non-recursive operation - refer to the recurse and
- mask commands for more information. Note that all transfers in
- <b class="command">smbclient</b> are binary. See also the lowercase command. </p></dd><dt><span class="term">mkdir &lt;directory name&gt;</span></dt><dd><p>Create a new directory on the server (user access
- privileges permitting) with the specified name. </p></dd><dt><span class="term">mput &lt;mask&gt;</span></dt><dd><p>Copy all files matching <i class="replaceable"><tt>mask</tt></i> in the current working
- directory on the local machine to the current working directory on
- the server. </p><p>Note that <i class="replaceable"><tt>mask</tt></i> is interpreted differently during recursive
- operation and non-recursive operation - refer to the recurse and mask
- commands for more information. Note that all transfers in <b class="command">smbclient</b>
- are binary. </p></dd><dt><span class="term">print &lt;file name&gt;</span></dt><dd><p>Print the specified file from the local machine
- through a printable service on the server. </p><p>See also the printmode command.</p></dd><dt><span class="term">printmode &lt;graphics or text&gt;</span></dt><dd><p>Set the print mode to suit either binary data
- (such as graphical information) or text. Subsequent print
- commands will use the currently set print mode. </p></dd><dt><span class="term">prompt</span></dt><dd><p>Toggle prompting for filenames during operation
- of the mget and mput commands. </p><p>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.
- </p></dd><dt><span class="term">put &lt;local file name&gt; [remote file name]</span></dt><dd><p>Copy the file called <tt class="filename">local file name</tt> from the
- machine running the client to the server. If specified,
- name the remote copy <tt class="filename">remote file name</tt>. Note that all transfers
- in <b class="command">smbclient</b> are binary. See also the lowercase command.
- </p></dd><dt><span class="term">queue</span></dt><dd><p>Displays the print queue, showing the job id,
- name, size and current status. </p></dd><dt><span class="term">quit</span></dt><dd><p>See the exit command. </p></dd><dt><span class="term">rd &lt;directory name&gt;</span></dt><dd><p>See the rmdir command. </p></dd><dt><span class="term">recurse</span></dt><dd><p>Toggle directory recursion for the commands mget
- and mput. </p><p>When toggled ON, these commands will process all directories
- in the source directory (i.e., the directory they are copying
- from ) and will recurse into any that match the mask specified
- to the command. Only files that match the mask specified using
- the mask command will be retrieved. See also the mask command.
- </p><p>When recursion is toggled OFF, only files from the current
- working directory on the source machine that match the mask specified
- to the mget or mput commands will be copied, and any mask specified
- using the mask command will be ignored. </p></dd><dt><span class="term">rm &lt;mask&gt;</span></dt><dd><p>Remove all files matching <i class="replaceable"><tt>mask</tt></i> from the current
- working directory on the server. </p></dd><dt><span class="term">rmdir &lt;directory name&gt;</span></dt><dd><p>Remove the specified directory (user access
- privileges permitting) from the server. </p></dd><dt><span class="term">setmode &lt;filename&gt; &lt;perm=[+|\-]rsha&gt;</span></dt><dd><p>A version of the DOS attrib command to set
- file permissions. For example: </p><p><b class="command">setmode myfile +r </b></p><p>would make myfile read only. </p></dd><dt><span class="term">symlink source destination</span></dt><dd><p>This command depends on the server supporting the CIFS
- UNIX extensions and will fail if the server does not. The client requests that the server
- create a symbolic hard link between the source and destination files. The source file
- must not exist. Note that the server will not create a link to any path that lies
- outside the currently connected share. This is enforced by the Samba server.
- </p></dd><dt><span class="term">tar &lt;c|x&gt;[IXbgNa]</span></dt><dd><p>Performs a tar operation - see the <i class="parameter"><tt>-T
- </tt></i> command line option above. Behavior may be affected
- by the tarmode command (see below). Using g (incremental) and N
- (newer) will affect tarmode settings. Note that using the "-" option
- with tar x may not work - use the command line option instead.
- </p></dd><dt><span class="term">blocksize &lt;blocksize&gt;</span></dt><dd><p>Blocksize. Must be followed by a valid (greater
- than zero) blocksize. Causes tar file to be written out in
- <i class="replaceable"><tt>blocksize</tt></i>*TBLOCK (usually 512 byte) blocks. </p></dd><dt><span class="term">tarmode &lt;full|inc|reset|noreset&gt;</span></dt><dd><p>Changes tar's behavior with regard to archive
- bits. In full mode, tar will back up everything regardless of the
- archive bit setting (this is the default mode). In incremental mode,
- tar will only back up files with the archive bit set. In reset mode,
- tar will reset the archive bit on all files it backs up (implies
- read/write share). </p></dd></dl></div></div><div class="refsect1" lang="en"><h2>NOTES</h2><p>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.
- </p><p>It is often necessary to use the -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.</p><p>smbclient supports long file names where the server
- supports the LANMAN2 protocol or above. </p></div><div class="refsect1" lang="en"><h2>ENVIRONMENT VARIABLES</h2><p>The variable <tt class="envar">USER</tt> may contain the
- username of the person using the client. This information is
- used only if the protocol level is high enough to support
- session-level passwords.</p><p>The variable <tt class="envar">PASSWD</tt> may contain
- the password of the person using the client. This information is
- used only if the protocol level is high enough to support
- session-level passwords. </p><p>The variable <tt class="envar">LIBSMB_PROG</tt> may contain
- the path, executed with system(), which the client should connect
- to instead of connecting to a server. This functionality is primarily
- intended as a development aid, and works best when using a LMHOSTS
- file</p></div><div class="refsect1" lang="en"><h2>INSTALLATION</h2><p>The location of the client program is a matter for
- individual system administrators. The following are thus
- suggestions only. </p><p>It is recommended that the smbclient software be installed
- in the <tt class="filename">/usr/local/samba/bin/</tt> or <tt class="filename">
- /usr/samba/bin/</tt> directory, this directory readable
- by all, writeable only by root. The client program itself should
- be executable by all. The client should <span class="emphasis"><em>NOT</em></span> be
- setuid or setgid! </p><p>The client log files should be put in a directory readable
- and writeable only by the user. </p><p>To test the client, you will need to know the name of a
- running SMB/CIFS server. It is possible to run <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> as an ordinary user - running that server as a daemon
- on a user-accessible port (typically any port number over 1024)
- would provide a suitable test server. </p></div><div class="refsect1" lang="en"><h2>DIAGNOSTICS</h2><p>Most diagnostics issued by the client are logged in a
- specified log file. The log file name is specified at compile time,
- but may be overridden on the command line. </p><p>The number and nature of diagnostics available depends
- on the debug level used by the client. If you have problems,
- set the debug level to 3 and peruse the log files. </p></div><div class="refsect1" lang="en"><h2>VERSION</h2><p>This man page is correct for version 2.2 of the Samba suite.</p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities
- were created by Andrew Tridgell. Samba is now developed
- by the Samba Team as an Open Source project similar
- to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer.
- The man page sources were converted to YODL format (another
- excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
- ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
- release by Jeremy Allison. The conversion to DocBook for
- Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0
- was done by Alexander Bokovoy.</p></div></div></body></html>