summaryrefslogtreecommitdiff
path: root/docs/manpages/smbclient.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/manpages/smbclient.1')
-rw-r--r--docs/manpages/smbclient.1242
1 files changed, 124 insertions, 118 deletions
diff --git a/docs/manpages/smbclient.1 b/docs/manpages/smbclient.1
index 3d193b0c62..6ba48185a3 100644
--- a/docs/manpages/smbclient.1
+++ b/docs/manpages/smbclient.1
@@ -3,7 +3,7 @@
.\" <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" "18 March 2003" "" ""
+.TH "SMBCLIENT" "1" "24 March 2003" "" ""
.SH NAME
smbclient \- ftp-like client to access SMB/CIFS resources on servers
@@ -67,16 +67,6 @@ 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 \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 \fBsmb.conf\fR(5) manual page for the list of valid
-options.
-.TP
\fB-R <name resolve order>\fR
This option is used by the programs in the Samba
suite to determine what naming services and in what order to resolve
@@ -158,57 +148,6 @@ WinPopup messages in Samba.
on your WfWg PCs if you want them to always be able to receive
messages.
.TP
-\fB-i scope\fR
-This specifies a NetBIOS scope that smbclient will
-use to communicate with when generating NetBIOS names. For details
-on the use of NetBIOS scopes, see \fIrfc1001.txt\fR
-and \fIrfc1002.txt\fR.
-NetBIOS scopes are \fBvery\fR rarely used, only set
-this parameter if you are the system administrator in charge of all
-the NetBIOS systems you communicate with.
-.TP
-\fB-N\fR
-If specified, this parameter suppresses the normal
-password prompt from the client to the user. This is useful when
-accessing a service that does not require a password.
-
-Unless a password is specified on the command line or
-this parameter is specified, the client will request a
-password.
-.TP
-\fB-n NetBIOS name\fR
-By default, the client will use the local
-machine's hostname (in uppercase) as its NetBIOS name. This parameter
-allows you to override the host name and use whatever NetBIOS
-name you wish.
-.TP
-\fB-d debuglevel\fR
-\fIdebuglevel\fR is an integer from 0 to 10, or
-the letter 'A'.
-
-The default value if this parameter is not specified
-is zero.
-
-The higher this value, the more detail will be logged to
-the log files about the activities of the
-client. At level 0, only critical errors and serious warnings will
-be logged. Level 1 is a reasonable level for day to day running -
-it generates a small amount of information about operations
-carried out.
-
-Levels above 1 will generate considerable amounts of log
-data, and should only be used when investigating a problem.
-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
-\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).
-
-Note that specifying this parameter here will override
-the log level parameter in the \fIsmb.conf (5)\fR
-file.
-.TP
\fB-p port\fR
This number is the TCP port number that will be used
when making connections to the server. The standard (well-known)
@@ -228,8 +167,8 @@ would be \fIlog.client\fR.
The log file generated is never removed by the client.
.TP
-\fB-h\fR
-Print the usage message for the client.
+\fB-h|--help\fR
+Print a summary of command line options.
.TP
\fB-I IP-address\fR
\fIIP address\fR is the address of the server to connect to.
@@ -255,52 +194,6 @@ output stream.
By default, the client writes messages to standard output
- typically the user's tty.
.TP
-\fB-U username[%pass]\fR
-Sets the SMB username or username and password.
-If %pass is not specified, The user will be prompted. The client
-will first check the \fBUSER\fR environment variable, then the
-\fBLOGNAME\fR variable and if either exists, the
-string is uppercased. Anything in these variables following a '%'
-sign will be treated as the password. If these environment
-variables are not found, the username GUEST
-is used.
-
-If the password is not included in these environment
-variables (using the %pass syntax), \fBsmbclient\fR will look for
-a \fBPASSWD\fR environment variable from which
-to read the password.
-
-A third option is to use a credentials file which
-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
-\fI-A\fR for more details.
-
-Be cautious about including passwords in scripts or in
-the \fBPASSWD\fR environment variable. Also, on
-many systems the command line of a running process may be seen
-via the \fBps\fR command to be safe always allow
-\fBsmbclient\fR to prompt for a password and type
-it in directly.
-.TP
-\fB-A filename\fR
-This option allows
-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
-
-
-.nf
-username = <value>
-password = <value>
-domain = <value>
-.fi
-
-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
@@ -328,10 +221,127 @@ size when getting or putting a file from/to the server. The default
is 65520 bytes. Setting this value smaller (to 1200 bytes) has been
observed to speed up file transfers to and from a Win9x server.
.TP
-\fB-W WORKGROUP\fR
-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.
+\fB-V\fR
+Prints the version number for
+\fBsmbd\fR.
+.TP
+\fB-s <configuration file>\fR
+The file specified contains the
+configuration details required by the server. The
+information in this file includes server-specific
+information such as what printcap file to use, as well
+as descriptions of all the services that the server is
+to provide. See \fIsmb.conf(5)\fR for more information.
+The default configuration file name is determined at
+compile time.
+.TP
+\fB-d|--debug=debuglevel\fR
+\fIdebuglevel\fR is an integer
+from 0 to 10. The default value if this parameter is
+not specified is zero.
+
+The higher this value, the more detail will be
+logged to the log files about the activities of the
+server. At level 0, only critical errors and serious
+warnings will be logged. Level 1 is a reasonable level for
+day to day running - it generates a small amount of
+information about operations carried out.
+
+Levels above 1 will generate considerable
+amounts of log data, and should only be used when
+investigating a problem. Levels above 3 are designed for
+use only by developers and generate HUGE amounts of log
+data, most of which is extremely cryptic.
+
+Note that specifying this parameter here will
+override the log
+level file.
+.TP
+\fB-l|--logfile=logbasename\fR
+File name for log/debug files. The extension
+".client" will be appended. The log file is
+never removed by the client.
+.TP
+\fB-N\fR
+If specified, this parameter suppresses the normal
+password prompt from the client to the user. This is useful when
+accessing a service that does not require a password.
+
+Unless a password is specified on the command line or
+this parameter is specified, the client will request a
+password.
+.TP
+\fB-k\fR
+Try to authenticate with kerberos. Only useful in
+an Active Directory environment.
+.TP
+\fB-A|--authfile=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
+
+
+.nf
+username = <value>
+password = <value>
+domain = <value>
+.fi
+
+Make certain that the permissions on the file restrict
+access from unwanted users.
+.TP
+\fB-U|--user=username[&%;password]\fR
+Sets the SMB username or username and password.
+
+If &%;password is not specified, the user will be prompted. The
+client will first check the \fBUSER\fR environment variable, then the
+\fBLOGNAME\fR variable and if either exists, the
+string is uppercased. If these environmental variables are not
+found, the username GUEST is used.
+
+A third option is to use a credentials file which
+contains the plaintext of the username and password. This
+option is mainly provided for scripts where the admin does not
+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
+\fI-A\fR for more details.
+
+Be cautious about including passwords in scripts. Also, on
+many systems the command line of a running process may be seen
+via the \fBps\fR command. To be safe always allow
+\fBrpcclient\fR to prompt for a password and type
+it in directly.
+.TP
+\fB-n <primary NetBIOS name>\fR
+This option allows you to override
+the NetBIOS name that Samba uses for itself. This is identical
+to setting the \fINetBIOS
+name\fR parameter in the \fBsmb.conf\fR(5) file. However, a command
+line setting will take precedence over settings in
+\fBsmb.conf\fR(5).
+.TP
+\fB-i <scope>\fR
+This specifies a NetBIOS scope that
+\fBnmblookup\fR will use to communicate with when
+generating NetBIOS names. For details on the use of NetBIOS
+scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are
+\fBvery\fR rarely used, only set this parameter
+if you are the system administrator in charge of all the
+NetBIOS systems you communicate with.
+.TP
+\fB-W|--workgroup=domain\fR
+Set the SMB domain of the username. This
+overrides the default domain which is the domain defined in
+smb.conf. If the domain specified is the same as the servers
+NetBIOS name, it causes the client to log on using the servers local
+SAM (as opposed to the Domain SAM).
+.TP
+\fB-O socket options\fR
+TCP socket options to set on the client
+socket. See the socket options parameter in
+the \fBsmb.conf\fR(5) manual page for the list of valid
+options.
.TP
\fB-T tar options\fR
smbclient may be used to create \fBtar(1)
@@ -459,10 +469,6 @@ commands to be executed instead of prompting from stdin. \fI -N\fR is implied b
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