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