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">
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.6</refmiscinfo>
15 <refname>smbclient</refname>
16 <refpurpose>ftp-like client to access SMB/CIFS resources
17 on servers</refpurpose>
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">-g</arg>
34 <arg choice="opt">-i scope</arg>
35 <arg choice="opt">-O <socket options></arg>
36 <arg choice="opt">-p port</arg>
37 <arg choice="opt">-R <name resolve order></arg>
38 <arg choice="opt">-s <smb config file></arg>
39 <arg choice="opt">-k</arg>
40 <arg choice="opt">-P</arg>
41 <arg choice="opt">-c <command></arg>
45 <command>smbclient</command>
46 <arg choice="req">servicename</arg>
47 <arg choice="opt">password</arg>
48 <arg choice="opt">-b <buffer size></arg>
49 <arg choice="opt">-d debuglevel</arg>
50 <arg choice="opt">-e</arg>
51 <arg choice="opt">-D Directory</arg>
52 <arg choice="opt">-U username</arg>
53 <arg choice="opt">-W workgroup</arg>
54 <arg choice="opt">-M <netbios name></arg>
55 <arg choice="opt">-m maxprotocol</arg>
56 <arg choice="opt">-A authfile</arg>
57 <arg choice="opt">-N</arg>
58 <arg choice="opt">-g</arg>
59 <arg choice="opt">-l log-basename</arg>
60 <arg choice="opt">-I destinationIP</arg>
61 <arg choice="opt">-E</arg>
62 <arg choice="opt">-c <command string></arg>
63 <arg choice="opt">-i scope</arg>
64 <arg choice="opt">-O <socket options></arg>
65 <arg choice="opt">-p port</arg>
66 <arg choice="opt">-R <name resolve order></arg>
67 <arg choice="opt">-s <smb config file></arg>
68 <arg choice="opt">-T<c|x>IXFqgbNan</arg>
69 <arg choice="opt">-k</arg>
74 <title>DESCRIPTION</title>
76 <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
77 <manvolnum>7</manvolnum></citerefentry> suite.</para>
79 <para><command>smbclient</command> is a client that can
80 'talk' to an SMB/CIFS server. It offers an interface
81 similar to that of the ftp program (see <citerefentry><refentrytitle>ftp</refentrytitle>
82 <manvolnum>1</manvolnum></citerefentry>).
83 Operations include things like getting files from the server
84 to the local machine, putting files from the local machine to
85 the server, retrieving directory information from the server
91 <title>OPTIONS</title>
95 <term>servicename</term>
96 <listitem><para>servicename is the name of the service
97 you want to use on the server. A service name takes the form
98 <filename>//server/service</filename> where <parameter>server
99 </parameter> is the NetBIOS name of the SMB/CIFS server
100 offering the desired service and <parameter>service</parameter>
101 is the name of the service offered. Thus to connect to
102 the service "printer" on the SMB/CIFS server "smbserver",
103 you would use the servicename <filename>//smbserver/printer
106 <para>Note that the server name required is NOT necessarily
107 the IP (DNS) host name of the server ! The name required is
108 a NetBIOS server name, which may or may not be the
109 same as the IP hostname of the machine running the server.
112 <para>The server name is looked up according to either
113 the <parameter>-R</parameter> parameter to <command>smbclient</command> or
114 using the name resolve order parameter in
115 the <citerefentry><refentrytitle>smb.conf</refentrytitle>
116 <manvolnum>5</manvolnum></citerefentry> file,
117 allowing an administrator to change the order and methods
118 by which server names are looked up. </para></listitem>
122 <term>password</term>
123 <listitem><para>The password required to access the specified
124 service on the specified server. If this parameter is
125 supplied, the <parameter>-N</parameter> option (suppress
126 password prompt) is assumed. </para>
128 <para>There is no default password. If no password is supplied
129 on the command line (either by using this parameter or adding
130 a password to the <parameter>-U</parameter> option (see
131 below)) and the <parameter>-N</parameter> option is not
132 specified, the client will prompt for a password, even if
133 the desired service does not require one. (If no password is
134 required, simply press ENTER to provide a null password.)
137 <para>Note: Some servers (including OS/2 and Windows for
138 Workgroups) insist on an uppercase password. Lowercase
139 or mixed case passwords may be rejected by these servers.
142 <para>Be cautious about including passwords in scripts.
147 <term>-R|--name-resolve <name resolve order></term>
148 <listitem><para>This option is used by the programs in the Samba
149 suite to determine what naming services and in what order to resolve
150 host names to IP addresses. The option takes a space-separated
151 string of different name resolution options.</para>
153 <para>The options are :"lmhosts", "host", "wins" and "bcast". They
154 cause names to be resolved as follows:</para>
157 <listitem><para><constant>lmhosts</constant>: Lookup an IP
158 address in the Samba lmhosts file. If the line in lmhosts has
159 no name type attached to the NetBIOS name (see
160 the <citerefentry><refentrytitle>lmhosts</refentrytitle>
161 <manvolnum>5</manvolnum></citerefentry> for details) then
162 any name type matches for lookup.</para>
165 <listitem><para><constant>host</constant>: Do a standard host
166 name to IP address resolution, using the system <filename>/etc/hosts
167 </filename>, NIS, or DNS lookups. This method of name resolution
168 is operating system dependent, for instance on IRIX or Solaris this
169 may be controlled by the <filename>/etc/nsswitch.conf</filename>
170 file). Note that this method is only used if the NetBIOS name
171 type being queried is the 0x20 (server) name type, otherwise
172 it is ignored.</para>
175 <listitem><para><constant>wins</constant>: Query a name with
176 the IP address listed in the <parameter>wins server</parameter>
177 parameter. If no WINS server has
178 been specified this method will be ignored.</para>
181 <listitem><para><constant>bcast</constant>: Do a broadcast on
182 each of the known local interfaces listed in the
183 <parameter>interfaces</parameter>
184 parameter. This is the least reliable of the name resolution
185 methods as it depends on the target host being on a locally
186 connected subnet.</para>
190 <para>If this parameter is not set then the name resolve order
191 defined in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
192 <manvolnum>5</manvolnum></citerefentry> file parameter
193 (name resolve order) will be used. </para>
195 <para>The default order is lmhosts, host, wins, bcast and without
196 this parameter or any entry in the <parameter>name resolve order
197 </parameter> parameter of the <citerefentry><refentrytitle>smb.conf</refentrytitle>
198 <manvolnum>5</manvolnum></citerefentry> file the name resolution
199 methods will be attempted in this order. </para></listitem>
204 <term>-M|--message NetBIOS name</term>
205 <listitem><para>This options allows you to send messages, using
206 the "WinPopup" protocol, to another computer. Once a connection is
207 established you then type your message, pressing ^D (control-D) to
210 <para>If the receiving computer is running WinPopup the user will
211 receive the message and probably a beep. If they are not running
212 WinPopup the message will be lost, and no error message will
215 <para>The message is also automatically truncated if the message
216 is over 1600 bytes, as this is the limit of the protocol.
220 One useful trick is to pipe the message through <command>smbclient</command>.
221 For example: smbclient -M FRED < mymessage.txt will send the
222 message in the file <filename>mymessage.txt</filename> to the
226 <para>You may also find the <parameter>-U</parameter> and
227 <parameter>-I</parameter> options useful, as they allow you to
228 control the FROM and TO parts of the message. </para>
230 <para>See the <parameter>message command</parameter> parameter in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
231 <manvolnum>5</manvolnum></citerefentry> for a description of how to handle incoming
232 WinPopup messages in Samba. </para>
234 <para><emphasis>Note</emphasis>: Copy WinPopup into the startup group
235 on your WfWg PCs if you want them to always be able to receive
236 messages. </para></listitem>
240 <term>-p|--port port</term>
241 <listitem><para>This number is the TCP port number that will be used
242 when making connections to the server. The standard (well-known)
243 TCP port number for an SMB/CIFS server is 139, which is the
244 default. </para></listitem>
248 <term>-g|--grepable</term>
249 <listitem><para>This parameter provides combined with
250 <parameter>-L</parameter> easy parseable output that allows processing
251 with utilities such as grep and cut.
256 <term>-m|--max-protocol protocol</term>
257 <listitem><para>This parameter sets the maximum protocol version announced by the client.
264 Make queries to the external server using the machine account of the local server.
271 <term>-I|--ip-address IP-address</term>
272 <listitem><para><replaceable>IP address</replaceable> is the address of the server to connect to.
273 It should be specified in standard "a.b.c.d" notation. </para>
275 <para>Normally the client would attempt to locate a named
276 SMB/CIFS server by looking it up via the NetBIOS name resolution
277 mechanism described above in the <parameter>name resolve order</parameter>
278 parameter above. Using this parameter will force the client
279 to assume that the server is on the machine with the specified IP
280 address and the NetBIOS name component of the resource being
281 connected to will be ignored. </para>
283 <para>There is no default for this parameter. If not supplied,
284 it will be determined automatically by the client as described
285 above. </para></listitem>
289 <term>-E|--stderr</term>
290 <listitem><para>This parameter causes the client to write messages
291 to the standard error stream (stderr) rather than to the standard
292 output stream. </para>
294 <para>By default, the client writes messages to standard output
295 - typically the user's tty. </para></listitem>
299 <term>-L|--list</term>
300 <listitem><para>This option allows you to look at what services
301 are available on a server. You use it as <command>smbclient -L
302 host</command> and a list should appear. The <parameter>-I
303 </parameter> option may be useful if your NetBIOS names don't
304 match your TCP/IP DNS host names or if you are trying to reach a
305 host on another network. </para></listitem>
309 <term>-b|--send-buffer buffersize</term>
310 <listitem><para>This option changes the transmit/send buffer
311 size when getting or putting a file from/to the server. The default
312 is 65520 bytes. Setting this value smaller (to 1200 bytes) has been
313 observed to speed up file transfers to and from a Win9x server.
319 <listitem><para>This command line parameter requires the remote
320 server support the UNIX extensions. Request that the connection be
321 encrypted. This is new for Samba 3.2 and will only work with Samba
322 3.2 or above servers. Negotiates SMB encryption using GSSAPI. Uses
323 the given credentials for the encryption negotiaion (either kerberos
324 or NTLMv1/v2 if given domain/username/password triple. Fails the
325 connection if encryption cannot be negotiated.
329 &stdarg.client.debug;
331 &popt.common.credentials;
332 &popt.common.connection;
335 <term>-T|--tar tar options</term>
336 <listitem><para>smbclient may be used to create <command>tar(1)
337 </command> compatible backups of all the files on an SMB/CIFS
338 share. The secondary tar flags that can be given to this option
342 <listitem><para><parameter>c</parameter> - Create a tar file on UNIX.
343 Must be followed by the name of a tar file, tape device
344 or "-" for standard output. If using standard output you must
345 turn the log level to its lowest value -d0 to avoid corrupting
346 your tar file. This flag is mutually exclusive with the
347 <parameter>x</parameter> flag. </para></listitem>
349 <listitem><para><parameter>x</parameter> - Extract (restore) a local
350 tar file back to a share. Unless the -D option is given, the tar
351 files will be restored from the top level of the share. Must be
352 followed by the name of the tar file, device or "-" for standard
353 input. Mutually exclusive with the <parameter>c</parameter> flag.
354 Restored files have their creation times (mtime) set to the
355 date saved in the tar file. Directories currently do not get
356 their creation dates restored properly. </para></listitem>
358 <listitem><para><parameter>I</parameter> - Include files and directories.
359 Is the default behavior when filenames are specified above. Causes
360 files to be included in an extract or create (and therefore
361 everything else to be excluded). See example below. Filename globbing
362 works in one of two ways. See <parameter>r</parameter> below. </para></listitem>
364 <listitem><para><parameter>X</parameter> - Exclude files and directories.
365 Causes files to be excluded from an extract or create. See
366 example below. Filename globbing works in one of two ways now.
367 See <parameter>r</parameter> below. </para></listitem>
369 <listitem><para><parameter>F</parameter> - File containing a list of files and directories.
370 The <parameter>F</parameter> causes the name following the tarfile to
371 create to be read as a filename that contains a list of files and directories to
372 be included in an extract or create (and therefore everything else to be excluded).
373 See example below. Filename globbing works in one of two ways.
374 See <parameter>r</parameter> below.
377 <listitem><para><parameter>b</parameter> - Blocksize. Must be followed
378 by a valid (greater than zero) blocksize. Causes tar file to be
379 written out in blocksize*TBLOCK (usually 512 byte) blocks.
382 <listitem><para><parameter>g</parameter> - Incremental. Only back up
383 files that have the archive bit set. Useful only with the
384 <parameter>c</parameter> flag. </para></listitem>
386 <listitem><para><parameter>q</parameter> - Quiet. Keeps tar from printing
387 diagnostics as it works. This is the same as tarmode quiet.
390 <listitem><para><parameter>r</parameter> - Regular expression include
391 or exclude. Uses regular expression matching for
392 excluding or excluding files if compiled with HAVE_REGEX_H.
393 However this mode can be very slow. If not compiled with
394 HAVE_REGEX_H, does a limited wildcard match on '*' and '?'.
397 <listitem><para><parameter>N</parameter> - Newer than. Must be followed
398 by the name of a file whose date is compared against files found
399 on the share during a create. Only files newer than the file
400 specified are backed up to the tar file. Useful only with the
401 <parameter>c</parameter> flag. </para></listitem>
403 <listitem><para><parameter>a</parameter> - Set archive bit. Causes the
404 archive bit to be reset when a file is backed up. Useful with the
405 <parameter>g</parameter> and <parameter>c</parameter> flags.
409 <para><emphasis>Tar Long File Names</emphasis></para>
411 <para><command>smbclient</command>'s tar option now supports long
412 file names both on backup and restore. However, the full path
413 name of the file must be less than 1024 bytes. Also, when
414 a tar archive is created, <command>smbclient</command>'s tar option places all
415 files in the archive with relative names, not absolute names.
418 <para><emphasis>Tar Filenames</emphasis></para>
420 <para>All file names can be given as DOS path names (with '\\'
421 as the component separator) or as UNIX path names (with '/' as
422 the component separator). </para>
424 <para><emphasis>Examples</emphasis></para>
426 <para>Restore from tar file <filename>backup.tar</filename> into myshare on mypc
427 (no password on share). </para>
429 <para><command>smbclient //mypc/yshare "" -N -Tx backup.tar
432 <para>Restore everything except <filename>users/docs</filename>
435 <para><command>smbclient //mypc/myshare "" -N -TXx backup.tar
436 users/docs</command></para>
438 <para>Create a tar file of the files beneath <filename>
439 users/docs</filename>. </para>
441 <para><command>smbclient //mypc/myshare "" -N -Tc
442 backup.tar users/docs </command></para>
444 <para>Create the same tar file as above, but now use
445 a DOS path name. </para>
447 <para><command>smbclient //mypc/myshare "" -N -tc backup.tar
448 users\edocs </command></para>
450 <para>Create a tar file of the files listed in the file <filename>tarlist</filename>.</para>
452 <para><command>smbclient //mypc/myshare "" -N -TcF
453 backup.tar tarlist</command></para>
455 <para>Create a tar file of all the files and directories in
458 <para><command>smbclient //mypc/myshare "" -N -Tc backup.tar *
464 <term>-D|--directory initial directory</term>
465 <listitem><para>Change to initial directory before starting. Probably
466 only of any use with the tar -T option. </para></listitem>
470 <term>-c|--comand command string</term>
471 <listitem><para>command string is a semicolon-separated list of
472 commands to be executed instead of prompting from stdin. <parameter>
473 -N</parameter> is implied by <parameter>-c</parameter>.</para>
475 <para>This is particularly useful in scripts and for printing stdin
476 to the server, e.g. <command>-c 'print -'</command>. </para></listitem>
484 <title>OPERATIONS</title>
486 <para>Once the client is running, the user is presented with
489 <para><prompt>smb:\> </prompt></para>
491 <para>The backslash ("\\") indicates the current working directory
492 on the server, and will change if the current working directory
495 <para>The prompt indicates that the client is ready and waiting to
496 carry out a user command. Each command is a single word, optionally
497 followed by parameters specific to that command. Command and parameters
498 are space-delimited unless these notes specifically
499 state otherwise. All commands are case-insensitive. Parameters to
500 commands may or may not be case sensitive, depending on the command.
503 <para>You can specify file names which have spaces in them by quoting
504 the name with double quotes, for example "a long file name". </para>
506 <para>Parameters shown in square brackets (e.g., "[parameter]") are
507 optional. If not given, the command will use suitable defaults. Parameters
508 shown in angle brackets (e.g., "<parameter>") are required.
512 <para>Note that all commands operating on the server are actually
513 performed by issuing a request to the server. Thus the behavior may
514 vary from server to server, depending on how the server was implemented.
517 <para>The commands available are given here in alphabetical order. </para>
521 <term>? [command]</term>
522 <listitem><para>If <replaceable>command</replaceable> is specified, the ? command will display
523 a brief informative message about the specified command. If no
524 command is specified, a list of available commands will
525 be displayed. </para></listitem>
529 <term>! [shell command]</term>
530 <listitem><para>If <replaceable>shell command</replaceable> is specified, the !
531 command will execute a shell locally and run the specified shell
532 command. If no command is specified, a local shell will be run.
537 <term>allinfo file</term>
538 <listitem><para>The client will request that the server return
539 all known information about a file or directory (including streams).
544 <term>altname file</term>
545 <listitem><para>The client will request that the server return
546 the "alternate" name (the 8.3 name) for a file or directory.
551 <term>archive <number></term>
552 <listitem><para>Sets the archive level when operating on files.
553 0 means ignore the archive bit, 1 means only operate on files with this bit set,
554 2 means only operate on files with this bit set and reset it after operation,
555 3 means operate on all files and reset it after operation. The default is 0.
560 <term>blocksize <number></term>
561 <listitem><para>Sets the blocksize parameter for a tar operation. The default is 20.
562 Causes tar file to be written out in blocksize*TBLOCK (normally 512 byte) units.
567 <term>cancel jobid0 [jobid1] ... [jobidN]</term>
568 <listitem><para>The client will request that the server cancel
569 the printjobs identified by the given numeric print job ids.
574 <term>case_sensitive</term>
575 <listitem><para>Toggles the setting of the flag in SMB packets that
576 tells the server to treat filenames as case sensitive. Set to OFF by
577 default (tells file server to treat filenames as case insensitive). Only
578 currently affects Samba 3.0.5 and above file servers with the case sensitive
579 parameter set to auto in the smb.conf.
584 <term>cd <directory name></term>
585 <listitem><para>If "directory name" is specified, the current
586 working directory on the server will be changed to the directory
587 specified. This operation will fail if for any reason the specified
588 directory is inaccessible. </para>
590 <para>If no directory name is specified, the current working
591 directory on the server will be reported. </para></listitem>
595 <term>chmod file mode in octal</term>
596 <listitem><para>This command depends on the server supporting the CIFS
597 UNIX extensions and will fail if the server does not. The client requests that the server
598 change the UNIX permissions to the given octal mode, in standard UNIX format.
603 <term>chown file uid gid</term>
604 <listitem><para>This command depends on the server supporting the CIFS
605 UNIX extensions and will fail if the server does not. The client requests that the server
606 change the UNIX user and group ownership to the given decimal values. Note there is
607 currently no way to remotely look up the UNIX uid and gid values for a given name.
608 This may be addressed in future versions of the CIFS UNIX extensions.
613 <term>close <fileid></term>
614 <listitem><para>Closes a file explicitly opened by the open command. Used for
615 internal Samba testing purposes.
620 <term>del <mask></term>
621 <listitem><para>The client will request that the server attempt
622 to delete all files matching <replaceable>mask</replaceable> from the current working
623 directory on the server. </para></listitem>
627 <term>dir <mask></term>
628 <listitem><para>A list of the files matching <replaceable>mask</replaceable> in the current
629 working directory on the server will be retrieved from the server
630 and displayed. </para></listitem>
634 <term>du <filename></term>
635 <listitem><para>Does a directory listing and then prints out the current disk useage and free space on a share.
640 <term>echo <number> <data></term>
641 <listitem><para>Does an SMBecho request to ping the server. Used for internal Samba testing purposes.
647 <listitem><para>Terminate the connection with the server and exit
648 from the program. </para></listitem>
652 <term>get <remote file name> [local file name]</term>
653 <listitem><para>Copy the file called <filename>remote file name</filename> from
654 the server to the machine running the client. If specified, name
655 the local copy <filename>local file name</filename>. Note that all transfers in
656 <command>smbclient</command> are binary. See also the
657 lowercase command. </para></listitem>
661 <term>getfacl <filename></term>
662 <listitem><para>Requires the server support the UNIX extensions. Requests and prints
663 the POSIX ACL on a file.
668 <term>hardlink <src> <dest></term>
669 <listitem><para>Creates a hardlink on the server using Windows CIFS semantics.
674 <term>help [command]</term>
675 <listitem><para>See the ? command above. </para></listitem>
679 <term>history</term> <listitem><para>Displays the command history.</para></listitem>
683 <term>iosize <bytes></term>
684 <listitem><para>When sending or receiving files, smbclient uses an
685 internal memory buffer by default of size 64512 bytes. This command
686 allows this size to be set to any range between 16384 (0x4000) bytes
687 and 16776960 (0xFFFF00) bytes. Larger sizes may mean more efficient
688 data transfer as smbclient will try and use the most efficient
689 read and write calls for the connected server.
694 <term>lcd [directory name]</term>
695 <listitem><para>If <replaceable>directory name</replaceable> is specified, the current
696 working directory on the local machine will be changed to
697 the directory specified. This operation will fail if for any
698 reason the specified directory is inaccessible. </para>
700 <para>If no directory name is specified, the name of the
701 current working directory on the local machine will be reported.
706 <term>link target linkname</term>
707 <listitem><para>This command depends on the server supporting the CIFS
708 UNIX extensions and will fail if the server does not. The client requests that the server
709 create a hard link between the linkname and target files. The linkname file
715 <term>listconnect</term>
716 <listitem><para>Show the current connections held for DFS purposes.
721 <term>lock <filenum> <r|w> <hex-start> <hex-len></term>
722 <listitem><para>This command depends on the server supporting the CIFS
723 UNIX extensions and will fail if the server does not. Tries to set a POSIX
724 fcntl lock of the given type on the given range. Used for internal Samba testing purposes.
729 <term>logon <username> <password></term>
730 <listitem><para>Establishes a new vuid for this session by logging on again.
731 Replaces the current vuid. Prints out the new vuid. Used for internal Samba testing purposes.
736 <term>lowercase</term>
737 <listitem><para>Toggle lowercasing of filenames for the get and
741 <para>When lowercasing is toggled ON, local filenames are converted
742 to lowercase when using the get and mget commands. This is
743 often useful when copying (say) MSDOS files from a server, because
744 lowercase filenames are the norm on UNIX systems. </para></listitem>
748 <term>ls <mask></term>
749 <listitem><para>See the dir command above. </para></listitem>
753 <term>mask <mask></term>
754 <listitem><para>This command allows the user to set up a mask
755 which will be used during recursive operation of the mget and
756 mput commands. </para>
758 <para>The masks specified to the mget and mput commands act as
759 filters for directories rather than files when recursion is
762 <para>The mask specified with the mask command is necessary
763 to filter files within those directories. For example, if the
764 mask specified in an mget command is "source*" and the mask
765 specified with the mask command is "*.c" and recursion is
766 toggled ON, the mget command will retrieve all files matching
767 "*.c" in all directories below and including all directories
768 matching "source*" in the current working directory. </para>
770 <para>Note that the value for mask defaults to blank (equivalent
771 to "*") and remains so until the mask command is used to change it.
772 It retains the most recently specified value indefinitely. To
773 avoid unexpected results it would be wise to change the value of
774 mask back to "*" after using the mget or mput commands. </para></listitem>
778 <term>md <directory name></term>
779 <listitem><para>See the mkdir command. </para></listitem>
783 <term>mget <mask></term>
784 <listitem><para>Copy all files matching <replaceable>mask</replaceable> from the server to
785 the machine running the client. </para>
787 <para>Note that <replaceable>mask</replaceable> is interpreted differently during recursive
788 operation and non-recursive operation - refer to the recurse and
789 mask commands for more information. Note that all transfers in
790 <command>smbclient</command> are binary. See also the lowercase command. </para></listitem>
794 <term>mkdir <directory name></term>
795 <listitem><para>Create a new directory on the server (user access
796 privileges permitting) with the specified name. </para></listitem>
800 <term>more <file name></term>
801 <listitem><para>Fetch a remote file and view it with the contents
802 of your PAGER environment variable.
807 <term>mput <mask></term>
808 <listitem><para>Copy all files matching <replaceable>mask</replaceable> in the current working
809 directory on the local machine to the current working directory on
812 <para>Note that <replaceable>mask</replaceable> is interpreted differently during recursive
813 operation and non-recursive operation - refer to the recurse and mask
814 commands for more information. Note that all transfers in <command>smbclient</command>
815 are binary. </para></listitem>
820 <listitem><para>Query the remote server to see if it supports the CIFS UNIX
821 extensions and prints out the list of capabilities supported. If so, turn
822 on POSIX pathname processing and large file read/writes (if available),.
827 <term>posix_encrypt <domain> <username> <password></term>
828 <listitem><para>This command depends on the server supporting the CIFS
829 UNIX extensions and will fail if the server does not. Attempt to negotiate
830 SMB encryption on this connection. If smbclient connected with kerberos
831 credentials (-k) the arguments to this command are ignored and the kerberos
832 credentials are used to negotiate GSSAPI signing and sealing instead. See
833 also the -e option to smbclient to force encryption on initial connection.
834 This command is new with Samba 3.2.
839 <term>posix_open <filename> <octal mode></term>
840 <listitem><para>This command depends on the server supporting the CIFS
841 UNIX extensions and will fail if the server does not. Opens a remote file
842 using the CIFS UNIX extensions and prints a fileid. Used for internal Samba
848 <term>posix_mkdir <directoryname> <octal mode></term>
849 <listitem><para>This command depends on the server supporting the CIFS
850 UNIX extensions and will fail if the server does not. Creates a remote directory
851 using the CIFS UNIX extensions with the given mode.
856 <term>posix_rmdir <directoryname></term>
857 <listitem><para>This command depends on the server supporting the CIFS
858 UNIX extensions and will fail if the server does not. Deletes a remote directory
859 using the CIFS UNIX extensions.
864 <term>posix_unlink <filename></term>
865 <listitem><para>This command depends on the server supporting the CIFS
866 UNIX extensions and will fail if the server does not. Deletes a remote file
867 using the CIFS UNIX extensions.
872 <term>print <file name></term>
873 <listitem><para>Print the specified file from the local machine
874 through a printable service on the server. </para></listitem>
879 <listitem><para>Toggle prompting for filenames during operation
880 of the mget and mput commands. </para>
882 <para>When toggled ON, the user will be prompted to confirm
883 the transfer of each file during these commands. When toggled
884 OFF, all specified files will be transferred without prompting.
889 <term>put <local file name> [remote file name]</term>
890 <listitem><para>Copy the file called <filename>local file name</filename> from the
891 machine running the client to the server. If specified,
892 name the remote copy <filename>remote file name</filename>. Note that all transfers
893 in <command>smbclient</command> are binary. See also the lowercase command.
899 <listitem><para>Displays the print queue, showing the job id,
900 name, size and current status. </para></listitem>
905 <listitem><para>See the exit command. </para></listitem>
909 <term>readlink symlinkname</term>
910 <listitem><para>This command depends on the server supporting the CIFS
911 UNIX extensions and will fail if the server does not. Print
912 the value of the symlink "symlinkname".
917 <term>rd <directory name></term>
918 <listitem><para>See the rmdir command. </para></listitem>
923 <listitem><para>Toggle directory recursion for the commands mget
926 <para>When toggled ON, these commands will process all directories
927 in the source directory (i.e., the directory they are copying
928 from ) and will recurse into any that match the mask specified
929 to the command. Only files that match the mask specified using
930 the mask command will be retrieved. See also the mask command.
933 <para>When recursion is toggled OFF, only files from the current
934 working directory on the source machine that match the mask specified
935 to the mget or mput commands will be copied, and any mask specified
936 using the mask command will be ignored. </para></listitem>
940 <term>rename <old filename> <new filename></term>
941 <listitem><para>Rename files in the current working directory on the
942 server from <replaceable>old filename</replaceable> to
943 <replaceable>new filename</replaceable>. </para></listitem>
947 <term>rm <mask></term>
948 <listitem><para>Remove all files matching <replaceable>mask</replaceable> from the current
949 working directory on the server. </para></listitem>
953 <term>rmdir <directory name></term>
954 <listitem><para>Remove the specified directory (user access
955 privileges permitting) from the server. </para></listitem>
959 <term>setmode <filename> <perm=[+|\-]rsha></term>
960 <listitem><para>A version of the DOS attrib command to set
961 file permissions. For example: </para>
963 <para><command>setmode myfile +r </command></para>
965 <para>would make myfile read only. </para></listitem>
969 <term>showconnect</term>
970 <listitem><para>Show the currently active connection held for DFS purposes.
975 <term>stat file</term>
976 <listitem><para>This command depends on the server supporting the CIFS
977 UNIX extensions and will fail if the server does not. The client requests the
978 UNIX basic info level and prints out the same info that the Linux stat command
979 would about the file. This includes the size, blocks used on disk, file type,
980 permissions, inode number, number of links and finally the three timestamps
981 (access, modify and change). If the file is a special file (symlink, character or
982 block device, fifo or socket) then extra information may also be printed.
987 <term>symlink target linkname</term>
988 <listitem><para>This command depends on the server supporting the CIFS
989 UNIX extensions and will fail if the server does not. The client requests that the server
990 create a symbolic hard link between the target and linkname files. The linkname file
991 must not exist. Note that the server will not create a link to any path that lies
992 outside the currently connected share. This is enforced by the Samba server.
997 <term>tar <c|x>[IXbgNa]</term>
998 <listitem><para>Performs a tar operation - see the <parameter>-T
999 </parameter> command line option above. Behavior may be affected
1000 by the tarmode command (see below). Using g (incremental) and N
1001 (newer) will affect tarmode settings. Note that using the "-" option
1002 with tar x may not work - use the command line option instead.
1007 <term>blocksize <blocksize></term>
1008 <listitem><para>Blocksize. Must be followed by a valid (greater
1009 than zero) blocksize. Causes tar file to be written out in
1010 <replaceable>blocksize</replaceable>*TBLOCK (usually 512 byte) blocks. </para></listitem>
1014 <term>tarmode <full|inc|reset|noreset></term>
1015 <listitem><para>Changes tar's behavior with regard to archive
1016 bits. In full mode, tar will back up everything regardless of the
1017 archive bit setting (this is the default mode). In incremental mode,
1018 tar will only back up files with the archive bit set. In reset mode,
1019 tar will reset the archive bit on all files it backs up (implies
1020 read/write share). </para></listitem>
1024 <term>unlock <filenum> <hex-start> <hex-len></term>
1025 <listitem><para>This command depends on the server supporting the CIFS
1026 UNIX extensions and will fail if the server does not. Tries to unlock a POSIX
1027 fcntl lock on the given range. Used for internal Samba testing purposes.
1033 <listitem><para>Prints the current volume name of the share.
1038 <term>vuid <number></term>
1039 <listitem><para>Changes the currently used vuid in the protocol to
1040 the given arbitrary number. Without an argument prints out the current
1041 vuid being used. Used for internal Samba testing purposes.
1049 <title>NOTES</title>
1051 <para>Some servers are fussy about the case of supplied usernames,
1052 passwords, share names (AKA service names) and machine names.
1053 If you fail to connect try giving all parameters in uppercase.
1056 <para>It is often necessary to use the -n option when connecting
1057 to some types of servers. For example OS/2 LanManager insists
1058 on a valid NetBIOS name being used, so you need to supply a valid
1059 name that would be known to the server.</para>
1061 <para>smbclient supports long file names where the server
1062 supports the LANMAN2 protocol or above. </para>
1066 <title>ENVIRONMENT VARIABLES</title>
1068 <para>The variable <envar>USER</envar> may contain the
1069 username of the person using the client. This information is
1070 used only if the protocol level is high enough to support
1071 session-level passwords.</para>
1074 <para>The variable <envar>PASSWD</envar> may contain
1075 the password of the person using the client. This information is
1076 used only if the protocol level is high enough to support
1077 session-level passwords. </para>
1079 <para>The variable <envar>LIBSMB_PROG</envar> may contain
1080 the path, executed with system(), which the client should connect
1081 to instead of connecting to a server. This functionality is primarily
1082 intended as a development aid, and works best when using a LMHOSTS
1088 <title>INSTALLATION</title>
1090 <para>The location of the client program is a matter for
1091 individual system administrators. The following are thus
1092 suggestions only. </para>
1094 <para>It is recommended that the smbclient software be installed
1095 in the <filename>/usr/local/samba/bin/</filename> or <filename>
1096 /usr/samba/bin/</filename> directory, this directory readable
1097 by all, writeable only by root. The client program itself should
1098 be executable by all. The client should <emphasis>NOT</emphasis> be
1099 setuid or setgid! </para>
1101 <para>The client log files should be put in a directory readable
1102 and writeable only by the user. </para>
1104 <para>To test the client, you will need to know the name of a
1105 running SMB/CIFS server. It is possible to run <citerefentry><refentrytitle>smbd</refentrytitle>
1106 <manvolnum>8</manvolnum></citerefentry> as an ordinary user - running that server as a daemon
1107 on a user-accessible port (typically any port number over 1024)
1108 would provide a suitable test server. </para>
1113 <title>DIAGNOSTICS</title>
1115 <para>Most diagnostics issued by the client are logged in a
1116 specified log file. The log file name is specified at compile time,
1117 but may be overridden on the command line. </para>
1119 <para>The number and nature of diagnostics available depends
1120 on the debug level used by the client. If you have problems,
1121 set the debug level to 3 and peruse the log files. </para>
1126 <title>VERSION</title>
1128 <para>This man page is correct for version 3.2 of the Samba suite.</para>
1133 <title>AUTHOR</title>
1135 <para>The original Samba software and related utilities
1136 were created by Andrew Tridgell. Samba is now developed
1137 by the Samba Team as an Open Source project similar
1138 to the way the Linux kernel is developed.</para>
1140 <para>The original Samba man pages were written by Karl Auer.
1141 The man page sources were converted to YODL format (another
1142 excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
1143 ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
1144 release by Jeremy Allison. The conversion to DocBook for
1145 Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0
1146 was done by Alexander Bokovoy.</para>