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