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