[Pcsclite-cvs-commit] r1615 - trunk/PCSC/doc
Ludovic Rousseau
rousseau at costa.debian.org
Mon Aug 15 09:59:04 UTC 2005
Author: rousseau
Date: 2005-08-15 09:59:03 +0000 (Mon, 15 Aug 2005)
New Revision: 1615
Modified:
trunk/PCSC/doc/formaticc.1
trunk/PCSC/doc/pcscd.8.in
trunk/PCSC/doc/reader.conf.5.in
Log:
update
Modified: trunk/PCSC/doc/formaticc.1
===================================================================
--- trunk/PCSC/doc/formaticc.1 2005-08-13 14:27:23 UTC (rev 1614)
+++ trunk/PCSC/doc/formaticc.1 2005-08-15 09:59:03 UTC (rev 1615)
@@ -1,47 +1,40 @@
-.TH "formaticc" "1" "1.2.9" "Debian GNU/Linux" "PC/SC Lite"
-.SH "NAME"
-.LP
+.TH formaticc 1 "August 2005" Muscle "PC/SC Lite"
+.SH NAME
formaticc \- An APDU robot for pcsc\-lite
-.SH "SYNTAX"
-.LP
+.
+.SH SYNTAX
.B formaticc
-.SH "DESCRIPTION"
-.LP
+.
+.SH DESCRIPTION
.B formaticc
sends one or more request APDU's to a smart card and get responses.
-.LP
+.PP
.B formaticc
takes a set of APDU's from an input file
and generates an output file with the data returned by the card.
-.LP
+.PP
The input and output file names and the identification of the reader
to connect to are prompted to the user.
-.LP
-The input file contains a line per APDU. Each line contains the length in
+.PP
+The input file contains an APDU per line. Each line contains the length in
bytes of the APDU and the APDU octets in hexadecimal notation, separated by
space characters. The generated output file contains response APDU's
following the same format.
-.SH "FILES"
+.
+.SH "EXAMPLE FILES"
.TP
-\fI/usr/share/doc/libpcsclite1/examples/sample.in
-.br
-sample input file.
+sample input file:
+ 05 C0 84 00 00 08
+ 05 C0 84 00 00 08
+ 07 C0 A4 00 00 02 3F 00
+ 07 C0 A4 00 00 02 3F 00
.TP
-\fI/usr/share/doc/libpcsclite1/examples/sample.ibm
-.br
-sample input file for an IBM MFC smart card.
-.TP
-\fI/usr/share/doc/libpcsclite1/examples/sample.out
-.br
-sample output file.
-.SH "EXAMPLES"
-.LP
-To run this program the standard way type:
-.LP
-.B formaticc
-.SH "AUTHORS"
+sample output file:
+ 02 6e 00
+.
+.SH AUTHORS
This manual page was written by Carlos Prados <cprados at debian.org>,
for the Debian GNU/Linux system (but may be used by others).
+.
.SH "SEE ALSO"
-.LP
.BR pcscd (8)
Modified: trunk/PCSC/doc/pcscd.8.in
===================================================================
--- trunk/PCSC/doc/pcscd.8.in 2005-08-13 14:27:23 UTC (rev 1614)
+++ trunk/PCSC/doc/pcscd.8.in 2005-08-15 09:59:03 UTC (rev 1615)
@@ -1,60 +1,69 @@
-.\" Process this file with
-.\" groff -man -Tascii pcscd.txt
-.\"
-.TH PCSCD 8 "March 2005" Linux "User Manual"
+.TH PCSCD 8 "August 2005" Muscle "PC/SC Lite"
.SH NAME
pcscd \- PC/SC Smart Card Daemon
+.
.SH SYNOPSIS
-.BI "pcscd [" options "]"
+.B pcscd
+.RI [ options ]
+.
.SH OPTIONS
.TP
-\fB\-a\fR, \fB\-\-apdu\fR
-log APDUs and SW using the debug method (see \fB\-d\fR)
+.BR -a ", " \-\-apdu
+log APDUs and SW using the debug method (see
+.BR \-\-debug ).
.TP
-\fB\-c\fR, \fB\-\-config\fR \fIfile\fR
-Specifies the file \fIfile\fR as an alternate location for
-\fI at confdir@/reader.conf\fR
+.BR \-c ", " \-\-config " \fIfile\fP"
+Specifies the file \fIfile\fP as an alternate location for
+.IR @confdir@/reader.conf .
.TP
-\fB\-f\fR, \fB\-\-foreground\fR
-Runs pcscd in the foreground and send logs to stderr instead of syslog
+.BR \-f ", " \-\-foreground
+Runs pcscd in the foreground and sends log messages to stderr instead of
+syslog(3).
.TP
-\fB\-d\fR, \fB\-\-debug\fR
-use lowest log level. Any log message of this level or above will be
-sent to stderr or syslog depending on the use of \fB\-\-foreground\fR
+.BR \-d ", " \-\-debug
+use the lowest log level. Any log message of this level or above will be
+sent to stderr or syslog(3) depending on the use of
+.BR \-\-foreground .
.TP
-\fB\-\-info\fR
-use info log level
+.B \-\-info
+use info log level. This is the default log level.
.TP
-\fB\-\-error\fR
-use error log level
+.B \-\-error
+use error log level.
.TP
-\fB\-\-critical\fR
-use critical log level
+.B \-\-critical
+use critical log level.
+.PP
+The log levels are ordered as: debug < info < error < critical. Use a
+log level l will log this level and all the levels above it.
.TP
-\fB\-h\fR, \fB\-\-help\fR
+.BR \-h ", " \-\-help
Displays information about the pcscd command line
.TP
-\fB\-v\fR, \fB\-\-version\fR
+.BR \-v ", " \-\-version
Displays the program version number
+.
.SH DESCRIPTION
pcscd is the daemon program for pcsc-lite and the MuscleCard framework. It is
a resource manager that coordinates communications with smart card readers
and smart cards and cryptographic tokens that are connected to the system.
-
+.PP
pcscd is normally started at boot time from
.IR @sysconfdir_exp@/init.d/pcscd .
It allows applications to access smart cards and readers without knowing
details of the card or reader.
-
+.PP
pcscd coordinates the loading of drivers for card readers.
-
+.PP
The purpose of pcsc-lite is to provide a cross compatible API (called
winscard) for migrating Windows based PC/SC applications to Unix.
-
+.PP
At startup, pcscd loads the smart card reader drivers specified in the
.I @confdir@/reader.conf
-file (or specified using \fB-c\fR \fIfile\fR).
-
+file (or specified using
+.B \-\-config
+.IR file ).
+.
.SH "SERIAL SMART CARD READER DRIVERS"
Smart card reader drivers are placed in the
.I @usbdropdir@
@@ -65,27 +74,34 @@
file. See the
.BR reader.conf (5)
manual page for more information.
-Drivers are available at \fIhttp://www.musclecard.com/drivers.html\fR.
-
+Drivers are available at \fIhttp://www.musclecard.com/drivers.html\fP.
+.
+.SH "USB SMART CARD READER DRIVERS"
+USB smart card reader drivers are located in
+.I @usbdropdir@
+directory as a bundle. You shall not add a USB driver in
+.I @confdir@/reader.conf
+file.
+.
.SH FILES
.I @confdir@/reader.conf
: Reader configuration file
-
+.PP
.I @sysconfdir_exp@/init.d/pcscd
: pcscd startup script
-
+.PP
@HAVE_RUNPID at .I @runpid@
@HAVE_RUNPID@: process id of the running pcscd
@HAVE_RUNPID@
.I @usbdropdir@
-: directory containing bundles for USB
-drivers
-.SH BUGS
-None known.
+: directory containing bundles for USB drivers
+.
.SH "SEE ALSO"
.BR bundleTool (8),
.BR formaticc (1),
-.BR reader.conf (5)
+.BR reader.conf (5),
+.BR syslog (3)
+.
.SH AUTHORS
David Corcoran <corcoran at musclecard.com> and Ludovic Rousseau
<ludovic.rousseau at free.fr>
Modified: trunk/PCSC/doc/reader.conf.5.in
===================================================================
--- trunk/PCSC/doc/reader.conf.5.in 2005-08-13 14:27:23 UTC (rev 1614)
+++ trunk/PCSC/doc/reader.conf.5.in 2005-08-15 09:59:03 UTC (rev 1615)
@@ -1,33 +1,32 @@
-.\" Process this file with
-.\" groff -man -Tascii reader_conf.8
-.\"
-.TH READER_CONF 8 "April 2004" Linux "User Manual"
+.TH READER.CONF 5 "August 2005" Muscle "PC/SC Lite"
.SH NAME
-reader.conf - configuration file for pcscd readers' drivers
+reader.conf \- configuration file for pcscd readers' drivers
+.
.SH DESCRIPTION
The
.I @confdir@/reader.conf
file contains configuration information for serial and (some) PCMCIA
smart card readers.
-
+.PP
USB readers SHALL NOT be configured using this file.
.B pcscd
uses another mechanism to automatically load USB drivers.
+.
.SH SYNTAX
The
.I @confdir@/reader.conf
is a regular text file. Each reader must be defined by four fields:
-
+.PP
FRIENDLYNAME TEXT_STRING
DEVICENAME FILENAME
LIBPATH FILENAME
CHANNELID NUMBER
-
+.PP
The "FRIENDLYNAME" field is an arbitrary text used to identify the
reader. This text is displayed by commands like
.BR pcsc_scan (1)
that prints the names of all the connected and detected readers.
-
+.PP
The "DEVICENAME" field was not used for old drivers (using the IFD
handler version 2.0 or earlier). It is now (IFD handler version 3.0) used
to identify the physical port on which the reader is connected. This
@@ -37,17 +36,17 @@
under Linux and
.I /dev/cuaa0
under FreeBSD.
-
+.PP
The "LIBPATH" field is the filename of the driver code. The driver is
a dynamically loaded piece of code (generally a
-.I drivername.so*
-file).
-
+.IR drivername.so* file).
+.PP
The "CHANNELID" is no more used for recent drivers (IFD handler 3.0) and
has been superseded by "DEVICENAME". If you have an old driver this
field is used to indicate the port to use. You should read your driver
documentation to know what information is needed here. It should be the
serial port number for a serial reader.
+.
.SH EXAMPLE
# Gemplus GemPCTwin reader with serial communication
# connected to the first serial port
@@ -55,6 +54,7 @@
DEVICENAME /dev/ttyS0
LIBPATH @usbdropdir@/serial/libccidtwin.so.0.4.1
CHANNELID 1
+.
.SH DEBUGGING
In order to set up your
.I @confdir@/reader.conf
@@ -62,15 +62,17 @@
.BR pcscd .
I recommend you to start
.B pscsd
-in the foreground using:
- # pcscd --foreground
-
+in the foreground and debug mode using:
+ # pcscd \-\-foreground \-\-debug
+.PP
If everything seems OK you can use the
.B pcsc_scan
command to print the list of correctly detected readers and try to get
the ATR of your smart cards.
+.
.SH AUTHOR
Ludovic Rousseau <ludovic.rousseau at free.fr>
+.
.SH SEE ALSO
.BR pcscd (8),
.BR pcsc_scan (1)
More information about the Pcsclite-cvs-commit
mailing list