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