s3-docs: mention long and undocumented option names in pdbedit manpage.

Guenther

1 files changed, 124 insertions, 44 deletions

diff --git a/docs-xml/manpages-3/pdbedit.8.xml b/docs-xml/manpages-3/pdbedit.8.xml
index d0ea811838..86a566d1f2 100644
--- a/docs-xml/manpages-3/pdbedit.8.xml
+++ b/docs-xml/manpages-3/pdbedit.8.xml
@@ -19,30 +19,40 @@
 <refsynopsisdiv>
 	<cmdsynopsis>
 		<command>pdbedit</command>
-		<arg choice="opt">-L</arg>	
-		<arg choice="opt">-v</arg>	
-		<arg choice="opt">-w</arg>	
-		<arg choice="opt">-u username</arg>	
-		<arg choice="opt">-f fullname</arg>	
-		<arg choice="opt">-h homedir</arg>	
-		<arg choice="opt">-D drive</arg>	
-		<arg choice="opt">-S script</arg>
-		<arg choice="opt">-p profile</arg>	
-		<arg choice="opt">-a</arg>	
-		<arg choice="opt">-t, --password-from-stdin</arg>
-		<arg choice="opt">-m</arg>	
-		<arg choice="opt">-r</arg>	
-		<arg choice="opt">-x</arg>	
-		<arg choice="opt">-i passdb-backend</arg>	
-		<arg choice="opt">-e passdb-backend</arg>   
+		<arg choice="opt">-a</arg>
 		<arg choice="opt">-b passdb-backend</arg>
-		<arg choice="opt">-g</arg>
+		<arg choice="opt">-c account-control</arg>
+		<arg choice="opt">-C value</arg>
 		<arg choice="opt">-d debuglevel</arg>
-		<arg choice="opt">-s configfile</arg>
+		<arg choice="opt">-D drive</arg>
+		<arg choice="opt">-e passdb-backend</arg>
+		<arg choice="opt">-f fullname</arg>
+		<arg choice="opt">--force-initialized-passwords</arg>
+		<arg choice="opt">-g</arg>
+		<arg choice="opt">-G SID|RID</arg>
+		<arg choice="opt">-h homedir</arg>
+		<arg choice="opt">-i passdb-backend</arg>
+		<arg choice="opt">-I domain</arg>
+		<arg choice="opt">-L </arg>
+		<arg choice="opt">-m</arg>
+		<arg choice="opt">-N description</arg>
 		<arg choice="opt">-P account-policy</arg>
-		<arg choice="opt">-C value</arg>
-		<arg choice="opt">-c account-control</arg>
+		<arg choice="opt">-p profile</arg>
+		<arg choice="opt">--policies-reset</arg>
+		<arg choice="opt">-r</arg>
+		<arg choice="opt">-s configfile</arg>
+		<arg choice="opt">-S script</arg>
+		<arg choice="opt">-t</arg>
+		<arg choice="opt">--time-format</arg>
+		<arg choice="opt">-u username</arg>
+		<arg choice="opt">-U SID|RID</arg>
+		<arg choice="opt">-v</arg>
+		<arg choice="opt">-V</arg>
+		<arg choice="opt">-w</arg>
+		<arg choice="opt">-x</arg>
 		<arg choice="opt">-y</arg>
+		<arg choice="opt">-z</arg>
+		<arg choice="opt">-Z</arg>
 	</cmdsynopsis>
 </refsynopsisdiv>
 
@@ -69,7 +79,7 @@
 	<title>OPTIONS</title>
 	<variablelist>
 		<varlistentry>
-		<term>-L</term>
+		<term>-L|--list</term>
 		<listitem><para>This option lists all the user accounts
 		present in the users database.
 		This option prints a list of user/uid pairs separated by
@@ -85,7 +95,7 @@ samba:45:Test User
 		
 		
 		<varlistentry>
-		<term>-v</term>
+		<term>-v|--verbose</term>
 		<listitem><para>This option enables the verbose listing format.
 		It causes pdbedit to list the users in the database, printing
 		out the account fields in a descriptive format.</para>
@@ -117,7 +127,7 @@ Profile Path:   \\BERSERKER\profile
 		
 		
 		<varlistentry>
-		<term>-w</term>
+		<term>-w|--smbpasswd-style</term>
 		<listitem><para>This option sets the "smbpasswd" listing format.
 		It will make pdbedit list the users in the database, printing
 		out the account fields in a format compatible with the
@@ -139,7 +149,7 @@ samba:45:0F2B255F7B67A7A9AAD3B435B51404EE:
 		
 		
 		<varlistentry>
-		<term>-u username</term>
+		<term>-u|--user username</term>
 		<listitem><para>This option specifies the username to be
 		used for the operation requested (listing, adding, removing).
 		It is <emphasis>required</emphasis> in add, remove and modify
@@ -149,7 +159,7 @@ samba:45:0F2B255F7B67A7A9AAD3B435B51404EE:
 		</varlistentry>
 
 		<varlistentry>
-		<term>-f fullname</term>
+		<term>-f|--fullname fullname</term>
 		<listitem><para>This option can be used while adding or
 		modifing a user account. It will specify the user's full
 		name. </para>
@@ -159,7 +169,7 @@ samba:45:0F2B255F7B67A7A9AAD3B435B51404EE:
 		</varlistentry>
 		
 		<varlistentry>
-		<term>-h homedir</term>
+		<term>-h|--homedir homedir</term>
 		<listitem><para>This option can be used while adding or
 		modifing a user account. It will specify the user's home
 		directory network path.</para>
@@ -170,7 +180,7 @@ samba:45:0F2B255F7B67A7A9AAD3B435B51404EE:
 		</varlistentry>
 		
 		<varlistentry>
-		<term>-D drive</term>
+		<term>-D|--drive drive</term>
 		<listitem><para>This option can be used while adding or
 		modifing a user account. It will specify the windows drive
 		letter to be used to map the home directory.</para>
@@ -182,7 +192,7 @@ samba:45:0F2B255F7B67A7A9AAD3B435B51404EE:
 		
 		
 		<varlistentry>
-		<term>-S script</term>
+		<term>-S|--script script</term>
 		<listitem><para>This option can be used while adding or
 		modifing a user account. It will specify the user's logon
 		script path.</para>
@@ -194,7 +204,7 @@ samba:45:0F2B255F7B67A7A9AAD3B435B51404EE:
 		
 		
 		<varlistentry>
-		<term>-p profile</term>
+		<term>-p|--profile profile</term>
 		<listitem><para>This option can be used while adding or
 		modifing a user account. It will specify the user's profile
 		directory.</para>
@@ -205,7 +215,7 @@ samba:45:0F2B255F7B67A7A9AAD3B435B51404EE:
 		</varlistentry>
 
 		<varlistentry>
-		<term>-G SID|rid</term>
+		<term>-G|'--group SID' SID|rid</term>
 		<listitem><para>
 		This option can be used while adding or modifying a user account. It 
 		will specify the users' new primary group SID (Security Identifier) or 
@@ -216,18 +226,21 @@ samba:45:0F2B255F7B67A7A9AAD3B435B51404EE:
 		</varlistentry>
 
 		<varlistentry>
-		<term>-U SID|rid</term>
+		<term>-U|'--user SID' SID|rid</term>
 		<listitem><para>
 		This option can be used while adding or modifying a user account. It 
 		will specify the users' new SID (Security Identifier) or 
 		rid. </para>
 
 		<para>Example: <command>-U S-1-5-21-2447931902-1787058256-3961074038-5004</command></para>
+		<para>Example: <command>'--user SID' S-1-5-21-2447931902-1787058256-3961074038-5004</command></para>
+		<para>Example: <command>-U 5004</command></para>
+		<para>Example: <command>'--user SID' 5004</command></para>
 		</listitem>
 		</varlistentry>
 
 		<varlistentry>
-		<term>-c account-control</term>
+		<term>-c|--account-control account-control</term>
 		<listitem><para>This option can be used while adding or modifying a user
 				account. It will specify the users' account control property. Possible flags are listed below.
 	</para>
@@ -263,7 +276,7 @@ samba:45:0F2B255F7B67A7A9AAD3B435B51404EE:
                 </varlistentry>
 
 		<varlistentry>
-		<term>-a</term>
+		<term>-a|--create</term>
 		<listitem><para>This option is used to add a user into the
 		database. This command needs a user name specified with
 		the -u switch. When adding a new user, pdbedit will also
@@ -289,7 +302,7 @@ retype new password
 		</varlistentry>
 		
 		<varlistentry>
-		<term>-t, --password-from-stdin</term>
+		<term>-t|--password-from-stdin</term>
 		<listitem><para>This option causes pdbedit to read the password
 		from standard input, rather than from /dev/tty (like the
 		<command>passwd(1)</command> program does).  The password has
@@ -298,7 +311,7 @@ retype new password
 		</varlistentry>
 
 		<varlistentry>
-		<term>-r</term>
+		<term>-r|--modify</term>
 		<listitem><para>This option is used to modify an existing user 
 		in the database. This command needs a user name specified with the -u 
 		switch. Other options can be specified to modify the properties of 
@@ -308,7 +321,7 @@ retype new password
 		</varlistentry>
 			
 		<varlistentry>
-		<term>-m</term>
+		<term>-m|--machine</term>
 		<listitem><para>This option may only be used in conjunction 
 		with the <parameter>-a</parameter> option. It will make
 		pdbedit to add a machine trust account instead of a user
@@ -321,7 +334,7 @@ retype new password
 		
 		
 		<varlistentry>
-		<term>-x</term>
+		<term>-x|--delete</term>
 		<listitem><para>This option causes pdbedit to delete an account
 		from the database. It needs a username specified with the
 		-u switch.</para>
@@ -332,7 +345,7 @@ retype new password
 		
 
 		<varlistentry>
-		<term>-i passdb-backend</term>
+		<term>-i|--import passdb-backend</term>
 		<listitem><para>Use a different passdb backend to retrieve users
                 than the one specified in smb.conf. Can be used to import data into
                 your local user database.</para>
@@ -346,7 +359,7 @@ retype new password
 		</varlistentry>
 
 		<varlistentry>
-		<term>-e passdb-backend</term>
+		<term>-e|--export passdb-backend</term>
 		<listitem><para>Exports all currently available users to the
 		specified password database backend.</para>
 
@@ -358,7 +371,7 @@ retype new password
 		</varlistentry>
 
 		<varlistentry>
-		<term>-g</term>
+		<term>-g|--group</term>
 		<listitem><para>If you specify <parameter>-g</parameter>,
 		then <parameter>-i in-backend -e out-backend</parameter>
 		applies to the group mapping instead of the user database.</para>
@@ -370,7 +383,7 @@ retype new password
 		</varlistentry>
 
 		<varlistentry>
-		<term>-b passdb-backend</term>
+		<term>-b|--backend passdb-backend</term>
 		<listitem><para>Use a different default passdb backend. </para>
 
 		<para>Example: <command>pdbedit -b xml:/root/pdb-backup.xml -l</command></para>
@@ -378,7 +391,7 @@ retype new password
 		</varlistentry>
 
 		<varlistentry>
-		<term>-P account-policy</term>
+		<term>-P|--account-policy account-policy</term>
 		<listitem><para>Display an account policy</para>
 		<para>Valid policies are: minimum password age, reset count minutes, disconnect time,
 		user must logon to change password, password history, lockout duration, min password length,
@@ -394,7 +407,7 @@ account policy value for bad lockout attempt is 0
 
 
 		<varlistentry>
-		<term>-C account-policy-value</term>
+		<term>-C|--value account-policy-value</term>
 		<listitem><para>Sets an account policy to a specified value. 
 		This option may only be used in conjunction
 		with the <parameter>-P</parameter> option.
@@ -409,7 +422,7 @@ account policy value for bad lockout attempt is now 3
 		</varlistentry>
 
 		<varlistentry>
-		<term>-y</term>
+		<term>-y|--policies</term>
 		<listitem><para>If you specify <parameter>-y</parameter>,
 		then <parameter>-i in-backend -e out-backend</parameter>
 		applies to the account policies instead of the user database.</para>
@@ -422,6 +435,73 @@ account policy value for bad lockout attempt is now 3
 		</listitem>
 		</varlistentry>
 
+		<varlistentry>
+		<term>--force-initialized-passwords</term>
+		<listitem><para>This option forces all users to change their
+				password upon next login.
+		</para>
+		</listitem>
+		</varlistentry>
+
+		<varlistentry>
+		<term>-N|--account-desc description</term>
+		<listitem><para>This option can be used while adding or
+		modifing a user account. It will specify the user's description
+		field.</para>
+
+		<para>Example: <command>-N "test description"</command>
+		</para>
+		</listitem>
+		</varlistentry>
+
+		<varlistentry>
+		<term>-Z|--logon-hours-reset</term>
+		<listitem><para>This option can be used while adding or
+		modifing a user account. It will reset the user's allowed logon
+		hours. A user may login at any time afterwards.</para>
+
+		<para>Example: <command>-Z</command>
+		</para>
+		</listitem>
+		</varlistentry>
+
+		<varlistentry>
+		<term>-z|--bad-password-count-reset</term>
+		<listitem><para>This option can be used while adding or
+		modifing a user account. It will reset the stored bad login
+		counter from a specified user.</para>
+
+		<para>Example: <command>-z</command>
+		</para>
+		</listitem>
+		</varlistentry>
+
+		<varlistentry>
+		<term>--policies-reset</term>
+		<listitem><para>This option can be used to reset the general
+				password policies stored for a domain to their
+				default values.</para>
+		<para>Example: <command>--policies-reset</command>
+		</para>
+		</listitem>
+		</varlistentry>
+
+		<varlistentry>
+		<term>-I|--domain</term>
+		<listitem><para>This option can be used while adding or
+		modifing a user account. It will specify the user's domain field.</para>
+
+		<para>Example: <command>-I "MYDOMAIN"</command>
+		</para>
+		</listitem>
+		</varlistentry>
+
+		<varlistentry>
+		<term>--time-format</term>
+		<listitem><para>This option is currently not being used.</para>
+		</listitem>
+		</varlistentry>
+
 		&stdarg.help;
 		&stdarg.server.debug;
 		&popt.common.samba;