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