SUP(1)

📦 version 1.4, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

okay bestie, sit down, hydrate, because you're about to read sup(1) — the manual page (section 1!) for sup, the curses-based email client 💖 this is the good stuff, no cap

🌸 NAME 🌸

sup — a curses-based email client 👑

✨ SYNOPSIS ✨

sup [options]

💅 DESCRIPTION 💅

Sup is a console-based email client for people with a lot of email. And when I say a lot, I mean the kind of inbox that has its own weather system 🌀

It serves up an interface that's literally a list of threads, and a thread is a hierarchical collection of email messages. Every thread can have multiple tags slapped onto it 🏷️ It supports a very fast full-text search, automatic contact-list management, custom code insertion via a Ruby hook system, and more. If you're the type of person who treats email as an extension of your long-term memory, Sup is for you. That's you. That's literally you 🫵💜

🎀 OPTIONS 🎀

  • -l, --list-hooks — Lists every single hook and its description, then quits. If you wanna filter, use --hooks-matching ✨
  • -m, --hooks-matching=<s> — If given, lists all hooks and descriptions that match the given pattern. Needs the --list-hooks option to work (default: ) 👀
  • -n, --no-threads — Turns threading off. Super helpful for debugging. (It necessarily disables background polling for new messages too, so just know that.) 🐛
  • -o, --no-initial-poll — Don't poll for new messages when starting. Like, don't even look 💤
  • -s QUERY, --search QUERY — Searches for this query upon startup 🔍
  • -c STRING, --compose STRING — Composes a message to this recipient upon startup ✍️
  • -j STRING, --subject STRING — When composing, use this subject 💌
  • -v, --version — Prints the version and exits 🏃♀️
  • -h, --help — Shows a brief help message 🆘

🌈 ENVIRONMENT 🌈

  • SUP_LOG_LEVEL — Sets log level verbosity. The valid values, ordered by decreasing verbosity, are: debug, info, warn, error. The default log level is info. 📢
  • SUP_BASE — Specifies the home directory for configuration files and the xapian index. It defaults to: $HOME/.sup. 🏠

🦋 FILES 🦋

  • $HOME/.sup/config.yaml — Configuration file for Sup ⚙️
  • $HOME/.sup/sources.yaml — Configuration file for Sup mail sources 📬
  • $HOME/.sup/colors.yaml — Color theme for Sup 🎨

⭐ SEE ALSO ⭐

mail(1), sup-add(1), sup-config(1), sup-dump(1), sup-import-dump(1), sup-recover-sources(1), sup-sync(1), sup-sync-back-maildir(1), sup-tweak-labels(1) — go read those too, they're the friend group 🫶

🐛 REPORTING BUGS 🐛

You are so welcome to submit bug reports to the Sup issue tracker, located at

<https://github.com/sup-heliotrope/sup/issues>

(Please do, bestie, they want the feedback 💖)

💌 CONTACT INFORMATION 💌

  • The Sup web page:
<http://supmua.org/>
  • Code repository:
<https://github.com/sup-heliotrope/sup/>
  • Sup Wiki:
<https://github.com/sup-heliotrope/sup/wiki/>
  • Sup IRC channel:
#sup @ freenode.net
  • Mailing list:
supmua@googlegroups.com
supmua+subscribe@googlegroups.com
Archives: <https://groups.google.com/d/forum/supmua/>

Copyright © 2006-2009 William Morgan <mworgan-sup@masanjin.net>

Copyright @ 2013-2014 Sup developers

Permission is granted to copy and distribute this manual under the terms of the GNU General Public License; either version 2 or (at your option) any later version. 📜✨

🧚 AUTHORS 🧚

Sup was originally written by William Morgan <wmorgan-sup@masanjin.net> and is now developed and maintained by the Sup developers. Legends, honestly 👑

and that's the whole page, bestie — this was the Sup User Manual, dated April 8, 2014, for SUP(1) 💜 thanks for reading, now go clear that inbox (or don't, it's giving "extension of long-term memory" anyway) 🎀

📦 where this page comes from