summaryrefslogtreecommitdiff
path: root/docs/manpages/rpcclient.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/manpages/rpcclient.1')
-rw-r--r--docs/manpages/rpcclient.1168
1 files changed, 104 insertions, 64 deletions
diff --git a/docs/manpages/rpcclient.1 b/docs/manpages/rpcclient.1
index afd75a6838..a359d6772f 100644
--- a/docs/manpages/rpcclient.1
+++ b/docs/manpages/rpcclient.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 "RPCCLIENT" "1" "18 March 2003" "" ""
+.TH "RPCCLIENT" "1" "24 March 2003" "" ""
.SH NAME
rpcclient \- tool for executing client side MS-RPC functions
@@ -27,27 +27,39 @@ NetBIOS name of Server to which to connect.
The server can be any SMB/CIFS server. The name is
resolved using the \fIname resolve order\fR line from \fBsmb.conf\fR(5).
.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-c|--command='command string'\fR
execute semicolon separated commands (listed
below))
.TP
-\fB-h|--help\fR
-Print a summary of command line options.
+\fB-I IP-address\fR
+\fIIP address\fR is the address of the server to connect to.
+It should be specified in standard "a.b.c.d" notation.
+
+Normally the client would attempt to locate a named
+SMB/CIFS server by looking it up via the NetBIOS name resolution
+mechanism described above in the \fIname resolve order\fR
+parameter above. Using this parameter will force the client
+to assume that the server is on the machine with the specified IP
+address and the NetBIOS name component of the resource being
+connected to will be ignored.
+
+There is no default for this parameter. If not supplied,
+it will be determined automatically by the client as described
+above.
+.TP
+\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
@@ -71,66 +83,94 @@ Note that specifying this parameter here will
override the log
level file.
.TP
-\fB-I IP-address\fR
-\fIIP address\fR is the address of the server to connect to.
-It should be specified in standard "a.b.c.d" notation.
-
-Normally the client would attempt to locate a named
-SMB/CIFS server by looking it up via the NetBIOS name resolution
-mechanism described above in the \fIname resolve order\fR
-parameter above. Using this parameter will force the client
-to assume that the server is on the machine with the specified IP
-address and the NetBIOS name component of the resource being
-connected to will be ignored.
-
-There is no default for this parameter. If not supplied,
-it will be determined automatically by the client as described
-above.
-.TP
\fB-l|--logfile=logbasename\fR
-File name for log/debug files. The extension
-\&'.client' will be appended. The log file is
+File name for log/debug files. The extension
+".client" will be appended. The log file is
never removed by the client.
.TP
-\fB-N|--nopass\fR
-instruct \fBrpcclient\fR not to ask
-for a password. By default, \fBrpcclient\fR will
-prompt for a password. See also the \fI-U\fR
-option.
+\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-s|--conf=smb.conf\fR
-Specifies the location of the all-important
-\fIsmb.conf\fR file.
+\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
+\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
+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
+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
+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 server's NetBIOS name,
-it causes the client to log on using the server's local SAM (as
-opposed to the Domain SAM).
+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-h|--help\fR
+Print a summary of command line options.
.SH "COMMANDS"
.PP
\fBLSARPC\fR