diff options
Diffstat (limited to 'docs/docbook/manpages/rpcclient.1.sgml')
| -rw-r--r-- | docs/docbook/manpages/rpcclient.1.sgml | 149 |
1 files changed, 119 insertions, 30 deletions
diff --git a/docs/docbook/manpages/rpcclient.1.sgml b/docs/docbook/manpages/rpcclient.1.sgml index 225bb064ff..10e0ff438d 100644 --- a/docs/docbook/manpages/rpcclient.1.sgml +++ b/docs/docbook/manpages/rpcclient.1.sgml @@ -1,7 +1,7 @@ <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ <!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> -<refentry id="rpcclient.1"> +<refentry id="rpcclient"> <refmeta> <refentrytitle>rpcclient</refentrytitle> @@ -36,8 +36,8 @@ <refsect1> <title>DESCRIPTION</title> - <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> - <manvolnum>7</manvolnum></citerefentry> suite.</para> + <para>This tool is part of the <ulink url="samba.7.html"> + Samba</ulink> suite.</para> <para><command>rpcclient</command> is a utility initially developed to test MS-RPC functionality in Samba itself. It has undergone @@ -56,18 +56,42 @@ <listitem><para>NetBIOS name of Server to which to connect. The server can be any SMB/CIFS server. The name is resolved using the <ulink url="smb.conf.5.html#NAMERESOLVEORDER"> - <parameter>name resolve order</parameter></ulink> line from <citerefentry><refentrytitle>smb.conf</refentrytitle> - <manvolnum>5</manvolnum></citerefentry>.</para></listitem> + <parameter>name resolve order</parameter></ulink> line from + <filename>smb.conf(5)</filename>.</para></listitem> </varlistentry> <varlistentry> + <term>-A|--authfile=filename</term> + <listitem><para>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 + </para> + + <para><programlisting> + username = <value> + password = <value> + domain = <value> + </programlisting></para> + + <para>Make certain that the permissions on the file restrict + access from unwanted users. </para></listitem> + </varlistentry> + + + + <varlistentry> <term>-c|--command='command string'</term> <listitem><para>execute semicolon separated commands (listed below)) </para></listitem> </varlistentry> - + + + + &stdarg.debuglevel; + &stdarg.help; + <varlistentry> <term>-I IP-address</term> <listitem><para><replaceable>IP address</replaceable> is the address of the server to connect to. @@ -86,10 +110,72 @@ above. </para></listitem> </varlistentry> - &popt.common.samba; - &popt.common.credentials; - &popt.common.connection; - &stdarg.help; + + <varlistentry> + <term>-l|--logfile=logbasename</term> + <listitem><para>File name for log/debug files. The extension + <constant>'.client'</constant> will be appended. The log file is + never removed by the client. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-N|--nopass</term> + <listitem><para>instruct <command>rpcclient</command> not to ask + for a password. By default, <command>rpcclient</command> will + prompt for a password. See also the <parameter>-U</parameter> + option.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>-s|--conf=smb.conf</term> + <listitem><para>Specifies the location of the all-important + <filename>smb.conf</filename> file. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-U|--user=username[%password]</term> + <listitem><para>Sets the SMB username or username and password. </para> + + <para>If %password is not specified, the user will be prompted. The + client will first check the <envar>USER</envar> environment variable, then the + <envar>LOGNAME</envar> variable and if either exists, the + string is uppercased. If these environmental variables are not + found, the username <constant>GUEST</constant> is used. </para> + + <para>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 + <parameter>-A</parameter> for more details. </para> + + <para>Be cautious about including passwords in scripts. Also, on + many systems the command line of a running process may be seen + via the <command>ps</command> command. To be safe always allow + <command>rpcclient</command> to prompt for a password and type + it in directly. </para></listitem> + </varlistentry> + + + + + <varlistentry> + <term>-W|--workgroup=domain</term> + <listitem><para>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). </para></listitem> + </varlistentry> + + </variablelist> </refsect1> @@ -128,10 +214,12 @@ </itemizedlist> <para> </para> + + <para><emphasis>SPOOLSS</emphasis></para> <itemizedlist> - <listitem><para><command>adddriver <arch> <config></command> + <listitem><para><command>adddriver <arch> <config></command> - Execute an AddPrinterDriver() RPC to install the printer driver information on the server. Note that the driver files should already exist in the directory returned by @@ -141,16 +229,16 @@ The <parameter>config</parameter> parameter is defined as follows: </para> -<para><programlisting> -Long Printer Name:\ -Driver File Name:\ -Data File Name:\ -Config File Name:\ -Help File Name:\ -Language Monitor Name:\ -Default Data Type:\ -Comma Separated list of Files -</programlisting></para> + <para><programlisting> + Long Printer Name:\ + Driver File Name:\ + Data File Name:\ + Config File Name:\ + Help File Name:\ + Language Monitor Name:\ + Default Data Type:\ + Comma Separated list of Files + </programlisting></para> <para>Any empty fields should be enter as the string "NULL". </para> @@ -160,7 +248,10 @@ Comma Separated list of Files be "NULL". On a remote NT print server, the Print Monitor for a driver must already be installed prior to adding the driver or else the RPC will fail. </para></listitem> - + + + + <listitem><para><command>addprinter <printername> <sharename> <drivername> <port></command> - Add a printer on the remote server. This printer @@ -296,7 +387,7 @@ Comma Separated list of Files <para>From Luke Leighton's original rpcclient man page:</para> - <para><emphasis>WARNING!</emphasis> The MSRPC over SMB code has + <para><emphasis>"WARNING!</emphasis> The MSRPC over SMB code has been developed from examining Network traces. No documentation is available from the original creators (Microsoft) on how MSRPC over SMB works, or how the individual MSRPC services work. Microsoft's @@ -304,13 +395,12 @@ Comma Separated list of Files to be... a bit flaky in places. </para> <para>The development of Samba's implementation is also a bit rough, - and as more of the services are understood, it can even result in - versions of <citerefentry><refentrytitle>smbd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>rpcclient</refentrytitle> - <manvolnum>1</manvolnum></citerefentry> that are incompatible for some commands or services. Additionally, + and as more of the services are understood, it can even result in + versions of <command>smbd(8)</command> and <command>rpcclient(1)</command> + that are incompatible for some commands or services. Additionally, the developers are sending reports to Microsoft, and problems found or reported to Microsoft are fixed in Service Packs, which may - result in incompatibilities.</para> + result in incompatibilities." </para> </refsect1> @@ -332,8 +422,7 @@ Comma Separated list of Files <para>The original rpcclient man page was written by Matthew Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter. 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.</para> + Carter.</para> </refsect1> </refentry> |