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