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