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