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