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