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