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

112 lines
3.2 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<refentry id="cardos-tool">
<refmeta>
<refentrytitle>cardos-tool</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="productname">OpenSC</refmiscinfo>
<refmiscinfo class="manual">OpenSC Tools</refmiscinfo>
<refmiscinfo class="source">opensc</refmiscinfo>
</refmeta>
<refnamediv>
<refname>cardos-tool</refname>
<refpurpose>displays information about Card OS-based security tokens or format them
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>cardos-tool</command>
<arg choice="opt"><replaceable class="option">OPTIONS</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
The <command>cardos-tool</command> utility is used to display information about
smart cards and similar security tokens based on Siemens Card/OS M4.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>
<variablelist>
<varlistentry>
<term>
<option>--format</option>,
<option>-f</option>
</term>
<listitem><para>Format the card or token.</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>--info</option>,
<option>-i</option>
</term>
<listitem><para>Display information about the card or token.</para></listitem>
</varlistentry>
<varlistentry>
<term>
<option>--reader</option> <replaceable>arg</replaceable>,
<option>-r</option> <replaceable>arg</replaceable>
</term>
<listitem>
<para>
Number of the reader to use. By default, the first
reader with a present card is used. If
<replaceable>arg</replaceable> is an ATR, the
reader with a matching card will be chosen.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--startkey</option> <replaceable>arg</replaceable>,
<option>-s</option> <replaceable>arg</replaceable>
</term>
<listitem><para>Specify startkey for format.</para></listitem>
</varlistentry>
<varlistentry>
<term>
<option>--change-startkey</option> <replaceable>arg</replaceable>,
<option>-S</option> <replaceable>arg</replaceable>
</term>
<listitem><para>Change Startkey with given APDU command.</para></listitem>
</varlistentry>
<varlistentry>
<term>
<option>--verbose</option>,
<option>-v</option>
</term>
<listitem><para>Causes <command>cardos-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>--wait</option>,
<option>-w</option>
</term>
<listitem><para>Causes <command>cardos-tool</command> to wait for the token
to be inserted into reader.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1>
<title>Authors</title>
<para><command>cardos-tool</command> was written by
Andreas Jellinghaus <email>aj@dungeon.inka.de</email>.</para>
</refsect1>
</refentry>