@node Top
@top feeder
-@command{feeder} is free software newsfeeds aggregator.
+@command{feeder} is a free software newsfeeds aggregator.
I wrote it solely for my personal needs, so currently probably there is
some hard-code in the scripts.
@url{https://codemadness.org/git/sfeed/file/README.html, sfeed} project,
that tries to reuse many already existing tools (like @command{curl}),
be @url{https://suckless.org/philosophy/, suckless} and Unix-friendly,
-but failed somewhere during the try and asked myself if it is really so
-hard to make that kind of software. It was written for less than a day,
+but failed somewhere during the try, and asked myself if it is really so
+hard to make that kind of software. It was written in less than a day,
completely replacing Newsboat, with much higher performance and great
flexibility.
@item @url{https://www.djcbsoftware.nl/code/mu/, mu} utilities perform
indexing and searching among the messages. Of course it would be
trivial to use @url{https://www.lesbonscomptes.com/recoll/, recoll}
- or @url{https://notmuchmail.org/, notmuch} instead. If you need that.
+ or @url{https://notmuchmail.org/, notmuch} instead, if you need that.
@item Bunch of optional @url{https://www.zsh.org/, Zsh} helper scripts.
@end itemize
@end verbatim
Each message is placed under @code{HEX(SHA512/2(title+content))} filename.
-Unfortunately many feeds does not provide any date information at all.
+Unfortunately many feeds do not provide any date information at all.
Often multiple entries contain the same date. So you can not solely
depend on update/publish date.
@unnumbered Storage
Each feed is kept in separate subdirectory in the @file{feeds/}. Its
-name is not important, but human readable is preferable choice. It
+name is not important, but human readable is a preferable choice. It
contains:
@table @file
labels/titles.
Also it contains contains @code{auto_view text/html}, that expects
-proper @file{mailcap} configuration file with @code{text/html} entry to
+a 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
+override them with @env{$MAILCAPS} environment variable. See the
example @file{contrib/mailcap}.
Mutt will be started in mailboxes browser mode (I will skip many entries):
@section 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/}
+podcasts. While your mail is not processed by MUA, its @file{new/}
messages are still there, so you can run enclosure downloading process,
that uses @url{https://www.gnu.org/software/wget/, GNU Wget}. Each
enclosure's filename is more or less filesystem-friendly with the
@node Install
@section Install
-Currently I am lazy enough to create tarballs. Just get its source code:
+Currently I am too lazy to create tarballs. Just get its source code:
@example
$ git clone git://git.stargrave.org/feeder.git
@node Options
@section Options
-There few configuration options taken from @file{cmd/env.rc}. You can
+There are a few configuration options defined in @file{cmd/env.rc}. You can
override them either with environment variables, or by editing that file
directly. You can override @command{curl}, @command{wget},
@command{zstd}, @command{parallel} command invocations,
@end example
That will create @file{mu/} and @file{search/} directories and run
-@command{mu index} indexing, that is safely can be done incrementally
+@command{mu index} indexing, that safely can be done incrementally
after each download/parse cycle.
@url{https://en.wikipedia.org/wiki/Planetfall, Planetfall} during
2019-2021 period: @code{Planetfall date:2019..2021}. @command{mu} will
create symbolic links in @file{search/} subdirectory to the message.
-Press @code{<F2>} to switch that mailbox:
+Press @code{<F2>} to switch to that mailbox:
@verbatim
1 [2021-12-20 07:08] Missed Classic: Stationfall - When Food Dispensers Attack (The Adventurers Guild)
-%-Mutt: =search [Nachr:8 215K]---
@end verbatim
-Pay attention that there is different index format, lacking unnecessary
-message flags display and adding name of the feed in parenthesis.
+Pay attention that `this uses a different index format, lacking unnecessary
+message flags display and adding the name of the feed in parenthesis.
Similarly to @ref{Enclosures, enclosures} downloading, you may run
downloading of @code{X-URL} URLs, pointing to the article itself. If it
-is HTML document, then it can depend on various other resources, like
+is a HTML document, it can depend on various other resources, like
images and stylesheets. @url{https://www.gnu.org/software/wget/, GNU Wget}
-has ability to download it with all required requisites. Moreover it is
+has the ability to download it with all required requisites. Moreover it is
able to output the whole document in
@url{https://en.wikipedia.org/wiki/Web_ARChive, WARC} format.