doc/index.texi

   1 \input texinfo
   2 @settitle feeder
   3
   4 @copying
   5 Copyright @copyright{} 2022-2023 @email{stargrave@@stargrave.org, Sergey Matveev}
   6 @end copying
   7
   8 @node Top
   9 @top feeder
  10
  11 @command{feeder} is a free software newsfeeds aggregator.
  12 I wrote it solely for my personal needs, so currently probably there is
  13 some hard-code in the scripts.
  14
  15 My experience was heavily based on @url{https://newsboat.org/, Newsboat}
  16 reader, that unfortunately was rewritten on Rust, so I had to use its
  17 old version. I also saw
  18 @url{https://codemadness.org/git/sfeed/file/README.html, sfeed} project,
  19 that tries to reuse many already existing tools (like @command{curl}),
  20 be @url{https://suckless.org/philosophy/, suckless} and Unix-friendly,
  21 but failed somewhere during the try, and asked myself if it is really so
  22 hard to make that kind of software. It was written in less than a day,
  23 completely replacing Newsboat, with much higher performance and great
  24 flexibility.
  25
  26 Its architecture is very simple:
  27
  28 @itemize
  29 @item @url{https://curl.se/, cURL} is used to download feed URLs.
  30 @item @url{https://go.dev/, Go}-written @command{feed2mdir} utility
  31     parses and converts feed's items to mail messages stored inside
  32     @url{https://en.wikipedia.org/wiki/Maildir, Maildir}.
  33 @item Automatically generated @url{http://www.mutt.org/, Mutt} source
  34     file contains convenient options and human-readable mailboxes list.
  35 @item @url{https://www.gnu.org/software/parallel/, GNU parallel} for
  36     parallel invocation of download/parsing jobs.
  37 @item @url{https://www.djcbsoftware.nl/code/mu/, mu} utilities perform
  38     indexing and searching among the messages. Of course it would be
  39     trivial to use @url{https://www.lesbonscomptes.com/recoll/, recoll}
  40     or @url{https://notmuchmail.org/, notmuch} instead, if you need that.
  41 @item Bunch of optional @url{https://www.zsh.org/, Zsh} helper scripts.
  42 @end itemize
  43
  44 But of course it has its price: original feed data, its Base64-encoded
  45 copy in mailbox and another copy in @command{mu}'s Xapian database.
  46
  47 @insertcopying
  48
  49 @include storage.texi
  50 @include mail.texi
  51 @include usage/index.texi
  52
  53 @bye