ff28ffe25325b7ef7c3326157603c1c6d591435c
[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 for more on how this works.
524 Note that some versions of PGP interpret the presence of a keyserver
525 URL as an instruction to enable PGP/MIME mail encoding.  Setting a
526 value of "none" removes a 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 HTTP-like keyserver schemes that (such as HKP and HTTP itself),
1278 try to access the keyserver over a proxy.  If a &ParmValue; is
1279 specified, use this as the HTTP proxy.  If no &ParmValue; is
1280 specified, try to use the value of the environment variable
1281 "http_proxy".
1282 </para></listitem></varlistentry>
1283
1284 <varlistentry>
1285 <term>auto-key-retrieve</term>
1286 <listitem><para>
1287 This option enables the automatic retrieving of keys from a keyserver
1288 when verifying signatures made by keys that are not on the local
1289 keyring.
1290 </para><para>
1291 Note that this option makes a "web bug" like behavior possible.
1292 Keyserver operators can see which keys you request, so by sending you
1293 a message signed by a brand new key (which you naturally will not have
1294 on your local keyring), the operator can tell both your IP address and
1295 the time when you verified the signature.
1296 </para></listitem></varlistentry>
1297
1298 </variablelist>
1299 </para></listitem></varlistentry>
1300
1301 <varlistentry>
1302 <term>--import-options <parameter>parameters</parameter></term>
1303 <listitem><para>
1304 This is a space or comma delimited string that gives options for
1305 importing keys.  Options can be prepended with a `no-' to give the
1306 opposite meaning.  The options are:
1307 <variablelist>
1308
1309 <varlistentry>
1310 <term>allow-local-sigs</term>
1311 <listitem><para>
1312 Allow importing key signatures marked as "local".  This is not
1313 generally useful unless a shared keyring scheme is being used.
1314 Defaults to no.
1315 </para></listitem></varlistentry>
1316
1317 <varlistentry>
1318 <term>repair-pks-subkey-bug</term>
1319 <listitem><para>
1320 During import, attempt to repair the damage caused by the PKS
1321 keyserver bug (pre version 0.9.6) that mangles keys with multiple
1322 subkeys.  Note that this cannot completely repair the damaged key as
1323 some crucial data is removed by the keyserver, but it does at least
1324 give you back one subkey.  Defaults to no for regular --import and to
1325 yes for keyserver --recv-keys.
1326 </para></listitem></varlistentry>
1327
1328 <varlistentry>
1329 <term>merge-only</term>
1330 <listitem><para>
1331 During import, allow key updates to existing keys, but do not allow
1332 any new keys to be imported.  Defaults to no.
1333 </para></listitem></varlistentry>
1334
1335 </variablelist>
1336 </para></listitem></varlistentry>
1337
1338 <varlistentry>
1339 <term>--export-options <parameter>parameters</parameter></term>
1340 <listitem><para>
1341 This is a space or comma delimited string that gives options for
1342 exporting keys.  Options can be prepended with a `no-' to give the
1343 opposite meaning.  The options are:
1344 <variablelist>
1345
1346 <varlistentry>
1347 <term>include-local-sigs</term>
1348 <listitem><para>
1349 Allow exporting key signatures marked as "local".  This is not
1350 generally useful unless a shared keyring scheme is being used.
1351 Defaults to no.
1352 </para></listitem></varlistentry>
1353
1354 <varlistentry>
1355 <term>include-attributes</term>
1356 <listitem><para>
1357 Include attribute user IDs (photo IDs) while exporting.  This is
1358 useful to export keys if they are going to be used by an OpenPGP
1359 program that does not accept attribute user IDs.  Defaults to yes.
1360 </para></listitem></varlistentry>
1361
1362 <varlistentry>
1363 <term>include-sensitive-revkeys</term>
1364 <listitem><para>
1365 Include designated revoker information that was marked as
1366 "sensitive".  Defaults to no.
1367 </para></listitem></varlistentry>
1368
1369 </variablelist>
1370 </para></listitem></varlistentry>
1371
1372 <varlistentry>
1373 <term>--list-options <parameter>parameters</parameter></term>
1374 <listitem><para>
1375 This is a space or comma delimited string that gives options used when
1376 listing keys and signatures (that is, --list-keys, --list-sigs,
1377 --list-public-keys, --list-secret-keys, and the --edit-key functions).
1378 Options can be prepended with a `no-' to give the opposite meaning.
1379 The options are:
1380 <variablelist>
1381
1382 <varlistentry>
1383 <term>show-photos</term>
1384 <listitem><para>
1385 Causes --list-keys, --list-sigs, --list-public-keys, and
1386 --list-secret-keys to display any photo IDs attached to the key.
1387 Defaults to no.  See also --photo-viewer.
1388 </para></listitem></varlistentry>
1389
1390 <varlistentry>
1391 <term>show-policy-urls</term>
1392 <listitem><para>
1393 Show policy URLs in the --list-sigs or --check-sigs listings.
1394 Defaults to no.
1395 </para></listitem></varlistentry>
1396
1397 <varlistentry>
1398 <term>show-notations</term>
1399 <term>show-std-notations</term>
1400 <term>show-user-notations</term>
1401 <listitem><para>
1402 Show all, IETF standard, or user-defined signature notations in the
1403 --list-sigs or --check-sigs listings.  Defaults to no.
1404 </para></listitem></varlistentry>
1405
1406 <varlistentry>
1407 <term>show-keyserver-urls</term>
1408 <listitem><para>
1409 Show any preferred keyserver URL in the --list-sigs or --check-sigs
1410 listings.  Defaults to no.
1411 </para></listitem></varlistentry>
1412
1413 <varlistentry>
1414 <term>show-uid-validity</term>
1415 <listitem><para>
1416 Display the calculated validity of user IDs during key listings.
1417 Defaults to no.
1418 </para></listitem></varlistentry>
1419
1420 <varlistentry>
1421 <term>show-unusable-uids</term>
1422 <listitem><para>
1423 Show revoked and expired user IDs in key listings.  Defaults to no.
1424 </para></listitem></varlistentry>
1425
1426 <varlistentry>
1427 <term>show-unusable-subkeys</term>
1428 <listitem><para>
1429 Show revoked and expired subkeys in key listings.  Defaults to no.
1430 </para></listitem></varlistentry>
1431
1432 <varlistentry>
1433 <term>show-keyring</term>
1434 <listitem><para>
1435 Display the keyring name at the head of key listings to show which
1436 keyring a given key resides on.  Defaults to no.
1437 </para></listitem></varlistentry>
1438
1439 <varlistentry>
1440 <term>show-sig-expire</term>
1441 <listitem><para>
1442 Show signature expiration dates (if any) during --list-sigs or
1443 --check-sigs listings.  Defaults to no.
1444 </para></listitem></varlistentry>
1445
1446 <varlistentry>
1447 <term>show-sig-subpackets</term>
1448 <listitem><para>
1449 Include signature subpackets in the key listing.  This option can take
1450 an optional argument list of the subpackets to list.  If no argument
1451 is passed, list all subpackets.  Defaults to no.  This option is only
1452 meaningful when using --with-colons along with --list-sigs or
1453 --check-sigs.
1454 </para></listitem></varlistentry>
1455
1456 </variablelist>
1457 </para></listitem></varlistentry>
1458
1459 <varlistentry>
1460 <term>--verify-options <parameter>parameters</parameter></term>
1461 <listitem><para>
1462 This is a space or comma delimited string that gives options used when
1463 verifying signatures.  Options can be prepended with a `no-' to give
1464 the opposite meaning.  The options are:
1465 <variablelist>
1466
1467 <varlistentry>
1468 <term>show-photos</term>
1469 <listitem><para>
1470 Display any photo IDs present on the key that issued the signature.
1471 Defaults to no.  See also --photo-viewer.
1472 </para></listitem></varlistentry>
1473
1474 <varlistentry>
1475 <term>show-policy-urls</term>
1476 <listitem><para>
1477 Show policy URLs in the signature being verified.  Defaults to no.
1478 </para></listitem></varlistentry>
1479
1480 <varlistentry>
1481 <term>show-notations</term>
1482 <term>show-std-notations</term>
1483 <term>show-user-notations</term>
1484 <listitem><para>
1485 Show all, IETF standard, or user-defined signature notations in the
1486 signature being verified.  Defaults to IETF standard.
1487 </para></listitem></varlistentry>
1488
1489 <varlistentry>
1490 <term>show-keyserver-urls</term>
1491 <listitem><para>
1492 Show any preferred keyserver URL in the signature being verified.
1493 Defaults to no.
1494 </para></listitem></varlistentry>
1495
1496 <varlistentry>
1497 <term>show-uid-validity</term>
1498 <listitem><para>
1499 Display the calculated validity of the user IDs on the key that issued
1500 the signature.  Defaults to no.
1501 </para></listitem></varlistentry>
1502
1503 <varlistentry>
1504 <term>show-unusable-uids</term>
1505 <listitem><para>
1506 Show revoked and expired user IDs during signature verification.
1507 Defaults to no.
1508 </para></listitem></varlistentry>
1509
1510 </variablelist>
1511 </para></listitem></varlistentry>
1512
1513 <varlistentry>
1514 <term>--show-photos</term>
1515 <term>--no-show-photos</term>
1516 <listitem><para>
1517 Causes --list-keys, --list-sigs, --list-public-keys,
1518 --list-secret-keys, and verifying a signature to also display the
1519 photo ID attached to the key, if any.  See also --photo-viewer.  These
1520 options are deprecated.  Use `--list-options [no-]show-photos' and/or
1521 `--verify-options [no-]show-photos' instead.
1522 </para></listitem></varlistentry>
1523
1524 <varlistentry>
1525 <term>--photo-viewer &ParmString;</term>
1526 <listitem><para>
1527 This is the command line that should be run to view a photo ID.  "%i"
1528 will be expanded to a filename containing the photo.  "%I" does the
1529 same, except the file will not be deleted once the viewer exits.
1530 Other flags are "%k" for the key ID, "%K" for the long key ID, "%f"
1531 for the key fingerprint, "%t" for the extension of the image type
1532 (e.g. "jpg"), "%T" for the MIME type of the image (e.g. "image/jpeg"),
1533 and "%%" for an actual percent sign.  If neither %i or %I are present,
1534 then the photo will be supplied to the viewer on standard input.
1535 </para><para>
1536 The default viewer is "xloadimage -fork -quiet -title 'KeyID 0x%k'
1537 stdin".  Note that if your image viewer program is not secure, then
1538 executing it from GnuPG does not make it secure.
1539 </para></listitem></varlistentry>
1540
1541 <varlistentry>
1542 <term>--exec-path &ParmString;</term>
1543 <listitem><para>
1544 Sets a list of directories to search for photo viewers and keyserver
1545 helpers.  If not provided, keyserver helpers use the compiled-in
1546 default directory, and photo viewers use the $PATH environment
1547 variable.
1548 </para></listitem></varlistentry>
1549
1550 <varlistentry>
1551 <term>--show-keyring</term>
1552 <listitem><para>
1553 Display the keyring name at the head of key listings to show which
1554 keyring a given key resides on.  This option is deprecated: use
1555 `--list-options [no-]show-keyring' instead.
1556 </para></listitem></varlistentry>
1557
1558 <varlistentry>
1559 <term>--keyring &ParmFile;</term>
1560 <listitem><para>
1561 Add &ParmFile; to the current list of keyrings.  If &ParmFile; begins
1562 with a tilde and a slash, these are replaced by the $HOME
1563 directory. If the filename does not contain a slash, it is assumed to
1564 be in the GnuPG home directory ("~/.gnupg" if --homedir or $GNUPGHOME
1565 is not used).
1566 </para><para>
1567 Note that this adds a keyring to the current list.  If the intent is
1568 to use the specified keyring alone, use --keyring along with
1569 --no-default-keyring.
1570 </para></listitem></varlistentry>
1571
1572
1573 <varlistentry>
1574 <term>--secret-keyring &ParmFile;</term>
1575 <listitem><para>
1576 Same as --keyring but for the secret keyrings.
1577 </para></listitem></varlistentry>
1578
1579 <varlistentry>
1580 <term>--primary-keyring &ParmFile;</term>
1581 <listitem><para>
1582 Designate &ParmFile; as the primary public keyring.  This means that
1583 newly imported keys (via --import or keyserver --recv-from) will go to
1584 this keyring.
1585 </para></listitem></varlistentry>
1586
1587 <varlistentry>
1588 <term>--trustdb-name &ParmFile;</term>
1589 <listitem><para>
1590 Use &ParmFile; instead of the default trustdb.  If &ParmFile; begins
1591 with a tilde and a slash, these are replaced by the $HOME
1592 directory. If the filename does not contain a slash, it is assumed to
1593 be in the GnuPG home directory ("~/.gnupg" if --homedir or $GNUPGHOME
1594 is not used).
1595 </para></listitem></varlistentry>
1596
1597
1598 <varlistentry>
1599 <term>--homedir &ParmDir;</term>
1600 <listitem><para>
1601 Set the name of the home directory to &ParmDir; If this option is not
1602 used it defaults to "~/.gnupg". It does not make sense to use this in
1603 a options file. This also overrides the environment variable
1604 $GNUPGHOME.
1605 </para></listitem></varlistentry>
1606
1607
1608 <varlistentry>
1609 <term>--display-charset &ParmName;</term>
1610 <listitem><para>
1611 Set the name of the native character set.  This is used to convert
1612 some informational strings like user IDs to the proper UTF-8
1613 encoding. If this option is not used, the default character set is
1614 determined from the current locale.  A verbosity level of 3 shows the
1615 chosen set.  Valid values for &ParmName; are:</para>
1616 <variablelist>
1617 <varlistentry>
1618 <term>iso-8859-1</term><listitem><para>This is the Latin 1 set.</para></listitem>
1619 </varlistentry>
1620 <varlistentry>
1621 <term>iso-8859-2</term><listitem><para>The Latin 2 set.</para></listitem>
1622 </varlistentry>
1623 <varlistentry>
1624 <term>iso-8859-15</term><listitem><para>This is currently an alias for
1625 the Latin 1 set.</para></listitem>
1626 </varlistentry>
1627 <varlistentry>
1628 <term>koi8-r</term><listitem><para>The usual Russian set (rfc1489).</para></listitem>
1629 </varlistentry>
1630 <varlistentry>
1631 <term>utf-8</term><listitem><para>Bypass all translations and assume
1632 that the OS uses native UTF-8 encoding.</para></listitem>
1633 </varlistentry>
1634 </variablelist>
1635 </listitem></varlistentry>
1636
1637
1638 <varlistentry>
1639 <term>--utf8-strings</term>
1640 <term>--no-utf8-strings</term>
1641 <listitem><para>
1642 Assume that command line arguments are given as UTF8 strings.  The
1643 default (--no-utf8-strings) is to assume that arguments are encoded in
1644 the character set as specified by --display-charset. These options
1645 affect all following arguments.  Both options may be used multiple
1646 times.
1647 </para></listitem></varlistentry>
1648
1649
1650 <varlistentry>
1651 <term>--options &ParmFile;</term>
1652 <listitem><para>
1653 Read options from &ParmFile; and do not try to read
1654 them from the default options file in the homedir
1655 (see --homedir). This option is ignored if used
1656 in an options file.
1657 </para></listitem></varlistentry>
1658
1659
1660 <varlistentry>
1661 <term>--no-options</term>
1662 <listitem><para>
1663 Shortcut for "--options /dev/null".  This option is
1664 detected before an attempt to open an option file.
1665 Using this option will also prevent the creation of a 
1666 "~./gnupg" homedir.
1667 </para></listitem></varlistentry>
1668
1669
1670 <varlistentry>
1671 <term>--load-extension &ParmName;</term>
1672 <listitem><para>
1673 Load an extension module. If &ParmName; does not contain a slash it is
1674 searched for in the directory configured when GnuPG was built
1675 (generally "/usr/local/lib/gnupg").  Extensions are not generally
1676 useful anymore, and the use of this option is deprecated.
1677 </para></listitem></varlistentry>
1678
1679
1680 <varlistentry>
1681 <term>--debug &ParmFlags;</term>
1682 <listitem><para>
1683 Set debugging flags. All flags are or-ed and &ParmFlags; may
1684 be given in C syntax (e.g. 0x0042).
1685 </para></listitem></varlistentry>
1686
1687
1688 <varlistentry>
1689 <term>--debug-all</term>
1690 <listitem><para>
1691  Set all useful debugging flags.
1692 </para></listitem></varlistentry>
1693
1694 <varlistentry>
1695 <term>--debug-ccid-driver</term>
1696 <listitem><para>
1697 Enable debug output from the included CCID driver for smartcards.
1698 Note that this option is only available on some system.
1699 </para></listitem></varlistentry>
1700
1701
1702 <varlistentry>
1703 <term>--enable-progress-filter</term>
1704 <listitem><para>
1705 Enable certain PROGRESS status outputs.  This option allows frontends
1706 to display a progress indicator while gpg is processing larger files.
1707 There is a slight performance overhead using it.
1708 </para></listitem></varlistentry>
1709
1710
1711 <varlistentry>
1712 <term>--status-fd &ParmN;</term>
1713 <listitem><para>
1714 Write special status strings to the file descriptor &ParmN;.
1715 See the file DETAILS in the documentation for a listing of them.
1716 </para></listitem></varlistentry>
1717
1718
1719 <varlistentry>
1720 <term>--logger-fd &ParmN;</term>
1721 <listitem><para>
1722 Write log output to file descriptor &ParmN; and not to stderr.
1723 </para></listitem></varlistentry>
1724
1725
1726 <varlistentry>
1727 <term>--attribute-fd &ParmN;</term>
1728 <listitem><para>
1729 Write attribute subpackets to the file descriptor &ParmN;.  This is
1730 most useful for use with --status-fd, since the status messages are
1731 needed to separate out the various subpackets from the stream
1732 delivered to the file descriptor.
1733 </para></listitem></varlistentry>
1734
1735
1736 <varlistentry>
1737 <term>--sk-comments</term>
1738 <term>--no-sk-comments</term>
1739 <listitem><para>
1740 Include secret key comment packets when exporting secret keys.  This
1741 is a GnuPG extension to the OpenPGP standard, and is off by default.
1742 Please note that this has nothing to do with the comments in clear
1743 text signatures or armor headers.  --no-sk-comments disables this
1744 option.
1745 </para></listitem></varlistentry>
1746
1747
1748 <varlistentry>
1749 <term>--comment &ParmString;</term>
1750 <term>--no-comments</term>
1751 <listitem><para>
1752 Use &ParmString; as a comment string in clear text signatures and
1753 ASCII armored messages or keys (see --armor).  The default behavior is
1754 not to use a comment string.  --comment may be repeated multiple times
1755 to get multiple comment strings.  --no-comments removes all comments.
1756 </para></listitem></varlistentry>
1757
1758
1759 <varlistentry>
1760 <term>--emit-version</term>
1761 <term>--no-emit-version</term>
1762 <listitem><para>
1763 Force inclusion of the version string in ASCII armored output.
1764 --no-emit-version disables this option.
1765 </para></listitem></varlistentry>
1766
1767
1768 <varlistentry>
1769 <term>--sig-notation &ParmNameValue;</term>
1770 <term>--cert-notation &ParmNameValue;</term>
1771 <term>-N, --set-notation &ParmNameValue;</term>
1772 <listitem><para>
1773 Put the name value pair into the signature as notation data.
1774 &ParmName; must consist only of printable characters or spaces, and
1775 must contain a '@' character.  This is to help prevent pollution of
1776 the IETF reserved notation namespace.  The --expert flag overrides the
1777 '@' check.  &ParmValue; may be any printable string; it will be
1778 encoded in UTF8, so you should check that your --display-charset is
1779 set correctly.  If you prefix &ParmName; with an exclamation mark (!),
1780 the notation data will be flagged as critical (rfc2440:5.2.3.15).
1781 --sig-notation sets a notation for data signatures.  --cert-notation
1782 sets a notation for key signatures (certifications).  --set-notation
1783 sets both.
1784 </para>
1785
1786 <para>
1787 There are special codes that may be used in notation names.  "%k" will
1788 be expanded into the key ID of the key being signed, "%K" into the
1789 long key ID of the key being signed, "%f" into the fingerprint of the
1790 key being signed, "%s" into the key ID of the key making the
1791 signature, "%S" into the long key ID of the key making the signature,
1792 "%g" into the fingerprint of the key making the signature (which might
1793 be a subkey), "%p" into the fingerprint of the primary key of the key
1794 making the signature, "%c" into the signature count from the OpenPGP
1795 smartcard, and "%%" results in a single "%".  %k, %K, and %f are only
1796 meaningful when making a key signature (certification), and %c is only
1797 meaningful when using the OpenPGP smartcard.
1798 </para>
1799
1800 </listitem></varlistentry>
1801
1802 <varlistentry>
1803 <term>--show-notation</term>
1804 <term>--no-show-notation</term>
1805 <listitem><para>
1806 Show signature notations in the --list-sigs or --check-sigs listings
1807 as well as when verifying a signature with a notation in it.  These
1808 options are deprecated.  Use `--list-options [no-]show-notation'
1809 and/or `--verify-options [no-]show-notation' instead.
1810 </para></listitem></varlistentry>
1811
1812 <varlistentry>
1813 <term>--sig-policy-url &ParmString;</term>
1814 <term>--cert-policy-url &ParmString;</term>
1815 <term>--set-policy-url &ParmString;</term>
1816 <listitem><para>
1817 Use &ParmString; as a Policy URL for signatures (rfc2440:5.2.3.19).
1818 If you prefix it with an exclamation mark (!), the policy URL packet
1819 will be flagged as critical.  --sig-policy-url sets a policy url for
1820 data signatures.  --cert-policy-url sets a policy url for key
1821 signatures (certifications).  --set-policy-url sets both.
1822 </para><para>
1823 The same %-expandos used for notation data are available here as well.
1824 </para></listitem></varlistentry>
1825
1826 <varlistentry>
1827 <term>--show-policy-url</term>
1828 <term>--no-show-policy-url</term>
1829 <listitem><para>
1830 Show policy URLs in the --list-sigs or --check-sigs listings as well
1831 as when verifying a signature with a policy URL in it.  These options
1832 are deprecated.  Use `--list-options [no-]show-policy-url' and/or
1833 `--verify-options [no-]show-policy-url' instead.
1834 </para></listitem></varlistentry>
1835
1836
1837 <varlistentry>
1838 <term>--sig-keyserver-url &ParmString;</term>
1839 <listitem><para>
1840 Use &ParmString; as a preferred keyserver URL for data signatures.  If
1841 you prefix it with an exclamation mark, the keyserver URL packet will
1842 be flagged as critical.  </para><para>
1843 The same %-expandos used for notation data are available here as well.
1844 </para></listitem></varlistentry>
1845
1846
1847 <varlistentry>
1848 <term>--set-filename &ParmString;</term>
1849 <listitem><para>
1850 Use &ParmString; as the filename which is stored inside messages.
1851 This overrides the default, which is to use the actual filename of the
1852 file being encrypted.
1853 </para></listitem></varlistentry>
1854
1855 <varlistentry>
1856 <term>--for-your-eyes-only</term>
1857 <term>--no-for-your-eyes-only</term>
1858 <listitem><para>
1859 Set the `for your eyes only' flag in the message.  This causes GnuPG
1860 to refuse to save the file unless the --output option is given, and
1861 PGP to use the "secure viewer" with a Tempest-resistant font to
1862 display the message.  This option overrides --set-filename.
1863 --no-for-your-eyes-only disables this option.
1864 </para></listitem></varlistentry>
1865
1866 <varlistentry>
1867 <term>--use-embedded-filename</term>
1868 <term>--no-use-embedded-filename</term>
1869 <listitem><para>
1870 Try to create a file with a name as embedded in the data.  This can be
1871 a dangerous option as it allows to overwrite files.  Defaults to no.
1872 </para></listitem></varlistentry>
1873
1874
1875 <varlistentry>
1876 <term>--completes-needed &ParmN;</term>
1877 <listitem><para>
1878 Number of completely trusted users to introduce a new
1879 key signer (defaults to 1).
1880 </para></listitem></varlistentry>
1881
1882
1883 <varlistentry>
1884 <term>--marginals-needed &ParmN;</term>
1885 <listitem><para>
1886 Number of marginally trusted users to introduce a new
1887 key signer (defaults to 3)
1888 </para></listitem></varlistentry>
1889
1890
1891 <varlistentry>
1892 <term>--max-cert-depth &ParmN;</term>
1893 <listitem><para>
1894 Maximum depth of a certification chain (default is 5).
1895 </para></listitem></varlistentry>
1896
1897
1898 <varlistentry>
1899 <term>--cipher-algo &ParmName;</term>
1900 <listitem><para>
1901 Use  &ParmName; as cipher algorithm. Running the program
1902 with the command --version yields a list of supported
1903 algorithms. If this is not used the cipher algorithm is
1904 selected from the preferences stored with the key.
1905 </para></listitem></varlistentry>
1906
1907
1908 <varlistentry>
1909 <term>--digest-algo &ParmName;</term>
1910 <listitem><para>
1911 Use &ParmName; as the message digest algorithm. Running the program
1912 with the command --version yields a list of supported algorithms.
1913 </para></listitem></varlistentry>
1914
1915
1916 <varlistentry>
1917 <term>--compress-algo &ParmName;</term>
1918 <listitem><para>
1919 Use compression algorithm &ParmName;.  "zlib" is RFC-1950 ZLIB
1920 compression.  "zip" is RFC-1951 ZIP compression which is used by PGP.
1921 "bzip2" is a more modern compression scheme that can compress some
1922 things better than zip or zlib, but at the cost of more memory used
1923 during compression and decompression.  "uncompressed" or "none"
1924 disables compression.  If this option is not used, the default
1925 behavior is to examine the recipient key preferences to see which
1926 algorithms the recipient supports.  If all else fails, ZIP is used for
1927 maximum compatibility.
1928 </para><para>
1929 ZLIB may give better compression results than ZIP, as the compression
1930 window size is not limited to 8k.  BZIP2 may give even better
1931 compression results than that, but will use a significantly larger
1932 amount of memory while compressing and decompressing.  This may be
1933 significant in low memory situations.  Note, however, that PGP (all
1934 versions) only supports ZIP compression.  Using any algorithm other
1935 than ZIP or "none" will make the message unreadable with PGP.
1936 </para></listitem></varlistentry>
1937
1938
1939 <varlistentry>
1940 <term>--cert-digest-algo &ParmName;</term>
1941 <listitem><para>
1942 Use &ParmName; as the message digest algorithm used when signing a
1943 key.  Running the program with the command --version yields a list of
1944 supported algorithms.  Be aware that if you choose an algorithm that
1945 GnuPG supports but other OpenPGP implementations do not, then some
1946 users will not be able to use the key signatures you make, or quite
1947 possibly your entire key.
1948 </para></listitem></varlistentry>
1949
1950
1951 <varlistentry>
1952 <term>--s2k-cipher-algo &ParmName;</term>
1953 <listitem><para>
1954 Use &ParmName; as the cipher algorithm used to protect secret keys.
1955 The default cipher is CAST5.  This cipher is also used for
1956 conventional encryption if --personal-cipher-preferences and
1957 --cipher-algo is not given.
1958 </para></listitem></varlistentry>
1959
1960
1961 <varlistentry>
1962 <term>--s2k-digest-algo &ParmName;</term>
1963 <listitem><para>
1964 Use &ParmName; as the digest algorithm used to mangle the passphrases.
1965 The default algorithm is SHA-1.
1966 </para></listitem></varlistentry>
1967
1968
1969 <varlistentry>
1970 <term>--s2k-mode &ParmN;</term>
1971 <listitem><para>
1972 Selects how passphrases are mangled. If &ParmN; is 0 a plain
1973 passphrase (which is not recommended) will be used, a 1 adds a salt to
1974 the passphrase and a 3 (the default) iterates the whole process a
1975 couple of times.  Unless --rfc1991 is used, this mode is also used for
1976 conventional encryption.
1977 </para></listitem></varlistentry>
1978
1979
1980 <varlistentry>
1981 <term>--simple-sk-checksum</term>
1982 <listitem><para>
1983 Secret keys are integrity protected by using a SHA-1 checksum.  This
1984 method is part of the upcoming enhanced OpenPGP specification but
1985 GnuPG already uses it as a countermeasure against certain attacks.
1986 Old applications don't understand this new format, so this option may
1987 be used to switch back to the old behaviour.  Using this option bears
1988 a security risk.  Note that using this option only takes effect when
1989 the secret key is encrypted - the simplest way to make this happen is
1990 to change the passphrase on the key (even changing it to the same
1991 value is acceptable).
1992 </para></listitem></varlistentry>
1993
1994
1995 <varlistentry>
1996 <term>--disable-cipher-algo &ParmName;</term>
1997 <listitem><para>
1998 Never allow the use of &ParmName; as cipher algorithm.
1999 The given name will not be checked so that a later loaded algorithm
2000 will still get disabled.
2001 </para></listitem></varlistentry>
2002
2003 <varlistentry>
2004 <term>--disable-pubkey-algo &ParmName;</term>
2005 <listitem><para>
2006 Never allow the use of &ParmName; as public key algorithm.
2007 The given name will not be checked so that a later loaded algorithm
2008 will still get disabled.
2009 </para></listitem></varlistentry>
2010
2011 <varlistentry>
2012 <term>--no-sig-cache</term>
2013 <listitem><para>
2014 Do not cache the verification status of key signatures.
2015 Caching gives a much better performance in key listings.  However, if
2016 you suspect that your public keyring is not save against write
2017 modifications, you can use this option to disable the caching.  It
2018 probably does not make sense to disable it because all kind of damage
2019 can be done if someone else has write access to your public keyring.
2020 </para></listitem></varlistentry>
2021
2022 <varlistentry>
2023 <term>--no-sig-create-check</term>
2024 <listitem><para>
2025 GnuPG normally verifies each signature right after creation to protect
2026 against bugs and hardware malfunctions which could leak out bits from
2027 the secret key.  This extra verification needs some time (about 115%
2028 for DSA keys), and so this option can be used to disable it.
2029 However, due to the fact that the signature creation needs manual
2030 interaction, this performance penalty does not matter in most settings.
2031 </para></listitem></varlistentry>
2032
2033 <varlistentry>
2034 <term>--auto-check-trustdb</term>
2035 <term>--no-auto-check-trustdb</term>
2036 <listitem><para>
2037 If GnuPG feels that its information about the Web of Trust has to be
2038 updated, it automatically runs the --check-trustdb command internally.
2039 This may be a time consuming process.  --no-auto-check-trustdb
2040 disables this option.
2041 </para></listitem></varlistentry>
2042
2043 <varlistentry>
2044 <term>--throw-keyids</term>
2045 <term>--no-throw-keyids</term>
2046 <listitem><para>
2047 Do not put the recipient keyid into encrypted packets.  This option
2048 hides the receiver of the message and is a countermeasure against
2049 traffic analysis.  It may slow down the decryption process because all
2050 available secret keys are tried.  --no-throw-keyids disables this
2051 option.
2052 </para></listitem></varlistentry>
2053
2054 <varlistentry>
2055 <term>--not-dash-escaped</term>
2056 <listitem><para>
2057 This option changes the behavior of cleartext signatures
2058 so that they can be used for patch files. You should not
2059 send such an armored file via email because all spaces
2060 and line endings are hashed too.  You can not use this
2061 option for data which has 5 dashes at the beginning of a
2062 line, patch files don't have this. A special armor header
2063 line tells GnuPG about this cleartext signature option.
2064 </para></listitem></varlistentry>
2065
2066 <varlistentry>
2067 <term>--escape-from-lines</term>
2068 <term>--no-escape-from-lines</term>
2069 <listitem><para>
2070 Because some mailers change lines starting with "From " to "&#62;From
2071 " it is good to handle such lines in a special way when creating
2072 cleartext signatures to prevent the mail system from breaking the
2073 signature.  Note that all other PGP versions do it this way too.
2074 Enabled by default.  --no-escape-from-lines disables this option.
2075 </para></listitem></varlistentry>
2076
2077
2078 <varlistentry>
2079 <term>--passphrase-fd &ParmN;</term>
2080 <listitem><para>
2081 Read the passphrase from file descriptor &ParmN;. If you use
2082 0 for &ParmN;, the passphrase will be read from stdin.  This
2083 can only be used if only one passphrase is supplied.
2084 <!--fixme: make this print strong-->
2085 Don't use this option if you can avoid it.
2086 </para></listitem></varlistentry>
2087
2088 <varlistentry>
2089 <term>--command-fd &ParmN;</term>
2090 <listitem><para>
2091 This is a replacement for the deprecated shared-memory IPC mode.
2092 If this option is enabled, user input on questions is not expected
2093 from the TTY but from the given file descriptor.  It should be used
2094 together with --status-fd. See the file doc/DETAILS in the source
2095 distribution for details on how to use it.
2096 </para></listitem></varlistentry>
2097
2098 <varlistentry>
2099 <term>--use-agent</term>
2100 <term>--no-use-agent</term>
2101 <listitem><para>
2102 Try to use the GnuPG-Agent. Please note that this agent is still under
2103 development.  With this option, GnuPG first tries to connect to the
2104 agent before it asks for a passphrase.  --no-use-agent disables this
2105 option.
2106 </para></listitem></varlistentry>
2107
2108 <varlistentry>
2109 <term>--gpg-agent-info</term>
2110 <listitem><para>
2111 Override the value of the environment variable
2112 <literal>GPG_AGENT_INFO</literal>.  This is only used when --use-agent has been given
2113 </para></listitem></varlistentry>
2114
2115 <varlistentry>
2116 <term>Compliance options</term>
2117 <listitem><para>
2118 These options control what GnuPG is compliant to.  Only one of these
2119 options may be active at a time.  Note that the default setting of
2120 this is nearly always the correct one.  See the INTEROPERABILITY WITH
2121 OTHER OPENPGP PROGRAMS section below before using one of these
2122 options.
2123 <variablelist>
2124
2125 <varlistentry>
2126 <term>--gnupg</term>
2127 <listitem><para>
2128 Use standard GnuPG behavior.  This is essentially OpenPGP behavior
2129 (see --openpgp), but with some additional workarounds for common
2130 compatibility problems in different versions of PGP.  This is the
2131 default option, so it is not generally needed, but it may be useful to
2132 override a different compliance option in the gpg.conf file.
2133 </para></listitem></varlistentry>
2134
2135 <varlistentry>
2136 <term>--openpgp</term>
2137 <listitem><para>
2138 Reset all packet, cipher and digest options to strict OpenPGP
2139 behavior.  Use this option to reset all previous options like
2140 --rfc1991, --force-v3-sigs, --s2k-*, --cipher-algo, --digest-algo and
2141 --compress-algo to OpenPGP compliant values.  All PGP workarounds are
2142 disabled.
2143 </para></listitem></varlistentry>
2144
2145 <varlistentry>
2146 <term>--rfc2440</term>
2147 <listitem><para>
2148 Reset all packet, cipher and digest options to strict RFC-2440
2149 behavior.  Note that this is currently the same thing as --openpgp.
2150 </para></listitem></varlistentry>
2151
2152 <varlistentry>
2153 <term>--rfc1991</term>
2154 <listitem><para>
2155 Try to be more RFC-1991 (PGP 2.x) compliant.
2156 </para></listitem></varlistentry>
2157
2158 <varlistentry>
2159 <term>--pgp2</term>
2160 <listitem><para>
2161 Set up all options to be as PGP 2.x compliant as possible, and warn if
2162 an action is taken (e.g. encrypting to a non-RSA key) that will create
2163 a message that PGP 2.x will not be able to handle.  Note that `PGP
2164 2.x' here means `MIT PGP 2.6.2'.  There are other versions of PGP 2.x
2165 available, but the MIT release is a good common baseline.
2166 </para><para>
2167 This option implies `--rfc1991 --disable-mdc --no-force-v4-certs
2168 --no-sk-comment --escape-from-lines --force-v3-sigs
2169 --no-ask-sig-expire --no-ask-cert-expire --cipher-algo IDEA
2170 --digest-algo MD5 --compress-algo 1'.  It also disables --textmode
2171 when encrypting.
2172 </para></listitem></varlistentry>
2173
2174 <varlistentry>
2175 <term>--pgp6</term>
2176 <listitem><para>
2177 Set up all options to be as PGP 6 compliant as possible.  This
2178 restricts you to the ciphers IDEA (if the IDEA plugin is installed),
2179 3DES, and CAST5, the hashes MD5, SHA1 and RIPEMD160, and the
2180 compression algorithms none and ZIP.  This also disables
2181 --throw-keyids, and making signatures with signing subkeys as PGP 6
2182 does not understand signatures made by signing subkeys.
2183 </para><para>
2184 This option implies `--disable-mdc --no-sk-comment --escape-from-lines
2185 --force-v3-sigs --no-ask-sig-expire'
2186 </para></listitem></varlistentry>
2187
2188 <varlistentry>
2189 <term>--pgp7</term>
2190 <listitem><para>
2191 Set up all options to be as PGP 7 compliant as possible.  This is
2192 identical to --pgp6 except that MDCs are not disabled, and the list of
2193 allowable ciphers is expanded to add AES128, AES192, AES256, and
2194 TWOFISH.
2195 </para></listitem></varlistentry>
2196
2197 <varlistentry>
2198 <term>--pgp8</term>
2199 <listitem><para>
2200 Set up all options to be as PGP 8 compliant as possible.  PGP 8 is a
2201 lot closer to the OpenPGP standard than previous versions of PGP, so
2202 all this does is disable --throw-keyids and set --escape-from-lines.
2203 All algorithms are allowed except for the SHA384 and SHA512 digests.
2204 </para></listitem></varlistentry>
2205
2206 </variablelist></para></listitem></varlistentry>
2207
2208 <varlistentry>
2209 <term>--force-v3-sigs</term>
2210 <term>--no-force-v3-sigs</term>
2211 <listitem><para>
2212 OpenPGP states that an implementation should generate v4 signatures
2213 but PGP versions 5 through 7 only recognize v4 signatures on key
2214 material.  This option forces v3 signatures for signatures on data.
2215 Note that this option overrides --ask-sig-expire, as v3 signatures
2216 cannot have expiration dates.  --no-force-v3-sigs disables this
2217 option.
2218 </para></listitem></varlistentry>
2219
2220 <varlistentry>
2221 <term>--force-v4-certs</term>
2222 <term>--no-force-v4-certs</term>
2223 <listitem><para>
2224 Always use v4 key signatures even on v3 keys.  This option also
2225 changes the default hash algorithm for v3 RSA keys from MD5 to SHA-1.
2226 --no-force-v4-certs disables this option.
2227 </para></listitem></varlistentry>
2228
2229 <varlistentry>
2230 <term>--force-mdc</term>
2231 <listitem><para>
2232 Force the use of encryption with a modification detection code.  This
2233 is always used with the newer ciphers (those with a blocksize greater
2234 than 64 bits), or if all of the recipient keys indicate MDC support in
2235 their feature flags.
2236 </para></listitem></varlistentry>
2237
2238 <varlistentry>
2239 <term>--disable-mdc</term>
2240 <listitem><para>
2241 Disable the use of the modification detection code.  Note that by
2242 using this option, the encrypted message becomes vulnerable to a
2243 message modification attack.
2244 </para></listitem></varlistentry>
2245
2246 <varlistentry>
2247 <term>--allow-non-selfsigned-uid</term>
2248 <term>--no-allow-non-selfsigned-uid</term>
2249 <listitem><para>
2250 Allow the import and use of keys with user IDs which are not
2251 self-signed.  This is not recommended, as a non self-signed user ID is
2252 trivial to forge.  --no-allow-non-selfsigned-uid disables.
2253 </para></listitem></varlistentry>
2254
2255 <varlistentry>
2256 <term>--allow-freeform-uid</term>
2257 <listitem><para>
2258 Disable all checks on the form of the user ID while generating a new
2259 one.  This option should only be used in very special environments as
2260 it does not ensure the de-facto standard format of user IDs.
2261 </para></listitem></varlistentry>
2262
2263 <varlistentry>
2264 <term>--ignore-time-conflict</term>
2265 <listitem><para>
2266 GnuPG normally checks that the timestamps associated with keys and
2267 signatures have plausible values.  However, sometimes a signature
2268 seems to be older than the key due to clock problems.  This option
2269 makes these checks just a warning.  See also --ignore-valid-from for
2270 timestamp issues on subkeys.
2271 </para></listitem></varlistentry>
2272
2273 <varlistentry>
2274 <term>--ignore-valid-from</term>
2275 <listitem><para>
2276 GnuPG normally does not select and use subkeys created in the future.
2277 This option allows the use of such keys and thus exhibits the
2278 pre-1.0.7 behaviour.  You should not use this option unless you there
2279 is some clock problem.  See also --ignore-time-conflict for timestamp
2280 issues with signatures.
2281 </para></listitem></varlistentry>
2282
2283 <varlistentry>
2284 <term>--ignore-crc-error</term>
2285 <listitem><para>
2286 The ASCII armor used by OpenPGP is protected by a CRC checksum against
2287 transmission errors.  Occasionally the CRC gets mangled somewhere on
2288 the transmission channel but the actual content (which is protected by
2289 the OpenPGP protocol anyway) is still okay.  This option allows GnuPG
2290 to ignore CRC errors.
2291 </para></listitem></varlistentry>
2292
2293 <varlistentry>
2294 <term>--ignore-mdc-error</term>
2295 <listitem><para>
2296 This option changes a MDC integrity protection failure into a warning.
2297 This can be useful if a message is partially corrupt, but it is
2298 necessary to get as much data as possible out of the corrupt message.
2299 However, be aware that a MDC protection failure may also mean that the
2300 message was tampered with intentionally by an attacker.
2301 </para></listitem></varlistentry>
2302
2303 <varlistentry>
2304 <term>--lock-once</term>
2305 <listitem><para>
2306 Lock the databases the first time a lock is requested
2307 and do not release the lock until the process
2308 terminates.
2309 </para></listitem></varlistentry>
2310
2311 <varlistentry>
2312 <term>--lock-multiple</term>
2313 <listitem><para>
2314 Release the locks every time a lock is no longer
2315 needed. Use this to override a previous --lock-once
2316 from a config file.
2317 </para></listitem></varlistentry>
2318
2319 <varlistentry>
2320 <term>--lock-never</term>
2321 <listitem><para>
2322 Disable locking entirely.  This option should be used only in very
2323 special environments, where it can be assured that only one process
2324 is accessing those files.  A bootable floppy with a stand-alone
2325 encryption system will probably use this.  Improper usage of this
2326 option may lead to data and key corruption.
2327 </para></listitem></varlistentry>
2328
2329 <varlistentry>
2330 <term>--no-random-seed-file</term>
2331 <listitem><para>
2332 GnuPG uses a file to store its internal random pool over invocations.
2333 This makes random generation faster; however sometimes write operations
2334 are not desired.  This option can be used to achieve that with the cost of
2335 slower random generation.
2336 </para></listitem></varlistentry>
2337
2338 <varlistentry>
2339 <term>--no-verbose</term>
2340 <listitem><para>
2341 Reset verbose level to 0.
2342 </para></listitem></varlistentry>
2343
2344 <varlistentry>
2345 <term>--no-greeting</term>
2346 <listitem><para>
2347 Suppress the initial copyright message.
2348 </para></listitem></varlistentry>
2349
2350 <varlistentry>
2351 <term>--no-secmem-warning</term>
2352 <listitem><para>
2353 Suppress the warning about "using insecure memory".
2354 </para></listitem></varlistentry>
2355
2356 <varlistentry>
2357 <term>--no-permission-warning</term>
2358 <listitem><para>
2359 Suppress the warning about unsafe file and home directory (--homedir)
2360 permissions.  Note that the permission checks that GnuPG performs are
2361 not intended to be authoritative, but rather they simply warn about
2362 certain common permission problems.  Do not assume that the lack of a
2363 warning means that your system is secure.
2364 </para><para>
2365 Note that the warning for unsafe --homedir permissions cannot be
2366 supressed in the gpg.conf file, as this would allow an attacker to
2367 place an unsafe gpg.conf file in place, and use this file to supress
2368 warnings about itself.  The --homedir permissions warning may only be
2369 supressed on the command line.
2370 </para></listitem></varlistentry>
2371
2372 <varlistentry>
2373 <term>--no-mdc-warning</term>
2374 <listitem><para>
2375 Suppress the warning about missing MDC integrity protection.
2376 </para></listitem></varlistentry>
2377
2378
2379 <varlistentry>
2380 <term>--no-armor</term>
2381 <listitem><para>
2382 Assume the input data is not in ASCII armored format.
2383 </para></listitem></varlistentry>
2384
2385
2386 <varlistentry>
2387 <term>--no-default-keyring</term>
2388 <listitem><para>
2389 Do not add the default keyrings to the list of keyrings.  Note that
2390 GnuPG will not operate without any keyrings, so if you use this option
2391 and do not provide alternate keyrings via --keyring or
2392 --secret-keyring, then GnuPG will still use the default public or
2393 secret keyrings.
2394 </para></listitem></varlistentry>
2395
2396
2397 <varlistentry>
2398 <term>--skip-verify</term>
2399 <listitem><para>
2400 Skip the signature verification step.  This may be
2401 used to make the decryption faster if the signature
2402 verification is not needed.
2403 </para></listitem></varlistentry>
2404
2405
2406 <varlistentry>
2407 <term>--with-colons</term>
2408 <listitem><para>
2409 Print key listings delimited by colons.  Note that the output will be
2410 encoded in UTF-8 regardless of any --display-charset setting.  This
2411 format is useful when GnuPG is called from scripts and other programs
2412 as it is easily machine parsed.  The details of this format are
2413 documented in the file doc/DETAILS, which is included in the GnuPG
2414 source distribution.
2415 </para></listitem></varlistentry>
2416
2417
2418 <varlistentry>
2419 <term>--with-key-data</term>
2420 <listitem><para>
2421 Print key listings delimited by colons (like --with-colons) and print the public key data.
2422 </para></listitem></varlistentry>
2423
2424 <varlistentry>
2425 <term>--with-fingerprint</term>
2426 <listitem><para>
2427 Same as the command --fingerprint but changes only the format of the output
2428 and may be used together with another command.
2429 </para></listitem></varlistentry>
2430
2431 <varlistentry>
2432 <term>--fast-list-mode</term>
2433 <listitem><para>
2434 Changes the output of the list commands to work faster; this is achieved
2435 by leaving some parts empty.  Some applications don't need the user ID and
2436 the trust information given in the listings.  By using this options they
2437 can get a faster listing.  The exact behaviour of this option may change
2438 in future versions.
2439 </para></listitem></varlistentry>
2440
2441 <varlistentry>
2442 <term>--fixed-list-mode</term>
2443 <listitem><para>
2444 Do not merge primary user ID and primary key in --with-colon listing
2445 mode and print all timestamps as seconds since 1970-01-01.
2446 </para></listitem></varlistentry>
2447
2448 <varlistentry>
2449 <term>--list-only</term>
2450 <listitem><para>
2451 Changes the behaviour of some commands.  This is like --dry-run but
2452 different in some cases.  The semantic of this command may be extended in
2453 the future.  Currently it only skips the actual decryption pass and
2454 therefore enables a fast listing of the encryption keys.
2455 </para></listitem></varlistentry>
2456
2457 <varlistentry>
2458 <term>--no-literal</term>
2459 <listitem><para>
2460 This is not for normal use.  Use the source to see for what it might be useful.
2461 </para></listitem></varlistentry>
2462
2463 <varlistentry>
2464 <term>--set-filesize</term>
2465 <listitem><para>
2466 This is not for normal use.  Use the source to see for what it might be useful.
2467 </para></listitem></varlistentry>
2468
2469 <varlistentry>
2470 <term>--show-session-key</term>
2471 <listitem><para>
2472 Display the session key used for one message. See --override-session-key
2473 for the counterpart of this option.
2474 </para>
2475 <para>
2476 We think that Key Escrow is a Bad Thing; however the user should have
2477 the freedom to decide whether to go to prison or to reveal the content
2478 of one specific message without compromising all messages ever
2479 encrypted for one secret key. DON'T USE IT UNLESS YOU ARE REALLY
2480 FORCED TO DO SO.
2481 </para></listitem></varlistentry>
2482
2483 <varlistentry>
2484 <term>--override-session-key &ParmString; </term>
2485 <listitem><para>
2486 Don't use the public key but the session key &ParmString;.  The format of this
2487 string is the same as the one printed by --show-session-key.  This option
2488 is normally not used but comes handy in case someone forces you to reveal the
2489 content of an encrypted message; using this option you can do this without
2490 handing out the secret key.
2491 </para></listitem></varlistentry>
2492
2493 <varlistentry>
2494 <term>--ask-sig-expire</term>
2495 <term>--no-ask-sig-expire</term>
2496 <listitem><para>
2497 When making a data signature, prompt for an expiration time.  If this
2498 option is not specified, the expiration time is "never".
2499 --no-ask-sig-expire disables this option.
2500 </para></listitem></varlistentry>
2501
2502 <varlistentry>
2503 <term>--ask-cert-expire</term>
2504 <term>--no-ask-cert-expire</term>
2505 <listitem><para>
2506 When making a key signature, prompt for an expiration time.  If this
2507 option is not specified, the expiration time is "never".
2508 --no-ask-cert-expire disables this option.
2509 </para></listitem></varlistentry>
2510
2511 <varlistentry>
2512 <term>--expert</term>
2513 <term>--no-expert</term>
2514 <listitem><para>
2515 Allow the user to do certain nonsensical or "silly" things like
2516 signing an expired or revoked key, or certain potentially incompatible
2517 things like generating unusual key types.  This also disables certain
2518 warning messages about potentially incompatible actions.  As the name
2519 implies, this option is for experts only.  If you don't fully
2520 understand the implications of what it allows you to do, leave this
2521 off.  --no-expert disables this option.
2522 </para></listitem></varlistentry>
2523
2524 <varlistentry>
2525 <term>--allow-secret-key-import</term>
2526 <listitem><para>
2527 This is an obsolete option and is not used anywhere.
2528 </para></listitem></varlistentry>
2529
2530 <varlistentry>
2531 <term>--try-all-secrets</term>
2532 <listitem><para>
2533 Don't look at the key ID as stored in the message but try all secret
2534 keys in turn to find the right decryption key. This option forces the
2535 behaviour as used by anonymous recipients (created by using
2536 --throw-keyids) and might come handy in case where an encrypted
2537 message contains a bogus key ID.
2538 </para></listitem></varlistentry>
2539
2540 <varlistentry>
2541 <term>--enable-special-filenames</term>
2542 <listitem><para>
2543 This options enables a mode in which filenames of the form
2544 <filename>-&#38;n</filename>, where n is a non-negative decimal number,
2545 refer to the file descriptor n and not to a file with that name.
2546 </para></listitem></varlistentry>
2547
2548 <varlistentry>
2549 <term>--no-expensive-trust-checks</term>
2550 <listitem><para>
2551 Experimental use only.
2552 </para></listitem></varlistentry>
2553
2554 <varlistentry>
2555 <term>--group &ParmNameValues;</term>
2556 <listitem><para>
2557 Sets up a named group, which is similar to aliases in email programs.
2558 Any time the group name is a recipient (-r or --recipient), it will be
2559 expanded to the values specified.  Multiple groups with the same name
2560 are automatically merged into a single group.
2561 </para><para>
2562 The values are &ParmKeyIDs; or fingerprints, but any key description
2563 is accepted.  Note that a value with spaces in it will be treated as
2564 two different values.  Note also there is only one level of expansion
2565 - you cannot make an group that points to another group.  When used
2566 from the command line, it may be necessary to quote the argument to
2567 this option to prevent the shell from treating it as multiple
2568 arguments.
2569 </para></listitem></varlistentry>
2570
2571 <varlistentry>
2572 <term>--ungroup &ParmName;</term>
2573 <listitem><para>
2574 Remove a given entry from the --group list.
2575 </para></listitem></varlistentry>
2576
2577 <varlistentry>
2578 <term>--no-groups</term>
2579 <listitem><para>
2580 Remove all entries from the --group list.
2581 </para></listitem></varlistentry>
2582
2583 <varlistentry>
2584 <term>--preserve-permissions</term>
2585 <listitem><para>
2586 Don't change the permissions of a secret keyring back to user
2587 read/write only.  Use this option only if you really know what you are doing.
2588 </para></listitem></varlistentry>
2589
2590 <varlistentry>
2591 <term>--personal-cipher-preferences &ParmString;</term>
2592 <listitem><para>
2593 Set the list of personal cipher preferences to &ParmString;, this list
2594 should be a string similar to the one printed by the command "pref" in
2595 the edit menu.  This allows the user to factor in their own preferred
2596 algorithms when algorithms are chosen via recipient key preferences.
2597 The most highly ranked cipher in this list is also used for the
2598 --symmetric encryption command.
2599 </para></listitem></varlistentry>
2600
2601 <varlistentry>
2602 <term>--personal-digest-preferences &ParmString;</term>
2603 <listitem><para>
2604 Set the list of personal digest preferences to &ParmString;, this list
2605 should be a string similar to the one printed by the command "pref" in
2606 the edit menu.  This allows the user to factor in their own preferred
2607 algorithms when algorithms are chosen via recipient key preferences.
2608 The most highly ranked digest algorithm in this list is algo used when
2609 signing without encryption (e.g. --clearsign or --sign).  The default
2610 value is SHA-1.
2611 </para></listitem></varlistentry>
2612
2613 <varlistentry>
2614 <term>--personal-compress-preferences &ParmString;</term>
2615 <listitem><para>
2616 Set the list of personal compression preferences to &ParmString;, this
2617 list should be a string similar to the one printed by the command
2618 "pref" in the edit menu.  This allows the user to factor in their own
2619 preferred algorithms when algorithms are chosen via recipient key
2620 preferences.  The most highly ranked algorithm in this list is also
2621 used when there are no recipient keys to consider (e.g. --symmetric).
2622 </para></listitem></varlistentry>
2623
2624 <varlistentry>
2625 <term>--default-preference-list &ParmString;</term>
2626 <listitem><para>
2627 Set the list of default preferences to &ParmString;, this list should
2628 be a string similar to the one printed by the command "pref" in the
2629 edit menu.  This affects both key generation and "updpref" in the edit
2630 menu.
2631 </para></listitem></varlistentry>
2632
2633 <varlistentry>
2634 <term>--list-config &OptParmNames;</term>
2635 <listitem><para>
2636 Display various internal configuration parameters of GnuPG.  This
2637 option is intended for external programs that call GnuPG to perform
2638 tasks, and is thus not generally useful.  See the file
2639 <filename>doc/DETAILS</filename> in the source distribution for the
2640 details of which configuration items may be listed.  --list-config is
2641 only usable with --with-colons set.
2642 </para></listitem></varlistentry>
2643
2644 </variablelist>
2645 </refsect1>
2646
2647
2648 <refsect1>
2649     <title>How to specify a user ID</title>
2650     <para>
2651 There are different ways to specify a user ID to GnuPG; here are some
2652 examples:
2653     </para>
2654
2655     <variablelist>
2656 <varlistentry>
2657 <term></term>
2658 <listitem><para></para></listitem>
2659 </varlistentry>
2660
2661 <varlistentry>
2662 <term>234567C4</term>
2663 <term>0F34E556E</term>
2664 <term>01347A56A</term>
2665 <term>0xAB123456</term>
2666 <listitem><para>
2667 Here the key ID is given in the usual short form.
2668 </para></listitem>
2669 </varlistentry>
2670
2671 <varlistentry>
2672 <term>234AABBCC34567C4</term>
2673 <term>0F323456784E56EAB</term>
2674 <term>01AB3FED1347A5612</term>
2675 <term>0x234AABBCC34567C4</term>
2676 <listitem><para>
2677 Here the key ID is given in the long form as used by OpenPGP
2678 (you can get the long key ID using the option --with-colons).
2679 </para></listitem>
2680 </varlistentry>
2681
2682 <varlistentry>
2683 <term>1234343434343434C434343434343434</term>
2684 <term>123434343434343C3434343434343734349A3434</term>
2685 <term>0E12343434343434343434EAB3484343434343434</term>
2686 <term>0xE12343434343434343434EAB3484343434343434</term>
2687 <listitem><para>
2688 The best way to specify a key ID is by using the fingerprint of
2689 the key.  This avoids any ambiguities in case that there are duplicated
2690 key IDs (which are really rare for the long key IDs).
2691 </para></listitem>
2692 </varlistentry>
2693
2694 <varlistentry>
2695 <term>=Heinrich Heine &#60;heinrichh@uni-duesseldorf.de&#62;</term>
2696 <listitem><para>
2697 Using an exact to match string.  The equal sign indicates this.
2698 </para></listitem>
2699 </varlistentry>
2700
2701 <varlistentry>
2702 <term>&#60;heinrichh@uni-duesseldorf.de&#62;</term>
2703 <listitem><para>
2704 Using the email address part which must match exactly.  The left angle bracket
2705 indicates this email address mode.
2706 </para></listitem>
2707 </varlistentry>
2708
2709 <varlistentry>
2710 <term>+Heinrich Heine duesseldorf</term>
2711 <listitem><para>
2712 All words must match exactly (not case sensitive) but can appear in
2713 any order in the user ID.  Words are any sequences of letters,
2714 digits, the underscore and all characters with bit 7 set.
2715 </para></listitem>
2716 </varlistentry>
2717
2718 <varlistentry>
2719 <term>Heine</term>
2720 <term>*Heine</term>
2721 <listitem><para>
2722 By case insensitive substring matching.  This is the default mode but
2723 applications may want to explicitly indicate this by putting the asterisk
2724 in front.
2725 </para></listitem>
2726 </varlistentry>
2727
2728     </variablelist>
2729
2730     <para>
2731 Note that you can append an exclamation mark (!) to key IDs or
2732 fingerprints.  This flag tells GnuPG to use the specified primary or
2733 secondary key and not to try and calculate which primary or secondary
2734 key to use.
2735     </para>
2736
2737 </refsect1>
2738
2739
2740 <refsect1>
2741     <title>RETURN VALUE</title>
2742     <para>
2743 The program returns 0 if everything was fine, 1 if at least
2744 a signature was bad, and other error codes for fatal errors.
2745     </para>
2746 </refsect1>
2747
2748 <refsect1>
2749     <title>EXAMPLES</title>
2750     <variablelist>
2751
2752 <varlistentry>
2753 <term>gpg -se -r <parameter/Bob/ &ParmFile;</term>
2754 <listitem><para>sign and encrypt for user Bob</para></listitem>
2755 </varlistentry>
2756
2757 <varlistentry>
2758 <term>gpg --clearsign &ParmFile;</term>
2759 <listitem><para>make a clear text signature</para></listitem>
2760 </varlistentry>
2761
2762 <varlistentry>
2763 <term>gpg -sb  &ParmFile;</term>
2764 <listitem><para>make a detached signature</para></listitem>
2765 </varlistentry>
2766
2767 <varlistentry>
2768 <term>gpg --list-keys  <parameter/user_ID/</term>
2769 <listitem><para>show keys</para></listitem>
2770 </varlistentry>
2771
2772 <varlistentry>
2773 <term>gpg --fingerprint  <parameter/user_ID/</term>
2774 <listitem><para>show fingerprint</para></listitem>
2775 </varlistentry>
2776
2777 <varlistentry>
2778 <term>gpg --verify  <parameter/pgpfile/</term>
2779 <term>gpg --verify  <parameter/sigfile/ &OptParmFiles;</term>
2780 <listitem><para>
2781 Verify the signature of the file but do not output the data. The
2782 second form is used for detached signatures, where <parameter/sigfile/
2783 is the detached signature (either ASCII armored or binary) and
2784 &OptParmFiles; are the signed data; if this is not given, the name of
2785 the file holding the signed data is constructed by cutting off the
2786 extension (".asc" or ".sig") of <parameter/sigfile/ or by asking the
2787 user for the filename.
2788 </para></listitem></varlistentry>
2789
2790     </variablelist>
2791 </refsect1>
2792
2793
2794 <refsect1>
2795     <title>ENVIRONMENT</title>
2796
2797     <variablelist>
2798 <varlistentry>
2799 <term>HOME</term>
2800 <listitem><para>Used to locate the default home directory.</para></listitem>
2801 </varlistentry>
2802 <varlistentry>
2803 <term>GNUPGHOME</term>
2804 <listitem><para>If set directory used instead of "~/.gnupg".</para></listitem>
2805 </varlistentry>
2806 <varlistentry>
2807 <term>GPG_AGENT_INFO</term>
2808 <listitem><para>Used to locate the gpg-agent; only honored when
2809 --use-agent is set.  The value consists of 3 colon delimited fields: 
2810 The first is the path to the Unix Domain Socket, the second the PID of
2811 the gpg-agent and the protocol version which should be set to 1.  When
2812 starting the gpg-agent as described in its documentation, this
2813 variable is set to the correct value.  The option --gpg-agent-info can
2814 be used to override it.</para></listitem>
2815 </varlistentry>
2816 <varlistentry>
2817 <term>http_proxy</term>
2818 <listitem><para>Only honored when the keyserver-option
2819 honor-http-proxy is set.</para></listitem>
2820 </varlistentry>
2821
2822 <varlistentry>
2823 <term>COLUMNS</term>
2824 <term>LINES</term>
2825 <listitem><para>
2826 Used to size some displays to the full size of the screen.
2827 </para></listitem></varlistentry>
2828
2829     </variablelist>
2830
2831 </refsect1>
2832
2833 <refsect1>
2834     <title>FILES</title>
2835     <variablelist>
2836
2837 <varlistentry>
2838 <term>~/.gnupg/secring.gpg</term>
2839 <listitem><para>The secret keyring</para></listitem>
2840 </varlistentry>
2841
2842 <varlistentry>
2843 <term>~/.gnupg/secring.gpg.lock</term>
2844 <listitem><para>and the lock file</para></listitem>
2845 </varlistentry>
2846
2847 <varlistentry>
2848 <term>~/.gnupg/pubring.gpg</term>
2849 <listitem><para>The public keyring</para></listitem>
2850 </varlistentry>
2851
2852 <varlistentry>
2853 <term>~/.gnupg/pubring.gpg.lock</term>
2854 <listitem><para>and the lock file</para></listitem>
2855 </varlistentry>
2856
2857 <varlistentry>
2858 <term>~/.gnupg/trustdb.gpg</term>
2859 <listitem><para>The trust database</para></listitem>
2860 </varlistentry>
2861
2862 <varlistentry>
2863 <term>~/.gnupg/trustdb.gpg.lock</term>
2864 <listitem><para>and the lock file</para></listitem>
2865 </varlistentry>
2866
2867 <varlistentry>
2868 <term>~/.gnupg/random_seed</term>
2869 <listitem><para>used to preserve the internal random pool</para></listitem>
2870 </varlistentry>
2871
2872 <varlistentry>
2873 <term>~/.gnupg/gpg.conf</term>
2874 <listitem><para>Default configuration file</para></listitem>
2875 </varlistentry>
2876
2877 <varlistentry>
2878 <term>~/.gnupg/options</term>
2879 <listitem><para>Old style configuration file; only used when gpg.conf
2880 is not found</para></listitem>
2881 </varlistentry>
2882
2883 <varlistentry>
2884 <term>/usr[/local]/share/gnupg/options.skel</term>
2885 <listitem><para>Skeleton options file</para></listitem>
2886 </varlistentry>
2887
2888 <varlistentry>
2889 <term>/usr[/local]/lib/gnupg/</term>
2890 <listitem><para>Default location for extensions</para></listitem>
2891 </varlistentry>
2892
2893     </variablelist>
2894 </refsect1>
2895
2896 <!-- SEE ALSO  not yet needed-->
2897
2898 <refsect1>
2899     <title>WARNINGS</title>
2900     <para>
2901 Use a *good* password for your user account and a *good* passphrase
2902 to protect your secret key.  This passphrase is the weakest part of the
2903 whole system.  Programs to do dictionary attacks on your secret keyring
2904 are very easy to write and so you should protect your "~/.gnupg/"
2905 directory very well.
2906 </para>
2907 <para>
2908 Keep in mind that, if this program is used over a network (telnet), it
2909 is *very* easy to spy out your passphrase!
2910 </para>
2911 <para>
2912 If you are going to verify detached signatures, make sure that the
2913 program knows about it; either give both filenames on the command line
2914 or use <literal>-</literal> to specify stdin.
2915 </para>
2916 </refsect1>
2917
2918 <refsect1>
2919     <title>INTEROPERABILITY WITH OTHER OPENPGP PROGRAMS</title>
2920 <para>
2921 GnuPG tries to be a very flexible implementation of the OpenPGP
2922 standard.  In particular, GnuPG implements many of the optional parts
2923 of the standard, such as the SHA-512 hash, and the ZLIB and BZIP2
2924 compression algorithms.  It is important to be aware that not all
2925 OpenPGP programs implement these optional algorithms and that by
2926 forcing their use via the --cipher-algo, --digest-algo,
2927 --cert-digest-algo, or --compress-algo options in GnuPG, it is
2928 possible to create a perfectly valid OpenPGP message, but one that
2929 cannot be read by the intended recipient.
2930 </para>
2931
2932 <para>
2933 There are dozens of variations of OpenPGP programs available, and each
2934 supports a slightly different subset of these optional algorithms.
2935 For example, until recently, no (unhacked) version of PGP supported
2936 the BLOWFISH cipher algorithm.  A message using BLOWFISH simply could
2937 not be read by a PGP user.  By default, GnuPG uses the standard
2938 OpenPGP preferences system that will always do the right thing and
2939 create messages that are usable by all recipients, regardless of which
2940 OpenPGP program they use.  Only override this safe default if you
2941 really know what you are doing.
2942 </para>
2943
2944 <para>
2945 If you absolutely must override the safe default, or if the
2946 preferences on a given key are invalid for some reason, you are far
2947 better off using the --pgp6, --pgp7, or --pgp8 options.  These options
2948 are safe as they do not force any particular algorithms in violation
2949 of OpenPGP, but rather reduce the available algorithms to a "PGP-safe"
2950 list.
2951 </para>
2952
2953 </refsect1>
2954
2955
2956 <refsect1>
2957     <title>BUGS</title>
2958     <para>
2959 On many systems this program should be installed as setuid(root). This
2960 is necessary to lock memory pages.  Locking memory pages prevents the
2961 operating system from writing memory pages (which may contain
2962 passphrases or other sensitive material) to disk.  If you get no
2963 warning message about insecure memory your operating system supports
2964 locking without being root.  The program drops root privileges as soon
2965 as locked memory is allocated.
2966 </para>
2967 </refsect1>
2968
2969 </refentry>