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