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.60.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbclient.1"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>smbclient — ftp-like client to access SMB/CIFS resources
2 on servers</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">smbclient</tt> {servicename} [password] [-b <buffer size>] [-d debuglevel] [-D Directory] [-U username] [-W workgroup] [-M <netbios name>] [-m maxprotocol] [-A authfile] [-N] [-l logfile] [-L <netbios name>] [-I destinationIP] [-E] [-c <command string>] [-i scope] [-O <socket options>] [-p port] [-R <name resolve order>] [-s <smb config file>] [-T<c|x>IXFqgbNan] [-k]</p></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This tool is part of the <a href="Samba.7.html"><span class="citerefentry"><span class="refentrytitle">Samba</span>(7)</span></a> suite.</p><p><b class="command">smbclient</b> is a client that can
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"><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 <tt class="filename">//server/service</tt> where <i class="parameter"><tt>server
11 </tt></i> is the NetBIOS name of the SMB/CIFS server
12 offering the desired service and <i class="parameter"><tt>service</tt></i>
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 <tt class="filename">//smbserver/printer
16 </tt></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 <i class="parameter"><tt>-R</tt></i> parameter to <b class="command">smbclient</b> 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 <i class="parameter"><tt>-N</tt></i> 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 <i class="parameter"><tt>-U</tt></i> option (see
31 below)) and the <i class="parameter"><tt>-N</tt></i> 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 order></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><tt class="constant">lmhosts</tt>: 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><tt class="constant">host</tt>: Do a standard host
48 name to IP address resolution, using the system <tt class="filename">/etc/hosts
49 </tt>, 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 <tt class="filename">/etc/nsswitch.conf</tt>
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><tt class="constant">wins</tt>: Query a name with
55 the IP address listed in the <i class="parameter"><tt>wins server</tt></i>
56 parameter. If no WINS server has
57 been specified this method will be ignored.</p></li><li><p><tt class="constant">bcast</tt>: Do a broadcast on
58 each of the known local interfaces listed in the
59 <i class="parameter"><tt>interfaces</tt></i>
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 <i class="parameter"><tt>name resolve order
66 </tt></i> parameter of the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file the name resolution
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>One useful trick is to cat the message through
76 <b class="command">smbclient</b>. For example: <b class="command">
77 cat mymessage.txt | smbclient -M FRED </b> will
78 send the message in the file <tt class="filename">mymessage.txt</tt>
79 to the machine FRED. </p><p>You may also find the <i class="parameter"><tt>-U</tt></i> and
80 <i class="parameter"><tt>-I</tt></i> options useful, as they allow you to
81 control the FROM and TO parts of the message. </p><p>See the <i class="parameter"><tt>message command</tt></i> parameter in the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> for a description of how to handle incoming
82 WinPopup messages in Samba. </p><p><span class="emphasis"><em>Note</em></span>: Copy WinPopup into the startup group
83 on your WfWg PCs if you want them to always be able to receive
84 messages. </p></dd><dt><span class="term">-p port</span></dt><dd><p>This number is the TCP port number that will be used
85 when making connections to the server. The standard (well-known)
86 TCP port number for an SMB/CIFS server is 139, which is the
87 default. </p></dd><dt><span class="term">-l logfilename</span></dt><dd><p>If specified, <i class="replaceable"><tt>logfilename</tt></i> specifies a base filename
88 into which operational data from the running client will be
89 logged. </p><p>The default base name is specified at compile time.</p><p>The base name is used to generate actual log file names.
90 For example, if the name specified was "log", the debug file
91 would be <tt class="filename">log.client</tt>.</p><p>The log file generated is never removed by the client.
92 </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
93 </p></dd><dt><span class="term">-I IP-address</span></dt><dd><p><i class="replaceable"><tt>IP address</tt></i> is the address of the server to connect to.
94 It should be specified in standard "a.b.c.d" notation. </p><p>Normally the client would attempt to locate a named
95 SMB/CIFS server by looking it up via the NetBIOS name resolution
96 mechanism described above in the <i class="parameter"><tt>name resolve order</tt></i>
97 parameter above. Using this parameter will force the client
98 to assume that the server is on the machine with the specified IP
99 address and the NetBIOS name component of the resource being
100 connected to will be ignored. </p><p>There is no default for this parameter. If not supplied,
101 it will be determined automatically by the client as described
102 above. </p></dd><dt><span class="term">-E</span></dt><dd><p>This parameter causes the client to write messages
103 to the standard error stream (stderr) rather than to the standard
104 output stream. </p><p>By default, the client writes messages to standard output
105 - 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
106 are available on a server. You use it as <b class="command">smbclient -L
107 host</b> and a list should appear. The <i class="parameter"><tt>-I
108 </tt></i> option may be useful if your NetBIOS names don't
109 match your TCP/IP DNS host names or if you are trying to reach a
110 host on another network. </p></dd><dt><span class="term">-t terminal code</span></dt><dd><p>This option tells <b class="command">smbclient</b> how to interpret
111 filenames coming from the remote server. Usually Asian language
112 multibyte UNIX implementations use different character sets than
113 SMB/CIFS servers (<span class="emphasis"><em>EUC</em></span> instead of <span class="emphasis"><em>
114 SJIS</em></span> for example). Setting this parameter will let
115 <b class="command">smbclient</b> convert between the UNIX filenames and
116 the SMB filenames correctly. This option has not been seriously tested
117 and may have some problems. </p><p>The terminal codes include CWsjis, CWeuc, CWjis7, CWjis8,
118 CWjunet, CWhex, CWcap. This is not a complete list, check the Samba
119 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
120 size when getting or putting a file from/to the server. The default
121 is 65520 bytes. Setting this value smaller (to 1200 bytes) has been
122 observed to speed up file transfers to and from a Win9x server.
123 </p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the version number for
124 <b class="command">smbd</b>.</p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>The file specified contains the
125 configuration details required by the server. The
126 information in this file includes server-specific
127 information such as what printcap file to use, as well
128 as descriptions of all the services that the server is
129 to provide. See <a href="smb.conf.5.html" target="_top"><tt class="filename">
130 smb.conf(5)</tt></a> for more information.
131 The default configuration file name is determined at
132 compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i class="replaceable"><tt>debuglevel</tt></i> is an integer
133 from 0 to 10. The default value if this parameter is
134 not specified is zero.</p><p>The higher this value, the more detail will be
135 logged to the log files about the activities of the
136 server. At level 0, only critical errors and serious
137 warnings will be logged. Level 1 is a reasonable level for
138 day to day running - it generates a small amount of
139 information about operations carried out.</p><p>Levels above 1 will generate considerable
140 amounts of log data, and should only be used when
141 investigating a problem. Levels above 3 are designed for
142 use only by developers and generate HUGE amounts of log
143 data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will
144 override the <a href="smb.conf.5.html#loglevel" target="_top">log
145 level</a> parameter in the <a href="smb.conf.5.html" target="_top">
146 <tt class="filename">smb.conf(5)</tt></a> file.</p></dd><dt><span class="term">-l|--logfile=logbasename</span></dt><dd><p>File name for log/debug files. The extension
147 <tt class="constant">".client"</tt> will be appended. The log file is
148 never removed by the client.
149 </p></dd><dt><span class="term">-N</span></dt><dd><p>If specified, this parameter suppresses the normal
150 password prompt from the client to the user. This is useful when
151 accessing a service that does not require a password. </p><p>Unless a password is specified on the command line or
152 this parameter is specified, the client will request a
153 password.</p></dd><dt><span class="term">-k</span></dt><dd><p>
154 Try to authenticate with kerberos. Only useful in
155 an Active Directory environment.
156 </p></dd><dt><span class="term">-A|--authfile=filename</span></dt><dd><p>This option allows
157 you to specify a file from which to read the username and
158 password used in the connection. The format of the file is
159 </p><pre class="programlisting">
160 username = <value>
161 password = <value>
162 domain = <value>
163 </pre><p>Make certain that the permissions on the file restrict
164 access from unwanted users. </p></dd><dt><span class="term">-U|--user=username[%password]</span></dt><dd><p>Sets the SMB username or username and password. </p><p>If %password is not specified, the user will be prompted. The
165 client will first check the <tt class="envar">USER</tt> environment variable, then the
166 <tt class="envar">LOGNAME</tt> variable and if either exists, the
167 string is uppercased. If these environmental variables are not
168 found, the username <tt class="constant">GUEST</tt> is used. </p><p>A third option is to use a credentials file which
169 contains the plaintext of the username and password. This
170 option is mainly provided for scripts where the admin does not
171 wish to pass the credentials on the command line or via environment
172 variables. If this method is used, make certain that the permissions
173 on the file restrict access from unwanted users. See the
174 <i class="parameter"><tt>-A</tt></i> for more details. </p><p>Be cautious about including passwords in scripts. Also, on
175 many systems the command line of a running process may be seen
176 via the <b class="command">ps</b> command. To be safe always allow
177 <b class="command">rpcclient</b> to prompt for a password and type
178 it in directly. </p></dd><dt><span class="term">-n <primary NetBIOS name></span></dt><dd><p>This option allows you to override
179 the NetBIOS name that Samba uses for itself. This is identical
180 to setting the <a href="smb.conf.5.html#netbiosname" target="_top"><i class="parameter"><tt>NetBIOS
181 name</tt></i></a> parameter in the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file. However, a command
182 line setting will take precedence over settings in
183 <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>.</p></dd><dt><span class="term">-i <scope></span></dt><dd><p>This specifies a NetBIOS scope that
184 <b class="command">nmblookup</b> will use to communicate with when
185 generating NetBIOS names. For details on the use of NetBIOS
186 scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are
187 <span class="emphasis"><em>very</em></span> rarely used, only set this parameter
188 if you are the system administrator in charge of all the
189 NetBIOS systems you communicate with.</p></dd><dt><span class="term">-W|--workgroup=domain</span></dt><dd><p>Set the SMB domain of the username. This
190 overrides the default domain which is the domain defined in
191 smb.conf. If the domain specified is the same as the servers
192 NetBIOS name, it causes the client to log on using the servers local
193 SAM (as opposed to the Domain SAM). </p></dd><dt><span class="term">-O socket options</span></dt><dd><p>TCP socket options to set on the client
194 socket. See the socket options parameter in
195 the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> manual page for the list of valid
196 options. </p></dd><dt><span class="term">-T tar options</span></dt><dd><p>smbclient may be used to create <b class="command">tar(1)
197 </b> 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><i class="parameter"><tt>c</tt></i> - 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 <i class="parameter"><tt>x</tt></i> flag. </p></li><li><p><i class="parameter"><tt>x</tt></i> - 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 <i class="parameter"><tt>c</tt></i> 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><i class="parameter"><tt>I</tt></i> - Include files and directories.
212 Is the default behavior when filenames are specified above. Causes
213 tar 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 r below. </p></li><li><p><i class="parameter"><tt>X</tt></i> - Exclude files and directories.
216 Causes tar files to be excluded from an extract or create. See
217 example below. Filename globbing works in one of two ways now.
218 See <i class="parameter"><tt>r</tt></i> below. </p></li><li><p><i class="parameter"><tt>b</tt></i> - Blocksize. Must be followed
219 by a valid (greater than zero) blocksize. Causes tar file to be
220 written out in blocksize*TBLOCK (usually 512 byte) blocks.
221 </p></li><li><p><i class="parameter"><tt>g</tt></i> - Incremental. Only back up
222 files that have the archive bit set. Useful only with the
223 <i class="parameter"><tt>c</tt></i> flag. </p></li><li><p><i class="parameter"><tt>q</tt></i> - Quiet. Keeps tar from printing
224 diagnostics as it works. This is the same as tarmode quiet.
225 </p></li><li><p><i class="parameter"><tt>r</tt></i> - Regular expression include
226 or exclude. Uses regular expression matching for
227 excluding or excluding files if compiled with HAVE_REGEX_H.
228 However this mode can be very slow. If not compiled with
229 HAVE_REGEX_H, does a limited wildcard match on '*' and '?'.
230 </p></li><li><p><i class="parameter"><tt>N</tt></i> - Newer than. Must be followed
231 by the name of a file whose date is compared against files found
232 on the share during a create. Only files newer than the file
233 specified are backed up to the tar file. Useful only with the
234 <i class="parameter"><tt>c</tt></i> flag. </p></li><li><p><i class="parameter"><tt>a</tt></i> - Set archive bit. Causes the
235 archive bit to be reset when a file is backed up. Useful with the
236 <i class="parameter"><tt>g</tt></i> and <i class="parameter"><tt>c</tt></i> flags.
237 </p></li></ul></div><p><span class="emphasis"><em>Tar Long File Names</em></span></p><p><b class="command">smbclient</b>'s tar option now supports long
238 file names both on backup and restore. However, the full path
239 name of the file must be less than 1024 bytes. Also, when
240 a tar archive is created, <b class="command">smbclient</b>'s tar option places all
241 files in the archive with relative names, not absolute names.
242 </p><p><span class="emphasis"><em>Tar Filenames</em></span></p><p>All file names can be given as DOS path names (with '\\'
243 as the component separator) or as UNIX path names (with '/' as
244 the component separator). </p><p><span class="emphasis"><em>Examples</em></span></p><p>Restore from tar file <tt class="filename">backup.tar</tt> into myshare on mypc
245 (no password on share). </p><p><b class="command">smbclient //mypc/yshare "" -N -Tx backup.tar
246 </b></p><p>Restore everything except <tt class="filename">users/docs</tt>
247 </p><p><b class="command">smbclient //mypc/myshare "" -N -TXx backup.tar
248 users/docs</b></p><p>Create a tar file of the files beneath <tt class="filename">
249 users/docs</tt>. </p><p><b class="command">smbclient //mypc/myshare "" -N -Tc
250 backup.tar users/docs </b></p><p>Create the same tar file as above, but now use
251 a DOS path name. </p><p><b class="command">smbclient //mypc/myshare "" -N -tc backup.tar
252 users\edocs </b></p><p>Create a tar file of all the files and directories in
253 the share. </p><p><b class="command">smbclient //mypc/myshare "" -N -Tc backup.tar *
254 </b></p></dd><dt><span class="term">-D initial directory</span></dt><dd><p>Change to initial directory before starting. Probably
255 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
256 commands to be executed instead of prompting from stdin. <i class="parameter"><tt>
257 -N</tt></i> is implied by <i class="parameter"><tt>-c</tt></i>.</p><p>This is particularly useful in scripts and for printing stdin
258 to the server, e.g. <b class="command">-c 'print -'</b>. </p></dd></dl></div></div><div class="refsect1" lang="en"><h2>OPERATIONS</h2><p>Once the client is running, the user is presented with
259 a prompt : </p><p><tt class="prompt">smb:\> </tt></p><p>The backslash ("\\") indicates the current working directory
260 on the server, and will change if the current working directory
261 is changed. </p><p>The prompt indicates that the client is ready and waiting to
262 carry out a user command. Each command is a single word, optionally
263 followed by parameters specific to that command. Command and parameters
264 are space-delimited unless these notes specifically
265 state otherwise. All commands are case-insensitive. Parameters to
266 commands may or may not be case sensitive, depending on the command.
267 </p><p>You can specify file names which have spaces in them by quoting
268 the name with double quotes, for example "a long file name". </p><p>Parameters shown in square brackets (e.g., "[parameter]") are
269 optional. If not given, the command will use suitable defaults. Parameters
270 shown in angle brackets (e.g., "<parameter>") are required.
271 </p><p>Note that all commands operating on the server are actually
272 performed by issuing a request to the server. Thus the behavior may
273 vary from server to server, depending on how the server was implemented.
274 </p><p>The commands available are given here in alphabetical order. </p><div class="variablelist"><dl><dt><span class="term">? [command]</span></dt><dd><p>If <i class="replaceable"><tt>command</tt></i> is specified, the ? command will display
275 a brief informative message about the specified command. If no
276 command is specified, a list of available commands will
277 be displayed. </p></dd><dt><span class="term">! [shell command]</span></dt><dd><p>If <i class="replaceable"><tt>shell command</tt></i> is specified, the !
278 command will execute a shell locally and run the specified shell
279 command. If no command is specified, a local shell will be run.
280 </p></dd><dt><span class="term">altname file</span></dt><dd><p>The client will request that the server return
281 the "alternate" name (the 8.3 name) for a file or directory.
282 </p></dd><dt><span class="term">cancel jobid0 [jobid1] ... [jobidN]</span></dt><dd><p>The client will request that the server cancel
283 the printjobs identified by the given numeric print job ids.
284 </p></dd><dt><span class="term">chmod file mode in octal</span></dt><dd><p>This command depends on the server supporting the CIFS
285 UNIX extensions and will fail if the server does not. The client requests that the server
286 change the UNIX permissions to the given octal mode, in standard UNIX format.
287 </p></dd><dt><span class="term">chown file uid gid</span></dt><dd><p>This command depends on the server supporting the CIFS
288 UNIX extensions and will fail if the server does not. The client requests that the server
289 change the UNIX user and group ownership to the given decimal values. Note there is
290 currently no way to remotely look up the UNIX uid and gid values for a given name.
291 This may be addressed in future versions of the CIFS UNIX extensions.
292 </p></dd><dt><span class="term">cd [directory name]</span></dt><dd><p>If "directory name" is specified, the current
293 working directory on the server will be changed to the directory
294 specified. This operation will fail if for any reason the specified
295 directory is inaccessible. </p><p>If no directory name is specified, the current working
296 directory on the server will be reported. </p></dd><dt><span class="term">del <mask></span></dt><dd><p>The client will request that the server attempt
297 to delete all files matching <i class="replaceable"><tt>mask</tt></i> from the current working
298 directory on the server. </p></dd><dt><span class="term">dir <mask></span></dt><dd><p>A list of the files matching <i class="replaceable"><tt>mask</tt></i> in the current
299 working directory on the server will be retrieved from the server
300 and displayed. </p></dd><dt><span class="term">exit</span></dt><dd><p>Terminate the connection with the server and exit
301 from the program. </p></dd><dt><span class="term">get <remote file name> [local file name]</span></dt><dd><p>Copy the file called <tt class="filename">remote file name</tt> from
302 the server to the machine running the client. If specified, name
303 the local copy <tt class="filename">local file name</tt>. Note that all transfers in
304 <b class="command">smbclient</b> are binary. See also the
305 lowercase command. </p></dd><dt><span class="term">help [command]</span></dt><dd><p>See the ? command above. </p></dd><dt><span class="term">lcd [directory name]</span></dt><dd><p>If <i class="replaceable"><tt>directory name</tt></i> is specified, the current
306 working directory on the local machine will be changed to
307 the directory specified. This operation will fail if for any
308 reason the specified directory is inaccessible. </p><p>If no directory name is specified, the name of the
309 current working directory on the local machine will be reported.
310 </p></dd><dt><span class="term">link source destination</span></dt><dd><p>This command depends on the server supporting the CIFS
311 UNIX extensions and will fail if the server does not. The client requests that the server
312 create a hard link between the source and destination files. The source file
314 </p></dd><dt><span class="term">lowercase</span></dt><dd><p>Toggle lowercasing of filenames for the get and
315 mget commands. </p><p>When lowercasing is toggled ON, local filenames are converted
316 to lowercase when using the get and mget commands. This is
317 often useful when copying (say) MSDOS files from a server, because
318 lowercase filenames are the norm on UNIX systems. </p></dd><dt><span class="term">ls <mask></span></dt><dd><p>See the dir command above. </p></dd><dt><span class="term">mask <mask></span></dt><dd><p>This command allows the user to set up a mask
319 which will be used during recursive operation of the mget and
320 mput commands. </p><p>The masks specified to the mget and mput commands act as
321 filters for directories rather than files when recursion is
322 toggled ON. </p><p>The mask specified with the mask command is necessary
323 to filter files within those directories. For example, if the
324 mask specified in an mget command is "source*" and the mask
325 specified with the mask command is "*.c" and recursion is
326 toggled ON, the mget command will retrieve all files matching
327 "*.c" in all directories below and including all directories
328 matching "source*" in the current working directory. </p><p>Note that the value for mask defaults to blank (equivalent
329 to "*") and remains so until the mask command is used to change it.
330 It retains the most recently specified value indefinitely. To
331 avoid unexpected results it would be wise to change the value of
332 mask back to "*" after using the mget or mput commands. </p></dd><dt><span class="term">md <directory name></span></dt><dd><p>See the mkdir command. </p></dd><dt><span class="term">mget <mask></span></dt><dd><p>Copy all files matching <i class="replaceable"><tt>mask</tt></i> from the server to
333 the machine running the client. </p><p>Note that <i class="replaceable"><tt>mask</tt></i> is interpreted differently during recursive
334 operation and non-recursive operation - refer to the recurse and
335 mask commands for more information. Note that all transfers in
336 <b class="command">smbclient</b> are binary. See also the lowercase command. </p></dd><dt><span class="term">mkdir <directory name></span></dt><dd><p>Create a new directory on the server (user access
337 privileges permitting) with the specified name. </p></dd><dt><span class="term">mput <mask></span></dt><dd><p>Copy all files matching <i class="replaceable"><tt>mask</tt></i> in the current working
338 directory on the local machine to the current working directory on
339 the server. </p><p>Note that <i class="replaceable"><tt>mask</tt></i> is interpreted differently during recursive
340 operation and non-recursive operation - refer to the recurse and mask
341 commands for more information. Note that all transfers in <b class="command">smbclient</b>
342 are binary. </p></dd><dt><span class="term">print <file name></span></dt><dd><p>Print the specified file from the local machine
343 through a printable service on the server. </p><p>See also the printmode command.</p></dd><dt><span class="term">printmode <graphics or text></span></dt><dd><p>Set the print mode to suit either binary data
344 (such as graphical information) or text. Subsequent print
345 commands will use the currently set print mode. </p></dd><dt><span class="term">prompt</span></dt><dd><p>Toggle prompting for filenames during operation
346 of the mget and mput commands. </p><p>When toggled ON, the user will be prompted to confirm
347 the transfer of each file during these commands. When toggled
348 OFF, all specified files will be transferred without prompting.
349 </p></dd><dt><span class="term">put <local file name> [remote file name]</span></dt><dd><p>Copy the file called <tt class="filename">local file name</tt> from the
350 machine running the client to the server. If specified,
351 name the remote copy <tt class="filename">remote file name</tt>. Note that all transfers
352 in <b class="command">smbclient</b> are binary. See also the lowercase command.
353 </p></dd><dt><span class="term">queue</span></dt><dd><p>Displays the print queue, showing the job id,
354 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 <directory name></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
355 and mput. </p><p>When toggled ON, these commands will process all directories
356 in the source directory (i.e., the directory they are copying
357 from ) and will recurse into any that match the mask specified
358 to the command. Only files that match the mask specified using
359 the mask command will be retrieved. See also the mask command.
360 </p><p>When recursion is toggled OFF, only files from the current
361 working directory on the source machine that match the mask specified
362 to the mget or mput commands will be copied, and any mask specified
363 using the mask command will be ignored. </p></dd><dt><span class="term">rm <mask></span></dt><dd><p>Remove all files matching <i class="replaceable"><tt>mask</tt></i> from the current
364 working directory on the server. </p></dd><dt><span class="term">rmdir <directory name></span></dt><dd><p>Remove the specified directory (user access
365 privileges permitting) from the server. </p></dd><dt><span class="term">setmode <filename> <perm=[+|\-]rsha></span></dt><dd><p>A version of the DOS attrib command to set
366 file permissions. For example: </p><p><b class="command">setmode myfile +r </b></p><p>would make myfile read only. </p></dd><dt><span class="term">symlink source destination</span></dt><dd><p>This command depends on the server supporting the CIFS
367 UNIX extensions and will fail if the server does not. The client requests that the server
368 create a symbolic hard link between the source and destination files. The source file
369 must not exist. Note that the server will not create a link to any path that lies
370 outside the currently connected share. This is enforced by the Samba server.
371 </p></dd><dt><span class="term">tar <c|x>[IXbgNa]</span></dt><dd><p>Performs a tar operation - see the <i class="parameter"><tt>-T
372 </tt></i> command line option above. Behavior may be affected
373 by the tarmode command (see below). Using g (incremental) and N
374 (newer) will affect tarmode settings. Note that using the "-" option
375 with tar x may not work - use the command line option instead.
376 </p></dd><dt><span class="term">blocksize <blocksize></span></dt><dd><p>Blocksize. Must be followed by a valid (greater
377 than zero) blocksize. Causes tar file to be written out in
378 <i class="replaceable"><tt>blocksize</tt></i>*TBLOCK (usually 512 byte) blocks. </p></dd><dt><span class="term">tarmode <full|inc|reset|noreset></span></dt><dd><p>Changes tar's behavior with regard to archive
379 bits. In full mode, tar will back up everything regardless of the
380 archive bit setting (this is the default mode). In incremental mode,
381 tar will only back up files with the archive bit set. In reset mode,
382 tar will reset the archive bit on all files it backs up (implies
383 read/write share). </p></dd></dl></div></div><div class="refsect1" lang="en"><h2>NOTES</h2><p>Some servers are fussy about the case of supplied usernames,
384 passwords, share names (AKA service names) and machine names.
385 If you fail to connect try giving all parameters in uppercase.
386 </p><p>It is often necessary to use the -n option when connecting
387 to some types of servers. For example OS/2 LanManager insists
388 on a valid NetBIOS name being used, so you need to supply a valid
389 name that would be known to the server.</p><p>smbclient supports long file names where the server
390 supports the LANMAN2 protocol or above. </p></div><div class="refsect1" lang="en"><h2>ENVIRONMENT VARIABLES</h2><p>The variable <tt class="envar">USER</tt> may contain the
391 username of the person using the client. This information is
392 used only if the protocol level is high enough to support
393 session-level passwords.</p><p>The variable <tt class="envar">PASSWD</tt> may contain
394 the password of the person using the client. This information is
395 used only if the protocol level is high enough to support
396 session-level passwords. </p><p>The variable <tt class="envar">LIBSMB_PROG</tt> may contain
397 the path, executed with system(), which the client should connect
398 to instead of connecting to a server. This functionality is primarily
399 intended as a development aid, and works best when using a LMHOSTS
400 file</p></div><div class="refsect1" lang="en"><h2>INSTALLATION</h2><p>The location of the client program is a matter for
401 individual system administrators. The following are thus
402 suggestions only. </p><p>It is recommended that the smbclient software be installed
403 in the <tt class="filename">/usr/local/samba/bin/</tt> or <tt class="filename">
404 /usr/samba/bin/</tt> directory, this directory readable
405 by all, writeable only by root. The client program itself should
406 be executable by all. The client should <span class="emphasis"><em>NOT</em></span> be
407 setuid or setgid! </p><p>The client log files should be put in a directory readable
408 and writeable only by the user. </p><p>To test the client, you will need to know the name of a
409 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
410 on a user-accessible port (typically any port number over 1024)
411 would provide a suitable test server. </p></div><div class="refsect1" lang="en"><h2>DIAGNOSTICS</h2><p>Most diagnostics issued by the client are logged in a
412 specified log file. The log file name is specified at compile time,
413 but may be overridden on the command line. </p><p>The number and nature of diagnostics available depends
414 on the debug level used by the client. If you have problems,
415 set the debug level to 3 and peruse the log files. </p></div><div class="refsect1" lang="en"><h2>VERSION</h2><p>This man page is correct for version 2.2 of the Samba suite.</p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities
416 were created by Andrew Tridgell. Samba is now developed
417 by the Samba Team as an Open Source project similar
418 to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer.
419 The man page sources were converted to YODL format (another
420 excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top">
421 ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0
422 release by Jeremy Allison. The conversion to DocBook for
423 Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0
424 was done by Alexander Bokovoy.</p></div></div></body></html>
git.samba.org / tprouty / samba.git / blob