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