doc: add FSRVP commands to rpcclient man page
[obnox/samba/samba-obnox.git] / docs-xml / manpages-3 / rpcclient.1.xml
index b9f5afbf47296cb46e354037a59bce7d286dbdda..4e3d30c0970b6e84db0d78595a78e9b122f0c6a2 100644 (file)
@@ -7,7 +7,7 @@
        <manvolnum>1</manvolnum>
        <refmiscinfo class="source">Samba</refmiscinfo>
        <refmiscinfo class="manual">User Commands</refmiscinfo>
-       <refmiscinfo class="version">3.2</refmiscinfo>
+       <refmiscinfo class="version">3.6</refmiscinfo>
 </refmeta>
 
 
@@ -29,7 +29,6 @@
                <arg choice="opt">-s &lt;smb config file&gt;</arg>
                <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>
 
 
                <varlistentry>
-               <term>-c|--command='command string'</term>
-               <listitem><para>execute semicolon separated commands (listed 
-               below)) </para></listitem>
+               <term>-c|--command=&lt;command string&gt;</term>
+               <listitem><para>Execute semicolon separated commands (listed
+               below) </para></listitem>
                </varlistentry>
 
                
                <varlistentry>
-               <term>-I IP-address</term>
+               <term>-I|--dest-ip 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>
 
                above. </para></listitem>
                </varlistentry>
 
+               <varlistentry>
+               <term>-p|--port port</term>
+               <listitem><para>This number is the TCP port number that will be used
+               when making connections to the server. The standard (well-known)
+               TCP port number for an SMB/CIFS server is 139, which is the
+               default. </para></listitem>
+               </varlistentry>
+
                &stdarg.server.debug;
                &popt.common.samba;
                &popt.common.credentials;               
                of usernames to SIDs.
                </para></listitem></varlistentry>
                
-               <varlistentry><term>enumtrusts</term><listitem><para>Enumerate trusted domains</para></listitem></varlistentry>
+               <varlistentry><term>enumtrust</term><listitem><para>Enumerate trusted domains</para></listitem></varlistentry>
 
                <varlistentry><term>enumprivs</term><listitem><para>Enumerate privileges</para></listitem></varlistentry>
 
@@ -260,16 +267,19 @@ Comma Separated list of Files
                </listitem></varlistentry>
 
 
-               <varlistentry><term>deldriver</term><listitem><para>Delete the 
+               <varlistentry><term>deldriver &lt;driver&gt;</term><listitem><para>Delete the
                specified printer driver for all architectures.  This
                does not delete the actual driver files from the server,
                only the entry from the server's list of drivers.
                </para></listitem></varlistentry>
 
-               <varlistentry><term>deldriverex &lt;driver&gt; [architecture] [version]
-               </term><listitem><para>Delete the specified printer driver including driver files. 
-               You can limit this action to a specific architecture and a specific version. 
-               If no architecure is given, all driver files of that driver will be deleted. 
+               <varlistentry><term>deldriverex &lt;driver&gt; [architecture] [version] [flags]
+               </term><listitem><para>Delete the specified printer driver and optionally files
+               associated with the driver.
+               You can limit this action to a specific architecture and a specific version.
+               If no architecture is given, all driver files of that driver will be deleted.
+               <parameter>flags</parameter> correspond to numeric DPD_* values, i.e. a value
+               of 3 requests (DPD_DELETE_UNUSED_FILES | DPD_DELETE_SPECIFIC_VERSION).
                </para></listitem></varlistentry>
 
                <varlistentry><term>enumdata</term><listitem><para>Enumerate all 
@@ -416,6 +426,51 @@ Comma Separated list of Files
        </variablelist>
        </refsect2>
 
+       <refsect2>
+       <title>FSRVP</title>
+       <variablelist>
+
+       <varlistentry><term>fss_is_path_sup</term>
+               <listitem>
+                       <para>Check whether a share supports shadow-copy
+                       requests</para>
+               </listitem>
+       </varlistentry>
+       <varlistentry><term>fss_get_sup_version</term>
+               <listitem>
+                       <para>Get supported FSRVP version from server</para>
+               </listitem>
+       </varlistentry>
+       <varlistentry><term>fss_create_expose</term>
+               <listitem>
+                       <para>Request shadow-copy creation and exposure</para>
+               </listitem>
+       </varlistentry>
+       <varlistentry><term>fss_delete</term>
+               <listitem>
+                       <para>Request shadow-copy share deletion</para>
+       </listitem>
+       </varlistentry>
+       <varlistentry><term>fss_has_shadow_copy</term>
+               <listitem>
+                       <para>Check for an associated share shadow-copy</para>
+               </listitem>
+       </varlistentry>
+       <varlistentry><term>fss_get_mapping</term>
+               <listitem>
+                       <para>Get shadow-copy share mapping information</para>
+               </listitem>
+       </varlistentry>
+       <varlistentry><term>fss_recovery_complete</term>
+               <listitem>
+                       <para>Flag read-write snapshot as recovery complete,
+                       allowing further shadow-copy requests</para>
+               </listitem>
+       </varlistentry>
+
+       </variablelist>
+       </refsect2>
+
        <refsect2>
        <title>GENERAL COMMANDS</title>
 
@@ -465,7 +520,7 @@ Comma Separated list of Files
 <refsect1>
        <title>VERSION</title>
 
-       <para>This man page is correct for version 3.0 of the Samba 
+       <para>This man page is correct for version 3 of the Samba 
        suite.</para>
 </refsect1>