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