Copy in most files keylookup from keylookup cvs repository

[pgp-tools.git] / keylookup / keylookup.1

diff --git a/keylookup/keylookup.1 b/keylookup/keylookup.1
new file mode 100644 (file)
index 0000000..c652a9e
--- /dev/null
+++ b/keylookup/keylookup.1
@@ -0,0 +1,109 @@
+.TH keylookup 1 "" Jun-2002 ""
+.\" manual page (c) 2000, 2001, 2002 Christian Kurz, Peter Palfrader
+.\" $Id: keylookup.1,v 1.6 2002/06/17 14:18:13 weasel Exp $
+
+.SH NAME
+.LP
+keylookup \- Fetch and Import GnuPG keys from keyservers.
+
+.SH SYNOPSIS
+\fBkeylookup\fP [\fIoptions\fP] \fIsearch-string\fP
+
+.SH DESCRIPTION
+.LP
+\fBkeylookup\fR is a perl script that queries a keyserver for keys 
+matching the \fIsearch-string\fP. It shows a list to the user and offers 
+her/him to select the keys for importing into her/his GnuPG keyring.
+
+For the actual import of keys GnuPG itself is called.
+
+
+.SH OPTIONS
+.IP "\fB--keyserver\fP=\fIkeyserver\fP" 8
+Specify the keyserver to use. If no keyserver is specified, it 
+will parse the GnuPG optiosn file for a default keyserver to use.
+If no keyserver can be found, \fBkeylookup\fP will abort.
+
+.IP "\fB--port\fP=\fIport\fP" 8
+Use a port other than 11371.
+
+.IP "\fB--frontend\fP=\fIfrontend\fP" 8
+\fBkeylookup\fP supports displaying the search results with 3
+different frondends. Both \fBwhiptail\fP and \fBdialog\fP are
+interactive and allow the user to select the keys to import.
+The third frontend \fBplain\fP is non\-interactive and just 
+prints the keys to STDOUT. The user must then call GnuPG him/herself.
+
+If available, \fB/usr/bin/dialog\fP is the default. If it is not
+available but \fB/usr/bin/whiptail\fP is installed, then this is 
+used instead. If nothing else works, we'll fall back to \fBplain\fP.
+
+.IP "\fB--importall\fP" 8
+Don't ask the user which keys to import, but instead import all 
+keys matching the \fIsearch-string\fP. If this is given no 
+frontend is needed.
+
+.IP "\fB--honor-http-proxy\fP" 8
+Similar to GnuP \fBkeylookup\fP will only honor the \fBhttp_proxy\fP
+environment variable if this option is given. If it is not given
+but your GnuPG options file includes it, then \fBkeylookup\fP will 
+use it.
+
+.IP "\fB--help\fP" 8
+Print a brief help message and exit succesfully.
+
+
+
+.SH ENVIRONMENT
+
+.IP "HOME" 10 
+Used to locate the default home directory. 
+
+.IP "GNUPGHOME" 10 
+If set directory used instead of "~/.gnupg". 
+
+.IP "http_proxy" 10 
+Only honored when the option --honor-http-proxy is set or honor-http-proxy is
+set in GnuPG's config file.
+
+
+
+.SH EXAMPLES
+
+.IP "keylookup Christian Kurz"
+will query your default keyserver for Christian's keys and offer you to
+import them into your keyring with the dialog frontend (if available).
+
+.IP "keylookup --honor-http-proxy --frontend plain wk@gnupg"
+will query the default keyserver again, now using the http_proxy if
+the environment variable is defined and list wk@gnupg's (Werner Koch)'s key
+on STDOUT.
+
+.IP "keylookup --keyserver pgp.mit.edu Peter Palfrader"
+will now ask the keyserver pgp.mit.edu for my (Peter's) keys and
+display them for import in dialog.
+
+
+.SH FILES
+
+.IP "~/.gnupg/options"  10
+GnuPG's options file where \fBkeylookup\fP will take the keyserver
+and honor-http-proxy values from if it exists.
+
+
+.SH "SEE ALSO"
+
+\fBgpg\fP(1), \fBhttp://www.palfrader.org/keylookup/\fP
+
+.SH BUGS
+
+.LP
+Please report bugs to shorty@debian.org and peter@palfrader.org.
+
+
+.SH AUTHOR
+
+.LP
+Christian Kurz <shorty@debian.org>
+.br
+Peter Palfrader <peter@palfrader.org>