diff pwm.1.xml @ 12:8768fbd09bc5

Add generatepassword command to generate random passwords Refactor and generalize handling of named arguments.
author Guido Berhoerster <guido+pwm@berhoerster.name>
date Thu, 03 Aug 2017 10:22:07 +0200
parents 85bce13237cf
children cf81eb0c2d5a
line wrap: on
line diff
--- a/pwm.1.xml	Mon Jul 31 09:20:21 2017 +0200
+++ b/pwm.1.xml	Thu Aug 03 10:22:07 2017 +0200
@@ -34,7 +34,7 @@
       <email>guido+pwm@berhoerster.name</email>
       <personblurb/>
     </author>
-    <date>31 July, 2017</date>
+    <date>3 August, 2017</date>
   </info>
   <refmeta>
     <refentrytitle>pwm</refentrytitle>
@@ -393,6 +393,54 @@
           </listitem>
         </varlistentry>
         <varlistentry>
+          <term>Generate a random password</term>
+          <listitem>
+            <cmdsynopsis>
+              <command>generatepassword</command>
+              <arg choice="opt">
+                <replaceable>id</replaceable>
+              </arg>
+              <arg choice="opt">
+                len=<replaceable>n</replaceable>
+              </arg>
+              <arg choice="opt" rep="repeat">
+                chars=<replaceable>n</replaceable>:<replaceable>chars</replaceable>
+              </arg>
+              <arg choice="opt" rep="repeat">
+                charclass=<replaceable>n</replaceable>:<replaceable>class</replaceable>
+              </arg>
+            </cmdsynopsis>
+            <cmdsynopsis>
+              <command>gp</command>
+              <arg choice="opt">
+                <replaceable>id</replaceable>
+              </arg>
+              <arg choice="opt">
+                len=<replaceable>n</replaceable>
+              </arg>
+              <arg choice="opt" rep="repeat">
+                chars=<replaceable>n</replaceable>:<replaceable>chars</replaceable>
+              </arg>
+              <arg choice="opt" rep="repeat">
+                charclass=<replaceable>n</replaceable>:<replaceable>class</replaceable>
+              </arg>
+              <sbr/>
+            </cmdsynopsis>
+            <para>Randomly generate a new password according to the specified
+            constraints. The <literal>len</literal> argument sets the length of
+            the generated password to <replaceable>n</replaceable> characters.
+            The <literal>chars</literal> argument constrains the password to
+            <replaceable>n</replaceable> from the set of characters
+            <replaceable>chars</replaceable>. Similarly, the
+            <literal>charclass</literal> argument to
+            <replaceable>n</replaceable> characters from the extended regular
+            expression character class <replaceable>class</replaceable>.
+            Multiple <literal>char</literal> and <literal>charclass</literal>
+            arguments may be specified, in which case the generated passwords
+            match all of them.</para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
           <term>Change the master password</term>
           <listitem>
             <cmdsynopsis>