+<!DOCTYPE html>
<html>
<head>
<title>Getting Started With rss2email</title>
+<style type="text/css">
+.hint {
+ color: green;
+}
+
+strong {
+ color: red;
+}
+
+pre,code {
+ color: #900;
+ font-family: monospace;
+}
+</style>
</head>
<body>
<h1>Getting Started With rss2email</h1>
-<p style="color: green;">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: <a href="http://feeds.feedburner.com/allthingsrss/hJBr">http://feeds.feedburner.com/allthingsrss/hJBr</a></p>
-<p><a href="#windows">Instructions for Windows Users</a><br/>
-<a href="#unix">Instructions for UNIX Users</a><br/>
-<a href="#customizeit">Customizing rss2email</a></p>
+<p class="hint">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:
+<a href="http://feeds.feedburner.com/allthingsrss/hJBr">
+http://feeds.feedburner.com/allthingsrss/hJBr</a></p>
+<ul>
+ <li><a href="#windows">Instructions for Windows Users</a></li>
+ <li><a href="#unix">Instructions for UNIX Users</a></li>
+ <li><a href="#usage">Using rss2email</a></li>
+ <li><a href="#customize">Customizing rss2email</a></li>
+</ul>
<h2 id="windows">Instructions for Windows Users</h2>
<h3>Requirements</h3>
-<p>Before you install rss2email, you'll need to make sure that a few things are in place. First, is that a version of <a href="http://www.python.org">Python</a> 2.x installed. Second, determine your outgoing email server's address. That should be all you need.</p>
+<p>Before you install rss2email, you'll need to make sure that a few
+things are in place. First, is that a version
+of <a href="http://www.python.org">Python</a> 2.x installed. Second,
+determine your outgoing email server's address. That should be all you
+need.</p>
<h3>Download</h3>
<ol>
-<li>Create a new folder</li>
-<li>Download the latest rss2email .ZIP file and unzip to the new folder
+ <li>Create a new directory.</li>
+ <li>Download the latest rss2email <code>.ZIP</code> file and unzip to
+ the new directory.</li>
</ol>
<h3>Configure</h3>
-<p>Edit the <code>config.py</code> file and fill in your outoing email server's details. If your server requires you to login, change <code>"AUTHREQUIRED = 0"</code> to <code>"AUTHREQUIRED = 1"</code> and enter your email username and password.</p>
+<p>Edit the configuration file and fill in your outoing email server's
+details. If your server requires you to login,
+change <code>AUTHREQUIRED = 0</code> to <code>AUTHREQUIRED = 1</code>
+and enter your email username and password.</p>
<h3>Install</h3>
-<p>From the command line, change to the folder you created. Now create a new feed database to send updates to your email address:</p>
-
-<blockquote>
- <p><code>r2e new you@yourdomain.com</code></p>
-</blockquote>
-
-<p>Subscribe to some feeds:</p>
-
-<blockquote>
- <p><code>r2e add http://feeds.feedburner.com/allthingsrss/hJBr</code></p>
-</blockquote>
-
-<p>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.</p>
-
-<p>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:</p>
-
-<blockquote>
- <p><code>r2e run --no-send</code></p>
-</blockquote>
-
-<p>Then later, you can ask it to email you new stories:</p>
-
-<blockquote>
- <p><code>r2e run</code></p>
-
-</blockquote>
-
-<p>If you get an error message "Sender domain must exist", add a line to <code>config.py</code> like this:</p>
-
-<blockquote>
- <p><code>DEFAULT_FROM = rss2email@yoursite.com</code></p>
-</blockquote>
-
-<p>You can make the email address whatever you want, but your mail server requires that the yoursite.com part actually exists.</p>
+<p>From the command line, change to the directory you created, and
+just run <code>r2e</code> from this directory. For basic usage
+guidelines, look <a href="#usage">here</a>.</p>
<h3>Automating rss2email</h3>
-<p>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 <a href="http://www.iopus.com/guides/winscheduler.htm">tutorial</a> 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".</p>
-
-<p>Now jump down to the section on <a href="#customizeit">customizing rss2email</a> to your needs.</p>
+<p>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 <a href="http://www.iopus.com/guides/winscheduler.htm">tutorial</a>
+on it. Just select <code>r2e.bat</code> 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 <code>run</code> comes
+after <code>r2e.bat</code>. For example, if you installed rss2email in
+the <code>C:\rss2email</code> directory, then you would change the Run
+entry from <code>C:\rss2email\r2e.bat</code>
+to <code>C:\rss2email\r2e.bat run</code>.</p>
+
+<p>Now jump down to the section on <a href="#customize">customizing
+rss2email</a> to your needs.</p>
<h3>Upgrading to a new version</h3>
-<p>Simply replace all of the files from the .ZIP package to your install directory <strong style="color: red;">EXCEPT config.py</strong></p>
+
+<p>Simply replace all of the files in your install
+directory <strong>EXCEPT your config file</strong> with new versions
+from the <code>.ZIP</code> package.</p>
<h2 id="unix">Instructions for UNIX/Linux Users</h2>
<h3>Requirements</h3>
-<p>Before you install rss2email, you'll need to make sure that a few things are in place. First, is a version of <a href="http://www.python.org">Python</a> 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.</p>
+<p>Before you install rss2email, you'll need to make sure that a few
+things are in place: a version
+of <a href="http://www.python.org">Python</a> 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.</p>
<h3>Download</h3>
-<p>A quick way to get rss2email going is using pre-made packages. Here are releases for <a href="http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&version=all&exact=1&keywords=rss2email">Debian</a> Linux, <a href="http://packages.ubuntu.com/search?keywords=rss2email&searchon=names§ion=all">Ubuntu</a> Linux and <a href="ftp://ftp.netbsd.org/pub/NetBSD/NetBSD-current/pkgsrc/mail/rss2email/README.html">NetBSD</a>.</p>
+<p>A quick way to get rss2email going is using pre-made packages. Here
+are releases for
+<a href="http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&version=all&exact=1&keywords=rss2email">Debian</a> Linux,
+<a href="http://packages.ubuntu.com/search?keywords=rss2email&searchon=names§ion=all">Ubuntu</a> Linux,
+and
+<a href="ftp://ftp.netbsd.org/pub/NetBSD/NetBSD-current/pkgsrc/mail/rss2email/README.html">NetBSD</a>.</p>
-<p>If you are unable to use these packages or you want the latest and greatest version, here's what you do:</p>
+<p>If you are unable to use these packages or you want the latest and
+greatest version, here's what you do:</p>
-<blockquote><code>
-Unarchive (probably 'tar -xzf') the rss2email .tar.gz package to [folder where you want rss2email files to live] <br>
-cd [yourfolder] <br>
-chmod +x r2e
-</code></blockquote>
+<pre>
+$ tar xvf rss2email-*.tar.gz
+$ mv rss2email-* /path/to/install/location/
+$ cd /path/to/install/location
+$ chmod +x r2e
+</pre>
-<h3>Install</h3>
+<p>You can run <code>r2e</code> from this directory or add the
+installation directory to your <code>PATH</code>. For basic usage
+guidelines, look <a href="#usage">here</a>.</p>
-<p>Create a new feed database with your target email address:</p>
-
-<blockquote>
- <p><code>./r2e new you@yourdomain.com</code></p>
-</blockquote>
-
-<p>Subscribe to some feeds:</p>
-
-<blockquote>
- <p><code>./r2e add http://feeds.feedburner.com/allthingsrss/hJBr</code></p>
+<h3>Upgrading to a new version</h3>
-</blockquote>
+<p>Simply replace all of the files in your install
+directory <strong>EXCEPT your config file</strong> with new versions
+from the <code>.tar.gz</code> package.</p>
-<p>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.</p>
+<h2 id="usage">Using rss2email</h2>
-<p>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:</p>
+</p>Create a new feed database to send updates to your email
+address:</p>
-<blockquote>
- <p><code>./r2e run --no-send</code></p>
-</blockquote>
+<pre>
+r2e new you@yourdomain.com
+</pre>
-<p>Then later, you can ask it to email you new stories:</p>
+<p>Subscribe to some feeds:</p>
-<blockquote>
- <p><code>./r2e run</code></p>
-</blockquote>
+<pre>
+r2e add http://feeds.feedburner.com/allthingsrss/hJBr
+</pre>
-<p>You probably want to set things up so that this command is run repeatedly. (One good way is via a cron job.)</p>
+<p>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.</p>
-<p>If you get an error message "Sender domain must exist", add a line to <code>config.py</code> like this:</p>
+<p>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:</p>
-<blockquote>
- <p><code>DEFAULT_FROM = rss2email@yoursite.com</code></p>
-</blockquote>
+<pre>
+r2e run --no-send
+</pre>
-<p>You can make the email address whatever you want, but your mail server requires that the yoursite.com part actually exists.</p>
+<p>Then later, you can ask it to email you new stories:</p>
-<h3>Upgrading to a new version</h3>
-<p>Simply replace all of the files from the .tar.gz package to your install directory <strong style="color: red;">EXCEPT config.py</strong></p>
+<pre>
+r2e run
+</pre>
+<p>If you get an error message <code>Sender domain must exist</code>,
+add a line to your configuration file like this:</p>
+<pre>
+DEFAULT_FROM = rss2email@yoursite.com
+</pre>
-<h1 id="customizeit">Customize rss2email</h1>
+<p>You can make the email address whatever you want, but your mail
+server requires that the <code>yoursite.com</code> part actually
+exists.</p>
-<p>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 <code>config.py</code> file. If you're not using rss2email under Windows, you'll have to create this file if it doesn't already exist.</p>
+<h2 id="customize">Customize rss2email</h2>
-<p>For example, if you want to receive HTML mail, instead of having entries converted to plain text:</p>
+<p>There are a number of options, described in full at the top of
+<code>rss2email.py</code> 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.</p>
-<blockquote>
- <p><code>HTML_MAIL = 1</code></p>
+<p>For example, if you want to receive HTML mail, instead of having
+entries converted to plain text:</p>
-</blockquote>
+<pre>
+HTML_MAIL = 1
+</pre>
-<p>To be notified every time a post changes, instead of just when it's first posted:</p>
+<p>To be notified every time a post changes, instead of just when it's
+first posted:</p>
-<blockquote>
- <p><code>TRUST_GUID = 0</code></p>
-</blockquote>
+<pre>
+TRUST_GUID = 0
+</pre>
-<p>And to make the emails look as if they were sent when the item was posted:</p>
+<p>And to make the emails look as if they were sent when the item was
+posted:</p>
-<blockquote>
- <p><code>DATE_HEADER = 1</code></p>
+<pre>
+DATE_HEADER = 1
+</pre>
</body>
</html>
projects / rss2email.git / commitdiff