See ChangeLog: Wed Jul 14 19:42:08 CEST 1999 Werner Koch

4 files changed, 71 insertions, 40 deletions

diff --git a/doc/DETAILS b/doc/DETAILS
index 6ff7cb656..d58567fdb 100644
--- a/doc/DETAILS
+++ b/doc/DETAILS
@@ -14,24 +14,33 @@ ssb::1536:20:5CE086B5B5A18FF4:1998-07-07:0:::
 	    fpr = fingerprint: (fingerprint is in field 10)
 	    pkd = public key data (special field format, see below)
 
- 2. Field:  A letter describing the calculated trust, see doc/FAQ
-	    This is a single letter, but be prepared that additional
-	    information may follow in some future versions.
-	    (not used for secret keys)
+ 2. Field:  A letter describing the calculated trust. This is a single
+	    letter, but be prepared that additional information may follow
+	    in some future versions. (not used for secret keys)
+		o = Unknown (this key is new to the system)
+		d = The key has been disabled
+		r = The key has been revoked
+		e = The key has expired
+		q = Undefined (no value assigned)
+		n = Don't trust this key at all
+		m = There is marginal trust in this key
+		f = The key is full trusted.
+		u = The key is ultimately trusted; this is only used for
+		    keys for which the secret key is also available.
  3. Field:  length of key in bits.
  4. Field:  Algorithm:	1 = RSA
 		       16 = ElGamal (encrypt only)
 		       17 = DSA (sometimes called DH, sign only)
 		       20 = ElGamal (sign and encrypt)
+            (for other id's see include/cipher.h)
  5. Field:  KeyID
  6. Field:  Creation Date (in UTC)
  7. Field:  Key expiration date or empty if none.
- 8. Field:  Local ID: record number of the dir record in the trustdb
-	    this value is only valid as long as the trustdb is not
-	    deleted.  May be later used to lookup the key: You will be
-	    able to use "#<local-id> as the user id.  This is needed
-	    because keyids may not be unique - a program may use this
-	    number to access keys later.
+ 8. Field:  Local ID: record number of the dir record in the trustdb.
+	    This value is only valid as long as the trustdb is not
+	    deleted. You can use "#<local-id> as the user id when
+	    specifying a key. This is needed because keyids may not be
+	    unique - a program may use this number to access keys later.
  9. Field:  Ownertrust (primary public keys only)
 	    This is a single letter, but be prepared that additional
 	    information may follow in some future versions.
@@ -158,6 +167,14 @@ more arguments in future versions.
     NO_SECKEY  <long keyid>
 	The key is not available
 
+    IMPORTED   <long keyid>  <username>
+	The keyid and name of the signature just imported
+
+    IMPORTED_RES <count> <no_user_id> <imported> <imported_rsa> <unchanged>
+	<n_uids> <n_subk> <n_sigs> <n_revoc> <sec_read> <sec_imported> <sec_dups>
+	Final statistics on import process (this is one long line)
+
+
 
 Key generation
 ==============
@@ -196,7 +213,7 @@ Layout of the TrustDB
 The TrustDB is built from fixed length records, where the first byte
 describes the record type.  All numeric values are stored in network
 byte order. The length of each record is 40 bytes. The first record of
-the DB is always of type 2 and this is the only record of this type.
+the DB is always of type 1 and this is the only record of this type.
 
   Record type 0:
   --------------
@@ -541,30 +558,28 @@ Status codes are:
 
 
 
-Ich werde jetzt doch das HKP Protokoll implementieren:
+Documentation on HKP (the http keyserver protocol):
 
-Naja, die Doku ist so gut wie nichtexistent, da gebe ich Dir recht.
-In kurzen Worten:
+A minimalistic HTTP server on port 11371 recognizes a GET for /pks/lookup.
+The standard http URL encoded query parameters are this (always key=value):
 
-(Minimal-)HTTP-Server auf Port 11371, versteht ein GET auf /pks/lookup,
-wobei die Query-Parameter (Key-Value-Paare mit = zwischen Key und
-Value; die Paare sind hinter ? und durch & getrennt). Gültige
-Operationen sind:
+- op=index (like pgp -kv), op=vindex (like pgp -kvv) and op=get (like
+  pgp -kxa)
 
-- - op (Operation) mit den Möglichkeiten index (gleich wie -kv bei
-  PGP), vindex (-kvv) und get (-kxa)
-- - search: Liste der Worte, die im Key vorkommen müssen. Worte sind
-  mit Worttrennzeichen wie Space, Punkt, @, ... getrennt, Worttrennzeichen
-  werden nicht betrachtet, die Reihenfolge der Worte ist egal.
-- - exact: (on=aktiv, alles andere inaktiv) Nur die Schlüssel
-  zurückgeben, die auch den "search"-String beinhalten (d.h.
-  Wortreihenfolge und Sonderzeichen sind wichtig)
-- - fingerprint (Bei [v]index auch den Fingerprint ausgeben), "on"
-  für aktiv, alles andere inaktiv
+- search=<stringlist>. This is a list of words that must occur in the key.
+  The words are delimited with space, points, @ and so on. The delimiters
+  are not searched for and the order of the words doesn't matter (but see
+  next option).
 
-Neu (wird von GNUPG benutzt):
-   /pks/lookup/<gnupg_formatierte_user_id>?op=<operation>
+- exact=on. This switch tells the hkp server to only report exact mathing
+  keys back. In this case the order and the "delimiters" are important.
+
+- fingerprint=on. Also reports the fingerprints when used with 'index' or
+  'vindex'
 
-Zusätzlich versteht der Keyserver auch ein POST auf /pks/add, womit
-man Keys hochladen kann.
+New (already used by GnuPG):
+
+   /pks/lookup/<gnupg_formatierte_user_id>?op=<operation>
 
+The keyserver also recognizes http-POSTs to /pks/add. Use this to upload
+keys.
diff --git a/doc/FAQ b/doc/FAQ
index c57b490ae..c879f93aa 100644
--- a/doc/FAQ
+++ b/doc/FAQ
@@ -161,7 +161,7 @@
   on a local computer (a disconnected laptop is probably the best choice)
   and if you need it on your connected box (I know: We all do this) be
   sure to have a strong password for your account and for your secret key
-  and trust your Root.
+  and that you can trust your system administrator.
 
   When I check GnuPG on a remote system via ssh (I have no Alpha here ;-)
   I have the same problem.  It takes a *very* long time to create the
@@ -178,7 +178,7 @@
 
   You can see the validity (calculated trust value) using this command.
 
-      gpgm --list-keys --with-colons
+      gpg --list-keys --with-colons
 
   If the first field is "pub" or "uid", the second field shows you the trust:
 
@@ -199,7 +199,7 @@
   You can get a list of the assigned trust values (how much you trust
   the owner to correctly sign another person's key)
 
-      gpgm --list-ownertrust
+      gpg --list-ownertrust
 
   The first field is the fingerprint of the primary key, the second field
   is the assigned value:
diff --git a/doc/HACKING b/doc/HACKING
index 8b285cfcd..bc06a7064 100644
--- a/doc/HACKING
+++ b/doc/HACKING
@@ -30,7 +30,10 @@ by sending a mail with subject "subscribe" to
     gnupg-commit-watchers-request@gnupg.org
 
 
-Please run scripts/autogen.sh to create some required files.
+You must run scripts/autogen.sh before doing the ./configure,
+as this creates some needed while which are not in the CVS.
+autogen.sh should checks that you have all required tools
+installed.
 
 
 RSYNC access
@@ -41,6 +44,17 @@ of the CVS head revision is also available.  See rsync(1) and try
 
 
 
+Special Tools
+=============
+Documention is based on the docbook DTD.  Actually we have only the
+man page for now.  To build a man page you need the docbook-to-man
+tool and all the other thinks needed for SGML processing.  Debian
+comes with the docbook tools and you only need this docbook-to-man
+script which is comes with gtk-doc or download it from
+ftp.openit.de:/pub/devel/sgml.	If you don't have it everything
+should still work fine but you will have only a dummy man page.
+
+
 RFCs
 ====
 
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 26f83e32b..c5bdf3c98 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -7,17 +7,19 @@ man_MANS = gpg.1
 
 %.1 : %.sgml
 if HAVE_DOCBOOK_TO_MAN
-	  docbook-to-man $<  >$@
+	docbook-to-man $<  >$@
 else
-	  : Warning: missing docbook-to-man, cannot make $@
+	: Warning: missing docbook-to-man, cannot make $@
+	echo ".TH $< 1"   >$@
+	echo "No man page due to missing docbook-to-man" >>$@
 endif
 
 
 %.txt : %.sgml
-	 sgml2txt -c latin $*
+	sgml2txt -c latin $*
 
 %.html : %.sgml
-	 sgml2html -c latin $*
+	sgml2html -c latin $*
 
 %.dvi : %.sgml
 	-rm $*.sgml.tmp