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