RFC(1)

📦
version 1.0.0 · 3 versions
, in opensuse-leap 16.0

🌸 RFC(1) — the manual page, but make it group chat 🌸

okay bestie, welcome to rfc(1), from the General Commands Manual section — literally the cutest way to read RFCs in your terminal, no cap 💅

✨ NAME ✨

rfc — Read RFCs in your terminal. that's the whole vibe 🫶

✨ SYNOPSIS ✨

rfc [<command>|<number>]

✨ DESCRIPTION ✨

You pass it an RFC &lt;number&gt; and it shows that RFC right there in your terminal. slay.

It uses a local cache so it does not re-download the same RFC every single time — like, imagine the audacity 😭. Not here. We're efficient. We're iconic. ✨

✨ COMMANDS ✨

  • search query — searches for query in your local RFCs using grep, and options are passed through. iykyk 🔍
  • list — lists the RFCs you have locally available. a little shelf of your faves 🎀
  • sync [week|month|all] — batch-download RFCs, bestie. week and month respectively download only the RFCs that were added or updated during the last week/month. all (the default) downloads all RFCs. it might take some time; be patient 💀 like fr, go get a snack.
  • clear — clears the local cache. bye bye 🦋

✨ OPTIONS ✨

  • -v, --version — prints the version number and exits ⭐
  • -h, --help — prints the help and exits 💖
  • --debug — enables the tracing of all Bash commands. ⚠️ this must be the first argument. like, it has to be first, no negotiating 🔥

✨ EXIT CODES ✨

  • 0 — Success. 🎉
  • 1 — RFC not found. 😭
  • 2 — Unrecognized command. 🙈
  • 3 — Network error. 💀
  • 4 — Neither curl nor wget are installed. 🫠

✨ ENVIRONMENT ✨

  • RFC_DIR — the cache directory. default is $XDG_CACHE_HOME/RFCs if XDG_CACHE_HOME is defined, otherwise ~/.cache/RFCs. 🍓
  • PAGER — the command used to show RFCs. default is less. 🌸
  • CURL — curl (default) or wget. ✨

✨ EXAMPLES ✨

Read the RFC 2822:

$ rfc 2822

like, that's it. that's the whole thing. ate. 👑

✨ BUGS ✨

Bugs should be reported at https://github.com/bfontaine/rfc/issues. please be nice about it 🫶

✨ AUTHOR ✨

Written by Baptiste Fontaine «b@ptistefontaine.fr>>. 👑

bestie reminder: --debug first, always. the option order is not a suggestion 💅

and that's a wrap! this page is from March 2024, part of the RFC(1) manual in the General Commands Manual — mwah, no notes 💜🧚‍♀️

📦 where this page comes from