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