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