opensc/doc/tools/gids-tool.1.xml

146 lines
4.1 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<refentry id="gids-tool">
<refmeta>
<refentrytitle>gids-tool</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="productname">OpenSC</refmiscinfo>
<refmiscinfo class="manual">OpenSC Tools</refmiscinfo>
<refmiscinfo class="source">opensc</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gids-tool</refname>
<refpurpose>smart card utility for GIDS cards</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>gids-tool</command>
<arg choice="opt"><replaceable class="option">OPTIONS</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<para>
The <command>gids-tool</command> utility can be used from the command line to perform
miscellaneous smart card operations on a GIDS smart card.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>
<variablelist>
<varlistentry>
<term>
<option>-X</option>,
<option>--initialize</option>
</term>
<listitem><para>Initialize token.</para></listitem>
</varlistentry>
<varlistentry>
<term>
<option>--admin-key</option> <replaceable>argument</replaceable>
</term>
<listitem><para>Define the administrator key</para></listitem>
</varlistentry>
<varlistentry>
<term>
<option>--pin</option> <replaceable>pin</replaceable>
</term>
<listitem>
<para>
This option can be used to specify the PIN value
on the command line. If the value is set to
<literal>env:</literal><replaceable>VARIABLE</replaceable>, the value
of the specified environment variable is used. By default,
the code is prompted on the command line if needed.
</para>
<para>
Note that on most operation systems, any user can
display the command line of any process on the
system using utilities such as
<command>ps(1)</command>. Therefore, you should prefer
passing the codes via an environment variable
on an unsecured system.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--serial-number</option> <replaceable>argument</replaceable>
</term>
<listitem><para>Define serial number.</para></listitem>
</varlistentry>
<varlistentry>
<term>
<option>-U</option>,
<option>--unblock</option>
</term>
<listitem><para>Unblock the user PIN after an administrator
authentication.</para></listitem>
</varlistentry>
<varlistentry>
<term>
<option>-C</option>,
<option>--change-admin-key</option>
</term>
<listitem><para>Change the administrator key.</para></listitem>
</varlistentry>
<varlistentry>
<term>
<option>--new-admin-key</option> <replaceable>argument</replaceable>
</term>
<listitem><para>Define the new administrator key.</para></listitem>
</varlistentry>
<varlistentry>
<term>
<option>--reader</option> <replaceable>argument</replaceable>,
<option>-r</option> <replaceable>argument</replaceable>
</term>
<listitem>
<para>
Number of the reader to use. By default, the first
reader with a present card is used. If
<replaceable>argument</replaceable> is an ATR, the
reader with a matching card will be chosen.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-w</option>,
<option>--wait</option>
</term>
<listitem><para>Wait for a card to be inserted.</para></listitem>
</varlistentry>
<varlistentry>
<term>
<option>-v</option>,
<option>--verbose</option>
</term>
<listitem><para>Verbose operation. Use several times to
enable debug output.</para></listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<citerefentry>
<refentrytitle>opensc-tool</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
</para>
</refsect1>
<refsect1>
<title>Authors</title>
<para><command>gids-tool</command> was written by
Vincent Le Toux <email>vincent.letoux@mysmartlogon.com</email>.</para>
</refsect1>
</refentry>