Sync docbook directory with HEAD.
[kai/samba.git] / docs / docbook / manpages / rpcclient.1.sgml
index f32e2f9ece63dfd6ac979325bb76d01f6f8b3263..10e0ff438d5ade135b7ed78d2f18ddddfced4804 100644 (file)
@@ -1,4 +1,6 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
+]>
 <refentry id="rpcclient">
 
 <refmeta>
@@ -16,7 +18,6 @@
 <refsynopsisdiv>
        <cmdsynopsis>
                <command>rpcclient</command>
-               <arg choice="req">server</arg>
                <arg choice="opt">-A authfile</arg>
                <arg choice="opt">-c &lt;command string&gt;</arg>
                <arg choice="opt">-d debuglevel</arg>
@@ -27,6 +28,8 @@
                <arg choice="opt">-U username[%password]</arg>
                <arg choice="opt">-W workgroup</arg>
                <arg choice="opt">-N</arg>
+               <arg choice="opt">-I destinationIP</arg>
+               <arg choice="req">server</arg>
        </cmdsynopsis>
 </refsynopsisdiv>
 
@@ -59,7 +62,8 @@
 
 
                <varlistentry>
-               <term>-A filename</term><listitem><para>This option allows 
+               <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>
@@ -77,7 +81,7 @@
 
 
                <varlistentry>
-               <term>-c 'command string'</term>
+               <term>-c|--command='command string'</term>
                <listitem><para>execute semicolon separated commands (listed 
                below)) </para></listitem>
                </varlistentry>
                                
                
 
-               <varlistentry>
-               <term>-d debuglevel</term>
-               <listitem><para>set the debuglevel. Debug level 0 is the lowest 
-               and 100 being the highest. This should be set to 100 if you are
-               planning on submitting a bug report to the Samba team (see <filename>BUGS.txt</filename>). 
-               </para></listitem>
-               </varlistentry>
-               
-       
-
+               &stdarg.debuglevel;
+               &stdarg.help;
 
                <varlistentry>
-               <term>-h</term>
-               <listitem><para>Print a summary of command line options.
-               </para></listitem>
+               <term>-I IP-address</term>
+               <listitem><para><replaceable>IP address</replaceable> is the address of the server to connect to. 
+               It should be specified in standard "a.b.c.d" notation. </para>
+
+               <para>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 <parameter>name resolve order</parameter> 
+               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. </para>
+
+               <para>There is no default for this parameter. If not supplied, 
+               it will be determined automatically by the client as described 
+               above. </para></listitem>
                </varlistentry>
 
-
-
                
                <varlistentry>
-               <term>-l logbasename</term>
+               <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.
+               <constant>'.client'</constant> will be appended. The log file is
+               never removed by the client.
                </para></listitem>
                </varlistentry>
 
 
                
                <varlistentry>
-               <term>-N</term>
+               <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>
+               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 smb.conf</term>
-               <listitem><para>Specifies the location of the all important 
+               <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 username[%password]</term>
+               <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 
 
                <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 doesn'
-               desire to pass the credentials on the command line or via environment 
+               option is mainly provided for scripts where the admin does no
+               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>
                
                
                <varlistentry>
-               <term>-W domain</term>
+               <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, 
                of SIDs to usernames.
                </para></listitem>
                
-               <listitem><para><command>lookupnames</command> - Resolve s list 
+               <listitem><para><command>lookupnames</command> - Resolve a list 
                of usernames to SIDs.
                </para></listitem>
                
 
 
                <listitem><para><command>enumjobs &lt;printer&gt;</command> 
-               - List the jobs and status of a given printer.  
+               - List the jobs and status of a given printer. 
                This command corresponds to the MS Platform SDK EnumJobs() 
                function (* This command is currently unimplemented).</para></listitem>
                
 
                <listitem><para><command>getdriverdir &lt;arch&gt;</command> 
                - Execute a GetPrinterDriverDirectory()
-               RPC to retreive the SMB share name and subdirectory for 
+               RPC to retrieve the SMB share name and subdirectory for 
                storing printer driver files for a given architecture.  Possible 
                values for <parameter>arch</parameter> are "Windows 4.0" 
                (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows
                against a given printer. </para></listitem> 
 
 
-               <listitem><para><command>setdriver &lt;printername&gt; &lt;drivername&gt;</command> 
-               - Execute a SetPrinter() command to update the printer driver associated
-               with an installed printer.  The printer driver must already be correctly
-               installed on the print server.  </para>
+               <listitem><para><command>setdriver &lt;printername&gt;
+               &lt;drivername&gt;</command>
+               - Execute a SetPrinter() command to update the printer driver
+               associated with an installed printer.  The printer driver must
+               already be correctly installed on the print server.  </para>
 
                <para>See also the <command>enumprinters</command> and 
                <command>enumdrivers</command> commands for obtaining a list of
        <para><emphasis>GENERAL OPTIONS</emphasis></para>
 
        <itemizedlist>
-               <listitem><para><command>debuglevel</command> - Set the current debug level
-               used to log information.</para></listitem>
+               <listitem><para><command>debuglevel</command> - Set the current
+               debug level used to log information.</para></listitem>
 
                <listitem><para><command>help (?)</command> - Print a listing of all 
                known commands or extended help  on a particular command. 
 <refsect1>
        <title>VERSION</title>
 
-       <para>This man page is correct for version 2.2 of the Samba 
+       <para>This man page is correct for version 3.0 of the Samba 
        suite.</para>
 </refsect1>