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">4.1</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">-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>
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>
76 <title>DESCRIPTION</title>
78 <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
79 <manvolnum>7</manvolnum></citerefentry> suite.</para>
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
93 <title>OPTIONS</title>
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
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.
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>
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>
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.)
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.
144 <para>Be cautious about including passwords in scripts.
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>
155 <para>The options are :"lmhosts", "host", "wins" and "bcast". They
156 cause names to be resolved as follows:</para>
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>
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>
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>
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>
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>
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>
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
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
217 <para>The message is also automatically truncated if the message
218 is over 1600 bytes, as this is the limit of the protocol.
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
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>
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>
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>
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>
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.
258 <term>-m|--max-protocol protocol</term>
259 <listitem><para>This allows the user to select the
260 highest SMB protocol level that smbclient will use to
261 connect to the server. By default this is set to
262 NT1, which is the highest available SMB1 protocol.
263 To connect using SMB2 or SMB3 protocol, use the
264 strings SMB2 or SMB3 respectively. Note that to connect
265 to a Windows 2012 server with encrypted transport selecting
266 a max-protocol of SMB3 is required.
271 <term>-P|--machine-pass</term>
273 Make queries to the external server using the machine account of the local server.
280 <term>-I|--ip-address IP-address</term>
281 <listitem><para><replaceable>IP address</replaceable> is the address of the server to connect to.
282 It should be specified in standard "a.b.c.d" notation. </para>
284 <para>Normally the client would attempt to locate a named
285 SMB/CIFS server by looking it up via the NetBIOS name resolution
286 mechanism described above in the <parameter>name resolve order</parameter>
287 parameter above. Using this parameter will force the client
288 to assume that the server is on the machine with the specified IP
289 address and the NetBIOS name component of the resource being
290 connected to will be ignored. </para>
292 <para>There is no default for this parameter. If not supplied,
293 it will be determined automatically by the client as described
294 above. </para></listitem>
298 <term>-E|--stderr</term>
299 <listitem><para>This parameter causes the client to write messages
300 to the standard error stream (stderr) rather than to the standard
301 output stream. </para>
303 <para>By default, the client writes messages to standard output
304 - typically the user's tty. </para></listitem>
308 <term>-L|--list</term>
309 <listitem><para>This option allows you to look at what services
310 are available on a server. You use it as <command>smbclient -L
311 host</command> and a list should appear. The <parameter>-I
312 </parameter> option may be useful if your NetBIOS names don't
313 match your TCP/IP DNS host names or if you are trying to reach a
314 host on another network. </para></listitem>
318 <term>-b|--send-buffer buffersize</term>
319 <listitem><para>This option changes the transmit/send buffer
320 size when getting or putting a file from/to the server. The default
321 is 65520 bytes. Setting this value smaller (to 1200 bytes) has been
322 observed to speed up file transfers to and from a Win9x server.
327 <term>-e|--encrypt</term>
328 <listitem><para>This command line parameter requires the remote
329 server support the UNIX extensions. Request that the connection be
330 encrypted. This is new for Samba 3.2 and will only work with Samba
331 3.2 or above servers. Negotiates SMB encryption using GSSAPI. Uses
332 the given credentials for the encryption negotiation (either kerberos
333 or NTLMv1/v2 if given domain/username/password triple. Fails the
334 connection if encryption cannot be negotiated.
338 &stdarg.client.debug;
340 &popt.common.credentials;
341 &popt.common.connection;
344 <term>-T|--tar tar options</term>
345 <listitem><para>smbclient may be used to create <command>tar(1)
346 </command> compatible backups of all the files on an SMB/CIFS
347 share. The secondary tar flags that can be given to this option
351 <listitem><para><parameter>c</parameter> - Create a tar file on UNIX.
352 Must be followed by the name of a tar file, tape device
353 or "-" for standard output. If using standard output you must
354 turn the log level to its lowest value -d0 to avoid corrupting
355 your tar file. This flag is mutually exclusive with the
356 <parameter>x</parameter> flag. </para></listitem>
358 <listitem><para><parameter>x</parameter> - Extract (restore) a local
359 tar file back to a share. Unless the -D option is given, the tar
360 files will be restored from the top level of the share. Must be
361 followed by the name of the tar file, device or "-" for standard
362 input. Mutually exclusive with the <parameter>c</parameter> flag.
363 Restored files have their creation times (mtime) set to the
364 date saved in the tar file. Directories currently do not get
365 their creation dates restored properly. </para></listitem>
367 <listitem><para><parameter>I</parameter> - Include files and directories.
368 Is the default behavior when filenames are specified above. Causes
369 files to be included in an extract or create (and therefore
370 everything else to be excluded). See example below. Filename globbing
371 works in one of two ways. See <parameter>r</parameter> below. </para></listitem>
373 <listitem><para><parameter>X</parameter> - Exclude files and directories.
374 Causes files to be excluded from an extract or create. See
375 example below. Filename globbing works in one of two ways now.
376 See <parameter>r</parameter> below. </para></listitem>
378 <listitem><para><parameter>F</parameter> - File containing a list of files and directories.
379 The <parameter>F</parameter> causes the name following the tarfile to
380 create to be read as a filename that contains a list of files and directories to
381 be included in an extract or create (and therefore everything else to be excluded).
382 See example below. Filename globbing works in one of two ways.
383 See <parameter>r</parameter> below.
386 <listitem><para><parameter>b</parameter> - Blocksize. Must be followed
387 by a valid (greater than zero) blocksize. Causes tar file to be
388 written out in blocksize*TBLOCK (usually 512 byte) blocks.
391 <listitem><para><parameter>g</parameter> - Incremental. Only back up
392 files that have the archive bit set. Useful only with the
393 <parameter>c</parameter> flag. </para></listitem>
395 <listitem><para><parameter>q</parameter> - Quiet. Keeps tar from printing
396 diagnostics as it works. This is the same as tarmode quiet.
399 <listitem><para><parameter>r</parameter> - Regular expression include
400 or exclude. Uses regular expression matching for
401 excluding or excluding files if compiled with HAVE_REGEX_H.
402 However this mode can be very slow. If not compiled with
403 HAVE_REGEX_H, does a limited wildcard match on '*' and '?'.
406 <listitem><para><parameter>N</parameter> - Newer than. Must be followed
407 by the name of a file whose date is compared against files found
408 on the share during a create. Only files newer than the file
409 specified are backed up to the tar file. Useful only with the
410 <parameter>c</parameter> flag. </para></listitem>
412 <listitem><para><parameter>a</parameter> - Set archive bit. Causes the
413 archive bit to be reset when a file is backed up. Useful with the
414 <parameter>g</parameter> and <parameter>c</parameter> flags.
418 <para><emphasis>Tar Long File Names</emphasis></para>
420 <para><command>smbclient</command>'s tar option now supports long
421 file names both on backup and restore. However, the full path
422 name of the file must be less than 1024 bytes. Also, when
423 a tar archive is created, <command>smbclient</command>'s tar option places all
424 files in the archive with relative names, not absolute names.
427 <para><emphasis>Tar Filenames</emphasis></para>
429 <para>All file names can be given as DOS path names (with '\\'
430 as the component separator) or as UNIX path names (with '/' as
431 the component separator). </para>
433 <para><emphasis>Examples</emphasis></para>
435 <para>Restore from tar file <filename>backup.tar</filename> into myshare on mypc
436 (no password on share). </para>
438 <para><command>smbclient //mypc/myshare "" -N -Tx backup.tar
441 <para>Restore everything except <filename>users/docs</filename>
444 <para><command>smbclient //mypc/myshare "" -N -TXx backup.tar
445 users/docs</command></para>
447 <para>Create a tar file of the files beneath <filename>
448 users/docs</filename>. </para>
450 <para><command>smbclient //mypc/myshare "" -N -Tc
451 backup.tar users/docs </command></para>
453 <para>Create the same tar file as above, but now use
454 a DOS path name. </para>
456 <para><command>smbclient //mypc/myshare "" -N -Tc backup.tar
457 users\edocs </command></para>
459 <para>Create a tar file of the files listed in the file <filename>tarlist</filename>.</para>
461 <para><command>smbclient //mypc/myshare "" -N -TcF
462 backup.tar tarlist</command></para>
464 <para>Create a tar file of all the files and directories in
467 <para><command>smbclient //mypc/myshare "" -N -Tc backup.tar *
473 <term>-D|--directory initial directory</term>
474 <listitem><para>Change to initial directory before starting. Probably
475 only of any use with the tar -T option. </para></listitem>
479 <term>-c|--command command string</term>
480 <listitem><para>command string is a semicolon-separated list of
481 commands to be executed instead of prompting from stdin. <parameter>
482 -N</parameter> is implied by <parameter>-c</parameter>.</para>
484 <para>This is particularly useful in scripts and for printing stdin
485 to the server, e.g. <command>-c 'print -'</command>. </para></listitem>
493 <title>OPERATIONS</title>
495 <para>Once the client is running, the user is presented with
498 <para><prompt>smb:\> </prompt></para>
500 <para>The backslash ("\\") indicates the current working directory
501 on the server, and will change if the current working directory
504 <para>The prompt indicates that the client is ready and waiting to
505 carry out a user command. Each command is a single word, optionally
506 followed by parameters specific to that command. Command and parameters
507 are space-delimited unless these notes specifically
508 state otherwise. All commands are case-insensitive. Parameters to
509 commands may or may not be case sensitive, depending on the command.
512 <para>You can specify file names which have spaces in them by quoting
513 the name with double quotes, for example "a long file name". </para>
515 <para>Parameters shown in square brackets (e.g., "[parameter]") are
516 optional. If not given, the command will use suitable defaults. Parameters
517 shown in angle brackets (e.g., "<parameter>") are required.
521 <para>Note that all commands operating on the server are actually
522 performed by issuing a request to the server. Thus the behavior may
523 vary from server to server, depending on how the server was implemented.
526 <para>The commands available are given here in alphabetical order. </para>
530 <term>? [command]</term>
531 <listitem><para>If <replaceable>command</replaceable> is specified, the ? command will display
532 a brief informative message about the specified command. If no
533 command is specified, a list of available commands will
534 be displayed. </para></listitem>
538 <term>! [shell command]</term>
539 <listitem><para>If <replaceable>shell command</replaceable> is specified, the !
540 command will execute a shell locally and run the specified shell
541 command. If no command is specified, a local shell will be run.
546 <term>allinfo file</term>
547 <listitem><para>The client will request that the server return
548 all known information about a file or directory (including streams).
553 <term>altname file</term>
554 <listitem><para>The client will request that the server return
555 the "alternate" name (the 8.3 name) for a file or directory.
560 <term>archive <number></term>
561 <listitem><para>Sets the archive level when operating on files.
562 0 means ignore the archive bit, 1 means only operate on files with this bit set,
563 2 means only operate on files with this bit set and reset it after operation,
564 3 means operate on all files and reset it after operation. The default is 0.
570 <listitem><para>Toggle the state of the "backup intent" flag
571 sent to the server on directory listings and file opens. If
572 the "backup intent" flag is true, the server will try and
573 bypass some file system checks if the user has been granted
574 SE_BACKUP or SE_RESTORE privileges. This state is useful when
575 performing a backup or restore operation.
580 <term>blocksize <number></term>
581 <listitem><para>Sets the blocksize parameter for a tar operation. The default is 20.
582 Causes tar file to be written out in blocksize*TBLOCK (normally 512 byte) units.
587 <term>cancel jobid0 [jobid1] ... [jobidN]</term>
588 <listitem><para>The client will request that the server cancel
589 the printjobs identified by the given numeric print job ids.
594 <term>case_sensitive</term>
595 <listitem><para>Toggles the setting of the flag in SMB packets that
596 tells the server to treat filenames as case sensitive. Set to OFF by
597 default (tells file server to treat filenames as case insensitive). Only
598 currently affects Samba 3.0.5 and above file servers with the case sensitive
599 parameter set to auto in the smb.conf.
604 <term>cd <directory name></term>
605 <listitem><para>If "directory name" is specified, the current
606 working directory on the server will be changed to the directory
607 specified. This operation will fail if for any reason the specified
608 directory is inaccessible. </para>
610 <para>If no directory name is specified, the current working
611 directory on the server will be reported. </para></listitem>
615 <term>chmod file mode in octal</term>
616 <listitem><para>This command depends on the server supporting the CIFS
617 UNIX extensions and will fail if the server does not. The client requests that the server
618 change the UNIX permissions to the given octal mode, in standard UNIX format.
623 <term>chown file uid gid</term>
624 <listitem><para>This command depends on the server supporting the CIFS
625 UNIX extensions and will fail if the server does not. The client requests that the server
626 change the UNIX user and group ownership to the given decimal values. Note there is
627 currently no way to remotely look up the UNIX uid and gid values for a given name.
628 This may be addressed in future versions of the CIFS UNIX extensions.
633 <term>close <fileid></term>
634 <listitem><para>Closes a file explicitly opened by the open command. Used for
635 internal Samba testing purposes.
640 <term>del <mask></term>
641 <listitem><para>The client will request that the server attempt
642 to delete all files matching <replaceable>mask</replaceable> from the current working
643 directory on the server. </para></listitem>
647 <term>dir <mask></term>
648 <listitem><para>A list of the files matching <replaceable>mask</replaceable> in the current
649 working directory on the server will be retrieved from the server
650 and displayed. </para></listitem>
654 <term>du <filename></term>
655 <listitem><para>Does a directory listing and then prints out the current disk usage and free space on a share.
660 <term>echo <number> <data></term>
661 <listitem><para>Does an SMBecho request to ping the server. Used for internal Samba testing purposes.
667 <listitem><para>Terminate the connection with the server and exit
668 from the program. </para></listitem>
672 <term>get <remote file name> [local file name]</term>
673 <listitem><para>Copy the file called <filename>remote file name</filename> from
674 the server to the machine running the client. If specified, name
675 the local copy <filename>local file name</filename>. Note that all transfers in
676 <command>smbclient</command> are binary. See also the
677 lowercase command. </para></listitem>
681 <term>getfacl <filename></term>
682 <listitem><para>Requires the server support the UNIX extensions. Requests and prints
683 the POSIX ACL on a file.
688 <term>hardlink <src> <dest></term>
689 <listitem><para>Creates a hardlink on the server using Windows CIFS semantics.
694 <term>help [command]</term>
695 <listitem><para>See the ? command above. </para></listitem>
699 <term>history</term> <listitem><para>Displays the command history.</para></listitem>
703 <term>iosize <bytes></term>
704 <listitem><para>When sending or receiving files, smbclient uses an
705 internal memory buffer by default of size 64512 bytes. This command
706 allows this size to be set to any range between 16384 (0x4000) bytes
707 and 16776960 (0xFFFF00) bytes. Larger sizes may mean more efficient
708 data transfer as smbclient will try and use the most efficient
709 read and write calls for the connected server.
714 <term>lcd [directory name]</term>
715 <listitem><para>If <replaceable>directory name</replaceable> is specified, the current
716 working directory on the local machine will be changed to
717 the directory specified. This operation will fail if for any
718 reason the specified directory is inaccessible. </para>
720 <para>If no directory name is specified, the name of the
721 current working directory on the local machine will be reported.
726 <term>link target linkname</term>
727 <listitem><para>This command depends on the server supporting the CIFS
728 UNIX extensions and will fail if the server does not. The client requests that the server
729 create a hard link between the linkname and target files. The linkname file
735 <term>listconnect</term>
736 <listitem><para>Show the current connections held for DFS purposes.
741 <term>lock <filenum> <r|w> <hex-start> <hex-len></term>
742 <listitem><para>This command depends on the server supporting the CIFS
743 UNIX extensions and will fail if the server does not. Tries to set a POSIX
744 fcntl lock of the given type on the given range. Used for internal Samba testing purposes.
749 <term>logon <username> <password></term>
750 <listitem><para>Establishes a new vuid for this session by logging on again.
751 Replaces the current vuid. Prints out the new vuid. Used for internal Samba testing purposes.
757 <listitem><para>Logs the user off the server, closing the session.
758 Used for internal Samba testing purposes.
763 <term>lowercase</term>
764 <listitem><para>Toggle lowercasing of filenames for the get and
768 <para>When lowercasing is toggled ON, local filenames are converted
769 to lowercase when using the get and mget commands. This is
770 often useful when copying (say) MSDOS files from a server, because
771 lowercase filenames are the norm on UNIX systems. </para></listitem>
775 <term>ls <mask></term>
776 <listitem><para>See the dir command above. </para></listitem>
780 <term>mask <mask></term>
781 <listitem><para>This command allows the user to set up a mask
782 which will be used during recursive operation of the mget and
783 mput commands. </para>
785 <para>The masks specified to the mget and mput commands act as
786 filters for directories rather than files when recursion is
789 <para>The mask specified with the mask command is necessary
790 to filter files within those directories. For example, if the
791 mask specified in an mget command is "source*" and the mask
792 specified with the mask command is "*.c" and recursion is
793 toggled ON, the mget command will retrieve all files matching
794 "*.c" in all directories below and including all directories
795 matching "source*" in the current working directory. </para>
797 <para>Note that the value for mask defaults to blank (equivalent
798 to "*") and remains so until the mask command is used to change it.
799 It retains the most recently specified value indefinitely. To
800 avoid unexpected results it would be wise to change the value of
801 mask back to "*" after using the mget or mput commands. </para></listitem>
805 <term>md <directory name></term>
806 <listitem><para>See the mkdir command. </para></listitem>
810 <term>mget <mask></term>
811 <listitem><para>Copy all files matching <replaceable>mask</replaceable> from the server to
812 the machine running the client. </para>
814 <para>Note that <replaceable>mask</replaceable> is interpreted differently during recursive
815 operation and non-recursive operation - refer to the recurse and
816 mask commands for more information. Note that all transfers in
817 <command>smbclient</command> are binary. See also the lowercase command. </para></listitem>
821 <term>mkdir <directory name></term>
822 <listitem><para>Create a new directory on the server (user access
823 privileges permitting) with the specified name. </para></listitem>
827 <term>more <file name></term>
828 <listitem><para>Fetch a remote file and view it with the contents
829 of your PAGER environment variable.
834 <term>mput <mask></term>
835 <listitem><para>Copy all files matching <replaceable>mask</replaceable> in the current working
836 directory on the local machine to the current working directory on
839 <para>Note that <replaceable>mask</replaceable> is interpreted differently during recursive
840 operation and non-recursive operation - refer to the recurse and mask
841 commands for more information. Note that all transfers in <command>smbclient</command>
842 are binary. </para></listitem>
847 <listitem><para>Query the remote server to see if it supports the CIFS UNIX
848 extensions and prints out the list of capabilities supported. If so, turn
849 on POSIX pathname processing and large file read/writes (if available),.
854 <term>posix_encrypt <domain> <username> <password></term>
855 <listitem><para>This command depends on the server supporting the CIFS
856 UNIX extensions and will fail if the server does not. Attempt to negotiate
857 SMB encryption on this connection. If smbclient connected with kerberos
858 credentials (-k) the arguments to this command are ignored and the kerberos
859 credentials are used to negotiate GSSAPI signing and sealing instead. See
860 also the -e option to smbclient to force encryption on initial connection.
861 This command is new with Samba 3.2.
866 <term>posix_open <filename> <octal mode></term>
867 <listitem><para>This command depends on the server supporting the CIFS
868 UNIX extensions and will fail if the server does not. Opens a remote file
869 using the CIFS UNIX extensions and prints a fileid. Used for internal Samba
875 <term>posix_mkdir <directoryname> <octal mode></term>
876 <listitem><para>This command depends on the server supporting the CIFS
877 UNIX extensions and will fail if the server does not. Creates a remote directory
878 using the CIFS UNIX extensions with the given mode.
883 <term>posix_rmdir <directoryname></term>
884 <listitem><para>This command depends on the server supporting the CIFS
885 UNIX extensions and will fail if the server does not. Deletes a remote directory
886 using the CIFS UNIX extensions.
891 <term>posix_unlink <filename></term>
892 <listitem><para>This command depends on the server supporting the CIFS
893 UNIX extensions and will fail if the server does not. Deletes a remote file
894 using the CIFS UNIX extensions.
899 <term>print <file name></term>
900 <listitem><para>Print the specified file from the local machine
901 through a printable service on the server. </para></listitem>
906 <listitem><para>Toggle prompting for filenames during operation
907 of the mget and mput commands. </para>
909 <para>When toggled ON, the user will be prompted to confirm
910 the transfer of each file during these commands. When toggled
911 OFF, all specified files will be transferred without prompting.
916 <term>put <local file name> [remote file name]</term>
917 <listitem><para>Copy the file called <filename>local file name</filename> from the
918 machine running the client to the server. If specified,
919 name the remote copy <filename>remote file name</filename>. Note that all transfers
920 in <command>smbclient</command> are binary. See also the lowercase command.
926 <listitem><para>Displays the print queue, showing the job id,
927 name, size and current status. </para></listitem>
932 <listitem><para>See the exit command. </para></listitem>
936 <term>readlink symlinkname</term>
937 <listitem><para>This command depends on the server supporting the CIFS
938 UNIX extensions and will fail if the server does not. Print
939 the value of the symlink "symlinkname".
944 <term>rd <directory name></term>
945 <listitem><para>See the rmdir command. </para></listitem>
950 <listitem><para>Toggle directory recursion for the commands mget
953 <para>When toggled ON, these commands will process all directories
954 in the source directory (i.e., the directory they are copying
955 from ) and will recurse into any that match the mask specified
956 to the command. Only files that match the mask specified using
957 the mask command will be retrieved. See also the mask command.
960 <para>When recursion is toggled OFF, only files from the current
961 working directory on the source machine that match the mask specified
962 to the mget or mput commands will be copied, and any mask specified
963 using the mask command will be ignored. </para></listitem>
967 <term>rename <old filename> <new filename></term>
968 <listitem><para>Rename files in the current working directory on the
969 server from <replaceable>old filename</replaceable> to
970 <replaceable>new filename</replaceable>. </para></listitem>
974 <term>rm <mask></term>
975 <listitem><para>Remove all files matching <replaceable>mask</replaceable> from the current
976 working directory on the server. </para></listitem>
980 <term>rmdir <directory name></term>
981 <listitem><para>Remove the specified directory (user access
982 privileges permitting) from the server. </para></listitem>
986 <term>setmode <filename> <perm=[+|\-]rsha></term>
987 <listitem><para>A version of the DOS attrib command to set
988 file permissions. For example: </para>
990 <para><command>setmode myfile +r </command></para>
992 <para>would make myfile read only. </para></listitem>
996 <term>showconnect</term>
997 <listitem><para>Show the currently active connection held for DFS purposes.
1002 <term>stat file</term>
1003 <listitem><para>This command depends on the server supporting the CIFS
1004 UNIX extensions and will fail if the server does not. The client requests the
1005 UNIX basic info level and prints out the same info that the Linux stat command
1006 would about the file. This includes the size, blocks used on disk, file type,
1007 permissions, inode number, number of links and finally the three timestamps
1008 (access, modify and change). If the file is a special file (symlink, character or
1009 block device, fifo or socket) then extra information may also be printed.
1014 <term>symlink target linkname</term>
1015 <listitem><para>This command depends on the server supporting the CIFS
1016 UNIX extensions and will fail if the server does not. The client requests that the server
1017 create a symbolic hard link between the target and linkname files. The linkname file
1018 must not exist. Note that the server will not create a link to any path that lies
1019 outside the currently connected share. This is enforced by the Samba server.
1024 <term>tar <c|x>[IXbgNa]</term>
1025 <listitem><para>Performs a tar operation - see the <parameter>-T
1026 </parameter> command line option above. Behavior may be affected
1027 by the tarmode command (see below). Using g (incremental) and N
1028 (newer) will affect tarmode settings. Note that using the "-" option
1029 with tar x may not work - use the command line option instead.
1034 <term>blocksize <blocksize></term>
1035 <listitem><para>Blocksize. Must be followed by a valid (greater
1036 than zero) blocksize. Causes tar file to be written out in
1037 <replaceable>blocksize</replaceable>*TBLOCK (usually 512 byte) blocks. </para></listitem>
1041 <term>tarmode <full|inc|reset|noreset></term>
1042 <listitem><para>Changes tar's behavior with regard to archive
1043 bits. In full mode, tar will back up everything regardless of the
1044 archive bit setting (this is the default mode). In incremental mode,
1045 tar will only back up files with the archive bit set. In reset mode,
1046 tar will reset the archive bit on all files it backs up (implies
1047 read/write share). </para></listitem>
1051 <term>unlock <filenum> <hex-start> <hex-len></term>
1052 <listitem><para>This command depends on the server supporting the CIFS
1053 UNIX extensions and will fail if the server does not. Tries to unlock a POSIX
1054 fcntl lock on the given range. Used for internal Samba testing purposes.
1060 <listitem><para>Prints the current volume name of the share.
1065 <term>vuid <number></term>
1066 <listitem><para>Changes the currently used vuid in the protocol to
1067 the given arbitrary number. Without an argument prints out the current
1068 vuid being used. Used for internal Samba testing purposes.
1073 <term>tcon <sharename></term>
1074 <listitem><para>Establishes a new tree connect (connection to a share).
1075 Replaces the current tree connect. Prints the new tid (tree id).
1076 Used for internal Samba testing purposes.
1082 <listitem><para>Close the current share connection (tree disconnect).
1083 Used for internal Samba testing purposes.
1088 <term>tid <number></term>
1089 <listitem><para>Changes the current tree id (tid) in the
1090 protocol to a new arbitrary number. Without an argument, it
1091 prints out the tid currently used.
1092 Used for internal Samba testing purposes.
1100 <title>NOTES</title>
1102 <para>Some servers are fussy about the case of supplied usernames,
1103 passwords, share names (AKA service names) and machine names.
1104 If you fail to connect try giving all parameters in uppercase.
1107 <para>It is often necessary to use the -n option when connecting
1108 to some types of servers. For example OS/2 LanManager insists
1109 on a valid NetBIOS name being used, so you need to supply a valid
1110 name that would be known to the server.</para>
1112 <para>smbclient supports long file names where the server
1113 supports the LANMAN2 protocol or above. </para>
1117 <title>ENVIRONMENT VARIABLES</title>
1119 <para>The variable <envar>USER</envar> may contain the
1120 username of the person using the client. This information is
1121 used only if the protocol level is high enough to support
1122 session-level passwords.</para>
1125 <para>The variable <envar>PASSWD</envar> may contain
1126 the password of the person using the client. This information is
1127 used only if the protocol level is high enough to support
1128 session-level passwords. </para>
1130 <para>The variable <envar>LIBSMB_PROG</envar> may contain
1131 the path, executed with system(), which the client should connect
1132 to instead of connecting to a server. This functionality is primarily
1133 intended as a development aid, and works best when using a LMHOSTS
1139 <title>INSTALLATION</title>
1141 <para>The location of the client program is a matter for
1142 individual system administrators. The following are thus
1143 suggestions only. </para>
1145 <para>It is recommended that the smbclient software be installed
1146 in the <filename>/usr/local/samba/bin/</filename> or <filename>
1147 /usr/samba/bin/</filename> directory, this directory readable
1148 by all, writeable only by root. The client program itself should
1149 be executable by all. The client should <emphasis>NOT</emphasis> be
1150 setuid or setgid! </para>
1152 <para>The client log files should be put in a directory readable
1153 and writeable only by the user. </para>
1155 <para>To test the client, you will need to know the name of a
1156 running SMB/CIFS server. It is possible to run <citerefentry><refentrytitle>smbd</refentrytitle>
1157 <manvolnum>8</manvolnum></citerefentry> as an ordinary user - running that server as a daemon
1158 on a user-accessible port (typically any port number over 1024)
1159 would provide a suitable test server. </para>
1164 <title>DIAGNOSTICS</title>
1166 <para>Most diagnostics issued by the client are logged in a
1167 specified log file. The log file name is specified at compile time,
1168 but may be overridden on the command line. </para>
1170 <para>The number and nature of diagnostics available depends
1171 on the debug level used by the client. If you have problems,
1172 set the debug level to 3 and peruse the log files. </para>
1177 <title>VERSION</title>
1179 <para>This man page is correct for version 3.2 of the Samba suite.</para>
1184 <title>AUTHOR</title>
1186 <para>The original Samba software and related utilities
1187 were created by Andrew Tridgell. Samba is now developed
1188 by the Samba Team as an Open Source project similar
1189 to the way the Linux kernel is developed.</para>
1191 <para>The original Samba man pages were written by Karl Auer.
1192 The man page sources were converted to YODL format (another
1193 excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
1194 ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
1195 release by Jeremy Allison. The conversion to DocBook for
1196 Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0
1197 was done by Alexander Bokovoy.</para>