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