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