]> git.cworth.org Git - sup/blob - doc/FAQ.txt
6a3b756586ab25741d4b5bd0c0fd28198e9e41f9
[sup] / doc / FAQ.txt
1 Sup FAQ
2 -------
3 Q: What does Sup stand for?
4 A: It stands for "what's up?", which is more or less the question in
5    mind when I fire up my mail client.
6
7 Q: If you love GMail so much, why not just use it?
8 A: I hate ads, I hate using a mouse, and I hate non-programmability
9    and non-extensibility.
10
11 Q: Why the console?
12 A: There are many advantages to the console. A
13    few keystrokes can accomplish the work of a hundred mouse clicks
14    (as any Unix user knows). Also, you don't need web browser, and you
15    get instantaneous response and a simple interface.
16
17 Q: How does Sup deal with spam?
18 A: You can manually mark messages as spam, which prevents them from
19    showing up in future searches, but that's all that Sup does. Spam
20    filtering should be done by a dedicated tool like SpamAssassin.
21
22 Q: How do I delete a message?
23 A: Press the 'd' key.
24
25 Q: But I want to delete it for real, not just add a 'deleted' flag in
26    the index. I want it gone from disk!
27 A: Deleting a message is an old-fashioned concept. In the modern
28    world, disk space is cheap enough that you should never have to
29    delete a message. If it's spam, save it for future analysis.
30
31 Q: C'mon, really now!
32 A: Ok, at some point I plan to have a batch deletion tool that will
33    run through a source and delete all messages that have a 'spam' or
34    'deleted' tags (and, for mbox sources, will update the offsets of
35    all later messages). But that doesn't exist yet.
36
37 Q: I got some error message about needing to run sup-import --rescan
38    when I tried to read a message. What's that about?
39 A: If messages have been moved, deleted, or altered in a source, Sup
40    may have to rebuild its index for that source. For example, for
41    mbox files, even reading a message changes the offsets of every
42    file on disk. Rather than rescanning every time, Sup assumes
43    sources don't change except by having new messages added. If that
44    assumption is violated, you'll have to run sup-import --rescan.
45
46    The alternative is to rescan every source when Sup starts
47    up. Because Sup is designed to work with arbitrarily large mbox
48    files, this would not be a good idea.
49
50 Q: What are all these "Redwood" references I see in the code?
51 A: That was Sup's original name. (Think pine, elm. Although I am a
52    Mutt user, I couldn't think of a good progression there.) But it was
53    taken by another project on RubyForge, and wasn't that original,
54    and was too long to type anyways.
55
56    Maybe one day I'll do a huge search-and-replace on the code, but it
57    doesn't seem that important at this point.
58
59 Q: I want to move messages from one source to another. (E.g., my
60    primary inbox is an IMAP server with a quota, and I want to move
61    some of those messages to local mbox files.) How do I do that while
62    preserving message state?
63 A: Move the messages from the source to the target using whatever tool
64    you'd like. Then (and this is the important part), sup-import
65    --rescan the target, and THEN the source. If you do it the other
66    way around, you'll lose any message state.
67
68 Q: How is Sup possible?
69 A: Sup is only possible through the hard work of Dave Balmain, the
70    author of ferret, which is the search engine behind Sup. Ferret is
71    really a first-class piece of software, and it's due to the
72    tremendous amount of time and effort he's put in to it.
73