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