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