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