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