1R2E(1)                      General Commands Manual                     R2E(1)
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
27       It is possible to use authenticated feeds using the following syntax:
28
29              r2e add http://user:password@example.com/feed
30

ACTIONS

32       new [youremail]
33              Create  a  new  feedfile.  If the second option is specified, it
34              sets the default email address that mails are sent to.
35
36       add url [youremail]
37              Subscribe to a feed. The first option is the URL  of  the  feed.
38              The  optional  second  option  is  the email address to send new
39              items to.  Repeat for each feed you want to subscribe to.
40
41       run [--no-send] [num]
42              Scan the feeds and send emails for new items. This can be run in
43              a cron job.
44
45       The --no-send option stops r2e from sending any email. This can be use‐
46       ful the first time you run it, as otherwise it would send every  avail‐
47       able story.
48
49       If  a  number  is specified, r2e will only download that feed. The list
50       command lists the feed numbers.
51
52       email yournewemail
53              Change the default email address.
54
55       list   List all your currently subscribed feeds.
56
57       delete n
58              Delete a feed, using its number from the list command.
59
60       pause n
61              Temporarily ignore a feed. A paused feed  won't  be  updated  at
62              all.
63
64       unpause n
65              Re-enable updates from a feed.
66
67       opmlimport url
68              Import feeds from an OPML file.
69
70       opmlexport
71              Export feeds to standard output, as an OPML file.
72

CONFIGURATION

74       The program's behavior can be controlled via the ~/.rss2email/config.py
75       config file. The file is a python file, so variables are  set  using  a
76       syntax like this: VARIABLE = "value"
77
78       If the value is a number, the quotes may be omitted. Most configuration
79       variables in the file are boolean  values,  where  a  1  indicates  the
80       option is set, and a 0 disables it.
81
82       See  the example config.py file for a full list of available configura‐
83       tion variables.
84

FILES

86       ~/.rss2email/feeds.dat
87              The database of feeds. Use r2e to add, remove, or modify  feeds,
88              do not edit it directly.
89
90       ~/.rss2email/config.py
91              If this file exists, it is read to configure the program.
92

AUTHOR

94       Aaron Swartz <rss2email@aaronsw.com>
95
96
97
98                                                                        R2E(1)