8 @item Get its source code
11 $ git clone git://git.stargrave.org/feeder.git
15 @item Compile @command{feed2mdir} utility
18 $ ( cd cmd/feed2mdir ; go build )
21 @item Create feeds state directories
23 You can create feeds subdirectories under @file{feeds/} manually:
26 $ mkdir -p feeds/my_first_feed/@{cur,new,tmp@}
27 $ echo http://example.com/feed.atom > feeds/my_first_feed/url
30 or convert Newsboat @file{urls} file (containing many lines with URLs)
31 with @file{urls2feeds.zsh} to subdirectories hierarchy:
34 $ ./urls2feeds.zsh < ~/.newsboat/urls
35 $ cat feeds/blog.stargrave.org_russian_feed.atom/url
36 http://blog.stargrave.org/russian/feed.atom
39 @file{urls2feeds.zsh} won't touch already existing directories and will
40 warn if some of them disappeared from @file{urls}.
42 @item Download your feed(s) data
45 $ cmd/download.sh feeds/blog.stargrave.org_russian_feed.atom
46 $ ./feeds-download.zsh # to invoke parallel downloading of everything
49 Probably you want to change its default @env{$PROXY} value. It uses
50 @command{curl}, that is aware of @code{If-Modified-Since} and
51 @code{ETag} headers, compressed content encodings and HTTP redirections.
52 If you want to see verbose output, then set @env{FEEDER_CURL_VERBOSE=1}.
54 @item Parse your feeds
57 $ cmd/parse.sh feeds/blog.stargrave.org_russian_feed.atom
58 $ ./feeds-parse.zsh # to parse all feeds in parallel
61 @item Quick overview of the news:
65 habr.com_ru_rss_interesting: 7
66 habr.com_ru_rss_news: 3
68 naked-science.ru_?yandex_feed=news: 1
69 planet.fsfe.org_atom.xml: 1
70 www.astronews.ru_astronews.xml: 1
71 www.darkside.ru_news_rss: 5
80 That will read all feeds titles and create @file{mutt.rc} sourceable
81 configuration file with predefined helpers and @code{mailboxes}
82 commands. Mutt will be started in mailboxes browser mode (I will skip
86 1 N [ 1|101] 2021-02-17 20:41 Cryptology ePrint Archive/
87 3 [ 0| 8] 2021-12-02 19:28 Thoughts/
88 32 [ 0| 8] 2021-02-17 19:32 apenwarr/
89 101 [ 10| 50] 2021-02-14 13:40 Блог Stargrave на русском comments/
90 102 [ 0| 51] 2021-02-17 19:37 Блог Stargrave на русском/
91 316 [ 0| 44] 2021-02-17 19:33 Eaten By A Grue: Infocom, Text Adventures, and Interactive Fiction/
94 ePrint has new entries since last downloading/parsing. Stargrave's blog
95 comments have nothing new, but still ten unread entries.
97 If we open "Eaten By A Grue" mailbox, then will see its entries:
100 1 [2021-01-30 11:00] Zork Zero: The Revenge of Megaboz (0,8K)
101 2 [2021-06-12 11:01] Journey: The Quest Begins (0,8K)
102 3 [2021-04-28 11:00] Eaten By A Cruise (0,8K)
104 ---Mutt: feeds/monsterfeet.com_grue.rss [Nachr:44 60K]---
107 @item Press @code{q} to return to mailbox browser again
109 This is made for convenience, because you will often switch your
110 mailboxes (feeds), but @code{q} quits Mutt by default.
112 @item Press @code{A} to mark all messages read
114 And again this is made for convenience. It will mark both new
115 (@strong{N}) and old-but-unread (@strong{O}) messages as read. You will
116 see left tag-marks near each message to understand what was touched.
118 @item Index your messages
124 That will create @file{mu/} and @file{search/} directories and run
125 @command{mu index} indexing, that is safely can be done incrementally
126 after each download/parse cycle.
128 @item Search something
130 Press @code{<F8>} in Mutt's index and enter your mu/Xapian search query.
131 Let's search for articles mentioning
132 @url{https://en.wikipedia.org/wiki/Planetfall, Planetfall} during
133 2019-2021 period: @code{Planetfall date:2019..2021}. @command{mu} will
134 create symbolic links in @file{search/} subdirectory to the message. Press
135 @code{<F9>} to switch that mailbox:
138 1 [2021-12-20 07:08] Missed Classic: Stationfall - When Food Dispensers Attack (The Adventurers Guild)
139 2 [2021-11-20 04:52] Missed Classic 102: Stationfall - Introduction (1987) (The Adventurers Guild)
140 3 [2021-11-19 17:54] Boffo Games (The Digital Antiquarian)
141 4 [2021-10-30 23:05] Missed Classic 100: The Manhole (1988) (The Adventurers Guild)
142 5 [2020-05-17 22:16] Round 04 Reveal (unWinnable State)
143 6 [2020-05-16 22:29] Round 03 Reveal (unWinnable State)
144 7 [2020-04-20 11:00] Planetfall (Eaten By A Grue: Infocom, Text Adventures, and Interactive Fiction)
145 8 [2020-04-09 11:00] Beyond Zork (Eaten By A Grue: Infocom, Text Adventures, and Interactive Fiction)
146 -%-Mutt: =search [Nachr:8 215K]---
149 Pay attention that there is different index format, lacking unnecessary
150 message flags display and adding name of the feed in parenthesis.
152 @item Cleanup excess number of messages
158 That will remove all messages in all feeds @file{cur/} directory that is
159 not first hundred of ones, ordered by @code{mtime}. Pay attention that
160 @file{new/} directory is not touched, so you won't loose completely new
161 and unread messages when you are on vacation and left @command{cron}-ed
162 workers. @command{cmd/feed2mdir/feed2mdir} command by default has
163 @option{-max-entries 100} option set.
165 @item If you want to clean download state
168 $ cmd/download-clean.sh feed/FEED
172 @item Download enclosures
174 Many feeds include links to so-called enclosures, like audio files for
175 podcasts. While you mail is not processed by MUA, its @file{new/}
176 messages still there, you can run enclosure downloading process, that
177 uses @url{https://www.gnu.org/software/wget/, GNU Wget}. Specify the
178 directory where your enclosures should be placed. Each enclosure's
179 filename is more or less filesystem-friendly with the current timestamp
183 $ mkdir path/to/enclosures
184 $ ./feeds-encs.zsh path/to/enclosures
186 traffic.libsyn.com_monsterfeet_grue_018.mp3-20220218-152822
188 $ file path/to/enclosures/traffic.libsyn.com_monsterfeet_grue_018.mp3-20220218-152822
189 path/to/...: Audio file with ID3 version 2.2.0, contains:MPEG ADTS, layer III, v1, 96 kbps, 44.1 kHz, Monaural
192 @command{feeds-encs.zsh} do not parallelize jobs, because enclosure are
193 often heavy enough to satiate your Internet link.