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