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