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