1R2E(1a)                                                                R2E(1a)
2
3
4

NAME

6       r2e - receive RSS feeds by email
7

SYNOPSIS

9       r2e action [options]
10

DESCRIPTION

12       r2e  is a simple program which you can run in your crontab.  It watches
13       RSS feeds and sends you a nicely formatted email message for  each  new
14       item.
15
16       The program is configured by ~/.rss2email/config.py
17
18       For a quick start with r2e, try these steps:
19
20              r2e new your@address
21              r2e add http://feed.url/somewhere.rss
22              r2e run
23
24       The last command should eventually be put into your crontab, if you
25       want things be sent you automatically.
26

ACTIONS

28       new [youremail]
29              Create  a  new  feedfile.  If the second option is specified, it
30              sets the default email address that mails are sent to.
31
32       add url [youremail]
33              Subscribe to a feed. The first option is the URL  of  the  feed.
34              The  optional  second  option  is  the email address to send new
35              items to.  Repeat for each feed you want to subscribe to.
36
37       run [--no-send] [num]
38              Scan the feeds and send emails for new items. This can be run in
39              a cron job.
40
41       The --no-send option stops r2e from sending any email. This can be use‐
42       ful the first time you run it, as otherwise it would send every  avail‐
43       able story.
44
45       If  a  number  is specified, r2e will only download that feed. The list
46       command lists the feed numbers.
47
48       email yournewemail
49              Change the default email address.
50
51       list   List all your currently subscribed feeds.
52
53       delete n
54              Delete a feed, using its number from the list command.
55

CONFIGURATION

57       The program's behavior can be controlled via the ~/.rss2email/config.py
58       config  file.  The  file is a python file, so variables are set using a
59       syntax like this: VARIABLE = "value"
60
61       If the value is a number, the quotes may be omitted. Most configuration
62       variables  in  the  file  are  boolean  values, where a 1 indicates the
63       option is set, and a 0 disables it.
64
65       See the example config.py file for a full list of available  configura‐
66       tion variables.
67

FILES

69       ~/.rss2email/feeds.dat
70              The  database of feeds. Use r2e to add, remove, or modify feeds,
71              do not edit it directly.
72
73       ~/.rss2email/config.py
74              If this file exists, it is read to configure the program.
75

AUTHOR

77       Aaron Swartz <rss2email@aaronsw.com>
78
79
80
81                                                                       R2E(1a)