FEAD(1)

πŸ“¦ version 1.0.0, in nixos 26.05, nixpkgs unstable

πŸ’… FEAD(1) β€” like, the fead manual page, bestie

okay so first things first: the command is fead, it lives in the User Commands section of the manual, and it is literally an advert generator that eats web feeds for breakfast. no cap. πŸ¦‹


✨ NAME ✨

fead β€” advert generator from web feeds 🌸

πŸŽ€ SYNOPSIS πŸŽ€

fead [OPTION]...

🫢 DESCRIPTION 🫢

Generate adverts from web feeds. that's the whole vibe. you give it feeds, it gives you ads. iconic behavior honestly πŸ‘‘

πŸ’… OPTIONS πŸ’…

  • -h, --help β€” shows this help message and then exits, like a polite queen πŸŽ€
  • -v, --version β€” shows the program's version number and then exits πŸ‘‘
  • -F, --feeds PATH β€” a file containing newline-separated web feed URLs (one URL per line, slay) πŸ“„
  • -f, --feed URL β€” an additional web feed URL; you can use this one multiple times, so stack 'em up 🧚
  • -s, --strict β€” abort the whole thing when it fails to fetch or parse a web feed. no silent failures, we die with dignity πŸ’€
  • -n, --count N β€” the maximum number of ads in total (defaults to 3)
  • -p, --per-feed N β€” the maximum number of ads per feed (defaults to 1)
  • -l, --length N β€” the maximum summary length (defaults to 256)
  • -t, --template PATH β€” the template file (defaults to stdin)
  • -o, --output PATH β€” the output file (defaults to stdout)
🚨 lowkey important: any use of -f before -F is ignored. order matters, bestie, -F first or it's giving nothing.

⭐ TEMPLATE ⭐

the template gets used by Python str.format to generate each advert. it can contain the following fields, and they're delimited by braces ({ and }) β€” so yes, curly braces, not vibes πŸŽ€

  • source_title β€” the title of the web feed
  • source_link β€” the URL to the feed's website
  • title β€” the title of the feed item
  • link β€” the URL to the item
  • time β€” the publication time
  • summary β€” the truncated content or description

and about that publication time: it's a Python datetime.datetime object, which supports at least C89 format codes, e.g. {time:%Y-%m-%d}. so you can format it however you want, periodt πŸ•βœ¨

🌈 EXAMPLES 🌈

okay so given these URLs in a feeds file:

https://adol.pw/index.xml
https://cnx.gdn/feed.xml
https://xrvs.net/index.xml

you can generate an advertisement of the two latest blogs among them, along with articles by Drew DeVault, via the following command. it's giving main character energy fr fr:

echo "<article>
  <h3><a href='{link}'>{title}</a></h3>
  {summary}&mdash;<a href='{source_link}'>{source_title}</a>,
{time:%F}
  </article>" | fead -F feeds -f https://drewdevault.com/blog/index.xml
-n 2

😭 REPORTING BUGS 😭

issues should be reported to <~cnx/misc@lists.sr.ht>. don't suffer in silence, tell the maintainers 🫢

πŸ¦‹ SEE ALSO πŸ¦‹

python(1), strftime(3)


and that's the whole page πŸ’– this was fead version 1.0.0, dated January 1980 (yes really, that date is not a typo, it's just vintage ✨). mwah, go generate some ads πŸŽ€πŸ”₯

πŸ“¦ where this page comes from