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