Various refactoring and parametrizing

[feeder.git] / doc / usage.texi

diff --git a/doc/usage.texi b/doc/usage.texi
index d7eb951665529e99ae35d01e1f3b921af5ed7ad9..328201a42f8cd1f0b2b23751d84a240d03bedbc6 100644 (file)
--- a/doc/usage.texi
+++ b/doc/usage.texi
@@ -39,6 +39,13 @@ http://blog.stargrave.org/russian/feed.atom
 @command{urls2feeds.zsh} won't touch already existing directories and will
 warn if some of them disappeared from @file{urls}.
 
+@item Check configuration options
+
+@file{cmd/env.rc} contains list of various options you can override by
+environment variables, like @command{curl}, @command{wget},
+@command{zstd}, @command{parallel} command invocations,
+@code{User-Agent}, number of download/parse jobs run in parallel and so on.
+
 @item Download your feed(s) data
 
 @example
@@ -58,6 +65,14 @@ $ cmd/parse.sh feeds/blog.stargrave.org_russian_feed.atom
 $ ./feeds-parse.zsh # to parse all feeds in parallel
 @end example
 
+@item Download-n-parse
+
+You can also download and parse the feeds immediately:
+
+@example
+$ ./feeds-dnp.zsh
+@end example
+
 @item Quick overview of the news:
 
 @example
@@ -74,13 +89,20 @@ www.darkside.ru_news_rss: 5
 @item Run Mutt
 
 @example
-$ ./feeds-browse.zsh
+$ ./feeds-browse.sh
 @end example
 
 That will read all feeds titles and create @file{mutt.rc} sourceable
 configuration file with predefined helpers and @code{mailboxes}
-commands. Mutt will be started in mailboxes browser mode (I will skip
-many entries):
+commands.
+
+That configuration contains @code{auto_view text/html}, that expects
+proper @file{mailcap} configuration file with @code{text/html} entry to
+exists. Mutt has some built-in default search paths for, but you can
+override them with @env{$MAILCAPS} environment variable. There is
+example @file{contrib/mailcap}.
+
+Mutt will be started in mailboxes browser mode (I will skip many entries):
 
 @verbatim
   1   N [  1|101] 2021-02-17 20:41 Cryptology ePrint Archive/
@@ -162,6 +184,7 @@ Parser only appends them, but does not remove obsolete ones.
 
 @example
 $ ./feeds-clear.zsh
+$ cmd/clear.zsh feeds/FEED # to clear single feed
 @end example
 
 will clear everything exceeding the quantity limit. You can set that
@@ -208,7 +231,7 @@ progress is also printed both to stderr and @file{feeds/FEED/encs.log}.
 Of course you can also download only single feed's enclosures:
 
 @example
-$ cmd/download-encs.sh path/to/FEED [optional overriden destination directory]
+$ cmd/encs.zsh path/to/FEED [optional overriden destination directory]
 @end example
 
 @end table