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