Canto-curses(1)

📦 version 0.9.9, in arch rolling, nixos 26.05, nixpkgs unstable

💅 CANTO-CURSES(1) — General Commands Manual 🌸

okay so bestie, let me tell you about Canto-curses — it's an ncurses frontend for canto-daemon, and it's literally the moment. no cap. 💖

🎀 COMMAND LINE USAGE 🎀

canto-curses (options)

that's it. that's the vibe. run it with options, slay. ✨

✨ OPTIONS ✨

  • -V — prints version info and dips. iconic behavior. 👑
  • -h/--help — prints usage help, so you're never lost, bestie. 🫶
  • -v — enables verbose logging (debug mode). it's giving tell me everything. 🔍
  • -D/--dir [directory] — changes the base directory for canto-daemon. default is $XDG_CONFIG_HOME/canto. you can move it around like it's your own furniture. 🪑
  • --noplugins — disables ALL plugins. zero plugins. none. ghost town. 💀
  • --enableplugins 'plugin1 plugin2...' — enable these specific plugins. note: this overrides --noplugins, so it's the main character move. 🌟
  • --disableplugins 'plugin1 plugin2...' — disable these specific plugins. not today, bestie. 🙈
  • -a/--address [IP] — tries to connect to the address instead of the local Unix socket. defaults to loopback (127.0.0.1), which is literally just home. 🏠
  • -p/--port [port] — uses the port when listening with -a. coordinate your fit. 🎯
  • -l — appends pid to the log filename (debug). for when you need to know exactly which instance is doing the thing. 🔥

🌈 GETTING STARTED 🌈

  • : (colon) — brings up the canto-curses command line. it's the doorway to everything. 🚪✨
  • :help — brings up the internal help, which has a way more complete list of keybinds and commands. the full tea. 🫖

💜 BASIC COMMANDS 💜

  • :set browser [browser] — set your favorite browser. treat yourself. 🥰
  • :set browser.text [True|False] — set this to True if you're using a text-based browser like elinks, so canto-curses knows to give up the screen to it. polite and considerate. 🎀
  • :add [URL] (username=user password=secret) (name="Some name") — subscribe to a feed, with optional arguments. the add heard 'round the world. 📬
  • :del — unsubscribe from the selected feed. it's not you, it's the feed. 💔

🌸 BASIC KEYBINDS 🌸

  • j/k — previous item / next item. up and down, the classic. ⬆️⬇️
  • J/K — previous tag / next tag. capital letters for the big moves. 🔠
  • PgUp/PgDown — previous page / next page. flip through like it's a magazine. 📖
  • g — goto the selected item in your browser. go go go! 🚀
  • <space> — open / close the internal item reader. the spacebar is that girl. ⌨️
  • c/v — collapse (minimize) / uncollapse the selected tag. control the chaos. 🌀
  • C/V — collapse (minimize) / uncollapse all visible tags. go big or go home. 💥

🔥 ADVANCED USAGE 🔥

Canto-curses supports a lot more features, like categorizing feeds/tags, filtering and sorting, searching, and more — all of which can be discovered with :help. it's giving hidden depths. 🕵️‍♀️

It also supports a variety of plugins that can add a lot of extra functionality. these are included with this install or available on the homepage. plug in, bestie. 🔌✨

🧚 PLUGINS 🧚

Plugins are packaged in <prefix>/canto/plugins (i.e. /usr/lib/canto/plugins) and can be enabled by copying them into your configuration directory (i.e. $XDG_CONFIG_HOME/canto/plugins). Many of them have configuration in them, so you may want to open the files to make changes. here are a few example plugins included with the canto-curses source. 🎁

  • autocmd.py — issues commands automatically on startup (useful to change configuration on startup). set it and forget it. 🤖
  • reader-extras.py — adds extra content to some feeds, also useful to see what's included in a feed. bonus content, no cap. 🍓
  • xtermtitle.py — sets the title of xterm-compatible terminals on startup, and optionally includes the selected item title. your terminal title has main character energy. 👑
  • yank.py — adds :yank-link (defaults to 'y') and :yank-title commands (needs xclip installed). grab it and go. 📋
  • favorites.py — a proof of concept user "favorites" tag, that can change the appearance of certain items selected by the user. it's a whole mood. 💖
  • smartlink.py — a plugin that lets you define specific handlers for links based on the URL or the output of file on the downloaded content. useful for listening to podcast enclosures or displaying PDF/image/other content in a dedicated program. smart AND pretty. 🧠💅
  • cleantitle.py — a plugin that helps strip bad content (newlines, HTML, etc.) out of item titles. a little spring cleaning for your titles. 🧹✨

💀 FILES 💀

  • $XDG_CONFIG_HOME/canto/curses-log — the canto-curses log file. receipts. 🧾
  • $XDG_CONFIG_HOME/canto/plugins/ — the canto-curses enabled plugins directory. where the chosen ones live. 🏡
  • /usr/lib/canto/plugins — the default packaged plugin directory. the original source. 📦

👑 HOMEPAGE 👑

http://codezen.org/canto-ng

that's the spot. go visit. 🌐

💜 AUTHOR 💜

Jack Miller <jack@codezen.org>

thank you for your service, king. 🫡

🦋 SEE ALSO 🦋

canto-daemon(1) canto-remote(1)

the whole squad. iykyk. 💕

and bestie, this masterpiece is from the Canto-curses(1) manual — no cap, it's giving general commands manual realness. catch you in the terminal! 💅✨🌸

📦 where this page comes from