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