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