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