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