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