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