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