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