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