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