Require libgpg-error 1.10
[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 and public 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 --enarmor
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
853 @end table
854
855 @c man:.RS
856 The listing shows you the key with its secondary keys and all user
857 ids.  The primary user id is indicated by a dot, and selected keys or
858 user ids are indicated by an asterisk.  The trust
859 value is displayed with the primary key: the first is the assigned owner
860 trust and the second is the calculated trust value. Letters are used for
861 the values:
862 @c man:.RE
863
864 @table @asis
865
866 @item -
867 No ownertrust assigned / not yet calculated.
868
869 @item e
870 Trust
871 calculation has failed; probably due to an expired key.
872
873 @item q
874 Not enough information for calculation.
875
876 @item n
877 Never trust this key.
878
879 @item m
880 Marginally trusted.
881
882 @item f
883 Fully trusted.
884
885 @item u
886 Ultimately trusted.
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
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 Display the calculated validity of user IDs during key listings.
1059 Defaults to no.
1060
1061 @item show-unusable-uids
1062 Show revoked and expired user IDs in key listings. Defaults to no.
1063
1064 @item show-unusable-subkeys
1065 Show revoked and expired subkeys in key listings. Defaults to no.
1066
1067 @item show-keyring
1068 Display the keyring name at the head of key listings to show which
1069 keyring a given key resides on. Defaults to no.
1070
1071 @item show-sig-expire
1072 Show signature expiration dates (if any) during @option{--list-sigs} or
1073 @option{--check-sigs} listings. Defaults to no.
1074
1075 @item show-sig-subpackets
1076 Include signature subpackets in the key listing. This option can take an
1077 optional argument list of the subpackets to list. If no argument is
1078 passed, list all subpackets. Defaults to no. This option is only
1079 meaningful when using @option{--with-colons} along with
1080 @option{--list-sigs} or @option{--check-sigs}.
1081 @end table
1082
1083 @item --verify-options @code{parameters}
1084 This is a space or comma delimited string that gives options used when
1085 verifying signatures. Options can be prepended with a `no-' to give
1086 the opposite meaning. The options are:
1087
1088 @table @asis
1089
1090 @item show-photos
1091 Display any photo IDs present on the key that issued the signature.
1092 Defaults to no. See also @option{--photo-viewer}.
1093
1094 @item show-policy-urls
1095 Show policy URLs in the signature being verified. Defaults to no.
1096
1097 @item show-notations
1098 @itemx show-std-notations
1099 @itemx show-user-notations
1100 Show all, IETF standard, or user-defined signature notations in the
1101 signature being verified. Defaults to IETF standard.
1102
1103 @item show-keyserver-urls
1104 Show any preferred keyserver URL in the signature being verified.
1105 Defaults to no.
1106
1107 @item show-uid-validity
1108 Display the calculated validity of the user IDs on the key that issued
1109 the signature. Defaults to no.
1110
1111 @item show-unusable-uids
1112 Show revoked and expired user IDs during signature verification.
1113 Defaults to no.
1114
1115 @item show-primary-uid-only
1116 Show only the primary user ID during signature verification.  That is
1117 all the AKA lines as well as photo Ids are not shown with the signature
1118 verification status.
1119
1120 @item pka-lookups
1121 Enable PKA lookups to verify sender addresses. Note that PKA is based
1122 on DNS, and so enabling this option may disclose information on when
1123 and what signatures are verified or to whom data is encrypted. This
1124 is similar to the "web bug" described for the auto-key-retrieve
1125 feature.
1126
1127 @item pka-trust-increase
1128 Raise the trust in a signature to full if the signature passes PKA
1129 validation. This option is only meaningful if pka-lookups is set.
1130 @end table
1131
1132 @item --enable-dsa2
1133 @itemx --disable-dsa2
1134 Enable hash truncation for all DSA keys even for old DSA Keys up to
1135 1024 bit.  This is also the default with @option{--openpgp}.  Note
1136 that older versions of GnuPG also required this flag to allow the
1137 generation of DSA larger than 1024 bit.
1138
1139 @item --photo-viewer @code{string}
1140 This is the command line that should be run to view a photo ID. "%i"
1141 will be expanded to a filename containing the photo. "%I" does the
1142 same, except the file will not be deleted once the viewer exits.
1143 Other flags are "%k" for the key ID, "%K" for the long key ID, "%f"
1144 for the key fingerprint, "%t" for the extension of the image type
1145 (e.g. "jpg"), "%T" for the MIME type of the image (e.g. "image/jpeg"),
1146 "%v" for the single-character calculated validity of the image being
1147 viewed (e.g. "f"), "%V" for the calculated validity as a string (e.g.
1148 "full"),
1149 and "%%" for an actual percent sign. If neither %i or %I are present,
1150 then the photo will be supplied to the viewer on standard input.
1151
1152 The default viewer is "xloadimage -fork -quiet -title 'KeyID 0x%k'
1153 STDIN". Note that if your image viewer program is not secure, then
1154 executing it from GnuPG does not make it secure.
1155
1156 @item --exec-path @code{string}
1157 Sets a list of directories to search for photo viewers and keyserver
1158 helpers. If not provided, keyserver helpers use the compiled-in
1159 default directory, and photo viewers use the $PATH environment
1160 variable.
1161 Note, that on W32 system this value is ignored when searching for
1162 keyserver helpers.
1163
1164 @item --keyring @code{file}
1165 Add @code{file} to the current list of keyrings. If @code{file} begins
1166 with a tilde and a slash, these are replaced by the $HOME directory. If
1167 the filename does not contain a slash, it is assumed to be in the GnuPG
1168 home directory ("~/.gnupg" if @option{--homedir} or $GNUPGHOME is not
1169 used).
1170
1171 Note that this adds a keyring to the current list. If the intent is to
1172 use the specified keyring alone, use @option{--keyring} along with
1173 @option{--no-default-keyring}.
1174
1175 @item --secret-keyring @code{file}
1176 Same as @option{--keyring} but for the secret keyrings.
1177
1178 @item --primary-keyring @code{file}
1179 Designate @code{file} as the primary public keyring. This means that
1180 newly imported keys (via @option{--import} or keyserver
1181 @option{--recv-from}) will go to this keyring.
1182
1183 @item --trustdb-name @code{file}
1184 Use @code{file} instead of the default trustdb. If @code{file} begins
1185 with a tilde and a slash, these are replaced by the $HOME directory. If
1186 the filename does not contain a slash, it is assumed to be in the GnuPG
1187 home directory (@file{~/.gnupg} if @option{--homedir} or $GNUPGHOME is
1188 not used).
1189
1190 @ifset gpgone
1191 @anchor{option --homedir}
1192 @end ifset
1193 @include opt-homedir.texi
1194
1195
1196 @ifset gpgone
1197 @item --pcsc-driver @code{file}
1198 Use @code{file} to access the smartcard reader. The current default is
1199 `libpcsclite.so.1' for GLIBC based systems,
1200 `/System/Library/Frameworks/PCSC.framework/PCSC' for MAC OS X,
1201 `winscard.dll' for Windows and `libpcsclite.so' for other systems.
1202 @end ifset
1203
1204 @ifset gpgone
1205 @item --disable-ccid
1206 Disable the integrated support for CCID compliant readers. This
1207 allows to fall back to one of the other drivers even if the internal
1208 CCID driver can handle the reader. Note, that CCID support is only
1209 available if libusb was available at build time.
1210 @end ifset
1211
1212 @ifset gpgone
1213 @item --reader-port @code{number_or_string}
1214 This option may be used to specify the port of the card terminal. A
1215 value of 0 refers to the first serial device; add 32768 to access USB
1216 devices. The default is 32768 (first USB device). PC/SC or CCID
1217 readers might need a string here; run the program in verbose mode to get
1218 a list of available readers. The default is then the first reader
1219 found.
1220 @end ifset
1221
1222 @item --display-charset @code{name}
1223 Set the name of the native character set. This is used to convert
1224 some informational strings like user IDs to the proper UTF-8 encoding.
1225 Note that this has nothing to do with the character set of data to be
1226 encrypted or signed; GnuPG does not recode user-supplied data. If
1227 this option is not used, the default character set is determined from
1228 the current locale. A verbosity level of 3 shows the chosen set.
1229 Valid values for @code{name} are:
1230
1231 @table @asis
1232
1233 @item iso-8859-1
1234 This is the Latin 1 set.
1235
1236 @item iso-8859-2
1237 The Latin 2 set.
1238
1239 @item iso-8859-15
1240 This is currently an alias for
1241 the Latin 1 set.
1242
1243 @item koi8-r
1244 The usual Russian set (rfc1489).
1245
1246 @item utf-8
1247 Bypass all translations and assume
1248 that the OS uses native UTF-8 encoding.
1249 @end table
1250
1251 @item --utf8-strings
1252 @itemx --no-utf8-strings
1253 Assume that command line arguments are given as UTF8 strings. The
1254 default (@option{--no-utf8-strings}) is to assume that arguments are
1255 encoded in the character set as specified by
1256 @option{--display-charset}. These options affect all following
1257 arguments. Both options may be used multiple times.
1258
1259 @ifset gpgone
1260 @anchor{option --options}
1261 @end ifset
1262 @item --options @code{file}
1263 Read options from @code{file} and do not try to read them from the
1264 default options file in the homedir (see @option{--homedir}). This
1265 option is ignored if used in an options file.
1266
1267 @item --no-options
1268 Shortcut for @option{--options /dev/null}. This option is detected
1269 before an attempt to open an option file.  Using this option will also
1270 prevent the creation of a @file{~/.gnupg} homedir.
1271
1272
1273
1274 @item -z @code{n}
1275 @itemx --compress-level @code{n}
1276 @itemx --bzip2-compress-level @code{n}
1277 Set compression level to @code{n} for the ZIP and ZLIB compression
1278 algorithms. The default is to use the default compression level of zlib
1279 (normally 6). @option{--bzip2-compress-level} sets the compression level
1280 for the BZIP2 compression algorithm (defaulting to 6 as well). This is a
1281 different option from @option{--compress-level} since BZIP2 uses a
1282 significant amount of memory for each additional compression level.
1283 @option{-z} sets both. A value of 0 for @code{n} disables compression.
1284
1285 @item --bzip2-decompress-lowmem
1286 Use a different decompression method for BZIP2 compressed files. This
1287 alternate method uses a bit more than half the memory, but also runs
1288 at half the speed. This is useful under extreme low memory
1289 circumstances when the file was originally compressed at a high
1290 @option{--bzip2-compress-level}.
1291
1292
1293 @item --mangle-dos-filenames
1294 @itemx --no-mangle-dos-filenames
1295 @opindex mangle-dos-filenames
1296 @opindex no-mangle-dos-filenames
1297 Older version of Windows cannot handle filenames with more than one
1298 dot. @option{--mangle-dos-filenames} causes GnuPG to replace (rather
1299 than add to) the extension of an output filename to avoid this
1300 problem. This option is off by default and has no effect on non-Windows
1301 platforms.
1302
1303 @item --ask-cert-level
1304 @itemx --no-ask-cert-level
1305 When making a key signature, prompt for a certification level. If this
1306 option is not specified, the certification level used is set via
1307 @option{--default-cert-level}. See @option{--default-cert-level} for
1308 information on the specific levels and how they are
1309 used. @option{--no-ask-cert-level} disables this option. This option
1310 defaults to no.
1311
1312 @item --default-cert-level @code{n}
1313 The default to use for the check level when signing a key.
1314
1315 0 means you make no particular claim as to how carefully you verified
1316 the key.
1317
1318 1 means you believe the key is owned by the person who claims to own
1319 it but you could not, or did not verify the key at all. This is
1320 useful for a "persona" verification, where you sign the key of a
1321 pseudonymous user.
1322
1323 2 means you did casual verification of the key. For example, this
1324 could mean that you verified that the key fingerprint and checked the
1325 user ID on the key against a photo ID.
1326
1327 3 means you did extensive verification of the key. For example, this
1328 could mean that you verified the key fingerprint with the owner of the
1329 key in person, and that you checked, by means of a hard to forge
1330 document with a photo ID (such as a passport) that the name of the key
1331 owner matches the name in the user ID on the key, and finally that you
1332 verified (by exchange of email) that the email address on the key
1333 belongs to the key owner.
1334
1335 Note that the examples given above for levels 2 and 3 are just that:
1336 examples. In the end, it is up to you to decide just what "casual"
1337 and "extensive" mean to you.
1338
1339 This option defaults to 0 (no particular claim).
1340
1341 @item --min-cert-level
1342 When building the trust database, treat any signatures with a
1343 certification level below this as invalid. Defaults to 2, which
1344 disregards level 1 signatures. Note that level 0 "no particular
1345 claim" signatures are always accepted.
1346
1347 @item --trusted-key @code{long key ID}
1348 Assume that the specified key (which must be given
1349 as a full 8 byte key ID) is as trustworthy as one of
1350 your own secret keys. This option is useful if you
1351 don't want to keep your secret keys (or one of them)
1352 online but still want to be able to check the validity of a given
1353 recipient's or signator's key.
1354
1355 @item --trust-model @code{pgp|classic|direct|always|auto}
1356 Set what trust model GnuPG should follow. The models are:
1357
1358 @table @asis
1359
1360 @item pgp
1361 This is the Web of Trust combined with trust signatures as used in PGP
1362 5.x and later. This is the default trust model when creating a new
1363 trust database.
1364
1365 @item classic
1366 This is the standard Web of Trust as used in PGP 2.x and earlier.
1367
1368 @item direct
1369 Key validity is set directly by the user and not calculated via the
1370 Web of Trust.
1371
1372 @item always
1373 Skip key validation and assume that used keys are always fully
1374 trusted. You generally won't use this unless you are using some
1375 external validation scheme. This option also suppresses the
1376 "[uncertain]" tag printed with signature checks when there is no
1377 evidence that the user ID is bound to the key.
1378
1379 @item auto
1380 Select the trust model depending on whatever the internal trust
1381 database says. This is the default model if such a database already
1382 exists.
1383 @end table
1384
1385 @item --auto-key-locate @code{parameters}
1386 @itemx --no-auto-key-locate
1387 GnuPG can automatically locate and retrieve keys as needed using this
1388 option. This happens when encrypting to an email address (in the
1389 "user@@example.com" form), and there are no user@@example.com keys on
1390 the local keyring.  This option takes any number of the following
1391 mechanisms, in the order they are to be tried:
1392
1393 @table @asis
1394
1395 @item cert
1396 Locate a key using DNS CERT, as specified in rfc4398.
1397
1398 @item pka
1399 Locate a key using DNS PKA.
1400
1401 @item ldap
1402 Using DNS Service Discovery, check the domain in question for any LDAP
1403 keyservers to use.  If this fails, attempt to locate the key using the
1404 PGP Universal method of checking @samp{ldap://keys.(thedomain)}.
1405
1406 @item keyserver
1407 Locate a key using whatever keyserver is defined using the
1408 @option{--keyserver} option.
1409
1410 @item keyserver-URL
1411 In addition, a keyserver URL as used in the @option{--keyserver} option
1412 may be used here to query that particular keyserver.
1413
1414 @item local
1415 Locate the key using the local keyrings.  This mechanism allows to
1416 select the order a local key lookup is done.  Thus using
1417 @samp{--auto-key-locate local} is identical to
1418 @option{--no-auto-key-locate}.
1419
1420 @item nodefault
1421 This flag disables the standard local key lookup, done before any of the
1422 mechanisms defined by the @option{--auto-key-locate} are tried.  The
1423 position of this mechanism in the list does not matter.  It is not
1424 required if @code{local} is also used.
1425
1426 @end table
1427
1428 @item --keyid-format @code{short|0xshort|long|0xlong}
1429 Select how to display key IDs. "short" is the traditional 8-character
1430 key ID. "long" is the more accurate (but less convenient)
1431 16-character key ID. Add an "0x" to either to include an "0x" at the
1432 beginning of the key ID, as in 0x99242560.
1433
1434 @item --keyserver @code{name}
1435 Use @code{name} as your keyserver. This is the server that
1436 @option{--recv-keys}, @option{--send-keys}, and @option{--search-keys}
1437 will communicate with to receive keys from, send keys to, and search for
1438 keys on. The format of the @code{name} is a URI:
1439 `scheme:[//]keyservername[:port]' The scheme is the type of keyserver:
1440 "hkp" for the HTTP (or compatible) keyservers, "ldap" for the LDAP
1441 keyservers, or "mailto" for the Graff email keyserver. Note that your
1442 particular installation of GnuPG may have other keyserver types
1443 available as well. Keyserver schemes are case-insensitive. After the
1444 keyserver name, optional keyserver configuration options may be
1445 provided. These are the same as the global @option{--keyserver-options}
1446 from below, but apply only to this particular keyserver.
1447
1448 Most keyservers synchronize with each other, so there is generally no
1449 need to send keys to more than one server. The keyserver
1450 @code{hkp://keys.gnupg.net} uses round robin DNS to give a different
1451 keyserver each time you use it.
1452
1453 @item --keyserver-options @code{name=value1 }
1454 This is a space or comma delimited string that gives options for the
1455 keyserver. Options can be prefixed with a `no-' to give the opposite
1456 meaning. Valid import-options or export-options may be used here as
1457 well to apply to importing (@option{--recv-key}) or exporting
1458 (@option{--send-key}) a key from a keyserver. While not all options
1459 are available for all keyserver types, some common options are:
1460
1461 @table @asis
1462
1463 @item include-revoked
1464 When searching for a key with @option{--search-keys}, include keys that
1465 are marked on the keyserver as revoked. Note that not all keyservers
1466 differentiate between revoked and unrevoked keys, and for such
1467 keyservers this option is meaningless. Note also that most keyservers do
1468 not have cryptographic verification of key revocations, and so turning
1469 this option off may result in skipping keys that are incorrectly marked
1470 as revoked.
1471
1472 @item include-disabled
1473 When searching for a key with @option{--search-keys}, include keys that
1474 are marked on the keyserver as disabled. Note that this option is not
1475 used with HKP keyservers.
1476
1477 @item auto-key-retrieve
1478 This option enables the automatic retrieving of keys from a keyserver
1479 when verifying signatures made by keys that are not on the local
1480 keyring.
1481
1482 Note that this option makes a "web bug" like behavior possible.
1483 Keyserver operators can see which keys you request, so by sending you
1484 a message signed by a brand new key (which you naturally will not have
1485 on your local keyring), the operator can tell both your IP address and
1486 the time when you verified the signature.
1487
1488 @item honor-keyserver-url
1489 When using @option{--refresh-keys}, if the key in question has a preferred
1490 keyserver URL, then use that preferred keyserver to refresh the key
1491 from. In addition, if auto-key-retrieve is set, and the signature
1492 being verified has a preferred keyserver URL, then use that preferred
1493 keyserver to fetch the key from. Defaults to yes.
1494
1495 @item honor-pka-record
1496 If auto-key-retrieve is set, and the signature being verified has a
1497 PKA record, then use the PKA information to fetch the key. Defaults
1498 to yes.
1499
1500 @item include-subkeys
1501 When receiving a key, include subkeys as potential targets. Note that
1502 this option is not used with HKP keyservers, as they do not support
1503 retrieving keys by subkey id.
1504
1505 @item use-temp-files
1506 On most Unix-like platforms, GnuPG communicates with the keyserver
1507 helper program via pipes, which is the most efficient method. This
1508 option forces GnuPG to use temporary files to communicate. On some
1509 platforms (such as Win32 and RISC OS), this option is always enabled.
1510
1511 @item keep-temp-files
1512 If using `use-temp-files', do not delete the temp files after using
1513 them. This option is useful to learn the keyserver communication
1514 protocol by reading the temporary files.
1515
1516 @item verbose
1517 Tell the keyserver helper program to be more verbose. This option can
1518 be repeated multiple times to increase the verbosity level.
1519
1520 @item timeout
1521 Tell the keyserver helper program how long (in seconds) to try and
1522 perform a keyserver action before giving up. Note that performing
1523 multiple actions at the same time uses this timeout value per action.
1524 For example, when retrieving multiple keys via @option{--recv-keys}, the
1525 timeout applies separately to each key retrieval, and not to the
1526 @option{--recv-keys} command as a whole. Defaults to 30 seconds.
1527
1528 @item http-proxy=@code{value}
1529 Set the proxy to use for HTTP and HKP keyservers.  This overrides the
1530 "http_proxy" environment variable, if any.
1531
1532 @item max-cert-size
1533 When retrieving a key via DNS CERT, only accept keys up to this size.
1534 Defaults to 16384 bytes.
1535
1536 @item debug
1537 Turn on debug output in the keyserver helper program.  Note that the
1538 details of debug output depends on which keyserver helper program is
1539 being used, and in turn, on any libraries that the keyserver helper
1540 program uses internally (libcurl, openldap, etc).
1541
1542 @item check-cert
1543 Enable certificate checking if the keyserver presents one (for hkps or
1544 ldaps).  Defaults to on.
1545
1546 @item ca-cert-file
1547 Provide a certificate store to override the system default.  Only
1548 necessary if check-cert is enabled, and the keyserver is using a
1549 certificate that is not present in a system default certificate list.
1550
1551 Note that depending on the SSL library that the keyserver helper is
1552 built with, this may actually be a directory or a file.
1553 @end table
1554
1555 @item --completes-needed @code{n}
1556 Number of completely trusted users to introduce a new
1557 key signer (defaults to 1).
1558
1559 @item --marginals-needed @code{n}
1560 Number of marginally trusted users to introduce a new
1561 key signer (defaults to 3)
1562
1563 @item --max-cert-depth @code{n}
1564 Maximum depth of a certification chain (default is 5).
1565
1566 @ifclear gpgtwoone
1567 @item --simple-sk-checksum
1568 Secret keys are integrity protected by using a SHA-1 checksum. This
1569 method is part of the upcoming enhanced OpenPGP specification but
1570 GnuPG already uses it as a countermeasure against certain attacks.
1571 Old applications don't understand this new format, so this option may
1572 be used to switch back to the old behaviour. Using this option bears
1573 a security risk. Note that using this option only takes effect when
1574 the secret key is encrypted - the simplest way to make this happen is
1575 to change the passphrase on the key (even changing it to the same
1576 value is acceptable).
1577 @end ifclear
1578
1579 @item --no-sig-cache
1580 Do not cache the verification status of key signatures.
1581 Caching gives a much better performance in key listings. However, if
1582 you suspect that your public keyring is not save against write
1583 modifications, you can use this option to disable the caching. It
1584 probably does not make sense to disable it because all kind of damage
1585 can be done if someone else has write access to your public keyring.
1586
1587 @item --no-sig-create-check
1588 GnuPG normally verifies each signature right after creation to protect
1589 against bugs and hardware malfunctions which could leak out bits from
1590 the secret key. This extra verification needs some time (about 115%
1591 for DSA keys), and so this option can be used to disable it.
1592 However, due to the fact that the signature creation needs manual
1593 interaction, this performance penalty does not matter in most settings.
1594
1595 @item --auto-check-trustdb
1596 @itemx --no-auto-check-trustdb
1597 If GnuPG feels that its information about the Web of Trust has to be
1598 updated, it automatically runs the @option{--check-trustdb} command
1599 internally.  This may be a time consuming
1600 process. @option{--no-auto-check-trustdb} disables this option.
1601
1602 @item --use-agent
1603 @itemx --no-use-agent
1604 @ifclear gpgone
1605 This is dummy option. @command{@gpgname} always requires the agent.
1606 @end ifclear
1607 @ifset gpgone
1608 Try to use the GnuPG-Agent.  With this option, GnuPG first tries to
1609 connect to the agent before it asks for a
1610 passphrase. @option{--no-use-agent} disables this option.
1611 @end ifset
1612
1613 @item --gpg-agent-info
1614 @ifclear gpgone
1615 This is dummy option. It has no effect when used with @command{gpg2}.
1616 @end ifclear
1617 @ifset gpgone
1618 Override the value of the environment variable
1619 @samp{GPG_AGENT_INFO}. This is only used when @option{--use-agent} has
1620 been given.  Given that this option is not anymore used by
1621 @command{gpg2}, it should be avoided if possible.
1622 @end ifset
1623
1624 @item --lock-once
1625 Lock the databases the first time a lock is requested
1626 and do not release the lock until the process
1627 terminates.
1628
1629 @item --lock-multiple
1630 Release the locks every time a lock is no longer
1631 needed. Use this to override a previous @option{--lock-once}
1632 from a config file.
1633
1634 @item --lock-never
1635 Disable locking entirely. This option should be used only in very
1636 special environments, where it can be assured that only one process
1637 is accessing those files. A bootable floppy with a stand-alone
1638 encryption system will probably use this. Improper usage of this
1639 option may lead to data and key corruption.
1640
1641 @item --exit-on-status-write-error
1642 This option will cause write errors on the status FD to immediately
1643 terminate the process. That should in fact be the default but it never
1644 worked this way and thus we need an option to enable this, so that the
1645 change won't break applications which close their end of a status fd
1646 connected pipe too early. Using this option along with
1647 @option{--enable-progress-filter} may be used to cleanly cancel long
1648 running gpg operations.
1649
1650 @item --limit-card-insert-tries @code{n}
1651 With @code{n} greater than 0 the number of prompts asking to insert a
1652 smartcard gets limited to N-1. Thus with a value of 1 gpg won't at
1653 all ask to insert a card if none has been inserted at startup. This
1654 option is useful in the configuration file in case an application does
1655 not know about the smartcard support and waits ad infinitum for an
1656 inserted card.
1657
1658 @item --no-random-seed-file
1659 GnuPG uses a file to store its internal random pool over invocations.
1660 This makes random generation faster; however sometimes write operations
1661 are not desired. This option can be used to achieve that with the cost of
1662 slower random generation.
1663
1664 @item --no-greeting
1665 Suppress the initial copyright message.
1666
1667 @item --no-secmem-warning
1668 Suppress the warning about "using insecure memory".
1669
1670 @item --no-permission-warning
1671 Suppress the warning about unsafe file and home directory (@option{--homedir})
1672 permissions. Note that the permission checks that GnuPG performs are
1673 not intended to be authoritative, but rather they simply warn about
1674 certain common permission problems. Do not assume that the lack of a
1675 warning means that your system is secure.
1676
1677 Note that the warning for unsafe @option{--homedir} permissions cannot be
1678 suppressed in the gpg.conf file, as this would allow an attacker to
1679 place an unsafe gpg.conf file in place, and use this file to suppress
1680 warnings about itself. The @option{--homedir} permissions warning may only be
1681 suppressed on the command line.
1682
1683 @item --no-mdc-warning
1684 Suppress the warning about missing MDC integrity protection.
1685
1686 @item --require-secmem
1687 @itemx --no-require-secmem
1688 Refuse to run if GnuPG cannot get secure memory. Defaults to no
1689 (i.e. run, but give a warning).
1690
1691
1692 @item --require-cross-certification
1693 @itemx --no-require-cross-certification
1694 When verifying a signature made from a subkey, ensure that the cross
1695 certification "back signature" on the subkey is present and valid.  This
1696 protects against a subtle attack against subkeys that can sign.
1697 Defaults to @option{--require-cross-certification} for
1698 @command{@gpgname}.
1699
1700 @item --expert
1701 @itemx --no-expert
1702 Allow the user to do certain nonsensical or "silly" things like
1703 signing an expired or revoked key, or certain potentially incompatible
1704 things like generating unusual key types. This also disables certain
1705 warning messages about potentially incompatible actions. As the name
1706 implies, this option is for experts only. If you don't fully
1707 understand the implications of what it allows you to do, leave this
1708 off. @option{--no-expert} disables this option.
1709
1710
1711
1712
1713 @end table
1714
1715
1716 @c *******************************************
1717 @c ********  KEY RELATED OPTIONS  ************
1718 @c *******************************************
1719 @node GPG Key related Options
1720 @subsection Key related options
1721
1722 @table @gnupgtabopt
1723
1724 @item --recipient @var{name}
1725 @itemx -r
1726 @opindex recipient
1727 Encrypt for user id @var{name}. If this option or
1728 @option{--hidden-recipient} is not specified, GnuPG asks for the user-id
1729 unless @option{--default-recipient} is given.
1730
1731 @item --hidden-recipient @var{name}
1732 @itemx -R
1733 @opindex hidden-recipient
1734 Encrypt for user ID @var{name}, but hide the key ID of this user's
1735 key. This option helps to hide the receiver of the message and is a
1736 limited countermeasure against traffic analysis. If this option or
1737 @option{--recipient} is not specified, GnuPG asks for the user ID unless
1738 @option{--default-recipient} is given.
1739
1740 @item --encrypt-to @code{name}
1741 Same as @option{--recipient} but this one is intended for use in the
1742 options file and may be used with your own user-id as an
1743 "encrypt-to-self". These keys are only used when there are other
1744 recipients given either by use of @option{--recipient} or by the asked
1745 user id.  No trust checking is performed for these user ids and even
1746 disabled keys can be used.
1747
1748 @item --hidden-encrypt-to @code{name}
1749 Same as @option{--hidden-recipient} but this one is intended for use in the
1750 options file and may be used with your own user-id as a hidden
1751 "encrypt-to-self". These keys are only used when there are other
1752 recipients given either by use of @option{--recipient} or by the asked user id.
1753 No trust checking is performed for these user ids and even disabled
1754 keys can be used.
1755
1756 @item --no-encrypt-to
1757 Disable the use of all @option{--encrypt-to} and
1758 @option{--hidden-encrypt-to} keys.
1759
1760 @item --group @code{name=value1 }
1761 Sets up a named group, which is similar to aliases in email programs.
1762 Any time the group name is a recipient (@option{-r} or
1763 @option{--recipient}), it will be expanded to the values
1764 specified. Multiple groups with the same name are automatically merged
1765 into a single group.
1766
1767 The values are @code{key IDs} or fingerprints, but any key description
1768 is accepted. Note that a value with spaces in it will be treated as
1769 two different values. Note also there is only one level of expansion
1770 --- you cannot make an group that points to another group. When used
1771 from the command line, it may be necessary to quote the argument to
1772 this option to prevent the shell from treating it as multiple
1773 arguments.
1774
1775 @item --ungroup @code{name}
1776 Remove a given entry from the @option{--group} list.
1777
1778 @item --no-groups
1779 Remove all entries from the @option{--group} list.
1780
1781 @item --local-user @var{name}
1782 @itemx -u
1783 @opindex local-user
1784 Use @var{name} as the key to sign with. Note that this option overrides
1785 @option{--default-key}.
1786
1787 @ifset gpgtwoone
1788 @item --try-secret-key @var{name}
1789 @opindex try-secret-key
1790 For hidden recipients GPG needs to know the keys to use for trial
1791 decryption.  The key set with @option{--default-key} is always tried
1792 first, but this is often not sufficient.  This option allows to set more
1793 keys to be used for trial decryption.  Although any valid user-id
1794 specification may be used for @var{name} it makes sense to use at least
1795 the long keyid to avoid ambiguities.  Note that gpg-agent might pop up a
1796 pinentry for a lot keys to do the trial decryption.  If you want to stop
1797 all further trial decryption you may use close-window button instead of
1798 the cancel button.
1799 @end ifset
1800
1801 @item --try-all-secrets
1802 @opindex try-all-secrets
1803 Don't look at the key ID as stored in the message but try all secret
1804 keys in turn to find the right decryption key. This option forces the
1805 behaviour as used by anonymous recipients (created by using
1806 @option{--throw-keyids} or @option{--hidden-recipient}) and might come
1807 handy in case where an encrypted message contains a bogus key ID.
1808
1809 @item --skip-hidden-recipients
1810 @itemx --no-skip-hidden-recipients
1811 @opindex skip-hidden-recipients
1812 @opindex no-skip-hidden-recipients
1813 During decryption skip all anonymous recipients.  This option helps in
1814 the case that people use the hidden recipients feature to hide there
1815 own encrypt-to key from others.  If oneself has many secret keys this
1816 may lead to a major annoyance because all keys are tried in turn to
1817 decrypt soemthing which was not really intended for it.  The drawback
1818 of this option is that it is currently not possible to decrypt a
1819 message which includes real anonymous recipients.
1820
1821
1822 @end table
1823
1824 @c *******************************************
1825 @c ********  INPUT AND OUTPUT  ***************
1826 @c *******************************************
1827 @node GPG Input and Output
1828 @subsection Input and Output
1829
1830 @table @gnupgtabopt
1831
1832 @item --armor
1833 @itemx -a
1834 @opindex armor
1835 Create ASCII armored output.  The default is to create the binary
1836 OpenPGP format.
1837
1838 @item --no-armor
1839 Assume the input data is not in ASCII armored format.
1840
1841 @item --output @var{file}
1842 @itemx -o @var{file}
1843 @opindex output
1844 Write output to @var{file}.
1845
1846 @item --max-output @code{n}
1847 @opindex max-output
1848 This option sets a limit on the number of bytes that will be generated
1849 when processing a file. Since OpenPGP supports various levels of
1850 compression, it is possible that the plaintext of a given message may be
1851 significantly larger than the original OpenPGP message. While GnuPG
1852 works properly with such messages, there is often a desire to set a
1853 maximum file size that will be generated before processing is forced to
1854 stop by the OS limits. Defaults to 0, which means "no limit".
1855
1856 @item --import-options @code{parameters}
1857 This is a space or comma delimited string that gives options for
1858 importing keys. Options can be prepended with a `no-' to give the
1859 opposite meaning. The options are:
1860
1861 @table @asis
1862
1863 @item import-local-sigs
1864 Allow importing key signatures marked as "local". This is not
1865 generally useful unless a shared keyring scheme is being used.
1866 Defaults to no.
1867
1868 @item repair-pks-subkey-bug
1869 During import, attempt to repair the damage caused by the PKS keyserver
1870 bug (pre version 0.9.6) that mangles keys with multiple subkeys. Note
1871 that this cannot completely repair the damaged key as some crucial data
1872 is removed by the keyserver, but it does at least give you back one
1873 subkey. Defaults to no for regular @option{--import} and to yes for
1874 keyserver @option{--recv-keys}.
1875
1876 @item merge-only
1877 During import, allow key updates to existing keys, but do not allow
1878 any new keys to be imported. Defaults to no.
1879
1880 @item import-clean
1881 After import, compact (remove all signatures except the
1882 self-signature) any user IDs from the new key that are not usable.
1883 Then, remove any signatures from the new key that are not usable.
1884 This includes signatures that were issued by keys that are not present
1885 on the keyring. This option is the same as running the @option{--edit-key}
1886 command "clean" after import. Defaults to no.
1887
1888 @item import-minimal
1889 Import the smallest key possible. This removes all signatures except
1890 the most recent self-signature on each user ID. This option is the
1891 same as running the @option{--edit-key} command "minimize" after import.
1892 Defaults to no.
1893 @end table
1894
1895 @item --export-options @code{parameters}
1896 This is a space or comma delimited string that gives options for
1897 exporting keys. Options can be prepended with a `no-' to give the
1898 opposite meaning. The options are:
1899
1900 @table @asis
1901
1902 @item export-local-sigs
1903 Allow exporting key signatures marked as "local". This is not
1904 generally useful unless a shared keyring scheme is being used.
1905 Defaults to no.
1906
1907 @item export-attributes
1908 Include attribute user IDs (photo IDs) while exporting. This is
1909 useful to export keys if they are going to be used by an OpenPGP
1910 program that does not accept attribute user IDs. Defaults to yes.
1911
1912 @item export-sensitive-revkeys
1913 Include designated revoker information that was marked as
1914 "sensitive". Defaults to no.
1915
1916 @c Since GnuPG 2.1 gpg-agent manages the secret key and thus the
1917 @c export-reset-subkey-passwd hack is not anymore justified.  Such use
1918 @c cases need to be implemented using a specialized secret key export
1919 @c tool.
1920 @ifclear gpgtwoone
1921 @item export-reset-subkey-passwd
1922 When using the @option{--export-secret-subkeys} command, this option resets
1923 the passphrases for all exported subkeys to empty. This is useful
1924 when the exported subkey is to be used on an unattended machine where
1925 a passphrase doesn't necessarily make sense. Defaults to no.
1926 @end ifclear
1927
1928 @item export-clean
1929 Compact (remove all signatures from) user IDs on the key being
1930 exported if the user IDs are not usable. Also, do not export any
1931 signatures that are not usable. This includes signatures that were
1932 issued by keys that are not present on the keyring. This option is
1933 the same as running the @option{--edit-key} command "clean" before export
1934 except that the local copy of the key is not modified. Defaults to
1935 no.
1936
1937 @item export-minimal
1938 Export the smallest key possible. This removes all signatures except the
1939 most recent self-signature on each user ID. This option is the same as
1940 running the @option{--edit-key} command "minimize" before export except
1941 that the local copy of the key is not modified. Defaults to no.
1942 @end table
1943
1944 @item --with-colons
1945 @opindex with-colons
1946 Print key listings delimited by colons. Note that the output will be
1947 encoded in UTF-8 regardless of any @option{--display-charset} setting. This
1948 format is useful when GnuPG is called from scripts and other programs
1949 as it is easily machine parsed. The details of this format are
1950 documented in the file @file{doc/DETAILS}, which is included in the GnuPG
1951 source distribution.
1952
1953 @item --fixed-list-mode
1954 @opindex fixed-list-mode
1955 Do not merge primary user ID and primary key in @option{--with-colon}
1956 listing mode and print all timestamps as seconds since 1970-01-01.
1957 @ifclear gpgone
1958 Since GnuPG 2.0.10, this mode is always used and thus this option is
1959 obsolete; it does not harm to use it though.
1960 @end ifclear
1961
1962 @item --with-fingerprint
1963 @opindex with-fingerprint
1964 Same as the command @option{--fingerprint} but changes only the format
1965 of the output and may be used together with another command.
1966
1967 @ifset gpgtwoone
1968 @item --with-keygrip
1969 @opindex with-keygrip
1970 Include the keygrip in the key listings.
1971 @end ifset
1972
1973 @end table
1974
1975 @c *******************************************
1976 @c ********  OPENPGP OPTIONS  ****************
1977 @c *******************************************
1978 @node OpenPGP Options
1979 @subsection OpenPGP protocol specific options.
1980
1981 @table @gnupgtabopt
1982
1983 @item -t, --textmode
1984 @itemx --no-textmode
1985 Treat input files as text and store them in the OpenPGP canonical text
1986 form with standard "CRLF" line endings. This also sets the necessary
1987 flags to inform the recipient that the encrypted or signed data is text
1988 and may need its line endings converted back to whatever the local
1989 system uses. This option is useful when communicating between two
1990 platforms that have different line ending conventions (UNIX-like to Mac,
1991 Mac to Windows, etc). @option{--no-textmode} disables this option, and
1992 is the default.
1993
1994 @ifset gpgone
1995 If @option{-t} (but not @option{--textmode}) is used together with
1996 armoring and signing, this enables clearsigned messages. This kludge is
1997 needed for command-line compatibility with command-line versions of PGP;
1998 normally you would use @option{--sign} or @option{--clearsign} to select
1999 the type of the signature.
2000 @end ifset
2001
2002 @item --force-v3-sigs
2003 @itemx --no-force-v3-sigs
2004 OpenPGP states that an implementation should generate v4 signatures
2005 but PGP versions 5 through 7 only recognize v4 signatures on key
2006 material. This option forces v3 signatures for signatures on data.
2007 Note that this option implies @option{--no-ask-sig-expire}, and unsets
2008 @option{--sig-policy-url}, @option{--sig-notation}, and
2009 @option{--sig-keyserver-url}, as these features cannot be used with v3
2010 signatures.  @option{--no-force-v3-sigs} disables this option.
2011 Defaults to no.
2012
2013 @item --force-v4-certs
2014 @itemx --no-force-v4-certs
2015 Always use v4 key signatures even on v3 keys. This option also
2016 changes the default hash algorithm for v3 RSA keys from MD5 to SHA-1.
2017 @option{--no-force-v4-certs} disables this option.
2018
2019 @item --force-mdc
2020 Force the use of encryption with a modification detection code. This
2021 is always used with the newer ciphers (those with a blocksize greater
2022 than 64 bits), or if all of the recipient keys indicate MDC support in
2023 their feature flags.
2024
2025 @item --disable-mdc
2026 Disable the use of the modification detection code. Note that by
2027 using this option, the encrypted message becomes vulnerable to a
2028 message modification attack.
2029
2030 @item --personal-cipher-preferences @code{string}
2031 Set the list of personal cipher preferences to @code{string}.  Use
2032 @command{@gpgname --version} to get a list of available algorithms,
2033 and use @code{none} to set no preference at all.  This allows the user
2034 to safely override the algorithm chosen by the recipient key
2035 preferences, as GPG will only select an algorithm that is usable by
2036 all recipients.  The most highly ranked cipher in this list is also
2037 used for the @option{--symmetric} encryption command.
2038
2039 @item --personal-digest-preferences @code{string}
2040 Set the list of personal digest preferences to @code{string}.  Use
2041 @command{@gpgname --version} to get a list of available algorithms,
2042 and use @code{none} to set no preference at all.  This allows the user
2043 to safely override the algorithm chosen by the recipient key
2044 preferences, as GPG will only select an algorithm that is usable by
2045 all recipients.  The most highly ranked digest algorithm in this list
2046 is also used when signing without encryption
2047 (e.g. @option{--clearsign} or @option{--sign}).
2048
2049 @item --personal-compress-preferences @code{string}
2050 Set the list of personal compression preferences to @code{string}.
2051 Use @command{@gpgname --version} to get a list of available
2052 algorithms, and use @code{none} to set no preference at all.  This
2053 allows the user to safely override the algorithm chosen by the
2054 recipient key preferences, as GPG will only select an algorithm that
2055 is usable by all recipients.  The most highly ranked compression
2056 algorithm in this list is also used when there are no recipient keys
2057 to consider (e.g. @option{--symmetric}).
2058
2059 @item --s2k-cipher-algo @code{name}
2060 Use @code{name} as the cipher algorithm used to protect secret keys.
2061 The default cipher is CAST5. This cipher is also used for
2062 conventional encryption if @option{--personal-cipher-preferences} and
2063 @option{--cipher-algo} is not given.
2064
2065 @item --s2k-digest-algo @code{name}
2066 Use @code{name} as the digest algorithm used to mangle the passphrases.
2067 The default algorithm is SHA-1.
2068
2069 @item --s2k-mode @code{n}
2070 Selects how passphrases are mangled. If @code{n} is 0 a plain
2071 passphrase (which is not recommended) will be used, a 1 adds a salt to
2072 the passphrase and a 3 (the default) iterates the whole process a
2073 number of times (see --s2k-count).  Unless @option{--rfc1991} is used,
2074 this mode is also used for conventional encryption.
2075
2076 @item --s2k-count @code{n}
2077 Specify how many times the passphrase mangling is repeated.  This
2078 value may range between 1024 and 65011712 inclusive, and the default
2079 is 65536.  Note that not all values in the 1024-65011712 range are
2080 legal and if an illegal value is selected, GnuPG will round up to the
2081 nearest legal value.  This option is only meaningful if
2082 @option{--s2k-mode} is 3.
2083
2084
2085 @end table
2086
2087 @c ***************************
2088 @c ******* Compliance ********
2089 @c ***************************
2090 @subsection Compliance options
2091
2092 These options control what GnuPG is compliant to. Only one of these
2093 options may be active at a time. Note that the default setting of
2094 this is nearly always the correct one. See the INTEROPERABILITY WITH
2095 OTHER OPENPGP PROGRAMS section below before using one of these
2096 options.
2097
2098 @table @gnupgtabopt
2099
2100 @item --gnupg
2101 @opindex gnupg
2102 Use standard GnuPG behavior. This is essentially OpenPGP behavior
2103 (see @option{--openpgp}), but with some additional workarounds for common
2104 compatibility problems in different versions of PGP. This is the
2105 default option, so it is not generally needed, but it may be useful to
2106 override a different compliance option in the gpg.conf file.
2107
2108 @item --openpgp
2109 @opindex openpgp
2110 Reset all packet, cipher and digest options to strict OpenPGP
2111 behavior. Use this option to reset all previous options like
2112 @option{--s2k-*}, @option{--cipher-algo}, @option{--digest-algo} and
2113 @option{--compress-algo} to OpenPGP compliant values. All PGP
2114 workarounds are disabled.
2115
2116 @item --rfc4880
2117 @opindex rfc4880
2118 Reset all packet, cipher and digest options to strict RFC-4880
2119 behavior. Note that this is currently the same thing as
2120 @option{--openpgp}.
2121
2122 @item --rfc2440
2123 @opindex rfc2440
2124 Reset all packet, cipher and digest options to strict RFC-2440
2125 behavior.
2126
2127 @item --rfc1991
2128 @opindex rfc1991
2129 Try to be more RFC-1991 (PGP 2.x) compliant.
2130
2131 @item --pgp2
2132 @opindex pgp2
2133 Set up all options to be as PGP 2.x compliant as possible, and warn if
2134 an action is taken (e.g. encrypting to a non-RSA key) that will create
2135 a message that PGP 2.x will not be able to handle. Note that `PGP
2136 2.x' here means `MIT PGP 2.6.2'. There are other versions of PGP 2.x
2137 available, but the MIT release is a good common baseline.
2138
2139 This option implies @option{--rfc1991 --disable-mdc
2140 --no-force-v4-certs --escape-from-lines --force-v3-sigs --cipher-algo
2141 IDEA --digest-algo MD5 --compress-algo ZIP}. It also disables
2142 @option{--textmode} when encrypting.
2143
2144 @item --pgp6
2145 @opindex pgp6
2146 Set up all options to be as PGP 6 compliant as possible. This
2147 restricts you to the ciphers IDEA (if the IDEA plugin is installed),
2148 3DES, and CAST5, the hashes MD5, SHA1 and RIPEMD160, and the
2149 compression algorithms none and ZIP. This also disables
2150 --throw-keyids, and making signatures with signing subkeys as PGP 6
2151 does not understand signatures made by signing subkeys.
2152
2153 This option implies @option{--disable-mdc --escape-from-lines
2154 --force-v3-sigs}.
2155
2156 @item --pgp7
2157 @opindex pgp7
2158 Set up all options to be as PGP 7 compliant as possible. This is
2159 identical to @option{--pgp6} except that MDCs are not disabled, and the
2160 list of allowable ciphers is expanded to add AES128, AES192, AES256, and
2161 TWOFISH.
2162
2163 @item --pgp8
2164 @opindex pgp8
2165 Set up all options to be as PGP 8 compliant as possible. PGP 8 is a lot
2166 closer to the OpenPGP standard than previous versions of PGP, so all
2167 this does is disable @option{--throw-keyids} and set
2168 @option{--escape-from-lines}.  All algorithms are allowed except for the
2169 SHA224, SHA384, and SHA512 digests.
2170
2171 @end table
2172
2173
2174 @c *******************************************
2175 @c ********  ESOTERIC OPTIONS  ***************
2176 @c *******************************************
2177 @node GPG Esoteric Options
2178 @subsection Doing things one usually doesn't want to do.
2179
2180 @table @gnupgtabopt
2181
2182 @item -n
2183 @itemx --dry-run
2184 @opindex dry-run
2185 Don't make any changes (this is not completely implemented).
2186
2187 @item --list-only
2188 Changes the behaviour of some commands. This is like @option{--dry-run} but
2189 different in some cases. The semantic of this command may be extended in
2190 the future. Currently it only skips the actual decryption pass and
2191 therefore enables a fast listing of the encryption keys.
2192
2193 @item -i
2194 @itemx --interactive
2195 @opindex interactive
2196 Prompt before overwriting any files.
2197
2198 @item --debug-level @var{level}
2199 @opindex debug-level
2200 Select the debug level for investigating problems. @var{level} may be
2201 a numeric value or by a keyword:
2202
2203 @table @code
2204 @item none
2205 No debugging at all.  A value of less than 1 may be used instead of
2206 the keyword.
2207 @item basic
2208 Some basic debug messages.  A value between 1 and 2 may be used
2209 instead of the keyword.
2210 @item advanced
2211 More verbose debug messages.  A value between 3 and 5 may be used
2212 instead of the keyword.
2213 @item expert
2214 Even more detailed messages.  A value between 6 and 8 may be used
2215 instead of the keyword.
2216 @item guru
2217 All of the debug messages you can get. A value greater than 8 may be
2218 used instead of the keyword.  The creation of hash tracing files is
2219 only enabled if the keyword is used.
2220 @end table
2221
2222 How these messages are mapped to the actual debugging flags is not
2223 specified and may change with newer releases of this program. They are
2224 however carefully selected to best aid in debugging.
2225
2226 @item --debug @var{flags}
2227 @opindex debug
2228 Set debugging flags. All flags are or-ed and @var{flags} may
2229 be given in C syntax (e.g. 0x0042).
2230
2231 @item --debug-all
2232 Set all useful debugging flags.
2233
2234 @ifset gpgone
2235 @item --debug-ccid-driver
2236 Enable debug output from the included CCID driver for smartcards.
2237 Note that this option is only available on some system.
2238 @end ifset
2239
2240 @item --faked-system-time @var{epoch}
2241 @opindex faked-system-time
2242 This option is only useful for testing; it sets the system time back or
2243 forth to @var{epoch} which is the number of seconds elapsed since the year
2244 1970.  Alternatively @var{epoch} may be given as a full ISO time string
2245 (e.g. "20070924T154812").
2246
2247 @item --enable-progress-filter
2248 Enable certain PROGRESS status outputs. This option allows frontends
2249 to display a progress indicator while gpg is processing larger files.
2250 There is a slight performance overhead using it.
2251
2252 @item --status-fd @code{n}
2253 Write special status strings to the file descriptor @code{n}.
2254 See the file DETAILS in the documentation for a listing of them.
2255
2256 @item --status-file @code{file}
2257 Same as @option{--status-fd}, except the status data is written to file
2258 @code{file}.
2259
2260 @item --logger-fd @code{n}
2261 Write log output to file descriptor @code{n} and not to STDERR.
2262
2263 @item --log-file @code{file}
2264 @itemx --logger-file @code{file}
2265 Same as @option{--logger-fd}, except the logger data is written to file
2266 @code{file}.  Note that @option{--log-file} is only implemented for
2267 GnuPG-2.
2268
2269 @item --attribute-fd @code{n}
2270 Write attribute subpackets to the file descriptor @code{n}. This is most
2271 useful for use with @option{--status-fd}, since the status messages are
2272 needed to separate out the various subpackets from the stream delivered
2273 to the file descriptor.
2274
2275 @item --attribute-file @code{file}
2276 Same as @option{--attribute-fd}, except the attribute data is written to
2277 file @code{file}.
2278
2279 @item --comment @code{string}
2280 @itemx --no-comments
2281 Use @code{string} as a comment string in clear text signatures and ASCII
2282 armored messages or keys (see @option{--armor}). The default behavior is
2283 not to use a comment string. @option{--comment} may be repeated multiple
2284 times to get multiple comment strings. @option{--no-comments} removes
2285 all comments.  It is a good idea to keep the length of a single comment
2286 below 60 characters to avoid problems with mail programs wrapping such
2287 lines.  Note that comment lines, like all other header lines, are not
2288 protected by the signature.
2289
2290 @item --emit-version
2291 @itemx --no-emit-version
2292 Force inclusion of the version string in ASCII armored output.
2293 @option{--no-emit-version} disables this option.
2294
2295 @item --sig-notation @code{name=value}
2296 @itemx --cert-notation @code{name=value}
2297 @itemx -N, --set-notation @code{name=value}
2298 Put the name value pair into the signature as notation data.
2299 @code{name} must consist only of printable characters or spaces, and
2300 must contain a '@@' character in the form keyname@@domain.example.com
2301 (substituting the appropriate keyname and domain name, of course).  This
2302 is to help prevent pollution of the IETF reserved notation
2303 namespace. The @option{--expert} flag overrides the '@@'
2304 check. @code{value} may be any printable string; it will be encoded in
2305 UTF8, so you should check that your @option{--display-charset} is set
2306 correctly. If you prefix @code{name} with an exclamation mark (!), the
2307 notation data will be flagged as critical
2308 (rfc2440:5.2.3.15). @option{--sig-notation} sets a notation for data
2309 signatures. @option{--cert-notation} sets a notation for key signatures
2310 (certifications). @option{--set-notation} sets both.
2311
2312 There are special codes that may be used in notation names. "%k" will
2313 be expanded into the key ID of the key being signed, "%K" into the
2314 long key ID of the key being signed, "%f" into the fingerprint of the
2315 key being signed, "%s" into the key ID of the key making the
2316 signature, "%S" into the long key ID of the key making the signature,
2317 "%g" into the fingerprint of the key making the signature (which might
2318 be a subkey), "%p" into the fingerprint of the primary key of the key
2319 making the signature, "%c" into the signature count from the OpenPGP
2320 smartcard, and "%%" results in a single "%". %k, %K, and %f are only
2321 meaningful when making a key signature (certification), and %c is only
2322 meaningful when using the OpenPGP smartcard.
2323
2324 @item --sig-policy-url @code{string}
2325 @itemx --cert-policy-url @code{string}
2326 @itemx --set-policy-url @code{string}
2327 Use @code{string} as a Policy URL for signatures (rfc2440:5.2.3.19).  If
2328 you prefix it with an exclamation mark (!), the policy URL packet will
2329 be flagged as critical. @option{--sig-policy-url} sets a policy url for
2330 data signatures. @option{--cert-policy-url} sets a policy url for key
2331 signatures (certifications). @option{--set-policy-url} sets both.
2332
2333 The same %-expandos used for notation data are available here as well.
2334
2335 @item --sig-keyserver-url @code{string}
2336 Use @code{string} as a preferred keyserver URL for data signatures. If
2337 you prefix it with an exclamation mark (!), the keyserver URL packet
2338 will be flagged as critical.
2339
2340 The same %-expandos used for notation data are available here as well.
2341
2342 @item --set-filename @code{string}
2343 Use @code{string} as the filename which is stored inside messages.
2344 This overrides the default, which is to use the actual filename of the
2345 file being encrypted.
2346
2347 @item --for-your-eyes-only
2348 @itemx --no-for-your-eyes-only
2349 Set the `for your eyes only' flag in the message. This causes GnuPG to
2350 refuse to save the file unless the @option{--output} option is given,
2351 and PGP to use a "secure viewer" with a claimed Tempest-resistant font
2352 to display the message. This option overrides @option{--set-filename}.
2353 @option{--no-for-your-eyes-only} disables this option.
2354
2355 @item --use-embedded-filename
2356 @itemx --no-use-embedded-filename
2357 Try to create a file with a name as embedded in the data. This can be
2358 a dangerous option as it allows to overwrite files. Defaults to no.
2359
2360 @item --cipher-algo @code{name}
2361 Use @code{name} as cipher algorithm. Running the program with the
2362 command @option{--version} yields a list of supported algorithms. If
2363 this is not used the cipher algorithm is selected from the preferences
2364 stored with the key. In general, you do not want to use this option as
2365 it allows you to violate the OpenPGP standard.
2366 @option{--personal-cipher-preferences} is the safe way to accomplish the
2367 same thing.
2368
2369 @item --digest-algo @code{name}
2370 Use @code{name} as the message digest algorithm. Running the program
2371 with the command @option{--version} yields a list of supported algorithms. In
2372 general, you do not want to use this option as it allows you to
2373 violate the OpenPGP standard. @option{--personal-digest-preferences} is the
2374 safe way to accomplish the same thing.
2375
2376 @item --compress-algo @code{name}
2377 Use compression algorithm @code{name}. "zlib" is RFC-1950 ZLIB
2378 compression. "zip" is RFC-1951 ZIP compression which is used by PGP.
2379 "bzip2" is a more modern compression scheme that can compress some
2380 things better than zip or zlib, but at the cost of more memory used
2381 during compression and decompression. "uncompressed" or "none"
2382 disables compression. If this option is not used, the default
2383 behavior is to examine the recipient key preferences to see which
2384 algorithms the recipient supports. If all else fails, ZIP is used for
2385 maximum compatibility.
2386
2387 ZLIB may give better compression results than ZIP, as the compression
2388 window size is not limited to 8k. BZIP2 may give even better
2389 compression results than that, but will use a significantly larger
2390 amount of memory while compressing and decompressing. This may be
2391 significant in low memory situations. Note, however, that PGP (all
2392 versions) only supports ZIP compression. Using any algorithm other
2393 than ZIP or "none" will make the message unreadable with PGP. In
2394 general, you do not want to use this option as it allows you to
2395 violate the OpenPGP standard. @option{--personal-compress-preferences} is the
2396 safe way to accomplish the same thing.
2397
2398 @item --cert-digest-algo @code{name}
2399 Use @code{name} as the message digest algorithm used when signing a
2400 key. Running the program with the command @option{--version} yields a
2401 list of supported algorithms. Be aware that if you choose an algorithm
2402 that GnuPG supports but other OpenPGP implementations do not, then some
2403 users will not be able to use the key signatures you make, or quite
2404 possibly your entire key.
2405
2406 @item --disable-cipher-algo @code{name}
2407 Never allow the use of @code{name} as cipher algorithm.
2408 The given name will not be checked so that a later loaded algorithm
2409 will still get disabled.
2410
2411 @item --disable-pubkey-algo @code{name}
2412 Never allow the use of @code{name} as public key algorithm.
2413 The given name will not be checked so that a later loaded algorithm
2414 will still get disabled.
2415
2416 @item --throw-keyids
2417 @itemx --no-throw-keyids
2418 Do not put the recipient key IDs into encrypted messages. This helps to
2419 hide the receivers of the message and is a limited countermeasure
2420 against traffic analysis.@footnote{Using a little social engineering
2421 anyone who is able to decrypt the message can check whether one of the
2422 other recipients is the one he suspects.}  On the receiving side, it may
2423 slow down the decryption process because all available secret keys must
2424 be tried.  @option{--no-throw-keyids} disables this option. This option
2425 is essentially the same as using @option{--hidden-recipient} for all
2426 recipients.
2427
2428 @item --not-dash-escaped
2429 This option changes the behavior of cleartext signatures
2430 so that they can be used for patch files. You should not
2431 send such an armored file via email because all spaces
2432 and line endings are hashed too. You can not use this
2433 option for data which has 5 dashes at the beginning of a
2434 line, patch files don't have this. A special armor header
2435 line tells GnuPG about this cleartext signature option.
2436
2437 @item --escape-from-lines
2438 @itemx --no-escape-from-lines
2439 Because some mailers change lines starting with "From " to ">From " it
2440 is good to handle such lines in a special way when creating cleartext
2441 signatures to prevent the mail system from breaking the signature. Note
2442 that all other PGP versions do it this way too.  Enabled by
2443 default. @option{--no-escape-from-lines} disables this option.
2444
2445 @item --passphrase-repeat @code{n}
2446 Specify how many times @command{@gpgname} will request a new
2447 passphrase be repeated.  This is useful for helping memorize a
2448 passphrase.  Defaults to 1 repetition.
2449
2450 @item --passphrase-fd @code{n}
2451 Read the passphrase from file descriptor @code{n}. Only the first line
2452 will be read from file descriptor @code{n}. If you use 0 for @code{n},
2453 the passphrase will be read from STDIN. This can only be used if only
2454 one passphrase is supplied.
2455 @ifclear gpgone
2456 Note that this passphrase is only used if the option @option{--batch}
2457 has also been given.  This is different from @command{gpg}.
2458 @end ifclear
2459
2460 @item --passphrase-file @code{file}
2461 Read the passphrase from file @code{file}. Only the first line will
2462 be read from file @code{file}. This can only be used if only one
2463 passphrase is supplied. Obviously, a passphrase stored in a file is
2464 of questionable security if other users can read this file. Don't use
2465 this option if you can avoid it.
2466 @ifclear gpgone
2467 Note that this passphrase is only used if the option @option{--batch}
2468 has also been given.  This is different from @command{gpg}.
2469 @end ifclear
2470
2471 @item --passphrase @code{string}
2472 Use @code{string} as the passphrase. This can only be used if only one
2473 passphrase is supplied. Obviously, this is of very questionable
2474 security on a multi-user system. Don't use this option if you can
2475 avoid it.
2476 @ifclear gpgone
2477 Note that this passphrase is only used if the option @option{--batch}
2478 has also been given.  This is different from @command{gpg}.
2479 @end ifclear
2480
2481 @item --command-fd @code{n}
2482 This is a replacement for the deprecated shared-memory IPC mode.
2483 If this option is enabled, user input on questions is not expected
2484 from the TTY but from the given file descriptor. It should be used
2485 together with @option{--status-fd}. See the file doc/DETAILS in the source
2486 distribution for details on how to use it.
2487
2488 @item --command-file @code{file}
2489 Same as @option{--command-fd}, except the commands are read out of file
2490 @code{file}
2491
2492 @item --allow-non-selfsigned-uid
2493 @itemx --no-allow-non-selfsigned-uid
2494 Allow the import and use of keys with user IDs which are not
2495 self-signed. This is not recommended, as a non self-signed user ID is
2496 trivial to forge. @option{--no-allow-non-selfsigned-uid} disables.
2497
2498 @item --allow-freeform-uid
2499 Disable all checks on the form of the user ID while generating a new
2500 one. This option should only be used in very special environments as
2501 it does not ensure the de-facto standard format of user IDs.
2502
2503 @item --ignore-time-conflict
2504 GnuPG normally checks that the timestamps associated with keys and
2505 signatures have plausible values. However, sometimes a signature
2506 seems to be older than the key due to clock problems. This option
2507 makes these checks just a warning. See also @option{--ignore-valid-from} for
2508 timestamp issues on subkeys.
2509
2510 @item --ignore-valid-from
2511 GnuPG normally does not select and use subkeys created in the future.
2512 This option allows the use of such keys and thus exhibits the
2513 pre-1.0.7 behaviour. You should not use this option unless there
2514 is some clock problem. See also @option{--ignore-time-conflict} for timestamp
2515 issues with signatures.
2516
2517 @item --ignore-crc-error
2518 The ASCII armor used by OpenPGP is protected by a CRC checksum against
2519 transmission errors. Occasionally the CRC gets mangled somewhere on
2520 the transmission channel but the actual content (which is protected by
2521 the OpenPGP protocol anyway) is still okay. This option allows GnuPG
2522 to ignore CRC errors.
2523
2524 @item --ignore-mdc-error
2525 This option changes a MDC integrity protection failure into a warning.
2526 This can be useful if a message is partially corrupt, but it is
2527 necessary to get as much data as possible out of the corrupt message.
2528 However, be aware that a MDC protection failure may also mean that the
2529 message was tampered with intentionally by an attacker.
2530
2531 @item --no-default-keyring
2532 Do not add the default keyrings to the list of keyrings. Note that
2533 GnuPG will not operate without any keyrings, so if you use this option
2534 and do not provide alternate keyrings via @option{--keyring} or
2535 @option{--secret-keyring}, then GnuPG will still use the default public or
2536 secret keyrings.
2537
2538 @item --skip-verify
2539 Skip the signature verification step. This may be
2540 used to make the decryption faster if the signature
2541 verification is not needed.
2542
2543 @item --with-key-data
2544 Print key listings delimited by colons (like @option{--with-colons}) and
2545 print the public key data.
2546
2547 @item --fast-list-mode
2548 Changes the output of the list commands to work faster; this is achieved
2549 by leaving some parts empty. Some applications don't need the user ID
2550 and the trust information given in the listings. By using this options
2551 they can get a faster listing. The exact behaviour of this option may
2552 change in future versions.  If you are missing some information, don't
2553 use this option.
2554
2555 @item --no-literal
2556 This is not for normal use. Use the source to see for what it might be useful.
2557
2558 @item --set-filesize
2559 This is not for normal use. Use the source to see for what it might be useful.
2560
2561 @item --show-session-key
2562 Display the session key used for one message. See
2563 @option{--override-session-key} for the counterpart of this option.
2564
2565 We think that Key Escrow is a Bad Thing; however the user should have
2566 the freedom to decide whether to go to prison or to reveal the content
2567 of one specific message without compromising all messages ever
2568 encrypted for one secret key. DON'T USE IT UNLESS YOU ARE REALLY
2569 FORCED TO DO SO.
2570
2571 @item --override-session-key @code{string}
2572 Don't use the public key but the session key @code{string}. The format
2573 of this string is the same as the one printed by
2574 @option{--show-session-key}. This option is normally not used but comes
2575 handy in case someone forces you to reveal the content of an encrypted
2576 message; using this option you can do this without handing out the
2577 secret key.
2578
2579 @item --ask-sig-expire
2580 @itemx --no-ask-sig-expire
2581 When making a data signature, prompt for an expiration time. If this
2582 option is not specified, the expiration time set via
2583 @option{--default-sig-expire} is used. @option{--no-ask-sig-expire}
2584 disables this option.
2585
2586 @item --default-sig-expire
2587 The default expiration time to use for signature expiration. Valid
2588 values are "0" for no expiration, a number followed by the letter d
2589 (for days), w (for weeks), m (for months), or y (for years) (for
2590 example "2m" for two months, or "5y" for five years), or an absolute
2591 date in the form YYYY-MM-DD. Defaults to "0".
2592
2593 @item --ask-cert-expire
2594 @itemx --no-ask-cert-expire
2595 When making a key signature, prompt for an expiration time. If this
2596 option is not specified, the expiration time set via
2597 @option{--default-cert-expire} is used. @option{--no-ask-cert-expire}
2598 disables this option.
2599
2600 @item --default-cert-expire
2601 The default expiration time to use for key signature expiration.
2602 Valid values are "0" for no expiration, a number followed by the
2603 letter d (for days), w (for weeks), m (for months), or y (for years)
2604 (for example "2m" for two months, or "5y" for five years), or an
2605 absolute date in the form YYYY-MM-DD. Defaults to "0".
2606
2607 @item --allow-secret-key-import
2608 This is an obsolete option and is not used anywhere.
2609
2610 @item --allow-multiple-messages
2611 @item --no-allow-multiple-messages
2612 Allow processing of multiple OpenPGP messages contained in a single file
2613 or stream.  Some programs that call GPG are not prepared to deal with
2614 multiple messages being processed together, so this option defaults to
2615 no.  Note that versions of GPG prior to 1.4.7 always allowed multiple
2616 messages.
2617
2618 Warning: Do not use this option unless you need it as a temporary
2619 workaround!
2620
2621
2622 @item --enable-special-filenames
2623 This options enables a mode in which filenames of the form
2624 @file{-&n}, where n is a non-negative decimal number,
2625 refer to the file descriptor n and not to a file with that name.
2626
2627 @item --no-expensive-trust-checks
2628 Experimental use only.
2629
2630 @item --preserve-permissions
2631 Don't change the permissions of a secret keyring back to user
2632 read/write only. Use this option only if you really know what you are doing.
2633
2634 @item --default-preference-list @code{string}
2635 @opindex default-preference-list
2636 Set the list of default preferences to @code{string}. This preference
2637 list is used for new keys and becomes the default for "setpref" in the
2638 edit menu.
2639
2640 @item --default-keyserver-url @code{name}
2641 @opindex default-keyserver-url
2642 Set the default keyserver URL to @code{name}. This keyserver will be
2643 used as the keyserver URL when writing a new self-signature on a key,
2644 which includes key generation and changing preferences.
2645
2646 @item --list-config
2647 @opindex list-config
2648 Display various internal configuration parameters of GnuPG. This option
2649 is intended for external programs that call GnuPG to perform tasks, and
2650 is thus not generally useful. See the file @file{doc/DETAILS} in the
2651 source distribution for the details of which configuration items may be
2652 listed. @option{--list-config} is only usable with
2653 @option{--with-colons} set.
2654
2655 @item --gpgconf-list
2656 @opindex gpgconf-list
2657 This command is similar to @option{--list-config} but in general only
2658 internally used by the @command{gpgconf} tool.
2659
2660 @item --gpgconf-test
2661 @opindex gpgconf-test
2662 This is more or less dummy action.  However it parses the configuration
2663 file and returns with failure if the configuration file would prevent
2664 @command{gpg} from startup.  Thus it may be used to run a syntax check
2665 on the configuration file.
2666
2667 @end table
2668
2669 @c *******************************
2670 @c ******* Deprecated ************
2671 @c *******************************
2672 @subsection Deprecated options
2673
2674 @table @gnupgtabopt
2675
2676 @ifset gpgone
2677 @item --load-extension @code{name}
2678 Load an extension module. If @code{name} does not contain a slash it is
2679 searched for in the directory configured when GnuPG was built
2680 (generally "/usr/local/lib/gnupg"). Extensions are not generally
2681 useful anymore, and the use of this option is deprecated.
2682 @end ifset
2683
2684 @item --show-photos
2685 @itemx --no-show-photos
2686 Causes @option{--list-keys}, @option{--list-sigs},
2687 @option{--list-public-keys}, @option{--list-secret-keys}, and verifying
2688 a signature to also display the photo ID attached to the key, if
2689 any. See also @option{--photo-viewer}. These options are deprecated. Use
2690 @option{--list-options [no-]show-photos} and/or @option{--verify-options
2691 [no-]show-photos} instead.
2692
2693 @item --show-keyring
2694 Display the keyring name at the head of key listings to show which
2695 keyring a given key resides on. This option is deprecated: use
2696 @option{--list-options [no-]show-keyring} instead.
2697
2698 @ifset gpgone
2699 @item --ctapi-driver @code{file}
2700 Use @code{file} to access the smartcard reader. The current default
2701 is `libtowitoko.so'. Note that the use of this interface is
2702 deprecated; it may be removed in future releases.
2703 @end ifset
2704
2705 @item --always-trust
2706 Identical to @option{--trust-model always}. This option is deprecated.
2707
2708 @item --show-notation
2709 @itemx --no-show-notation
2710 Show signature notations in the @option{--list-sigs} or @option{--check-sigs} listings
2711 as well as when verifying a signature with a notation in it. These
2712 options are deprecated. Use @option{--list-options [no-]show-notation}
2713 and/or @option{--verify-options [no-]show-notation} instead.
2714
2715 @item --show-policy-url
2716 @itemx --no-show-policy-url
2717 Show policy URLs in the @option{--list-sigs} or @option{--check-sigs}
2718 listings as well as when verifying a signature with a policy URL in
2719 it. These options are deprecated. Use @option{--list-options
2720 [no-]show-policy-url} and/or @option{--verify-options
2721 [no-]show-policy-url} instead.
2722
2723
2724 @end table
2725
2726
2727 @c *******************************************
2728 @c ***************            ****************
2729 @c ***************   FILES    ****************
2730 @c ***************            ****************
2731 @c *******************************************
2732 @mansect files
2733 @node GPG Configuration
2734 @section Configuration files
2735
2736 There are a few configuration files to control certain aspects of
2737 @command{@gpgname}'s operation. Unless noted, they are expected in the
2738 current home directory (@pxref{option --homedir}).
2739
2740 @table @file
2741
2742 @item gpg.conf
2743 @cindex gpg.conf
2744 This is the standard configuration file read by @command{@gpgname} on
2745 startup.  It may contain any valid long option; the leading two dashes
2746 may not be entered and the option may not be abbreviated.  This default
2747 name may be changed on the command line (@pxref{option --options}).
2748 You should backup this file.
2749
2750 @end table
2751
2752 @c man:.RE
2753 Note that on larger installations, it is useful to put predefined files
2754 into the directory @file{/etc/skel/.gnupg/} so that newly created users
2755 start up with a working configuration.
2756 @ifclear gpgone
2757 For existing users the a small
2758 helper script is provided to create these files (@pxref{addgnupghome}).
2759 @end ifclear
2760
2761 For internal purposes @command{@gpgname} creates and maintains a few other
2762 files; They all live in in the current home directory (@pxref{option
2763 --homedir}).  Only the @command{@gpgname} may modify these files.
2764
2765
2766 @table @file
2767 @item ~/.gnupg/secring.gpg
2768 The secret keyring.  You should backup this file.
2769
2770 @item ~/.gnupg/secring.gpg.lock
2771 The lock file for the secret keyring.
2772
2773 @item ~/.gnupg/pubring.gpg
2774 The public keyring.  You should backup this file.
2775
2776 @item ~/.gnupg/pubring.gpg.lock
2777 The lock file for the public keyring.
2778
2779 @item ~/.gnupg/trustdb.gpg
2780 The trust database.  There is no need to backup this file; it is better
2781 to backup the ownertrust values (@pxref{option --export-ownertrust}).
2782
2783 @item ~/.gnupg/trustdb.gpg.lock
2784 The lock file for the trust database.
2785
2786 @item ~/.gnupg/random_seed
2787 A file used to preserve the state of the internal random pool.
2788
2789 @item /usr[/local]/share/gnupg/options.skel
2790 The skeleton options file.
2791
2792 @item /usr[/local]/lib/gnupg/
2793 Default location for extensions.
2794
2795 @end table
2796
2797 @c man:.RE
2798 Operation is further controlled by a few environment variables:
2799
2800 @table @asis
2801
2802 @item HOME
2803 Used to locate the default home directory.
2804
2805 @item GNUPGHOME
2806 If set directory used instead of "~/.gnupg".
2807
2808 @item GPG_AGENT_INFO
2809 Used to locate the gpg-agent.
2810 @ifset gpgone
2811 This is only honored when @option{--use-agent} is set.
2812 @end ifset
2813 The value consists of 3 colon delimited fields: The first is the path
2814 to the Unix Domain Socket, the second the PID of the gpg-agent and the
2815 protocol version which should be set to 1. When starting the gpg-agent
2816 as described in its documentation, this variable is set to the correct
2817 value. The option @option{--gpg-agent-info} can be used to override it.
2818
2819 @item PINENTRY_USER_DATA
2820 This value is passed via gpg-agent to pinentry.  It is useful to convey
2821 extra information to a custom pinentry.
2822
2823 @item COLUMNS
2824 @itemx LINES
2825 Used to size some displays to the full size of the screen.
2826
2827
2828 @item LANGUAGE
2829 Apart from its use by GNU, it is used in the W32 version to override the
2830 language selection done through the Registry.  If used and set to a
2831 valid and available language name (@var{langid}), the file with the
2832 translation is loaded from
2833 @code{@var{gpgdir}/gnupg.nls/@var{langid}.mo}.  Here @var{gpgdir} is the
2834 directory out of which the gpg binary has been loaded.  If it can't be
2835 loaded the Registry is tried and as last resort the native Windows
2836 locale system is used.
2837
2838 @end table
2839
2840
2841 @c *******************************************
2842 @c ***************            ****************
2843 @c ***************  EXAMPLES  ****************
2844 @c ***************            ****************
2845 @c *******************************************
2846 @mansect examples
2847 @node GPG Examples
2848 @section Examples
2849
2850 @table @asis
2851
2852 @item gpg -se -r @code{Bob} @code{file}
2853 sign and encrypt for user Bob
2854
2855 @item gpg --clearsign @code{file}
2856 make a clear text signature
2857
2858 @item gpg -sb @code{file}
2859 make a detached signature
2860
2861 @item gpg -u 0x12345678 -sb @code{file}
2862 make a detached signature with the key 0x12345678
2863
2864 @item gpg --list-keys @code{user_ID}
2865 show keys
2866
2867 @item gpg --fingerprint @code{user_ID}
2868 show fingerprint
2869
2870 @item gpg --verify @code{pgpfile}
2871 @itemx gpg --verify @code{sigfile}
2872 Verify the signature of the file but do not output the data. The
2873 second form is used for detached signatures, where @code{sigfile}
2874 is the detached signature (either ASCII armored or binary) and
2875 are the signed data; if this is not given, the name of
2876 the file holding the signed data is constructed by cutting off the
2877 extension (".asc" or ".sig") of @code{sigfile} or by asking the
2878 user for the filename.
2879 @end table
2880
2881
2882 @c *******************************************
2883 @c ***************            ****************
2884 @c ***************  USER ID   ****************
2885 @c ***************            ****************
2886 @c *******************************************
2887 @mansect how to specify a user id
2888 @ifset isman
2889 @include specify-user-id.texi
2890 @end ifset
2891
2892 @mansect return value
2893 @chapheading RETURN VALUE
2894
2895 The program returns 0 if everything was fine, 1 if at least
2896 a signature was bad, and other error codes for fatal errors.
2897
2898 @mansect warnings
2899 @chapheading WARNINGS
2900
2901 Use a *good* password for your user account and a *good* passphrase
2902 to protect your secret key. This passphrase is the weakest part of the
2903 whole system. Programs to do dictionary attacks on your secret keyring
2904 are very easy to write and so you should protect your "~/.gnupg/"
2905 directory very well.
2906
2907 Keep in mind that, if this program is used over a network (telnet), it
2908 is *very* easy to spy out your passphrase!
2909
2910 If you are going to verify detached signatures, make sure that the
2911 program knows about it; either give both filenames on the command line
2912 or use @samp{-} to specify STDIN.
2913
2914 @mansect interoperability
2915 @chapheading INTEROPERABILITY WITH OTHER OPENPGP PROGRAMS
2916
2917 GnuPG tries to be a very flexible implementation of the OpenPGP
2918 standard. In particular, GnuPG implements many of the optional parts
2919 of the standard, such as the SHA-512 hash, and the ZLIB and BZIP2
2920 compression algorithms. It is important to be aware that not all
2921 OpenPGP programs implement these optional algorithms and that by
2922 forcing their use via the @option{--cipher-algo},
2923 @option{--digest-algo}, @option{--cert-digest-algo}, or
2924 @option{--compress-algo} options in GnuPG, it is possible to create a
2925 perfectly valid OpenPGP message, but one that cannot be read by the
2926 intended recipient.
2927
2928 There are dozens of variations of OpenPGP programs available, and each
2929 supports a slightly different subset of these optional algorithms.
2930 For example, until recently, no (unhacked) version of PGP supported
2931 the BLOWFISH cipher algorithm. A message using BLOWFISH simply could
2932 not be read by a PGP user. By default, GnuPG uses the standard
2933 OpenPGP preferences system that will always do the right thing and
2934 create messages that are usable by all recipients, regardless of which
2935 OpenPGP program they use. Only override this safe default if you
2936 really know what you are doing.
2937
2938 If you absolutely must override the safe default, or if the preferences
2939 on a given key are invalid for some reason, you are far better off using
2940 the @option{--pgp6}, @option{--pgp7}, or @option{--pgp8} options. These
2941 options are safe as they do not force any particular algorithms in
2942 violation of OpenPGP, but rather reduce the available algorithms to a
2943 "PGP-safe" list.
2944
2945 @mansect bugs
2946 @chapheading BUGS
2947
2948 On older systems this program should be installed as setuid(root). This
2949 is necessary to lock memory pages. Locking memory pages prevents the
2950 operating system from writing memory pages (which may contain
2951 passphrases or other sensitive material) to disk. If you get no
2952 warning message about insecure memory your operating system supports
2953 locking without being root. The program drops root privileges as soon
2954 as locked memory is allocated.
2955
2956 Note also that some systems (especially laptops) have the ability to
2957 ``suspend to disk'' (also known as ``safe sleep'' or ``hibernate'').
2958 This writes all memory to disk before going into a low power or even
2959 powered off mode.  Unless measures are taken in the operating system
2960 to protect the saved memory, passphrases or other sensitive material
2961 may be recoverable from it later.
2962
2963 Before you report a bug you should first search the mailing list
2964 archives for similar problems and second check whether such a bug has
2965 already been reported to our bug tracker at http://bugs.gnupg.org .
2966
2967 @c *******************************************
2968 @c ***************              **************
2969 @c ***************  UNATTENDED  **************
2970 @c ***************              **************
2971 @c *******************************************
2972 @manpause
2973 @node Unattended Usage of GPG
2974 @section Unattended Usage
2975
2976 @command{gpg} is often used as a backend engine by other software.  To help
2977 with this a machine interface has been defined to have an unambiguous
2978 way to do this.  The options @option{--status-fd} and @option{--batch}
2979 are almost always required for this.
2980
2981 @menu
2982 * Unattended GPG key generation::  Unattended key generation
2983 @end menu
2984
2985
2986 @node Unattended GPG key generation,,,Unattended Usage of GPG
2987 @section Unattended key generation
2988
2989 The command @option{--gen-key} may be used along with the option
2990 @option{--batch} for unattended key generation.  The parameters are
2991 either read from stdin or given as a file on the command line.
2992 The format of the parameter file is as follows:
2993
2994 @itemize @bullet
2995 @item Text only, line length is limited to about 1000 characters.
2996 @item UTF-8 encoding must be used to specify non-ASCII characters.
2997 @item Empty lines are ignored.
2998 @item Leading and trailing while space is ignored.
2999 @item A hash sign as the first non white space character indicates
3000 a comment line.
3001 @item Control statements are indicated by a leading percent sign, the
3002 arguments are separated by white space from the keyword.
3003 @item Parameters are specified by a keyword, followed by a colon.  Arguments
3004 are separated by white space.
3005 @item
3006 The first parameter must be @samp{Key-Type}; control statements may be
3007 placed anywhere.
3008 @item
3009 The order of the parameters does not matter except for @samp{Key-Type}
3010 which must be the first parameter.  The parameters are only used for
3011 the generated keyblock (primary and subkeys); parameters from previous
3012 sets are not used.  Some syntactically checks may be performed.
3013 @item
3014 Key generation takes place when either the end of the parameter file
3015 is reached, the next @samp{Key-Type} parameter is encountered or at the
3016 control statement @samp{%commit} is encountered.
3017 @end itemize
3018
3019 @noindent
3020 Control statements:
3021
3022 @table @asis
3023
3024 @item %echo @var{text}
3025 Print @var{text} as diagnostic.
3026
3027 @item %dry-run
3028 Suppress actual key generation (useful for syntax checking).
3029
3030 @item %commit
3031 Perform the key generation.  Note that an implicit commit is done at
3032 the next @asis{Key-Type} parameter.
3033
3034 @item %pubring @var{filename}
3035 @itemx %secring @var{filename}
3036 Do not write the key to the default or commandline given keyring but
3037 to @var{filename}.  This must be given before the first commit to take
3038 place, duplicate specification of the same filename is ignored, the
3039 last filename before a commit is used.  The filename is used until a
3040 new filename is used (at commit points) and all keys are written to
3041 that file. If a new filename is given, this file is created (and
3042 overwrites an existing one).  For gnuPG versions prior to 2.1, both
3043 control statements must be given. For GnuPG 2.1 and later
3044 @samp{%secring} is a no-op.
3045
3046 @item %ask-passphrase
3047 @itemx %no-ask-passphrase
3048 Enable (or disable) a mode where the command @option{passphrase} is
3049 ignored and instead the usual passphrase dialog is used.  This does
3050 not make sense for batch key generation; however the unattended key
3051 generation feature is also used by GUIs and this feature relinquishes
3052 the GUI from implementing its own passphrase entry code.  These are
3053 global control statements and affect all future key genrations.
3054
3055 @item %no-protection
3056 Since GnuPG version 2.1 it is not anymore possible to specify a
3057 passphrase for unattended key generation.  The passphrase command is
3058 simply ignored and @samp{%ask-passpharse} is thus implicitly enabled.
3059 Using this option allows the creation of keys without any passphrase
3060 protection.  This option is mainly intended for regression tests.
3061
3062 @item %transient-key
3063 If given the keys are created using a faster and a somewhat less
3064 secure random number generator.  This option may be used for keys
3065 which are only used for a short time and do not require full
3066 cryptographic strength.  It takes only effect if used together with
3067 the control statement @samp{%no-protection}.
3068
3069 @end table
3070
3071 @noindent
3072 General Parameters:
3073
3074 @table @asis
3075
3076 @item Key-Type: @var{algo}
3077 Starts a new parameter block by giving the type of the primary
3078 key. The algorithm must be capable of signing.  This is a required
3079 parameter.  @var{algo} may either be an OpenPGP algorithm number or a
3080 string with the algorithm name.  The special value @samp{default} may
3081 be used for @var{algo} to create the default key type; in this case a
3082 @samp{Key-Usage} shall not be given and @samp{default} also be used
3083 for @samp{Subkey-Type}.
3084
3085 @item Key-Length: @var{nbits}
3086 The requested length of the generated key in bits.  The default is
3087 returned by running the command @samp{gpg2 --gpgconf-list}.
3088
3089 @item Key-Grip: @var{hexstring}
3090 This is optional and used to generate a CSR or certificatet for an
3091 already existing key.  Key-Length will be ignored when given.
3092
3093 @item Key-Usage: @var{usage-list}
3094 Space or comma delimited list of key usages.  Allowed values are
3095 @samp{encrypt}, @samp{sign}, and @samp{auth}.  This is used to
3096 generate the key flags.  Please make sure that the algorithm is
3097 capable of this usage.  Note that OpenPGP requires that all primary
3098 keys are capable of certification, so no matter what usage is given
3099 here, the @samp{cert} flag will be on.  If no @samp{Key-Usage} is
3100 specified and the @samp{Key-Type} is not @samp{default}, all allowed
3101 usages for that particular algorithm are used; if it is not given but
3102 @samp{default} is used the usage will be @samp{sign}.
3103
3104 @item Subkey-Type: @var{algo}
3105 This generates a secondary key (subkey).  Currently only one subkey
3106 can be handled.  See also @samp{Key-Type} above.
3107
3108 @item Subkey-Length: @var{nbits}
3109 Length of the secondary key (subkey) in bits.  The default is returned
3110 by running the command @samp{gpg2 --gpgconf-list}".
3111
3112 @item Subkey-Usage: @var{usage-list}
3113 Key usage lists for a subkey; similar to @samp{Key-Usage}.
3114
3115 @item Passphrase: @var{string}
3116 If you want to specify a passphrase for the secret key,
3117 enter it here.  Default is not to use any passphrase.
3118
3119 @item Name-Real: @var{name}
3120 @itemx Name-Comment: @var{comment}
3121 @itemx Name-Email: @var{email}
3122 The three parts of a user name.  Remember to use UTF-8 encoding here.
3123 If you don't give any of them, no user ID is created.
3124
3125 @item Expire-Date: @var{iso-date}|(@var{number}[d|w|m|y])
3126 Set the expiration date for the key (and the subkey).  It may either
3127 be entered in ISO date format (2000-08-15) or as number of days,
3128 weeks, month or years.  The special notation "seconds=N" is also
3129 allowed to directly give an Epoch value. Without a letter days are
3130 assumed.  Note that there is no check done on the overflow of the type
3131 used by OpenPGP for timestamps.  Thus you better make sure that the
3132 given value make sense.  Although OpenPGP works with time intervals,
3133 GnuPG uses an absolute value internally and thus the last year we can
3134 represent is 2105.
3135
3136 @item  Ceation-Date: @var{iso-date}
3137 Set the creation date of the key as stored in the key information and
3138 which is also part of the fingerprint calculation.  Either a date like
3139 "1986-04-26" or a full timestamp like "19860426T042640" may be used.
3140 The time is considered to be UTC.  If it is not given the current time
3141 is used.
3142
3143 @item Preferences: @var{string}
3144 Set the cipher, hash, and compression preference values for this key.
3145 This expects the same type of string as the sub-command @samp{setpref}
3146 in the @option{--edit-key} menu.
3147
3148 @item  Revoker: @var{algo}:@var{fpr} [sensitive]
3149 Add a designated revoker to the generated key.  Algo is the public key
3150 algorithm of the designated revoker (i.e. RSA=1, DSA=17, etc.)
3151 @var{fpr} is the fingerprint of the designated revoker.  The optional
3152 @samp{sensitive} flag marks the designated revoker as sensitive
3153 information.  Only v4 keys may be designated revokers.
3154
3155 @item Keyserver: @var{string}
3156 This is an optional parameter that specifies the preferred keyserver
3157 URL for the key.
3158
3159 @item Handle: @var{string}
3160 This is an optional parameter only used with the status lines
3161 KEY_CREATED and KEY_NOT_CREATED.  @var{string} may be up to 100
3162 characters and should not contain spaces.  It is useful for batch key
3163 generation to associate a key parameter block with a status line.
3164
3165 @end table
3166
3167 @noindent
3168 Here is an example on how to create a key:
3169 @smallexample
3170 $ cat >foo <<EOF
3171      %echo Generating a basic OpenPGP key
3172      Key-Type: DSA
3173      Key-Length: 1024
3174      Subkey-Type: ELG-E
3175      Subkey-Length: 1024
3176      Name-Real: Joe Tester
3177      Name-Comment: with stupid passphrase
3178      Name-Email: joe@@foo.bar
3179      Expire-Date: 0
3180      Passphrase: abc
3181      %pubring foo.pub
3182      %secring foo.sec
3183      # Do a commit here, so that we can later print "done" :-)
3184      %commit
3185      %echo done
3186 EOF
3187 $ gpg2 --batch --gen-key foo
3188  [...]
3189 $ gpg2 --no-default-keyring --secret-keyring ./foo.sec \
3190        --keyring ./foo.pub --list-secret-keys
3191 /home/wk/work/gnupg-stable/scratch/foo.sec
3192 ------------------------------------------
3193 sec  1024D/915A878D 2000-03-09 Joe Tester (with stupid passphrase) <joe@@foo.bar>
3194 ssb  1024g/8F70E2C0 2000-03-09
3195 @end smallexample
3196
3197
3198 @noindent
3199 If you want to create a key with the default algorithms you would use
3200 these parameters:
3201 @smallexample
3202      %echo Generating a default key
3203      Key-Type: default
3204      Subkey-Type: default
3205      Name-Real: Joe Tester
3206      Name-Comment: with stupid passphrase
3207      Name-Email: joe@@foo.bar
3208      Expire-Date: 0
3209      Passphrase: abc
3210      %pubring foo.pub
3211      %secring foo.sec
3212      # Do a commit here, so that we can later print "done" :-)
3213      %commit
3214      %echo done
3215 @end smallexample
3216
3217
3218
3219
3220 @mansect see also
3221 @ifset isman
3222 @command{gpgv}(1),
3223 @ifclear gpgone
3224 @command{gpgsm}(1),
3225 @command{gpg-agent}(1)
3226 @end ifclear
3227 @end ifset
3228 @include see-also-note.texi