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