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