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