docs-xml/manpages/smbclient.1.xml

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