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