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