giomba
/
opensc
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

new manpages for cardos-info and pkcs11-tool, 

both written my Joe Phillips.


git-svn-id: https://www.opensc-project.org/svnp/opensc/trunk@1695 c6295689-39f2-0310-b995-f0e70906c6a9
This commit is contained in:
aj 2003-12-29 12:01:43 +00:00
parent 5db7585bb0
commit 4e48b7778a
4 changed files with 141 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Makefile.am
View File

@ -14,6 +14,8 @@ MANSRC = \
opensc-explorer.1 \
opensc-tool.1 \
pkcs15-tool.1 \
pkcs11-tool.1 \
cardos-info.1 \
opensc.7 \
pkcs15.7 \
sc_connect_card.3 \

38
docs/cardos-info.1 Normal file
View File

@ -0,0 +1,38 @@
.PU
.ds nm \fBcardos-info\fR
.TH cardos-info 1 "December 11, 2003" "" OpenSC
.SH NAME
cardos-info \- Displays information about Card OS based security tokens
.SH SYNOPSIS
\*(nm
.RI [OPTIONS]
.SH DESCRIPTION
The \*(nm utility is used to display information about Card OS based
smart cards and similar security tokens.
.SH OPTIONS
.TP
.BR "\-\-reader " \fInumber\fP ", \-r " \fInumber\fP
Display information about the token in reader number \fInumber\fP .
The default is reader 0.
.TP
.Br "\-\-card\-driver " \fIname\fP ", \-c " \fIname\fP
Use the card driver specified by \fIname\fP .
The default is to auto-detect the correct card driver.
.TP
.BR \-\-wait ", " \-w
Causes \*(nm to wait for the token to be inserted into \fIreader\fP .
.TP
.BR \-\-quiet ", " \-q
Causes \*(nm to be less verbose about what is going on behind the scenes.
.TP
.BR \-\-debug ", " \-d
Causes \*(nm to print debugging information during operation. This option
may be specified more than once to incrementaly increase the amount
of debugging information output.
either \-\-login or \-\-pin.
.SH SEE ALSO
.BR opensc (7),
.SH AUTHORS
\*(nm was written by Juha Yrj and Andreas Jellinghaus <aj@dungeon.inka.de>.
This manpage was contributed by Joe Phillips <joe.phillips@innovationsw.com>
for the Debian GNU/Linux system (but may be used by others).

100
docs/pkcs11-tool.1 Normal file
View File

@ -0,0 +1,100 @@
.PU
.ds nm \fBpkcs11-tool\fR
.TH pkcs11-tool 1 "December 11, 2003" "" OpenSC
.SH NAME
pkcs11-tool \- utility for managing and using PKCS #11 security tokens
.SH SYNOPSIS
\*(nm
.RI [OPTIONS]
.SH DESCRIPTION
The \*(nm utility is used to manage the
data objects on smart cards and similar PKCS #11 security tokens.
Users can list and read PINs, keys and
certificates stored on the token. User PIN authentication is
performed for those operations that require it.
.SH OPTIONS
.TP
.BR \-\-login ", " \-l
Authenticate to the token before performing other operations.
This option is not needed if a PIN is provided on the command line.
.TP
.BR "\-\-pin " \fIpin\fP ", \-p " \fIpin\fP
Use the given \fIpin\fP for token operations.
WARNING: Be careful using this option as other users may be able to
read the command line from the system or if it is embedded in a script.
.TP
.BR \-\-change\-pin ", " \-c
Change the user PIN on the token
.TP
.BR \-\-quiet ", " \-q
Causes \*(nm to be less verbose about what is going on behind the scenes.
.TP
.BR \-\-test ", " \-t
Performs some tests on the token. This option is most useful when used with
either \-\-login or \-\-pin.
.TP
.BR \-\-show\-info ", " \-I
Displays general token information.
.TP
.BR \-\-list\-slots ", " \-L
Displays a list of available slots on the token.
.TP
.BR \-\-list\-mechanisms ", " \-M
Displays a list of mechanisms supported by the token.
.TP
.BR \-\-list\-objects ", " \-O
Displays a list of objects.
.TP
.BR \-\-sign ", " \-s
Sign some data.
.TP
.BR \-\-hash ", " \-h
Hash some data.
.TP
.Br "\-\-mechanism " \fImechanism\fP ", \-m " \fImechanism\fP
Use the specified \fImechanism\fP for token operations.
See \-M for a list of mechanisms supported by your token.
.TP
.BR \-\-keypairgen ", " \-k
Generate a new key pair (public and private pair.)
.TP
.BR "\-\-write\-object " \fIid\fP ", \-w " \fIid\fP
Write a key or certificate object to the token.
.TP
.BR "\-\-type " \fItype\fP ", \-y " \fItype\fP
Specify the type of object to operate on. Examples are \fIcert\fP ,
\fIprivkey\fP and \fIpubkey\fP .
.TP
.BR "\-\-id " \fIid\fP ", \-d " \fIid\fP
Specify the id of the object to operate on."
.TP
.BR "\-\-label " \fIname\fP ", \-a " \fIname\fP
Specify the name of the object to operate on.
.TP
.BR "\-\-slot " \fIid\fP
Specify the id of the slot to use.
.TP
.BR "\-\-slot\-id " \fIname\fP
Specify the name of the slot to use.
.TP
.BR "\-\-set\-id " \fIid\fP ", \-e " \fIid\fP
Set the CKA_ID of the object.
.TP
.BR "\-\-input\-file " \fIpath\fP ", \-i " \fIpath\fP
Specify the path to a file for input.
.TP
.BR "\-\-output\-file " \fIpath\fP ", \-o " \fIpath\fP
Specify the path to a file for output.
.TP
.BR "\-\-module " \fImod\fP
Specify a module to load.
.TP
.BR "\-\-moz\-cert " \fIpath\fP ", \-z " \fIpath\fP
Tests a Mozilla-like keypair generation and certificate request.
Specify the \fIpath\fP to the certificate file.
.SH SEE ALSO
.BR opensc (7),
.SH AUTHORS
\*(nm was written by Olaf Kirch
This manpage was contributed by Joe Phillips <joe.phillips@innovationsw.com>
for the Debian GNU/Linux system (but may be used by others).

2
src/tools/pkcs11-tool.c
View File

@ -61,9 +61,9 @@ const struct option options[] = {
{ "type", 1, 0, 'y' },
{ "id", 1, 0, 'd' },
{ "label", 1, 0, 'a' },
{ "set-id", 1, 0, 'e' },
{ "slot", 1, 0, OPT_SLOT },
{ "slot-label", 1, 0, OPT_SLOT_LABEL },
{ "set-id", 1, 0, 'e' },
{ "input-file", 1, 0, 'i' },
{ "output-file", 1, 0, 'o' },
{ "module", 1, 0, OPT_MODULE },