gpg: Extend the ERRSIG status line with a fingerprint.
[gnupg.git] / doc / scdaemon.texi
index 85a80f0..a9e6d1e 100644 (file)
@@ -66,22 +66,22 @@ only one command is allowed.
 @table @gnupgtabopt
 @item --version
 @opindex version
-Print the program version and licensing information.  Not that you can
+Print the program version and licensing information.  Note that you cannot
 abbreviate this command.
 
 @item --help, -h
 @opindex help
 Print a usage message summarizing the most useful command-line options.
-Not that you can abbreviate this command.
+Note that you cannot abbreviate this command.
 
 @item --dump-options
 @opindex dump-options
-Print a list of all available options and commands.  Not that you can
+Print a list of all available options and commands.  Note that you cannot
 abbreviate this command.
 
 @item --server
 @opindex server
-Run in server mode and wait for commands on the @code{stdin}.  This is
+Run in server mode and wait for commands on the @code{stdin}.  The
 default mode is to create a socket and listen for commands there.
 
 @item --multi-server
@@ -160,7 +160,7 @@ helpers to debug problems.
 
 @item --debug @var{flags}
 @opindex debug
-This option is only useful for debugging and the behaviour may change at
+This option is only useful for debugging and the behavior may change at
 any time without notice.  FLAGS are bit encoded and may be given in
 usual C-Syntax. The currently defined bits are:
 
@@ -176,7 +176,7 @@ memory allocation
 @item 6  (64)
 caching
 @item 7  (128)
-show memory statistics.
+show memory statistics
 @item 9  (512)
 write hashed data to files named @code{dbgmd-000*}
 @item 10 (1024)
@@ -213,7 +213,7 @@ insertions.
 @opindex debug-allow-core-dump
 For security reasons we won't create a core dump when the process
 aborts.  For debugging purposes it is sometimes better to allow core
-dump.  This options enables it and also changes the working directory to
+dump.  This option enables it and also changes the working directory to
 @file{/tmp} when running in @option{--server} mode.
 
 @item --debug-log-tid
@@ -225,7 +225,7 @@ This option appends a thread ID to the PID in the log output.
 @efindex ASSUAN_DEBUG
 Changes the active Libassuan logging categories to @var{cats}.  The
 value for @var{cats} is an unsigned integer given in usual C-Syntax.
-A value of of 0 switches to a default category.  If this option is not
+A value of 0 switches to a default category.  If this option is not
 used the categories are taken from the environment variable
 @code{ASSUAN_DEBUG}.  Note that this option has only an effect if the
 Assuan debug flag has also been with the option @option{--debug}.  For
@@ -236,6 +236,12 @@ a list of categories see the Libassuan manual.
 Don't detach the process from the console.  This is mainly useful for
 debugging.
 
+@item --listen-backlog @var{n}
+@opindex listen-backlog
+Set the size of the queue for pending connections.  The default is 64.
+This option has an effect only if @option{--multi-server} is also
+used.
+
 @item --log-file @var{file}
 @opindex log-file
 Append all logging output to @var{file}.  This is very helpful in
@@ -313,10 +319,10 @@ Even if a card reader features a pinpad, do not try to use it.
 @opindex allow-admin
 This option disables the use of admin class commands for card
 applications where this is supported.  Currently we support it for the
-OpenPGP card. This commands is useful to inhibit accidental access to
+OpenPGP card. This option is useful to inhibit accidental access to
 admin class command which could ultimately lock the card through wrong
 PIN numbers.  Note that GnuPG versions older than 2.0.11 featured an
-@option{--allow-admin} command which was required to use such admin
+@option{--allow-admin} option which was required to use such admin
 commands.  This option has no more effect today because the default is
 now to allow admin commands.
 
@@ -390,7 +396,7 @@ comes with almost all German banking cards.
 @node SmartCard-HSM
 @subsection The SmartCard-HSM card application ``sc-hsm''
 
-This application adds read/only support for keys and certificates
+This application adds read-only support for keys and certificates
 stored on a @uref{http://www.smartcard-hsm.com, SmartCard-HSM}.
 
 To generate keys and store certifiates you may use
@@ -433,12 +439,12 @@ name may be changed on the command line (@pxref{option --options}).
 
 @item scd-event
 @cindex scd-event
-If this file is present and executable, it will be called on veyer card
-reader's status changed. An example of this script is provided with the
+If this file is present and executable, it will be called on every card
+reader's status change An example of this script is provided with the
 distribution
 
 @item reader_@var{n}.status
-This file is created by @command{sdaemon} to let other applications now
+This file is created by @command{scdaemon} to let other applications now
 about reader status changes.  Its use is now deprecated in favor of
 @file{scd-event}.
 
@@ -469,7 +475,7 @@ $ scdaemon --server -v
 
 The SC-Daemon should be started by the system to provide access to
 external tokens.  Using Smartcards on a multi-user system does not
-make much sense expect for system services, but in this case no
+make much sense except for system services, but in this case no
 regular user accounts are hosted on the machine.
 
 A client connects to the SC-Daemon by connecting to the socket named
@@ -490,7 +496,7 @@ synchronizing access to a token between sessions.
 * Scdaemon SETATTR::      Update an attribute's value.
 * Scdaemon WRITEKEY::     Write a key to a card.
 * Scdaemon GENKEY::       Generate a new key on-card.
-* Scdaemon RANDOM::       Return random bytes generate on-card.
+* Scdaemon RANDOM::       Return random bytes generated on-card.
 * Scdaemon PASSWD::       Change PINs.
 * Scdaemon CHECKPIN::     Perform a VERIFY operation.
 * Scdaemon RESTART::      Restart connection
@@ -516,11 +522,10 @@ done on the same card unless he call this function.
 Return the serial number of the card using a status response like:
 
 @example
-  S SERIALNO D27600000000000000000000 0
+  S SERIALNO D27600000000000000000000
 @end example
 
-The trailing 0 should be ignored for now, it is reserved for a future
-extension.  The serial number is the hex encoded value identified by
+The serial number is the hex encoded value identified by
 the @code{0x5A} tag in the GDO file (FIX=0x2F02).
 
 
@@ -533,11 +538,11 @@ the @code{0x5A} tag in the GDO file (FIX=0x2F02).
 @end example
 
 Learn all useful information of the currently inserted card.  When
-used without the force options, the command might do an INQUIRE
+used without the @option{--force} option, the command might do an INQUIRE
 like this:
 
 @example
-      INQUIRE KNOWNCARDP <hexstring_with_serialNumber> <timestamp>
+      INQUIRE KNOWNCARDP <hexstring_with_serialNumber>
 @end example
 
 The client should just send an @code{END} if the processing should go on
@@ -561,7 +566,7 @@ returned in @var{hexstring_with_keygrip}.
 
 This function is used to read a certificate identified by
 @var{hexified_certid} from the card.  With OpenPGP cards the keyid
-@code{OpenPGP.3} may be used to rad the certificate of version 2 cards.
+@code{OpenPGP.3} may be used to read the certificate of version 2 cards.
 
 
 @node Scdaemon READKEY
@@ -622,23 +627,23 @@ using the command
 
 where @var{keyid} is the hexified ID of the key to be used.
 
-If the card is ware of the apdding format a status line with padding
+If the card is aware of the apdding format a status line with padding
 information is send before the plaintext data.  The key for this
 status line is @code{PADDING} with the only defined value being 0 and
 meaning padding has been removed.
 
 @node Scdaemon GETATTR
-@subsection Read an attribute's value.
+@subsection Read an attribute's value
 
 TO BE WRITTEN.
 
 @node Scdaemon SETATTR
-@subsection Update an attribute's value.
+@subsection Update an attribute's value
 
 TO BE WRITTEN.
 
 @node Scdaemon WRITEKEY
-@subsection Write a key to a card.
+@subsection Write a key to a card
 
 @example
   WRITEKEY [--force] @var{keyid}
@@ -657,18 +662,18 @@ actual card application.
 
 
 @node Scdaemon GENKEY
-@subsection Generate a new key on-card.
+@subsection Generate a new key on-card
 
 TO BE WRITTEN.
 
 @node Scdaemon RANDOM
-@subsection Return random bytes generate on-card.
+@subsection Return random bytes generated on-card
 
 TO BE WRITTEN.
 
 
 @node Scdaemon PASSWD
-@subsection Change PINs.
+@subsection Change PINs
 
 @example
    PASSWD [--reset] [--nullpin] @var{chvno}
@@ -680,7 +685,7 @@ is used to initialize the PIN of TCOS cards (6 byte NullPIN only).
 
 
 @node Scdaemon CHECKPIN
-@subsection Perform a VERIFY operation.
+@subsection Perform a VERIFY operation
 
 @example
   CHECKPIN @var{idstr}
@@ -709,7 +714,7 @@ and only if the retry counter is still at 3.
 
 
 @node Scdaemon RESTART
-@subsection Perform a RESTART operation.
+@subsection Perform a RESTART operation
 
 @example
   RESTART
@@ -727,7 +732,7 @@ command; i.e. to select another application.
 
 
 @node Scdaemon APDU
-@subsection Send a verbatim APDU to the card.
+@subsection Send a verbatim APDU to the card
 
 @example
   APDU [--atr] [--more] [--exlen[=@var{n}]] [@var{hexstring}]