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