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