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