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