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