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