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">4.1</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                 NT1, which is the highest available SMB1 protocol.
 265                 To connect using SMB2 or SMB3 protocol, use the
 266                 strings SMB2 or SMB3 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 file on UNIX.
 365                         Must be followed by the name of a tar file, tape device
 366                         or "-" for standard output. If using standard output you must
 367                         turn the log level to its lowest value -d0 to avoid corrupting
 368                         your tar file. This flag is mutually exclusive with the
 369                         <parameter>x</parameter> flag. </para></listitem>
 370
 371                         <listitem><para><parameter>x</parameter> - Extract (restore) a local
 372                         tar file back to a share. Unless the -D option is given, the tar
 373                         files will be restored from the top level of the share. Must be
 374                         followed by the name of the tar file, device or "-" for standard
 375                         input. Mutually exclusive with the <parameter>c</parameter> flag.
 376                         Restored files have their creation times (mtime) set to the
 377                         date saved in the tar file. Directories currently do not get
 378                         their creation dates restored properly. </para></listitem>
 379
 380                         <listitem><para><parameter>I</parameter> - Include files and directories.
 381                         Is the default behavior when filenames are specified above. Causes
 382                         files to be included in an extract or create (and therefore
 383                         everything else to be excluded). See example below.  Filename globbing
 384                         works  in one of two ways.  See <parameter>r</parameter> below. </para></listitem>
 385
 386                         <listitem><para><parameter>X</parameter> - Exclude files and directories.
 387                         Causes files to be excluded from an extract or create. See
 388                         example below.  Filename globbing works in one of two ways now.
 389                         See <parameter>r</parameter> below. </para></listitem>
 390
 391                         <listitem><para><parameter>F</parameter> - File containing a list of files and directories.
 392                         The <parameter>F</parameter> causes the name following the tarfile to
 393                         create to be read as a filename that contains a list of files and directories to
 394                         be included in an extract or create (and therefore everything else to be excluded).
 395                         See example below. Filename globbing works in one of two ways.
 396                         See <parameter>r</parameter> below.
 397                         </para></listitem>
 398
 399                         <listitem><para><parameter>b</parameter> - Blocksize. Must be followed
 400                         by a valid (greater than zero) blocksize.  Causes tar file to be
 401                         written out in blocksize*TBLOCK (usually 512 byte) blocks.
 402                         </para></listitem>
 403
 404                         <listitem><para><parameter>g</parameter> - Incremental. Only back up
 405                         files that have the archive bit set. Useful only with the
 406                         <parameter>c</parameter> flag. </para></listitem>
 407
 408                         <listitem><para><parameter>q</parameter> - Quiet. Keeps tar from printing
 409                         diagnostics as it works.  This is the same as tarmode quiet.
 410                         </para></listitem>
 411
 412                         <listitem><para><parameter>r</parameter> - Regular expression include
 413                         or exclude.  Uses regular  expression matching for
 414                         excluding or excluding files if  compiled with HAVE_REGEX_H.
 415                         However this mode can be very slow. If  not compiled with
 416                         HAVE_REGEX_H, does a limited wildcard match on '*' and  '?'.
 417                         </para></listitem>
 418
 419                         <listitem><para><parameter>N</parameter> - Newer than. Must be followed
 420                         by the name of a file whose date is compared against files found
 421                         on the share during a create. Only files newer than the file
 422                         specified are backed up to the tar file. Useful only with the
 423                         <parameter>c</parameter> flag. </para></listitem>
 424
 425                         <listitem><para><parameter>a</parameter> - Set archive bit. Causes the
 426                         archive bit to be reset when a file is backed up. Useful with the
 427                         <parameter>g</parameter> and <parameter>c</parameter> flags.
 428                         </para></listitem>
 429                 </itemizedlist>
 430
 431                 <para><emphasis>Tar Long File Names</emphasis></para>
 432
 433                 <para><command>smbclient</command>'s tar option now supports long
 434                 file names both on backup and restore. However, the full path
 435                 name of the file must be less than 1024 bytes.  Also, when
 436                 a tar archive is created, <command>smbclient</command>'s tar option places all
 437                 files in the archive with relative names, not absolute names.
 438                 </para>
 439
 440                 <para><emphasis>Tar Filenames</emphasis></para>
 441
 442                 <para>All file names can be given as DOS path names (with '\\'
 443                 as the component separator) or as UNIX path names (with '/' as
 444                 the component separator). </para>
 445
 446                 <para><emphasis>Examples</emphasis></para>
 447
 448                 <para>Restore from tar file <filename>backup.tar</filename> into myshare on mypc
 449                 (no password on share). </para>
 450
 451                 <para><command>smbclient //mypc/myshare "" -N -Tx backup.tar
 452                 </command></para>
 453
 454                 <para>Restore everything except <filename>users/docs</filename>
 455                 </para>
 456
 457                 <para><command>smbclient //mypc/myshare "" -N -TXx backup.tar
 458                 users/docs</command></para>
 459
 460                 <para>Create a tar file of the files beneath <filename>
 461                 users/docs</filename>. </para>
 462
 463                 <para><command>smbclient //mypc/myshare "" -N -Tc
 464                 backup.tar users/docs </command></para>
 465
 466                 <para>Create the same tar file as above, but now use
 467                 a DOS path name. </para>
 468
 469                 <para><command>smbclient //mypc/myshare "" -N -Tc backup.tar
 470                 users\edocs </command></para>
 471
 472                 <para>Create a tar file of the files listed in the file <filename>tarlist</filename>.</para>
 473
 474                 <para><command>smbclient //mypc/myshare "" -N -TcF
 475                 backup.tar tarlist</command></para>
 476
 477                 <para>Create a tar file of all the files and directories in
 478                 the share. </para>
 479
 480                 <para><command>smbclient //mypc/myshare "" -N -Tc backup.tar *
 481                 </command></para>
 482                 </listitem>
 483                 </varlistentry>
 484
 485                 <varlistentry>
 486                 <term>-D|--directory initial directory</term>
 487                 <listitem><para>Change to initial directory before starting. Probably
 488                 only of any use with the tar -T option. </para></listitem>
 489                 </varlistentry>
 490
 491                 <varlistentry>
 492                 <term>-c|--command command string</term>
 493                 <listitem><para>command string is a semicolon-separated list of
 494                 commands to be executed instead of prompting from stdin. <parameter>
 495                 -N</parameter> is implied by <parameter>-c</parameter>.</para>
 496
 497                 <para>This is particularly useful in scripts and for printing stdin
 498                 to the server, e.g. <command>-c 'print -'</command>. </para></listitem>
 499                 </varlistentry>
 500
 501         </variablelist>
 502 </refsect1>
 503
 504
 505 <refsect1>
 506         <title>OPERATIONS</title>
 507
 508         <para>Once the client is running, the user is presented with
 509         a prompt : </para>
 510
 511         <para><prompt>smb:\&gt; </prompt></para>
 512
 513         <para>The backslash ("\\") indicates the current working directory
 514         on the server, and will change if the current working directory
 515         is changed. </para>
 516
 517         <para>The prompt indicates that the client is ready and waiting to
 518         carry out a user command. Each command is a single word, optionally
 519         followed by parameters specific to that command. Command and parameters
 520         are space-delimited unless these notes specifically
 521         state otherwise. All commands are case-insensitive.  Parameters to
 522         commands may or may not be case sensitive, depending on the command.
 523         </para>
 524
 525         <para>You can specify file names which have spaces in them by quoting
 526         the name with double quotes, for example "a long file name". </para>
 527
 528         <para>Parameters shown in square brackets (e.g., "[parameter]") are
 529         optional.  If not given, the command will use suitable defaults. Parameters
 530         shown in angle brackets (e.g., "&lt;parameter&gt;") are required.
 531         </para>
 532
 533
 534         <para>Note that all commands operating on the server are actually
 535         performed by issuing a request to the server. Thus the behavior may
 536         vary from server to server, depending on how the server was implemented.
 537         </para>
 538
 539         <para>The commands available are given here in alphabetical order. </para>
 540
 541         <variablelist>
 542                 <varlistentry>
 543                 <term>? [command]</term>
 544                 <listitem><para>If <replaceable>command</replaceable> is specified, the ? command will display
 545                 a brief informative message about the specified command.  If no
 546                 command is specified, a list of available commands will
 547                 be displayed. </para></listitem>
 548                 </varlistentry>
 549
 550                 <varlistentry>
 551                 <term>! [shell command]</term>
 552                 <listitem><para>If <replaceable>shell command</replaceable> is specified, the !
 553                 command will execute a shell locally and run the specified shell
 554                 command. If no command is specified, a local shell will be run.
 555                 </para></listitem>
 556                 </varlistentry>
 557
 558                 <varlistentry>
 559                 <term>allinfo file</term>
 560                 <listitem><para>The client will request that the server return
 561                 all known information about a file or directory (including streams).
 562                 </para></listitem>
 563                 </varlistentry>
 564
 565                 <varlistentry>
 566                 <term>altname file</term>
 567                 <listitem><para>The client will request that the server return
 568                 the "alternate" name (the 8.3 name) for a file or directory.
 569                 </para></listitem>
 570                 </varlistentry>
 571
 572                 <varlistentry>
 573                 <term>archive &lt;number&gt;</term>
 574                 <listitem><para>Sets the archive level when operating on files.
 575                 0 means ignore the archive bit, 1 means only operate on files with this bit set,
 576                 2 means only operate on files with this bit set and reset it after operation,
 577                 3 means operate on all files and reset it after operation. The default is 0.
 578                 </para></listitem>
 579                 </varlistentry>
 580
 581                 <varlistentry>
 582                 <term>backup</term>
 583                 <listitem><para>Toggle the state of the "backup intent" flag
 584                 sent to the server on directory listings and file opens. If
 585                 the "backup intent" flag is true, the server will try and
 586                 bypass some file system checks if the user has been granted
 587                 SE_BACKUP or SE_RESTORE privileges. This state is useful when
 588                 performing a backup or restore operation.
 589                 </para></listitem>
 590                 </varlistentry>
 591
 592                 <varlistentry>
 593                 <term>blocksize &lt;number&gt;</term>
 594                 <listitem><para>Sets the blocksize parameter for a tar operation. The default is 20.
 595                 Causes tar file to be written out in blocksize*TBLOCK (normally 512 byte) units.
 596                 </para></listitem>
 597                 </varlistentry>
 598
 599                 <varlistentry>
 600                 <term>cancel jobid0 [jobid1] ... [jobidN]</term>
 601                 <listitem><para>The client will request that the server cancel
 602                 the printjobs identified by the given numeric print job ids.
 603                 </para></listitem>
 604                 </varlistentry>
 605
 606                 <varlistentry>
 607                 <term>case_sensitive</term>
 608                 <listitem><para>Toggles the setting of the flag in SMB packets that
 609                 tells the server to treat filenames as case sensitive. Set to OFF by
 610                 default (tells file server to treat filenames as case insensitive). Only
 611                 currently affects Samba 3.0.5 and above file servers with the case sensitive
 612                 parameter set to auto in the smb.conf.
 613                 </para></listitem>
 614                 </varlistentry>
 615
 616                 <varlistentry>
 617                 <term>cd &lt;directory name&gt;</term>
 618                 <listitem><para>If "directory name" is specified, the current
 619                 working directory on the server will be changed to the directory
 620                 specified. This operation will fail if for any reason the specified
 621                 directory is inaccessible. </para>
 622
 623                 <para>If no directory name is specified, the current working
 624                 directory on the server will be reported. </para></listitem>
 625                 </varlistentry>
 626
 627                 <varlistentry>
 628                 <term>chmod file mode in octal</term>
 629                 <listitem><para>This command depends on the server supporting the CIFS
 630                 UNIX extensions and will fail if the server does not. The client requests that the server
 631                 change the UNIX permissions to the given octal mode, in standard UNIX format.
 632                 </para></listitem>
 633                 </varlistentry>
 634
 635                 <varlistentry>
 636                 <term>chown file uid gid</term>
 637                 <listitem><para>This command depends on the server supporting the CIFS
 638                 UNIX extensions and will fail if the server does not. The client requests that the server
 639                 change the UNIX user and group ownership to the given decimal values. Note there is
 640                 currently no way to remotely look up the UNIX uid and gid values for a given name.
 641                 This may be addressed in future versions of the CIFS UNIX extensions.
 642                 </para></listitem>
 643                 </varlistentry>
 644
 645                 <varlistentry>
 646                 <term>close &lt;fileid&gt;</term>
 647                 <listitem><para>Closes a file explicitly opened by the open command. Used for
 648                 internal Samba testing purposes.
 649                 </para></listitem>
 650                 </varlistentry>
 651
 652                 <varlistentry>
 653                 <term>del &lt;mask&gt;</term>
 654                 <listitem><para>The client will request that the server attempt
 655                 to delete all files matching <replaceable>mask</replaceable> from the current working
 656                 directory on the server. </para></listitem>
 657                 </varlistentry>
 658
 659                 <varlistentry>
 660                 <term>dir &lt;mask&gt;</term>
 661                 <listitem><para>A list of the files matching <replaceable>mask</replaceable> in the current
 662                 working directory on the server will be retrieved from the server
 663                 and displayed. </para></listitem>
 664                 </varlistentry>
 665
 666                 <varlistentry>
 667                 <term>du &lt;filename&gt;</term>
 668                 <listitem><para>Does a directory listing and then prints out the current disk usage and free space on a share.
 669                 </para></listitem>
 670                 </varlistentry>
 671
 672                 <varlistentry>
 673                 <term>echo &lt;number&gt; &lt;data&gt;</term>
 674                 <listitem><para>Does an SMBecho request to ping the server. Used for internal Samba testing purposes.
 675                 </para></listitem>
 676                 </varlistentry>
 677
 678                 <varlistentry>
 679                 <term>exit</term>
 680                 <listitem><para>Terminate the connection with the server and exit
 681                 from the program. </para></listitem>
 682                 </varlistentry>
 683
 684                 <varlistentry>
 685                 <term>get &lt;remote file name&gt; [local file name]</term>
 686                 <listitem><para>Copy the file called <filename>remote file name</filename> from
 687                 the server to the machine running the client. If specified, name
 688                 the local copy <filename>local file name</filename>.  Note that all transfers in
 689                 <command>smbclient</command> are binary. See also the
 690                 lowercase command. </para></listitem>
 691                 </varlistentry>
 692
 693                 <varlistentry>
 694                 <term>getfacl &lt;filename&gt;</term>
 695                 <listitem><para>Requires the server support the UNIX extensions. Requests and prints
 696                 the POSIX ACL on a file.
 697                 </para></listitem>
 698                 </varlistentry>
 699
 700                 <varlistentry>
 701                 <term>hardlink &lt;src&gt; &lt;dest&gt;</term>
 702                 <listitem><para>Creates a hardlink on the server using Windows CIFS semantics.
 703                 </para></listitem>
 704                 </varlistentry>
 705
 706                 <varlistentry>
 707                 <term>help [command]</term>
 708                 <listitem><para>See the ? command above. </para></listitem>
 709                 </varlistentry>
 710
 711                 <varlistentry>
 712                 <term>history</term> <listitem><para>Displays the command history.</para></listitem>
 713                 </varlistentry>
 714
 715                 <varlistentry>
 716                 <term>iosize &lt;bytes&gt;</term>
 717                 <listitem><para>
 718                 When sending or receiving files, smbclient uses an
 719                 internal buffer sized by the maximum number of allowed requests
 720                 to the connected server. This command allows this size to be set to any
 721                 range between 0 (which means use the default server controlled size) bytes
 722                 and 16776960 (0xFFFF00) bytes. Using the server controlled size is the
 723                 most efficient as smbclient will pipeline as many simultaneous reads or
 724                 writes needed to keep the server as busy as possible. Setting this to
 725                 any other size will slow down the transfer.
 726                 </para></listitem>
 727                 </varlistentry>
 728
 729                 <varlistentry>
 730                 <term>lcd [directory name]</term>
 731                 <listitem><para>If <replaceable>directory name</replaceable> is specified, the current
 732                 working directory on the local machine will be changed to
 733                 the directory specified. This operation will fail if for any
 734                 reason the specified directory is inaccessible. </para>
 735
 736                 <para>If no directory name is specified, the name of the
 737                 current working directory on the local machine will be reported.
 738                 </para></listitem>
 739                 </varlistentry>
 740
 741                 <varlistentry>
 742                 <term>link target linkname</term>
 743                 <listitem><para>This command depends on the server supporting the CIFS
 744                 UNIX extensions and will fail if the server does not. The client requests that the server
 745                 create a hard link between the linkname and target files. The linkname file
 746                 must not exist.
 747                 </para></listitem>
 748                 </varlistentry>
 749
 750                 <varlistentry>
 751                 <term>listconnect</term>
 752                 <listitem><para>Show the current connections held for DFS purposes.
 753                 </para></listitem>
 754                 </varlistentry>
 755
 756                 <varlistentry>
 757                 <term>lock &lt;filenum&gt; &lt;r|w&gt; &lt;hex-start&gt; &lt;hex-len&gt;</term>
 758                 <listitem><para>This command depends on the server supporting the CIFS
 759                 UNIX extensions and will fail if the server does not. Tries to set a POSIX
 760                 fcntl lock of the given type on the given range. Used for internal Samba testing purposes.
 761                 </para></listitem>
 762                 </varlistentry>
 763
 764                 <varlistentry>
 765                 <term>logon &lt;username&gt; &lt;password&gt;</term>
 766                 <listitem><para>Establishes a new vuid for this session by logging on again.
 767                 Replaces the current vuid. Prints out the new vuid. Used for internal Samba testing purposes.
 768                 </para></listitem>
 769                 </varlistentry>
 770
 771                 <varlistentry>
 772                 <term>logoff</term>
 773                 <listitem><para>Logs the user off the server, closing the session.
 774                 Used for internal Samba testing purposes.
 775                 </para></listitem>
 776                 </varlistentry>
 777
 778                 <varlistentry>
 779                 <term>lowercase</term>
 780                 <listitem><para>Toggle lowercasing of filenames for the get and
 781                 mget commands.
 782                 </para>
 783
 784                 <para>When lowercasing is toggled ON, local filenames are converted
 785                 to lowercase when using the get and mget commands. This is
 786                 often useful when copying (say) MSDOS files from a server, because
 787                 lowercase filenames are the norm on UNIX systems. </para></listitem>
 788                 </varlistentry>
 789
 790                 <varlistentry>
 791                 <term>ls &lt;mask&gt;</term>
 792                 <listitem><para>See the dir command above. </para></listitem>
 793                 </varlistentry>
 794
 795                 <varlistentry>
 796                 <term>mask &lt;mask&gt;</term>
 797                 <listitem><para>This command allows the user to set up a mask
 798                 which will be used during recursive operation of the mget and
 799                 mput commands. </para>
 800
 801                 <para>The masks specified to the mget and mput commands act as
 802                 filters for directories rather than files when recursion is
 803                 toggled ON. </para>
 804
 805                 <para>The mask specified with the mask command is necessary
 806                 to filter files within those directories. For example, if the
 807                 mask specified in an mget command is "source*" and the mask
 808                 specified with the mask command is "*.c" and recursion is
 809                 toggled ON, the mget command will retrieve all files matching
 810                 "*.c" in all directories below and including all directories
 811                 matching "source*" in the current working directory. </para>
 812
 813                 <para>Note that the value for mask defaults to blank (equivalent
 814                 to "*") and remains so until the mask command is used to change it.
 815                 It retains the most recently specified value indefinitely. To
 816                 avoid unexpected results it would be wise to change the value of
 817                 mask back to "*" after using the mget or mput commands. </para></listitem>
 818                 </varlistentry>
 819
 820                 <varlistentry>
 821                 <term>md &lt;directory name&gt;</term>
 822                 <listitem><para>See the mkdir command. </para></listitem>
 823                 </varlistentry>
 824
 825                 <varlistentry>
 826                 <term>mget &lt;mask&gt;</term>
 827                 <listitem><para>Copy all files matching <replaceable>mask</replaceable> from the server to
 828                 the machine running the client. </para>
 829
 830                 <para>Note that <replaceable>mask</replaceable> is interpreted differently during recursive
 831                 operation and non-recursive operation - refer to the recurse and
 832                 mask commands for more information. Note that all transfers in
 833                 <command>smbclient</command> are binary. See also the lowercase command. </para></listitem>
 834                 </varlistentry>
 835
 836                 <varlistentry>
 837                 <term>mkdir &lt;directory name&gt;</term>
 838                 <listitem><para>Create a new directory on the server (user access
 839                 privileges permitting) with the specified name. </para></listitem>
 840                 </varlistentry>
 841
 842                 <varlistentry>
 843                 <term>more &lt;file name&gt;</term>
 844                 <listitem><para>Fetch a remote file and view it with the contents
 845                 of your PAGER environment variable.
 846                 </para></listitem>
 847                 </varlistentry>
 848
 849                 <varlistentry>
 850                 <term>mput &lt;mask&gt;</term>
 851                 <listitem><para>Copy all files matching <replaceable>mask</replaceable> in the current working
 852                 directory on the local machine to the current working directory on
 853                 the server. </para>
 854
 855                 <para>Note that <replaceable>mask</replaceable> is interpreted differently during recursive
 856                 operation and non-recursive operation - refer to the recurse and mask
 857                 commands for more information. Note that all transfers in <command>smbclient</command>
 858                 are binary. </para></listitem>
 859                 </varlistentry>
 860
 861                 <varlistentry>
 862                 <term>posix</term>
 863                 <listitem><para>Query the remote server to see if it supports the CIFS UNIX
 864                 extensions and prints out the list of capabilities supported. If so, turn
 865                 on POSIX pathname processing and large file read/writes (if available),.
 866                 </para></listitem>
 867                 </varlistentry>
 868
 869                 <varlistentry>
 870                 <term>posix_encrypt &lt;domain&gt; &lt;username&gt; &lt;password&gt;</term>
 871                 <listitem><para>This command depends on the server supporting the CIFS
 872                 UNIX extensions and will fail if the server does not. Attempt to negotiate
 873                 SMB encryption on this connection. If smbclient connected with kerberos
 874                 credentials (-k) the arguments to this command are ignored and the kerberos
 875                 credentials are used to negotiate GSSAPI signing and sealing instead. See
 876                 also the -e option to smbclient to force encryption on initial connection.
 877                 This command is new with Samba 3.2.
 878                 </para></listitem>
 879                 </varlistentry>
 880
 881                 <varlistentry>
 882                 <term>posix_open &lt;filename&gt; &lt;octal mode&gt;</term>
 883                 <listitem><para>This command depends on the server supporting the CIFS
 884                 UNIX extensions and will fail if the server does not. Opens a remote file
 885                 using the CIFS UNIX extensions and prints a fileid. Used for internal Samba
 886                 testing purposes.
 887                 </para></listitem>
 888                 </varlistentry>
 889
 890                 <varlistentry>
 891                 <term>posix_mkdir &lt;directoryname&gt; &lt;octal mode&gt;</term>
 892                 <listitem><para>This command depends on the server supporting the CIFS
 893                 UNIX extensions and will fail if the server does not. Creates a remote directory
 894                 using the CIFS UNIX extensions with the given mode.
 895                 </para></listitem>
 896                 </varlistentry>
 897
 898                 <varlistentry>
 899                 <term>posix_rmdir &lt;directoryname&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. Deletes a remote directory
 902                 using the CIFS UNIX extensions.
 903                 </para></listitem>
 904                 </varlistentry>
 905
 906                 <varlistentry>
 907                 <term>posix_unlink &lt;filename&gt;</term>
 908                 <listitem><para>This command depends on the server supporting the CIFS
 909                 UNIX extensions and will fail if the server does not. Deletes a remote file
 910                 using the CIFS UNIX extensions.
 911                 </para></listitem>
 912                 </varlistentry>
 913
 914                 <varlistentry>
 915                 <term>print &lt;file name&gt;</term>
 916                 <listitem><para>Print the specified file from the local machine
 917                 through a printable service on the server. </para></listitem>
 918                 </varlistentry>
 919
 920                 <varlistentry>
 921                 <term>prompt</term>
 922                 <listitem><para>Toggle prompting for filenames during operation
 923                 of the mget and mput commands. </para>
 924
 925                 <para>When toggled ON, the user will be prompted to confirm
 926                 the transfer of each file during these commands. When toggled
 927                 OFF, all specified files will be transferred without prompting.
 928                 </para></listitem>
 929                 </varlistentry>
 930
 931                 <varlistentry>
 932                 <term>put &lt;local file name&gt; [remote file name]</term>
 933                 <listitem><para>Copy the file called <filename>local file name</filename> from the
 934                 machine running the client to the server. If specified,
 935                 name the remote copy <filename>remote file name</filename>. Note that all transfers
 936                 in <command>smbclient</command> are binary. See also the lowercase command.
 937                 </para></listitem>
 938                 </varlistentry>
 939
 940                 <varlistentry>
 941                 <term>queue</term>
 942                 <listitem><para>Displays the print queue, showing the job id,
 943                 name, size and current status. </para></listitem>
 944                 </varlistentry>
 945
 946                 <varlistentry>
 947                 <term>quit</term>
 948                 <listitem><para>See the exit command. </para></listitem>
 949                 </varlistentry>
 950
 951                 <varlistentry>
 952                 <term>readlink symlinkname</term>
 953                 <listitem><para>This command depends on the server supporting the CIFS
 954                 UNIX extensions and will fail if the server does not. Print
 955                 the value of the symlink "symlinkname".
 956                 </para></listitem>
 957                 </varlistentry>
 958
 959                 <varlistentry>
 960                 <term>rd &lt;directory name&gt;</term>
 961                 <listitem><para>See the rmdir command. </para></listitem>
 962                 </varlistentry>
 963
 964                 <varlistentry>
 965                 <term>recurse</term>
 966                 <listitem><para>Toggle directory recursion for the commands mget
 967                 and mput. </para>
 968
 969                 <para>When toggled ON, these commands will process all directories
 970                 in the source directory (i.e., the directory they are copying
 971                 from ) and will recurse into any that match the mask specified
 972                 to the command. Only files that match the mask specified using
 973                 the mask command will be retrieved. See also the mask command.
 974                 </para>
 975
 976                 <para>When recursion is toggled OFF, only files from the current
 977                 working directory on the source machine that match the mask specified
 978                 to the mget or mput commands will be copied, and any mask specified
 979                 using the mask command will be ignored. </para></listitem>
 980                 </varlistentry>
 981
 982                 <varlistentry>
 983                 <term>rename &lt;old filename&gt; &lt;new filename&gt;</term>
 984                 <listitem><para>Rename files in the current working directory on the
 985                 server from <replaceable>old filename</replaceable> to
 986                 <replaceable>new filename</replaceable>. </para></listitem>
 987                 </varlistentry>
 988
 989                 <varlistentry>
 990                 <term>rm &lt;mask&gt;</term>
 991                 <listitem><para>Remove all files matching <replaceable>mask</replaceable> from the current
 992                 working directory on the server. </para></listitem>
 993                 </varlistentry>
 994
 995                 <varlistentry>
 996                 <term>rmdir &lt;directory name&gt;</term>
 997                 <listitem><para>Remove the specified directory (user access
 998                 privileges permitting) from the server. </para></listitem>
 999                 </varlistentry>
1000
1001                 <varlistentry>
1002                 <term>setmode &lt;filename&gt; &lt;perm=[+|\-]rsha&gt;</term>
1003                 <listitem><para>A version of the DOS attrib command to set
1004                 file permissions. For example: </para>
1005
1006                 <para><command>setmode myfile +r </command></para>
1007
1008                 <para>would make myfile read only. </para></listitem>
1009                 </varlistentry>
1010
1011                 <varlistentry>
1012                 <term>showconnect</term>
1013                 <listitem><para>Show the currently active connection held for DFS purposes.
1014                 </para></listitem>
1015                 </varlistentry>
1016
1017                 <varlistentry>
1018                 <term>stat file</term>
1019                 <listitem><para>This command depends on the server supporting the CIFS
1020                 UNIX extensions and will fail if the server does not. The client requests the
1021                 UNIX basic info level and prints out the same info that the Linux stat command
1022                 would about the file. This includes the size, blocks used on disk, file type,
1023                 permissions, inode number, number of links and finally the three timestamps
1024                 (access, modify and change). If the file is a special file (symlink, character or
1025                 block device, fifo or socket) then extra information may also be printed.
1026                 </para></listitem>
1027                 </varlistentry>
1028
1029                 <varlistentry>
1030                 <term>symlink target linkname</term>
1031                 <listitem><para>This command depends on the server supporting the CIFS
1032                 UNIX extensions and will fail if the server does not. The client requests that the server
1033                 create a symbolic hard link between the target and linkname files. The linkname file
1034                 must not exist. Note that the server will not create a link to any path that lies
1035                 outside the currently connected share. This is enforced by the Samba server.
1036                 </para></listitem>
1037                 </varlistentry>
1038
1039                 <varlistentry>
1040                 <term>tar &lt;c|x&gt;[IXbgNa]</term>
1041                 <listitem><para>Performs a tar operation - see the <parameter>-T
1042                 </parameter> command line option above. Behavior may be affected
1043                 by the tarmode command (see below). Using g (incremental) and N
1044                 (newer) will affect tarmode settings. Note that using the "-" option
1045                 with tar x may not work - use the command line option instead.
1046                 </para></listitem>
1047                 </varlistentry>
1048
1049                 <varlistentry>
1050                 <term>blocksize &lt;blocksize&gt;</term>
1051                 <listitem><para>Blocksize. Must be followed by a valid (greater
1052                 than zero) blocksize. Causes tar file to be written out in
1053                 <replaceable>blocksize</replaceable>*TBLOCK (usually 512 byte) blocks. </para></listitem>
1054                 </varlistentry>
1055
1056                 <varlistentry>
1057                 <term>tarmode &lt;full|inc|reset|noreset&gt;</term>
1058                 <listitem><para>Changes tar's behavior with regard to archive
1059                 bits. In full mode, tar will back up everything regardless of the
1060                 archive bit setting (this is the default mode). In incremental mode,
1061                 tar will only back up files with the archive bit set. In reset mode,
1062                 tar will reset the archive bit on all files it backs up (implies
1063                 read/write share). </para></listitem>
1064                 </varlistentry>
1065
1066                 <varlistentry>
1067                 <term>timeout &lt;per-operation timeout in seconds&gt;</term>
1068                 <listitem><para>This allows the user to tune the default
1069                 timeout used for each SMB request. The default setting is
1070                 20 seconds. Increase it if requests to the server sometimes
1071                 time out. This can happen when SMB3 encryption is selected
1072                 and smbclient is overwhelming the server with requests.
1073                 </para></listitem>
1074                 </varlistentry>
1075
1076                 <varlistentry>
1077                 <term>unlock &lt;filenum&gt; &lt;hex-start&gt; &lt;hex-len&gt;</term>
1078                 <listitem><para>This command depends on the server supporting the CIFS
1079                 UNIX extensions and will fail if the server does not. Tries to unlock a POSIX
1080                 fcntl lock on the given range. Used for internal Samba testing purposes.
1081                 </para></listitem>
1082                 </varlistentry>
1083
1084                 <varlistentry>
1085                 <term>volume</term>
1086                 <listitem><para>Prints the current volume name of the share.
1087                 </para></listitem>
1088                 </varlistentry>
1089
1090                 <varlistentry>
1091                 <term>vuid &lt;number&gt;</term>
1092                 <listitem><para>Changes the currently used vuid in the protocol to
1093                 the given arbitrary number. Without an argument prints out the current
1094                 vuid being used. Used for internal Samba testing purposes.
1095                 </para></listitem>
1096                 </varlistentry>
1097
1098                 <varlistentry>
1099                 <term>tcon &lt;sharename&gt;</term>
1100                 <listitem><para>Establishes a new tree connect (connection to a share).
1101                 Replaces the current tree connect. Prints the new tid (tree id).
1102                 Used for internal Samba testing purposes.
1103                 </para></listitem>
1104                 </varlistentry>
1105
1106                 <varlistentry>
1107                 <term>tdis</term>
1108                 <listitem><para>Close the current share connection (tree disconnect).
1109                 Used for internal Samba testing purposes.
1110                 </para></listitem>
1111                 </varlistentry>
1112
1113                 <varlistentry>
1114                 <term>tid &lt;number&gt;</term>
1115                 <listitem><para>Changes the current tree id (tid) in the
1116                 protocol to a new arbitrary number. Without an argument, it
1117                 prints out the tid currently used.
1118                 Used for internal Samba testing purposes.
1119                 </para></listitem>
1120                 </varlistentry>
1121
1122         </variablelist>
1123 </refsect1>
1124
1125 <refsect1>
1126         <title>NOTES</title>
1127
1128         <para>Some servers are fussy about the case of supplied usernames,
1129         passwords, share names (AKA service names) and machine names.
1130         If you fail to connect try giving all parameters in uppercase.
1131         </para>
1132
1133         <para>It is often necessary to use the -n option when connecting
1134         to some types of servers. For example OS/2 LanManager insists
1135         on a valid NetBIOS name being used, so you need to supply a valid
1136         name that would be known to the server.</para>
1137
1138         <para>smbclient supports long file names where the server
1139         supports the LANMAN2 protocol or above. </para>
1140 </refsect1>
1141
1142 <refsect1>
1143         <title>ENVIRONMENT VARIABLES</title>
1144
1145         <para>The variable <envar>USER</envar> may contain the
1146         username of the person  using the client. This information is
1147         used only if the protocol  level is high enough to support
1148         session-level passwords.</para>
1149
1150
1151         <para>The variable <envar>PASSWD</envar> may contain
1152         the password of the person using the client.  This information is
1153         used only if the protocol level is high enough to support
1154         session-level passwords. </para>
1155
1156         <para>The variable <envar>LIBSMB_PROG</envar> may contain
1157         the path, executed with system(), which the client should connect
1158         to instead of connecting to a server.  This functionality is primarily
1159         intended as a development aid, and works best when using a LMHOSTS
1160         file</para>
1161 </refsect1>
1162
1163
1164 <refsect1>
1165         <title>INSTALLATION</title>
1166
1167         <para>The location of the client program is a matter for
1168         individual system administrators. The following are thus
1169         suggestions only. </para>
1170
1171         <para>It is recommended that the smbclient software be installed
1172         in the <filename>/usr/local/samba/bin/</filename> or <filename>
1173         /usr/samba/bin/</filename> directory, this directory readable
1174         by all, writeable only by root. The client program itself should
1175         be executable by all. The client should <emphasis>NOT</emphasis> be
1176         setuid or setgid! </para>
1177
1178         <para>The client log files should be put in a directory readable
1179         and writeable only by the user. </para>
1180
1181         <para>To test the client, you will need to know the name of a
1182         running SMB/CIFS server. It is possible to run <citerefentry><refentrytitle>smbd</refentrytitle>
1183         <manvolnum>8</manvolnum></citerefentry> as an ordinary user - running that server as a daemon
1184         on a user-accessible port (typically any port number over 1024)
1185         would provide a suitable test server. </para>
1186 </refsect1>
1187
1188
1189 <refsect1>
1190         <title>DIAGNOSTICS</title>
1191
1192         <para>Most diagnostics issued by the client are logged in a
1193         specified log file. The log file name is specified at compile time,
1194         but may be overridden on the command line. </para>
1195
1196         <para>The number and nature of diagnostics available depends
1197         on the debug level used by the client. If you have problems,
1198         set the debug level to 3 and peruse the log files. </para>
1199 </refsect1>
1200
1201
1202 <refsect1>
1203         <title>VERSION</title>
1204
1205         <para>This man page is correct for version 3.2 of the Samba suite.</para>
1206 </refsect1>
1207
1208
1209 <refsect1>
1210         <title>AUTHOR</title>
1211
1212         <para>The original Samba software and related utilities
1213         were created by Andrew Tridgell. Samba is now developed
1214         by the Samba Team as an Open Source project similar
1215         to the way the Linux kernel is developed.</para>
1216
1217         <para>The original Samba man pages were written by Karl Auer.
1218         The man page sources were converted to YODL format (another
1219         excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
1220         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
1221         release by Jeremy Allison.  The conversion to DocBook for
1222         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0
1223         was done by Alexander Bokovoy.</para>
1224 </refsect1>
1225
1226 </refentry>