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