From f708402505edbfcf9c8b9125c15adb6b9154bb89 Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Thu, 4 Oct 2012 07:45:04 -0400 Subject: [PATCH] readme: cleanup formatting. --- readme.html | 234 +++++++++++++++++++++++++++++++--------------------- 1 file changed, 138 insertions(+), 96 deletions(-) diff --git a/readme.html b/readme.html index 6af9cbd..cb2a677 100644 --- a/readme.html +++ b/readme.html @@ -1,162 +1,204 @@ + Getting Started With rss2email +

Getting Started With rss2email

We highly recommend that you subscribe to the rss2email project feed so you can keep up to date with the latest version, bugfixes and features: http://feeds.feedburner.com/allthingsrss/hJBr

Instructions for Windows Users
-Instructions for UNIX Users
-Customizing rss2email

We highly recommend that you subscribe to the +rss2email project feed so you can keep up to date with the latest +version, bugfixes and features: + +http://feeds.feedburner.com/allthingsrss/hJBr

Instructions for Windows Users
Instructions for UNIX Users
Using rss2email
Customizing rss2email

Instructions for Windows Users

Requirements

Before you install rss2email, you'll need to make sure that a few things are in place. First, is that a version of Python 2.x installed. Second, determine your outgoing email server's address. That should be all you need.

Before you install rss2email, you'll need to make sure that a few +things are in place. First, is that a version +of Python 2.x installed. Second, +determine your outgoing email server's address. That should be all you +need.

Download

Create a new folder
Download the latest rss2email .ZIP file and unzip to the new folder +
Create a new directory.
Download the latest rss2email .ZIP file and unzip to + the new directory.

Configure

Edit the config.py file and fill in your outoing email server's details. If your server requires you to login, change "AUTHREQUIRED = 0" to "AUTHREQUIRED = 1" and enter your email username and password.

Edit the configuration file and fill in your outoing email server's +details. If your server requires you to login, +change AUTHREQUIRED = 0 to AUTHREQUIRED = 1 +and enter your email username and password.

Install

From the command line, change to the folder you created. Now create a new feed database to send updates to your email address:

- -

-
r2e new you@yourdomain.com
-

- -

Subscribe to some feeds:

- -

-
r2e add http://feeds.feedburner.com/allthingsrss/hJBr
-

- -

That's the feed to be notified when there's a new version of rss2email. Repeat this for each feed you want to subscribe to.

- -

When you run rss2email, it emails you about every story it hasn't seen before. But the first time you run it, that will be every story. To avoid this, you can ask rss2email not to send you any stories the first time you run it:

- -

-
r2e run --no-send
-

- -

Then later, you can ask it to email you new stories:

- -

-
r2e run
- -

- -

If you get an error message "Sender domain must exist", add a line to config.py like this:

- -

-
DEFAULT_FROM = rss2email@yoursite.com
-

- -

You can make the email address whatever you want, but your mail server requires that the yoursite.com part actually exists.

From the command line, change to the directory you created, and +just run r2e from this directory. For basic usage +guidelines, look here.

Automating rss2email

More than likely you will want rss2email to run automatically at a regular interval. Under Windows this is can be easily accomplished using the Windows Task Scheduler. This site has a nice tutorial on it. Just select r2e.bat as the program to run. Once you've created the task, double click on it in the task list and change the Run entry so that "run" comes after r2e.bat. For example, if you installed rss2email in the C:\rss2email folder, then you would change the Run entry from "C:\rss2email\r2e.bat" to "C:\rss2email\r2e.bat run".

- -

Now jump down to the section on customizing rss2email to your needs.

More than likely you will want rss2email to run automatically at a +regular interval. Under Windows this is can be easily accomplished +using the Windows Task Scheduler. This site has a +nice tutorial +on it. Just select r2e.bat as the program to run. Once +you've created the task, double click on it in the task list and +change the Run entry so that run comes +after r2e.bat. For example, if you installed rss2email in +the C:\rss2email directory, then you would change the Run +entry from C:\rss2email\r2e.bat +to C:\rss2email\r2e.bat run.

+ +

Now jump down to the section on customizing +rss2email to your needs.

Upgrading to a new version

Simply replace all of the files from the .ZIP package to your install directory EXCEPT config.py

+ +

Simply replace all of the files in your install +directory EXCEPT your config file with new versions +from the .ZIP package.

Instructions for UNIX/Linux Users

Requirements

Before you install rss2email, you'll need to make sure that a few things are in place. First, is a version of Python 2.x installed. Second, is whether you have sendmail (or a compatible replacement like postfix) installed. If sendmail isn't installed, determine your outgoing email server's address. That should be all you need.

Before you install rss2email, you'll need to make sure that a few +things are in place: a version +of Python 2.x and sendmail (or a +compatible replacement like postfix) installed. If sendmail isn't +installed, determine your outgoing email server's address. That should +be all you need.

Download

A quick way to get rss2email going is using pre-made packages. Here are releases for Debian Linux, Ubuntu Linux and NetBSD.

A quick way to get rss2email going is using pre-made packages. Here +are releases for +Debian Linux, +Ubuntu Linux, +and +NetBSD.

If you are unable to use these packages or you want the latest and greatest version, here's what you do:

If you are unable to use these packages or you want the latest and +greatest version, here's what you do:

-Unarchive (probably 'tar -xzf') the rss2email .tar.gz package to [folder where you want rss2email files to live] -cd [yourfolder] -chmod +x r2e -

+$ tar xvf rss2email-*.tar.gz
+$ mv rss2email-* /path/to/install/location/
+$ cd /path/to/install/location
+$ chmod +x r2e
+

Install

You can run r2e from this directory or add the +installation directory to your PATH. For basic usage +guidelines, look here.

Create a new feed database with your target email address:

- -

-
./r2e new you@yourdomain.com
-

- -

Subscribe to some feeds:

- -

-
./r2e add http://feeds.feedburner.com/allthingsrss/hJBr
+
Upgrading to a new version
-

Simply replace all of the files in your install +directory EXCEPT your config file with new versions +from the .tar.gz package.

That's the feed to be notified when there's a new version of rss2email. Repeat this for each feed you want to subscribe to.

Using rss2email

Create a new feed database to send updates to your email +address:

-
./r2e run --no-send
-

+r2e new you@yourdomain.com
+

Then later, you can ask it to email you new stories:

Subscribe to some feeds:

-
./r2e run
-

+r2e add http://feeds.feedburner.com/allthingsrss/hJBr
+

You probably want to set things up so that this command is run repeatedly. (One good way is via a cron job.)

That's the feed to be notified when there's a new version of +rss2email. Repeat this for each feed you want to subscribe to.

If you get an error message "Sender domain must exist", add a line to config.py like this:

When you run rss2email, it emails you about every story it hasn't +seen before. But the first time you run it, that will be every +story. To avoid this, you can ask rss2email not to send you any +stories the first time you run it:

-
DEFAULT_FROM = rss2email@yoursite.com
-

+r2e run --no-send
+

You can make the email address whatever you want, but your mail server requires that the yoursite.com part actually exists.

Then later, you can ask it to email you new stories:

Upgrading to a new version

Simply replace all of the files from the .tar.gz package to your install directory EXCEPT config.py

+r2e run
+

If you get an error message Sender domain must exist, +add a line to your configuration file like this:

+DEFAULT_FROM = rss2email@yoursite.com
+

Customize rss2email

You can make the email address whatever you want, but your mail +server requires that the yoursite.com part actually +exists.

There are a number of options, described in full at the top of rss2email.py file, to customize the way rss2email behaves. If you want to change something, edit the config.py file. If you're not using rss2email under Windows, you'll have to create this file if it doesn't already exist.

Customize rss2email

For example, if you want to receive HTML mail, instead of having entries converted to plain text:

There are a number of options, described in full at the top of +rss2email.py file, to customize the way rss2email +behaves. If you want to change something, edit the the configuration +file. You may have to create this file if it doesn't already +exist.

-
HTML_MAIL = 1
+
For example, if you want to receive HTML mail, instead of having +entries converted to plain text:
-

+HTML_MAIL = 1
+

To be notified every time a post changes, instead of just when it's first posted:

To be notified every time a post changes, instead of just when it's +first posted:

-
TRUST_GUID = 0
-

+TRUST_GUID = 0
+

And to make the emails look as if they were sent when the item was posted:

And to make the emails look as if they were sent when the item was +posted:

-
DATE_HEADER = 1
+
+DATE_HEADER = 1
+
-- 2.26.2