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