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