File: opensc-tool.1.xml

package info (click to toggle)
opensc 0.26.1-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 11,420 kB
  • sloc: ansic: 178,823; xml: 6,327; sh: 2,115; makefile: 1,023; cpp: 304; lex: 92
file content (200 lines) | stat: -rw-r--r-- 6,220 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
<?xml version="1.0" encoding="UTF-8"?>
<refentry id="opensc-tool">
	<refmeta>
		<refentrytitle>opensc-tool</refentrytitle>
		<manvolnum>1</manvolnum>
		<refmiscinfo class="productname">OpenSC</refmiscinfo>
		<refmiscinfo class="manual">OpenSC Tools</refmiscinfo>
		<refmiscinfo class="source">opensc</refmiscinfo>
	</refmeta>

	<refnamediv>
		<refname>opensc-tool</refname>
		<refpurpose>generic smart card utility</refpurpose>
	</refnamediv>

	<refsynopsisdiv>
		<cmdsynopsis>
			<command>opensc-tool</command>
			<arg choice="opt"><replaceable class="option">OPTIONS</replaceable></arg>
		</cmdsynopsis>
	</refsynopsisdiv>

	<refsect1>
		<title>Description</title>
		<para>
			The <command>opensc-tool</command> utility can be used from the command line to perform
			miscellaneous smart card operations such as getting the card ATR or
			sending arbitrary APDU commands to a card.
		</para>
	</refsect1>

	<refsect1>
		<title>Options</title>
		<para>
			<variablelist>
				<varlistentry>
					<term>
						<option>--version</option>
					</term>
					<listitem><para>Print the OpenSC package release version.</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--atr</option>,
						<option>-a</option>
					</term>
					<listitem><para>Print the Answer To Reset (ATR) of the card.
					Output is in hex byte format</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--card-driver</option> <replaceable>driver</replaceable>,
						<option>-c</option> <replaceable>driver</replaceable>
					</term>
					<listitem><para>
						Use the given card driver.
						The default is to auto-detect the correct card driver.
						The literal value <literal>?</literal> lists
						all available card drivers.
					</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--list-algorithms</option>,
					</term>
					<listitem><para>Lists algorithms supported by card</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--info</option>,
						<option>-i</option>
					</term>
					<listitem><para>Print information about OpenSC, such as version and enabled components.</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--list-drivers</option>,
						<option>-D</option>
					</term>
					<listitem><para>List all installed card drivers.</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--list-files</option>,
						<option>-f</option>
					</term>
					<listitem><para>Recursively list all files stored on card.</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--list-readers</option>,
						<option>-l</option>
					</term>
					<listitem><para>List all configured readers.</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--name</option>,
						<option>-n</option>
					</term>
					<listitem><para>Print the name of the inserted card (driver).</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--get-conf-entry</option> <replaceable>conf</replaceable>,
						<option>-G</option> <replaceable>conf</replaceable>
					</term>
					<listitem><para>Get configuration key, format: section:name:key</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--set-conf-entry</option> <replaceable>conf</replaceable>,
						<option>-S</option> <replaceable>conf</replaceable>
					</term>
					<listitem><para>Set configuration key, format: section:name:key:value</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>--reset</option> <arg choice="opt"><replaceable>type</replaceable></arg>,
					</term>
					<listitem><para>Resets the card in reader.
					The default reset type is <literal>cold</literal>,
					but <literal>warm</literal> reset is also possible.</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--send-apdu</option> <replaceable>apdu</replaceable>,
						<option>-s</option> <replaceable>apdu</replaceable>
					</term>
					<listitem>
						<para>
							Sends an arbitrary APDU to the card in the format
							<code>AA:BB:CC:DD:EE:FF...</code>. Use this option
							multiple times to send more than one APDU.
						</para>
						<para>
                            The built-in card drivers may send additional APDUs
                            for detection and initialization. To avoid this
							behavior, you may additionally specify
							<option>--card-driver</option> <literal>default</literal>.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--serial</option>
					</term>
					<listitem><para>Print the card serial number (normally the ICCSN).
					Output is in hex byte format</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--verbose</option>,
						<option>-v</option>
					</term>
					<listitem><para>Causes <command>opensc-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>Wait for a card to be inserted.</para></listitem>
				</varlistentry>
			</variablelist>
		</para>
	</refsect1>

	<refsect1>
		<title>See also</title>
		<para>
			<citerefentry>
				<refentrytitle>opensc-explorer</refentrytitle>
				<manvolnum>1</manvolnum>
			</citerefentry>
		</para>
	</refsect1>

	<refsect1>
		<title>Authors</title>
		<para><command>opensc-tool</command> was written by
		Juha Yrjölä <email>juha.yrjola@iki.fi</email>.</para>
	</refsect1>

</refentry>