LinuxCommandLibrary

sup

Share files and directories with others

TLDR

Add an article to the RSS feed

$ sup [path/to/file.html]
copy

SYNOPSIS

sup [options] [search_term]

PARAMETERS

-h, --help
    Displays a brief help message and exits, detailing available options.

-v, --version
    Shows the installed sup version and exits.

-c, --config
    Specifies an alternative configuration file to use instead of the default.

-u, --update
    Fetches new mail from configured sources and updates the local index, then exits.

-S, --sync
    Synchronizes all mail folders (fetch new, mark read/delete) and updates the index, then exits.

-N, --no-index
    Starts sup without building or updating the index for new messages. This can speed up startup but may miss recent mail.

-f, --fast
    Opens sup quickly by skipping initial indexing and loading, but may not show the absolute latest mail or fully updated views.

search_term
    Immediately performs a search for the specified term upon starting sup, opening the search results view.

DESCRIPTION

The sup command refers to a fast, console-based Mail User Agent (MUA) designed for efficient email management directly from your terminal. It distinguishes itself by indexing all your email, allowing for lightning-fast full-text searches, flexible tagging, and robust threading capabilities across large mail archives. sup supports various mail storage formats including IMAP, Maildir, and mbox. Written in Ruby, it provides a modern, keyboard-driven interface optimized for users who prefer working in a command-line environment and need powerful tools for organizing and navigating extensive email collections. Its primary goal is to provide a responsive and powerful email experience without leaving the console.

CAVEATS

sup requires the Ruby programming language and specific RubyGems to function, which must be installed separately. Its configuration is managed through a Ruby file, ~/.sup/config.rb, which can be less intuitive for users unfamiliar with Ruby syntax. It is not pre-installed on most Linux distributions and usually requires manual installation.

CONFIGURATION

sup's behavior is highly customizable through its configuration file, typically located at ~/.sup/config.rb. This file, written in Ruby, allows users to define mail accounts, configure keybindings, customize display options, set up indexing rules, and integrate with external commands for advanced mail processing.

HISTORY

The sup mail client emerged as a modern alternative for console-based email management, developed with a strong focus on speed and efficient handling of large email archives. Written in Ruby, it was designed to provide advanced features like comprehensive indexing and robust searching capabilities. Its development aimed to fill a niche for users seeking a powerful, keyboard-driven MUA beyond traditional console clients like Mutt, reflecting a trend towards more dynamic and scriptable command-line tools in the Linux ecosystem.

SEE ALSO

mutt(1), alpine(1), neomutt(1), mail(1)

Copied to clipboard