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