git.cworth.org Git - sup/blob - doc/FAQ.txt

   1 Sup FAQ
   2 -------
   3
   4 Q: What is Sup?
   5 A: Sup is a console-based email client for people with a lot of email.
   6    It supports tagging, very fast full-text search, automatic contact-
   7    list management, and more. If you're the type of person who treats
   8    email as an extension of your long-term memory, Sup is for you.
   9
  10 Q: What does Sup stand for?
  11 A: "What's up?"
  12
  13 Q: Sup looks a lot like a text-based Gmail.
  14 A: I stole a lot of their ideas. And improved upon them, of course.
  15
  16 Q: If you love Gmail so much, why not just use it?
  17 A: I hate ads, I hate using a mouse, and I hate non-programmability
  18    and non-extensibility.
  19
  20    Also, Gmail doesn't let you use a monospace font, which is just
  21    plain lame.
  22
  23    Also, Gmail encourages top-posting. THIS CANNOT BE TOLERATED!
  24
  25 Q: Why the console?
  26 A: Because a keystroke is worth a hundred mouse clicks, as any Unix
  27    user knows. Because you don't need web browser. Because you get
  28    instantaneous response and a simple interface.
  29
  30 Q: How does Sup deal with spam?
  31 A: You can manually mark messages as spam, which prevents them from
  32    showing up in future searches, but that's as far as Sup goes. Spam
  33    filtering should be done by a dedicated tool like SpamAssassin.
  34
  35 Q: How do I delete a message?
  36 A: Why delete? Unless it's spam, you might as well just archive it.
  37
  38 Q: C'mon, really now!
  39 A: Ok, press the 'd' key.
  40
  41 Q: But I want to delete it for real, not just add a 'deleted' flag in
  42    the index. I want it gone from disk!
  43 A: Currently, for mbox sources, there is a batch deletion tool that
  44    will strip out all messages marked as spam or deleted.
  45
  46 Q: I got some error message about needing to run sup-sync --changed
  47    when I tried to read a message. What's that about?
  48 A: If messages have been moved, deleted, or altered in a source, Sup
  49    may have to rebuild its index for that source. For example, for
  50    mbox files, reading a single unread message changes the offsets of
  51    every file on disk. Rather than rescanning every time, Sup assumes
  52    sources don't change except by having new messages added. If that
  53    assumption is violated, you'll have to sync the index.
  54
  55 Q: How do I back up my index?
  56 Q: How do I make a state dump?
  57 A: Since the contents of the messages are recoverable from their
  58    sources using sup-sync, all you need to back up is the message
  59    state. To do this, simply run:
  60       sup-dump > <dumpfile>
  61    This will save all message state in a big text file, which you
  62    should probably compress.
  63
  64 Q: How do I restore the message state I saved in my state dump?
  65 A: Run:
  66      sup-sync [<source>+] --restored --restore <dumpfile>
  67    where <dumpfile> was created as above.
  68
  69 Q: I upgraded Ferret and the index format changed. I need to
  70    completely rebuild my index. How do I do this?
  71 Q: Ferret crashed and I can't read my index. Luckily I made a state
  72    dump. What should I do?
  73 A: First, you'll need a complete state dump. If you haven't made
  74    one, you'll need to downgrade Ferret and make a state dump as
  75    above. Then run these commands:
  76      rm -rf ~/.sup/ferret    # omg wtf
  77      sup-sync --all-sources --all --restore <dumpfile>
  78    Voila! A brand new index.
  79
  80 Q: I want to move messages from one source to another. (E.g., my
  81    primary inbox is an IMAP server with a quota, and I want to move
  82    some of those messages to local mbox files.) How do I do that while
  83    preserving message state?
  84 A: Move the messages from the source to the target using whatever tool
  85    you'd like. Then (and this is the important part), run:
  86      sup-sync --changed <source1> <source2>
  87
  88    If you sup-sync only one source at a time, depending on the order,
  89    the messages may be treated as missing and then deleted from the
  90    index, which means that their states will be lost when you sync the
  91    other source.
  92
  93 Q: What are all these "Redwood" references I see in the code?
  94 A: That was Sup's original name. (Think pine, elm. Although I am a
  95    Mutt user, I couldn't think of a good progression there.) But it was
  96    taken by another project on RubyForge, and wasn't that original,
  97    and was too long to type anyways.
  98
  99    Maybe one day I'll do a huge search-and-replace on the code, but it
 100    doesn't seem that important at this point.
 101
 102 Q: How is Sup possible?
 103 A: Sup is only possible through the hard work of Dave Balmain, the
 104    author of ferret, which is the search engine behind Sup. Ferret is
 105    really a first-class piece of software, and it's due to the
 106    tremendous amount of time and effort he's put in to it.
 107
 108 Common Problems
 109 ---------------
 110
 111 P: I see this message from Ferret:
 112      Error occured in index.c:825 - sis_find_segments_file
 113 S: Yikes! You've upgraded Ferret and the index format changed beneath
 114    you. Follow the index rebuild instructions above.
 115
 116 P: I get some error message from Rubymail about frozen strings when
 117    importing messages with attachments.
 118 S: The current solution is to directly modify RubyMail. Change line 159 of
 119    multipart.rb to:
 120      chunk = chunk[0..start]
 121    This is because RubyMail hasn't been updated since like Ruby 1.8.2.
 122    Please bug Matt Lickey.
 123
 124 P: I see this error:
 125      /usr/local/lib/ruby/1.8/yaml.rb:133:in `transfer': allocator undefined for Bignum (TypeError)
 126 S: You need to upgrade to Ruby 1.8.5. YAML in earlier versions can't
 127    parse BigNums, but Sup relies on that for Maildir and IMAP.
 128
 129 P: I see this error:
 130      /usr/lib/ruby/1.8/net/imap.rb:204: uninitialized constant Net::IMAP::SSL (NameError)
 131 S: You need to install a package called libssl-ruby or something similar.
 132    Or, don't use imaps:// sources. Ruby's IMAP library otherwise fails in
 133    this completely uninformative manner.
 134
 135 P: When I run Sup remotely and view an HTML attachment, an existing
 136    Firefox on the *local* machine is redirected to the attachment
 137    file, which it can't find (since it's on the remote machine). How do
 138    I view HTML attachments in this environment?
 139 S: Put this in your ~/.mailcap on the machine you run Sup on:
 140       text/html; /usr/bin/firefox -a sup '%s'; description=HTML Text; test=test -n "$DISPLAY";  nametemplate=%s.html