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