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