x-urlopen.sh

[feeder.git] / doc / usage.texi

diff --git a/doc/usage.texi b/doc/usage.texi
index 280cce0e80e82491046af4fb150c27b6fd89fe93..8af779f66c5fcd35fbee28ea2b97fbb954171c4e 100644 (file)
--- a/doc/usage.texi
+++ b/doc/usage.texi
@@ -36,6 +36,9 @@ $ cat feeds/blog.stargrave.org_russian_feed.atom/url
 http://blog.stargrave.org/russian/feed.atom
 @end example
 
+@file{urls2feeds.zsh} won't touch already existing directories and will
+warn if some of them disappeared from @file{urls}.
+
 @item Download your feed(s) data
 
 @example
@@ -55,6 +58,19 @@ $ cmd/parse.sh feeds/blog.stargrave.org_russian_feed.atom
 $ ./feeds-parse.zsh # to parse all feeds in parallel
 @end example
 
+@item Quick overview of the news:
+
+@example
+$ ./feeds-news.zsh
+habr.com_ru_rss_interesting: 7
+habr.com_ru_rss_news: 3
+lobste.rs_rss: 3
+naked-science.ru_?yandex_feed=news: 1
+planet.fsfe.org_atom.xml: 1
+www.astronews.ru_astronews.xml: 1
+www.darkside.ru_news_rss: 5
+@end example
+
 @item Run Mutt
 
 @example
@@ -99,6 +115,12 @@ And again this is made for convenience. It will mark both new
 (@strong{N}) and old-but-unread (@strong{O}) messages as read. You will
 see left tag-marks near each message to understand what was touched.
 
+@item Press @code{o} to open links and enclosures URLs
+
+Do it in pager mode and you message will be piped to
+@file{cmd/x-urlview.sh}, that will show all @code{X-URL}
+and @code{X-Enclosure} links.
+
 @item Index your messages
 
 @example
@@ -152,4 +174,28 @@ workers. @command{cmd/feed2mdir/feed2mdir} command by default has
 $ cmd/download-clean.sh feed/FEED
 @end example
 
+@anchor{Enclosures}
+@item Download enclosures
+
+Many feeds include links to so-called enclosures, like audio files for
+podcasts. While you mail is not processed by MUA, its @file{new/}
+messages still there, you can run enclosure downloading process, that
+uses @url{https://www.gnu.org/software/wget/, GNU Wget}. Specify the
+directory where your enclosures should be placed. Each enclosure's
+filename is more or less filesystem-friendly with the current timestamp
+in it.
+
+@example
+$ mkdir path/to/enclosures
+$ ./feeds-encs.zsh path/to/enclosures
+[...]
+traffic.libsyn.com_monsterfeet_grue_018.mp3-20220218-152822
+[...]
+$ file path/to/enclosures/traffic.libsyn.com_monsterfeet_grue_018.mp3-20220218-152822
+path/to/...: Audio file with ID3 version 2.2.0, contains:MPEG ADTS, layer III, v1,  96 kbps, 44.1 kHz, Monaural
+@end example
+
+@command{feeds-encs.zsh} do not parallelize jobs, because enclosure are
+often heavy enough to satiate your Internet link.
+
 @end table