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