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