r2e.1

   1 .TH R2E 1
   2 .SH NAME
   3 r2e \- receive RSS feeds by email
   4 .SH SYNOPSIS
   5 .B r2e [options] <command> [<args>]
   6 .SH DESCRIPTION
   7 .BR r2e
   8 is a simple program which you can run in your crontab.
   9 It watches RSS feeds and sends you nicely formatted email message
  10 for each new item.
  11 .P
  12 For a quick start with \fBr2e\fR, try these steps:
  13 .P
  14 .RS 4
  15 .nf
  16 .BI "r2e new " "your@yourdomain.com"
  17 .BI "r2e add " "feedname http://feed.url/somewhere.rss"
  18 .BI "r2e run"
  19 .RE
  20 .P
  21 The last command should eventually be put into your crontab, if you
  22 want things be sent you automatically.
  23 .SH OPTIONS
  24 .TP 4
  25 \-\-help
  26 Print the rss2email help and exit.
  27 .TP
  28 \-v, \-\-version
  29 Print the rss2email version and exit.
  30 .TP
  31 \-c, \-\-config \fI<path>\fR
  32 The program is configured by ~/\&.config/rss2mail/config by
  33 default. Use this option to set a different config file.
  34 .TP
  35 \-d, \-\-data \fI<path>\fR
  36 The program is configured by ~/\&.config/rss2mail/config by
  37 default. Use this option to set a different config file.
  38 .TP
  39 \-V, \-\-verbose
  40 Increment the logging verbosity.
  41 .SH COMMANDS
  42 .TP 4
  43 .B new [\fI<email>\fR]
  44 Create a new feed database. If the \fI<email>\fR argument is given, it
  45 sets the default email address that mails are sent to.
  46 .TP
  47 .B email [\fI<email>\fR]
  48 Update the default target email address to \fI<email>\fR.
  49 .TP
  50 .B add \fI<name>\fR \fI<url>\fR [\fI<email>\fR]
  51 Subscribe to a feed. The \fI<name>\fR argument gives the feed a name
  52 for future manipulation. \fI<url>\fR is the URL of the feed.  The
  53 optional \fI<email>\fR argument is the email address to send new items
  54 to, overriding the default address for this particular feed.  Repeat
  55 for each feed you want to subscribe to.
  56 .TP
  57 .B run [\-\-no-send] [\fI<index>\fR [\fI<index>\fR ...]]
  58 Scan the feeds and send emails for new items. This can be run in a cron
  59 job.
  60 .P
  61 .RS 4
  62 The \-\-no-send option stops \fBr2e\fR from sending any email. This can be
  63 useful the first time you run it, as otherwise it would send an email
  64 for every available feed entry.
  65 .P
  66 If an \fI<index>\fR is specified, \fBr2e\fR will only download that
  67 feed. \fI<index>\fR can be either the feed name (as set by \fBadd\fR)
  68 or the feed index (as shown by \fBlist\fR).
  69 .RE
  70 .TP
  71 .B list
  72 List all the feeds in the database.
  73 .TP
  74 .B pause [\fI<index>\fR [\fI<index>\fR ...]]
  75 Pause feeds (disable fetching).  The \fI<index>\fR option selects the
  76 feed(s) to pause (see \fBrun\fR for possible values).  If no
  77 \fI<index>\fR is given, all feeds are paused.
  78 .TP
  79 .B unpause [\fI<index>\fR [\fI<index>\fR ...]]
  80 Unpause feeds (enable fetching).
  81 .TP
  82 .B delete \fI<index>\fR [\fI<index>\fR [\fI<index>\fR ...]]
  83 Remove a feed (or feeds) from the database.  The \fI<index>\fR option
  84 selects the feed(s) to delete (see \fBrun\fR for possible values).
  85 .TP
  86 .B reset [\fI<index>\fR [\fI<index>\fR ...]]
  87 Forget dynamic feed data (e.g. to re-send old entries).  The
  88 \fI<index>\fR option selects the feed(s) to reset (see \fBrun\fR for
  89 possible values).  If no \fI<index>\fR is given, all feeds are reset.
  90 .TP
  91 .B opmlimport [\fI<path>\fR]
  92 Import new feeds from OPML.  \fI<path>\fR is the file from which the
  93 OPML data will be read.  If \fI<path>\fR is not given \fBr2e\fR reads
  94 the data from stdin.
  95 .TP
  96 .B opmlexport [\fI<path>\fR]
  97 Export all feeds to OPML.  \fI<path>\fR is the file to which the OPML
  98 data will be written.  If \fI<path>\fR is not given \fBr2e\fR writes
  99 the data to stdout.
 100 .SH "CONFIGURATION"
 101 The program's behavior can be controlled via the
 102 ~/.config/rss2email/config file. The file format is similar to a
 103 Microsoft Windows INI file.  It is parsed by Python's ConfigParser
 104 class, so see the Python documentation at
 105 http://docs\&.python\&.org/py3k/library/configparser\&.html for format
 106 details.
 107 .P
 108 The config file stores general configuration (applied to all feeds) in
 109 the \fB[DEFAULT]\fR section.  The \fBnew\fR command will create a
 110 configuration file for you, which you can edit as you see fit.  The
 111 \fBadd\fR command will add feed-specific sections.  To override any a
 112 setting for all feeds, change the value in the \fB[DEFAULT]\fR
 113 section.  To override a setting for a particular feed, add that
 114 setting to the feed-specific section.  Here is an example overriding
 115 \fBuse-publisher-email\fR and \fBfriendly-name\fR for the
 116 \fBfeedname\fR feed.
 117 .P
 118 .RS 4
 119 .nf
 120 [DEFAULT]
 121 from = user@rss2email.invalid
 122 force-from = False
 123 use-publisher-email = False
 124 friendly-name = True
 125 ...
 126 verbose = warning
 127
 128 [feed.feedname]
 129 url = http://feed.url/somewhere.rss
 130 use-publisher-email = True
 131 friendly-name = False
 132 .RE
 133 .P
 134 .SH FILES
 135 .TP
 136 .B ~/.rss2email/feeds\&.dat
 137 The database of feeds. Use \fBr2e\fR to add, remove, or modify feeds,
 138 do not edit it directly.
 139 .TP
 140 .B ~/.rss2email/config\&.py
 141 If this file exists, it it read to configure the program.
 142 .SH AUTHORS
 143 rss2email was started by Aaron Swartz, and is currently maintained by
 144 Lindsey Smith.  For a more complete list of contributors, see the
 145 __contributors__ list in rss2email\&.py.
 146 .SH "REPORTING BUGS"
 147 Report bugs to the current maintainer (see the __author__ string in
 148 rss2email\&.py).