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