Permalink
Browse files

westcos-tool.1.xml: sort options alphabetically

  • Loading branch information...
1 parent 56a1ab6 commit 3b6c985cca934ff30b66e4ec0161d50be11de8db @marschap marschap committed Aug 21, 2011
Showing with 57 additions and 57 deletions.
  1. +57 −57 doc/tools/westcos-tool.1.xml
@@ -37,20 +37,34 @@
<variablelist>
<varlistentry>
<term>
- <option>--reader</option> <replaceable>num</replaceable>,
- <option>-r</option> <replaceable>num</replaceable>
+ <option>--change-pin</option>,
+ <option>-n</option>
</term>
- <listitem><para>
- Use the given reader. The default is the first reader with a card.
- </para></listitem>
+ <listitem><para>Changes a PIN stored on the card.
+ User authentication is required for this operation.</para></listitem>
</varlistentry>
<varlistentry>
<term>
- <option>--wait</option>,
- <option>-w</option>
+ <option>--certificate</option> <replaceable>file</replaceable>,
+ <option>-t</option> <replaceable>file</replaceable>
</term>
- <listitem><para>Wait for a card to be inserted.</para></listitem>
+ <listitem><para>Write certificate file <replaceable>file</replaceable>
+ in PEM format to the card.
+ User authentication is required for this operation.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--finalize</option>,
+ <option>-f</option>
+ </term>
+ <listitem><para>Finalize the card. Once finalized the default key is
+ invalidated, so PIN and PUK cannot be changed anymore without user
+ authentication.</para>
+ <para>Warning, un-finalized are insecure because PIN can be changed
+ without user authentication (knowledge of default key
+ is enough).</para></listitem>
</varlistentry>
<varlistentry>
@@ -67,10 +81,19 @@
<varlistentry>
<term>
- <option>--overwrite-key</option>,
- <option>-o</option>
+ <option>--help</option>,
+ <option>-h</option>
</term>
- <listitem><para>Overwrite the key if there is already a key on the card.</para></listitem>
+ <listitem><para>Print help message on screen.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--install-pin</option>,
+ <option>-i</option>
+ </term>
+ <listitem><para>Install PIN file in on the card.
+ You must provide a PIN value with <option>-x</option>.</para></listitem>
</varlistentry>
<varlistentry>
@@ -84,11 +107,10 @@
<varlistentry>
<term>
- <option>--install-pin</option>,
- <option>-i</option>
+ <option>--overwrite-key</option>,
+ <option>-o</option>
</term>
- <listitem><para>Install PIN file in on the card.
- You must provide a PIN value with <option>-x</option>.</para></listitem>
+ <listitem><para>Overwrite the key if there is already a key on the card.</para></listitem>
</varlistentry>
<varlistentry>
@@ -110,53 +132,48 @@
<varlistentry>
<term>
- <option>--change-pin</option>,
- <option>-n</option>
+ <option>--read-file</option> <replaceable>path</replaceable>,
+ <option>-j</option> <replaceable>path</replaceable>
</term>
- <listitem><para>Changes a PIN stored on the card.
+ <listitem><para>Read the file <replaceable>path</replaceable> from the card.
+ The file is written on disk with name <replaceable>path</replaceable>.
User authentication is required for this operation.</para></listitem>
</varlistentry>
<varlistentry>
<term>
- <option>--unblock-pin</option>,
- <option>-u</option>
+ <option>--reader</option> <replaceable>num</replaceable>,
+ <option>-r</option> <replaceable>num</replaceable>
</term>
- <listitem><para>Unblocks a PIN stored on the card. Knowledge of the
- PIN Unblock Key (PUK) is required for this operation.</para></listitem>
+ <listitem><para>
+ Use the given reader. The default is the first reader with a card.
+ </para></listitem>
</varlistentry>
<varlistentry>
<term>
- <option>--certificate</option> <replaceable>file</replaceable>,
- <option>-t</option> <replaceable>file</replaceable>
+ <option>--unblock-pin</option>,
+ <option>-u</option>
</term>
- <listitem><para>Write certificate file <replaceable>file</replaceable>
- in PEM format to the card.
- User authentication is required for this operation.</para></listitem>
+ <listitem><para>Unblocks a PIN stored on the card. Knowledge of the
+ PIN Unblock Key (PUK) is required for this operation.</para></listitem>
</varlistentry>
<varlistentry>
<term>
- <option>--finalize</option>,
- <option>-f</option>
+ <option>-v</option>
</term>
- <listitem><para>Finalize the card. Once finalized the default key is
- invalidated, so PIN and PUK cannot be changed anymore without user
- authentication.</para>
- <para>Warning, un-finalized are insecure because PIN can be changed
- without user authentication (knowledge of default key
- is enough).</para></listitem>
+ <listitem><para>Causes <command>westcos-tool</command> to be more
+ verbose. Specify this flag several times to enable debug output
+ in the OpenSC library.</para></listitem>
</varlistentry>
<varlistentry>
<term>
- <option>--read-file</option> <replaceable>path</replaceable>,
- <option>-j</option> <replaceable>path</replaceable>
+ <option>--wait</option>,
+ <option>-w</option>
</term>
- <listitem><para>Read the file <replaceable>path</replaceable> from the card.
- The file is written on disk with name <replaceable>path</replaceable>.
- User authentication is required for this operation.</para></listitem>
+ <listitem><para>Wait for a card to be inserted.</para></listitem>
</varlistentry>
<varlistentry>
@@ -170,23 +187,6 @@
User authentication is required for this operation.</para></listitem>
</varlistentry>
- <varlistentry>
- <term>
- <option>--help</option>,
- <option>-h</option>
- </term>
- <listitem><para>Print help message on screen.</para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term>
- <option>-v</option>
- </term>
- <listitem><para>Causes <command>westcos-tool</command> to be more
- verbose. Specify this flag several times to enable debug output
- in the OpenSC library.</para></listitem>
- </varlistentry>
-
</variablelist>
</para>
</refsect1>

0 comments on commit 3b6c985

Please sign in to comment.