See ChangeLog: Tue Jul 13 17:39:25 CEST 1999 Werner Koch
[gnupg.git] / doc / gpg.sgml
1 <!-- gpg.sgml - the man page for GnuPG
2     Copyright (C) 1998, 1999 Free Software Foundation, Inc.
3
4     This file is part of GnuPG.
5
6     GnuPG is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     GnuPG is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with this program; if not, write to the Free Software
18     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19 -->
20 <!-- This file should be processed by docbook-to-man to
21      create a manual page.  This program has currenlty the bug
22      not to remove leading white space. So this source file does
23      not look very pretty
24
25     FIXME: generated a file with entity (e.g. pathnames) from the
26     configure scripts and include it here
27 -->
28
29
30 <!doctype refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
31 <!entity ParmDir "<parameter>directory</parameter>">
32 <!entity ParmFile "<parameter>file</parameter>">
33 <!entity OptParmFile "<optional>&ParmFile;</optional>">
34 <!entity ParmFiles "<parameter>files</parameter>">
35 <!entity OptParmFiles "<optional>&ParmFiles;</optional>">
36 <!entity ParmNames "<parameter>names</parameter>">
37 <!entity OptParmNames "<optional>&ParmNames;</optional>">
38 <!entity ParmName  "<parameter>name</parameter>">
39 <!entity OptParmName  "<optional>&ParmName;</optional>">
40 <!entity ParmKeyIDs "<parameter>key IDs</parameter>">
41 <!entity ParmN      "<parameter>n</parameter>">
42 <!entity ParmFlags  "<parameter>flags</parameter>">
43 <!entity ParmString "<parameter>string</parameter>">
44 <!entity ParmValue  "<parameter>value</parameter>">
45 <!entity ParmNameValue  "<parameter>name=value</parameter>">
46 ]>
47
48 <refentry id="gpg">
49 <refmeta>
50   <refentrytitle>gpg</refentrytitle>
51   <manvolnum>1</manvolnum>
52   <refmiscinfo class="gnu">GNU Tools</refmiscinfo>
53 </refmeta>
54 <refnamediv>
55   <refname/gpg/
56   <refpurpose>encryption and signing tool</>
57 </refnamediv>
58 <refsynopsisdiv>
59   <synopsis>
60 <command>gpg</>
61  <optional>--homedir <parameter/name/</optional>
62  <optional>--options <parameter/file/</optional>
63  <optional><parameter/options/</optional>
64  <parameter>command</>
65  <optional><parameter/args/</optional>
66   </synopsis>
67 </refsynopsisdiv>
68
69 <refsect1>
70     <title>DESCRIPTION</title>
71     <para>
72 <command/gpg/ is the main program for the GnuPG system.
73     </para>
74 </refsect1>
75
76 <refsect1>
77 <title>COMMANDS</title>
78 <para>
79 <command/gpg/ recognizes these commands:
80 </para>
81
82 <variablelist>
83
84 <varlistentry>
85 <term>-s, --sign</term>
86 <listitem><para>
87 Make a signature. This command may be combined
88 with --encrypt.
89 </para></listitem></varlistentry>
90
91
92 <varlistentry>
93 <term>--clearsign</term>
94 <listitem><para>
95 Make a clear text signature.
96 </para></listitem></varlistentry>
97
98
99 <varlistentry>
100 <term>-b, --detach-sign</term>
101 <listitem><para>
102 Make a detached signature.
103 </para></listitem></varlistentry>
104
105
106 <varlistentry>
107 <term>-e, --encrypt</term>
108 <listitem><para>
109 Encrypt data. This option may be combined with --sign.
110 </para></listitem></varlistentry>
111
112
113 <varlistentry>
114 <term>-c, --symmetric</term>
115 <listitem><para>
116 Encrypt with symmetric cipher only
117 This command asks for a passphrase.
118 </para></listitem></varlistentry>
119
120 <varlistentry>
121 <term>--store</term>
122 <listitem><para>
123 Store only (make a simple RFC1991 packet).
124 </para></listitem></varlistentry>
125
126
127 <varlistentry>
128 <term>--decrypt &OptParmFile;</term>
129 <listitem><para>
130 Decrypt &ParmFile; (or stdin if no file is specified) and
131 write it to stdout (or the file specified with
132 --output). If the decrypted file is signed, the
133 signature is also verified. This command differs
134 from the default operation, as it never writes to the
135 filename which is included in the file and it
136 rejects files which don't begin with an encrypted
137 message.
138 </para></listitem></varlistentry>
139
140
141 <varlistentry>
142 <term>--verify <optional><optional><parameter/sigfile/</optional>
143  <optional><parameter/signed-files/</optional></optional></term>
144 <listitem><para>
145 Assume that <parameter/sigfile/ is a signature and verify it
146 without generating any output.  With no arguments,
147 the signature packet is read from stdin (it may be a
148 detached signature when not used in batch mode). If
149 only a sigfile is given, it may be a complete
150 signature or a detached signature, in which case
151 the signed stuff is expected in a file without the
152 ".sig" or ".asc" extension (if such a file does
153 not exist it is expected at stdin; use a single dash ("-") as
154 filename to force a read from stdin). With more than
155 1 argument, the first should be a detached signature
156 and the remaining files are the signed stuff.
157 </para></listitem></varlistentry>
158
159 <!--
160 B<-k> [I<username>] [I<keyring>]
161     Kludge to be somewhat compatible with PGP.
162     Without arguments, all public keyrings are listed.
163     With one argument, only I<keyring> is listed.
164     Special combinations are also allowed, but they may
165     give strange results when combined with more options.
166     B<-kv>    Same as B<-k>
167     B<-kvv>   List the signatures with every key.
168     B<-kvvv>  Additionally check all signatures.
169     B<-kvc>   List fingerprints
170     B<-kvvc>  List fingerprints and signatures
171
172     B<This command may be removed in the future!>
173 -->
174
175 <varlistentry>
176 <term>--list-keys &OptParmNames;</term>
177 <term>--list-public-keys &OptParmNames;</term>
178 <listitem><para>
179 List all keys from the public keyrings, or just the
180 ones given on the command line.
181 </para></listitem></varlistentry>
182
183
184 <varlistentry>
185 <term>--list-secret-keys &OptParmNames;</term>
186 <listitem><para>
187 List all keys from the secret keyrings, or just the
188 ones given on the command line.
189 </para></listitem></varlistentry>
190
191
192 <varlistentry>
193 <term>--list-sigs &OptParmNames;</term>
194 <listitem><para>
195 Same as --list-keys, but the signatures are listed too.
196 </para></listitem></varlistentry>
197
198
199 <varlistentry>
200 <term>--check-sigs &OptParmNames;</term>
201 <listitem><para>
202 Same as --list-sigs, but the signatures are verified.
203 </para></listitem></varlistentry>
204
205
206 <varlistentry>
207 <term>--fingerprint &OptParmNames;</term>
208 <listitem><para>
209 List all keys with their fingerprints. This is the
210 same output as --list-keys but with the additional output
211 of a line with the fingerprint. May also be combined
212 with --list-sigs or --check-sigs.
213 If this command is given twice, the fingerprints of all
214 secondary keys are listed too.
215 </para></listitem></varlistentry>
216
217
218 <varlistentry>
219 <term>--list-packets</term>
220 <listitem><para>
221 List only the sequence of packets. This is mainly
222 useful for debugging.
223 </para></listitem></varlistentry>
224
225
226 <varlistentry>
227 <term>--gen-key</term>
228 <listitem><para>
229 Generate a new key pair. This command can only be
230 used interactive.
231 </para></listitem></varlistentry>
232
233
234 <varlistentry>
235 <term>--edit-key &ParmName;</term>
236 <listitem><para>
237 Present a menu which enables you to do all key
238 related tasks:</para>
239     <variablelist>
240
241     <varlistentry>
242     <term>sign</term>
243     <listitem><para>
244 Make a signature on key of user &ParmName;
245 If the key is not yet signed by the default
246 user (or the users given with -u), the
247 program displays the information of the key
248 again, together with its fingerprint and
249 asks whether it should be signed. This
250 question is repeated for all users specified
251 with -u.</para></listitem></varlistentry>
252     <varlistentry>
253     <term>lsign</term>
254     <listitem><para>
255 Same as --sign but the signature is marked as
256 non-exportbale and will therefore never be used
257 by others.  This may be used to make keys valid
258 only in the local environment.</para></listitem></varlistentry>
259     <varlistentry>
260     <term>revsig</term>
261     <listitem><para>
262 Revoke a signature.  GnuPG asks for every
263 every signature which has been done by one of
264 the secret keys, whether a revocation
265 certificate should be generated.</para></listitem></varlistentry>
266     <varlistentry>
267     <term>trust</term>
268     <listitem><para>
269 Change the owner trust value. This updates the
270 trust-db immediately and no save is required.</para></listitem></varlistentry>
271     <varlistentry>
272     <term>disable</term>
273     <term>enable</term>
274     <listitem><para>
275 Disable or enable an entire key. A disabled key can normally not be used
276 for encryption.</para></listitem></varlistentry>
277     <varlistentry>
278     <term>adduid</term>
279     <listitem><para>
280 Create an alternate user id.</para></listitem></varlistentry>
281     <varlistentry>
282     <term>deluid</term>
283     <listitem><para>
284 Delete an user id.</para></listitem></varlistentry>
285     <varlistentry>
286     <term>addkey</term>
287     <listitem><para>
288 Add a subkey to this key.</para></listitem></varlistentry>
289     <varlistentry>
290     <term>delkey</term>
291     <listitem><para>
292 Remove a subkey.</para></listitem></varlistentry>
293     <varlistentry>
294     <term>revkey</term>
295     <listitem><para>
296 Revoke a subkey.</para></listitem></varlistentry>
297     <varlistentry>
298     <term>expire</term>
299     <listitem><para>
300 Change the key expiration time.  If a key is
301 selected, the time of this key will be changed.
302 With no selection the key expiration of the
303 primary key is changed.</para></listitem></varlistentry>
304     <varlistentry>
305     <term>passwd</term>
306     <listitem><para>
307 Change the passphrase of the secret key.</para></listitem></varlistentry>
308     <varlistentry>
309     <term>uid &ParmN;</term>
310     <listitem><para>
311 Toggle selection of user id with index &ParmN;.
312 Use 0 to deselect all.</para></listitem></varlistentry>
313     <varlistentry>
314     <term>key &ParmN;</term>
315     <listitem><para>
316 Toggle selection of subkey with index &ParmN;.
317 Use 0 to deselect all.</para></listitem></varlistentry>
318     <varlistentry>
319     <term>check</term>
320     <listitem><para>
321 Check all selected user ids.</para></listitem></varlistentry>
322     <varlistentry>
323     <term>pref</term>
324     <listitem><para>
325 List preferences.</para></listitem></varlistentry>
326     <varlistentry>
327     <term>toggle</term>
328     <listitem><para>
329 Toggle between public and secret key listing.</para></listitem></varlistentry>
330     <varlistentry>
331     <term>save</term>
332     <listitem><para>
333 Save all changes to the key rings and quit.</para></listitem></varlistentry>
334     <varlistentry>
335     <term>quit</term>
336     <listitem><para>
337 Quit the program without updating the
338 key rings.</para></listitem></varlistentry>
339     </variablelist>
340     <para>
341 The listing shows you the key with its secondary
342 keys and all user ids. Selected keys or user ids
343 are indicated by an asterisk. The trust value is
344 displayed with the primary key: the first is the
345 assigned owner trust and the second is the calculated
346 trust value.  Letters are used for the values:</para>
347     <variablelist>
348       <varlistentry><term>-</term><listitem><para>No ownertrust assigned / not yet calculated.</para></listitem></varlistentry>
349       <varlistentry><term>e</term><listitem><para>Trust calculation has failed.</para></listitem></varlistentry>
350       <varlistentry><term>q</term><listitem><para>Not enough information for calculation.</para></listitem></varlistentry>
351       <varlistentry><term>n</term><listitem><para>Never trust this key.</para></listitem></varlistentry>
352       <varlistentry><term>m</term><listitem><para>Marginally trusted.</para></listitem></varlistentry>
353       <varlistentry><term>f</term><listitem><para>Fully trusted.</para></listitem></varlistentry>
354       <varlistentry><term>u</term><listitem><para>Ultimately trusted.</para></listitem></varlistentry>
355     </variablelist>
356 </listitem></varlistentry>
357
358 <varlistentry>
359 <term>--sign-key &ParmName;</term>
360 <listitem><para>
361 Sign a public key with you secret key.  This is a shortcut version
362 of the subcommand <term>sign</term> from --edit.
363 </para></listitem></varlistentry>
364
365 <varlistentry>
366 <term>--lsign-key &ParmName;</term>
367 <listitem><para>
368 Sign a public key with you secret key but mark it as non-exportable.
369 This is a shortcut version of the subcommand <term>lsign</term> from --edit.
370 </para></listitem></varlistentry>
371
372 <varlistentry>
373 <term>--delete-key &ParmName;</term>
374 <listitem><para>
375 Remove key from the public keyring
376 </para></listitem></varlistentry>
377
378 <varlistentry>
379 <term>--delete-secret-key  &ParmName;</term>
380 <listitem><para>
381 Remove key from the secret and public keyring
382 </para></listitem></varlistentry>
383
384 <varlistentry>
385 <term>--gen-revoke</term>
386 <listitem><para>
387 Generate a revocation certificate for the complete key. To revoke
388 a subkey or a signature, use the --edit command.
389 </para></listitem></varlistentry>
390
391
392 <varlistentry>
393 <term>--export &OptParmNames;</term>
394 <listitem><para>
395 Either export all keys from all keyrings (default
396 keyrings and those registered via option --keyring),
397 or if at least one name is given, those of the given
398 name. The new keyring is written to stdout or to
399 the file given with option "output".  Use together
400 with --armor to mail those keys.
401 </para></listitem></varlistentry>
402
403
404 <varlistentry>
405 <term>--send-keys &OptParmNames;</term>
406 <listitem><para>
407 Same as --export but sends the keys to a keyserver.
408 Option --keyserver must be used to give the name
409 of this keyserver. Don't send your complete keyring
410 to a keyserver - select only those keys which are new
411 or changed by you.
412 </para></listitem></varlistentry>
413
414
415 <varlistentry>
416 <term>--export-all &OptParmNames;</term>
417 <listitem><para>
418 Same as --export, but does also export keys which
419 are not compatible to OpenPGP.
420 </para></listitem></varlistentry>
421
422
423 <varlistentry>
424 <term>--export-secret-keys &OptParmNames;</term>
425 <listitem><para>
426 Same as --export, but does export the secret keys.
427 This is normally not very useful and a security risk.
428 </para></listitem></varlistentry>
429
430
431 <varlistentry>
432 <term>--import &OptParmFiles;</term>
433 <term>--fast-import &OptParmFiles;</term>
434 <listitem><para>
435 Import/merge keys.  The fast version does not build
436 the trustdb; this can be done at any time with the
437 command --update-trustdb.
438 </para></listitem></varlistentry>
439
440
441 <varlistentry>
442 <term>--recv-keys &ParmKeyIDs;</term>
443 <listitem><para>
444 Import the keys with the given key IDs from a HKP
445 keyserver. Option --keyserver must be used to
446 give the name of this keyserver.
447 </para></listitem></varlistentry>
448
449
450 <varlistentry>
451 <term>--export-ownertrust</term>
452 <listitem><para>
453 List the assigned ownertrust values in ASCII format
454 for backup purposes
455 </para></listitem></varlistentry>
456
457
458 <varlistentry>
459 <term>--import-ownertrust &OptParmFiles;</term>
460 <listitem><para>
461 Update the trustdb with the ownertrust values stored
462 in &ParmFiles; (or stdin if not given); existing
463 values will be overwritten.
464 </para></listitem></varlistentry>
465
466
467 <varlistentry>
468 <term>--print-md <parameter>algo</parameter> &OptParmFiles;</term>
469 <listitem><para>
470 Print message digest og algorithm ALGO for all given files of stdin.
471 If "*" is used for the algorithm, digests for all available algorithms
472 are printed.
473 </para></listitem></varlistentry>
474
475
476 <varlistentry>
477 <term>--gen-random <parameter>0|1|2</parameter>
478                    <optional><parameter>count</parameter></optional></term>
479 <listitem><para>
480 Emit COUNT random bytes of the given quality level. If count is not given
481 or zero, an endless sequenece of random bytes will be emitted.
482 PLEASE, don't use this command unless you know waht you are doing, it may
483 remove precious entropy from the system!
484 </para></listitem></varlistentry>
485
486 <varlistentry>
487 <term>--gen-prime <parameter>mode</parameter>
488                   <parameter>bits</parameter>
489                    <optional><parameter>qbits</parameter></optional></term>
490 <listitem><para>
491 Use the source, Luke :-). The output format is still subject to change.
492 </para></listitem></varlistentry>
493
494
495 <varlistentry>
496 <term>--version</term>
497 <listitem><para>
498 Print version information along with a list
499 of supported algorithms.
500 </para></listitem></varlistentry>
501
502
503 <varlistentry>
504 <term>--warranty</term>
505 <listitem><para>
506 Print warranty information.
507 </para></listitem></varlistentry>
508
509
510 <varlistentry>
511 <term>-h, --help</term>
512 <listitem><para>
513 Print usage information.  This is a really long list even it does list
514 not all options.
515 </para></listitem></varlistentry>
516
517
518
519 </variablelist>
520 </refsect1>
521
522 <refsect1>
523 <title>OPTIONS</title>
524 <para>
525 Long options can be put in an options file (default "~/.gnupg/options").
526 Do not write the 2 dashes, but simply the name of the option and any
527 required arguments. Lines with a hash as the first non-white-space
528 character are ignored. Commands may be put in this file too, but that
529 does not make sense.
530 </para>
531 <para>
532 <command/gpg/ recognizes these options:
533 </para>
534
535 <variablelist>
536
537
538 <varlistentry>
539 <term>-a, --armor</term>
540 <listitem><para>
541 Create ASCII armored output.
542 </para></listitem></varlistentry>
543
544
545 <varlistentry>
546 <term>-o, --output &ParmFile;</term>
547 <listitem><para>
548 Write output to &ParmFile;.
549 </para></listitem></varlistentry>
550
551
552 <varlistentry>
553 <term>-u, --local-user &ParmName;</term>
554 <listitem><para>
555 Use &ParmName as the user ID to sign.
556 This option is silently ignored for the list commands,
557 so that it can be used in an options file.
558 </para></listitem></varlistentry>
559
560
561 <varlistentry>
562 <term>--default-key &ParmName;</term>
563 <listitem><para>
564 Use &ParmName; as default user ID for signatures.  If this
565 is not used the default user ID is the first user ID
566 found in the secret keyring.
567 </para></listitem></varlistentry>
568
569
570 <varlistentry>
571 <term>-r, --recipient &ParmName;</term>
572 <term></term>
573 <listitem><para>
574 Encrypt for user id &ParmName;. If this option is not
575 specified, GnuPG asks for the user-id unless --default-recipient is given
576 </para></listitem></varlistentry>
577
578 <varlistentry>
579 <term>--default-recipient &ParmName;</term>
580 <listitem><para>
581 Use &ParmName; as default recipient if option --recipient is not used and
582 don't ask if this is a valid one. &ParmName; must be a non empty.
583 </para></listitem></varlistentry>
584
585 <varlistentry>
586 <term>--default-recipient-self</term>
587 <listitem><para>
588 Use the default key as default recipient if option --recipient is not used and
589 don't ask if this is a valid one. The default key is the first one from the
590 secret keyring or the one set with --default-key.
591 </para></listitem></varlistentry>
592
593
594 <varlistentry>
595 <term>--no-default-recipient</term>
596 <listitem><para>
597 Reset --default-recipient and --default-recipient-self.
598 </para></listitem></varlistentry>
599
600 <varlistentry>
601 <term>--encrypt-to &ParmName;</term>
602 <listitem><para>
603 Same as --recipient but this one is intended for
604 in the options file and may be used together with
605 an own user-id as an "encrypt-to-self".  These keys
606 are only used when there are other recipients given
607 either by use of --recipient or by the asked user id.
608 No trust checking is performed for these user ids and
609 even disabled keys can be used.
610 </para></listitem></varlistentry>
611
612
613 <varlistentry>
614 <term>--no-encrypt-to</term>
615 <listitem><para>
616 Disable the use of all --encrypt-to keys.
617 </para></listitem></varlistentry>
618
619
620 <varlistentry>
621 <term>-v, --verbose</term>
622 <listitem><para>
623 Give more information during processing. If used
624 twice, the input data is listed in detail.
625 </para></listitem></varlistentry>
626
627
628 <varlistentry>
629 <term>-q, --quiet</term>
630 <listitem><para>
631 Try to be as quiet as possible.
632 </para></listitem></varlistentry>
633
634
635 <varlistentry>
636 <term>-z &ParmN;</term>
637 <listitem><para>
638 Set compression level to &ParmN;. A value of 0 for &ParmN;
639 disables compression. Default is to use the default
640 compression level of zlib (normally 6).
641 </para></listitem></varlistentry>
642
643
644 <varlistentry>
645 <term>-t, --textmode</term>
646 <listitem><para>
647 Use canonical text mode.  If -t (but not
648 --textmode) is used together with armoring
649 and signing, this enables clearsigned messages.
650 This kludge is needed for PGP compatibility;
651 normally you would use --sign or --clearsign
652 to selected the type of the signature.
653 </para></listitem></varlistentry>
654
655
656 <varlistentry>
657 <term>-n, --dry-run</term>
658 <listitem><para>
659 Don't make any changes (this is not completely implemented).
660 </para></listitem></varlistentry>
661
662
663 <varlistentry>
664 <term>-i, --interactive</term>
665 <listitem><para>
666 Prompt before overwriting any files.
667 </para></listitem></varlistentry>
668
669
670 <varlistentry>
671 <term>--batch</term>
672 <listitem><para>
673 Use batch mode.  Never ask, do not allow interactive
674 commands.
675 </para></listitem></varlistentry>
676
677
678 <varlistentry>
679 <term>--no-batch</term>
680 <listitem><para>
681 Disable batch mode.  This may be of use if --batch
682 is enabled from an options file.
683 </para></listitem></varlistentry>
684
685
686 <varlistentry>
687 <term>--yes</term>
688 <listitem><para>
689 Assume "yes" on most questions.
690 </para></listitem></varlistentry>
691
692
693 <varlistentry>
694 <term>--no</term>
695 <listitem><para>
696  Assume "no" on most questions.
697 </para></listitem></varlistentry>
698
699
700 <varlistentry>
701 <term>--keyserver &ParmName;</term>
702 <listitem><para>
703 Use &ParmName to lookup keys which are not yet in
704 your keyring.  This is only done while verifying
705 messages with signatures.  The option is also
706 required for the command --send-keys to
707 specify the keyserver to where the keys should
708 be send.  All keyservers synchronize with each
709 other - so there is no need to send keys to more
710 than one server.  Using the command
711 "host -l pgp.net | grep wwwkeys" gives you a
712 list of keyservers.  Because there is load
713 balancing using round-robin DNS you may notice
714 that you get different key servers.
715 </para></listitem></varlistentry>
716
717
718 <varlistentry>
719 <term>--keyring &ParmFile;</term>
720 <listitem><para>
721 Add &ParmFile to the list of keyrings.
722 If &ParmFile begins with a tilde and a slash, these
723 are replaced by the HOME directory. If the filename
724 does not contain a slash, it is assumed to be in the
725 home-directory ("~/.gnupg" if --homedir is not used).
726 The filename may be prefixed with a scheme:</para>
727 <para>"gnupg-ring:" is the default one.</para>
728 <para>"gnupg-gdbm:" may be used for a GDBM ring.</para>
729 <para>It might make sense to use it together with --no-default-keyring.
730 </para></listitem></varlistentry>
731
732
733 <varlistentry>
734 <term>--secret-keyring &ParmFile;</term>
735 <listitem><para>
736 Same as --keyring but for the secret keyrings.
737 </para></listitem></varlistentry>
738
739
740 <varlistentry>
741 <term>--homedir &ParmDir;</term>
742 <listitem><para>
743 Set the name of the home directory to &ParmDir; If this
744 option is not used it defaults to "~/.gnupg". It does
745 not make sense to use this in a options file. This
746 also overrides the environment variable "GNUPGHOME".
747 </para></listitem></varlistentry>
748
749
750 <varlistentry>
751 <term>--charset &ParmName;</term>
752 <listitem><para>
753 Set the name of the native character set.  This is used
754 to convert some strings to proper UTF-8 encoding.
755 Valid values for &ParmName; are:</para>
756 <variablelist>
757 <varlistentry>
758 <term>iso-8859-1</term><listitem><para>This is the default Latin 1 set.</para></listitem>
759 </varlistentry>
760 <varlistentry>
761 <term>iso-8859-2</term><listitem><para>The Latin 2 set.</para></listitem>
762 </varlistentry>
763 <varlistentry>
764 <term>koi8-r</term><listitem><para>The usual Russian set (rfc1489).</para></listitem>
765 </varlistentry>
766 </variablelist>
767 </listitem></varlistentry>
768
769
770 <varlistentry>
771 <term>--utf8-strings</term>
772 <term>--no-utf8-strings</term>
773 <listitem><para>
774 Assume that the arguments are already given as UTF8 strings.  The default
775 (--no-utf8-strings)
776 is to assume that arguments are encoded in the character set as specified
777 by --charset. These options effects all following arguments.  Both options may
778 used multiple times.
779 </para></listitem></varlistentry>
780
781
782 <varlistentry>
783 <term>--options &ParmFile;</term>
784 <listitem><para>
785 Read options from &ParmFile; and do not try to read
786 them from the default options file in the homedir
787 (see --homedir). This option is ignored if used
788 in an options file.
789 </para></listitem></varlistentry>
790
791
792 <varlistentry>
793 <term>--no-options</term>
794 <listitem><para>
795 Shortcut for "--options /dev/null".  This option is
796 detected before an attempt to open an option file.
797 </para></listitem></varlistentry>
798
799
800 <varlistentry>
801 <term>--load-extension &ParmName;</term>
802 <listitem><para>
803 Load an extension module. If &ParmName; does not
804 contain a slash it is searched in "/usr/local/lib/gnupg"
805 See the manual for more information about extensions.
806 </para></listitem></varlistentry>
807
808
809 <varlistentry>
810 <term>--debug &ParmFlags;</term>
811 <listitem><para>
812 Set debugging flags. All flags are or-ed and &ParmFlags; may
813 be given in C syntax (e.g. 0x0042).
814 </para></listitem></varlistentry>
815
816
817 <varlistentry>
818 <term>--debug-all</term>
819 <listitem><para>
820  Set all useful debugging flags.
821 </para></listitem></varlistentry>
822
823
824 <varlistentry>
825 <term>--status-fd &ParmN;</term>
826 <listitem><para>
827 Write special status strings to the file descriptor &ParmN;.
828 See the file DETAILS in the documentation for a listing of them.
829 </para></listitem></varlistentry>
830
831
832 <varlistentry>
833 <term>--logger-fd &ParmN;</term>
834 <listitem><para>
835 Write log output to file descriptor &ParmN; and not to stderr.
836 </para></listitem></varlistentry>
837
838
839 <varlistentry>
840 <term>--no-comment</term>
841 <listitem><para>
842 Do not write comment packets.  This option affects only
843 the generation of secret keys.  Output of option packets
844 is disabled since version 0.4.2.
845 </para></listitem></varlistentry>
846
847
848 <varlistentry>
849 <term>--comment &ParmString;</term>
850 <listitem><para>
851 Use &ParmString; as comment string in clear text signatures.
852 </para></listitem></varlistentry>
853
854
855 <varlistentry>
856 <term>--default-comment</term>
857 <listitem><para>
858 Force to write the standard comment string in clear
859 text signatures.  Use this to overwrite a --comment
860 from a config file.
861 </para></listitem></varlistentry>
862
863
864 <varlistentry>
865 <term>--no-version</term>
866 <listitem><para>
867 Omit the version string in clear text signatures.
868 </para></listitem></varlistentry>
869
870
871 <varlistentry>
872 <term>--emit-version</term>
873 <listitem><para>
874 Force to write the version string in clear text
875 signatures.  Use this to overwrite a previous
876 --no-version from a config file.
877 </para></listitem></varlistentry>
878
879
880 <varlistentry>
881 <term>-N, --notation-data &ParmNameValue;</term>
882 <listitem><para>
883 Put the name value pair into the signature as notation data.
884 &ParmName; must consists only of alphanumeric characters, digits
885 or the underscore; the first character must not be a digit.
886 &ParmValue; may be any printable string; it will encoded in UTF8,
887 so sou should have check that your --charset is set right.
888 If you prefix &ParmName; with an exclamation mark, the notation
889 data will be flagged as critical (rfc2440:5.2.3.15).
890 </para></listitem></varlistentry>
891
892
893 <varlistentry>
894 <term>--set-policy-url &ParmString;</term>
895 <listitem><para>
896 Use &ParmString; as Policy URL for signatures (rfc2440:5.2.3.19).
897 If you prefix it with an exclamation mark, the policy URL
898 packet will be flagged as critical.
899 </para></listitem></varlistentry>
900
901
902 <varlistentry>
903 <term>--set-filename &ParmString;</term>
904 <listitem><para>
905 Use &ParmString; as the name of file which is stored in
906 messages.
907 </para></listitem></varlistentry>
908
909
910 <varlistentry>
911 <term>--completes-needed &ParmN;</term>
912 <listitem><para>
913 Number of completely trusted users to introduce a new
914 key signer (defaults to 1).
915 </para></listitem></varlistentry>
916
917
918 <varlistentry>
919 <term>--marginals-needed &ParmN;</term>
920 <listitem><para>
921 Number of marginally trusted users to introduce a new
922 key signer (defaults to 3)
923 </para></listitem></varlistentry>
924
925
926 <varlistentry>
927 <term>--max-cert-depth &ParmN;</term>
928 <listitem><para>
929 Maximum depth of a certification chain (default is 5).
930 </para></listitem></varlistentry>
931
932
933 <varlistentry>
934 <term>--cipher-algo &ParmName;</term>
935 <listitem><para>
936 Use  &ParmName; as cipher algorithm. Running the program
937 with the command --version yields a list of supported
938 algorithms. If this is not used the cipher algorithm is
939 selected from the preferences stored with the key.
940 </para></listitem></varlistentry>
941
942
943 <varlistentry>
944 <term>--digest-algo &ParmName;</term>
945 <listitem><para>
946 Use  &ParmName; as message digest algorithm. Running the
947 program with the command --version yields a list of
948 supported algorithms.  Please note that using this
949 option may violate the OpenPGP requirement, that a
950 160 bit hash is to be used for DSA.
951 </para></listitem></varlistentry>
952
953
954 <varlistentry>
955 <term>--s2k-cipher-algo &ParmName;</term>
956 <listitem><para>
957 Use  &ParmName; as the cipher algorithm used to protect secret
958 keys.  The default cipher is BLOWFISH.  This cipher is
959 also used for conventional encryption if --cipher-algo
960 is not given.
961 </para></listitem></varlistentry>
962
963
964 <varlistentry>
965 <term>--s2k-digest-algo &ParmName;</term>
966 <listitem><para>
967 Use  &ParmName; as the digest algorithm used to mangle the
968 passphrases.  The default algorithm is RIPE-MD-160.
969 This digest algorithm is also used for conventional
970 encryption if --digest-algo is not given.
971 </para></listitem></varlistentry>
972
973
974 <varlistentry>
975 <term>--s2k-mode &ParmN;</term>
976 <listitem><para>
977 Selects how passphrases are mangled. If &ParmN; is 0
978 a plain passphrase (which is not recommended) will be used,
979 a 1 (default) adds a salt to the passphrase and
980 a 3 iterates the whole process a couple of times.
981 Unless --rfc1991 is used, this mode is also used
982 for conventional encryption.
983 </para></listitem></varlistentry>
984
985
986 <varlistentry>
987 <term>--compress-algo &ParmN;</term>
988 <listitem><para>
989 Use compress algorithm  &ParmN;. Default is 2 which is
990 RFC1950 compression. You may use 1 to use the old zlib
991 version which is used by PGP. The default algorithm may
992 give better results because the window size is not limited
993 to 8K. If this is not used the OpenPGP behavior is used,
994 i.e. the compression algorithm is selected from the
995 preferences; note, that this can't be done if you do
996 not encrypt the data.
997 </para></listitem></varlistentry>
998
999
1000 <varlistentry>
1001 <term>--throw-keyid</term>
1002 <listitem><para>
1003 Do not put the keyid into encrypted packets.  This option
1004 hides the receiver of the message and is a countermeasure
1005 against traffic analysis.  It may slow down the decryption
1006 process because all available secret keys are tried.
1007 </para></listitem></varlistentry>
1008
1009
1010 <varlistentry>
1011 <term>--not-dash-escaped</term>
1012 <listitem><para>
1013 This option changes the behavior of cleartext signatures
1014 so that they can be used for patch files. You should not
1015 send such an armored file via email because all spaces
1016 and line endings are hashed too.  You can not use this
1017 option for data which has 5 dashes at the beginning of a
1018 line, patch files don't have this. A special armor header
1019 line tells GnuPG about this cleartext signature option.
1020 </para></listitem></varlistentry>
1021
1022
1023 <varlistentry>
1024 <term>--escape-from-lines</term>
1025 <listitem><para>
1026 Because some mailers change lines starting with "From "
1027 to "&#60;From " it is good to handle such lines in a special
1028 way when creating cleartext signatures. All other PGP
1029 versions do it this way too. This option is not enabled
1030 by default because it would violate rfc2440.
1031 </para></listitem></varlistentry>
1032
1033
1034 <varlistentry>
1035 <term>--passphrase-fd &ParmN;</term>
1036 <listitem><para>
1037 Read the passphrase from file descriptor &ParmN;. If you use
1038 0 for &ParmN;, the passphrase will be read from stdin.  This
1039 can only be used if only one passphrase is supplied.
1040 <!--fixme: make this print strong-->
1041 Don't use this option if you can avoid it.
1042 </para></listitem></varlistentry>
1043
1044
1045 <varlistentry>
1046 <term>--rfc1991</term>
1047 <listitem><para>
1048 Try to be more RFC1991 (PGP 2.x) compliant.
1049 </para></listitem></varlistentry>
1050
1051
1052 <varlistentry>
1053 <term>--openpgp</term>
1054 <listitem><para>
1055 Reset all packet, cipher and digest options to OpenPGP
1056 behavior. Use this option to reset all previous
1057 options like --rfc1991, --force-v3-sigs, --s2k-*,
1058 --cipher-algo, --digest-algo and --compress-algo to
1059 OpenPGP compliant values.
1060 </para></listitem></varlistentry>
1061
1062
1063 <varlistentry>
1064 <term>--force-v3-sigs</term>
1065 <listitem><para>
1066 OpenPGP states that an implementation should generate
1067 v4 signatures but PGP 5.x recognizes v4 signatures only
1068 on key material.  This options forces v3 signatures for
1069 signatures on data.
1070 </para></listitem></varlistentry>
1071
1072
1073 <varlistentry>
1074 <term>--force-mdc</term>
1075 <listitem><para>
1076 Force the use of encryption with appended manipulation
1077 code.  This is always used with the newer cipher (those
1078 with a blocksize greater than 64 bit).
1079 </para></listitem></varlistentry>
1080
1081
1082 <varlistentry>
1083 <term>--lock-once</term>
1084 <listitem><para>
1085 Lock the databases the first time a lock is requested
1086 and do not release the lock until the process
1087 terminates.
1088 </para></listitem></varlistentry>
1089
1090
1091 <varlistentry>
1092 <term>--lock-multiple</term>
1093 <listitem><para>
1094 Release the locks every time a lock is no longer
1095 needed. Use this to override a previous --lock-once
1096 from a config file.
1097 </para></listitem></varlistentry>
1098
1099
1100 <varlistentry>
1101 <term>--no-verbose</term>
1102 <listitem><para>
1103 Reset verbose level to 0.
1104 </para></listitem></varlistentry>
1105
1106
1107 <varlistentry>
1108 <term>--no-greeting</term>
1109 <listitem><para>
1110 Suppress the initial copyright message but do not
1111 enter batch mode.
1112 </para></listitem></varlistentry>
1113
1114
1115 <varlistentry>
1116 <term>--no-armor</term>
1117 <listitem><para>
1118 Assume the input data is not in ASCII armored format.
1119 </para></listitem></varlistentry>
1120
1121
1122 <varlistentry>
1123 <term>--no-default-keyring</term>
1124 <listitem><para>
1125 Do not add the default keyrings to the list of
1126 keyrings.
1127 </para></listitem></varlistentry>
1128
1129
1130 <varlistentry>
1131 <term>--skip-verify</term>
1132 <listitem><para>
1133 Skip the signature verification step.  This may be
1134 used to make the encryption faster if the signature
1135 verification is not needed.
1136 </para></listitem></varlistentry>
1137
1138
1139 <varlistentry>
1140 <term>--with-colons</term>
1141 <listitem><para>
1142 Print key listings delimited by colons.
1143 </para></listitem></varlistentry>
1144
1145
1146 <varlistentry>
1147 <term>--with-key-data</term>
1148 <listitem><para>
1149 Print key listings delimited by colons and print the public key data.
1150 </para></listitem></varlistentry>
1151
1152 <varlistentry>
1153 <term>--with-fingerprint</term>
1154 <listitem><para>
1155 Same as the command --fingerprint but changes only the format of the output
1156 and may be used together with another command.
1157 </para></listitem></varlistentry>
1158
1159
1160 </variablelist>
1161 </refsect1>
1162
1163 <refsect1>
1164     <title>RETURN VALUE</title>
1165     <para>
1166 The program returns 0 if everything was fine, 1 if at least
1167 a signature was bad, and other error codes for fatal errors.
1168     </para>
1169 </refsect1>
1170
1171 <refsect1>
1172     <title>EXAMPLES</title>
1173     <variablelist>
1174
1175 <varlistentry>
1176 <term>gpg -se -r <parameter/Bob/ &ParmFile;</term>
1177 <listitem><para>sign and encrypt for user Bob</para></listitem>
1178 </varlistentry>
1179
1180 <varlistentry>
1181 <term>gpg --clearsign &ParmFile;</term>
1182 <listitem><para>make a clear text signature</para></listitem>
1183 </varlistentry>
1184
1185 <varlistentry>
1186 <term>gpg -sb  &ParmFile;</term>
1187 <listitem><para>make a detached signature</para></listitem>
1188 </varlistentry>
1189
1190 <varlistentry>
1191 <term>gpg --list-keys  <parameter/user_ID/</term>
1192 <listitem><para>show keys</para></listitem>
1193 </varlistentry>
1194
1195 <varlistentry>
1196 <term>gpg --fingerprint  <parameter/user_ID/</term>
1197 <listitem><para>show fingerprint</para></listitem>
1198 </varlistentry>
1199
1200     </variablelist>
1201 </refsect1>
1202
1203
1204 <refsect1>
1205     <title>ENVIRONMENT</title>
1206
1207     <variablelist>
1208 <varlistentry>
1209 <term>HOME</term>
1210 <listitem><para>Used to locate the default home directory.</para></listitem>
1211 </varlistentry>
1212 <varlistentry>
1213 <term>GNUPGHOME</term>
1214 <listitem><para>If set directory used instead of "~/.gnupg".</para></listitem>
1215 </varlistentry>
1216     </variablelist>
1217
1218 </refsect1>
1219
1220 <refsect1>
1221     <title>FILES</title>
1222     <variablelist>
1223
1224 <varlistentry>
1225 <term>~/.gnupg/secring.gpg</term>
1226 <listitem><para>The secret keyring</para></listitem>
1227 </varlistentry>
1228
1229 <varlistentry>
1230 <term>~/.gnupg/secring.gpg.lock</term>
1231 <listitem><para>and the lock file</para></listitem>
1232 </varlistentry>
1233
1234 <varlistentry>
1235 <term>~/.gnupg/pubring.gpg</term>
1236 <listitem><para>The public keyring</para></listitem>
1237 </varlistentry>
1238
1239 <varlistentry>
1240 <term>~/.gnupg/pubring.gpg.lock</term>
1241 <listitem><para>and the lock file</para></listitem>
1242 </varlistentry>
1243
1244 <varlistentry>
1245 <term>~/.gnupg/trustdb.gpg</term>
1246 <listitem><para>The trust database</para></listitem>
1247 </varlistentry>
1248
1249 <varlistentry>
1250 <term>~/.gnupg/trustdb.gpg.lock</term>
1251 <listitem><para>and the lock file</para></listitem>
1252 </varlistentry>
1253
1254 <varlistentry>
1255 <term>~/.gnupg/options</term>
1256 <listitem><para>May contain options</para></listitem>
1257 </varlistentry>
1258
1259 <varlistentry>
1260 <term>/usr[/local]/share/gnupg/options.skel</term>
1261 <listitem><para>Skeleton options file</para></listitem>
1262 </varlistentry>
1263
1264 <varlistentry>
1265 <term>/usr[/local]/lib/gnupg/</term>
1266 <listitem><para>Default location for extensions</para></listitem>
1267 </varlistentry>
1268
1269     </variablelist>
1270 </refsect1>
1271
1272 <!-- SEE ALSO  not yet needed-->
1273
1274 <refsect1>
1275     <title>WARNINGS</title>
1276     <para>
1277 Use a *good* password for your user account and a *good* passphrase
1278 to protect your secret key.  This passphrase is the weakest part of the
1279 whole system.  Programs to do dictionary attacks on your secret keyring
1280 are very easy to write and so you should protect your "~/.gnupg/"
1281 directory very well.
1282 </para>
1283 <para>
1284 Keep in mind that, if this program is used over a network (telnet), it
1285 is *very* easy to spy out your passphrase!
1286 </para>
1287 </refsect1>
1288
1289
1290 <refsect1>
1291     <title>BUGS</title>
1292     <para>
1293 On many systems this program should be installed as setuid(root). This
1294 is necessary to lock memory pages. Locking memory pages prevents the
1295 operating system from writing memory pages to disk. If you get no
1296 warning message about insecure memory your operating system supports
1297 locking without being root. The program drops root privileges as soon
1298 as locked memory is allocated.
1299 </para>
1300 </refsect1>
1301
1302 </refentry>
1303