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