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