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