source: trunk/samba-3.0.25pre1/docs/htmldocs/manpages/smbclient.1.html @ 1

Last change on this file since 1 was 1, checked in by Paul Smedley, 14 years ago

Initial code import

File size: 40.3 KB
Line 
1<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.68.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 class="refnamediv"><h2>Name</h2><p>smbclient &#8212; ftp-like client to access SMB/CIFS resources
2        on servers</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">smbclient</code>  [-b &lt;buffer size&gt;] [-d debuglevel] [-L &lt;netbios name&gt;] [-U username] [-I destinationIP] [-M &lt;netbios name&gt;] [-m maxprotocol] [-A authfile] [-N] [-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="command">smbclient</code>  {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 logdir] [-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="id230548"></a><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><span><strong class="command">smbclient</strong></span> is a client that can
3        'talk' to an SMB/CIFS server. It offers an interface
4        similar to that of the ftp program (see <a href="ftp.1.html"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a>). 
5        Operations include things like getting files from the server
6        to the local machine, putting files from the local machine to
7        the server, retrieving directory information from the server
8        and so on. </p></div><div class="refsect1" lang="en"><a name="id230585"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">servicename</span></dt><dd><p>servicename is the name of the service
9                you want to use on the server. A service name takes the form
10                <code class="filename">//server/service</code> where <em class="parameter"><code>server
11                </code></em> is the NetBIOS name of the SMB/CIFS server
12                offering the desired service and <em class="parameter"><code>service</code></em> 
13                is the name of the service offered.  Thus to connect to
14                the service "printer" on the SMB/CIFS server "smbserver",
15                you would use the servicename <code class="filename">//smbserver/printer
16                </code></p><p>Note that the server name required is NOT necessarily
17                the IP (DNS) host name of the server !  The name required is
18                a NetBIOS server name, which may or may not be the
19                same as the IP hostname of the machine running the server.
20                </p><p>The server name is looked up according to either
21                the <em class="parameter"><code>-R</code></em> parameter to <span><strong class="command">smbclient</strong></span> or
22                using the name resolve order parameter in
23                the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file,
24                allowing an administrator to change the order and methods
25                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
26                service on the specified server. If this parameter is
27                supplied, the <em class="parameter"><code>-N</code></em> option (suppress
28                password prompt) is assumed. </p><p>There is no default password. If no password is supplied
29                on the command line (either by using this parameter or adding
30                a password to the <em class="parameter"><code>-U</code></em> option (see
31                below)) and the <em class="parameter"><code>-N</code></em> option is not
32                specified, the client will prompt for a password, even if
33                the desired service does not require one. (If no password is
34                required, simply press ENTER to provide a null password.)
35                </p><p>Note: Some servers (including OS/2 and Windows for
36                Workgroups) insist on an uppercase password. Lowercase
37                or mixed case passwords may be rejected by these servers.               
38                </p><p>Be cautious about including passwords in scripts.
39                </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
40                suite to determine what naming services and in what order to resolve
41                host names to IP addresses. The option takes a space-separated
42                string of different name resolution options.</p><p>The options are :"lmhosts", "host", "wins" and "bcast". They
43                cause names to be resolved as follows:</p><div class="itemizedlist"><ul type="disc"><li><p><code class="constant">lmhosts</code>: Lookup an IP
44                        address in the Samba lmhosts file. If the line in lmhosts has
45                        no name type attached to the NetBIOS name (see
46                        the <a href="lmhosts.5.html"><span class="citerefentry"><span class="refentrytitle">lmhosts</span>(5)</span></a> for details) then
47                        any name type matches for lookup.</p></li><li><p><code class="constant">host</code>: Do a standard host
48                        name to IP address resolution, using the system <code class="filename">/etc/hosts
49                        </code>, NIS, or DNS lookups. This method of name resolution
50                        is operating system dependent, for instance on IRIX or Solaris this
51                        may be controlled by the <code class="filename">/etc/nsswitch.conf</code> 
52                        file).  Note that this method is only used if the NetBIOS name
53                        type being queried is the 0x20 (server) name type, otherwise
54                        it is ignored.</p></li><li><p><code class="constant">wins</code>: Query a name with
55                        the IP address listed in the <em class="parameter"><code>wins server</code></em>
56                        parameter.  If no WINS server has
57                        been specified this method will be ignored.</p></li><li><p><code class="constant">bcast</code>: Do a broadcast on
58                        each of the known local interfaces listed in the
59                        <em class="parameter"><code>interfaces</code></em>
60                        parameter. This is the least reliable of the name resolution
61                        methods as it depends on the target host being on a locally
62                        connected subnet.</p></li></ul></div><p>If this parameter is not set then the name resolve order
63                defined in the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file parameter 
64                (name resolve order) will be used. </p><p>The default order is lmhosts, host, wins, bcast and without
65                this parameter or any entry in the <em class="parameter"><code>name resolve order
66                </code></em> 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
67                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
68                the "WinPopup" protocol, to another computer. Once a connection is
69                established you then type your message, pressing ^D (control-D) to
70                end. </p><p>If the receiving computer is running WinPopup the user will
71                receive the message and probably a beep. If they are not running
72                WinPopup the message will be lost, and no error message will
73                occur. </p><p>The message is also automatically truncated if the message
74                is over 1600 bytes, as this is the limit of the protocol.
75                </p><p>
76                One useful trick is to cat the message through <span><strong class="command">smbclient</strong></span>. For example:
77</p><pre class="programlisting">
78<span><strong class="command">cat mymessage.txt | smbclient -M FRED </strong></span>
79</pre><p>
80                will send the message in the file <code class="filename">mymessage.txt</code> to the machine FRED.
81                </p><p>You may also find the <em class="parameter"><code>-U</code></em> and
82                <em class="parameter"><code>-I</code></em> options useful, as they allow you to
83                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 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
84                WinPopup messages in Samba. </p><p><span class="emphasis"><em>Note</em></span>: Copy WinPopup into the startup group
85                on your WfWg PCs if you want them to always be able to receive
86                messages. </p></dd><dt><span class="term">-p port</span></dt><dd><p>This number is the TCP port number that will be used
87                when making connections to the server. The standard (well-known)
88                TCP port number for an SMB/CIFS server is 139, which is the
89                default. </p></dd><dt><span class="term">-P</span></dt><dd><p>
90                Make queries to the external server using the machine account of the local server.
91                </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
92</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.
93                It should be specified in standard "a.b.c.d" notation. </p><p>Normally the client would attempt to locate a named
94                SMB/CIFS server by looking it up via the NetBIOS name resolution
95                mechanism described above in the <em class="parameter"><code>name resolve order</code></em> 
96                parameter above. Using this parameter will force the client
97                to assume that the server is on the machine with the specified IP
98                address and the NetBIOS name component of the resource being
99                connected to will be ignored. </p><p>There is no default for this parameter. If not supplied,
100                it will be determined automatically by the client as described
101                above. </p></dd><dt><span class="term">-E</span></dt><dd><p>This parameter causes the client to write messages
102                to the standard error stream (stderr) rather than to the standard
103                output stream. </p><p>By default, the client writes messages to standard output
104                - 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
105                are available on a server. You use it as <span><strong class="command">smbclient -L
106                host</strong></span> and a list should appear.  The <em class="parameter"><code>-I
107                </code></em> option may be useful if your NetBIOS names don't
108                match your TCP/IP DNS host names or if you are trying to reach a
109                host on another network. </p></dd><dt><span class="term">-t terminal code</span></dt><dd><p>This option tells <span><strong class="command">smbclient</strong></span> how to interpret
110                filenames coming from the remote server. Usually Asian language
111                multibyte UNIX implementations use different character sets than
112                SMB/CIFS servers (<span class="emphasis"><em>EUC</em></span> instead of <span class="emphasis"><em>
113                SJIS</em></span> for example). Setting this parameter will let
114                <span><strong class="command">smbclient</strong></span> convert between the UNIX filenames and
115                the SMB filenames correctly. This option has not been seriously tested
116                and may have some problems. </p><p>The terminal codes include CWsjis, CWeuc, CWjis7, CWjis8,
117                CWjunet, CWhex, CWcap. This is not a complete list, check the Samba
118                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
119                size when getting or putting a file from/to the server. The default
120                is 65520 bytes. Setting this value smaller (to 1200 bytes) has been
121                observed to speed up file transfers to and from a Win9x server.
122                </p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number.
123</p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></dt><dd><p>The file specified contains the
124configuration details required by the server.  The
125information in this file includes server-specific
126information such as what printcap file to use, as well
127as descriptions of all the services that the server is
128to provide. See <code class="filename">smb.conf</code> for more information.
129The default configuration file name is determined at
130compile time.</p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer
131from 0 to 10.  The default value if this parameter is
132not specified is zero.</p><p>The higher this value, the more detail will be
133logged to the log files about the activities of the
134server. At level 0, only critical errors and serious
135warnings will be logged. Level 1 is a reasonable level for
136day-to-day running - it generates a small amount of
137information about operations carried out.</p><p>Levels above 1 will generate considerable
138amounts of log data, and should only be used when
139investigating a problem. Levels above 3 are designed for
140use only by developers and generate HUGE amounts of log
141data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will
142override the <a class="indexterm" name="id272229"></a> parameter
143in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-l|--logfile=logdirectory</span></dt><dd><p>Base directory name for log/debug files. The extension
144<code class="constant">".progname"</code> will be appended (e.g. log.smbclient,
145log.smbd, etc...). The log file is never removed by the client.
146</p></dd><dt><span class="term">-N</span></dt><dd><p>If specified, this parameter suppresses the normal
147password prompt from the client to the user. This is useful when
148accessing a service that does not require a password. </p><p>Unless a password is specified on the command line or
149this parameter is specified, the client will request a
150password.</p></dd><dt><span class="term">-k</span></dt><dd><p>
151Try to authenticate with kerberos. Only useful in
152an Active Directory environment.
153</p></dd><dt><span class="term">-A|--authentication-file=filename</span></dt><dd><p>This option allows
154you to specify a file from which to read the username and
155password used in the connection.  The format of the file is
156</p><pre class="programlisting">
157username = &lt;value&gt;
158password = &lt;value&gt;
159domain   = &lt;value&gt;
160</pre><p>Make certain that the permissions on the file restrict
161access 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
162client will first check the <code class="envar">USER</code> environment variable, then the
163<code class="envar">LOGNAME</code> variable and if either exists, the
164string is uppercased. If these environmental variables are not
165found, the username <code class="constant">GUEST</code> is used. </p><p>A third option is to use a credentials file which
166contains the plaintext of the username and password.  This
167option is mainly provided for scripts where the admin does not
168wish to pass the credentials on the command line or via environment
169variables. If this method is used, make certain that the permissions
170on the file restrict access from unwanted users.  See the
171<em class="parameter"><code>-A</code></em> for more details. </p><p>Be cautious about including passwords in scripts. Also, on
172many systems the command line of a running process may be seen
173via the <span><strong class="command">ps</strong></span> command.  To be safe always allow
174<span><strong class="command">rpcclient</strong></span> to prompt for a password and type
175it in directly. </p></dd><dt><span class="term">-n &lt;primary NetBIOS name&gt;</span></dt><dd><p>This option allows you to override
176the NetBIOS name that Samba uses for itself. This is identical
177to setting the <a class="indexterm" name="id272379"></a> parameter in the <code class="filename">smb.conf</code> file.
178However, a command
179line setting will take precedence over settings in
180<code class="filename">smb.conf</code>.</p></dd><dt><span class="term">-i &lt;scope&gt;</span></dt><dd><p>This specifies a NetBIOS scope that
181<span><strong class="command">nmblookup</strong></span> will use to communicate with when
182generating NetBIOS names. For details on the use of NetBIOS
183scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are
184<span class="emphasis"><em>very</em></span> rarely used, only set this parameter
185if you are the system administrator in charge of all the
186NetBIOS 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
187overrides the default domain which is the domain defined in
188smb.conf.  If the domain specified is the same as the servers
189NetBIOS name, it causes the client to log on using the servers local
190SAM (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
191socket. See the socket options parameter in
192the <code class="filename">smb.conf</code> manual page for the list of valid
193options. </p></dd><dt><span class="term">-T tar options</span></dt><dd><p>smbclient may be used to create <span><strong class="command">tar(1)
194                </strong></span> compatible backups of all the files on an SMB/CIFS
195                share. The secondary tar flags that can be given to this option
196                are : </p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>c</code></em> - Create a tar file on UNIX.
197                        Must be followed by the name of a tar file, tape device
198                        or "-" for standard output. If using standard output you must
199                        turn the log level to its lowest value -d0 to avoid corrupting
200                        your tar file. This flag is mutually exclusive with the
201                        <em class="parameter"><code>x</code></em> flag. </p></li><li><p><em class="parameter"><code>x</code></em> - Extract (restore) a local
202                        tar file back to a share. Unless the -D option is given, the tar
203                        files will be restored from the top level of the share. Must be
204                        followed by the name of the tar file, device or "-" for standard
205                        input. Mutually exclusive with the <em class="parameter"><code>c</code></em> flag.
206                        Restored files have their creation times (mtime) set to the
207                        date saved in the tar file. Directories currently do not get
208                        their creation dates restored properly. </p></li><li><p><em class="parameter"><code>I</code></em> - Include files and directories.
209                        Is the default behavior when filenames are specified above. Causes
210                        files to be included in an extract or create (and therefore
211                        everything else to be excluded). See example below.  Filename globbing
212                        works  in one of two ways.  See <em class="parameter"><code>r</code></em> below. </p></li><li><p><em class="parameter"><code>X</code></em> - Exclude files and directories.
213                        Causes files to be excluded from an extract or create. See
214                        example below.  Filename globbing works in one of two ways now.
215                        See <em class="parameter"><code>r</code></em> below. </p></li><li><p><em class="parameter"><code>F</code></em> - File containing a list of files and directories.
216                        The <em class="parameter"><code>F</code></em> causes the name following the tarfile to
217                        create to be read as a filename that contains a list of files and directories to
218                        be included in an extract or create (and therefore everything else to be excluded).
219                        See example below. Filename globbing works in one of two ways.
220                        See <em class="parameter"><code>r</code></em> below.
221                        </p></li><li><p><em class="parameter"><code>b</code></em> - Blocksize. Must be followed
222                        by a valid (greater than zero) blocksize.  Causes tar file to be
223                        written out in blocksize*TBLOCK (usually 512 byte) blocks.
224                        </p></li><li><p><em class="parameter"><code>g</code></em> - Incremental. Only back up
225                        files that have the archive bit set. Useful only with the
226                        <em class="parameter"><code>c</code></em> flag. </p></li><li><p><em class="parameter"><code>q</code></em> - Quiet. Keeps tar from printing
227                        diagnostics as it works.  This is the same as tarmode quiet.
228                        </p></li><li><p><em class="parameter"><code>r</code></em> - Regular expression include
229                        or exclude.  Uses regular  expression matching for
230                        excluding or excluding files if  compiled with HAVE_REGEX_H.
231                        However this mode can be very slow. If  not compiled with
232                        HAVE_REGEX_H, does a limited wildcard match on '*' and  '?'.
233                        </p></li><li><p><em class="parameter"><code>N</code></em> - Newer than. Must be followed
234                        by the name of a file whose date is compared against files found
235                        on the share during a create. Only files newer than the file
236                        specified are backed up to the tar file. Useful only with the
237                        <em class="parameter"><code>c</code></em> flag. </p></li><li><p><em class="parameter"><code>a</code></em> - Set archive bit. Causes the
238                        archive bit to be reset when a file is backed up. Useful with the
239                        <em class="parameter"><code>g</code></em> and <em class="parameter"><code>c</code></em> flags.
240                        </p></li></ul></div><p><span class="emphasis"><em>Tar Long File Names</em></span></p><p><span><strong class="command">smbclient</strong></span>'s tar option now supports long
241                file names both on backup and restore. However, the full path
242                name of the file must be less than 1024 bytes.  Also, when
243                a tar archive is created, <span><strong class="command">smbclient</strong></span>'s tar option places all
244                files in the archive with relative names, not absolute names.
245                </p><p><span class="emphasis"><em>Tar Filenames</em></span></p><p>All file names can be given as DOS path names (with '\\'
246                as the component separator) or as UNIX path names (with '/' as
247                the component separator). </p><p><span class="emphasis"><em>Examples</em></span></p><p>Restore from tar file <code class="filename">backup.tar</code> into myshare on mypc
248                (no password on share). </p><p><span><strong class="command">smbclient //mypc/yshare "" -N -Tx backup.tar
249                </strong></span></p><p>Restore everything except <code class="filename">users/docs</code>
250                </p><p><span><strong class="command">smbclient //mypc/myshare "" -N -TXx backup.tar
251                users/docs</strong></span></p><p>Create a tar file of the files beneath <code class="filename">
252                users/docs</code>. </p><p><span><strong class="command">smbclient //mypc/myshare "" -N -Tc
253                backup.tar users/docs </strong></span></p><p>Create the same tar file as above, but now use
254                a DOS path name. </p><p><span><strong class="command">smbclient //mypc/myshare "" -N -tc backup.tar
255                users\edocs </strong></span></p><p>Create a tar file of the files listed in the file <code class="filename">tarlist</code>.</p><p><span><strong class="command">smbclient //mypc/myshare "" -N -TcF
256                backup.tar tarlist</strong></span></p><p>Create a tar file of all the files and directories in
257                the share. </p><p><span><strong class="command">smbclient //mypc/myshare "" -N -Tc backup.tar *
258                </strong></span></p></dd><dt><span class="term">-D initial directory</span></dt><dd><p>Change to initial directory before starting. Probably
259                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
260                commands to be executed instead of prompting from stdin. <em class="parameter"><code>
261                -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
262                to the server, e.g. <span><strong class="command">-c 'print -'</strong></span>. </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id272823"></a><h2>OPERATIONS</h2><p>Once the client is running, the user is presented with
263        a prompt : </p><p><code class="prompt">smb:\&gt; </code></p><p>The backslash ("\\") indicates the current working directory
264        on the server, and will change if the current working directory
265        is changed. </p><p>The prompt indicates that the client is ready and waiting to
266        carry out a user command. Each command is a single word, optionally
267        followed by parameters specific to that command. Command and parameters
268        are space-delimited unless these notes specifically
269        state otherwise. All commands are case-insensitive.  Parameters to
270        commands may or may not be case sensitive, depending on the command.
271        </p><p>You can specify file names which have spaces in them by quoting
272        the name with double quotes, for example "a long file name". </p><p>Parameters shown in square brackets (e.g., "[parameter]") are
273        optional.  If not given, the command will use suitable defaults. Parameters
274        shown in angle brackets (e.g., "&lt;parameter&gt;") are required.
275        </p><p>Note that all commands operating on the server are actually
276        performed by issuing a request to the server. Thus the behavior may
277        vary from server to server, depending on how the server was implemented.
278        </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 <em class="replaceable"><code>command</code></em> is specified, the ? command will display
279                a brief informative message about the specified command.  If no
280                command is specified, a list of available commands will
281                be displayed. </p></dd><dt><span class="term">! [shell command]</span></dt><dd><p>If <em class="replaceable"><code>shell command</code></em> is specified, the ! 
282                command will execute a shell locally and run the specified shell
283                command. If no command is specified, a local shell will be run.
284                </p></dd><dt><span class="term">altname file</span></dt><dd><p>The client will request that the server return
285                the "alternate" name (the 8.3 name) for a file or directory.
286                </p></dd><dt><span class="term">case_sensitive</span></dt><dd><p>Toggles the setting of the flag in SMB packets that
287                tells the server to treat filenames as case sensitive. Set to OFF by
288                default (tells file server to treat filenames as case insensitive). Only
289                currently affects Samba 3.0.5 and above file servers with the case sensitive
290                parameter set to auto in the smb.conf.
291                </p></dd><dt><span class="term">cancel jobid0 [jobid1] ... [jobidN]</span></dt><dd><p>The client will request that the server cancel
292                the printjobs identified by the given numeric print job ids.
293                </p></dd><dt><span class="term">chmod file mode in octal</span></dt><dd><p>This command depends on the server supporting the CIFS
294                UNIX extensions and will fail if the server does not. The client requests that the server
295                change the UNIX permissions to the given octal mode, in standard UNIX format.
296                </p></dd><dt><span class="term">chown file uid gid</span></dt><dd><p>This command depends on the server supporting the CIFS
297                UNIX extensions and will fail if the server does not. The client requests that the server
298                change the UNIX user and group ownership to the given decimal values. Note there is
299                currently no way to remotely look up the UNIX uid and gid values for a given name.
300                This may be addressed in future versions of the CIFS UNIX extensions.
301                </p></dd><dt><span class="term">cd [directory name]</span></dt><dd><p>If "directory name" is specified, the current
302                working directory on the server will be changed to the directory
303                specified. This operation will fail if for any reason the specified
304                directory is inaccessible. </p><p>If no directory name is specified, the current working
305                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
306                to delete all files matching <em class="replaceable"><code>mask</code></em> from the current working
307                directory on the server. </p></dd><dt><span class="term">dir &lt;mask&gt;</span></dt><dd><p>A list of the files matching <em class="replaceable"><code>mask</code></em> in the current
308                working directory on the server will be retrieved from the server
309                and displayed. </p></dd><dt><span class="term">exit</span></dt><dd><p>Terminate the connection with the server and exit
310                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 <code class="filename">remote file name</code> from
311                the server to the machine running the client. If specified, name
312                the local copy <code class="filename">local file name</code>.  Note that all transfers in
313                <span><strong class="command">smbclient</strong></span> are binary. See also the
314                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 <em class="replaceable"><code>directory name</code></em> is specified, the current
315                working directory on the local machine will be changed to
316                the directory specified. This operation will fail if for any
317                reason the specified directory is inaccessible. </p><p>If no directory name is specified, the name of the
318                current working directory on the local machine will be reported.
319                </p></dd><dt><span class="term">link target linkname</span></dt><dd><p>This command depends on the server supporting the CIFS
320                UNIX extensions and will fail if the server does not. The client requests that the server
321                create a hard link between the linkname and target files. The linkname file
322                must not exist.
323                </p></dd><dt><span class="term">lowercase</span></dt><dd><p>Toggle lowercasing of filenames for the get and
324                mget commands. </p><p>When lowercasing is toggled ON, local filenames are converted
325                to lowercase when using the get and mget commands. This is
326                often useful when copying (say) MSDOS files from a server, because
327                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
328                which will be used during recursive operation of the mget and
329                mput commands. </p><p>The masks specified to the mget and mput commands act as
330                filters for directories rather than files when recursion is
331                toggled ON. </p><p>The mask specified with the mask command is necessary
332                to filter files within those directories. For example, if the
333                mask specified in an mget command is "source*" and the mask
334                specified with the mask command is "*.c" and recursion is
335                toggled ON, the mget command will retrieve all files matching
336                "*.c" in all directories below and including all directories
337                matching "source*" in the current working directory. </p><p>Note that the value for mask defaults to blank (equivalent
338                to "*") and remains so until the mask command is used to change it.
339                It retains the most recently specified value indefinitely. To
340                avoid unexpected results it would be wise to change the value of
341                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 <em class="replaceable"><code>mask</code></em> from the server to
342                the machine running the client. </p><p>Note that <em class="replaceable"><code>mask</code></em> is interpreted differently during recursive
343                operation and non-recursive operation - refer to the recurse and
344                mask commands for more information. Note that all transfers in
345                <span><strong class="command">smbclient</strong></span> 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
346                privileges permitting) with the specified name. </p></dd><dt><span class="term">mput &lt;mask&gt;</span></dt><dd><p>Copy all files matching <em class="replaceable"><code>mask</code></em> in the current working
347                directory on the local machine to the current working directory on
348                the server. </p><p>Note that <em class="replaceable"><code>mask</code></em> is interpreted differently during recursive
349                operation and non-recursive operation - refer to the recurse and mask
350                commands for more information. Note that all transfers in <span><strong class="command">smbclient</strong></span> 
351                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
352                through a printable service on the server. </p></dd><dt><span class="term">prompt</span></dt><dd><p>Toggle prompting for filenames during operation
353                of the mget and mput commands. </p><p>When toggled ON, the user will be prompted to confirm
354                the transfer of each file during these commands. When toggled
355                OFF, all specified files will be transferred without prompting.
356                </p></dd><dt><span class="term">put &lt;local file name&gt; [remote file name]</span></dt><dd><p>Copy the file called <code class="filename">local file name</code> from the
357                machine running the client to the server. If specified,
358                name the remote copy <code class="filename">remote file name</code>. Note that all transfers
359                in <span><strong class="command">smbclient</strong></span> are binary. See also the lowercase command.
360                </p></dd><dt><span class="term">queue</span></dt><dd><p>Displays the print queue, showing the job id,
361                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
362                and mput. </p><p>When toggled ON, these commands will process all directories
363                in the source directory (i.e., the directory they are copying
364                from ) and will recurse into any that match the mask specified
365                to the command. Only files that match the mask specified using
366                the mask command will be retrieved. See also the mask command.
367                </p><p>When recursion is toggled OFF, only files from the current
368                working directory on the source machine that match the mask specified
369                to the mget or mput commands will be copied, and any mask specified
370                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 <em class="replaceable"><code>mask</code></em> from the current
371                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
372                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
373                file permissions. For example: </p><p><span><strong class="command">setmode myfile +r </strong></span></p><p>would make myfile read only. </p></dd><dt><span class="term">stat file</span></dt><dd><p>This command depends on the server supporting the CIFS
374                UNIX extensions and will fail if the server does not. The client requests the
375                UNIX basic info level and prints out the same info that the Linux stat command
376                would about the file. This includes the size, blocks used on disk, file type,
377                permissions, inode number, number of links and finally the three timestamps
378                (access, modify and change). If the file is a special file (symlink, character or
379                block device, fifo or socket) then extra information may also be printed.
380                </p></dd><dt><span class="term">symlink target linkname</span></dt><dd><p>This command depends on the server supporting the CIFS
381                UNIX extensions and will fail if the server does not. The client requests that the server
382                create a symbolic hard link between the target and linkname files. The linkname file
383                must not exist. Note that the server will not create a link to any path that lies
384                outside the currently connected share. This is enforced by the Samba server.
385                </p></dd><dt><span class="term">tar &lt;c|x&gt;[IXbgNa]</span></dt><dd><p>Performs a tar operation - see the <em class="parameter"><code>-T
386                </code></em> command line option above. Behavior may be affected
387                by the tarmode command (see below). Using g (incremental) and N
388                (newer) will affect tarmode settings. Note that using the "-" option
389                with tar x may not work - use the command line option instead.
390                </p></dd><dt><span class="term">blocksize &lt;blocksize&gt;</span></dt><dd><p>Blocksize. Must be followed by a valid (greater
391                than zero) blocksize. Causes tar file to be written out in
392                <em class="replaceable"><code>blocksize</code></em>*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
393                bits. In full mode, tar will back up everything regardless of the
394                archive bit setting (this is the default mode). In incremental mode,
395                tar will only back up files with the archive bit set. In reset mode,
396                tar will reset the archive bit on all files it backs up (implies
397                read/write share). </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id273496"></a><h2>NOTES</h2><p>Some servers are fussy about the case of supplied usernames,
398        passwords, share names (AKA service names) and machine names.
399        If you fail to connect try giving all parameters in uppercase.
400        </p><p>It is often necessary to use the -n option when connecting
401        to some types of servers. For example OS/2 LanManager insists
402        on a valid NetBIOS name being used, so you need to supply a valid
403        name that would be known to the server.</p><p>smbclient supports long file names where the server
404        supports the LANMAN2 protocol or above. </p></div><div class="refsect1" lang="en"><a name="id273518"></a><h2>ENVIRONMENT VARIABLES</h2><p>The variable <code class="envar">USER</code> may contain the
405        username of the person  using the client. This information is
406        used only if the protocol  level is high enough to support
407        session-level passwords.</p><p>The variable <code class="envar">PASSWD</code> may contain
408        the password of the person using the client.  This information is
409        used only if the protocol level is high enough to support
410        session-level passwords. </p><p>The variable <code class="envar">LIBSMB_PROG</code> may contain
411        the path, executed with system(), which the client should connect
412        to instead of connecting to a server.  This functionality is primarily
413        intended as a development aid, and works best when using a LMHOSTS
414        file</p></div><div class="refsect1" lang="en"><a name="id273550"></a><h2>INSTALLATION</h2><p>The location of the client program is a matter for
415        individual system administrators. The following are thus
416        suggestions only. </p><p>It is recommended that the smbclient software be installed
417        in the <code class="filename">/usr/local/samba/bin/</code> or <code class="filename">
418        /usr/samba/bin/</code> directory, this directory readable
419        by all, writeable only by root. The client program itself should
420        be executable by all. The client should <span class="emphasis"><em>NOT</em></span> be
421        setuid or setgid! </p><p>The client log files should be put in a directory readable
422        and writeable only by the user. </p><p>To test the client, you will need to know the name of a
423        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
424        on a user-accessible port (typically any port number over 1024)
425        would provide a suitable test server. </p></div><div class="refsect1" lang="en"><a name="id273600"></a><h2>DIAGNOSTICS</h2><p>Most diagnostics issued by the client are logged in a
426        specified log file. The log file name is specified at compile time,
427        but may be overridden on the command line. </p><p>The number and nature of diagnostics available depends
428        on the debug level used by the client. If you have problems,
429        set the debug level to 3 and peruse the log files. </p></div><div class="refsect1" lang="en"><a name="id273616"></a><h2>VERSION</h2><p>This man page is correct for version 3 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id273626"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities
430        were created by Andrew Tridgell. Samba is now developed
431        by the Samba Team as an Open Source project similar
432        to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer.
433        The man page sources were converted to YODL format (another
434        excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top">
435        ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0
436        release by Jeremy Allison.  The conversion to DocBook for
437        Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0
438        was done by Alexander Bokovoy.</p></div></div></body></html>
Note: See TracBrowser for help on using the repository browser.