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