doc/index.texi

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