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