docs/manpages/smbclient.1.xml

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