Add a changelog
[pgp-tools.git] / keylookup / keylookup.1
1 .TH keylookup 1 "" Jun-2002 ""
2 .\" manual page (c) 2000, 2001, 2002 Christian Kurz, Peter Palfrader
3 .\" $Id$
4
5 .SH NAME
6 .LP
7 keylookup - Fetch and Import GnuPG keys from keyservers.
8
9 .SH SYNOPSIS
10 \fBkeylookup\fP [\fIoptions\fP] \fIsearch-string\fP
11
12 .SH DESCRIPTION
13 .LP
14 \fBkeylookup\fR is a wrapper around gpg \-\-search, allowing you to search
15 for keys on a keyserver. It presents the list of matching keys to the user
16 and allows her to select the keys for importing into the GnuPG keyring.
17
18 For the search and actual import of keys GnuPG itself is called.
19
20
21 .SH OPTIONS
22 .IP "\fB\-\-keyserver\fP=\fIkeyserver\fP" 8
23 Specify the keyserver to use. If no keyserver is specified, it
24 will parse the GnuPG options file for a default keyserver to use.
25 If no keyserver can be found, \fBkeylookup\fP will abort.
26
27 .IP "\fB\-\-port\fP=\fIport\fP" 8
28 Use a port other than 11371.
29
30 .IP "\fB\-\-frontend\fP=\fIfrontend\fP" 8
31 \fBkeylookup\fP supports displaying the search results with 3
32 different frondends. Both \fBwhiptail\fP and \fBdialog\fP are
33 interactive and allow the user to select the keys to import.
34 The third frontend \fBplain\fP is non\-interactive and just
35 prints the keys to STDOUT. The user must then call GnuPG him/herself.
36
37 If available, \fB/usr/bin/dialog\fP is the default. If it is not
38 available but \fB/usr/bin/whiptail\fP is installed, then this is
39 used instead. If nothing else works, we'll fall back to \fBplain\fP.
40
41 .IP "\fB\-\-importall\fP" 8
42 Don't ask the user which keys to import, but instead import all
43 keys matching the \fIsearch-string\fP. If this is given no
44 frontend is needed.
45
46 .IP "\fB\-\-honor\-http\-proxy\fP" 8
47 Similar to GnuP \fBkeylookup\fP will only honor the \fBhttp_proxy\fP
48 environment variable if this option is given. If it is not given
49 but your GnuPG options file includes it, then \fBkeylookup\fP will
50 use it.
51
52 .IP "\fB\-\-help\fP" 8
53 Print a brief help message and exit successfully.
54
55
56
57 .SH ENVIRONMENT
58
59 .IP "HOME" 10
60 Used to locate the default home directory.
61
62 .IP "GNUPGHOME" 10
63 If set directory used instead of "~/.gnupg".
64
65 .IP "http_proxy" 10
66 Only honored when the option \-\-honor\-http\-proxy is set or
67 honor\-http\-proxy is set in GnuPG's config file.
68
69
70
71 .SH EXAMPLES
72
73 .IP "keylookup Christian Kurz"
74 will query your default keyserver for Christian's keys and offer you to
75 import them into your keyring with the dialog frontend (if available).
76
77 .IP "keylookup \-\-honor\-http\-proxy \-\-frontend plain wk@gnupg"
78 will query the default keyserver again, now using the http_proxy if
79 the environment variable is defined and list wk@gnupg's (Werner Koch)'s key
80 on STDOUT.
81
82 .IP "keylookup \-\-keyserver pgp.mit.edu Peter Palfrader"
83 will now ask the keyserver pgp.mit.edu for my (Peter's) keys and
84 display them for import in dialog.
85
86
87 .SH FILES
88
89 .IP "~/.gnupg/options" 10
90 GnuPG's options file where \fBkeylookup\fP will take the keyserver
91 and honor\-http\-proxy values from if it exists.
92
93
94 .SH "SEE ALSO"
95
96 \fBgpg\fP(1)
97
98 .SH BUGS
99
100 .LP
101 Please report bugs using the Debian bug tracking system at
102 http://bugs.debian.org/.
103
104
105 .SH AUTHORS
106
107 .LP
108 Christian Kurz <shorty@debian.org>
109 .br
110 Peter Palfrader <peter@palfrader.org>