See ChangeLog: Wed Feb 10 17:15:39 CET 1999 Werner Koch
[gnupg.git] / doc / gpg.1pod
1 =head1 NAME
2
3 gpg, gpgm - GNU Privacy Guard
4
5 =head1 SYNOPSIS
6
7 B<gpg> [--homedir name] [--options file] [options] command [args]
8
9 B<gpgm> [--homedir name] [--options file] [options] command [args]
10
11 =head1 DESCRIPTION
12
13 B<gpg> is the main program for the GnuPG system. B<gpgm> is a maintenance
14 tool which has some commands B<gpg> does not have; it is there because
15 it does not handle sensitive data and therefore has no need to allocate
16 secure memory.
17
18 =head1 COMMANDS
19
20 B<gpg> recognizes these commands:
21
22 B<-s>, B<--sign>
23     Make a signature. This option may be combined
24     with B<--encrypt>.
25
26 B<--clearsign>
27     Make a clear text signature.
28
29 B<-b>, B<--detach-sign>
30     Make a detached signature.
31
32 B<-e>, B<--encrypt>
33     Encrypt data. This option may be combined with B<--sign>.
34
35 B<-c>, B<--symmetric>
36     Encrypt with symmetric cipher only
37     This command asks for a passphrase.
38
39 B<--store>
40     store only (make a simple RFC1991 packet).
41
42 B<--decrypt> [I<file>]
43     Decrypt file (or stdin if no file is specified) and
44     write it to stdout (or the file specified with
45     B<--output>). If the decrypted file is signed, the
46     signature is also verified. This command differs
47     from the default operation, as it never writes to the
48     filename which is included in the file and it
49     rejects files which don't begin with an encrypted
50     message.
51
52 B<--verify> [[I<sigfile>] {I<signed-files>}]
53     Assume that I<filename> is a signature and verify it
54     without generating any output.  With no arguments,
55     the signature packet is read from stdin (it may be a
56     detached signature when not used in batch mode). If
57     only a sigfile is given, it may be a complete
58     signature or a detached signature, in which case
59     the signed stuff is expected in a file without the
60     I<.sig> or I<.asc> extension (if such a file does
61     not exist it is expected at stdin - use B<-> as
62     filename to force a read from stdin). With more than
63     1 argument, the first should be a detached signature
64     and the remaining files are the signed stuff.
65
66 B<-k> [I<username>] [I<keyring>]
67     Kludge to be somewhat compatible with PGP.
68     Without arguments, all public keyrings are listed.
69     With one argument, only I<keyring> is listed.
70     Special combinations are also allowed, but they may
71     give strange results when combined with more options.
72     B<-kv>    Same as B<-k>
73     B<-kvv>   List the signatures with every key.
74     B<-kvvv>  Additionally check all signatures.
75     B<-kvc>   List fingerprints
76     B<-kvvc>  List fingerprints and signatures
77
78 B<--list-keys>  [I<names>]
79     List all keys from the public keyrings, or just the
80     ones given on the command line.
81
82 B<--list-secret-keys> [I<names>]
83     List all keys from the secret keyrings, or just the
84     ones given on the command line.
85
86 B<--list-sigs>  [I<names>]
87     Same as B<--list-keys>, but the signatures are listed
88     too.
89
90 B<--check-sigs> [I<names>]
91     Same as B<--list-sigs>, but the signatures are verified.
92
93 B<--fingerprint> [I<names>]
94     List all keys with their fingerprints. This is the
95     same output as B<list-keys> but with the additional output
96     of a line with the fingerprint. May also be combined
97     with B<--list-sigs> or B<--check-sigs>.
98
99 B<--list-packets>
100     List only the sequence of packets. This is mainly
101     useful for debugging.
102
103 B<--gen-key>
104     Generate a new key pair. This command can only be
105     used interactive.
106
107
108 B<--edit-key> I<name>
109     Present a menu which enables you to do all key
110     related tasks:
111     B<sign>
112       Make a signature on key of user I<name>.
113       If the key is not yet signed by the default
114       user (or the users given with B<-u>), the
115       program displays the information of the key
116       again, together with its fingerprint and
117       asks whether it should be signed. This
118       question is repeated for all users specified
119       with B<-u>.
120     B<trust>
121       Change the owner trust value. This updates the
122       trust-db immediately and no save is required.
123     B<adduid>
124       Create an alternate user id.
125     B<deluid>
126       Delete an user id.
127     B<addkey>
128        Add a subkey to this key.
129     B<delkey>
130        Remove a subkey.
131     B<expire>
132        Change the key expiration time.  If a key is
133        selected, the time of this key will be changed.
134        With no selection the key expiration of the
135        primary key is changed.
136     B<passwd>
137        Change the passphrase of the secret key.
138     B<uid> I<n>
139        Toggle selection of user id with index I<n>.
140        Use 0 to deselect all.
141     B<key> I<n>
142        Toggle selection of subkey with index I<n>.
143        Use 0 to deselect all.
144     B<check>
145        Check all selected user ids.
146     B<pref>
147        List preferences.
148     B<toggle>
149        Toggle between public and secret key listing.
150     B<save>
151        Save all changes to the key rings and quit.
152     B<quit>
153        Quit the program without updating the
154        key rings.
155     The listing shows you the key with its secondary
156     keys and all user ids. Selected keys or user ids
157     are indicated by an asterisk. The trust value is
158     displayed with the primary key: the first is the
159     assigned owner trust and the second is the calculated
160     trust value.  Letters are used for the values:
161       B<->  No ownertrust assigned / not yet calculated.
162       B<e>  Trust calculation has failed.
163       B<q>  Not enough information for calculation.
164       B<n>  Never trust this key.
165       B<m>  Marginally trusted.
166       B<f>  Fully trusted.
167       B<u>  Ultimately trusted
168
169
170 B<--delete-key>
171     Remove key from the public keyring
172
173 B<--delete-secret-key>
174     Remove key from the secret and public keyring
175
176 B<--gen-revoke>
177     Generate a revocation certificate.
178
179 B<--export> [I<names>]
180     Either export all keys from all keyrings (default
181     keyrings and those registered via option B<--keyring>),
182     or if at least one name is given, those of the given
183     name. The new keyring is written to F<stdout> or to
184     the file given with option "output".  Use together
185     with B<-a> to mail those keys.
186
187 B<--send-keys> [I<names>]
188     Same as B<--export> but sends the keys to a keyserver.
189     Option B<--keyserver> must be used to give the name
190     of this keyserver. Don't send your complete keyring
191     to a keyserver - select only those keys which are new
192     or changed by you.
193
194 B<--export-all> [I<names>]
195     Same as B<--export> but does also export keys which
196     are not compatible to OpenPGP.
197
198 B<--export-secret-keys> [I<names>]
199     Same as B<--export>, but does export the secret keys.
200     This is normally not very useful.
201
202 B<--import>, B<--fast-import>
203     Import/merge keys.  The fast version does not build
204     the trustdb; this can be done at any time with the
205     command B<--update-trustdb>.
206
207 B<--export-ownertrust>
208     List the assigned ownertrust values in ASCII format
209     for backup purposes [B<gpgm> only].
210
211 B<--import-ownertrust> [I<filename>]
212     Update the trustdb with the ownertrust values stored
213     in I<filename> (or stdin if not given); existing
214     values will be overwritten. [B<gpgm> only].
215
216 =head1 OPTIONS
217
218 Long options can be put in an options file (default F<~/.gnupg/options>).
219 Do not write the 2 dashes, but simply the name of the option and any
220 required arguments.     Lines with a hash as the first non-white-space
221 character are ignored. Commands may be put in this file too, but that
222 does not make sense.
223
224 B<gpg> recognizes these options:
225
226
227 B<-a>, B<--armor>
228     Create ASCII armored output.
229
230 B<-o> I<file>, B<--output> I<file>
231     Write output to I<file>.
232
233 B<-u> I<name>, B<--local-user> I<name>
234     Use I<name> as the user-id to sign.
235     This option is silently ignored for the list commands,
236     so that it can be used in an options file.
237
238 B<--default-key>  I<name>
239     Use I<name> as default user-id for signatures.  If this
240     is not used the default user-id is the first user-id
241     from the secret keyring.
242
243 B<--trusted-key>  I<keyid>
244     Assume that the key with the I<keyid> (which must be
245     a full (8 byte) keyid) is as trustworthy as one of
246     your own secret keys.  This may be used to make keys
247     valid which are not directly certified by you but
248     by a CA you trust.  The advantage of this option is
249     that it shortens the path of certification.
250
251     You may also use this option to skip the verification
252     of your own secret keys which is normally done every
253     time GnuPG starts up by using the I<keyid> of
254     your key.
255
256 B<-r>  I<name>, B<--recipient>  I<name>
257     Use I<name> as the user-id for encryption.
258     This option is silently ignored for the list commands,
259     so that it can be used in an options file.
260
261 B<-v>, B<--verbose>
262     Give more information during processing. If used
263     twice, the input data is listed in detail.
264
265 B<-q>, B<--quiet>
266     Be somewhat more quiet in some cases.
267
268 B<-z> I<n>
269     Set compress level to I<n>. A value of 0 for I<n>
270     disables compression. Default is to use the default
271     compression level of zlib (normally 6).
272
273 B<-t>, B<--textmode>
274     Use canonical text mode.  If B<-t> (but not
275     B<--textmode>) is used together with armoring
276     and signing, this enables clearsigned messages.
277     This kludge is needed for PGP compatibility;
278     normally you would use B<--sign> or B<--clearsign>
279     to selected the type of the signature.
280
281 B<-n>, B<--dry-run>
282     Don't make any changes (not yet implemented).
283
284 B<--batch>
285     Use batch mode.  Never ask, do not allow interactive
286     commands.
287
288 B<--no-batch>
289     Disable batch mode.  This may be used if B<batch>
290     is used in the options file.
291
292 B<--yes>
293     Assume "yes" on most questions.
294
295 B<--no>
296     Assume "no" on most questions.
297
298 B<--keyserver> I<name>
299     Use I<name> to lookup keys which are not yet in
300     your keyring.  This is only done while verifying
301     messages with signatures.  The option is also
302     required for the command B<--send-keys> to
303     specify the keyserver to where the keys should
304     be send.  All keyservers synchronize with each
305     other - so there is no need to send keys to more
306     than one server.  Using the command
307     "host -l pgp.net | grep wwwkeys" gives you a
308     list of keyservers.  Because there is load
309     balancing using round-robin-dns you may notice
310     that you get different key servers.
311
312 B<--keyring> I<file>
313     Add I<file> to the list of keyrings.
314     If I<file> begins with a tilde and a slash, these
315     are replaced by the HOME directory. If the filename
316     does not contain a slash, it is assumed to be in the
317     home-directory (F<~/.gnupg> if B<--homedir>) is not used.
318     The filename may be prefixed with a scheme:
319       "gnupg-ring:" is the default one.
320       "gnupg-gdbm:" may be used for a GDBM ring.
321
322 B<--secret-keyring> I<file>
323     Same as B<--keyring> but for secret keyrings.
324
325 B<--homedir> I<dir>
326     Set the name of the home directory to I<dir>. If this
327     option is not used it defaults to F<~/.gnupg>. It does
328     not make sense to use this in a options file. This
329     also overrides the environment variable C<GNUPGHOME>.
330
331 B<--charset> I<name>
332     Set the name of the native character set.  This is used
333     to convert some strings to proper UTF-8 encoding.
334     Valid values for I<name> are:
335       B<iso-8859-1>  This is the default.
336       B<koi8-r>      The usual Russian set (rfc1489).
337
338 B<--options> I<file>
339     Read options from I<file> and do not try to read
340     them from the default options file in the homedir
341     (see B<--homedir>). This option is ignored when used
342     in an options file.
343
344 B<--no-options>
345     Shortcut for B<--options> I</dev/null>.  This option is
346     detected before an attempt to open an option file.
347
348 B<--load-extension> I<modulename>
349     Load an extension module. If I<modulename> does not
350     contain a slash it is searched in B</usr/local/lib/gnupg>
351     See the manual for more information about extensions.
352
353 B<--debug> I<flags>
354     Set debugging flags. All flags are or-ed and I<flags> may
355     be given in C syntax (e.g. 0x0042).
356
357 B<--debug-all>
358     Set all useful debugging flags.
359
360 B<--status-fd> I<n>
361     Write special status strings to the file descriptor I<n>.
362
363 B<--no-comment>
364     Do not write comment packets.  This option affects only
365     the generation of secret keys.  Output of option packets
366     is disabled since version 0.4.2.
367
368 B<--comment> I<string>
369     Use I<string> as comment string in clear text signatures.
370
371 B<--set-filename> I<string>
372     Use I<string> as the name of file which is stored in
373     messages.
374
375 B<--completes-needed> I<n>
376     Number of completely trusted users to introduce a new
377     key signer (defaults to 1).
378
379 B<--marginals-needed> I<n>
380     Number of marginally trusted users to introduce a new
381     key signer (defaults to 3)
382
383 B<--max-cert-depth> I<n>
384     Maximum depth of a certification chain (default is 5).
385
386 B<--cipher-algo> I<name>
387     Use I<name> as cipher algorithm. Running the program
388     with the command B<--version> yields a list of supported
389     algorithms. If this is not used the cipher algorithm is
390     selected from the preferences stored with the key.
391
392 B<--digest-algo> I<name>
393     Use I<name> as message digest algorithm. Running the
394     program with the command B<--version> yields a list of
395     supported algorithms.  Please note that using this
396     option may violate the OpenPGP requirement, that a
397     160 bit hash is to be used for DSA.
398
399 B<--s2k-cipher-algo> I<name>
400     Use I<name> as the cipher algorithm used to protect secret
401     keys.  The default cipher is BLOWFISH.  This cipher is
402     also used for conventional encryption if B<--cipher-algo>
403     is not given.
404
405 B<--s2k-digest-algo> I<name>
406     Use I<name> as the digest algorithm used to mangle the
407     passphrases.  The default algorithm is RIPE-MD-160.
408     This digest algorithm is also used for conventional
409     encryption if B<--digest-algo> is not given.
410
411 B<--s2k-mode> I<number>
412     Selects how passphrases are mangled. A number of I<0>
413     uses the plain passphrase (which is not recommended),
414     a I<1> (default) adds a salt to the passphrase and
415     I<3> iterates the whole process a couple of times.
416     Unless -B<--rfc1991> is used, this mode is also used
417     for conventional encryption.
418
419 B<--compress-algo> I<number>
420     Use compress algorithm I<number>. Default is I<2> which is
421     RFC1950 compression. You may use I<1> to use the old zlib
422     version which is used by PGP. The default algorithm may
423     give better results because the window size is not limited
424     to 8K. If this is not used the OpenPGP behavior is used,
425     i.e. the compression algorithm is selected from the
426     preferences.
427
428 B<--digest-algo> I<name>
429     Use I<name> as message digest algorithm. Running the
430     program with the command B<--version> yields a list of
431     supported algorithms.
432
433
434 B<--throw-keyid>
435     Do not put the keyid into encrypted packets.  This option
436     hides the receiver of the message and is a countermeasure
437     against traffic analysis.  It may slow down the decryption
438     process because all available secret keys are tried.
439
440 B<--not-dash-escaped>
441     This option changes the behavior of cleartext signatures
442     so that they can be used for patch files. You should not
443     send such an armored file via email because all spaces
444     and line endings are hashed too.  You can not use this
445     option for data which has 5 dashes at the beginning of a
446     line, patch files don't have this. A special armor header
447     line tells GnuPG about this cleartext signature option.
448
449 B<--escape-from-lines>
450     Because some mailers change lines starting with "From "
451     to ">From " it is good to handle such lines in a special
452     way when creating cleartext signatures. All other PGP
453     versions do it this way too. This option is not enabled
454     by default because it would violate rfc2440.
455
456 B<--passphrase-fd> I<n>
457     Read the passphrase from file descriptor I<n>. If you use
458     0 for I<n>, the passphrase will be read from stdin.  This
459     can only be used if only one passphrase is supplied.
460     B<Don't use this option if you can avoid it>
461
462 B<--rfc1991>
463     Try to be more RFC1991 (PGP 2.x) compliant.
464
465 B<--force-v3-sigs>
466     OpenPGP states that an implementation should generate
467     v4 signatures but PGP 5.x recognizes v4 signatures only
468     on key material.  This options forces v3 signatures for
469     signatures on data.
470
471 B<--lock-once>
472     Lock the file the first time a lock is requested
473     and do not release the lock until the process
474     terminates.
475
476 B<--no-verbose>
477     Reset verbose level to 0.
478
479 B<--no-greeting>
480     Suppress the initial copyright message but do not
481     enter batch mode.
482
483 B<--no-armor>
484     Assume the input data is not in ASCII armored format.
485
486 B<--no-default-keyring>
487     Do not add the default keyrings to the list of
488     keyrings.
489
490 B<--skip-verify>
491     Skip the signature verification step.  This may be
492     used to make the encryption faster if the signature
493     verification is not needed.
494
495 B<--version>
496     Print version information along with a list
497     of supported algorithms.
498
499 B<--with-colons>
500     Print key listings delimited by colons.
501
502 B<--warranty>
503     Print warranty information.
504
505 B<-h>, B<--help>
506     Print usage information.
507
508
509 =head1 RETURN VALUE
510
511 The Program returns 0 if everything was fine, 1 if at least
512 a signature was bad, and other error codes for fatal errors.
513
514 =head1 EXAMPLES
515
516   -se -r Bob [file]          sign and encrypt for user Bob
517   -sat [file]                make a clear text signature
518   -sb  [file]                make a detached signature
519   -k   [userid]              show keys
520   -kc  [userid]              show fingerprint
521
522 =head1 ENVIRONMENT
523
524 C<HOME>       Used to locate the default home directory.
525 C<GNUPGHOME>  If set directory used instead of F<~/.gnupg>.
526
527 =head1 FILES
528
529 F<~/.gnupg/secring.gpg>      The secret keyring
530 F<~/.gnupg/secring.gpg.lock> and the lock file
531
532 F<~/.gnupg/pubring.gpg>      The public keyring
533 F<~/.gnupg/pubring.gpg.lock> and the lock file
534
535 F<~/.gnupg/trustdb.gpg>      The trust database
536 F<~/.gnupg/trustdb.gpg.lock> and the lock file
537
538 F<~/.gnupg/options>         May contain options
539 F</usr[/local]/share/gnupg/options.skel> Skeleton file
540
541 F</usr[/local]/lib/gnupg/>  Default location for extensions
542
543 =head1 SEE ALSO
544
545 gpg(1)  gpgm(1)
546
547
548 =head1 WARNINGS
549
550 Use a B<good> password for your user account and a B<good> passphrase
551 to protect your secret key.  This passphrase is the weakest part of the
552 whole system.  Programs to do dictionary attacks on your secret keyring
553 are very easy to write and so you should protect your B<~/.gnupg/>
554 directory very well.
555
556 Keep in mind that, if this program is used over a network (telnet), it
557 is B<very> easy to spy out your passphrase!
558
559 =head1 BUGS
560
561 On many systems this program should be installed as setuid(root). This
562 is necessary to lock memory pages. If you get no warning message about
563 insecure memory your OS kernel supports locking without being root.
564 The program drops root privileges as soon as locked memory is allocated.
565