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