docs/docbook/manpages/smbclient.1.xml

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