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