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