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