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