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