9c3a97f6de0a8fd2accad937e5910d727a0b16d5
[kai/samba.git] / docs-xml / manpages-3 / smbclient.1.xml
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="smbclient.1">
4
5 <refmeta>
6         <refentrytitle>smbclient</refentrytitle>
7         <manvolnum>1</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">User Commands</refmiscinfo>
10         <refmiscinfo class="version">3.6</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>smbclient</refname>
16         <refpurpose>ftp-like client to access SMB/CIFS resources
17         on servers</refpurpose>
18 </refnamediv>
19
20 <refsynopsisdiv>
21         <cmdsynopsis>
22                 <command>smbclient</command>
23                 <arg choice="opt">-b &lt;buffer size&gt;</arg>
24                 <arg choice="opt">-d debuglevel</arg>
25                 <arg choice="opt">-e</arg>
26                 <arg choice="opt">-L &lt;netbios name&gt;</arg>
27                 <arg choice="opt">-U username</arg>
28                 <arg choice="opt">-I destinationIP</arg>
29                 <arg choice="opt">-M &lt;netbios name&gt;</arg>
30                 <arg choice="opt">-m maxprotocol</arg>
31                 <arg choice="opt">-A authfile</arg>
32                 <arg choice="opt">-N</arg>
33                 <arg choice="opt">-g</arg>
34                 <arg choice="opt">-i scope</arg>
35                 <arg choice="opt">-O &lt;socket options&gt;</arg>
36                 <arg choice="opt">-p port</arg>
37                 <arg choice="opt">-R &lt;name resolve order&gt;</arg>
38                 <arg choice="opt">-s &lt;smb config file&gt;</arg>
39                 <arg choice="opt">-k</arg>
40                 <arg choice="opt">-P</arg>
41                 <arg choice="opt">-c &lt;command&gt;</arg>
42         </cmdsynopsis>
43
44         <cmdsynopsis>
45                 <command>smbclient</command>
46                 <arg choice="req">servicename</arg>
47                 <arg choice="opt">password</arg>
48                 <arg choice="opt">-b &lt;buffer size&gt;</arg>
49                 <arg choice="opt">-d debuglevel</arg>
50                 <arg choice="opt">-e</arg>
51                 <arg choice="opt">-D Directory</arg>
52                 <arg choice="opt">-U username</arg>
53                 <arg choice="opt">-W workgroup</arg>
54                 <arg choice="opt">-M &lt;netbios name&gt;</arg>
55                 <arg choice="opt">-m maxprotocol</arg>
56                 <arg choice="opt">-A authfile</arg>
57                 <arg choice="opt">-N</arg>
58                 <arg choice="opt">-g</arg>
59                 <arg choice="opt">-l log-basename</arg>
60                 <arg choice="opt">-I destinationIP</arg>
61                 <arg choice="opt">-E</arg>
62                 <arg choice="opt">-c &lt;command string&gt;</arg>
63                 <arg choice="opt">-i scope</arg>
64                 <arg choice="opt">-O &lt;socket options&gt;</arg>
65                 <arg choice="opt">-p port</arg>
66                 <arg choice="opt">-R &lt;name resolve order&gt;</arg>
67                 <arg choice="opt">-s &lt;smb config file&gt;</arg>
68                 <arg choice="opt">-T&lt;c|x&gt;IXFqgbNan</arg>
69                 <arg choice="opt">-k</arg>
70         </cmdsynopsis>
71 </refsynopsisdiv>
72
73 <refsect1>
74         <title>DESCRIPTION</title>
75
76         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
77         <manvolnum>7</manvolnum></citerefentry> suite.</para>
78
79         <para><command>smbclient</command> is a client that can 
80         'talk' to an SMB/CIFS server. It offers an interface
81         similar to that of the ftp program (see <citerefentry><refentrytitle>ftp</refentrytitle>
82         <manvolnum>1</manvolnum></citerefentry>).  
83         Operations include things like getting files from the server 
84         to the local machine, putting files from the local machine to 
85         the server, retrieving directory information from the server 
86         and so on. </para>
87 </refsect1>
88
89
90 <refsect1>
91         <title>OPTIONS</title>
92         
93         <variablelist>
94                 <varlistentry>
95                 <term>servicename</term>
96                 <listitem><para>servicename is the name of the service 
97                 you want to use on the server. A service name takes the form
98                 <filename>//server/service</filename> where <parameter>server
99                 </parameter> is the NetBIOS name of the SMB/CIFS server 
100                 offering the desired service and <parameter>service</parameter> 
101                 is the name of the service offered.  Thus to connect to 
102                 the service "printer" on the SMB/CIFS server "smbserver",
103                 you would use the servicename <filename>//smbserver/printer
104                 </filename></para>
105
106                 <para>Note that the server name required is NOT necessarily 
107                 the IP (DNS) host name of the server !  The name required is 
108                 a NetBIOS server name, which may or may not be the
109                 same as the IP hostname of the machine running the server.
110                 </para>
111
112                 <para>The server name is looked up according to either 
113                 the <parameter>-R</parameter> parameter to <command>smbclient</command> or 
114                 using the name resolve order parameter in 
115                 the <citerefentry><refentrytitle>smb.conf</refentrytitle>
116                 <manvolnum>5</manvolnum></citerefentry> file, 
117                 allowing an administrator to change the order and methods 
118                 by which server names are looked up. </para></listitem>
119                 </varlistentry>
120
121                 <varlistentry>
122                 <term>password</term>
123                 <listitem><para>The password required to access the specified 
124                 service on the specified server. If this parameter is 
125                 supplied, the <parameter>-N</parameter> option (suppress 
126                 password prompt) is assumed. </para>
127
128                 <para>There is no default password. If no password is supplied 
129                 on the command line (either by using this parameter or adding 
130                 a password to the <parameter>-U</parameter> option (see 
131                 below)) and the <parameter>-N</parameter> option is not 
132                 specified, the client will prompt for a password, even if 
133                 the desired service does not require one. (If no password is 
134                 required, simply press ENTER to provide a null password.)
135                 </para>
136
137                 <para>Note: Some servers (including OS/2 and Windows for 
138                 Workgroups) insist on an uppercase password. Lowercase 
139                 or mixed case passwords may be rejected by these servers.               
140                 </para>
141
142                 <para>Be cautious about including passwords in scripts.
143                 </para></listitem>
144                 </varlistentry>
145                 
146                 <varlistentry>
147                 <term>-R|--name-resolve &lt;name resolve order&gt;</term>
148                 <listitem><para>This option is used by the programs in the Samba 
149                 suite to determine what naming services and in what order to resolve 
150                 host names to IP addresses. The option takes a space-separated 
151                 string of different name resolution options.</para>
152
153                 <para>The options are :"lmhosts", "host", "wins" and "bcast". They 
154                 cause names to be resolved as follows:</para>
155
156                 <itemizedlist>
157                         <listitem><para><constant>lmhosts</constant>: Lookup an IP 
158                         address in the Samba lmhosts file. If the line in lmhosts has 
159                         no name type attached to the NetBIOS name (see 
160                         the <citerefentry><refentrytitle>lmhosts</refentrytitle>
161                         <manvolnum>5</manvolnum></citerefentry> for details) then
162                         any name type matches for lookup.</para>
163                         </listitem>
164                         
165                         <listitem><para><constant>host</constant>: Do a standard host 
166                         name to IP address resolution, using the system <filename>/etc/hosts
167                         </filename>, NIS, or DNS lookups. This method of name resolution 
168                         is operating system dependent, for instance on IRIX or Solaris this 
169                         may be controlled by the <filename>/etc/nsswitch.conf</filename> 
170                         file).  Note that this method is only used if the NetBIOS name 
171                         type being queried is the 0x20 (server) name type, otherwise 
172                         it is ignored.</para>
173                         </listitem>
174                         
175                         <listitem><para><constant>wins</constant>: Query a name with 
176                         the IP address listed in the <parameter>wins server</parameter>
177                         parameter.  If no WINS server has
178                         been specified this method will be ignored.</para>
179                         </listitem>
180                         
181                         <listitem><para><constant>bcast</constant>: Do a broadcast on 
182                         each of the known local interfaces listed in the 
183                         <parameter>interfaces</parameter>
184                         parameter. This is the least reliable of the name resolution 
185                         methods as it depends on the target host being on a locally 
186                         connected subnet.</para>
187                         </listitem>
188                 </itemizedlist>
189
190                 <para>If this parameter is not set then the name resolve order 
191                 defined in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
192                 <manvolnum>5</manvolnum></citerefentry> file parameter  
193                 (name resolve order) will be used. </para>
194
195                 <para>The default order is lmhosts, host, wins, bcast and without 
196                 this parameter or any entry in the <parameter>name resolve order
197                 </parameter> parameter of the <citerefentry><refentrytitle>smb.conf</refentrytitle>
198                 <manvolnum>5</manvolnum></citerefentry> file the name resolution
199                 methods will be attempted in this order. </para></listitem>
200                 </varlistentry>
201                 
202                 
203                 <varlistentry>
204                 <term>-M|--message NetBIOS name</term>
205                 <listitem><para>This options allows you to send messages, using 
206                 the "WinPopup" protocol, to another computer. Once a connection is 
207                 established you then type your message, pressing ^D (control-D) to 
208                 end. </para>
209
210                 <para>If the receiving computer is running WinPopup the user will 
211                 receive the message and probably a beep. If they are not running 
212                 WinPopup the message will be lost, and no error message will 
213                 occur. </para>
214
215                 <para>The message is also automatically truncated if the message 
216                 is over 1600 bytes, as this is the limit of the protocol. 
217                 </para>
218
219                 <para>
220                 One useful trick is to pipe the message through <command>smbclient</command>. 
221                 For example: smbclient -M FRED &lt; mymessage.txt will send the 
222                 message in the file <filename>mymessage.txt</filename> to the 
223                 machine FRED.
224                 </para>
225
226                 <para>You may also find the <parameter>-U</parameter> and 
227                 <parameter>-I</parameter> options useful, as they allow you to 
228                 control the FROM and TO parts of the message. </para>
229
230                 <para>See the <parameter>message command</parameter> parameter in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
231                 <manvolnum>5</manvolnum></citerefentry> for a description of how to handle incoming 
232                 WinPopup messages in Samba. </para>
233
234                 <para><emphasis>Note</emphasis>: Copy WinPopup into the startup group 
235                 on your WfWg PCs if you want them to always be able to receive 
236                 messages. </para></listitem>
237                 </varlistentry>
238
239                 <varlistentry>
240                 <term>-p|--port port</term>
241                 <listitem><para>This number is the TCP port number that will be used 
242                 when making connections to the server. The standard (well-known)
243                 TCP port number for an SMB/CIFS server is 139, which is the 
244                 default. </para></listitem>
245                 </varlistentry>
246
247                 <varlistentry>
248                 <term>-g|--grepable</term>
249                 <listitem><para>This parameter provides combined with
250                 <parameter>-L</parameter> easy parseable output that allows processing
251                 with utilities such as grep and cut.
252                 </para></listitem>
253                 </varlistentry>
254
255                 <varlistentry>
256                 <term>-m|--max-protocol protocol</term>
257                 <listitem><para>This parameter sets the maximum protocol version announced by the client.
258                 </para></listitem>
259                 </varlistentry>
260
261                 <varlistentry>
262                 <term>-P</term>
263                 <listitem><para>
264                 Make queries to the external server using the machine account of the local server.
265                 </para></listitem>
266                 </varlistentry>
267
268                 &stdarg.help;
269
270                 <varlistentry>
271                 <term>-I|--ip-address IP-address</term>
272                 <listitem><para><replaceable>IP address</replaceable> is the address of the server to connect to.
273                 It should be specified in standard "a.b.c.d" notation. </para>
274
275                 <para>Normally the client would attempt to locate a named 
276                 SMB/CIFS server by looking it up via the NetBIOS name resolution 
277                 mechanism described above in the <parameter>name resolve order</parameter> 
278                 parameter above. Using this parameter will force the client
279                 to assume that the server is on the machine with the specified IP 
280                 address and the NetBIOS name component of the resource being 
281                 connected to will be ignored. </para>
282
283                 <para>There is no default for this parameter. If not supplied, 
284                 it will be determined automatically by the client as described 
285                 above. </para></listitem>
286                 </varlistentry>
287                 
288                 <varlistentry>
289                 <term>-E|--stderr</term>
290                 <listitem><para>This parameter causes the client to write messages 
291                 to the standard error stream (stderr) rather than to the standard 
292                 output stream. </para>
293                 
294                 <para>By default, the client writes messages to standard output 
295                 - typically the user's tty. </para></listitem>
296                 </varlistentry>
297                 
298                 <varlistentry>
299                 <term>-L|--list</term>
300                 <listitem><para>This option allows you to look at what services 
301                 are available on a server. You use it as <command>smbclient -L 
302                 host</command> and a list should appear.  The <parameter>-I
303                 </parameter> option may be useful if your NetBIOS names don't 
304                 match your TCP/IP DNS host names or if you are trying to reach a 
305                 host on another network. </para></listitem>
306                 </varlistentry>
307                 
308                 <varlistentry>  
309                 <term>-b|--send-buffer buffersize</term>
310                 <listitem><para>This option changes the transmit/send buffer 
311                 size when getting or putting a file from/to the server. The default 
312                 is 65520 bytes. Setting this value smaller (to 1200 bytes) has been 
313                 observed to speed up file transfers to and from a Win9x server. 
314                 </para></listitem>
315                 </varlistentry>
316                 
317                 <varlistentry>
318                 <term>-e</term>
319                 <listitem><para>This command line parameter requires the remote
320                 server support the UNIX extensions. Request that the connection be
321                 encrypted. This is new for Samba 3.2 and will only work with Samba
322                 3.2 or above servers. Negotiates SMB encryption using GSSAPI. Uses
323                 the given credentials for the encryption negotiaion (either kerberos
324                 or NTLMv1/v2 if given domain/username/password triple. Fails the
325                 connection if encryption cannot be negotiated.
326                 </para></listitem>
327                 </varlistentry>
328                 
329                 &stdarg.client.debug;
330                 &popt.common.samba;
331                 &popt.common.credentials;
332                 &popt.common.connection;
333                 
334                 <varlistentry>
335                 <term>-T|--tar tar options</term>
336                 <listitem><para>smbclient may be used to create <command>tar(1)
337                 </command> compatible backups of all the files on an SMB/CIFS
338                 share. The secondary tar flags that can be given to this option 
339                 are : </para>
340                 
341                 <itemizedlist>
342                         <listitem><para><parameter>c</parameter> - Create a tar file on UNIX. 
343                         Must be followed by the name of a tar file, tape device
344                         or "-" for standard output. If using standard output you must 
345                         turn the log level to its lowest value -d0 to avoid corrupting 
346                         your tar file. This flag is mutually exclusive with the 
347                         <parameter>x</parameter> flag. </para></listitem>
348                         
349                         <listitem><para><parameter>x</parameter> - Extract (restore) a local 
350                         tar file back to a share. Unless the -D option is given, the tar 
351                         files will be restored from the top level of the share. Must be 
352                         followed by the name of the tar file, device or "-" for standard 
353                         input. Mutually exclusive with the <parameter>c</parameter> flag. 
354                         Restored files have their creation times (mtime) set to the
355                         date saved in the tar file. Directories currently do not get 
356                         their creation dates restored properly. </para></listitem>
357                         
358                         <listitem><para><parameter>I</parameter> - Include files and directories. 
359                         Is the default behavior when filenames are specified above. Causes 
360                         files to be included in an extract or create (and therefore 
361                         everything else to be excluded). See example below.  Filename globbing 
362                         works  in one of two ways.  See <parameter>r</parameter> below. </para></listitem>
363                         
364                         <listitem><para><parameter>X</parameter> - Exclude files and directories. 
365                         Causes files to be excluded from an extract or create. See 
366                         example below.  Filename globbing works in one of two ways now. 
367                         See <parameter>r</parameter> below. </para></listitem>
368                         
369                         <listitem><para><parameter>F</parameter> - File containing a list of files and directories.
370                         The <parameter>F</parameter> causes the name following the tarfile to
371                         create to be read as a filename that contains a list of files and directories to 
372                         be included in an extract or create (and therefore everything else to be excluded).
373                         See example below. Filename globbing works in one of two ways.
374                         See <parameter>r</parameter> below.
375                         </para></listitem>
376                         
377                         <listitem><para><parameter>b</parameter> - Blocksize. Must be followed 
378                         by a valid (greater than zero) blocksize.  Causes tar file to be 
379                         written out in blocksize*TBLOCK (usually 512 byte) blocks. 
380                         </para></listitem>
381                         
382                         <listitem><para><parameter>g</parameter> - Incremental. Only back up 
383                         files that have the archive bit set. Useful only with the 
384                         <parameter>c</parameter> flag. </para></listitem>
385
386                         <listitem><para><parameter>q</parameter> - Quiet. Keeps tar from printing 
387                         diagnostics as it works.  This is the same as tarmode quiet. 
388                         </para></listitem>
389                         
390                         <listitem><para><parameter>r</parameter> - Regular expression include
391                         or exclude.  Uses regular  expression matching for 
392                         excluding or excluding files if  compiled with HAVE_REGEX_H. 
393                         However this mode can be very slow. If  not compiled with 
394                         HAVE_REGEX_H, does a limited wildcard match on '*' and  '?'. 
395                         </para></listitem>
396                         
397                         <listitem><para><parameter>N</parameter> - Newer than. Must be followed 
398                         by the name of a file whose date is compared against files found 
399                         on the share during a create. Only files newer than the file 
400                         specified are backed up to the tar file. Useful only with the 
401                         <parameter>c</parameter> flag. </para></listitem>
402                         
403                         <listitem><para><parameter>a</parameter> - Set archive bit. Causes the 
404                         archive bit to be reset when a file is backed up. Useful with the 
405                         <parameter>g</parameter> and <parameter>c</parameter> flags. 
406                         </para></listitem>
407                 </itemizedlist>
408                         
409                 <para><emphasis>Tar Long File Names</emphasis></para>
410                         
411                 <para><command>smbclient</command>'s tar option now supports long 
412                 file names both on backup and restore. However, the full path 
413                 name of the file must be less than 1024 bytes.  Also, when
414                 a tar archive is created, <command>smbclient</command>'s tar option places all 
415                 files in the archive with relative names, not absolute names. 
416                 </para>
417
418                 <para><emphasis>Tar Filenames</emphasis></para>
419                         
420                 <para>All file names can be given as DOS path names (with '\\' 
421                 as the component separator) or as UNIX path names (with '/' as 
422                 the component separator). </para>
423                         
424                 <para><emphasis>Examples</emphasis></para>
425                 
426                 <para>Restore from tar file <filename>backup.tar</filename> into myshare on mypc 
427                 (no password on share). </para>
428                 
429                 <para><command>smbclient //mypc/yshare "" -N -Tx backup.tar
430                 </command></para>
431                 
432                 <para>Restore everything except <filename>users/docs</filename>
433                 </para>
434                 
435                 <para><command>smbclient //mypc/myshare "" -N -TXx backup.tar 
436                 users/docs</command></para>
437                 
438                 <para>Create a tar file of the files beneath <filename>
439                 users/docs</filename>. </para>
440                 
441                 <para><command>smbclient //mypc/myshare "" -N -Tc
442                 backup.tar users/docs </command></para>
443                 
444                 <para>Create the same tar file as above, but now use 
445                 a DOS path name. </para>
446                 
447                 <para><command>smbclient //mypc/myshare "" -N -tc backup.tar 
448                 users\edocs </command></para>
449                 
450                 <para>Create a tar file of the files listed in the file <filename>tarlist</filename>.</para>
451                 
452                 <para><command>smbclient //mypc/myshare "" -N -TcF
453                 backup.tar tarlist</command></para>
454                 
455                 <para>Create a tar file of all the files and directories in 
456                 the share. </para>
457                 
458                 <para><command>smbclient //mypc/myshare "" -N -Tc backup.tar *
459                 </command></para>
460                 </listitem>
461                 </varlistentry>
462                 
463                 <varlistentry>
464                 <term>-D|--directory initial directory</term>
465                 <listitem><para>Change to initial directory before starting. Probably 
466                 only of any use with the tar -T option. </para></listitem>
467                 </varlistentry>
468                 
469                 <varlistentry>
470                 <term>-c|--comand command string</term>
471                 <listitem><para>command string is a semicolon-separated list of 
472                 commands to be executed instead of prompting from stdin. <parameter>
473                 -N</parameter> is implied by <parameter>-c</parameter>.</para>
474
475                 <para>This is particularly useful in scripts and for printing stdin 
476                 to the server, e.g. <command>-c 'print -'</command>. </para></listitem>
477                 </varlistentry>
478
479         </variablelist>
480 </refsect1>
481
482
483 <refsect1>
484         <title>OPERATIONS</title>
485
486         <para>Once the client is running, the user is presented with 
487         a prompt : </para>
488
489         <para><prompt>smb:\&gt; </prompt></para>
490
491         <para>The backslash ("\\") indicates the current working directory 
492         on the server, and will change if the current working directory 
493         is changed. </para>
494
495         <para>The prompt indicates that the client is ready and waiting to 
496         carry out a user command. Each command is a single word, optionally 
497         followed by parameters specific to that command. Command and parameters 
498         are space-delimited unless these notes specifically
499         state otherwise. All commands are case-insensitive.  Parameters to 
500         commands may or may not be case sensitive, depending on the command. 
501         </para>
502
503         <para>You can specify file names which have spaces in them by quoting 
504         the name with double quotes, for example "a long file name". </para>
505
506         <para>Parameters shown in square brackets (e.g., "[parameter]") are 
507         optional.  If not given, the command will use suitable defaults. Parameters 
508         shown in angle brackets (e.g., "&lt;parameter&gt;") are required.
509         </para>
510
511
512         <para>Note that all commands operating on the server are actually 
513         performed by issuing a request to the server. Thus the behavior may 
514         vary from server to server, depending on how the server was implemented. 
515         </para>
516
517         <para>The commands available are given here in alphabetical order. </para>
518
519         <variablelist>
520                 <varlistentry>
521                 <term>? [command]</term>
522                 <listitem><para>If <replaceable>command</replaceable> is specified, the ? command will display
523                 a brief informative message about the specified command.  If no
524                 command is specified, a list of available commands will
525                 be displayed. </para></listitem>
526                 </varlistentry>
527
528                 <varlistentry>
529                 <term>! [shell command]</term>
530                 <listitem><para>If <replaceable>shell command</replaceable> is specified, the !
531                 command will execute a shell locally and run the specified shell
532                 command. If no command is specified, a local shell will be run.
533                 </para></listitem>
534                 </varlistentry>
535
536                 <varlistentry>
537                 <term>allinfo file</term>
538                 <listitem><para>The client will request that the server return
539                 all known information about a file or directory (including streams).
540                 </para></listitem>
541                 </varlistentry>
542
543                 <varlistentry>
544                 <term>altname file</term>
545                 <listitem><para>The client will request that the server return
546                 the "alternate" name (the 8.3 name) for a file or directory.
547                 </para></listitem>
548                 </varlistentry>
549
550                 <varlistentry>
551                 <term>archive &lt;number&gt;</term>
552                 <listitem><para>Sets the archive level when operating on files.
553                 0 means ignore the archive bit, 1 means only operate on files with this bit set,
554                 2 means only operate on files with this bit set and reset it after operation,
555                 3 means operate on all files and reset it after operation. The default is 0.
556                 </para></listitem>
557                 </varlistentry>
558
559                 <varlistentry>
560                 <term>blocksize &lt;number&gt;</term>
561                 <listitem><para>Sets the blocksize parameter for a tar operation. The default is 20.
562                 Causes tar file to be written out in blocksize*TBLOCK (normally 512 byte) units.
563                 </para></listitem>
564                 </varlistentry>
565
566                 <varlistentry>
567                 <term>cancel jobid0 [jobid1] ... [jobidN]</term>
568                 <listitem><para>The client will request that the server cancel
569                 the printjobs identified by the given numeric print job ids.
570                 </para></listitem>
571                 </varlistentry>
572
573                 <varlistentry>
574                 <term>case_sensitive</term>
575                 <listitem><para>Toggles the setting of the flag in SMB packets that
576                 tells the server to treat filenames as case sensitive. Set to OFF by
577                 default (tells file server to treat filenames as case insensitive). Only
578                 currently affects Samba 3.0.5 and above file servers with the case sensitive
579                 parameter set to auto in the smb.conf.
580                 </para></listitem>
581                 </varlistentry>
582
583                 <varlistentry>
584                 <term>cd &lt;directory name&gt;</term>
585                 <listitem><para>If "directory name" is specified, the current
586                 working directory on the server will be changed to the directory
587                 specified. This operation will fail if for any reason the specified
588                 directory is inaccessible. </para>
589
590                 <para>If no directory name is specified, the current working
591                 directory on the server will be reported. </para></listitem>
592                 </varlistentry>
593
594                 <varlistentry>
595                 <term>chmod file mode in octal</term>
596                 <listitem><para>This command depends on the server supporting the CIFS
597                 UNIX extensions and will fail if the server does not. The client requests that the server
598                 change the UNIX permissions to the given octal mode, in standard UNIX format.
599                 </para></listitem>
600                 </varlistentry>
601
602                 <varlistentry>
603                 <term>chown file uid gid</term>
604                 <listitem><para>This command depends on the server supporting the CIFS
605                 UNIX extensions and will fail if the server does not. The client requests that the server
606                 change the UNIX user and group ownership to the given decimal values. Note there is
607                 currently no way to remotely look up the UNIX uid and gid values for a given name.
608                 This may be addressed in future versions of the CIFS UNIX extensions.
609                 </para></listitem>
610                 </varlistentry>
611
612                 <varlistentry>
613                 <term>close &lt;fileid&gt;</term>
614                 <listitem><para>Closes a file explicitly opened by the open command. Used for
615                 internal Samba testing purposes.
616                 </para></listitem>
617                 </varlistentry>
618
619                 <varlistentry>
620                 <term>del &lt;mask&gt;</term>
621                 <listitem><para>The client will request that the server attempt
622                 to delete all files matching <replaceable>mask</replaceable> from the current working
623                 directory on the server. </para></listitem>
624                 </varlistentry>
625
626                 <varlistentry>
627                 <term>dir &lt;mask&gt;</term>
628                 <listitem><para>A list of the files matching <replaceable>mask</replaceable> in the current
629                 working directory on the server will be retrieved from the server
630                 and displayed. </para></listitem>
631                 </varlistentry>
632
633                 <varlistentry>
634                 <term>du &lt;filename&gt;</term>
635                 <listitem><para>Does a directory listing and then prints out the current disk useage and free space on a share.
636                 </para></listitem>
637                 </varlistentry>
638
639                 <varlistentry>
640                 <term>echo &lt;number&gt; &lt;data&gt;</term>
641                 <listitem><para>Does an SMBecho request to ping the server. Used for internal Samba testing purposes.
642                 </para></listitem>
643                 </varlistentry>
644
645                 <varlistentry>
646                 <term>exit</term>
647                 <listitem><para>Terminate the connection with the server and exit
648                 from the program. </para></listitem>
649                 </varlistentry>
650
651                 <varlistentry>
652                 <term>get &lt;remote file name&gt; [local file name]</term>
653                 <listitem><para>Copy the file called <filename>remote file name</filename> from
654                 the server to the machine running the client. If specified, name
655                 the local copy <filename>local file name</filename>.  Note that all transfers in
656                 <command>smbclient</command> are binary. See also the
657                 lowercase command. </para></listitem>
658                 </varlistentry>
659
660                 <varlistentry>
661                 <term>getfacl &lt;filename&gt;</term>
662                 <listitem><para>Requires the server support the UNIX extensions. Requests and prints
663                 the POSIX ACL on a file.
664                 </para></listitem>
665                 </varlistentry>
666
667                 <varlistentry>
668                 <term>hardlink &lt;src&gt; &lt;dest&gt;</term>
669                 <listitem><para>Creates a hardlink on the server using Windows CIFS semantics.
670                 </para></listitem>
671                 </varlistentry>
672
673                 <varlistentry>
674                 <term>help [command]</term>
675                 <listitem><para>See the ? command above. </para></listitem>
676                 </varlistentry>
677
678                 <varlistentry>
679                 <term>history</term> <listitem><para>Displays the command history.</para></listitem>
680                 </varlistentry>
681
682                 <varlistentry>
683                 <term>iosize &lt;bytes&gt;</term>
684                 <listitem><para>When sending or receiving files, smbclient uses an
685                 internal memory buffer by default of size 64512 bytes. This command
686                 allows this size to be set to any range between 16384 (0x4000) bytes
687                 and 16776960 (0xFFFF00) bytes. Larger sizes may mean more efficient
688                 data transfer as smbclient will try and use the most efficient
689                 read and write calls for the connected server.
690                 </para></listitem>
691                 </varlistentry>
692
693                 <varlistentry>
694                 <term>lcd [directory name]</term>
695                 <listitem><para>If <replaceable>directory name</replaceable> is specified, the current
696                 working directory on the local machine will be changed to
697                 the directory specified. This operation will fail if for any
698                 reason the specified directory is inaccessible. </para>
699
700                 <para>If no directory name is specified, the name of the
701                 current working directory on the local machine will be reported.
702                 </para></listitem>
703                 </varlistentry>
704
705                 <varlistentry>
706                 <term>link target linkname</term>
707                 <listitem><para>This command depends on the server supporting the CIFS
708                 UNIX extensions and will fail if the server does not. The client requests that the server
709                 create a hard link between the linkname and target files. The linkname file
710                 must not exist.
711                 </para></listitem>
712                 </varlistentry>
713
714                 <varlistentry>
715                 <term>listconnect</term>
716                 <listitem><para>Show the current connections held for DFS purposes.
717                 </para></listitem>
718                 </varlistentry>
719
720                 <varlistentry>
721                 <term>lock &lt;filenum&gt; &lt;r|w&gt; &lt;hex-start&gt; &lt;hex-len&gt;</term>
722                 <listitem><para>This command depends on the server supporting the CIFS
723                 UNIX extensions and will fail if the server does not. Tries to set a POSIX
724                 fcntl lock of the given type on the given range. Used for internal Samba testing purposes.
725                 </para></listitem>
726                 </varlistentry>
727
728                 <varlistentry>
729                 <term>logon &lt;username&gt; &lt;password&gt;</term>
730                 <listitem><para>Establishes a new vuid for this session by logging on again.
731                 Replaces the current vuid. Prints out the new vuid. Used for internal Samba testing purposes.
732                 </para></listitem>
733                 </varlistentry>
734
735                 <varlistentry>
736                 <term>lowercase</term>
737                 <listitem><para>Toggle lowercasing of filenames for the get and
738                 mget commands.          
739                 </para> 
740
741                 <para>When lowercasing is toggled ON, local filenames are converted
742                 to lowercase when using the get and mget commands. This is
743                 often useful when copying (say) MSDOS files from a server, because
744                 lowercase filenames are the norm on UNIX systems. </para></listitem>
745                 </varlistentry>
746
747                 <varlistentry>
748                 <term>ls &lt;mask&gt;</term>
749                 <listitem><para>See the dir command above. </para></listitem>
750                 </varlistentry>
751
752                 <varlistentry>
753                 <term>mask &lt;mask&gt;</term>
754                 <listitem><para>This command allows the user to set up a mask
755                 which will be used during recursive operation of the mget and
756                 mput commands. </para>
757
758                 <para>The masks specified to the mget and mput commands act as
759                 filters for directories rather than files when recursion is
760                 toggled ON. </para>
761
762                 <para>The mask specified with the mask command is necessary
763                 to filter files within those directories. For example, if the
764                 mask specified in an mget command is "source*" and the mask
765                 specified with the mask command is "*.c" and recursion is
766                 toggled ON, the mget command will retrieve all files matching
767                 "*.c" in all directories below and including all directories
768                 matching "source*" in the current working directory. </para>
769
770                 <para>Note that the value for mask defaults to blank (equivalent
771                 to "*") and remains so until the mask command is used to change it.
772                 It retains the most recently specified value indefinitely. To
773                 avoid unexpected results it would be wise to change the value of
774                 mask back to "*" after using the mget or mput commands. </para></listitem>
775                 </varlistentry>
776
777                 <varlistentry>
778                 <term>md &lt;directory name&gt;</term>
779                 <listitem><para>See the mkdir command. </para></listitem>
780                 </varlistentry>
781
782                 <varlistentry>
783                 <term>mget &lt;mask&gt;</term>
784                 <listitem><para>Copy all files matching <replaceable>mask</replaceable> from the server to
785                 the machine running the client. </para>
786
787                 <para>Note that <replaceable>mask</replaceable> is interpreted differently during recursive
788                 operation and non-recursive operation - refer to the recurse and
789                 mask commands for more information. Note that all transfers in
790                 <command>smbclient</command> are binary. See also the lowercase command. </para></listitem>
791                 </varlistentry>
792
793                 <varlistentry>
794                 <term>mkdir &lt;directory name&gt;</term>
795                 <listitem><para>Create a new directory on the server (user access
796                 privileges permitting) with the specified name. </para></listitem>
797                 </varlistentry>
798
799                 <varlistentry>
800                 <term>more &lt;file name&gt;</term>
801                 <listitem><para>Fetch a remote file and view it with the contents
802                 of your PAGER environment variable.
803                 </para></listitem>
804                 </varlistentry>
805
806                 <varlistentry>
807                 <term>mput &lt;mask&gt;</term>
808                 <listitem><para>Copy all files matching <replaceable>mask</replaceable> in the current working
809                 directory on the local machine to the current working directory on
810                 the server. </para>
811
812                 <para>Note that <replaceable>mask</replaceable> is interpreted differently during recursive
813                 operation and non-recursive operation - refer to the recurse and mask
814                 commands for more information. Note that all transfers in <command>smbclient</command>
815                 are binary. </para></listitem>
816                 </varlistentry>
817
818                 <varlistentry>
819                 <term>posix</term>
820                 <listitem><para>Query the remote server to see if it supports the CIFS UNIX
821                 extensions and prints out the list of capabilities supported. If so, turn
822                 on POSIX pathname processing and large file read/writes (if available),.
823                 </para></listitem>
824                 </varlistentry>
825
826                 <varlistentry>
827                 <term>posix_encrypt &lt;domain&gt; &lt;username&gt; &lt;password&gt;</term>
828                 <listitem><para>This command depends on the server supporting the CIFS
829                 UNIX extensions and will fail if the server does not. Attempt to negotiate
830                 SMB encryption on this connection. If smbclient connected with kerberos
831                 credentials (-k) the arguments to this command are ignored and the kerberos
832                 credentials are used to negotiate GSSAPI signing and sealing instead. See
833                 also the -e option to smbclient to force encryption on initial connection.
834                 This command is new with Samba 3.2.
835                 </para></listitem>
836                 </varlistentry>
837
838                 <varlistentry>
839                 <term>posix_open &lt;filename&gt; &lt;octal mode&gt;</term>
840                 <listitem><para>This command depends on the server supporting the CIFS
841                 UNIX extensions and will fail if the server does not. Opens a remote file
842                 using the CIFS UNIX extensions and prints a fileid. Used for internal Samba
843                 testing purposes.
844                 </para></listitem>
845                 </varlistentry>
846
847                 <varlistentry>
848                 <term>posix_mkdir &lt;directoryname&gt; &lt;octal mode&gt;</term>
849                 <listitem><para>This command depends on the server supporting the CIFS
850                 UNIX extensions and will fail if the server does not. Creates a remote directory
851                 using the CIFS UNIX extensions with the given mode.
852                 </para></listitem>
853                 </varlistentry>
854
855                 <varlistentry>
856                 <term>posix_rmdir &lt;directoryname&gt;</term>
857                 <listitem><para>This command depends on the server supporting the CIFS
858                 UNIX extensions and will fail if the server does not. Deletes a remote directory
859                 using the CIFS UNIX extensions.
860                 </para></listitem>
861                 </varlistentry>
862
863                 <varlistentry>
864                 <term>posix_unlink &lt;filename&gt;</term>
865                 <listitem><para>This command depends on the server supporting the CIFS
866                 UNIX extensions and will fail if the server does not. Deletes a remote file
867                 using the CIFS UNIX extensions.
868                 </para></listitem>
869                 </varlistentry>
870
871                 <varlistentry>
872                 <term>print &lt;file name&gt;</term>
873                 <listitem><para>Print the specified file from the local machine
874                 through a printable service on the server. </para></listitem>
875                 </varlistentry>
876
877                 <varlistentry>
878                 <term>prompt</term>
879                 <listitem><para>Toggle prompting for filenames during operation
880                 of the mget and mput commands. </para>
881
882                 <para>When toggled ON, the user will be prompted to confirm
883                 the transfer of each file during these commands. When toggled
884                 OFF, all specified files will be transferred without prompting.
885                 </para></listitem>
886                 </varlistentry>
887
888                 <varlistentry>
889                 <term>put &lt;local file name&gt; [remote file name]</term>
890                 <listitem><para>Copy the file called <filename>local file name</filename> from the
891                 machine running the client to the server. If specified,
892                 name the remote copy <filename>remote file name</filename>. Note that all transfers
893                 in <command>smbclient</command> are binary. See also the lowercase command.
894                 </para></listitem>
895                 </varlistentry>
896
897                 <varlistentry>
898                 <term>queue</term>
899                 <listitem><para>Displays the print queue, showing the job id,
900                 name, size and current status. </para></listitem>
901                 </varlistentry>
902
903                 <varlistentry>
904                 <term>quit</term>
905                 <listitem><para>See the exit command. </para></listitem>
906                 </varlistentry>
907
908                 <varlistentry>
909                 <term>readlink symlinkname</term>
910                 <listitem><para>This command depends on the server supporting the CIFS
911                 UNIX extensions and will fail if the server does not. Print
912                 the value of the symlink "symlinkname".
913                 </para></listitem>
914                 </varlistentry>
915
916                 <varlistentry>
917                 <term>rd &lt;directory name&gt;</term>
918                 <listitem><para>See the rmdir command. </para></listitem>
919                 </varlistentry>
920
921                 <varlistentry>
922                 <term>recurse</term>
923                 <listitem><para>Toggle directory recursion for the commands mget
924                 and mput. </para>
925
926                 <para>When toggled ON, these commands will process all directories
927                 in the source directory (i.e., the directory they are copying
928                 from ) and will recurse into any that match the mask specified
929                 to the command. Only files that match the mask specified using
930                 the mask command will be retrieved. See also the mask command.
931                 </para>
932
933                 <para>When recursion is toggled OFF, only files from the current
934                 working directory on the source machine that match the mask specified
935                 to the mget or mput commands will be copied, and any mask specified
936                 using the mask command will be ignored. </para></listitem>
937                 </varlistentry>
938
939                 <varlistentry>
940                 <term>rename &lt;old filename&gt; &lt;new filename&gt;</term>
941                 <listitem><para>Rename files in the current working directory on the
942                 server from <replaceable>old filename</replaceable> to
943                 <replaceable>new filename</replaceable>. </para></listitem>
944                 </varlistentry>
945
946                 <varlistentry>
947                 <term>rm &lt;mask&gt;</term>
948                 <listitem><para>Remove all files matching <replaceable>mask</replaceable> from the current
949                 working directory on the server. </para></listitem>
950                 </varlistentry>
951
952                 <varlistentry>
953                 <term>rmdir &lt;directory name&gt;</term>
954                 <listitem><para>Remove the specified directory (user access
955                 privileges permitting) from the server. </para></listitem>
956                 </varlistentry>
957
958                 <varlistentry>
959                 <term>setmode &lt;filename&gt; &lt;perm=[+|\-]rsha&gt;</term>
960                 <listitem><para>A version of the DOS attrib command to set
961                 file permissions. For example: </para>
962
963                 <para><command>setmode myfile +r </command></para>
964
965                 <para>would make myfile read only. </para></listitem>
966                 </varlistentry>
967
968                 <varlistentry>
969                 <term>showconnect</term>
970                 <listitem><para>Show the currently active connection held for DFS purposes.
971                 </para></listitem>
972                 </varlistentry>
973
974                 <varlistentry>
975                 <term>stat file</term>
976                 <listitem><para>This command depends on the server supporting the CIFS
977                 UNIX extensions and will fail if the server does not. The client requests the
978                 UNIX basic info level and prints out the same info that the Linux stat command
979                 would about the file. This includes the size, blocks used on disk, file type,
980                 permissions, inode number, number of links and finally the three timestamps
981                 (access, modify and change). If the file is a special file (symlink, character or
982                 block device, fifo or socket) then extra information may also be printed.
983                 </para></listitem>
984                 </varlistentry>
985
986                 <varlistentry>
987                 <term>symlink target linkname</term>
988                 <listitem><para>This command depends on the server supporting the CIFS
989                 UNIX extensions and will fail if the server does not. The client requests that the server
990                 create a symbolic hard link between the target and linkname files. The linkname file
991                 must not exist. Note that the server will not create a link to any path that lies
992                 outside the currently connected share. This is enforced by the Samba server.
993                 </para></listitem>
994                 </varlistentry>
995
996                 <varlistentry>
997                 <term>tar &lt;c|x&gt;[IXbgNa]</term>
998                 <listitem><para>Performs a tar operation - see the <parameter>-T
999                 </parameter> command line option above. Behavior may be affected
1000                 by the tarmode command (see below). Using g (incremental) and N
1001                 (newer) will affect tarmode settings. Note that using the "-" option
1002                 with tar x may not work - use the command line option instead.
1003                 </para></listitem>
1004                 </varlistentry>
1005
1006                 <varlistentry>
1007                 <term>blocksize &lt;blocksize&gt;</term>
1008                 <listitem><para>Blocksize. Must be followed by a valid (greater
1009                 than zero) blocksize. Causes tar file to be written out in
1010                 <replaceable>blocksize</replaceable>*TBLOCK (usually 512 byte) blocks. </para></listitem>
1011                 </varlistentry>
1012
1013                 <varlistentry>
1014                 <term>tarmode &lt;full|inc|reset|noreset&gt;</term>
1015                 <listitem><para>Changes tar's behavior with regard to archive
1016                 bits. In full mode, tar will back up everything regardless of the
1017                 archive bit setting (this is the default mode). In incremental mode,
1018                 tar will only back up files with the archive bit set. In reset mode,
1019                 tar will reset the archive bit on all files it backs up (implies
1020                 read/write share). </para></listitem>
1021                 </varlistentry>
1022
1023                 <varlistentry>
1024                 <term>unlock &lt;filenum&gt; &lt;hex-start&gt; &lt;hex-len&gt;</term>
1025                 <listitem><para>This command depends on the server supporting the CIFS
1026                 UNIX extensions and will fail if the server does not. Tries to unlock a POSIX
1027                 fcntl lock on the given range. Used for internal Samba testing purposes.
1028                 </para></listitem>
1029                 </varlistentry>
1030
1031                 <varlistentry>
1032                 <term>volume</term>
1033                 <listitem><para>Prints the current volume name of the share.
1034                 </para></listitem>
1035                 </varlistentry>
1036
1037                 <varlistentry>
1038                 <term>vuid &lt;number&gt;</term>
1039                 <listitem><para>Changes the currently used vuid in the protocol to
1040                 the given arbitrary number. Without an argument prints out the current
1041                 vuid being used. Used for internal Samba testing purposes.
1042                 </para></listitem>
1043                 </varlistentry>
1044
1045         </variablelist>
1046 </refsect1>
1047
1048 <refsect1>
1049         <title>NOTES</title>
1050
1051         <para>Some servers are fussy about the case of supplied usernames,
1052         passwords, share names (AKA service names) and machine names.
1053         If you fail to connect try giving all parameters in uppercase.
1054         </para>
1055
1056         <para>It is often necessary to use the -n option when connecting
1057         to some types of servers. For example OS/2 LanManager insists
1058         on a valid NetBIOS name being used, so you need to supply a valid
1059         name that would be known to the server.</para>
1060
1061         <para>smbclient supports long file names where the server 
1062         supports the LANMAN2 protocol or above. </para>
1063 </refsect1>
1064
1065 <refsect1>
1066         <title>ENVIRONMENT VARIABLES</title>
1067
1068         <para>The variable <envar>USER</envar> may contain the 
1069         username of the person  using the client. This information is 
1070         used only if the protocol  level is high enough to support 
1071         session-level passwords.</para>
1072
1073
1074         <para>The variable <envar>PASSWD</envar> may contain 
1075         the password of the person using the client.  This information is 
1076         used only if the protocol level is high enough to support 
1077         session-level passwords. </para>
1078
1079         <para>The variable <envar>LIBSMB_PROG</envar> may contain 
1080         the path, executed with system(), which the client should connect 
1081         to instead of connecting to a server.  This functionality is primarily
1082         intended as a development aid, and works best when using a LMHOSTS 
1083         file</para>
1084 </refsect1>
1085
1086
1087 <refsect1>
1088         <title>INSTALLATION</title>
1089
1090         <para>The location of the client program is a matter for 
1091         individual system administrators. The following are thus
1092         suggestions only. </para>
1093
1094         <para>It is recommended that the smbclient software be installed
1095         in the <filename>/usr/local/samba/bin/</filename> or <filename>
1096         /usr/samba/bin/</filename> directory, this directory readable 
1097         by all, writeable only by root. The client program itself should 
1098         be executable by all. The client should <emphasis>NOT</emphasis> be 
1099         setuid or setgid! </para>
1100
1101         <para>The client log files should be put in a directory readable 
1102         and writeable only by the user. </para>
1103
1104         <para>To test the client, you will need to know the name of a 
1105         running SMB/CIFS server. It is possible to run <citerefentry><refentrytitle>smbd</refentrytitle>
1106         <manvolnum>8</manvolnum></citerefentry> as an ordinary user - running that server as a daemon 
1107         on a user-accessible port (typically any port number over 1024)
1108         would provide a suitable test server. </para>
1109 </refsect1>
1110
1111
1112 <refsect1>
1113         <title>DIAGNOSTICS</title>
1114
1115         <para>Most diagnostics issued by the client are logged in a 
1116         specified log file. The log file name is specified at compile time, 
1117         but may be overridden on the command line. </para>
1118
1119         <para>The number and nature of diagnostics available depends 
1120         on the debug level used by the client. If you have problems, 
1121         set the debug level to 3 and peruse the log files. </para>
1122 </refsect1>
1123
1124
1125 <refsect1>
1126         <title>VERSION</title>
1127
1128         <para>This man page is correct for version 3.2 of the Samba suite.</para>
1129 </refsect1>
1130
1131
1132 <refsect1>
1133         <title>AUTHOR</title>
1134         
1135         <para>The original Samba software and related utilities 
1136         were created by Andrew Tridgell. Samba is now developed
1137         by the Samba Team as an Open Source project similar 
1138         to the way the Linux kernel is developed.</para>
1139         
1140         <para>The original Samba man pages were written by Karl Auer. 
1141         The man page sources were converted to YODL format (another 
1142         excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
1143         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 
1144         release by Jeremy Allison.  The conversion to DocBook for 
1145         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0
1146         was done by Alexander Bokovoy.</para>
1147 </refsect1>
1148
1149 </refentry>