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