Rssgoemail README file

1. What is rssgoemail?

Rssgoemail is a command line tool that let you read your favourite feeds from
your mailbox.
It is designed to work in cooperation with the system mailer, as it will send
all the items of every give feed using sendmail(8).

A typical setup involves a local mailer able to store e-mails in a Maildir
mailbox, but anything your MTA supports will work.

2. Installation.

If you are reading this README file, it means that you downloaded the .tar.gz
archive that you can use to install rssgoemail the classic way (including the
man pages). To install the program, from the project root:

	$ make
	# make install

Will install the program and the man page under /usr/local.

The DESTDIR environment variable may be used to change the root directory where
rssgoemail will be installed. The PREFIX environment variable can be used to
apply a prefix before the final installation path. Thus, the final path, for
example, of the rssgoemail binary will be:

	${DESTDIR}${PREFIX}/bin/rssgoemail

3. Usage

By default rssgoemail will read a series of feed URLs from the
${HOME}/.rssgoemail.conf file, one URL per line. For example, to fetch the Hacker
News and "The Guardian" feeds:

	$ echo 'https://www.theguardian.com/world/rss' \
	    >${HOME}/.rssgoemail.conf
	$ echo 'https://news.ycombinator.com/rss' \
	    >>${HOME}/.rssgoemail.conf
	$ rssgoemail

This is everything required.

Feeds are cached, meaning that entries in feeds that were already fetched, will not
be sent to your mailbox again.

Delivered e-mails are tagged with a custom 'X-RSSGo-Email' header. This will let
you separate the feeds e-mails from the regular ones with a rule in your MTA or,
in your e-mail client.

There are no support for IMAP, or SMTP directly, if you want to have your e-mails
delivered to your IMAP mailbox, you must find a way to forward the messages from
your mailer or run rssgoemail directly on your mailserver.

4. Contacts

If you have questions, or you want to report bugs, refer to the project's forum:

	https://lab.abiscuola.com/rssgoemail/forum

That's the prefered place to report problems and ask questions. If you don't
want to use the official forum (but you should!), feel free to report any problem
at:
	a@abiscuola.com
