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