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