* gem install sup -y
-== KNOWN BUGS IN OTHER PACKAGES:
-
-* If you get an error about frozen strings in RubyMail when importing
- certain messages with attachments, in rmail, change line 159 of
- multipart.rb to:
- chunk = chunk[0..start]
- This is because RubyMail hasn't been updated since like Ruby 1.8.2.
- Please bug Matt Lickey.
-* Occasionally Ferret produces something the Ruby GC doesn't like
- (particularly when importing messages from very large sources).
- No worries, just re-run sup-import. (This is unresolved atm.)
-* If you are using IMAP or Maildir and see this error:
- /usr/local/lib/ruby/1.8/yaml.rb:133:in `transfer': allocator undefined for Bignum (TypeError)
- then you need to upgrade to Ruby 1.8.5. YAML in earlier versions
- can't parse BigNums.
+== PROBLEMS:
+
+See FAQ.txt for some common problems and their solutions.
== LICENSE:
sup-sync [<source>+] --restored --restore <dumpfile>
where <dumpfile> was created as above.
-Q: I see this message from Ferret:
- Error occured in index.c:825 - sis_find_segments_file
-A: Yikes! You've upgraded Ferret and the index format changed beneath
- you. Follow the index rebuild instructions below.
-
Q: I upgraded Ferret and the index format changed. I need to
completely rebuild my index. How do I do this?
A: First, you'll need a complete state dump. If you haven't made
author of ferret, which is the search engine behind Sup. Ferret is
really a first-class piece of software, and it's due to the
tremendous amount of time and effort he's put in to it.
+
+Common Problems
+---------------
+
+P: I see this message from Ferret:
+ Error occured in index.c:825 - sis_find_segments_file
+S: Yikes! You've upgraded Ferret and the index format changed beneath
+ you. Follow the index rebuild instructions above.
+
+P: I get some error message from Rubymail about frozen strings when
+ importing messages with attachments.
+S: The current solution is to directly modify RubyMail. Change line 159 of
+ multipart.rb to:
+ chunk = chunk[0..start]
+ This is because RubyMail hasn't been updated since like Ruby 1.8.2.
+ Please bug Matt Lickey.
+
+P: I see this error:
+ /usr/local/lib/ruby/1.8/yaml.rb:133:in `transfer': allocator undefined for Bignum (TypeError)
+S: You need to upgrade to Ruby 1.8.5. YAML in earlier versions can't
+ parse BigNums, but Sup relies on that for Maildir and IMAP.
+
+P: I see this error:
+ /usr/lib/ruby/1.8/net/imap.rb:204: uninitialized constant Net::IMAP::SSL (NameError)
+S: You need to install a package called libssl-ruby or something similar.
+ Or, don't use imaps:// sources. Ruby's IMAP library otherwise fails in
+ this somewhat uninformative manner.
+