trunk/Mix/mpgp.1

.TH MPGP 1 "Mixmaster Version 3.0"
.\" $Id: $
.SH NAME
mpgp \- Mixmaster OpenPGP Module
.SH SYNOPSIS
.B mpgp \fB\-e\fR [\fB\-b\fR] \fIkeyname\fR [\fIfilename\fR]
.PP
.B mpgp \fB\-s\fR [\fB\-b\fR] [\fIkeyname\fR [\fIfilename\fR]]
.PP
.B mpgp \fB\-c\fR [\fB\-b\fR] [\fIfilename\fR]
.PP
.B mpgp \fB\-C\fR [\fB\-b\fR] [\fIfilename\fR]
.PP
.B mpgp \fB\-d\fR [\fB\-b\fR] [\fIpassphrase\fR [\fIfilename\fR]]
.PP
.B mpgp \fB\-g\fR[\fBr\fR] \fIkeyname\fR [\fIbits\fR]
.PP
.B mpgp \fB\-a\fR[\fB+\-\fR] [\fB\-b\fR] [\fIfilename\fR]
.SH DESCRIPTION
Mixmaster is an anonymous remailer. mpgp is a light-weight OpenPGP
implementation, primarily used to diagnose issues with OpenPGP keys and
messages handled by the Mixmaster remailer software.
.PP
mpgp can encrypt, decrypt and sign a message using the Mixmaster 
OpenPGP library. The message is read from the standard input or the 
specified \fIfilename\fR. The output will be written to the standard 
output. When called without arguments mpgp decrypts from the standard 
input. It asks for a passphrase when needed.
.SH OPTIONS
.TP
.B "\-h"
Print a summary of command line options.
.TP
.B "\-e"
Encrypt a message with the first OpenPGP key from the public key ring 
whose contains \fIkeyname\fR as a substring.
.TP
.B "\-s"
Make a signature of the message with the first OpenPGP key from the secret
key ring, or the first key whose contains \fIkeyname\fR as a substring if
specified.
.TP
.B "\-c"
Encrypt with symmetric cipher only.
.TP
.B "\-C"
Encrypt with symmetric cipher only using the new OpenPGP format.
.TP
.B "\-d"
Decrypt a message using \fIpassphrase\fR if specified or asking for it if
needed. It also verifies its signature.
.TP
.B "\-g\fR[\fBr\fR]"
Generate new OpenPGP key pair with the given \fIkeyname\fR as user ID. If
\fBr\fR is specified the OpenPGP key will be created using the RSA 
algorithm, otherwise the ElGamal algorithm will be used. \fIbits\fR is the 
key length and its default value is 1024.
.TP
.B "\-a\fR[\fB+\-\fR]"
Create an ASCII OpenPGP armored message. If \fB\-\fR is specified mpgp 
will remove ASCII armor.
.TP
.B "\-b"
Specifies that the message is in binary format.
.SH CONFIGURATION
The Mixmaster OpenPGP module reads its configuration from the file
.B mix.cfg
in its working directory.  The configuration file consists of lines of
the type
.PP
.I VARIABLE       values
.PP
and of comments, which begin with a
.B #
character.
.PP
.TP
.B PGPPUBRING
Path to your public OpenPGP key ring. Default:
.BR ~/.pgp/pubring.pgp .
(Windows default: PGP registry value.)
.TP
.B PGPSECRING
Path to your secret OpenPGP key ring. Default:
.BR ~/.pgp/secring.pgp .
(Windows default: PGP registry value.)
.SH FILES
These filenames can be overridden by setting the corresponding configuration
option (given in parentheses).
.TP
.B mix.cfg
Mixmaster configuration file.
.TP
.B pubring.pgp
OpenPGP public keys (\fBPGPPUBRING\fP).
.TP
.B secring.pgp
OpenPGP secret keys (\fBPGPSECRING\fP).
.SH SEE ALSO
.BR mixmaster (1),
.BR pgp (1),
.BR gpg (1).
.SH COPYRIGHT
(C) 1999-2004 Anonymizer Inc. and others.
Mixmaster may be redistributed and modified under certain conditions.
This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF
ANY KIND, either express or implied. See the file COPYRIGHT for
details.
1	.TH MPGP 1 "Mixmaster Version 3.0"
2	.\" $Id: $
3	.SH NAME
4	mpgp \- Mixmaster OpenPGP Module
5	.SH SYNOPSIS
6	.B mpgp \fB\-e\fR [\fB\-b\fR] \fIkeyname\fR [\fIfilename\fR]
7	.PP
8	.B mpgp \fB\-s\fR [\fB\-b\fR] [\fIkeyname\fR [\fIfilename\fR]]
9	.PP
10	.B mpgp \fB\-c\fR [\fB\-b\fR] [\fIfilename\fR]
11	.PP
12	.B mpgp \fB\-C\fR [\fB\-b\fR] [\fIfilename\fR]
13	.PP
14	.B mpgp \fB\-d\fR [\fB\-b\fR] [\fIpassphrase\fR [\fIfilename\fR]]
15	.PP
16	.B mpgp \fB\-g\fR[\fBr\fR] \fIkeyname\fR [\fIbits\fR]
17	.PP
18	.B mpgp \fB\-a\fR[\fB+\-\fR] [\fB\-b\fR] [\fIfilename\fR]
19	.SH DESCRIPTION
20	Mixmaster is an anonymous remailer. mpgp is a light-weight OpenPGP
21	implementation, primarily used to diagnose issues with OpenPGP keys and
22	messages handled by the Mixmaster remailer software.
23	.PP
24	mpgp can encrypt, decrypt and sign a message using the Mixmaster
25	OpenPGP library. The message is read from the standard input or the
26	specified \fIfilename\fR. The output will be written to the standard
27	output. When called without arguments mpgp decrypts from the standard
28	input. It asks for a passphrase when needed.
29	.SH OPTIONS
30	.TP
31	.B "\-h"
32	Print a summary of command line options.
33	.TP
34	.B "\-e"
35	Encrypt a message with the first OpenPGP key from the public key ring
36	whose contains \fIkeyname\fR as a substring.
37	.TP
38	.B "\-s"
39	Make a signature of the message with the first OpenPGP key from the secret
40	key ring, or the first key whose contains \fIkeyname\fR as a substring if
41	specified.
42	.TP
43	.B "\-c"
44	Encrypt with symmetric cipher only.
45	.TP
46	.B "\-C"
47	Encrypt with symmetric cipher only using the new OpenPGP format.
48	.TP
49	.B "\-d"
50	Decrypt a message using \fIpassphrase\fR if specified or asking for it if
51	needed. It also verifies its signature.
52	.TP
53	.B "\-g\fR[\fBr\fR]"
54	Generate new OpenPGP key pair with the given \fIkeyname\fR as user ID. If
55	\fBr\fR is specified the OpenPGP key will be created using the RSA
56	algorithm, otherwise the ElGamal algorithm will be used. \fIbits\fR is the
57	key length and its default value is 1024.
58	.TP
59	.B "\-a\fR[\fB+\-\fR]"
60	Create an ASCII OpenPGP armored message. If \fB\-\fR is specified mpgp
61	will remove ASCII armor.
62	.TP
63	.B "\-b"
64	Specifies that the message is in binary format.
65	.SH CONFIGURATION
66	The Mixmaster OpenPGP module reads its configuration from the file
67	.B mix.cfg
68	in its working directory. The configuration file consists of lines of
69	the type
70	.PP
71	.I VARIABLE values
72	.PP
73	and of comments, which begin with a
74	.B #
75	character.
76	.PP
77	.TP
78	.B PGPPUBRING
79	Path to your public OpenPGP key ring. Default:
80	.BR ~/.pgp/pubring.pgp .
81	(Windows default: PGP registry value.)
82	.TP
83	.B PGPSECRING
84	Path to your secret OpenPGP key ring. Default:
85	.BR ~/.pgp/secring.pgp .
86	(Windows default: PGP registry value.)
87	.SH FILES
88	These filenames can be overridden by setting the corresponding configuration
89	option (given in parentheses).
90	.TP
91	.B mix.cfg
92	Mixmaster configuration file.
93	.TP
94	.B pubring.pgp
95	OpenPGP public keys (\fBPGPPUBRING\fP).
96	.TP
97	.B secring.pgp
98	OpenPGP secret keys (\fBPGPSECRING\fP).
99	.SH SEE ALSO
100	.BR mixmaster (1),
101	.BR pgp (1),
102	.BR gpg (1).
103	.SH COPYRIGHT
104	(C) 1999-2004 Anonymizer Inc. and others.
105	Mixmaster may be redistributed and modified under certain conditions.
106	This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF
107	ANY KIND, either express or implied. See the file COPYRIGHT for
108	details.