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