maildir cpu usage regression fix

[sup] / README.txt

diff --git a/README.txt b/README.txt
index bc271fa10d18258ae242e6f979f341c4bbc2b84e..1b2b516380c22857baf8287c3770bac5df9e34b5 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -4,16 +4,17 @@ sup
 
 == DESCRIPTION:
 
-Sup is a console-based email client that combines the best
-features of GMail, mutt, and emacs. Sup matches the power of GMail
-with the speed and simplicity of a console interface.
+Sup is a console-based email client for people with a lot of email.
+It supports tagging, very fast full-text search, automatic contact-
+list management, and more. If you're the type of person who treats
+email as an extension of your long-term memory, Sup is for you.
 
 Sup makes it easy to:
 - Handle massive amounts of email.
 
-- Mix email from different sources: mbox files (even across
-  different machines), IMAP folders, POP accounts, and GMail
-  accounts.
+- Mix email from different sources: mbox files (even across different
+  machines), Maildir directories, IMAP folders, POP accounts, and
+  GMail accounts.
 
 - Instantaneously search over your entire email collection. Search
   over body text, or use a query language to combine search
@@ -40,7 +41,7 @@ Features:
   operability, regardless of how much amount of email you have.
 
 - Immediate full-text search of your entire email archive, using the
-  Ferret query langauge. Search over message bodies, labels, from: and
+  Ferret query language. Search over message bodies, labels, from: and
   to: fields, or any combination thereof.
 
 - Thread-centrism. Operations are performed at the thread, not the
@@ -84,24 +85,15 @@ Current limitations which will be fixed:
 
 == SYNOPSYS:
 
-  1. sup-import <source>+
-  2. sup
-  3. edit ~/.sup/config.yaml for the (very few) settings sup has
-
-  Where <source> is a filename (for mbox files), an imap or imaps URI,
-  or a mbox+ssh URI (for remote mbox files). You will be prompted for
-  a username and password if required.
-
-  sup-import has several options which control whether you want
-  messages from particular mailboxes not to be added to the inbox, or
-  not to be marked as new, so run it with -h for help.
+  0. sup-config
+  1. sup
 
   Note that Sup never changes the contents of any mailboxes; it only
   indexes in to them. So it shouldn't ever corrupt your mail. The flip
   side is that if you change a mailbox (e.g. delete messages, or, in
   the case of mbox files, read an unread message) then Sup will be
   unable to load messages from that source and will ask you to run
-  sup-import --rebuild.
+  sup-sync --changed.
 
 == REQUIREMENTS:
 
@@ -109,25 +101,18 @@ Current limitations which will be fixed:
 * ncurses
 * rmail
 * highline
+* net-ssh
+* trollop >= 1.7
+* lockfile
+* mime-types
 
 == INSTALL:
 
 * 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]
-* 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.)
-* There are a couple other Ferret issues with outstanding patches but
-  they are pretty rare.
-* 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: