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