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