update wbinfo manpage
authorHerb Lewis <herb@samba.org>
Wed, 19 Jul 2006 20:39:44 +0000 (20:39 +0000)
committerGerald W. Carter <jerry@samba.org>
Wed, 23 Apr 2008 13:47:21 +0000 (08:47 -0500)
(This used to be commit 40abd42cafc0144052095adbb5d61a76afde2fc3)

docs/manpages-3/wbinfo.1.xml

index 9dd55a7ec2968c556412672f15c8b06836409ee5..7b5a46275ebfe6d385d0067cbeb69db8c517f600 100644 (file)
        <cmdsynopsis>
                <command>wbinfo</command>
                <arg choice="opt">-a user%password</arg>
-               <arg choice="opt">-c username</arg>
-               <arg choice="opt">-C groupname</arg>
+               <arg choice="opt">--all-domains</arg>
+               <arg choice="opt">--allocate-gid</arg>
+               <arg choice="opt">--allocate-uid</arg>
+               <arg choice="opt">-D domain</arg>
                <arg choice="opt">--domain domain</arg>
-               <arg choice="opt">-I ip</arg>
-               <arg choice="opt">-s sid</arg>
-               <arg choice="opt">-u</arg>
-               <arg choice="opt">-U uid</arg>
                <arg choice="opt">-g</arg>
+               <arg choice="opt">--getdcname domain</arg>
                <arg choice="opt">--get-auth-user</arg>
                <arg choice="opt">-G gid</arg>
+               <arg choice="opt">-h</arg>
+               <arg choice="opt">-i user</arg>
+               <arg choice="opt">-I ip</arg>
+               <arg choice="opt">-K user%password</arg>
                <arg choice="opt">-m</arg>
                <arg choice="opt">-n name</arg>
                <arg choice="opt">-N netbios-name</arg>
-               <arg choice="opt">-o user:group</arg>
-               <arg choice="opt">-O user:group</arg>
+               <arg choice="opt">--own-domain</arg>
                <arg choice="opt">-p</arg>
                <arg choice="opt">-r user</arg>
-               <arg choice="opt">--set-auth-user user%password</arg>
+               <arg choice="opt">-s sid</arg>
+               <arg choice="opt">--separator</arg>
                <arg choice="opt">--sequence</arg>
+               <arg choice="opt">--set-auth-user user%password</arg>
                <arg choice="opt">-S sid</arg>
                <arg choice="opt">-t</arg>
-               <arg choice="opt">-x username</arg>
-               <arg choice="opt">-X groupname</arg>
+               <arg choice="opt">-u</arg>
+               <arg choice="opt">--user-domgroups sid</arg>
+               <arg choice="opt">--user-sids sid</arg>
+               <arg choice="opt">-U uid</arg>
+               <arg choice="opt">-V</arg>
                <arg choice="opt">-Y sid</arg>
        </cmdsynopsis>
 </refsynopsisdiv>
@@ -65,7 +72,7 @@
 
        <variablelist>          
                <varlistentry>
-               <term>-a username%password</term>
+               <term>-a|--authenticate username%password</term>
                <listitem><para>Attempt to authenticate a user via winbindd. 
                 This checks both authenticaion methods and reports its results.
                </para><note><para>Do not be tempted to use this
                </varlistentry>
 
                <varlistentry>
-               <term>-c user</term>
-               <listitem><para>Create a local winbind user.
+               <term>--allocate-gid</term>
+               <listitem><para>Get a new GID out of idmap
                </para></listitem>
                </varlistentry>
-               
+
                <varlistentry>
-               <term>-C group</term>
-               <listitem><para>Create a local winbindd group.
+               <term>--allocate-uid</term>
+               <listitem><para>Get a new UID out of idmap
                </para></listitem>
                </varlistentry>
-               
+
+               <varlistentry>
+               <term>--all-domains</term>
+               <listitem><para>List all domains (trusted and 
+               own domain).
+               </para></listitem>
+               </varlistentry>
+
                <varlistentry>
                <term>--domain name</term>
                <listitem><para>This parameter sets the domain on which any specified
                </varlistentry>
 
                <varlistentry>
-               <term>-g</term>
+               <term>-D|--domain-info domain</term>
+               <listitem><para>Show most of the info we have about the domain.
+               </para></listitem>
+               </varlistentry>
+               
+               <varlistentry>
+               <term>-g|--domain-groups</term>
                <listitem><para>This option will list all groups available 
                in the Windows NT domain for which the <citerefentry><refentrytitle>samba</refentrytitle>
                <manvolnum>7</manvolnum></citerefentry> daemon is operating in. Groups in all trusted domains
                <term>--get-auth-user</term>
                <listitem><para>Print username and password used by winbindd
                during session setup to a domain controller. Username 
-               and password can be set using '-A'. Only available for 
-               root.</para></listitem>
+               and password can be set using <option>--set-auth-user</option>. 
+               Only available for root.</para></listitem>
+               </varlistentry>
+               
+               <varlistentry>
+               <term>--getdcname domain</term>
+               <listitem><para>Get the DC name for the specified domain.
+               </para></listitem>
                </varlistentry>
                
                <varlistentry>
-               <term>-G gid</term>
+               <term>-G|--gid-to-sid gid</term>
                <listitem><para>Try to convert a UNIX group id to a Windows 
                NT SID.  If the gid specified does not refer to one within 
                the idmap gid range then the operation will fail. </para></listitem>
                </varlistentry>
                
                <varlistentry>
-               <term>-I ip</term>
+               <term>-i|--user-info user</term>
+               <listitem><para>Get user info.
+               </para></listitem>
+               </varlistentry>
+               
+               <varlistentry>
+               <term>-I|--WINS-by-ip ip</term>
                <listitem><para>The <parameter>-I</parameter> option 
                queries <citerefentry><refentrytitle>winbindd</refentrytitle>
                <manvolnum>8</manvolnum></citerefentry> to send a node status
                </para></listitem>
                </varlistentry>
 
+               <varlistentry>
+               <term>-K|--krb5auth username%password</term>
+               <listitem><para>Attempt to authenticate a user via Kerberos. 
+               </para></listitem>
+               </varlistentry>
 
                <varlistentry>
-               <term>-m</term>
+               <term>-m|--trusted-domains</term>
                <listitem><para>Produce a list of domains trusted by the 
                Windows NT server <citerefentry><refentrytitle>winbindd</refentrytitle>
                <manvolnum>8</manvolnum></citerefentry> contacts 
                </varlistentry>
                
                <varlistentry>
-               <term>-n name</term>
+               <term>-n|--name-to-sid name</term>
                <listitem><para>The <parameter>-n</parameter> option 
                queries <citerefentry><refentrytitle>winbindd</refentrytitle>
                <manvolnum>8</manvolnum></citerefentry> for the SID             
                </varlistentry>
                
                <varlistentry>
-               <term>-N name</term>
+               <term>-N|--WINS-by-name name</term>
                <listitem><para>The <parameter>-N</parameter> option 
                queries <citerefentry><refentrytitle>winbindd</refentrytitle>
                <manvolnum>8</manvolnum></citerefentry> to query the WINS
                </varlistentry>
 
                <varlistentry>
-               <term>-o user:group</term>
-               <listitem><para>Add a winbindd local group as a secondary group 
-               for the specified winbindd local user.
-               </para></listitem>
-               </varlistentry>
-               
-               <varlistentry>
-               <term>-O user:group</term>
-               <listitem><para>Remove a winbindd local group as a secondary group 
-               for the specified winbindd local user.
+               <term>--own-domain</term>
+               <listitem><para>List own domain.
                </para></listitem>
                </varlistentry>
-               
+
                <varlistentry>
-               <term>-p</term>
+               <term>-p|--ping</term>
                <listitem><para>Check whether winbindd is still alive. 
                Prints out either 'succeeded' or 'failed'.
                </para></listitem>
                </varlistentry>
 
                <varlistentry>
-               <term>-r username</term>
+               <term>-r|--user-groups username</term>
                <listitem><para>Try to obtain the list of UNIX group ids
                to which the user belongs.  This only works for users
                defined on a Domain Controller.
                </varlistentry>
                
                <varlistentry>
-               <term>-s sid</term>
+               <term>-s|--sid-to-name sid</term>
                <listitem><para>Use <parameter>-s</parameter> to resolve
                a SID to a name.  This is the inverse of the <parameter>-n
                </parameter> option above.  SIDs must be specified as ASCII strings 
                S-1-5-21-1455342024-3071081365-2475485837-500. </para></listitem>
                </varlistentry>
 
+               <varlistentry>
+               <term>--separator</term>
+               <listitem><para>Get the active winbind separator.
+               </para></listitem>
+
+               </varlistentry>
+               <varlistentry>
+               <term>--sequence</term>
+               <listitem><para>Show sequence numbers of 
+               all known domains</para></listitem>
+               </varlistentry>
+               
                <varlistentry>
                <term>--set-auth-user username%password</term>
                <listitem><para>Store username and password used by winbindd 
                </varlistentry>
 
                <varlistentry>
-               <term>--sequence</term>
-               <listitem><para>Show sequence numbers of 
-               all known domains</para></listitem>
-               </varlistentry>
-               
-               <varlistentry>
-               <term>-S sid</term>
+               <term>-S|--sid-to-uid sid</term>
                <listitem><para>Convert a SID to a UNIX user id.  If the SID 
                does not correspond to a UNIX user mapped by <citerefentry>
                <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
                </varlistentry>
 
                <varlistentry>
-               <term>-t</term>
+               <term>-t|--check-secret</term>
                <listitem><para>Verify that the workstation trust account 
                created when the Samba server is added to the Windows NT
                domain is working. </para></listitem>
                </varlistentry>
 
                <varlistentry>
-               <term>-u</term>
+               <term>-u|--domain-users</term>
                <listitem><para>This option will list all users available 
                in the Windows NT domain for which the <citerefentry><refentrytitle>winbindd</refentrytitle>
                <manvolnum>8</manvolnum></citerefentry> daemon is operating in. Users in all trusted domains 
                </varlistentry>
                
                <varlistentry>
-               <term>-U uid</term>
-               <listitem><para>Try to convert a UNIX user id to a Windows NT 
-               SID.  If the uid specified does not refer to one within
-               the idmap uid range then the operation will fail. </para></listitem>
+               <term>--user-domgroups SID</term>
+               <listitem><para>Get user domain groups.
+               </para></listitem>
                </varlistentry>
                
                <varlistentry>
-               <term>-x user</term>
-               <listitem><para>Delete an existing local winbind user.
+               <term>--user-sids SID</term>
+               <listitem><para>Get user group SIDs for user.
                </para></listitem>
                </varlistentry>
                
                <varlistentry>
-               <term>-X group</term>
-               <listitem><para>Delete an existing local winbindd group.
-               </para></listitem>
+               <term>-U|--uid-to-sid uid</term>
+               <listitem><para>Try to convert a UNIX user id to a Windows NT 
+               SID.  If the uid specified does not refer to one within
+               the idmap uid range then the operation will fail. </para></listitem>
                </varlistentry>
                
                <varlistentry>
-               <term>-Y sid</term>
+               <term>-Y|--sid-to-gid sid</term>
                <listitem><para>Convert a SID to a UNIX group id.  If the SID 
                does not correspond to a UNIX group mapped by <citerefentry>
                <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry> then