===============
==  PinePgp  ==
===============

PinePgp 0.14.0


Description
-----------

PinePgp is set of display and sending filters which enables pine to send and
receive signed and/or encrypted e-mails.

Supported are both  PGP <http://www.pgp.com/> (version 2.6.x, 5.x and 6.5.x)
and GnuPG <http://www.gnupg.org/> (version 1.0.0 and later).


Copying
-------

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

See the COPYING file or GNU General Public License page
<http://www.gnu.org/copyleft/gpl.html> for license information.

Copyright 1998,.. by Peter Soos <sp@osb.hu>. All rights reserved.


Requirements
------------

mktemp:	is required to handle temp file used to store gpg/pgp output when
	checking/decrypting incomming message so proper footer can be
	created. If you do not want to install this utility, you can still
	use pinepgp, but only version 0.12 or earlier.

	For more information about mktemp see <http://www.openbsd.org> .
	Sources can be downloaded from
	<ftp://ftp.openbsd.org/pub/OpenBSD/src/usr.bin/mktemp/> or from
	mirrors <http://www.openbsd.org/ftp.html>.
	RPM package of mktemp can be foud for example at
	<http://rufus.w3.org/linux/RPM/mktemp.html>.


Download
--------

You can find sources at:

	http://www.megaloman.com/~hany/_data/pinepgp/
	http://fornax.elf.stuba.sk/~hany/_data/pinepgp/

Also you can download RPM packages from:

	http://www.megaloman.com/~hany/RPM/pinepgp.html
	http://www.megaloman.com/~hany/RPM/pinepgp26x.html
	http://www.megaloman.com/~hany/RPM/pinepgp5x.html
	http://www.megaloman.com/~hany/RPM/pinepgp65x.html
	http://www.megaloman.com/~hany/RPM/pinegpg.html


To verify files, use my public key:
<http://www.megaloman.com/~hany/gnupg-hany-public-key.txt>.


Installation
-----------

First, you need some UNIX system which have 'sed' and 'awk' alredy installed.
Also 'mktemp' utility is required (pinepgp version 0.12.90 and later).

After you sucessfuly downloaded and unpacked source tarball, do the
following in source directory:

	$ make
	$ make install-<package>

where <package> is 'pgp26x', 'pgp5x', 'pgp65x' or 'gpg' depending of which
filters you want to install. If you want install all filters, just run:

	$ make install

By default, scripts are installed in /usr/bin . If you want to use diferent
directory, run following (example will install scripts into /usr/local/bin):

	$ make prefix=/usr/local install
		or
	$ make bindir=/usr/local/bin install

From this moment users on your system can run either 'pinegpg-install',
'pinepgp5x-install', 'pinepgp65x-install' or 'pinepgp26x-install' to add
particular filters into theire own pine configuration file (~/.pinerc).

	Pine filters
	------------

If you want to add filters manualy into pine configuration file, than you
have to add following lines (or change current filter definitions) into
it (example will add GnuPG filters):

	# This variable takes a list of programs that message text is piped into
	# after MIME decoding, prior to display.
	display-filters=_LEADING("-----BEGIN PGP MESSAGE-----")_ /usr/bin/gpg-check,\
		_LEADING("-----BEGIN PGP SIGNED MESSAGE-----")_ /usr/bin/gpg-check,

	# This defines a program that message text is piped into before MIME
	# encoding, prior to sending
	sending-filters=/usr/bin/gpg-sign,/usr/bin/gpg-encrypt -r _RECIPIENTS_,\
		/usr/bin/gpg-sign+encrypt -r _RECIPIENTS_,

Your own pine configuration file is ussualy ~/.pinerc . System wide
configuration file should be in /etc/pine.conf but that depends on type of
your system.


Usage
-----

	Viewing signed and/or encrypted messages
	----------------------------------------

To view signed and/or encrypted message just selects it from index.

	Sending signed and/or encrypted messages
	----------------------------------------

To send signed and/or encrypted message just compose it as ussual. Then
press <Ctrl+X> (send message) and select particular filter:

	+ 'unfiltered' for normal message
	+ 'gpg-sign' for signed (by you) message
	+ 'gpg-encrypt"' for encrypted message (you need public key
	  of recipient in your key ring)
	+ 'gpg-sign+encrypt' for signed (by you) and encrypted message
	  (you need public key of recipient in your key ring)


	Pine's compose-send-offers-first-filter
	---------------------------------------

Setting this feature will cause the first filter in the sending-filters list
(in case of default pinepgp install it is 'sign' filter) to be offered
as the default instead of unfiltered, the usual default.


For aditional information on cryptography consult Pine, GnuPG and/or PGP
documentation.


How to contribute
-----------------

If you would like to submit a patch, send it to me <hanecak@megaloman.sk>
or to any other author. Please be sure to include a textual explanation of
what your patch does.

The preferred format for changes is 'diff -u' output. You can generate it
like this:

	$ diff -urN pinepgp-orig pinepgp-work > mydiffs.patch


TODO
----

	+ documentation?
	+ some other package formats to support more distributions


Authors
-------

Peter Soos <sp@osb.hu>
Peter Hanecak <hanecak@megaloman.sk>
Martin Edas Edlman <edlman@dzungle.ms.mff.cuni.cz>


Maintainer
----------

Current maintainer is Peter Hanecak <hanecak@megaloman.sk> .
