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