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