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