More changes on the way to remove secring.gpg.
[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. Selected keys or user ids are indicated by an asterisk. The trust
849 value is displayed with the primary key: the first is the assigned owner
850 trust and the second is the calculated trust value. Letters are used for
851 the values:
852 @c man:.RE
853
854 @table @asis
855
856 @item -
857 No ownertrust assigned / not yet calculated.
858
859 @item e
860 Trust
861 calculation has failed; probably due to an expired key.
862
863 @item q
864 Not enough information for calculation.
865
866 @item n
867 Never trust this key.
868
869 @item m
870 Marginally trusted.
871
872 @item f
873 Fully trusted.
874
875 @item u
876 Ultimately trusted.
877 @end table
878 @c ******** End Edit-key Options **********
879
880 @item --sign-key @code{name}
881 @opindex sign-key
882 Signs a public key with your secret key. This is a shortcut version of
883 the subcommand "sign" from @option{--edit}.
884
885 @item --lsign-key @code{name}
886 @opindex lsign-key
887 Signs a public key with your secret key but marks it as
888 non-exportable. This is a shortcut version of the subcommand "lsign"
889 from @option{--edit-key}.
890
891 @ifclear gpgone
892 @item --passwd @var{user_id}
893 @opindex passwd
894 Change the passphrase of the secret key belonging to the certificate
895 specified as @var{user_id}.  This is a shortcut for the sub-command
896 @code{passwd} of the edit key menu.
897 @end ifclear
898
899 @end table
900
901
902 @c *******************************************
903 @c ***************            ****************
904 @c ***************  OPTIONS   ****************
905 @c ***************            ****************
906 @c *******************************************
907 @mansect options
908 @node GPG Options
909 @section Option Summary
910
911 @command{@gpgname} features a bunch of options to control the exact
912 behaviour and to change the default configuration.
913
914 @menu
915 * GPG Configuration Options::   How to change the configuration.
916 * GPG Key related Options::     Key related options.
917 * GPG Input and Output::        Input and Output.
918 * OpenPGP Options::             OpenPGP protocol specific options.
919 * GPG Esoteric Options::        Doing things one usually don't want to do.
920 @end menu
921
922 Long options can be put in an options file (default
923 "~/.gnupg/gpg.conf"). Short option names will not work - for example,
924 "armor" is a valid option for the options file, while "a" is not. Do not
925 write the 2 dashes, but simply the name of the option and any required
926 arguments. Lines with a hash ('#') as the first non-white-space
927 character are ignored. Commands may be put in this file too, but that is
928 not generally useful as the command will execute automatically with
929 every execution of gpg.
930
931 Please remember that option parsing stops as soon as a non-option is
932 encountered, you can explicitly stop parsing by using the special option
933 @option{--}.
934
935 @c *******************************************
936 @c ********  CONFIGURATION OPTIONS  **********
937 @c *******************************************
938 @node GPG Configuration Options
939 @subsection How to change the configuration
940
941 These options are used to change the configuration and are usually found
942 in the option file.
943
944 @table @gnupgtabopt
945
946 @item --default-key @var{name}
947 @opindex default-key
948 Use @var{name} as the default key to sign with. If this option is not
949 used, the default key is the first key found in the secret keyring.
950 Note that @option{-u} or @option{--local-user} overrides this option.
951
952 @item --default-recipient @var{name}
953 @opindex default-recipient
954 Use @var{name} as default recipient if option @option{--recipient} is
955 not used and don't ask if this is a valid one. @var{name} must be
956 non-empty.
957
958 @item --default-recipient-self
959 @opindex default-recipient-self
960 Use the default key as default recipient if option @option{--recipient} is not
961 used and don't ask if this is a valid one. The default key is the first
962 one from the secret keyring or the one set with @option{--default-key}.
963
964 @item --no-default-recipient
965 @opindex no-default-recipient
966 Reset @option{--default-recipient} and @option{--default-recipient-self}.
967
968 @item -v, --verbose
969 @opindex verbose
970 Give more information during processing. If used
971 twice, the input data is listed in detail.
972
973 @item --no-verbose
974 @opindex no-verbose
975 Reset verbose level to 0.
976
977 @item -q, --quiet
978 @opindex quiet
979 Try to be as quiet as possible.
980
981 @item --batch
982 @itemx --no-batch
983 @opindex batch
984 @opindex no-batch
985 Use batch mode.  Never ask, do not allow interactive commands.
986 @option{--no-batch} disables this option.  Note that even with a
987 filename given on the command line, gpg might still need to read from
988 STDIN (in particular if gpg figures that the input is a
989 detached signature and no data file has been specified).  Thus if you
990 do not want to feed data via STDIN, you should connect STDIN to
991 @file{/dev/null}.
992
993 @item --no-tty
994 @opindex no-tty
995 Make sure that the TTY (terminal) is never used for any output.
996 This option is needed in some cases because GnuPG sometimes prints
997 warnings to the TTY even if @option{--batch} is used.
998
999 @item --yes
1000 @opindex yes
1001 Assume "yes" on most questions.
1002
1003 @item --no
1004 @opindex no
1005 Assume "no" on most questions.
1006
1007
1008 @item --list-options @code{parameters}
1009 @opindex list-options
1010 This is a space or comma delimited string that gives options used when
1011 listing keys and signatures (that is, @option{--list-keys},
1012 @option{--list-sigs}, @option{--list-public-keys},
1013 @option{--list-secret-keys}, and the @option{--edit-key} functions).
1014 Options can be prepended with a @option{no-} (after the two dashes) to
1015 give the opposite meaning.  The options are:
1016
1017 @table @asis
1018
1019 @item show-photos
1020 @opindex list-options:show-photos
1021 Causes @option{--list-keys}, @option{--list-sigs},
1022 @option{--list-public-keys}, and @option{--list-secret-keys} to display
1023 any photo IDs attached to the key.  Defaults to no. See also
1024 @option{--photo-viewer}.
1025
1026 @item show-policy-urls
1027 @opindex list-options:show-policy-urls
1028 Show policy URLs in the @option{--list-sigs} or @option{--check-sigs}
1029 listings.  Defaults to no.
1030
1031 @item show-notations
1032 @itemx show-std-notations
1033 @itemx show-user-notations
1034 @opindex list-options:show-notations
1035 @opindex list-options:show-std-notations
1036 @opindex list-options:show-user-notations
1037 Show all, IETF standard, or user-defined signature notations in the
1038 @option{--list-sigs} or @option{--check-sigs} listings. Defaults to no.
1039
1040 @item show-keyserver-urls
1041
1042 Show any preferred keyserver URL in the @option{--list-sigs} or
1043 @option{--check-sigs} listings. Defaults to no.
1044
1045 @item show-uid-validity
1046 Display the calculated validity of user IDs during key listings.
1047 Defaults to no.
1048
1049 @item show-unusable-uids
1050 Show revoked and expired user IDs in key listings. Defaults to no.
1051
1052 @item show-unusable-subkeys
1053 Show revoked and expired subkeys in key listings. Defaults to no.
1054
1055 @item show-keyring
1056 Display the keyring name at the head of key listings to show which
1057 keyring a given key resides on. Defaults to no.
1058
1059 @item show-sig-expire
1060 Show signature expiration dates (if any) during @option{--list-sigs} or
1061 @option{--check-sigs} listings. Defaults to no.
1062
1063 @item show-sig-subpackets
1064 Include signature subpackets in the key listing. This option can take an
1065 optional argument list of the subpackets to list. If no argument is
1066 passed, list all subpackets. Defaults to no. This option is only
1067 meaningful when using @option{--with-colons} along with
1068 @option{--list-sigs} or @option{--check-sigs}.
1069 @end table
1070
1071 @item --verify-options @code{parameters}
1072 This is a space or comma delimited string that gives options used when
1073 verifying signatures. Options can be prepended with a `no-' to give
1074 the opposite meaning. The options are:
1075
1076 @table @asis
1077
1078 @item show-photos
1079 Display any photo IDs present on the key that issued the signature.
1080 Defaults to no. See also @option{--photo-viewer}.
1081
1082 @item show-policy-urls
1083 Show policy URLs in the signature being verified. Defaults to no.
1084
1085 @item show-notations
1086 @itemx show-std-notations
1087 @itemx show-user-notations
1088 Show all, IETF standard, or user-defined signature notations in the
1089 signature being verified. Defaults to IETF standard.
1090
1091 @item show-keyserver-urls
1092 Show any preferred keyserver URL in the signature being verified.
1093 Defaults to no.
1094
1095 @item show-uid-validity
1096 Display the calculated validity of the user IDs on the key that issued
1097 the signature. Defaults to no.
1098
1099 @item show-unusable-uids
1100 Show revoked and expired user IDs during signature verification.
1101 Defaults to no.
1102
1103 @item show-primary-uid-only
1104 Show only the primary user ID during signature verification.  That is
1105 all the AKA lines as well as photo Ids are not shown with the signature
1106 verification status.
1107
1108 @item pka-lookups
1109 Enable PKA lookups to verify sender addresses. Note that PKA is based
1110 on DNS, and so enabling this option may disclose information on when
1111 and what signatures are verified or to whom data is encrypted. This
1112 is similar to the "web bug" described for the auto-key-retrieve
1113 feature.
1114
1115 @item pka-trust-increase
1116 Raise the trust in a signature to full if the signature passes PKA
1117 validation. This option is only meaningful if pka-lookups is set.
1118 @end table
1119
1120 @item --enable-dsa2
1121 @itemx --disable-dsa2
1122 Enable hash truncation for all DSA keys even for old DSA Keys up to
1123 1024 bit.  This is also the default with @option{--openpgp}.  Note
1124 that older versions of GnuPG also required this flag to allow the
1125 generation of DSA larger than 1024 bit.
1126
1127 @item --photo-viewer @code{string}
1128 This is the command line that should be run to view a photo ID. "%i"
1129 will be expanded to a filename containing the photo. "%I" does the
1130 same, except the file will not be deleted once the viewer exits.
1131 Other flags are "%k" for the key ID, "%K" for the long key ID, "%f"
1132 for the key fingerprint, "%t" for the extension of the image type
1133 (e.g. "jpg"), "%T" for the MIME type of the image (e.g. "image/jpeg"),
1134 and "%%" for an actual percent sign. If neither %i or %I are present,
1135 then the photo will be supplied to the viewer on standard input.
1136
1137 The default viewer is "xloadimage -fork -quiet -title 'KeyID 0x%k'
1138 STDIN". Note that if your image viewer program is not secure, then
1139 executing it from GnuPG does not make it secure.
1140
1141 @item --exec-path @code{string}
1142 Sets a list of directories to search for photo viewers and keyserver
1143 helpers. If not provided, keyserver helpers use the compiled-in
1144 default directory, and photo viewers use the $PATH environment
1145 variable.
1146 Note, that on W32 system this value is ignored when searching for
1147 keyserver helpers.
1148
1149 @item --keyring @code{file}
1150 Add @code{file} to the current list of keyrings. If @code{file} begins
1151 with a tilde and a slash, these are replaced by the $HOME directory. If
1152 the filename does not contain a slash, it is assumed to be in the GnuPG
1153 home directory ("~/.gnupg" if @option{--homedir} or $GNUPGHOME is not
1154 used).
1155
1156 Note that this adds a keyring to the current list. If the intent is to
1157 use the specified keyring alone, use @option{--keyring} along with
1158 @option{--no-default-keyring}.
1159
1160 @item --secret-keyring @code{file}
1161 Same as @option{--keyring} but for the secret keyrings.
1162
1163 @item --primary-keyring @code{file}
1164 Designate @code{file} as the primary public keyring. This means that
1165 newly imported keys (via @option{--import} or keyserver
1166 @option{--recv-from}) will go to this keyring.
1167
1168 @item --trustdb-name @code{file}
1169 Use @code{file} instead of the default trustdb. If @code{file} begins
1170 with a tilde and a slash, these are replaced by the $HOME directory. If
1171 the filename does not contain a slash, it is assumed to be in the GnuPG
1172 home directory (@file{~/.gnupg} if @option{--homedir} or $GNUPGHOME is
1173 not used).
1174
1175 @ifset gpgone
1176 @anchor{option --homedir}
1177 @end ifset
1178 @include opt-homedir.texi
1179
1180
1181 @ifset gpgone
1182 @item --pcsc-driver @code{file}
1183 Use @code{file} to access the smartcard reader. The current default is
1184 `libpcsclite.so.1' for GLIBC based systems,
1185 `/System/Library/Frameworks/PCSC.framework/PCSC' for MAC OS X,
1186 `winscard.dll' for Windows and `libpcsclite.so' for other systems.
1187 @end ifset
1188
1189 @ifset gpgone
1190 @item --disable-ccid
1191 Disable the integrated support for CCID compliant readers. This
1192 allows to fall back to one of the other drivers even if the internal
1193 CCID driver can handle the reader. Note, that CCID support is only
1194 available if libusb was available at build time.
1195 @end ifset
1196
1197 @ifset gpgone
1198 @item --reader-port @code{number_or_string}
1199 This option may be used to specify the port of the card terminal. A
1200 value of 0 refers to the first serial device; add 32768 to access USB
1201 devices. The default is 32768 (first USB device). PC/SC or CCID
1202 readers might need a string here; run the program in verbose mode to get
1203 a list of available readers. The default is then the first reader
1204 found.
1205 @end ifset
1206
1207 @item --display-charset @code{name}
1208 Set the name of the native character set. This is used to convert
1209 some informational strings like user IDs to the proper UTF-8 encoding.
1210 Note that this has nothing to do with the character set of data to be
1211 encrypted or signed; GnuPG does not recode user-supplied data. If
1212 this option is not used, the default character set is determined from
1213 the current locale. A verbosity level of 3 shows the chosen set.
1214 Valid values for @code{name} are:
1215
1216 @table @asis
1217
1218 @item iso-8859-1
1219 This is the Latin 1 set.
1220
1221 @item iso-8859-2
1222 The Latin 2 set.
1223
1224 @item iso-8859-15
1225 This is currently an alias for
1226 the Latin 1 set.
1227
1228 @item koi8-r
1229 The usual Russian set (rfc1489).
1230
1231 @item utf-8
1232 Bypass all translations and assume
1233 that the OS uses native UTF-8 encoding.
1234 @end table
1235
1236 @item --utf8-strings
1237 @itemx --no-utf8-strings
1238 Assume that command line arguments are given as UTF8 strings. The
1239 default (@option{--no-utf8-strings}) is to assume that arguments are
1240 encoded in the character set as specified by
1241 @option{--display-charset}. These options affect all following
1242 arguments. Both options may be used multiple times.
1243
1244 @ifset gpgone
1245 @anchor{option --options}
1246 @end ifset
1247 @item --options @code{file}
1248 Read options from @code{file} and do not try to read them from the
1249 default options file in the homedir (see @option{--homedir}). This
1250 option is ignored if used in an options file.
1251
1252 @item --no-options
1253 Shortcut for @option{--options /dev/null}. This option is detected
1254 before an attempt to open an option file.  Using this option will also
1255 prevent the creation of a @file{~/.gnupg} homedir.
1256
1257
1258
1259 @item -z @code{n}
1260 @itemx --compress-level @code{n}
1261 @itemx --bzip2-compress-level @code{n}
1262 Set compression level to @code{n} for the ZIP and ZLIB compression
1263 algorithms. The default is to use the default compression level of zlib
1264 (normally 6). @option{--bzip2-compress-level} sets the compression level
1265 for the BZIP2 compression algorithm (defaulting to 6 as well). This is a
1266 different option from @option{--compress-level} since BZIP2 uses a
1267 significant amount of memory for each additional compression level.
1268 @option{-z} sets both. A value of 0 for @code{n} disables compression.
1269
1270 @item --bzip2-decompress-lowmem
1271 Use a different decompression method for BZIP2 compressed files. This
1272 alternate method uses a bit more than half the memory, but also runs
1273 at half the speed. This is useful under extreme low memory
1274 circumstances when the file was originally compressed at a high
1275 @option{--bzip2-compress-level}.
1276
1277
1278 @item --mangle-dos-filenames
1279 @itemx --no-mangle-dos-filenames
1280 @opindex mangle-dos-filenames
1281 @opindex no-mangle-dos-filenames
1282 Older version of Windows cannot handle filenames with more than one
1283 dot. @option{--mangle-dos-filenames} causes GnuPG to replace (rather
1284 than add to) the extension of an output filename to avoid this
1285 problem. This option is off by default and has no effect on non-Windows
1286 platforms.
1287
1288 @item --ask-cert-level
1289 @itemx --no-ask-cert-level
1290 When making a key signature, prompt for a certification level. If this
1291 option is not specified, the certification level used is set via
1292 @option{--default-cert-level}. See @option{--default-cert-level} for
1293 information on the specific levels and how they are
1294 used. @option{--no-ask-cert-level} disables this option. This option
1295 defaults to no.
1296
1297 @item --default-cert-level @code{n}
1298 The default to use for the check level when signing a key.
1299
1300 0 means you make no particular claim as to how carefully you verified
1301 the key.
1302
1303 1 means you believe the key is owned by the person who claims to own
1304 it but you could not, or did not verify the key at all. This is
1305 useful for a "persona" verification, where you sign the key of a
1306 pseudonymous user.
1307
1308 2 means you did casual verification of the key. For example, this
1309 could mean that you verified that the key fingerprint and checked the
1310 user ID on the key against a photo ID.
1311
1312 3 means you did extensive verification of the key. For example, this
1313 could mean that you verified the key fingerprint with the owner of the
1314 key in person, and that you checked, by means of a hard to forge
1315 document with a photo ID (such as a passport) that the name of the key
1316 owner matches the name in the user ID on the key, and finally that you
1317 verified (by exchange of email) that the email address on the key
1318 belongs to the key owner.
1319
1320 Note that the examples given above for levels 2 and 3 are just that:
1321 examples. In the end, it is up to you to decide just what "casual"
1322 and "extensive" mean to you.
1323
1324 This option defaults to 0 (no particular claim).
1325
1326 @item --min-cert-level
1327 When building the trust database, treat any signatures with a
1328 certification level below this as invalid. Defaults to 2, which
1329 disregards level 1 signatures. Note that level 0 "no particular
1330 claim" signatures are always accepted.
1331
1332 @item --trusted-key @code{long key ID}
1333 Assume that the specified key (which must be given
1334 as a full 8 byte key ID) is as trustworthy as one of
1335 your own secret keys. This option is useful if you
1336 don't want to keep your secret keys (or one of them)
1337 online but still want to be able to check the validity of a given
1338 recipient's or signator's key.
1339
1340 @item --trust-model @code{pgp|classic|direct|always|auto}
1341 Set what trust model GnuPG should follow. The models are:
1342
1343 @table @asis
1344
1345 @item pgp
1346 This is the Web of Trust combined with trust signatures as used in PGP
1347 5.x and later. This is the default trust model when creating a new
1348 trust database.
1349
1350 @item classic
1351 This is the standard Web of Trust as used in PGP 2.x and earlier.
1352
1353 @item direct
1354 Key validity is set directly by the user and not calculated via the
1355 Web of Trust.
1356
1357 @item always
1358 Skip key validation and assume that used keys are always fully
1359 trusted. You generally won't use this unless you are using some
1360 external validation scheme. This option also suppresses the
1361 "[uncertain]" tag printed with signature checks when there is no
1362 evidence that the user ID is bound to the key.
1363
1364 @item auto
1365 Select the trust model depending on whatever the internal trust
1366 database says. This is the default model if such a database already
1367 exists.
1368 @end table
1369
1370 @item --auto-key-locate @code{parameters}
1371 @itemx --no-auto-key-locate
1372 GnuPG can automatically locate and retrieve keys as needed using this
1373 option. This happens when encrypting to an email address (in the
1374 "user@@example.com" form), and there are no user@@example.com keys on
1375 the local keyring.  This option takes any number of the following
1376 mechanisms, in the order they are to be tried:
1377
1378 @table @asis
1379
1380 @item cert
1381 Locate a key using DNS CERT, as specified in rfc4398.
1382
1383 @item pka
1384 Locate a key using DNS PKA.
1385
1386 @item ldap
1387 Using DNS Service Discovery, check the domain in question for any LDAP
1388 keyservers to use.  If this fails, attempt to locate the key using the
1389 PGP Universal method of checking @samp{ldap://keys.(thedomain)}.
1390
1391 @item keyserver
1392 Locate a key using whatever keyserver is defined using the
1393 @option{--keyserver} option.
1394
1395 @item keyserver-URL
1396 In addition, a keyserver URL as used in the @option{--keyserver} option
1397 may be used here to query that particular keyserver.
1398
1399 @item local
1400 Locate the key using the local keyrings.  This mechanism allows to
1401 select the order a local key lookup is done.  Thus using
1402 @samp{--auto-key-locate local} is identical to
1403 @option{--no-auto-key-locate}.
1404
1405 @item nodefault
1406 This flag disables the standard local key lookup, done before any of the
1407 mechanisms defined by the @option{--auto-key-locate} are tried.  The
1408 position of this mechanism in the list does not matter.  It is not
1409 required if @code{local} is also used.
1410
1411 @end table
1412
1413 @item --keyid-format @code{short|0xshort|long|0xlong}
1414 Select how to display key IDs. "short" is the traditional 8-character
1415 key ID. "long" is the more accurate (but less convenient)
1416 16-character key ID. Add an "0x" to either to include an "0x" at the
1417 beginning of the key ID, as in 0x99242560.
1418
1419 @item --keyserver @code{name}
1420 Use @code{name} as your keyserver. This is the server that
1421 @option{--recv-keys}, @option{--send-keys}, and @option{--search-keys}
1422 will communicate with to receive keys from, send keys to, and search for
1423 keys on. The format of the @code{name} is a URI:
1424 `scheme:[//]keyservername[:port]' The scheme is the type of keyserver:
1425 "hkp" for the HTTP (or compatible) keyservers, "ldap" for the LDAP
1426 keyservers, or "mailto" for the Graff email keyserver. Note that your
1427 particular installation of GnuPG may have other keyserver types
1428 available as well. Keyserver schemes are case-insensitive. After the
1429 keyserver name, optional keyserver configuration options may be
1430 provided. These are the same as the global @option{--keyserver-options}
1431 from below, but apply only to this particular keyserver.
1432
1433 Most keyservers synchronize with each other, so there is generally no
1434 need to send keys to more than one server. The keyserver
1435 @code{hkp://keys.gnupg.net} uses round robin DNS to give a different
1436 keyserver each time you use it.
1437
1438 @item --keyserver-options @code{name=value1 }
1439 This is a space or comma delimited string that gives options for the
1440 keyserver. Options can be prefixed with a `no-' to give the opposite
1441 meaning. Valid import-options or export-options may be used here as
1442 well to apply to importing (@option{--recv-key}) or exporting
1443 (@option{--send-key}) a key from a keyserver. While not all options
1444 are available for all keyserver types, some common options are:
1445
1446 @table @asis
1447
1448 @item include-revoked
1449 When searching for a key with @option{--search-keys}, include keys that
1450 are marked on the keyserver as revoked. Note that not all keyservers
1451 differentiate between revoked and unrevoked keys, and for such
1452 keyservers this option is meaningless. Note also that most keyservers do
1453 not have cryptographic verification of key revocations, and so turning
1454 this option off may result in skipping keys that are incorrectly marked
1455 as revoked.
1456
1457 @item include-disabled
1458 When searching for a key with @option{--search-keys}, include keys that
1459 are marked on the keyserver as disabled. Note that this option is not
1460 used with HKP keyservers.
1461
1462 @item auto-key-retrieve
1463 This option enables the automatic retrieving of keys from a keyserver
1464 when verifying signatures made by keys that are not on the local
1465 keyring.
1466
1467 Note that this option makes a "web bug" like behavior possible.
1468 Keyserver operators can see which keys you request, so by sending you
1469 a message signed by a brand new key (which you naturally will not have
1470 on your local keyring), the operator can tell both your IP address and
1471 the time when you verified the signature.
1472
1473 @item honor-keyserver-url
1474 When using @option{--refresh-keys}, if the key in question has a preferred
1475 keyserver URL, then use that preferred keyserver to refresh the key
1476 from. In addition, if auto-key-retrieve is set, and the signature
1477 being verified has a preferred keyserver URL, then use that preferred
1478 keyserver to fetch the key from. Defaults to yes.
1479
1480 @item honor-pka-record
1481 If auto-key-retrieve is set, and the signature being verified has a
1482 PKA record, then use the PKA information to fetch the key. Defaults
1483 to yes.
1484
1485 @item include-subkeys
1486 When receiving a key, include subkeys as potential targets. Note that
1487 this option is not used with HKP keyservers, as they do not support
1488 retrieving keys by subkey id.
1489
1490 @item use-temp-files
1491 On most Unix-like platforms, GnuPG communicates with the keyserver
1492 helper program via pipes, which is the most efficient method. This
1493 option forces GnuPG to use temporary files to communicate. On some
1494 platforms (such as Win32 and RISC OS), this option is always enabled.
1495
1496 @item keep-temp-files
1497 If using `use-temp-files', do not delete the temp files after using
1498 them. This option is useful to learn the keyserver communication
1499 protocol by reading the temporary files.
1500
1501 @item verbose
1502 Tell the keyserver helper program to be more verbose. This option can
1503 be repeated multiple times to increase the verbosity level.
1504
1505 @item timeout
1506 Tell the keyserver helper program how long (in seconds) to try and
1507 perform a keyserver action before giving up. Note that performing
1508 multiple actions at the same time uses this timeout value per action.
1509 For example, when retrieving multiple keys via @option{--recv-keys}, the
1510 timeout applies separately to each key retrieval, and not to the
1511 @option{--recv-keys} command as a whole. Defaults to 30 seconds.
1512
1513 @item http-proxy=@code{value}
1514 Set the proxy to use for HTTP and HKP keyservers.  This overrides the
1515 "http_proxy" environment variable, if any.
1516
1517 @item max-cert-size
1518 When retrieving a key via DNS CERT, only accept keys up to this size.
1519 Defaults to 16384 bytes.
1520
1521 @item debug
1522 Turn on debug output in the keyserver helper program.  Note that the
1523 details of debug output depends on which keyserver helper program is
1524 being used, and in turn, on any libraries that the keyserver helper
1525 program uses internally (libcurl, openldap, etc).
1526
1527 @item check-cert
1528 Enable certificate checking if the keyserver presents one (for hkps or
1529 ldaps).  Defaults to on.
1530
1531 @item ca-cert-file
1532 Provide a certificate store to override the system default.  Only
1533 necessary if check-cert is enabled, and the keyserver is using a
1534 certificate that is not present in a system default certificate list.
1535
1536 Note that depending on the SSL library that the keyserver helper is
1537 built with, this may actually be a directory or a file.
1538 @end table
1539
1540 @item --completes-needed @code{n}
1541 Number of completely trusted users to introduce a new
1542 key signer (defaults to 1).
1543
1544 @item --marginals-needed @code{n}
1545 Number of marginally trusted users to introduce a new
1546 key signer (defaults to 3)
1547
1548 @item --max-cert-depth @code{n}
1549 Maximum depth of a certification chain (default is 5).
1550
1551 @item --simple-sk-checksum
1552 Secret keys are integrity protected by using a SHA-1 checksum. This
1553 method is part of the upcoming enhanced OpenPGP specification but
1554 GnuPG already uses it as a countermeasure against certain attacks.
1555 Old applications don't understand this new format, so this option may
1556 be used to switch back to the old behaviour. Using this option bears
1557 a security risk. Note that using this option only takes effect when
1558 the secret key is encrypted - the simplest way to make this happen is
1559 to change the passphrase on the key (even changing it to the same
1560 value is acceptable).
1561
1562 @item --no-sig-cache
1563 Do not cache the verification status of key signatures.
1564 Caching gives a much better performance in key listings. However, if
1565 you suspect that your public keyring is not save against write
1566 modifications, you can use this option to disable the caching. It
1567 probably does not make sense to disable it because all kind of damage
1568 can be done if someone else has write access to your public keyring.
1569
1570 @item --no-sig-create-check
1571 GnuPG normally verifies each signature right after creation to protect
1572 against bugs and hardware malfunctions which could leak out bits from
1573 the secret key. This extra verification needs some time (about 115%
1574 for DSA keys), and so this option can be used to disable it.
1575 However, due to the fact that the signature creation needs manual
1576 interaction, this performance penalty does not matter in most settings.
1577
1578 @item --auto-check-trustdb
1579 @itemx --no-auto-check-trustdb
1580 If GnuPG feels that its information about the Web of Trust has to be
1581 updated, it automatically runs the @option{--check-trustdb} command
1582 internally.  This may be a time consuming
1583 process. @option{--no-auto-check-trustdb} disables this option.
1584
1585 @item --use-agent
1586 @itemx --no-use-agent
1587 @ifclear gpgone
1588 This is dummy option. @command{@gpgname} always requires the agent.
1589 @end ifclear
1590 @ifset gpgone
1591 Try to use the GnuPG-Agent.  With this option, GnuPG first tries to
1592 connect to the agent before it asks for a
1593 passphrase. @option{--no-use-agent} disables this option.
1594 @end ifset
1595
1596 @item --gpg-agent-info
1597 @ifclear gpgone
1598 This is dummy option. It has no effect when used with @command{gpg2}.
1599 @end ifclear
1600 @ifset gpgone
1601 Override the value of the environment variable
1602 @samp{GPG_AGENT_INFO}. This is only used when @option{--use-agent} has
1603 been given.  Given that this option is not anymore used by
1604 @command{gpg2}, it should be avoided if possible.
1605 @end ifset
1606
1607 @item --lock-once
1608 Lock the databases the first time a lock is requested
1609 and do not release the lock until the process
1610 terminates.
1611
1612 @item --lock-multiple
1613 Release the locks every time a lock is no longer
1614 needed. Use this to override a previous @option{--lock-once}
1615 from a config file.
1616
1617 @item --lock-never
1618 Disable locking entirely. This option should be used only in very
1619 special environments, where it can be assured that only one process
1620 is accessing those files. A bootable floppy with a stand-alone
1621 encryption system will probably use this. Improper usage of this
1622 option may lead to data and key corruption.
1623
1624 @item --exit-on-status-write-error
1625 This option will cause write errors on the status FD to immediately
1626 terminate the process. That should in fact be the default but it never
1627 worked this way and thus we need an option to enable this, so that the
1628 change won't break applications which close their end of a status fd
1629 connected pipe too early. Using this option along with
1630 @option{--enable-progress-filter} may be used to cleanly cancel long
1631 running gpg operations.
1632
1633 @item --limit-card-insert-tries @code{n}
1634 With @code{n} greater than 0 the number of prompts asking to insert a
1635 smartcard gets limited to N-1. Thus with a value of 1 gpg won't at
1636 all ask to insert a card if none has been inserted at startup. This
1637 option is useful in the configuration file in case an application does
1638 not know about the smartcard support and waits ad infinitum for an
1639 inserted card.
1640
1641 @item --no-random-seed-file
1642 GnuPG uses a file to store its internal random pool over invocations.
1643 This makes random generation faster; however sometimes write operations
1644 are not desired. This option can be used to achieve that with the cost of
1645 slower random generation.
1646
1647 @item --no-greeting
1648 Suppress the initial copyright message.
1649
1650 @item --no-secmem-warning
1651 Suppress the warning about "using insecure memory".
1652
1653 @item --no-permission-warning
1654 Suppress the warning about unsafe file and home directory (@option{--homedir})
1655 permissions. Note that the permission checks that GnuPG performs are
1656 not intended to be authoritative, but rather they simply warn about
1657 certain common permission problems. Do not assume that the lack of a
1658 warning means that your system is secure.
1659
1660 Note that the warning for unsafe @option{--homedir} permissions cannot be
1661 suppressed in the gpg.conf file, as this would allow an attacker to
1662 place an unsafe gpg.conf file in place, and use this file to suppress
1663 warnings about itself. The @option{--homedir} permissions warning may only be
1664 suppressed on the command line.
1665
1666 @item --no-mdc-warning
1667 Suppress the warning about missing MDC integrity protection.
1668
1669 @item --require-secmem
1670 @itemx --no-require-secmem
1671 Refuse to run if GnuPG cannot get secure memory. Defaults to no
1672 (i.e. run, but give a warning).
1673
1674
1675 @item --require-cross-certification
1676 @itemx --no-require-cross-certification
1677 When verifying a signature made from a subkey, ensure that the cross
1678 certification "back signature" on the subkey is present and valid.  This
1679 protects against a subtle attack against subkeys that can sign.
1680 Defaults to @option{--require-cross-certification} for
1681 @command{@gpgname}.
1682
1683 @item --expert
1684 @itemx --no-expert
1685 Allow the user to do certain nonsensical or "silly" things like
1686 signing an expired or revoked key, or certain potentially incompatible
1687 things like generating unusual key types. This also disables certain
1688 warning messages about potentially incompatible actions. As the name
1689 implies, this option is for experts only. If you don't fully
1690 understand the implications of what it allows you to do, leave this
1691 off. @option{--no-expert} disables this option.
1692
1693
1694
1695
1696 @end table
1697
1698
1699 @c *******************************************
1700 @c ********  KEY RELATED OPTIONS  ************
1701 @c *******************************************
1702 @node GPG Key related Options
1703 @subsection Key related options
1704
1705 @table @gnupgtabopt
1706
1707 @item --recipient @var{name}
1708 @itemx -r
1709 @opindex recipient
1710 Encrypt for user id @var{name}. If this option or
1711 @option{--hidden-recipient} is not specified, GnuPG asks for the user-id
1712 unless @option{--default-recipient} is given.
1713
1714 @item --hidden-recipient @var{name}
1715 @itemx -R
1716 @opindex hidden-recipient
1717 Encrypt for user ID @var{name}, but hide the key ID of this user's
1718 key. This option helps to hide the receiver of the message and is a
1719 limited countermeasure against traffic analysis. If this option or
1720 @option{--recipient} is not specified, GnuPG asks for the user ID unless
1721 @option{--default-recipient} is given.
1722
1723 @item --encrypt-to @code{name}
1724 Same as @option{--recipient} but this one is intended for use in the
1725 options file and may be used with your own user-id as an
1726 "encrypt-to-self". These keys are only used when there are other
1727 recipients given either by use of @option{--recipient} or by the asked
1728 user id.  No trust checking is performed for these user ids and even
1729 disabled keys can be used.
1730
1731 @item --hidden-encrypt-to @code{name}
1732 Same as @option{--hidden-recipient} but this one is intended for use in the
1733 options file and may be used with your own user-id as a hidden
1734 "encrypt-to-self". These keys are only used when there are other
1735 recipients given either by use of @option{--recipient} or by the asked user id.
1736 No trust checking is performed for these user ids and even disabled
1737 keys can be used.
1738
1739 @item --no-encrypt-to
1740 Disable the use of all @option{--encrypt-to} and
1741 @option{--hidden-encrypt-to} keys.
1742
1743 @item --group @code{name=value1 }
1744 Sets up a named group, which is similar to aliases in email programs.
1745 Any time the group name is a recipient (@option{-r} or
1746 @option{--recipient}), it will be expanded to the values
1747 specified. Multiple groups with the same name are automatically merged
1748 into a single group.
1749
1750 The values are @code{key IDs} or fingerprints, but any key description
1751 is accepted. Note that a value with spaces in it will be treated as
1752 two different values. Note also there is only one level of expansion
1753 --- you cannot make an group that points to another group. When used
1754 from the command line, it may be necessary to quote the argument to
1755 this option to prevent the shell from treating it as multiple
1756 arguments.
1757
1758 @item --ungroup @code{name}
1759 Remove a given entry from the @option{--group} list.
1760
1761 @item --no-groups
1762 Remove all entries from the @option{--group} list.
1763
1764 @item --local-user @var{name}
1765 @itemx -u
1766 @opindex local-user
1767 Use @var{name} as the key to sign with. Note that this option overrides
1768 @option{--default-key}.
1769
1770 @item --try-all-secrets
1771 @opindex try-all-secrets
1772 Don't look at the key ID as stored in the message but try all secret
1773 keys in turn to find the right decryption key. This option forces the
1774 behaviour as used by anonymous recipients (created by using
1775 @option{--throw-keyids}) and might come handy in case where an encrypted
1776 message contains a bogus key ID.
1777
1778 @item --skip-hidden-recipients
1779 @itemx --no-skip-hidden-recipients
1780 @opindex skip-hidden-recipients
1781 @opindex no-skip-hidden-recipients
1782 During decryption skip all anonymous recipients.  This option helps in
1783 the case that people use the hidden recipients feature to hide there
1784 own encrypt-to key from others.  If oneself has many secret keys this
1785 may lead to a major annoyance because all keys are tried in turn to
1786 decrypt soemthing which was not really intended for it.  The drawback
1787 of this option is that it is currently not possible to decrypt a
1788 message which includes real anonymous recipients.
1789
1790
1791 @end table
1792
1793 @c *******************************************
1794 @c ********  INPUT AND OUTPUT  ***************
1795 @c *******************************************
1796 @node GPG Input and Output
1797 @subsection Input and Output
1798
1799 @table @gnupgtabopt
1800
1801 @item --armor
1802 @itemx -a
1803 @opindex armor
1804 Create ASCII armored output.  The default is to create the binary
1805 OpenPGP format.
1806
1807 @item --no-armor
1808 Assume the input data is not in ASCII armored format.
1809
1810 @item --output @var{file}
1811 @itemx -o @var{file}
1812 @opindex output
1813 Write output to @var{file}.
1814
1815 @item --max-output @code{n}
1816 @opindex max-output
1817 This option sets a limit on the number of bytes that will be generated
1818 when processing a file. Since OpenPGP supports various levels of
1819 compression, it is possible that the plaintext of a given message may be
1820 significantly larger than the original OpenPGP message. While GnuPG
1821 works properly with such messages, there is often a desire to set a
1822 maximum file size that will be generated before processing is forced to
1823 stop by the OS limits. Defaults to 0, which means "no limit".
1824
1825 @item --import-options @code{parameters}
1826 This is a space or comma delimited string that gives options for
1827 importing keys. Options can be prepended with a `no-' to give the
1828 opposite meaning. The options are:
1829
1830 @table @asis
1831
1832 @item import-local-sigs
1833 Allow importing key signatures marked as "local". This is not
1834 generally useful unless a shared keyring scheme is being used.
1835 Defaults to no.
1836
1837 @item repair-pks-subkey-bug
1838 During import, attempt to repair the damage caused by the PKS keyserver
1839 bug (pre version 0.9.6) that mangles keys with multiple subkeys. Note
1840 that this cannot completely repair the damaged key as some crucial data
1841 is removed by the keyserver, but it does at least give you back one
1842 subkey. Defaults to no for regular @option{--import} and to yes for
1843 keyserver @option{--recv-keys}.
1844
1845 @item merge-only
1846 During import, allow key updates to existing keys, but do not allow
1847 any new keys to be imported. Defaults to no.
1848
1849 @item import-clean
1850 After import, compact (remove all signatures except the
1851 self-signature) any user IDs from the new key that are not usable.
1852 Then, remove any signatures from the new key that are not usable.
1853 This includes signatures that were issued by keys that are not present
1854 on the keyring. This option is the same as running the @option{--edit-key}
1855 command "clean" after import. Defaults to no.
1856
1857 @item import-minimal
1858 Import the smallest key possible. This removes all signatures except
1859 the most recent self-signature on each user ID. This option is the
1860 same as running the @option{--edit-key} command "minimize" after import.
1861 Defaults to no.
1862 @end table
1863
1864 @item --export-options @code{parameters}
1865 This is a space or comma delimited string that gives options for
1866 exporting keys. Options can be prepended with a `no-' to give the
1867 opposite meaning. The options are:
1868
1869 @table @asis
1870
1871 @item export-local-sigs
1872 Allow exporting key signatures marked as "local". This is not
1873 generally useful unless a shared keyring scheme is being used.
1874 Defaults to no.
1875
1876 @item export-attributes
1877 Include attribute user IDs (photo IDs) while exporting. This is
1878 useful to export keys if they are going to be used by an OpenPGP
1879 program that does not accept attribute user IDs. Defaults to yes.
1880
1881 @item export-sensitive-revkeys
1882 Include designated revoker information that was marked as
1883 "sensitive". Defaults to no.
1884
1885 @item export-reset-subkey-passwd
1886 When using the @option{--export-secret-subkeys} command, this option resets
1887 the passphrases for all exported subkeys to empty. This is useful
1888 when the exported subkey is to be used on an unattended machine where
1889 a passphrase doesn't necessarily make sense. Defaults to no.
1890
1891 @item export-clean
1892 Compact (remove all signatures from) user IDs on the key being
1893 exported if the user IDs are not usable. Also, do not export any
1894 signatures that are not usable. This includes signatures that were
1895 issued by keys that are not present on the keyring. This option is
1896 the same as running the @option{--edit-key} command "clean" before export
1897 except that the local copy of the key is not modified. Defaults to
1898 no.
1899
1900 @item export-minimal
1901 Export the smallest key possible. This removes all signatures except the
1902 most recent self-signature on each user ID. This option is the same as
1903 running the @option{--edit-key} command "minimize" before export except
1904 that the local copy of the key is not modified. Defaults to no.
1905 @end table
1906
1907 @item --with-colons
1908 @opindex with-colons
1909 Print key listings delimited by colons. Note that the output will be
1910 encoded in UTF-8 regardless of any @option{--display-charset} setting. This
1911 format is useful when GnuPG is called from scripts and other programs
1912 as it is easily machine parsed. The details of this format are
1913 documented in the file @file{doc/DETAILS}, which is included in the GnuPG
1914 source distribution.
1915
1916 @item --fixed-list-mode
1917 @opindex fixed-list-mode
1918 Do not merge primary user ID and primary key in @option{--with-colon}
1919 listing mode and print all timestamps as seconds since 1970-01-01.
1920 @ifclear gpgone
1921 Since GnuPG 2.0.10, this mode is always used and thus this option is
1922 obsolete; it does not harm to use it though.
1923 @end ifclear
1924
1925 @item --with-fingerprint
1926 @opindex with-fingerprint
1927 Same as the command @option{--fingerprint} but changes only the format
1928 of the output and may be used together with another command.
1929
1930
1931 @end table
1932
1933 @c *******************************************
1934 @c ********  OPENPGP OPTIONS  ****************
1935 @c *******************************************
1936 @node OpenPGP Options
1937 @subsection OpenPGP protocol specific options.
1938
1939 @table @gnupgtabopt
1940
1941 @item -t, --textmode
1942 @itemx --no-textmode
1943 Treat input files as text and store them in the OpenPGP canonical text
1944 form with standard "CRLF" line endings. This also sets the necessary
1945 flags to inform the recipient that the encrypted or signed data is text
1946 and may need its line endings converted back to whatever the local
1947 system uses. This option is useful when communicating between two
1948 platforms that have different line ending conventions (UNIX-like to Mac,
1949 Mac to Windows, etc). @option{--no-textmode} disables this option, and
1950 is the default.
1951
1952 @ifset gpgone
1953 If @option{-t} (but not @option{--textmode}) is used together with
1954 armoring and signing, this enables clearsigned messages. This kludge is
1955 needed for command-line compatibility with command-line versions of PGP;
1956 normally you would use @option{--sign} or @option{--clearsign} to select
1957 the type of the signature.
1958 @end ifset
1959
1960 @item --force-v3-sigs
1961 @itemx --no-force-v3-sigs
1962 OpenPGP states that an implementation should generate v4 signatures
1963 but PGP versions 5 through 7 only recognize v4 signatures on key
1964 material. This option forces v3 signatures for signatures on data.
1965 Note that this option implies @option{--ask-sig-expire},
1966 @option{--sig-policy-url}, @option{--sig-notation}, and
1967 @option{--sig-keyserver-url}, as these features cannot be used with v3
1968 signatures.  @option{--no-force-v3-sigs} disables this option.
1969
1970 @item --force-v4-certs
1971 @itemx --no-force-v4-certs
1972 Always use v4 key signatures even on v3 keys. This option also
1973 changes the default hash algorithm for v3 RSA keys from MD5 to SHA-1.
1974 @option{--no-force-v4-certs} disables this option.
1975
1976 @item --force-mdc
1977 Force the use of encryption with a modification detection code. This
1978 is always used with the newer ciphers (those with a blocksize greater
1979 than 64 bits), or if all of the recipient keys indicate MDC support in
1980 their feature flags.
1981
1982 @item --disable-mdc
1983 Disable the use of the modification detection code. Note that by
1984 using this option, the encrypted message becomes vulnerable to a
1985 message modification attack.
1986
1987 @item --personal-cipher-preferences @code{string}
1988 Set the list of personal cipher preferences to @code{string}.  Use
1989 @command{@gpgname --version} to get a list of available algorithms,
1990 and use @code{none} to set no preference at all.  This allows the user
1991 to safely override the algorithm chosen by the recipient key
1992 preferences, as GPG will only select an algorithm that is usable by
1993 all recipients.  The most highly ranked cipher in this list is also
1994 used for the @option{--symmetric} encryption command.
1995
1996 @item --personal-digest-preferences @code{string}
1997 Set the list of personal digest preferences to @code{string}.  Use
1998 @command{@gpgname --version} to get a list of available algorithms,
1999 and use @code{none} to set no preference at all.  This allows the user
2000 to safely override the algorithm chosen by the recipient key
2001 preferences, as GPG will only select an algorithm that is usable by
2002 all recipients.  The most highly ranked digest algorithm in this list
2003 is also used when signing without encryption
2004 (e.g. @option{--clearsign} or @option{--sign}). The default value is
2005 SHA-1.
2006
2007 @item --personal-compress-preferences @code{string}
2008 Set the list of personal compression preferences to @code{string}.
2009 Use @command{@gpgname --version} to get a list of available
2010 algorithms, and use @code{none} to set no preference at all.  This
2011 allows the user to safely override the algorithm chosen by the
2012 recipient key preferences, as GPG will only select an algorithm that
2013 is usable by all recipients.  The most highly ranked compression
2014 algorithm in this list is also used when there are no recipient keys
2015 to consider (e.g. @option{--symmetric}).
2016
2017 @item --s2k-cipher-algo @code{name}
2018 Use @code{name} as the cipher algorithm used to protect secret keys.
2019 The default cipher is CAST5. This cipher is also used for
2020 conventional encryption if @option{--personal-cipher-preferences} and
2021 @option{--cipher-algo} is not given.
2022
2023 @item --s2k-digest-algo @code{name}
2024 Use @code{name} as the digest algorithm used to mangle the passphrases.
2025 The default algorithm is SHA-1.
2026
2027 @item --s2k-mode @code{n}
2028 Selects how passphrases are mangled. If @code{n} is 0 a plain
2029 passphrase (which is not recommended) will be used, a 1 adds a salt to
2030 the passphrase and a 3 (the default) iterates the whole process a
2031 number of times (see --s2k-count).  Unless @option{--rfc1991} is used,
2032 this mode is also used for conventional encryption.
2033
2034 @item --s2k-count @code{n}
2035 Specify how many times the passphrase mangling is repeated.  This
2036 value may range between 1024 and 65011712 inclusive, and the default
2037 is 65536.  Note that not all values in the 1024-65011712 range are
2038 legal and if an illegal value is selected, GnuPG will round up to the
2039 nearest legal value.  This option is only meaningful if
2040 @option{--s2k-mode} is 3.
2041
2042
2043 @end table
2044
2045 @c ***************************
2046 @c ******* Compliance ********
2047 @c ***************************
2048 @subsection Compliance options
2049
2050 These options control what GnuPG is compliant to. Only one of these
2051 options may be active at a time. Note that the default setting of
2052 this is nearly always the correct one. See the INTEROPERABILITY WITH
2053 OTHER OPENPGP PROGRAMS section below before using one of these
2054 options.
2055
2056 @table @gnupgtabopt
2057
2058 @item --gnupg
2059 @opindex gnupg
2060 Use standard GnuPG behavior. This is essentially OpenPGP behavior
2061 (see @option{--openpgp}), but with some additional workarounds for common
2062 compatibility problems in different versions of PGP. This is the
2063 default option, so it is not generally needed, but it may be useful to
2064 override a different compliance option in the gpg.conf file.
2065
2066 @item --openpgp
2067 @opindex openpgp
2068 Reset all packet, cipher and digest options to strict OpenPGP
2069 behavior. Use this option to reset all previous options like
2070 @option{--s2k-*}, @option{--cipher-algo}, @option{--digest-algo} and
2071 @option{--compress-algo} to OpenPGP compliant values. All PGP
2072 workarounds are disabled.
2073
2074 @item --rfc4880
2075 @opindex rfc4880
2076 Reset all packet, cipher and digest options to strict RFC-4880
2077 behavior. Note that this is currently the same thing as
2078 @option{--openpgp}.
2079
2080 @item --rfc2440
2081 @opindex rfc2440
2082 Reset all packet, cipher and digest options to strict RFC-2440
2083 behavior.
2084
2085 @item --rfc1991
2086 @opindex rfc1991
2087 Try to be more RFC-1991 (PGP 2.x) compliant.
2088
2089 @item --pgp2
2090 @opindex pgp2
2091 Set up all options to be as PGP 2.x compliant as possible, and warn if
2092 an action is taken (e.g. encrypting to a non-RSA key) that will create
2093 a message that PGP 2.x will not be able to handle. Note that `PGP
2094 2.x' here means `MIT PGP 2.6.2'. There are other versions of PGP 2.x
2095 available, but the MIT release is a good common baseline.
2096
2097 This option implies @option{--rfc1991 --disable-mdc
2098 --no-force-v4-certs --escape-from-lines --force-v3-sigs --cipher-algo
2099 IDEA --digest-algo MD5 --compress-algo ZIP}. It also disables
2100 @option{--textmode} when encrypting.
2101
2102 @item --pgp6
2103 @opindex pgp6
2104 Set up all options to be as PGP 6 compliant as possible. This
2105 restricts you to the ciphers IDEA (if the IDEA plugin is installed),
2106 3DES, and CAST5, the hashes MD5, SHA1 and RIPEMD160, and the
2107 compression algorithms none and ZIP. This also disables
2108 --throw-keyids, and making signatures with signing subkeys as PGP 6
2109 does not understand signatures made by signing subkeys.
2110
2111 This option implies @option{--disable-mdc --escape-from-lines
2112 --force-v3-sigs}.
2113
2114 @item --pgp7
2115 @opindex pgp7
2116 Set up all options to be as PGP 7 compliant as possible. This is
2117 identical to @option{--pgp6} except that MDCs are not disabled, and the
2118 list of allowable ciphers is expanded to add AES128, AES192, AES256, and
2119 TWOFISH.
2120
2121 @item --pgp8
2122 @opindex pgp8
2123 Set up all options to be as PGP 8 compliant as possible. PGP 8 is a lot
2124 closer to the OpenPGP standard than previous versions of PGP, so all
2125 this does is disable @option{--throw-keyids} and set
2126 @option{--escape-from-lines}.  All algorithms are allowed except for the
2127 SHA224, SHA384, and SHA512 digests.
2128
2129 @end table
2130
2131
2132 @c *******************************************
2133 @c ********  ESOTERIC OPTIONS  ***************
2134 @c *******************************************
2135 @node GPG Esoteric Options
2136 @subsection Doing things one usually doesn't want to do.
2137
2138 @table @gnupgtabopt
2139
2140 @item -n
2141 @itemx --dry-run
2142 @opindex dry-run
2143 Don't make any changes (this is not completely implemented).
2144
2145 @item --list-only
2146 Changes the behaviour of some commands. This is like @option{--dry-run} but
2147 different in some cases. The semantic of this command may be extended in
2148 the future. Currently it only skips the actual decryption pass and
2149 therefore enables a fast listing of the encryption keys.
2150
2151 @item -i
2152 @itemx --interactive
2153 @opindex interactive
2154 Prompt before overwriting any files.
2155
2156 @item --debug-level @var{level}
2157 @opindex debug-level
2158 Select the debug level for investigating problems. @var{level} may be
2159 a numeric value or by a keyword:
2160
2161 @table @code
2162 @item none
2163 No debugging at all.  A value of less than 1 may be used instead of
2164 the keyword.
2165 @item basic  
2166 Some basic debug messages.  A value between 1 and 2 may be used
2167 instead of the keyword.
2168 @item advanced
2169 More verbose debug messages.  A value between 3 and 5 may be used
2170 instead of the keyword.
2171 @item expert
2172 Even more detailed messages.  A value between 6 and 8 may be used
2173 instead of the keyword.
2174 @item guru
2175 All of the debug messages you can get. A value greater than 8 may be
2176 used instead of the keyword.  The creation of hash tracing files is
2177 only enabled if the keyword is used.
2178 @end table
2179
2180 How these messages are mapped to the actual debugging flags is not
2181 specified and may change with newer releases of this program. They are
2182 however carefully selected to best aid in debugging.
2183
2184 @item --debug @var{flags}
2185 @opindex debug
2186 Set debugging flags. All flags are or-ed and @var{flags} may
2187 be given in C syntax (e.g. 0x0042).
2188
2189 @item --debug-all
2190 Set all useful debugging flags.
2191
2192 @ifset gpgone
2193 @item --debug-ccid-driver
2194 Enable debug output from the included CCID driver for smartcards.
2195 Note that this option is only available on some system.
2196 @end ifset
2197
2198 @item --faked-system-time @var{epoch}
2199 @opindex faked-system-time
2200 This option is only useful for testing; it sets the system time back or
2201 forth to @var{epoch} which is the number of seconds elapsed since the year
2202 1970.  Alternatively @var{epoch} may be given as a full ISO time string
2203 (e.g. "20070924T154812").
2204
2205 @item --enable-progress-filter
2206 Enable certain PROGRESS status outputs. This option allows frontends
2207 to display a progress indicator while gpg is processing larger files.
2208 There is a slight performance overhead using it.
2209
2210 @item --status-fd @code{n}
2211 Write special status strings to the file descriptor @code{n}.
2212 See the file DETAILS in the documentation for a listing of them.
2213
2214 @item --status-file @code{file}
2215 Same as @option{--status-fd}, except the status data is written to file
2216 @code{file}.
2217
2218 @item --logger-fd @code{n}
2219 Write log output to file descriptor @code{n} and not to STDERR.
2220
2221 @item --log-file @code{file}
2222 @itemx --logger-file @code{file}
2223 Same as @option{--logger-fd}, except the logger data is written to file
2224 @code{file}.  Note that @option{--log-file} is only implemented for
2225 GnuPG-2.
2226
2227 @item --attribute-fd @code{n}
2228 Write attribute subpackets to the file descriptor @code{n}. This is most
2229 useful for use with @option{--status-fd}, since the status messages are
2230 needed to separate out the various subpackets from the stream delivered
2231 to the file descriptor.
2232
2233 @item --attribute-file @code{file}
2234 Same as @option{--attribute-fd}, except the attribute data is written to
2235 file @code{file}.
2236
2237 @item --comment @code{string}
2238 @itemx --no-comments
2239 Use @code{string} as a comment string in clear text signatures and ASCII
2240 armored messages or keys (see @option{--armor}). The default behavior is
2241 not to use a comment string. @option{--comment} may be repeated multiple
2242 times to get multiple comment strings. @option{--no-comments} removes
2243 all comments.  It is a good idea to keep the length of a single comment
2244 below 60 characters to avoid problems with mail programs wrapping such
2245 lines.  Note that comment lines, like all other header lines, are not
2246 protected by the signature.
2247
2248 @item --emit-version
2249 @itemx --no-emit-version
2250 Force inclusion of the version string in ASCII armored output.
2251 @option{--no-emit-version} disables this option.
2252
2253 @item --sig-notation @code{name=value}
2254 @itemx --cert-notation @code{name=value}
2255 @itemx -N, --set-notation @code{name=value}
2256 Put the name value pair into the signature as notation data.
2257 @code{name} must consist only of printable characters or spaces, and
2258 must contain a '@@' character in the form keyname@@domain.example.com
2259 (substituting the appropriate keyname and domain name, of course).  This
2260 is to help prevent pollution of the IETF reserved notation
2261 namespace. The @option{--expert} flag overrides the '@@'
2262 check. @code{value} may be any printable string; it will be encoded in
2263 UTF8, so you should check that your @option{--display-charset} is set
2264 correctly. If you prefix @code{name} with an exclamation mark (!), the
2265 notation data will be flagged as critical
2266 (rfc2440:5.2.3.15). @option{--sig-notation} sets a notation for data
2267 signatures. @option{--cert-notation} sets a notation for key signatures
2268 (certifications). @option{--set-notation} sets both.
2269
2270 There are special codes that may be used in notation names. "%k" will
2271 be expanded into the key ID of the key being signed, "%K" into the
2272 long key ID of the key being signed, "%f" into the fingerprint of the
2273 key being signed, "%s" into the key ID of the key making the
2274 signature, "%S" into the long key ID of the key making the signature,
2275 "%g" into the fingerprint of the key making the signature (which might
2276 be a subkey), "%p" into the fingerprint of the primary key of the key
2277 making the signature, "%c" into the signature count from the OpenPGP
2278 smartcard, and "%%" results in a single "%". %k, %K, and %f are only
2279 meaningful when making a key signature (certification), and %c is only
2280 meaningful when using the OpenPGP smartcard.
2281
2282 @item --sig-policy-url @code{string}
2283 @itemx --cert-policy-url @code{string}
2284 @itemx --set-policy-url @code{string}
2285 Use @code{string} as a Policy URL for signatures (rfc2440:5.2.3.19).  If
2286 you prefix it with an exclamation mark (!), the policy URL packet will
2287 be flagged as critical. @option{--sig-policy-url} sets a policy url for
2288 data signatures. @option{--cert-policy-url} sets a policy url for key
2289 signatures (certifications). @option{--set-policy-url} sets both.
2290
2291 The same %-expandos used for notation data are available here as well.
2292
2293 @item --sig-keyserver-url @code{string}
2294 Use @code{string} as a preferred keyserver URL for data signatures. If
2295 you prefix it with an exclamation mark (!), the keyserver URL packet
2296 will be flagged as critical.
2297
2298 The same %-expandos used for notation data are available here as well.
2299
2300 @item --set-filename @code{string}
2301 Use @code{string} as the filename which is stored inside messages.
2302 This overrides the default, which is to use the actual filename of the
2303 file being encrypted.
2304
2305 @item --for-your-eyes-only
2306 @itemx --no-for-your-eyes-only
2307 Set the `for your eyes only' flag in the message. This causes GnuPG to
2308 refuse to save the file unless the @option{--output} option is given,
2309 and PGP to use a "secure viewer" with a claimed Tempest-resistant font
2310 to display the message. This option overrides @option{--set-filename}.
2311 @option{--no-for-your-eyes-only} disables this option.
2312
2313 @item --use-embedded-filename
2314 @itemx --no-use-embedded-filename
2315 Try to create a file with a name as embedded in the data. This can be
2316 a dangerous option as it allows to overwrite files. Defaults to no.
2317
2318 @item --cipher-algo @code{name}
2319 Use @code{name} as cipher algorithm. Running the program with the
2320 command @option{--version} yields a list of supported algorithms. If
2321 this is not used the cipher algorithm is selected from the preferences
2322 stored with the key. In general, you do not want to use this option as
2323 it allows you to violate the OpenPGP standard.
2324 @option{--personal-cipher-preferences} is the safe way to accomplish the
2325 same thing.
2326
2327 @item --digest-algo @code{name}
2328 Use @code{name} as the message digest algorithm. Running the program
2329 with the command @option{--version} yields a list of supported algorithms. In
2330 general, you do not want to use this option as it allows you to
2331 violate the OpenPGP standard. @option{--personal-digest-preferences} is the
2332 safe way to accomplish the same thing.
2333
2334 @item --compress-algo @code{name}
2335 Use compression algorithm @code{name}. "zlib" is RFC-1950 ZLIB
2336 compression. "zip" is RFC-1951 ZIP compression which is used by PGP.
2337 "bzip2" is a more modern compression scheme that can compress some
2338 things better than zip or zlib, but at the cost of more memory used
2339 during compression and decompression. "uncompressed" or "none"
2340 disables compression. If this option is not used, the default
2341 behavior is to examine the recipient key preferences to see which
2342 algorithms the recipient supports. If all else fails, ZIP is used for
2343 maximum compatibility.
2344
2345 ZLIB may give better compression results than ZIP, as the compression
2346 window size is not limited to 8k. BZIP2 may give even better
2347 compression results than that, but will use a significantly larger
2348 amount of memory while compressing and decompressing. This may be
2349 significant in low memory situations. Note, however, that PGP (all
2350 versions) only supports ZIP compression. Using any algorithm other
2351 than ZIP or "none" will make the message unreadable with PGP. In
2352 general, you do not want to use this option as it allows you to
2353 violate the OpenPGP standard. @option{--personal-compress-preferences} is the
2354 safe way to accomplish the same thing.
2355
2356 @item --cert-digest-algo @code{name}
2357 Use @code{name} as the message digest algorithm used when signing a
2358 key. Running the program with the command @option{--version} yields a
2359 list of supported algorithms. Be aware that if you choose an algorithm
2360 that GnuPG supports but other OpenPGP implementations do not, then some
2361 users will not be able to use the key signatures you make, or quite
2362 possibly your entire key.
2363
2364 @item --disable-cipher-algo @code{name}
2365 Never allow the use of @code{name} as cipher algorithm.
2366 The given name will not be checked so that a later loaded algorithm
2367 will still get disabled.
2368
2369 @item --disable-pubkey-algo @code{name}
2370 Never allow the use of @code{name} as public key algorithm.
2371 The given name will not be checked so that a later loaded algorithm
2372 will still get disabled.
2373
2374 @item --throw-keyids
2375 @itemx --no-throw-keyids
2376 Do not put the recipient key IDs into encrypted messages. This helps to
2377 hide the receivers of the message and is a limited countermeasure
2378 against traffic analysis.@footnote{Using a little social engineering
2379 anyone who is able to decrypt the message can check whether one of the
2380 other recipients is the one he suspects.}  On the receiving side, it may
2381 slow down the decryption process because all available secret keys must
2382 be tried.  @option{--no-throw-keyids} disables this option. This option
2383 is essentially the same as using @option{--hidden-recipient} for all
2384 recipients.
2385
2386 @item --not-dash-escaped
2387 This option changes the behavior of cleartext signatures
2388 so that they can be used for patch files. You should not
2389 send such an armored file via email because all spaces
2390 and line endings are hashed too. You can not use this
2391 option for data which has 5 dashes at the beginning of a
2392 line, patch files don't have this. A special armor header
2393 line tells GnuPG about this cleartext signature option.
2394
2395 @item --escape-from-lines
2396 @itemx --no-escape-from-lines
2397 Because some mailers change lines starting with "From " to ">From " it
2398 is good to handle such lines in a special way when creating cleartext
2399 signatures to prevent the mail system from breaking the signature. Note
2400 that all other PGP versions do it this way too.  Enabled by
2401 default. @option{--no-escape-from-lines} disables this option.
2402
2403 @item --passphrase-repeat @code{n}
2404 Specify how many times @command{@gpgname} will request a new
2405 passphrase be repeated.  This is useful for helping memorize a
2406 passphrase.  Defaults to 1 repetition.
2407
2408 @item --passphrase-fd @code{n}
2409 Read the passphrase from file descriptor @code{n}. Only the first line
2410 will be read from file descriptor @code{n}. If you use 0 for @code{n},
2411 the passphrase will be read from STDIN. This can only be used if only
2412 one passphrase is supplied.
2413 @ifclear gpgone
2414 Note that this passphrase is only used if the option @option{--batch}
2415 has also been given.  This is different from @command{gpg}.
2416 @end ifclear
2417
2418 @item --passphrase-file @code{file}
2419 Read the passphrase from file @code{file}. Only the first line will
2420 be read from file @code{file}. This can only be used if only one
2421 passphrase is supplied. Obviously, a passphrase stored in a file is
2422 of questionable security if other users can read this file. Don't use
2423 this option if you can avoid it.
2424 @ifclear gpgone
2425 Note that this passphrase is only used if the option @option{--batch}
2426 has also been given.  This is different from @command{gpg}.
2427 @end ifclear
2428
2429 @item --passphrase @code{string}
2430 Use @code{string} as the passphrase. This can only be used if only one
2431 passphrase is supplied. Obviously, this is of very questionable
2432 security on a multi-user system. Don't use this option if you can
2433 avoid it.
2434 @ifclear gpgone
2435 Note that this passphrase is only used if the option @option{--batch}
2436 has also been given.  This is different from @command{gpg}.
2437 @end ifclear
2438
2439 @item --command-fd @code{n}
2440 This is a replacement for the deprecated shared-memory IPC mode.
2441 If this option is enabled, user input on questions is not expected
2442 from the TTY but from the given file descriptor. It should be used
2443 together with @option{--status-fd}. See the file doc/DETAILS in the source
2444 distribution for details on how to use it.
2445
2446 @item --command-file @code{file}
2447 Same as @option{--command-fd}, except the commands are read out of file
2448 @code{file}
2449
2450 @item --allow-non-selfsigned-uid
2451 @itemx --no-allow-non-selfsigned-uid
2452 Allow the import and use of keys with user IDs which are not
2453 self-signed. This is not recommended, as a non self-signed user ID is
2454 trivial to forge. @option{--no-allow-non-selfsigned-uid} disables.
2455
2456 @item --allow-freeform-uid
2457 Disable all checks on the form of the user ID while generating a new
2458 one. This option should only be used in very special environments as
2459 it does not ensure the de-facto standard format of user IDs.
2460
2461 @item --ignore-time-conflict
2462 GnuPG normally checks that the timestamps associated with keys and
2463 signatures have plausible values. However, sometimes a signature
2464 seems to be older than the key due to clock problems. This option
2465 makes these checks just a warning. See also @option{--ignore-valid-from} for
2466 timestamp issues on subkeys.
2467
2468 @item --ignore-valid-from
2469 GnuPG normally does not select and use subkeys created in the future.
2470 This option allows the use of such keys and thus exhibits the
2471 pre-1.0.7 behaviour. You should not use this option unless you there
2472 is some clock problem. See also @option{--ignore-time-conflict} for timestamp
2473 issues with signatures.
2474
2475 @item --ignore-crc-error
2476 The ASCII armor used by OpenPGP is protected by a CRC checksum against
2477 transmission errors. Occasionally the CRC gets mangled somewhere on
2478 the transmission channel but the actual content (which is protected by
2479 the OpenPGP protocol anyway) is still okay. This option allows GnuPG
2480 to ignore CRC errors.
2481
2482 @item --ignore-mdc-error
2483 This option changes a MDC integrity protection failure into a warning.
2484 This can be useful if a message is partially corrupt, but it is
2485 necessary to get as much data as possible out of the corrupt message.
2486 However, be aware that a MDC protection failure may also mean that the
2487 message was tampered with intentionally by an attacker.
2488
2489 @item --no-default-keyring
2490 Do not add the default keyrings to the list of keyrings. Note that
2491 GnuPG will not operate without any keyrings, so if you use this option
2492 and do not provide alternate keyrings via @option{--keyring} or
2493 @option{--secret-keyring}, then GnuPG will still use the default public or
2494 secret keyrings.
2495
2496 @item --skip-verify
2497 Skip the signature verification step. This may be
2498 used to make the decryption faster if the signature
2499 verification is not needed.
2500
2501 @item --with-key-data
2502 Print key listings delimited by colons (like @option{--with-colons}) and
2503 print the public key data.
2504
2505 @item --fast-list-mode
2506 Changes the output of the list commands to work faster; this is achieved
2507 by leaving some parts empty. Some applications don't need the user ID
2508 and the trust information given in the listings. By using this options
2509 they can get a faster listing. The exact behaviour of this option may
2510 change in future versions.  If you are missing some information, don't
2511 use this option.
2512
2513 @item --no-literal
2514 This is not for normal use. Use the source to see for what it might be useful.
2515
2516 @item --set-filesize
2517 This is not for normal use. Use the source to see for what it might be useful.
2518
2519 @item --show-session-key
2520 Display the session key used for one message. See
2521 @option{--override-session-key} for the counterpart of this option.
2522
2523 We think that Key Escrow is a Bad Thing; however the user should have
2524 the freedom to decide whether to go to prison or to reveal the content
2525 of one specific message without compromising all messages ever
2526 encrypted for one secret key. DON'T USE IT UNLESS YOU ARE REALLY
2527 FORCED TO DO SO.
2528
2529 @item --override-session-key @code{string}
2530 Don't use the public key but the session key @code{string}. The format
2531 of this string is the same as the one printed by
2532 @option{--show-session-key}. This option is normally not used but comes
2533 handy in case someone forces you to reveal the content of an encrypted
2534 message; using this option you can do this without handing out the
2535 secret key.
2536
2537 @item --ask-sig-expire
2538 @itemx --no-ask-sig-expire
2539 When making a data signature, prompt for an expiration time. If this
2540 option is not specified, the expiration time set via
2541 @option{--default-sig-expire} is used. @option{--no-ask-sig-expire}
2542 disables this option. Note that by default, @option{--force-v3-sigs} is
2543 set which also disables this option. If you want signature expiration,
2544 you must set @option{--no-force-v3-sigs} as well as turning
2545 @option{--ask-sig-expire} on.
2546
2547 @item --default-sig-expire
2548 The default expiration time to use for signature expiration. Valid
2549 values are "0" for no expiration, a number followed by the letter d
2550 (for days), w (for weeks), m (for months), or y (for years) (for
2551 example "2m" for two months, or "5y" for five years), or an absolute
2552 date in the form YYYY-MM-DD. Defaults to "0".
2553
2554 @item --ask-cert-expire
2555 @itemx --no-ask-cert-expire
2556 When making a key signature, prompt for an expiration time. If this
2557 option is not specified, the expiration time set via
2558 @option{--default-cert-expire} is used. @option{--no-ask-cert-expire}
2559 disables this option.
2560
2561 @item --default-cert-expire
2562 The default expiration time to use for key signature expiration.
2563 Valid values are "0" for no expiration, a number followed by the
2564 letter d (for days), w (for weeks), m (for months), or y (for years)
2565 (for example "2m" for two months, or "5y" for five years), or an
2566 absolute date in the form YYYY-MM-DD. Defaults to "0".
2567
2568 @item --allow-secret-key-import
2569 This is an obsolete option and is not used anywhere.
2570
2571 @item --allow-multiple-messages
2572 @item --no-allow-multiple-messages
2573 Allow processing of multiple OpenPGP messages contained in a single file
2574 or stream.  Some programs that call GPG are not prepared to deal with
2575 multiple messages being processed together, so this option defaults to
2576 no.  Note that versions of GPG prior to 1.4.7 always allowed multiple
2577 messages.  
2578
2579 Warning: Do not use this option unless you need it as a temporary
2580 workaround!
2581
2582
2583 @item --enable-special-filenames
2584 This options enables a mode in which filenames of the form
2585 @file{-&n}, where n is a non-negative decimal number,
2586 refer to the file descriptor n and not to a file with that name.
2587
2588 @item --no-expensive-trust-checks
2589 Experimental use only.
2590
2591 @item --preserve-permissions
2592 Don't change the permissions of a secret keyring back to user
2593 read/write only. Use this option only if you really know what you are doing.
2594
2595 @item --default-preference-list @code{string}
2596 @opindex default-preference-list
2597 Set the list of default preferences to @code{string}. This preference
2598 list is used for new keys and becomes the default for "setpref" in the
2599 edit menu.
2600
2601 @item --default-keyserver-url @code{name}
2602 @opindex default-keyserver-url
2603 Set the default keyserver URL to @code{name}. This keyserver will be
2604 used as the keyserver URL when writing a new self-signature on a key,
2605 which includes key generation and changing preferences.
2606
2607 @item --list-config
2608 @opindex list-config
2609 Display various internal configuration parameters of GnuPG. This option
2610 is intended for external programs that call GnuPG to perform tasks, and
2611 is thus not generally useful. See the file @file{doc/DETAILS} in the
2612 source distribution for the details of which configuration items may be
2613 listed. @option{--list-config} is only usable with
2614 @option{--with-colons} set.
2615
2616 @item --gpgconf-list
2617 @opindex gpgconf-list
2618 This command is similar to @option{--list-config} but in general only
2619 internally used by the @command{gpgconf} tool.
2620
2621 @item --gpgconf-test
2622 @opindex gpgconf-test
2623 This is more or less dummy action.  However it parses the configuration
2624 file and returns with failure if the configuration file would prevent
2625 @command{gpg} from startup.  Thus it may be used to run a syntax check
2626 on the configuration file.
2627
2628 @end table
2629
2630 @c *******************************
2631 @c ******* Deprecated ************
2632 @c *******************************
2633 @subsection Deprecated options
2634
2635 @table @gnupgtabopt
2636
2637 @ifset gpgone
2638 @item --load-extension @code{name}
2639 Load an extension module. If @code{name} does not contain a slash it is
2640 searched for in the directory configured when GnuPG was built
2641 (generally "/usr/local/lib/gnupg"). Extensions are not generally
2642 useful anymore, and the use of this option is deprecated.
2643 @end ifset
2644
2645 @item --show-photos
2646 @itemx --no-show-photos
2647 Causes @option{--list-keys}, @option{--list-sigs},
2648 @option{--list-public-keys}, @option{--list-secret-keys}, and verifying
2649 a signature to also display the photo ID attached to the key, if
2650 any. See also @option{--photo-viewer}. These options are deprecated. Use
2651 @option{--list-options [no-]show-photos} and/or @option{--verify-options
2652 [no-]show-photos} instead.
2653
2654 @item --show-keyring
2655 Display the keyring name at the head of key listings to show which
2656 keyring a given key resides on. This option is deprecated: use
2657 @option{--list-options [no-]show-keyring} instead.
2658
2659 @ifset gpgone
2660 @item --ctapi-driver @code{file}
2661 Use @code{file} to access the smartcard reader. The current default
2662 is `libtowitoko.so'. Note that the use of this interface is
2663 deprecated; it may be removed in future releases.
2664 @end ifset
2665
2666 @item --always-trust
2667 Identical to @option{--trust-model always}. This option is deprecated.
2668
2669 @item --show-notation
2670 @itemx --no-show-notation
2671 Show signature notations in the @option{--list-sigs} or @option{--check-sigs} listings
2672 as well as when verifying a signature with a notation in it. These
2673 options are deprecated. Use @option{--list-options [no-]show-notation}
2674 and/or @option{--verify-options [no-]show-notation} instead.
2675
2676 @item --show-policy-url
2677 @itemx --no-show-policy-url
2678 Show policy URLs in the @option{--list-sigs} or @option{--check-sigs}
2679 listings as well as when verifying a signature with a policy URL in
2680 it. These options are deprecated. Use @option{--list-options
2681 [no-]show-policy-url} and/or @option{--verify-options
2682 [no-]show-policy-url} instead.
2683
2684
2685 @end table
2686
2687
2688 @c *******************************************
2689 @c ***************            ****************
2690 @c ***************   FILES    ****************
2691 @c ***************            ****************
2692 @c *******************************************
2693 @mansect files
2694 @node GPG Configuration
2695 @section Configuration files
2696
2697 There are a few configuration files to control certain aspects of
2698 @command{@gpgname}'s operation. Unless noted, they are expected in the
2699 current home directory (@pxref{option --homedir}).
2700
2701 @table @file
2702
2703 @item gpg.conf
2704 @cindex gpg.conf
2705 This is the standard configuration file read by @command{@gpgname} on
2706 startup.  It may contain any valid long option; the leading two dashes
2707 may not be entered and the option may not be abbreviated.  This default
2708 name may be changed on the command line (@pxref{option --options}).
2709 You should backup this file.
2710
2711 @end table
2712
2713 @c man:.RE
2714 Note that on larger installations, it is useful to put predefined files
2715 into the directory @file{/etc/skel/.gnupg/} so that newly created users
2716 start up with a working configuration.
2717 @ifclear gpgone
2718 For existing users the a small
2719 helper script is provided to create these files (@pxref{addgnupghome}).
2720 @end ifclear
2721
2722 For internal purposes @command{@gpgname} creates and maintains a few other
2723 files; They all live in in the current home directory (@pxref{option
2724 --homedir}).  Only the @command{@gpgname} may modify these files.
2725
2726
2727 @table @file
2728 @item ~/.gnupg/secring.gpg
2729 The secret keyring.  You should backup this file.
2730
2731 @item ~/.gnupg/secring.gpg.lock
2732 The lock file for the secret keyring.
2733
2734 @item ~/.gnupg/pubring.gpg
2735 The public keyring.  You should backup this file.
2736
2737 @item ~/.gnupg/pubring.gpg.lock
2738 The lock file for the public keyring.
2739
2740 @item ~/.gnupg/trustdb.gpg
2741 The trust database.  There is no need to backup this file; it is better
2742 to backup the ownertrust values (@pxref{option --export-ownertrust}).
2743
2744 @item ~/.gnupg/trustdb.gpg.lock
2745 The lock file for the trust database.
2746
2747 @item ~/.gnupg/random_seed
2748 A file used to preserve the state of the internal random pool.
2749
2750 @item /usr[/local]/share/gnupg/options.skel
2751 The skeleton options file.
2752
2753 @item /usr[/local]/lib/gnupg/
2754 Default location for extensions.
2755
2756 @end table
2757
2758 @c man:.RE
2759 Operation is further controlled by a few environment variables:
2760
2761 @table @asis
2762
2763 @item HOME
2764 Used to locate the default home directory.
2765
2766 @item GNUPGHOME
2767 If set directory used instead of "~/.gnupg".
2768
2769 @item GPG_AGENT_INFO
2770 Used to locate the gpg-agent.
2771 @ifset gpgone
2772 This is only honored when @option{--use-agent} is set.
2773 @end ifset
2774 The value consists of 3 colon delimited fields: The first is the path
2775 to the Unix Domain Socket, the second the PID of the gpg-agent and the
2776 protocol version which should be set to 1. When starting the gpg-agent
2777 as described in its documentation, this variable is set to the correct
2778 value. The option @option{--gpg-agent-info} can be used to override it.
2779
2780 @item PINENTRY_USER_DATA
2781 This value is passed via gpg-agent to pinentry.  It is useful to convey
2782 extra information to a custom pinentry.
2783
2784 @item COLUMNS
2785 @itemx LINES
2786 Used to size some displays to the full size of the screen.
2787
2788
2789 @item LANGUAGE
2790 Apart from its use by GNU, it is used in the W32 version to override the
2791 language selection done through the Registry.  If used and set to a
2792 valid and available language name (@var{langid}), the file with the
2793 translation is loaded from
2794 @code{@var{gpgdir}/gnupg.nls/@var{langid}.mo}.  Here @var{gpgdir} is the
2795 directory out of which the gpg binary has been loaded.  If it can't be
2796 loaded the Registry is tried and as last resort the native Windows
2797 locale system is used.  
2798
2799 @end table
2800
2801
2802 @c *******************************************
2803 @c ***************            ****************
2804 @c ***************  EXAMPLES  ****************
2805 @c ***************            ****************
2806 @c *******************************************
2807 @mansect examples
2808 @node GPG Examples
2809 @section Examples
2810
2811 @table @asis
2812
2813 @item gpg -se -r @code{Bob} @code{file}
2814 sign and encrypt for user Bob
2815
2816 @item gpg --clearsign @code{file}
2817 make a clear text signature
2818
2819 @item gpg -sb @code{file}
2820 make a detached signature
2821
2822 @item gpg -u 0x12345678 -sb @code{file}
2823 make a detached signature with the key 0x12345678
2824
2825 @item gpg --list-keys @code{user_ID}
2826 show keys
2827
2828 @item gpg --fingerprint @code{user_ID}
2829 show fingerprint
2830
2831 @item gpg --verify @code{pgpfile}
2832 @itemx gpg --verify @code{sigfile}
2833 Verify the signature of the file but do not output the data. The
2834 second form is used for detached signatures, where @code{sigfile}
2835 is the detached signature (either ASCII armored or binary) and
2836 are the signed data; if this is not given, the name of
2837 the file holding the signed data is constructed by cutting off the
2838 extension (".asc" or ".sig") of @code{sigfile} or by asking the
2839 user for the filename.
2840 @end table
2841
2842
2843 @c *******************************************
2844 @c ***************            ****************
2845 @c ***************  USER ID   ****************
2846 @c ***************            ****************
2847 @c *******************************************
2848 @mansect how to specify a user id
2849 @ifset isman
2850 @include specify-user-id.texi
2851 @end ifset
2852
2853 @mansect return value
2854 @chapheading RETURN VALUE
2855
2856 The program returns 0 if everything was fine, 1 if at least
2857 a signature was bad, and other error codes for fatal errors.
2858
2859 @mansect warnings
2860 @chapheading WARNINGS
2861
2862 Use a *good* password for your user account and a *good* passphrase
2863 to protect your secret key. This passphrase is the weakest part of the
2864 whole system. Programs to do dictionary attacks on your secret keyring
2865 are very easy to write and so you should protect your "~/.gnupg/"
2866 directory very well.
2867
2868 Keep in mind that, if this program is used over a network (telnet), it
2869 is *very* easy to spy out your passphrase!
2870
2871 If you are going to verify detached signatures, make sure that the
2872 program knows about it; either give both filenames on the command line
2873 or use @samp{-} to specify STDIN.
2874
2875 @mansect interoperability
2876 @chapheading INTEROPERABILITY WITH OTHER OPENPGP PROGRAMS
2877
2878 GnuPG tries to be a very flexible implementation of the OpenPGP
2879 standard. In particular, GnuPG implements many of the optional parts
2880 of the standard, such as the SHA-512 hash, and the ZLIB and BZIP2
2881 compression algorithms. It is important to be aware that not all
2882 OpenPGP programs implement these optional algorithms and that by
2883 forcing their use via the @option{--cipher-algo},
2884 @option{--digest-algo}, @option{--cert-digest-algo}, or
2885 @option{--compress-algo} options in GnuPG, it is possible to create a
2886 perfectly valid OpenPGP message, but one that cannot be read by the
2887 intended recipient.
2888
2889 There are dozens of variations of OpenPGP programs available, and each
2890 supports a slightly different subset of these optional algorithms.
2891 For example, until recently, no (unhacked) version of PGP supported
2892 the BLOWFISH cipher algorithm. A message using BLOWFISH simply could
2893 not be read by a PGP user. By default, GnuPG uses the standard
2894 OpenPGP preferences system that will always do the right thing and
2895 create messages that are usable by all recipients, regardless of which
2896 OpenPGP program they use. Only override this safe default if you
2897 really know what you are doing.
2898
2899 If you absolutely must override the safe default, or if the preferences
2900 on a given key are invalid for some reason, you are far better off using
2901 the @option{--pgp6}, @option{--pgp7}, or @option{--pgp8} options. These
2902 options are safe as they do not force any particular algorithms in
2903 violation of OpenPGP, but rather reduce the available algorithms to a
2904 "PGP-safe" list.
2905
2906 @mansect bugs
2907 @chapheading BUGS
2908
2909 On older systems this program should be installed as setuid(root). This
2910 is necessary to lock memory pages. Locking memory pages prevents the
2911 operating system from writing memory pages (which may contain
2912 passphrases or other sensitive material) to disk. If you get no
2913 warning message about insecure memory your operating system supports
2914 locking without being root. The program drops root privileges as soon
2915 as locked memory is allocated.
2916
2917 Note also that some systems (especially laptops) have the ability to
2918 ``suspend to disk'' (also known as ``safe sleep'' or ``hibernate'').
2919 This writes all memory to disk before going into a low power or even
2920 powered off mode.  Unless measures are taken in the operating system
2921 to protect the saved memory, passphrases or other sensitive material
2922 may be recoverable from it later.
2923
2924 Before you report a bug you should first search the mailing list
2925 archives for similar problems and second check whether such a bug has
2926 already been reported to our bug tracker at http://bugs.gnupg.org .
2927
2928 @mansect see also
2929 @ifset isman
2930 @command{gpgv}(1), 
2931 @ifclear gpgone
2932 @command{gpgsm}(1), 
2933 @command{gpg-agent}(1)
2934 @end ifclear
2935 @end ifset
2936 @include see-also-note.texi