Sup

From ArchWiki
Revision as of 23:16, 7 March 2010 by Trey (Talk | contribs) (Created page.)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Tango-document-new.pngThis article is a stub.Tango-document-new.png

Notes: please use the first argument of the template to provide more detailed indications. (Discuss in Talk:Sup#)
Template:Article summary start

Template:Article summary text Template:Article summary end

Sup is a powerful new mail client developed for people who manage lots of mail. It can be viewed as a cross between Mutt and Gmail, with very fast operation and search, tagging, automatic contact management, support for a wide variety of accounts at once, and more.

Installing Sup

To install Sup, download it from the AUR here. For more information, see the AUR_User_Guidelines. Alternatively, users that have yaourt installed may run:

$ yaourt -S sup

This will automatically install gdbm, ruby-ncurses, and xapian-ruby-bindings. Otherwise, ensure these (as well as their dependencies, such as ruby) are installed to make installing sup as painless as possible.

Configuring Sup

Sup comes with an easy to use configuration tool called Template:Codeline. To use it, start it in the console and walk through the steps, which are as follows:

  1. Enter your full name.
  2. Enter your primary e-mail address, as well as any alternate e-mail addresses.
  3. Enter the path to your signature file, if you have one.
  4. Enter the editor that should be used to compose new mail, as well as any arguments that should be passed to it.
  5. Add sources for your mail, including:
    1. mbox files
    2. maildir directories
    3. remote mbox files over SSH
    4. IMAP servers

After this is done, Template:Codeline will execute the Template:Codeline command to import mail into your mailbox.

If you use POP3 or another mail service (not IMAP) and you don't have any external programs installed to handle mail retrieval, use a guide such as the one on the Mutt#POP3 wiki page, then select the mbox or maildir delivery option when configuring Sup. Sup is for the most part only an MUA (mail user agent) and, with the exception of IMAP, cannot handle downloading mail on its own.

Using Sup

Execute the Template:Codeline or Template:Codeline command to start the Sup mail client. The program should show the messages imported by Template:Codeline.

The most important key for new users to remember is the "?" key. This will display a full list of keyboard commands at any point, reminding new users how to navigate the program.

To navigate between threads, use the arrow keys or the "j" and "k" keys ("J" and "K" work like the Page Up and Page Down keys). To jump between threads with new messages, press the Tab key. Sup doesn't load all threads by default; press "M" to load more (more messages will automatically load to fill the window).

To view a thread, select it and press the Enter key. To expand or collapse an individual message while viewing a thread, select the message and press the Enter key. Press "N" to expand only new messages (the default view) or "E" to toggle the state of all messages. Press "o" to show or hide hidden parts of a message (such as signatures).

To navigate between messages in a thread, press the "n" and "p" keys. To display the headers on a message, press the "h" key.

To cycle through buffers, press the "b" key, or press the ";" key to view a list of all of the open buffers. To kill a buffer, press the "x" key.

To archive a thread, press the "a" key. This will hide it from the inbox until someone replies to it, at which point it will reappear. To kill a thread, press the "&" key. This is equivalent to Gmail's "mute" function, which hides a message even if people reply to it. It will never re-appear in the inbox, but it will still show up in search results.

To star a thread, press the "*" key. To mark a thread as spam, press the "S" key. Sup doesn't have any built-in spam filter; for that, consider a program such as SpamAssassin.

To tag a thread, press the "t" key. To label the messages in a thread, press the "l" key. To search labels, press the "L" key. Enter a label for which to search or press the Enter key to call up a list of labels. To perform a full text search, press the "\" key.

Backing-up and Restoring Sup

Backing-up e-mail is very important. To ensure that you don't lose anything, first back up the sources, such as mbox files and maildir directories, then run:

$ sup-dump > filename

This will back-up all message states in a text file. To restore your message states from this text file, simply run:

$ sup-sync [<source>+] --restored --restore filename

Just remember that the commands above only back-up and restore message states. The messages themselves will need to be backed-up separately.

More Information

Sup has a website with a README, a new user guide, a FAQ, and a philosophical statement, as well as a wiki.