* gpg.sgml: Use "keyserver-url" instead of "preferred-keyserver" for the
[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 <varlistentry>
789 <term>--mangle-dos-filenames</term>
790 <term>--no-mangle-dos-filenames</term>
791 <listitem><para>
792 The Windows version of GnuPG replaces the extension of an output
793 filename to avoid problems with filenames containing more than one
794 dot.  This is not necessary for newer Windows versions and so
795 --no-mangle-dos-filenames can be used to switch this feature off and
796 have GnuPG append the new extension.  This option has no effect on
797 non-Windows platforms.
798 </para></listitem></varlistentry>
799
800
801 <varlistentry>
802 <term>-u, --local-user &ParmName;</term>
803 <listitem><para>
804 Use &ParmName as the user ID to sign.
805 This option is silently ignored for the list commands,
806 so that it can be used in an options file.
807 </para></listitem></varlistentry>
808
809
810 <varlistentry>
811 <term>--default-key &ParmName;</term>
812 <listitem><para>
813 Use &ParmName; as default user ID for signatures.  If this
814 is not used the default user ID is the first user ID
815 found in the secret keyring.
816 </para></listitem></varlistentry>
817
818
819 <varlistentry>
820 <term>-r, --recipient &ParmName;</term>
821 <term></term>
822 <listitem><para>
823 Encrypt for user id &ParmName;. If this option or --hidden-recipient
824 is not specified, GnuPG asks for the user-id unless
825 --default-recipient is given.
826 </para></listitem></varlistentry>
827
828 <varlistentry>
829 <term>-R, --hidden-recipient &ParmName;</term>
830 <term></term>
831 <listitem><para>
832 Encrypt for user id &ParmName;, but hide the keyid of the key.  This
833 option hides the receiver of the message and is a countermeasure
834 against traffic analysis.  If this option or --recipient is not
835 specified, GnuPG asks for the user-id unless --default-recipient is
836 given.
837 </para></listitem></varlistentry>
838
839 <varlistentry>
840 <term>--default-recipient &ParmName;</term>
841 <listitem><para>
842 Use &ParmName; as default recipient if option --recipient is not used and
843 don't ask if this is a valid one. &ParmName; must be non-empty.
844 </para></listitem></varlistentry>
845
846 <varlistentry>
847 <term>--default-recipient-self</term>
848 <listitem><para>
849 Use the default key as default recipient if option --recipient is not used and
850 don't ask if this is a valid one. The default key is the first one from the
851 secret keyring or the one set with --default-key.
852 </para></listitem></varlistentry>
853
854
855 <varlistentry>
856 <term>--no-default-recipient</term>
857 <listitem><para>
858 Reset --default-recipient and --default-recipient-self.
859 </para></listitem></varlistentry>
860
861 <varlistentry>
862 <term>--encrypt-to &ParmName;</term>
863 <listitem><para>
864 Same as --recipient but this one is intended for use
865 in the options file and may be used with
866 your own user-id as an "encrypt-to-self".  These keys
867 are only used when there are other recipients given
868 either by use of --recipient or by the asked user id.
869 No trust checking is performed for these user ids and
870 even disabled keys can be used.
871 </para></listitem></varlistentry>
872
873 <varlistentry>
874 <term>--hidden-encrypt-to &ParmName;</term>
875 <listitem><para>
876 Same as --hidden-recipient but this one is intended for use in the
877 options file and may be used with your own user-id as a hidden
878 "encrypt-to-self".  These keys are only used when there are other
879 recipients given either by use of --recipient or by the asked user id.
880 No trust checking is performed for these user ids and even disabled
881 keys can be used.
882 </para></listitem></varlistentry>
883
884 <varlistentry>
885 <term>--no-encrypt-to</term>
886 <listitem><para>
887 Disable the use of all --encrypt-to and --hidden-encrypt-to keys.
888 </para></listitem></varlistentry>
889
890
891 <varlistentry>
892 <term>-v, --verbose</term>
893 <listitem><para>
894 Give more information during processing. If used
895 twice, the input data is listed in detail.
896 </para></listitem></varlistentry>
897
898
899 <varlistentry>
900 <term>-q, --quiet</term>
901 <listitem><para>
902 Try to be as quiet as possible.
903 </para></listitem></varlistentry>
904
905
906 <varlistentry>
907 <term>-z &ParmN;, --compress &ParmN;</term>
908 <listitem><para>
909 Set compression level to &ParmN;. A value of 0 for &ParmN;
910 disables compression. Default is to use the default
911 compression level of zlib (normally 6).
912 </para></listitem></varlistentry>
913
914
915 <varlistentry>
916 <term>-t, --textmode</term>
917 <term>--no-textmode</term>
918 <listitem><para>
919 Use canonical text mode.  --no-textmode disables this option.  If -t
920 (but not --textmode) is used together with armoring and signing, this
921 enables clearsigned messages.  This kludge is needed for command-line
922 compatibility with command-line versions of PGP; normally you would
923 use --sign or --clearsign to select the type of the signature.
924 </para></listitem></varlistentry>
925
926
927 <varlistentry>
928 <term>-n, --dry-run</term>
929 <listitem><para>
930 Don't make any changes (this is not completely implemented).
931 </para></listitem></varlistentry>
932
933
934 <varlistentry>
935 <term>-i, --interactive</term>
936 <listitem><para>
937 Prompt before overwriting any files.
938 </para></listitem></varlistentry>
939
940
941 <varlistentry>
942 <term>--batch</term>
943 <term>--no-batch</term>
944 <listitem><para>
945 Use batch mode.  Never ask, do not allow interactive commands.
946 --no-batch disables this option.
947 </para></listitem></varlistentry>
948
949
950 <varlistentry>
951 <term>--no-tty</term>
952 <listitem><para>
953 Make sure that the TTY (terminal) is never used for any output.
954 This option is needed in some cases because GnuPG sometimes prints
955 warnings to the TTY if --batch is used.
956 </para></listitem></varlistentry>
957
958
959 <varlistentry>
960 <term>--yes</term>
961 <listitem><para>
962 Assume "yes" on most questions.
963 </para></listitem></varlistentry>
964
965
966 <varlistentry>
967 <term>--no</term>
968 <listitem><para>
969  Assume "no" on most questions.
970 </para></listitem></varlistentry>
971
972 <varlistentry>
973 <term>--default-cert-check-level &ParmN;</term>
974 <listitem><para>
975 The default to use for the check level when signing a key.
976 </para><para>
977 0 means you make no particular claim as to how carefully you verified
978 the key.
979 </para><para>
980 1 means you believe the key is owned by the person who claims to own
981 it but you could not, or did not verify the key at all.  This is
982 useful for a "persona" verification, where you sign the key of a
983 pseudonymous user.
984 </para><para>
985 2 means you did casual verification of the key.  For example, this
986 could mean that you verified that the key fingerprint and checked the
987 user ID on the key against a photo ID.
988 </para><para>
989 3 means you did extensive verification of the key.  For example, this
990 could mean that you verified the key fingerprint with the owner of the
991 key in person, and that you checked, by means of a hard to forge
992 document with a photo ID (such as a passport) that the name of the key
993 owner matches the name in the user ID on the key, and finally that you
994 verified (by exchange of email) that the email address on the key
995 belongs to the key owner.
996 </para><para>
997 Note that the examples given above for levels 2 and 3 are just that:
998 examples.  In the end, it is up to you to decide just what "casual"
999 and "extensive" mean to you.
1000 </para><para>
1001 This option defaults to 0.
1002 </para></listitem></varlistentry>
1003
1004
1005
1006 <varlistentry>
1007 <term>--trusted-key <parameter>long key ID</parameter></term>
1008 <listitem><para>
1009 Assume that the specified key (which must be given
1010 as a  full 8 byte key ID) is as trustworthy as one of
1011 your own secret keys. This option is useful if you
1012 don't want to keep your secret keys (or one of them)
1013 online but still want to be able to check the validity of a given
1014 recipient's or signator's key. 
1015 </para></listitem></varlistentry>
1016
1017 <varlistentry>
1018 <term>--trust-model <parameter>pgp|classic|always</parameter></term>
1019 <listitem><para>
1020
1021 Set what trust model GnuPG should follow.  The models are:
1022
1023 <variablelist>
1024
1025 <varlistentry><term>pgp</term><listitem><para>
1026 This is the web-of-trust combined with trust signatures as used in PGP
1027 5.x and later.  This is the default trust model.
1028 </para></listitem></varlistentry>
1029
1030 <varlistentry><term>classic</term><listitem><para>
1031 This is the standard web-of-trust as used in PGP 2.x and earlier.
1032 </para></listitem></varlistentry>
1033
1034 <varlistentry><term>always</term><listitem><para>
1035 Skip key validation and assume that used keys are always fully
1036 trusted.  You won't use this unless you have installed some external
1037 validation scheme.  This option also suppresses the "[uncertain]" tag
1038 printed with signature checks when there is no evidence that the user
1039 ID is bound to the key.
1040 </para></listitem></varlistentry>
1041
1042 </variablelist></para></listitem></varlistentry>
1043
1044 <varlistentry>
1045 <term>--always-trust</term>
1046 <listitem><para>
1047 Identical to `--trust-model always'
1048 </para></listitem></varlistentry>
1049
1050
1051 <varlistentry>
1052 <term>--keyserver &ParmName;</term>
1053 <listitem><para>
1054 Use &ParmName as your keyserver.  This is the server that --recv-keys,
1055 --send-keys, and --search-keys will communicate with to receive keys
1056 from, send keys to, and search for keys on.  The format of the
1057 &ParmName is a URI: `scheme:[//]keyservername[:port]' The scheme is
1058 the type of keyserver: "hkp" for the Horowitz (or compatible)
1059 keyservers, "ldap" for the NAI LDAP keyserver, or "mailto" for the
1060 Horowitz email keyserver.  Note that your particular installation of
1061 GnuPG may have other keyserver types available as well.  Keyserver
1062 schemes are case-insensitive.
1063 </para><para>
1064 Most keyservers synchronize with each other, so there is generally no
1065 need to send keys to more than one server.  Using the command "host -l
1066 pgp.net | grep wwwkeys" gives you a list of HKP keyservers.  When
1067 using one of the wwwkeys servers, due to load balancing using
1068 round-robin DNS you may notice that you get a different key server
1069 each time.
1070 </para></listitem></varlistentry>
1071
1072 <varlistentry>
1073 <term>--keyserver-options <parameter>parameters</parameter></term>
1074 <listitem><para>
1075 This is a space or comma delimited string that gives options for the
1076 keyserver.  Options can be prepended with a `no-' to give the opposite
1077 meaning.  Valid import-options or export-options may be used here as
1078 well to apply to importing (--recv-key) or exporting (--send-key) a
1079 key from a keyserver.  While not all options are available for all
1080 keyserver types, some common options are:
1081 <variablelist>
1082
1083 <varlistentry>
1084 <term>include-revoked</term>
1085 <listitem><para>
1086 When searching for a key with --search-keys, include keys that are
1087 marked on the keyserver as revoked.  Note that this option is always
1088 set when using the NAI HKP keyserver, as this keyserver does not
1089 differentiate between revoked and unrevoked keys.
1090 </para></listitem></varlistentry>
1091
1092 <varlistentry>
1093 <term>include-disabled</term>
1094 <listitem><para>
1095 When searching for a key with --search-keys, include keys that are
1096 marked on the keyserver as disabled.  Note that this option is not
1097 used with HKP keyservers.
1098 </para></listitem></varlistentry>
1099
1100 <varlistentry>
1101 <term>include-subkeys</term>
1102 <listitem><para>
1103 When receiving a key, include subkeys as potential targets.  Note that
1104 this option is not used with HKP keyservers, as they do not support
1105 retrieving keys by subkey id.
1106 </para></listitem></varlistentry>
1107
1108 <varlistentry>
1109 <term>use-temp-files</term>
1110 <listitem><para>
1111 On most Unix-like platforms, GnuPG communicates with the keyserver
1112 helper program via pipes, which is the most efficient method.  This
1113 option forces GnuPG to use temporary files to communicate.  On some
1114 platforms (such as Win32 and RISC OS), this option is always enabled.
1115 </para></listitem></varlistentry>
1116
1117 <varlistentry>
1118 <term>keep-temp-files</term>
1119 <listitem><para>
1120 If using `use-temp-files', do not delete the temp files after using
1121 them.  This option is useful to learn the keyserver communication
1122 protocol by reading the temporary files.
1123 </para></listitem></varlistentry>
1124
1125 <varlistentry>
1126 <term>verbose</term>
1127 <listitem><para>
1128 Tell the keyserver helper program to be more verbose.  This option can
1129 be repeated multiple times to increase the verbosity level.
1130 </para></listitem></varlistentry>
1131
1132 <varlistentry>
1133 <term>honor-http-proxy</term>
1134 <listitem><para>
1135 For keyserver schemes that use HTTP (such as HKP), try to access the
1136 keyserver over the proxy set with the environment variable
1137 "http_proxy".
1138 </para></listitem></varlistentry>
1139
1140 <varlistentry>
1141 <term>auto-key-retrieve</term>
1142 <listitem><para>
1143 This option enables the automatic retrieving of keys from a keyserver
1144 when verifying signatures made by keys that are not on the local
1145 keyring.
1146 </para></listitem></varlistentry>
1147
1148 </variablelist>
1149 </para></listitem></varlistentry>
1150
1151 <varlistentry>
1152 <term>--import-options <parameter>parameters</parameter></term>
1153 <listitem><para>
1154 This is a space or comma delimited string that gives options for
1155 importing keys.  Options can be prepended with a `no-' to give the
1156 opposite meaning.  The options are:
1157 <variablelist>
1158
1159 <varlistentry>
1160 <term>allow-local-sigs</term>
1161 <listitem><para>
1162 Allow importing key signatures marked as "local".  This is not
1163 generally useful unless a shared keyring scheme is being used.
1164 Defaults to no.
1165 </para></listitem></varlistentry>
1166
1167 <varlistentry>
1168 <term>repair-pks-subkey-bug</term>
1169 <listitem><para>
1170 During import, attempt to repair the damage caused by the PKS
1171 keyserver bug (pre version 0.9.6) that mangles keys with multiple
1172 subkeys.  Note that this cannot completely repair the damaged key as
1173 some crucial data is removed by the keyserver, but it does at least
1174 give you back one subkey.  Defaults to no for regular --import and to
1175 yes for keyserver --recv-keys.
1176 </para></listitem></varlistentry>
1177
1178 </variablelist>
1179 </para></listitem></varlistentry>
1180
1181 <varlistentry>
1182 <term>--export-options <parameter>parameters</parameter></term>
1183 <listitem><para>
1184 This is a space or comma delimited string that gives options for
1185 exporting keys.  Options can be prepended with a `no-' to give the
1186 opposite meaning.  The options are:
1187 <variablelist>
1188
1189 <varlistentry>
1190 <term>include-non-rfc</term>
1191 <listitem><para>
1192 Include non-RFC compliant keys in the export.  Defaults to yes.
1193 </para></listitem></varlistentry>
1194
1195 <varlistentry>
1196 <term>include-local-sigs</term>
1197 <listitem><para>
1198 Allow exporting key signatures marked as "local".  This is not
1199 generally useful unless a shared keyring scheme is being used.
1200 Defaults to no.
1201 </para></listitem></varlistentry>
1202
1203 <varlistentry>
1204 <term>include-attributes</term>
1205 <listitem><para>
1206 Include attribute user IDs (photo IDs) while exporting.  This is
1207 useful to export keys if they are going to be used by an OpenPGP
1208 program that does not accept attribute user IDs.  Defaults to yes.
1209 </para></listitem></varlistentry>
1210
1211 <varlistentry>
1212 <term>include-sensitive-revkeys</term>
1213 <listitem><para>
1214 Include designated revoker information that was marked as
1215 "sensitive".  Defaults to no.
1216 </para></listitem></varlistentry>
1217
1218 </variablelist>
1219 </para></listitem></varlistentry>
1220
1221 <varlistentry>
1222 <term>--list-options <parameter>parameters</parameter></term>
1223 <listitem><para>
1224 This is a space or comma delimited string that gives options used when
1225 listing keys and signatures (that is, --list-keys, --list-sigs,
1226 --list-public-keys, --list-secret-keys, and the --edit-key functions).
1227 Options can be prepended with a `no-' to give the opposite meaning.
1228 The options are:
1229 <variablelist>
1230
1231 <varlistentry>
1232 <term>show-photos</term>
1233 <listitem><para>
1234 Causes --list-keys, --list-sigs, --list-public-keys, and
1235 --list-secret-keys to display any photo IDs attached to the key.
1236 Defaults to no.  See also --photo-viewer.
1237 </para></listitem></varlistentry>
1238
1239 <varlistentry>
1240 <term>show-policy-url</term>
1241 <listitem><para>
1242 Show policy URLs in the --list-sigs or --check-sigs listings.
1243 Defaults to no.
1244 </para></listitem></varlistentry>
1245
1246 <varlistentry>
1247 <term>show-notation</term>
1248 <listitem><para>
1249 Show signature notations in the --list-sigs or --check-sigs listings.
1250 Defaults to no.
1251 </para></listitem></varlistentry>
1252
1253 <varlistentry>
1254 <term>show-keyserver-url</term>
1255 <listitem><para>
1256 Show any preferred keyserver URL in the --list-sigs or --check-sigs
1257 listings.  Defaults to no.
1258 </para></listitem></varlistentry>
1259
1260 <varlistentry>
1261 <term>show-validity</term>
1262 <listitem><para>
1263 Display the calculated validity of keys and user IDs during key
1264 listings.  Defaults to no.
1265 </para></listitem></varlistentry>
1266
1267 <varlistentry>
1268 <term>show-long-keyid</term>
1269 <listitem><para>
1270 Display all 64 bits (16 digits) of key IDs during key listings, rather
1271 than the more common 32 bit (8 digit) IDs.  Defaults to no.
1272 </para></listitem></varlistentry>
1273
1274 <varlistentry>
1275 <term>show-keyring</term>
1276 <listitem><para>
1277 Display the keyring name at the head of key listings to show which
1278 keyring a given key resides on.  Defaults to no.
1279 </para></listitem></varlistentry>
1280
1281 <varlistentry>
1282 <term>show-sig-expire</term>
1283 <listitem><para>
1284 Show signature expiration dates (if any) during --list-sigs or
1285 --check-sigs listings.  Defaults to no.
1286 </para></listitem></varlistentry>
1287
1288 </variablelist>
1289 </para></listitem></varlistentry>
1290
1291 <varlistentry>
1292 <term>--verify-options <parameter>parameters</parameter></term>
1293 <listitem><para>
1294 This is a space or comma delimited string that gives options used when
1295 verifying signatures.  Options can be prepended with a `no-' to give
1296 the opposite meaning.  The options are:
1297 <variablelist>
1298
1299 <varlistentry>
1300 <term>show-photos</term>
1301 <listitem><para>
1302 Display any photo IDs present on the key that issued the signature.
1303 Defaults to no.  See also --photo-viewer.
1304 </para></listitem></varlistentry>
1305
1306 <varlistentry>
1307 <term>show-policy-url</term>
1308 <listitem><para>
1309 Show policy URLs in the signature being verified.  Defaults to no.
1310 </para></listitem></varlistentry>
1311
1312 <varlistentry>
1313 <term>show-notation</term>
1314 <listitem><para>
1315 Show signature notations in the signature being verified.  Defaults to
1316 no.
1317 </para></listitem></varlistentry>
1318
1319 <varlistentry>
1320 <term>show-keyserver-url</term>
1321 <listitem><para>
1322 Show any preferred keyserver URL in the signature being verified.
1323 Defaults to no.
1324 </para></listitem></varlistentry>
1325
1326 <varlistentry>
1327 <term>show-validity</term>
1328 <listitem><para>
1329 Display the calculated validity of the user IDs on the key that issued
1330 the signature.  Defaults to no.
1331 </para></listitem></varlistentry>
1332
1333 <varlistentry>
1334 <term>show-long-keyid</term>
1335 <listitem><para>
1336 Display all 64 bits (16 digits) of key IDs during signature
1337 verification, rather than the more common 32 bit (8 digit) IDs.
1338 Defaults to no.
1339 </para></listitem></varlistentry>
1340
1341 </variablelist>
1342 </para></listitem></varlistentry>
1343
1344 <varlistentry>
1345 <term>--show-photos</term>
1346 <term>--no-show-photos</term>
1347 <listitem><para>
1348 Causes --list-keys, --list-sigs, --list-public-keys,
1349 --list-secret-keys, and verifying a signature to also display the
1350 photo ID attached to the key, if any.  See also --photo-viewer.  These
1351 options are deprecated.  Use `--list-options [no-]show-photos' and/or
1352 `--verify-options [no-]show-photos' instead.
1353 </para></listitem></varlistentry>
1354
1355 <varlistentry>
1356 <term>--photo-viewer &ParmString;</term>
1357 <listitem><para>
1358 This is the command line that should be run to view a photo ID.  "%i"
1359 will be expanded to a filename containing the photo.  "%I" does the
1360 same, except the file will not be deleted once the viewer exits.
1361 Other flags are "%k" for the key ID, "%K" for the long key ID, "%f"
1362 for the key fingerprint, "%t" for the extension of the image type
1363 (e.g. "jpg"), "%T" for the MIME type of the image (e.g. "image/jpeg"),
1364 and "%%" for an actual percent sign.  If neither %i or %I are present,
1365 then the photo will be supplied to the viewer on standard input.
1366 </para><para>
1367 The default viewer is "xloadimage -fork -quiet -title 'KeyID 0x%k'
1368 stdin".  Note that if your image viewer program is not secure, then
1369 executing it from GnuPG does not make it secure.
1370 </para></listitem></varlistentry>
1371
1372 <varlistentry>
1373 <term>--exec-path &ParmString;</term>
1374 <listitem><para>
1375 Sets a list of directories to search for photo viewers and keyserver
1376 helpers.  If not provided, keyserver helpers use the compiled-in
1377 default directory, and photo viewers use the $PATH environment
1378 variable.
1379 </para></listitem></varlistentry>
1380
1381 <varlistentry>
1382 <term>--show-keyring</term>
1383 <listitem><para>
1384 Display the keyring name at the head of key listings to show which
1385 keyring a given key resides on.  This option is deprecated: use
1386 `--list-options [no-]show-keyring' instead.
1387 </para></listitem></varlistentry>
1388
1389 <varlistentry>
1390 <term>--keyring &ParmFile;</term>
1391 <listitem><para>
1392 Add &ParmFile; to the list of keyrings.  If &ParmFile; begins with a
1393 tilde and a slash, these are replaced by the HOME directory. If the
1394 filename does not contain a slash, it is assumed to be in the GnuPG
1395 home directory ("~/.gnupg" if --homedir is not used).  The filename
1396 may be prefixed with a scheme:</para>
1397 <para>"gnupg-ring:" is the default one.</para>
1398 <para>It might make sense to use it together with --no-default-keyring.
1399 </para></listitem></varlistentry>
1400
1401
1402 <varlistentry>
1403 <term>--secret-keyring &ParmFile;</term>
1404 <listitem><para>
1405 Same as --keyring but for the secret keyrings.
1406 </para></listitem></varlistentry>
1407
1408 <varlistentry>
1409 <term>--primary-keyring &ParmFile;</term>
1410 <listitem><para>
1411 Designate &ParmFile; as the primary public keyring.  This means that
1412 newly imported keys (via --import or keyserver --recv-from) will go to
1413 this keyring.
1414 </para></listitem></varlistentry>
1415
1416 <varlistentry>
1417 <term>--trustdb-name &ParmFile;</term>
1418 <listitem><para>
1419
1420 Use &ParmFile; instead of the default trustdb.  If &ParmFile; begins
1421 with a tilde and a slash, these are replaced by the HOME directory. If
1422 the filename does not contain a slash, it is assumed to be in the
1423 GnuPG home directory ("~/.gnupg" if --homedir is not used).
1424
1425 </para></listitem></varlistentry>
1426
1427
1428 <varlistentry>
1429 <term>--homedir &ParmDir;</term>
1430 <listitem><para>
1431 Set the name of the home directory to &ParmDir; If this
1432 option is not used it defaults to "~/.gnupg". It does
1433 not make sense to use this in a options file. This
1434 also overrides the environment variable "GNUPGHOME".
1435 </para></listitem></varlistentry>
1436
1437
1438 <varlistentry>
1439 <term>--charset &ParmName;</term>
1440 <listitem><para>
1441 Set the name of the native character set.  This is used
1442 to convert some strings to proper UTF-8 encoding. If this option is not used, the default character set is determined
1443 from the current locale.  A verbosity level of 3 shows the used one.
1444 Valid values for &ParmName; are:</para>
1445 <variablelist>
1446 <varlistentry>
1447 <term>iso-8859-1</term><listitem><para>This is the Latin 1 set.</para></listitem>
1448 </varlistentry>
1449 <varlistentry>
1450 <term>iso-8859-2</term><listitem><para>The Latin 2 set.</para></listitem>
1451 </varlistentry>
1452 <varlistentry>
1453 <term>iso-8859-15</term><listitem><para>This is currently an alias for
1454 the Latin 1 set.</para></listitem>
1455 </varlistentry>
1456 <varlistentry>
1457 <term>koi8-r</term><listitem><para>The usual Russian set (rfc1489).</para></listitem>
1458 </varlistentry>
1459 <varlistentry>
1460 <term>utf-8</term><listitem><para>Bypass all translations and assume
1461 that the OS uses native UTF-8 encoding.</para></listitem>
1462 </varlistentry>
1463 </variablelist>
1464 </listitem></varlistentry>
1465
1466
1467 <varlistentry>
1468 <term>--utf8-strings</term>
1469 <term>--no-utf8-strings</term>
1470 <listitem><para>
1471 Assume that the arguments are already given as UTF8 strings.  The default
1472 (--no-utf8-strings)
1473 is to assume that arguments are encoded in the character set as specified
1474 by --charset. These options affect all following arguments.  Both options may
1475 be used multiple times.
1476 </para></listitem></varlistentry>
1477
1478
1479 <varlistentry>
1480 <term>--options &ParmFile;</term>
1481 <listitem><para>
1482 Read options from &ParmFile; and do not try to read
1483 them from the default options file in the homedir
1484 (see --homedir). This option is ignored if used
1485 in an options file.
1486 </para></listitem></varlistentry>
1487
1488
1489 <varlistentry>
1490 <term>--no-options</term>
1491 <listitem><para>
1492 Shortcut for "--options /dev/null".  This option is
1493 detected before an attempt to open an option file.
1494 Using this option will also prevent the creation of a 
1495 "~./gnupg" homedir.
1496 </para></listitem></varlistentry>
1497
1498
1499 <varlistentry>
1500 <term>--load-extension &ParmName;</term>
1501 <listitem><para>
1502 Load an extension module. If &ParmName; does not contain a slash it is
1503 searched for in the directory configured when GnuPG was built
1504 (generally "/usr/local/lib/gnupg").  Extensions are not generally
1505 useful anymore, and the use of this option is deprecated.
1506 </para></listitem></varlistentry>
1507
1508
1509 <varlistentry>
1510 <term>--debug &ParmFlags;</term>
1511 <listitem><para>
1512 Set debugging flags. All flags are or-ed and &ParmFlags; may
1513 be given in C syntax (e.g. 0x0042).
1514 </para></listitem></varlistentry>
1515
1516
1517 <varlistentry>
1518 <term>--debug-all</term>
1519 <listitem><para>
1520  Set all useful debugging flags.
1521 </para></listitem></varlistentry>
1522
1523
1524 <varlistentry>
1525 <term>--enable-progress-filter</term>
1526 <listitem><para>
1527 Enable certain PROGRESS status outputs.  This option allows frontends
1528 to display a progress indicator while gpg is processing larger files.
1529 There is a slight performance overhead using it.
1530 </para></listitem></varlistentry>
1531
1532
1533 <varlistentry>
1534 <term>--status-fd &ParmN;</term>
1535 <listitem><para>
1536 Write special status strings to the file descriptor &ParmN;.
1537 See the file DETAILS in the documentation for a listing of them.
1538 </para></listitem></varlistentry>
1539
1540
1541 <varlistentry>
1542 <term>--logger-fd &ParmN;</term>
1543 <listitem><para>
1544 Write log output to file descriptor &ParmN; and not to stderr.
1545 </para></listitem></varlistentry>
1546
1547
1548 <varlistentry>
1549 <term>--attribute-fd &ParmN;</term>
1550 <listitem><para>
1551 Write attribute subpackets to the file descriptor &ParmN;.  This is
1552 most useful for use with --status-fd, since the status messages are
1553 needed to separate out the various subpackets from the stream
1554 delivered to the file descriptor.
1555 </para></listitem></varlistentry>
1556
1557
1558 <varlistentry>
1559 <term>--sk-comments</term>
1560 <term>--no-sk-comments</term>
1561 <listitem><para>
1562 Include secret key comment packets when exporting secret keys.  This
1563 is a GnuPG extension to the OpenPGP standard, and is off by default.
1564 Please note that this has nothing to do with the comments in clear
1565 text signatures or armor headers.  --no-sk-comments disables this
1566 option.
1567 </para></listitem></varlistentry>
1568
1569
1570 <varlistentry>
1571 <term>--no-comment</term>
1572 <listitem><para>
1573 See --no-sk-comments.  This option is deprecated and may be removed
1574 soon.
1575 </para></listitem></varlistentry>
1576
1577
1578 <varlistentry>
1579 <term>--comment &ParmString;</term>
1580 <listitem><para>
1581 Use &ParmString; as the comment string in clear text signatures.  The
1582 default behavior is not to use a comment string.
1583 </para></listitem></varlistentry>
1584
1585
1586 <varlistentry>
1587 <term>--default-comment</term>
1588 <listitem><para>
1589 Force to write the standard comment string in clear
1590 text signatures.  Use this to overwrite a --comment
1591 from a config file.  This option is now obsolete because there is no
1592 default comment string anymore.
1593 </para></listitem></varlistentry>
1594
1595
1596 <varlistentry>
1597 <term>--emit-version</term>
1598 <term>--no-emit-version</term>
1599 <listitem><para>
1600 Force inclusion of the version string in ASCII armored output.
1601 --no-emit-version disables this option.
1602 </para></listitem></varlistentry>
1603
1604
1605 <varlistentry>
1606 <term>--sig-notation &ParmNameValue;</term>
1607 <term>--cert-notation &ParmNameValue;</term>
1608 <term>-N, --set-notation &ParmNameValue;</term>
1609 <listitem><para>
1610 Put the name value pair into the signature as notation data.
1611 &ParmName; must consist only of printable characters or spaces, and
1612 must contain a '@' character.  This is to help prevent pollution of
1613 the IETF reserved notation namespace.  The --expert flag overrides the
1614 '@' check.  &ParmValue; may be any printable string; it will be
1615 encoded in UTF8, so you should check that your --charset is set
1616 correctly.  If you prefix &ParmName; with an exclamation mark, the
1617 notation data will be flagged as critical (rfc2440:5.2.3.15).
1618 --sig-notation sets a notation for data signatures.  --cert-notation
1619 sets a notation for key signatures (certifications).  --set-notation
1620 sets both.
1621 </para>
1622
1623 <para>
1624 There are special codes that may be used in notation names.  "%k" will
1625 be expanded into the key ID of the key being signed, "%K" into the
1626 long key ID of the key being signed, "%f" into the fingerprint of the
1627 key being signed, "%s" into the key ID of the key making the
1628 signature, "%S" into the long key ID of the key making the signature,
1629 "%g" into the fingerprint of the key making the signature (which might
1630 be a subkey), "%p" into the fingerprint of the primary key of the key
1631 making the signature, and "%%" results in a single "%".  %k, %K, and
1632 %f are only meaningful when making a key signature (certification).
1633 </para>
1634
1635 </listitem></varlistentry>
1636
1637 <varlistentry>
1638 <term>--show-notation</term>
1639 <term>--no-show-notation</term>
1640 <listitem><para>
1641 Show signature notations in the --list-sigs or --check-sigs listings
1642 as well as when verifying a signature with a notation in it.  These
1643 options are deprecated.  Use `--list-options [no-]show-notation'
1644 and/or `--verify-options [no-]show-notation' instead.
1645 </para></listitem></varlistentry>
1646
1647
1648 <varlistentry>
1649 <term>--sig-policy-url &ParmString;</term>
1650 <term>--cert-policy-url &ParmString;</term>
1651 <term>--set-policy-url &ParmString;</term>
1652 <listitem><para>
1653 Use &ParmString; as Policy URL for signatures (rfc2440:5.2.3.19).  If
1654 you prefix it with an exclamation mark, the policy URL packet will be
1655 flagged as critical.  --sig-policy-url sets a a policy url for data
1656 signatures.  --cert-policy-url sets a policy url for key signatures
1657 (certifications).  --set-policy-url sets both.
1658 </para><para>
1659 The same %-expandos used for notation data are available here as well.
1660 </para></listitem></varlistentry>
1661
1662 <varlistentry>
1663 <term>--show-policy-url</term>
1664 <term>--no-show-policy-url</term>
1665 <listitem><para>
1666 Show policy URLs in the --list-sigs or --check-sigs listings as well
1667 as when verifying a signature with a policy URL in it.  These options
1668 are deprecated.  Use `--list-options [no-]show-policy-url' and/or
1669 `--verify-options [no-]show-policy-url' instead.
1670 </para></listitem></varlistentry>
1671
1672 <varlistentry>
1673 <term>--set-filename &ParmString;</term>
1674 <listitem><para>
1675 Use &ParmString; as the filename which is stored inside messages.
1676 This overrides the default, which is to use the actual filename of the
1677 file being encrypted.
1678 </para></listitem></varlistentry>
1679
1680 <varlistentry>
1681 <term>--for-your-eyes-only</term>
1682 <term>--no-for-your-eyes-only</term>
1683 <listitem><para>
1684 Set the `for your eyes only' flag in the message.  This causes GnuPG
1685 to refuse to save the file unless the --output option is given, and
1686 PGP to use the "secure viewer" with a Tempest-resistant font to
1687 display the message.  This option overrides --set-filename.
1688 --no-for-your-eyes-only disables this option.
1689 </para></listitem></varlistentry>
1690
1691 <varlistentry>
1692 <term>--use-embedded-filename</term>
1693 <listitem><para>
1694 Try to create a file with a name as embedded in the data.
1695 This can be a dangerous option as it allows to overwrite files.
1696 </para></listitem></varlistentry>
1697
1698
1699 <varlistentry>
1700 <term>--completes-needed &ParmN;</term>
1701 <listitem><para>
1702 Number of completely trusted users to introduce a new
1703 key signer (defaults to 1).
1704 </para></listitem></varlistentry>
1705
1706
1707 <varlistentry>
1708 <term>--marginals-needed &ParmN;</term>
1709 <listitem><para>
1710 Number of marginally trusted users to introduce a new
1711 key signer (defaults to 3)
1712 </para></listitem></varlistentry>
1713
1714
1715 <varlistentry>
1716 <term>--max-cert-depth &ParmN;</term>
1717 <listitem><para>
1718 Maximum depth of a certification chain (default is 5).
1719 </para></listitem></varlistentry>
1720
1721
1722 <varlistentry>
1723 <term>--cipher-algo &ParmName;</term>
1724 <listitem><para>
1725 Use  &ParmName; as cipher algorithm. Running the program
1726 with the command --version yields a list of supported
1727 algorithms. If this is not used the cipher algorithm is
1728 selected from the preferences stored with the key.
1729 </para></listitem></varlistentry>
1730
1731
1732 <varlistentry>
1733 <term>--digest-algo &ParmName;</term>
1734 <listitem><para>
1735 Use &ParmName; as the message digest algorithm. Running the program
1736 with the command --version yields a list of supported algorithms.
1737 </para></listitem></varlistentry>
1738
1739
1740 <varlistentry>
1741 <term>--compress-algo &ParmName;</term>
1742 <listitem><para>
1743 Use compression algorithm &ParmName;.  "zlib" is RFC1950 ZLIB
1744 compression.  "zip" is RFC-1951 ZIP compression which is used by PGP.
1745 "uncompressed" or "none" disables compression.  If this option is not
1746 used, the default behavior is to examine the recipient key preferences
1747 to see which algorithms the recipient supports.  If all else fails,
1748 ZIP is used for maximum compatibility.  Note, however, that ZLIB may
1749 give better compression results if that is more important, as the
1750 compression window size is not limited to 8k.
1751 </para></listitem></varlistentry>
1752
1753
1754 <varlistentry>
1755 <term>--cert-digest-algo &ParmName;</term>
1756 <listitem><para>
1757 Use &ParmName; as the message digest algorithm used when signing a
1758 key.  Running the program with the command --version yields a list of
1759 supported algorithms.  Be aware that if you choose an algorithm that
1760 GnuPG supports but other OpenPGP implementations do not, then some
1761 users will not be able to use the key signatures you make, or quite
1762 possibly your entire key.
1763 </para></listitem></varlistentry>
1764
1765
1766 <varlistentry>
1767 <term>--s2k-cipher-algo &ParmName;</term>
1768 <listitem><para>
1769 Use &ParmName; as the cipher algorithm used to protect secret keys.
1770 The default cipher is CAST5.  This cipher is also used for
1771 conventional encryption if --personal-cipher-preferences and
1772 --cipher-algo is not given.
1773 </para></listitem></varlistentry>
1774
1775
1776 <varlistentry>
1777 <term>--s2k-digest-algo &ParmName;</term>
1778 <listitem><para>
1779 Use &ParmName; as the digest algorithm used to mangle the passphrases.
1780 The default algorithm is SHA-1.
1781 </para></listitem></varlistentry>
1782
1783
1784 <varlistentry>
1785 <term>--s2k-mode &ParmN;</term>
1786 <listitem><para>
1787 Selects how passphrases are mangled. If &ParmN; is 0 a plain
1788 passphrase (which is not recommended) will be used, a 1 adds a salt to
1789 the passphrase and a 3 (the default) iterates the whole process a
1790 couple of times.  Unless --rfc1991 is used, this mode is also used for
1791 conventional encryption.
1792 </para></listitem></varlistentry>
1793
1794
1795 <varlistentry>
1796 <term>--simple-sk-checksum</term>
1797 <listitem><para>
1798 Secret keys are integrity protected by using a SHA-1 checksum.  This
1799 method will be part of an enhanced OpenPGP specification but GnuPG
1800 already uses it as a countermeasure against certain attacks.  Old
1801 applications don't understand this new format, so this option may be
1802 used to switch back to the old behaviour.  Using this this option
1803 bears a security risk.  Note that using this option only takes effect
1804 when the secret key is encrypted - the simplest way to make this
1805 happen is to change the passphrase on the key (even changing it to the
1806 same value is acceptable).
1807 </para></listitem></varlistentry>
1808
1809
1810 <varlistentry>
1811 <term>--disable-cipher-algo &ParmName;</term>
1812 <listitem><para>
1813 Never allow the use of &ParmName; as cipher algorithm.
1814 The given name will not be checked so that a later loaded algorithm
1815 will still get disabled.
1816 </para></listitem></varlistentry>
1817
1818 <varlistentry>
1819 <term>--disable-pubkey-algo &ParmName;</term>
1820 <listitem><para>
1821 Never allow the use of &ParmName; as public key algorithm.
1822 The given name will not be checked so that a later loaded algorithm
1823 will still get disabled.
1824 </para></listitem></varlistentry>
1825
1826 <varlistentry>
1827 <term>--no-sig-cache</term>
1828 <listitem><para>
1829 Do not cache the verification status of key signatures.
1830 Caching gives a much better performance in key listings.  However, if
1831 you suspect that your public keyring is not save against write
1832 modifications, you can use this option to disable the caching.  It
1833 probably does not make sense to disable it because all kind of damage
1834 can be done if someone else has write access to your public keyring.
1835 </para></listitem></varlistentry>
1836
1837 <varlistentry>
1838 <term>--no-sig-create-check</term>
1839 <listitem><para>
1840 GnuPG normally verifies each signature right after creation to protect
1841 against bugs and hardware malfunctions which could leak out bits from
1842 the secret key.  This extra verification needs some time (about 115%
1843 for DSA keys), and so this option can be used to disable it.
1844 However, due to the fact that the signature creation needs manual
1845 interaction, this performance penalty does not matter in most settings.
1846 </para></listitem></varlistentry>
1847
1848 <varlistentry>
1849 <term>--auto-check-trustdb</term>
1850 <term>--no-auto-check-trustdb</term>
1851 <listitem><para>
1852 If GnuPG feels that its information about the Web-of-Trust has to be
1853 updated, it automatically runs the --check-trustdb command internally.
1854 This may be a time consuming process.  --no-auto-check-trustdb
1855 disables this option.
1856 </para></listitem></varlistentry>
1857
1858 <varlistentry>
1859 <term>--throw-keyid</term>
1860 <listitem><para>
1861 Do not put the keyids into encrypted packets.  This option hides the
1862 receiver of the message and is a countermeasure against traffic
1863 analysis.  It may slow down the decryption process because all
1864 available secret keys are tried.
1865 </para></listitem></varlistentry>
1866
1867 <varlistentry>
1868 <term>--no-throw-keyid</term>
1869 <listitem><para>
1870 Resets the --throw-keyid option.
1871 </para></listitem></varlistentry>
1872
1873 <varlistentry>
1874 <term>--not-dash-escaped</term>
1875 <listitem><para>
1876 This option changes the behavior of cleartext signatures
1877 so that they can be used for patch files. You should not
1878 send such an armored file via email because all spaces
1879 and line endings are hashed too.  You can not use this
1880 option for data which has 5 dashes at the beginning of a
1881 line, patch files don't have this. A special armor header
1882 line tells GnuPG about this cleartext signature option.
1883 </para></listitem></varlistentry>
1884
1885
1886 <varlistentry>
1887 <term>--escape-from-lines</term>
1888 <term>--no-escape-from-lines</term>
1889 <listitem><para>
1890 Because some mailers change lines starting with "From " to "&#62;From
1891 " it is good to handle such lines in a special way when creating
1892 cleartext signatures to prevent the mail system from breaking the
1893 signature.  Note that all other PGP versions do it this way too.
1894 Enabled by default.  --no-escape-from-lines disables this option.
1895 </para></listitem></varlistentry>
1896
1897
1898 <varlistentry>
1899 <term>--passphrase-fd &ParmN;</term>
1900 <listitem><para>
1901 Read the passphrase from file descriptor &ParmN;. If you use
1902 0 for &ParmN;, the passphrase will be read from stdin.  This
1903 can only be used if only one passphrase is supplied.
1904 <!--fixme: make this print strong-->
1905 Don't use this option if you can avoid it.
1906 </para></listitem></varlistentry>
1907
1908 <varlistentry>
1909 <term>--command-fd &ParmN;</term>
1910 <listitem><para>
1911 This is a replacement for the deprecated shared-memory IPC mode.
1912 If this option is enabled, user input on questions is not expected
1913 from the TTY but from the given file descriptor.  It should be used
1914 together with --status-fd. See the file doc/DETAILS in the source
1915 distribution for details on how to use it.
1916 </para></listitem></varlistentry>
1917
1918 <varlistentry>
1919 <term>--use-agent</term>
1920 <term>--no-use-agent</term>
1921 <listitem><para>
1922 Try to use the GnuPG-Agent. Please note that this agent is still under
1923 development.  With this option, GnuPG first tries to connect to the
1924 agent before it asks for a passphrase.  --no-use-agent disables this
1925 option.
1926 </para></listitem></varlistentry>
1927
1928 <varlistentry>
1929 <term>--gpg-agent-info</term>
1930 <listitem><para>
1931 Override the value of the environment variable
1932 <literal>GPG_AGENT_INFO</literal>.  This is only used when --use-agent has been given
1933 </para></listitem></varlistentry>
1934
1935 <varlistentry>
1936 <term>Compliance options</term>
1937 <listitem><para>
1938 These options control what GnuPG is compliant to.  Only one of these
1939 options may be active at a time.  Note that the default setting of
1940 this is nearly always the correct one.  See the INTEROPERABILITY WITH
1941 OTHER OPENPGP PROGRAMS section below before using one of these
1942 options.
1943 <variablelist>
1944
1945 <varlistentry>
1946 <term>--gnupg</term>
1947 <listitem><para>
1948 Use standard GnuPG behavior.  This is essentially OpenPGP behavior
1949 (see --openpgp), but with some additional workarounds for common
1950 compatibility problems in different versions of PGP.  This is the
1951 default option, so it is not generally needed, but it may be useful to
1952 override a different compliance option in the gpg.conf file.
1953 </para></listitem></varlistentry>
1954
1955 <varlistentry>
1956 <term>--openpgp</term>
1957 <listitem><para>
1958 Reset all packet, cipher and digest options to strict OpenPGP
1959 behavior.  Use this option to reset all previous options like
1960 --rfc1991, --force-v3-sigs, --s2k-*, --cipher-algo, --digest-algo and
1961 --compress-algo to OpenPGP compliant values.  All PGP workarounds are
1962 disabled.
1963 </para></listitem></varlistentry>
1964
1965 <varlistentry>
1966 <term>--rfc1991</term>
1967 <listitem><para>
1968 Try to be more RFC-1991 (PGP 2.x) compliant.
1969 </para></listitem></varlistentry>
1970
1971 <varlistentry>
1972 <term>--pgp2</term>
1973 <listitem><para>
1974 Set up all options to be as PGP 2.x compliant as possible, and warn if
1975 an action is taken (e.g. encrypting to a non-RSA key) that will create
1976 a message that PGP 2.x will not be able to handle.  Note that `PGP
1977 2.x' here means `MIT PGP 2.6.2'.  There are other versions of PGP 2.x
1978 available, but the MIT release is a good common baseline.
1979 </para><para>
1980 This option implies `--rfc1991 --disable-mdc --no-force-v4-certs
1981 --no-sk-comment --escape-from-lines --force-v3-sigs
1982 --no-ask-sig-expire --no-ask-cert-expire --cipher-algo IDEA
1983 --digest-algo MD5 --compress-algo 1'.  It also disables --textmode
1984 when encrypting.
1985 </para></listitem></varlistentry>
1986
1987 <varlistentry>
1988 <term>--pgp6</term>
1989 <listitem><para>
1990 Set up all options to be as PGP 6 compliant as possible.  This
1991 restricts you to the ciphers IDEA (if the IDEA plugin is installed),
1992 3DES, and CAST5, the hashes MD5, SHA1 and RIPEMD160, and the
1993 compression algorithms none and ZIP.  This also disables
1994 --throw-keyid, and making signatures with signing subkeys as PGP 6
1995 does not understand signatures made by signing subkeys.
1996 </para><para>
1997 This option implies `--disable-mdc --no-sk-comment --escape-from-lines
1998 --force-v3-sigs --no-ask-sig-expire'
1999 </para></listitem></varlistentry>
2000
2001 <varlistentry>
2002 <term>--pgp7</term>
2003 <listitem><para>
2004 Set up all options to be as PGP 7 compliant as possible.  This is
2005 identical to --pgp6 except that MDCs are not disabled, and the list of
2006 allowable ciphers is expanded to add AES128, AES192, AES256, and
2007 TWOFISH.
2008 </para></listitem></varlistentry>
2009
2010 <varlistentry>
2011 <term>--pgp8</term>
2012 <listitem><para>
2013 Set up all options to be as PGP 8 compliant as possible.  PGP 8 is a
2014 lot closer to the OpenPGP standard than previous versions of PGP, so
2015 all this does is disable --throw-keyid and set --escape-from-lines.
2016 The allowed algorithms list is the same as --pgp7 with the addition of
2017 the SHA-256 digest algorithm.
2018 </para></listitem></varlistentry>
2019
2020 </variablelist></para></listitem></varlistentry>
2021
2022 <varlistentry>
2023 <term>--force-v3-sigs</term>
2024 <term>--no-force-v3-sigs</term>
2025 <listitem><para>
2026 OpenPGP states that an implementation should generate v4 signatures
2027 but PGP versions 5 and higher only recognize v4 signatures on key
2028 material.  This option forces v3 signatures for signatures on data.
2029 Note that this option overrides --ask-sig-expire, as v3 signatures
2030 cannot have expiration dates.  --no-force-v3-sigs disables this
2031 option.
2032 </para></listitem></varlistentry>
2033
2034 <varlistentry>
2035 <term>--force-v4-certs</term>
2036 <term>--no-force-v4-certs</term>
2037 <listitem><para>
2038 Always use v4 key signatures even on v3 keys.  This option also
2039 changes the default hash algorithm for v3 RSA keys from MD5 to SHA-1.
2040 --no-force-v4-certs disables this option.
2041 </para></listitem></varlistentry>
2042
2043 <varlistentry>
2044 <term>--force-mdc</term>
2045 <listitem><para>
2046 Force the use of encryption with a modification detection code.  This
2047 is always used with the newer ciphers (those with a blocksize greater
2048 than 64 bits), or if all of the recipient keys indicate MDC support in
2049 their feature flags.
2050 </para></listitem></varlistentry>
2051
2052 <varlistentry>
2053 <term>--disable-mdc</term>
2054 <listitem><para>
2055 Disable the use of the modification detection code.  Note that by
2056 using this option, the encrypted message becomes vulnerable to a
2057 message modification attack.
2058 </para></listitem></varlistentry>
2059
2060 <varlistentry>
2061 <term>--allow-non-selfsigned-uid</term>
2062 <term>--no-allow-non-selfsigned-uid</term>
2063 <listitem><para>
2064 Allow the import and use of keys with user IDs which are not
2065 self-signed.  This is not recommended, as a non self-signed user ID is
2066 trivial to forge.  --no-allow-non-selfsigned-uid disables.
2067 </para></listitem></varlistentry>
2068
2069 <varlistentry>
2070 <term>--allow-freeform-uid</term>
2071 <listitem><para>
2072 Disable all checks on the form of the user ID while generating a new
2073 one.  This option should only be used in very special environments as
2074 it does not ensure the de-facto standard format of user IDs.
2075 </para></listitem></varlistentry>
2076
2077 <varlistentry>
2078 <term>--ignore-time-conflict</term>
2079 <listitem><para>
2080 GnuPG normally checks that the timestamps associated with keys and
2081 signatures have plausible values.  However, sometimes a signature
2082 seems to be older than the key due to clock problems.  This option
2083 makes these checks just a warning.  See also --ignore-valid-from for
2084 timestamp issues on subkeys.
2085 </para></listitem></varlistentry>
2086
2087 <varlistentry>
2088 <term>--ignore-valid-from</term>
2089 <listitem><para>
2090 GnuPG normally does not select and use subkeys created in the future.
2091 This option allows the use of such keys and thus exhibits the
2092 pre-1.0.7 behaviour.  You should not use this option unless you there
2093 is some clock problem.  See also --ignore-time-conflict for timestamp
2094 issues with signatures.
2095 </para></listitem></varlistentry>
2096
2097 <varlistentry>
2098 <term>--ignore-crc-error</term>
2099 <listitem><para>
2100 The ASCII armor used by OpenPGP is protected by a CRC checksum against
2101 transmission errors.  Sometimes it happens that the CRC gets mangled
2102 somewhere on the transmission channel but the actual content (which is
2103 protected by the OpenPGP protocol anyway) is still okay.  This option
2104 will let gpg ignore CRC errors.
2105 </para></listitem></varlistentry>
2106
2107 <varlistentry>
2108 <term>--ignore-mdc-error</term>
2109 <listitem><para>
2110 This option changes a MDC integrity protection failure into a warning.
2111 This can be useful if a message is partially corrupt, but it is
2112 necessary to get as much data as possible out of the corrupt message.
2113 However, be aware that a MDC protection failure may also mean that the
2114 message was tampered with intentionally by an attacker.
2115 </para></listitem></varlistentry>
2116
2117 <varlistentry>
2118 <term>--lock-once</term>
2119 <listitem><para>
2120 Lock the databases the first time a lock is requested
2121 and do not release the lock until the process
2122 terminates.
2123 </para></listitem></varlistentry>
2124
2125 <varlistentry>
2126 <term>--lock-multiple</term>
2127 <listitem><para>
2128 Release the locks every time a lock is no longer
2129 needed. Use this to override a previous --lock-once
2130 from a config file.
2131 </para></listitem></varlistentry>
2132
2133 <varlistentry>
2134 <term>--lock-never</term>
2135 <listitem><para>
2136 Disable locking entirely.  This option should be used only in very
2137 special environments, where it can be assured that only one process
2138 is accessing those files.  A bootable floppy with a stand-alone
2139 encryption system will probably use this.  Improper usage of this
2140 option may lead to data and key corruption.
2141 </para></listitem></varlistentry>
2142
2143 <varlistentry>
2144 <term>--no-random-seed-file</term>
2145 <listitem><para>
2146 GnuPG uses a file to store its internal random pool over invocations.
2147 This makes random generation faster; however sometimes write operations
2148 are not desired.  This option can be used to achieve that with the cost of
2149 slower random generation.
2150 </para></listitem></varlistentry>
2151
2152 <varlistentry>
2153 <term>--no-verbose</term>
2154 <listitem><para>
2155 Reset verbose level to 0.
2156 </para></listitem></varlistentry>
2157
2158 <varlistentry>
2159 <term>--no-greeting</term>
2160 <listitem><para>
2161 Suppress the initial copyright message.
2162 </para></listitem></varlistentry>
2163
2164 <varlistentry>
2165 <term>--no-secmem-warning</term>
2166 <listitem><para>
2167 Suppress the warning about "using insecure memory".
2168 </para></listitem></varlistentry>
2169
2170 <varlistentry>
2171 <term>--no-permission-warning</term>
2172 <listitem><para>
2173
2174 Suppress the warning about unsafe file and home directory (--homedir)
2175 permissions.  Note that the permission checks that GnuPG performs are
2176 not intended to be authoritative, but rather they simply warn about
2177 certain common permission problems.  Do not assume that the lack of a
2178 warning means that your system is secure.
2179 </para><para>
2180 Note that the warning for unsafe --homedir permissions cannot be
2181 supressed in the gpg.conf file, as this would allow an attacker to
2182 place an unsafe gpg.conf file in place, and use this file to supress
2183 warnings about itself.  The --homedir permissions warning may only be
2184 supressed on the command line.
2185 </para></listitem></varlistentry>
2186
2187 <varlistentry>
2188 <term>--no-mdc-warning</term>
2189 <listitem><para>
2190 Suppress the warning about missing MDC integrity protection.
2191 </para></listitem></varlistentry>
2192
2193
2194 <varlistentry>
2195 <term>--no-armor</term>
2196 <listitem><para>
2197 Assume the input data is not in ASCII armored format.
2198 </para></listitem></varlistentry>
2199
2200
2201 <varlistentry>
2202 <term>--no-default-keyring</term>
2203 <listitem><para>
2204 Do not add the default keyrings to the list of
2205 keyrings.
2206 </para></listitem></varlistentry>
2207
2208
2209 <varlistentry>
2210 <term>--skip-verify</term>
2211 <listitem><para>
2212 Skip the signature verification step.  This may be
2213 used to make the decryption faster if the signature
2214 verification is not needed.
2215 </para></listitem></varlistentry>
2216
2217
2218 <varlistentry>
2219 <term>--with-colons</term>
2220 <listitem><para>
2221 Print key listings delimited by colons.  Note that the output will be
2222 encoded in UTF-8 regardless of any --charset setting.  This format is
2223 useful when GnuPG is called from scripts and other programs as it is
2224 easily machine parsed.  The details of this format are documented in
2225 the file doc/DETAILS, which is included in the GnuPG source
2226 distribution.
2227 </para></listitem></varlistentry>
2228
2229
2230 <varlistentry>
2231 <term>--with-key-data</term>
2232 <listitem><para>
2233 Print key listings delimited by colons (like --with-colons) and print the public key data.
2234 </para></listitem></varlistentry>
2235
2236 <varlistentry>
2237 <term>--with-fingerprint</term>
2238 <listitem><para>
2239 Same as the command --fingerprint but changes only the format of the output
2240 and may be used together with another command.
2241 </para></listitem></varlistentry>
2242
2243 <varlistentry>
2244 <term>--fast-list-mode</term>
2245 <listitem><para>
2246 Changes the output of the list commands to work faster; this is achieved
2247 by leaving some parts empty.  Some applications don't need the user ID and
2248 the trust information given in the listings.  By using this options they
2249 can get a faster listing.  The exact behaviour of this option may change
2250 in future versions.
2251 </para></listitem></varlistentry>
2252
2253 <varlistentry>
2254 <term>--fixed-list-mode</term>
2255 <listitem><para>
2256 Do not merge primary user ID and primary key in --with-colon listing
2257 mode and print all timestamps as seconds since 1970-01-01.
2258 </para></listitem></varlistentry>
2259
2260 <varlistentry>
2261 <term>--list-only</term>
2262 <listitem><para>
2263 Changes the behaviour of some commands.  This is like --dry-run but
2264 different in some cases.  The semantic of this command may be extended in
2265 the future.  Currently it only skips the actual decryption pass and
2266 therefore enables a fast listing of the encryption keys.
2267 </para></listitem></varlistentry>
2268
2269 <varlistentry>
2270 <term>--no-literal</term>
2271 <listitem><para>
2272 This is not for normal use.  Use the source to see for what it might be useful.
2273 </para></listitem></varlistentry>
2274
2275 <varlistentry>
2276 <term>--set-filesize</term>
2277 <listitem><para>
2278 This is not for normal use.  Use the source to see for what it might be useful.
2279 </para></listitem></varlistentry>
2280
2281 <varlistentry>
2282 <term>--emulate-md-encode-bug</term>
2283 <listitem><para>
2284 GnuPG versions prior to 1.0.2 had a bug in the way a signature was encoded.
2285 This options enables a workaround by checking faulty signatures again with
2286 the encoding used in old versions.  This may only happen for ElGamal signatures
2287 which are not widely used.
2288 </para></listitem></varlistentry>
2289
2290 <varlistentry>
2291 <term>--show-session-key</term>
2292 <listitem><para>
2293 Display the session key used for one message. See --override-session-key
2294 for the counterpart of this option.
2295 </para>
2296 <para>
2297 We think that Key-Escrow is a Bad Thing; however the user should
2298 have the freedom to decide whether to go to prison or to reveal the content of
2299 one specific message without compromising all messages ever encrypted for one
2300 secret key. DON'T USE IT UNLESS YOU ARE REALLY FORCED TO DO SO.
2301 </para></listitem></varlistentry>
2302
2303 <varlistentry>
2304 <term>--override-session-key &ParmString; </term>
2305 <listitem><para>
2306 Don't use the public key but the session key &ParmString;.  The format of this
2307 string is the same as the one printed by --show-session-key.  This option
2308 is normally not used but comes handy in case someone forces you to reveal the
2309 content of an encrypted message; using this option you can do this without
2310 handing out the secret key.
2311 </para></listitem></varlistentry>
2312
2313 <varlistentry>
2314 <term>--ask-sig-expire</term>
2315 <term>--no-ask-sig-expire</term>
2316 <listitem><para>
2317 When making a data signature, prompt for an expiration time.  If this
2318 option is not specified, the expiration time is "never".
2319 --no-ask-sig-expire disables this option.
2320 </para></listitem></varlistentry>
2321
2322 <varlistentry>
2323 <term>--ask-cert-expire</term>
2324 <term>--no-ask-cert-expire</term>
2325 <listitem><para>
2326 When making a key signature, prompt for an expiration time.  If this
2327 option is not specified, the expiration time is "never".
2328 --no-ask-cert-expire disables this option.
2329 </para></listitem></varlistentry>
2330
2331 <varlistentry>
2332 <term>--expert</term>
2333 <term>--no-expert</term>
2334 <listitem><para>
2335 Allow the user to do certain nonsensical or "silly" things like
2336 signing an expired or revoked key, or certain potentially incompatible
2337 things like generating deprecated key types.  This also disables
2338 certain warning messages about potentially incompatible actions.  As
2339 the name implies, this option is for experts only.  If you don't fully
2340 understand the implications of what it allows you to do, leave this
2341 off.  --no-expert disables this option.
2342 </para></listitem></varlistentry>
2343
2344 <varlistentry>
2345 <term>--merge-only</term>
2346 <listitem><para>
2347 Don't insert new keys into the keyrings while doing an import.
2348 </para></listitem></varlistentry>
2349
2350 <varlistentry>
2351 <term>--allow-secret-key-import</term>
2352 <listitem><para>
2353 This is an obsolete option and is not used anywhere.
2354 </para></listitem></varlistentry>
2355
2356 <varlistentry>
2357 <term>--try-all-secrets</term>
2358 <listitem><para>
2359 Don't look at the key ID as stored in the message but try all secret keys in
2360 turn to find the right decryption key.  This option forces the behaviour as
2361 used by anonymous recipients (created by using --throw-keyid) and might come
2362 handy in case where an encrypted message contains a bogus key ID.
2363 </para></listitem></varlistentry>
2364
2365 <varlistentry>
2366 <term>--enable-special-filenames</term>
2367 <listitem><para>
2368 This options enables a mode in which filenames of the form
2369 <filename>-&#38;n</filename>, where n is a non-negative decimal number,
2370 refer to the file descriptor n and not to a file with that name.
2371 </para></listitem></varlistentry>
2372
2373 <varlistentry>
2374 <term>--no-expensive-trust-checks</term>
2375 <listitem><para>
2376 Experimental use only.
2377 </para></listitem></varlistentry>
2378
2379 <varlistentry>
2380 <term>--group &ParmNameValues;</term>
2381 <listitem><para>
2382 Sets up a named group, which is similar to aliases in email programs.
2383 Any time the group name is a recipient (-r or --recipient), it will
2384 be expanded to the values specified.
2385 </para><para>
2386 The values are &ParmKeyIDs; or fingerprints, but any key description
2387 is accepted.  Note that a value with spaces in it will be treated as
2388 two different values.  Note also there is only one level of expansion
2389 - you cannot make an group that points to another group.  When used
2390 from the command line, it may be necessary to quote the argument to
2391 this option to prevent the shell from treating it as multiple
2392 arguments.
2393 </para></listitem></varlistentry>
2394
2395 <varlistentry>
2396 <term>--preserve-permissions</term>
2397 <listitem><para>
2398 Don't change the permissions of a secret keyring back to user
2399 read/write only.  Use this option only if you really know what you are doing.
2400 </para></listitem></varlistentry>
2401
2402 <varlistentry>
2403 <term>--personal-cipher-preferences &ParmString;</term>
2404 <listitem><para>
2405 Set the list of personal cipher preferences to &ParmString;, this list
2406 should be a string similar to the one printed by the command "pref" in
2407 the edit menu.  This allows the user to factor in their own preferred
2408 algorithms when algorithms are chosen via recipient key preferences.
2409 The most highly ranked cipher in this list is also used for the
2410 --symmetric encryption command.
2411 </para></listitem></varlistentry>
2412
2413 <varlistentry>
2414 <term>--personal-digest-preferences &ParmString;</term>
2415 <listitem><para>
2416 Set the list of personal digest preferences to &ParmString;, this list
2417 should be a string similar to the one printed by the command "pref" in
2418 the edit menu.  This allows the user to factor in their own preferred
2419 algorithms when algorithms are chosen via recipient key preferences.
2420 The most highly ranked digest algorithm in this list is algo used when
2421 signing without encryption (e.g. --clearsign or --sign).  The default
2422 value is SHA-1.
2423 </para></listitem></varlistentry>
2424
2425 <varlistentry>
2426 <term>--personal-compress-preferences &ParmString;</term>
2427 <listitem><para>
2428 Set the list of personal compression preferences to &ParmString;, this
2429 list should be a string similar to the one printed by the command
2430 "pref" in the edit menu.  This allows the user to factor in their own
2431 preferred algorithms when algorithms are chosen via recipient key
2432 preferences.  The most highly ranked algorithm in this list is also
2433 used when there are no recipient keys to consider (e.g. --symmetric).
2434 </para></listitem></varlistentry>
2435
2436 <varlistentry>
2437 <term>--default-preference-list &ParmString;</term>
2438 <listitem><para>
2439 Set the list of default preferences to &ParmString;, this list should
2440 be a string similar to the one printed by the command "pref" in the
2441 edit menu.  This affects both key generation and "updpref" in the edit
2442 menu.
2443 </para></listitem></varlistentry>
2444
2445
2446 </variablelist>
2447 </refsect1>
2448
2449
2450 <refsect1>
2451     <title>How to specify a user ID</title>
2452     <para>
2453 There are different ways to specify a user ID to GnuPG; here are some
2454 examples:
2455     </para>
2456
2457     <variablelist>
2458 <varlistentry>
2459 <term></term>
2460 <listitem><para></para></listitem>
2461 </varlistentry>
2462
2463 <varlistentry>
2464 <term>234567C4</term>
2465 <term>0F34E556E</term>
2466 <term>01347A56A</term>
2467 <term>0xAB123456</term>
2468 <listitem><para>
2469 Here the key ID is given in the usual short form.
2470 </para></listitem>
2471 </varlistentry>
2472
2473 <varlistentry>
2474 <term>234AABBCC34567C4</term>
2475 <term>0F323456784E56EAB</term>
2476 <term>01AB3FED1347A5612</term>
2477 <term>0x234AABBCC34567C4</term>
2478 <listitem><para>
2479 Here the key ID is given in the long form as used by OpenPGP
2480 (you can get the long key ID using the option --with-colons).
2481 </para></listitem>
2482 </varlistentry>
2483
2484 <varlistentry>
2485 <term>1234343434343434C434343434343434</term>
2486 <term>123434343434343C3434343434343734349A3434</term>
2487 <term>0E12343434343434343434EAB3484343434343434</term>
2488 <term>0xE12343434343434343434EAB3484343434343434</term>
2489 <listitem><para>
2490 The best way to specify a key ID is by using the fingerprint of
2491 the key.  This avoids any ambiguities in case that there are duplicated
2492 key IDs (which are really rare for the long key IDs).
2493 </para></listitem>
2494 </varlistentry>
2495
2496 <varlistentry>
2497 <term>=Heinrich Heine &#60;heinrichh@uni-duesseldorf.de&#62;</term>
2498 <listitem><para>
2499 Using an exact to match string.  The equal sign indicates this.
2500 </para></listitem>
2501 </varlistentry>
2502
2503 <varlistentry>
2504 <term>&#60;heinrichh@uni-duesseldorf.de&#62;</term>
2505 <listitem><para>
2506 Using the email address part which must match exactly.  The left angle bracket
2507 indicates this email address mode.
2508 </para></listitem>
2509 </varlistentry>
2510
2511 <varlistentry>
2512 <term>+Heinrich Heine duesseldorf</term>
2513 <listitem><para>
2514 All words must match exactly (not case sensitive) but can appear in
2515 any order in the user ID.  Words are any sequences of letters,
2516 digits, the underscore and all characters with bit 7 set.
2517 </para></listitem>
2518 </varlistentry>
2519
2520 <varlistentry>
2521 <term>Heine</term>
2522 <term>*Heine</term>
2523 <listitem><para>
2524 By case insensitive substring matching.  This is the default mode but
2525 applications may want to explicitly indicate this by putting the asterisk
2526 in front.
2527 </para></listitem>
2528 </varlistentry>
2529
2530     </variablelist>
2531
2532     <para>
2533 Note that you can append an exclamation mark to key IDs or
2534 fingerprints.  This flag tells GnuPG to use exactly the given primary
2535 or secondary key and not to try to figure out which secondary or
2536 primary key to use.
2537     </para>
2538
2539 </refsect1>
2540
2541
2542 <refsect1>
2543     <title>RETURN VALUE</title>
2544     <para>
2545 The program returns 0 if everything was fine, 1 if at least
2546 a signature was bad, and other error codes for fatal errors.
2547     </para>
2548 </refsect1>
2549
2550 <refsect1>
2551     <title>EXAMPLES</title>
2552     <variablelist>
2553
2554 <varlistentry>
2555 <term>gpg -se -r <parameter/Bob/ &ParmFile;</term>
2556 <listitem><para>sign and encrypt for user Bob</para></listitem>
2557 </varlistentry>
2558
2559 <varlistentry>
2560 <term>gpg --clearsign &ParmFile;</term>
2561 <listitem><para>make a clear text signature</para></listitem>
2562 </varlistentry>
2563
2564 <varlistentry>
2565 <term>gpg -sb  &ParmFile;</term>
2566 <listitem><para>make a detached signature</para></listitem>
2567 </varlistentry>
2568
2569 <varlistentry>
2570 <term>gpg --list-keys  <parameter/user_ID/</term>
2571 <listitem><para>show keys</para></listitem>
2572 </varlistentry>
2573
2574 <varlistentry>
2575 <term>gpg --fingerprint  <parameter/user_ID/</term>
2576 <listitem><para>show fingerprint</para></listitem>
2577 </varlistentry>
2578
2579 <varlistentry>
2580 <term>gpg --verify  <parameter/pgpfile/</term>
2581 <term>gpg --verify  <parameter/sigfile/ &OptParmFiles;</term>
2582 <listitem><para>
2583 Verify the signature of the file but do not output the data. The second form
2584 is used for detached signatures, where <parameter/sigfile/ is the detached
2585 signature (either ASCII armored of binary) and &OptParmFiles are the signed
2586 data; if this is not given the name of the file holding the signed data is
2587 constructed by cutting off the extension (".asc" or ".sig") of
2588 <parameter/sigfile/ or by asking the user for the filename.
2589 </para></listitem></varlistentry>
2590
2591     </variablelist>
2592 </refsect1>
2593
2594
2595 <refsect1>
2596     <title>ENVIRONMENT</title>
2597
2598     <variablelist>
2599 <varlistentry>
2600 <term>HOME</term>
2601 <listitem><para>Used to locate the default home directory.</para></listitem>
2602 </varlistentry>
2603 <varlistentry>
2604 <term>GNUPGHOME</term>
2605 <listitem><para>If set directory used instead of "~/.gnupg".</para></listitem>
2606 </varlistentry>
2607 <varlistentry>
2608 <term>GPG_AGENT_INFO</term>
2609 <listitem><para>Used to locate the gpg-agent; only honored when
2610 --use-agent is set.  The value consists of 3 colon delimited fields: 
2611 The first is the path to the Unix Domain Socket, the second the PID of
2612 the gpg-agent and the protocol version which should be set to 1.  When
2613 starting the gpg-agent as described in its documentation, this
2614 variable is set to the correct value.  The option --gpg-agent-info can
2615 be used to override it.</para></listitem>
2616 </varlistentry>
2617 <varlistentry>
2618 <term>http_proxy</term>
2619 <listitem><para>Only honored when the keyserver-option
2620 honor-http-proxy is set.</para></listitem>
2621 </varlistentry>
2622     </variablelist>
2623
2624 </refsect1>
2625
2626 <refsect1>
2627     <title>FILES</title>
2628     <variablelist>
2629
2630 <varlistentry>
2631 <term>~/.gnupg/secring.gpg</term>
2632 <listitem><para>The secret keyring</para></listitem>
2633 </varlistentry>
2634
2635 <varlistentry>
2636 <term>~/.gnupg/secring.gpg.lock</term>
2637 <listitem><para>and the lock file</para></listitem>
2638 </varlistentry>
2639
2640 <varlistentry>
2641 <term>~/.gnupg/pubring.gpg</term>
2642 <listitem><para>The public keyring</para></listitem>
2643 </varlistentry>
2644
2645 <varlistentry>
2646 <term>~/.gnupg/pubring.gpg.lock</term>
2647 <listitem><para>and the lock file</para></listitem>
2648 </varlistentry>
2649
2650 <varlistentry>
2651 <term>~/.gnupg/trustdb.gpg</term>
2652 <listitem><para>The trust database</para></listitem>
2653 </varlistentry>
2654
2655 <varlistentry>
2656 <term>~/.gnupg/trustdb.gpg.lock</term>
2657 <listitem><para>and the lock file</para></listitem>
2658 </varlistentry>
2659
2660 <varlistentry>
2661 <term>~/.gnupg/random_seed</term>
2662 <listitem><para>used to preserve the internal random pool</para></listitem>
2663 </varlistentry>
2664
2665 <varlistentry>
2666 <term>~/.gnupg/gpg.conf</term>
2667 <listitem><para>Default configuration file</para></listitem>
2668 </varlistentry>
2669
2670 <varlistentry>
2671 <term>~/.gnupg/options</term>
2672 <listitem><para>Old style configuration file; only used when gpg.conf
2673 is not found</para></listitem>
2674 </varlistentry>
2675
2676 <varlistentry>
2677 <term>/usr[/local]/share/gnupg/options.skel</term>
2678 <listitem><para>Skeleton options file</para></listitem>
2679 </varlistentry>
2680
2681 <varlistentry>
2682 <term>/usr[/local]/lib/gnupg/</term>
2683 <listitem><para>Default location for extensions</para></listitem>
2684 </varlistentry>
2685
2686     </variablelist>
2687 </refsect1>
2688
2689 <!-- SEE ALSO  not yet needed-->
2690
2691 <refsect1>
2692     <title>WARNINGS</title>
2693     <para>
2694 Use a *good* password for your user account and a *good* passphrase
2695 to protect your secret key.  This passphrase is the weakest part of the
2696 whole system.  Programs to do dictionary attacks on your secret keyring
2697 are very easy to write and so you should protect your "~/.gnupg/"
2698 directory very well.
2699 </para>
2700 <para>
2701 Keep in mind that, if this program is used over a network (telnet), it
2702 is *very* easy to spy out your passphrase!
2703 </para>
2704 <para>
2705 If you are going to verify detached signatures, make sure that the
2706 program knows about it; either be giving both filenames on the
2707 command line or using <literal>-</literal> to specify stdin.
2708 </para>
2709 </refsect1>
2710
2711 <refsect1>
2712     <title>INTEROPERABILITY WITH OTHER OPENPGP PROGRAMS</title>
2713 <para>
2714 GnuPG tries to be a very flexible implementation of the OpenPGP
2715 standard.  In particular, GnuPG implements many of the "optional"
2716 parts of the standard, such as the RIPEMD/160 hash, and the ZLIB
2717 compression algorithms.  It is important to be aware that not all
2718 OpenPGP programs implement these optional algorithms and that by
2719 forcing their use via the --cipher-algo, --digest-algo,
2720 --cert-digest-algo, or --compress-algo options in GnuPG, it is
2721 possible to create a perfectly valid OpenPGP message, but one that
2722 cannot be read by the intended recipient.
2723 </para>
2724
2725 <para>
2726 For example, as of this writing, no version of official PGP supports
2727 the BLOWFISH cipher algorithm.  If you use it, no PGP user will be
2728 able to decrypt your message.  The same thing applies to the ZLIB
2729 compression algorithm.  By default, GnuPG uses the OpenPGP preferences
2730 system that will always do the right thing and create messages that
2731 are usable by all recipients, regardless of which OpenPGP program they
2732 use.  Only override this safe default if you know what you are doing.
2733 </para>
2734
2735 <para>
2736 If you absolutely must override the safe default, or if the
2737 preferences on a given key are invalid for some reason, you are far
2738 better off using the --pgp2, --pgp6, --pgp7, or --pgp8 options.  These
2739 options are safe as they do not force any particular algorithms in
2740 violation of OpenPGP, but rather reduce the available algorithms to a
2741 "PGP-safe" list.
2742 </para>
2743
2744 </refsect1>
2745
2746
2747 <refsect1>
2748     <title>BUGS</title>
2749     <para>
2750 On many systems this program should be installed as setuid(root). This
2751 is necessary to lock memory pages. Locking memory pages prevents the
2752 operating system from writing memory pages to disk. If you get no
2753 warning message about insecure memory your operating system supports
2754 locking without being root. The program drops root privileges as soon
2755 as locked memory is allocated.
2756 </para>
2757 </refsect1>
2758
2759 </refentry>