]> git.cworth.org Git - sup/blobdiff - README.txt
Sent label handling change
[sup] / README.txt
index 748cb918937ba4166e874bc701d340a5b9ebf5ba..0437de9f0c91b87b300c99077a88d7df82162100 100644 (file)
@@ -4,9 +4,10 @@ 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.
@@ -79,29 +80,20 @@ Current limitations which will be fixed:
 - Unix-centrism in MIME attachment handling and in sendmail
   invocation.
 
-- Several obvious missing features, like undo, filters / saved
+- Several obvious missing features, like filters / saved
   searches, message annotations, etc.
 
 == 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,32 +101,22 @@ Current limitations which will be fixed:
 * ncurses
 * rmail
 * highline
-* trollop
 * net-ssh
+* trollop >= 1.7
+* lockfile
+* mime-types
 
 == INSTALL:
 
-* gem install sup -y
+* gem install sup
 
-== KNOWN BUGS IN OTHER PACKAGES:
+== PROBLEMS:
 
-* 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.
+See FAQ.txt for some common problems and their solutions.
 
 == LICENSE:
 
-Copyright (c) 2006, 2007 William Morgan.
+Copyright (c) 2006--2009 William Morgan.
 
 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License