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