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