README

getfeed is a RSS/Atom feed fetcher.

This script fetches configured feeds, caches their messages and sends new
ones to an external program.

This software is initially intended to pipe feeds to a mail delivery agent to
read them in your favourite mail client.

There is another similar script, r2e, [1]. It is written in python too and uses
the same feedparser [2], but it lacks some features I'd like to see, including:

* getfeed acts mostly like a popular getmail[3].
* Simple and powerful (YAML) configuration file format.
* You may split all your feeds and destinations through your configuration
  files the way you want. You can also call getfeed for only those
  configuration files you want.
* Unix-wayity: getfeed does only what it should do: it gets a feed, splits it
  into separate messages and pipes them to external program. SMTP absence IS a
  feature. Use msmtp[4], sendmail[5] or other analogues for it. Mbox/maildir
  support absence is a feature too. Use maildrop[6], procmail[7] or other
  analogues for that.
* XDG-Basedir support.

If you want any missing info on the project, just ask me. You may fill an issue
form at bug tracker if you think that this info should be in README. Or you may
email me directly. Please see BUGS section on how to do that.

USAGE

See sample-config.yaml for the sample configuration. Request documentation if
you want it.

Default configuration file location is '~/.config/getfeed/config.yaml'. You may
tell getfeed to use another or other configuration files with '-r' command line
parameters. Use "./" prefix to proceed a file from the current directory. If
you don't the file will be looked at ~/.config/getfeed/ by default.

Use 'getfeed --help' for details.

BUGS

* There may be no correct MIME types and character encodings interpretation
yet. To be continued.
* No configuration file format stability is guaranteed at the moment. Though
database format will always be backward compatible.

Please, report any bugs and desired features including spelling and grammar
errors in both messages and README etc.

To report a bug submit new issue to http://github.com/sshilovsky/getfeed/ or send
e-mail to sshilovsky@gmail.com with subject starting with "[getfeed] "

Please attach your configuration file and related cache databases if they may
matter.

[1] http://www.allthingsrss.com/rss2email
[2] http://code.google.com/p/feedparser/ http://pypi.python.org/pypi/feedparser
[3] http://pyropus.ca/software/getmail/
[4] http://msmtp.sourceforge.net/
[5] http://www.sendmail.org/
[6] http://www.courier-mta.org/maildrop/
[7] http://www.procmail.org/