summaryrefslogtreecommitdiff
path: root/docs/htmldocs/manpages/smbclient.1.html
diff options
context:
space:
mode:
authorbubulle <bubulle@alioth.debian.org>2010-09-06 20:54:34 +0000
committerbubulle <bubulle@alioth.debian.org>2010-09-06 20:54:34 +0000
commit53601faba8f69c3454ad07acaceeef9165cb3743 (patch)
treeb31a4174a7f4d2650717c1902a6bc3f922e13117 /docs/htmldocs/manpages/smbclient.1.html
parent1b77db997b6a2ce389356509415a6e5e540bcfe0 (diff)
downloadsamba-53601faba8f69c3454ad07acaceeef9165cb3743.tar.gz
Merge 3.5.4 in upstream branch
git-svn-id: svn://svn.debian.org/svn/pkg-samba/branches/samba/upstream@3574 fc4039ab-9d04-0410-8cac-899223bdd6b0
Diffstat (limited to 'docs/htmldocs/manpages/smbclient.1.html')
-rw-r--r--docs/htmldocs/manpages/smbclient.1.html53
1 files changed, 24 insertions, 29 deletions
diff --git a/docs/htmldocs/manpages/smbclient.1.html b/docs/htmldocs/manpages/smbclient.1.html
index d278db2534..244960caf3 100644
--- a/docs/htmldocs/manpages/smbclient.1.html
+++ b/docs/htmldocs/manpages/smbclient.1.html
@@ -1,11 +1,11 @@
<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.74.0"></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 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><code class="literal">smbclient</code> [-b &lt;buffer size&gt;] [-d debuglevel] [-e] [-L &lt;netbios name&gt;] [-U username] [-I destinationIP] [-M &lt;netbios name&gt;] [-m maxprotocol] [-A authfile] [-N] [-g] [-i scope] [-O &lt;socket options&gt;] [-p port] [-R &lt;name resolve order&gt;] [-s &lt;smb config file&gt;] [-k] [-P] [-c &lt;command&gt;]</p></div><div class="cmdsynopsis"><p><code class="literal">smbclient</code> {servicename} [password] [-b &lt;buffer size&gt;] [-d debuglevel] [-e] [-D Directory] [-U username] [-W workgroup] [-M &lt;netbios name&gt;] [-m maxprotocol] [-A authfile] [-N] [-g] [-l log-basename] [-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"><a name="id2483754"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a class="citerefentry" href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">smbclient</code> is a client that can
+ on servers</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">smbclient</code> [-b &lt;buffer size&gt;] [-d debuglevel] [-e] [-L &lt;netbios name&gt;] [-U username] [-I destinationIP] [-M &lt;netbios name&gt;] [-m maxprotocol] [-A authfile] [-N] [-C] [-g] [-i scope] [-O &lt;socket options&gt;] [-p port] [-R &lt;name resolve order&gt;] [-s &lt;smb config file&gt;] [-k] [-P] [-c &lt;command&gt;]</p></div><div class="cmdsynopsis"><p><code class="literal">smbclient</code> {servicename} [password] [-b &lt;buffer size&gt;] [-d debuglevel] [-e] [-D Directory] [-U username] [-W workgroup] [-M &lt;netbios name&gt;] [-m maxprotocol] [-A authfile] [-N] [-C] [-g] [-l log-basename] [-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"><a name="id2483767"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a class="citerefentry" href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">smbclient</code> is a client that can
'talk' to an SMB/CIFS server. It offers an interface
similar to that of the ftp program (see <a class="citerefentry" 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"><a name="id2483794"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">servicename</span></dt><dd><p>servicename is the name of the service
+ and so on. </p></div><div class="refsect1" lang="en"><a name="id2481476"></a><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
<code class="filename">//server/service</code> where <em class="parameter"><code>server
</code></em> is the NetBIOS name of the SMB/CIFS server
@@ -36,7 +36,7 @@
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
+ </p></dd><dt><span class="term">-R|--name-resolve &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
@@ -64,7 +64,7 @@
(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 <em class="parameter"><code>name resolve order
</code></em> parameter of the <a class="citerefentry" 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
+ methods will be attempted in this order. </p></dd><dt><span class="term">-M|--message 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
@@ -82,16 +82,17 @@
control the FROM and TO parts of the message. </p><p>See the <em class="parameter"><code>message command</code></em> parameter in the <a class="citerefentry" 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
+ messages. </p></dd><dt><span class="term">-p|--port 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">-g</span></dt><dd><p>This parameter provides combined with
+ default. </p></dd><dt><span class="term">-g|--grepable</span></dt><dd><p>This parameter provides combined with
<em class="parameter"><code>-L</code></em> easy parseable output that allows processing
with utilities such as grep and cut.
+ </p></dd><dt><span class="term">-m|--max-protocol protocol</span></dt><dd><p>This parameter sets the maximum protocol version announced by the client.
</p></dd><dt><span class="term">-P</span></dt><dd><p>
Make queries to the external server using the machine account of the local server.
</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><em class="replaceable"><code>IP address</code></em> is the address of the server to connect to.
+</p></dd><dt><span class="term">-I|--ip-address IP-address</span></dt><dd><p><em class="replaceable"><code>IP address</code></em> 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 <em class="parameter"><code>name resolve order</code></em>
@@ -100,24 +101,15 @@
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
+ above. </p></dd><dt><span class="term">-E|--stderr</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
+ - typically the user's tty. </p></dd><dt><span class="term">-L|--list</span></dt><dd><p>This option allows you to look at what services
are available on a server. You use it as <code class="literal">smbclient -L
host</code> and a list should appear. The <em class="parameter"><code>-I
</code></em> 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 <code class="literal">smbclient</code> 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
- <code class="literal">smbclient</code> 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
+ host on another network. </p></dd><dt><span class="term">-b|--send-buffer 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.
@@ -203,7 +195,7 @@ 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 socket options</span></dt><dd><p>TCP socket options to set on the client
socket. See the socket options parameter in
the <code class="filename">smb.conf</code> 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 <code class="literal">tar(1)
+options. </p></dd><dt><span class="term">-T|--tar tar options</span></dt><dd><p>smbclient may be used to create <code class="literal">tar(1)
</code> 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><em class="parameter"><code>c</code></em> - Create a tar file on UNIX.
@@ -268,11 +260,11 @@ options. </p></dd><dt><span class="term">-T tar options</span></dt><dd><p>smbcli
users\edocs </code></p><p>Create a tar file of the files listed in the file <code class="filename">tarlist</code>.</p><p><code class="literal">smbclient //mypc/myshare "" -N -TcF
backup.tar tarlist</code></p><p>Create a tar file of all the files and directories in
the share. </p><p><code class="literal">smbclient //mypc/myshare "" -N -Tc backup.tar *
- </code></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
+ </code></p></dd><dt><span class="term">-D|--directory 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|--comand command string</span></dt><dd><p>command string is a semicolon-separated list of
commands to be executed instead of prompting from stdin. <em class="parameter"><code>
-N</code></em> is implied by <em class="parameter"><code>-c</code></em>.</p><p>This is particularly useful in scripts and for printing stdin
- to the server, e.g. <code class="literal">-c 'print -'</code>. </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2533317"></a><h2>OPERATIONS</h2><p>Once the client is running, the user is presented with
+ to the server, e.g. <code class="literal">-c 'print -'</code>. </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2533296"></a><h2>OPERATIONS</h2><p>Once the client is running, the user is presented with
a prompt : </p><p><code class="prompt">smb:\&gt; </code></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
@@ -424,7 +416,10 @@ options. </p></dd><dt><span class="term">-T tar options</span></dt><dd><p>smbcli
name the remote copy <code class="filename">remote file name</code>. Note that all transfers
in <code class="literal">smbclient</code> 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
+ 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">readlink symlinkname</span></dt><dd><p>This command depends on the server supporting the CIFS
+ UNIX extensions and will fail if the server does not. Print
+ the value of the symlink "symlinkname".
+ </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
@@ -470,14 +465,14 @@ options. </p></dd><dt><span class="term">-T tar options</span></dt><dd><p>smbcli
</p></dd><dt><span class="term">vuid &lt;number&gt;</span></dt><dd><p>Changes the currently used vuid in the protocol to
the given arbitrary number. Without an argument prints out the current
vuid being used. Used for internal Samba testing purposes.
- </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2534408"></a><h2>NOTES</h2><p>Some servers are fussy about the case of supplied usernames,
+ </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2534407"></a><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"><a name="id2534433"></a><h2>ENVIRONMENT VARIABLES</h2><p>The variable <code class="envar">USER</code> may contain the
+ supports the LANMAN2 protocol or above. </p></div><div class="refsect1" lang="en"><a name="id2534432"></a><h2>ENVIRONMENT VARIABLES</h2><p>The variable <code class="envar">USER</code> 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 <code class="envar">PASSWD</code> may contain
@@ -487,7 +482,7 @@ options. </p></dd><dt><span class="term">-T tar options</span></dt><dd><p>smbcli
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"><a name="id2534469"></a><h2>INSTALLATION</h2><p>The location of the client program is a matter for
+ file</p></div><div class="refsect1" lang="en"><a name="id2534468"></a><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 <code class="filename">/usr/local/samba/bin/</code> or <code class="filename">
@@ -498,11 +493,11 @@ options. </p></dd><dt><span class="term">-T tar options</span></dt><dd><p>smbcli
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 class="citerefentry" 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"><a name="id2534522"></a><h2>DIAGNOSTICS</h2><p>Most diagnostics issued by the client are logged in a
+ would provide a suitable test server. </p></div><div class="refsect1" lang="en"><a name="id2534520"></a><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"><a name="id2534540"></a><h2>VERSION</h2><p>This man page is correct for version 3.2 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id2534551"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities
+ set the debug level to 3 and peruse the log files. </p></div><div class="refsect1" lang="en"><a name="id2534539"></a><h2>VERSION</h2><p>This man page is correct for version 3.2 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id2534550"></a><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.