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