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