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