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