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