-.\" This manpage has been automatically generated by docbook2man-spec
-.\" from a DocBook document. docbook2man-spec can be found at:
-.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/>
+.\" This manpage has been automatically generated by docbook2man
+.\" from a DocBook document. This tool can be found at:
+.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
.\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "SMBCLIENT" "1" "06 December 2001" "" ""
+.TH "SMBCLIENT" "1" "18 February 2003" "" ""
+
.SH NAME
smbclient \- ftp-like client to access SMB/CIFS resources on servers
.SH SYNOPSIS
-.sp
-\fBsmbclient\fR \fBservicename\fR [ \fBpassword\fR ] [ \fB-b <buffer size>\fR ] [ \fB-d debuglevel\fR ] [ \fB-D Directory\fR ] [ \fB-U username\fR ] [ \fB-W workgroup\fR ] [ \fB-M <netbios name>\fR ] [ \fB-m maxprotocol\fR ] [ \fB-A authfile\fR ] [ \fB-N\fR ] [ \fB-l logfile\fR ] [ \fB-L <netbios name>\fR ] [ \fB-I destinationIP\fR ] [ \fB-E <terminal code>\fR ] [ \fB-c <command string>\fR ] [ \fB-i scope\fR ] [ \fB-O <socket options>\fR ] [ \fB-p port\fR ] [ \fB-R <name resolve order>\fR ] [ \fB-s <smb config file>\fR ] [ \fB-T<c|x>IXFqgbNan\fR ]
+
+\fBsmbclient\fR \fBservicename\fR [ \fBpassword\fR ] [ \fB-b <buffer size>\fR ] [ \fB-d debuglevel\fR ] [ \fB-D Directory\fR ] [ \fB-U username\fR ] [ \fB-W workgroup\fR ] [ \fB-M <netbios name>\fR ] [ \fB-m maxprotocol\fR ] [ \fB-A authfile\fR ] [ \fB-N\fR ] [ \fB-l logfile\fR ] [ \fB-L <netbios name>\fR ] [ \fB-I destinationIP\fR ] [ \fB-E\fR ] [ \fB-c <command string>\fR ] [ \fB-i scope\fR ] [ \fB-O <socket options>\fR ] [ \fB-p port\fR ] [ \fB-R <name resolve order>\fR ] [ \fB-s <smb config file>\fR ] [ \fB-T<c|x>IXFqgbNan\fR ] [ \fB-k\fR ]
+
.SH "DESCRIPTION"
.PP
-This tool is part of the Sambasuite.
+This tool is part of the \fBSamba\fR(7) suite.
.PP
\fBsmbclient\fR is a client that can
\&'talk' to an SMB/CIFS server. It offers an interface
-similar to that of the ftp program (see \fBftp(1)\fR).
+similar to that of the ftp program (see \fBftp\fR(1)).
Operations include things like getting files from the server
to the local machine, putting files from the local machine to
the server, retrieving directory information from the server
servicename is the name of the service
you want to use on the server. A service name takes the form
\fI//server/service\fR where \fIserver
-\fRis the NetBIOS name of the SMB/CIFS server
+\fR is the NetBIOS name of the SMB/CIFS server
offering the desired service and \fIservice\fR
-is the name of the service offered. Thus to connect to
+is the name of the service offered. Thus to connect to
the service "printer" on the SMB/CIFS server "smbserver",
you would use the servicename \fI//smbserver/printer
\fR
+
Note that the server name required is NOT necessarily
-the IP (DNS) host name of the server ! The name required is
+the IP (DNS) host name of the server ! The name required is
a NetBIOS server name, which may or may not be the
same as the IP hostname of the machine running the server.
The server name is looked up according to either
the \fI-R\fR parameter to \fBsmbclient\fR or
-using the name resolve order parameter in the \fIsmb.conf\fR file,
+using the name resolve order parameter in
+the \fBsmb.conf\fR(5) file,
allowing an administrator to change the order and methods
by which server names are looked up.
.TP
Note: Some servers (including OS/2 and Windows for
Workgroups) insist on an uppercase password. Lowercase
-or mixed case passwords may be rejected by these servers.
+or mixed case passwords may be rejected by these servers.
Be cautious about including passwords in scripts.
.TP
\fB-s smb.conf\fR
-Specifies the location of the all important
-\fIsmb.conf\fR file.
+Specifies the location of the all
+important \fBsmb.conf\fR(5) file.
.TP
\fB-O socket options\fR
TCP socket options to set on the client
-socket. See the socket options parameter in the \fI smb.conf (5)\fR manpage for the list of valid
+socket. See the socket options parameter in
+the \fBsmb.conf\fR(5) manual page for the list of valid
options.
.TP
\fB-R <name resolve order>\fR
string of different name resolution options.
The options are :"lmhosts", "host", "wins" and "bcast". They
-cause names to be resolved as follows :
+cause names to be resolved as follows:
.RS
.TP 0.2i
\(bu
-lmhosts : Lookup an IP
+lmhosts: Lookup an IP
address in the Samba lmhosts file. If the line in lmhosts has
-no name type attached to the NetBIOS name (see the lmhosts(5)for details) then
+no name type attached to the NetBIOS name (see
+the \fBlmhosts\fR(5) for details) then
any name type matches for lookup.
.TP 0.2i
\(bu
-host : Do a standard host
+host: Do a standard host
name to IP address resolution, using the system \fI/etc/hosts
\fR, NIS, or DNS lookups. This method of name resolution
is operating system dependent, for instance on IRIX or Solaris this
may be controlled by the \fI/etc/nsswitch.conf\fR
-file). Note that this method is only used if the NetBIOS name
+file). Note that this method is only used if the NetBIOS name
type being queried is the 0x20 (server) name type, otherwise
it is ignored.
.TP 0.2i
\(bu
-wins : Query a name with
+wins: Query a name with
the IP address listed in the \fIwins server\fR
-parameter. If no WINS server has
+parameter. If no WINS server has
been specified this method will be ignored.
.TP 0.2i
\(bu
-bcast : Do a broadcast on
+bcast: Do a broadcast on
each of the known local interfaces listed in the
\fIinterfaces\fR
parameter. This is the least reliable of the name resolution
methods as it depends on the target host being on a locally
connected subnet.
.RE
-.PP
+
If this parameter is not set then the name resolve order
-defined in the \fIsmb.conf\fR file parameter
+defined in the \fBsmb.conf\fR(5) file parameter
(name resolve order) will be used.
-.PP
-.PP
+
The default order is lmhosts, host, wins, bcast and without
this parameter or any entry in the \fIname resolve order
-\fRparameter of the \fIsmb.conf\fR file the name resolution
+\fR parameter of the \fBsmb.conf\fR(5) file the name resolution
methods will be attempted in this order.
-.PP
.TP
\fB-M NetBIOS name\fR
This options allows you to send messages, using
is over 1600 bytes, as this is the limit of the protocol.
One useful trick is to cat the message through
-\fBsmbclient\fR. For example: \fB cat mymessage.txt | smbclient -M FRED \fR will
+\fBsmbclient\fR. For example: \fB cat mymessage.txt | smbclient -M FRED \fR will
send the message in the file \fImymessage.txt\fR
to the machine FRED.
\fI-I\fR options useful, as they allow you to
control the FROM and TO parts of the message.
-See the message command parameter in the \fI smb.conf(5)\fR for a description of how to handle incoming
+See the \fImessage command\fR parameter in the \fBsmb.conf\fR(5) for a description of how to handle incoming
WinPopup messages in Samba.
\fBNote\fR: Copy WinPopup into the startup group
Levels above 3 are designed for use only by developers and
generate HUGE amounts of log data, most of which is extremely
cryptic. If \fIdebuglevel\fR is set to the letter 'A', then \fBall
-\fRdebug messages will be printed. This setting
+\fR debug messages will be printed. This setting
is for developers only (and people who \fBreally\fR want
to know how the code works internally).
For example, if the name specified was "log", the debug file
would be \fIlog.client\fR.
-The log file generated is never removed by the client.
+The log file generated is never removed by the client.
.TP
\fB-h\fR
Print the usage message for the client.
to read the password.
A third option is to use a credentials file which
-contains the plaintext of the username and password. This
+contains the plaintext of the domain name, username and password. This
option is mainly provided for scripts where the admin doesn't
wish to pass the credentials on the command line or via environment
variables. If this method is used, make certain that the permissions
-on the file restrict access from unwanted users. See the
+on the file restrict access from unwanted users. See the
\fI-A\fR for more details.
Be cautious about including passwords in scripts or in
.TP
\fB-A filename\fR
This option allows
-you to specify a file from which to read the username and
-password used in the connection. The format of the file is
+you to specify a file from which to read the username, domain name, and
+password used in the connection. The format of the file is
+
-.sp
.nf
username = <value>
password = <value>
-
-.sp
+domain = <value>
.fi
-Make certain that the permissions on the file restrict
+If the domain parameter is missing the current workgroup name
+is used instead. Make certain that the permissions on the file restrict
access from unwanted users.
.TP
\fB-L\fR
This option allows you to look at what services
are available on a server. You use it as \fBsmbclient -L
-host\fR and a list should appear. The \fI-I
-\fRoption may be useful if your NetBIOS names don't
+host\fR and a list should appear. The \fI-I
+\fR option may be useful if your NetBIOS names don't
match your TCP/IP DNS host names or if you are trying to reach a
host on another network.
.TP
This option tells \fBsmbclient\fR how to interpret
filenames coming from the remote server. Usually Asian language
multibyte UNIX implementations use different character sets than
-SMB/CIFS servers (\fBEUC\fR instead of \fB SJIS\fR for example). Setting this parameter will let
+SMB/CIFS servers (\fBEUC\fR instead of \fB SJIS\fR for example). Setting this parameter will let
\fBsmbclient\fR convert between the UNIX filenames and
the SMB filenames correctly. This option has not been seriously tested
and may have some problems.
observed to speed up file transfers to and from a Win9x server.
.TP
\fB-W WORKGROUP\fR
-Override the default workgroup specified in the
-workgroup parameter of the \fIsmb.conf\fR file
-for this connection. This may be needed to connect to some
-servers.
+Override the default workgroup (domain) specified
+in the workgroup parameter of the \fBsmb.conf\fR(5) file for this connection. This may be
+needed to connect to some servers.
.TP
\fB-T tar options\fR
smbclient may be used to create \fBtar(1)
-\fRcompatible backups of all the files on an SMB/CIFS
+\fR compatible backups of all the files on an SMB/CIFS
share. The secondary tar flags that can be given to this option
are :
.RS
\fII\fR - Include files and directories.
Is the default behavior when filenames are specified above. Causes
tar files to be included in an extract or create (and therefore
-everything else to be excluded). See example below. Filename globbing
-works in one of two ways. See r below.
+everything else to be excluded). See example below. Filename globbing
+works in one of two ways. See r below.
.TP 0.2i
\(bu
\fIX\fR - Exclude files and directories.
Causes tar files to be excluded from an extract or create. See
-example below. Filename globbing works in one of two ways now.
+example below. Filename globbing works in one of two ways now.
See \fIr\fR below.
.TP 0.2i
\(bu
\fIb\fR - Blocksize. Must be followed
-by a valid (greater than zero) blocksize. Causes tar file to be
+by a valid (greater than zero) blocksize. Causes tar file to be
written out in blocksize*TBLOCK (usually 512 byte) blocks.
.TP 0.2i
\(bu
.TP 0.2i
\(bu
\fIq\fR - Quiet. Keeps tar from printing
-diagnostics as it works. This is the same as tarmode quiet.
+diagnostics as it works. This is the same as tarmode quiet.
.TP 0.2i
\(bu
\fIr\fR - Regular expression include
-or exclude. Uses regular expression matching for
-excluding or excluding files if compiled with HAVE_REGEX_H.
-However this mode can be very slow. If not compiled with
-HAVE_REGEX_H, does a limited wildcard match on '*' and '?'.
+or exclude. Uses regular expression matching for
+excluding or excluding files if compiled with HAVE_REGEX_H.
+However this mode can be very slow. If not compiled with
+HAVE_REGEX_H, does a limited wildcard match on '*' and '?'.
.TP 0.2i
\(bu
\fIN\fR - Newer than. Must be followed
archive bit to be reset when a file is backed up. Useful with the
\fIg\fR and \fIc\fR flags.
.RE
-.PP
+
\fBTar Long File Names\fR
-.PP
-.PP
+
\fBsmbclient\fR's tar option now supports long
file names both on backup and restore. However, the full path
-name of the file must be less than 1024 bytes. Also, when
+name of the file must be less than 1024 bytes. Also, when
a tar archive is created, \fBsmbclient\fR's tar option places all
files in the archive with relative names, not absolute names.
-.PP
-.PP
+
\fBTar Filenames\fR
-.PP
-.PP
-All file names can be given as DOS path names (with '\\'
+
+All file names can be given as DOS path names (with '\\\\'
as the component separator) or as UNIX path names (with '/' as
the component separator).
-.PP
-.PP
+
\fBExamples\fR
-.PP
-.PP
+
Restore from tar file \fIbackup.tar\fR into myshare on mypc
(no password on share).
-.PP
-.PP
+
\fBsmbclient //mypc/yshare "" -N -Tx backup.tar
-\fR.PP
-.PP
+\fR
+
Restore everything except \fIusers/docs\fR
-.PP
-.PP
+
\fBsmbclient //mypc/myshare "" -N -TXx backup.tar
users/docs\fR
-.PP
-.PP
-Create a tar file of the files beneath \fI users/docs\fR.
-.PP
-.PP
+
+Create a tar file of the files beneath \fI users/docs\fR.
+
\fBsmbclient //mypc/myshare "" -N -Tc
backup.tar users/docs \fR
-.PP
-.PP
+
Create the same tar file as above, but now use
a DOS path name.
-.PP
-.PP
+
\fBsmbclient //mypc/myshare "" -N -tc backup.tar
users\\edocs \fR
-.PP
-.PP
+
Create a tar file of all the files and directories in
the share.
-.PP
-.PP
+
\fBsmbclient //mypc/myshare "" -N -Tc backup.tar *
-\fR.PP
+\fR
.TP
\fB-D initial directory\fR
Change to initial directory before starting. Probably
.TP
\fB-c command string\fR
command string is a semicolon-separated list of
-commands to be executed instead of prompting from stdin. \fI -N\fR is implied by \fI-c\fR.
+commands to be executed instead of prompting from stdin. \fI -N\fR is implied by \fI-c\fR.
This is particularly useful in scripts and for printing stdin
to the server, e.g. \fB-c 'print -'\fR.
+.TP
+\fB-k\fR
+Try to authenticate with kerberos. Only useful in
+an Active Directory environment.
.SH "OPERATIONS"
.PP
Once the client is running, the user is presented with
.PP
smb:\\>
.PP
-The backslash ("\\") indicates the current working directory
+The backslash ("\\\\") indicates the current working directory
on the server, and will change if the current working directory
is changed.
.PP
carry out a user command. Each command is a single word, optionally
followed by parameters specific to that command. Command and parameters
are space-delimited unless these notes specifically
-state otherwise. All commands are case-insensitive. Parameters to
+state otherwise. All commands are case-insensitive. Parameters to
commands may or may not be case sensitive, depending on the command.
.PP
You can specify file names which have spaces in them by quoting
the name with double quotes, for example "a long file name".
.PP
Parameters shown in square brackets (e.g., "[parameter]") are
-optional. If not given, the command will use suitable defaults. Parameters
+optional. If not given, the command will use suitable defaults. Parameters
shown in angle brackets (e.g., "<parameter>") are required.
.PP
Note that all commands operating on the server are actually
.TP
\fB? [command]\fR
If \fIcommand\fR is specified, the ? command will display
-a brief informative message about the specified command. If no
+a brief informative message about the specified command. If no
command is specified, a list of available commands will
be displayed.
.TP
\fB! [shell command]\fR
-If \fIshell command\fR is specified, the !
+If \fIshell command\fR is specified, the !
command will execute a shell locally and run the specified shell
command. If no command is specified, a local shell will be run.
.TP
+\fBaltname file\fR
+The client will request that the server return
+the "alternate" name (the 8.3 name) for a file or directory.
+.TP
+\fBcancel jobid0 [jobid1] ... [jobidN]\fR
+The client will request that the server cancel
+the printjobs identified by the given numeric print job ids.
+.TP
+\fBchmod file mode in octal\fR
+This command depends on the server supporting the CIFS
+UNIX extensions and will fail if the server does not. The client requests that the server
+change the UNIX permissions to the given octal mode, in standard UNIX format.
+.TP
+\fBchown file uid gid\fR
+This command depends on the server supporting the CIFS
+UNIX extensions and will fail if the server does not. The client requests that the server
+change the UNIX user and group ownership to the given decimal values. Note there is
+currently no way to remotely look up the UNIX uid and gid values for a given name.
+This may be addressed in future versions of the CIFS UNIX extensions.
+.TP
\fBcd [directory name]\fR
If "directory name" is specified, the current
working directory on the server will be changed to the directory
\fBget <remote file name> [local file name]\fR
Copy the file called \fIremote file name\fR from
the server to the machine running the client. If specified, name
-the local copy \fIlocal file name\fR. Note that all transfers in
+the local copy \fIlocal file name\fR. Note that all transfers in
\fBsmbclient\fR are binary. See also the
lowercase command.
.TP
If no directory name is specified, the name of the
current working directory on the local machine will be reported.
.TP
+\fBlink source destination\fR
+This command depends on the server supporting the CIFS
+UNIX extensions and will fail if the server does not. The client requests that the server
+create a hard link between the source and destination files. The source file
+must not exist.
+.TP
\fBlowercase\fR
Toggle lowercasing of filenames for the get and
mget commands.
Remove the specified directory (user access
privileges permitting) from the server.
.TP
+\fBsetmode <filename> <perm=[+|\\-]rsha>\fR
+A version of the DOS attrib command to set
+file permissions. For example:
+
+\fBsetmode myfile +r \fR
+
+would make myfile read only.
+.TP
+\fBsymlink source destination\fR
+This command depends on the server supporting the CIFS
+UNIX extensions and will fail if the server does not. The client requests that the server
+create a symbolic hard link between the source and destination files. The source file
+must not exist. Note that the server will not create a link to any path that lies
+outside the currently connected share. This is enforced by the Samba server.
+.TP
\fBtar <c|x>[IXbgNa]\fR
Performs a tar operation - see the \fI-T
-\fRcommand line option above. Behavior may be affected
+\fR command line option above. Behavior may be affected
by the tarmode command (see below). Using g (incremental) and N
(newer) will affect tarmode settings. Note that using the "-" option
with tar x may not work - use the command line option instead.
tar will only back up files with the archive bit set. In reset mode,
tar will reset the archive bit on all files it backs up (implies
read/write share).
-.TP
-\fBsetmode <filename> <perm=[+|\\-]rsha>\fR
-A version of the DOS attrib command to set
-file permissions. For example:
-
-\fBsetmode myfile +r \fR
-
-would make myfile read only.
.SH "NOTES"
.PP
Some servers are fussy about the case of supplied usernames,
.SH "ENVIRONMENT VARIABLES"
.PP
The variable \fBUSER\fR may contain the
-username of the person using the client. This information is
-used only if the protocol level is high enough to support
+username of the person using the client. This information is
+used only if the protocol level is high enough to support
session-level passwords.
.PP
The variable \fBPASSWD\fR may contain
-the password of the person using the client. This information is
+the password of the person using the client. This information is
used only if the protocol level is high enough to support
session-level passwords.
.PP
The variable \fBLIBSMB_PROG\fR may contain
the path, executed with system(), which the client should connect
-to instead of connecting to a server. This functionality is primarily
+to instead of connecting to a server. This functionality is primarily
intended as a development aid, and works best when using a LMHOSTS
file
.SH "INSTALLATION"
and writeable only by the user.
.PP
To test the client, you will need to know the name of a
-running SMB/CIFS server. It is possible to run \fBsmbd(8)
-\fRas an ordinary user - running that server as a daemon
+running SMB/CIFS server. It is possible to run \fBsmbd\fR(8) as an ordinary user - running that server as a daemon
on a user-accessible port (typically any port number over 1024)
would provide a suitable test server.
.SH "DIAGNOSTICS"
set the debug level to 3 and peruse the log files.
.SH "VERSION"
.PP
-This man page is correct for version 2.2 of
-the Samba suite.
+This man page is correct for version 2.2 of the Samba suite.
.SH "AUTHOR"
.PP
The original Samba software and related utilities
.PP
The original Samba man pages were written by Karl Auer.
The man page sources were converted to YODL format (another
-excellent piece of Open Source software, available at
-ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0
-release by Jeremy Allison. The conversion to DocBook for
-Samba 2.2 was done by Gerald Carter
+excellent piece of Open Source software, available at ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0
+release by Jeremy Allison. The conversion to DocBook for
+Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0
+was done by Alexander Bokovoy.
git.samba.org / ira / wip.git / blobdiff