1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
.TH R2E 1a
.SH NAME
r2e \- receive RSS feeds by email
.SH SYNOPSIS
.B r2e action [options]
.SH DESCRIPTION
.BR r2e
is a simple program which you can run in your crontab.
It watches RSS feeds and sends you nicely formatted email message
for each new item.
.P
The program is configured by ~/.rss2email/config.py
.P
For a quick start with r2e, try these steps:
.P
.RS
.nf
.BI "r2e new " your@address
.BI "r2e add " http://feed.url/somewhere.rss
.BI "r2e run "
.RE
.P
The last command should eventually be put into your crontab, if you
want things be sent you automatically.
.SH ACTIONS
.TP
.B new [youremail]
Create a new feedfile. If the second option is specified, it sets the
default email address that mails are sent to.
.TP
.B add url [youremail]
Subscribe to a feed. The first option is the URL of the feed.
The optional second option is the email address to send new items to.
Repeat for each feed you want to subscribe to.
.TP
.B run [--no-send] [num]
Scan the feeds and send emails for new items. This can be run in a cron
job.
.P
The --no-send option stops r2e from sending any email. This can be
useful the first time you run it, as otherwise it would send every
available story.
.P
If a number is specified, r2e will only download that feed. The list
command lists the feed numbers.
.TP
.B email yournewemail
Change the default email address.
.TP
.B list
List all your currently subscribed feeds.
.TP
.B delete n
Delete a feed, using its number from the list command.
.SH "CONFIGURATION"
The program's behavior can be controlled via the ~/.rss2email/config.py
config file. The file is a python file, so variables are set using a syntax
like this: VARIABLE = "value"
.P
If the value is a number, the quotes may be omitted. Most configuration
variables in the file are boolean values, where a 1 indicates the option is
set, and a 0 disables it.
.P
See the example config.py file for a full list of available configuration
variables.
.SH FILES
.TP
.B ~/.rss2email/feeds.dat
The database of feeds. Use r2e to add, remove, or modify feeds, do not edit
it directly.
.TP
.B ~/.rss2email/config.py
If this file exists, it it read to configure the program.
.SH AUTHOR
Aaron Swartz <rss2email@aaronsw.com>
.TH R2E 1a
.SH NAME
r2e \- receive RSS feeds by email
.SH SYNOPSIS
.B r2e action [options]
.SH DESCRIPTION
.BR r2e
is a simple program which you can run in your crontab.
It watches RSS feeds and sends you nicely formatted email message
for each new item.
.P
The program is configured by ~/.rss2email/config.py
.P
For a quick start with r2e, try these steps:
.P
.RS
.nf
.BI "r2e new " your@address
.BI "r2e add " http://feed.url/somewhere.rss
.BI "r2e run "
.RE
.P
The last command should eventually be put into your crontab, if you
want things be sent you automatically.
.SH ACTIONS
.TP
.B new [youremail]
Create a new feedfile. If the second option is specified, it sets the
default email address that mails are sent to.
.TP
.B add url [youremail]
Subscribe to a feed. The first option is the URL of the feed.
The optional second option is the email address to send new items to.
Repeat for each feed you want to subscribe to.
.TP
.B run [--no-send]
Scan the feeds and send emails for new items. This can be run in a cron
job.
The --no-send option stops r2e from sending any email. This can be
useful the first time you run it, as otherwise it would send every
available story.
.TP
.B email yournewemail
Change the default email address.
.TP
.B list
List all your currently subscribed feeds.
.TP
.B delete n
Delete a feed, using its number from the list command.
.SH "CONFIGURATION"
The following configuration variables can be set in the ~/.rss2email/config.py
config file. The file is a python file, so variables are set using a syntax
like this: VARIABLE = "value"
.P
If the value is a number, the quotes may be omitted. Most configuration
variables in the file are boolean values, where a 1 indicates the option is
set, and a 0 disables it.
.TP
.B DEFAULT_FROM
The email address messages are from by default, if the rss feed does not
specify an email address. The default valus is "bozo@dev.null"
.TP
.B FORCE_FROM
If set, the DEFAULT_FROM address will always be used, otherwise use
the email address specified by the feed, when possible.
.TP
.B HTML_MAIL
If set, HTML mail will be sent as such. Otherwise, entries will be
converted to plain text before sending.
.TP
.B TRUST_GUID
If set, receive one email per post. Otherwise, a new email will be sent
each time a post changes.
.TP
.B DATE_HEADER
If set, the mail's date will be set to the date the item was posted, if
possible. Otherwise, the date will be based on the time the email is sent.
.TP
.B QP_REQUIRED
If set, do a quoted printible conversion; otherwise send message in 8 bits.
.TP
.B VERBOSE
If set, feeds are named as they're processed.
.SH FILES
.TP
.B ~/.rss2email/feeds.dat
The database of feeds. Use r2e to add, remove, or modify feeds, do not edit
it directly.
.TP
.B ~/.rss2email/config.py
If this file exists, it it read to configure the program.
.SH AUTHOR
Aaron Swartz <me@aaronsw.com>
|
