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