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