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