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