See ChangeLog: Mon Jul 12 18:45:57 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>--version</term>
469 <listitem><para>
470 Print version information along with a list
471 of supported algorithms.
472 </para></listitem></varlistentry>
473
474
475 <varlistentry>
476 <term>--warranty</term>
477 <listitem><para>
478 Print warranty information.
479 </para></listitem></varlistentry>
480
481
482 <varlistentry>
483 <term>-h, --help</term>
484 <listitem><para>
485 Print usage information.  This is a really long list even it does list
486 not all options.
487 </para></listitem></varlistentry>
488
489
490
491 </variablelist>
492 </refsect1>
493
494 <refsect1>
495 <title>OPTIONS</title>
496 <para>
497 Long options can be put in an options file (default "~/.gnupg/options").
498 Do not write the 2 dashes, but simply the name of the option and any
499 required arguments. Lines with a hash as the first non-white-space
500 character are ignored. Commands may be put in this file too, but that
501 does not make sense.
502 </para>
503 <para>
504 <command/gpg/ recognizes these options:
505 </para>
506
507 <variablelist>
508
509
510 <varlistentry>
511 <term>-a, --armor</term>
512 <listitem><para>
513 Create ASCII armored output.
514 </para></listitem></varlistentry>
515
516
517 <varlistentry>
518 <term>-o, --output &ParmFile;</term>
519 <listitem><para>
520 Write output to &ParmFile;.
521 </para></listitem></varlistentry>
522
523
524 <varlistentry>
525 <term>-u, --local-user &ParmName;</term>
526 <listitem><para>
527 Use &ParmName as the user ID to sign.
528 This option is silently ignored for the list commands,
529 so that it can be used in an options file.
530 </para></listitem></varlistentry>
531
532
533 <varlistentry>
534 <term>--default-key &ParmName;</term>
535 <listitem><para>
536 Use &ParmName; as default user ID for signatures.  If this
537 is not used the default user ID is the first user ID
538 found in the secret keyring.
539 </para></listitem></varlistentry>
540
541
542 <varlistentry>
543 <term>-r, --recipient &ParmName;</term>
544 <term></term>
545 <listitem><para>
546 Encrypt for user id &ParmName;. If this option is not
547 specified, GnuPG asks for the user id.
548 </para></listitem></varlistentry>
549
550
551 <varlistentry>
552 <term>--encrypt-to &ParmName;</term>
553 <listitem><para>
554 Same as --recipient but this one is intended for
555 in the options file and may be used together with
556 an own user-id as an "encrypt-to-self".  These keys
557 are only used when there are other recipients given
558 either by use of --recipient or by the asked user id.
559 No trust checking is performed for these user ids and
560 even disabled keys can be used.
561 </para></listitem></varlistentry>
562
563
564 <varlistentry>
565 <term>--no-encrypt-to</term>
566 <listitem><para>
567 Disable the use of all --encrypt-to keys.
568 </para></listitem></varlistentry>
569
570
571 <varlistentry>
572 <term>-v, --verbose</term>
573 <listitem><para>
574 Give more information during processing. If used
575 twice, the input data is listed in detail.
576 </para></listitem></varlistentry>
577
578
579 <varlistentry>
580 <term>-q, --quiet</term>
581 <listitem><para>
582 Try to be as quiet as possible.
583 </para></listitem></varlistentry>
584
585
586 <varlistentry>
587 <term>-z &ParmN;</term>
588 <listitem><para>
589 Set compression level to &ParmN;. A value of 0 for &ParmN;
590 disables compression. Default is to use the default
591 compression level of zlib (normally 6).
592 </para></listitem></varlistentry>
593
594
595 <varlistentry>
596 <term>-t, --textmode</term>
597 <listitem><para>
598 Use canonical text mode.  If -t (but not
599 --textmode) is used together with armoring
600 and signing, this enables clearsigned messages.
601 This kludge is needed for PGP compatibility;
602 normally you would use --sign or --clearsign
603 to selected the type of the signature.
604 </para></listitem></varlistentry>
605
606
607 <varlistentry>
608 <term>-n, --dry-run</term>
609 <listitem><para>
610 Don't make any changes (this is not completely implemented).
611 </para></listitem></varlistentry>
612
613
614 <varlistentry>
615 <term>-i, --interactive</term>
616 <listitem><para>
617 Prompt before overwriting any files.
618 </para></listitem></varlistentry>
619
620
621 <varlistentry>
622 <term>--batch</term>
623 <listitem><para>
624 Use batch mode.  Never ask, do not allow interactive
625 commands.
626 </para></listitem></varlistentry>
627
628
629 <varlistentry>
630 <term>--no-batch</term>
631 <listitem><para>
632 Disable batch mode.  This may be of use if --batch
633 is enabled from an options file.
634 </para></listitem></varlistentry>
635
636
637 <varlistentry>
638 <term>--yes</term>
639 <listitem><para>
640 Assume "yes" on most questions.
641 </para></listitem></varlistentry>
642
643
644 <varlistentry>
645 <term>--no</term>
646 <listitem><para>
647  Assume "no" on most questions.
648 </para></listitem></varlistentry>
649
650
651 <varlistentry>
652 <term>--keyserver &ParmName;</term>
653 <listitem><para>
654 Use &ParmName to lookup keys which are not yet in
655 your keyring.  This is only done while verifying
656 messages with signatures.  The option is also
657 required for the command --send-keys to
658 specify the keyserver to where the keys should
659 be send.  All keyservers synchronize with each
660 other - so there is no need to send keys to more
661 than one server.  Using the command
662 "host -l pgp.net | grep wwwkeys" gives you a
663 list of keyservers.  Because there is load
664 balancing using round-robin DNS you may notice
665 that you get different key servers.
666 </para></listitem></varlistentry>
667
668
669 <varlistentry>
670 <term>--keyring &ParmFile;</term>
671 <listitem><para>
672 Add &ParmFile to the list of keyrings.
673 If &ParmFile begins with a tilde and a slash, these
674 are replaced by the HOME directory. If the filename
675 does not contain a slash, it is assumed to be in the
676 home-directory ("~/.gnupg" if --homedir is not used).
677 The filename may be prefixed with a scheme:</para>
678 <para>"gnupg-ring:" is the default one.</para>
679 <para>"gnupg-gdbm:" may be used for a GDBM ring.</para>
680 <para>It might make sense to use it together with --no-default-keyring.
681 </para></listitem></varlistentry>
682
683
684 <varlistentry>
685 <term>--secret-keyring &ParmFile;</term>
686 <listitem><para>
687 Same as --keyring but for the secret keyrings.
688 </para></listitem></varlistentry>
689
690
691 <varlistentry>
692 <term>--homedir &ParmDir;</term>
693 <listitem><para>
694 Set the name of the home directory to &ParmDir; If this
695 option is not used it defaults to "~/.gnupg". It does
696 not make sense to use this in a options file. This
697 also overrides the environment variable "GNUPGHOME".
698 </para></listitem></varlistentry>
699
700
701 <varlistentry>
702 <term>--charset &ParmName;</term>
703 <listitem><para>
704 Set the name of the native character set.  This is used
705 to convert some strings to proper UTF-8 encoding.
706 Valid values for &ParmName; are:</para>
707 <variablelist>
708 <varlistentry>
709 <term>iso-8859-1</term><listitem><para>This is the default Latin 1 set.</para></listitem>
710 </varlistentry>
711 <varlistentry>
712 <term>iso-8859-2</term><listitem><para>The Latin 2 set.</para></listitem>
713 </varlistentry>
714 <varlistentry>
715 <term>koi8-r</term><listitem><para>The usual Russian set (rfc1489).</para></listitem>
716 </varlistentry>
717 </variablelist>
718 </listitem></varlistentry>
719
720
721 <varlistentry>
722 <term>--utf8-strings</term>
723 <term>--no-utf8-strings</term>
724 <listitem><para>
725 Assume that the arguments are already given as UTF8 strings.  The default
726 (--no-utf8-strings)
727 is to assume that arguments are encoded in the character set as specified
728 by --charset. These options effects all following arguments.  Both options may
729 used multiple times.
730 </para></listitem></varlistentry>
731
732
733 <varlistentry>
734 <term>--options &ParmFile;</term>
735 <listitem><para>
736 Read options from &ParmFile; and do not try to read
737 them from the default options file in the homedir
738 (see --homedir). This option is ignored if used
739 in an options file.
740 </para></listitem></varlistentry>
741
742
743 <varlistentry>
744 <term>--no-options</term>
745 <listitem><para>
746 Shortcut for "--options /dev/null".  This option is
747 detected before an attempt to open an option file.
748 </para></listitem></varlistentry>
749
750
751 <varlistentry>
752 <term>--load-extension &ParmName;</term>
753 <listitem><para>
754 Load an extension module. If &ParmName; does not
755 contain a slash it is searched in "/usr/local/lib/gnupg"
756 See the manual for more information about extensions.
757 </para></listitem></varlistentry>
758
759
760 <varlistentry>
761 <term>--debug &ParmFlags;</term>
762 <listitem><para>
763 Set debugging flags. All flags are or-ed and &ParmFlags; may
764 be given in C syntax (e.g. 0x0042).
765 </para></listitem></varlistentry>
766
767
768 <varlistentry>
769 <term>--debug-all</term>
770 <listitem><para>
771  Set all useful debugging flags.
772 </para></listitem></varlistentry>
773
774
775 <varlistentry>
776 <term>--status-fd &ParmN;</term>
777 <listitem><para>
778 Write special status strings to the file descriptor &ParmN;.
779 See the file DETAILS in the documentation for a listing of them.
780 </para></listitem></varlistentry>
781
782
783 <varlistentry>
784 <term>--logger-fd &ParmN;</term>
785 <listitem><para>
786 Write log output to file descriptor &ParmN; and not to stderr.
787 </para></listitem></varlistentry>
788
789
790 <varlistentry>
791 <term>--no-comment</term>
792 <listitem><para>
793 Do not write comment packets.  This option affects only
794 the generation of secret keys.  Output of option packets
795 is disabled since version 0.4.2.
796 </para></listitem></varlistentry>
797
798
799 <varlistentry>
800 <term>--comment &ParmString;</term>
801 <listitem><para>
802 Use &ParmString; as comment string in clear text signatures.
803 </para></listitem></varlistentry>
804
805
806 <varlistentry>
807 <term>--default-comment</term>
808 <listitem><para>
809 Force to write the standard comment string in clear
810 text signatures.  Use this to overwrite a --comment
811 from a config file.
812 </para></listitem></varlistentry>
813
814
815 <varlistentry>
816 <term>--no-version</term>
817 <listitem><para>
818 Omit the version string in clear text signatures.
819 </para></listitem></varlistentry>
820
821
822 <varlistentry>
823 <term>--emit-version</term>
824 <listitem><para>
825 Force to write the version string in clear text
826 signatures.  Use this to overwrite a previous
827 --no-version from a config file.
828 </para></listitem></varlistentry>
829
830
831 <varlistentry>
832 <term>-N, --notation-data &ParmNameValue;</term>
833 <listitem><para>
834 Put the name value pair into the signature as notation data.
835 &ParmName; must consists only of alphanumeric characters, digits
836 or the underscore; the first character must not be a digit.
837 &ParmValue; may be any printable string; it will encoded in UTF8,
838 so sou should have check that your --charset is set right.
839 If you prefix &ParmName; with an exclamation mark, the notation
840 data will be flagged as critical (rfc2440:5.2.3.15).
841 </para></listitem></varlistentry>
842
843
844 <varlistentry>
845 <term>--set-policy-url &ParmString;</term>
846 <listitem><para>
847 Use &ParmString; as Policy URL for signatures (rfc2440:5.2.3.19).
848 If you prefix it with an exclamation mark, the policy URL
849 packet will be flagged as critical.
850 </para></listitem></varlistentry>
851
852
853 <varlistentry>
854 <term>--set-filename &ParmString;</term>
855 <listitem><para>
856 Use &ParmString; as the name of file which is stored in
857 messages.
858 </para></listitem></varlistentry>
859
860
861 <varlistentry>
862 <term>--completes-needed &ParmN;</term>
863 <listitem><para>
864 Number of completely trusted users to introduce a new
865 key signer (defaults to 1).
866 </para></listitem></varlistentry>
867
868
869 <varlistentry>
870 <term>--marginals-needed &ParmN;</term>
871 <listitem><para>
872 Number of marginally trusted users to introduce a new
873 key signer (defaults to 3)
874 </para></listitem></varlistentry>
875
876
877 <varlistentry>
878 <term>--max-cert-depth &ParmN;</term>
879 <listitem><para>
880 Maximum depth of a certification chain (default is 5).
881 </para></listitem></varlistentry>
882
883
884 <varlistentry>
885 <term>--cipher-algo &ParmName;</term>
886 <listitem><para>
887 Use  &ParmName; as cipher algorithm. Running the program
888 with the command --version yields a list of supported
889 algorithms. If this is not used the cipher algorithm is
890 selected from the preferences stored with the key.
891 </para></listitem></varlistentry>
892
893
894 <varlistentry>
895 <term>--digest-algo &ParmName;</term>
896 <listitem><para>
897 Use  &ParmName; as message digest algorithm. Running the
898 program with the command --version yields a list of
899 supported algorithms.  Please note that using this
900 option may violate the OpenPGP requirement, that a
901 160 bit hash is to be used for DSA.
902 </para></listitem></varlistentry>
903
904
905 <varlistentry>
906 <term>--s2k-cipher-algo &ParmName;</term>
907 <listitem><para>
908 Use  &ParmName; as the cipher algorithm used to protect secret
909 keys.  The default cipher is BLOWFISH.  This cipher is
910 also used for conventional encryption if --cipher-algo
911 is not given.
912 </para></listitem></varlistentry>
913
914
915 <varlistentry>
916 <term>--s2k-digest-algo &ParmName;</term>
917 <listitem><para>
918 Use  &ParmName; as the digest algorithm used to mangle the
919 passphrases.  The default algorithm is RIPE-MD-160.
920 This digest algorithm is also used for conventional
921 encryption if --digest-algo is not given.
922 </para></listitem></varlistentry>
923
924
925 <varlistentry>
926 <term>--s2k-mode &ParmN;</term>
927 <listitem><para>
928 Selects how passphrases are mangled. If &ParmN; is 0
929 a plain passphrase (which is not recommended) will be used,
930 a 1 (default) adds a salt to the passphrase and
931 a 3 iterates the whole process a couple of times.
932 Unless --rfc1991 is used, this mode is also used
933 for conventional encryption.
934 </para></listitem></varlistentry>
935
936
937 <varlistentry>
938 <term>--compress-algo &ParmN;</term>
939 <listitem><para>
940 Use compress algorithm  &ParmN;. Default is 2 which is
941 RFC1950 compression. You may use 1 to use the old zlib
942 version which is used by PGP. The default algorithm may
943 give better results because the window size is not limited
944 to 8K. If this is not used the OpenPGP behavior is used,
945 i.e. the compression algorithm is selected from the
946 preferences; note, that this can't be done if you do
947 not encrypt the data.
948 </para></listitem></varlistentry>
949
950
951 <varlistentry>
952 <term>--throw-keyid</term>
953 <listitem><para>
954 Do not put the keyid into encrypted packets.  This option
955 hides the receiver of the message and is a countermeasure
956 against traffic analysis.  It may slow down the decryption
957 process because all available secret keys are tried.
958 </para></listitem></varlistentry>
959
960
961 <varlistentry>
962 <term>--not-dash-escaped</term>
963 <listitem><para>
964 This option changes the behavior of cleartext signatures
965 so that they can be used for patch files. You should not
966 send such an armored file via email because all spaces
967 and line endings are hashed too.  You can not use this
968 option for data which has 5 dashes at the beginning of a
969 line, patch files don't have this. A special armor header
970 line tells GnuPG about this cleartext signature option.
971 </para></listitem></varlistentry>
972
973
974 <varlistentry>
975 <term>--escape-from-lines</term>
976 <listitem><para>
977 Because some mailers change lines starting with "From "
978 to "&#60;From " it is good to handle such lines in a special
979 way when creating cleartext signatures. All other PGP
980 versions do it this way too. This option is not enabled
981 by default because it would violate rfc2440.
982 </para></listitem></varlistentry>
983
984
985 <varlistentry>
986 <term>--passphrase-fd &ParmN;</term>
987 <listitem><para>
988 Read the passphrase from file descriptor &ParmN;. If you use
989 0 for &ParmN;, the passphrase will be read from stdin.  This
990 can only be used if only one passphrase is supplied.
991 <!--fixme: make this print strong-->
992 Don't use this option if you can avoid it.
993 </para></listitem></varlistentry>
994
995
996 <varlistentry>
997 <term>--rfc1991</term>
998 <listitem><para>
999 Try to be more RFC1991 (PGP 2.x) compliant.
1000 </para></listitem></varlistentry>
1001
1002
1003 <varlistentry>
1004 <term>--openpgp</term>
1005 <listitem><para>
1006 Reset all packet, cipher and digest options to OpenPGP
1007 behavior. Use this option to reset all previous
1008 options like --rfc1991, --force-v3-sigs, --s2k-*,
1009 --cipher-algo, --digest-algo and --compress-algo to
1010 OpenPGP compliant values.
1011 </para></listitem></varlistentry>
1012
1013
1014 <varlistentry>
1015 <term>--force-v3-sigs</term>
1016 <listitem><para>
1017 OpenPGP states that an implementation should generate
1018 v4 signatures but PGP 5.x recognizes v4 signatures only
1019 on key material.  This options forces v3 signatures for
1020 signatures on data.
1021 </para></listitem></varlistentry>
1022
1023
1024 <varlistentry>
1025 <term>--force-mdc</term>
1026 <listitem><para>
1027 Force the use of encryption with appended manipulation
1028 code.  This is always used with the newer cipher (those
1029 with a blocksize greater than 64 bit).
1030 </para></listitem></varlistentry>
1031
1032
1033 <varlistentry>
1034 <term>--lock-once</term>
1035 <listitem><para>
1036 Lock the databases the first time a lock is requested
1037 and do not release the lock until the process
1038 terminates.
1039 </para></listitem></varlistentry>
1040
1041
1042 <varlistentry>
1043 <term>--lock-multiple</term>
1044 <listitem><para>
1045 Release the locks every time a lock is no longer
1046 needed. Use this to override a previous --lock-once
1047 from a config file.
1048 </para></listitem></varlistentry>
1049
1050
1051 <varlistentry>
1052 <term>--no-verbose</term>
1053 <listitem><para>
1054 Reset verbose level to 0.
1055 </para></listitem></varlistentry>
1056
1057
1058 <varlistentry>
1059 <term>--no-greeting</term>
1060 <listitem><para>
1061 Suppress the initial copyright message but do not
1062 enter batch mode.
1063 </para></listitem></varlistentry>
1064
1065
1066 <varlistentry>
1067 <term>--no-armor</term>
1068 <listitem><para>
1069 Assume the input data is not in ASCII armored format.
1070 </para></listitem></varlistentry>
1071
1072
1073 <varlistentry>
1074 <term>--no-default-keyring</term>
1075 <listitem><para>
1076 Do not add the default keyrings to the list of
1077 keyrings.
1078 </para></listitem></varlistentry>
1079
1080
1081 <varlistentry>
1082 <term>--skip-verify</term>
1083 <listitem><para>
1084 Skip the signature verification step.  This may be
1085 used to make the encryption faster if the signature
1086 verification is not needed.
1087 </para></listitem></varlistentry>
1088
1089
1090 <varlistentry>
1091 <term>--with-colons</term>
1092 <listitem><para>
1093 Print key listings delimited by colons.
1094 </para></listitem></varlistentry>
1095
1096
1097 <varlistentry>
1098 <term>--with-key-data</term>
1099 <listitem><para>
1100 Print key listings delimited by colons and print the public key data.
1101 </para></listitem></varlistentry>
1102
1103 <varlistentry>
1104 <term>--with-fingerprint</term>
1105 <listitem><para>
1106 Same as the command --fingerprint but changes only the format of the output
1107 and may be used together with another command.
1108 </para></listitem></varlistentry>
1109
1110
1111 </variablelist>
1112 </refsect1>
1113
1114 <refsect1>
1115     <title>RETURN VALUE</title>
1116     <para>
1117 The program returns 0 if everything was fine, 1 if at least
1118 a signature was bad, and other error codes for fatal errors.
1119     </para>
1120 </refsect1>
1121
1122 <refsect1>
1123     <title>EXAMPLES</title>
1124     <variablelist>
1125
1126 <varlistentry>
1127 <term>gpg -se -r <parameter/Bob/ &ParmFile;</term>
1128 <listitem><para>sign and encrypt for user Bob</para></listitem>
1129 </varlistentry>
1130
1131 <varlistentry>
1132 <term>gpg --clearsign &ParmFile;</term>
1133 <listitem><para>make a clear text signature</para></listitem>
1134 </varlistentry>
1135
1136 <varlistentry>
1137 <term>gpg -sb  &ParmFile;</term>
1138 <listitem><para>make a detached signature</para></listitem>
1139 </varlistentry>
1140
1141 <varlistentry>
1142 <term>gpg --list-keys  <parameter/user_ID/</term>
1143 <listitem><para>show keys</para></listitem>
1144 </varlistentry>
1145
1146 <varlistentry>
1147 <term>gpg --fingerprint  <parameter/user_ID/</term>
1148 <listitem><para>show fingerprint</para></listitem>
1149 </varlistentry>
1150
1151     </variablelist>
1152 </refsect1>
1153
1154
1155 <refsect1>
1156     <title>ENVIRONMENT</title>
1157
1158     <variablelist>
1159 <varlistentry>
1160 <term>HOME</term>
1161 <listitem><para>Used to locate the default home directory.</para></listitem>
1162 </varlistentry>
1163 <varlistentry>
1164 <term>GNUPGHOME</term>
1165 <listitem><para>If set directory used instead of "~/.gnupg".</para></listitem>
1166 </varlistentry>
1167     </variablelist>
1168
1169 </refsect1>
1170
1171 <refsect1>
1172     <title>FILES</title>
1173     <variablelist>
1174
1175 <varlistentry>
1176 <term>~/.gnupg/secring.gpg</term>
1177 <listitem><para>The secret keyring</para></listitem>
1178 </varlistentry>
1179
1180 <varlistentry>
1181 <term>~/.gnupg/secring.gpg.lock</term>
1182 <listitem><para>and the lock file</para></listitem>
1183 </varlistentry>
1184
1185 <varlistentry>
1186 <term>~/.gnupg/pubring.gpg</term>
1187 <listitem><para>The public keyring</para></listitem>
1188 </varlistentry>
1189
1190 <varlistentry>
1191 <term>~/.gnupg/pubring.gpg.lock</term>
1192 <listitem><para>and the lock file</para></listitem>
1193 </varlistentry>
1194
1195 <varlistentry>
1196 <term>~/.gnupg/trustdb.gpg</term>
1197 <listitem><para>The trust database</para></listitem>
1198 </varlistentry>
1199
1200 <varlistentry>
1201 <term>~/.gnupg/trustdb.gpg.lock</term>
1202 <listitem><para>and the lock file</para></listitem>
1203 </varlistentry>
1204
1205 <varlistentry>
1206 <term>~/.gnupg/options</term>
1207 <listitem><para>May contain options</para></listitem>
1208 </varlistentry>
1209
1210 <varlistentry>
1211 <term>/usr[/local]/share/gnupg/options.skel</term>
1212 <listitem><para>Skeleton options file</para></listitem>
1213 </varlistentry>
1214
1215 <varlistentry>
1216 <term>/usr[/local]/lib/gnupg/</term>
1217 <listitem><para>Default location for extensions</para></listitem>
1218 </varlistentry>
1219
1220     </variablelist>
1221 </refsect1>
1222
1223 <!-- SEE ALSO  not yet needed-->
1224
1225 <refsect1>
1226     <title>WARNINGS</title>
1227     <para>
1228 Use a *good* password for your user account and a *good* passphrase
1229 to protect your secret key.  This passphrase is the weakest part of the
1230 whole system.  Programs to do dictionary attacks on your secret keyring
1231 are very easy to write and so you should protect your "~/.gnupg/"
1232 directory very well.
1233 </para>
1234 <para>
1235 Keep in mind that, if this program is used over a network (telnet), it
1236 is *very* easy to spy out your passphrase!
1237 </para>
1238 </refsect1>
1239
1240
1241 <refsect1>
1242     <title>BUGS</title>
1243     <para>
1244 On many systems this program should be installed as setuid(root). This
1245 is necessary to lock memory pages. Locking memory pages prevents the
1246 operating system from writing memory pages to disk. If you get no
1247 warning message about insecure memory your operating system supports
1248 locking without being root. The program drops root privileges as soon
1249 as locked memory is allocated.
1250 </para>
1251 </refsect1>
1252
1253 </refentry>
1254