* gpg.sgml: Clarify "group".
[gnupg.git] / doc / gpg.texi
1 \input texinfo
2 @c This Texinfo document has been automatically generated by
3 @c docbook2texi from a DocBook documentation.  The tool used
4 @c can be found at:
5 @c <URL:http://shell.ipoline.com/~elmert/hacks/docbook2X/>
6 @c Please send any bug reports, improvements, comments, 
7 @c patches, etc. to Steve Cheng <steve@ggi-project.org>.
8
9 @setfilename gpg.info
10 @dircategory GnuPG
11 @direntry
12 * gpg: (gpg).                         GnuPG encryption and signing tool.
13 @end direntry
14
15 @node top
16 @top gpg
17 @menu
18 @end menu
19
20 @majorheading Name
21 gpg ---- encryption and signing tool
22
23 @majorheading Synopsis
24
25 @majorheading DESCRIPTION
26 @code{gpg} is the main program for the GnuPG system.
27
28 This man page only lists the commands and options available.
29 For more verbose documentation get the GNU Privacy Handbook (GPH) or
30 one of the other documents at http://www.gnupg.org/docs.html .
31
32 Please remember that option parsing stops as soon as a non option is
33 encountered, you can explicitly stop option parsing by using the
34 special option "---".
35
36 @majorheading COMMANDS
37 @code{gpg} recognizes these commands:
38
39 @table @asis
40 @item -s, ---sign
41 Make a signature. This command may be combined
42 with ---encrypt.
43
44 @item ---clearsign
45 Make a clear text signature.
46
47 @item -b, ---detach-sign
48 Make a detached signature.
49
50 @item -e, ---encrypt
51 Encrypt data. This option may be combined with ---sign.
52
53 @item -c, ---symmetric
54 Encrypt with symmetric cipher only.
55 This command asks for a passphrase.
56
57 @item ---store
58 Store only (make a simple RFC1991 packet).
59
60 @item ---decrypt @code{file}
61 Decrypt @code{file} (or stdin if no file is specified) and
62 write it to stdout (or the file specified with
63 ---output). If the decrypted file is signed, the
64 signature is also verified. This command differs
65 from the default operation, as it never writes to the
66 filename which is included in the file and it
67 rejects files which don't begin with an encrypted
68 message.
69
70 @item ---verify @code{sigfile} @code{signed-files}
71 Assume that @code{sigfile} is a signature and verify it
72 without generating any output. With no arguments,
73 the signature packet is read from stdin. If
74 only a sigfile is given, it may be a complete
75 signature or a detached signature, in which case
76 the signed stuff is expected in a file without the
77 ".sig" or ".asc" extension. 
78 With more than
79 1 argument, the first should be a detached signature
80 and the remaining files are the signed stuff. To read the signed
81 stuff from stdin, use @samp{-} as the second filename.
82 For security reasons a detached signature cannot read the signed
83 material from stdin without denoting it in the above way.
84
85 @item ---verify-files @code{files}
86 This is a special version of the ---verify command which does not work with
87 detached signatures. The command expects the files to be verified either
88 on the command line or reads the filenames from stdin; each name must be on
89 separate line. The command is intended for quick checking of many files.
90
91 @item ---encrypt-files @code{files}
92 This is a special version of the ---encrypt command. The command expects
93 the files to be encrypted either on the command line or reads the filenames
94 from stdin; each name must be on separate line. The command is intended
95 for a quick encryption of multiple files.
96
97 @item ---decrypt-files @code{files}
98 The same as ---encrypt-files with the difference that files will be
99 decrypted. The syntax or the filenames is the same.
100
101 @item ---list-keys @code{names}
102 @itemx ---list-public-keys @code{names}
103 List all keys from the public keyrings, or just the
104 ones given on the command line.
105
106 @item ---list-secret-keys @code{names}
107 List all keys from the secret keyrings, or just the
108 ones given on the command line.
109
110 @item ---list-sigs @code{names}
111 Same as ---list-keys, but the signatures are listed too.
112
113 @item ---check-sigs @code{names}
114 Same as ---list-sigs, but the signatures are verified.
115
116 @item ---fingerprint @code{names}
117 List all keys with their fingerprints. This is the
118 same output as ---list-keys but with the additional output
119 of a line with the fingerprint. May also be combined
120 with ---list-sigs or --check-sigs.
121 If this command is given twice, the fingerprints of all
122 secondary keys are listed too.
123
124 @item ---list-packets
125 List only the sequence of packets. This is mainly
126 useful for debugging.
127
128 @item ---gen-key
129 Generate a new key pair. This command is normally only used
130 interactively.
131
132 There is an experimental feature which allows you to create keys
133 in batch mode. See the file @file{doc/DETAILS}
134 in the source distribution on how to use this.
135
136 @item ---edit-key @code{name}
137 Present a menu which enables you to do all key
138 related tasks:
139
140 @table @asis
141 @item sign
142 Make a signature on key of user @code{name}
143 If the key is not yet signed by the default
144 user (or the users given with -u), the
145 program displays the information of the key
146 again, together with its fingerprint and
147 asks whether it should be signed. This
148 question is repeated for all users specified
149 with -u.
150
151 @item lsign
152 Same as ---sign but the signature is marked as
153 non-exportable and will therefore never be used
154 by others. This may be used to make keys valid
155 only in the local environment.
156
157 @item nrsign
158 Same as ---sign but the signature is marked as non-revocable and can
159 therefore never be revoked.
160
161 @item nrlsign
162 Combines the functionality of nrsign and lsign to make a signature
163 that is both non-revocable and
164 non-exportable.
165
166 @item revsig
167 Revoke a signature. GnuPG asks for every
168 signature which has been done by one of
169 the secret keys, whether a revocation
170 certificate should be generated.
171
172 @item trust
173 Change the owner trust value. This updates the
174 trust-db immediately and no save is required.
175
176 @item disable
177 @itemx enable
178 Disable or enable an entire key. A disabled key can normally not be used
179 for encryption.
180
181 @item adduid
182 Create an alternate user id.
183
184 @item addphoto
185 Create a photographic user id.
186
187 @item deluid
188 Delete a user id.
189
190 @item addkey
191 Add a subkey to this key.
192
193 @item delkey
194 Remove a subkey.
195
196 @item addrevoker
197 Add a designated revoker.
198
199 @item revkey
200 Revoke a subkey.
201
202 @item expire
203 Change the key expiration time. If a key is
204 selected, the time of this key will be changed.
205 With no selection the key expiration of the
206 primary key is changed.
207
208 @item passwd
209 Change the passphrase of the secret key.
210
211 @item primary
212 Flag the current user id as the primary one, removes the primary user
213 id flag from all other user ids and sets the timestamp of all affected
214 self-signatures one second ahead. Note that setting a photo user ID
215 as primary makes it primary over other photo user IDs, and setting a
216 regular user ID as primary makes it primary over other regular user
217 IDs.
218
219 @item uid @code{n}
220 Toggle selection of user id with index @code{n}.
221 Use 0 to deselect all.
222
223 @item key @code{n}
224 Toggle selection of subkey with index @code{n}.
225 Use 0 to deselect all.
226
227 @item check
228 Check all selected user ids.
229
230 @item showphoto
231 Display the selected photographic user
232 id.
233
234 @item pref
235 List preferences.
236
237 @item showpref
238 More verbose preferences listing.
239
240 @item setpref @code{string}
241 Set the list of user ID preferences to @code{string}, this should be 
242 a string similar to the one printed by "pref". Using an empty string
243 will set the default preference string, using "none" will set the 
244 preferences to nil. Only available algorithms are allowed. This
245 command just initializes an internal list and does not change anything
246 unless another command which changes the self-signatures is used.
247
248 @item updpref
249 Change the preferences of all user IDs (or just of the selected ones
250 to the current list of preferences. The timestamp of all affected
251 self-signatures fill be advanced by one second.
252
253 @item toggle
254 Toggle between public and secret key listing.
255
256 @item save
257 Save all changes to the key rings and quit.
258
259 @item quit
260 Quit the program without updating the
261 key rings.
262
263 @end table
264
265 The listing shows you the key with its secondary
266 keys and all user ids. Selected keys or user ids
267 are indicated by an asterisk. The trust value is
268 displayed with the primary key: the first is the
269 assigned owner trust and the second is the calculated
270 trust value. Letters are used for the values:
271
272 @table @asis
273 @item -
274 No ownertrust assigned / not yet calculated.
275
276 @item e
277 Trust
278 calculation has failed; probably due to an expired key.
279
280 @item q
281 Not enough information for calculation.
282
283 @item n
284 Never trust this key.
285
286 @item m
287 Marginally trusted.
288
289 @item f
290 Fully trusted.
291
292 @item u
293 Ultimately trusted.
294
295 @end table
296
297 @item ---sign-key @code{name}
298 Signs a public key with your secret key. This is a shortcut version of
299 the subcommand "sign" from ---edit.
300
301 @item ---lsign-key @code{name}
302 Signs a public key with your secret key but marks it as
303 non-exportable. This is a shortcut version of the subcommand "lsign"
304 from ---edit.
305
306 @item ---nrsign-key @code{name}
307 Signs a public key with your secret key but marks it as non-revocable.
308 This is a shortcut version of the subcommand "nrsign" from ---edit.
309
310 @item ---delete-key @code{name}
311 Remove key from the public keyring
312
313 @item ---delete-secret-key @code{name}
314 Remove key from the secret and public keyring
315
316 @item ---delete-secret-and-public-key @code{name}
317 Same as ---delete-key, but if a secret key exists, it will be removed first.
318
319 @item ---gen-revoke
320 Generate a revocation certificate for the complete key. To revoke
321 a subkey or a signature, use the ---edit command.
322
323 @item ---desig-revoke
324 Generate a designated revocation certificate for a key. This allows a
325 user (with the permission of the keyholder) to revoke someone elses
326 key.
327
328 @item ---export @code{names}
329 Either export all keys from all keyrings (default
330 keyrings and those registered via option ---keyring),
331 or if at least one name is given, those of the given
332 name. The new keyring is written to stdout or to
333 the file given with option "output". Use together
334 with ---armor to mail those keys.
335
336 @item ---send-keys @code{names}
337 Same as ---export but sends the keys to a keyserver.
338 Option ---keyserver must be used to give the name
339 of this keyserver. Don't send your complete keyring
340 to a keyserver - select only those keys which are new
341 or changed by you.
342
343 @item ---export-all @code{names}
344 Same as ---export, but also exports keys which
345 are not compatible with OpenPGP.
346
347 @item ---export-secret-keys @code{names}
348 @itemx ---export-secret-subkeys @code{names}
349 Same as ---export, but exports the secret keys instead.
350 This is normally not very useful and a security risk.
351 The second form of the command has the special property to
352 render the secret part of the primary key useless; this is
353 a GNU extension to OpenPGP and other implementations can
354 not be expected to successfully import such a key.
355 See the option ---simple-sk-checksum if you want to import such an
356 exported key with an older OpenPGP implementation.
357
358 @item ---import @code{files}
359 @itemx ---fast-import @code{files}
360 Import/merge keys. This adds the given keys to the
361 keyring. The fast version is currently just a synonym.
362
363 There are a few other options which control how this command works.
364 Most notable here is the ---merge-only option which does not insert new keys
365 but does only the merging of new signatures, user-IDs and subkeys.
366
367 @item ---recv-keys @code{key IDs}
368 Import the keys with the given key IDs from a keyserver. Option
369 ---keyserver must be used to give the name of this keyserver.
370
371 @item ---search-keys @code{names}
372 Search the keyserver for the given names. Multiple names given here
373 will be joined together to create the search string for the keyserver.
374 Option ---keyserver must be used to give the name of this keyserver.
375
376 @item ---update-trustdb
377 Do trust DB maintenance. This command goes over all keys and builds
378 the Web-of-Trust. This is an interactive command because it may has to
379 ask for the "ownertrust" values of keys. The user has to give an
380 estimation in how far she trusts the owner of the displayed key to
381 correctly certify (sign) other keys. It does only ask for that value
382 if it has not yet been assigned to a key. Using the edit menu, that
383 value can be changed at any time later.
384
385 @item ---check-trustdb
386 Do trust DB maintenance without user interaction. Form time to time
387 the trust database must be updated so that expired keys and resulting
388 changes in the Web-of-Trust can be tracked. GnuPG tries to figure
389 when this is required and then does it implicitly; this command can be
390 used to force such a check. The processing is identically to that of
391 ---update-trustdb but it skips keys with a not yet defined "ownertrust".
392
393 For use with cron jobs, this command can be used together with ---batch
394 in which case the check is only done when it is due. To force a run
395 even in batch mode add the option ---yes.
396
397 @item ---export-ownertrust @code{file}
398 Store the ownertrust values into
399 @code{file} (or stdin if not given). This is useful for backup
400 purposes as these values are the only ones which can't be re-created
401 from a corrupted trust DB.
402
403 @item ---import-ownertrust @code{files}
404 Update the trustdb with the ownertrust values stored
405 in @code{files} (or stdin if not given); existing
406 values will be overwritten.
407
408 @item ---print-md @code{algo} @code{files}
409 @itemx ---print-mds @code{files}
410 Print message digest of algorithm ALGO for all given files or stdin.
411 With the second form (or a deprecated "*" as algo) digests for all
412 available algorithms are printed.
413
414 @item ---gen-random @code{0|1|2} @code{count}
415 Emit COUNT random bytes of the given quality level. If count is not given
416 or zero, an endless sequence of random bytes will be emitted.
417 PLEASE, don't use this command unless you know what you are doing; it may
418 remove precious entropy from the system!
419
420 @item ---gen-prime @code{mode} @code{bits} @code{qbits}
421 Use the source, Luke :-). The output format is still subject to change.
422
423 @item ---version
424 Print version information along with a list
425 of supported algorithms.
426
427 @item ---warranty
428 Print warranty information.
429
430 @item -h, ---help
431 Print usage information. This is a really long list even though it doesn't list
432 all options.
433
434 @end table
435
436 @majorheading OPTIONS
437 Long options can be put in an options file (default "~/.gnupg/options").
438 Do not write the 2 dashes, but simply the name of the option and any
439 required arguments. Lines with a hash as the first non-white-space
440 character are ignored. Commands may be put in this file too, but that
441 does not make sense.
442
443 @code{gpg} recognizes these options:
444
445 @table @asis
446 @item -a, ---armor
447 Create ASCII armored output.
448
449 @item -o, ---output @code{file}
450 Write output to @code{file}.
451
452 @item -u, ---local-user @code{name}
453 Use @code{name} as the user ID to sign.
454 This option is silently ignored for the list commands,
455 so that it can be used in an options file.
456
457 @item ---default-key @code{name}
458 Use @code{name} as default user ID for signatures. If this
459 is not used the default user ID is the first user ID
460 found in the secret keyring.
461
462 @item -r, ---recipient @code{name}
463 @itemx 
464 Encrypt for user id @code{name}. If this option is not
465 specified, GnuPG asks for the user-id unless ---default-recipient is given
466
467 @item ---default-recipient @code{name}
468 Use @code{name} as default recipient if option ---recipient is not used and
469 don't ask if this is a valid one. @code{name} must be non-empty.
470
471 @item ---default-recipient-self
472 Use the default key as default recipient if option ---recipient is not used and
473 don't ask if this is a valid one. The default key is the first one from the
474 secret keyring or the one set with ---default-key.
475
476 @item ---no-default-recipient
477 Reset ---default-recipient and --default-recipient-self.
478
479 @item ---encrypt-to @code{name}
480 Same as ---recipient but this one is intended for use
481 in the options file and may be used with
482 your own user-id as an "encrypt-to-self". These keys
483 are only used when there are other recipients given
484 either by use of ---recipient or by the asked user id.
485 No trust checking is performed for these user ids and
486 even disabled keys can be used.
487
488 @item ---no-encrypt-to
489 Disable the use of all ---encrypt-to keys.
490
491 @item -v, ---verbose
492 Give more information during processing. If used
493 twice, the input data is listed in detail.
494
495 @item -q, ---quiet
496 Try to be as quiet as possible.
497
498 @item -z @code{n}, ---compress @code{n}
499 Set compression level to @code{n}. A value of 0 for @code{n}
500 disables compression. Default is to use the default
501 compression level of zlib (normally 6).
502
503 @item -t, ---textmode
504 Use canonical text mode. If -t (but not
505 ---textmode) is used together with armoring
506 and signing, this enables clearsigned messages.
507 This kludge is needed for PGP compatibility;
508 normally you would use ---sign or --clearsign
509 to selected the type of the signature.
510
511 @item -n, ---dry-run
512 Don't make any changes (this is not completely implemented).
513
514 @item -i, ---interactive
515 Prompt before overwriting any files.
516
517 @item ---batch
518 Use batch mode. Never ask, do not allow interactive
519 commands.
520
521 @item ---no-tty
522 Make sure that the TTY (terminal) is never used for any output.
523 This option is needed in some cases because GnuPG sometimes prints
524 warnings to the TTY if ---batch is used.
525
526 @item ---no-batch
527 Disable batch mode. This may be of use if ---batch
528 is enabled from an options file.
529
530 @item ---yes
531 Assume "yes" on most questions.
532
533 @item ---no
534 Assume "no" on most questions.
535
536 @item ---default-cert-check-level @code{n}
537 The default to use for the check level when signing a key.
538
539 0 means you make no particular claim as to how carefully you verified
540 the key.
541
542 1 means you believe the key is owned by the person who claims to own
543 it but you could not, or did not verify the key at all. This is
544 useful for a "persona" verification, where you sign the key of a
545 pseudonymous user.
546
547 2 means you did casual verification of the key. For example, this
548 could mean that you verified that the key fingerprint and checked the
549 user ID on the key against a photo ID.
550
551 3 means you did extensive verification of the key. For example, this
552 could mean that you verified the key fingerprint with the owner of the
553 key in person, and that you checked, by means of a hard to forge
554 document with a photo ID (such as a passport) that the name of the key
555 owner matches the name in the user ID on the key, and finally that you
556 verified (by exchange of email) that the email address on the key
557 belongs to the key owner.
558
559 Note that the examples given above for levels 2 and 3 are just that:
560 examples. In the end, it is up to you to decide just what "casual"
561 and "extensive" mean to you.
562
563 This option defaults to 0.
564
565 @item ---trusted-key @code{long key ID}
566 Assume that the specified key (which must be given
567 as a full 8 byte key ID) is as trustworthy as one of
568 your own secret keys. This option is useful if you
569 don't want to keep your secret keys (or one of them)
570 online but still want to be able to check the validity of a given
571 recipient's or signator's key. 
572
573 @item ---always-trust
574 Skip key validation and assume that used keys are always fully trusted.
575 You won't use this unless you have installed some external validation
576 scheme. This option also suppresses the "[uncertain]" tag printed
577 with signature checks when there is no evidence that the user ID
578 is bound to the key.
579
580 @item ---keyserver @code{name}
581 Use @code{name} as your keyserver. This is the server that ---recv-keys,
582 ---send-keys, and --search-keys will communicate with to receive keys
583 from, send keys to, and search for keys on. The format of the
584 @code{name} is a URI: `scheme:[//]keyservername[:port]' The scheme is
585 the type of keyserver: "hkp" for the Horowitz (or compatible)
586 keyservers, "ldap" for the NAI LDAP keyserver, or "mailto" for the
587 Horowitz email keyserver. Note that your particular installation of
588 GnuPG may have other keyserver types available as well.
589
590 Most keyservers synchronize with each other, so there is generally no
591 need to send keys to more than one server. Using the command "host -l
592 pgp.net | grep wwwkeys" gives you a list of HKP keyservers. When
593 using one of the wwwkeys servers, due to load balancing using
594 round-robin DNS you may notice that you get a different key server
595 each time.
596
597 @item ---keyserver-options @code{parameters}
598 This is a space or comma delimited string that gives options for the
599 keyserver. Options can be prepended with a `no-' to give the opposite
600 meaning. While not all options are available for all keyserver types,
601 some common options are:
602
603 @table @asis
604 @item include-revoked
605 When receiving or searching for a key, include keys that are marked on
606 the keyserver as revoked. Note that this option is always set when
607 using the NAI HKP keyserver, as this keyserver does not differentiate
608 between revoked and unrevoked keys.
609
610 @item include-disabled
611 When receiving or searching for a key, include keys that are marked on
612 the keyserver as disabled. Note that this option is not used with HKP
613 keyservers, as they do not support disabling keys.
614
615 @item use-temp-files
616 On most Unix-like platforms, GnuPG communicates with the keyserver
617 helper program via pipes, which is the most efficient method. This
618 option forces GnuPG to use temporary files to communicate. On some
619 platforms (such as Win32 and RISC OS), this option is always enabled.
620
621 @item keep-temp-files
622 If using `use-temp-files', do not delete the temp files after using
623 them. This option is useful to learn the keyserver communication
624 protocol by reading the temporary files.
625
626 @item verbose
627 Tell the keyserver helper program to be more verbose. This option can
628 be repeated multiple times to increase the verbosity level.
629
630 @item honor-http-proxy
631 For keyserver schemes that use HTTP (such as HKP), try to access the
632 keyserver over the proxy set with the environment variable
633 "http_proxy".
634
635 @item auto-key-retrieve
636 This option enables the automatic retrieving of keys from a keyserver
637 when verifying signatures made by keys that are not on the local
638 keyring.
639
640 @end table
641
642 @item ---show-photos
643 Causes ---list-keys, --list-sigs, --list-public-keys, and
644 ---list-secret-keys to also display the photo ID attached to a key, if
645 any.
646 See also ---photo-viewer.
647
648 @item ---no-show-photos
649 Resets the ---show-photos flag.
650
651 @item ---photo-viewer @code{string}
652 This is the command line that should be run to view a photo ID. "%i"
653 will be expanded to a filename containing the photo. "%I" does the
654 same, except the file will not be deleted once the viewer exits.
655 Other flags are "%k" for the key ID, "%K" for the long key ID, "%f"
656 for the key fingerprint, "%t" for the extension of the image type
657 (e.g. "jpg"), "%T" for the MIME type of the image (e.g. "image/jpeg"),
658 and "%%" for an actual percent sign. If neither %i or %I are present,
659 then the photo will be supplied to the viewer on standard input.
660
661 The default viewer is "xloadimage -fork -quiet -title 'KeyID 0x%k'
662 stdin"
663
664 @item ---show-keyring
665 Causes ---list-keys, --list-public-keys, and --list-secret-keys to
666 display the name of the keyring a given key resides on. This is only
667 useful when you're listing a specific key or set of keys. It has no
668 effect when listing all keys.
669
670 @item ---keyring @code{file}
671 Add @code{file} to the list of keyrings.
672 If @code{file} begins with a tilde and a slash, these
673 are replaced by the HOME directory. If the filename
674 does not contain a slash, it is assumed to be in the
675 home-directory ("~/.gnupg" if ---homedir is not used).
676 The filename may be prefixed with a scheme:
677
678 "gnupg-ring:" is the default one.
679
680 It might make sense to use it together with ---no-default-keyring.
681
682 @item ---secret-keyring @code{file}
683 Same as ---keyring but for the secret keyrings.
684
685 @item ---homedir @code{directory}
686 Set the name of the home directory to @code{directory} If this
687 option is not used it defaults to "~/.gnupg". It does
688 not make sense to use this in a options file. This
689 also overrides the environment variable "GNUPGHOME".
690
691 @item ---charset @code{name}
692 Set the name of the native character set. This is used
693 to convert some strings to proper UTF-8 encoding.
694 Valid values for @code{name} are:
695
696 @table @asis
697 @item iso-8859-1
698 This is the default Latin 1 set.
699
700 @item iso-8859-2
701 The Latin 2 set.
702
703 @item koi8-r
704 The usual Russian set (rfc1489).
705
706 @item utf-8
707 Bypass all translations and assume
708 that the OS uses native UTF-8 encoding.
709
710 @end table
711
712 @item ---utf8-strings
713 @itemx ---no-utf8-strings
714 Assume that the arguments are already given as UTF8 strings. The default
715 (---no-utf8-strings)
716 is to assume that arguments are encoded in the character set as specified
717 by ---charset. These options affect all following arguments. Both options may
718 be used multiple times.
719
720 @item ---options @code{file}
721 Read options from @code{file} and do not try to read
722 them from the default options file in the homedir
723 (see ---homedir). This option is ignored if used
724 in an options file.
725
726 @item ---no-options
727 Shortcut for "---options /dev/null". This option is
728 detected before an attempt to open an option file.
729 Using this option will also prevent the creation of a 
730 "~./gnupg" homedir.
731
732 @item ---load-extension @code{name}
733 Load an extension module. If @code{name} does not
734 contain a slash it is searched in "/usr/local/lib/gnupg"
735 See the manual for more information about extensions.
736
737 @item ---debug @code{flags}
738 Set debugging flags. All flags are or-ed and @code{flags} may
739 be given in C syntax (e.g. 0x0042).
740
741 @item ---debug-all
742 Set all useful debugging flags.
743
744 @item ---status-fd @code{n}
745 Write special status strings to the file descriptor @code{n}.
746 See the file DETAILS in the documentation for a listing of them.
747
748 @item ---logger-fd @code{n}
749 Write log output to file descriptor @code{n} and not to stderr.
750
751 @item ---attribute-fd @code{n}
752 Write attribute subpackets to the file descriptor @code{n}. This is
753 most useful for use with ---status-fd, since the status messages are
754 needed to separate out the various subpackets from the stream
755 delivered to the file descriptor.
756
757 @item ---sk-comments
758 Include secret key comment packets when exporting secret keys. This
759 is a GnuPG extension to the OpenPGP standard, and is off by default.
760 Please note that this has nothing to do with the comments in clear
761 text signatures or armor headers.
762
763 @item ---no-sk-comments
764 Resets the ---sk-comments option.
765
766 @item ---no-comment
767 See ---sk-comments. This option is deprecated and may be removed soon.
768
769 @item ---comment @code{string}
770 Use @code{string} as comment string in clear text signatures.
771 The default is not do write a comment string.
772
773 @item ---default-comment
774 Force to write the standard comment string in clear
775 text signatures. Use this to overwrite a ---comment
776 from a config file. This option is now obsolete because there is no
777 default comment string anymore.
778
779 @item ---no-version
780 Omit the version string in clear text signatures.
781
782 @item ---emit-version
783 Force to write the version string in clear text
784 signatures. Use this to overwrite a previous
785 ---no-version from a config file.
786
787 @item -N, ---notation-data @code{name=value}
788 Put the name value pair into the signature as notation data.
789 @code{name} must consist only of alphanumeric characters, digits
790 or the underscore; the first character must not be a digit.
791 @code{value} may be any printable string; it will be encoded in UTF8,
792 so you should check that your ---charset is set correctly.
793 If you prefix @code{name} with an exclamation mark, the notation
794 data will be flagged as critical (rfc2440:5.2.3.15).
795
796 @item ---show-notation
797 Show key signature notations in the ---list-sigs or --check-sigs
798 listings.
799
800 @item ---no-show-notation
801 Do not show key signature notations in the ---list-sigs or --check-sigs
802 listings.
803
804 @item ---set-policy-url @code{string}
805 Use @code{string} as Policy URL for signatures (rfc2440:5.2.3.19).
806 If you prefix it with an exclamation mark, the policy URL
807 packet will be flagged as critical.
808
809 @item ---show-policy-url
810 Show any policy URLs set in the ---list-sigs or --check-sigs listings.
811
812 @item ---no-show-policy-url
813 Do not show any policy URLs set in the ---list-sigs or --check-sigs
814 listings.
815
816 @item ---set-filename @code{string}
817 Use @code{string} as the name of file which is stored in
818 messages.
819
820 @item ---for-your-eyes-only
821 Set the `for your eyes only' flag in the message. This causes GnuPG
822 to refuse to save the file unless the ---output option is given, and
823 PGP to use the "secure viewer" with a Tempest-resistant font to
824 display the message. This option overrides ---set-filename.
825
826 @item ---no-for-your-eyes-only
827 Resets the ---for-your-eyes-only flag.
828
829 @item ---use-embedded-filename
830 Try to create a file with a name as embedded in the data.
831 This can be a dangerous option as it allows to overwrite files.
832
833 @item ---completes-needed @code{n}
834 Number of completely trusted users to introduce a new
835 key signer (defaults to 1).
836
837 @item ---marginals-needed @code{n}
838 Number of marginally trusted users to introduce a new
839 key signer (defaults to 3)
840
841 @item ---max-cert-depth @code{n}
842 Maximum depth of a certification chain (default is 5).
843
844 @item ---cipher-algo @code{name}
845 Use @code{name} as cipher algorithm. Running the program
846 with the command ---version yields a list of supported
847 algorithms. If this is not used the cipher algorithm is
848 selected from the preferences stored with the key.
849
850 @item ---digest-algo @code{name}
851 Use @code{name} as the message digest algorithm. Running the program
852 with the command ---version yields a list of supported algorithms.
853
854 @item ---cert-digest-algo @code{name}
855 Use @code{name} as the message digest algorithm used when signing a
856 key. Running the program with the command ---version yields a list of
857 supported algorithms. Be aware that if you choose an algorithm that
858 GnuPG supports but other OpenPGP implementations do not, then some
859 users will not be able to use the key signatures you make, or quite
860 possibly your entire key.
861
862 @item ---s2k-cipher-algo @code{name}
863 Use @code{name} as the cipher algorithm used to protect secret keys.
864 The default cipher is CAST5. This cipher is also used for
865 conventional encryption if ---cipher-algo is not given.
866
867 @item ---s2k-digest-algo @code{name}
868 Use @code{name} as the digest algorithm used to mangle the
869 passphrases. The default algorithm is RIPE-MD-160.
870 This digest algorithm is also used for conventional
871 encryption if ---digest-algo is not given.
872
873 @item ---s2k-mode @code{n}
874 Selects how passphrases are mangled. If @code{n} is 0
875 a plain passphrase (which is not recommended) will be used,
876 a 1 (default) adds a salt to the passphrase and
877 a 3 iterates the whole process a couple of times.
878 Unless ---rfc1991 is used, this mode is also used
879 for conventional encryption.
880
881 @item ---simple-sk-checksum
882 Secret keys are integrity protected by using a SHA-1 checksum. This
883 method will be part of an enhanced OpenPGP specification but GnuPG
884 already uses it as a countermeasure against certain attacks. Old
885 applications don't understand this new format, so this option may be
886 used to switch back to the old behaviour. Using this this option
887 bears a security risk.
888
889 @item ---compress-algo @code{n}
890 Use compression algorithm @code{n}. Default is 2 which is RFC1950
891 compression. You may use 1 to use the old zlib version (RFC1951) which
892 is used by PGP. 0 disables compression. The default algorithm may give
893 better results because the window size is not limited to 8K. If this
894 is not used the OpenPGP behavior is used, i.e. the compression
895 algorithm is selected from the preferences; note, that this can't be
896 done if you do not encrypt the data.
897
898 @item ---disable-cipher-algo @code{name}
899 Never allow the use of @code{name} as cipher algorithm.
900 The given name will not be checked so that a later loaded algorithm
901 will still get disabled.
902
903 @item ---disable-pubkey-algo @code{name}
904 Never allow the use of @code{name} as public key algorithm.
905 The given name will not be checked so that a later loaded algorithm
906 will still get disabled.
907
908 @item ---no-sig-cache
909 Do not cache the verification status of key signatures.
910 Caching gives a much better performance in key listings. However, if
911 you suspect that your public keyring is not save against write
912 modifications, you can use this option to disable the caching. It
913 probably does not make sense to disable it because all kind of damage
914 can be done if someone else has write access to your public keyring.
915
916 @item ---no-sig-create-check
917 GnuPG normally verifies each signature right after creation to protect
918 against bugs and hardware malfunctions which could leak out bits from
919 the secret key. This extra verification needs some time (about 115%
920 for DSA keys), and so this option can be used to disable it.
921 However, due to the fact that the signature creation needs manual
922 interaction, this performance penalty does not matter in most settings.
923
924 @item ---auto-check-trustdb
925 If GnuPG feels that its information about the Web-of-Trust has to be
926 updated, it automatically runs the ---check-trustdb command 
927 internally. This may be a time consuming process.
928
929 @item ---no-auto-check-trustdb
930 Resets the ---auto-check-trustdb option.
931
932 @item ---throw-keyid
933 Do not put the keyid into encrypted packets. This option
934 hides the receiver of the message and is a countermeasure
935 against traffic analysis. It may slow down the decryption
936 process because all available secret keys are tried.
937
938 @item ---not-dash-escaped
939 This option changes the behavior of cleartext signatures
940 so that they can be used for patch files. You should not
941 send such an armored file via email because all spaces
942 and line endings are hashed too. You can not use this
943 option for data which has 5 dashes at the beginning of a
944 line, patch files don't have this. A special armor header
945 line tells GnuPG about this cleartext signature option.
946
947 @item ---escape-from-lines
948 Because some mailers change lines starting with "From "
949 to "<From " it is good to handle such lines in a special
950 way when creating cleartext signatures. All other PGP
951 versions do it this way too. This option is not enabled
952 by default because it would violate rfc2440.
953
954 @item ---passphrase-fd @code{n}
955 Read the passphrase from file descriptor @code{n}. If you use
956 0 for @code{n}, the passphrase will be read from stdin. This
957 can only be used if only one passphrase is supplied.
958 Don't use this option if you can avoid it.
959
960 @item ---command-fd @code{n}
961 This is a replacement for the deprecated shared-memory IPC mode.
962 If this option is enabled, user input on questions is not expected
963 from the TTY but from the given file descriptor. It should be used
964 together with ---status-fd. See the file doc/DETAILS in the source
965 distribution for details on how to use it.
966
967 @item ---use-agent
968 Try to use the GnuPG-Agent. Please note that this agent is still under
969 development. With this option, GnuPG first tries to connect to the
970 agent before it asks for a passphrase.
971
972 @item ---gpg-agent-info
973 Override the value of the environment variable
974 @samp{GPG_AGENT_INFO}. This is only used when ---use-agent has been given
975
976 @item ---rfc1991
977 Try to be more RFC1991 (PGP 2.x) compliant.
978
979 @item ---pgp2
980 Set up all options to be as PGP 2.x compliant as possible, and warn if
981 an action is taken (e.g. encrypting to a non-RSA key) that will create
982 a message that PGP 2.x will not be able to handle. Note that `PGP
983 2.x' here means `MIT PGP 2.6.2'. There are other versions of PGP 2.x
984 available, but the MIT release is a good common baseline.
985
986 This option implies `---rfc1991 --no-openpgp --disable-mdc
987 ---no-force-v4-certs --no-comment --escape-from-lines --force-v3-sigs
988 ---no-ask-sig-expire --no-ask-cert-expire --cipher-algo IDEA
989 ---digest-algo MD5 --compress-algo 1'
990
991 @item ---no-pgp2
992 Resets the ---pgp2 option.
993
994 @item ---pgp6
995 Set up all options to be as PGP 6 compliant as possible. This
996 restricts you to the ciphers IDEA (if the IDEA plugin is installed),
997 3DES, and CAST5, the hashes MD5, SHA1 and RIPEMD160, and the
998 compression algorithms none and ZIP. This also disables making
999 signatures with signing subkeys as PGP 6 does not understand
1000 signatures made by signing subkeys.
1001
1002 This option implies `---disable-mdc --no-comment --escape-from-lines
1003 ---force-v3-sigs --no-ask-sig-expire --compress-algo 1'
1004
1005 @item ---no-pgp6
1006 Resets the ---pgp6 option.
1007
1008 @item ---pgp7
1009 Set up all options to be as PGP 7 compliant as possible. This is
1010 identical to ---pgp6 except that the list of allowable ciphers is
1011 expanded to add AES128, AES192, AES256, and TWOFISH.
1012
1013 @item ---no-pgp7
1014 Resets the ---pgp7 option.
1015
1016 @item ---openpgp
1017 Reset all packet, cipher and digest options to OpenPGP behavior. Use
1018 this option to reset all previous options like ---rfc1991,
1019 ---force-v3-sigs, --s2k-*, --cipher-algo, --digest-algo and
1020 ---compress-algo to OpenPGP compliant values. All PGP workarounds are
1021 also disabled.
1022
1023 @item ---force-v3-sigs
1024 OpenPGP states that an implementation should generate v4 signatures
1025 but PGP versions 5 and higher only recognize v4 signatures on key
1026 material. This option forces v3 signatures for signatures on data.
1027 Note that this option overrides ---ask-sig-expire, as v3 signatures
1028 cannot have expiration dates.
1029
1030 @item ---no-force-v3-sigs
1031 Reset the ---force-v3-sigs option.
1032
1033 @item ---force-v4-certs
1034 Always use v4 key signatures even on v3 keys. This option also
1035 changes the default hash algorithm for v3 RSA keys from MD5 to SHA-1.
1036
1037 @item ---no-force-v4-certs
1038 Reset the ---force-v4-certs option.
1039
1040 @item ---force-mdc
1041 Force the use of encryption with appended manipulation code. This is
1042 always used with the newer ciphers (those with a blocksize greater
1043 than 64 bit).
1044
1045 @item ---allow-non-selfsigned-uid
1046 Allow the import and use of keys with user IDs which are not
1047 self-signed. This is not recommended, as a non self-signed user ID is
1048 trivial to forge.
1049
1050 @item ---no-allow-non-selfsigned-uid
1051 Reset the ---allow-non-selfsigned-uid option.
1052
1053 @item ---allow-freeform-uid
1054 Disable all checks on the form of the user ID while generating a new
1055 one. This option should only be used in very special environments as
1056 it does not ensure the de-facto standard format of user IDs.
1057
1058 @item ---ignore-time-conflict
1059 GnuPG normally checks that the timestamps associated with keys and
1060 signatures have plausible values. However, sometimes a signature seems to
1061 be older than the key due to clock problems. This option makes these
1062 checks just a warning.
1063
1064 @item ---ignore-valid-from
1065 GnuPG normally does not select and use subkeys created in the future. This
1066 option allows the use of such keys and thus exhibits the pre-1.0.7
1067 behaviour. You should not use this option unless you there is some
1068 clock problem.
1069
1070 @item ---ignore-crc-error
1071 The ASCII armor used by OpenPG is protected by a CRC checksum against
1072 transmission errors. Sometimes it happens that the CRC gets mangled
1073 somewhere on the transmission channel 
1074 but the actual content (which is anyway protected by
1075 the OpenPGP protocol) is still okay. This option will let gpg ignore
1076 CRC errors.
1077
1078 @item ---lock-once
1079 Lock the databases the first time a lock is requested
1080 and do not release the lock until the process
1081 terminates.
1082
1083 @item ---lock-multiple
1084 Release the locks every time a lock is no longer
1085 needed. Use this to override a previous ---lock-once
1086 from a config file.
1087
1088 @item ---lock-never
1089 Disable locking entirely. This option should be used only in very
1090 special environments, where it can be assured that only one process
1091 is accessing those files. A bootable floppy with a stand-alone
1092 encryption system will probably use this. Improper usage of this
1093 option may lead to data and key corruption.
1094
1095 @item ---no-random-seed-file
1096 GnuPG uses a file to store its internal random pool over invocations.
1097 This makes random generation faster; however sometimes write operations
1098 are not desired. This option can be used to achieve that with the cost of
1099 slower random generation.
1100
1101 @item ---no-verbose
1102 Reset verbose level to 0.
1103
1104 @item ---no-greeting
1105 Suppress the initial copyright message but do not
1106 enter batch mode.
1107
1108 @item ---no-secmem-warning
1109 Suppress the warning about "using insecure memory".
1110
1111 @item ---no-permission-warning
1112 Suppress the warning about unsafe file permissions.
1113
1114 @item ---no-armor
1115 Assume the input data is not in ASCII armored format.
1116
1117 @item ---no-default-keyring
1118 Do not add the default keyrings to the list of
1119 keyrings.
1120
1121 @item ---skip-verify
1122 Skip the signature verification step. This may be
1123 used to make the decryption faster if the signature
1124 verification is not needed.
1125
1126 @item ---with-colons
1127 Print key listings delimited by colons. Note, that the output will be
1128 encoded in UTF-8 regardless of any ---charset setting.
1129
1130 @item ---with-key-data
1131 Print key listings delimited by colons (like ---with-colons) and print the public key data.
1132
1133 @item ---with-fingerprint
1134 Same as the command ---fingerprint but changes only the format of the output
1135 and may be used together with another command.
1136
1137 @item ---fast-list-mode
1138 Changes the output of the list commands to work faster; this is achieved
1139 by leaving some parts empty. Some applications don't need the user ID and
1140 the trust information given in the listings. By using this options they
1141 can get a faster listing. The exact behaviour of this option may change
1142 in future versions.
1143
1144 @item ---fixed-list-mode
1145 Do not merge user ID and primary key in ---with-colon listing mode and
1146 print all timestamps as seconds since 1970-01-01.
1147
1148 @item ---list-only
1149 Changes the behaviour of some commands. This is like ---dry-run but
1150 different in some cases. The semantic of this command may be extended in
1151 the future. Currently it only skips the actual decryption pass and
1152 therefore enables a fast listing of the encryption keys.
1153
1154 @item ---no-literal
1155 This is not for normal use. Use the source to see for what it might be useful.
1156
1157 @item ---set-filesize
1158 This is not for normal use. Use the source to see for what it might be useful.
1159
1160 @item ---emulate-md-encode-bug
1161 GnuPG versions prior to 1.0.2 had a bug in the way a signature was encoded.
1162 This options enables a workaround by checking faulty signatures again with
1163 the encoding used in old versions. This may only happen for ElGamal signatures
1164 which are not widely used.
1165
1166 @item ---show-session-key
1167 Display the session key used for one message. See ---override-session-key
1168 for the counterpart of this option.
1169
1170 We think that Key-Escrow is a Bad Thing; however the user should
1171 have the freedom to decide whether to go to prison or to reveal the content of
1172 one specific message without compromising all messages ever encrypted for one
1173 secret key. DON'T USE IT UNLESS YOU ARE REALLY FORCED TO DO SO.
1174
1175 @item ---override-session-key @code{string} 
1176 Don't use the public key but the session key @code{string}. The format of this
1177 string is the same as the one printed by ---show-session-key. This option
1178 is normally not used but comes handy in case someone forces you to reveal the
1179 content of an encrypted message; using this option you can do this without
1180 handing out the secret key.
1181
1182 @item ---ask-sig-expire
1183 When making a data signature, prompt for an expiration time. If this
1184 option is not specified, the expiration time is "never".
1185
1186 @item ---no-ask-sig-expire
1187 Resets the ---ask-sig-expire option.
1188
1189 @item ---ask-cert-expire
1190 When making a key signature, prompt for an expiration time. If this
1191 option is not specified, the expiration time is "never".
1192
1193 @item ---no-ask-cert-expire
1194 Resets the ---ask-cert-expire option.
1195
1196 @item ---expert
1197 Allow the user to do certain nonsensical or "silly" things like
1198 signing an expired or revoked key, or certain potentially incompatible
1199 things like generating deprecated key types. This also disables
1200 certain warning messages about potentially incompatible actions. As
1201 the name implies, this option is for experts only. If you don't fully
1202 understand the implications of what it allows you to do, leave this
1203 off.
1204
1205 @item ---no-expert
1206 Resets the ---expert option.
1207
1208 @item ---merge-only
1209 Don't insert new keys into the keyrings while doing an import.
1210
1211 @item ---allow-secret-key-import
1212 This is an obsolete option and is not used anywhere.
1213
1214 @item ---try-all-secrets
1215 Don't look at the key ID as stored in the message but try all secret keys in
1216 turn to find the right decryption key. This option forces the behaviour as
1217 used by anonymous recipients (created by using ---throw-keyid) and might come
1218 handy in case where an encrypted message contains a bogus key ID.
1219
1220 @item ---enable-special-filenames
1221 This options enables a mode in which filenames of the form
1222 @file{-&n}, where n is a non-negative decimal number,
1223 refer to the file descriptor n and not to a file with that name.
1224
1225 @item ---no-expensive-trust-checks
1226 Experimental use only.
1227
1228 @item ---group @code{name=value}
1229 Sets up a name group, which is similar to aliases in email programs.
1230 Any time the group name is a receipient (-r or ---recipient), it will
1231 be expanded to the values specified. Note there is only one level of
1232 expansion - you cannot make an group that points to another group.
1233
1234 @item ---preserve-permissions
1235 Don't change the permissions of a secret keyring back to user
1236 read/write only. Use this option only if you really know what you are doing.
1237
1238 @item ---personal-cipher-preferences @code{string}
1239 Set the list of personal cipher preferences to @code{string}, this list
1240 should be a string similar to the one printed by the command "pref" in
1241 the edit menu. This allows the user to factor in their own preferred
1242 algorithms when algorithms are chosen via recipient key preferences.
1243
1244 @item ---personal-digest-preferences @code{string}
1245 Set the list of personal digest preferences to @code{string}, this list
1246 should be a string similar to the one printed by the command "pref" in
1247 the edit menu. This allows the user to factor in their own preferred
1248 algorithms when algorithms are chosen via recipient key preferences.
1249
1250 @item ---personal-compress-preferences @code{string}
1251 Set the list of personal compression preferences to @code{string}, this
1252 list should be a string similar to the one printed by the command
1253 "pref" in the edit menu. This allows the user to factor in their own
1254 preferred algorithms when algorithms are chosen via recipient key
1255 preferences.
1256
1257 @item ---default-preference-list @code{string}
1258 Set the list of default preferences to @code{string}, this list should
1259 be a string similar to the one printed by the command "pref" in the
1260 edit menu. This affects both key generation and "updpref" in the edit
1261 menu.
1262
1263 @end table
1264
1265 @majorheading How to specify a user ID
1266 There are different ways on how to specify a user ID to GnuPG;
1267 here are some examples:
1268
1269 @table @asis
1270 @item 
1271 @item 234567C4
1272 @itemx 0F34E556E
1273 @itemx 01347A56A
1274 @itemx 0xAB123456
1275 Here the key ID is given in the usual short form.
1276
1277 @item 234AABBCC34567C4
1278 @itemx 0F323456784E56EAB
1279 @itemx 01AB3FED1347A5612
1280 @itemx 0x234AABBCC34567C4
1281 Here the key ID is given in the long form as used by OpenPGP
1282 (you can get the long key ID using the option ---with-colons).
1283
1284 @item 1234343434343434C434343434343434
1285 @itemx 123434343434343C3434343434343734349A3434
1286 @itemx 0E12343434343434343434EAB3484343434343434
1287 @itemx 0xE12343434343434343434EAB3484343434343434
1288 The best way to specify a key ID is by using the fingerprint of
1289 the key. This avoids any ambiguities in case that there are duplicated
1290 key IDs (which are really rare for the long key IDs).
1291
1292 @item =Heinrich Heine <heinrichh@@uni-duesseldorf.de>
1293 Using an exact to match string. The equal sign indicates this.
1294
1295 @item <heinrichh@@uni-duesseldorf.de>
1296 Using the email address part which must match exactly. The left angle bracket
1297 indicates this email address mode.
1298
1299 @item +Heinrich Heine duesseldorf
1300 All words must match exactly (not case sensitive) but can appear in
1301 any order in the user ID. Words are any sequences of letters,
1302 digits, the underscore and all characters with bit 7 set.
1303
1304 @item Heine
1305 @itemx *Heine
1306 By case insensitive substring matching. This is the default mode but
1307 applications may want to explicitly indicate this by putting the asterisk
1308 in front.
1309
1310 @end table
1311
1312 Note that you can append an exclamation mark to key IDs or
1313 fingerprints. This flag tells GnuPG to use exactly the given primary
1314 or secondary key and not to try to figure out which secondary or
1315 primary key to use.
1316
1317 @majorheading RETURN VALUE
1318 The program returns 0 if everything was fine, 1 if at least
1319 a signature was bad, and other error codes for fatal errors.
1320
1321 @majorheading EXAMPLES
1322 @table @asis
1323 @item gpg -se -r @code{Bob} @code{file}
1324 sign and encrypt for user Bob
1325
1326 @item gpg ---clearsign @code{file}
1327 make a clear text signature
1328
1329 @item gpg -sb @code{file}
1330 make a detached signature
1331
1332 @item gpg ---list-keys @code{user_ID}
1333 show keys
1334
1335 @item gpg ---fingerprint @code{user_ID}
1336 show fingerprint
1337
1338 @item gpg ---verify @code{pgpfile}
1339 @itemx gpg ---verify @code{sigfile} @code{files}
1340 Verify the signature of the file but do not output the data. The second form
1341 is used for detached signatures, where @code{sigfile} is the detached
1342 signature (either ASCII armored of binary) and @code{files} are the signed
1343 data; if this is not given the name of the file holding the signed data is
1344 constructed by cutting off the extension (".asc" or ".sig") of
1345 @code{sigfile} or by asking the user for the filename.
1346
1347 @end table
1348
1349 @majorheading ENVIRONMENT
1350 @table @asis
1351 @item HOME
1352 Used to locate the default home directory.
1353
1354 @item GNUPGHOME
1355 If set directory used instead of "~/.gnupg".
1356
1357 @item GPG_AGENT_INFO
1358 Used to locate the gpg-agent; only honored when
1359 ---use-agent is set. The value consists of 3 colon delimited fields: 
1360 The first is the path to the Unix Domain Socket, the second the PID of
1361 the gpg-agent and the protocol version which should be set to 1. When
1362 starting the gpg-agent as described in its documentation, this
1363 variable is set to the correct value. The option ---gpg-agent-info can
1364 be used to overide it.
1365
1366 @item http_proxy
1367 Only honored when the option ---honor-http-proxy is set.
1368
1369 @end table
1370
1371 @majorheading FILES
1372 @table @asis
1373 @item ~/.gnupg/secring.gpg
1374 The secret keyring
1375
1376 @item ~/.gnupg/secring.gpg.lock
1377 and the lock file
1378
1379 @item ~/.gnupg/pubring.gpg
1380 The public keyring
1381
1382 @item ~/.gnupg/pubring.gpg.lock
1383 and the lock file
1384
1385 @item ~/.gnupg/trustdb.gpg
1386 The trust database
1387
1388 @item ~/.gnupg/trustdb.gpg.lock
1389 and the lock file
1390
1391 @item ~/.gnupg/random_seed
1392 used to preserve the internal random pool
1393
1394 @item ~/.gnupg/options
1395 May contain options
1396
1397 @item /usr[/local]/share/gnupg/options.skel
1398 Skeleton options file
1399
1400 @item /usr[/local]/lib/gnupg/
1401 Default location for extensions
1402
1403 @end table
1404
1405 @majorheading WARNINGS
1406 Use a *good* password for your user account and a *good* passphrase
1407 to protect your secret key. This passphrase is the weakest part of the
1408 whole system. Programs to do dictionary attacks on your secret keyring
1409 are very easy to write and so you should protect your "~/.gnupg/"
1410 directory very well.
1411
1412 Keep in mind that, if this program is used over a network (telnet), it
1413 is *very* easy to spy out your passphrase!
1414
1415 If you are going to verify detached signatures, make sure that the
1416 program knows about it; either be giving both filenames on the
1417 commandline or using @samp{-} to specify stdin.
1418
1419 @majorheading BUGS
1420 On many systems this program should be installed as setuid(root). This
1421 is necessary to lock memory pages. Locking memory pages prevents the
1422 operating system from writing memory pages to disk. If you get no
1423 warning message about insecure memory your operating system supports
1424 locking without being root. The program drops root privileges as soon
1425 as locked memory is allocated.
1426
1427 @bye