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