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