From c9489fc76e2fbf041a39d3d6311e2ace165d970d Mon Sep 17 00:00:00 2001 From: Werner Koch Date: Wed, 22 Dec 2004 17:24:13 +0000 Subject: [PATCH] * gnupg.texi: Reordered. * contrib.texi: Updated. --- doc/ChangeLog | 5 +++++ doc/assuan.texi | 18 ++++++++++------ doc/contrib.texi | 54 ++++++++++++++++------------------------------- doc/glossary.texi | 6 ++++++ doc/gnupg.texi | 19 ++++++----------- doc/tools.texi | 22 ++++++++++--------- 6 files changed, 59 insertions(+), 65 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index f6f41f2b5..407b706b0 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,8 @@ +2004-12-22 Werner Koch + + * gnupg.texi: Reordered. + * contrib.texi: Updated. + 2004-12-21 Werner Koch * tools.texi (gpg-preset-passphrase): New section. diff --git a/doc/assuan.texi b/doc/assuan.texi index 2e2219263..cb6eb9c31 100644 --- a/doc/assuan.texi +++ b/doc/assuan.texi @@ -3,14 +3,15 @@ @c For copying conditions, see the file gnupg.texi. @node Assuan -@chapter Description of the Assuan protocol. +@appendix Description of the Assuan protocol. +@cindex Assuan, IPC The architecture of the modular GnuPG system is based on a couple of highly specialized modules which make up a network of client server communication. A common framework for intermodule communication is therefore needed and should be implemented in a library. -Goals: +@appendixsubsec Goals @itemize @bullet @item Common framework for module communication @@ -22,7 +23,7 @@ Goals: @end itemize -Design criteria: +@appendixsubsec Design criteria @itemize @bullet @item Client Server with back channel @@ -36,8 +37,10 @@ Design criteria: @item Subliminal channels are not an issue @end itemize -Implementation: +@appendixsubsec Implementation + +@noindent The implementation is line based with a maximum line size of 1000 octects. The default IPC mechanism are Unix Domain Sockets. @@ -57,7 +60,7 @@ state. All textual messages are assumed to be in UTF-8 unless otherwise noted. -Server responses: +@appendixsubsec Server responses @table @code @item OK [] @@ -98,7 +101,7 @@ treated as a communication error. (The rationale for having a line length limit is to allow for easier multiplexing of multiple channels). -Client requests: +@appendixsubsec Client requests The server waits for client requests after he sent an Okay or Error. The client should not issue a request in other cases with the @@ -171,7 +174,8 @@ to indicate a partial end of data. @end table -Error Codes: + +@appendixsubsec Error Codes Here we keep a list of error codes used in any Assuan based protocol. The format is the string @code{ERR}, white space, the error diff --git a/doc/contrib.texi b/doc/contrib.texi index 73d722c23..28ea2e1d3 100644 --- a/doc/contrib.texi +++ b/doc/contrib.texi @@ -10,42 +10,7 @@ The GnuPG project would like to thank its many contributors. Without them the project would not have been nearly as successful as it has been. Any omissions in this list are accidental. Feel free to contact the maintainer if you have been left out or some of your contributions -are not listed. Please keep this list in alphabetical order. - -@itemize @bullet - -@item -Bernhard Herzog did extensive testing and tracked down a lot of bugs. - -@item -Bernhard Reiter made sure that we met the specifications and the -deadlines. He did extensive testing and came up with a lot of suggestions. - -@item -Jan-Oliver Wagner made sure that we met the specifications and the -deadlines. He did extensive testing and came up with a lot of suggestions. - -@item -Karl-Heinz Zimmer had to struggle with all the bugs and misconceptions -while working on Kmail integration. - -@item -Marcus Brinkman cleaned up the Assuan code and fixed bugs all over the place. - -@item -Steffen Hansen had a hard time to write the dirmngr due to -underspecified interfaces. - -@item -Thomas Koester did extensive testing and tracked down a lot of bugs. - -@item -Werner Koch designed the system and wrote most of the original code. - -@end itemize - -We'd also like to thank these folks who have contributed a lot of time -and energy working on GnuPG over the years: +are not listed. David Shaw, Matthew Skala, Michael Roth, Niklas Hernaeus, Nils Ellmenreich, Rémi Guyomarch, Stefan Bellon, Timo Schulz and Werner @@ -60,6 +25,23 @@ Koch, Yosiaki IIDA did the official translations. Mike Ashley wrote and maintains the GNU Privacy Handbook. David Scribner is the current FAQ editor. Lorenzo Cappelletti maintains the web site. +The new modularized architecture of gnupg 1.9 as well as the X.509/CMS +part has been developed as part of the Ägypten project. Direct +contributors to this project are: Bernhard Herzog, who did extensive +testing and tracked down a lot of bugs. Bernhard Reiter, who made sure +that we met the specifications and the deadlines. He did extensive +testing and came up with a lot of suggestions. Jan-Oliver Wagner made +sure that we met the specifications and the deadlines. He also did +extensive testing and came up with a lot of suggestions. Karl-Heinz +Zimmer and Marc Mutz had to struggle with all the bugs and +misconceptions while working on KDE integration. Marcus Brinkman +extended GPGME, cleaned up the Assuan code and fixed bugs all over the +place. Moritz Schulte took over Libgcrypt maintenance and developed it +into a stable an useful library. Steffen Hansen had a hard time to +write the dirmngr due to underspecified interfaces. Thomas Koester did +extensive testing and tracked down a lot of bugs. Werner Koch designed +the system and wrote most of the code. + The following people helped greatly by suggesting improvements, testing, fixing bugs, providing resources and doing other important tasks: Adam Mitchell, Albert Chin, Alec Habig, Allan Clark, Anand diff --git a/doc/glossary.texi b/doc/glossary.texi index 7c1b7d5a0..e739947ef 100644 --- a/doc/glossary.texi +++ b/doc/glossary.texi @@ -16,6 +16,12 @@ certificates. The @emph{Certificate Revocation List} is a list containing certificates revoked by the issuer. +@item Keygrip + This term is used by GnuPG to describe a 20 byte hash value used +to identify a certain key without referencing to a concrete protocol. +It is used internally to access a private key. Usually it is shown and +entered as a 40 character hexadecimal formatted string. + @item OCSP The @emph{Online Certificate Status Protocol} is used as an alternative to a @acronym{CRL}. It is described in @code{RFC 2560}. diff --git a/doc/gnupg.texi b/doc/gnupg.texi index d74a76ca9..006e604a0 100644 --- a/doc/gnupg.texi +++ b/doc/gnupg.texi @@ -107,7 +107,7 @@ Boston, MA 02111-1307 USA @top Introduction @cindex introduction -This manual documents how to use the GNU Privay Guard system as well as +This manual documents how to use the GNU Privacy Guard system as well as the administration and the architecture. @menu @@ -116,21 +116,15 @@ the administration and the architecture. * Invoking GPG-AGENT:: How to launch the secret key daemon. * Invoking SCDAEMON:: How to handle Smartcards. -Developer information - -* Assuan:: Description of the Assuan protocol. -* System Notes:: Notes pertaining to certain OSes. - -Miscellaneous - * Helper Tools:: Description of small helper tools + +* System Notes:: Notes pertaining to certain OSes. * Debugging:: How to solve problems +* Assuan:: Description of the Assuan protocol. * Copying:: GNU General Public License says how you can copy and share GnuPG * Contributors:: People who have contributed to GnuPG. -Indices - * Glossary:: Short descrition of used terms. * Option Index:: Index to command line options. * Index:: Index of concepts and symbol names. @@ -141,12 +135,13 @@ Indices @include gpg-agent.texi @include scdaemon.texi -@include assuan.texi +@include tools.texi + @include sysnotes.texi -@include tools.texi @include debugging.texi +@include assuan.texi @include gpl.texi @include contrib.texi diff --git a/doc/tools.texi b/doc/tools.texi index a7081e429..684975e19 100644 --- a/doc/tools.texi +++ b/doc/tools.texi @@ -601,10 +601,10 @@ whicl will be printed to stdout. @section Put a passphrase into the cache. The @command{gpg-preset-passphrase} is a utility to seed the internal -cache of a running @command{gpg-agent} with passphrases. This is mainly -useful for unatteneded machines, where a pinentry may not be used and -the passphrases for the to be used keys should be given at machine -startup. +cache of a running @command{gpg-agent} with passphrases. It is mainly +useful for unattended machines, where the usual @command{pinentry} tool +may not be used and the passphrases for the to be used keys are given at +machine startup. Passphrases set with this utility don't expire unless the @option{--forget} option is used to explicitly clear them from the cache @@ -630,28 +630,29 @@ gpg-preset-passphrase [options] [command] @var{keygrip} @var{keygrip} is a 40 character string of hexadecimal characters identifying the key for which the passphrase should be set or cleared. -This @emph{keygrip} is listed along with the key when running the -command: @code{gpgsm --dump-secret-keys}. One of the following commands +This keygrip is listed along with the key when running the command: +@code{gpgsm --dump-secret-keys}. One of the following command options must be given: @table @gnupgtabopt @item --preset Preset a passphrase. This is what you usually will -use. @command{gpg-preset-passphrase} will then read the passphrase form +use. @command{gpg-preset-passphrase} will then read the passphrase from @code{stdin}. @item --forget -Clear the passphrase for the given keygrip from the cache. +Flush the passphrase for the given keygrip from the cache. @end table -The following options may be used: +@noindent +The following additional options may be used: @table @gnupgtabopt @item -v @itemx --verbose @opindex verbose -Outputs additional information while running. +Output additional information while running. @item -P @var{string} @itemx --passphrase @var{string} @@ -663,3 +664,4 @@ for other users. +