ad044ffc0f909fc459718c072a5f9470a784573d
[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.  When using together with the
1130 option @option{--dry-run} this will not actually change the passphrase
1131 but check that the current passphrase is correct.
1132
1133 @end table
1134
1135
1136 @c *******************************************
1137 @c ***************            ****************
1138 @c ***************  OPTIONS   ****************
1139 @c ***************            ****************
1140 @c *******************************************
1141 @mansect options
1142 @node GPG Options
1143 @section Option Summary
1144
1145 @command{@gpgname} features a bunch of options to control the exact
1146 behaviour and to change the default configuration.
1147
1148 @menu
1149 * GPG Configuration Options::   How to change the configuration.
1150 * GPG Key related Options::     Key related options.
1151 * GPG Input and Output::        Input and Output.
1152 * OpenPGP Options::             OpenPGP protocol specific options.
1153 * Compliance Options::          Compliance options.
1154 * GPG Esoteric Options::        Doing things one usually doesn't want to do.
1155 * Deprecated Options::          Deprecated options.
1156 @end menu
1157
1158 Long options can be put in an options file (default
1159 "~/.gnupg/gpg.conf"). Short option names will not work - for example,
1160 "armor" is a valid option for the options file, while "a" is not. Do not
1161 write the 2 dashes, but simply the name of the option and any required
1162 arguments. Lines with a hash ('#') as the first non-white-space
1163 character are ignored. Commands may be put in this file too, but that is
1164 not generally useful as the command will execute automatically with
1165 every execution of gpg.
1166
1167 Please remember that option parsing stops as soon as a non-option is
1168 encountered, you can explicitly stop parsing by using the special option
1169 @option{--}.
1170
1171 @c *******************************************
1172 @c ********  CONFIGURATION OPTIONS  **********
1173 @c *******************************************
1174 @node GPG Configuration Options
1175 @subsection How to change the configuration
1176
1177 These options are used to change the configuration and are usually found
1178 in the option file.
1179
1180 @table @gnupgtabopt
1181
1182 @item --default-key @var{name}
1183 @opindex default-key
1184 Use @var{name} as the default key to sign with. If this option is not
1185 used, the default key is the first key found in the secret keyring.
1186 Note that @option{-u} or @option{--local-user} overrides this option.
1187 This option may be given multiple times.  In this case, the last key
1188 for which a secret key is available is used.  If there is no secret
1189 key available for any of the specified values, GnuPG will not emit an
1190 error message but continue as if this option wasn't given.
1191
1192 @item --default-recipient @var{name}
1193 @opindex default-recipient
1194 Use @var{name} as default recipient if option @option{--recipient} is
1195 not used and don't ask if this is a valid one. @var{name} must be
1196 non-empty.
1197
1198 @item --default-recipient-self
1199 @opindex default-recipient-self
1200 Use the default key as default recipient if option @option{--recipient} is not
1201 used and don't ask if this is a valid one. The default key is the first
1202 one from the secret keyring or the one set with @option{--default-key}.
1203
1204 @item --no-default-recipient
1205 @opindex no-default-recipient
1206 Reset @option{--default-recipient} and @option{--default-recipient-self}.
1207
1208 @item -v, --verbose
1209 @opindex verbose
1210 Give more information during processing. If used
1211 twice, the input data is listed in detail.
1212
1213 @item --no-verbose
1214 @opindex no-verbose
1215 Reset verbose level to 0.
1216
1217 @item -q, --quiet
1218 @opindex quiet
1219 Try to be as quiet as possible.
1220
1221 @item --batch
1222 @itemx --no-batch
1223 @opindex batch
1224 @opindex no-batch
1225 Use batch mode.  Never ask, do not allow interactive commands.
1226 @option{--no-batch} disables this option.  Note that even with a
1227 filename given on the command line, gpg might still need to read from
1228 STDIN (in particular if gpg figures that the input is a
1229 detached signature and no data file has been specified).  Thus if you
1230 do not want to feed data via STDIN, you should connect STDIN to
1231 g@file{/dev/null}.
1232
1233 It is highly recommended to use this option along with the options
1234 @option{--status-fd} and @option{--with-colons} for any unattended use of
1235 @command{gpg}.
1236
1237 @item --no-tty
1238 @opindex no-tty
1239 Make sure that the TTY (terminal) is never used for any output.
1240 This option is needed in some cases because GnuPG sometimes prints
1241 warnings to the TTY even if @option{--batch} is used.
1242
1243 @item --yes
1244 @opindex yes
1245 Assume "yes" on most questions.
1246
1247 @item --no
1248 @opindex no
1249 Assume "no" on most questions.
1250
1251
1252 @item --list-options @var{parameters}
1253 @opindex list-options
1254 This is a space or comma delimited string that gives options used when
1255 listing keys and signatures (that is, @option{--list-keys},
1256 @option{--check-signatures}, @option{--list-public-keys},
1257 @option{--list-secret-keys}, and the @option{--edit-key} functions).
1258 Options can be prepended with a @option{no-} (after the two dashes) to
1259 give the opposite meaning.  The options are:
1260
1261 @table @asis
1262
1263   @item show-photos
1264   @opindex list-options:show-photos
1265   Causes @option{--list-keys}, @option{--check-signatures},
1266   @option{--list-public-keys}, and @option{--list-secret-keys} to
1267   display any photo IDs attached to the key.  Defaults to no. See also
1268   @option{--photo-viewer}.  Does not work with @option{--with-colons}:
1269   see @option{--attribute-fd} for the appropriate way to get photo data
1270   for scripts and other frontends.
1271
1272   @item show-usage
1273   @opindex list-options:show-usage
1274   Show usage information for keys and subkeys in the standard key
1275   listing.  This is a list of letters indicating the allowed usage for a
1276   key (@code{E}=encryption, @code{S}=signing, @code{C}=certification,
1277   @code{A}=authentication).  Defaults to yes.
1278
1279   @item show-policy-urls
1280   @opindex list-options:show-policy-urls
1281   Show policy URLs in the  @option{--check-signatures}
1282   listings.  Defaults to no.
1283
1284   @item show-notations
1285   @itemx show-std-notations
1286   @itemx show-user-notations
1287   @opindex list-options:show-notations
1288   @opindex list-options:show-std-notations
1289   @opindex list-options:show-user-notations
1290   Show all, IETF standard, or user-defined signature notations in the
1291   @option{--check-signatures} listings. Defaults to no.
1292
1293   @item show-keyserver-urls
1294   @opindex list-options:show-keyserver-urls
1295   Show any preferred keyserver URL in the
1296   @option{--check-signatures} listings. Defaults to no.
1297
1298   @item show-uid-validity
1299   @opindex list-options:show-uid-validity
1300   Display the calculated validity of user IDs during key listings.
1301   Defaults to yes.
1302
1303   @item show-unusable-uids
1304   @opindex list-options:show-unusable-uids
1305   Show revoked and expired user IDs in key listings. Defaults to no.
1306
1307   @item show-unusable-subkeys
1308   @opindex list-options:show-unusable-subkeys
1309   Show revoked and expired subkeys in key listings. Defaults to no.
1310
1311   @item show-keyring
1312   @opindex list-options:show-keyring
1313   Display the keyring name at the head of key listings to show which
1314   keyring a given key resides on. Defaults to no.
1315
1316   @item show-sig-expire
1317   @opindex list-options:show-sig-expire
1318   Show signature expiration dates (if any) during
1319   @option{--check-signatures} listings. Defaults to no.
1320
1321   @item show-sig-subpackets
1322   @opindex list-options:show-sig-subpackets
1323   Include signature subpackets in the key listing. This option can take an
1324   optional argument list of the subpackets to list. If no argument is
1325   passed, list all subpackets. Defaults to no. This option is only
1326   meaningful when using @option{--with-colons} along with
1327   @option{--check-signatures}.
1328
1329 @end table
1330
1331 @item --verify-options @var{parameters}
1332 @opindex verify-options
1333 This is a space or comma delimited string that gives options used when
1334 verifying signatures. Options can be prepended with a `no-' to give
1335 the opposite meaning. The options are:
1336
1337 @table @asis
1338
1339   @item show-photos
1340   @opindex verify-options:show-photos
1341   Display any photo IDs present on the key that issued the signature.
1342   Defaults to no. See also @option{--photo-viewer}.
1343
1344   @item show-policy-urls
1345   @opindex verify-options:show-policy-urls
1346   Show policy URLs in the signature being verified. Defaults to yes.
1347
1348   @item show-notations
1349   @itemx show-std-notations
1350   @itemx show-user-notations
1351   @opindex verify-options:show-notations
1352   @opindex verify-options:show-std-notations
1353   @opindex verify-options:show-user-notations
1354   Show all, IETF standard, or user-defined signature notations in the
1355   signature being verified. Defaults to IETF standard.
1356
1357   @item show-keyserver-urls
1358   @opindex verify-options:show-keyserver-urls
1359   Show any preferred keyserver URL in the signature being verified.
1360   Defaults to yes.
1361
1362   @item show-uid-validity
1363   @opindex verify-options:show-uid-validity
1364   Display the calculated validity of the user IDs on the key that issued
1365   the signature. Defaults to yes.
1366
1367   @item show-unusable-uids
1368   @opindex verify-options:show-unusable-uids
1369   Show revoked and expired user IDs during signature verification.
1370   Defaults to no.
1371
1372   @item show-primary-uid-only
1373   @opindex verify-options:show-primary-uid-only
1374   Show only the primary user ID during signature verification.  That is
1375   all the AKA lines as well as photo Ids are not shown with the signature
1376   verification status.
1377
1378   @item pka-lookups
1379   @opindex verify-options:pka-lookups
1380   Enable PKA lookups to verify sender addresses. Note that PKA is based
1381   on DNS, and so enabling this option may disclose information on when
1382   and what signatures are verified or to whom data is encrypted. This
1383   is similar to the "web bug" described for the @option{--auto-key-retrieve}
1384   option.
1385
1386   @item pka-trust-increase
1387   @opindex verify-options:pka-trust-increase
1388   Raise the trust in a signature to full if the signature passes PKA
1389   validation. This option is only meaningful if pka-lookups is set.
1390 @end table
1391
1392 @item --enable-large-rsa
1393 @itemx --disable-large-rsa
1394 @opindex enable-large-rsa
1395 @opindex disable-large-rsa
1396 With --generate-key and --batch, enable the creation of RSA secret keys as
1397 large as 8192 bit.  Note: 8192 bit is more than is generally
1398 recommended.  These large keys don't significantly improve security,
1399 but they are more expensive to use, and their signatures and
1400 certifications are larger.  This option is only available if the
1401 binary was build with large-secmem support.
1402
1403 @item --enable-dsa2
1404 @itemx --disable-dsa2
1405 @opindex enable-dsa2
1406 @opindex disable-dsa2
1407 Enable hash truncation for all DSA keys even for old DSA Keys up to
1408 1024 bit.  This is also the default with @option{--openpgp}.  Note
1409 that older versions of GnuPG also required this flag to allow the
1410 generation of DSA larger than 1024 bit.
1411
1412 @item --photo-viewer @var{string}
1413 @opindex photo-viewer
1414 This is the command line that should be run to view a photo ID. "%i"
1415 will be expanded to a filename containing the photo. "%I" does the
1416 same, except the file will not be deleted once the viewer exits.
1417 Other flags are "%k" for the key ID, "%K" for the long key ID, "%f"
1418 for the key fingerprint, "%t" for the extension of the image type
1419 (e.g. "jpg"), "%T" for the MIME type of the image (e.g. "image/jpeg"),
1420 "%v" for the single-character calculated validity of the image being
1421 viewed (e.g. "f"), "%V" for the calculated validity as a string (e.g.
1422 "full"), "%U" for a base32 encoded hash of the user ID,
1423 and "%%" for an actual percent sign. If neither %i or %I are present,
1424 then the photo will be supplied to the viewer on standard input.
1425
1426 The default viewer is "xloadimage -fork -quiet -title 'KeyID 0x%k'
1427 STDIN". Note that if your image viewer program is not secure, then
1428 executing it from GnuPG does not make it secure.
1429
1430 @item --exec-path @var{string}
1431 @opindex exec-path
1432 @efindex PATH
1433 Sets a list of directories to search for photo viewers and keyserver
1434 helpers. If not provided, keyserver helpers use the compiled-in
1435 default directory, and photo viewers use the @code{PATH} environment
1436 variable.
1437 Note, that on W32 system this value is ignored when searching for
1438 keyserver helpers.
1439
1440 @item --keyring @var{file}
1441 @opindex keyring
1442 Add @var{file} to the current list of keyrings. If @var{file} begins
1443 with a tilde and a slash, these are replaced by the $HOME directory. If
1444 the filename does not contain a slash, it is assumed to be in the GnuPG
1445 home directory ("~/.gnupg" if @option{--homedir} or $GNUPGHOME is not
1446 used).
1447
1448 Note that this adds a keyring to the current list. If the intent is to
1449 use the specified keyring alone, use @option{--keyring} along with
1450 @option{--no-default-keyring}.
1451
1452 If the option @option{--no-keyring} has been used no keyrings will
1453 be used at all.
1454
1455
1456 @item --secret-keyring @var{file}
1457 @opindex secret-keyring
1458 This is an obsolete option and ignored.  All secret keys are stored in
1459 the @file{private-keys-v1.d} directory below the GnuPG home directory.
1460
1461 @item --primary-keyring @var{file}
1462 @opindex primary-keyring
1463 Designate @var{file} as the primary public keyring. This means that
1464 newly imported keys (via @option{--import} or keyserver
1465 @option{--recv-from}) will go to this keyring.
1466
1467 @item --trustdb-name @var{file}
1468 @opindex trustdb-name
1469 Use @var{file} instead of the default trustdb. If @var{file} begins
1470 with a tilde and a slash, these are replaced by the $HOME directory. If
1471 the filename does not contain a slash, it is assumed to be in the GnuPG
1472 home directory (@file{~/.gnupg} if @option{--homedir} or $GNUPGHOME is
1473 not used).
1474
1475 @include opt-homedir.texi
1476
1477
1478 @item --display-charset @var{name}
1479 @opindex display-charset
1480 Set the name of the native character set. This is used to convert
1481 some informational strings like user IDs to the proper UTF-8 encoding.
1482 Note that this has nothing to do with the character set of data to be
1483 encrypted or signed; GnuPG does not recode user-supplied data. If
1484 this option is not used, the default character set is determined from
1485 the current locale. A verbosity level of 3 shows the chosen set.
1486 Valid values for @var{name} are:
1487
1488 @table @asis
1489
1490   @item iso-8859-1
1491   @opindex display-charset:iso-8859-1
1492   This is the Latin 1 set.
1493
1494   @item iso-8859-2
1495   @opindex display-charset:iso-8859-2
1496   The Latin 2 set.
1497
1498   @item iso-8859-15
1499   @opindex display-charset:iso-8859-15
1500   This is currently an alias for
1501   the Latin 1 set.
1502
1503   @item koi8-r
1504   @opindex display-charset:koi8-r
1505   The usual Russian set (RFC-1489).
1506
1507   @item utf-8
1508   @opindex display-charset:utf-8
1509   Bypass all translations and assume
1510   that the OS uses native UTF-8 encoding.
1511 @end table
1512
1513 @item --utf8-strings
1514 @itemx --no-utf8-strings
1515 @opindex utf8-strings
1516 Assume that command line arguments are given as UTF-8 strings. The
1517 default (@option{--no-utf8-strings}) is to assume that arguments are
1518 encoded in the character set as specified by
1519 @option{--display-charset}. These options affect all following
1520 arguments. Both options may be used multiple times.
1521
1522 @anchor{gpg-option --options}
1523 @item --options @var{file}
1524 @opindex options
1525 Read options from @var{file} and do not try to read them from the
1526 default options file in the homedir (see @option{--homedir}). This
1527 option is ignored if used in an options file.
1528
1529 @item --no-options
1530 @opindex no-options
1531 Shortcut for @option{--options /dev/null}. This option is detected
1532 before an attempt to open an option file.  Using this option will also
1533 prevent the creation of a @file{~/.gnupg} homedir.
1534
1535 @item -z @var{n}
1536 @itemx --compress-level @var{n}
1537 @itemx --bzip2-compress-level @var{n}
1538 @opindex compress-level
1539 @opindex bzip2-compress-level
1540 Set compression level to @var{n} for the ZIP and ZLIB compression
1541 algorithms. The default is to use the default compression level of zlib
1542 (normally 6). @option{--bzip2-compress-level} sets the compression level
1543 for the BZIP2 compression algorithm (defaulting to 6 as well). This is a
1544 different option from @option{--compress-level} since BZIP2 uses a
1545 significant amount of memory for each additional compression level.
1546 @option{-z} sets both. A value of 0 for @var{n} disables compression.
1547
1548 @item --bzip2-decompress-lowmem
1549 @opindex bzip2-decompress-lowmem
1550 Use a different decompression method for BZIP2 compressed files. This
1551 alternate method uses a bit more than half the memory, but also runs
1552 at half the speed. This is useful under extreme low memory
1553 circumstances when the file was originally compressed at a high
1554 @option{--bzip2-compress-level}.
1555
1556
1557 @item --mangle-dos-filenames
1558 @itemx --no-mangle-dos-filenames
1559 @opindex mangle-dos-filenames
1560 @opindex no-mangle-dos-filenames
1561 Older version of Windows cannot handle filenames with more than one
1562 dot. @option{--mangle-dos-filenames} causes GnuPG to replace (rather
1563 than add to) the extension of an output filename to avoid this
1564 problem. This option is off by default and has no effect on non-Windows
1565 platforms.
1566
1567 @item --ask-cert-level
1568 @itemx --no-ask-cert-level
1569 @opindex ask-cert-level
1570 When making a key signature, prompt for a certification level. If this
1571 option is not specified, the certification level used is set via
1572 @option{--default-cert-level}. See @option{--default-cert-level} for
1573 information on the specific levels and how they are
1574 used. @option{--no-ask-cert-level} disables this option. This option
1575 defaults to no.
1576
1577 @item --default-cert-level @var{n}
1578 @opindex default-cert-level
1579 The default to use for the check level when signing a key.
1580
1581 0 means you make no particular claim as to how carefully you verified
1582 the key.
1583
1584 1 means you believe the key is owned by the person who claims to own
1585 it but you could not, or did not verify the key at all. This is
1586 useful for a "persona" verification, where you sign the key of a
1587 pseudonymous user.
1588
1589 2 means you did casual verification of the key. For example, this
1590 could mean that you verified the key fingerprint and checked the
1591 user ID on the key against a photo ID.
1592
1593 3 means you did extensive verification of the key. For example, this
1594 could mean that you verified the key fingerprint with the owner of the
1595 key in person, and that you checked, by means of a hard to forge
1596 document with a photo ID (such as a passport) that the name of the key
1597 owner matches the name in the user ID on the key, and finally that you
1598 verified (by exchange of email) that the email address on the key
1599 belongs to the key owner.
1600
1601 Note that the examples given above for levels 2 and 3 are just that:
1602 examples. In the end, it is up to you to decide just what "casual"
1603 and "extensive" mean to you.
1604
1605 This option defaults to 0 (no particular claim).
1606
1607 @item --min-cert-level
1608 @opindex min-cert-level
1609 When building the trust database, treat any signatures with a
1610 certification level below this as invalid. Defaults to 2, which
1611 disregards level 1 signatures. Note that level 0 "no particular
1612 claim" signatures are always accepted.
1613
1614 @item --trusted-key @var{long key ID}
1615 @opindex trusted-key
1616 Assume that the specified key (which must be given
1617 as a full 8 byte key ID) is as trustworthy as one of
1618 your own secret keys. This option is useful if you
1619 don't want to keep your secret keys (or one of them)
1620 online but still want to be able to check the validity of a given
1621 recipient's or signator's key.
1622
1623 @item --trust-model @{pgp|classic|tofu|tofu+pgp|direct|always|auto@}
1624 @opindex trust-model
1625 Set what trust model GnuPG should follow. The models are:
1626
1627 @table @asis
1628
1629   @item pgp
1630   @opindex trust-model:pgp
1631   This is the Web of Trust combined with trust signatures as used in PGP
1632   5.x and later. This is the default trust model when creating a new
1633   trust database.
1634
1635   @item classic
1636   @opindex trust-model:classic
1637   This is the standard Web of Trust as introduced by PGP 2.
1638
1639   @item tofu
1640   @opindex trust-model:tofu
1641   @anchor{trust-model-tofu}
1642   TOFU stands for Trust On First Use.  In this trust model, the first
1643   time a key is seen, it is memorized.  If later another key with a
1644   user id with the same email address is seen, both keys are marked as
1645   suspect.  In that case, the next time either is used, a warning is
1646   displayed describing the conflict, why it might have occurred
1647   (either the user generated a new key and failed to cross sign the
1648   old and new keys, the key is forgery, or a man-in-the-middle attack
1649   is being attempted), and the user is prompted to manually confirm
1650   the validity of the key in question.
1651
1652   Because a potential attacker is able to control the email address
1653   and thereby circumvent the conflict detection algorithm by using an
1654   email address that is similar in appearance to a trusted email
1655   address, whenever a message is verified, statistics about the number
1656   of messages signed with the key are shown.  In this way, a user can
1657   easily identify attacks using fake keys for regular correspondents.
1658
1659   When compared with the Web of Trust, TOFU offers significantly
1660   weaker security guarantees.  In particular, TOFU only helps ensure
1661   consistency (that is, that the binding between a key and email
1662   address doesn't change).  A major advantage of TOFU is that it
1663   requires little maintenance to use correctly.  To use the web of
1664   trust properly, you need to actively sign keys and mark users as
1665   trusted introducers.  This is a time-consuming process and anecdotal
1666   evidence suggests that even security-conscious users rarely take the
1667   time to do this thoroughly and instead rely on an ad-hoc TOFU
1668   process.
1669
1670   In the TOFU model, policies are associated with bindings between
1671   keys and email addresses (which are extracted from user ids and
1672   normalized).  There are five policies, which can be set manually
1673   using the @option{--tofu-policy} option.  The default policy can be
1674   set using the @option{--tofu-default-policy} option.
1675
1676   The TOFU policies are: @code{auto}, @code{good}, @code{unknown},
1677   @code{bad} and @code{ask}.  The @code{auto} policy is used by
1678   default (unless overridden by @option{--tofu-default-policy}) and
1679   marks a binding as marginally trusted.  The @code{good},
1680   @code{unknown} and @code{bad} policies mark a binding as fully
1681   trusted, as having unknown trust or as having trust never,
1682   respectively.  The @code{unknown} policy is useful for just using
1683   TOFU to detect conflicts, but to never assign positive trust to a
1684   binding.  The final policy, @code{ask} prompts the user to indicate
1685   the binding's trust.  If batch mode is enabled (or input is
1686   inappropriate in the context), then the user is not prompted and the
1687   @code{undefined} trust level is returned.
1688
1689   @item tofu+pgp
1690   @opindex trust-model:tofu+pgp
1691   This trust model combines TOFU with the Web of Trust.  This is done
1692   by computing the trust level for each model and then taking the
1693   maximum trust level where the trust levels are ordered as follows:
1694   @code{unknown < undefined < marginal < fully < ultimate < expired <
1695   never}.
1696
1697   By setting @option{--tofu-default-policy=unknown}, this model can be
1698   used to implement the web of trust with TOFU's conflict detection
1699   algorithm, but without its assignment of positive trust values,
1700   which some security-conscious users don't like.
1701
1702   @item direct
1703   @opindex trust-model:direct
1704   Key validity is set directly by the user and not calculated via the
1705   Web of Trust.  This model is solely based on the key and does
1706   not distinguish user IDs.  Note that when changing to another trust
1707   model the trust values assigned to a key are transformed into
1708   ownertrust values, which also indicate how you trust the owner of
1709   the key to sign other keys.
1710
1711   @item always
1712   @opindex trust-model:always
1713   Skip key validation and assume that used keys are always fully
1714   valid. You generally won't use this unless you are using some
1715   external validation scheme. This option also suppresses the
1716   "[uncertain]" tag printed with signature checks when there is no
1717   evidence that the user ID is bound to the key.  Note that this
1718   trust model still does not allow the use of expired, revoked, or
1719   disabled keys.
1720
1721   @item auto
1722   @opindex trust-model:auto
1723   Select the trust model depending on whatever the internal trust
1724   database says. This is the default model if such a database already
1725   exists.
1726 @end table
1727
1728 @item --auto-key-locate @var{mechanisms}
1729 @itemx --no-auto-key-locate
1730 @opindex auto-key-locate
1731 GnuPG can automatically locate and retrieve keys as needed using this
1732 option.  This happens when encrypting to an email address (in the
1733 "user@@example.com" form), and there are no "user@@example.com" keys
1734 on the local keyring.  This option takes any number of the mechanisms
1735 listed below, in the order they are to be tried.  Instead of listing
1736 the mechanisms as comma delimited arguments, the option may also be
1737 given several times to add more mechanism.  The option
1738 @option{--no-auto-key-locate} or the mechanism "clear" resets the
1739 list.  The default is "local,wkd".
1740
1741 @table @asis
1742
1743   @item cert
1744   Locate a key using DNS CERT, as specified in RFC-4398.
1745
1746   @item pka
1747   Locate a key using DNS PKA.
1748
1749   @item dane
1750   Locate a key using DANE, as specified
1751   in draft-ietf-dane-openpgpkey-05.txt.
1752
1753   @item wkd
1754   Locate a key using the Web Key Directory protocol.
1755
1756   @item ldap
1757   Using DNS Service Discovery, check the domain in question for any LDAP
1758   keyservers to use.  If this fails, attempt to locate the key using the
1759   PGP Universal method of checking @samp{ldap://keys.(thedomain)}.
1760
1761   @item keyserver
1762   Locate a key using whatever keyserver is defined using the
1763   @option{--keyserver} option.
1764
1765   @item keyserver-URL
1766   In addition, a keyserver URL as used in the @option{--keyserver} option
1767   may be used here to query that particular keyserver.
1768
1769   @item local
1770   Locate the key using the local keyrings.  This mechanism allows the user to
1771   select the order a local key lookup is done.  Thus using
1772   @samp{--auto-key-locate local} is identical to
1773   @option{--no-auto-key-locate}.
1774
1775   @item nodefault
1776   This flag disables the standard local key lookup, done before any of the
1777   mechanisms defined by the @option{--auto-key-locate} are tried.  The
1778   position of this mechanism in the list does not matter.  It is not
1779   required if @code{local} is also used.
1780
1781   @item clear
1782   Clear all defined mechanisms.  This is useful to override
1783   mechanisms given in a config file.
1784
1785 @end table
1786
1787
1788 @item --auto-key-retrieve
1789 @itemx --no-auto-key-retrieve
1790 @opindex auto-key-retrieve
1791 @opindex no-auto-key-retrieve
1792 These options enable or disable the automatic retrieving of keys from
1793 a keyserver when verifying signatures made by keys that are not on the
1794 local keyring.  The default is @option{--no-auto-key-retrieve}.
1795
1796 If the method "wkd" is included in the list of methods given to
1797 @option{auto-key-locate}, the signer's user ID is part of the
1798 signature, and the option @option{--disable-signer-uid} is not used,
1799 the "wkd" method may also be used to retrieve a key.
1800
1801 Note that this option makes a "web bug" like behavior possible.
1802 Keyserver or Web Key Directory operators can see which keys you
1803 request, so by sending you a message signed by a brand new key (which
1804 you naturally will not have on your local keyring), the operator can
1805 tell both your IP address and the time when you verified the
1806 signature.
1807
1808 @item --keyid-format @{none|short|0xshort|long|0xlong@}
1809 @opindex keyid-format
1810 Select how to display key IDs.  "none" does not show the key ID at all
1811 but shows the fingerprint in a separate line.  "short" is the
1812 traditional 8-character key ID.  "long" is the more accurate (but less
1813 convenient) 16-character key ID.  Add an "0x" to either to include an
1814 "0x" at the beginning of the key ID, as in 0x99242560.  Note that this
1815 option is ignored if the option @option{--with-colons} is used.
1816
1817 @item --keyserver @var{name}
1818 @opindex keyserver
1819 This option is deprecated - please use the @option{--keyserver} in
1820 @file{dirmngr.conf} instead.
1821
1822 Use @var{name} as your keyserver. This is the server that
1823 @option{--receive-keys}, @option{--send-keys}, and @option{--search-keys}
1824 will communicate with to receive keys from, send keys to, and search for
1825 keys on. The format of the @var{name} is a URI:
1826 `scheme:[//]keyservername[:port]' The scheme is the type of keyserver:
1827 "hkp" for the HTTP (or compatible) keyservers, "ldap" for the LDAP
1828 keyservers, or "mailto" for the Graff email keyserver. Note that your
1829 particular installation of GnuPG may have other keyserver types
1830 available as well. Keyserver schemes are case-insensitive. After the
1831 keyserver name, optional keyserver configuration options may be
1832 provided. These are the same as the global @option{--keyserver-options}
1833 from below, but apply only to this particular keyserver.
1834
1835 Most keyservers synchronize with each other, so there is generally no
1836 need to send keys to more than one server. The keyserver
1837 @code{hkp://keys.gnupg.net} uses round robin DNS to give a different
1838 keyserver each time you use it.
1839
1840 @item --keyserver-options @{@var{name}=@var{value}@}
1841 @opindex keyserver-options
1842 This is a space or comma delimited string that gives options for the
1843 keyserver. Options can be prefixed with a `no-' to give the opposite
1844 meaning. Valid import-options or export-options may be used here as
1845 well to apply to importing (@option{--recv-key}) or exporting
1846 (@option{--send-key}) a key from a keyserver. While not all options
1847 are available for all keyserver types, some common options are:
1848
1849 @table @asis
1850
1851   @item include-revoked
1852   When searching for a key with @option{--search-keys}, include keys that
1853   are marked on the keyserver as revoked. Note that not all keyservers
1854   differentiate between revoked and unrevoked keys, and for such
1855   keyservers this option is meaningless. Note also that most keyservers do
1856   not have cryptographic verification of key revocations, and so turning
1857   this option off may result in skipping keys that are incorrectly marked
1858   as revoked.
1859
1860   @item include-disabled
1861   When searching for a key with @option{--search-keys}, include keys that
1862   are marked on the keyserver as disabled. Note that this option is not
1863   used with HKP keyservers.
1864
1865   @item auto-key-retrieve
1866   This is an obsolete alias for the option @option{auto-key-retrieve}.
1867   Please do not use it; it will be removed in future versions..
1868
1869   @item honor-keyserver-url
1870   When using @option{--refresh-keys}, if the key in question has a preferred
1871   keyserver URL, then use that preferred keyserver to refresh the key
1872   from. In addition, if auto-key-retrieve is set, and the signature
1873   being verified has a preferred keyserver URL, then use that preferred
1874   keyserver to fetch the key from. Note that this option introduces a
1875   "web bug": The creator of the key can see when the keys is
1876   refreshed.  Thus this option is not enabled by default.
1877
1878   @item honor-pka-record
1879   If @option{--auto-key-retrieve} is used, and the signature being
1880   verified has a PKA record, then use the PKA information to fetch
1881   the key. Defaults to "yes".
1882
1883   @item include-subkeys
1884   When receiving a key, include subkeys as potential targets. Note that
1885   this option is not used with HKP keyservers, as they do not support
1886   retrieving keys by subkey id.
1887
1888   @item timeout
1889   Tell the keyserver helper program how long (in seconds) to try and
1890   perform a keyserver action before giving up. Note that performing
1891   multiple actions at the same time uses this timeout value per action.
1892   For example, when retrieving multiple keys via @option{--receive-keys}, the
1893   timeout applies separately to each key retrieval, and not to the
1894   @option{--receive-keys} command as a whole. Defaults to 30 seconds.
1895
1896   @item http-proxy=@var{value}
1897   This option is deprecated.
1898   Set the proxy to use for HTTP and HKP keyservers.
1899   This overrides any proxy defined in @file{dirmngr.conf}.
1900
1901   @item verbose
1902   This option has no more function since GnuPG 2.1.  Use the
1903   @code{dirmngr} configuration options instead.
1904
1905   @item debug
1906   This option has no more function since GnuPG 2.1.  Use the
1907   @code{dirmngr} configuration options instead.
1908
1909   @item check-cert
1910   This option has no more function since GnuPG 2.1.  Use the
1911   @code{dirmngr} configuration options instead.
1912
1913   @item ca-cert-file
1914   This option has no more function since GnuPG 2.1.  Use the
1915   @code{dirmngr} configuration options instead.
1916
1917 @end table
1918
1919 @item --completes-needed @var{n}
1920 @opindex compliant-needed
1921 Number of completely trusted users to introduce a new
1922 key signer (defaults to 1).
1923
1924 @item --marginals-needed @var{n}
1925 @opindex marginals-needed
1926 Number of marginally trusted users to introduce a new
1927 key signer (defaults to 3)
1928
1929 @item --tofu-default-policy @{auto|good|unknown|bad|ask@}
1930 @opindex tofu-default-policy
1931 The default TOFU policy (defaults to @code{auto}).  For more
1932 information about the meaning of this option, @pxref{trust-model-tofu}.
1933
1934 @item --max-cert-depth @var{n}
1935 @opindex max-cert-depth
1936 Maximum depth of a certification chain (default is 5).
1937
1938 @item --no-sig-cache
1939 @opindex no-sig-cache
1940 Do not cache the verification status of key signatures.
1941 Caching gives a much better performance in key listings. However, if
1942 you suspect that your public keyring is not safe against write
1943 modifications, you can use this option to disable the caching. It
1944 probably does not make sense to disable it because all kind of damage
1945 can be done if someone else has write access to your public keyring.
1946
1947 @item --auto-check-trustdb
1948 @itemx --no-auto-check-trustdb
1949 @opindex auto-check-trustdb
1950 If GnuPG feels that its information about the Web of Trust has to be
1951 updated, it automatically runs the @option{--check-trustdb} command
1952 internally.  This may be a time consuming
1953 process. @option{--no-auto-check-trustdb} disables this option.
1954
1955 @item --use-agent
1956 @itemx --no-use-agent
1957 @opindex use-agent
1958 This is dummy option. @command{@gpgname} always requires the agent.
1959
1960 @item --gpg-agent-info
1961 @opindex gpg-agent-info
1962 This is dummy option. It has no effect when used with @command{@gpgname}.
1963
1964
1965 @item --agent-program @var{file}
1966 @opindex agent-program
1967 Specify an agent program to be used for secret key operations.  The
1968 default value is determined by running @command{gpgconf} with the
1969 option @option{--list-dirs}.  Note that the pipe symbol (@code{|}) is
1970 used for a regression test suite hack and may thus not be used in the
1971 file name.
1972
1973 @item --dirmngr-program @var{file}
1974 @opindex dirmngr-program
1975 Specify a dirmngr program to be used for keyserver access.  The
1976 default value is @file{@value{BINDIR}/dirmngr}.
1977
1978 @item --disable-dirmngr
1979 Entirely disable the use of the Dirmngr.
1980
1981 @item --no-autostart
1982 @opindex no-autostart
1983 Do not start the gpg-agent or the dirmngr if it has not yet been
1984 started and its service is required.  This option is mostly useful on
1985 machines where the connection to gpg-agent has been redirected to
1986 another machines.  If dirmngr is required on the remote machine, it
1987 may be started manually using @command{gpgconf --launch dirmngr}.
1988
1989 @item --lock-once
1990 @opindex lock-once
1991 Lock the databases the first time a lock is requested
1992 and do not release the lock until the process
1993 terminates.
1994
1995 @item --lock-multiple
1996 @opindex lock-multiple
1997 Release the locks every time a lock is no longer
1998 needed. Use this to override a previous @option{--lock-once}
1999 from a config file.
2000
2001 @item --lock-never
2002 @opindex lock-never
2003 Disable locking entirely. This option should be used only in very
2004 special environments, where it can be assured that only one process
2005 is accessing those files. A bootable floppy with a stand-alone
2006 encryption system will probably use this. Improper usage of this
2007 option may lead to data and key corruption.
2008
2009 @item --exit-on-status-write-error
2010 @opindex exit-on-status-write-error
2011 This option will cause write errors on the status FD to immediately
2012 terminate the process. That should in fact be the default but it never
2013 worked this way and thus we need an option to enable this, so that the
2014 change won't break applications which close their end of a status fd
2015 connected pipe too early. Using this option along with
2016 @option{--enable-progress-filter} may be used to cleanly cancel long
2017 running gpg operations.
2018
2019 @item --limit-card-insert-tries @var{n}
2020 @opindex limit-card-insert-tries
2021 With @var{n} greater than 0 the number of prompts asking to insert a
2022 smartcard gets limited to N-1. Thus with a value of 1 gpg won't at
2023 all ask to insert a card if none has been inserted at startup. This
2024 option is useful in the configuration file in case an application does
2025 not know about the smartcard support and waits ad infinitum for an
2026 inserted card.
2027
2028 @item --no-random-seed-file
2029 @opindex no-random-seed-file
2030 GnuPG uses a file to store its internal random pool over invocations.
2031 This makes random generation faster; however sometimes write operations
2032 are not desired. This option can be used to achieve that with the cost of
2033 slower random generation.
2034
2035 @item --no-greeting
2036 @opindex no-greeting
2037 Suppress the initial copyright message.
2038
2039 @item --no-secmem-warning
2040 @opindex no-secmem-warning
2041 Suppress the warning about "using insecure memory".
2042
2043 @item --no-permission-warning
2044 @opindex permission-warning
2045 Suppress the warning about unsafe file and home directory (@option{--homedir})
2046 permissions. Note that the permission checks that GnuPG performs are
2047 not intended to be authoritative, but rather they simply warn about
2048 certain common permission problems. Do not assume that the lack of a
2049 warning means that your system is secure.
2050
2051 Note that the warning for unsafe @option{--homedir} permissions cannot be
2052 suppressed in the gpg.conf file, as this would allow an attacker to
2053 place an unsafe gpg.conf file in place, and use this file to suppress
2054 warnings about itself. The @option{--homedir} permissions warning may only be
2055 suppressed on the command line.
2056
2057 @item --no-mdc-warning
2058 @opindex no-mdc-warning
2059 Suppress the warning about missing MDC integrity protection.
2060
2061 @item --require-secmem
2062 @itemx --no-require-secmem
2063 @opindex require-secmem
2064 Refuse to run if GnuPG cannot get secure memory. Defaults to no
2065 (i.e. run, but give a warning).
2066
2067
2068 @item --require-cross-certification
2069 @itemx --no-require-cross-certification
2070 @opindex require-cross-certification
2071 When verifying a signature made from a subkey, ensure that the cross
2072 certification "back signature" on the subkey is present and valid.  This
2073 protects against a subtle attack against subkeys that can sign.
2074 Defaults to @option{--require-cross-certification} for
2075 @command{@gpgname}.
2076
2077 @item --expert
2078 @itemx --no-expert
2079 @opindex expert
2080 Allow the user to do certain nonsensical or "silly" things like
2081 signing an expired or revoked key, or certain potentially incompatible
2082 things like generating unusual key types. This also disables certain
2083 warning messages about potentially incompatible actions. As the name
2084 implies, this option is for experts only. If you don't fully
2085 understand the implications of what it allows you to do, leave this
2086 off. @option{--no-expert} disables this option.
2087
2088 @end table
2089
2090
2091 @c *******************************************
2092 @c ********  KEY RELATED OPTIONS  ************
2093 @c *******************************************
2094 @node GPG Key related Options
2095 @subsection Key related options
2096
2097 @table @gnupgtabopt
2098
2099 @item --recipient @var{name}
2100 @itemx -r
2101 @opindex recipient
2102 Encrypt for user id @var{name}. If this option or
2103 @option{--hidden-recipient} is not specified, GnuPG asks for the user-id
2104 unless @option{--default-recipient} is given.
2105
2106 @item --hidden-recipient @var{name}
2107 @itemx -R
2108 @opindex hidden-recipient
2109 Encrypt for user ID @var{name}, but hide the key ID of this user's
2110 key. This option helps to hide the receiver of the message and is a
2111 limited countermeasure against traffic analysis. If this option or
2112 @option{--recipient} is not specified, GnuPG asks for the user ID unless
2113 @option{--default-recipient} is given.
2114
2115 @item --recipient-file @var{file}
2116 @itemx -f
2117 @opindex recipient-file
2118 This option is similar to @option{--recipient} except that it
2119 encrypts to a key stored in the given file.  @var{file} must be the
2120 name of a file containing exactly one key.  @command{@gpgname} assumes that
2121 the key in this file is fully valid.
2122
2123 @item --hidden-recipient-file @var{file}
2124 @itemx -F
2125 @opindex hidden-recipient-file
2126 This option is similar to @option{--hidden-recipient} except that it
2127 encrypts to a key stored in the given file.  @var{file} must be the
2128 name of a file containing exactly one key.  @command{@gpgname} assumes that
2129 the key in this file is fully valid.
2130
2131 @item --encrypt-to @var{name}
2132 @opindex encrypt-to
2133 Same as @option{--recipient} but this one is intended for use in the
2134 options file and may be used with your own user-id as an
2135 "encrypt-to-self". These keys are only used when there are other
2136 recipients given either by use of @option{--recipient} or by the asked
2137 user id.  No trust checking is performed for these user ids and even
2138 disabled keys can be used.
2139
2140 @item --hidden-encrypt-to @var{name}
2141 @opindex hidden-encrypt-to
2142 Same as @option{--hidden-recipient} but this one is intended for use in the
2143 options file and may be used with your own user-id as a hidden
2144 "encrypt-to-self". These keys are only used when there are other
2145 recipients given either by use of @option{--recipient} or by the asked user id.
2146 No trust checking is performed for these user ids and even disabled
2147 keys can be used.
2148
2149 @item --no-encrypt-to
2150 @opindex no-encrypt-to
2151 Disable the use of all @option{--encrypt-to} and
2152 @option{--hidden-encrypt-to} keys.
2153
2154 @item --group @{@var{name}=@var{value}@}
2155 @opindex group
2156 Sets up a named group, which is similar to aliases in email programs.
2157 Any time the group name is a recipient (@option{-r} or
2158 @option{--recipient}), it will be expanded to the values
2159 specified. Multiple groups with the same name are automatically merged
2160 into a single group.
2161
2162 The values are @code{key IDs} or fingerprints, but any key description
2163 is accepted. Note that a value with spaces in it will be treated as
2164 two different values. Note also there is only one level of expansion
2165 --- you cannot make an group that points to another group. When used
2166 from the command line, it may be necessary to quote the argument to
2167 this option to prevent the shell from treating it as multiple
2168 arguments.
2169
2170 @item --ungroup @var{name}
2171 @opindex ungroup
2172 Remove a given entry from the @option{--group} list.
2173
2174 @item --no-groups
2175 @opindex no-groups
2176 Remove all entries from the @option{--group} list.
2177
2178 @item --local-user @var{name}
2179 @itemx -u
2180 @opindex local-user
2181 Use @var{name} as the key to sign with. Note that this option overrides
2182 @option{--default-key}.
2183
2184 @item --sender @var{mbox}
2185 @opindex sender
2186 This option has two purposes.  @var{mbox} must either be a complete
2187 user id with a proper mail address or just a mail address.  When
2188 creating a signature this option tells gpg the user id of a key used
2189 to make a signature if the key was not directly specified by a user
2190 id.  When verifying a signature the @var{mbox} is used to restrict the
2191 information printed by the TOFU code to matching user ids.
2192
2193 @item --try-secret-key @var{name}
2194 @opindex try-secret-key
2195 For hidden recipients GPG needs to know the keys to use for trial
2196 decryption.  The key set with @option{--default-key} is always tried
2197 first, but this is often not sufficient.  This option allows setting more
2198 keys to be used for trial decryption.  Although any valid user-id
2199 specification may be used for @var{name} it makes sense to use at least
2200 the long keyid to avoid ambiguities.  Note that gpg-agent might pop up a
2201 pinentry for a lot keys to do the trial decryption.  If you want to stop
2202 all further trial decryption you may use close-window button instead of
2203 the cancel button.
2204
2205 @item --try-all-secrets
2206 @opindex try-all-secrets
2207 Don't look at the key ID as stored in the message but try all secret
2208 keys in turn to find the right decryption key. This option forces the
2209 behaviour as used by anonymous recipients (created by using
2210 @option{--throw-keyids} or @option{--hidden-recipient}) and might come
2211 handy in case where an encrypted message contains a bogus key ID.
2212
2213 @item --skip-hidden-recipients
2214 @itemx --no-skip-hidden-recipients
2215 @opindex skip-hidden-recipients
2216 @opindex no-skip-hidden-recipients
2217 During decryption skip all anonymous recipients.  This option helps in
2218 the case that people use the hidden recipients feature to hide their
2219 own encrypt-to key from others.  If one has many secret keys this
2220 may lead to a major annoyance because all keys are tried in turn to
2221 decrypt something which was not really intended for it.  The drawback
2222 of this option is that it is currently not possible to decrypt a
2223 message which includes real anonymous recipients.
2224
2225
2226 @end table
2227
2228 @c *******************************************
2229 @c ********  INPUT AND OUTPUT  ***************
2230 @c *******************************************
2231 @node GPG Input and Output
2232 @subsection Input and Output
2233
2234 @table @gnupgtabopt
2235
2236 @item --armor
2237 @itemx -a
2238 @opindex armor
2239 Create ASCII armored output.  The default is to create the binary
2240 OpenPGP format.
2241
2242 @item --no-armor
2243 @opindex no-armor
2244 Assume the input data is not in ASCII armored format.
2245
2246 @item --output @var{file}
2247 @itemx -o @var{file}
2248 @opindex output
2249 Write output to @var{file}.  To write to stdout use @code{-} as the
2250 filename.
2251
2252 @item --max-output @var{n}
2253 @opindex max-output
2254 This option sets a limit on the number of bytes that will be generated
2255 when processing a file. Since OpenPGP supports various levels of
2256 compression, it is possible that the plaintext of a given message may be
2257 significantly larger than the original OpenPGP message. While GnuPG
2258 works properly with such messages, there is often a desire to set a
2259 maximum file size that will be generated before processing is forced to
2260 stop by the OS limits. Defaults to 0, which means "no limit".
2261
2262 @item --input-size-hint @var{n}
2263 @opindex input-size-hint
2264 This option can be used to tell GPG the size of the input data in
2265 bytes.  @var{n} must be a positive base-10 number.  This option is
2266 only useful if the input is not taken from a file.  GPG may use this
2267 hint to optimize its buffer allocation strategy.  It is also used by
2268 the @option{--status-fd} line ``PROGRESS'' to provide a value for
2269 ``total'' if that is not available by other means.
2270
2271 @item --key-origin @var{string}[,@var{url}]
2272 @opindex key-origin
2273 gpg can track the origin of a key. Certain origins are implicitly
2274 known (e.g. keyserver, web key directory) and set.  For a standard
2275 import the origin of the keys imported can be set with this option.
2276 To list the possible values use "help" for @var{string}.  Some origins
2277 can store an optional @var{url} argument.  That URL can appended to
2278 @var{string} after a comma.
2279
2280 @item --import-options @var{parameters}
2281 @opindex import-options
2282 This is a space or comma delimited string that gives options for
2283 importing keys. Options can be prepended with a `no-' to give the
2284 opposite meaning. The options are:
2285
2286 @table @asis
2287
2288   @item import-local-sigs
2289   Allow importing key signatures marked as "local". This is not
2290   generally useful unless a shared keyring scheme is being used.
2291   Defaults to no.
2292
2293   @item keep-ownertrust
2294   Normally possible still existing ownertrust values of a key are
2295   cleared if a key is imported.  This is in general desirable so that
2296   a formerly deleted key does not automatically gain an ownertrust
2297   values merely due to import.  On the other hand it is sometimes
2298   necessary to re-import a trusted set of keys again but keeping
2299   already assigned ownertrust values.  This can be achieved by using
2300   this option.
2301
2302   @item repair-pks-subkey-bug
2303   During import, attempt to repair the damage caused by the PKS keyserver
2304   bug (pre version 0.9.6) that mangles keys with multiple subkeys. Note
2305   that this cannot completely repair the damaged key as some crucial data
2306   is removed by the keyserver, but it does at least give you back one
2307   subkey. Defaults to no for regular @option{--import} and to yes for
2308   keyserver @option{--receive-keys}.
2309
2310   @item import-show
2311   @itemx show-only
2312   Show a listing of the key as imported right before it is stored.
2313   This can be combined with the option @option{--dry-run} to only look
2314   at keys; the option @option{show-only} is a shortcut for this
2315   combination.  Note that suffixes like '#' for "sec" and "sbb" lines
2316   may or may not be printed.
2317
2318   @item import-export
2319   Run the entire import code but instead of storing the key to the
2320   local keyring write it to the output.  The export options
2321   @option{export-pka} and @option{export-dane} affect the output.  This
2322   option can be used to remove all invalid parts from a key without the
2323   need to store it.
2324
2325   @item merge-only
2326   During import, allow key updates to existing keys, but do not allow
2327   any new keys to be imported. Defaults to no.
2328
2329   @item import-clean
2330   After import, compact (remove all signatures except the
2331   self-signature) any user IDs from the new key that are not usable.
2332   Then, remove any signatures from the new key that are not usable.
2333   This includes signatures that were issued by keys that are not present
2334   on the keyring. This option is the same as running the @option{--edit-key}
2335   command "clean" after import. Defaults to no.
2336
2337   @item repair-keys.  After import, fix various problems with the
2338   keys.  For example, this reorders signatures, and strips duplicate
2339   signatures.  Defaults to yes.
2340
2341   @item import-minimal
2342   Import the smallest key possible. This removes all signatures except
2343   the most recent self-signature on each user ID. This option is the
2344   same as running the @option{--edit-key} command "minimize" after import.
2345   Defaults to no.
2346
2347   @item restore
2348   @itemx import-restore
2349   Import in key restore mode.  This imports all data which is usually
2350   skipped during import; including all GnuPG specific data.  All other
2351   contradicting options are overridden.
2352 @end table
2353
2354 @item --import-filter @{@var{name}=@var{expr}@}
2355 @itemx --export-filter @{@var{name}=@var{expr}@}
2356 @opindex import-filter
2357 @opindex export-filter
2358 These options define an import/export filter which are applied to the
2359 imported/exported keyblock right before it will be stored/written.
2360 @var{name} defines the type of filter to use, @var{expr} the
2361 expression to evaluate.  The option can be used several times which
2362 then appends more expression to the same @var{name}.
2363
2364 @noindent
2365 The available filter types are:
2366
2367 @table @asis
2368
2369   @item keep-uid
2370   This filter will keep a user id packet and its dependent packets in
2371   the keyblock if the expression evaluates to true.
2372
2373   @item drop-subkey
2374   This filter drops the selected subkeys.
2375   Currently only implemented for --export-filter.
2376
2377   @item drop-sig
2378   This filter drops the selected key signatures on user ids.
2379   Self-signatures are not considered.
2380   Currently only implemented for --import-filter.
2381
2382 @end table
2383
2384 For the syntax of the expression see the chapter "FILTER EXPRESSIONS".
2385 The property names for the expressions depend on the actual filter
2386 type and are indicated in the following table.
2387
2388 The available properties are:
2389
2390 @table @asis
2391
2392   @item uid
2393   A string with the user id.  (keep-uid)
2394
2395   @item mbox
2396   The addr-spec part of a user id with mailbox or the empty string.
2397   (keep-uid)
2398
2399   @item key_algo
2400   A number with the public key algorithm of a key or subkey packet.
2401   (drop-subkey)
2402
2403   @item key_created
2404   @itemx key_created_d
2405   The first is the timestamp a public key or subkey packet was
2406   created.  The second is the same but given as an ISO string,
2407   e.g. "2016-08-17". (drop-subkey)
2408
2409   @item primary
2410   Boolean indicating whether the user id is the primary one.  (keep-uid)
2411
2412   @item expired
2413   Boolean indicating whether a user id (keep-uid), a key (drop-subkey), or a
2414   signature (drop-sig) expired.
2415
2416   @item revoked
2417   Boolean indicating whether a user id (keep-uid) or a key (drop-subkey) has
2418   been revoked.
2419
2420   @item disabled
2421   Boolean indicating whether a primary key is disabled. (not used)
2422
2423   @item secret
2424   Boolean indicating whether a key or subkey is a secret one.
2425   (drop-subkey)
2426
2427   @item sig_created
2428   @itemx sig_created_d
2429   The first is the timestamp a signature packet was created.  The
2430   second is the same but given as an ISO date string,
2431   e.g. "2016-08-17". (drop-sig)
2432
2433   @item sig_algo
2434   A number with the public key algorithm of a signature packet. (drop-sig)
2435
2436   @item sig_digest_algo
2437   A number with the digest algorithm of a signature packet. (drop-sig)
2438
2439 @end table
2440
2441 @item --export-options @var{parameters}
2442 @opindex export-options
2443 This is a space or comma delimited string that gives options for
2444 exporting keys.  Options can be prepended with a `no-' to give the
2445 opposite meaning.  The options are:
2446
2447 @table @asis
2448
2449   @item export-local-sigs
2450   Allow exporting key signatures marked as "local". This is not
2451   generally useful unless a shared keyring scheme is being used.
2452   Defaults to no.
2453
2454   @item export-attributes
2455   Include attribute user IDs (photo IDs) while exporting. Not
2456   including attribute user IDs is useful to export keys that are going
2457   to be used by an OpenPGP program that does not accept attribute user
2458   IDs.  Defaults to yes.
2459
2460   @item export-sensitive-revkeys
2461   Include designated revoker information that was marked as
2462   "sensitive". Defaults to no.
2463
2464   @c Since GnuPG 2.1 gpg-agent manages the secret key and thus the
2465   @c export-reset-subkey-passwd hack is not anymore justified.  Such use
2466   @c cases may be implemented using a specialized secret key export
2467   @c tool.
2468   @c @item export-reset-subkey-passwd
2469   @c When using the @option{--export-secret-subkeys} command, this option resets
2470   @c the passphrases for all exported subkeys to empty. This is useful
2471   @c when the exported subkey is to be used on an unattended machine where
2472   @c a passphrase doesn't necessarily make sense. Defaults to no.
2473
2474   @item backup
2475   @itemx export-backup
2476   Export for use as a backup.  The exported data includes all data
2477   which is needed to restore the key or keys later with GnuPG.  The
2478   format is basically the OpenPGP format but enhanced with GnuPG
2479   specific data.  All other contradicting options are overridden.
2480
2481   @item export-clean
2482   Compact (remove all signatures from) user IDs on the key being
2483   exported if the user IDs are not usable. Also, do not export any
2484   signatures that are not usable. This includes signatures that were
2485   issued by keys that are not present on the keyring. This option is
2486   the same as running the @option{--edit-key} command "clean" before export
2487   except that the local copy of the key is not modified. Defaults to
2488   no.
2489
2490   @item export-minimal
2491   Export the smallest key possible. This removes all signatures except the
2492   most recent self-signature on each user ID. This option is the same as
2493   running the @option{--edit-key} command "minimize" before export except
2494   that the local copy of the key is not modified. Defaults to no.
2495
2496   @item export-pka
2497   Instead of outputting the key material output PKA records suitable
2498   to put into DNS zone files.  An ORIGIN line is printed before each
2499   record to allow diverting the records to the corresponding zone file.
2500
2501   @item export-dane
2502   Instead of outputting the key material output OpenPGP DANE records
2503   suitable to put into DNS zone files.  An ORIGIN line is printed before
2504   each record to allow diverting the records to the corresponding zone
2505   file.
2506
2507 @end table
2508
2509 @item --with-colons
2510 @opindex with-colons
2511 Print key listings delimited by colons. Note that the output will be
2512 encoded in UTF-8 regardless of any @option{--display-charset} setting. This
2513 format is useful when GnuPG is called from scripts and other programs
2514 as it is easily machine parsed. The details of this format are
2515 documented in the file @file{doc/DETAILS}, which is included in the GnuPG
2516 source distribution.
2517
2518 @item --fixed-list-mode
2519 @opindex fixed-list-mode
2520 Do not merge primary user ID and primary key in @option{--with-colon}
2521 listing mode and print all timestamps as seconds since 1970-01-01.
2522 Since GnuPG 2.0.10, this mode is always used and thus this option is
2523 obsolete; it does not harm to use it though.
2524
2525 @item --legacy-list-mode
2526 @opindex legacy-list-mode
2527 Revert to the pre-2.1 public key list mode.  This only affects the
2528 human readable output and not the machine interface
2529 (i.e. @code{--with-colons}).  Note that the legacy format does not
2530 convey suitable information for elliptic curves.
2531
2532 @item --with-fingerprint
2533 @opindex with-fingerprint
2534 Same as the command @option{--fingerprint} but changes only the format
2535 of the output and may be used together with another command.
2536
2537 @item --with-subkey-fingerprint
2538 @opindex with-subkey-fingerprint
2539 If a fingerprint is printed for the primary key, this option forces
2540 printing of the fingerprint for all subkeys.  This could also be
2541 achieved by using the @option{--with-fingerprint} twice but by using
2542 this option along with keyid-format "none" a compact fingerprint is
2543 printed.
2544
2545 @item --with-icao-spelling
2546 @opindex with-icao-spelling
2547 Print the ICAO spelling of the fingerprint in addition to the hex digits.
2548
2549 @item --with-keygrip
2550 @opindex with-keygrip
2551 Include the keygrip in the key listings.  In @code{--with-colons} mode
2552 this is implicitly enable for secret keys.
2553
2554 @item --with-key-origin
2555 @opindex with-key-origin
2556 Include the locally held information on the origin and last update of
2557 a key in a key listing.  In @code{--with-colons} mode this is always
2558 printed.  This data is currently experimental and shall not be
2559 considered part of the stable API.
2560
2561 @item --with-wkd-hash
2562 @opindex with-wkd-hash
2563 Print a Web Key Directory identifier along with each user ID in key
2564 listings.  This is an experimental feature and semantics may change.
2565
2566 @item --with-secret
2567 @opindex with-secret
2568 Include info about the presence of a secret key in public key listings
2569 done with @code{--with-colons}.
2570
2571 @end table
2572
2573 @c *******************************************
2574 @c ********  OPENPGP OPTIONS  ****************
2575 @c *******************************************
2576 @node OpenPGP Options
2577 @subsection OpenPGP protocol specific options
2578
2579 @table @gnupgtabopt
2580
2581 @item -t, --textmode
2582 @itemx --no-textmode
2583 @opindex textmode
2584 Treat input files as text and store them in the OpenPGP canonical text
2585 form with standard "CRLF" line endings. This also sets the necessary
2586 flags to inform the recipient that the encrypted or signed data is text
2587 and may need its line endings converted back to whatever the local
2588 system uses. This option is useful when communicating between two
2589 platforms that have different line ending conventions (UNIX-like to Mac,
2590 Mac to Windows, etc). @option{--no-textmode} disables this option, and
2591 is the default.
2592
2593 @item --force-v3-sigs
2594 @itemx --no-force-v3-sigs
2595 @item --force-v4-certs
2596 @itemx --no-force-v4-certs
2597 These options are obsolete and have no effect since GnuPG 2.1.
2598
2599 @item --force-mdc
2600 @opindex force-mdc
2601 Force the use of encryption with a modification detection code. This
2602 is always used with the newer ciphers (those with a blocksize greater
2603 than 64 bits), or if all of the recipient keys indicate MDC support in
2604 their feature flags.
2605
2606 @item --disable-mdc
2607 @opindex disable-mdc
2608 Disable the use of the modification detection code. Note that by
2609 using this option, the encrypted message becomes vulnerable to a
2610 message modification attack.
2611
2612 @item --disable-signer-uid
2613 @opindex disable-signer-uid
2614 By default the user ID of the signing key is embedded in the data
2615 signature.  As of now this is only done if the signing key has been
2616 specified with @option{local-user} using a mail address.  This
2617 information can be helpful for verifier to locate the key; see
2618 option @option{--auto-key-retrieve}.
2619
2620 @item --personal-cipher-preferences @var{string}
2621 @opindex personal-cipher-preferences
2622 Set the list of personal cipher preferences to @var{string}.  Use
2623 @command{@gpgname --version} to get a list of available algorithms,
2624 and use @code{none} to set no preference at all.  This allows the user
2625 to safely override the algorithm chosen by the recipient key
2626 preferences, as GPG will only select an algorithm that is usable by
2627 all recipients.  The most highly ranked cipher in this list is also
2628 used for the @option{--symmetric} encryption command.
2629
2630 @item --personal-digest-preferences @var{string}
2631 @opindex personal-digest-preferences
2632 Set the list of personal digest preferences to @var{string}.  Use
2633 @command{@gpgname --version} to get a list of available algorithms,
2634 and use @code{none} to set no preference at all.  This allows the user
2635 to safely override the algorithm chosen by the recipient key
2636 preferences, as GPG will only select an algorithm that is usable by
2637 all recipients.  The most highly ranked digest algorithm in this list
2638 is also used when signing without encryption
2639 (e.g. @option{--clear-sign} or @option{--sign}).
2640
2641 @item --personal-compress-preferences @var{string}
2642 @opindex personal-compress-preferences
2643 Set the list of personal compression preferences to @var{string}.
2644 Use @command{@gpgname --version} to get a list of available
2645 algorithms, and use @code{none} to set no preference at all.  This
2646 allows the user to safely override the algorithm chosen by the
2647 recipient key preferences, as GPG will only select an algorithm that
2648 is usable by all recipients.  The most highly ranked compression
2649 algorithm in this list is also used when there are no recipient keys
2650 to consider (e.g. @option{--symmetric}).
2651
2652 @item --s2k-cipher-algo @var{name}
2653 @opindex s2k-cipher-algo
2654 Use @var{name} as the cipher algorithm for symmetric encryption with
2655 a passphrase if @option{--personal-cipher-preferences} and
2656 @option{--cipher-algo} are not given.  The default is @value{GPGSYMENCALGO}.
2657
2658 @item --s2k-digest-algo @var{name}
2659 @opindex s2k-digest-algo
2660 Use @var{name} as the digest algorithm used to mangle the passphrases
2661 for symmetric encryption.  The default is SHA-1.
2662
2663 @item --s2k-mode @var{n}
2664 @opindex s2k-mode
2665 Selects how passphrases for symmetric encryption are mangled. If
2666 @var{n} is 0 a plain passphrase (which is in general not recommended)
2667 will be used, a 1 adds a salt (which should not be used) to the
2668 passphrase and a 3 (the default) iterates the whole process a number
2669 of times (see @option{--s2k-count}).
2670
2671 @item --s2k-count @var{n}
2672 @opindex s2k-count
2673 Specify how many times the passphrases mangling for symmetric
2674 encryption is repeated.  This value may range between 1024 and
2675 65011712 inclusive.  The default is inquired from gpg-agent.  Note
2676 that not all values in the 1024-65011712 range are legal and if an
2677 illegal value is selected, GnuPG will round up to the nearest legal
2678 value.  This option is only meaningful if @option{--s2k-mode} is set
2679 to the default of 3.
2680
2681
2682 @end table
2683
2684 @c ***************************
2685 @c ******* Compliance ********
2686 @c ***************************
2687 @node Compliance Options
2688 @subsection Compliance options
2689
2690 These options control what GnuPG is compliant to. Only one of these
2691 options may be active at a time. Note that the default setting of
2692 this is nearly always the correct one. See the INTEROPERABILITY WITH
2693 OTHER OPENPGP PROGRAMS section below before using one of these
2694 options.
2695
2696 @table @gnupgtabopt
2697
2698 @item --gnupg
2699 @opindex gnupg
2700 Use standard GnuPG behavior. This is essentially OpenPGP behavior
2701 (see @option{--openpgp}), but with some additional workarounds for common
2702 compatibility problems in different versions of PGP. This is the
2703 default option, so it is not generally needed, but it may be useful to
2704 override a different compliance option in the gpg.conf file.
2705
2706 @item --openpgp
2707 @opindex openpgp
2708 Reset all packet, cipher and digest options to strict OpenPGP
2709 behavior. Use this option to reset all previous options like
2710 @option{--s2k-*}, @option{--cipher-algo}, @option{--digest-algo} and
2711 @option{--compress-algo} to OpenPGP compliant values. All PGP
2712 workarounds are disabled.
2713
2714 @item --rfc4880
2715 @opindex rfc4880
2716 Reset all packet, cipher and digest options to strict RFC-4880
2717 behavior. Note that this is currently the same thing as
2718 @option{--openpgp}.
2719
2720 @item --rfc4880bis
2721 @opindex rfc4880bis
2722 Enable experimental features from proposed updates to RFC-4880.  This
2723 option can be used in addition to the other compliance options.
2724 Warning: The behavior may change with any GnuPG release and created
2725 keys or data may not be usable with future GnuPG versions.
2726
2727 @item --rfc2440
2728 @opindex rfc2440
2729 Reset all packet, cipher and digest options to strict RFC-2440
2730 behavior.
2731
2732 @item --pgp6
2733 @opindex pgp6
2734 Set up all options to be as PGP 6 compliant as possible. This
2735 restricts you to the ciphers IDEA (if the IDEA plugin is installed),
2736 3DES, and CAST5, the hashes MD5, SHA1 and RIPEMD160, and the
2737 compression algorithms none and ZIP. This also disables
2738 @option{--throw-keyids}, and making signatures with signing subkeys as PGP 6
2739 does not understand signatures made by signing subkeys.
2740
2741 This option implies @option{--disable-mdc --escape-from-lines}.
2742
2743 @item --pgp7
2744 @opindex pgp7
2745 Set up all options to be as PGP 7 compliant as possible. This is
2746 identical to @option{--pgp6} except that MDCs are not disabled, and the
2747 list of allowable ciphers is expanded to add AES128, AES192, AES256, and
2748 TWOFISH.
2749
2750 @item --pgp8
2751 @opindex pgp8
2752 Set up all options to be as PGP 8 compliant as possible. PGP 8 is a lot
2753 closer to the OpenPGP standard than previous versions of PGP, so all
2754 this does is disable @option{--throw-keyids} and set
2755 @option{--escape-from-lines}.  All algorithms are allowed except for the
2756 SHA224, SHA384, and SHA512 digests.
2757
2758 @item --compliance @var{string}
2759 @opindex compliance
2760 This option can be used instead of one of the options above.  Valid
2761 values for @var{string} are the above option names (without the double
2762 dash) and possibly others as shown when using "help" for @var{value}.
2763
2764 @end table
2765
2766
2767 @c *******************************************
2768 @c ********  ESOTERIC OPTIONS  ***************
2769 @c *******************************************
2770 @node GPG Esoteric Options
2771 @subsection Doing things one usually doesn't want to do
2772
2773 @table @gnupgtabopt
2774
2775 @item -n
2776 @itemx --dry-run
2777 @opindex dry-run
2778 Don't make any changes (this is not completely implemented).
2779
2780 @item --list-only
2781 @opindex list-only
2782 Changes the behaviour of some commands. This is like @option{--dry-run} but
2783 different in some cases. The semantic of this option may be extended in
2784 the future. Currently it only skips the actual decryption pass and
2785 therefore enables a fast listing of the encryption keys.
2786
2787 @item -i
2788 @itemx --interactive
2789 @opindex interactive
2790 Prompt before overwriting any files.
2791
2792 @item --debug-level @var{level}
2793 @opindex debug-level
2794 Select the debug level for investigating problems. @var{level} may be
2795 a numeric value or by a keyword:
2796
2797 @table @code
2798   @item none
2799   No debugging at all.  A value of less than 1 may be used instead of
2800   the keyword.
2801   @item basic
2802   Some basic debug messages.  A value between 1 and 2 may be used
2803   instead of the keyword.
2804   @item advanced
2805   More verbose debug messages.  A value between 3 and 5 may be used
2806   instead of the keyword.
2807   @item expert
2808   Even more detailed messages.  A value between 6 and 8 may be used
2809   instead of the keyword.
2810   @item guru
2811   All of the debug messages you can get. A value greater than 8 may be
2812   used instead of the keyword.  The creation of hash tracing files is
2813   only enabled if the keyword is used.
2814 @end table
2815
2816 How these messages are mapped to the actual debugging flags is not
2817 specified and may change with newer releases of this program. They are
2818 however carefully selected to best aid in debugging.
2819
2820 @item --debug @var{flags}
2821 @opindex debug
2822 Set debugging flags. All flags are or-ed and @var{flags} may be given
2823 in C syntax (e.g. 0x0042) or as a comma separated list of flag names.
2824 To get a list of all supported flags the single word "help" can be
2825 used.
2826
2827 @item --debug-all
2828 @opindex debug-all
2829 Set all useful debugging flags.
2830
2831 @item --debug-iolbf
2832 @opindex debug-iolbf
2833 Set stdout into line buffered mode.  This option is only honored when
2834 given on the command line.
2835
2836 @item --faked-system-time @var{epoch}
2837 @opindex faked-system-time
2838 This option is only useful for testing; it sets the system time back or
2839 forth to @var{epoch} which is the number of seconds elapsed since the year
2840 1970.  Alternatively @var{epoch} may be given as a full ISO time string
2841 (e.g. "20070924T154812").
2842
2843 If you suffix @var{epoch} with an exclamation mark (!), the system time
2844 will appear to be frozen at the specified time.
2845
2846 @item --enable-progress-filter
2847 @opindex enable-progress-filter
2848 Enable certain PROGRESS status outputs. This option allows frontends
2849 to display a progress indicator while gpg is processing larger files.
2850 There is a slight performance overhead using it.
2851
2852 @item --status-fd @var{n}
2853 @opindex status-fd
2854 Write special status strings to the file descriptor @var{n}.
2855 See the file DETAILS in the documentation for a listing of them.
2856
2857 @item --status-file @var{file}
2858 @opindex status-file
2859 Same as @option{--status-fd}, except the status data is written to file
2860 @var{file}.
2861
2862 @item --logger-fd @var{n}
2863 @opindex logger-fd
2864 Write log output to file descriptor @var{n} and not to STDERR.
2865
2866 @item --log-file @var{file}
2867 @itemx --logger-file @var{file}
2868 @opindex log-file
2869 Same as @option{--logger-fd}, except the logger data is written to
2870 file @var{file}.  Use @file{socket://} to log to s socket.
2871
2872 @item --attribute-fd @var{n}
2873 @opindex attribute-fd
2874 Write attribute subpackets to the file descriptor @var{n}. This is most
2875 useful for use with @option{--status-fd}, since the status messages are
2876 needed to separate out the various subpackets from the stream delivered
2877 to the file descriptor.
2878
2879 @item --attribute-file @var{file}
2880 @opindex attribute-file
2881 Same as @option{--attribute-fd}, except the attribute data is written to
2882 file @var{file}.
2883
2884 @item --comment @var{string}
2885 @itemx --no-comments
2886 @opindex comment
2887 Use @var{string} as a comment string in cleartext signatures and ASCII
2888 armored messages or keys (see @option{--armor}). The default behavior is
2889 not to use a comment string. @option{--comment} may be repeated multiple
2890 times to get multiple comment strings. @option{--no-comments} removes
2891 all comments.  It is a good idea to keep the length of a single comment
2892 below 60 characters to avoid problems with mail programs wrapping such
2893 lines.  Note that comment lines, like all other header lines, are not
2894 protected by the signature.
2895
2896 @item --emit-version
2897 @itemx --no-emit-version
2898 @opindex emit-version
2899 Force inclusion of the version string in ASCII armored output.  If
2900 given once only the name of the program and the major number is
2901 emitted, given twice the minor is also emitted, given thrice
2902 the micro is added, and given four times an operating system identification
2903 is also emitted.  @option{--no-emit-version} (default) disables the version
2904 line.
2905
2906 @item --sig-notation @{@var{name}=@var{value}@}
2907 @itemx --cert-notation @{@var{name}=@var{value}@}
2908 @itemx -N, --set-notation @{@var{name}=@var{value}@}
2909 @opindex sig-notation
2910 @opindex cert-notation
2911 @opindex set-notation
2912 Put the name value pair into the signature as notation data.
2913 @var{name} must consist only of printable characters or spaces, and
2914 must contain a '@@' character in the form keyname@@domain.example.com
2915 (substituting the appropriate keyname and domain name, of course).  This
2916 is to help prevent pollution of the IETF reserved notation
2917 namespace. The @option{--expert} flag overrides the '@@'
2918 check. @var{value} may be any printable string; it will be encoded in
2919 UTF-8, so you should check that your @option{--display-charset} is set
2920 correctly. If you prefix @var{name} with an exclamation mark (!), the
2921 notation data will be flagged as critical
2922 (rfc4880:5.2.3.16). @option{--sig-notation} sets a notation for data
2923 signatures. @option{--cert-notation} sets a notation for key signatures
2924 (certifications). @option{--set-notation} sets both.
2925
2926 There are special codes that may be used in notation names. "%k" will
2927 be expanded into the key ID of the key being signed, "%K" into the
2928 long key ID of the key being signed, "%f" into the fingerprint of the
2929 key being signed, "%s" into the key ID of the key making the
2930 signature, "%S" into the long key ID of the key making the signature,
2931 "%g" into the fingerprint of the key making the signature (which might
2932 be a subkey), "%p" into the fingerprint of the primary key of the key
2933 making the signature, "%c" into the signature count from the OpenPGP
2934 smartcard, and "%%" results in a single "%". %k, %K, and %f are only
2935 meaningful when making a key signature (certification), and %c is only
2936 meaningful when using the OpenPGP smartcard.
2937
2938 @item --sig-policy-url @var{string}
2939 @itemx --cert-policy-url @var{string}
2940 @itemx --set-policy-url @var{string}
2941 @opindex sig-policy-url
2942 @opindex cert-policy-url
2943 @opindex set-policy-url
2944 Use @var{string} as a Policy URL for signatures (rfc4880:5.2.3.20).  If
2945 you prefix it with an exclamation mark (!), the policy URL packet will
2946 be flagged as critical. @option{--sig-policy-url} sets a policy url for
2947 data signatures. @option{--cert-policy-url} sets a policy url for key
2948 signatures (certifications). @option{--set-policy-url} sets both.
2949
2950 The same %-expandos used for notation data are available here as well.
2951
2952 @item --sig-keyserver-url @var{string}
2953 @opindex sig-keyserver-url
2954 Use @var{string} as a preferred keyserver URL for data signatures. If
2955 you prefix it with an exclamation mark (!), the keyserver URL packet
2956 will be flagged as critical.
2957
2958 The same %-expandos used for notation data are available here as well.
2959
2960 @item --set-filename @var{string}
2961 @opindex set-filename
2962 Use @var{string} as the filename which is stored inside messages.
2963 This overrides the default, which is to use the actual filename of the
2964 file being encrypted.  Using the empty string for @var{string}
2965 effectively removes the filename from the output.
2966
2967 @item --for-your-eyes-only
2968 @itemx --no-for-your-eyes-only
2969 @opindex for-your-eyes-only
2970 Set the `for your eyes only' flag in the message. This causes GnuPG to
2971 refuse to save the file unless the @option{--output} option is given,
2972 and PGP to use a "secure viewer" with a claimed Tempest-resistant font
2973 to display the message. This option overrides @option{--set-filename}.
2974 @option{--no-for-your-eyes-only} disables this option.
2975
2976 @item --use-embedded-filename
2977 @itemx --no-use-embedded-filename
2978 @opindex use-embedded-filename
2979 Try to create a file with a name as embedded in the data. This can be
2980 a dangerous option as it enables overwriting files. Defaults to no.
2981
2982 @item --cipher-algo @var{name}
2983 @opindex cipher-algo
2984 Use @var{name} as cipher algorithm. Running the program with the
2985 command @option{--version} yields a list of supported algorithms. If
2986 this is not used the cipher algorithm is selected from the preferences
2987 stored with the key. In general, you do not want to use this option as
2988 it allows you to violate the OpenPGP standard.
2989 @option{--personal-cipher-preferences} is the safe way to accomplish the
2990 same thing.
2991
2992 @item --digest-algo @var{name}
2993 @opindex digest-algo
2994 Use @var{name} as the message digest algorithm. Running the program
2995 with the command @option{--version} yields a list of supported algorithms. In
2996 general, you do not want to use this option as it allows you to
2997 violate the OpenPGP standard. @option{--personal-digest-preferences} is the
2998 safe way to accomplish the same thing.
2999
3000 @item --compress-algo @var{name}
3001 @opindex compress-algo
3002 Use compression algorithm @var{name}. "zlib" is RFC-1950 ZLIB
3003 compression. "zip" is RFC-1951 ZIP compression which is used by PGP.
3004 "bzip2" is a more modern compression scheme that can compress some
3005 things better than zip or zlib, but at the cost of more memory used
3006 during compression and decompression. "uncompressed" or "none"
3007 disables compression. If this option is not used, the default
3008 behavior is to examine the recipient key preferences to see which
3009 algorithms the recipient supports. If all else fails, ZIP is used for
3010 maximum compatibility.
3011
3012 ZLIB may give better compression results than ZIP, as the compression
3013 window size is not limited to 8k. BZIP2 may give even better
3014 compression results than that, but will use a significantly larger
3015 amount of memory while compressing and decompressing. This may be
3016 significant in low memory situations. Note, however, that PGP (all
3017 versions) only supports ZIP compression. Using any algorithm other
3018 than ZIP or "none" will make the message unreadable with PGP. In
3019 general, you do not want to use this option as it allows you to
3020 violate the OpenPGP standard. @option{--personal-compress-preferences} is the
3021 safe way to accomplish the same thing.
3022
3023 @item --cert-digest-algo @var{name}
3024 @opindex cert-digest-algo
3025 Use @var{name} as the message digest algorithm used when signing a
3026 key. Running the program with the command @option{--version} yields a
3027 list of supported algorithms. Be aware that if you choose an algorithm
3028 that GnuPG supports but other OpenPGP implementations do not, then some
3029 users will not be able to use the key signatures you make, or quite
3030 possibly your entire key.
3031
3032 @item --disable-cipher-algo @var{name}
3033 @opindex disable-cipher-algo
3034 Never allow the use of @var{name} as cipher algorithm.
3035 The given name will not be checked so that a later loaded algorithm
3036 will still get disabled.
3037
3038 @item --disable-pubkey-algo @var{name}
3039 @opindex disable-pubkey-algo
3040 Never allow the use of @var{name} as public key algorithm.
3041 The given name will not be checked so that a later loaded algorithm
3042 will still get disabled.
3043
3044 @item --throw-keyids
3045 @itemx --no-throw-keyids
3046 @opindex throw-keyids
3047 Do not put the recipient key IDs into encrypted messages. This helps to
3048 hide the receivers of the message and is a limited countermeasure
3049 against traffic analysis.@footnote{Using a little social engineering
3050 anyone who is able to decrypt the message can check whether one of the
3051 other recipients is the one he suspects.}  On the receiving side, it may
3052 slow down the decryption process because all available secret keys must
3053 be tried.  @option{--no-throw-keyids} disables this option. This option
3054 is essentially the same as using @option{--hidden-recipient} for all
3055 recipients.
3056
3057 @item --not-dash-escaped
3058 @opindex not-dash-escaped
3059 This option changes the behavior of cleartext signatures
3060 so that they can be used for patch files. You should not
3061 send such an armored file via email because all spaces
3062 and line endings are hashed too. You can not use this
3063 option for data which has 5 dashes at the beginning of a
3064 line, patch files don't have this. A special armor header
3065 line tells GnuPG about this cleartext signature option.
3066
3067 @item --escape-from-lines
3068 @itemx --no-escape-from-lines
3069 @opindex escape-from-lines
3070 Because some mailers change lines starting with "From " to ">From " it
3071 is good to handle such lines in a special way when creating cleartext
3072 signatures to prevent the mail system from breaking the signature. Note
3073 that all other PGP versions do it this way too.  Enabled by
3074 default. @option{--no-escape-from-lines} disables this option.
3075
3076 @item --passphrase-repeat @var{n}
3077 @opindex passphrase-repeat
3078 Specify how many times @command{@gpgname} will request a new
3079 passphrase be repeated.  This is useful for helping memorize a
3080 passphrase.  Defaults to 1 repetition.
3081
3082 @item --passphrase-fd @var{n}
3083 @opindex passphrase-fd
3084 Read the passphrase from file descriptor @var{n}. Only the first line
3085 will be read from file descriptor @var{n}. If you use 0 for @var{n},
3086 the passphrase will be read from STDIN. This can only be used if only
3087 one passphrase is supplied.
3088
3089 Note that since Version 2.0 this passphrase is only used if the
3090 option @option{--batch} has also been given. Since Version 2.1
3091 the @option{--pinentry-mode} also needs to be set to @code{loopback}.
3092
3093 @item --passphrase-file @var{file}
3094 @opindex passphrase-file
3095 Read the passphrase from file @var{file}. Only the first line will
3096 be read from file @var{file}. This can only be used if only one
3097 passphrase is supplied. Obviously, a passphrase stored in a file is
3098 of questionable security if other users can read this file. Don't use
3099 this option if you can avoid it.
3100
3101 Note that since Version 2.0 this passphrase is only used if the
3102 option @option{--batch} has also been given. Since Version 2.1
3103 the @option{--pinentry-mode} also needs to be set to @code{loopback}.
3104
3105 @item --passphrase @var{string}
3106 @opindex passphrase
3107 Use @var{string} as the passphrase. This can only be used if only one
3108 passphrase is supplied. Obviously, this is of very questionable
3109 security on a multi-user system. Don't use this option if you can
3110 avoid it.
3111
3112 Note that since Version 2.0 this passphrase is only used if the
3113 option @option{--batch} has also been given. Since Version 2.1
3114 the @option{--pinentry-mode} also needs to be set to @code{loopback}.
3115
3116 @item --pinentry-mode @var{mode}
3117 @opindex pinentry-mode
3118 Set the pinentry mode to @var{mode}.  Allowed values for @var{mode}
3119 are:
3120 @table @asis
3121   @item default
3122   Use the default of the agent, which is @code{ask}.
3123   @item ask
3124   Force the use of the Pinentry.
3125   @item cancel
3126   Emulate use of Pinentry's cancel button.
3127   @item error
3128   Return a Pinentry error (``No Pinentry'').
3129   @item loopback
3130   Redirect Pinentry queries to the caller.  Note that in contrast to
3131   Pinentry the user is not prompted again if he enters a bad password.
3132 @end table
3133
3134 @item --command-fd @var{n}
3135 @opindex command-fd
3136 This is a replacement for the deprecated shared-memory IPC mode.
3137 If this option is enabled, user input on questions is not expected
3138 from the TTY but from the given file descriptor. It should be used
3139 together with @option{--status-fd}. See the file doc/DETAILS in the source
3140 distribution for details on how to use it.
3141
3142 @item --command-file @var{file}
3143 @opindex command-file
3144 Same as @option{--command-fd}, except the commands are read out of file
3145 @var{file}
3146
3147 @item --allow-non-selfsigned-uid
3148 @itemx --no-allow-non-selfsigned-uid
3149 @opindex allow-non-selfsigned-uid
3150 Allow the import and use of keys with user IDs which are not
3151 self-signed. This is not recommended, as a non self-signed user ID is
3152 trivial to forge. @option{--no-allow-non-selfsigned-uid} disables.
3153
3154 @item --allow-freeform-uid
3155 @opindex allow-freeform-uid
3156 Disable all checks on the form of the user ID while generating a new
3157 one. This option should only be used in very special environments as
3158 it does not ensure the de-facto standard format of user IDs.
3159
3160 @item --ignore-time-conflict
3161 @opindex ignore-time-conflict
3162 GnuPG normally checks that the timestamps associated with keys and
3163 signatures have plausible values. However, sometimes a signature
3164 seems to be older than the key due to clock problems. This option
3165 makes these checks just a warning. See also @option{--ignore-valid-from} for
3166 timestamp issues on subkeys.
3167
3168 @item --ignore-valid-from
3169 @opindex ignore-valid-from
3170 GnuPG normally does not select and use subkeys created in the future.
3171 This option allows the use of such keys and thus exhibits the
3172 pre-1.0.7 behaviour. You should not use this option unless there
3173 is some clock problem. See also @option{--ignore-time-conflict} for timestamp
3174 issues with signatures.
3175
3176 @item --ignore-crc-error
3177 @opindex ignore-crc-error
3178 The ASCII armor used by OpenPGP is protected by a CRC checksum against
3179 transmission errors. Occasionally the CRC gets mangled somewhere on
3180 the transmission channel but the actual content (which is protected by
3181 the OpenPGP protocol anyway) is still okay. This option allows GnuPG
3182 to ignore CRC errors.
3183
3184 @item --ignore-mdc-error
3185 @opindex ignore-mdc-error
3186 This option changes a MDC integrity protection failure into a warning.
3187 This can be useful if a message is partially corrupt, but it is
3188 necessary to get as much data as possible out of the corrupt message.
3189 However, be aware that a MDC protection failure may also mean that the
3190 message was tampered with intentionally by an attacker.
3191
3192 @item --allow-weak-digest-algos
3193 @opindex allow-weak-digest-algos
3194 Signatures made with known-weak digest algorithms are normally
3195 rejected with an ``invalid digest algorithm'' message.  This option
3196 allows the verification of signatures made with such weak algorithms.
3197 MD5 is the only digest algorithm considered weak by default.  See also
3198 @option{--weak-digest} to reject other digest algorithms.
3199
3200 @item --weak-digest @var{name}
3201 @opindex weak-digest
3202 Treat the specified digest algorithm as weak.  Signatures made over
3203 weak digests algorithms are normally rejected. This option can be
3204 supplied multiple times if multiple algorithms should be considered
3205 weak.  See also @option{--allow-weak-digest-algos} to disable
3206 rejection of weak digests.  MD5 is always considered weak, and does
3207 not need to be listed explicitly.
3208
3209 @item --no-default-keyring
3210 @opindex no-default-keyring
3211 Do not add the default keyrings to the list of keyrings. Note that
3212 GnuPG will not operate without any keyrings, so if you use this option
3213 and do not provide alternate keyrings via @option{--keyring} or
3214 @option{--secret-keyring}, then GnuPG will still use the default public or
3215 secret keyrings.
3216
3217 @item --no-keyring
3218 @opindex no-keyring
3219 Do not add use any keyrings even if specified as options.
3220
3221 @item --skip-verify
3222 @opindex skip-verify
3223 Skip the signature verification step. This may be
3224 used to make the decryption faster if the signature
3225 verification is not needed.
3226
3227 @item --with-key-data
3228 @opindex with-key-data
3229 Print key listings delimited by colons (like @option{--with-colons}) and
3230 print the public key data.
3231
3232 @item --list-signatures
3233 @opindex list-signatures
3234 @itemx --list-sigs
3235 @opindex list-sigs
3236 Same as @option{--list-keys}, but the signatures are listed too.  This
3237 command has the same effect as using @option{--list-keys} with
3238 @option{--with-sig-list}.  Note that in contrast to
3239 @option{--check-signatures} the key signatures are not verified.
3240
3241
3242 @item --fast-list-mode
3243 @opindex fast-list-mode
3244 Changes the output of the list commands to work faster; this is achieved
3245 by leaving some parts empty. Some applications don't need the user ID
3246 and the trust information given in the listings. By using this options
3247 they can get a faster listing. The exact behaviour of this option may
3248 change in future versions.  If you are missing some information, don't
3249 use this option.
3250
3251 @item --no-literal
3252 @opindex no-literal
3253 This is not for normal use. Use the source to see for what it might be useful.
3254
3255 @item --set-filesize
3256 @opindex set-filesize
3257 This is not for normal use. Use the source to see for what it might be useful.
3258
3259 @item --show-session-key
3260 @opindex show-session-key
3261 Display the session key used for one message. See
3262 @option{--override-session-key} for the counterpart of this option.
3263
3264 We think that Key Escrow is a Bad Thing; however the user should have
3265 the freedom to decide whether to go to prison or to reveal the content
3266 of one specific message without compromising all messages ever
3267 encrypted for one secret key.
3268
3269 You can also use this option if you receive an encrypted message which
3270 is abusive or offensive, to prove to the administrators of the
3271 messaging system that the ciphertext transmitted corresponds to an
3272 inappropriate plaintext so they can take action against the offending
3273 user.
3274
3275 @item --override-session-key @var{string}
3276 @itemx --override-session-key-fd @var{fd}
3277 @opindex override-session-key
3278 Don't use the public key but the session key @var{string} respective
3279 the session key taken from the first line read from file descriptor
3280 @var{fd}.  The format of this string is the same as the one printed
3281 by @option{--show-session-key}. This option is normally not used but
3282 comes handy in case someone forces you to reveal the content of an
3283 encrypted message; using this option you can do this without handing
3284 out the secret key.  Note that using @option{--override-session-key}
3285 may reveal the session key to all local users via the global process
3286 table.
3287
3288 @item --ask-sig-expire
3289 @itemx --no-ask-sig-expire
3290 @opindex ask-sig-expire
3291 When making a data signature, prompt for an expiration time. If this
3292 option is not specified, the expiration time set via
3293 @option{--default-sig-expire} is used. @option{--no-ask-sig-expire}
3294 disables this option.
3295
3296 @item --default-sig-expire
3297 @opindex default-sig-expire
3298 The default expiration time to use for signature expiration. Valid
3299 values are "0" for no expiration, a number followed by the letter d
3300 (for days), w (for weeks), m (for months), or y (for years) (for
3301 example "2m" for two months, or "5y" for five years), or an absolute
3302 date in the form YYYY-MM-DD. Defaults to "0".
3303
3304 @item --ask-cert-expire
3305 @itemx --no-ask-cert-expire
3306 @opindex ask-cert-expire
3307 When making a key signature, prompt for an expiration time. If this
3308 option is not specified, the expiration time set via
3309 @option{--default-cert-expire} is used. @option{--no-ask-cert-expire}
3310 disables this option.
3311
3312 @item --default-cert-expire
3313 @opindex default-cert-expire
3314 The default expiration time to use for key signature expiration.
3315 Valid values are "0" for no expiration, a number followed by the
3316 letter d (for days), w (for weeks), m (for months), or y (for years)
3317 (for example "2m" for two months, or "5y" for five years), or an
3318 absolute date in the form YYYY-MM-DD. Defaults to "0".
3319
3320 @item --default-new-key-algo @var{string}
3321 @opindex default-new-key-algo @var{string}
3322 This option can be used to change the default algorithms for key
3323 generation.  Note that the advanced key generation commands can always
3324 be used to specify a key algorithm directly.  Please consult the
3325 source code to learn the syntax of @var{string}.
3326
3327 @item --allow-secret-key-import
3328 @opindex allow-secret-key-import
3329 This is an obsolete option and is not used anywhere.
3330
3331 @item --allow-multiple-messages
3332 @item --no-allow-multiple-messages
3333 @opindex allow-multiple-messages
3334 Allow processing of multiple OpenPGP messages contained in a single file
3335 or stream.  Some programs that call GPG are not prepared to deal with
3336 multiple messages being processed together, so this option defaults to
3337 no.  Note that versions of GPG prior to 1.4.7 always allowed multiple
3338 messages.
3339
3340 Warning: Do not use this option unless you need it as a temporary
3341 workaround!
3342
3343
3344 @item --enable-special-filenames
3345 @opindex enable-special-filenames
3346 This option enables a mode in which filenames of the form
3347 @file{-&n}, where n is a non-negative decimal number,
3348 refer to the file descriptor n and not to a file with that name.
3349
3350 @item --no-expensive-trust-checks
3351 @opindex no-expensive-trust-checks
3352 Experimental use only.
3353
3354 @item --preserve-permissions
3355 @opindex preserve-permissions
3356 Don't change the permissions of a secret keyring back to user
3357 read/write only. Use this option only if you really know what you are doing.
3358
3359 @item --default-preference-list @var{string}
3360 @opindex default-preference-list
3361 Set the list of default preferences to @var{string}. This preference
3362 list is used for new keys and becomes the default for "setpref" in the
3363 edit menu.
3364
3365 @item --default-keyserver-url @var{name}
3366 @opindex default-keyserver-url
3367 Set the default keyserver URL to @var{name}. This keyserver will be
3368 used as the keyserver URL when writing a new self-signature on a key,
3369 which includes key generation and changing preferences.
3370
3371 @item --list-config
3372 @opindex list-config
3373 Display various internal configuration parameters of GnuPG. This option
3374 is intended for external programs that call GnuPG to perform tasks, and
3375 is thus not generally useful. See the file @file{doc/DETAILS} in the
3376 source distribution for the details of which configuration items may be
3377 listed. @option{--list-config} is only usable with
3378 @option{--with-colons} set.
3379
3380 @item --list-gcrypt-config
3381 @opindex list-gcrypt-config
3382 Display various internal configuration parameters of Libgcrypt.
3383
3384 @item --gpgconf-list
3385 @opindex gpgconf-list
3386 This command is similar to @option{--list-config} but in general only
3387 internally used by the @command{gpgconf} tool.
3388
3389 @item --gpgconf-test
3390 @opindex gpgconf-test
3391 This is more or less dummy action.  However it parses the configuration
3392 file and returns with failure if the configuration file would prevent
3393 @command{@gpgname} from startup.  Thus it may be used to run a syntax check
3394 on the configuration file.
3395
3396 @end table
3397
3398 @c *******************************
3399 @c ******* Deprecated ************
3400 @c *******************************
3401 @node Deprecated Options
3402 @subsection Deprecated options
3403
3404 @table @gnupgtabopt
3405
3406 @item --show-photos
3407 @itemx --no-show-photos
3408 @opindex show-photos
3409 Causes @option{--list-keys}, @option{--list-signatures},
3410 @option{--list-public-keys}, @option{--list-secret-keys}, and verifying
3411 a signature to also display the photo ID attached to the key, if
3412 any. See also @option{--photo-viewer}. These options are deprecated. Use
3413 @option{--list-options [no-]show-photos} and/or @option{--verify-options
3414 [no-]show-photos} instead.
3415
3416 @item --show-keyring
3417 @opindex show-keyring
3418 Display the keyring name at the head of key listings to show which
3419 keyring a given key resides on. This option is deprecated: use
3420 @option{--list-options [no-]show-keyring} instead.
3421
3422 @item --always-trust
3423 @opindex always-trust
3424 Identical to @option{--trust-model always}. This option is deprecated.
3425
3426 @item --show-notation
3427 @itemx --no-show-notation
3428 @opindex show-notation
3429 Show signature notations in the @option{--list-signatures} or @option{--check-signatures} listings
3430 as well as when verifying a signature with a notation in it. These
3431 options are deprecated. Use @option{--list-options [no-]show-notation}
3432 and/or @option{--verify-options [no-]show-notation} instead.
3433
3434 @item --show-policy-url
3435 @itemx --no-show-policy-url
3436 @opindex show-policy-url
3437 Show policy URLs in the @option{--list-signatures} or @option{--check-signatures}
3438 listings as well as when verifying a signature with a policy URL in
3439 it. These options are deprecated. Use @option{--list-options
3440 [no-]show-policy-url} and/or @option{--verify-options
3441 [no-]show-policy-url} instead.
3442
3443
3444 @end table
3445
3446
3447 @c *******************************************
3448 @c ***************            ****************
3449 @c ***************   FILES    ****************
3450 @c ***************            ****************
3451 @c *******************************************
3452 @mansect files
3453 @node GPG Configuration
3454 @section Configuration files
3455
3456 There are a few configuration files to control certain aspects of
3457 @command{@gpgname}'s operation. Unless noted, they are expected in the
3458 current home directory (@pxref{option --homedir}).
3459
3460 @table @file
3461
3462   @item gpg.conf
3463   @efindex gpg.conf
3464   This is the standard configuration file read by @command{@gpgname} on
3465   startup.  It may contain any valid long option; the leading two dashes
3466   may not be entered and the option may not be abbreviated.  This default
3467   name may be changed on the command line (@pxref{gpg-option --options}).
3468   You should backup this file.
3469
3470 @end table
3471
3472 Note that on larger installations, it is useful to put predefined files
3473 into the directory @file{@value{SYSCONFSKELDIR}} so that
3474 newly created users start up with a working configuration.
3475 For existing users a small
3476 helper script is provided to create these files (@pxref{addgnupghome}).
3477
3478 For internal purposes @command{@gpgname} creates and maintains a few other
3479 files; They all live in the current home directory (@pxref{option
3480 --homedir}).  Only the @command{@gpgname} program may modify these files.
3481
3482
3483 @table @file
3484   @item ~/.gnupg
3485   @efindex ~/.gnupg
3486   This is the default home directory which is used if neither the
3487   environment variable @code{GNUPGHOME} nor the option
3488   @option{--homedir} is given.
3489
3490   @item ~/.gnupg/pubring.gpg
3491   @efindex pubring.gpg
3492   The public keyring.  You should backup this file.
3493
3494   @item ~/.gnupg/pubring.gpg.lock
3495   The lock file for the public keyring.
3496
3497   @item ~/.gnupg/pubring.kbx
3498   @efindex pubring.kbx
3499   The public keyring using a different format.  This file is shared
3500   with @command{gpgsm}.  You should backup this file.
3501
3502   @item ~/.gnupg/pubring.kbx.lock
3503   The lock file for @file{pubring.kbx}.
3504
3505   @item ~/.gnupg/secring.gpg
3506   @efindex secring.gpg
3507   A secret keyring as used by GnuPG versions before 2.1.  It is not
3508   used by GnuPG 2.1 and later.
3509
3510   @item ~/.gnupg/secring.gpg.lock
3511   The lock file for the secret keyring.
3512
3513   @item ~/.gnupg/.gpg-v21-migrated
3514   @efindex .gpg-v21-migrated
3515   File indicating that a migration to GnuPG 2.1 has been done.
3516
3517   @item ~/.gnupg/trustdb.gpg
3518   @efindex trustdb.gpg
3519   The trust database.  There is no need to backup this file; it is better
3520   to backup the ownertrust values (@pxref{option --export-ownertrust}).
3521
3522   @item ~/.gnupg/trustdb.gpg.lock
3523   The lock file for the trust database.
3524
3525   @item ~/.gnupg/random_seed
3526   @efindex random_seed
3527   A file used to preserve the state of the internal random pool.
3528
3529   @item ~/.gnupg/openpgp-revocs.d/
3530   @efindex openpgp-revocs.d
3531   This is the directory where gpg stores pre-generated revocation
3532   certificates.  The file name corresponds to the OpenPGP fingerprint of
3533   the respective key.  It is suggested to backup those certificates and
3534   if the primary private key is not stored on the disk to move them to
3535   an external storage device.  Anyone who can access theses files is
3536   able to revoke the corresponding key.  You may want to print them out.
3537   You should backup all files in this directory and take care to keep
3538   this backup closed away.
3539
3540 @end table
3541
3542 Operation is further controlled by a few environment variables:
3543
3544 @table @asis
3545
3546   @item HOME
3547   @efindex HOME
3548   Used to locate the default home directory.
3549
3550   @item GNUPGHOME
3551   @efindex GNUPGHOME
3552   If set directory used instead of "~/.gnupg".
3553
3554   @item GPG_AGENT_INFO
3555   This variable is obsolete; it was used by GnuPG versions before 2.1.
3556
3557   @item PINENTRY_USER_DATA
3558   @efindex PINENTRY_USER_DATA
3559   This value is passed via gpg-agent to pinentry.  It is useful to convey
3560   extra information to a custom pinentry.
3561
3562   @item COLUMNS
3563   @itemx LINES
3564   @efindex COLUMNS
3565   @efindex LINES
3566   Used to size some displays to the full size of the screen.
3567
3568   @item LANGUAGE
3569   @efindex LANGUAGE
3570   Apart from its use by GNU, it is used in the W32 version to override the
3571   language selection done through the Registry.  If used and set to a
3572   valid and available language name (@var{langid}), the file with the
3573   translation is loaded from
3574   @code{@var{gpgdir}/gnupg.nls/@var{langid}.mo}.  Here @var{gpgdir} is the
3575   directory out of which the gpg binary has been loaded.  If it can't be
3576   loaded the Registry is tried and as last resort the native Windows
3577   locale system is used.
3578
3579 @end table
3580
3581
3582 @c *******************************************
3583 @c ***************            ****************
3584 @c ***************  EXAMPLES  ****************
3585 @c ***************            ****************
3586 @c *******************************************
3587 @mansect examples
3588 @node GPG Examples
3589 @section Examples
3590
3591 @table @asis
3592
3593 @item gpg -se -r @code{Bob} @code{file}
3594 sign and encrypt for user Bob
3595
3596 @item gpg --clear-sign @code{file}
3597 make a cleartext signature
3598
3599 @item gpg -sb @code{file}
3600 make a detached signature
3601
3602 @item gpg -u 0x12345678 -sb @code{file}
3603 make a detached signature with the key 0x12345678
3604
3605 @item gpg --list-keys @code{user_ID}
3606 show keys
3607
3608 @item gpg --fingerprint @code{user_ID}
3609 show fingerprint
3610
3611 @item gpg --verify @code{pgpfile}
3612 @itemx gpg --verify @code{sigfile} [@code{datafile}]
3613 Verify the signature of the file but do not output the data unless
3614 requested.  The second form is used for detached signatures, where
3615 @code{sigfile} is the detached signature (either ASCII armored or
3616 binary) and @code{datafile} are the signed data; if this is not given, the name of the
3617 file holding the signed data is constructed by cutting off the
3618 extension (".asc" or ".sig") of @code{sigfile} or by asking the user
3619 for the filename.  If the option @option{--output} is also used the
3620 signed data is written to the file specified by that option; use
3621 @code{-} to write the signed data to stdout.
3622 @end table
3623
3624
3625 @c *******************************************
3626 @c ***************            ****************
3627 @c ***************  USER ID   ****************
3628 @c ***************            ****************
3629 @c *******************************************
3630 @mansect how to specify a user id
3631 @ifset isman
3632 @include specify-user-id.texi
3633 @end ifset
3634
3635 @mansect filter expressions
3636 @chapheading FILTER EXPRESSIONS
3637
3638 The options @option{--import-filter} and @option{--export-filter} use
3639 expressions with this syntax (square brackets indicate an optional
3640 part and curly braces a repetition, white space between the elements
3641 are allowed):
3642
3643 @c man:.RS
3644 @example
3645   [lc] @{[@{flag@}] PROPNAME op VALUE [lc]@}
3646 @end example
3647 @c man:.RE
3648
3649 The name of a property (@var{PROPNAME}) may only consist of letters,
3650 digits and underscores.  The description for the filter type
3651 describes which properties are defined.  If an undefined property is
3652 used it evaluates to the empty string.  Unless otherwise noted, the
3653 @var{VALUE} must always be given and may not be the empty string.  No
3654 quoting is defined for the value, thus the value may not contain the
3655 strings @code{&&} or @code{||}, which are used as logical connection
3656 operators.  The flag @code{--} can be used to remove this restriction.
3657
3658 Numerical values are computed as long int; standard C notation
3659 applies.  @var{lc} is the logical connection operator; either
3660 @code{&&} for a conjunction or @code{||} for a disjunction.  A
3661 conjunction is assumed at the begin of an expression.  Conjunctions
3662 have higher precedence than disjunctions.  If @var{VALUE} starts with
3663 one of the characters used in any @var{op} a space after the
3664 @var{op} is required.
3665
3666 @noindent
3667 The supported operators (@var{op}) are:
3668
3669 @table @asis
3670
3671   @item =~
3672   Substring must match.
3673
3674   @item  !~
3675   Substring must not match.
3676
3677   @item  =
3678   The full string must match.
3679
3680   @item  <>
3681   The full string must not match.
3682
3683   @item  ==
3684   The numerical value must match.
3685
3686   @item  !=
3687   The numerical value must not match.
3688
3689   @item  <=
3690   The numerical value of the field must be LE than the value.
3691
3692   @item  <
3693   The numerical value of the field must be LT than the value.
3694
3695   @item  >
3696   The numerical value of the field must be GT than the value.
3697
3698   @item  >=
3699   The numerical value of the field must be GE than the value.
3700
3701   @item  -le
3702   The string value of the field must be less or equal than the value.
3703
3704   @item  -lt
3705   The string value of the field must be less than the value.
3706
3707   @item  -gt
3708   The string value of the field must be greater than the value.
3709
3710   @item  -ge
3711   The string value of the field must be greater or equal than the value.
3712
3713   @item  -n
3714   True if value is not empty (no value allowed).
3715
3716   @item  -z
3717   True if value is empty (no value allowed).
3718
3719   @item  -t
3720   Alias for "PROPNAME != 0" (no value allowed).
3721
3722   @item  -f
3723   Alias for "PROPNAME == 0" (no value allowed).
3724
3725 @end table
3726
3727 @noindent
3728 Values for @var{flag} must be space separated.  The supported flags
3729 are:
3730
3731 @table @asis
3732   @item --
3733   @var{VALUE} spans to the end of the expression.
3734   @item -c
3735   The string match in this part is done case-sensitive.
3736 @end table
3737
3738 The filter options concatenate several specifications for a filter of
3739 the same type.  For example the four options in this example:
3740
3741 @c man:.RS
3742 @example
3743  --import-option keep-uid="uid =~ Alfa"
3744  --import-option keep-uid="&& uid !~ Test"
3745  --import-option keep-uid="|| uid =~ Alpha"
3746  --import-option keep-uid="uid !~ Test"
3747 @end example
3748 @c man:.RE
3749
3750 @noindent
3751 which is equivalent to
3752
3753 @c man:.RS
3754 @example
3755  --import-option \
3756   keep-uid="uid =~ Alfa" && uid !~ Test" || uid =~ Alpha" && "uid !~ Test"
3757 @end example
3758 @c man:.RE
3759
3760 imports only the user ids of a key containing the strings "Alfa"
3761 or "Alpha" but not the string "test".
3762
3763
3764 @mansect return value
3765 @chapheading RETURN VALUE
3766
3767 The program returns 0 if everything was fine, 1 if at least
3768 a signature was bad, and other error codes for fatal errors.
3769
3770 @mansect warnings
3771 @chapheading WARNINGS
3772
3773 Use a *good* password for your user account and a *good* passphrase
3774 to protect your secret key. This passphrase is the weakest part of the
3775 whole system. Programs to do dictionary attacks on your secret keyring
3776 are very easy to write and so you should protect your "~/.gnupg/"
3777 directory very well.
3778
3779 Keep in mind that, if this program is used over a network (telnet), it
3780 is *very* easy to spy out your passphrase!
3781
3782 If you are going to verify detached signatures, make sure that the
3783 program knows about it; either give both filenames on the command line
3784 or use @samp{-} to specify STDIN.
3785
3786 For scripted or other unattended use of @command{gpg} make sure to use
3787 the machine-parseable interface and not the default interface which is
3788 intended for direct use by humans.  The machine-parseable interface
3789 provides a stable and well documented API independent of the locale or
3790 future changes of @command{gpg}.  To enable this interface use the
3791 options @option{--with-colons} and @option{--status-fd}.  For certain
3792 operations the option @option{--command-fd} may come handy too.  See
3793 this man page and the file @file{DETAILS} for the specification of the
3794 interface.  Note that the GnuPG ``info'' pages as well as the PDF
3795 version of the GnuPG manual features a chapter on unattended use of
3796 GnuPG.  As an alternative the library @command{GPGME} can be used as a
3797 high-level abstraction on top of that interface.
3798
3799 @mansect interoperability
3800 @chapheading INTEROPERABILITY WITH OTHER OPENPGP PROGRAMS
3801
3802 GnuPG tries to be a very flexible implementation of the OpenPGP
3803 standard. In particular, GnuPG implements many of the optional parts
3804 of the standard, such as the SHA-512 hash, and the ZLIB and BZIP2
3805 compression algorithms. It is important to be aware that not all
3806 OpenPGP programs implement these optional algorithms and that by
3807 forcing their use via the @option{--cipher-algo},
3808 @option{--digest-algo}, @option{--cert-digest-algo}, or
3809 @option{--compress-algo} options in GnuPG, it is possible to create a
3810 perfectly valid OpenPGP message, but one that cannot be read by the
3811 intended recipient.
3812
3813 There are dozens of variations of OpenPGP programs available, and each
3814 supports a slightly different subset of these optional algorithms.
3815 For example, until recently, no (unhacked) version of PGP supported
3816 the BLOWFISH cipher algorithm. A message using BLOWFISH simply could
3817 not be read by a PGP user. By default, GnuPG uses the standard
3818 OpenPGP preferences system that will always do the right thing and
3819 create messages that are usable by all recipients, regardless of which
3820 OpenPGP program they use. Only override this safe default if you
3821 really know what you are doing.
3822
3823 If you absolutely must override the safe default, or if the preferences
3824 on a given key are invalid for some reason, you are far better off using
3825 the @option{--pgp6}, @option{--pgp7}, or @option{--pgp8} options. These
3826 options are safe as they do not force any particular algorithms in
3827 violation of OpenPGP, but rather reduce the available algorithms to a
3828 "PGP-safe" list.
3829
3830 @mansect bugs
3831 @chapheading BUGS
3832
3833 On older systems this program should be installed as setuid(root). This
3834 is necessary to lock memory pages. Locking memory pages prevents the
3835 operating system from writing memory pages (which may contain
3836 passphrases or other sensitive material) to disk. If you get no
3837 warning message about insecure memory your operating system supports
3838 locking without being root. The program drops root privileges as soon
3839 as locked memory is allocated.
3840
3841 Note also that some systems (especially laptops) have the ability to
3842 ``suspend to disk'' (also known as ``safe sleep'' or ``hibernate'').
3843 This writes all memory to disk before going into a low power or even
3844 powered off mode.  Unless measures are taken in the operating system
3845 to protect the saved memory, passphrases or other sensitive material
3846 may be recoverable from it later.
3847
3848 Before you report a bug you should first search the mailing list
3849 archives for similar problems and second check whether such a bug has
3850 already been reported to our bug tracker at @url{https://bugs.gnupg.org}.
3851
3852 @c *******************************************
3853 @c ***************              **************
3854 @c ***************  UNATTENDED  **************
3855 @c ***************              **************
3856 @c *******************************************
3857 @manpause
3858 @node Unattended Usage of GPG
3859 @section Unattended Usage
3860
3861 @command{@gpgname} is often used as a backend engine by other software.  To help
3862 with this a machine interface has been defined to have an unambiguous
3863 way to do this.  The options @option{--status-fd} and @option{--batch}
3864 are almost always required for this.
3865
3866 @menu
3867 * Programmatic use of GnuPG:: Programmatic use of GnuPG
3868 * Ephemeral home directories:: Ephemeral home directories
3869 * The quick key manipulation interface:: The quick key manipulation interface
3870 * Unattended GPG key generation::  Unattended key generation
3871 @end menu
3872
3873
3874 @node Programmatic use of GnuPG
3875 @subsection Programmatic use of GnuPG
3876
3877 Please consider using GPGME instead of calling @command{@gpgname}
3878 directly.  GPGME offers a stable, backend-independent interface for
3879 many cryptographic operations.  It supports OpenPGP and S/MIME, and
3880 also allows interaction with various GnuPG components.
3881
3882 GPGME provides a C-API, and comes with bindings for C++, Qt, and
3883 Python.  Bindings for other languages are available.
3884
3885 @node Ephemeral home directories
3886 @subsection Ephemeral home directories
3887
3888 Sometimes you want to contain effects of some operation, for example
3889 you want to import a key to inspect it, but you do not want this key
3890 to be added to your keyring.  In earlier versions of GnuPG, it was
3891 possible to specify alternate keyring files for both public and secret
3892 keys.  In modern GnuPG versions, however, we changed how secret keys
3893 are stored in order to better protect secret key material, and it was
3894 not possible to preserve this interface.
3895
3896 The preferred way to do this is to use ephemeral home directories.
3897 This technique works across all versions of GnuPG.
3898
3899 Create a temporary directory, create (or copy) a configuration that
3900 meets your needs, make @command{@gpgname} use this directory either
3901 using the environment variable @var{GNUPGHOME}, or the option
3902 @option{--homedir}.  GPGME supports this too on a per-context basis,
3903 by modifying the engine info of contexts.  Now execute whatever
3904 operation you like, import and export key material as necessary.  Once
3905 finished, you can delete the directory.  All GnuPG backend services
3906 that were started will detect this and shut down.
3907
3908 @node The quick key manipulation interface
3909 @subsection The quick key manipulation interface
3910
3911 Recent versions of GnuPG have an interface to manipulate keys without
3912 using the interactive command @option{--edit-key}.  This interface was
3913 added mainly for the benefit of GPGME (please consider using GPGME,
3914 see the manual subsection ``Programmatic use of GnuPG'').  This
3915 interface is described in the subsection ``How to manage your keys''.
3916
3917 @node Unattended GPG key generation
3918 @subsection Unattended key generation
3919
3920 The command @option{--generate-key} may be used along with the option
3921 @option{--batch} for unattended key generation.  This is the most
3922 flexible way of generating keys, but it is also the most complex one.
3923 Consider using the quick key manipulation interface described in the
3924 previous subsection ``The quick key manipulation interface''.
3925
3926 The parameters for the key are either read from stdin or given as a
3927 file on the command line.  The format of the parameter file is as
3928 follows:
3929
3930 @itemize @bullet
3931   @item Text only, line length is limited to about 1000 characters.
3932   @item UTF-8 encoding must be used to specify non-ASCII characters.
3933   @item Empty lines are ignored.
3934   @item Leading and trailing white space is ignored.
3935   @item A hash sign as the first non white space character indicates
3936   a comment line.
3937   @item Control statements are indicated by a leading percent sign, the
3938   arguments are separated by white space from the keyword.
3939   @item Parameters are specified by a keyword, followed by a colon.  Arguments
3940   are separated by white space.
3941   @item
3942   The first parameter must be @samp{Key-Type}; control statements may be
3943   placed anywhere.
3944   @item
3945   The order of the parameters does not matter except for @samp{Key-Type}
3946   which must be the first parameter.  The parameters are only used for
3947   the generated keyblock (primary and subkeys); parameters from previous
3948   sets are not used.  Some syntactically checks may be performed.
3949   @item
3950   Key generation takes place when either the end of the parameter file
3951   is reached, the next @samp{Key-Type} parameter is encountered or at the
3952   control statement @samp{%commit} is encountered.
3953 @end itemize
3954
3955 @noindent
3956 Control statements:
3957
3958 @table @asis
3959
3960 @item %echo @var{text}
3961 Print @var{text} as diagnostic.
3962
3963 @item %dry-run
3964 Suppress actual key generation (useful for syntax checking).
3965
3966 @item %commit
3967 Perform the key generation.  Note that an implicit commit is done at
3968 the next @asis{Key-Type} parameter.
3969
3970 @item %pubring @var{filename}
3971 Do not write the key to the default or commandline given keyring but
3972 to @var{filename}.  This must be given before the first commit to take
3973 place, duplicate specification of the same filename is ignored, the
3974 last filename before a commit is used.  The filename is used until a
3975 new filename is used (at commit points) and all keys are written to
3976 that file. If a new filename is given, this file is created (and
3977 overwrites an existing one).
3978
3979 See the previous subsection ``Ephemeral home directories'' for a more
3980 robust way to contain side-effects.
3981
3982 @item %secring @var{filename}
3983 This option is a no-op for GnuPG 2.1 and later.
3984
3985 See the previous subsection ``Ephemeral home directories''.
3986
3987 @item %ask-passphrase
3988 @itemx %no-ask-passphrase
3989 This option is a no-op for GnuPG 2.1 and later.
3990
3991 @item %no-protection
3992 Using this option allows the creation of keys without any passphrase
3993 protection.  This option is mainly intended for regression tests.
3994
3995 @item %transient-key
3996 If given the keys are created using a faster and a somewhat less
3997 secure random number generator.  This option may be used for keys
3998 which are only used for a short time and do not require full
3999 cryptographic strength.  It takes only effect if used together with
4000 the control statement @samp{%no-protection}.
4001
4002 @end table
4003
4004 @noindent
4005 General Parameters:
4006
4007 @table @asis
4008
4009 @item Key-Type: @var{algo}
4010 Starts a new parameter block by giving the type of the primary
4011 key. The algorithm must be capable of signing.  This is a required
4012 parameter.  @var{algo} may either be an OpenPGP algorithm number or a
4013 string with the algorithm name.  The special value @samp{default} may
4014 be used for @var{algo} to create the default key type; in this case a
4015 @samp{Key-Usage} shall not be given and @samp{default} also be used
4016 for @samp{Subkey-Type}.
4017
4018 @item Key-Length: @var{nbits}
4019 The requested length of the generated key in bits.  The default is
4020 returned by running the command @samp{@gpgname --gpgconf-list}.
4021
4022 @item Key-Grip: @var{hexstring}
4023 This is optional and used to generate a CSR or certificate for an
4024 already existing key.  Key-Length will be ignored when given.
4025
4026 @item Key-Usage: @var{usage-list}
4027 Space or comma delimited list of key usages.  Allowed values are
4028 @samp{encrypt}, @samp{sign}, and @samp{auth}.  This is used to
4029 generate the key flags.  Please make sure that the algorithm is
4030 capable of this usage.  Note that OpenPGP requires that all primary
4031 keys are capable of certification, so no matter what usage is given
4032 here, the @samp{cert} flag will be on.  If no @samp{Key-Usage} is
4033 specified and the @samp{Key-Type} is not @samp{default}, all allowed
4034 usages for that particular algorithm are used; if it is not given but
4035 @samp{default} is used the usage will be @samp{sign}.
4036
4037 @item Subkey-Type: @var{algo}
4038 This generates a secondary key (subkey).  Currently only one subkey
4039 can be handled.  See also @samp{Key-Type} above.
4040
4041 @item Subkey-Length: @var{nbits}
4042 Length of the secondary key (subkey) in bits.  The default is returned
4043 by running the command @samp{@gpgname --gpgconf-list}.
4044
4045 @item Subkey-Usage: @var{usage-list}
4046 Key usage lists for a subkey; similar to @samp{Key-Usage}.
4047
4048 @item Passphrase: @var{string}
4049 If you want to specify a passphrase for the secret key, enter it here.
4050 Default is to use the Pinentry dialog to ask for a passphrase.
4051
4052 @item Name-Real: @var{name}
4053 @itemx Name-Comment: @var{comment}
4054 @itemx Name-Email: @var{email}
4055 The three parts of a user name.  Remember to use UTF-8 encoding here.
4056 If you don't give any of them, no user ID is created.
4057
4058 @item Expire-Date: @var{iso-date}|(@var{number}[d|w|m|y])
4059 Set the expiration date for the key (and the subkey).  It may either
4060 be entered in ISO date format (e.g. "20000815T145012") or as number of
4061 days, weeks, month or years after the creation date.  The special
4062 notation "seconds=N" is also allowed to specify a number of seconds
4063 since creation.  Without a letter days are assumed.  Note that there
4064 is no check done on the overflow of the type used by OpenPGP for
4065 timestamps.  Thus you better make sure that the given value make
4066 sense.  Although OpenPGP works with time intervals, GnuPG uses an
4067 absolute value internally and thus the last year we can represent is
4068 2105.
4069
4070 @item  Creation-Date: @var{iso-date}
4071 Set the creation date of the key as stored in the key information and
4072 which is also part of the fingerprint calculation.  Either a date like
4073 "1986-04-26" or a full timestamp like "19860426T042640" may be used.
4074 The time is considered to be UTC.  The special notation "seconds=N"
4075 may be used to directly specify a the number of seconds since Epoch
4076 (Unix time).  If it is not given the current time is used.
4077
4078 @item Preferences: @var{string}
4079 Set the cipher, hash, and compression preference values for this key.
4080 This expects the same type of string as the sub-command @samp{setpref}
4081 in the @option{--edit-key} menu.
4082
4083 @item  Revoker: @var{algo}:@var{fpr} [sensitive]
4084 Add a designated revoker to the generated key.  Algo is the public key
4085 algorithm of the designated revoker (i.e. RSA=1, DSA=17, etc.)
4086 @var{fpr} is the fingerprint of the designated revoker.  The optional
4087 @samp{sensitive} flag marks the designated revoker as sensitive
4088 information.  Only v4 keys may be designated revokers.
4089
4090 @item Keyserver: @var{string}
4091 This is an optional parameter that specifies the preferred keyserver
4092 URL for the key.
4093
4094 @item Handle: @var{string}
4095 This is an optional parameter only used with the status lines
4096 KEY_CREATED and KEY_NOT_CREATED.  @var{string} may be up to 100
4097 characters and should not contain spaces.  It is useful for batch key
4098 generation to associate a key parameter block with a status line.
4099
4100 @end table
4101
4102 @noindent
4103 Here is an example on how to create a key in an ephemeral home directory:
4104 @smallexample
4105 $ export GNUPGHOME="$(mktemp -d)"
4106 $ cat >foo <<EOF
4107      %echo Generating a basic OpenPGP key
4108      Key-Type: DSA
4109      Key-Length: 1024
4110      Subkey-Type: ELG-E
4111      Subkey-Length: 1024
4112      Name-Real: Joe Tester
4113      Name-Comment: with stupid passphrase
4114      Name-Email: joe@@foo.bar
4115      Expire-Date: 0
4116      Passphrase: abc
4117      # Do a commit here, so that we can later print "done" :-)
4118      %commit
4119      %echo done
4120 EOF
4121 $ @gpgname --batch --generate-key foo
4122  [...]
4123 $ @gpgname --list-secret-keys
4124 /tmp/tmp.0NQxB74PEf/pubring.kbx
4125 -------------------------------
4126 sec   dsa1024 2016-12-16 [SCA]
4127       768E895903FC1C44045C8CB95EEBDB71E9E849D0
4128 uid           [ultimate] Joe Tester (with stupid passphrase) <joe@@foo.bar>
4129 ssb   elg1024 2016-12-16 [E]
4130 @end smallexample
4131
4132 @noindent
4133 If you want to create a key with the default algorithms you would use
4134 these parameters:
4135 @smallexample
4136      %echo Generating a default key
4137      Key-Type: default
4138      Subkey-Type: default
4139      Name-Real: Joe Tester
4140      Name-Comment: with stupid passphrase
4141      Name-Email: joe@@foo.bar
4142      Expire-Date: 0
4143      Passphrase: abc
4144      # Do a commit here, so that we can later print "done" :-)
4145      %commit
4146      %echo done
4147 @end smallexample
4148
4149
4150
4151
4152 @mansect see also
4153 @ifset isman
4154 @command{gpgv}(1),
4155 @command{gpgsm}(1),
4156 @command{gpg-agent}(1)
4157 @end ifset
4158 @include see-also-note.texi