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