Skip to content

Commit

Permalink
Updated dnie-tool.1.xml for consistency
Browse files Browse the repository at this point in the history
Experienced a problem with dnie-tool where I would receive a warning with the content of /etc/bash_completion.d/dnie-tool.

The cause of the error was a missing case label which in turn was caused by the formatting of the dnie-tool.1.xml.

Options were formatted like <term><option--xarg, -x</option></term> which were not handled by the sed regular expression in the makefiles.

Modified the dnie-tool.1.xml file to be consistent with the other doc files and to generate the dnie-tool file correctly.
  • Loading branch information
lbakman committed Mar 11, 2015
1 parent 595be37 commit 1becc45
Showing 1 changed file with 52 additions and 22 deletions.
74 changes: 52 additions & 22 deletions doc/tools/dnie-tool.1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,22 @@
<refmeta>
<refentrytitle>dnie-tool</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>opensc</refmiscinfo>
<refmiscinfo class="productname">OpenSC</refmiscinfo>
<refmiscinfo class="manual">OpenSC Tools</refmiscinfo>
<refmiscinfo class="source">opensc</refmiscinfo>
</refmeta>

<refnamediv>
<refname>dnie-tool</refname>
<refpurpose>displays information about DNIe based security tokens</refpurpose>
</refnamediv>

<refsect1>
<title>Synopsis</title>
<para>
<command>dnie-tool</command> [OPTIONS]
</para>
</refsect1>
<refsynopsisdiv>
<cmdsynopsis>
<command>dnie-tool</command>
<arg choice="opt"><replaceable class="option">OPTIONS</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
<title>Description</title>
Expand All @@ -30,56 +32,84 @@
<para>
<variablelist>
<varlistentry>
<term><option>--idesp, -i </option></term>
<listitem><para>Show the DNIe IDESP value.
</para></listitem>
<term>
<option>--idesp</option>,
<option>-i</option>
</term>
<listitem><para>Show the DNIe IDESP value.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--data, -d </option></term>
<term>
<option>--data</option>,
<option>-d</option>
</term>
<listitem><para>Show DNIe personal information.
Reads and print DNIe number and User Name and SurName</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--all, -a </option></term>
<term>
<option>--all</option>,
<option>-a</option>
</term>
<listitem><para>Displays every available information.
This command is equivalent to -d -i -s
</para></listitem>
This command is equivalent to -d -i -s</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--serial, -s </option></term>
<term>
<option>--serial</option>,
<option>-s</option>
</term>
<listitem><para>Displays DNIe Serial Number
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--version, -V </option></term>
<term>
<option>--version</option>,
<option>-V</option>
</term>
<listitem><para>Show DNIe sw version.
Displays sofware version for in-card DNIe OS</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--pin</option> <replaceable>pin</replaceable>, <option>-p</option> <replaceable>pin</replaceable></term>
<term>
<option>--pin</option> <replaceable>pin</replaceable>,
<option>-p</option> <replaceable>pin</replaceable>
</term>
<listitem><para>Specify the user pin <replaceable>pin</replaceable> to use.
If set to env:<replaceable>VARIABLE</replaceable>, the
value of the environment variable
<replaceable>VARIABLE</replaceable> is used.
The default is do not enter pin</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--reader</option> <replaceable>number</replaceable>, <option>-r</option> <replaceable>number</replaceable></term>
<term>
<option>--reader</option> <replaceable>number</replaceable>,
<option>-r</option> <replaceable>number</replaceable>
</term>
<listitem><para>Specify the reader <replaceable>number</replaceable> to use.
The default is reader 0.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--driver</option> <replaceable>driver</replaceable>, <option>-c</option> <replaceable>driver</replaceable></term>
<term>
<option>--driver</option> <replaceable>driver</replaceable>,
<option>-c</option> <replaceable>driver</replaceable>
</term>
<listitem><para>Specify the card driver <replaceable>driver</replaceable> to use.
Default is use driver from configuration file, or auto-detect if absent</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--wait, -w</option></term>
<term>
<option>--wait</option>,
<option>-w</option>
</term>
<listitem><para>Causes <command>dnie-tool</command> to wait for the token to be inserted into reader.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--verbose, -v</option></term>
<term>
<option>--verbose</option>,
<option>-v</option>
</term>
<listitem><para>Causes <command>dnie-tool</command> to be more verbose.
Specify this flag several times
to enable debug output in the opensc library.</para></listitem>
Expand Down

0 comments on commit 1becc45

Please sign in to comment.