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