source: vendor/3.5.0/docs/htmldocs/manpages/smbclient.1.html

Last change on this file was 414, checked in by Herwig Bauernfeind, 16 years ago

Samba 3.5.0: Initial import

File size: 46.6 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.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
2 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="id2483752"></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
3 'talk' to an SMB/CIFS server. It offers an interface
4 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>).
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="id2483792"></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 <code class="literal">smbclient</code> or
22 using the name resolve order parameter in
23 the <a class="citerefentry" 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|--name-resolve &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 class="citerefentry" 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 class="citerefentry" 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 class="citerefentry" 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|--message 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 pipe the message through <code class="literal">smbclient</code>.
77 For example: smbclient -M FRED &lt; mymessage.txt will send the
78 message in the file <code class="filename">mymessage.txt</code> to the
79 machine FRED.
80 </p><p>You may also find the <em class="parameter"><code>-U</code></em> and
81 <em class="parameter"><code>-I</code></em> options useful, as they allow you to
82 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
83 WinPopup messages in Samba. </p><p><span class="emphasis"><em>Note</em></span>: Copy WinPopup into the startup group
84 on your WfWg PCs if you want them to always be able to receive
85 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
86 when making connections to the server. The standard (well-known)
87 TCP port number for an SMB/CIFS server is 139, which is the
88 default. </p></dd><dt><span class="term">-g|--grepable</span></dt><dd><p>This parameter provides combined with
89 <em class="parameter"><code>-L</code></em> easy parseable output that allows processing
90 with utilities such as grep and cut.
91 </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.
92 </p></dd><dt><span class="term">-P</span></dt><dd><p>
93 Make queries to the external server using the machine account of the local server.
94 </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
95</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.
96 It should be specified in standard "a.b.c.d" notation. </p><p>Normally the client would attempt to locate a named
97 SMB/CIFS server by looking it up via the NetBIOS name resolution
98 mechanism described above in the <em class="parameter"><code>name resolve order</code></em>
99 parameter above. Using this parameter will force the client
100 to assume that the server is on the machine with the specified IP
101 address and the NetBIOS name component of the resource being
102 connected to will be ignored. </p><p>There is no default for this parameter. If not supplied,
103 it will be determined automatically by the client as described
104 above. </p></dd><dt><span class="term">-E|--stderr</span></dt><dd><p>This parameter causes the client to write messages
105 to the standard error stream (stderr) rather than to the standard
106 output stream. </p><p>By default, the client writes messages to standard output
107 - 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
108 are available on a server. You use it as <code class="literal">smbclient -L
109 host</code> and a list should appear. The <em class="parameter"><code>-I
110 </code></em> option may be useful if your NetBIOS names don't
111 match your TCP/IP DNS host names or if you are trying to reach a
112 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
113 size when getting or putting a file from/to the server. The default
114 is 65520 bytes. Setting this value smaller (to 1200 bytes) has been
115 observed to speed up file transfers to and from a Win9x server.
116 </p></dd><dt><span class="term">-e</span></dt><dd><p>This command line parameter requires the remote
117 server support the UNIX extensions. Request that the connection be
118 encrypted. This is new for Samba 3.2 and will only work with Samba
119 3.2 or above servers. Negotiates SMB encryption using GSSAPI. Uses
120 the given credentials for the encryption negotiaion (either kerberos
121 or NTLMv1/v2 if given domain/username/password triple. Fails the
122 connection if encryption cannot be negotiated.
123 </p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer
124from 0 to 10. The default value if this parameter is
125not specified is 1.</p><p>The higher this value, the more detail will be
126logged to the log files about the activities of the
127server. At level 0, only critical errors and serious
128warnings will be logged. Level 1 is a reasonable level for
129day-to-day running - it generates a small amount of
130information about operations carried out.</p><p>Levels above 1 will generate considerable
131amounts of log data, and should only be used when
132investigating a problem. Levels above 3 are designed for
133use only by developers and generate HUGE amounts of log
134data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will
135override the <a class="link" href="smb.conf.5.html#" target="_top"></a> parameter
136in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-V|--version</span></dt><dd><p>Prints the program version number.
137</p></dd><dt><span class="term">-s|--configfile &lt;configuration file&gt;</span></dt><dd><p>The file specified contains the
138configuration details required by the server. The
139information in this file includes server-specific
140information such as what printcap file to use, as well
141as descriptions of all the services that the server is
142to provide. See <code class="filename">smb.conf</code> for more information.
143The default configuration file name is determined at
144compile time.</p></dd><dt><span class="term">-l|--log-basename=logdirectory</span></dt><dd><p>Base directory name for log/debug files. The extension
145<code class="constant">".progname"</code> will be appended (e.g. log.smbclient,
146log.smbd, etc...). The log file is never removed by the client.
147</p></dd><dt><span class="term">-N|--no-pass</span></dt><dd><p>If specified, this parameter suppresses the normal
148password prompt from the client to the user. This is useful when
149accessing a service that does not require a password. </p><p>Unless a password is specified on the command line or
150this parameter is specified, the client will request a
151password.</p><p>If a password is specified on the command line and this
152option is also defined the password on the command line will
153be silently ingnored and no password will be used.</p></dd><dt><span class="term">-k|--kerberos</span></dt><dd><p>
154Try to authenticate with kerberos. Only useful in
155an Active Directory environment.
156</p></dd><dt><span class="term">-A|--authentication-file=filename</span></dt><dd><p>This option allows
157you to specify a file from which to read the username and
158password used in the connection. The format of the file is
159</p><pre class="programlisting">
160username = &lt;value&gt;
161password = &lt;value&gt;
162domain = &lt;value&gt;
163</pre><p>Make certain that the permissions on the file restrict
164access 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
165client will first check the <code class="envar">USER</code> environment variable, then the
166<code class="envar">LOGNAME</code> variable and if either exists, the
167string is uppercased. If these environmental variables are not
168found, the username <code class="constant">GUEST</code> is used. </p><p>A third option is to use a credentials file which
169contains the plaintext of the username and password. This
170option is mainly provided for scripts where the admin does not
171wish to pass the credentials on the command line or via environment
172variables. If this method is used, make certain that the permissions
173on the file restrict access from unwanted users. See the
174<em class="parameter"><code>-A</code></em> for more details. </p><p>Be cautious about including passwords in scripts. Also, on
175many systems the command line of a running process may be seen
176via the <code class="literal">ps</code> command. To be safe always allow
177<code class="literal">rpcclient</code> to prompt for a password and type
178it in directly. </p></dd><dt><span class="term">-n|--netbiosname &lt;primary NetBIOS name&gt;</span></dt><dd><p>This option allows you to override
179the NetBIOS name that Samba uses for itself. This is identical
180to setting the <a class="link" href="smb.conf.5.html#" target="_top"></a> parameter in the <code class="filename">smb.conf</code> file.
181However, a command
182line setting will take precedence over settings in
183<code class="filename">smb.conf</code>.</p></dd><dt><span class="term">-i|--scope &lt;scope&gt;</span></dt><dd><p>This specifies a NetBIOS scope that
184<code class="literal">nmblookup</code> will use to communicate with when
185generating NetBIOS names. For details on the use of NetBIOS
186scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are
187<span class="emphasis"><em>very</em></span> rarely used, only set this parameter
188if you are the system administrator in charge of all the
189NetBIOS 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
190overrides the default domain which is the domain defined in
191smb.conf. If the domain specified is the same as the servers
192NetBIOS name, it causes the client to log on using the servers local
193SAM (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
194socket. See the socket options parameter in
195the <code class="filename">smb.conf</code> manual page for the list of valid
196options. </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)
197 </code> compatible backups of all the files on an SMB/CIFS
198 share. The secondary tar flags that can be given to this option
199 are : </p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>c</code></em> - Create a tar file on UNIX.
200 Must be followed by the name of a tar file, tape device
201 or "-" for standard output. If using standard output you must
202 turn the log level to its lowest value -d0 to avoid corrupting
203 your tar file. This flag is mutually exclusive with the
204 <em class="parameter"><code>x</code></em> flag. </p></li><li><p><em class="parameter"><code>x</code></em> - Extract (restore) a local
205 tar file back to a share. Unless the -D option is given, the tar
206 files will be restored from the top level of the share. Must be
207 followed by the name of the tar file, device or "-" for standard
208 input. Mutually exclusive with the <em class="parameter"><code>c</code></em> flag.
209 Restored files have their creation times (mtime) set to the
210 date saved in the tar file. Directories currently do not get
211 their creation dates restored properly. </p></li><li><p><em class="parameter"><code>I</code></em> - Include files and directories.
212 Is the default behavior when filenames are specified above. Causes
213 files to be included in an extract or create (and therefore
214 everything else to be excluded). See example below. Filename globbing
215 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.
216 Causes files to be excluded from an extract or create. See
217 example below. Filename globbing works in one of two ways now.
218 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.
219 The <em class="parameter"><code>F</code></em> causes the name following the tarfile to
220 create to be read as a filename that contains a list of files and directories to
221 be included in an extract or create (and therefore everything else to be excluded).
222 See example below. Filename globbing works in one of two ways.
223 See <em class="parameter"><code>r</code></em> below.
224 </p></li><li><p><em class="parameter"><code>b</code></em> - Blocksize. Must be followed
225 by a valid (greater than zero) blocksize. Causes tar file to be
226 written out in blocksize*TBLOCK (usually 512 byte) blocks.
227 </p></li><li><p><em class="parameter"><code>g</code></em> - Incremental. Only back up
228 files that have the archive bit set. Useful only with the
229 <em class="parameter"><code>c</code></em> flag. </p></li><li><p><em class="parameter"><code>q</code></em> - Quiet. Keeps tar from printing
230 diagnostics as it works. This is the same as tarmode quiet.
231 </p></li><li><p><em class="parameter"><code>r</code></em> - Regular expression include
232 or exclude. Uses regular expression matching for
233 excluding or excluding files if compiled with HAVE_REGEX_H.
234 However this mode can be very slow. If not compiled with
235 HAVE_REGEX_H, does a limited wildcard match on '*' and '?'.
236 </p></li><li><p><em class="parameter"><code>N</code></em> - Newer than. Must be followed
237 by the name of a file whose date is compared against files found
238 on the share during a create. Only files newer than the file
239 specified are backed up to the tar file. Useful only with the
240 <em class="parameter"><code>c</code></em> flag. </p></li><li><p><em class="parameter"><code>a</code></em> - Set archive bit. Causes the
241 archive bit to be reset when a file is backed up. Useful with the
242 <em class="parameter"><code>g</code></em> and <em class="parameter"><code>c</code></em> flags.
243 </p></li></ul></div><p><span class="emphasis"><em>Tar Long File Names</em></span></p><p><code class="literal">smbclient</code>'s tar option now supports long
244 file names both on backup and restore. However, the full path
245 name of the file must be less than 1024 bytes. Also, when
246 a tar archive is created, <code class="literal">smbclient</code>'s tar option places all
247 files in the archive with relative names, not absolute names.
248 </p><p><span class="emphasis"><em>Tar Filenames</em></span></p><p>All file names can be given as DOS path names (with '\\'
249 as the component separator) or as UNIX path names (with '/' as
250 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
251 (no password on share). </p><p><code class="literal">smbclient //mypc/yshare "" -N -Tx backup.tar
252 </code></p><p>Restore everything except <code class="filename">users/docs</code>
253 </p><p><code class="literal">smbclient //mypc/myshare "" -N -TXx backup.tar
254 users/docs</code></p><p>Create a tar file of the files beneath <code class="filename">
255 users/docs</code>. </p><p><code class="literal">smbclient //mypc/myshare "" -N -Tc
256 backup.tar users/docs </code></p><p>Create the same tar file as above, but now use
257 a DOS path name. </p><p><code class="literal">smbclient //mypc/myshare "" -N -tc backup.tar
258 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
259 backup.tar tarlist</code></p><p>Create a tar file of all the files and directories in
260 the share. </p><p><code class="literal">smbclient //mypc/myshare "" -N -Tc backup.tar *
261 </code></p></dd><dt><span class="term">-D|--directory initial directory</span></dt><dd><p>Change to initial directory before starting. Probably
262 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
263 commands to be executed instead of prompting from stdin. <em class="parameter"><code>
264 -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
265 to the server, e.g. <code class="literal">-c 'print -'</code>. </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2533270"></a><h2>OPERATIONS</h2><p>Once the client is running, the user is presented with
266 a prompt : </p><p><code class="prompt">smb:\&gt; </code></p><p>The backslash ("\\") indicates the current working directory
267 on the server, and will change if the current working directory
268 is changed. </p><p>The prompt indicates that the client is ready and waiting to
269 carry out a user command. Each command is a single word, optionally
270 followed by parameters specific to that command. Command and parameters
271 are space-delimited unless these notes specifically
272 state otherwise. All commands are case-insensitive. Parameters to
273 commands may or may not be case sensitive, depending on the command.
274 </p><p>You can specify file names which have spaces in them by quoting
275 the name with double quotes, for example "a long file name". </p><p>Parameters shown in square brackets (e.g., "[parameter]") are
276 optional. If not given, the command will use suitable defaults. Parameters
277 shown in angle brackets (e.g., "&lt;parameter&gt;") are required.
278 </p><p>Note that all commands operating on the server are actually
279 performed by issuing a request to the server. Thus the behavior may
280 vary from server to server, depending on how the server was implemented.
281 </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
282 a brief informative message about the specified command. If no
283 command is specified, a list of available commands will
284 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 !
285 command will execute a shell locally and run the specified shell
286 command. If no command is specified, a local shell will be run.
287 </p></dd><dt><span class="term">allinfo file</span></dt><dd><p>The client will request that the server return
288 all known information about a file or directory (including streams).
289 </p></dd><dt><span class="term">altname file</span></dt><dd><p>The client will request that the server return
290 the "alternate" name (the 8.3 name) for a file or directory.
291 </p></dd><dt><span class="term">archive &lt;number&gt;</span></dt><dd><p>Sets the archive level when operating on files.
292 0 means ignore the archive bit, 1 means only operate on files with this bit set,
293 2 means only operate on files with this bit set and reset it after operation,
294 3 means operate on all files and reset it after operation. The default is 0.
295 </p></dd><dt><span class="term">blocksize &lt;number&gt;</span></dt><dd><p>Sets the blocksize parameter for a tar operation. The default is 20.
296 Causes tar file to be written out in blocksize*TBLOCK (normally 512 byte) units.
297 </p></dd><dt><span class="term">cancel jobid0 [jobid1] ... [jobidN]</span></dt><dd><p>The client will request that the server cancel
298 the printjobs identified by the given numeric print job ids.
299 </p></dd><dt><span class="term">case_sensitive</span></dt><dd><p>Toggles the setting of the flag in SMB packets that
300 tells the server to treat filenames as case sensitive. Set to OFF by
301 default (tells file server to treat filenames as case insensitive). Only
302 currently affects Samba 3.0.5 and above file servers with the case sensitive
303 parameter set to auto in the smb.conf.
304 </p></dd><dt><span class="term">cd &lt;directory name&gt;</span></dt><dd><p>If "directory name" is specified, the current
305 working directory on the server will be changed to the directory
306 specified. This operation will fail if for any reason the specified
307 directory is inaccessible. </p><p>If no directory name is specified, the current working
308 directory on the server will be reported. </p></dd><dt><span class="term">chmod file mode in octal</span></dt><dd><p>This command depends on the server supporting the CIFS
309 UNIX extensions and will fail if the server does not. The client requests that the server
310 change the UNIX permissions to the given octal mode, in standard UNIX format.
311 </p></dd><dt><span class="term">chown file uid gid</span></dt><dd><p>This command depends on the server supporting the CIFS
312 UNIX extensions and will fail if the server does not. The client requests that the server
313 change the UNIX user and group ownership to the given decimal values. Note there is
314 currently no way to remotely look up the UNIX uid and gid values for a given name.
315 This may be addressed in future versions of the CIFS UNIX extensions.
316 </p></dd><dt><span class="term">close &lt;fileid&gt;</span></dt><dd><p>Closes a file explicitly opened by the open command. Used for
317 internal Samba testing purposes.
318 </p></dd><dt><span class="term">del &lt;mask&gt;</span></dt><dd><p>The client will request that the server attempt
319 to delete all files matching <em class="replaceable"><code>mask</code></em> from the current working
320 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
321 working directory on the server will be retrieved from the server
322 and displayed. </p></dd><dt><span class="term">du &lt;filename&gt;</span></dt><dd><p>Does a directory listing and then prints out the current disk useage and free space on a share.
323 </p></dd><dt><span class="term">echo &lt;number&gt; &lt;data&gt;</span></dt><dd><p>Does an SMBecho request to ping the server. Used for internal Samba testing purposes.
324 </p></dd><dt><span class="term">exit</span></dt><dd><p>Terminate the connection with the server and exit
325 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
326 the server to the machine running the client. If specified, name
327 the local copy <code class="filename">local file name</code>. Note that all transfers in
328 <code class="literal">smbclient</code> are binary. See also the
329 lowercase command. </p></dd><dt><span class="term">getfacl &lt;filename&gt;</span></dt><dd><p>Requires the server support the UNIX extensions. Requests and prints
330 the POSIX ACL on a file.
331 </p></dd><dt><span class="term">hardlink &lt;src&gt; &lt;dest&gt;</span></dt><dd><p>Creates a hardlink on the server using Windows CIFS semantics.
332 </p></dd><dt><span class="term">help [command]</span></dt><dd><p>See the ? command above. </p></dd><dt><span class="term">history</span></dt><dd><p>Displays the command history.</p></dd><dt><span class="term">iosize &lt;bytes&gt;</span></dt><dd><p>When sending or receiving files, smbclient uses an
333 internal memory buffer by default of size 64512 bytes. This command
334 allows this size to be set to any range between 16384 (0x4000) bytes
335 and 16776960 (0xFFFF00) bytes. Larger sizes may mean more efficient
336 data transfer as smbclient will try and use the most efficient
337 read and write calls for the connected server.
338 </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
339 working directory on the local machine will be changed to
340 the directory specified. This operation will fail if for any
341 reason the specified directory is inaccessible. </p><p>If no directory name is specified, the name of the
342 current working directory on the local machine will be reported.
343 </p></dd><dt><span class="term">link target linkname</span></dt><dd><p>This command depends on the server supporting the CIFS
344 UNIX extensions and will fail if the server does not. The client requests that the server
345 create a hard link between the linkname and target files. The linkname file
346 must not exist.
347 </p></dd><dt><span class="term">listconnect</span></dt><dd><p>Show the current connections held for DFS purposes.
348 </p></dd><dt><span class="term">lock &lt;filenum&gt; &lt;r|w&gt; &lt;hex-start&gt; &lt;hex-len&gt;</span></dt><dd><p>This command depends on the server supporting the CIFS
349 UNIX extensions and will fail if the server does not. Tries to set a POSIX
350 fcntl lock of the given type on the given range. Used for internal Samba testing purposes.
351 </p></dd><dt><span class="term">logon &lt;username&gt; &lt;password&gt;</span></dt><dd><p>Establishes a new vuid for this session by logging on again.
352 Replaces the current vuid. Prints out the new vuid. Used for internal Samba testing purposes.
353 </p></dd><dt><span class="term">lowercase</span></dt><dd><p>Toggle lowercasing of filenames for the get and
354 mget commands.
355 </p><p>When lowercasing is toggled ON, local filenames are converted
356 to lowercase when using the get and mget commands. This is
357 often useful when copying (say) MSDOS files from a server, because
358 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
359 which will be used during recursive operation of the mget and
360 mput commands. </p><p>The masks specified to the mget and mput commands act as
361 filters for directories rather than files when recursion is
362 toggled ON. </p><p>The mask specified with the mask command is necessary
363 to filter files within those directories. For example, if the
364 mask specified in an mget command is "source*" and the mask
365 specified with the mask command is "*.c" and recursion is
366 toggled ON, the mget command will retrieve all files matching
367 "*.c" in all directories below and including all directories
368 matching "source*" in the current working directory. </p><p>Note that the value for mask defaults to blank (equivalent
369 to "*") and remains so until the mask command is used to change it.
370 It retains the most recently specified value indefinitely. To
371 avoid unexpected results it would be wise to change the value of
372 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
373 the machine running the client. </p><p>Note that <em class="replaceable"><code>mask</code></em> is interpreted differently during recursive
374 operation and non-recursive operation - refer to the recurse and
375 mask commands for more information. Note that all transfers in
376 <code class="literal">smbclient</code> 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
377 privileges permitting) with the specified name. </p></dd><dt><span class="term">more &lt;file name&gt;</span></dt><dd><p>Fetch a remote file and view it with the contents
378 of your PAGER environment variable.
379 </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
380 directory on the local machine to the current working directory on
381 the server. </p><p>Note that <em class="replaceable"><code>mask</code></em> is interpreted differently during recursive
382 operation and non-recursive operation - refer to the recurse and mask
383 commands for more information. Note that all transfers in <code class="literal">smbclient</code>
384 are binary. </p></dd><dt><span class="term">posix</span></dt><dd><p>Query the remote server to see if it supports the CIFS UNIX
385 extensions and prints out the list of capabilities supported. If so, turn
386 on POSIX pathname processing and large file read/writes (if available),.
387 </p></dd><dt><span class="term">posix_encrypt &lt;domain&gt; &lt;username&gt; &lt;password&gt;</span></dt><dd><p>This command depends on the server supporting the CIFS
388 UNIX extensions and will fail if the server does not. Attempt to negotiate
389 SMB encryption on this connection. If smbclient connected with kerberos
390 credentials (-k) the arguments to this command are ignored and the kerberos
391 credentials are used to negotiate GSSAPI signing and sealing instead. See
392 also the -e option to smbclient to force encryption on initial connection.
393 This command is new with Samba 3.2.
394 </p></dd><dt><span class="term">posix_open &lt;filename&gt; &lt;octal mode&gt;</span></dt><dd><p>This command depends on the server supporting the CIFS
395 UNIX extensions and will fail if the server does not. Opens a remote file
396 using the CIFS UNIX extensions and prints a fileid. Used for internal Samba
397 testing purposes.
398 </p></dd><dt><span class="term">posix_mkdir &lt;directoryname&gt; &lt;octal mode&gt;</span></dt><dd><p>This command depends on the server supporting the CIFS
399 UNIX extensions and will fail if the server does not. Creates a remote directory
400 using the CIFS UNIX extensions with the given mode.
401 </p></dd><dt><span class="term">posix_rmdir &lt;directoryname&gt;</span></dt><dd><p>This command depends on the server supporting the CIFS
402 UNIX extensions and will fail if the server does not. Deletes a remote directory
403 using the CIFS UNIX extensions.
404 </p></dd><dt><span class="term">posix_unlink &lt;filename&gt;</span></dt><dd><p>This command depends on the server supporting the CIFS
405 UNIX extensions and will fail if the server does not. Deletes a remote file
406 using the CIFS UNIX extensions.
407 </p></dd><dt><span class="term">print &lt;file name&gt;</span></dt><dd><p>Print the specified file from the local machine
408 through a printable service on the server. </p></dd><dt><span class="term">prompt</span></dt><dd><p>Toggle prompting for filenames during operation
409 of the mget and mput commands. </p><p>When toggled ON, the user will be prompted to confirm
410 the transfer of each file during these commands. When toggled
411 OFF, all specified files will be transferred without prompting.
412 </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
413 machine running the client to the server. If specified,
414 name the remote copy <code class="filename">remote file name</code>. Note that all transfers
415 in <code class="literal">smbclient</code> are binary. See also the lowercase command.
416 </p></dd><dt><span class="term">queue</span></dt><dd><p>Displays the print queue, showing the job id,
417 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
418 UNIX extensions and will fail if the server does not. Print
419 the value of the symlink "symlinkname".
420 </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
421 and mput. </p><p>When toggled ON, these commands will process all directories
422 in the source directory (i.e., the directory they are copying
423 from ) and will recurse into any that match the mask specified
424 to the command. Only files that match the mask specified using
425 the mask command will be retrieved. See also the mask command.
426 </p><p>When recursion is toggled OFF, only files from the current
427 working directory on the source machine that match the mask specified
428 to the mget or mput commands will be copied, and any mask specified
429 using the mask command will be ignored. </p></dd><dt><span class="term">rename &lt;old filename&gt; &lt;new filename&gt;</span></dt><dd><p>Rename files in the current working directory on the
430 server from <em class="replaceable"><code>old filename</code></em> to
431 <em class="replaceable"><code>new filename</code></em>. </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
432 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
433 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
434 file permissions. For example: </p><p><code class="literal">setmode myfile +r </code></p><p>would make myfile read only. </p></dd><dt><span class="term">showconnect</span></dt><dd><p>Show the currently active connection held for DFS purposes.
435 </p></dd><dt><span class="term">stat file</span></dt><dd><p>This command depends on the server supporting the CIFS
436 UNIX extensions and will fail if the server does not. The client requests the
437 UNIX basic info level and prints out the same info that the Linux stat command
438 would about the file. This includes the size, blocks used on disk, file type,
439 permissions, inode number, number of links and finally the three timestamps
440 (access, modify and change). If the file is a special file (symlink, character or
441 block device, fifo or socket) then extra information may also be printed.
442 </p></dd><dt><span class="term">symlink target linkname</span></dt><dd><p>This command depends on the server supporting the CIFS
443 UNIX extensions and will fail if the server does not. The client requests that the server
444 create a symbolic hard link between the target and linkname files. The linkname file
445 must not exist. Note that the server will not create a link to any path that lies
446 outside the currently connected share. This is enforced by the Samba server.
447 </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
448 </code></em> command line option above. Behavior may be affected
449 by the tarmode command (see below). Using g (incremental) and N
450 (newer) will affect tarmode settings. Note that using the "-" option
451 with tar x may not work - use the command line option instead.
452 </p></dd><dt><span class="term">blocksize &lt;blocksize&gt;</span></dt><dd><p>Blocksize. Must be followed by a valid (greater
453 than zero) blocksize. Causes tar file to be written out in
454 <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
455 bits. In full mode, tar will back up everything regardless of the
456 archive bit setting (this is the default mode). In incremental mode,
457 tar will only back up files with the archive bit set. In reset mode,
458 tar will reset the archive bit on all files it backs up (implies
459 read/write share). </p></dd><dt><span class="term">unlock &lt;filenum&gt; &lt;hex-start&gt; &lt;hex-len&gt;</span></dt><dd><p>This command depends on the server supporting the CIFS
460 UNIX extensions and will fail if the server does not. Tries to unlock a POSIX
461 fcntl lock on the given range. Used for internal Samba testing purposes.
462 </p></dd><dt><span class="term">volume</span></dt><dd><p>Prints the current volume name of the share.
463 </p></dd><dt><span class="term">vuid &lt;number&gt;</span></dt><dd><p>Changes the currently used vuid in the protocol to
464 the given arbitrary number. Without an argument prints out the current
465 vuid being used. Used for internal Samba testing purposes.
466 </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2534521"></a><h2>NOTES</h2><p>Some servers are fussy about the case of supplied usernames,
467 passwords, share names (AKA service names) and machine names.
468 If you fail to connect try giving all parameters in uppercase.
469 </p><p>It is often necessary to use the -n option when connecting
470 to some types of servers. For example OS/2 LanManager insists
471 on a valid NetBIOS name being used, so you need to supply a valid
472 name that would be known to the server.</p><p>smbclient supports long file names where the server
473 supports the LANMAN2 protocol or above. </p></div><div class="refsect1" lang="en"><a name="id2534546"></a><h2>ENVIRONMENT VARIABLES</h2><p>The variable <code class="envar">USER</code> may contain the
474 username of the person using the client. This information is
475 used only if the protocol level is high enough to support
476 session-level passwords.</p><p>The variable <code class="envar">PASSWD</code> may contain
477 the password of the person using the client. This information is
478 used only if the protocol level is high enough to support
479 session-level passwords. </p><p>The variable <code class="envar">LIBSMB_PROG</code> may contain
480 the path, executed with system(), which the client should connect
481 to instead of connecting to a server. This functionality is primarily
482 intended as a development aid, and works best when using a LMHOSTS
483 file</p></div><div class="refsect1" lang="en"><a name="id2534582"></a><h2>INSTALLATION</h2><p>The location of the client program is a matter for
484 individual system administrators. The following are thus
485 suggestions only. </p><p>It is recommended that the smbclient software be installed
486 in the <code class="filename">/usr/local/samba/bin/</code> or <code class="filename">
487 /usr/samba/bin/</code> directory, this directory readable
488 by all, writeable only by root. The client program itself should
489 be executable by all. The client should <span class="emphasis"><em>NOT</em></span> be
490 setuid or setgid! </p><p>The client log files should be put in a directory readable
491 and writeable only by the user. </p><p>To test the client, you will need to know the name of a
492 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
493 on a user-accessible port (typically any port number over 1024)
494 would provide a suitable test server. </p></div><div class="refsect1" lang="en"><a name="id2534634"></a><h2>DIAGNOSTICS</h2><p>Most diagnostics issued by the client are logged in a
495 specified log file. The log file name is specified at compile time,
496 but may be overridden on the command line. </p><p>The number and nature of diagnostics available depends
497 on the debug level used by the client. If you have problems,
498 set the debug level to 3 and peruse the log files. </p></div><div class="refsect1" lang="en"><a name="id2534653"></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="id2534664"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities
499 were created by Andrew Tridgell. Samba is now developed
500 by the Samba Team as an Open Source project similar
501 to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer.
502 The man page sources were converted to YODL format (another
503 excellent piece of Open Source software, available at <a class="ulink" href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top">
504 ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0
505 release by Jeremy Allison. The conversion to DocBook for
506 Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0
507 was done by Alexander Bokovoy.</p></div></div></body></html>
Note: See TracBrowser for help on using the repository browser.