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