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