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