Add framework for net command manpage - still contains a lot of FIXME's...
authorJelmer Vernooij <jelmer@samba.org>
Wed, 2 Oct 2002 17:33:06 +0000 (17:33 +0000)
committerJelmer Vernooij <jelmer@samba.org>
Wed, 2 Oct 2002 17:33:06 +0000 (17:33 +0000)
(This used to be commit 1e7686e5e7952b9b6f0474bace43078d2f6cb871)

docs/docbook/manpages/net.8.sgml

index 5b822ccfe67c15cabdfff4ff35a8c4b6552ac242..8e777d2afee414645918e6008023e8b195d211e8 100644 (file)
        <cmdsynopsis>
                <command>net</command>
                <arg choice="req">&lt;ads|rap|rpc&gt;</arg>
+               <arg choice="opt">-h</arg>
+               <arg choice="opt">-w workgroup</arg>
+               <arg choice="opt">-W myworkgroup</arg>
+               <arg choice="opt">-U user</arg>
+               <arg choice="opt">-I ip-address</arg>
+               <arg choice="opt">-p port</arg>
+               <arg choice="opt">-n myname</arg>
+               <arg choice="opt">-s conffile</arg>
+               <arg choice="opt">-S server</arg>
+               <arg choice="opt">-C comment</arg>
+               <arg choice="opt">-M maxusers</arg>
+               <arg choice="opt">-F flags</arg>
+               <arg choice="opt">-j jobid</arg>
+               <arg choice="opt">-l</arg>
+               <arg choice="opt">-r</arg>
+               <arg choice="opt">-f</arg>
+               <arg choice="opt">-t timeout</arg>
+               <arg choice="opt">-P</arg>
+               <arg choice="opt">-D debuglevel</arg>
        </cmdsynopsis>
 </refsynopsisdiv>
 
        <para>This tool is part of the <ulink url="samba.7.html">
        Samba</ulink> suite.</para>
 
-</refsect1>
+       <para>The samba net utility is meant to work just like the net utility 
+       available for windows and DOS.</para>
 
+       FIXME
+</refsect1>
 
 <refsect1>
        <title>OPTIONS</title>
 
-       <para></para>
+       <variablelist>
+               <varlistentry>
+               <term>-h</term>
+               <listitem><para>
+               Display summary of all available options.
+               
+               </listitem></para>
+               </varlistentry>
+               
+               <varlistentry>
+               <term>-w target-workgroup</term>
+               <listitem><para>
+               Sets target workgroup or domain. You have to specify either this option or the IP address or the name of a server.
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>-W workgroup</term>
+               <listitem><para>
+               Sets client workgroup or domain
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>-U user</term>
+               <listitem><para>
+               User name to use
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>-I ip-address</term>
+               <listitem><para>
+               IP address of target server to use. You have to specify either this option or a target workgroup or a target server.
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>-p port</term>
+               <listitem><para>
+               Port on the target server to connect to.
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>-n myname</term>
+               <listitem><para>
+               Sets name of the client.
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>-s conffile</term>
+               <listitem><para>
+               Specify alternative configuration file that should be loaded.
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>-S server</term>
+               <listitem><para>
+               Name of target server. You should specify either this option or a target workgroup or a target IP address.
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>-C comment</term>
+               <listitem><para>
+               FIXME
+               </para></listitem>
+               </varlistentry>
 
+               <varlistentry>
+               <term>-M maxusers</term>
+               <listitem><para>
+               FIXME
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>-F flags</term>
+               <listitem><para>
+               FIXME
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>-j jobid</term>
+               <listitem><para>
+               FIXME
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>-l</term>
+               <listitem><para>
+               FIXME
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>-r</term>
+               <listitem><para>
+               FIXME
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>-f</term>
+               <listitem><para>
+               FIXME
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>-t timeout</term>
+               <listitem><para>
+               FIXME
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>-P</term>
+               <listitem><para>
+               Make queries to the external server using the machine account of the local server.
+               </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>
+       </variablelist>
 </refsect1>
 
 
 <refsect1>
-       <title>COMMANDS</title>
+       <title>TIME</title>
+
+       <para>The <command>NET TIME</command> command allows you to view the time on a remote server
+       or synchronise the time on the local server with the time on the remote server.
 
+       <variablelist>
+               <varlistentry>
+               <term></term>
+               <listitem><para>
+               Without any options, the <command>NET TIME</command> command 
+               displays the time on the remote server.
+               </para></listitem>
+               </varlistentry>
 
-       <para></para>
+               <varlistentry>
+               <term>SYSTEM</term>
+               <listitem><para>
+               Displays the time on the remote server in a format ready for /bin/date
+               </para></listitem>
+               </varlistentry>
 
+               <varlistentry>
+               <term>SET</term>
+               <listitem><para>
+               Tries to set the date and time of the local server to that on 
+               the remote server using /bin/date.
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>ZONE</term>
+               <listitem><para>
+               Displays the timezone in hours from GMT on the remote computer.
+               </para></listitem>
+               </varlistentry>
+       </variablelist>
 </refsect1>
 
+<refsect1>
+       <title>RPC</title>
+
+       <para>The <command>NET RPC</command> command allows you to do various 
+       NT4 operations.</para>
+
+       <variablelist>
+               <varlistentry>
+               <term>JOIN -U username[%password] [options]</term>
+               <listitem><para>
+               Join a domain with specified username and password. Password 
+               will be prompted if none is specified.</para>
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>JOIN [options except -U]</term>
+               <listitem><para>
+               to join a domain created in server manager
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>USER [misc. options] [targets]</term>
+               <listitem><para>
+               List users
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>USER DELETE &lt;name&gt; [misc options]</term>
+               <listitem><para>
+               delete specified user
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>USER INFO &lt;name&gt; [misc options]</term>
+               <listitem><para>
+               list the domain groups of the specified user
+               </listitem></para>
+               </varlistentry>
+
+               <varlistentry>
+               <term>USER ADD &lt;name&gt; [password] [-F user flags] [misc. options</term>
+               <listitem><para>
+               Add specified user
+               </listitem></para>
+               </varlistentry>
+
+               <varlistentry>
+               <term>GROUP [misc options] [targets]</term>
+               <listitem><para>
+               List user groups
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>GROUP DELETE &lt;name&gt; [misc. options] [targets]</term>
+               <listitem><para>
+               Delete specified group
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>GROUP ADD &lt;name&gt; [-C comment]</term>
+               <listitem><para>
+               Create specified group
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>SHARE [misc. options] [targets]</term>
+               <listitem><para>
+               enumerates all exported resources (network shares) on target server
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>SHARE ADD &lt;name=serverpath&gt; [misc. options] [targets]</term>
+               <listitem><para>
+               Adds a share from a server (makes the export active)
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>SHARE DELETE &lt;sharenam
+
+
+
 <refsect1>
        <title>VERSION</title>