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