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