Welcome to Sup! Here's how to get started. | | |
First, try running `sup`. Since this is your first time, you'll be
confronted with a mostly blank screen, and a notice at the bottom that
you have no new messages. That's because Sup doesn't hasn't loaded
anything into its index yet, and has no idea where to look for them
anyways. | | |
If you want to play around a little at this point, you can press 'b'
to cycle between buffers, ';' to get a list of the open buffers, and
'x' to kill a buffer. There's probably not too much interesting there,
but there's a log buffer with some cryptic messages. You can also
press '?' at any point to get a list of keyboard commands, but in the
absence of any email, these will be mostly useless. When you get
bored, press 'q' to quit. | | |
To use Sup for email, we need to load messages into the index. The
index is where Sup stores all message state (e.g. read or unread, any
message labels), and all information necessary for searching and for
threading messages. Sup only knows about messages in its index. | | |
We can add messages to the index by telling Sup about the "source"
where the messages reside. Sources are things like IMAP folders, mbox
folders, and maildir directories. Sup doesn't duplicate the actual
message content in the index; it only stores whatever information is
necessary for searching, threading and labelling. So when you search
for messages or view your inbox, Sup talks only to the index (stored
locally on disk). When you view a thread, Sup requests the full
content of all the messages from the source. | | |
The easiest way to set up all your sources is to run `sup-config`.
This will interactively walk you through some basic configuration,
prompt you for all the sources you need, and optionally import
messages from them. Sup-config uses two other tools, sup-add and
sup-sync, to load messages into the index. In the future you may make
use of these tools directly (see below). | | |
Once you've run sup-config, you're ready to run `sup`. You should see
the most recent unarchived messages appear in your inbox.
Congratulations, you've got Sup working! | | |
