* DETAILS: Details for --list-config.
[gnupg.git] / doc / gpg.texi
1 \input texinfo
2 @c This Texinfo document has been automatically generated by
3 @c docbook2texi from a DocBook documentation.  The tool used
4 @c can be found at:
5 @c <URL:http://shell.ipoline.com/~elmert/hacks/docbook2X/>
6 @c Please send any bug reports, improvements, comments, 
7 @c patches, etc. to Steve Cheng <steve@ggi-project.org>.
8
9 @setfilename gpg.info
10 @dircategory GnuPG
11 @direntry
12 * gpg: (gpg).                         GnuPG encryption and signing tool.
13 @end direntry
14
15 @node top
16 @top gpg
17 @menu
18 @end menu
19
20 @majorheading Name
21 gpg ---- encryption and signing tool</>
22
23 @majorheading Synopsis
24
25 @majorheading DESCRIPTION
26 @code{gpg} is the main program for the GnuPG system.
27
28 This man page only lists the commands and options available.
29 For more verbose documentation get the GNU Privacy Handbook (GPH) or
30 one of the other documents at http://www.gnupg.org/docs.html .
31
32 Please remember that option parsing stops as soon as a non option is
33 encountered, you can explicitly stop option parsing by using the
34 special option "---".
35
36 @majorheading COMMANDS
37 @code{gpg} recognizes these commands:
38
39 @table @asis
40 @item -s, ---sign
41 Make a signature. This command may be combined
42 with ---encrypt.
43
44 @item ---clearsign
45 Make a clear text signature.
46
47 @item -b, ---detach-sign
48 Make a detached signature.
49
50 @item -e, ---encrypt
51 Encrypt data. This option may be combined with ---sign.
52
53 @item -c, ---symmetric
54 Encrypt with a symmetric cipher using a passphrase. The default
55 symmetric cipher used is CAST5, but may be chosen with the
56 ---cipher-algo option.
57
58 @item ---store
59 Store only (make a simple RFC1991 packet).
60
61 @item ---decrypt @code{file}
62 Decrypt @code{file} (or stdin if no file is specified) and
63 write it to stdout (or the file specified with
64 ---output). If the decrypted file is signed, the
65 signature is also verified. This command differs
66 from the default operation, as it never writes to the
67 filename which is included in the file and it
68 rejects files which don't begin with an encrypted
69 message.
70
71 @item ---verify @code{sigfile} @code{signed-files}
72 Assume that @code{sigfile} is a signature and verify it
73 without generating any output. With no arguments,
74 the signature packet is read from stdin. If
75 only a sigfile is given, it may be a complete
76 signature or a detached signature, in which case
77 the signed stuff is expected in a file without the
78 ".sig" or ".asc" extension. 
79 With more than
80 1 argument, the first should be a detached signature
81 and the remaining files are the signed stuff. To read the signed
82 stuff from stdin, use @samp{-} as the second filename.
83 For security reasons a detached signature cannot read the signed
84 material from stdin without denoting it in the above way.
85
86 @item ---verify-files @code{files}
87 This is a special version of the ---verify command which does not work with
88 detached signatures. The command expects the files to be verified either
89 on the command line or reads the filenames from stdin; each name must be on
90 separate line. The command is intended for quick checking of many files.
91
92 @item ---encrypt-files @code{files}
93 This is a special version of the ---encrypt command. The command expects
94 the files to be encrypted either on the command line or reads the filenames
95 from stdin; each name must be on separate line. The command is intended
96 for a quick encryption of multiple files.
97
98 @item ---decrypt-files @code{files}
99 The same as ---encrypt-files with the difference that files will be
100 decrypted. The syntax or the filenames is the same.
101
102 @item ---list-keys @code{names}
103 @itemx ---list-public-keys @code{names}
104 List all keys from the public keyrings, or just the ones given on the
105 command line.
106
107 Avoid using the output of this command in scripts or other programs as
108 it is likely to change as GnuPG changes. See ---with-colons for a
109 machine-parseable key listing command that is appropriate for use in
110 scripts and other programs.
111
112 @item ---list-secret-keys @code{names}
113 List all keys from the secret keyrings, or just the ones given on the
114 command line. A '#' after the letters 'sec' means that the secret key
115 is not usable (for example, if it was created via
116 ---export-secret-subkeys).
117
118 @item ---list-sigs @code{names}
119 Same as ---list-keys, but the signatures are listed too.
120
121 For each signature listed, there are several flags in between the
122 "sig" tag and keyid. These flags give additional information about
123 each signature. From left to right, they are the numbers 1-3 for
124 certificate check level (see ---default-cert-check-level), "L" for a
125 local or non-exportable signature (see ---lsign-key), "R" for a
126 nonRevocable signature (see ---nrsign-key), "P" for a signature that
127 contains a policy URL (see ---cert-policy-url), "N" for a signature
128 that contains a notation (see ---cert-notation), "X" for an eXpired
129 signature (see ---ask-cert-expire), and the numbers 1-9 or "T" for 10
130 and above to indicate trust signature levels (see the ---edit-key
131 command "tsign").
132
133 @item ---check-sigs @code{names}
134 Same as ---list-sigs, but the signatures are verified.
135
136 @item ---fingerprint @code{names}
137 List all keys with their fingerprints. This is the
138 same output as ---list-keys but with the additional output
139 of a line with the fingerprint. May also be combined
140 with ---list-sigs or --check-sigs.
141 If this command is given twice, the fingerprints of all
142 secondary keys are listed too.
143
144 @item ---list-packets
145 List only the sequence of packets. This is mainly
146 useful for debugging.
147
148 @item ---gen-key
149 Generate a new key pair. This command is normally only used
150 interactively.
151
152 There is an experimental feature which allows you to create keys
153 in batch mode. See the file @file{doc/DETAILS}
154 in the source distribution on how to use this.
155
156 @item ---edit-key @code{name}
157 Present a menu which enables you to do all key
158 related tasks:
159
160 @table @asis
161 @item sign
162 Make a signature on key of user @code{name}
163 If the key is not yet signed by the default
164 user (or the users given with -u), the
165 program displays the information of the key
166 again, together with its fingerprint and
167 asks whether it should be signed. This
168 question is repeated for all users specified
169 with -u.
170
171 @item lsign
172 Same as ---sign but the signature is marked as
173 non-exportable and will therefore never be used
174 by others. This may be used to make keys valid
175 only in the local environment.
176
177 @item nrsign
178 Same as ---sign but the signature is marked as non-revocable and can
179 therefore never be revoked.
180
181 @item nrlsign
182 Combines the functionality of nrsign and lsign to make a signature
183 that is both non-revocable and
184 non-exportable.
185
186 @item tsign
187 Make a trust signature. This is a signature that combines the notions
188 of certification (like a regular signature), and trust (like the
189 "trust" command). It is generally only useful in distinct communities
190 or groups.
191
192 @item revsig
193 Revoke a signature. For every signature which has been generated by
194 one of the secret keys, GnuPG asks whether a revocation certificate
195 should be generated.
196
197 @item trust
198 Change the owner trust value. This updates the
199 trust-db immediately and no save is required.
200
201 @item disable
202 @itemx enable
203 Disable or enable an entire key. A disabled key can not normally be
204 used for encryption.
205
206 @item adduid
207 Create an alternate user id.
208
209 @item addphoto
210 Create a photographic user id. This will prompt for a JPEG file that
211 will be embedded into the user ID. A very large JPEG will make for a
212 very large key.
213
214 @item deluid
215 Delete a user id.
216
217 @item revuid
218 Revoke a user id.
219
220 @item addkey
221 Add a subkey to this key.
222
223 @item delkey
224 Remove a subkey.
225
226 @item addrevoker
227 Add a designated revoker. This takes one optional argument:
228 "sensitive". If a designated revoker is marked as sensitive, it will
229 not be exported by default (see
230 export-options).
231
232 @item revkey
233 Revoke a subkey.
234
235 @item expire
236 Change the key expiration time. If a subkey is selected, the
237 expiration time of this subkey will be changed. With no selection,
238 the key expiration of the primary key is changed.
239
240 @item passwd
241 Change the passphrase of the secret key.
242
243 @item primary
244 Flag the current user id as the primary one, removes the primary user
245 id flag from all other user ids and sets the timestamp of all affected
246 self-signatures one second ahead. Note that setting a photo user ID
247 as primary makes it primary over other photo user IDs, and setting a
248 regular user ID as primary makes it primary over other regular user
249 IDs.
250
251 @item uid @code{n}
252 Toggle selection of user id with index @code{n}.
253 Use 0 to deselect all.
254
255 @item key @code{n}
256 Toggle selection of subkey with index @code{n}.
257 Use 0 to deselect all.
258
259 @item check
260 Check all selected user ids.
261
262 @item showphoto
263 Display the selected photographic user
264 id.
265
266 @item pref
267 List preferences from the selected user ID. This shows the actual
268 preferences, without including any implied preferences.
269
270 @item showpref
271 More verbose preferences listing for the selected user ID. This shows
272 the preferences in effect by including the implied preferences of
273 3DES (cipher), SHA-1 (digest), and Uncompressed (compression) if they
274 are not already included in the preference list.
275
276 @item setpref @code{string}
277 Set the list of user ID preferences to @code{string}, this should be a
278 string similar to the one printed by "pref". Using an empty string
279 will set the default preference string, using "none" will set the
280 preferences to nil. Use "gpg ---version" to get a list of available
281 algorithms. This command just initializes an internal list and does
282 not change anything unless another command (such as "updpref") which
283 changes the self-signatures is used.
284
285 @item updpref
286 Change the preferences of all user IDs (or just of the selected ones
287 to the current list of preferences. The timestamp of all affected
288 self-signatures will be advanced by one second. Note that while you
289 can change the preferences on an attribute user ID (aka "photo ID"),
290 GnuPG does not select keys via attribute user IDs so these preferences
291 will not be used by GnuPG.
292
293 @item toggle
294 Toggle between public and secret key listing.
295
296 @item save
297 Save all changes to the key rings and quit.
298
299 @item quit
300 Quit the program without updating the
301 key rings.
302
303 @end table
304
305 The listing shows you the key with its secondary
306 keys and all user ids. Selected keys or user ids
307 are indicated by an asterisk. The trust value is
308 displayed with the primary key: the first is the
309 assigned owner trust and the second is the calculated
310 trust value. Letters are used for the values:
311
312 @table @asis
313 @item -
314 No ownertrust assigned / not yet calculated.
315
316 @item e
317 Trust
318 calculation has failed; probably due to an expired key.
319
320 @item q
321 Not enough information for calculation.
322
323 @item n
324 Never trust this key.
325
326 @item m
327 Marginally trusted.
328
329 @item f
330 Fully trusted.
331
332 @item u
333 Ultimately trusted.
334
335 @end table
336
337 @item ---sign-key @code{name}
338 Signs a public key with your secret key. This is a shortcut version of
339 the subcommand "sign" from ---edit.
340
341 @item ---lsign-key @code{name}
342 Signs a public key with your secret key but marks it as
343 non-exportable. This is a shortcut version of the subcommand "lsign"
344 from ---edit.
345
346 @item ---nrsign-key @code{name}
347 Signs a public key with your secret key but marks it as non-revocable.
348 This is a shortcut version of the subcommand "nrsign" from ---edit.
349
350 @item ---delete-key @code{name}
351 Remove key from the public keyring. In batch mode either ---yes is
352 required or the key must be specified by fingerprint. This is a
353 safeguard against accidental deletion of multiple keys.
354
355 @item ---delete-secret-key @code{name}
356 Remove key from the secret and public keyring. In batch mode the key
357 must be specified by fingerprint.
358
359 @item ---delete-secret-and-public-key @code{name}
360 Same as ---delete-key, but if a secret key exists, it will be removed 
361 first. In batch mode the key must be specified by fingerprint.
362
363 @item ---gen-revoke
364 Generate a revocation certificate for the complete key. To revoke
365 a subkey or a signature, use the ---edit command.
366
367 @item ---desig-revoke
368 Generate a designated revocation certificate for a key. This allows a
369 user (with the permission of the keyholder) to revoke someone else's
370 key.
371
372 @item ---export @code{names}
373 Either export all keys from all keyrings (default
374 keyrings and those registered via option ---keyring),
375 or if at least one name is given, those of the given
376 name. The new keyring is written to stdout or to
377 the file given with option "output". Use together
378 with ---armor to mail those keys.
379
380 @item ---send-keys @code{names}
381 Same as ---export but sends the keys to a keyserver.
382 Option ---keyserver must be used to give the name
383 of this keyserver. Don't send your complete keyring
384 to a keyserver - select only those keys which are new
385 or changed by you.
386
387 @item ---export-all @code{names}
388 Same as ---export, but also exports keys which
389 are not compatible with OpenPGP.
390
391 @item ---export-secret-keys @code{names}
392 @itemx ---export-secret-subkeys @code{names}
393 Same as ---export, but exports the secret keys instead.
394 This is normally not very useful and a security risk.
395 The second form of the command has the special property to
396 render the secret part of the primary key useless; this is
397 a GNU extension to OpenPGP and other implementations can
398 not be expected to successfully import such a key.
399 See the option ---simple-sk-checksum if you want to import such an
400 exported key with an older OpenPGP implementation.
401
402 @item ---import @code{files}
403 @itemx ---fast-import @code{files}
404 Import/merge keys. This adds the given keys to the
405 keyring. The fast version is currently just a synonym.
406
407 There are a few other options which control how this command works.
408 Most notable here is the ---merge-only option which does not insert new keys
409 but does only the merging of new signatures, user-IDs and subkeys.
410
411 @item ---recv-keys @code{key IDs}
412 Import the keys with the given key IDs from a keyserver. Option
413 ---keyserver must be used to give the name of this keyserver.
414
415 @item ---refresh-keys @code{key IDs}
416 Request updates from a keyserver for keys that already exist on the
417 local keyring. This is useful for updating a key with the latest
418 signatures, user IDs, etc. Option ---keyserver must be used to give
419 the name of this keyserver.
420
421 @item ---search-keys @code{names}
422 Search the keyserver for the given names. Multiple names given here
423 will be joined together to create the search string for the keyserver.
424 Option ---keyserver must be used to give the name of this keyserver.
425
426 @item ---update-trustdb
427 Do trust database maintenance. This command iterates over all keys
428 and builds the Web-of-Trust. This is an interactive command because it
429 may have to ask for the "ownertrust" values for keys. The user has to
430 give an estimation of how far she trusts the owner of the displayed
431 key to correctly certify (sign) other keys. GnuPG only asks for the
432 ownertrust value if it has not yet been assigned to a key. Using the
433 ---edit-key menu, the assigned value can be changed at any time.
434
435 @item ---check-trustdb
436 Do trust database maintenance without user interaction. From time to
437 time the trust database must be updated so that expired keys or
438 signatures and the resulting changes in the Web-of-Trust can be
439 tracked. Normally, GnuPG will calculate when this is required and do
440 it automatically unless ---no-auto-check-trustdb is set. This command
441 can be used to force a trust database check at any time. The
442 processing is identical to that of ---update-trustdb but it skips keys
443 with a not yet defined "ownertrust".
444
445 For use with cron jobs, this command can be used together with ---batch
446 in which case the trust database check is done only if a check is
447 needed. To force a run even in batch mode add the option ---yes.
448
449 @item ---export-ownertrust
450 Send the ownertrust values to stdout. This is useful for backup
451 purposes as these values are the only ones which can't be re-created
452 from a corrupted trust DB.
453
454 @item ---import-ownertrust @code{files}
455 Update the trustdb with the ownertrust values stored
456 in @code{files} (or stdin if not given); existing
457 values will be overwritten.
458
459 @item ---rebuild-keydb-caches
460 When updating from version 1.0.6 to 1.0.7 this command should be used
461 to create signature caches in the keyring. It might be handy in other
462 situations too.
463
464 @item ---print-md @code{algo} @code{files}
465 @itemx ---print-mds @code{files}
466 Print message digest of algorithm ALGO for all given files or stdin.
467 With the second form (or a deprecated "*" as algo) digests for all
468 available algorithms are printed.
469
470 @item ---gen-random @code{0|1|2} @code{count}
471 Emit COUNT random bytes of the given quality level. If count is not given
472 or zero, an endless sequence of random bytes will be emitted.
473 PLEASE, don't use this command unless you know what you are doing; it may
474 remove precious entropy from the system!
475
476 @item ---gen-prime @code{mode} @code{bits} @code{qbits}
477 Use the source, Luke :-). The output format is still subject to change.
478
479 @item ---version
480 Print version information along with a list
481 of supported algorithms.
482
483 @item ---warranty
484 Print warranty information.
485
486 @item -h, ---help
487 Print usage information. This is a really long list even though it
488 doesn't list all options. For every option, consult this manual.
489
490 @end table
491
492 @majorheading OPTIONS
493 Long options can be put in an options file (default
494 "~/.gnupg/gpg.conf"). Short option names will not work - for example,
495 "armor" is a valid option for the options file, while "a" is not. Do
496 not write the 2 dashes, but simply the name of the option and any
497 required arguments. Lines with a hash ('#') as the first
498 non-white-space character are ignored. Commands may be put in this
499 file too, but that is not generally useful as the command will execute
500 automatically with every execution of gpg.
501
502 @code{gpg} recognizes these options:
503
504 @table @asis
505 @item -a, ---armor
506 Create ASCII armored output.
507
508 @item -o, ---output @code{file}
509 Write output to @code{file}.
510
511 @item ---mangle-dos-filenames
512 @itemx ---no-mangle-dos-filenames
513 Older version of Windows cannot handle filenames with more than one
514 dot. ---mangle-dos-filenames causes GnuPG to replace (rather than add
515 to) the extension of an output filename to avoid this problem. This
516 option is off by default and has no effect on non-Windows platforms.
517
518 @item -u, ---local-user @code{name}
519 Use @code{name} as the user ID to sign.
520 This option is silently ignored for the list commands,
521 so that it can be used in an options file.
522
523 @item ---default-key @code{name}
524 Use @code{name} as default user ID for signatures. If this
525 is not used the default user ID is the first user ID
526 found in the secret keyring.
527
528 @item -r, ---recipient @code{name}
529 @itemx 
530 Encrypt for user id @code{name}. If this option or ---hidden-recipient
531 is not specified, GnuPG asks for the user-id unless
532 ---default-recipient is given.
533
534 @item -R, ---hidden-recipient @code{name}
535 @itemx 
536 Encrypt for user id @code{name}, but hide the keyid of the key. This
537 option hides the receiver of the message and is a countermeasure
538 against traffic analysis. If this option or ---recipient is not
539 specified, GnuPG asks for the user-id unless ---default-recipient is
540 given.
541
542 @item ---default-recipient @code{name}
543 Use @code{name} as default recipient if option ---recipient is not used and
544 don't ask if this is a valid one. @code{name} must be non-empty.
545
546 @item ---default-recipient-self
547 Use the default key as default recipient if option ---recipient is not used and
548 don't ask if this is a valid one. The default key is the first one from the
549 secret keyring or the one set with ---default-key.
550
551 @item ---no-default-recipient
552 Reset ---default-recipient and --default-recipient-self.
553
554 @item ---encrypt-to @code{name}
555 Same as ---recipient but this one is intended for use
556 in the options file and may be used with
557 your own user-id as an "encrypt-to-self". These keys
558 are only used when there are other recipients given
559 either by use of ---recipient or by the asked user id.
560 No trust checking is performed for these user ids and
561 even disabled keys can be used.
562
563 @item ---hidden-encrypt-to @code{name}
564 Same as ---hidden-recipient but this one is intended for use in the
565 options file and may be used with your own user-id as a hidden
566 "encrypt-to-self". These keys are only used when there are other
567 recipients given either by use of ---recipient or by the asked user id.
568 No trust checking is performed for these user ids and even disabled
569 keys can be used.
570
571 @item ---no-encrypt-to
572 Disable the use of all ---encrypt-to and --hidden-encrypt-to keys.
573
574 @item -v, ---verbose
575 Give more information during processing. If used
576 twice, the input data is listed in detail.
577
578 @item -q, ---quiet
579 Try to be as quiet as possible.
580
581 @item -z @code{n}, ---compress @code{n}
582 Set compression level to @code{n}. A value of 0 for @code{n}
583 disables compression. Default is to use the default
584 compression level of zlib (normally 6).
585
586 @item -t, ---textmode
587 @itemx ---no-textmode
588 Use canonical text mode. ---no-textmode disables this option. If -t
589 (but not ---textmode) is used together with armoring and signing, this
590 enables clearsigned messages. This kludge is needed for command-line
591 compatibility with command-line versions of PGP; normally you would
592 use ---sign or --clearsign to select the type of the signature.
593
594 @item -n, ---dry-run
595 Don't make any changes (this is not completely implemented).
596
597 @item -i, ---interactive
598 Prompt before overwriting any files.
599
600 @item ---batch
601 @itemx ---no-batch
602 Use batch mode. Never ask, do not allow interactive commands.
603 ---no-batch disables this option.
604
605 @item ---no-tty
606 Make sure that the TTY (terminal) is never used for any output.
607 This option is needed in some cases because GnuPG sometimes prints
608 warnings to the TTY if ---batch is used.
609
610 @item ---yes
611 Assume "yes" on most questions.
612
613 @item ---no
614 Assume "no" on most questions.
615
616 @item ---default-cert-check-level @code{n}
617 The default to use for the check level when signing a key.
618
619 0 means you make no particular claim as to how carefully you verified
620 the key.
621
622 1 means you believe the key is owned by the person who claims to own
623 it but you could not, or did not verify the key at all. This is
624 useful for a "persona" verification, where you sign the key of a
625 pseudonymous user.
626
627 2 means you did casual verification of the key. For example, this
628 could mean that you verified that the key fingerprint and checked the
629 user ID on the key against a photo ID.
630
631 3 means you did extensive verification of the key. For example, this
632 could mean that you verified the key fingerprint with the owner of the
633 key in person, and that you checked, by means of a hard to forge
634 document with a photo ID (such as a passport) that the name of the key
635 owner matches the name in the user ID on the key, and finally that you
636 verified (by exchange of email) that the email address on the key
637 belongs to the key owner.
638
639 Note that the examples given above for levels 2 and 3 are just that:
640 examples. In the end, it is up to you to decide just what "casual"
641 and "extensive" mean to you.
642
643 This option defaults to 0.
644
645 @item ---trusted-key @code{long key ID}
646 Assume that the specified key (which must be given
647 as a full 8 byte key ID) is as trustworthy as one of
648 your own secret keys. This option is useful if you
649 don't want to keep your secret keys (or one of them)
650 online but still want to be able to check the validity of a given
651 recipient's or signator's key. 
652
653 @item ---trust-model @code{pgp|classic|always}
654 Set what trust model GnuPG should follow. The models are:
655
656 @table @asis
657 @item pgp
658 This is the web-of-trust combined with trust signatures as used in PGP
659 5.x and later. This is the default trust model.
660
661 @item classic
662 This is the standard web-of-trust as used in PGP 2.x and earlier.
663
664 @item always
665 Skip key validation and assume that used keys are always fully
666 trusted. You won't use this unless you have installed some external
667 validation scheme. This option also suppresses the "[uncertain]" tag
668 printed with signature checks when there is no evidence that the user
669 ID is bound to the key.
670
671 @end table
672
673 @item ---always-trust
674 Identical to `---trust-model always'
675
676 @item ---keyserver @code{name}
677 Use @code{name} as your keyserver. This is the server that ---recv-keys,
678 ---send-keys, and --search-keys will communicate with to receive keys
679 from, send keys to, and search for keys on. The format of the
680 @code{name} is a URI: `scheme:[//]keyservername[:port]' The scheme is
681 the type of keyserver: "hkp" for the Horowitz (or compatible)
682 keyservers, "ldap" for the NAI LDAP keyserver, or "mailto" for the
683 Horowitz email keyserver. Note that your particular installation of
684 GnuPG may have other keyserver types available as well. Keyserver
685 schemes are case-insensitive.
686
687 Most keyservers synchronize with each other, so there is generally no
688 need to send keys to more than one server. Using the command "host -l
689 pgp.net | grep wwwkeys" gives you a list of HKP keyservers. When
690 using one of the wwwkeys servers, due to load balancing using
691 round-robin DNS you may notice that you get a different key server
692 each time.
693
694 @item ---keyserver-options @code{parameters}
695 This is a space or comma delimited string that gives options for the
696 keyserver. Options can be prepended with a `no-' to give the opposite
697 meaning. Valid import-options or export-options may be used here as
698 well to apply to importing (---recv-key) or exporting (--send-key) a
699 key from a keyserver. While not all options are available for all
700 keyserver types, some common options are:
701
702 @table @asis
703 @item include-revoked
704 When searching for a key with ---search-keys, include keys that are
705 marked on the keyserver as revoked. Note that this option is always
706 set when using the NAI HKP keyserver, as this keyserver does not
707 differentiate between revoked and unrevoked keys.
708
709 @item include-disabled
710 When searching for a key with ---search-keys, include keys that are
711 marked on the keyserver as disabled. Note that this option is not
712 used with HKP keyservers.
713
714 @item include-subkeys
715 When receiving a key, include subkeys as potential targets. Note that
716 this option is not used with HKP keyservers, as they do not support
717 retrieving keys by subkey id.
718
719 @item use-temp-files
720 On most Unix-like platforms, GnuPG communicates with the keyserver
721 helper program via pipes, which is the most efficient method. This
722 option forces GnuPG to use temporary files to communicate. On some
723 platforms (such as Win32 and RISC OS), this option is always enabled.
724
725 @item keep-temp-files
726 If using `use-temp-files', do not delete the temp files after using
727 them. This option is useful to learn the keyserver communication
728 protocol by reading the temporary files.
729
730 @item verbose
731 Tell the keyserver helper program to be more verbose. This option can
732 be repeated multiple times to increase the verbosity level.
733
734 @item honor-http-proxy
735 For keyserver schemes that use HTTP (such as HKP), try to access the
736 keyserver over the proxy set with the environment variable
737 "http_proxy".
738
739 @item auto-key-retrieve
740 This option enables the automatic retrieving of keys from a keyserver
741 when verifying signatures made by keys that are not on the local
742 keyring.
743
744 Note that this option makes a "web bug" like behavior possible.
745 Keyserver operators can see which keys you request, so by sending you
746 a message signed by a brand new key (which you naturally will not have
747 on your local keyring), the operator can tell both your IP address and
748 the time when you verified the signature.
749
750 @end table
751
752 @item ---import-options @code{parameters}
753 This is a space or comma delimited string that gives options for
754 importing keys. Options can be prepended with a `no-' to give the
755 opposite meaning. The options are:
756
757 @table @asis
758 @item allow-local-sigs
759 Allow importing key signatures marked as "local". This is not
760 generally useful unless a shared keyring scheme is being used.
761 Defaults to no.
762
763 @item repair-pks-subkey-bug
764 During import, attempt to repair the damage caused by the PKS
765 keyserver bug (pre version 0.9.6) that mangles keys with multiple
766 subkeys. Note that this cannot completely repair the damaged key as
767 some crucial data is removed by the keyserver, but it does at least
768 give you back one subkey. Defaults to no for regular ---import and to
769 yes for keyserver ---recv-keys.
770
771 @end table
772
773 @item ---export-options @code{parameters}
774 This is a space or comma delimited string that gives options for
775 exporting keys. Options can be prepended with a `no-' to give the
776 opposite meaning. The options are:
777
778 @table @asis
779 @item include-non-rfc
780 Include non-RFC compliant keys in the export. Defaults to yes.
781
782 @item include-local-sigs
783 Allow exporting key signatures marked as "local". This is not
784 generally useful unless a shared keyring scheme is being used.
785 Defaults to no.
786
787 @item include-attributes
788 Include attribute user IDs (photo IDs) while exporting. This is
789 useful to export keys if they are going to be used by an OpenPGP
790 program that does not accept attribute user IDs. Defaults to yes.
791
792 @item include-sensitive-revkeys
793 Include designated revoker information that was marked as
794 "sensitive". Defaults to no.
795
796 @end table
797
798 @item ---list-options @code{parameters}
799 This is a space or comma delimited string that gives options used when
800 listing keys and signatures (that is, ---list-keys, --list-sigs,
801 ---list-public-keys, --list-secret-keys, and the --edit-key functions).
802 Options can be prepended with a `no-' to give the opposite meaning.
803 The options are:
804
805 @table @asis
806 @item show-photos
807 Causes ---list-keys, --list-sigs, --list-public-keys, and
808 ---list-secret-keys to display any photo IDs attached to the key.
809 Defaults to no. See also ---photo-viewer.
810
811 @item show-policy-url
812 Show policy URLs in the ---list-sigs or --check-sigs listings.
813 Defaults to no.
814
815 @item show-notation
816 Show signature notations in the ---list-sigs or --check-sigs listings.
817 Defaults to no.
818
819 @item show-keyserver-url
820 Show any preferred keyserver URL in the ---list-sigs or --check-sigs
821 listings. Defaults to no.
822
823 @item show-validity
824 Display the calculated validity of keys and user IDs during key
825 listings. Defaults to no.
826
827 @item show-long-keyid
828 Display all 64 bits (16 digits) of key IDs during key listings, rather
829 than the more common 32 bit (8 digit) IDs. Defaults to no.
830
831 @item show-unusable-uids
832 Show revoked and expired user IDs in key listings. Defaults to no.
833
834 @item show-keyring
835 Display the keyring name at the head of key listings to show which
836 keyring a given key resides on. Defaults to no.
837
838 @item show-sig-expire
839 Show signature expiration dates (if any) during ---list-sigs or
840 ---check-sigs listings. Defaults to no.
841
842 @end table
843
844 @item ---verify-options @code{parameters}
845 This is a space or comma delimited string that gives options used when
846 verifying signatures. Options can be prepended with a `no-' to give
847 the opposite meaning. The options are:
848
849 @table @asis
850 @item show-photos
851 Display any photo IDs present on the key that issued the signature.
852 Defaults to no. See also ---photo-viewer.
853
854 @item show-policy-url
855 Show policy URLs in the signature being verified. Defaults to no.
856
857 @item show-notation
858 Show signature notations in the signature being verified. Defaults to
859 no.
860
861 @item show-keyserver-url
862 Show any preferred keyserver URL in the signature being verified.
863 Defaults to no.
864
865 @item show-validity
866 Display the calculated validity of the user IDs on the key that issued
867 the signature. Defaults to no.
868
869 @item show-long-keyid
870 Display all 64 bits (16 digits) of key IDs during signature
871 verification, rather than the more common 32 bit (8 digit) IDs.
872 Defaults to no.
873
874 @item show-unusable-uids
875 Show revoked and expired user IDs during signature verification.
876 Defaults to no.
877
878 @end table
879
880 @item ---show-photos
881 @itemx ---no-show-photos
882 Causes ---list-keys, --list-sigs, --list-public-keys,
883 ---list-secret-keys, and verifying a signature to also display the
884 photo ID attached to the key, if any. See also ---photo-viewer. These
885 options are deprecated. Use `---list-options [no-]show-photos' and/or
886 `---verify-options [no-]show-photos' instead.
887
888 @item ---photo-viewer @code{string}
889 This is the command line that should be run to view a photo ID. "%i"
890 will be expanded to a filename containing the photo. "%I" does the
891 same, except the file will not be deleted once the viewer exits.
892 Other flags are "%k" for the key ID, "%K" for the long key ID, "%f"
893 for the key fingerprint, "%t" for the extension of the image type
894 (e.g. "jpg"), "%T" for the MIME type of the image (e.g. "image/jpeg"),
895 and "%%" for an actual percent sign. If neither %i or %I are present,
896 then the photo will be supplied to the viewer on standard input.
897
898 The default viewer is "xloadimage -fork -quiet -title 'KeyID 0x%k'
899 stdin". Note that if your image viewer program is not secure, then
900 executing it from GnuPG does not make it secure.
901
902 @item ---exec-path @code{string}
903 Sets a list of directories to search for photo viewers and keyserver
904 helpers. If not provided, keyserver helpers use the compiled-in
905 default directory, and photo viewers use the $PATH environment
906 variable.
907
908 @item ---show-keyring
909 Display the keyring name at the head of key listings to show which
910 keyring a given key resides on. This option is deprecated: use
911 `---list-options [no-]show-keyring' instead.
912
913 @item ---keyring @code{file}
914 Add @code{file} to the list of keyrings. If @code{file} begins with a
915 tilde and a slash, these are replaced by the HOME directory. If the
916 filename does not contain a slash, it is assumed to be in the GnuPG
917 home directory ("~/.gnupg" if ---homedir is not used). The filename
918 may be prefixed with a scheme:
919
920 "gnupg-ring:" is the default one.
921
922 It might make sense to use it together with ---no-default-keyring.
923
924 @item ---secret-keyring @code{file}
925 Same as ---keyring but for the secret keyrings.
926
927 @item ---primary-keyring @code{file}
928 Designate @code{file} as the primary public keyring. This means that
929 newly imported keys (via ---import or keyserver --recv-from) will go to
930 this keyring.
931
932 @item ---trustdb-name @code{file}
933 Use @code{file} instead of the default trustdb. If @code{file} begins
934 with a tilde and a slash, these are replaced by the HOME directory. If
935 the filename does not contain a slash, it is assumed to be in the
936 GnuPG home directory ("~/.gnupg" if ---homedir is not used).
937
938 @item ---homedir @code{directory}
939 Set the name of the home directory to @code{directory} If this
940 option is not used it defaults to "~/.gnupg". It does
941 not make sense to use this in a options file. This
942 also overrides the environment variable "GNUPGHOME".
943
944 @item ---charset @code{name}
945 Set the name of the native character set. This is used
946 to convert some strings to proper UTF-8 encoding. If this option is not used, the default character set is determined
947 from the current locale. A verbosity level of 3 shows the used one.
948 Valid values for @code{name} are:
949
950 @table @asis
951 @item iso-8859-1
952 This is the Latin 1 set.
953
954 @item iso-8859-2
955 The Latin 2 set.
956
957 @item iso-8859-15
958 This is currently an alias for
959 the Latin 1 set.
960
961 @item koi8-r
962 The usual Russian set (rfc1489).
963
964 @item utf-8
965 Bypass all translations and assume
966 that the OS uses native UTF-8 encoding.
967
968 @end table
969
970 @item ---utf8-strings
971 @itemx ---no-utf8-strings
972 Assume that the arguments are already given as UTF8 strings. The default
973 (---no-utf8-strings)
974 is to assume that arguments are encoded in the character set as specified
975 by ---charset. These options affect all following arguments. Both options may
976 be used multiple times.
977
978 @item ---options @code{file}
979 Read options from @code{file} and do not try to read
980 them from the default options file in the homedir
981 (see ---homedir). This option is ignored if used
982 in an options file.
983
984 @item ---no-options
985 Shortcut for "---options /dev/null". This option is
986 detected before an attempt to open an option file.
987 Using this option will also prevent the creation of a 
988 "~./gnupg" homedir.
989
990 @item ---load-extension @code{name}
991 Load an extension module. If @code{name} does not contain a slash it is
992 searched for in the directory configured when GnuPG was built
993 (generally "/usr/local/lib/gnupg"). Extensions are not generally
994 useful anymore, and the use of this option is deprecated.
995
996 @item ---debug @code{flags}
997 Set debugging flags. All flags are or-ed and @code{flags} may
998 be given in C syntax (e.g. 0x0042).
999
1000 @item ---debug-all
1001 Set all useful debugging flags.
1002
1003 @item ---enable-progress-filter
1004 Enable certain PROGRESS status outputs. This option allows frontends
1005 to display a progress indicator while gpg is processing larger files.
1006 There is a slight performance overhead using it.
1007
1008 @item ---status-fd @code{n}
1009 Write special status strings to the file descriptor @code{n}.
1010 See the file DETAILS in the documentation for a listing of them.
1011
1012 @item ---logger-fd @code{n}
1013 Write log output to file descriptor @code{n} and not to stderr.
1014
1015 @item ---attribute-fd @code{n}
1016 Write attribute subpackets to the file descriptor @code{n}. This is
1017 most useful for use with ---status-fd, since the status messages are
1018 needed to separate out the various subpackets from the stream
1019 delivered to the file descriptor.
1020
1021 @item ---sk-comments
1022 @itemx ---no-sk-comments
1023 Include secret key comment packets when exporting secret keys. This
1024 is a GnuPG extension to the OpenPGP standard, and is off by default.
1025 Please note that this has nothing to do with the comments in clear
1026 text signatures or armor headers. ---no-sk-comments disables this
1027 option.
1028
1029 @item ---comment @code{string}
1030 @itemx ---no-comments
1031 Use @code{string} as a comment string in clear text signatures and
1032 ASCII armored messages or keys (see ---armor). The default behavior is
1033 not to use a comment string. ---comment may be repeated multiple times
1034 to get multiple comment strings. ---no-comments removes all comments.
1035
1036 @item ---emit-version
1037 @itemx ---no-emit-version
1038 Force inclusion of the version string in ASCII armored output.
1039 ---no-emit-version disables this option.
1040
1041 @item ---sig-notation @code{name=value}
1042 @itemx ---cert-notation @code{name=value}
1043 @itemx -N, ---set-notation @code{name=value}
1044 Put the name value pair into the signature as notation data.
1045 @code{name} must consist only of printable characters or spaces, and
1046 must contain a '@@' character. This is to help prevent pollution of
1047 the IETF reserved notation namespace. The ---expert flag overrides the
1048 '@@' check. @code{value} may be any printable string; it will be
1049 encoded in UTF8, so you should check that your ---charset is set
1050 correctly. If you prefix @code{name} with an exclamation mark, the
1051 notation data will be flagged as critical (rfc2440:5.2.3.15).
1052 ---sig-notation sets a notation for data signatures. --cert-notation
1053 sets a notation for key signatures (certifications). ---set-notation
1054 sets both.
1055
1056 There are special codes that may be used in notation names. "%k" will
1057 be expanded into the key ID of the key being signed, "%K" into the
1058 long key ID of the key being signed, "%f" into the fingerprint of the
1059 key being signed, "%s" into the key ID of the key making the
1060 signature, "%S" into the long key ID of the key making the signature,
1061 "%g" into the fingerprint of the key making the signature (which might
1062 be a subkey), "%p" into the fingerprint of the primary key of the key
1063 making the signature, and "%%" results in a single "%". %k, %K, and
1064 %f are only meaningful when making a key signature (certification).
1065
1066 @item ---show-notation
1067 @itemx ---no-show-notation
1068 Show signature notations in the ---list-sigs or --check-sigs listings
1069 as well as when verifying a signature with a notation in it. These
1070 options are deprecated. Use `---list-options [no-]show-notation'
1071 and/or `---verify-options [no-]show-notation' instead.
1072
1073 @item ---sig-policy-url @code{string}
1074 @itemx ---cert-policy-url @code{string}
1075 @itemx ---set-policy-url @code{string}
1076 Use @code{string} as a Policy URL for signatures (rfc2440:5.2.3.19).
1077 If you prefix it with an exclamation mark, the policy URL packet will
1078 be flagged as critical. ---sig-policy-url sets a a policy url for data
1079 signatures. ---cert-policy-url sets a policy url for key signatures
1080 (certifications). ---set-policy-url sets both.
1081
1082 The same %-expandos used for notation data are available here as well.
1083
1084 @item ---show-policy-url
1085 @itemx ---no-show-policy-url
1086 Show policy URLs in the ---list-sigs or --check-sigs listings as well
1087 as when verifying a signature with a policy URL in it. These options
1088 are deprecated. Use `---list-options [no-]show-policy-url' and/or
1089 `---verify-options [no-]show-policy-url' instead.
1090
1091 @item ---sig-keyserver-url @code{string}
1092 Use @code{string} as a preferred keyserver URL for data signatures. If
1093 you prefix it with an exclamation mark, the keyserver URL packet will
1094 be flagged as critical. 
1095
1096 The same %-expandos used for notation data are available here as well.
1097
1098 @item ---set-filename @code{string}
1099 Use @code{string} as the filename which is stored inside messages.
1100 This overrides the default, which is to use the actual filename of the
1101 file being encrypted.
1102
1103 @item ---for-your-eyes-only
1104 @itemx ---no-for-your-eyes-only
1105 Set the `for your eyes only' flag in the message. This causes GnuPG
1106 to refuse to save the file unless the ---output option is given, and
1107 PGP to use the "secure viewer" with a Tempest-resistant font to
1108 display the message. This option overrides ---set-filename.
1109 ---no-for-your-eyes-only disables this option.
1110
1111 @item ---use-embedded-filename
1112 Try to create a file with a name as embedded in the data.
1113 This can be a dangerous option as it allows to overwrite files.
1114
1115 @item ---completes-needed @code{n}
1116 Number of completely trusted users to introduce a new
1117 key signer (defaults to 1).
1118
1119 @item ---marginals-needed @code{n}
1120 Number of marginally trusted users to introduce a new
1121 key signer (defaults to 3)
1122
1123 @item ---max-cert-depth @code{n}
1124 Maximum depth of a certification chain (default is 5).
1125
1126 @item ---cipher-algo @code{name}
1127 Use @code{name} as cipher algorithm. Running the program
1128 with the command ---version yields a list of supported
1129 algorithms. If this is not used the cipher algorithm is
1130 selected from the preferences stored with the key.
1131
1132 @item ---digest-algo @code{name}
1133 Use @code{name} as the message digest algorithm. Running the program
1134 with the command ---version yields a list of supported algorithms.
1135
1136 @item ---compress-algo @code{name}
1137 Use compression algorithm @code{name}. "zlib" is RFC1950 ZLIB
1138 compression. "zip" is RFC-1951 ZIP compression which is used by PGP.
1139 "uncompressed" or "none" disables compression. If this option is not
1140 used, the default behavior is to examine the recipient key preferences
1141 to see which algorithms the recipient supports. If all else fails,
1142 ZIP is used for maximum compatibility. Note, however, that ZLIB may
1143 give better compression results if that is more important, as the
1144 compression window size is not limited to 8k.
1145
1146 @item ---cert-digest-algo @code{name}
1147 Use @code{name} as the message digest algorithm used when signing a
1148 key. Running the program with the command ---version yields a list of
1149 supported algorithms. Be aware that if you choose an algorithm that
1150 GnuPG supports but other OpenPGP implementations do not, then some
1151 users will not be able to use the key signatures you make, or quite
1152 possibly your entire key.
1153
1154 @item ---s2k-cipher-algo @code{name}
1155 Use @code{name} as the cipher algorithm used to protect secret keys.
1156 The default cipher is CAST5. This cipher is also used for
1157 conventional encryption if ---personal-cipher-preferences and
1158 ---cipher-algo is not given.
1159
1160 @item ---s2k-digest-algo @code{name}
1161 Use @code{name} as the digest algorithm used to mangle the passphrases.
1162 The default algorithm is SHA-1.
1163
1164 @item ---s2k-mode @code{n}
1165 Selects how passphrases are mangled. If @code{n} is 0 a plain
1166 passphrase (which is not recommended) will be used, a 1 adds a salt to
1167 the passphrase and a 3 (the default) iterates the whole process a
1168 couple of times. Unless ---rfc1991 is used, this mode is also used for
1169 conventional encryption.
1170
1171 @item ---simple-sk-checksum
1172 Secret keys are integrity protected by using a SHA-1 checksum. This
1173 method will be part of an enhanced OpenPGP specification but GnuPG
1174 already uses it as a countermeasure against certain attacks. Old
1175 applications don't understand this new format, so this option may be
1176 used to switch back to the old behaviour. Using this this option
1177 bears a security risk. Note that using this option only takes effect
1178 when the secret key is encrypted - the simplest way to make this
1179 happen is to change the passphrase on the key (even changing it to the
1180 same value is acceptable).
1181
1182 @item ---disable-cipher-algo @code{name}
1183 Never allow the use of @code{name} as cipher algorithm.
1184 The given name will not be checked so that a later loaded algorithm
1185 will still get disabled.
1186
1187 @item ---disable-pubkey-algo @code{name}
1188 Never allow the use of @code{name} as public key algorithm.
1189 The given name will not be checked so that a later loaded algorithm
1190 will still get disabled.
1191
1192 @item ---no-sig-cache
1193 Do not cache the verification status of key signatures.
1194 Caching gives a much better performance in key listings. However, if
1195 you suspect that your public keyring is not save against write
1196 modifications, you can use this option to disable the caching. It
1197 probably does not make sense to disable it because all kind of damage
1198 can be done if someone else has write access to your public keyring.
1199
1200 @item ---no-sig-create-check
1201 GnuPG normally verifies each signature right after creation to protect
1202 against bugs and hardware malfunctions which could leak out bits from
1203 the secret key. This extra verification needs some time (about 115%
1204 for DSA keys), and so this option can be used to disable it.
1205 However, due to the fact that the signature creation needs manual
1206 interaction, this performance penalty does not matter in most settings.
1207
1208 @item ---auto-check-trustdb
1209 @itemx ---no-auto-check-trustdb
1210 If GnuPG feels that its information about the Web-of-Trust has to be
1211 updated, it automatically runs the ---check-trustdb command internally.
1212 This may be a time consuming process. ---no-auto-check-trustdb
1213 disables this option.
1214
1215 @item ---throw-keyid
1216 Do not put the keyids into encrypted packets. This option hides the
1217 receiver of the message and is a countermeasure against traffic
1218 analysis. It may slow down the decryption process because all
1219 available secret keys are tried.
1220
1221 @item ---no-throw-keyid
1222 Resets the ---throw-keyid option.
1223
1224 @item ---not-dash-escaped
1225 This option changes the behavior of cleartext signatures
1226 so that they can be used for patch files. You should not
1227 send such an armored file via email because all spaces
1228 and line endings are hashed too. You can not use this
1229 option for data which has 5 dashes at the beginning of a
1230 line, patch files don't have this. A special armor header
1231 line tells GnuPG about this cleartext signature option.
1232
1233 @item ---escape-from-lines
1234 @itemx ---no-escape-from-lines
1235 Because some mailers change lines starting with "From " to ">From
1236 " it is good to handle such lines in a special way when creating
1237 cleartext signatures to prevent the mail system from breaking the
1238 signature. Note that all other PGP versions do it this way too.
1239 Enabled by default. ---no-escape-from-lines disables this option.
1240
1241 @item ---passphrase-fd @code{n}
1242 Read the passphrase from file descriptor @code{n}. If you use
1243 0 for @code{n}, the passphrase will be read from stdin. This
1244 can only be used if only one passphrase is supplied.
1245 Don't use this option if you can avoid it.
1246
1247 @item ---command-fd @code{n}
1248 This is a replacement for the deprecated shared-memory IPC mode.
1249 If this option is enabled, user input on questions is not expected
1250 from the TTY but from the given file descriptor. It should be used
1251 together with ---status-fd. See the file doc/DETAILS in the source
1252 distribution for details on how to use it.
1253
1254 @item ---use-agent
1255 @itemx ---no-use-agent
1256 Try to use the GnuPG-Agent. Please note that this agent is still under
1257 development. With this option, GnuPG first tries to connect to the
1258 agent before it asks for a passphrase. ---no-use-agent disables this
1259 option.
1260
1261 @item ---gpg-agent-info
1262 Override the value of the environment variable
1263 @samp{GPG_AGENT_INFO}. This is only used when ---use-agent has been given
1264
1265 @item Compliance options
1266 These options control what GnuPG is compliant to. Only one of these
1267 options may be active at a time. Note that the default setting of
1268 this is nearly always the correct one. See the INTEROPERABILITY WITH
1269 OTHER OPENPGP PROGRAMS section below before using one of these
1270 options.
1271
1272 @table @asis
1273 @item ---gnupg
1274 Use standard GnuPG behavior. This is essentially OpenPGP behavior
1275 (see ---openpgp), but with some additional workarounds for common
1276 compatibility problems in different versions of PGP. This is the
1277 default option, so it is not generally needed, but it may be useful to
1278 override a different compliance option in the gpg.conf file.
1279
1280 @item ---openpgp
1281 Reset all packet, cipher and digest options to strict OpenPGP
1282 behavior. Use this option to reset all previous options like
1283 ---rfc1991, --force-v3-sigs, --s2k-*, --cipher-algo, --digest-algo and
1284 ---compress-algo to OpenPGP compliant values. All PGP workarounds are
1285 disabled.
1286
1287 @item ---rfc2440
1288 Reset all packet, cipher and digest options to strict RFC-2440
1289 behavior. Note that this is currently the same thing as ---openpgp.
1290
1291 @item ---rfc1991
1292 Try to be more RFC-1991 (PGP 2.x) compliant.
1293
1294 @item ---pgp2
1295 Set up all options to be as PGP 2.x compliant as possible, and warn if
1296 an action is taken (e.g. encrypting to a non-RSA key) that will create
1297 a message that PGP 2.x will not be able to handle. Note that `PGP
1298 2.x' here means `MIT PGP 2.6.2'. There are other versions of PGP 2.x
1299 available, but the MIT release is a good common baseline.
1300
1301 This option implies `---rfc1991 --disable-mdc --no-force-v4-certs
1302 ---no-sk-comment --escape-from-lines --force-v3-sigs
1303 ---no-ask-sig-expire --no-ask-cert-expire --cipher-algo IDEA
1304 ---digest-algo MD5 --compress-algo 1'. It also disables --textmode
1305 when encrypting.
1306
1307 @item ---pgp6
1308 Set up all options to be as PGP 6 compliant as possible. This
1309 restricts you to the ciphers IDEA (if the IDEA plugin is installed),
1310 3DES, and CAST5, the hashes MD5, SHA1 and RIPEMD160, and the
1311 compression algorithms none and ZIP. This also disables
1312 ---throw-keyid, and making signatures with signing subkeys as PGP 6
1313 does not understand signatures made by signing subkeys.
1314
1315 This option implies `---disable-mdc --no-sk-comment --escape-from-lines
1316 ---force-v3-sigs --no-ask-sig-expire'
1317
1318 @item ---pgp7
1319 Set up all options to be as PGP 7 compliant as possible. This is
1320 identical to ---pgp6 except that MDCs are not disabled, and the list of
1321 allowable ciphers is expanded to add AES128, AES192, AES256, and
1322 TWOFISH.
1323
1324 @item ---pgp8
1325 Set up all options to be as PGP 8 compliant as possible. PGP 8 is a
1326 lot closer to the OpenPGP standard than previous versions of PGP, so
1327 all this does is disable ---throw-keyid and set --escape-from-lines.
1328 The allowed algorithms list is the same as ---pgp7 with the addition of
1329 the SHA-256 digest algorithm.
1330
1331 @end table
1332
1333 @item ---force-v3-sigs
1334 @itemx ---no-force-v3-sigs
1335 OpenPGP states that an implementation should generate v4 signatures
1336 but PGP versions 5 and higher only recognize v4 signatures on key
1337 material. This option forces v3 signatures for signatures on data.
1338 Note that this option overrides ---ask-sig-expire, as v3 signatures
1339 cannot have expiration dates. ---no-force-v3-sigs disables this
1340 option.
1341
1342 @item ---force-v4-certs
1343 @itemx ---no-force-v4-certs
1344 Always use v4 key signatures even on v3 keys. This option also
1345 changes the default hash algorithm for v3 RSA keys from MD5 to SHA-1.
1346 ---no-force-v4-certs disables this option.
1347
1348 @item ---force-mdc
1349 Force the use of encryption with a modification detection code. This
1350 is always used with the newer ciphers (those with a blocksize greater
1351 than 64 bits), or if all of the recipient keys indicate MDC support in
1352 their feature flags.
1353
1354 @item ---disable-mdc
1355 Disable the use of the modification detection code. Note that by
1356 using this option, the encrypted message becomes vulnerable to a
1357 message modification attack.
1358
1359 @item ---allow-non-selfsigned-uid
1360 @itemx ---no-allow-non-selfsigned-uid
1361 Allow the import and use of keys with user IDs which are not
1362 self-signed. This is not recommended, as a non self-signed user ID is
1363 trivial to forge. ---no-allow-non-selfsigned-uid disables.
1364
1365 @item ---allow-freeform-uid
1366 Disable all checks on the form of the user ID while generating a new
1367 one. This option should only be used in very special environments as
1368 it does not ensure the de-facto standard format of user IDs.
1369
1370 @item ---ignore-time-conflict
1371 GnuPG normally checks that the timestamps associated with keys and
1372 signatures have plausible values. However, sometimes a signature
1373 seems to be older than the key due to clock problems. This option
1374 makes these checks just a warning. See also ---ignore-valid-from for
1375 timestamp issues on subkeys.
1376
1377 @item ---ignore-valid-from
1378 GnuPG normally does not select and use subkeys created in the future.
1379 This option allows the use of such keys and thus exhibits the
1380 pre-1.0.7 behaviour. You should not use this option unless you there
1381 is some clock problem. See also ---ignore-time-conflict for timestamp
1382 issues with signatures.
1383
1384 @item ---ignore-crc-error
1385 The ASCII armor used by OpenPGP is protected by a CRC checksum against
1386 transmission errors. Sometimes it happens that the CRC gets mangled
1387 somewhere on the transmission channel but the actual content (which is
1388 protected by the OpenPGP protocol anyway) is still okay. This option
1389 will let gpg ignore CRC errors.
1390
1391 @item ---ignore-mdc-error
1392 This option changes a MDC integrity protection failure into a warning.
1393 This can be useful if a message is partially corrupt, but it is
1394 necessary to get as much data as possible out of the corrupt message.
1395 However, be aware that a MDC protection failure may also mean that the
1396 message was tampered with intentionally by an attacker.
1397
1398 @item ---lock-once
1399 Lock the databases the first time a lock is requested
1400 and do not release the lock until the process
1401 terminates.
1402
1403 @item ---lock-multiple
1404 Release the locks every time a lock is no longer
1405 needed. Use this to override a previous ---lock-once
1406 from a config file.
1407
1408 @item ---lock-never
1409 Disable locking entirely. This option should be used only in very
1410 special environments, where it can be assured that only one process
1411 is accessing those files. A bootable floppy with a stand-alone
1412 encryption system will probably use this. Improper usage of this
1413 option may lead to data and key corruption.
1414
1415 @item ---no-random-seed-file
1416 GnuPG uses a file to store its internal random pool over invocations.
1417 This makes random generation faster; however sometimes write operations
1418 are not desired. This option can be used to achieve that with the cost of
1419 slower random generation.
1420
1421 @item ---no-verbose
1422 Reset verbose level to 0.
1423
1424 @item ---no-greeting
1425 Suppress the initial copyright message.
1426
1427 @item ---no-secmem-warning
1428 Suppress the warning about "using insecure memory".
1429
1430 @item ---no-permission-warning
1431 Suppress the warning about unsafe file and home directory (---homedir)
1432 permissions. Note that the permission checks that GnuPG performs are
1433 not intended to be authoritative, but rather they simply warn about
1434 certain common permission problems. Do not assume that the lack of a
1435 warning means that your system is secure.
1436
1437 Note that the warning for unsafe ---homedir permissions cannot be
1438 supressed in the gpg.conf file, as this would allow an attacker to
1439 place an unsafe gpg.conf file in place, and use this file to supress
1440 warnings about itself. The ---homedir permissions warning may only be
1441 supressed on the command line.
1442
1443 @item ---no-mdc-warning
1444 Suppress the warning about missing MDC integrity protection.
1445
1446 @item ---no-armor
1447 Assume the input data is not in ASCII armored format.
1448
1449 @item ---no-default-keyring
1450 Do not add the default keyrings to the list of
1451 keyrings.
1452
1453 @item ---skip-verify
1454 Skip the signature verification step. This may be
1455 used to make the decryption faster if the signature
1456 verification is not needed.
1457
1458 @item ---with-colons
1459 Print key listings delimited by colons. Note that the output will be
1460 encoded in UTF-8 regardless of any ---charset setting. This format is
1461 useful when GnuPG is called from scripts and other programs as it is
1462 easily machine parsed. The details of this format are documented in
1463 the file doc/DETAILS, which is included in the GnuPG source
1464 distribution.
1465
1466 @item ---with-key-data
1467 Print key listings delimited by colons (like ---with-colons) and print the public key data.
1468
1469 @item ---with-fingerprint
1470 Same as the command ---fingerprint but changes only the format of the output
1471 and may be used together with another command.
1472
1473 @item ---fast-list-mode
1474 Changes the output of the list commands to work faster; this is achieved
1475 by leaving some parts empty. Some applications don't need the user ID and
1476 the trust information given in the listings. By using this options they
1477 can get a faster listing. The exact behaviour of this option may change
1478 in future versions.
1479
1480 @item ---fixed-list-mode
1481 Do not merge primary user ID and primary key in ---with-colon listing
1482 mode and print all timestamps as seconds since 1970-01-01.
1483
1484 @item ---list-only
1485 Changes the behaviour of some commands. This is like ---dry-run but
1486 different in some cases. The semantic of this command may be extended in
1487 the future. Currently it only skips the actual decryption pass and
1488 therefore enables a fast listing of the encryption keys.
1489
1490 @item ---no-literal
1491 This is not for normal use. Use the source to see for what it might be useful.
1492
1493 @item ---set-filesize
1494 This is not for normal use. Use the source to see for what it might be useful.
1495
1496 @item ---emulate-md-encode-bug
1497 GnuPG versions prior to 1.0.2 had a bug in the way a signature was encoded.
1498 This options enables a workaround by checking faulty signatures again with
1499 the encoding used in old versions. This may only happen for ElGamal signatures
1500 which are not widely used.
1501
1502 @item ---show-session-key
1503 Display the session key used for one message. See ---override-session-key
1504 for the counterpart of this option.
1505
1506 We think that Key-Escrow is a Bad Thing; however the user should
1507 have the freedom to decide whether to go to prison or to reveal the content of
1508 one specific message without compromising all messages ever encrypted for one
1509 secret key. DON'T USE IT UNLESS YOU ARE REALLY FORCED TO DO SO.
1510
1511 @item ---override-session-key @code{string} 
1512 Don't use the public key but the session key @code{string}. The format of this
1513 string is the same as the one printed by ---show-session-key. This option
1514 is normally not used but comes handy in case someone forces you to reveal the
1515 content of an encrypted message; using this option you can do this without
1516 handing out the secret key.
1517
1518 @item ---ask-sig-expire
1519 @itemx ---no-ask-sig-expire
1520 When making a data signature, prompt for an expiration time. If this
1521 option is not specified, the expiration time is "never".
1522 ---no-ask-sig-expire disables this option.
1523
1524 @item ---ask-cert-expire
1525 @itemx ---no-ask-cert-expire
1526 When making a key signature, prompt for an expiration time. If this
1527 option is not specified, the expiration time is "never".
1528 ---no-ask-cert-expire disables this option.
1529
1530 @item ---expert
1531 @itemx ---no-expert
1532 Allow the user to do certain nonsensical or "silly" things like
1533 signing an expired or revoked key, or certain potentially incompatible
1534 things like generating deprecated key types. This also disables
1535 certain warning messages about potentially incompatible actions. As
1536 the name implies, this option is for experts only. If you don't fully
1537 understand the implications of what it allows you to do, leave this
1538 off. ---no-expert disables this option.
1539
1540 @item ---merge-only
1541 Don't insert new keys into the keyrings while doing an import.
1542
1543 @item ---allow-secret-key-import
1544 This is an obsolete option and is not used anywhere.
1545
1546 @item ---try-all-secrets
1547 Don't look at the key ID as stored in the message but try all secret keys in
1548 turn to find the right decryption key. This option forces the behaviour as
1549 used by anonymous recipients (created by using ---throw-keyid) and might come
1550 handy in case where an encrypted message contains a bogus key ID.
1551
1552 @item ---enable-special-filenames
1553 This options enables a mode in which filenames of the form
1554 @file{-&n}, where n is a non-negative decimal number,
1555 refer to the file descriptor n and not to a file with that name.
1556
1557 @item ---no-expensive-trust-checks
1558 Experimental use only.
1559
1560 @item ---group @code{name=value1 value2 value3 ...}
1561 Sets up a named group, which is similar to aliases in email programs.
1562 Any time the group name is a recipient (-r or ---recipient), it will
1563 be expanded to the values specified.
1564
1565 The values are @code{key IDs} or fingerprints, but any key description
1566 is accepted. Note that a value with spaces in it will be treated as
1567 two different values. Note also there is only one level of expansion
1568 - you cannot make an group that points to another group. When used
1569 from the command line, it may be necessary to quote the argument to
1570 this option to prevent the shell from treating it as multiple
1571 arguments.
1572
1573 @item ---no-groups
1574 Clear the ---group list.
1575
1576 @item ---preserve-permissions
1577 Don't change the permissions of a secret keyring back to user
1578 read/write only. Use this option only if you really know what you are doing.
1579
1580 @item ---personal-cipher-preferences @code{string}
1581 Set the list of personal cipher preferences to @code{string}, this list
1582 should be a string similar to the one printed by the command "pref" in
1583 the edit menu. This allows the user to factor in their own preferred
1584 algorithms when algorithms are chosen via recipient key preferences.
1585 The most highly ranked cipher in this list is also used for the
1586 ---symmetric encryption command.
1587
1588 @item ---personal-digest-preferences @code{string}
1589 Set the list of personal digest preferences to @code{string}, this list
1590 should be a string similar to the one printed by the command "pref" in
1591 the edit menu. This allows the user to factor in their own preferred
1592 algorithms when algorithms are chosen via recipient key preferences.
1593 The most highly ranked digest algorithm in this list is algo used when
1594 signing without encryption (e.g. ---clearsign or --sign). The default
1595 value is SHA-1.
1596
1597 @item ---personal-compress-preferences @code{string}
1598 Set the list of personal compression preferences to @code{string}, this
1599 list should be a string similar to the one printed by the command
1600 "pref" in the edit menu. This allows the user to factor in their own
1601 preferred algorithms when algorithms are chosen via recipient key
1602 preferences. The most highly ranked algorithm in this list is also
1603 used when there are no recipient keys to consider (e.g. ---symmetric).
1604
1605 @item ---default-preference-list @code{string}
1606 Set the list of default preferences to @code{string}, this list should
1607 be a string similar to the one printed by the command "pref" in the
1608 edit menu. This affects both key generation and "updpref" in the edit
1609 menu.
1610
1611 @end table
1612
1613 @majorheading How to specify a user ID
1614 There are different ways to specify a user ID to GnuPG; here are some
1615 examples:
1616
1617 @table @asis
1618 @item 
1619 @item 234567C4
1620 @itemx 0F34E556E
1621 @itemx 01347A56A
1622 @itemx 0xAB123456
1623 Here the key ID is given in the usual short form.
1624
1625 @item 234AABBCC34567C4
1626 @itemx 0F323456784E56EAB
1627 @itemx 01AB3FED1347A5612
1628 @itemx 0x234AABBCC34567C4
1629 Here the key ID is given in the long form as used by OpenPGP
1630 (you can get the long key ID using the option ---with-colons).
1631
1632 @item 1234343434343434C434343434343434
1633 @itemx 123434343434343C3434343434343734349A3434
1634 @itemx 0E12343434343434343434EAB3484343434343434
1635 @itemx 0xE12343434343434343434EAB3484343434343434
1636 The best way to specify a key ID is by using the fingerprint of
1637 the key. This avoids any ambiguities in case that there are duplicated
1638 key IDs (which are really rare for the long key IDs).
1639
1640 @item =Heinrich Heine <heinrichh@@uni-duesseldorf.de>
1641 Using an exact to match string. The equal sign indicates this.
1642
1643 @item <heinrichh@@uni-duesseldorf.de>
1644 Using the email address part which must match exactly. The left angle bracket
1645 indicates this email address mode.
1646
1647 @item +Heinrich Heine duesseldorf
1648 All words must match exactly (not case sensitive) but can appear in
1649 any order in the user ID. Words are any sequences of letters,
1650 digits, the underscore and all characters with bit 7 set.
1651
1652 @item Heine
1653 @itemx *Heine
1654 By case insensitive substring matching. This is the default mode but
1655 applications may want to explicitly indicate this by putting the asterisk
1656 in front.
1657
1658 @end table
1659
1660 Note that you can append an exclamation mark to key IDs or
1661 fingerprints. This flag tells GnuPG to use exactly the given primary
1662 or secondary key and not to try to figure out which secondary or
1663 primary key to use.
1664
1665 @majorheading RETURN VALUE
1666 The program returns 0 if everything was fine, 1 if at least
1667 a signature was bad, and other error codes for fatal errors.
1668
1669 @majorheading EXAMPLES
1670 @table @asis
1671 @item gpg -se -r @code{Bob} @code{file}
1672 sign and encrypt for user Bob
1673
1674 @item gpg ---clearsign @code{file}
1675 make a clear text signature
1676
1677 @item gpg -sb @code{file}
1678 make a detached signature
1679
1680 @item gpg ---list-keys @code{user_ID}
1681 show keys
1682
1683 @item gpg ---fingerprint @code{user_ID}
1684 show fingerprint
1685
1686 @item gpg ---verify @code{pgpfile}
1687 @itemx gpg ---verify @code{sigfile} @code{files}
1688 Verify the signature of the file but do not output the data. The second form
1689 is used for detached signatures, where @code{sigfile} is the detached
1690 signature (either ASCII armored of binary) and @code{files} are the signed
1691 data; if this is not given the name of the file holding the signed data is
1692 constructed by cutting off the extension (".asc" or ".sig") of
1693 @code{sigfile} or by asking the user for the filename.
1694
1695 @end table
1696
1697 @majorheading ENVIRONMENT
1698 @table @asis
1699 @item HOME
1700 Used to locate the default home directory.
1701
1702 @item GNUPGHOME
1703 If set directory used instead of "~/.gnupg".
1704
1705 @item GPG_AGENT_INFO
1706 Used to locate the gpg-agent; only honored when
1707 ---use-agent is set. The value consists of 3 colon delimited fields: 
1708 The first is the path to the Unix Domain Socket, the second the PID of
1709 the gpg-agent and the protocol version which should be set to 1. When
1710 starting the gpg-agent as described in its documentation, this
1711 variable is set to the correct value. The option ---gpg-agent-info can
1712 be used to override it.
1713
1714 @item http_proxy
1715 Only honored when the keyserver-option
1716 honor-http-proxy is set.
1717
1718 @end table
1719
1720 @majorheading FILES
1721 @table @asis
1722 @item ~/.gnupg/secring.gpg
1723 The secret keyring
1724
1725 @item ~/.gnupg/secring.gpg.lock
1726 and the lock file
1727
1728 @item ~/.gnupg/pubring.gpg
1729 The public keyring
1730
1731 @item ~/.gnupg/pubring.gpg.lock
1732 and the lock file
1733
1734 @item ~/.gnupg/trustdb.gpg
1735 The trust database
1736
1737 @item ~/.gnupg/trustdb.gpg.lock
1738 and the lock file
1739
1740 @item ~/.gnupg/random_seed
1741 used to preserve the internal random pool
1742
1743 @item ~/.gnupg/gpg.conf
1744 Default configuration file
1745
1746 @item ~/.gnupg/options
1747 Old style configuration file; only used when gpg.conf
1748 is not found
1749
1750 @item /usr[/local]/share/gnupg/options.skel
1751 Skeleton options file
1752
1753 @item /usr[/local]/lib/gnupg/
1754 Default location for extensions
1755
1756 @end table
1757
1758 @majorheading WARNINGS
1759 Use a *good* password for your user account and a *good* passphrase
1760 to protect your secret key. This passphrase is the weakest part of the
1761 whole system. Programs to do dictionary attacks on your secret keyring
1762 are very easy to write and so you should protect your "~/.gnupg/"
1763 directory very well.
1764
1765 Keep in mind that, if this program is used over a network (telnet), it
1766 is *very* easy to spy out your passphrase!
1767
1768 If you are going to verify detached signatures, make sure that the
1769 program knows about it; either be giving both filenames on the
1770 command line or using @samp{-} to specify stdin.
1771
1772 @majorheading INTEROPERABILITY WITH OTHER OPENPGP PROGRAMS
1773 GnuPG tries to be a very flexible implementation of the OpenPGP
1774 standard. In particular, GnuPG implements many of the "optional"
1775 parts of the standard, such as the RIPEMD/160 hash, and the ZLIB
1776 compression algorithms. It is important to be aware that not all
1777 OpenPGP programs implement these optional algorithms and that by
1778 forcing their use via the ---cipher-algo, --digest-algo,
1779 ---cert-digest-algo, or --compress-algo options in GnuPG, it is
1780 possible to create a perfectly valid OpenPGP message, but one that
1781 cannot be read by the intended recipient.
1782
1783 For example, as of this writing, no version of official PGP supports
1784 the BLOWFISH cipher algorithm. If you use it, no PGP user will be
1785 able to decrypt your message. The same thing applies to the ZLIB
1786 compression algorithm. By default, GnuPG uses the OpenPGP preferences
1787 system that will always do the right thing and create messages that
1788 are usable by all recipients, regardless of which OpenPGP program they
1789 use. Only override this safe default if you know what you are doing.
1790
1791 If you absolutely must override the safe default, or if the
1792 preferences on a given key are invalid for some reason, you are far
1793 better off using the ---pgp2, --pgp6, --pgp7, or --pgp8 options. These
1794 options are safe as they do not force any particular algorithms in
1795 violation of OpenPGP, but rather reduce the available algorithms to a
1796 "PGP-safe" list.
1797
1798 @majorheading BUGS
1799 On many systems this program should be installed as setuid(root). This
1800 is necessary to lock memory pages. Locking memory pages prevents the
1801 operating system from writing memory pages to disk. If you get no
1802 warning message about insecure memory your operating system supports
1803 locking without being root. The program drops root privileges as soon
1804 as locked memory is allocated.
1805
1806 @bye