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