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