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