* gpg.sgml: Document keyserver-option http-proxy, import-option
[gnupg.git] / doc / gpg.sgml
1 <!-- gpg.sgml - the man page for GnuPG
2     Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003,
3                   2004 Free Software Foundation, Inc.
4
5     This file is part of GnuPG.
6
7     GnuPG is free software; you can redistribute it and/or modify
8     it under the terms of the GNU General Public License as published by
9     the Free Software Foundation; either version 2 of the License, or
10     (at your option) any later version.
11
12     GnuPG is distributed in the hope that it will be useful,
13     but WITHOUT ANY WARRANTY; without even the implied warranty of
14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15     GNU General Public License for more details.
16
17     You should have received a copy of the GNU General Public License
18     along with this program; if not, write to the Free Software
19     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
20 -->
21 <!-- This file should be processed by docbook-to-man to
22      create a manual page.  This program has currently the bug
23      not to remove leading white space. So this source file does
24      not look very pretty
25
26     FIXME: generated a file with entity (e.g. pathnames) from the
27     configure scripts and include it here
28 -->
29
30
31 <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
32 <!entity ParmDir "<parameter>directory</parameter>">
33 <!entity ParmFile "<parameter>file</parameter>">
34 <!entity OptParmFile "<optional>&ParmFile;</optional>">
35 <!entity ParmFiles "<parameter>files</parameter>">
36 <!entity OptParmFiles "<optional>&ParmFiles;</optional>">
37 <!entity ParmNames "<parameter>names</parameter>">
38 <!entity OptParmNames "<optional>&ParmNames;</optional>">
39 <!entity ParmName  "<parameter>name</parameter>">
40 <!entity OptParmName  "<optional>&ParmName;</optional>">
41 <!entity ParmKeyIDs "<parameter>key IDs</parameter>">
42 <!entity ParmN      "<parameter>n</parameter>">
43 <!entity ParmFlags  "<parameter>flags</parameter>">
44 <!entity ParmString "<parameter>string</parameter>">
45 <!entity ParmValue  "<parameter>value</parameter>">
46 <!entity ParmNameValue  "<parameter>name=value</parameter>">
47 <!entity ParmNameValues "<parameter>name=value1 <optional>value2 value3 ...</optional></parameter>">
48 <!entity OptEqualsValue "<optional>=value</optional>">
49 ]>
50
51 <refentry id="gpg">
52 <refmeta>
53   <refentrytitle>gpg</refentrytitle>
54   <manvolnum>1</manvolnum>
55   <refmiscinfo class="gnu">GNU Tools</refmiscinfo>
56 </refmeta>
57 <refnamediv>
58   <refname/gpg/
59   <refpurpose>encryption and signing tool</>
60 </refnamediv>
61 <refsynopsisdiv>
62   <synopsis>
63 <command>gpg</command>
64  <optional>--homedir <parameter/name/</optional>
65  <optional>--options <parameter/file/</optional>
66  <optional><parameter/options/</optional>
67  <parameter>command</parameter>
68  <optional><parameter/args/</optional>
69   </synopsis>
70 </refsynopsisdiv>
71
72 <refsect1>
73     <title>DESCRIPTION</title>
74     <para>
75 <command/gpg/ is the main program for the GnuPG system.
76     </para>
77     <para>
78 This man page only lists the commands and options available.  For more
79 verbose documentation get the GNU Privacy Handbook (GPH) or one of the
80 other documents at http://www.gnupg.org/documentation/ .
81 </para>
82 <para>
83 Please remember that option parsing stops as soon as a non option is
84 encountered, you can explicitly stop option parsing by using the
85 special option "--".
86 </para>
87 </refsect1>
88
89 <refsect1>
90 <title>COMMANDS</title>
91
92 <para>
93 <command/gpg/ may be run with no commands, in which case it will
94 perform a reasonable action depending on the type of file it is given
95 as input (an encrypted message is decrypted, a signature is verified,
96 a file containing keys is listed).
97 </para>
98
99 <para>
100 <command/gpg/ recognizes these commands:
101 </para>
102
103 <variablelist>
104
105 <varlistentry>
106 <term>-s, --sign</term>
107 <listitem><para>
108 Make a signature. This command may be combined with --encrypt (for a
109 signed and encrypted message), --symmetric (for a signed and
110 symmetrically encrypted message), or --encrypt and --symmetric
111 together (for a signed message that may be decrypted via a secret key
112 or a passphrase).
113 </para></listitem></varlistentry>
114
115
116 <varlistentry>
117 <term>--clearsign</term>
118 <listitem><para>
119 Make a clear text signature.
120 </para></listitem></varlistentry>
121
122
123 <varlistentry>
124 <term>-b, --detach-sign</term>
125 <listitem><para>
126 Make a detached signature.
127 </para></listitem></varlistentry>
128
129
130 <varlistentry>
131 <term>-e, --encrypt</term>
132 <listitem><para>
133 Encrypt data. This option may be combined with --sign (for a signed
134 and encrypted message), --symmetric (for a message that may be
135 decrypted via a secret key or a passphrase), or --sign and --symmetric
136 together (for a signed message that may be decrypted via a secret key
137 or a passphrase).
138 </para></listitem></varlistentry>
139
140
141 <varlistentry>
142 <term>-c, --symmetric</term>
143 <listitem><para>
144 Encrypt with a symmetric cipher using a passphrase.  The default
145 symmetric cipher used is CAST5, but may be chosen with the
146 --cipher-algo option.  This option may be combined with --sign (for a
147 signed and symmetrically encrypted message), --encrypt (for a message
148 that may be decrypted via a secret key or a passphrase), or --sign and
149 --encrypt together (for a signed message that may be decrypted via a
150 secret key or a passphrase).
151 </para></listitem></varlistentry>
152
153
154 <varlistentry>
155 <term>--store</term>
156 <listitem><para>
157 Store only (make a simple RFC1991 packet).
158 </para></listitem></varlistentry>
159
160
161 <varlistentry>
162 <term>--decrypt &OptParmFile;</term>
163 <listitem><para>
164 Decrypt &ParmFile; (or stdin if no file is specified) and
165 write it to stdout (or the file specified with
166 --output). If the decrypted file is signed, the
167 signature is also verified. This command differs
168 from the default operation, as it never writes to the
169 filename which is included in the file and it
170 rejects files which don't begin with an encrypted
171 message.
172 </para></listitem></varlistentry>
173
174
175 <varlistentry>
176 <term>--verify <optional><optional><parameter/sigfile/</optional>
177  <optional><parameter/signed-files/</optional></optional></term>
178 <listitem><para>
179 Assume that <parameter/sigfile/ is a signature and verify it
180 without generating any output.  With no arguments,
181 the signature packet is read from stdin.  If
182 only a sigfile is given, it may be a complete
183 signature or a detached signature, in which case
184 the signed stuff is expected in a file without the
185 ".sig" or ".asc" extension. 
186 With more than
187 1 argument, the first should be a detached signature
188 and the remaining files are the signed stuff.  To read the signed
189 stuff from stdin, use <literal>-</literal> as the second filename.
190 For security reasons a detached signature cannot read the signed
191 material from stdin without denoting it in the above way.
192 </para></listitem></varlistentry>
193
194 <varlistentry>
195 <term>--multifile</term>
196 <listitem><para>
197 This modifies certain other commands to accept multiple files for
198 processing on the command line or read from stdin with each filename
199 on a separate line.  This allows for many files to be processed at
200 once.  --multifile may currently be used along with --verify,
201 --encrypt, and --decrypt.  Note that `--multifile --verify' may not be
202 used with detached signatures.
203 </para></listitem></varlistentry>
204
205 <varlistentry>
206 <term>--verify-files <optional><parameter/files/</optional></term>
207 <listitem><para>
208 Identical to `--multifile --verify'.
209 </para></listitem></varlistentry>
210
211 <varlistentry>
212 <term>--encrypt-files <optional><parameter/files/</optional></term>
213 <listitem><para>
214 Identical to `--multifile --encrypt'.
215 </para></listitem></varlistentry>
216
217 <varlistentry>
218 <term>--decrypt-files <optional><parameter/files/</optional></term>
219 <listitem><para>
220 Identical to `--multifile --decrypt'.
221 </para></listitem></varlistentry>
222
223 <!--
224 B<-k> [I<username>] [I<keyring>]
225     Kludge to be somewhat compatible with PGP.
226     Without arguments, all public keyrings are listed.
227     With one argument, only I<keyring> is listed.
228     Special combinations are also allowed, but they may
229     give strange results when combined with more options.
230     B<-kv>    Same as B<-k>
231     B<-kvv>   List the signatures with every key.
232     B<-kvvv>  Additionally check all signatures.
233     B<-kvc>   List fingerprints
234     B<-kvvc>  List fingerprints and signatures
235
236     B<This command may be removed in the future!>
237 -->
238
239 <varlistentry>
240 <term>--list-keys &OptParmNames;</term>
241 <term>--list-public-keys &OptParmNames;</term>
242 <listitem><para>
243 List all keys from the public keyrings, or just the ones given on the
244 command line.
245 </para><para>
246 Avoid using the output of this command in scripts or other programs as
247 it is likely to change as GnuPG changes.  See --with-colons for a
248 machine-parseable key listing command that is appropriate for use in
249 scripts and other programs.
250 </para></listitem></varlistentry>
251
252
253 <varlistentry>
254 <term>--list-secret-keys &OptParmNames;</term>
255 <listitem><para>
256 List all keys from the secret keyrings, or just the ones given on the
257 command line.  A '#' after the letters 'sec' means that the secret key
258 is not usable (for example, if it was created via
259 --export-secret-subkeys).
260 </para></listitem></varlistentry>
261
262
263 <varlistentry>
264 <term>--list-sigs &OptParmNames;</term>
265 <listitem><para>
266 Same as --list-keys, but the signatures are listed too.
267 </para><para>
268 For each signature listed, there are several flags in between the
269 "sig" tag and keyid.  These flags give additional information about
270 each signature.  From left to right, they are the numbers 1-3 for
271 certificate check level (see --default-cert-check-level), "L" for a
272 local or non-exportable signature (see --lsign-key), "R" for a
273 nonRevocable signature (see --nrsign-key), "P" for a signature that
274 contains a policy URL (see --cert-policy-url), "N" for a signature
275 that contains a notation (see --cert-notation), "X" for an eXpired
276 signature (see --ask-cert-expire), and the numbers 1-9 or "T" for 10
277 and above to indicate trust signature levels (see the --edit-key
278 command "tsign").
279 </para></listitem></varlistentry>
280
281
282 <varlistentry>
283 <term>--check-sigs &OptParmNames;</term>
284 <listitem><para>
285 Same as --list-sigs, but the signatures are verified.
286 </para></listitem></varlistentry>
287
288 <varlistentry>
289 <term>--fingerprint &OptParmNames;</term>
290 <listitem><para>
291 List all keys with their fingerprints. This is the
292 same output as --list-keys but with the additional output
293 of a line with the fingerprint. May also be combined
294 with --list-sigs or --check-sigs.
295 If this command is given twice, the fingerprints of all
296 secondary keys are listed too.
297 </para></listitem></varlistentry>
298
299
300 <varlistentry>
301 <term>--list-packets</term>
302 <listitem><para>
303 List only the sequence of packets. This is mainly
304 useful for debugging.
305 </para></listitem></varlistentry>
306
307
308 <varlistentry>
309 <term>--gen-key</term>
310 <listitem><para>
311 Generate a new key pair. This command is normally only used
312 interactively.
313 </para>
314 <para>
315 There is an experimental feature which allows you to create keys
316 in batch mode. See the file <filename>doc/DETAILS</filename>
317 in the source distribution on how to use this.
318 </para></listitem></varlistentry>
319
320
321 <varlistentry>
322 <term>--edit-key &ParmName;</term>
323 <listitem><para>
324 Present a menu which enables you to do all key
325 related tasks:</para>
326     <variablelist>
327
328     <varlistentry>
329     <term>sign</term>
330     <listitem><para>
331 Make a signature on key of user &ParmName;
332 If the key is not yet signed by the default
333 user (or the users given with -u), the
334 program displays the information of the key
335 again, together with its fingerprint and
336 asks whether it should be signed. This
337 question is repeated for all users specified
338 with -u.</para></listitem></varlistentry>
339     <varlistentry>
340     <term>lsign</term>
341     <listitem><para>
342 Same as --sign but the signature is marked as
343 non-exportable and will therefore never be used
344 by others.  This may be used to make keys valid
345 only in the local environment.</para></listitem></varlistentry>
346     <varlistentry>
347     <term>nrsign</term>
348     <listitem><para>
349 Same as --sign but the signature is marked as non-revocable and can
350 therefore never be revoked.</para></listitem></varlistentry>
351     <varlistentry>
352     <term>nrlsign</term>
353     <listitem><para>
354 Combines the functionality of nrsign and lsign to make a signature
355 that is both non-revocable and
356 non-exportable.</para></listitem></varlistentry>
357     <varlistentry>
358     <term>tsign</term>
359     <listitem><para>
360 Make a trust signature.  This is a signature that combines the notions
361 of certification (like a regular signature), and trust (like the
362 "trust" command).  It is generally only useful in distinct communities
363 or groups.
364 </para></listitem></varlistentry>
365     <varlistentry>
366     <term>revsig</term>
367     <listitem><para>
368 Revoke a signature.  For every signature which has been generated by
369 one of the secret keys, GnuPG asks whether a revocation certificate
370 should be generated.
371 </para></listitem></varlistentry>
372     <varlistentry>
373     <term>trust</term>
374     <listitem><para>
375 Change the owner trust value. This updates the
376 trust-db immediately and no save is required.</para></listitem></varlistentry>
377     <varlistentry>
378     <term>disable</term>
379     <term>enable</term>
380     <listitem><para>
381 Disable or enable an entire key. A disabled key can not normally be
382 used for encryption.</para></listitem></varlistentry>
383     <varlistentry>
384     <term>adduid</term>
385     <listitem><para>
386 Create an alternate user id.</para></listitem></varlistentry>
387     <varlistentry>
388     <term>addphoto</term>
389     <listitem><para>
390 Create a photographic user id.  This will prompt for a JPEG file that
391 will be embedded into the user ID.  A very large JPEG will make for a
392 very large key.
393 </para></listitem></varlistentry>
394     <varlistentry>
395     <term>deluid</term>
396     <listitem><para>
397 Delete a user id.</para></listitem></varlistentry>
398     <varlistentry>
399     <term>revuid</term>
400     <listitem><para>
401 Revoke a user id.</para></listitem></varlistentry>
402     <varlistentry>
403     <term>addkey</term>
404     <listitem><para>
405 Add a subkey to this key.</para></listitem></varlistentry>
406     <varlistentry>
407     <term>delkey</term>
408     <listitem><para>
409 Remove a subkey.</para></listitem></varlistentry>
410     <varlistentry>
411     <term>addrevoker <optional>sensitive</optional></term>
412     <listitem><para>
413 Add a designated revoker.  This takes one optional argument:
414 "sensitive".  If a designated revoker is marked as sensitive, it will
415 not be exported by default (see
416 export-options).</para></listitem></varlistentry>
417     <varlistentry>
418     <term>revkey</term>
419     <listitem><para>
420 Revoke a subkey.</para></listitem></varlistentry>
421     <varlistentry>
422     <term>expire</term>
423     <listitem><para>
424 Change the key expiration time.  If a subkey is selected, the
425 expiration time of this subkey will be changed.  With no selection,
426 the key expiration of the primary key is changed.
427 </para></listitem></varlistentry>
428     <varlistentry>
429     <term>passwd</term>
430     <listitem><para>
431 Change the passphrase of the secret key.</para></listitem></varlistentry>
432     <varlistentry>
433     <term>primary</term>
434     <listitem><para>
435 Flag the current user id as the primary one, removes the primary user
436 id flag from all other user ids and sets the timestamp of all affected
437 self-signatures one second ahead.  Note that setting a photo user ID
438 as primary makes it primary over other photo user IDs, and setting a
439 regular user ID as primary makes it primary over other regular user
440 IDs.
441 </para></listitem></varlistentry>
442     <varlistentry>
443     <term>uid &ParmN;</term>
444     <listitem><para>
445 Toggle selection of user id with index &ParmN;.
446 Use 0 to deselect all.</para></listitem></varlistentry>
447     <varlistentry>
448     <term>key &ParmN;</term>
449     <listitem><para>
450 Toggle selection of subkey with index &ParmN;.
451 Use 0 to deselect all.</para></listitem></varlistentry>
452     <varlistentry>
453     <term>check</term>
454     <listitem><para>
455 Check all selected user ids.</para></listitem></varlistentry>
456     <varlistentry>
457     <term>showphoto</term>
458     <listitem><para>
459 Display the selected photographic user
460 id.</para></listitem></varlistentry>
461     <varlistentry>
462     <term>pref</term>
463     <listitem><para>
464 List preferences from the selected user ID.  This shows the actual
465 preferences, without including any implied preferences.
466 </para></listitem></varlistentry>
467     <varlistentry>
468     <term>showpref</term>
469     <listitem><para>
470 More verbose preferences listing for the selected user ID.  This shows
471 the preferences in effect by including the implied preferences of
472 3DES (cipher), SHA-1 (digest), and Uncompressed (compression) if they
473 are not already included in the preference list.
474 </para></listitem></varlistentry>
475     <varlistentry>
476     <term>setpref &ParmString;</term>
477     <listitem><para>
478 Set the list of user ID preferences to &ParmString;, this should be a
479 string similar to the one printed by "pref".  Using an empty string
480 will set the default preference string, using "none" will set the
481 preferences to nil.  Use "gpg --version" to get a list of available
482 algorithms.  This command just initializes an internal list and does
483 not change anything unless another command (such as "updpref") which
484 changes the self-signatures is used.
485 </para></listitem></varlistentry>
486     <varlistentry>
487     <term>updpref</term>
488     <listitem><para>
489 Change the preferences of all user IDs (or just of the selected ones
490 to the current list of preferences.  The timestamp of all affected
491 self-signatures will be advanced by one second.  Note that while you
492 can change the preferences on an attribute user ID (aka "photo ID"),
493 GnuPG does not select keys via attribute user IDs so these preferences
494 will not be used by GnuPG.
495 </para></listitem></varlistentry>
496     <varlistentry>
497     <term>toggle</term>
498     <listitem><para>
499 Toggle between public and secret key listing.</para></listitem></varlistentry>
500     <varlistentry>
501     <term>save</term>
502     <listitem><para>
503 Save all changes to the key rings and quit.</para></listitem></varlistentry>
504     <varlistentry>
505     <term>quit</term>
506     <listitem><para>
507 Quit the program without updating the
508 key rings.</para></listitem></varlistentry>
509     </variablelist>
510     <para>
511 The listing shows you the key with its secondary
512 keys and all user ids. Selected keys or user ids
513 are indicated by an asterisk. The trust value is
514 displayed with the primary key: the first is the
515 assigned owner trust and the second is the calculated
516 trust value.  Letters are used for the values:</para>
517     <variablelist>
518       <varlistentry><term>-</term><listitem><para>No ownertrust assigned / not yet calculated.</para></listitem></varlistentry>
519       <varlistentry><term>e</term><listitem><para>Trust
520 calculation has failed; probably due to an expired key.</para></listitem></varlistentry>
521       <varlistentry><term>q</term><listitem><para>Not enough information for calculation.</para></listitem></varlistentry>
522       <varlistentry><term>n</term><listitem><para>Never trust this key.</para></listitem></varlistentry>
523       <varlistentry><term>m</term><listitem><para>Marginally trusted.</para></listitem></varlistentry>
524       <varlistentry><term>f</term><listitem><para>Fully trusted.</para></listitem></varlistentry>
525       <varlistentry><term>u</term><listitem><para>Ultimately trusted.</para></listitem></varlistentry>
526     </variablelist>
527 </listitem></varlistentry>
528
529 <varlistentry>
530 <term>--sign-key &ParmName;</term>
531 <listitem><para>
532 Signs a public key with your secret key. This is a shortcut version of
533 the subcommand "sign" from --edit.
534 </para></listitem></varlistentry>
535
536 <varlistentry>
537 <term>--lsign-key &ParmName;</term>
538 <listitem><para>
539 Signs a public key with your secret key but marks it as
540 non-exportable.  This is a shortcut version of the subcommand "lsign"
541 from --edit.
542 </para></listitem></varlistentry>
543
544 <varlistentry>
545 <term>--nrsign-key &ParmName;</term>
546 <listitem><para>
547 Signs a public key with your secret key but marks it as non-revocable.
548 This is a shortcut version of the subcommand "nrsign" from --edit.
549 </para></listitem></varlistentry>
550
551 <varlistentry>
552 <term>--delete-key &ParmName;</term>
553 <listitem><para>
554 Remove key from the public keyring.  In batch mode either --yes is
555 required or the key must be specified by fingerprint.  This is a
556 safeguard against accidental deletion of multiple keys.
557 </para></listitem></varlistentry>
558
559 <varlistentry>
560 <term>--delete-secret-key &ParmName;</term>
561 <listitem><para>
562 Remove key from the secret and public keyring. In batch mode the key
563 must be specified by fingerprint.
564 </para></listitem></varlistentry>
565
566 <varlistentry>
567 <term>--delete-secret-and-public-key &ParmName;</term>
568 <listitem><para>
569 Same as --delete-key, but if a secret key exists, it will be removed 
570 first. In batch mode the key must be specified by fingerprint.
571 </para></listitem></varlistentry>
572
573 <varlistentry>
574 <term>--gen-revoke &ParmName;</term>
575 <listitem><para>
576 Generate a revocation certificate for the complete key. To revoke
577 a subkey or a signature, use the --edit command.
578 </para></listitem></varlistentry>
579
580 <varlistentry>
581 <term>--desig-revoke &ParmName;</term>
582 <listitem><para>
583 Generate a designated revocation certificate for a key.  This allows a
584 user (with the permission of the keyholder) to revoke someone else's
585 key.
586 </para></listitem></varlistentry>
587
588 <varlistentry>
589 <term>--export &OptParmNames;</term>
590 <listitem><para>
591 Either export all keys from all keyrings (default
592 keyrings and those registered via option --keyring),
593 or if at least one name is given, those of the given
594 name. The new keyring is written to stdout or to
595 the file given with option "output".  Use together
596 with --armor to mail those keys.
597 </para></listitem></varlistentry>
598
599
600 <varlistentry>
601 <term>--send-keys &OptParmNames;</term>
602 <listitem><para>
603 Same as --export but sends the keys to a keyserver.
604 Option --keyserver must be used to give the name
605 of this keyserver. Don't send your complete keyring
606 to a keyserver - select only those keys which are new
607 or changed by you.
608 </para></listitem></varlistentry>
609
610
611 <varlistentry>
612 <term>--export-secret-keys &OptParmNames;</term>
613 <term>--export-secret-subkeys &OptParmNames;</term>
614 <listitem><para>
615 Same as --export, but exports the secret keys instead.
616 This is normally not very useful and a security risk.
617 The second form of the command has the special property to
618 render the secret part of the primary key useless; this is
619 a GNU extension to OpenPGP and other implementations can
620 not be expected to successfully import such a key.
621
622 See the option --simple-sk-checksum if you want to import such an
623 exported key with an older OpenPGP implementation.
624 </para></listitem></varlistentry>
625
626
627 <varlistentry>
628 <term>--import &OptParmFiles;</term>
629 <term>--fast-import &OptParmFiles;</term>
630 <listitem><para>
631 Import/merge keys. This adds the given keys to the
632 keyring.  The fast version is currently just a synonym.
633 </para>
634 <para>
635 There are a few other options which control how this command works.
636 Most notable here is the --keyserver-option merge-only option which
637 does not insert new keys but does only the merging of new signatures,
638 user-IDs and subkeys.
639 </para></listitem></varlistentry>
640
641
642 <varlistentry>
643 <term>--recv-keys &ParmKeyIDs;</term>
644 <listitem><para>
645 Import the keys with the given key IDs from a keyserver. Option
646 --keyserver must be used to give the name of this keyserver.
647 </para></listitem></varlistentry>
648
649 <varlistentry>
650 <term>--refresh-keys &ParmKeyIDs;</term>
651 <listitem><para>
652 Request updates from a keyserver for keys that already exist on the
653 local keyring.  This is useful for updating a key with the latest
654 signatures, user IDs, etc.  Option --keyserver must be used to give
655 the name of this keyserver.
656 </para></listitem></varlistentry>
657
658 <varlistentry>
659 <term>--search-keys &OptParmNames;</term>
660 <listitem><para>
661 Search the keyserver for the given names.  Multiple names given here
662 will be joined together to create the search string for the keyserver.
663 Option --keyserver must be used to give the name of this keyserver.
664 </para></listitem></varlistentry>
665
666 <varlistentry>
667 <term>--update-trustdb</term>
668 <listitem><para>
669 Do trust database maintenance.  This command iterates over all keys
670 and builds the Web-of-Trust. This is an interactive command because it
671 may have to ask for the "ownertrust" values for keys.  The user has to
672 give an estimation of how far she trusts the owner of the displayed
673 key to correctly certify (sign) other keys.  GnuPG only asks for the
674 ownertrust value if it has not yet been assigned to a key.  Using the
675 --edit-key menu, the assigned value can be changed at any time.
676 </para></listitem></varlistentry>
677
678 <varlistentry>
679 <term>--check-trustdb</term>
680 <listitem><para>
681 Do trust database maintenance without user interaction.  From time to
682 time the trust database must be updated so that expired keys or
683 signatures and the resulting changes in the Web-of-Trust can be
684 tracked.  Normally, GnuPG will calculate when this is required and do
685 it automatically unless --no-auto-check-trustdb is set.  This command
686 can be used to force a trust database check at any time.  The
687 processing is identical to that of --update-trustdb but it skips keys
688 with a not yet defined "ownertrust".
689 </para>
690 <para>
691 For use with cron jobs, this command can be used together with --batch
692 in which case the trust database check is done only if a check is
693 needed.  To force a run even in batch mode add the option --yes.
694 </para></listitem></varlistentry>
695
696
697 <varlistentry>
698 <term>--export-ownertrust</term>
699 <listitem><para>
700 Send the ownertrust values to stdout.  This is useful for backup
701 purposes as these values are the only ones which can't be re-created
702 from a corrupted trust DB.
703 </para></listitem></varlistentry>
704
705 <varlistentry>
706 <term>--import-ownertrust &OptParmFiles;</term>
707 <listitem><para>
708 Update the trustdb with the ownertrust values stored
709 in &ParmFiles; (or stdin if not given); existing
710 values will be overwritten.
711 </para></listitem></varlistentry>
712
713 <varlistentry>
714 <term>--rebuild-keydb-caches</term>
715 <listitem><para>
716 When updating from version 1.0.6 to 1.0.7 this command should be used
717 to create signature caches in the keyring.  It might be handy in other
718 situations too.
719 </para></listitem></varlistentry>
720
721 <varlistentry>
722 <term>--print-md <parameter>algo</parameter> &OptParmFiles;</term>
723 <term>--print-mds &OptParmFiles;</term>
724 <listitem><para>
725 Print message digest of algorithm ALGO for all given files or stdin.
726 With the second form (or a deprecated "*" as algo) digests for all
727 available algorithms are printed.
728 </para></listitem></varlistentry>
729
730
731 <varlistentry>
732 <term>--gen-random <parameter>0|1|2</parameter>
733                    <optional><parameter>count</parameter></optional></term>
734 <listitem><para>
735 Emit COUNT random bytes of the given quality level. If count is not given
736 or zero, an endless sequence of random bytes will be emitted.
737 PLEASE, don't use this command unless you know what you are doing; it may
738 remove precious entropy from the system!
739 </para></listitem></varlistentry>
740
741 <varlistentry>
742 <term>--gen-prime <parameter>mode</parameter>
743                   <parameter>bits</parameter>
744                    <optional><parameter>qbits</parameter></optional></term>
745 <listitem><para>
746 Use the source, Luke :-). The output format is still subject to change.
747 </para></listitem></varlistentry>
748
749
750 <varlistentry>
751 <term>--version</term>
752 <listitem><para>
753 Print version information along with a list
754 of supported algorithms.
755 </para></listitem></varlistentry>
756
757
758 <varlistentry>
759 <term>--warranty</term>
760 <listitem><para>
761 Print warranty information.
762 </para></listitem></varlistentry>
763
764
765 <varlistentry>
766 <term>-h, --help</term>
767 <listitem><para>
768 Print usage information.  This is a really long list even though it
769 doesn't list all options.  For every option, consult this manual.
770 </para></listitem></varlistentry>
771
772 </variablelist>
773 </refsect1>
774
775 <refsect1>
776 <title>OPTIONS</title>
777 <para>
778 Long options can be put in an options file (default
779 "~/.gnupg/gpg.conf").  Short option names will not work - for example,
780 "armor" is a valid option for the options file, while "a" is not.  Do
781 not write the 2 dashes, but simply the name of the option and any
782 required arguments.  Lines with a hash ('#') as the first
783 non-white-space character are ignored.  Commands may be put in this
784 file too, but that is not generally useful as the command will execute
785 automatically with every execution of gpg.
786 </para>
787 <para>
788 <command/gpg/ recognizes these options:
789 </para>
790
791 <variablelist>
792
793
794 <varlistentry>
795 <term>-a, --armor</term>
796 <listitem><para>
797 Create ASCII armored output.
798 </para></listitem></varlistentry>
799
800
801 <varlistentry>
802 <term>-o, --output &ParmFile;</term>
803 <listitem><para>
804 Write output to &ParmFile;.
805 </para></listitem></varlistentry>
806
807
808 <varlistentry>
809 <term>--mangle-dos-filenames</term>
810 <term>--no-mangle-dos-filenames</term>
811 <listitem><para>
812 Older version of Windows cannot handle filenames with more than one
813 dot.  --mangle-dos-filenames causes GnuPG to replace (rather than add
814 to) the extension of an output filename to avoid this problem.  This
815 option is off by default and has no effect on non-Windows platforms.
816 </para></listitem></varlistentry>
817
818
819 <varlistentry>
820 <term>-u, --local-user &ParmName;</term>
821 <listitem><para>
822 Use &ParmName; as the key to sign with.  Note that this option
823 overrides --default-key.
824 </para></listitem></varlistentry>
825
826 <varlistentry>
827 <term>--default-key &ParmName;</term>
828 <listitem><para>
829 Use &ParmName; as the default key to sign with.  If this option is not
830 used, the default key is the first key found in the secret keyring.
831 Note that -u or --local-user overrides this option.
832 </para></listitem></varlistentry>
833
834 <varlistentry>
835 <term>-r, --recipient &ParmName;</term>
836 <term></term>
837 <listitem><para>
838 Encrypt for user id &ParmName;. If this option or --hidden-recipient
839 is not specified, GnuPG asks for the user-id unless
840 --default-recipient is given.
841 </para></listitem></varlistentry>
842
843 <varlistentry>
844 <term>-R, --hidden-recipient &ParmName;</term>
845 <term></term>
846 <listitem><para>
847 Encrypt for user id &ParmName;, but hide the keyid of the key.  This
848 option hides the receiver of the message and is a countermeasure
849 against traffic analysis.  If this option or --recipient is not
850 specified, GnuPG asks for the user-id unless --default-recipient is
851 given.
852 </para></listitem></varlistentry>
853
854 <varlistentry>
855 <term>--default-recipient &ParmName;</term>
856 <listitem><para>
857 Use &ParmName; as default recipient if option --recipient is not used and
858 don't ask if this is a valid one. &ParmName; must be non-empty.
859 </para></listitem></varlistentry>
860
861 <varlistentry>
862 <term>--default-recipient-self</term>
863 <listitem><para>
864 Use the default key as default recipient if option --recipient is not used and
865 don't ask if this is a valid one. The default key is the first one from the
866 secret keyring or the one set with --default-key.
867 </para></listitem></varlistentry>
868
869
870 <varlistentry>
871 <term>--no-default-recipient</term>
872 <listitem><para>
873 Reset --default-recipient and --default-recipient-self.
874 </para></listitem></varlistentry>
875
876 <varlistentry>
877 <term>--encrypt-to &ParmName;</term>
878 <listitem><para>
879 Same as --recipient but this one is intended for use
880 in the options file and may be used with
881 your own user-id as an "encrypt-to-self".  These keys
882 are only used when there are other recipients given
883 either by use of --recipient or by the asked user id.
884 No trust checking is performed for these user ids and
885 even disabled keys can be used.
886 </para></listitem></varlistentry>
887
888 <varlistentry>
889 <term>--hidden-encrypt-to &ParmName;</term>
890 <listitem><para>
891 Same as --hidden-recipient but this one is intended for use in the
892 options file and may be used with your own user-id as a hidden
893 "encrypt-to-self".  These keys are only used when there are other
894 recipients given either by use of --recipient or by the asked user id.
895 No trust checking is performed for these user ids and even disabled
896 keys can be used.
897 </para></listitem></varlistentry>
898
899 <varlistentry>
900 <term>--no-encrypt-to</term>
901 <listitem><para>
902 Disable the use of all --encrypt-to and --hidden-encrypt-to keys.
903 </para></listitem></varlistentry>
904
905
906 <varlistentry>
907 <term>-v, --verbose</term>
908 <listitem><para>
909 Give more information during processing. If used
910 twice, the input data is listed in detail.
911 </para></listitem></varlistentry>
912
913
914 <varlistentry>
915 <term>-q, --quiet</term>
916 <listitem><para>
917 Try to be as quiet as possible.
918 </para></listitem></varlistentry>
919
920
921 <varlistentry>
922 <term>-z &ParmN;</term>
923 <term>--compress-level &ParmN;</term>
924 <term>--bzip2-compress-level &ParmN;</term>
925 <listitem><para>
926 Set compression level to &ParmN; for the ZIP and ZLIB compression
927 algorithms.  The default is to use the default compression level of
928 zlib (normally 6).  --bzip2-compress-level sets the compression level
929 for the BZIP2 compression algorithm (defaulting to 6 as well).  This
930 is a different option from --compress-level since BZIP2 uses a
931 significant amount of memory for each additional compression level.
932 -z sets both.  A value of 0 for &ParmN; disables compression.
933 </para></listitem></varlistentry>
934
935 <varlistentry>
936 <term>--bzip2-compress-lowmem</term>
937 <listitem><para>
938 Use a different decompression method for BZIP2 compressed files.  This
939 alternate method uses a bit more than half the memory, but also runs
940 at half the speed.  This is useful under extreme low memory
941 circumstances when the file was originally compressed at a high
942 --bzip2-compress-level.
943 </para></listitem></varlistentry>
944
945
946 <varlistentry>
947 <term>-t, --textmode</term>
948 <term>--no-textmode</term>
949 <listitem><para>
950 Treat input files as text and store them in the OpenPGP canonical text
951 form with standard "CRLF" line endings.  This also sets the necessary
952 flags to inform the recipient that the encrypted or signed data is
953 text and may need its line endings converted back to whatever the
954 local system uses.  This option is useful when communicating between
955 two platforms that have different line ending conventions (UNIX-like
956 to Mac, Mac to Windows, etc).  --no-textmode disables this option, and
957 is the default.
958 </para><para>
959 If -t (but not --textmode) is used together with armoring and signing,
960 this enables clearsigned messages.  This kludge is needed for
961 command-line compatibility with command-line versions of PGP; normally
962 you would use --sign or --clearsign to select the type of the
963 signature.
964 </para></listitem></varlistentry>
965
966
967 <varlistentry>
968 <term>-n, --dry-run</term>
969 <listitem><para>
970 Don't make any changes (this is not completely implemented).
971 </para></listitem></varlistentry>
972
973
974 <varlistentry>
975 <term>-i, --interactive</term>
976 <listitem><para>
977 Prompt before overwriting any files.
978 </para></listitem></varlistentry>
979
980
981 <varlistentry>
982 <term>--batch</term>
983 <term>--no-batch</term>
984 <listitem><para>
985 Use batch mode.  Never ask, do not allow interactive commands.
986 --no-batch disables this option.
987 </para></listitem></varlistentry>
988
989
990 <varlistentry>
991 <term>--no-tty</term>
992 <listitem><para>
993 Make sure that the TTY (terminal) is never used for any output.
994 This option is needed in some cases because GnuPG sometimes prints
995 warnings to the TTY if --batch is used.
996 </para></listitem></varlistentry>
997
998
999 <varlistentry>
1000 <term>--yes</term>
1001 <listitem><para>
1002 Assume "yes" on most questions.
1003 </para></listitem></varlistentry>
1004
1005
1006 <varlistentry>
1007 <term>--no</term>
1008 <listitem><para>
1009  Assume "no" on most questions.
1010 </para></listitem></varlistentry>
1011
1012 <varlistentry>
1013 <term>--default-cert-check-level &ParmN;</term>
1014 <listitem><para>
1015 The default to use for the check level when signing a key.
1016 </para><para>
1017 0 means you make no particular claim as to how carefully you verified
1018 the key.
1019 </para><para>
1020 1 means you believe the key is owned by the person who claims to own
1021 it but you could not, or did not verify the key at all.  This is
1022 useful for a "persona" verification, where you sign the key of a
1023 pseudonymous user.
1024 </para><para>
1025 2 means you did casual verification of the key.  For example, this
1026 could mean that you verified that the key fingerprint and checked the
1027 user ID on the key against a photo ID.
1028 </para><para>
1029 3 means you did extensive verification of the key.  For example, this
1030 could mean that you verified the key fingerprint with the owner of the
1031 key in person, and that you checked, by means of a hard to forge
1032 document with a photo ID (such as a passport) that the name of the key
1033 owner matches the name in the user ID on the key, and finally that you
1034 verified (by exchange of email) that the email address on the key
1035 belongs to the key owner.
1036 </para><para>
1037 Note that the examples given above for levels 2 and 3 are just that:
1038 examples.  In the end, it is up to you to decide just what "casual"
1039 and "extensive" mean to you.
1040 </para><para>
1041 This option defaults to 0.
1042 </para></listitem></varlistentry>
1043
1044
1045
1046 <varlistentry>
1047 <term>--trusted-key <parameter>long key ID</parameter></term>
1048 <listitem><para>
1049 Assume that the specified key (which must be given
1050 as a  full 8 byte key ID) is as trustworthy as one of
1051 your own secret keys. This option is useful if you
1052 don't want to keep your secret keys (or one of them)
1053 online but still want to be able to check the validity of a given
1054 recipient's or signator's key. 
1055 </para></listitem></varlistentry>
1056
1057 <varlistentry>
1058 <term>--trust-model <parameter>pgp|classic|always</parameter></term>
1059 <listitem><para>
1060
1061 Set what trust model GnuPG should follow.  The models are:
1062
1063 <variablelist>
1064
1065 <varlistentry><term>pgp</term><listitem><para>
1066 This is the web-of-trust combined with trust signatures as used in PGP
1067 5.x and later.  This is the default trust model.
1068 </para></listitem></varlistentry>
1069
1070 <varlistentry><term>classic</term><listitem><para>
1071 This is the standard web-of-trust as used in PGP 2.x and earlier.
1072 </para></listitem></varlistentry>
1073
1074 <varlistentry><term>always</term><listitem><para>
1075 Skip key validation and assume that used keys are always fully
1076 trusted.  You won't use this unless you have installed some external
1077 validation scheme.  This option also suppresses the "[uncertain]" tag
1078 printed with signature checks when there is no evidence that the user
1079 ID is bound to the key.
1080 </para></listitem></varlistentry>
1081
1082 </variablelist></para></listitem></varlistentry>
1083
1084 <varlistentry>
1085 <term>--always-trust</term>
1086 <listitem><para>
1087 Identical to `--trust-model always'.  This option is deprecated.
1088 </para></listitem></varlistentry>
1089
1090
1091 <varlistentry>
1092 <term>--keyserver &ParmName;</term>
1093 <listitem><para>
1094 Use &ParmName; as your keyserver.  This is the server that
1095 --recv-keys, --send-keys, and --search-keys will communicate with to
1096 receive keys from, send keys to, and search for keys on.  The format
1097 of the &ParmName; is a URI: `scheme:[//]keyservername[:port]' The
1098 scheme is the type of keyserver: "hkp" for the HTTP (or compatible)
1099 keyservers, "ldap" for the NAI LDAP keyserver, or "mailto" for the
1100 Graff email keyserver.  Note that your particular installation of
1101 GnuPG may have other keyserver types available as well.  Keyserver
1102 schemes are case-insensitive.
1103 </para><para>
1104 Most keyservers synchronize with each other, so there is generally no
1105 need to send keys to more than one server.  The keyserver
1106 "hkp://subkeys.pgp.net" uses round robin DNS to give a different
1107 keyserver each time you use it.
1108 </para></listitem></varlistentry>
1109
1110 <varlistentry>
1111 <term>--keyserver-options <parameter>parameters</parameter></term>
1112 <listitem><para>
1113 This is a space or comma delimited string that gives options for the
1114 keyserver.  Options can be prepended with a `no-' to give the opposite
1115 meaning.  Valid import-options or export-options may be used here as
1116 well to apply to importing (--recv-key) or exporting (--send-key) a
1117 key from a keyserver.  While not all options are available for all
1118 keyserver types, some common options are:
1119 <variablelist>
1120
1121 <varlistentry>
1122 <term>include-revoked</term>
1123 <listitem><para>
1124 When searching for a key with --search-keys, include keys that are
1125 marked on the keyserver as revoked.  Note that this option is always
1126 set when using the NAI HKP keyserver, as this keyserver does not
1127 differentiate between revoked and unrevoked keys.
1128 </para></listitem></varlistentry>
1129
1130 <varlistentry>
1131 <term>include-disabled</term>
1132 <listitem><para>
1133 When searching for a key with --search-keys, include keys that are
1134 marked on the keyserver as disabled.  Note that this option is not
1135 used with HKP keyservers.
1136 </para></listitem></varlistentry>
1137
1138 <varlistentry>
1139 <term>include-subkeys</term>
1140 <listitem><para>
1141 When receiving a key, include subkeys as potential targets.  Note that
1142 this option is not used with HKP keyservers, as they do not support
1143 retrieving keys by subkey id.
1144 </para></listitem></varlistentry>
1145
1146 <varlistentry>
1147 <term>use-temp-files</term>
1148 <listitem><para>
1149 On most Unix-like platforms, GnuPG communicates with the keyserver
1150 helper program via pipes, which is the most efficient method.  This
1151 option forces GnuPG to use temporary files to communicate.  On some
1152 platforms (such as Win32 and RISC OS), this option is always enabled.
1153 </para></listitem></varlistentry>
1154
1155 <varlistentry>
1156 <term>keep-temp-files</term>
1157 <listitem><para>
1158 If using `use-temp-files', do not delete the temp files after using
1159 them.  This option is useful to learn the keyserver communication
1160 protocol by reading the temporary files.
1161 </para></listitem></varlistentry>
1162
1163 <varlistentry>
1164 <term>verbose</term>
1165 <listitem><para>
1166 Tell the keyserver helper program to be more verbose.  This option can
1167 be repeated multiple times to increase the verbosity level.
1168 </para></listitem></varlistentry>
1169
1170 <varlistentry>
1171 <term>http-proxy&OptEqualsValue;</term>
1172 <listitem><para>
1173 For keyserver schemes that use HTTP (such as HKP), try to access the
1174 keyserver over a proxy.  If a &ParmValue; is specified, use this as
1175 the HTTP proxy.  If no &ParmValue; is specified, try to use the value
1176 of the environment variable "http_proxy".
1177 </para></listitem></varlistentry>
1178
1179 <varlistentry>
1180 <term>auto-key-retrieve</term>
1181 <listitem><para>
1182 This option enables the automatic retrieving of keys from a keyserver
1183 when verifying signatures made by keys that are not on the local
1184 keyring.
1185 </para><para>
1186 Note that this option makes a "web bug" like behavior possible.
1187 Keyserver operators can see which keys you request, so by sending you
1188 a message signed by a brand new key (which you naturally will not have
1189 on your local keyring), the operator can tell both your IP address and
1190 the time when you verified the signature.
1191 </para></listitem></varlistentry>
1192
1193 </variablelist>
1194 </para></listitem></varlistentry>
1195
1196 <varlistentry>
1197 <term>--import-options <parameter>parameters</parameter></term>
1198 <listitem><para>
1199 This is a space or comma delimited string that gives options for
1200 importing keys.  Options can be prepended with a `no-' to give the
1201 opposite meaning.  The options are:
1202 <variablelist>
1203
1204 <varlistentry>
1205 <term>allow-local-sigs</term>
1206 <listitem><para>
1207 Allow importing key signatures marked as "local".  This is not
1208 generally useful unless a shared keyring scheme is being used.
1209 Defaults to no.
1210 </para></listitem></varlistentry>
1211
1212 <varlistentry>
1213 <term>repair-pks-subkey-bug</term>
1214 <listitem><para>
1215 During import, attempt to repair the damage caused by the PKS
1216 keyserver bug (pre version 0.9.6) that mangles keys with multiple
1217 subkeys.  Note that this cannot completely repair the damaged key as
1218 some crucial data is removed by the keyserver, but it does at least
1219 give you back one subkey.  Defaults to no for regular --import and to
1220 yes for keyserver --recv-keys.
1221 </para></listitem></varlistentry>
1222
1223 <varlistentry>
1224 <term>merge-only</term>
1225 <listitem><para>
1226 During import, allow key updates to existing keys, but do not allow
1227 any new keys to be imported.  Defaults to no.
1228 </para></listitem></varlistentry>
1229
1230 </variablelist>
1231 </para></listitem></varlistentry>
1232
1233 <varlistentry>
1234 <term>--export-options <parameter>parameters</parameter></term>
1235 <listitem><para>
1236 This is a space or comma delimited string that gives options for
1237 exporting keys.  Options can be prepended with a `no-' to give the
1238 opposite meaning.  The options are:
1239 <variablelist>
1240
1241 <varlistentry>
1242 <term>include-non-rfc</term>
1243 <listitem><para>
1244 Include non-RFC compliant keys in the export.  Defaults to yes.
1245 </para></listitem></varlistentry>
1246
1247 <varlistentry>
1248 <term>include-local-sigs</term>
1249 <listitem><para>
1250 Allow exporting key signatures marked as "local".  This is not
1251 generally useful unless a shared keyring scheme is being used.
1252 Defaults to no.
1253 </para></listitem></varlistentry>
1254
1255 <varlistentry>
1256 <term>include-attributes</term>
1257 <listitem><para>
1258 Include attribute user IDs (photo IDs) while exporting.  This is
1259 useful to export keys if they are going to be used by an OpenPGP
1260 program that does not accept attribute user IDs.  Defaults to yes.
1261 </para></listitem></varlistentry>
1262
1263 <varlistentry>
1264 <term>include-sensitive-revkeys</term>
1265 <listitem><para>
1266 Include designated revoker information that was marked as
1267 "sensitive".  Defaults to no.
1268 </para></listitem></varlistentry>
1269
1270 </variablelist>
1271 </para></listitem></varlistentry>
1272
1273 <varlistentry>
1274 <term>--list-options <parameter>parameters</parameter></term>
1275 <listitem><para>
1276 This is a space or comma delimited string that gives options used when
1277 listing keys and signatures (that is, --list-keys, --list-sigs,
1278 --list-public-keys, --list-secret-keys, and the --edit-key functions).
1279 Options can be prepended with a `no-' to give the opposite meaning.
1280 The options are:
1281 <variablelist>
1282
1283 <varlistentry>
1284 <term>show-photos</term>
1285 <listitem><para>
1286 Causes --list-keys, --list-sigs, --list-public-keys, and
1287 --list-secret-keys to display any photo IDs attached to the key.
1288 Defaults to no.  See also --photo-viewer.
1289 </para></listitem></varlistentry>
1290
1291 <varlistentry>
1292 <term>show-policy-urls</term>
1293 <listitem><para>
1294 Show policy URLs in the --list-sigs or --check-sigs listings.
1295 Defaults to no.
1296 </para></listitem></varlistentry>
1297
1298 <varlistentry>
1299 <term>show-notations</term>
1300 <listitem><para>
1301 Show signature notations in the --list-sigs or --check-sigs listings.
1302 Defaults to no.
1303 </para></listitem></varlistentry>
1304
1305 <varlistentry>
1306 <term>show-keyserver-urls</term>
1307 <listitem><para>
1308 Show any preferred keyserver URL in the --list-sigs or --check-sigs
1309 listings.  Defaults to no.
1310 </para></listitem></varlistentry>
1311
1312 <varlistentry>
1313 <term>show-validity</term>
1314 <listitem><para>
1315 Display the calculated validity of keys and user IDs during key
1316 listings.  Defaults to no.
1317 </para></listitem></varlistentry>
1318
1319 <varlistentry>
1320 <term>show-long-keyids</term>
1321 <listitem><para>
1322 Display all 64 bits (16 digits) of key IDs during key listings, rather
1323 than the more common 32 bit (8 digit) IDs.  Defaults to no.
1324 </para></listitem></varlistentry>
1325
1326 <varlistentry>
1327 <term>show-unusable-uids</term>
1328 <listitem><para>
1329 Show revoked and expired user IDs in key listings.  Defaults to no.
1330 </para></listitem></varlistentry>
1331
1332 <varlistentry>
1333 <term>show-unusable-subkeys</term>
1334 <listitem><para>
1335 Show revoked and expired subkeys in key listings.  Defaults to no.
1336 </para></listitem></varlistentry>
1337
1338 <varlistentry>
1339 <term>show-keyring</term>
1340 <listitem><para>
1341 Display the keyring name at the head of key listings to show which
1342 keyring a given key resides on.  Defaults to no.
1343 </para></listitem></varlistentry>
1344
1345 <varlistentry>
1346 <term>show-sig-expire</term>
1347 <listitem><para>
1348 Show signature expiration dates (if any) during --list-sigs or
1349 --check-sigs listings.  Defaults to no.
1350 </para></listitem></varlistentry>
1351
1352 </variablelist>
1353 </para></listitem></varlistentry>
1354
1355 <varlistentry>
1356 <term>--verify-options <parameter>parameters</parameter></term>
1357 <listitem><para>
1358 This is a space or comma delimited string that gives options used when
1359 verifying signatures.  Options can be prepended with a `no-' to give
1360 the opposite meaning.  The options are:
1361 <variablelist>
1362
1363 <varlistentry>
1364 <term>show-photos</term>
1365 <listitem><para>
1366 Display any photo IDs present on the key that issued the signature.
1367 Defaults to no.  See also --photo-viewer.
1368 </para></listitem></varlistentry>
1369
1370 <varlistentry>
1371 <term>show-policy-urls</term>
1372 <listitem><para>
1373 Show policy URLs in the signature being verified.  Defaults to no.
1374 </para></listitem></varlistentry>
1375
1376 <varlistentry>
1377 <term>show-notations</term>
1378 <listitem><para>
1379 Show signature notations in the signature being verified.  Defaults to
1380 no.
1381 </para></listitem></varlistentry>
1382
1383 <varlistentry>
1384 <term>show-keyserver-urls</term>
1385 <listitem><para>
1386 Show any preferred keyserver URL in the signature being verified.
1387 Defaults to no.
1388 </para></listitem></varlistentry>
1389
1390 <varlistentry>
1391 <term>show-validity</term>
1392 <listitem><para>
1393 Display the calculated validity of the user IDs on the key that issued
1394 the signature.  Defaults to no.
1395 </para></listitem></varlistentry>
1396
1397 <varlistentry>
1398 <term>show-long-keyids</term>
1399 <listitem><para>
1400 Display all 64 bits (16 digits) of key IDs during signature
1401 verification, rather than the more common 32 bit (8 digit) IDs.
1402 Defaults to no.
1403 </para></listitem></varlistentry>
1404
1405 <varlistentry>
1406 <term>show-unusable-uids</term>
1407 <listitem><para>
1408 Show revoked and expired user IDs during signature verification.
1409 Defaults to no.
1410 </para></listitem></varlistentry>
1411
1412 </variablelist>
1413 </para></listitem></varlistentry>
1414
1415 <varlistentry>
1416 <term>--show-photos</term>
1417 <term>--no-show-photos</term>
1418 <listitem><para>
1419 Causes --list-keys, --list-sigs, --list-public-keys,
1420 --list-secret-keys, and verifying a signature to also display the
1421 photo ID attached to the key, if any.  See also --photo-viewer.  These
1422 options are deprecated.  Use `--list-options [no-]show-photos' and/or
1423 `--verify-options [no-]show-photos' instead.
1424 </para></listitem></varlistentry>
1425
1426 <varlistentry>
1427 <term>--photo-viewer &ParmString;</term>
1428 <listitem><para>
1429 This is the command line that should be run to view a photo ID.  "%i"
1430 will be expanded to a filename containing the photo.  "%I" does the
1431 same, except the file will not be deleted once the viewer exits.
1432 Other flags are "%k" for the key ID, "%K" for the long key ID, "%f"
1433 for the key fingerprint, "%t" for the extension of the image type
1434 (e.g. "jpg"), "%T" for the MIME type of the image (e.g. "image/jpeg"),
1435 and "%%" for an actual percent sign.  If neither %i or %I are present,
1436 then the photo will be supplied to the viewer on standard input.
1437 </para><para>
1438 The default viewer is "xloadimage -fork -quiet -title 'KeyID 0x%k'
1439 stdin".  Note that if your image viewer program is not secure, then
1440 executing it from GnuPG does not make it secure.
1441 </para></listitem></varlistentry>
1442
1443 <varlistentry>
1444 <term>--exec-path &ParmString;</term>
1445 <listitem><para>
1446 Sets a list of directories to search for photo viewers and keyserver
1447 helpers.  If not provided, keyserver helpers use the compiled-in
1448 default directory, and photo viewers use the $PATH environment
1449 variable.
1450 </para></listitem></varlistentry>
1451
1452 <varlistentry>
1453 <term>--show-keyring</term>
1454 <listitem><para>
1455 Display the keyring name at the head of key listings to show which
1456 keyring a given key resides on.  This option is deprecated: use
1457 `--list-options [no-]show-keyring' instead.
1458 </para></listitem></varlistentry>
1459
1460 <varlistentry>
1461 <term>--keyring &ParmFile;</term>
1462 <listitem><para>
1463 Add &ParmFile; to the current list of keyrings.  If &ParmFile; begins
1464 with a tilde and a slash, these are replaced by the $HOME
1465 directory. If the filename does not contain a slash, it is assumed to
1466 be in the GnuPG home directory ("~/.gnupg" if --homedir or $GNUPGHOME
1467 is not used).
1468 </para><para>
1469 Note that this adds a keyring to the current list.  If the intent is
1470 to use the specified keyring alone, use --keyring along with
1471 --no-default-keyring.
1472 </para></listitem></varlistentry>
1473
1474
1475 <varlistentry>
1476 <term>--secret-keyring &ParmFile;</term>
1477 <listitem><para>
1478 Same as --keyring but for the secret keyrings.
1479 </para></listitem></varlistentry>
1480
1481 <varlistentry>
1482 <term>--primary-keyring &ParmFile;</term>
1483 <listitem><para>
1484 Designate &ParmFile; as the primary public keyring.  This means that
1485 newly imported keys (via --import or keyserver --recv-from) will go to
1486 this keyring.
1487 </para></listitem></varlistentry>
1488
1489 <varlistentry>
1490 <term>--trustdb-name &ParmFile;</term>
1491 <listitem><para>
1492 Use &ParmFile; instead of the default trustdb.  If &ParmFile; begins
1493 with a tilde and a slash, these are replaced by the $HOME
1494 directory. If the filename does not contain a slash, it is assumed to
1495 be in the GnuPG home directory ("~/.gnupg" if --homedir or $GNUPGHOME
1496 is not used).
1497 </para></listitem></varlistentry>
1498
1499
1500 <varlistentry>
1501 <term>--homedir &ParmDir;</term>
1502 <listitem><para>
1503 Set the name of the home directory to &ParmDir; If this option is not
1504 used it defaults to "~/.gnupg". It does not make sense to use this in
1505 a options file. This also overrides the environment variable
1506 $GNUPGHOME.
1507 </para></listitem></varlistentry>
1508
1509
1510 <varlistentry>
1511 <term>--charset &ParmName;</term>
1512 <listitem><para>
1513 Set the name of the native character set.  This is used to convert
1514 some strings to proper UTF-8 encoding. If this option is not used, the
1515 default character set is determined from the current locale.  A
1516 verbosity level of 3 shows the used one.  Valid values for &ParmName;
1517 are:</para>
1518 <variablelist>
1519 <varlistentry>
1520 <term>iso-8859-1</term><listitem><para>This is the Latin 1 set.</para></listitem>
1521 </varlistentry>
1522 <varlistentry>
1523 <term>iso-8859-2</term><listitem><para>The Latin 2 set.</para></listitem>
1524 </varlistentry>
1525 <varlistentry>
1526 <term>iso-8859-15</term><listitem><para>This is currently an alias for
1527 the Latin 1 set.</para></listitem>
1528 </varlistentry>
1529 <varlistentry>
1530 <term>koi8-r</term><listitem><para>The usual Russian set (rfc1489).</para></listitem>
1531 </varlistentry>
1532 <varlistentry>
1533 <term>utf-8</term><listitem><para>Bypass all translations and assume
1534 that the OS uses native UTF-8 encoding.</para></listitem>
1535 </varlistentry>
1536 </variablelist>
1537 </listitem></varlistentry>
1538
1539
1540 <varlistentry>
1541 <term>--utf8-strings</term>
1542 <term>--no-utf8-strings</term>
1543 <listitem><para>
1544 Assume that the arguments are already given as UTF8 strings.  The default
1545 (--no-utf8-strings)
1546 is to assume that arguments are encoded in the character set as specified
1547 by --charset. These options affect all following arguments.  Both options may
1548 be used multiple times.
1549 </para></listitem></varlistentry>
1550
1551
1552 <varlistentry>
1553 <term>--options &ParmFile;</term>
1554 <listitem><para>
1555 Read options from &ParmFile; and do not try to read
1556 them from the default options file in the homedir
1557 (see --homedir). This option is ignored if used
1558 in an options file.
1559 </para></listitem></varlistentry>
1560
1561
1562 <varlistentry>
1563 <term>--no-options</term>
1564 <listitem><para>
1565 Shortcut for "--options /dev/null".  This option is
1566 detected before an attempt to open an option file.
1567 Using this option will also prevent the creation of a 
1568 "~./gnupg" homedir.
1569 </para></listitem></varlistentry>
1570
1571
1572 <varlistentry>
1573 <term>--load-extension &ParmName;</term>
1574 <listitem><para>
1575 Load an extension module. If &ParmName; does not contain a slash it is
1576 searched for in the directory configured when GnuPG was built
1577 (generally "/usr/local/lib/gnupg").  Extensions are not generally
1578 useful anymore, and the use of this option is deprecated.
1579 </para></listitem></varlistentry>
1580
1581
1582 <varlistentry>
1583 <term>--debug &ParmFlags;</term>
1584 <listitem><para>
1585 Set debugging flags. All flags are or-ed and &ParmFlags; may
1586 be given in C syntax (e.g. 0x0042).
1587 </para></listitem></varlistentry>
1588
1589
1590 <varlistentry>
1591 <term>--debug-all</term>
1592 <listitem><para>
1593  Set all useful debugging flags.
1594 </para></listitem></varlistentry>
1595
1596
1597 <varlistentry>
1598 <term>--enable-progress-filter</term>
1599 <listitem><para>
1600 Enable certain PROGRESS status outputs.  This option allows frontends
1601 to display a progress indicator while gpg is processing larger files.
1602 There is a slight performance overhead using it.
1603 </para></listitem></varlistentry>
1604
1605
1606 <varlistentry>
1607 <term>--status-fd &ParmN;</term>
1608 <listitem><para>
1609 Write special status strings to the file descriptor &ParmN;.
1610 See the file DETAILS in the documentation for a listing of them.
1611 </para></listitem></varlistentry>
1612
1613
1614 <varlistentry>
1615 <term>--logger-fd &ParmN;</term>
1616 <listitem><para>
1617 Write log output to file descriptor &ParmN; and not to stderr.
1618 </para></listitem></varlistentry>
1619
1620
1621 <varlistentry>
1622 <term>--attribute-fd &ParmN;</term>
1623 <listitem><para>
1624 Write attribute subpackets to the file descriptor &ParmN;.  This is
1625 most useful for use with --status-fd, since the status messages are
1626 needed to separate out the various subpackets from the stream
1627 delivered to the file descriptor.
1628 </para></listitem></varlistentry>
1629
1630
1631 <varlistentry>
1632 <term>--sk-comments</term>
1633 <term>--no-sk-comments</term>
1634 <listitem><para>
1635 Include secret key comment packets when exporting secret keys.  This
1636 is a GnuPG extension to the OpenPGP standard, and is off by default.
1637 Please note that this has nothing to do with the comments in clear
1638 text signatures or armor headers.  --no-sk-comments disables this
1639 option.
1640 </para></listitem></varlistentry>
1641
1642
1643 <varlistentry>
1644 <term>--comment &ParmString;</term>
1645 <term>--no-comments</term>
1646 <listitem><para>
1647 Use &ParmString; as a comment string in clear text signatures and
1648 ASCII armored messages or keys (see --armor).  The default behavior is
1649 not to use a comment string.  --comment may be repeated multiple times
1650 to get multiple comment strings.  --no-comments removes all comments.
1651 </para></listitem></varlistentry>
1652
1653
1654 <varlistentry>
1655 <term>--emit-version</term>
1656 <term>--no-emit-version</term>
1657 <listitem><para>
1658 Force inclusion of the version string in ASCII armored output.
1659 --no-emit-version disables this option.
1660 </para></listitem></varlistentry>
1661
1662
1663 <varlistentry>
1664 <term>--sig-notation &ParmNameValue;</term>
1665 <term>--cert-notation &ParmNameValue;</term>
1666 <term>-N, --set-notation &ParmNameValue;</term>
1667 <listitem><para>
1668 Put the name value pair into the signature as notation data.
1669 &ParmName; must consist only of printable characters or spaces, and
1670 must contain a '@' character.  This is to help prevent pollution of
1671 the IETF reserved notation namespace.  The --expert flag overrides the
1672 '@' check.  &ParmValue; may be any printable string; it will be
1673 encoded in UTF8, so you should check that your --charset is set
1674 correctly.  If you prefix &ParmName; with an exclamation mark (!), the
1675 notation data will be flagged as critical (rfc2440:5.2.3.15).
1676 --sig-notation sets a notation for data signatures.  --cert-notation
1677 sets a notation for key signatures (certifications).  --set-notation
1678 sets both.
1679 </para>
1680
1681 <para>
1682 There are special codes that may be used in notation names.  "%k" will
1683 be expanded into the key ID of the key being signed, "%K" into the
1684 long key ID of the key being signed, "%f" into the fingerprint of the
1685 key being signed, "%s" into the key ID of the key making the
1686 signature, "%S" into the long key ID of the key making the signature,
1687 "%g" into the fingerprint of the key making the signature (which might
1688 be a subkey), "%p" into the fingerprint of the primary key of the key
1689 making the signature, and "%%" results in a single "%".  %k, %K, and
1690 %f are only meaningful when making a key signature (certification).
1691 </para>
1692
1693 </listitem></varlistentry>
1694
1695 <varlistentry>
1696 <term>--show-notation</term>
1697 <term>--no-show-notation</term>
1698 <listitem><para>
1699 Show signature notations in the --list-sigs or --check-sigs listings
1700 as well as when verifying a signature with a notation in it.  These
1701 options are deprecated.  Use `--list-options [no-]show-notation'
1702 and/or `--verify-options [no-]show-notation' instead.
1703 </para></listitem></varlistentry>
1704
1705 <varlistentry>
1706 <term>--sig-policy-url &ParmString;</term>
1707 <term>--cert-policy-url &ParmString;</term>
1708 <term>--set-policy-url &ParmString;</term>
1709 <listitem><para>
1710 Use &ParmString; as a Policy URL for signatures (rfc2440:5.2.3.19).
1711 If you prefix it with an exclamation mark (!), the policy URL packet
1712 will be flagged as critical.  --sig-policy-url sets a policy url for
1713 data signatures.  --cert-policy-url sets a policy url for key
1714 signatures (certifications).  --set-policy-url sets both.
1715 </para><para>
1716 The same %-expandos used for notation data are available here as well.
1717 </para></listitem></varlistentry>
1718
1719 <varlistentry>
1720 <term>--show-policy-url</term>
1721 <term>--no-show-policy-url</term>
1722 <listitem><para>
1723 Show policy URLs in the --list-sigs or --check-sigs listings as well
1724 as when verifying a signature with a policy URL in it.  These options
1725 are deprecated.  Use `--list-options [no-]show-policy-url' and/or
1726 `--verify-options [no-]show-policy-url' instead.
1727 </para></listitem></varlistentry>
1728
1729
1730 <varlistentry>
1731 <term>--sig-keyserver-url &ParmString;</term>
1732 <listitem><para>
1733 Use &ParmString; as a preferred keyserver URL for data signatures.  If
1734 you prefix it with an exclamation mark, the keyserver URL packet will
1735 be flagged as critical.  </para><para>
1736 The same %-expandos used for notation data are available here as well.
1737 </para></listitem></varlistentry>
1738
1739
1740 <varlistentry>
1741 <term>--set-filename &ParmString;</term>
1742 <listitem><para>
1743 Use &ParmString; as the filename which is stored inside messages.
1744 This overrides the default, which is to use the actual filename of the
1745 file being encrypted.
1746 </para></listitem></varlistentry>
1747
1748 <varlistentry>
1749 <term>--for-your-eyes-only</term>
1750 <term>--no-for-your-eyes-only</term>
1751 <listitem><para>
1752 Set the `for your eyes only' flag in the message.  This causes GnuPG
1753 to refuse to save the file unless the --output option is given, and
1754 PGP to use the "secure viewer" with a Tempest-resistant font to
1755 display the message.  This option overrides --set-filename.
1756 --no-for-your-eyes-only disables this option.
1757 </para></listitem></varlistentry>
1758
1759 <varlistentry>
1760 <term>--use-embedded-filename</term>
1761 <listitem><para>
1762 Try to create a file with a name as embedded in the data.
1763 This can be a dangerous option as it allows to overwrite files.
1764 </para></listitem></varlistentry>
1765
1766
1767 <varlistentry>
1768 <term>--completes-needed &ParmN;</term>
1769 <listitem><para>
1770 Number of completely trusted users to introduce a new
1771 key signer (defaults to 1).
1772 </para></listitem></varlistentry>
1773
1774
1775 <varlistentry>
1776 <term>--marginals-needed &ParmN;</term>
1777 <listitem><para>
1778 Number of marginally trusted users to introduce a new
1779 key signer (defaults to 3)
1780 </para></listitem></varlistentry>
1781
1782
1783 <varlistentry>
1784 <term>--max-cert-depth &ParmN;</term>
1785 <listitem><para>
1786 Maximum depth of a certification chain (default is 5).
1787 </para></listitem></varlistentry>
1788
1789
1790 <varlistentry>
1791 <term>--cipher-algo &ParmName;</term>
1792 <listitem><para>
1793 Use  &ParmName; as cipher algorithm. Running the program
1794 with the command --version yields a list of supported
1795 algorithms. If this is not used the cipher algorithm is
1796 selected from the preferences stored with the key.
1797 </para></listitem></varlistentry>
1798
1799
1800 <varlistentry>
1801 <term>--digest-algo &ParmName;</term>
1802 <listitem><para>
1803 Use &ParmName; as the message digest algorithm. Running the program
1804 with the command --version yields a list of supported algorithms.
1805 </para></listitem></varlistentry>
1806
1807
1808 <varlistentry>
1809 <term>--compress-algo &ParmName;</term>
1810 <listitem><para>
1811 Use compression algorithm &ParmName;.  "zlib" is RFC-1950 ZLIB
1812 compression.  "zip" is RFC-1951 ZIP compression which is used by PGP.
1813 "bzip2" is a more modern compression scheme that can compress some
1814 things better than zip or zlib, but at the cost of more memory used
1815 during compression and decompression.  "uncompressed" or "none"
1816 disables compression.  If this option is not used, the default
1817 behavior is to examine the recipient key preferences to see which
1818 algorithms the recipient supports.  If all else fails, ZIP is used for
1819 maximum compatibility.
1820 </para><para>
1821 ZLIB may give better compression results than ZIP, as the compression
1822 window size is not limited to 8k.  BZIP2 may give even better
1823 compression results than that, but will use a significantly larger
1824 amount of memory while compressing and decompressing.  This may be
1825 significant in low memory situations.  Note, however, that PGP (all
1826 versions) only supports ZIP compression.  Using any algorithm other
1827 than ZIP or "none" will make the message unreadable with PGP.
1828 </para></listitem></varlistentry>
1829
1830
1831 <varlistentry>
1832 <term>--cert-digest-algo &ParmName;</term>
1833 <listitem><para>
1834 Use &ParmName; as the message digest algorithm used when signing a
1835 key.  Running the program with the command --version yields a list of
1836 supported algorithms.  Be aware that if you choose an algorithm that
1837 GnuPG supports but other OpenPGP implementations do not, then some
1838 users will not be able to use the key signatures you make, or quite
1839 possibly your entire key.
1840 </para></listitem></varlistentry>
1841
1842
1843 <varlistentry>
1844 <term>--s2k-cipher-algo &ParmName;</term>
1845 <listitem><para>
1846 Use &ParmName; as the cipher algorithm used to protect secret keys.
1847 The default cipher is CAST5.  This cipher is also used for
1848 conventional encryption if --personal-cipher-preferences and
1849 --cipher-algo is not given.
1850 </para></listitem></varlistentry>
1851
1852
1853 <varlistentry>
1854 <term>--s2k-digest-algo &ParmName;</term>
1855 <listitem><para>
1856 Use &ParmName; as the digest algorithm used to mangle the passphrases.
1857 The default algorithm is SHA-1.
1858 </para></listitem></varlistentry>
1859
1860
1861 <varlistentry>
1862 <term>--s2k-mode &ParmN;</term>
1863 <listitem><para>
1864 Selects how passphrases are mangled. If &ParmN; is 0 a plain
1865 passphrase (which is not recommended) will be used, a 1 adds a salt to
1866 the passphrase and a 3 (the default) iterates the whole process a
1867 couple of times.  Unless --rfc1991 is used, this mode is also used for
1868 conventional encryption.
1869 </para></listitem></varlistentry>
1870
1871
1872 <varlistentry>
1873 <term>--simple-sk-checksum</term>
1874 <listitem><para>
1875 Secret keys are integrity protected by using a SHA-1 checksum.  This
1876 method will be part of an enhanced OpenPGP specification but GnuPG
1877 already uses it as a countermeasure against certain attacks.  Old
1878 applications don't understand this new format, so this option may be
1879 used to switch back to the old behaviour.  Using this this option
1880 bears a security risk.  Note that using this option only takes effect
1881 when the secret key is encrypted - the simplest way to make this
1882 happen is to change the passphrase on the key (even changing it to the
1883 same value is acceptable).
1884 </para></listitem></varlistentry>
1885
1886
1887 <varlistentry>
1888 <term>--disable-cipher-algo &ParmName;</term>
1889 <listitem><para>
1890 Never allow the use of &ParmName; as cipher algorithm.
1891 The given name will not be checked so that a later loaded algorithm
1892 will still get disabled.
1893 </para></listitem></varlistentry>
1894
1895 <varlistentry>
1896 <term>--disable-pubkey-algo &ParmName;</term>
1897 <listitem><para>
1898 Never allow the use of &ParmName; as public key algorithm.
1899 The given name will not be checked so that a later loaded algorithm
1900 will still get disabled.
1901 </para></listitem></varlistentry>
1902
1903 <varlistentry>
1904 <term>--no-sig-cache</term>
1905 <listitem><para>
1906 Do not cache the verification status of key signatures.
1907 Caching gives a much better performance in key listings.  However, if
1908 you suspect that your public keyring is not save against write
1909 modifications, you can use this option to disable the caching.  It
1910 probably does not make sense to disable it because all kind of damage
1911 can be done if someone else has write access to your public keyring.
1912 </para></listitem></varlistentry>
1913
1914 <varlistentry>
1915 <term>--no-sig-create-check</term>
1916 <listitem><para>
1917 GnuPG normally verifies each signature right after creation to protect
1918 against bugs and hardware malfunctions which could leak out bits from
1919 the secret key.  This extra verification needs some time (about 115%
1920 for DSA keys), and so this option can be used to disable it.
1921 However, due to the fact that the signature creation needs manual
1922 interaction, this performance penalty does not matter in most settings.
1923 </para></listitem></varlistentry>
1924
1925 <varlistentry>
1926 <term>--auto-check-trustdb</term>
1927 <term>--no-auto-check-trustdb</term>
1928 <listitem><para>
1929 If GnuPG feels that its information about the Web-of-Trust has to be
1930 updated, it automatically runs the --check-trustdb command internally.
1931 This may be a time consuming process.  --no-auto-check-trustdb
1932 disables this option.
1933 </para></listitem></varlistentry>
1934
1935 <varlistentry>
1936 <term>--throw-keyid</term>
1937 <listitem><para>
1938 Do not put the keyids into encrypted packets.  This option hides the
1939 receiver of the message and is a countermeasure against traffic
1940 analysis.  It may slow down the decryption process because all
1941 available secret keys are tried.
1942 </para></listitem></varlistentry>
1943
1944 <varlistentry>
1945 <term>--no-throw-keyid</term>
1946 <listitem><para>
1947 Resets the --throw-keyid option.
1948 </para></listitem></varlistentry>
1949
1950 <varlistentry>
1951 <term>--not-dash-escaped</term>
1952 <listitem><para>
1953 This option changes the behavior of cleartext signatures
1954 so that they can be used for patch files. You should not
1955 send such an armored file via email because all spaces
1956 and line endings are hashed too.  You can not use this
1957 option for data which has 5 dashes at the beginning of a
1958 line, patch files don't have this. A special armor header
1959 line tells GnuPG about this cleartext signature option.
1960 </para></listitem></varlistentry>
1961
1962
1963 <varlistentry>
1964 <term>--escape-from-lines</term>
1965 <term>--no-escape-from-lines</term>
1966 <listitem><para>
1967 Because some mailers change lines starting with "From " to "&#62;From
1968 " it is good to handle such lines in a special way when creating
1969 cleartext signatures to prevent the mail system from breaking the
1970 signature.  Note that all other PGP versions do it this way too.
1971 Enabled by default.  --no-escape-from-lines disables this option.
1972 </para></listitem></varlistentry>
1973
1974
1975 <varlistentry>
1976 <term>--passphrase-fd &ParmN;</term>
1977 <listitem><para>
1978 Read the passphrase from file descriptor &ParmN;. If you use
1979 0 for &ParmN;, the passphrase will be read from stdin.  This
1980 can only be used if only one passphrase is supplied.
1981 <!--fixme: make this print strong-->
1982 Don't use this option if you can avoid it.
1983 </para></listitem></varlistentry>
1984
1985 <varlistentry>
1986 <term>--command-fd &ParmN;</term>
1987 <listitem><para>
1988 This is a replacement for the deprecated shared-memory IPC mode.
1989 If this option is enabled, user input on questions is not expected
1990 from the TTY but from the given file descriptor.  It should be used
1991 together with --status-fd. See the file doc/DETAILS in the source
1992 distribution for details on how to use it.
1993 </para></listitem></varlistentry>
1994
1995 <varlistentry>
1996 <term>--use-agent</term>
1997 <term>--no-use-agent</term>
1998 <listitem><para>
1999 Try to use the GnuPG-Agent. Please note that this agent is still under
2000 development.  With this option, GnuPG first tries to connect to the
2001 agent before it asks for a passphrase.  --no-use-agent disables this
2002 option.
2003 </para></listitem></varlistentry>
2004
2005 <varlistentry>
2006 <term>--gpg-agent-info</term>
2007 <listitem><para>
2008 Override the value of the environment variable
2009 <literal>GPG_AGENT_INFO</literal>.  This is only used when --use-agent has been given
2010 </para></listitem></varlistentry>
2011
2012 <varlistentry>
2013 <term>Compliance options</term>
2014 <listitem><para>
2015 These options control what GnuPG is compliant to.  Only one of these
2016 options may be active at a time.  Note that the default setting of
2017 this is nearly always the correct one.  See the INTEROPERABILITY WITH
2018 OTHER OPENPGP PROGRAMS section below before using one of these
2019 options.
2020 <variablelist>
2021
2022 <varlistentry>
2023 <term>--gnupg</term>
2024 <listitem><para>
2025 Use standard GnuPG behavior.  This is essentially OpenPGP behavior
2026 (see --openpgp), but with some additional workarounds for common
2027 compatibility problems in different versions of PGP.  This is the
2028 default option, so it is not generally needed, but it may be useful to
2029 override a different compliance option in the gpg.conf file.
2030 </para></listitem></varlistentry>
2031
2032 <varlistentry>
2033 <term>--openpgp</term>
2034 <listitem><para>
2035 Reset all packet, cipher and digest options to strict OpenPGP
2036 behavior.  Use this option to reset all previous options like
2037 --rfc1991, --force-v3-sigs, --s2k-*, --cipher-algo, --digest-algo and
2038 --compress-algo to OpenPGP compliant values.  All PGP workarounds are
2039 disabled.
2040 </para></listitem></varlistentry>
2041
2042 <varlistentry>
2043 <term>--rfc2440</term>
2044 <listitem><para>
2045 Reset all packet, cipher and digest options to strict RFC-2440
2046 behavior.  Note that this is currently the same thing as --openpgp.
2047 </para></listitem></varlistentry>
2048
2049 <varlistentry>
2050 <term>--rfc1991</term>
2051 <listitem><para>
2052 Try to be more RFC-1991 (PGP 2.x) compliant.
2053 </para></listitem></varlistentry>
2054
2055 <varlistentry>
2056 <term>--pgp2</term>
2057 <listitem><para>
2058 Set up all options to be as PGP 2.x compliant as possible, and warn if
2059 an action is taken (e.g. encrypting to a non-RSA key) that will create
2060 a message that PGP 2.x will not be able to handle.  Note that `PGP
2061 2.x' here means `MIT PGP 2.6.2'.  There are other versions of PGP 2.x
2062 available, but the MIT release is a good common baseline.
2063 </para><para>
2064 This option implies `--rfc1991 --disable-mdc --no-force-v4-certs
2065 --no-sk-comment --escape-from-lines --force-v3-sigs
2066 --no-ask-sig-expire --no-ask-cert-expire --cipher-algo IDEA
2067 --digest-algo MD5 --compress-algo 1'.  It also disables --textmode
2068 when encrypting.
2069 </para></listitem></varlistentry>
2070
2071 <varlistentry>
2072 <term>--pgp6</term>
2073 <listitem><para>
2074 Set up all options to be as PGP 6 compliant as possible.  This
2075 restricts you to the ciphers IDEA (if the IDEA plugin is installed),
2076 3DES, and CAST5, the hashes MD5, SHA1 and RIPEMD160, and the
2077 compression algorithms none and ZIP.  This also disables
2078 --throw-keyid, and making signatures with signing subkeys as PGP 6
2079 does not understand signatures made by signing subkeys.
2080 </para><para>
2081 This option implies `--disable-mdc --no-sk-comment --escape-from-lines
2082 --force-v3-sigs --no-ask-sig-expire'
2083 </para></listitem></varlistentry>
2084
2085 <varlistentry>
2086 <term>--pgp7</term>
2087 <listitem><para>
2088 Set up all options to be as PGP 7 compliant as possible.  This is
2089 identical to --pgp6 except that MDCs are not disabled, and the list of
2090 allowable ciphers is expanded to add AES128, AES192, AES256, and
2091 TWOFISH.
2092 </para></listitem></varlistentry>
2093
2094 <varlistentry>
2095 <term>--pgp8</term>
2096 <listitem><para>
2097 Set up all options to be as PGP 8 compliant as possible.  PGP 8 is a
2098 lot closer to the OpenPGP standard than previous versions of PGP, so
2099 all this does is disable --throw-keyid and set --escape-from-lines.
2100 The allowed algorithms list is the same as --pgp7 with the addition of
2101 the SHA-256 digest algorithm.
2102 </para></listitem></varlistentry>
2103
2104 </variablelist></para></listitem></varlistentry>
2105
2106 <varlistentry>
2107 <term>--force-v3-sigs</term>
2108 <term>--no-force-v3-sigs</term>
2109 <listitem><para>
2110 OpenPGP states that an implementation should generate v4 signatures
2111 but PGP versions 5 through 7 only recognize v4 signatures on key
2112 material.  This option forces v3 signatures for signatures on data.
2113 Note that this option overrides --ask-sig-expire, as v3 signatures
2114 cannot have expiration dates.  --no-force-v3-sigs disables this
2115 option.
2116 </para></listitem></varlistentry>
2117
2118 <varlistentry>
2119 <term>--force-v4-certs</term>
2120 <term>--no-force-v4-certs</term>
2121 <listitem><para>
2122 Always use v4 key signatures even on v3 keys.  This option also
2123 changes the default hash algorithm for v3 RSA keys from MD5 to SHA-1.
2124 --no-force-v4-certs disables this option.
2125 </para></listitem></varlistentry>
2126
2127 <varlistentry>
2128 <term>--force-mdc</term>
2129 <listitem><para>
2130 Force the use of encryption with a modification detection code.  This
2131 is always used with the newer ciphers (those with a blocksize greater
2132 than 64 bits), or if all of the recipient keys indicate MDC support in
2133 their feature flags.
2134 </para></listitem></varlistentry>
2135
2136 <varlistentry>
2137 <term>--disable-mdc</term>
2138 <listitem><para>
2139 Disable the use of the modification detection code.  Note that by
2140 using this option, the encrypted message becomes vulnerable to a
2141 message modification attack.
2142 </para></listitem></varlistentry>
2143
2144 <varlistentry>
2145 <term>--allow-non-selfsigned-uid</term>
2146 <term>--no-allow-non-selfsigned-uid</term>
2147 <listitem><para>
2148 Allow the import and use of keys with user IDs which are not
2149 self-signed.  This is not recommended, as a non self-signed user ID is
2150 trivial to forge.  --no-allow-non-selfsigned-uid disables.
2151 </para></listitem></varlistentry>
2152
2153 <varlistentry>
2154 <term>--allow-freeform-uid</term>
2155 <listitem><para>
2156 Disable all checks on the form of the user ID while generating a new
2157 one.  This option should only be used in very special environments as
2158 it does not ensure the de-facto standard format of user IDs.
2159 </para></listitem></varlistentry>
2160
2161 <varlistentry>
2162 <term>--ignore-time-conflict</term>
2163 <listitem><para>
2164 GnuPG normally checks that the timestamps associated with keys and
2165 signatures have plausible values.  However, sometimes a signature
2166 seems to be older than the key due to clock problems.  This option
2167 makes these checks just a warning.  See also --ignore-valid-from for
2168 timestamp issues on subkeys.
2169 </para></listitem></varlistentry>
2170
2171 <varlistentry>
2172 <term>--ignore-valid-from</term>
2173 <listitem><para>
2174 GnuPG normally does not select and use subkeys created in the future.
2175 This option allows the use of such keys and thus exhibits the
2176 pre-1.0.7 behaviour.  You should not use this option unless you there
2177 is some clock problem.  See also --ignore-time-conflict for timestamp
2178 issues with signatures.
2179 </para></listitem></varlistentry>
2180
2181 <varlistentry>
2182 <term>--ignore-crc-error</term>
2183 <listitem><para>
2184 The ASCII armor used by OpenPGP is protected by a CRC checksum against
2185 transmission errors.  Sometimes it happens that the CRC gets mangled
2186 somewhere on the transmission channel but the actual content (which is
2187 protected by the OpenPGP protocol anyway) is still okay.  This option
2188 will let gpg ignore CRC errors.
2189 </para></listitem></varlistentry>
2190
2191 <varlistentry>
2192 <term>--ignore-mdc-error</term>
2193 <listitem><para>
2194 This option changes a MDC integrity protection failure into a warning.
2195 This can be useful if a message is partially corrupt, but it is
2196 necessary to get as much data as possible out of the corrupt message.
2197 However, be aware that a MDC protection failure may also mean that the
2198 message was tampered with intentionally by an attacker.
2199 </para></listitem></varlistentry>
2200
2201 <varlistentry>
2202 <term>--lock-once</term>
2203 <listitem><para>
2204 Lock the databases the first time a lock is requested
2205 and do not release the lock until the process
2206 terminates.
2207 </para></listitem></varlistentry>
2208
2209 <varlistentry>
2210 <term>--lock-multiple</term>
2211 <listitem><para>
2212 Release the locks every time a lock is no longer
2213 needed. Use this to override a previous --lock-once
2214 from a config file.
2215 </para></listitem></varlistentry>
2216
2217 <varlistentry>
2218 <term>--lock-never</term>
2219 <listitem><para>
2220 Disable locking entirely.  This option should be used only in very
2221 special environments, where it can be assured that only one process
2222 is accessing those files.  A bootable floppy with a stand-alone
2223 encryption system will probably use this.  Improper usage of this
2224 option may lead to data and key corruption.
2225 </para></listitem></varlistentry>
2226
2227 <varlistentry>
2228 <term>--no-random-seed-file</term>
2229 <listitem><para>
2230 GnuPG uses a file to store its internal random pool over invocations.
2231 This makes random generation faster; however sometimes write operations
2232 are not desired.  This option can be used to achieve that with the cost of
2233 slower random generation.
2234 </para></listitem></varlistentry>
2235
2236 <varlistentry>
2237 <term>--no-verbose</term>
2238 <listitem><para>
2239 Reset verbose level to 0.
2240 </para></listitem></varlistentry>
2241
2242 <varlistentry>
2243 <term>--no-greeting</term>
2244 <listitem><para>
2245 Suppress the initial copyright message.
2246 </para></listitem></varlistentry>
2247
2248 <varlistentry>
2249 <term>--no-secmem-warning</term>
2250 <listitem><para>
2251 Suppress the warning about "using insecure memory".
2252 </para></listitem></varlistentry>
2253
2254 <varlistentry>
2255 <term>--no-permission-warning</term>
2256 <listitem><para>
2257 Suppress the warning about unsafe file and home directory (--homedir)
2258 permissions.  Note that the permission checks that GnuPG performs are
2259 not intended to be authoritative, but rather they simply warn about
2260 certain common permission problems.  Do not assume that the lack of a
2261 warning means that your system is secure.
2262 </para><para>
2263 Note that the warning for unsafe --homedir permissions cannot be
2264 supressed in the gpg.conf file, as this would allow an attacker to
2265 place an unsafe gpg.conf file in place, and use this file to supress
2266 warnings about itself.  The --homedir permissions warning may only be
2267 supressed on the command line.
2268 </para></listitem></varlistentry>
2269
2270 <varlistentry>
2271 <term>--no-mdc-warning</term>
2272 <listitem><para>
2273 Suppress the warning about missing MDC integrity protection.
2274 </para></listitem></varlistentry>
2275
2276
2277 <varlistentry>
2278 <term>--no-armor</term>
2279 <listitem><para>
2280 Assume the input data is not in ASCII armored format.
2281 </para></listitem></varlistentry>
2282
2283
2284 <varlistentry>
2285 <term>--no-default-keyring</term>
2286 <listitem><para>
2287 Do not add the default keyrings to the list of keyrings.  Note that
2288 GnuPG will not operate without any keyrings, so if you use this option
2289 and do not provide alternate keyrings via --keyring or
2290 --secret-keyring, then GnuPG will still use the default public or
2291 secret keyrings.
2292 </para></listitem></varlistentry>
2293
2294
2295 <varlistentry>
2296 <term>--skip-verify</term>
2297 <listitem><para>
2298 Skip the signature verification step.  This may be
2299 used to make the decryption faster if the signature
2300 verification is not needed.
2301 </para></listitem></varlistentry>
2302
2303
2304 <varlistentry>
2305 <term>--with-colons</term>
2306 <listitem><para>
2307 Print key listings delimited by colons.  Note that the output will be
2308 encoded in UTF-8 regardless of any --charset setting.  This format is
2309 useful when GnuPG is called from scripts and other programs as it is
2310 easily machine parsed.  The details of this format are documented in
2311 the file doc/DETAILS, which is included in the GnuPG source
2312 distribution.
2313 </para></listitem></varlistentry>
2314
2315
2316 <varlistentry>
2317 <term>--with-key-data</term>
2318 <listitem><para>
2319 Print key listings delimited by colons (like --with-colons) and print the public key data.
2320 </para></listitem></varlistentry>
2321
2322 <varlistentry>
2323 <term>--with-fingerprint</term>
2324 <listitem><para>
2325 Same as the command --fingerprint but changes only the format of the output
2326 and may be used together with another command.
2327 </para></listitem></varlistentry>
2328
2329 <varlistentry>
2330 <term>--fast-list-mode</term>
2331 <listitem><para>
2332 Changes the output of the list commands to work faster; this is achieved
2333 by leaving some parts empty.  Some applications don't need the user ID and
2334 the trust information given in the listings.  By using this options they
2335 can get a faster listing.  The exact behaviour of this option may change
2336 in future versions.
2337 </para></listitem></varlistentry>
2338
2339 <varlistentry>
2340 <term>--fixed-list-mode</term>
2341 <listitem><para>
2342 Do not merge primary user ID and primary key in --with-colon listing
2343 mode and print all timestamps as seconds since 1970-01-01.
2344 </para></listitem></varlistentry>
2345
2346 <varlistentry>
2347 <term>--list-only</term>
2348 <listitem><para>
2349 Changes the behaviour of some commands.  This is like --dry-run but
2350 different in some cases.  The semantic of this command may be extended in
2351 the future.  Currently it only skips the actual decryption pass and
2352 therefore enables a fast listing of the encryption keys.
2353 </para></listitem></varlistentry>
2354
2355 <varlistentry>
2356 <term>--no-literal</term>
2357 <listitem><para>
2358 This is not for normal use.  Use the source to see for what it might be useful.
2359 </para></listitem></varlistentry>
2360
2361 <varlistentry>
2362 <term>--set-filesize</term>
2363 <listitem><para>
2364 This is not for normal use.  Use the source to see for what it might be useful.
2365 </para></listitem></varlistentry>
2366
2367 <varlistentry>
2368 <term>--show-session-key</term>
2369 <listitem><para>
2370 Display the session key used for one message. See --override-session-key
2371 for the counterpart of this option.
2372 </para>
2373 <para>
2374 We think that Key-Escrow is a Bad Thing; however the user should
2375 have the freedom to decide whether to go to prison or to reveal the content of
2376 one specific message without compromising all messages ever encrypted for one
2377 secret key. DON'T USE IT UNLESS YOU ARE REALLY FORCED TO DO SO.
2378 </para></listitem></varlistentry>
2379
2380 <varlistentry>
2381 <term>--override-session-key &ParmString; </term>
2382 <listitem><para>
2383 Don't use the public key but the session key &ParmString;.  The format of this
2384 string is the same as the one printed by --show-session-key.  This option
2385 is normally not used but comes handy in case someone forces you to reveal the
2386 content of an encrypted message; using this option you can do this without
2387 handing out the secret key.
2388 </para></listitem></varlistentry>
2389
2390 <varlistentry>
2391 <term>--ask-sig-expire</term>
2392 <term>--no-ask-sig-expire</term>
2393 <listitem><para>
2394 When making a data signature, prompt for an expiration time.  If this
2395 option is not specified, the expiration time is "never".
2396 --no-ask-sig-expire disables this option.
2397 </para></listitem></varlistentry>
2398
2399 <varlistentry>
2400 <term>--ask-cert-expire</term>
2401 <term>--no-ask-cert-expire</term>
2402 <listitem><para>
2403 When making a key signature, prompt for an expiration time.  If this
2404 option is not specified, the expiration time is "never".
2405 --no-ask-cert-expire disables this option.
2406 </para></listitem></varlistentry>
2407
2408 <varlistentry>
2409 <term>--expert</term>
2410 <term>--no-expert</term>
2411 <listitem><para>
2412 Allow the user to do certain nonsensical or "silly" things like
2413 signing an expired or revoked key, or certain potentially incompatible
2414 things like generating deprecated key types.  This also disables
2415 certain warning messages about potentially incompatible actions.  As
2416 the name implies, this option is for experts only.  If you don't fully
2417 understand the implications of what it allows you to do, leave this
2418 off.  --no-expert disables this option.
2419 </para></listitem></varlistentry>
2420
2421 <varlistentry>
2422 <term>--allow-secret-key-import</term>
2423 <listitem><para>
2424 This is an obsolete option and is not used anywhere.
2425 </para></listitem></varlistentry>
2426
2427 <varlistentry>
2428 <term>--try-all-secrets</term>
2429 <listitem><para>
2430 Don't look at the key ID as stored in the message but try all secret keys in
2431 turn to find the right decryption key.  This option forces the behaviour as
2432 used by anonymous recipients (created by using --throw-keyid) and might come
2433 handy in case where an encrypted message contains a bogus key ID.
2434 </para></listitem></varlistentry>
2435
2436 <varlistentry>
2437 <term>--enable-special-filenames</term>
2438 <listitem><para>
2439 This options enables a mode in which filenames of the form
2440 <filename>-&#38;n</filename>, where n is a non-negative decimal number,
2441 refer to the file descriptor n and not to a file with that name.
2442 </para></listitem></varlistentry>
2443
2444 <varlistentry>
2445 <term>--no-expensive-trust-checks</term>
2446 <listitem><para>
2447 Experimental use only.
2448 </para></listitem></varlistentry>
2449
2450 <varlistentry>
2451 <term>--group &ParmNameValues;</term>
2452 <listitem><para>
2453 Sets up a named group, which is similar to aliases in email programs.
2454 Any time the group name is a recipient (-r or --recipient), it will be
2455 expanded to the values specified.  Multiple groups with the same name
2456 are automatically merged into a single group.
2457 </para><para>
2458 The values are &ParmKeyIDs; or fingerprints, but any key description
2459 is accepted.  Note that a value with spaces in it will be treated as
2460 two different values.  Note also there is only one level of expansion
2461 - you cannot make an group that points to another group.  When used
2462 from the command line, it may be necessary to quote the argument to
2463 this option to prevent the shell from treating it as multiple
2464 arguments.
2465 </para></listitem></varlistentry>
2466
2467 <varlistentry>
2468 <term>--ungroup &ParmName;</term>
2469 <listitem><para>
2470 Remove a given entry from the --group list.
2471 </para></listitem></varlistentry>
2472
2473 <varlistentry>
2474 <term>--no-groups</term>
2475 <listitem><para>
2476 Remove all entries from the --group list.
2477 </para></listitem></varlistentry>
2478
2479 <varlistentry>
2480 <term>--preserve-permissions</term>
2481 <listitem><para>
2482 Don't change the permissions of a secret keyring back to user
2483 read/write only.  Use this option only if you really know what you are doing.
2484 </para></listitem></varlistentry>
2485
2486 <varlistentry>
2487 <term>--personal-cipher-preferences &ParmString;</term>
2488 <listitem><para>
2489 Set the list of personal cipher preferences to &ParmString;, this list
2490 should be a string similar to the one printed by the command "pref" in
2491 the edit menu.  This allows the user to factor in their own preferred
2492 algorithms when algorithms are chosen via recipient key preferences.
2493 The most highly ranked cipher in this list is also used for the
2494 --symmetric encryption command.
2495 </para></listitem></varlistentry>
2496
2497 <varlistentry>
2498 <term>--personal-digest-preferences &ParmString;</term>
2499 <listitem><para>
2500 Set the list of personal digest preferences to &ParmString;, this list
2501 should be a string similar to the one printed by the command "pref" in
2502 the edit menu.  This allows the user to factor in their own preferred
2503 algorithms when algorithms are chosen via recipient key preferences.
2504 The most highly ranked digest algorithm in this list is algo used when
2505 signing without encryption (e.g. --clearsign or --sign).  The default
2506 value is SHA-1.
2507 </para></listitem></varlistentry>
2508
2509 <varlistentry>
2510 <term>--personal-compress-preferences &ParmString;</term>
2511 <listitem><para>
2512 Set the list of personal compression preferences to &ParmString;, this
2513 list should be a string similar to the one printed by the command
2514 "pref" in the edit menu.  This allows the user to factor in their own
2515 preferred algorithms when algorithms are chosen via recipient key
2516 preferences.  The most highly ranked algorithm in this list is also
2517 used when there are no recipient keys to consider (e.g. --symmetric).
2518 </para></listitem></varlistentry>
2519
2520 <varlistentry>
2521 <term>--default-preference-list &ParmString;</term>
2522 <listitem><para>
2523 Set the list of default preferences to &ParmString;, this list should
2524 be a string similar to the one printed by the command "pref" in the
2525 edit menu.  This affects both key generation and "updpref" in the edit
2526 menu.
2527 </para></listitem></varlistentry>
2528
2529 <varlistentry>
2530 <term>--list-config &OptParmNames;</term>
2531 <listitem><para>
2532 Display various internal configuration parameters of GnuPG.  This
2533 option is intended for external programs that call GnuPG to perform
2534 tasks, and is thus not generally useful.  See the file
2535 <filename>doc/DETAILS</filename> in the source distribution for the
2536 details of which configuration items may be listed.  --list-config is
2537 only usable with --with-colons set.
2538 </para></listitem></varlistentry>
2539
2540 </variablelist>
2541 </refsect1>
2542
2543
2544 <refsect1>
2545     <title>How to specify a user ID</title>
2546     <para>
2547 There are different ways to specify a user ID to GnuPG; here are some
2548 examples:
2549     </para>
2550
2551     <variablelist>
2552 <varlistentry>
2553 <term></term>
2554 <listitem><para></para></listitem>
2555 </varlistentry>
2556
2557 <varlistentry>
2558 <term>234567C4</term>
2559 <term>0F34E556E</term>
2560 <term>01347A56A</term>
2561 <term>0xAB123456</term>
2562 <listitem><para>
2563 Here the key ID is given in the usual short form.
2564 </para></listitem>
2565 </varlistentry>
2566
2567 <varlistentry>
2568 <term>234AABBCC34567C4</term>
2569 <term>0F323456784E56EAB</term>
2570 <term>01AB3FED1347A5612</term>
2571 <term>0x234AABBCC34567C4</term>
2572 <listitem><para>
2573 Here the key ID is given in the long form as used by OpenPGP
2574 (you can get the long key ID using the option --with-colons).
2575 </para></listitem>
2576 </varlistentry>
2577
2578 <varlistentry>
2579 <term>1234343434343434C434343434343434</term>
2580 <term>123434343434343C3434343434343734349A3434</term>
2581 <term>0E12343434343434343434EAB3484343434343434</term>
2582 <term>0xE12343434343434343434EAB3484343434343434</term>
2583 <listitem><para>
2584 The best way to specify a key ID is by using the fingerprint of
2585 the key.  This avoids any ambiguities in case that there are duplicated
2586 key IDs (which are really rare for the long key IDs).
2587 </para></listitem>
2588 </varlistentry>
2589
2590 <varlistentry>
2591 <term>=Heinrich Heine &#60;heinrichh@uni-duesseldorf.de&#62;</term>
2592 <listitem><para>
2593 Using an exact to match string.  The equal sign indicates this.
2594 </para></listitem>
2595 </varlistentry>
2596
2597 <varlistentry>
2598 <term>&#60;heinrichh@uni-duesseldorf.de&#62;</term>
2599 <listitem><para>
2600 Using the email address part which must match exactly.  The left angle bracket
2601 indicates this email address mode.
2602 </para></listitem>
2603 </varlistentry>
2604
2605 <varlistentry>
2606 <term>+Heinrich Heine duesseldorf</term>
2607 <listitem><para>
2608 All words must match exactly (not case sensitive) but can appear in
2609 any order in the user ID.  Words are any sequences of letters,
2610 digits, the underscore and all characters with bit 7 set.
2611 </para></listitem>
2612 </varlistentry>
2613
2614 <varlistentry>
2615 <term>Heine</term>
2616 <term>*Heine</term>
2617 <listitem><para>
2618 By case insensitive substring matching.  This is the default mode but
2619 applications may want to explicitly indicate this by putting the asterisk
2620 in front.
2621 </para></listitem>
2622 </varlistentry>
2623
2624     </variablelist>
2625
2626     <para>
2627 Note that you can append an exclamation mark (!) to key IDs or
2628 fingerprints.  This flag tells GnuPG to use the specified primary or
2629 secondary key and not to try and calculate which primary or secondary
2630 key to use.
2631     </para>
2632
2633 </refsect1>
2634
2635
2636 <refsect1>
2637     <title>RETURN VALUE</title>
2638     <para>
2639 The program returns 0 if everything was fine, 1 if at least
2640 a signature was bad, and other error codes for fatal errors.
2641     </para>
2642 </refsect1>
2643
2644 <refsect1>
2645     <title>EXAMPLES</title>
2646     <variablelist>
2647
2648 <varlistentry>
2649 <term>gpg -se -r <parameter/Bob/ &ParmFile;</term>
2650 <listitem><para>sign and encrypt for user Bob</para></listitem>
2651 </varlistentry>
2652
2653 <varlistentry>
2654 <term>gpg --clearsign &ParmFile;</term>
2655 <listitem><para>make a clear text signature</para></listitem>
2656 </varlistentry>
2657
2658 <varlistentry>
2659 <term>gpg -sb  &ParmFile;</term>
2660 <listitem><para>make a detached signature</para></listitem>
2661 </varlistentry>
2662
2663 <varlistentry>
2664 <term>gpg --list-keys  <parameter/user_ID/</term>
2665 <listitem><para>show keys</para></listitem>
2666 </varlistentry>
2667
2668 <varlistentry>
2669 <term>gpg --fingerprint  <parameter/user_ID/</term>
2670 <listitem><para>show fingerprint</para></listitem>
2671 </varlistentry>
2672
2673 <varlistentry>
2674 <term>gpg --verify  <parameter/pgpfile/</term>
2675 <term>gpg --verify  <parameter/sigfile/ &OptParmFiles;</term>
2676 <listitem><para>
2677 Verify the signature of the file but do not output the data. The
2678 second form is used for detached signatures, where <parameter/sigfile/
2679 is the detached signature (either ASCII armored or binary) and
2680 &OptParmFiles; are the signed data; if this is not given, the name of
2681 the file holding the signed data is constructed by cutting off the
2682 extension (".asc" or ".sig") of <parameter/sigfile/ or by asking the
2683 user for the filename.
2684 </para></listitem></varlistentry>
2685
2686     </variablelist>
2687 </refsect1>
2688
2689
2690 <refsect1>
2691     <title>ENVIRONMENT</title>
2692
2693     <variablelist>
2694 <varlistentry>
2695 <term>HOME</term>
2696 <listitem><para>Used to locate the default home directory.</para></listitem>
2697 </varlistentry>
2698 <varlistentry>
2699 <term>GNUPGHOME</term>
2700 <listitem><para>If set directory used instead of "~/.gnupg".</para></listitem>
2701 </varlistentry>
2702 <varlistentry>
2703 <term>GPG_AGENT_INFO</term>
2704 <listitem><para>Used to locate the gpg-agent; only honored when
2705 --use-agent is set.  The value consists of 3 colon delimited fields: 
2706 The first is the path to the Unix Domain Socket, the second the PID of
2707 the gpg-agent and the protocol version which should be set to 1.  When
2708 starting the gpg-agent as described in its documentation, this
2709 variable is set to the correct value.  The option --gpg-agent-info can
2710 be used to override it.</para></listitem>
2711 </varlistentry>
2712 <varlistentry>
2713 <term>http_proxy</term>
2714 <listitem><para>Only honored when the keyserver-option
2715 honor-http-proxy is set.</para></listitem>
2716 </varlistentry>
2717
2718 <varlistentry>
2719 <term>COLUMNS</term>
2720 <term>LINES</term>
2721 <listitem><para>
2722 Used to size some displays to the full size of the screen.
2723 </para></listitem></varlistentry>
2724
2725     </variablelist>
2726
2727 </refsect1>
2728
2729 <refsect1>
2730     <title>FILES</title>
2731     <variablelist>
2732
2733 <varlistentry>
2734 <term>~/.gnupg/secring.gpg</term>
2735 <listitem><para>The secret keyring</para></listitem>
2736 </varlistentry>
2737
2738 <varlistentry>
2739 <term>~/.gnupg/secring.gpg.lock</term>
2740 <listitem><para>and the lock file</para></listitem>
2741 </varlistentry>
2742
2743 <varlistentry>
2744 <term>~/.gnupg/pubring.gpg</term>
2745 <listitem><para>The public keyring</para></listitem>
2746 </varlistentry>
2747
2748 <varlistentry>
2749 <term>~/.gnupg/pubring.gpg.lock</term>
2750 <listitem><para>and the lock file</para></listitem>
2751 </varlistentry>
2752
2753 <varlistentry>
2754 <term>~/.gnupg/trustdb.gpg</term>
2755 <listitem><para>The trust database</para></listitem>
2756 </varlistentry>
2757
2758 <varlistentry>
2759 <term>~/.gnupg/trustdb.gpg.lock</term>
2760 <listitem><para>and the lock file</para></listitem>
2761 </varlistentry>
2762
2763 <varlistentry>
2764 <term>~/.gnupg/random_seed</term>
2765 <listitem><para>used to preserve the internal random pool</para></listitem>
2766 </varlistentry>
2767
2768 <varlistentry>
2769 <term>~/.gnupg/gpg.conf</term>
2770 <listitem><para>Default configuration file</para></listitem>
2771 </varlistentry>
2772
2773 <varlistentry>
2774 <term>~/.gnupg/options</term>
2775 <listitem><para>Old style configuration file; only used when gpg.conf
2776 is not found</para></listitem>
2777 </varlistentry>
2778
2779 <varlistentry>
2780 <term>/usr[/local]/share/gnupg/options.skel</term>
2781 <listitem><para>Skeleton options file</para></listitem>
2782 </varlistentry>
2783
2784 <varlistentry>
2785 <term>/usr[/local]/lib/gnupg/</term>
2786 <listitem><para>Default location for extensions</para></listitem>
2787 </varlistentry>
2788
2789     </variablelist>
2790 </refsect1>
2791
2792 <!-- SEE ALSO  not yet needed-->
2793
2794 <refsect1>
2795     <title>WARNINGS</title>
2796     <para>
2797 Use a *good* password for your user account and a *good* passphrase
2798 to protect your secret key.  This passphrase is the weakest part of the
2799 whole system.  Programs to do dictionary attacks on your secret keyring
2800 are very easy to write and so you should protect your "~/.gnupg/"
2801 directory very well.
2802 </para>
2803 <para>
2804 Keep in mind that, if this program is used over a network (telnet), it
2805 is *very* easy to spy out your passphrase!
2806 </para>
2807 <para>
2808 If you are going to verify detached signatures, make sure that the
2809 program knows about it; either be giving both filenames on the
2810 command line or using <literal>-</literal> to specify stdin.
2811 </para>
2812 </refsect1>
2813
2814 <refsect1>
2815     <title>INTEROPERABILITY WITH OTHER OPENPGP PROGRAMS</title>
2816 <para>
2817 GnuPG tries to be a very flexible implementation of the OpenPGP
2818 standard.  In particular, GnuPG implements many of the "optional"
2819 parts of the standard, such as the RIPEMD/160 hash, and the ZLIB
2820 compression algorithms.  It is important to be aware that not all
2821 OpenPGP programs implement these optional algorithms and that by
2822 forcing their use via the --cipher-algo, --digest-algo,
2823 --cert-digest-algo, or --compress-algo options in GnuPG, it is
2824 possible to create a perfectly valid OpenPGP message, but one that
2825 cannot be read by the intended recipient.
2826 </para>
2827
2828 <para>
2829 For example, as of this writing, no (unhacked) version of PGP supports
2830 the BLOWFISH cipher algorithm.  If you use it, no PGP user will be
2831 able to decrypt your message.  The same thing applies to the ZLIB
2832 compression algorithm.  By default, GnuPG uses the standard OpenPGP
2833 preferences system that will always do the right thing and create
2834 messages that are usable by all recipients, regardless of which
2835 OpenPGP program they use.  Only override this safe default if you know
2836 what you are doing.
2837 </para>
2838
2839 <para>
2840 If you absolutely must override the safe default, or if the
2841 preferences on a given key are invalid for some reason, you are far
2842 better off using the --pgp6, --pgp7, or --pgp8 options.  These options
2843 are safe as they do not force any particular algorithms in violation
2844 of OpenPGP, but rather reduce the available algorithms to a "PGP-safe"
2845 list.
2846 </para>
2847
2848 </refsect1>
2849
2850
2851 <refsect1>
2852     <title>BUGS</title>
2853     <para>
2854 On many systems this program should be installed as setuid(root). This
2855 is necessary to lock memory pages.  Locking memory pages prevents the
2856 operating system from writing memory pages (which may contain
2857 passphrases or other sensitive material) to disk.  If you get no
2858 warning message about insecure memory your operating system supports
2859 locking without being root.  The program drops root privileges as soon
2860 as locked memory is allocated.
2861 </para>
2862 </refsect1>
2863
2864 </refentry>