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