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