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