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