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