gpg: Add new usage option for drop-subkey filters.
[gnupg.git] / doc / gpg.texi
1 @c Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
2 @c               2008, 2009, 2010 Free Software Foundation, Inc.
3 @c This is part of the GnuPG manual.
4 @c For copying conditions, see the file gnupg.texi.
5
6 @include defs.inc
7
8 @node Invoking GPG
9 @chapter Invoking GPG
10 @cindex GPG command options
11 @cindex command options
12 @cindex options, GPG command
13
14
15 @c Begin standard stuff
16 @ifclear gpgtwohack
17 @manpage gpg.1
18 @ifset manverb
19 .B gpg
20 \- OpenPGP encryption and signing tool
21 @end ifset
22
23 @mansect synopsis
24 @ifset manverb
25 .B  gpg
26 .RB [ \-\-homedir
27 .IR dir ]
28 .RB [ \-\-options
29 .IR file ]
30 .RI [ options ]
31 .I command
32 .RI [ args ]
33 @end ifset
34 @end ifclear
35 @c End standard stuff
36
37 @c Begin gpg2 hack stuff
38 @ifset gpgtwohack
39 @manpage gpg2.1
40 @ifset manverb
41 .B gpg2
42 \- OpenPGP encryption and signing tool
43 @end ifset
44
45 @mansect synopsis
46 @ifset manverb
47 .B  gpg2
48 .RB [ \-\-homedir
49 .IR dir ]
50 .RB [ \-\-options
51 .IR file ]
52 .RI [ options ]
53 .I command
54 .RI [ args ]
55 @end ifset
56 @end ifset
57 @c End gpg2 hack stuff
58
59
60 @mansect description
61 @command{@gpgname} is the OpenPGP part of the GNU Privacy Guard (GnuPG). It
62 is a tool to provide digital encryption and signing services using the
63 OpenPGP standard. @command{@gpgname} features complete key management and
64 all the bells and whistles you would expect from a full OpenPGP
65 implementation.
66
67 There are two main versions of GnuPG: GnuPG 1.x and GnuPG 2.x.  GnuPG
68 2.x supports modern encryption algorithms and thus should be preferred
69 over GnuPG 1.x.  You only need to use GnuPG 1.x if your platform
70 doesn't support GnuPG 2.x, or you need support for some features that
71 GnuPG 2.x has deprecated, e.g., decrypting data created with PGP-2
72 keys.
73
74 @ifclear gpgtwohack
75 If you are looking for version 1 of GnuPG, you may find that version
76 installed under the name @command{gpg1}.
77 @end ifclear
78 @ifset gpgtwohack
79 In contrast to the standalone command @command{gpg} from GnuPG 1.x,
80 the 2.x version is commonly installed under the name
81 @command{@gpgname}.
82 @end ifset
83
84 @manpause
85
86 @xref{Option Index}, for an index to @command{@gpgname}'s commands and options.
87 @mancont
88
89 @menu
90 * GPG Commands::            List of all commands.
91 * GPG Options::             List of all options.
92 * GPG Configuration::       Configuration files.
93 * GPG Examples::            Some usage examples.
94
95 Developer information:
96 * Unattended Usage of GPG:: Using @command{gpg} from other programs.
97 @end menu
98
99 @c * GPG Protocol::        The protocol the server mode uses.
100
101
102 @c *******************************************
103 @c ***************            ****************
104 @c ***************  COMMANDS  ****************
105 @c ***************            ****************
106 @c *******************************************
107 @mansect commands
108 @node GPG Commands
109 @section Commands
110
111 Commands are not distinguished from options except for the fact that
112 only one command is allowed.  Generally speaking, irrelevant options
113 are silently ignored, and may not be checked for correctness.
114
115 @command{@gpgname} may be run with no commands. In this case it will
116 perform a reasonable action depending on the type of file it is given
117 as input (an encrypted message is decrypted, a signature is verified,
118 a file containing keys is listed, etc.).
119
120
121 @menu
122 * General GPG Commands::        Commands not specific to the functionality.
123 * Operational GPG Commands::    Commands to select the type of operation.
124 * OpenPGP Key Management::      How to manage your keys.
125 @end menu
126
127
128 @c *******************************************
129 @c **********  GENERAL COMMANDS  *************
130 @c *******************************************
131 @node General GPG Commands
132 @subsection Commands not specific to the function
133
134 @table @gnupgtabopt
135 @item --version
136 @opindex version
137 Print the program version and licensing information.  Note that you
138 cannot abbreviate this command.
139
140 @item --help
141 @itemx -h
142 @opindex help
143 Print a usage message summarizing the most useful command-line options.
144 Note that you cannot arbitrarily abbreviate this command
145 (though you can use its short form @option{-h}).
146
147 @item --warranty
148 @opindex warranty
149 Print warranty information.
150
151 @item --dump-options
152 @opindex dump-options
153 Print a list of all available options and commands.  Note that you cannot
154 abbreviate this command.
155 @end table
156
157
158 @c *******************************************
159 @c ********  OPERATIONAL COMMANDS  ***********
160 @c *******************************************
161 @node Operational GPG Commands
162 @subsection Commands to select the type of operation
163
164
165 @table @gnupgtabopt
166
167 @item --sign
168 @itemx -s
169 @opindex sign
170 Sign a message. This command may be combined with @option{--encrypt}
171 (to sign and encrypt a message), @option{--symmetric} (to sign and
172 symmetrically encrypt a message), or both @option{--encrypt} and
173 @option{--symmetric} (to sign and encrypt a message that can be
174 decrypted using a secret key or a passphrase).  The signing key is
175 chosen by default or can be set explicitly using the
176 @option{--local-user} and @option{--default-key} options.
177
178 @item --clear-sign
179 @opindex clear-sign
180 @itemx --clearsign
181 @opindex clearsign
182 Make a cleartext signature.  The content in a cleartext signature is
183 readable without any special software. OpenPGP software is only needed
184 to verify the signature.  cleartext signatures may modify end-of-line
185 whitespace for platform independence and are not intended to be
186 reversible.  The signing key is chosen by default or can be set
187 explicitly using the @option{--local-user} and @option{--default-key}
188 options.
189
190
191 @item --detach-sign
192 @itemx -b
193 @opindex detach-sign
194 Make a detached signature.
195
196 @item --encrypt
197 @itemx -e
198 @opindex encrypt
199 Encrypt data to one or more public keys. This command may be combined
200 with @option{--sign} (to sign and encrypt a message),
201 @option{--symmetric} (to encrypt a message that can decrypted using a
202 secret key or a passphrase), or @option{--sign} and
203 @option{--symmetric} together (for a signed message that can be
204 decrypted using a secret key or a passphrase).  @option{--recipient}
205 and related options specify which public keys to use for encryption.
206
207 @item --symmetric
208 @itemx -c
209 @opindex symmetric
210 Encrypt with a symmetric cipher using a passphrase. The default
211 symmetric cipher used is @value{GPGSYMENCALGO}, but may be chosen with the
212 @option{--cipher-algo} option. This command may be combined with
213 @option{--sign} (for a signed and symmetrically encrypted message),
214 @option{--encrypt} (for a message that may be decrypted via a secret key
215 or a passphrase), or @option{--sign} and @option{--encrypt} together
216 (for a signed message that may be decrypted via a secret key or a
217 passphrase).  @command{@gpgname} caches the passphrase used for
218 symmetric encryption so that a decrypt operation may not require that
219 the user needs to enter the passphrase.  The option
220 @option{--no-symkey-cache} can be used to disable this feature.
221
222 @item --store
223 @opindex store
224 Store only (make a simple literal data packet).
225
226 @item --decrypt
227 @itemx -d
228 @opindex decrypt
229 Decrypt the file given on the command line (or STDIN if no file
230 is specified) and write it to STDOUT (or the file specified with
231 @option{--output}). If the decrypted file is signed, the signature is also
232 verified. This command differs from the default operation, as it never
233 writes to the filename which is included in the file and it rejects
234 files that don't begin with an encrypted message.
235
236 @item --verify
237 @opindex verify
238 Assume that the first argument is a signed file and verify it without
239 generating any output.  With no arguments, the signature packet is
240 read from STDIN.  If only one argument is given, the specified file is
241 expected to include a complete signature.
242
243 With more than one argument, the first argument should specify a file
244 with a detached signature and the remaining files should contain the
245 signed data. To read the signed data from STDIN, use @samp{-} as the
246 second filename.  For security reasons, a detached signature will not
247 read the signed material from STDIN if not explicitly specified.
248
249 Note: If the option @option{--batch} is not used, @command{@gpgname}
250 may assume that a single argument is a file with a detached signature,
251 and it will try to find a matching data file by stripping certain
252 suffixes.  Using this historical feature to verify a detached
253 signature is strongly discouraged; you should always specify the data file
254 explicitly.
255
256 Note: When verifying a cleartext signature, @command{@gpgname} verifies
257 only what makes up the cleartext signed data and not any extra data
258 outside of the cleartext signature or the header lines directly following
259 the dash marker line.  The option @code{--output} may be used to write
260 out the actual signed data, but there are other pitfalls with this
261 format as well.  It is suggested to avoid cleartext signatures in
262 favor of detached signatures.
263
264 Note: Sometimes the use of the @command{gpgv} tool is easier than
265 using the full-fledged @command{gpg} with this option.  @command{gpgv}
266 is designed to compare signed data against a list of trusted keys and
267 returns with success only for a good signature.  It has its own manual
268 page.
269
270
271 @item --multifile
272 @opindex multifile
273 This modifies certain other commands to accept multiple files for
274 processing on the command line or read from STDIN with each filename on
275 a separate line. This allows for many files to be processed at
276 once. @option{--multifile} may currently be used along with
277 @option{--verify}, @option{--encrypt}, and @option{--decrypt}. Note that
278 @option{--multifile --verify} may not be used with detached signatures.
279
280 @item --verify-files
281 @opindex verify-files
282 Identical to @option{--multifile --verify}.
283
284 @item --encrypt-files
285 @opindex encrypt-files
286 Identical to @option{--multifile --encrypt}.
287
288 @item --decrypt-files
289 @opindex decrypt-files
290 Identical to @option{--multifile --decrypt}.
291
292 @item --list-keys
293 @itemx -k
294 @itemx --list-public-keys
295 @opindex list-keys
296 List the specified keys.  If no keys are specified, then all keys from
297 the configured public keyrings are listed.
298
299 Never use the output of this command in scripts or other programs.
300 The output is intended only for humans and its format is likely to
301 change.  The @option{--with-colons} option emits the output in a
302 stable, machine-parseable format, which is intended for use by scripts
303 and other programs.
304
305 @item --list-secret-keys
306 @itemx -K
307 @opindex list-secret-keys
308 List the specified secret keys.  If no keys are specified, then all
309 known secret keys are listed.  A @code{#} after the initial tags
310 @code{sec} or @code{ssb} means that the secret key or subkey is
311 currently not usable.  We also say that this key has been taken
312 offline (for example, a primary key can be taken offline by exporting
313 the key using the command @option{--export-secret-subkeys}).  A
314 @code{>} after these tags indicate that the key is stored on a
315 smartcard.  See also @option{--list-keys}.
316
317 @item --check-signatures
318 @opindex check-signatures
319 @itemx --check-sigs
320 @opindex check-sigs
321 Same as @option{--list-keys}, but the key signatures are verified and
322 listed too.  Note that for performance reasons the revocation status
323 of a signing key is not shown.  This command has the same effect as
324 using @option{--list-keys} with @option{--with-sig-check}.
325
326 The status of the verification is indicated by a flag directly
327 following the "sig" tag (and thus before the flags described below.  A
328 "!" indicates that the signature has been successfully verified, a "-"
329 denotes a bad signature and a "%" is used if an error occurred while
330 checking the signature (e.g. a non supported algorithm).  Signatures
331 where the public key is not available are not listed; to see their
332 keyids the command @option{--list-sigs} can be used.
333
334 For each signature listed, there are several flags in between the
335 signature status flag and keyid.  These flags give additional
336 information about each key signature.  From left to right, they are
337 the numbers 1-3 for certificate check level (see
338 @option{--ask-cert-level}), "L" for a local or non-exportable
339 signature (see @option{--lsign-key}), "R" for a nonRevocable signature
340 (see the @option{--edit-key} command "nrsign"), "P" for a signature
341 that contains a policy URL (see @option{--cert-policy-url}), "N" for a
342 signature that contains a notation (see @option{--cert-notation}), "X"
343 for an eXpired signature (see @option{--ask-cert-expire}), and the
344 numbers 1-9 or "T" for 10 and above to indicate trust signature levels
345 (see the @option{--edit-key} command "tsign").
346
347
348 @item --locate-keys
349 @opindex locate-keys
350 Locate the keys given as arguments.  This command basically uses the
351 same algorithm as used when locating keys for encryption or signing and
352 may thus be used to see what keys @command{@gpgname} might use.  In
353 particular external methods as defined by @option{--auto-key-locate} may
354 be used to locate a key.  Only public keys are listed.
355
356 @item --show-keys
357 @opindex show-keys
358 This commands takes OpenPGP keys as input and prints information about
359 them in the same way the command @option{--list-keys} does for locally
360 stored key.  In addition the list options @code{show-unusable-uids},
361 @code{show-unusable-subkeys}, @code{show-notations} and
362 @code{show-policy-urls} are also enabled.  As usual for automated
363 processing, this command should be combined with the option
364 @option{--with-colons}.
365
366 @item --fingerprint
367 @opindex fingerprint
368 List all keys (or the specified ones) along with their
369 fingerprints. This is the same output as @option{--list-keys} but with
370 the additional output of a line with the fingerprint. May also be
371 combined with @option{--check-signatures}.  If this
372 command is given twice, the fingerprints of all secondary keys are
373 listed too.  This command also forces pretty printing of fingerprints
374 if the keyid format has been set to "none".
375
376 @item --list-packets
377 @opindex list-packets
378 List only the sequence of packets.  This command is only useful for
379 debugging.  When used with option @option{--verbose} the actual MPI
380 values are dumped and not only their lengths.  Note that the output of
381 this command may change with new releases.
382
383
384 @item --edit-card
385 @opindex edit-card
386 @itemx --card-edit
387 @opindex card-edit
388 Present a menu to work with a smartcard. The subcommand "help" provides
389 an overview on available commands. For a detailed description, please
390 see the Card HOWTO at
391 https://gnupg.org/documentation/howtos.html#GnuPG-cardHOWTO .
392
393 @item --card-status
394 @opindex card-status
395 Show the content of the smart card.
396
397 @item --change-pin
398 @opindex change-pin
399 Present a menu to allow changing the PIN of a smartcard. This
400 functionality is also available as the subcommand "passwd" with the
401 @option{--edit-card} command.
402
403 @item --delete-keys @var{name}
404 @opindex delete-keys
405 Remove key from the public keyring. In batch mode either @option{--yes} is
406 required or the key must be specified by fingerprint. This is a
407 safeguard against accidental deletion of multiple keys.
408
409 @item --delete-secret-keys @var{name}
410 @opindex delete-secret-keys
411 Remove key from the secret keyring. In batch mode the key must be
412 specified by fingerprint.  The option @option{--yes} can be used to
413 advice gpg-agent not to request a confirmation.  This extra
414 pre-caution is done because @command{@gpgname} can't be sure that the
415 secret key (as controlled by gpg-agent) is only used for the given
416 OpenPGP public key.
417
418
419 @item --delete-secret-and-public-key @var{name}
420 @opindex delete-secret-and-public-key
421 Same as @option{--delete-key}, but if a secret key exists, it will be
422 removed first. In batch mode the key must be specified by fingerprint.
423 The option @option{--yes} can be used to advice gpg-agent not to
424 request a confirmation.
425
426 @item --export
427 @opindex export
428 Either export all keys from all keyrings (default keyrings and those
429 registered via option @option{--keyring}), or if at least one name is given,
430 those of the given name. The exported keys are written to STDOUT or to the
431 file given with option @option{--output}.  Use together with
432 @option{--armor} to mail those keys.
433
434 @item --send-keys @var{keyIDs}
435 @opindex send-keys
436 Similar to @option{--export} but sends the keys to a keyserver.
437 Fingerprints may be used instead of key IDs.  Option
438 @option{--keyserver} must be used to give the name of this
439 keyserver. Don't send your complete keyring to a keyserver --- select
440 only those keys which are new or changed by you.  If no @var{keyIDs}
441 are given, @command{@gpgname} does nothing.
442
443 @item --export-secret-keys
444 @itemx --export-secret-subkeys
445 @opindex export-secret-keys
446 @opindex export-secret-subkeys
447 Same as @option{--export}, but exports the secret keys instead.  The
448 exported keys are written to STDOUT or to the file given with option
449 @option{--output}.  This command is often used along with the option
450 @option{--armor} to allow for easy printing of the key for paper backup;
451 however the external tool @command{paperkey} does a better job of
452 creating backups on paper.  Note that exporting a secret key can be a
453 security risk if the exported keys are sent over an insecure channel.
454
455 The second form of the command has the special property to render the
456 secret part of the primary key useless; this is a GNU extension to
457 OpenPGP and other implementations can not be expected to successfully
458 import such a key.  Its intended use is in generating a full key with
459 an additional signing subkey on a dedicated machine.  This command
460 then exports the key without the primary key to the main machine.
461
462 GnuPG may ask you to enter the passphrase for the key.  This is
463 required, because the internal protection method of the secret key is
464 different from the one specified by the OpenPGP protocol.
465
466 @item --export-ssh-key
467 @opindex export-ssh-key
468 This command is used to export a key in the OpenSSH public key format.
469 It requires the specification of one key by the usual means and
470 exports the latest valid subkey which has an authentication capability
471 to STDOUT or to the file given with option @option{--output}.  That
472 output can directly be added to ssh's @file{authorized_key} file.
473
474 By specifying the key to export using a key ID or a fingerprint
475 suffixed with an exclamation mark (!), a specific subkey or the
476 primary key can be exported.  This does not even require that the key
477 has the authentication capability flag set.
478
479 @item --import
480 @itemx --fast-import
481 @opindex import
482 Import/merge keys. This adds the given keys to the
483 keyring. The fast version is currently just a synonym.
484
485 There are a few other options which control how this command works.
486 Most notable here is the @option{--import-options merge-only} option
487 which does not insert new keys but does only the merging of new
488 signatures, user-IDs and subkeys.
489
490 @item --receive-keys @var{keyIDs}
491 @opindex receive-keys
492 @itemx --recv-keys @var{keyIDs}
493 @opindex recv-keys
494 Import the keys with the given @var{keyIDs} from a keyserver. Option
495 @option{--keyserver} must be used to give the name of this keyserver.
496
497 @item --refresh-keys
498 @opindex refresh-keys
499 Request updates from a keyserver for keys that already exist on the
500 local keyring. This is useful for updating a key with the latest
501 signatures, user IDs, etc. Calling this with no arguments will refresh
502 the entire keyring. Option @option{--keyserver} must be used to give the
503 name of the keyserver for all keys that do not have preferred keyservers
504 set (see @option{--keyserver-options honor-keyserver-url}).
505
506 @item --search-keys @var{names}
507 @opindex search-keys
508 Search the keyserver for the given @var{names}. Multiple names given here will
509 be joined together to create the search string for the keyserver.
510 Option @option{--keyserver} must be used to give the name of this
511 keyserver.  Keyservers that support different search methods allow using
512 the syntax specified in "How to specify a user ID" below. Note that
513 different keyserver types support different search methods. Currently
514 only LDAP supports them all.
515
516 @item --fetch-keys @var{URIs}
517 @opindex fetch-keys
518 Retrieve keys located at the specified @var{URIs}. Note that different
519 installations of GnuPG may support different protocols (HTTP, FTP,
520 LDAP, etc.).  When using HTTPS the system provided root certificates
521 are used by this command.
522
523 @item --update-trustdb
524 @opindex update-trustdb
525 Do trust database maintenance. This command iterates over all keys and
526 builds the Web of Trust. This is an interactive command because it may
527 have to ask for the "ownertrust" values for keys. The user has to give
528 an estimation of how far she trusts the owner of the displayed key to
529 correctly certify (sign) other keys. GnuPG only asks for the ownertrust
530 value if it has not yet been assigned to a key. Using the
531 @option{--edit-key} menu, the assigned value can be changed at any time.
532
533 @item --check-trustdb
534 @opindex check-trustdb
535 Do trust database maintenance without user interaction. From time to
536 time the trust database must be updated so that expired keys or
537 signatures and the resulting changes in the Web of Trust can be
538 tracked. Normally, GnuPG will calculate when this is required and do it
539 automatically unless @option{--no-auto-check-trustdb} is set. This
540 command can be used to force a trust database check at any time. The
541 processing is identical to that of @option{--update-trustdb} but it
542 skips keys with a not yet defined "ownertrust".
543
544 For use with cron jobs, this command can be used together with
545 @option{--batch} in which case the trust database check is done only if
546 a check is needed. To force a run even in batch mode add the option
547 @option{--yes}.
548
549 @anchor{option --export-ownertrust}
550 @item --export-ownertrust
551 @opindex export-ownertrust
552 Send the ownertrust values to STDOUT. This is useful for backup purposes
553 as these values are the only ones which can't be re-created from a
554 corrupted trustdb.  Example:
555 @c man:.RS
556 @example
557   @gpgname{} --export-ownertrust > otrust.txt
558 @end example
559 @c man:.RE
560
561
562 @item --import-ownertrust
563 @opindex import-ownertrust
564 Update the trustdb with the ownertrust values stored in @code{files} (or
565 STDIN if not given); existing values will be overwritten.  In case of a
566 severely damaged trustdb and if you have a recent backup of the
567 ownertrust values (e.g. in the file @file{otrust.txt}), you may re-create
568 the trustdb using these commands:
569 @c man:.RS
570 @example
571   cd ~/.gnupg
572   rm trustdb.gpg
573   @gpgname{} --import-ownertrust < otrust.txt
574 @end example
575 @c man:.RE
576
577
578 @item --rebuild-keydb-caches
579 @opindex rebuild-keydb-caches
580 When updating from version 1.0.6 to 1.0.7 this command should be used
581 to create signature caches in the keyring. It might be handy in other
582 situations too.
583
584 @item --print-md @var{algo}
585 @itemx --print-mds
586 @opindex print-md
587 Print message digest of algorithm @var{algo} for all given files or STDIN.
588 With the second form (or a deprecated "*" for @var{algo}) digests for all
589 available algorithms are printed.
590
591 @item --gen-random @var{0|1|2} @var{count}
592 @opindex gen-random
593 Emit @var{count} random bytes of the given quality level 0, 1 or 2. If
594 @var{count} is not given or zero, an endless sequence of random bytes
595 will be emitted.  If used with @option{--armor} the output will be
596 base64 encoded.  PLEASE, don't use this command unless you know what
597 you are doing; it may remove precious entropy from the system!
598
599 @item --gen-prime @var{mode}  @var{bits}
600 @opindex gen-prime
601 Use the source, Luke :-). The output format is subject to change
602 with ant release.
603
604
605 @item --enarmor
606 @itemx --dearmor
607 @opindex enarmor
608 @opindex dearmor
609 Pack or unpack an arbitrary input into/from an OpenPGP ASCII armor.
610 This is a GnuPG extension to OpenPGP and in general not very useful.
611
612 @item --tofu-policy @{auto|good|unknown|bad|ask@}  @var{keys}
613 @opindex tofu-policy
614 Set the TOFU policy for all the bindings associated with the specified
615 @var{keys}.  For more information about the meaning of the policies,
616 @pxref{trust-model-tofu}.  The @var{keys} may be specified either by their
617 fingerprint (preferred) or their keyid.
618
619 @c @item --server
620 @c @opindex server
621 @c Run gpg in server mode.  This feature is not yet ready for use and
622 @c thus not documented.
623
624 @end table
625
626
627 @c *******************************************
628 @c *******  KEY MANGEMENT COMMANDS  **********
629 @c *******************************************
630 @node OpenPGP Key Management
631 @subsection How to manage your keys
632
633 This section explains the main commands for key management.
634
635 @table @gnupgtabopt
636
637 @item --quick-generate-key @var{user-id} [@var{algo} [@var{usage} [@var{expire}]]]
638 @itemx --quick-gen-key
639 @opindex quick-generate-key
640 @opindex quick-gen-key
641 This is a simple command to generate a standard key with one user id.
642 In contrast to @option{--generate-key} the key is generated directly
643 without the need to answer a bunch of prompts.  Unless the option
644 @option{--yes} is given, the key creation will be canceled if the
645 given user id already exists in the keyring.
646
647 If invoked directly on the console without any special options an
648 answer to a ``Continue?'' style confirmation prompt is required.  In
649 case the user id already exists in the keyring a second prompt to
650 force the creation of the key will show up.
651
652 If @var{algo} or @var{usage} are given, only the primary key is
653 created and no prompts are shown.  To specify an expiration date but
654 still create a primary and subkey use ``default'' or
655 ``future-default'' for @var{algo} and ``default'' for @var{usage}.
656 For a description of these optional arguments see the command
657 @code{--quick-add-key}.  The @var{usage} accepts also the value
658 ``cert'' which can be used to create a certification only primary key;
659 the default is to a create certification and signing key.
660
661 The @var{expire} argument can be used to specify an expiration date
662 for the key.  Several formats are supported; commonly the ISO formats
663 ``YYYY-MM-DD'' or ``YYYYMMDDThhmmss'' are used.  To make the key
664 expire in N seconds, N days, N weeks, N months, or N years use
665 ``seconds=N'', ``Nd'', ``Nw'', ``Nm'', or ``Ny'' respectively.  Not
666 specifying a value, or using ``-'' results in a key expiring in a
667 reasonable default interval.  The values ``never'', ``none'' can be
668 used for no expiration date.
669
670 If this command is used with @option{--batch},
671 @option{--pinentry-mode} has been set to @code{loopback}, and one of
672 the passphrase options (@option{--passphrase},
673 @option{--passphrase-fd}, or @option{passphrase-file}) is used, the
674 supplied passphrase is used for the new key and the agent does not ask
675 for it.  To create a key without any protection @code{--passphrase ''}
676 may be used.
677
678 @item --quick-set-expire @var{fpr} @var{expire} [*|@var{subfprs}]
679 @opindex quick-set-expire
680 With two arguments given, directly set the expiration time of the
681 primary key identified by @var{fpr} to @var{expire}.  To remove the
682 expiration time @code{0} can be used.  With three arguments and the
683 third given as an asterisk, the expiration time of all non-revoked and
684 not yet expired subkeys are set to @var{expire}.  With more than two
685 arguments and a list of fingerprints given for @var{subfprs}, all
686 non-revoked subkeys matching these fingerprints are set to
687 @var{expire}.
688
689
690 @item --quick-add-key @var{fpr} [@var{algo} [@var{usage} [@var{expire}]]]
691 @opindex quick-add-key
692 Directly add a subkey to the key identified by the fingerprint
693 @var{fpr}.  Without the optional arguments an encryption subkey is
694 added.  If any of the arguments are given a more specific subkey is
695 added.
696
697 @var{algo} may be any of the supported algorithms or curve names
698 given in the format as used by key listings.  To use the default
699 algorithm the string ``default'' or ``-'' can be used.  Supported
700 algorithms are ``rsa'', ``dsa'', ``elg'', ``ed25519'', ``cv25519'',
701 and other ECC curves.  For example the string ``rsa'' adds an RSA key
702 with the default key length; a string ``rsa4096'' requests that the
703 key length is 4096 bits.  The string ``future-default'' is an alias
704 for the algorithm which will likely be used as default algorithm in
705 future versions of gpg.
706
707 Depending on the given @var{algo} the subkey may either be an
708 encryption subkey or a signing subkey.  If an algorithm is capable of
709 signing and encryption and such a subkey is desired, a @var{usage}
710 string must be given.  This string is either ``default'' or ``-'' to
711 keep the default or a comma delimited list (or space delimited list)
712 of keywords: ``sign'' for a signing subkey, ``auth'' for an
713 authentication subkey, and ``encr'' for an encryption subkey
714 (``encrypt'' can be used as alias for ``encr'').  The valid
715 combinations depend on the algorithm.
716
717 The @var{expire} argument can be used to specify an expiration date
718 for the key.  Several formats are supported; commonly the ISO formats
719 ``YYYY-MM-DD'' or ``YYYYMMDDThhmmss'' are used.  To make the key
720 expire in N seconds, N days, N weeks, N months, or N years use
721 ``seconds=N'', ``Nd'', ``Nw'', ``Nm'', or ``Ny'' respectively.  Not
722 specifying a value, or using ``-'' results in a key expiring in a
723 reasonable default interval.  The values ``never'', ``none'' can be
724 used for no expiration date.
725
726 @item --generate-key
727 @opindex generate-key
728 @itemx --gen-key
729 @opindex gen-key
730 Generate a new key pair using the current default parameters.  This is
731 the standard command to create a new key.  In addition to the key a
732 revocation certificate is created and stored in the
733 @file{openpgp-revocs.d} directory below the GnuPG home directory.
734
735 @item --full-generate-key
736 @opindex full-generate-key
737 @itemx --full-gen-key
738 @opindex full-gen-key
739 Generate a new key pair with dialogs for all options.  This is an
740 extended version of @option{--generate-key}.
741
742 There is also a feature which allows you to create keys in batch
743 mode. See the manual section ``Unattended key generation'' on how
744 to use this.
745
746
747 @item --generate-revocation @var{name}
748 @opindex generate-revocation
749 @itemx --gen-revoke @var{name}
750 @opindex gen-revoke
751 Generate a revocation certificate for the complete key.  To only revoke
752 a subkey or a key signature, use the @option{--edit} command.
753
754 This command merely creates the revocation certificate so that it can
755 be used to revoke the key if that is ever needed.  To actually revoke
756 a key the created revocation certificate needs to be merged with the
757 key to revoke.  This is done by importing the revocation certificate
758 using the @option{--import} command.  Then the revoked key needs to be
759 published, which is best done by sending the key to a keyserver
760 (command @option{--send-key}) and by exporting (@option{--export}) it
761 to a file which is then send to frequent communication partners.
762
763
764 @item --generate-designated-revocation @var{name}
765 @opindex generate-designated-revocation
766 @itemx --desig-revoke @var{name}
767 @opindex desig-revoke
768 Generate a designated revocation certificate for a key. This allows a
769 user (with the permission of the keyholder) to revoke someone else's
770 key.
771
772
773 @item --edit-key
774 @opindex edit-key
775 Present a menu which enables you to do most of the key management
776 related tasks.  It expects the specification of a key on the command
777 line.
778
779 @c ******** Begin Edit-key Options **********
780 @table @asis
781
782   @item uid @var{n}
783   @opindex keyedit:uid
784   Toggle selection of user ID or photographic user ID with index @var{n}.
785   Use @code{*} to select all and @code{0} to deselect all.
786
787   @item key @var{n}
788   @opindex keyedit:key
789   Toggle selection of subkey with index @var{n} or key ID @var{n}.
790   Use @code{*} to select all and @code{0} to deselect all.
791
792   @item sign
793   @opindex keyedit:sign
794   Make a signature on key of user @code{name}. If the key is not yet
795   signed by the default user (or the users given with @option{-u}), the program
796   displays the information of the key again, together with its
797   fingerprint and asks whether it should be signed. This question is
798   repeated for all users specified with
799   @option{-u}.
800
801   @item lsign
802   @opindex keyedit:lsign
803   Same as "sign" but the signature is marked as non-exportable and will
804   therefore never be used by others. This may be used to make keys
805   valid only in the local environment.
806
807   @item nrsign
808   @opindex keyedit:nrsign
809   Same as "sign" but the signature is marked as non-revocable and can
810   therefore never be revoked.
811
812   @item tsign
813   @opindex keyedit:tsign
814   Make a trust signature. This is a signature that combines the notions
815   of certification (like a regular signature), and trust (like the
816   "trust" command). It is generally only useful in distinct communities
817   or groups.  For more information please read the sections
818   ``Trust Signature'' and ``Regular Expression'' in RFC-4880.
819 @end table
820
821 @c man:.RS
822 Note that "l" (for local / non-exportable), "nr" (for non-revocable,
823 and "t" (for trust) may be freely mixed and prefixed to "sign" to
824 create a signature of any type desired.
825 @c man:.RE
826
827 If the option @option{--only-sign-text-ids} is specified, then any
828 non-text based user ids (e.g., photo IDs) will not be selected for
829 signing.
830
831 @table @asis
832
833   @item delsig
834   @opindex keyedit:delsig
835   Delete a signature. Note that it is not possible to retract a signature,
836   once it has been send to the public (i.e. to a keyserver).  In that case
837   you better use @code{revsig}.
838
839   @item revsig
840   @opindex keyedit:revsig
841   Revoke a signature. For every signature which has been generated by
842   one of the secret keys, GnuPG asks whether a revocation certificate
843   should be generated.
844
845   @item check
846   @opindex keyedit:check
847   Check the signatures on all selected user IDs.  With the extra
848   option @code{selfsig} only self-signatures are shown.
849
850   @item adduid
851   @opindex keyedit:adduid
852   Create an additional user ID.
853
854   @item addphoto
855   @opindex keyedit:addphoto
856   Create a photographic user ID. This will prompt for a JPEG file that
857   will be embedded into the user ID. Note that a very large JPEG will make
858   for a very large key. Also note that some programs will display your
859   JPEG unchanged (GnuPG), and some programs will scale it to fit in a
860   dialog box (PGP).
861
862   @item showphoto
863   @opindex keyedit:showphoto
864   Display the selected photographic user ID.
865
866   @item deluid
867   @opindex keyedit:deluid
868   Delete a user ID or photographic user ID.  Note that it is not
869   possible to retract a user id, once it has been send to the public
870   (i.e. to a keyserver).  In that case you better use @code{revuid}.
871
872   @item revuid
873   @opindex keyedit:revuid
874   Revoke a user ID or photographic user ID.
875
876   @item primary
877   @opindex keyedit:primary
878   Flag the current user id as the primary one, removes the primary user
879   id flag from all other user ids and sets the timestamp of all affected
880   self-signatures one second ahead. Note that setting a photo user ID
881   as primary makes it primary over other photo user IDs, and setting a
882   regular user ID as primary makes it primary over other regular user
883   IDs.
884
885   @item keyserver
886   @opindex keyedit:keyserver
887   Set a preferred keyserver for the specified user ID(s). This allows
888   other users to know where you prefer they get your key from. See
889   @option{--keyserver-options honor-keyserver-url} for more on how this
890   works.  Setting a value of "none" removes an existing preferred
891   keyserver.
892
893   @item notation
894   @opindex keyedit:notation
895   Set a name=value notation for the specified user ID(s). See
896   @option{--cert-notation} for more on how this works. Setting a value of
897   "none" removes all notations, setting a notation prefixed with a minus
898   sign (-) removes that notation, and setting a notation name (without the
899   =value) prefixed with a minus sign removes all notations with that name.
900
901   @item pref
902   @opindex keyedit:pref
903   List preferences from the selected user ID. This shows the actual
904   preferences, without including any implied preferences.
905
906   @item showpref
907   @opindex keyedit:showpref
908   More verbose preferences listing for the selected user ID. This shows
909   the preferences in effect by including the implied preferences of 3DES
910   (cipher), SHA-1 (digest), and Uncompressed (compression) if they are
911   not already included in the preference list. In addition, the
912   preferred keyserver and signature notations (if any) are shown.
913
914   @item setpref @var{string}
915   @opindex keyedit:setpref
916   Set the list of user ID preferences to @var{string} for all (or just
917   the selected) user IDs. Calling setpref with no arguments sets the
918   preference list to the default (either built-in or set via
919   @option{--default-preference-list}), and calling setpref with "none"
920   as the argument sets an empty preference list. Use @command{@gpgname
921   --version} to get a list of available algorithms. Note that while you
922   can change the preferences on an attribute user ID (aka "photo ID"),
923   GnuPG does not select keys via attribute user IDs so these preferences
924   will not be used by GnuPG.
925
926   When setting preferences, you should list the algorithms in the order
927   which you'd like to see them used by someone else when encrypting a
928   message to your key.  If you don't include 3DES, it will be
929   automatically added at the end.  Note that there are many factors that
930   go into choosing an algorithm (for example, your key may not be the
931   only recipient), and so the remote OpenPGP application being used to
932   send to you may or may not follow your exact chosen order for a given
933   message.  It will, however, only choose an algorithm that is present
934   on the preference list of every recipient key.  See also the
935   INTEROPERABILITY WITH OTHER OPENPGP PROGRAMS section below.
936
937   @item addkey
938   @opindex keyedit:addkey
939   Add a subkey to this key.
940
941   @item addcardkey
942   @opindex keyedit:addcardkey
943   Generate a subkey on a card and add it to this key.
944
945   @item keytocard
946   @opindex keyedit:keytocard
947   Transfer the selected secret subkey (or the primary key if no subkey
948   has been selected) to a smartcard. The secret key in the keyring will
949   be replaced by a stub if the key could be stored successfully on the
950   card and you use the save command later. Only certain key types may be
951   transferred to the card. A sub menu allows you to select on what card
952   to store the key. Note that it is not possible to get that key back
953   from the card - if the card gets broken your secret key will be lost
954   unless you have a backup somewhere.
955
956   @item bkuptocard @var{file}
957   @opindex keyedit:bkuptocard
958   Restore the given @var{file} to a card. This command may be used to restore a
959   backup key (as generated during card initialization) to a new card. In
960   almost all cases this will be the encryption key. You should use this
961   command only with the corresponding public key and make sure that the
962   file given as argument is indeed the backup to restore. You should then
963   select 2 to restore as encryption key.  You will first be asked to enter
964   the passphrase of the backup key and then for the Admin PIN of the card.
965
966   @item delkey
967   @opindex keyedit:delkey
968   Remove a subkey (secondary key). Note that it is not possible to retract
969   a subkey, once it has been send to the public (i.e. to a keyserver).  In
970   that case you better use @code{revkey}.  Also note that this only
971   deletes the public part of a key.
972
973   @item revkey
974   @opindex keyedit:revkey
975   Revoke a subkey.
976
977   @item expire
978   @opindex keyedit:expire
979   Change the key or subkey expiration time. If a subkey is selected, the
980   expiration time of this subkey will be changed. With no selection, the
981   key expiration of the primary key is changed.
982
983   @item trust
984   @opindex keyedit:trust
985   Change the owner trust value for the key. This updates the trust-db
986   immediately and no save is required.
987
988   @item disable
989   @itemx enable
990   @opindex keyedit:disable
991   @opindex keyedit:enable
992   Disable or enable an entire key. A disabled key can not normally be
993   used for encryption.
994
995   @item addrevoker
996   @opindex keyedit:addrevoker
997   Add a designated revoker to the key. This takes one optional argument:
998   "sensitive". If a designated revoker is marked as sensitive, it will
999   not be exported by default (see export-options).
1000
1001   @item passwd
1002   @opindex keyedit:passwd
1003   Change the passphrase of the secret key.
1004
1005   @item toggle
1006   @opindex keyedit:toggle
1007   This is dummy command which exists only for backward compatibility.
1008
1009   @item clean
1010   @opindex keyedit:clean
1011   Compact (by removing all signatures except the selfsig) any user ID
1012   that is no longer usable (e.g. revoked, or expired). Then, remove any
1013   signatures that are not usable by the trust calculations.
1014   Specifically, this removes any signature that does not validate, any
1015   signature that is superseded by a later signature, revoked signatures,
1016   and signatures issued by keys that are not present on the keyring.
1017
1018   @item minimize
1019   @opindex keyedit:minimize
1020   Make the key as small as possible. This removes all signatures from
1021   each user ID except for the most recent self-signature.
1022
1023   @item change-usage
1024   @opindex keyedit:change-usage
1025   Change the usage flags (capabilities) of the primary key or of
1026   subkeys.  These usage flags (e.g. Certify, Sign, Authenticate,
1027   Encrypt) are set during key creation.  Sometimes it is useful to
1028   have the opportunity to change them (for example to add
1029   Authenticate) after they have been created.  Please take care when
1030   doing this; the allowed usage flags depend on the key algorithm.
1031
1032   @item cross-certify
1033   @opindex keyedit:cross-certify
1034   Add cross-certification signatures to signing subkeys that may not
1035   currently have them. Cross-certification signatures protect against a
1036   subtle attack against signing subkeys. See
1037   @option{--require-cross-certification}.  All new keys generated have
1038   this signature by default, so this command is only useful to bring
1039   older keys up to date.
1040
1041   @item save
1042   @opindex keyedit:save
1043   Save all changes to the keyrings and quit.
1044
1045   @item quit
1046   @opindex keyedit:quit
1047   Quit the program without updating the
1048   keyrings.
1049 @end table
1050
1051 @c man:.RS
1052 The listing shows you the key with its secondary keys and all user
1053 IDs.  The primary user ID is indicated by a dot, and selected keys or
1054 user IDs are indicated by an asterisk.  The trust
1055 value is displayed with the primary key: "trust" is the assigned owner
1056 trust and "validity" is the calculated validity of the key.  Validity
1057 values are also displayed for all user IDs.
1058 For possible values of trust, @pxref{trust-values}.
1059 @c man:.RE
1060 @c ******** End Edit-key Options **********
1061
1062 @item --sign-key @var{name}
1063 @opindex sign-key
1064 Signs a public key with your secret key. This is a shortcut version of
1065 the subcommand "sign" from @option{--edit}.
1066
1067 @item --lsign-key @var{name}
1068 @opindex lsign-key
1069 Signs a public key with your secret key but marks it as
1070 non-exportable. This is a shortcut version of the subcommand "lsign"
1071 from @option{--edit-key}.
1072
1073 @item --quick-sign-key @var{fpr} [@var{names}]
1074 @itemx --quick-lsign-key @var{fpr} [@var{names}]
1075 @opindex quick-sign-key
1076 @opindex quick-lsign-key
1077 Directly sign a key from the passphrase without any further user
1078 interaction.  The @var{fpr} must be the verified primary fingerprint
1079 of a key in the local keyring. If no @var{names} are given, all
1080 useful user ids are signed; with given [@var{names}] only useful user
1081 ids matching one of theses names are signed.  By default, or if a name
1082 is prefixed with a '*', a case insensitive substring match is used.
1083 If a name is prefixed with a '=' a case sensitive exact match is done.
1084
1085 The command @option{--quick-lsign-key} marks the signatures as
1086 non-exportable.  If such a non-exportable signature already exists the
1087 @option{--quick-sign-key} turns it into a exportable signature.
1088
1089 This command uses reasonable defaults and thus does not provide the
1090 full flexibility of the "sign" subcommand from @option{--edit-key}.
1091 Its intended use is to help unattended key signing by utilizing a list
1092 of verified fingerprints.
1093
1094 @item --quick-add-uid  @var{user-id} @var{new-user-id}
1095 @opindex quick-add-uid
1096 This command adds a new user id to an existing key.  In contrast to
1097 the interactive sub-command @code{adduid} of @option{--edit-key} the
1098 @var{new-user-id} is added verbatim with only leading and trailing
1099 white space removed, it is expected to be UTF-8 encoded, and no checks
1100 on its form are applied.
1101
1102 @item --quick-revoke-uid  @var{user-id} @var{user-id-to-revoke}
1103 @opindex quick-revoke-uid
1104 This command revokes a user ID on an existing key.  It cannot be used
1105 to revoke the last user ID on key (some non-revoked user ID must
1106 remain), with revocation reason ``User ID is no longer valid''.  If
1107 you want to specify a different revocation reason, or to supply
1108 supplementary revocation text, you should use the interactive
1109 sub-command @code{revuid} of @option{--edit-key}.
1110
1111 @item --quick-set-primary-uid  @var{user-id} @var{primary-user-id}
1112 @opindex quick-set-primary-uid
1113 This command sets or updates the primary user ID flag on an existing
1114 key.  @var{user-id} specifies the key and @var{primary-user-id} the
1115 user ID which shall be flagged as the primary user ID.  The primary
1116 user ID flag is removed from all other user ids and the timestamp of
1117 all affected self-signatures is set one second ahead.
1118
1119
1120 @item --change-passphrase @var{user-id}
1121 @opindex change-passphrase
1122 @itemx --passwd @var{user-id}
1123 @opindex passwd
1124 Change the passphrase of the secret key belonging to the certificate
1125 specified as @var{user-id}.  This is a shortcut for the sub-command
1126 @code{passwd} of the edit key menu.  When using together with the
1127 option @option{--dry-run} this will not actually change the passphrase
1128 but check that the current passphrase is correct.
1129
1130 @end table
1131
1132
1133 @c *******************************************
1134 @c ***************            ****************
1135 @c ***************  OPTIONS   ****************
1136 @c ***************            ****************
1137 @c *******************************************
1138 @mansect options
1139 @node GPG Options
1140 @section Option Summary
1141
1142 @command{@gpgname} features a bunch of options to control the exact
1143 behaviour and to change the default configuration.
1144
1145 @menu
1146 * GPG Configuration Options::   How to change the configuration.
1147 * GPG Key related Options::     Key related options.
1148 * GPG Input and Output::        Input and Output.
1149 * OpenPGP Options::             OpenPGP protocol specific options.
1150 * Compliance Options::          Compliance options.
1151 * GPG Esoteric Options::        Doing things one usually doesn't want to do.
1152 * Deprecated Options::          Deprecated options.
1153 @end menu
1154
1155 Long options can be put in an options file (default
1156 "~/.gnupg/gpg.conf"). Short option names will not work - for example,
1157 "armor" is a valid option for the options file, while "a" is not. Do not
1158 write the 2 dashes, but simply the name of the option and any required
1159 arguments. Lines with a hash ('#') as the first non-white-space
1160 character are ignored. Commands may be put in this file too, but that is
1161 not generally useful as the command will execute automatically with
1162 every execution of gpg.
1163
1164 Please remember that option parsing stops as soon as a non-option is
1165 encountered, you can explicitly stop parsing by using the special option
1166 @option{--}.
1167
1168 @c *******************************************
1169 @c ********  CONFIGURATION OPTIONS  **********
1170 @c *******************************************
1171 @node GPG Configuration Options
1172 @subsection How to change the configuration
1173
1174 These options are used to change the configuration and are usually found
1175 in the option file.
1176
1177 @table @gnupgtabopt
1178
1179 @item --default-key @var{name}
1180 @opindex default-key
1181 Use @var{name} as the default key to sign with. If this option is not
1182 used, the default key is the first key found in the secret keyring.
1183 Note that @option{-u} or @option{--local-user} overrides this option.
1184 This option may be given multiple times.  In this case, the last key
1185 for which a secret key is available is used.  If there is no secret
1186 key available for any of the specified values, GnuPG will not emit an
1187 error message but continue as if this option wasn't given.
1188
1189 @item --default-recipient @var{name}
1190 @opindex default-recipient
1191 Use @var{name} as default recipient if option @option{--recipient} is
1192 not used and don't ask if this is a valid one. @var{name} must be
1193 non-empty.
1194
1195 @item --default-recipient-self
1196 @opindex default-recipient-self
1197 Use the default key as default recipient if option @option{--recipient} is not
1198 used and don't ask if this is a valid one. The default key is the first
1199 one from the secret keyring or the one set with @option{--default-key}.
1200
1201 @item --no-default-recipient
1202 @opindex no-default-recipient
1203 Reset @option{--default-recipient} and @option{--default-recipient-self}.
1204
1205 @item -v, --verbose
1206 @opindex verbose
1207 Give more information during processing. If used
1208 twice, the input data is listed in detail.
1209
1210 @item --no-verbose
1211 @opindex no-verbose
1212 Reset verbose level to 0.
1213
1214 @item -q, --quiet
1215 @opindex quiet
1216 Try to be as quiet as possible.
1217
1218 @item --batch
1219 @itemx --no-batch
1220 @opindex batch
1221 @opindex no-batch
1222 Use batch mode.  Never ask, do not allow interactive commands.
1223 @option{--no-batch} disables this option.  Note that even with a
1224 filename given on the command line, gpg might still need to read from
1225 STDIN (in particular if gpg figures that the input is a
1226 detached signature and no data file has been specified).  Thus if you
1227 do not want to feed data via STDIN, you should connect STDIN to
1228 g@file{/dev/null}.
1229
1230 It is highly recommended to use this option along with the options
1231 @option{--status-fd} and @option{--with-colons} for any unattended use of
1232 @command{gpg}.
1233
1234 @item --no-tty
1235 @opindex no-tty
1236 Make sure that the TTY (terminal) is never used for any output.
1237 This option is needed in some cases because GnuPG sometimes prints
1238 warnings to the TTY even if @option{--batch} is used.
1239
1240 @item --yes
1241 @opindex yes
1242 Assume "yes" on most questions.
1243
1244 @item --no
1245 @opindex no
1246 Assume "no" on most questions.
1247
1248
1249 @item --list-options @var{parameters}
1250 @opindex list-options
1251 This is a space or comma delimited string that gives options used when
1252 listing keys and signatures (that is, @option{--list-keys},
1253 @option{--check-signatures}, @option{--list-public-keys},
1254 @option{--list-secret-keys}, and the @option{--edit-key} functions).
1255 Options can be prepended with a @option{no-} (after the two dashes) to
1256 give the opposite meaning.  The options are:
1257
1258 @table @asis
1259
1260   @item show-photos
1261   @opindex list-options:show-photos
1262   Causes @option{--list-keys}, @option{--check-signatures},
1263   @option{--list-public-keys}, and @option{--list-secret-keys} to
1264   display any photo IDs attached to the key.  Defaults to no. See also
1265   @option{--photo-viewer}.  Does not work with @option{--with-colons}:
1266   see @option{--attribute-fd} for the appropriate way to get photo data
1267   for scripts and other frontends.
1268
1269   @item show-usage
1270   @opindex list-options:show-usage
1271   Show usage information for keys and subkeys in the standard key
1272   listing.  This is a list of letters indicating the allowed usage for a
1273   key (@code{E}=encryption, @code{S}=signing, @code{C}=certification,
1274   @code{A}=authentication).  Defaults to yes.
1275
1276   @item show-policy-urls
1277   @opindex list-options:show-policy-urls
1278   Show policy URLs in the  @option{--check-signatures}
1279   listings.  Defaults to no.
1280
1281   @item show-notations
1282   @itemx show-std-notations
1283   @itemx show-user-notations
1284   @opindex list-options:show-notations
1285   @opindex list-options:show-std-notations
1286   @opindex list-options:show-user-notations
1287   Show all, IETF standard, or user-defined signature notations in the
1288   @option{--check-signatures} listings. Defaults to no.
1289
1290   @item show-keyserver-urls
1291   @opindex list-options:show-keyserver-urls
1292   Show any preferred keyserver URL in the
1293   @option{--check-signatures} listings. Defaults to no.
1294
1295   @item show-uid-validity
1296   @opindex list-options:show-uid-validity
1297   Display the calculated validity of user IDs during key listings.
1298   Defaults to yes.
1299
1300   @item show-unusable-uids
1301   @opindex list-options:show-unusable-uids
1302   Show revoked and expired user IDs in key listings. Defaults to no.
1303
1304   @item show-unusable-subkeys
1305   @opindex list-options:show-unusable-subkeys
1306   Show revoked and expired subkeys in key listings. Defaults to no.
1307
1308   @item show-keyring
1309   @opindex list-options:show-keyring
1310   Display the keyring name at the head of key listings to show which
1311   keyring a given key resides on. Defaults to no.
1312
1313   @item show-sig-expire
1314   @opindex list-options:show-sig-expire
1315   Show signature expiration dates (if any) during
1316   @option{--check-signatures} listings. Defaults to no.
1317
1318   @item show-sig-subpackets
1319   @opindex list-options:show-sig-subpackets
1320   Include signature subpackets in the key listing. This option can take an
1321   optional argument list of the subpackets to list. If no argument is
1322   passed, list all subpackets. Defaults to no. This option is only
1323   meaningful when using @option{--with-colons} along with
1324   @option{--check-signatures}.
1325
1326 @end table
1327
1328 @item --verify-options @var{parameters}
1329 @opindex verify-options
1330 This is a space or comma delimited string that gives options used when
1331 verifying signatures. Options can be prepended with a `no-' to give
1332 the opposite meaning. The options are:
1333
1334 @table @asis
1335
1336   @item show-photos
1337   @opindex verify-options:show-photos
1338   Display any photo IDs present on the key that issued the signature.
1339   Defaults to no. See also @option{--photo-viewer}.
1340
1341   @item show-policy-urls
1342   @opindex verify-options:show-policy-urls
1343   Show policy URLs in the signature being verified. Defaults to yes.
1344
1345   @item show-notations
1346   @itemx show-std-notations
1347   @itemx show-user-notations
1348   @opindex verify-options:show-notations
1349   @opindex verify-options:show-std-notations
1350   @opindex verify-options:show-user-notations
1351   Show all, IETF standard, or user-defined signature notations in the
1352   signature being verified. Defaults to IETF standard.
1353
1354   @item show-keyserver-urls
1355   @opindex verify-options:show-keyserver-urls
1356   Show any preferred keyserver URL in the signature being verified.
1357   Defaults to yes.
1358
1359   @item show-uid-validity
1360   @opindex verify-options:show-uid-validity
1361   Display the calculated validity of the user IDs on the key that issued
1362   the signature. Defaults to yes.
1363
1364   @item show-unusable-uids
1365   @opindex verify-options:show-unusable-uids
1366   Show revoked and expired user IDs during signature verification.
1367   Defaults to no.
1368
1369   @item show-primary-uid-only
1370   @opindex verify-options:show-primary-uid-only
1371   Show only the primary user ID during signature verification.  That is
1372   all the AKA lines as well as photo Ids are not shown with the signature
1373   verification status.
1374
1375   @item pka-lookups
1376   @opindex verify-options:pka-lookups
1377   Enable PKA lookups to verify sender addresses. Note that PKA is based
1378   on DNS, and so enabling this option may disclose information on when
1379   and what signatures are verified or to whom data is encrypted. This
1380   is similar to the "web bug" described for the @option{--auto-key-retrieve}
1381   option.
1382
1383   @item pka-trust-increase
1384   @opindex verify-options:pka-trust-increase
1385   Raise the trust in a signature to full if the signature passes PKA
1386   validation. This option is only meaningful if pka-lookups is set.
1387 @end table
1388
1389 @item --enable-large-rsa
1390 @itemx --disable-large-rsa
1391 @opindex enable-large-rsa
1392 @opindex disable-large-rsa
1393 With --generate-key and --batch, enable the creation of RSA secret keys as
1394 large as 8192 bit.  Note: 8192 bit is more than is generally
1395 recommended.  These large keys don't significantly improve security,
1396 but they are more expensive to use, and their signatures and
1397 certifications are larger.  This option is only available if the
1398 binary was build with large-secmem support.
1399
1400 @item --enable-dsa2
1401 @itemx --disable-dsa2
1402 @opindex enable-dsa2
1403 @opindex disable-dsa2
1404 Enable hash truncation for all DSA keys even for old DSA Keys up to
1405 1024 bit.  This is also the default with @option{--openpgp}.  Note
1406 that older versions of GnuPG also required this flag to allow the
1407 generation of DSA larger than 1024 bit.
1408
1409 @item --photo-viewer @var{string}
1410 @opindex photo-viewer
1411 This is the command line that should be run to view a photo ID. "%i"
1412 will be expanded to a filename containing the photo. "%I" does the
1413 same, except the file will not be deleted once the viewer exits.
1414 Other flags are "%k" for the key ID, "%K" for the long key ID, "%f"
1415 for the key fingerprint, "%t" for the extension of the image type
1416 (e.g. "jpg"), "%T" for the MIME type of the image (e.g. "image/jpeg"),
1417 "%v" for the single-character calculated validity of the image being
1418 viewed (e.g. "f"), "%V" for the calculated validity as a string (e.g.
1419 "full"), "%U" for a base32 encoded hash of the user ID,
1420 and "%%" for an actual percent sign. If neither %i or %I are present,
1421 then the photo will be supplied to the viewer on standard input.
1422
1423 The default viewer is "xloadimage -fork -quiet -title 'KeyID 0x%k'
1424 STDIN". Note that if your image viewer program is not secure, then
1425 executing it from GnuPG does not make it secure.
1426
1427 @item --exec-path @var{string}
1428 @opindex exec-path
1429 @efindex PATH
1430 Sets a list of directories to search for photo viewers and keyserver
1431 helpers. If not provided, keyserver helpers use the compiled-in
1432 default directory, and photo viewers use the @code{PATH} environment
1433 variable.
1434 Note, that on W32 system this value is ignored when searching for
1435 keyserver helpers.
1436
1437 @item --keyring @var{file}
1438 @opindex keyring
1439 Add @var{file} to the current list of keyrings. If @var{file} begins
1440 with a tilde and a slash, these are replaced by the $HOME directory. If
1441 the filename does not contain a slash, it is assumed to be in the GnuPG
1442 home directory ("~/.gnupg" if @option{--homedir} or $GNUPGHOME is not
1443 used).
1444
1445 Note that this adds a keyring to the current list. If the intent is to
1446 use the specified keyring alone, use @option{--keyring} along with
1447 @option{--no-default-keyring}.
1448
1449 If the option @option{--no-keyring} has been used no keyrings will
1450 be used at all.
1451
1452
1453 @item --secret-keyring @var{file}
1454 @opindex secret-keyring
1455 This is an obsolete option and ignored.  All secret keys are stored in
1456 the @file{private-keys-v1.d} directory below the GnuPG home directory.
1457
1458 @item --primary-keyring @var{file}
1459 @opindex primary-keyring
1460 Designate @var{file} as the primary public keyring. This means that
1461 newly imported keys (via @option{--import} or keyserver
1462 @option{--recv-from}) will go to this keyring.
1463
1464 @item --trustdb-name @var{file}
1465 @opindex trustdb-name
1466 Use @var{file} instead of the default trustdb. If @var{file} begins
1467 with a tilde and a slash, these are replaced by the $HOME directory. If
1468 the filename does not contain a slash, it is assumed to be in the GnuPG
1469 home directory (@file{~/.gnupg} if @option{--homedir} or $GNUPGHOME is
1470 not used).
1471
1472 @include opt-homedir.texi
1473
1474
1475 @item --display-charset @var{name}
1476 @opindex display-charset
1477 Set the name of the native character set. This is used to convert
1478 some informational strings like user IDs to the proper UTF-8 encoding.
1479 Note that this has nothing to do with the character set of data to be
1480 encrypted or signed; GnuPG does not recode user-supplied data. If
1481 this option is not used, the default character set is determined from
1482 the current locale. A verbosity level of 3 shows the chosen set.
1483 Valid values for @var{name} are:
1484
1485 @table @asis
1486
1487   @item iso-8859-1
1488   @opindex display-charset:iso-8859-1
1489   This is the Latin 1 set.
1490
1491   @item iso-8859-2
1492   @opindex display-charset:iso-8859-2
1493   The Latin 2 set.
1494
1495   @item iso-8859-15
1496   @opindex display-charset:iso-8859-15
1497   This is currently an alias for
1498   the Latin 1 set.
1499
1500   @item koi8-r
1501   @opindex display-charset:koi8-r
1502   The usual Russian set (RFC-1489).
1503
1504   @item utf-8
1505   @opindex display-charset:utf-8
1506   Bypass all translations and assume
1507   that the OS uses native UTF-8 encoding.
1508 @end table
1509
1510 @item --utf8-strings
1511 @itemx --no-utf8-strings
1512 @opindex utf8-strings
1513 Assume that command line arguments are given as UTF-8 strings. The
1514 default (@option{--no-utf8-strings}) is to assume that arguments are
1515 encoded in the character set as specified by
1516 @option{--display-charset}. These options affect all following
1517 arguments. Both options may be used multiple times.
1518
1519 @anchor{gpg-option --options}
1520 @item --options @var{file}
1521 @opindex options
1522 Read options from @var{file} and do not try to read them from the
1523 default options file in the homedir (see @option{--homedir}). This
1524 option is ignored if used in an options file.
1525
1526 @item --no-options
1527 @opindex no-options
1528 Shortcut for @option{--options /dev/null}. This option is detected
1529 before an attempt to open an option file.  Using this option will also
1530 prevent the creation of a @file{~/.gnupg} homedir.
1531
1532 @item -z @var{n}
1533 @itemx --compress-level @var{n}
1534 @itemx --bzip2-compress-level @var{n}
1535 @opindex compress-level
1536 @opindex bzip2-compress-level
1537 Set compression level to @var{n} for the ZIP and ZLIB compression
1538 algorithms. The default is to use the default compression level of zlib
1539 (normally 6). @option{--bzip2-compress-level} sets the compression level
1540 for the BZIP2 compression algorithm (defaulting to 6 as well). This is a
1541 different option from @option{--compress-level} since BZIP2 uses a
1542 significant amount of memory for each additional compression level.
1543 @option{-z} sets both. A value of 0 for @var{n} disables compression.
1544
1545 @item --bzip2-decompress-lowmem
1546 @opindex bzip2-decompress-lowmem
1547 Use a different decompression method for BZIP2 compressed files. This
1548 alternate method uses a bit more than half the memory, but also runs
1549 at half the speed. This is useful under extreme low memory
1550 circumstances when the file was originally compressed at a high
1551 @option{--bzip2-compress-level}.
1552
1553
1554 @item --mangle-dos-filenames
1555 @itemx --no-mangle-dos-filenames
1556 @opindex mangle-dos-filenames
1557 @opindex no-mangle-dos-filenames
1558 Older version of Windows cannot handle filenames with more than one
1559 dot. @option{--mangle-dos-filenames} causes GnuPG to replace (rather
1560 than add to) the extension of an output filename to avoid this
1561 problem. This option is off by default and has no effect on non-Windows
1562 platforms.
1563
1564 @item --ask-cert-level
1565 @itemx --no-ask-cert-level
1566 @opindex ask-cert-level
1567 When making a key signature, prompt for a certification level. If this
1568 option is not specified, the certification level used is set via
1569 @option{--default-cert-level}. See @option{--default-cert-level} for
1570 information on the specific levels and how they are
1571 used. @option{--no-ask-cert-level} disables this option. This option
1572 defaults to no.
1573
1574 @item --default-cert-level @var{n}
1575 @opindex default-cert-level
1576 The default to use for the check level when signing a key.
1577
1578 0 means you make no particular claim as to how carefully you verified
1579 the key.
1580
1581 1 means you believe the key is owned by the person who claims to own
1582 it but you could not, or did not verify the key at all. This is
1583 useful for a "persona" verification, where you sign the key of a
1584 pseudonymous user.
1585
1586 2 means you did casual verification of the key. For example, this
1587 could mean that you verified the key fingerprint and checked the
1588 user ID on the key against a photo ID.
1589
1590 3 means you did extensive verification of the key. For example, this
1591 could mean that you verified the key fingerprint with the owner of the
1592 key in person, and that you checked, by means of a hard to forge
1593 document with a photo ID (such as a passport) that the name of the key
1594 owner matches the name in the user ID on the key, and finally that you
1595 verified (by exchange of email) that the email address on the key
1596 belongs to the key owner.
1597
1598 Note that the examples given above for levels 2 and 3 are just that:
1599 examples. In the end, it is up to you to decide just what "casual"
1600 and "extensive" mean to you.
1601
1602 This option defaults to 0 (no particular claim).
1603
1604 @item --min-cert-level
1605 @opindex min-cert-level
1606 When building the trust database, treat any signatures with a
1607 certification level below this as invalid. Defaults to 2, which
1608 disregards level 1 signatures. Note that level 0 "no particular
1609 claim" signatures are always accepted.
1610
1611 @item --trusted-key @var{long key ID}
1612 @opindex trusted-key
1613 Assume that the specified key (which must be given
1614 as a full 8 byte key ID) is as trustworthy as one of
1615 your own secret keys. This option is useful if you
1616 don't want to keep your secret keys (or one of them)
1617 online but still want to be able to check the validity of a given
1618 recipient's or signator's key.
1619
1620 @item --trust-model @{pgp|classic|tofu|tofu+pgp|direct|always|auto@}
1621 @opindex trust-model
1622 Set what trust model GnuPG should follow. The models are:
1623
1624 @table @asis
1625
1626   @item pgp
1627   @opindex trust-model:pgp
1628   This is the Web of Trust combined with trust signatures as used in PGP
1629   5.x and later. This is the default trust model when creating a new
1630   trust database.
1631
1632   @item classic
1633   @opindex trust-model:classic
1634   This is the standard Web of Trust as introduced by PGP 2.
1635
1636   @item tofu
1637   @opindex trust-model:tofu
1638   @anchor{trust-model-tofu}
1639   TOFU stands for Trust On First Use.  In this trust model, the first
1640   time a key is seen, it is memorized.  If later another key with a
1641   user id with the same email address is seen, both keys are marked as
1642   suspect.  In that case, the next time either is used, a warning is
1643   displayed describing the conflict, why it might have occurred
1644   (either the user generated a new key and failed to cross sign the
1645   old and new keys, the key is forgery, or a man-in-the-middle attack
1646   is being attempted), and the user is prompted to manually confirm
1647   the validity of the key in question.
1648
1649   Because a potential attacker is able to control the email address
1650   and thereby circumvent the conflict detection algorithm by using an
1651   email address that is similar in appearance to a trusted email
1652   address, whenever a message is verified, statistics about the number
1653   of messages signed with the key are shown.  In this way, a user can
1654   easily identify attacks using fake keys for regular correspondents.
1655
1656   When compared with the Web of Trust, TOFU offers significantly
1657   weaker security guarantees.  In particular, TOFU only helps ensure
1658   consistency (that is, that the binding between a key and email
1659   address doesn't change).  A major advantage of TOFU is that it
1660   requires little maintenance to use correctly.  To use the web of
1661   trust properly, you need to actively sign keys and mark users as
1662   trusted introducers.  This is a time-consuming process and anecdotal
1663   evidence suggests that even security-conscious users rarely take the
1664   time to do this thoroughly and instead rely on an ad-hoc TOFU
1665   process.
1666
1667   In the TOFU model, policies are associated with bindings between
1668   keys and email addresses (which are extracted from user ids and
1669   normalized).  There are five policies, which can be set manually
1670   using the @option{--tofu-policy} option.  The default policy can be
1671   set using the @option{--tofu-default-policy} option.
1672
1673   The TOFU policies are: @code{auto}, @code{good}, @code{unknown},
1674   @code{bad} and @code{ask}.  The @code{auto} policy is used by
1675   default (unless overridden by @option{--tofu-default-policy}) and
1676   marks a binding as marginally trusted.  The @code{good},
1677   @code{unknown} and @code{bad} policies mark a binding as fully
1678   trusted, as having unknown trust or as having trust never,
1679   respectively.  The @code{unknown} policy is useful for just using
1680   TOFU to detect conflicts, but to never assign positive trust to a
1681   binding.  The final policy, @code{ask} prompts the user to indicate
1682   the binding's trust.  If batch mode is enabled (or input is
1683   inappropriate in the context), then the user is not prompted and the
1684   @code{undefined} trust level is returned.
1685
1686   @item tofu+pgp
1687   @opindex trust-model:tofu+pgp
1688   This trust model combines TOFU with the Web of Trust.  This is done
1689   by computing the trust level for each model and then taking the
1690   maximum trust level where the trust levels are ordered as follows:
1691   @code{unknown < undefined < marginal < fully < ultimate < expired <
1692   never}.
1693
1694   By setting @option{--tofu-default-policy=unknown}, this model can be
1695   used to implement the web of trust with TOFU's conflict detection
1696   algorithm, but without its assignment of positive trust values,
1697   which some security-conscious users don't like.
1698
1699   @item direct
1700   @opindex trust-model:direct
1701   Key validity is set directly by the user and not calculated via the
1702   Web of Trust.  This model is solely based on the key and does
1703   not distinguish user IDs.  Note that when changing to another trust
1704   model the trust values assigned to a key are transformed into
1705   ownertrust values, which also indicate how you trust the owner of
1706   the key to sign other keys.
1707
1708   @item always
1709   @opindex trust-model:always
1710   Skip key validation and assume that used keys are always fully
1711   valid. You generally won't use this unless you are using some
1712   external validation scheme. This option also suppresses the
1713   "[uncertain]" tag printed with signature checks when there is no
1714   evidence that the user ID is bound to the key.  Note that this
1715   trust model still does not allow the use of expired, revoked, or
1716   disabled keys.
1717
1718   @item auto
1719   @opindex trust-model:auto
1720   Select the trust model depending on whatever the internal trust
1721   database says. This is the default model if such a database already
1722   exists.
1723 @end table
1724
1725 @item --auto-key-locate @var{mechanisms}
1726 @itemx --no-auto-key-locate
1727 @opindex auto-key-locate
1728 GnuPG can automatically locate and retrieve keys as needed using this
1729 option.  This happens when encrypting to an email address (in the
1730 "user@@example.com" form), and there are no "user@@example.com" keys
1731 on the local keyring.  This option takes any number of the mechanisms
1732 listed below, in the order they are to be tried.  Instead of listing
1733 the mechanisms as comma delimited arguments, the option may also be
1734 given several times to add more mechanism.  The option
1735 @option{--no-auto-key-locate} or the mechanism "clear" resets the
1736 list.  The default is "local,wkd".
1737
1738 @table @asis
1739
1740   @item cert
1741   Locate a key using DNS CERT, as specified in RFC-4398.
1742
1743   @item pka
1744   Locate a key using DNS PKA.
1745
1746   @item dane
1747   Locate a key using DANE, as specified
1748   in draft-ietf-dane-openpgpkey-05.txt.
1749
1750   @item wkd
1751   Locate a key using the Web Key Directory protocol.
1752
1753   @item ldap
1754   Using DNS Service Discovery, check the domain in question for any LDAP
1755   keyservers to use.  If this fails, attempt to locate the key using the
1756   PGP Universal method of checking @samp{ldap://keys.(thedomain)}.
1757
1758   @item keyserver
1759   Locate a key using whatever keyserver is defined using the
1760   @option{--keyserver} option.
1761
1762   @item keyserver-URL
1763   In addition, a keyserver URL as used in the @option{--keyserver} option
1764   may be used here to query that particular keyserver.
1765
1766   @item local
1767   Locate the key using the local keyrings.  This mechanism allows the user to
1768   select the order a local key lookup is done.  Thus using
1769   @samp{--auto-key-locate local} is identical to
1770   @option{--no-auto-key-locate}.
1771
1772   @item nodefault
1773   This flag disables the standard local key lookup, done before any of the
1774   mechanisms defined by the @option{--auto-key-locate} are tried.  The
1775   position of this mechanism in the list does not matter.  It is not
1776   required if @code{local} is also used.
1777
1778   @item clear
1779   Clear all defined mechanisms.  This is useful to override
1780   mechanisms given in a config file.
1781
1782 @end table
1783
1784
1785 @item --auto-key-retrieve
1786 @itemx --no-auto-key-retrieve
1787 @opindex auto-key-retrieve
1788 @opindex no-auto-key-retrieve
1789 These options enable or disable the automatic retrieving of keys from
1790 a keyserver when verifying signatures made by keys that are not on the
1791 local keyring.  The default is @option{--no-auto-key-retrieve}.
1792
1793 If the method "wkd" is included in the list of methods given to
1794 @option{auto-key-locate}, the signer's user ID is part of the
1795 signature, and the option @option{--disable-signer-uid} is not used,
1796 the "wkd" method may also be used to retrieve a key.
1797
1798 Note that this option makes a "web bug" like behavior possible.
1799 Keyserver or Web Key Directory operators can see which keys you
1800 request, so by sending you a message signed by a brand new key (which
1801 you naturally will not have on your local keyring), the operator can
1802 tell both your IP address and the time when you verified the
1803 signature.
1804
1805 @item --keyid-format @{none|short|0xshort|long|0xlong@}
1806 @opindex keyid-format
1807 Select how to display key IDs.  "none" does not show the key ID at all
1808 but shows the fingerprint in a separate line.  "short" is the
1809 traditional 8-character key ID.  "long" is the more accurate (but less
1810 convenient) 16-character key ID.  Add an "0x" to either to include an
1811 "0x" at the beginning of the key ID, as in 0x99242560.  Note that this
1812 option is ignored if the option @option{--with-colons} is used.
1813
1814 @item --keyserver @var{name}
1815 @opindex keyserver
1816 This option is deprecated - please use the @option{--keyserver} in
1817 @file{dirmngr.conf} instead.
1818
1819 Use @var{name} as your keyserver. This is the server that
1820 @option{--receive-keys}, @option{--send-keys}, and @option{--search-keys}
1821 will communicate with to receive keys from, send keys to, and search for
1822 keys on. The format of the @var{name} is a URI:
1823 `scheme:[//]keyservername[:port]' The scheme is the type of keyserver:
1824 "hkp" for the HTTP (or compatible) keyservers, "ldap" for the LDAP
1825 keyservers, or "mailto" for the Graff email keyserver. Note that your
1826 particular installation of GnuPG may have other keyserver types
1827 available as well. Keyserver schemes are case-insensitive. After the
1828 keyserver name, optional keyserver configuration options may be
1829 provided. These are the same as the global @option{--keyserver-options}
1830 from below, but apply only to this particular keyserver.
1831
1832 Most keyservers synchronize with each other, so there is generally no
1833 need to send keys to more than one server. The keyserver
1834 @code{hkp://keys.gnupg.net} uses round robin DNS to give a different
1835 keyserver each time you use it.
1836
1837 @item --keyserver-options @{@var{name}=@var{value}@}
1838 @opindex keyserver-options
1839 This is a space or comma delimited string that gives options for the
1840 keyserver. Options can be prefixed with a `no-' to give the opposite
1841 meaning. Valid import-options or export-options may be used here as
1842 well to apply to importing (@option{--recv-key}) or exporting
1843 (@option{--send-key}) a key from a keyserver. While not all options
1844 are available for all keyserver types, some common options are:
1845
1846 @table @asis
1847
1848   @item include-revoked
1849   When searching for a key with @option{--search-keys}, include keys that
1850   are marked on the keyserver as revoked. Note that not all keyservers
1851   differentiate between revoked and unrevoked keys, and for such
1852   keyservers this option is meaningless. Note also that most keyservers do
1853   not have cryptographic verification of key revocations, and so turning
1854   this option off may result in skipping keys that are incorrectly marked
1855   as revoked.
1856
1857   @item include-disabled
1858   When searching for a key with @option{--search-keys}, include keys that
1859   are marked on the keyserver as disabled. Note that this option is not
1860   used with HKP keyservers.
1861
1862   @item auto-key-retrieve
1863   This is an obsolete alias for the option @option{auto-key-retrieve}.
1864   Please do not use it; it will be removed in future versions..
1865
1866   @item honor-keyserver-url
1867   When using @option{--refresh-keys}, if the key in question has a preferred
1868   keyserver URL, then use that preferred keyserver to refresh the key
1869   from. In addition, if auto-key-retrieve is set, and the signature
1870   being verified has a preferred keyserver URL, then use that preferred
1871   keyserver to fetch the key from. Note that this option introduces a
1872   "web bug": The creator of the key can see when the keys is
1873   refreshed.  Thus this option is not enabled by default.
1874
1875   @item honor-pka-record
1876   If @option{--auto-key-retrieve} is used, and the signature being
1877   verified has a PKA record, then use the PKA information to fetch
1878   the key. Defaults to "yes".
1879
1880   @item include-subkeys
1881   When receiving a key, include subkeys as potential targets. Note that
1882   this option is not used with HKP keyservers, as they do not support
1883   retrieving keys by subkey id.
1884
1885   @item timeout
1886   Tell the keyserver helper program how long (in seconds) to try and
1887   perform a keyserver action before giving up. Note that performing
1888   multiple actions at the same time uses this timeout value per action.
1889   For example, when retrieving multiple keys via @option{--receive-keys}, the
1890   timeout applies separately to each key retrieval, and not to the
1891   @option{--receive-keys} command as a whole. Defaults to 30 seconds.
1892
1893   @item http-proxy=@var{value}
1894   This option is deprecated.
1895   Set the proxy to use for HTTP and HKP keyservers.
1896   This overrides any proxy defined in @file{dirmngr.conf}.
1897
1898   @item verbose
1899   This option has no more function since GnuPG 2.1.  Use the
1900   @code{dirmngr} configuration options instead.
1901
1902   @item debug
1903   This option has no more function since GnuPG 2.1.  Use the
1904   @code{dirmngr} configuration options instead.
1905
1906   @item check-cert
1907   This option has no more function since GnuPG 2.1.  Use the
1908   @code{dirmngr} configuration options instead.
1909
1910   @item ca-cert-file
1911   This option has no more function since GnuPG 2.1.  Use the
1912   @code{dirmngr} configuration options instead.
1913
1914 @end table
1915
1916 @item --completes-needed @var{n}
1917 @opindex compliant-needed
1918 Number of completely trusted users to introduce a new
1919 key signer (defaults to 1).
1920
1921 @item --marginals-needed @var{n}
1922 @opindex marginals-needed
1923 Number of marginally trusted users to introduce a new
1924 key signer (defaults to 3)
1925
1926 @item --tofu-default-policy @{auto|good|unknown|bad|ask@}
1927 @opindex tofu-default-policy
1928 The default TOFU policy (defaults to @code{auto}).  For more
1929 information about the meaning of this option, @pxref{trust-model-tofu}.
1930
1931 @item --max-cert-depth @var{n}
1932 @opindex max-cert-depth
1933 Maximum depth of a certification chain (default is 5).
1934
1935 @item --no-sig-cache
1936 @opindex no-sig-cache
1937 Do not cache the verification status of key signatures.
1938 Caching gives a much better performance in key listings. However, if
1939 you suspect that your public keyring is not safe against write
1940 modifications, you can use this option to disable the caching. It
1941 probably does not make sense to disable it because all kind of damage
1942 can be done if someone else has write access to your public keyring.
1943
1944 @item --auto-check-trustdb
1945 @itemx --no-auto-check-trustdb
1946 @opindex auto-check-trustdb
1947 If GnuPG feels that its information about the Web of Trust has to be
1948 updated, it automatically runs the @option{--check-trustdb} command
1949 internally.  This may be a time consuming
1950 process. @option{--no-auto-check-trustdb} disables this option.
1951
1952 @item --use-agent
1953 @itemx --no-use-agent
1954 @opindex use-agent
1955 This is dummy option. @command{@gpgname} always requires the agent.
1956
1957 @item --gpg-agent-info
1958 @opindex gpg-agent-info
1959 This is dummy option. It has no effect when used with @command{@gpgname}.
1960
1961
1962 @item --agent-program @var{file}
1963 @opindex agent-program
1964 Specify an agent program to be used for secret key operations.  The
1965 default value is determined by running @command{gpgconf} with the
1966 option @option{--list-dirs}.  Note that the pipe symbol (@code{|}) is
1967 used for a regression test suite hack and may thus not be used in the
1968 file name.
1969
1970 @item --dirmngr-program @var{file}
1971 @opindex dirmngr-program
1972 Specify a dirmngr program to be used for keyserver access.  The
1973 default value is @file{@value{BINDIR}/dirmngr}.
1974
1975 @item --disable-dirmngr
1976 Entirely disable the use of the Dirmngr.
1977
1978 @item --no-autostart
1979 @opindex no-autostart
1980 Do not start the gpg-agent or the dirmngr if it has not yet been
1981 started and its service is required.  This option is mostly useful on
1982 machines where the connection to gpg-agent has been redirected to
1983 another machines.  If dirmngr is required on the remote machine, it
1984 may be started manually using @command{gpgconf --launch dirmngr}.
1985
1986 @item --lock-once
1987 @opindex lock-once
1988 Lock the databases the first time a lock is requested
1989 and do not release the lock until the process
1990 terminates.
1991
1992 @item --lock-multiple
1993 @opindex lock-multiple
1994 Release the locks every time a lock is no longer
1995 needed. Use this to override a previous @option{--lock-once}
1996 from a config file.
1997
1998 @item --lock-never
1999 @opindex lock-never
2000 Disable locking entirely. This option should be used only in very
2001 special environments, where it can be assured that only one process
2002 is accessing those files. A bootable floppy with a stand-alone
2003 encryption system will probably use this. Improper usage of this
2004 option may lead to data and key corruption.
2005
2006 @item --exit-on-status-write-error
2007 @opindex exit-on-status-write-error
2008 This option will cause write errors on the status FD to immediately
2009 terminate the process. That should in fact be the default but it never
2010 worked this way and thus we need an option to enable this, so that the
2011 change won't break applications which close their end of a status fd
2012 connected pipe too early. Using this option along with
2013 @option{--enable-progress-filter} may be used to cleanly cancel long
2014 running gpg operations.
2015
2016 @item --limit-card-insert-tries @var{n}
2017 @opindex limit-card-insert-tries
2018 With @var{n} greater than 0 the number of prompts asking to insert a
2019 smartcard gets limited to N-1. Thus with a value of 1 gpg won't at
2020 all ask to insert a card if none has been inserted at startup. This
2021 option is useful in the configuration file in case an application does
2022 not know about the smartcard support and waits ad infinitum for an
2023 inserted card.
2024
2025 @item --no-random-seed-file
2026 @opindex no-random-seed-file
2027 GnuPG uses a file to store its internal random pool over invocations.
2028 This makes random generation faster; however sometimes write operations
2029 are not desired. This option can be used to achieve that with the cost of
2030 slower random generation.
2031
2032 @item --no-greeting
2033 @opindex no-greeting
2034 Suppress the initial copyright message.
2035
2036 @item --no-secmem-warning
2037 @opindex no-secmem-warning
2038 Suppress the warning about "using insecure memory".
2039
2040 @item --no-permission-warning
2041 @opindex permission-warning
2042 Suppress the warning about unsafe file and home directory (@option{--homedir})
2043 permissions. Note that the permission checks that GnuPG performs are
2044 not intended to be authoritative, but rather they simply warn about
2045 certain common permission problems. Do not assume that the lack of a
2046 warning means that your system is secure.
2047
2048 Note that the warning for unsafe @option{--homedir} permissions cannot be
2049 suppressed in the gpg.conf file, as this would allow an attacker to
2050 place an unsafe gpg.conf file in place, and use this file to suppress
2051 warnings about itself. The @option{--homedir} permissions warning may only be
2052 suppressed on the command line.
2053
2054 @item --require-secmem
2055 @itemx --no-require-secmem
2056 @opindex require-secmem
2057 Refuse to run if GnuPG cannot get secure memory. Defaults to no
2058 (i.e. run, but give a warning).
2059
2060
2061 @item --require-cross-certification
2062 @itemx --no-require-cross-certification
2063 @opindex require-cross-certification
2064 When verifying a signature made from a subkey, ensure that the cross
2065 certification "back signature" on the subkey is present and valid.  This
2066 protects against a subtle attack against subkeys that can sign.
2067 Defaults to @option{--require-cross-certification} for
2068 @command{@gpgname}.
2069
2070 @item --expert
2071 @itemx --no-expert
2072 @opindex expert
2073 Allow the user to do certain nonsensical or "silly" things like
2074 signing an expired or revoked key, or certain potentially incompatible
2075 things like generating unusual key types. This also disables certain
2076 warning messages about potentially incompatible actions. As the name
2077 implies, this option is for experts only. If you don't fully
2078 understand the implications of what it allows you to do, leave this
2079 off. @option{--no-expert} disables this option.
2080
2081 @end table
2082
2083
2084 @c *******************************************
2085 @c ********  KEY RELATED OPTIONS  ************
2086 @c *******************************************
2087 @node GPG Key related Options
2088 @subsection Key related options
2089
2090 @table @gnupgtabopt
2091
2092 @item --recipient @var{name}
2093 @itemx -r
2094 @opindex recipient
2095 Encrypt for user id @var{name}. If this option or
2096 @option{--hidden-recipient} is not specified, GnuPG asks for the user-id
2097 unless @option{--default-recipient} is given.
2098
2099 @item --hidden-recipient @var{name}
2100 @itemx -R
2101 @opindex hidden-recipient
2102 Encrypt for user ID @var{name}, but hide the key ID of this user's
2103 key. This option helps to hide the receiver of the message and is a
2104 limited countermeasure against traffic analysis. If this option or
2105 @option{--recipient} is not specified, GnuPG asks for the user ID unless
2106 @option{--default-recipient} is given.
2107
2108 @item --recipient-file @var{file}
2109 @itemx -f
2110 @opindex recipient-file
2111 This option is similar to @option{--recipient} except that it
2112 encrypts to a key stored in the given file.  @var{file} must be the
2113 name of a file containing exactly one key.  @command{@gpgname} assumes that
2114 the key in this file is fully valid.
2115
2116 @item --hidden-recipient-file @var{file}
2117 @itemx -F
2118 @opindex hidden-recipient-file
2119 This option is similar to @option{--hidden-recipient} except that it
2120 encrypts to a key stored in the given file.  @var{file} must be the
2121 name of a file containing exactly one key.  @command{@gpgname} assumes that
2122 the key in this file is fully valid.
2123
2124 @item --encrypt-to @var{name}
2125 @opindex encrypt-to
2126 Same as @option{--recipient} but this one is intended for use in the
2127 options file and may be used with your own user-id as an
2128 "encrypt-to-self". These keys are only used when there are other
2129 recipients given either by use of @option{--recipient} or by the asked
2130 user id.  No trust checking is performed for these user ids and even
2131 disabled keys can be used.
2132
2133 @item --hidden-encrypt-to @var{name}
2134 @opindex hidden-encrypt-to
2135 Same as @option{--hidden-recipient} but this one is intended for use in the
2136 options file and may be used with your own user-id as a hidden
2137 "encrypt-to-self". These keys are only used when there are other
2138 recipients given either by use of @option{--recipient} or by the asked user id.
2139 No trust checking is performed for these user ids and even disabled
2140 keys can be used.
2141
2142 @item --no-encrypt-to
2143 @opindex no-encrypt-to
2144 Disable the use of all @option{--encrypt-to} and
2145 @option{--hidden-encrypt-to} keys.
2146
2147 @item --group @{@var{name}=@var{value}@}
2148 @opindex group
2149 Sets up a named group, which is similar to aliases in email programs.
2150 Any time the group name is a recipient (@option{-r} or
2151 @option{--recipient}), it will be expanded to the values
2152 specified. Multiple groups with the same name are automatically merged
2153 into a single group.
2154
2155 The values are @code{key IDs} or fingerprints, but any key description
2156 is accepted. Note that a value with spaces in it will be treated as
2157 two different values. Note also there is only one level of expansion
2158 --- you cannot make an group that points to another group. When used
2159 from the command line, it may be necessary to quote the argument to
2160 this option to prevent the shell from treating it as multiple
2161 arguments.
2162
2163 @item --ungroup @var{name}
2164 @opindex ungroup
2165 Remove a given entry from the @option{--group} list.
2166
2167 @item --no-groups
2168 @opindex no-groups
2169 Remove all entries from the @option{--group} list.
2170
2171 @item --local-user @var{name}
2172 @itemx -u
2173 @opindex local-user
2174 Use @var{name} as the key to sign with. Note that this option overrides
2175 @option{--default-key}.
2176
2177 @item --sender @var{mbox}
2178 @opindex sender
2179 This option has two purposes.  @var{mbox} must either be a complete
2180 user id with a proper mail address or just a mail address.  When
2181 creating a signature this option tells gpg the user id of a key used
2182 to make a signature if the key was not directly specified by a user
2183 id.  When verifying a signature the @var{mbox} is used to restrict the
2184 information printed by the TOFU code to matching user ids.
2185
2186 @item --try-secret-key @var{name}
2187 @opindex try-secret-key
2188 For hidden recipients GPG needs to know the keys to use for trial
2189 decryption.  The key set with @option{--default-key} is always tried
2190 first, but this is often not sufficient.  This option allows setting more
2191 keys to be used for trial decryption.  Although any valid user-id
2192 specification may be used for @var{name} it makes sense to use at least
2193 the long keyid to avoid ambiguities.  Note that gpg-agent might pop up a
2194 pinentry for a lot keys to do the trial decryption.  If you want to stop
2195 all further trial decryption you may use close-window button instead of
2196 the cancel button.
2197
2198 @item --try-all-secrets
2199 @opindex try-all-secrets
2200 Don't look at the key ID as stored in the message but try all secret
2201 keys in turn to find the right decryption key. This option forces the
2202 behaviour as used by anonymous recipients (created by using
2203 @option{--throw-keyids} or @option{--hidden-recipient}) and might come
2204 handy in case where an encrypted message contains a bogus key ID.
2205
2206 @item --skip-hidden-recipients
2207 @itemx --no-skip-hidden-recipients
2208 @opindex skip-hidden-recipients
2209 @opindex no-skip-hidden-recipients
2210 During decryption skip all anonymous recipients.  This option helps in
2211 the case that people use the hidden recipients feature to hide their
2212 own encrypt-to key from others.  If one has many secret keys this
2213 may lead to a major annoyance because all keys are tried in turn to
2214 decrypt something which was not really intended for it.  The drawback
2215 of this option is that it is currently not possible to decrypt a
2216 message which includes real anonymous recipients.
2217
2218
2219 @end table
2220
2221 @c *******************************************
2222 @c ********  INPUT AND OUTPUT  ***************
2223 @c *******************************************
2224 @node GPG Input and Output
2225 @subsection Input and Output
2226
2227 @table @gnupgtabopt
2228
2229 @item --armor
2230 @itemx -a
2231 @opindex armor
2232 Create ASCII armored output.  The default is to create the binary
2233 OpenPGP format.
2234
2235 @item --no-armor
2236 @opindex no-armor
2237 Assume the input data is not in ASCII armored format.
2238
2239 @item --output @var{file}
2240 @itemx -o @var{file}
2241 @opindex output
2242 Write output to @var{file}.  To write to stdout use @code{-} as the
2243 filename.
2244
2245 @item --max-output @var{n}
2246 @opindex max-output
2247 This option sets a limit on the number of bytes that will be generated
2248 when processing a file. Since OpenPGP supports various levels of
2249 compression, it is possible that the plaintext of a given message may be
2250 significantly larger than the original OpenPGP message. While GnuPG
2251 works properly with such messages, there is often a desire to set a
2252 maximum file size that will be generated before processing is forced to
2253 stop by the OS limits. Defaults to 0, which means "no limit".
2254
2255 @item --chunk-size @var{n}
2256 @opindex chunk-size
2257 The AEAD encryption mode encrypts the data in chunks so that a
2258 receiving side can check for transmission errors or tampering at the
2259 end of each chunk and does not need to delay this until all data has
2260 been received.  The used chunk size is 2^@var{n} byte.  The lowest
2261 allowed value for @var{n} is 6 (64 byte) and the largest is 62 (4
2262 EiB). The default value for @var{n} is 30 which creates chunks not
2263 larger than 1 GiB.
2264
2265 @item --input-size-hint @var{n}
2266 @opindex input-size-hint
2267 This option can be used to tell GPG the size of the input data in
2268 bytes.  @var{n} must be a positive base-10 number.  This option is
2269 only useful if the input is not taken from a file.  GPG may use this
2270 hint to optimize its buffer allocation strategy.  It is also used by
2271 the @option{--status-fd} line ``PROGRESS'' to provide a value for
2272 ``total'' if that is not available by other means.
2273
2274 @item --key-origin @var{string}[,@var{url}]
2275 @opindex key-origin
2276 gpg can track the origin of a key. Certain origins are implicitly
2277 known (e.g. keyserver, web key directory) and set.  For a standard
2278 import the origin of the keys imported can be set with this option.
2279 To list the possible values use "help" for @var{string}.  Some origins
2280 can store an optional @var{url} argument.  That URL can appended to
2281 @var{string} after a comma.
2282
2283 @item --import-options @var{parameters}
2284 @opindex import-options
2285 This is a space or comma delimited string that gives options for
2286 importing keys. Options can be prepended with a `no-' to give the
2287 opposite meaning. The options are:
2288
2289 @table @asis
2290
2291   @item import-local-sigs
2292   Allow importing key signatures marked as "local". This is not
2293   generally useful unless a shared keyring scheme is being used.
2294   Defaults to no.
2295
2296   @item keep-ownertrust
2297   Normally possible still existing ownertrust values of a key are
2298   cleared if a key is imported.  This is in general desirable so that
2299   a formerly deleted key does not automatically gain an ownertrust
2300   values merely due to import.  On the other hand it is sometimes
2301   necessary to re-import a trusted set of keys again but keeping
2302   already assigned ownertrust values.  This can be achieved by using
2303   this option.
2304
2305   @item repair-pks-subkey-bug
2306   During import, attempt to repair the damage caused by the PKS keyserver
2307   bug (pre version 0.9.6) that mangles keys with multiple subkeys. Note
2308   that this cannot completely repair the damaged key as some crucial data
2309   is removed by the keyserver, but it does at least give you back one
2310   subkey. Defaults to no for regular @option{--import} and to yes for
2311   keyserver @option{--receive-keys}.
2312
2313   @item import-show
2314   @itemx show-only
2315   Show a listing of the key as imported right before it is stored.
2316   This can be combined with the option @option{--dry-run} to only look
2317   at keys; the option @option{show-only} is a shortcut for this
2318   combination.  The command @option{--show-keys} is another shortcut
2319   for this.  Note that suffixes like '#' for "sec" and "sbb" lines
2320   may or may not be printed.
2321
2322   @item import-export
2323   Run the entire import code but instead of storing the key to the
2324   local keyring write it to the output.  The export options
2325   @option{export-pka} and @option{export-dane} affect the output.  This
2326   option can be used to remove all invalid parts from a key without the
2327   need to store it.
2328
2329   @item merge-only
2330   During import, allow key updates to existing keys, but do not allow
2331   any new keys to be imported. Defaults to no.
2332
2333   @item import-clean
2334   After import, compact (remove all signatures except the
2335   self-signature) any user IDs from the new key that are not usable.
2336   Then, remove any signatures from the new key that are not usable.
2337   This includes signatures that were issued by keys that are not present
2338   on the keyring. This option is the same as running the @option{--edit-key}
2339   command "clean" after import. Defaults to no.
2340
2341   @item repair-keys.  After import, fix various problems with the
2342   keys.  For example, this reorders signatures, and strips duplicate
2343   signatures.  Defaults to yes.
2344
2345   @item import-minimal
2346   Import the smallest key possible. This removes all signatures except
2347   the most recent self-signature on each user ID. This option is the
2348   same as running the @option{--edit-key} command "minimize" after import.
2349   Defaults to no.
2350
2351   @item restore
2352   @itemx import-restore
2353   Import in key restore mode.  This imports all data which is usually
2354   skipped during import; including all GnuPG specific data.  All other
2355   contradicting options are overridden.
2356 @end table
2357
2358 @item --import-filter @{@var{name}=@var{expr}@}
2359 @itemx --export-filter @{@var{name}=@var{expr}@}
2360 @opindex import-filter
2361 @opindex export-filter
2362 These options define an import/export filter which are applied to the
2363 imported/exported keyblock right before it will be stored/written.
2364 @var{name} defines the type of filter to use, @var{expr} the
2365 expression to evaluate.  The option can be used several times which
2366 then appends more expression to the same @var{name}.
2367
2368 @noindent
2369 The available filter types are:
2370
2371 @table @asis
2372
2373   @item keep-uid
2374   This filter will keep a user id packet and its dependent packets in
2375   the keyblock if the expression evaluates to true.
2376
2377   @item drop-subkey
2378   This filter drops the selected subkeys.
2379   Currently only implemented for --export-filter.
2380
2381   @item drop-sig
2382   This filter drops the selected key signatures on user ids.
2383   Self-signatures are not considered.
2384   Currently only implemented for --import-filter.
2385
2386 @end table
2387
2388 For the syntax of the expression see the chapter "FILTER EXPRESSIONS".
2389 The property names for the expressions depend on the actual filter
2390 type and are indicated in the following table.
2391
2392 The available properties are:
2393
2394 @table @asis
2395
2396   @item uid
2397   A string with the user id.  (keep-uid)
2398
2399   @item mbox
2400   The addr-spec part of a user id with mailbox or the empty string.
2401   (keep-uid)
2402
2403   @item key_algo
2404   A number with the public key algorithm of a key or subkey packet.
2405   (drop-subkey)
2406
2407   @item key_created
2408   @itemx key_created_d
2409   The first is the timestamp a public key or subkey packet was
2410   created.  The second is the same but given as an ISO string,
2411   e.g. "2016-08-17". (drop-subkey)
2412
2413   @item primary
2414   Boolean indicating whether the user id is the primary one.  (keep-uid)
2415
2416   @item expired
2417   Boolean indicating whether a user id (keep-uid), a key (drop-subkey), or a
2418   signature (drop-sig) expired.
2419
2420   @item revoked
2421   Boolean indicating whether a user id (keep-uid) or a key (drop-subkey) has
2422   been revoked.
2423
2424   @item disabled
2425   Boolean indicating whether a primary key is disabled. (not used)
2426
2427   @item secret
2428   Boolean indicating whether a key or subkey is a secret one.
2429   (drop-subkey)
2430
2431   @item usage
2432   A string indicating the usage flags for the subkey, from the
2433   sequence ``ecsa?''.  For example, a subkey capable of just signing
2434   and authentication would be an exact match for ``sa''. (drop-subkey)
2435
2436   @item sig_created
2437   @itemx sig_created_d
2438   The first is the timestamp a signature packet was created.  The
2439   second is the same but given as an ISO date string,
2440   e.g. "2016-08-17". (drop-sig)
2441
2442   @item sig_algo
2443   A number with the public key algorithm of a signature packet. (drop-sig)
2444
2445   @item sig_digest_algo
2446   A number with the digest algorithm of a signature packet. (drop-sig)
2447
2448 @end table
2449
2450 @item --export-options @var{parameters}
2451 @opindex export-options
2452 This is a space or comma delimited string that gives options for
2453 exporting keys.  Options can be prepended with a `no-' to give the
2454 opposite meaning.  The options are:
2455
2456 @table @asis
2457
2458   @item export-local-sigs
2459   Allow exporting key signatures marked as "local". This is not
2460   generally useful unless a shared keyring scheme is being used.
2461   Defaults to no.
2462
2463   @item export-attributes
2464   Include attribute user IDs (photo IDs) while exporting. Not
2465   including attribute user IDs is useful to export keys that are going
2466   to be used by an OpenPGP program that does not accept attribute user
2467   IDs.  Defaults to yes.
2468
2469   @item export-sensitive-revkeys
2470   Include designated revoker information that was marked as
2471   "sensitive". Defaults to no.
2472
2473   @c Since GnuPG 2.1 gpg-agent manages the secret key and thus the
2474   @c export-reset-subkey-passwd hack is not anymore justified.  Such use
2475   @c cases may be implemented using a specialized secret key export
2476   @c tool.
2477   @c @item export-reset-subkey-passwd
2478   @c When using the @option{--export-secret-subkeys} command, this option resets
2479   @c the passphrases for all exported subkeys to empty. This is useful
2480   @c when the exported subkey is to be used on an unattended machine where
2481   @c a passphrase doesn't necessarily make sense. Defaults to no.
2482
2483   @item backup
2484   @itemx export-backup
2485   Export for use as a backup.  The exported data includes all data
2486   which is needed to restore the key or keys later with GnuPG.  The
2487   format is basically the OpenPGP format but enhanced with GnuPG
2488   specific data.  All other contradicting options are overridden.
2489
2490   @item export-clean
2491   Compact (remove all signatures from) user IDs on the key being
2492   exported if the user IDs are not usable. Also, do not export any
2493   signatures that are not usable. This includes signatures that were
2494   issued by keys that are not present on the keyring. This option is
2495   the same as running the @option{--edit-key} command "clean" before export
2496   except that the local copy of the key is not modified. Defaults to
2497   no.
2498
2499   @item export-minimal
2500   Export the smallest key possible. This removes all signatures except the
2501   most recent self-signature on each user ID. This option is the same as
2502   running the @option{--edit-key} command "minimize" before export except
2503   that the local copy of the key is not modified. Defaults to no.
2504
2505   @item export-pka
2506   Instead of outputting the key material output PKA records suitable
2507   to put into DNS zone files.  An ORIGIN line is printed before each
2508   record to allow diverting the records to the corresponding zone file.
2509
2510   @item export-dane
2511   Instead of outputting the key material output OpenPGP DANE records
2512   suitable to put into DNS zone files.  An ORIGIN line is printed before
2513   each record to allow diverting the records to the corresponding zone
2514   file.
2515
2516 @end table
2517
2518 @item --with-colons
2519 @opindex with-colons
2520 Print key listings delimited by colons. Note that the output will be
2521 encoded in UTF-8 regardless of any @option{--display-charset} setting. This
2522 format is useful when GnuPG is called from scripts and other programs
2523 as it is easily machine parsed. The details of this format are
2524 documented in the file @file{doc/DETAILS}, which is included in the GnuPG
2525 source distribution.
2526
2527 @item --fixed-list-mode
2528 @opindex fixed-list-mode
2529 Do not merge primary user ID and primary key in @option{--with-colon}
2530 listing mode and print all timestamps as seconds since 1970-01-01.
2531 Since GnuPG 2.0.10, this mode is always used and thus this option is
2532 obsolete; it does not harm to use it though.
2533
2534 @item --legacy-list-mode
2535 @opindex legacy-list-mode
2536 Revert to the pre-2.1 public key list mode.  This only affects the
2537 human readable output and not the machine interface
2538 (i.e. @code{--with-colons}).  Note that the legacy format does not
2539 convey suitable information for elliptic curves.
2540
2541 @item --with-fingerprint
2542 @opindex with-fingerprint
2543 Same as the command @option{--fingerprint} but changes only the format
2544 of the output and may be used together with another command.
2545
2546 @item --with-subkey-fingerprint
2547 @opindex with-subkey-fingerprint
2548 If a fingerprint is printed for the primary key, this option forces
2549 printing of the fingerprint for all subkeys.  This could also be
2550 achieved by using the @option{--with-fingerprint} twice but by using
2551 this option along with keyid-format "none" a compact fingerprint is
2552 printed.
2553
2554 @item --with-icao-spelling
2555 @opindex with-icao-spelling
2556 Print the ICAO spelling of the fingerprint in addition to the hex digits.
2557
2558 @item --with-keygrip
2559 @opindex with-keygrip
2560 Include the keygrip in the key listings.  In @code{--with-colons} mode
2561 this is implicitly enable for secret keys.
2562
2563 @item --with-key-origin
2564 @opindex with-key-origin
2565 Include the locally held information on the origin and last update of
2566 a key in a key listing.  In @code{--with-colons} mode this is always
2567 printed.  This data is currently experimental and shall not be
2568 considered part of the stable API.
2569
2570 @item --with-wkd-hash
2571 @opindex with-wkd-hash
2572 Print a Web Key Directory identifier along with each user ID in key
2573 listings.  This is an experimental feature and semantics may change.
2574
2575 @item --with-secret
2576 @opindex with-secret
2577 Include info about the presence of a secret key in public key listings
2578 done with @code{--with-colons}.
2579
2580 @end table
2581
2582 @c *******************************************
2583 @c ********  OPENPGP OPTIONS  ****************
2584 @c *******************************************
2585 @node OpenPGP Options
2586 @subsection OpenPGP protocol specific options
2587
2588 @table @gnupgtabopt
2589
2590 @item -t, --textmode
2591 @itemx --no-textmode
2592 @opindex textmode
2593 Treat input files as text and store them in the OpenPGP canonical text
2594 form with standard "CRLF" line endings. This also sets the necessary
2595 flags to inform the recipient that the encrypted or signed data is text
2596 and may need its line endings converted back to whatever the local
2597 system uses. This option is useful when communicating between two
2598 platforms that have different line ending conventions (UNIX-like to Mac,
2599 Mac to Windows, etc). @option{--no-textmode} disables this option, and
2600 is the default.
2601
2602 @item --force-v3-sigs
2603 @itemx --no-force-v3-sigs
2604 @item --force-v4-certs
2605 @itemx --no-force-v4-certs
2606 These options are obsolete and have no effect since GnuPG 2.1.
2607
2608 @item --force-aead
2609 @opindex force-aead
2610 Force the use of AEAD encryption over MDC encryption.  AEAD is a
2611 modern and faster way to do authenticated encrytion than the old MDC
2612 method.  See also options @option{--aead-algo} and
2613 @option{--chunk-size}.
2614
2615 As of now this option requires the use of option @option{--rfc4880bis}
2616 to declare that a not yet standardized feature is used.
2617
2618 @item --force-mdc
2619 @itemx --disable-mdc
2620 @opindex force-mdc
2621 @opindex disable-mdc
2622 These options are obsolete and have no effect since GnuPG 2.2.8.  The
2623 MDC is always used unless the keys indicate that an AEAD algorithm can
2624 be used in which case AEAD is used.  But note: If the creation or of a
2625 legacy non-MDC message is exceptionally required, the option
2626 @option{--rfc2440} allows for this.
2627
2628 @item --disable-signer-uid
2629 @opindex disable-signer-uid
2630 By default the user ID of the signing key is embedded in the data
2631 signature.  As of now this is only done if the signing key has been
2632 specified with @option{local-user} using a mail address.  This
2633 information can be helpful for verifier to locate the key; see
2634 option @option{--auto-key-retrieve}.
2635
2636 @item --personal-cipher-preferences @var{string}
2637 @opindex personal-cipher-preferences
2638 Set the list of personal cipher preferences to @var{string}.  Use
2639 @command{@gpgname --version} to get a list of available algorithms,
2640 and use @code{none} to set no preference at all.  This allows the user
2641 to safely override the algorithm chosen by the recipient key
2642 preferences, as GPG will only select an algorithm that is usable by
2643 all recipients.  The most highly ranked cipher in this list is also
2644 used for the @option{--symmetric} encryption command.
2645
2646 @item --personal-aead-preferences @var{string}
2647 @opindex personal-aead-preferences
2648 Set the list of personal AEAD preferences to @var{string}.  Use
2649 @command{@gpgname --version} to get a list of available algorithms,
2650 and use @code{none} to set no preference at all.  This allows the user
2651 to safely override the algorithm chosen by the recipient key
2652 preferences, as GPG will only select an algorithm that is usable by
2653 all recipients.  The most highly ranked cipher in this list is also
2654 used for the @option{--symmetric} encryption command.
2655
2656 @item --personal-digest-preferences @var{string}
2657 @opindex personal-digest-preferences
2658 Set the list of personal digest preferences to @var{string}.  Use
2659 @command{@gpgname --version} to get a list of available algorithms,
2660 and use @code{none} to set no preference at all.  This allows the user
2661 to safely override the algorithm chosen by the recipient key
2662 preferences, as GPG will only select an algorithm that is usable by
2663 all recipients.  The most highly ranked digest algorithm in this list
2664 is also used when signing without encryption
2665 (e.g. @option{--clear-sign} or @option{--sign}).
2666
2667 @item --personal-compress-preferences @var{string}
2668 @opindex personal-compress-preferences
2669 Set the list of personal compression preferences to @var{string}.
2670 Use @command{@gpgname --version} to get a list of available
2671 algorithms, and use @code{none} to set no preference at all.  This
2672 allows the user to safely override the algorithm chosen by the
2673 recipient key preferences, as GPG will only select an algorithm that
2674 is usable by all recipients.  The most highly ranked compression
2675 algorithm in this list is also used when there are no recipient keys
2676 to consider (e.g. @option{--symmetric}).
2677
2678 @item --s2k-cipher-algo @var{name}
2679 @opindex s2k-cipher-algo
2680 Use @var{name} as the cipher algorithm for symmetric encryption with
2681 a passphrase if @option{--personal-cipher-preferences} and
2682 @option{--cipher-algo} are not given.  The default is @value{GPGSYMENCALGO}.
2683
2684 @item --s2k-digest-algo @var{name}
2685 @opindex s2k-digest-algo
2686 Use @var{name} as the digest algorithm used to mangle the passphrases
2687 for symmetric encryption.  The default is SHA-1.
2688
2689 @item --s2k-mode @var{n}
2690 @opindex s2k-mode
2691 Selects how passphrases for symmetric encryption are mangled. If
2692 @var{n} is 0 a plain passphrase (which is in general not recommended)
2693 will be used, a 1 adds a salt (which should not be used) to the
2694 passphrase and a 3 (the default) iterates the whole process a number
2695 of times (see @option{--s2k-count}).
2696
2697 @item --s2k-count @var{n}
2698 @opindex s2k-count
2699 Specify how many times the passphrases mangling for symmetric
2700 encryption is repeated.  This value may range between 1024 and
2701 65011712 inclusive.  The default is inquired from gpg-agent.  Note
2702 that not all values in the 1024-65011712 range are legal and if an
2703 illegal value is selected, GnuPG will round up to the nearest legal
2704 value.  This option is only meaningful if @option{--s2k-mode} is set
2705 to the default of 3.
2706
2707
2708 @end table
2709
2710 @c ***************************
2711 @c ******* Compliance ********
2712 @c ***************************
2713 @node Compliance Options
2714 @subsection Compliance options
2715
2716 These options control what GnuPG is compliant to. Only one of these
2717 options may be active at a time. Note that the default setting of
2718 this is nearly always the correct one. See the INTEROPERABILITY WITH
2719 OTHER OPENPGP PROGRAMS section below before using one of these
2720 options.
2721
2722 @table @gnupgtabopt
2723
2724 @item --gnupg
2725 @opindex gnupg
2726 Use standard GnuPG behavior. This is essentially OpenPGP behavior
2727 (see @option{--openpgp}), but with some additional workarounds for common
2728 compatibility problems in different versions of PGP. This is the
2729 default option, so it is not generally needed, but it may be useful to
2730 override a different compliance option in the gpg.conf file.
2731
2732 @item --openpgp
2733 @opindex openpgp
2734 Reset all packet, cipher and digest options to strict OpenPGP
2735 behavior. Use this option to reset all previous options like
2736 @option{--s2k-*}, @option{--cipher-algo}, @option{--digest-algo} and
2737 @option{--compress-algo} to OpenPGP compliant values. All PGP
2738 workarounds are disabled.
2739
2740 @item --rfc4880
2741 @opindex rfc4880
2742 Reset all packet, cipher and digest options to strict RFC-4880
2743 behavior. Note that this is currently the same thing as
2744 @option{--openpgp}.
2745
2746 @item --rfc4880bis
2747 @opindex rfc4880bis
2748 Enable experimental features from proposed updates to RFC-4880.  This
2749 option can be used in addition to the other compliance options.
2750 Warning: The behavior may change with any GnuPG release and created
2751 keys or data may not be usable with future GnuPG versions.
2752
2753 @item --rfc2440
2754 @opindex rfc2440
2755 Reset all packet, cipher and digest options to strict RFC-2440
2756 behavior.  Note that by using this option encryption packets are
2757 created in a legacy mode without MDC protection.  This is dangerous
2758 and should thus only be used for experiments.  See also option
2759 @option{--ignore-mdc-error}.
2760
2761 @item --pgp6
2762 @opindex pgp6
2763 This option is obsolete; it is handled as an alias for @option{--pgp7}
2764
2765 @item --pgp7
2766 @opindex pgp7
2767 Set up all options to be as PGP 7 compliant as possible. This allowd
2768 the ciphers IDEA, 3DES, CAST5,AES128, AES192, AES256, and TWOFISH.,
2769 the hashes MD5, SHA1 and RIPEMD160, and the compression algorithms
2770 none and ZIP.  This option implies @option{--escape-from-lines} and
2771 disables @option{--throw-keyids},
2772
2773 @item --pgp8
2774 @opindex pgp8
2775 Set up all options to be as PGP 8 compliant as possible. PGP 8 is a lot
2776 closer to the OpenPGP standard than previous versions of PGP, so all
2777 this does is disable @option{--throw-keyids} and set
2778 @option{--escape-from-lines}.  All algorithms are allowed except for the
2779 SHA224, SHA384, and SHA512 digests.
2780
2781 @item --compliance @var{string}
2782 @opindex compliance
2783 This option can be used instead of one of the options above.  Valid
2784 values for @var{string} are the above option names (without the double
2785 dash) and possibly others as shown when using "help" for @var{value}.
2786
2787 @end table
2788
2789
2790 @c *******************************************
2791 @c ********  ESOTERIC OPTIONS  ***************
2792 @c *******************************************
2793 @node GPG Esoteric Options
2794 @subsection Doing things one usually doesn't want to do
2795
2796 @table @gnupgtabopt
2797
2798 @item -n
2799 @itemx --dry-run
2800 @opindex dry-run
2801 Don't make any changes (this is not completely implemented).
2802
2803 @item --list-only
2804 @opindex list-only
2805 Changes the behaviour of some commands. This is like @option{--dry-run} but
2806 different in some cases. The semantic of this option may be extended in
2807 the future. Currently it only skips the actual decryption pass and
2808 therefore enables a fast listing of the encryption keys.
2809
2810 @item -i
2811 @itemx --interactive
2812 @opindex interactive
2813 Prompt before overwriting any files.
2814
2815 @item --debug-level @var{level}
2816 @opindex debug-level
2817 Select the debug level for investigating problems. @var{level} may be
2818 a numeric value or by a keyword:
2819
2820 @table @code
2821   @item none
2822   No debugging at all.  A value of less than 1 may be used instead of
2823   the keyword.
2824   @item basic
2825   Some basic debug messages.  A value between 1 and 2 may be used
2826   instead of the keyword.
2827   @item advanced
2828   More verbose debug messages.  A value between 3 and 5 may be used
2829   instead of the keyword.
2830   @item expert
2831   Even more detailed messages.  A value between 6 and 8 may be used
2832   instead of the keyword.
2833   @item guru
2834   All of the debug messages you can get. A value greater than 8 may be
2835   used instead of the keyword.  The creation of hash tracing files is
2836   only enabled if the keyword is used.
2837 @end table
2838
2839 How these messages are mapped to the actual debugging flags is not
2840 specified and may change with newer releases of this program. They are
2841 however carefully selected to best aid in debugging.
2842
2843 @item --debug @var{flags}
2844 @opindex debug
2845 Set debugging flags. All flags are or-ed and @var{flags} may be given
2846 in C syntax (e.g. 0x0042) or as a comma separated list of flag names.
2847 To get a list of all supported flags the single word "help" can be
2848 used.
2849
2850 @item --debug-all
2851 @opindex debug-all
2852 Set all useful debugging flags.
2853
2854 @item --debug-iolbf
2855 @opindex debug-iolbf
2856 Set stdout into line buffered mode.  This option is only honored when
2857 given on the command line.
2858
2859 @item --debug-set-iobuf-size @var{n}
2860 @opindex debug-iolbf
2861 Change the buffer size of the IOBUFs to @var{n} kilobyte.  Using 0
2862 prints the current size.  Note well: This is a maintainer only option
2863 and may thus be changed or removed at any time without notice.
2864
2865 @item --faked-system-time @var{epoch}
2866 @opindex faked-system-time
2867 This option is only useful for testing; it sets the system time back or
2868 forth to @var{epoch} which is the number of seconds elapsed since the year
2869 1970.  Alternatively @var{epoch} may be given as a full ISO time string
2870 (e.g. "20070924T154812").
2871
2872 If you suffix @var{epoch} with an exclamation mark (!), the system time
2873 will appear to be frozen at the specified time.
2874
2875 @item --enable-progress-filter
2876 @opindex enable-progress-filter
2877 Enable certain PROGRESS status outputs. This option allows frontends
2878 to display a progress indicator while gpg is processing larger files.
2879 There is a slight performance overhead using it.
2880
2881 @item --status-fd @var{n}
2882 @opindex status-fd
2883 Write special status strings to the file descriptor @var{n}.
2884 See the file DETAILS in the documentation for a listing of them.
2885
2886 @item --status-file @var{file}
2887 @opindex status-file
2888 Same as @option{--status-fd}, except the status data is written to file
2889 @var{file}.
2890
2891 @item --logger-fd @var{n}
2892 @opindex logger-fd
2893 Write log output to file descriptor @var{n} and not to STDERR.
2894
2895 @item --log-file @var{file}
2896 @itemx --logger-file @var{file}
2897 @opindex log-file
2898 Same as @option{--logger-fd}, except the logger data is written to
2899 file @var{file}.  Use @file{socket://} to log to s socket.
2900
2901 @item --attribute-fd @var{n}
2902 @opindex attribute-fd
2903 Write attribute subpackets to the file descriptor @var{n}. This is most
2904 useful for use with @option{--status-fd}, since the status messages are
2905 needed to separate out the various subpackets from the stream delivered
2906 to the file descriptor.
2907
2908 @item --attribute-file @var{file}
2909 @opindex attribute-file
2910 Same as @option{--attribute-fd}, except the attribute data is written to
2911 file @var{file}.
2912
2913 @item --comment @var{string}
2914 @itemx --no-comments
2915 @opindex comment
2916 Use @var{string} as a comment string in cleartext signatures and ASCII
2917 armored messages or keys (see @option{--armor}). The default behavior is
2918 not to use a comment string. @option{--comment} may be repeated multiple
2919 times to get multiple comment strings. @option{--no-comments} removes
2920 all comments.  It is a good idea to keep the length of a single comment
2921 below 60 characters to avoid problems with mail programs wrapping such
2922 lines.  Note that comment lines, like all other header lines, are not
2923 protected by the signature.
2924
2925 @item --emit-version
2926 @itemx --no-emit-version
2927 @opindex emit-version
2928 Force inclusion of the version string in ASCII armored output.  If
2929 given once only the name of the program and the major number is
2930 emitted, given twice the minor is also emitted, given thrice
2931 the micro is added, and given four times an operating system identification
2932 is also emitted.  @option{--no-emit-version} (default) disables the version
2933 line.
2934
2935 @item --sig-notation @{@var{name}=@var{value}@}
2936 @itemx --cert-notation @{@var{name}=@var{value}@}
2937 @itemx -N, --set-notation @{@var{name}=@var{value}@}
2938 @opindex sig-notation
2939 @opindex cert-notation
2940 @opindex set-notation
2941 Put the name value pair into the signature as notation data.
2942 @var{name} must consist only of printable characters or spaces, and
2943 must contain a '@@' character in the form keyname@@domain.example.com
2944 (substituting the appropriate keyname and domain name, of course).  This
2945 is to help prevent pollution of the IETF reserved notation
2946 namespace. The @option{--expert} flag overrides the '@@'
2947 check. @var{value} may be any printable string; it will be encoded in
2948 UTF-8, so you should check that your @option{--display-charset} is set
2949 correctly. If you prefix @var{name} with an exclamation mark (!), the
2950 notation data will be flagged as critical
2951 (rfc4880:5.2.3.16). @option{--sig-notation} sets a notation for data
2952 signatures. @option{--cert-notation} sets a notation for key signatures
2953 (certifications). @option{--set-notation} sets both.
2954
2955 There are special codes that may be used in notation names. "%k" will
2956 be expanded into the key ID of the key being signed, "%K" into the
2957 long key ID of the key being signed, "%f" into the fingerprint of the
2958 key being signed, "%s" into the key ID of the key making the
2959 signature, "%S" into the long key ID of the key making the signature,
2960 "%g" into the fingerprint of the key making the signature (which might
2961 be a subkey), "%p" into the fingerprint of the primary key of the key
2962 making the signature, "%c" into the signature count from the OpenPGP
2963 smartcard, and "%%" results in a single "%". %k, %K, and %f are only
2964 meaningful when making a key signature (certification), and %c is only
2965 meaningful when using the OpenPGP smartcard.
2966
2967 @item --sig-policy-url @var{string}
2968 @itemx --cert-policy-url @var{string}
2969 @itemx --set-policy-url @var{string}
2970 @opindex sig-policy-url
2971 @opindex cert-policy-url
2972 @opindex set-policy-url
2973 Use @var{string} as a Policy URL for signatures (rfc4880:5.2.3.20).  If
2974 you prefix it with an exclamation mark (!), the policy URL packet will
2975 be flagged as critical. @option{--sig-policy-url} sets a policy url for
2976 data signatures. @option{--cert-policy-url} sets a policy url for key
2977 signatures (certifications). @option{--set-policy-url} sets both.
2978
2979 The same %-expandos used for notation data are available here as well.
2980
2981 @item --sig-keyserver-url @var{string}
2982 @opindex sig-keyserver-url
2983 Use @var{string} as a preferred keyserver URL for data signatures. If
2984 you prefix it with an exclamation mark (!), the keyserver URL packet
2985 will be flagged as critical.
2986
2987 The same %-expandos used for notation data are available here as well.
2988
2989 @item --set-filename @var{string}
2990 @opindex set-filename
2991 Use @var{string} as the filename which is stored inside messages.
2992 This overrides the default, which is to use the actual filename of the
2993 file being encrypted.  Using the empty string for @var{string}
2994 effectively removes the filename from the output.
2995
2996 @item --for-your-eyes-only
2997 @itemx --no-for-your-eyes-only
2998 @opindex for-your-eyes-only
2999 Set the `for your eyes only' flag in the message. This causes GnuPG to
3000 refuse to save the file unless the @option{--output} option is given,
3001 and PGP to use a "secure viewer" with a claimed Tempest-resistant font
3002 to display the message. This option overrides @option{--set-filename}.
3003 @option{--no-for-your-eyes-only} disables this option.
3004
3005 @item --use-embedded-filename
3006 @itemx --no-use-embedded-filename
3007 @opindex use-embedded-filename
3008 Try to create a file with a name as embedded in the data. This can be
3009 a dangerous option as it enables overwriting files. Defaults to no.
3010
3011 @item --cipher-algo @var{name}
3012 @opindex cipher-algo
3013 Use @var{name} as cipher algorithm. Running the program with the
3014 command @option{--version} yields a list of supported algorithms. If
3015 this is not used the cipher algorithm is selected from the preferences
3016 stored with the key. In general, you do not want to use this option as
3017 it allows you to violate the OpenPGP standard.  The option
3018 @option{--personal-cipher-preferences} is the safe way to accomplish the
3019 same thing.
3020
3021 @item --aead-algo @var{name}
3022 @opindex aead-algo
3023 Specify that the AEAD algorithm @var{name} is to be used.  This is
3024 useful for symmetric encryption where no key preference are available
3025 to select the AEAD algorithm.  Runing @command{@gpgname} with option
3026 @option{--version} shows the available AEAD algorithms.  In general,
3027 you do not want to use this option as it allows you to violate the
3028 OpenPGP standard.  The option @option{--personal-aead-preferences} is
3029 the safe way to accomplish the same thing.
3030
3031 @item --digest-algo @var{name}
3032 @opindex digest-algo
3033 Use @var{name} as the message digest algorithm. Running the program
3034 with the command @option{--version} yields a list of supported
3035 algorithms. In general, you do not want to use this option as it
3036 allows you to violate the OpenPGP standard.  The option
3037 @option{--personal-digest-preferences} is the safe way to accomplish
3038 the same thing.
3039
3040 @item --compress-algo @var{name}
3041 @opindex compress-algo
3042 Use compression algorithm @var{name}. "zlib" is RFC-1950 ZLIB
3043 compression. "zip" is RFC-1951 ZIP compression which is used by PGP.
3044 "bzip2" is a more modern compression scheme that can compress some
3045 things better than zip or zlib, but at the cost of more memory used
3046 during compression and decompression. "uncompressed" or "none"
3047 disables compression. If this option is not used, the default
3048 behavior is to examine the recipient key preferences to see which
3049 algorithms the recipient supports. If all else fails, ZIP is used for
3050 maximum compatibility.
3051
3052 ZLIB may give better compression results than ZIP, as the compression
3053 window size is not limited to 8k. BZIP2 may give even better
3054 compression results than that, but will use a significantly larger
3055 amount of memory while compressing and decompressing. This may be
3056 significant in low memory situations. Note, however, that PGP (all
3057 versions) only supports ZIP compression. Using any algorithm other
3058 than ZIP or "none" will make the message unreadable with PGP. In
3059 general, you do not want to use this option as it allows you to
3060 violate the OpenPGP standard.  The option
3061 @option{--personal-compress-preferences} is the safe way to accomplish
3062 the same thing.
3063
3064 @item --cert-digest-algo @var{name}
3065 @opindex cert-digest-algo
3066 Use @var{name} as the message digest algorithm used when signing a
3067 key. Running the program with the command @option{--version} yields a
3068 list of supported algorithms. Be aware that if you choose an algorithm
3069 that GnuPG supports but other OpenPGP implementations do not, then some
3070 users will not be able to use the key signatures you make, or quite
3071 possibly your entire key.
3072
3073 @item --disable-cipher-algo @var{name}
3074 @opindex disable-cipher-algo
3075 Never allow the use of @var{name} as cipher algorithm.
3076 The given name will not be checked so that a later loaded algorithm
3077 will still get disabled.
3078
3079 @item --disable-pubkey-algo @var{name}
3080 @opindex disable-pubkey-algo
3081 Never allow the use of @var{name} as public key algorithm.
3082 The given name will not be checked so that a later loaded algorithm
3083 will still get disabled.
3084
3085 @item --throw-keyids
3086 @itemx --no-throw-keyids
3087 @opindex throw-keyids
3088 Do not put the recipient key IDs into encrypted messages. This helps to
3089 hide the receivers of the message and is a limited countermeasure
3090 against traffic analysis.@footnote{Using a little social engineering
3091 anyone who is able to decrypt the message can check whether one of the
3092 other recipients is the one he suspects.}  On the receiving side, it may
3093 slow down the decryption process because all available secret keys must
3094 be tried.  @option{--no-throw-keyids} disables this option. This option
3095 is essentially the same as using @option{--hidden-recipient} for all
3096 recipients.
3097
3098 @item --not-dash-escaped
3099 @opindex not-dash-escaped
3100 This option changes the behavior of cleartext signatures
3101 so that they can be used for patch files. You should not
3102 send such an armored file via email because all spaces
3103 and line endings are hashed too. You can not use this
3104 option for data which has 5 dashes at the beginning of a
3105 line, patch files don't have this. A special armor header
3106 line tells GnuPG about this cleartext signature option.
3107
3108 @item --escape-from-lines
3109 @itemx --no-escape-from-lines
3110 @opindex escape-from-lines
3111 Because some mailers change lines starting with "From " to ">From " it
3112 is good to handle such lines in a special way when creating cleartext
3113 signatures to prevent the mail system from breaking the signature. Note
3114 that all other PGP versions do it this way too.  Enabled by
3115 default. @option{--no-escape-from-lines} disables this option.
3116
3117 @item --passphrase-repeat @var{n}
3118 @opindex passphrase-repeat
3119 Specify how many times @command{@gpgname} will request a new
3120 passphrase be repeated.  This is useful for helping memorize a
3121 passphrase.  Defaults to 1 repetition.
3122
3123 @item --passphrase-fd @var{n}
3124 @opindex passphrase-fd
3125 Read the passphrase from file descriptor @var{n}. Only the first line
3126 will be read from file descriptor @var{n}. If you use 0 for @var{n},
3127 the passphrase will be read from STDIN. This can only be used if only
3128 one passphrase is supplied.
3129
3130 Note that since Version 2.0 this passphrase is only used if the
3131 option @option{--batch} has also been given. Since Version 2.1
3132 the @option{--pinentry-mode} also needs to be set to @code{loopback}.
3133
3134 @item --passphrase-file @var{file}
3135 @opindex passphrase-file
3136 Read the passphrase from file @var{file}. Only the first line will
3137 be read from file @var{file}. This can only be used if only one
3138 passphrase is supplied. Obviously, a passphrase stored in a file is
3139 of questionable security if other users can read this file. Don't use
3140 this option if you can avoid it.
3141
3142 Note that since Version 2.0 this passphrase is only used if the
3143 option @option{--batch} has also been given. Since Version 2.1
3144 the @option{--pinentry-mode} also needs to be set to @code{loopback}.
3145
3146 @item --passphrase @var{string}
3147 @opindex passphrase
3148 Use @var{string} as the passphrase. This can only be used if only one
3149 passphrase is supplied. Obviously, this is of very questionable
3150 security on a multi-user system. Don't use this option if you can
3151 avoid it.
3152
3153 Note that since Version 2.0 this passphrase is only used if the
3154 option @option{--batch} has also been given. Since Version 2.1
3155 the @option{--pinentry-mode} also needs to be set to @code{loopback}.
3156
3157 @item --pinentry-mode @var{mode}
3158 @opindex pinentry-mode
3159 Set the pinentry mode to @var{mode}.  Allowed values for @var{mode}
3160 are:
3161 @table @asis
3162   @item default
3163   Use the default of the agent, which is @code{ask}.
3164   @item ask
3165   Force the use of the Pinentry.
3166   @item cancel
3167   Emulate use of Pinentry's cancel button.
3168   @item error
3169   Return a Pinentry error (``No Pinentry'').
3170   @item loopback
3171   Redirect Pinentry queries to the caller.  Note that in contrast to
3172   Pinentry the user is not prompted again if he enters a bad password.
3173 @end table
3174
3175 @item --no-symkey-cache
3176 @opindex no-symkey-cache
3177 Disable the passphrase cache used for symmetrical en- and decryption.
3178 This cache is based on the message specific salt value
3179 (cf. @option{--s2k-mode}).
3180
3181 @item --request-origin @var{origin}
3182 @opindex request-origin
3183 Tell gpg to assume that the operation ultimately originated at
3184 @var{origin}.  Depending on the origin certain restrictions are applied
3185 and the Pinentry may include an extra note on the origin.  Supported
3186 values for @var{origin} are: @code{local} which is the default,
3187 @code{remote} to indicate a remote origin or @code{browser} for an
3188 operation requested by a web browser.
3189
3190 @item --command-fd @var{n}
3191 @opindex command-fd
3192 This is a replacement for the deprecated shared-memory IPC mode.
3193 If this option is enabled, user input on questions is not expected
3194 from the TTY but from the given file descriptor. It should be used
3195 together with @option{--status-fd}. See the file doc/DETAILS in the source
3196 distribution for details on how to use it.
3197
3198 @item --command-file @var{file}
3199 @opindex command-file
3200 Same as @option{--command-fd}, except the commands are read out of file
3201 @var{file}
3202
3203 @item --allow-non-selfsigned-uid
3204 @itemx --no-allow-non-selfsigned-uid
3205 @opindex allow-non-selfsigned-uid
3206 Allow the import and use of keys with user IDs which are not
3207 self-signed. This is not recommended, as a non self-signed user ID is
3208 trivial to forge. @option{--no-allow-non-selfsigned-uid} disables.
3209
3210 @item --allow-freeform-uid
3211 @opindex allow-freeform-uid
3212 Disable all checks on the form of the user ID while generating a new
3213 one. This option should only be used in very special environments as
3214 it does not ensure the de-facto standard format of user IDs.
3215
3216 @item --ignore-time-conflict
3217 @opindex ignore-time-conflict
3218 GnuPG normally checks that the timestamps associated with keys and
3219 signatures have plausible values. However, sometimes a signature
3220 seems to be older than the key due to clock problems. This option
3221 makes these checks just a warning. See also @option{--ignore-valid-from} for
3222 timestamp issues on subkeys.
3223
3224 @item --ignore-valid-from
3225 @opindex ignore-valid-from
3226 GnuPG normally does not select and use subkeys created in the future.
3227 This option allows the use of such keys and thus exhibits the
3228 pre-1.0.7 behaviour. You should not use this option unless there
3229 is some clock problem. See also @option{--ignore-time-conflict} for timestamp
3230 issues with signatures.
3231
3232 @item --ignore-crc-error
3233 @opindex ignore-crc-error
3234 The ASCII armor used by OpenPGP is protected by a CRC checksum against
3235 transmission errors. Occasionally the CRC gets mangled somewhere on
3236 the transmission channel but the actual content (which is protected by
3237 the OpenPGP protocol anyway) is still okay. This option allows GnuPG
3238 to ignore CRC errors.
3239
3240 @item --ignore-mdc-error
3241 @opindex ignore-mdc-error
3242 This option changes a MDC integrity protection failure into a warning.
3243 It is required to decrypt old messages which did not use an MDC.  It
3244 may also be useful if a message is partially garbled, but it is
3245 necessary to get as much data as possible out of that garbled message.
3246 Be aware that a missing or failed MDC can be an indication of an
3247 attack.  Use with great caution; see also option @option{--rfc2440}.
3248
3249 @item --allow-weak-digest-algos
3250 @opindex allow-weak-digest-algos
3251 Signatures made with known-weak digest algorithms are normally
3252 rejected with an ``invalid digest algorithm'' message.  This option
3253 allows the verification of signatures made with such weak algorithms.
3254 MD5 is the only digest algorithm considered weak by default.  See also
3255 @option{--weak-digest} to reject other digest algorithms.
3256
3257 @item --weak-digest @var{name}
3258 @opindex weak-digest
3259 Treat the specified digest algorithm as weak.  Signatures made over
3260 weak digests algorithms are normally rejected. This option can be
3261 supplied multiple times if multiple algorithms should be considered
3262 weak.  See also @option{--allow-weak-digest-algos} to disable
3263 rejection of weak digests.  MD5 is always considered weak, and does
3264 not need to be listed explicitly.
3265
3266 @item --no-default-keyring
3267 @opindex no-default-keyring
3268 Do not add the default keyrings to the list of keyrings. Note that
3269 GnuPG will not operate without any keyrings, so if you use this option
3270 and do not provide alternate keyrings via @option{--keyring} or
3271 @option{--secret-keyring}, then GnuPG will still use the default public or
3272 secret keyrings.
3273
3274 @item --no-keyring
3275 @opindex no-keyring
3276 Do not add use any keyrings even if specified as options.
3277
3278 @item --skip-verify
3279 @opindex skip-verify
3280 Skip the signature verification step. This may be
3281 used to make the decryption faster if the signature
3282 verification is not needed.
3283
3284 @item --with-key-data
3285 @opindex with-key-data
3286 Print key listings delimited by colons (like @option{--with-colons}) and
3287 print the public key data.
3288
3289 @item --list-signatures
3290 @opindex list-signatures
3291 @itemx --list-sigs
3292 @opindex list-sigs
3293 Same as @option{--list-keys}, but the signatures are listed too.  This
3294 command has the same effect as using @option{--list-keys} with
3295 @option{--with-sig-list}.  Note that in contrast to
3296 @option{--check-signatures} the key signatures are not verified.  This
3297 command can be used to create a list of signing keys missing in the
3298 lcoal keyring; for example:
3299
3300 @example
3301       gpg --list-sigs --with-colons USERID | \
3302         awk -F: '$1=="sig" && $2=="?" @{if($13)@{print $13@}else@{print $5@}@}'
3303 @end example
3304
3305 @item --fast-list-mode
3306 @opindex fast-list-mode
3307 Changes the output of the list commands to work faster; this is achieved
3308 by leaving some parts empty. Some applications don't need the user ID
3309 and the trust information given in the listings. By using this options
3310 they can get a faster listing. The exact behaviour of this option may
3311 change in future versions.  If you are missing some information, don't
3312 use this option.
3313
3314 @item --no-literal
3315 @opindex no-literal
3316 This is not for normal use. Use the source to see for what it might be useful.
3317
3318 @item --set-filesize
3319 @opindex set-filesize
3320 This is not for normal use. Use the source to see for what it might be useful.
3321
3322 @item --show-session-key
3323 @opindex show-session-key
3324 Display the session key used for one message. See
3325 @option{--override-session-key} for the counterpart of this option.
3326
3327 We think that Key Escrow is a Bad Thing; however the user should have
3328 the freedom to decide whether to go to prison or to reveal the content
3329 of one specific message without compromising all messages ever
3330 encrypted for one secret key.
3331
3332 You can also use this option if you receive an encrypted message which
3333 is abusive or offensive, to prove to the administrators of the
3334 messaging system that the ciphertext transmitted corresponds to an
3335 inappropriate plaintext so they can take action against the offending
3336 user.
3337
3338 @item --override-session-key @var{string}
3339 @itemx --override-session-key-fd @var{fd}
3340 @opindex override-session-key
3341 Don't use the public key but the session key @var{string} respective
3342 the session key taken from the first line read from file descriptor
3343 @var{fd}.  The format of this string is the same as the one printed
3344 by @option{--show-session-key}. This option is normally not used but
3345 comes handy in case someone forces you to reveal the content of an
3346 encrypted message; using this option you can do this without handing
3347 out the secret key.  Note that using @option{--override-session-key}
3348 may reveal the session key to all local users via the global process
3349 table.
3350
3351 @item --ask-sig-expire
3352 @itemx --no-ask-sig-expire
3353 @opindex ask-sig-expire
3354 When making a data signature, prompt for an expiration time. If this
3355 option is not specified, the expiration time set via
3356 @option{--default-sig-expire} is used. @option{--no-ask-sig-expire}
3357 disables this option.
3358
3359 @item --default-sig-expire
3360 @opindex default-sig-expire
3361 The default expiration time to use for signature expiration. Valid
3362 values are "0" for no expiration, a number followed by the letter d
3363 (for days), w (for weeks), m (for months), or y (for years) (for
3364 example "2m" for two months, or "5y" for five years), or an absolute
3365 date in the form YYYY-MM-DD. Defaults to "0".
3366
3367 @item --ask-cert-expire
3368 @itemx --no-ask-cert-expire
3369 @opindex ask-cert-expire
3370 When making a key signature, prompt for an expiration time. If this
3371 option is not specified, the expiration time set via
3372 @option{--default-cert-expire} is used. @option{--no-ask-cert-expire}
3373 disables this option.
3374
3375 @item --default-cert-expire
3376 @opindex default-cert-expire
3377 The default expiration time to use for key signature expiration.
3378 Valid values are "0" for no expiration, a number followed by the
3379 letter d (for days), w (for weeks), m (for months), or y (for years)
3380 (for example "2m" for two months, or "5y" for five years), or an
3381 absolute date in the form YYYY-MM-DD. Defaults to "0".
3382
3383 @item --default-new-key-algo @var{string}
3384 @opindex default-new-key-algo @var{string}
3385 This option can be used to change the default algorithms for key
3386 generation. The @var{string} is similar to the arguments required for
3387 the command @option{--quick-add-key} but slightly different.  For
3388 example the current default of @code{"rsa2048/cert,sign+rsa2048/encr"}
3389 (or @code{"rsa3072"}) can be changed to the value of what we currently
3390 call future default, which is @code{"ed25519/cert,sign+cv25519/encr"}.
3391 You need to consult the source code to learn the details.  Note that
3392 the advanced key generation commands can always be used to specify a
3393 key algorithm directly.
3394
3395 @item --allow-secret-key-import
3396 @opindex allow-secret-key-import
3397 This is an obsolete option and is not used anywhere.
3398
3399 @item --allow-multiple-messages
3400 @item --no-allow-multiple-messages
3401 These are obsolete options; they have no more effect since GnuPG 2.2.8.
3402
3403 @item --enable-special-filenames
3404 @opindex enable-special-filenames
3405 This option enables a mode in which filenames of the form
3406 @file{-&n}, where n is a non-negative decimal number,
3407 refer to the file descriptor n and not to a file with that name.
3408
3409 @item --no-expensive-trust-checks
3410 @opindex no-expensive-trust-checks
3411 Experimental use only.
3412
3413 @item --preserve-permissions
3414 @opindex preserve-permissions
3415 Don't change the permissions of a secret keyring back to user
3416 read/write only. Use this option only if you really know what you are doing.
3417
3418 @item --default-preference-list @var{string}
3419 @opindex default-preference-list
3420 Set the list of default preferences to @var{string}. This preference
3421 list is used for new keys and becomes the default for "setpref" in the
3422 edit menu.
3423
3424 @item --default-keyserver-url @var{name}
3425 @opindex default-keyserver-url
3426 Set the default keyserver URL to @var{name}. This keyserver will be
3427 used as the keyserver URL when writing a new self-signature on a key,
3428 which includes key generation and changing preferences.
3429
3430 @item --list-config
3431 @opindex list-config
3432 Display various internal configuration parameters of GnuPG. This option
3433 is intended for external programs that call GnuPG to perform tasks, and
3434 is thus not generally useful. See the file @file{doc/DETAILS} in the
3435 source distribution for the details of which configuration items may be
3436 listed. @option{--list-config} is only usable with
3437 @option{--with-colons} set.
3438
3439 @item --list-gcrypt-config
3440 @opindex list-gcrypt-config
3441 Display various internal configuration parameters of Libgcrypt.
3442
3443 @item --gpgconf-list
3444 @opindex gpgconf-list
3445 This command is similar to @option{--list-config} but in general only
3446 internally used by the @command{gpgconf} tool.
3447
3448 @item --gpgconf-test
3449 @opindex gpgconf-test
3450 This is more or less dummy action.  However it parses the configuration
3451 file and returns with failure if the configuration file would prevent
3452 @command{@gpgname} from startup.  Thus it may be used to run a syntax check
3453 on the configuration file.
3454
3455 @end table
3456
3457 @c *******************************
3458 @c ******* Deprecated ************
3459 @c *******************************
3460 @node Deprecated Options
3461 @subsection Deprecated options
3462
3463 @table @gnupgtabopt
3464
3465 @item --show-photos
3466 @itemx --no-show-photos
3467 @opindex show-photos
3468 Causes @option{--list-keys}, @option{--list-signatures},
3469 @option{--list-public-keys}, @option{--list-secret-keys}, and verifying
3470 a signature to also display the photo ID attached to the key, if
3471 any. See also @option{--photo-viewer}. These options are deprecated. Use
3472 @option{--list-options [no-]show-photos} and/or @option{--verify-options
3473 [no-]show-photos} instead.
3474
3475 @item --show-keyring
3476 @opindex show-keyring
3477 Display the keyring name at the head of key listings to show which
3478 keyring a given key resides on. This option is deprecated: use
3479 @option{--list-options [no-]show-keyring} instead.
3480
3481 @item --always-trust
3482 @opindex always-trust
3483 Identical to @option{--trust-model always}. This option is deprecated.
3484
3485 @item --show-notation
3486 @itemx --no-show-notation
3487 @opindex show-notation
3488 Show signature notations in the @option{--list-signatures} or @option{--check-signatures} listings
3489 as well as when verifying a signature with a notation in it. These
3490 options are deprecated. Use @option{--list-options [no-]show-notation}
3491 and/or @option{--verify-options [no-]show-notation} instead.
3492
3493 @item --show-policy-url
3494 @itemx --no-show-policy-url
3495 @opindex show-policy-url
3496 Show policy URLs in the @option{--list-signatures} or @option{--check-signatures}
3497 listings as well as when verifying a signature with a policy URL in
3498 it. These options are deprecated. Use @option{--list-options
3499 [no-]show-policy-url} and/or @option{--verify-options
3500 [no-]show-policy-url} instead.
3501
3502
3503 @end table
3504
3505
3506 @c *******************************************
3507 @c ***************            ****************
3508 @c ***************   FILES    ****************
3509 @c ***************            ****************
3510 @c *******************************************
3511 @mansect files
3512 @node GPG Configuration
3513 @section Configuration files
3514
3515 There are a few configuration files to control certain aspects of
3516 @command{@gpgname}'s operation. Unless noted, they are expected in the
3517 current home directory (@pxref{option --homedir}).
3518
3519 @table @file
3520
3521   @item gpg.conf
3522   @efindex gpg.conf
3523   This is the standard configuration file read by @command{@gpgname} on
3524   startup.  It may contain any valid long option; the leading two dashes
3525   may not be entered and the option may not be abbreviated.  This default
3526   name may be changed on the command line (@pxref{gpg-option --options}).
3527   You should backup this file.
3528
3529 @end table
3530
3531 Note that on larger installations, it is useful to put predefined files
3532 into the directory @file{@value{SYSCONFSKELDIR}} so that
3533 newly created users start up with a working configuration.
3534 For existing users a small
3535 helper script is provided to create these files (@pxref{addgnupghome}).
3536
3537 For internal purposes @command{@gpgname} creates and maintains a few other
3538 files; They all live in the current home directory (@pxref{option
3539 --homedir}).  Only the @command{@gpgname} program may modify these files.
3540
3541
3542 @table @file
3543   @item ~/.gnupg
3544   @efindex ~/.gnupg
3545   This is the default home directory which is used if neither the
3546   environment variable @code{GNUPGHOME} nor the option
3547   @option{--homedir} is given.
3548
3549   @item ~/.gnupg/pubring.gpg
3550   @efindex pubring.gpg
3551   The public keyring.  You should backup this file.
3552
3553   @item ~/.gnupg/pubring.gpg.lock
3554   The lock file for the public keyring.
3555
3556   @item ~/.gnupg/pubring.kbx
3557   @efindex pubring.kbx
3558   The public keyring using a different format.  This file is shared
3559   with @command{gpgsm}.  You should backup this file.
3560
3561   @item ~/.gnupg/pubring.kbx.lock
3562   The lock file for @file{pubring.kbx}.
3563
3564   @item ~/.gnupg/secring.gpg
3565   @efindex secring.gpg
3566   A secret keyring as used by GnuPG versions before 2.1.  It is not
3567   used by GnuPG 2.1 and later.
3568
3569   @item ~/.gnupg/secring.gpg.lock
3570   The lock file for the secret keyring.
3571
3572   @item ~/.gnupg/.gpg-v21-migrated
3573   @efindex .gpg-v21-migrated
3574   File indicating that a migration to GnuPG 2.1 has been done.
3575
3576   @item ~/.gnupg/trustdb.gpg
3577   @efindex trustdb.gpg
3578   The trust database.  There is no need to backup this file; it is better
3579   to backup the ownertrust values (@pxref{option --export-ownertrust}).
3580
3581   @item ~/.gnupg/trustdb.gpg.lock
3582   The lock file for the trust database.
3583
3584   @item ~/.gnupg/random_seed
3585   @efindex random_seed
3586   A file used to preserve the state of the internal random pool.
3587
3588   @item ~/.gnupg/openpgp-revocs.d/
3589   @efindex openpgp-revocs.d
3590   This is the directory where gpg stores pre-generated revocation
3591   certificates.  The file name corresponds to the OpenPGP fingerprint of
3592   the respective key.  It is suggested to backup those certificates and
3593   if the primary private key is not stored on the disk to move them to
3594   an external storage device.  Anyone who can access theses files is
3595   able to revoke the corresponding key.  You may want to print them out.
3596   You should backup all files in this directory and take care to keep
3597   this backup closed away.
3598
3599 @end table
3600
3601 Operation is further controlled by a few environment variables:
3602
3603 @table @asis
3604
3605   @item HOME
3606   @efindex HOME
3607   Used to locate the default home directory.
3608
3609   @item GNUPGHOME
3610   @efindex GNUPGHOME
3611   If set directory used instead of "~/.gnupg".
3612
3613   @item GPG_AGENT_INFO
3614   This variable is obsolete; it was used by GnuPG versions before 2.1.
3615
3616   @item PINENTRY_USER_DATA
3617   @efindex PINENTRY_USER_DATA
3618   This value is passed via gpg-agent to pinentry.  It is useful to convey
3619   extra information to a custom pinentry.
3620
3621   @item COLUMNS
3622   @itemx LINES
3623   @efindex COLUMNS
3624   @efindex LINES
3625   Used to size some displays to the full size of the screen.
3626
3627   @item LANGUAGE
3628   @efindex LANGUAGE
3629   Apart from its use by GNU, it is used in the W32 version to override the
3630   language selection done through the Registry.  If used and set to a
3631   valid and available language name (@var{langid}), the file with the
3632   translation is loaded from
3633   @code{@var{gpgdir}/gnupg.nls/@var{langid}.mo}.  Here @var{gpgdir} is the
3634   directory out of which the gpg binary has been loaded.  If it can't be
3635   loaded the Registry is tried and as last resort the native Windows
3636   locale system is used.
3637
3638 @end table
3639
3640
3641 @c *******************************************
3642 @c ***************            ****************
3643 @c ***************  EXAMPLES  ****************
3644 @c ***************            ****************
3645 @c *******************************************
3646 @mansect examples
3647 @node GPG Examples
3648 @section Examples
3649
3650 @table @asis
3651
3652 @item gpg -se -r @code{Bob} @code{file}
3653 sign and encrypt for user Bob
3654
3655 @item gpg --clear-sign @code{file}
3656 make a cleartext signature
3657
3658 @item gpg -sb @code{file}
3659 make a detached signature
3660
3661 @item gpg -u 0x12345678 -sb @code{file}
3662 make a detached signature with the key 0x12345678
3663
3664 @item gpg --list-keys @code{user_ID}
3665 show keys
3666
3667 @item gpg --fingerprint @code{user_ID}
3668 show fingerprint
3669
3670 @item gpg --verify @code{pgpfile}
3671 @itemx gpg --verify @code{sigfile} [@code{datafile}]
3672 Verify the signature of the file but do not output the data unless
3673 requested.  The second form is used for detached signatures, where
3674 @code{sigfile} is the detached signature (either ASCII armored or
3675 binary) and @code{datafile} are the signed data; if this is not given, the name of the
3676 file holding the signed data is constructed by cutting off the
3677 extension (".asc" or ".sig") of @code{sigfile} or by asking the user
3678 for the filename.  If the option @option{--output} is also used the
3679 signed data is written to the file specified by that option; use
3680 @code{-} to write the signed data to stdout.
3681 @end table
3682
3683
3684 @c *******************************************
3685 @c ***************            ****************
3686 @c ***************  USER ID   ****************
3687 @c ***************            ****************
3688 @c *******************************************
3689 @mansect how to specify a user id
3690 @ifset isman
3691 @include specify-user-id.texi
3692 @end ifset
3693
3694 @mansect filter expressions
3695 @chapheading FILTER EXPRESSIONS
3696
3697 The options @option{--import-filter} and @option{--export-filter} use
3698 expressions with this syntax (square brackets indicate an optional
3699 part and curly braces a repetition, white space between the elements
3700 are allowed):
3701
3702 @c man:.RS
3703 @example
3704   [lc] @{[@{flag@}] PROPNAME op VALUE [lc]@}
3705 @end example
3706 @c man:.RE
3707
3708 The name of a property (@var{PROPNAME}) may only consist of letters,
3709 digits and underscores.  The description for the filter type
3710 describes which properties are defined.  If an undefined property is
3711 used it evaluates to the empty string.  Unless otherwise noted, the
3712 @var{VALUE} must always be given and may not be the empty string.  No
3713 quoting is defined for the value, thus the value may not contain the
3714 strings @code{&&} or @code{||}, which are used as logical connection
3715 operators.  The flag @code{--} can be used to remove this restriction.
3716
3717 Numerical values are computed as long int; standard C notation
3718 applies.  @var{lc} is the logical connection operator; either
3719 @code{&&} for a conjunction or @code{||} for a disjunction.  A
3720 conjunction is assumed at the begin of an expression.  Conjunctions
3721 have higher precedence than disjunctions.  If @var{VALUE} starts with
3722 one of the characters used in any @var{op} a space after the
3723 @var{op} is required.
3724
3725 @noindent
3726 The supported operators (@var{op}) are:
3727
3728 @table @asis
3729
3730   @item =~
3731   Substring must match.
3732
3733   @item  !~
3734   Substring must not match.
3735
3736   @item  =
3737   The full string must match.
3738
3739   @item  <>
3740   The full string must not match.
3741
3742   @item  ==
3743   The numerical value must match.
3744
3745   @item  !=
3746   The numerical value must not match.
3747
3748   @item  <=
3749   The numerical value of the field must be LE than the value.
3750
3751   @item  <
3752   The numerical value of the field must be LT than the value.
3753
3754   @item  >
3755   The numerical value of the field must be GT than the value.
3756
3757   @item  >=
3758   The numerical value of the field must be GE than the value.
3759
3760   @item  -le
3761   The string value of the field must be less or equal than the value.
3762
3763   @item  -lt
3764   The string value of the field must be less than the value.
3765
3766   @item  -gt
3767   The string value of the field must be greater than the value.
3768
3769   @item  -ge
3770   The string value of the field must be greater or equal than the value.
3771
3772   @item  -n
3773   True if value is not empty (no value allowed).
3774
3775   @item  -z
3776   True if value is empty (no value allowed).
3777
3778   @item  -t
3779   Alias for "PROPNAME != 0" (no value allowed).
3780
3781   @item  -f
3782   Alias for "PROPNAME == 0" (no value allowed).
3783
3784 @end table
3785
3786 @noindent
3787 Values for @var{flag} must be space separated.  The supported flags
3788 are:
3789
3790 @table @asis
3791   @item --
3792   @var{VALUE} spans to the end of the expression.
3793   @item -c
3794   The string match in this part is done case-sensitive.
3795 @end table
3796
3797 The filter options concatenate several specifications for a filter of
3798 the same type.  For example the four options in this example:
3799
3800 @c man:.RS
3801 @example
3802  --import-option keep-uid="uid =~ Alfa"
3803  --import-option keep-uid="&& uid !~ Test"
3804  --import-option keep-uid="|| uid =~ Alpha"
3805  --import-option keep-uid="uid !~ Test"
3806 @end example
3807 @c man:.RE
3808
3809 @noindent
3810 which is equivalent to
3811
3812 @c man:.RS
3813 @example
3814  --import-option \
3815   keep-uid="uid =~ Alfa" && uid !~ Test" || uid =~ Alpha" && "uid !~ Test"
3816 @end example
3817 @c man:.RE
3818
3819 imports only the user ids of a key containing the strings "Alfa"
3820 or "Alpha" but not the string "test".
3821
3822 @mansect trust values
3823 @ifset isman
3824 @include trust-values.texi
3825 @end ifset
3826
3827 @mansect return value
3828 @chapheading RETURN VALUE
3829
3830 The program returns 0 if everything was fine, 1 if at least
3831 a signature was bad, and other error codes for fatal errors.
3832
3833 @mansect warnings
3834 @chapheading WARNINGS
3835
3836 Use a *good* password for your user account and a *good* passphrase
3837 to protect your secret key. This passphrase is the weakest part of the
3838 whole system. Programs to do dictionary attacks on your secret keyring
3839 are very easy to write and so you should protect your "~/.gnupg/"
3840 directory very well.
3841
3842 Keep in mind that, if this program is used over a network (telnet), it
3843 is *very* easy to spy out your passphrase!
3844
3845 If you are going to verify detached signatures, make sure that the
3846 program knows about it; either give both filenames on the command line
3847 or use @samp{-} to specify STDIN.
3848
3849 For scripted or other unattended use of @command{gpg} make sure to use
3850 the machine-parseable interface and not the default interface which is
3851 intended for direct use by humans.  The machine-parseable interface
3852 provides a stable and well documented API independent of the locale or
3853 future changes of @command{gpg}.  To enable this interface use the
3854 options @option{--with-colons} and @option{--status-fd}.  For certain
3855 operations the option @option{--command-fd} may come handy too.  See
3856 this man page and the file @file{DETAILS} for the specification of the
3857 interface.  Note that the GnuPG ``info'' pages as well as the PDF
3858 version of the GnuPG manual features a chapter on unattended use of
3859 GnuPG.  As an alternative the library @command{GPGME} can be used as a
3860 high-level abstraction on top of that interface.
3861
3862 @mansect interoperability
3863 @chapheading INTEROPERABILITY WITH OTHER OPENPGP PROGRAMS
3864
3865 GnuPG tries to be a very flexible implementation of the OpenPGP
3866 standard. In particular, GnuPG implements many of the optional parts
3867 of the standard, such as the SHA-512 hash, and the ZLIB and BZIP2
3868 compression algorithms. It is important to be aware that not all
3869 OpenPGP programs implement these optional algorithms and that by
3870 forcing their use via the @option{--cipher-algo},
3871 @option{--digest-algo}, @option{--cert-digest-algo}, or
3872 @option{--compress-algo} options in GnuPG, it is possible to create a
3873 perfectly valid OpenPGP message, but one that cannot be read by the
3874 intended recipient.
3875
3876 There are dozens of variations of OpenPGP programs available, and each
3877 supports a slightly different subset of these optional algorithms.
3878 For example, until recently, no (unhacked) version of PGP supported
3879 the BLOWFISH cipher algorithm. A message using BLOWFISH simply could
3880 not be read by a PGP user. By default, GnuPG uses the standard
3881 OpenPGP preferences system that will always do the right thing and
3882 create messages that are usable by all recipients, regardless of which
3883 OpenPGP program they use. Only override this safe default if you
3884 really know what you are doing.
3885
3886 If you absolutely must override the safe default, or if the preferences
3887 on a given key are invalid for some reason, you are far better off using
3888 the @option{--pgp6}, @option{--pgp7}, or @option{--pgp8} options. These
3889 options are safe as they do not force any particular algorithms in
3890 violation of OpenPGP, but rather reduce the available algorithms to a
3891 "PGP-safe" list.
3892
3893 @mansect bugs
3894 @chapheading BUGS
3895
3896 On older systems this program should be installed as setuid(root). This
3897 is necessary to lock memory pages. Locking memory pages prevents the
3898 operating system from writing memory pages (which may contain
3899 passphrases or other sensitive material) to disk. If you get no
3900 warning message about insecure memory your operating system supports
3901 locking without being root. The program drops root privileges as soon
3902 as locked memory is allocated.
3903
3904 Note also that some systems (especially laptops) have the ability to
3905 ``suspend to disk'' (also known as ``safe sleep'' or ``hibernate'').
3906 This writes all memory to disk before going into a low power or even
3907 powered off mode.  Unless measures are taken in the operating system
3908 to protect the saved memory, passphrases or other sensitive material
3909 may be recoverable from it later.
3910
3911 Before you report a bug you should first search the mailing list
3912 archives for similar problems and second check whether such a bug has
3913 already been reported to our bug tracker at @url{https://bugs.gnupg.org}.
3914
3915 @c *******************************************
3916 @c ***************              **************
3917 @c ***************  UNATTENDED  **************
3918 @c ***************              **************
3919 @c *******************************************
3920 @manpause
3921 @node Unattended Usage of GPG
3922 @section Unattended Usage
3923
3924 @command{@gpgname} is often used as a backend engine by other software.  To help
3925 with this a machine interface has been defined to have an unambiguous
3926 way to do this.  The options @option{--status-fd} and @option{--batch}
3927 are almost always required for this.
3928
3929 @menu
3930 * Programmatic use of GnuPG:: Programmatic use of GnuPG
3931 * Ephemeral home directories:: Ephemeral home directories
3932 * The quick key manipulation interface:: The quick key manipulation interface
3933 * Unattended GPG key generation::  Unattended key generation
3934 @end menu
3935
3936
3937 @node Programmatic use of GnuPG
3938 @subsection Programmatic use of GnuPG
3939
3940 Please consider using GPGME instead of calling @command{@gpgname}
3941 directly.  GPGME offers a stable, backend-independent interface for
3942 many cryptographic operations.  It supports OpenPGP and S/MIME, and
3943 also allows interaction with various GnuPG components.
3944
3945 GPGME provides a C-API, and comes with bindings for C++, Qt, and
3946 Python.  Bindings for other languages are available.
3947
3948 @node Ephemeral home directories
3949 @subsection Ephemeral home directories
3950
3951 Sometimes you want to contain effects of some operation, for example
3952 you want to import a key to inspect it, but you do not want this key
3953 to be added to your keyring.  In earlier versions of GnuPG, it was
3954 possible to specify alternate keyring files for both public and secret
3955 keys.  In modern GnuPG versions, however, we changed how secret keys
3956 are stored in order to better protect secret key material, and it was
3957 not possible to preserve this interface.
3958
3959 The preferred way to do this is to use ephemeral home directories.
3960 This technique works across all versions of GnuPG.
3961
3962 Create a temporary directory, create (or copy) a configuration that
3963 meets your needs, make @command{@gpgname} use this directory either
3964 using the environment variable @var{GNUPGHOME}, or the option
3965 @option{--homedir}.  GPGME supports this too on a per-context basis,
3966 by modifying the engine info of contexts.  Now execute whatever
3967 operation you like, import and export key material as necessary.  Once
3968 finished, you can delete the directory.  All GnuPG backend services
3969 that were started will detect this and shut down.
3970
3971 @node The quick key manipulation interface
3972 @subsection The quick key manipulation interface
3973
3974 Recent versions of GnuPG have an interface to manipulate keys without
3975 using the interactive command @option{--edit-key}.  This interface was
3976 added mainly for the benefit of GPGME (please consider using GPGME,
3977 see the manual subsection ``Programmatic use of GnuPG'').  This
3978 interface is described in the subsection ``How to manage your keys''.
3979
3980 @node Unattended GPG key generation
3981 @subsection Unattended key generation
3982
3983 The command @option{--generate-key} may be used along with the option
3984 @option{--batch} for unattended key generation.  This is the most
3985 flexible way of generating keys, but it is also the most complex one.
3986 Consider using the quick key manipulation interface described in the
3987 previous subsection ``The quick key manipulation interface''.
3988
3989 The parameters for the key are either read from stdin or given as a
3990 file on the command line.  The format of the parameter file is as
3991 follows:
3992
3993 @itemize @bullet
3994   @item Text only, line length is limited to about 1000 characters.
3995   @item UTF-8 encoding must be used to specify non-ASCII characters.
3996   @item Empty lines are ignored.
3997   @item Leading and trailing white space is ignored.
3998   @item A hash sign as the first non white space character indicates
3999   a comment line.
4000   @item Control statements are indicated by a leading percent sign, the
4001   arguments are separated by white space from the keyword.
4002   @item Parameters are specified by a keyword, followed by a colon.  Arguments
4003   are separated by white space.
4004   @item
4005   The first parameter must be @samp{Key-Type}; control statements may be
4006   placed anywhere.
4007   @item
4008   The order of the parameters does not matter except for @samp{Key-Type}
4009   which must be the first parameter.  The parameters are only used for
4010   the generated keyblock (primary and subkeys); parameters from previous
4011   sets are not used.  Some syntactically checks may be performed.
4012   @item
4013   Key generation takes place when either the end of the parameter file
4014   is reached, the next @samp{Key-Type} parameter is encountered or at the
4015   control statement @samp{%commit} is encountered.
4016 @end itemize
4017
4018 @noindent
4019 Control statements:
4020
4021 @table @asis
4022
4023 @item %echo @var{text}
4024 Print @var{text} as diagnostic.
4025
4026 @item %dry-run
4027 Suppress actual key generation (useful for syntax checking).
4028
4029 @item %commit
4030 Perform the key generation.  Note that an implicit commit is done at
4031 the next @asis{Key-Type} parameter.
4032
4033 @item %pubring @var{filename}
4034 Do not write the key to the default or commandline given keyring but
4035 to @var{filename}.  This must be given before the first commit to take
4036 place, duplicate specification of the same filename is ignored, the
4037 last filename before a commit is used.  The filename is used until a
4038 new filename is used (at commit points) and all keys are written to
4039 that file. If a new filename is given, this file is created (and
4040 overwrites an existing one).
4041
4042 See the previous subsection ``Ephemeral home directories'' for a more
4043 robust way to contain side-effects.
4044
4045 @item %secring @var{filename}
4046 This option is a no-op for GnuPG 2.1 and later.
4047
4048 See the previous subsection ``Ephemeral home directories''.
4049
4050 @item %ask-passphrase
4051 @itemx %no-ask-passphrase
4052 This option is a no-op for GnuPG 2.1 and later.
4053
4054 @item %no-protection
4055 Using this option allows the creation of keys without any passphrase
4056 protection.  This option is mainly intended for regression tests.
4057
4058 @item %transient-key
4059 If given the keys are created using a faster and a somewhat less
4060 secure random number generator.  This option may be used for keys
4061 which are only used for a short time and do not require full
4062 cryptographic strength.  It takes only effect if used together with
4063 the control statement @samp{%no-protection}.
4064
4065 @end table
4066
4067 @noindent
4068 General Parameters:
4069
4070 @table @asis
4071
4072 @item Key-Type: @var{algo}
4073 Starts a new parameter block by giving the type of the primary
4074 key. The algorithm must be capable of signing.  This is a required
4075 parameter.  @var{algo} may either be an OpenPGP algorithm number or a
4076 string with the algorithm name.  The special value @samp{default} may
4077 be used for @var{algo} to create the default key type; in this case a
4078 @samp{Key-Usage} shall not be given and @samp{default} also be used
4079 for @samp{Subkey-Type}.
4080
4081 @item Key-Length: @var{nbits}
4082 The requested length of the generated key in bits.  The default is
4083 returned by running the command @samp{@gpgname --gpgconf-list}.
4084
4085 @item Key-Grip: @var{hexstring}
4086 This is optional and used to generate a CSR or certificate for an
4087 already existing key.  Key-Length will be ignored when given.
4088
4089 @item Key-Usage: @var{usage-list}
4090 Space or comma delimited list of key usages.  Allowed values are
4091 @samp{encrypt}, @samp{sign}, and @samp{auth}.  This is used to
4092 generate the key flags.  Please make sure that the algorithm is
4093 capable of this usage.  Note that OpenPGP requires that all primary
4094 keys are capable of certification, so no matter what usage is given
4095 here, the @samp{cert} flag will be on.  If no @samp{Key-Usage} is
4096 specified and the @samp{Key-Type} is not @samp{default}, all allowed
4097 usages for that particular algorithm are used; if it is not given but
4098 @samp{default} is used the usage will be @samp{sign}.
4099
4100 @item Subkey-Type: @var{algo}
4101 This generates a secondary key (subkey).  Currently only one subkey
4102 can be handled.  See also @samp{Key-Type} above.
4103
4104 @item Subkey-Length: @var{nbits}
4105 Length of the secondary key (subkey) in bits.  The default is returned
4106 by running the command @samp{@gpgname --gpgconf-list}.
4107
4108 @item Subkey-Usage: @var{usage-list}
4109 Key usage lists for a subkey; similar to @samp{Key-Usage}.
4110
4111 @item Passphrase: @var{string}
4112 If you want to specify a passphrase for the secret key, enter it here.
4113 Default is to use the Pinentry dialog to ask for a passphrase.
4114
4115 @item Name-Real: @var{name}
4116 @itemx Name-Comment: @var{comment}
4117 @itemx Name-Email: @var{email}
4118 The three parts of a user name.  Remember to use UTF-8 encoding here.
4119 If you don't give any of them, no user ID is created.
4120
4121 @item Expire-Date: @var{iso-date}|(@var{number}[d|w|m|y])
4122 Set the expiration date for the key (and the subkey).  It may either
4123 be entered in ISO date format (e.g. "20000815T145012") or as number of
4124 days, weeks, month or years after the creation date.  The special
4125 notation "seconds=N" is also allowed to specify a number of seconds
4126 since creation.  Without a letter days are assumed.  Note that there
4127 is no check done on the overflow of the type used by OpenPGP for
4128 timestamps.  Thus you better make sure that the given value make
4129 sense.  Although OpenPGP works with time intervals, GnuPG uses an
4130 absolute value internally and thus the last year we can represent is
4131 2105.
4132
4133 @item  Creation-Date: @var{iso-date}
4134 Set the creation date of the key as stored in the key information and
4135 which is also part of the fingerprint calculation.  Either a date like
4136 "1986-04-26" or a full timestamp like "19860426T042640" may be used.
4137 The time is considered to be UTC.  The special notation "seconds=N"
4138 may be used to directly specify a the number of seconds since Epoch
4139 (Unix time).  If it is not given the current time is used.
4140
4141 @item Preferences: @var{string}
4142 Set the cipher, hash, and compression preference values for this key.
4143 This expects the same type of string as the sub-command @samp{setpref}
4144 in the @option{--edit-key} menu.
4145
4146 @item  Revoker: @var{algo}:@var{fpr} [sensitive]
4147 Add a designated revoker to the generated key.  Algo is the public key
4148 algorithm of the designated revoker (i.e. RSA=1, DSA=17, etc.)
4149 @var{fpr} is the fingerprint of the designated revoker.  The optional
4150 @samp{sensitive} flag marks the designated revoker as sensitive
4151 information.  Only v4 keys may be designated revokers.
4152
4153 @item Keyserver: @var{string}
4154 This is an optional parameter that specifies the preferred keyserver
4155 URL for the key.
4156
4157 @item Handle: @var{string}
4158 This is an optional parameter only used with the status lines
4159 KEY_CREATED and KEY_NOT_CREATED.  @var{string} may be up to 100
4160 characters and should not contain spaces.  It is useful for batch key
4161 generation to associate a key parameter block with a status line.
4162
4163 @end table
4164
4165 @noindent
4166 Here is an example on how to create a key in an ephemeral home directory:
4167 @smallexample
4168 $ export GNUPGHOME="$(mktemp -d)"
4169 $ cat >foo <<EOF
4170      %echo Generating a basic OpenPGP key
4171      Key-Type: DSA
4172      Key-Length: 1024
4173      Subkey-Type: ELG-E
4174      Subkey-Length: 1024
4175      Name-Real: Joe Tester
4176      Name-Comment: with stupid passphrase
4177      Name-Email: joe@@foo.bar
4178      Expire-Date: 0
4179      Passphrase: abc
4180      # Do a commit here, so that we can later print "done" :-)
4181      %commit
4182      %echo done
4183 EOF
4184 $ @gpgname --batch --generate-key foo
4185  [...]
4186 $ @gpgname --list-secret-keys
4187 /tmp/tmp.0NQxB74PEf/pubring.kbx
4188 -------------------------------
4189 sec   dsa1024 2016-12-16 [SCA]
4190       768E895903FC1C44045C8CB95EEBDB71E9E849D0
4191 uid           [ultimate] Joe Tester (with stupid passphrase) <joe@@foo.bar>
4192 ssb   elg1024 2016-12-16 [E]
4193 @end smallexample
4194
4195 @noindent
4196 If you want to create a key with the default algorithms you would use
4197 these parameters:
4198 @smallexample
4199      %echo Generating a default key
4200      Key-Type: default
4201      Subkey-Type: default
4202      Name-Real: Joe Tester
4203      Name-Comment: with stupid passphrase
4204      Name-Email: joe@@foo.bar
4205      Expire-Date: 0
4206      Passphrase: abc
4207      # Do a commit here, so that we can later print "done" :-)
4208      %commit
4209      %echo done
4210 @end smallexample
4211
4212
4213
4214
4215 @mansect see also
4216 @ifset isman
4217 @command{gpgv}(1),
4218 @command{gpgsm}(1),
4219 @command{gpg-agent}(1)
4220 @end ifset
4221 @include see-also-note.texi