git.cworth.org Git - sup/blob - README.txt

   1 sup
   2     by William Morgan <wmorgan-sup@masanjin.net>
   3     http://sup.rubyforge.org
   4
   5 == DESCRIPTION:
   6
   7 Sup is a console-based email client that combines the best
   8 features of GMail, mutt, and emacs. Sup matches the power of GMail
   9 with the speed and simplicity of a console interface.
  10
  11 Sup makes it easy to:
  12 - Handle massive amounts of email.
  13
  14 - Mix email from different sources: mbox files (even across different
  15   machines), Maildir directories, IMAP folders, POP accounts, and
  16   GMail accounts.
  17
  18 - Instantaneously search over your entire email collection. Search
  19   over body text, or use a query language to combine search
  20   predicates in any way.
  21
  22 - Handle multiple accounts. Replying to email sent to a particular
  23   account will use the correct SMTP server, signature, and from
  24   address.
  25
  26 - Add custom code to handle certain types of messages or to handle
  27   certain types of text within messages.
  28
  29 - Organize email with user-defined labels, automatically track
  30   recent contacts, and much more!
  31
  32 The goal of Sup is to become the email client of choice for nerds
  33 everywhere.
  34
  35 == FEATURES/PROBLEMS:
  36
  37 Features:
  38
  39 - Scalability to massive amounts of email. Immediate startup and
  40   operability, regardless of how much amount of email you have.
  41
  42 - Immediate full-text search of your entire email archive, using the
  43   Ferret query language. Search over message bodies, labels, from: and
  44   to: fields, or any combination thereof.
  45
  46 - Thread-centrism. Operations are performed at the thread, not the
  47   message level. Entire threads are manipulated and viewed (with
  48   redundancies removed) at a time.
  49
  50 - Labels instead of folders. Drop that tired old metaphor and you'll
  51   see how much easier it is to organize email.
  52
  53 - GMail-style thread management (but better!). Archive a thread, and
  54   it will disappear from your inbox until someone replies. Kill a
  55   thread, and it will never come back to your inbox (but will still
  56   show up in searches.) Mark a thread as spam and you'll never again
  57   see it unless explicitly searching for spam.
  58
  59 - Console based interface. No mouse clicking required!
  60
  61 - Programmability. It's in Ruby. The code is good. It's easy to
  62   extend.
  63
  64 - Multiple buffer support. Why be limited to viewing one thread at a
  65   time?
  66
  67 - Tons of other little features, like automatic context-sensitive
  68   help, multi-message operations, MIME attachment viewing, recent
  69   contact list generation, etc.
  70
  71 Current limitations which will be fixed:
  72
  73 - Support for mbox, remote mbox, and IMAP only at this point. No
  74   support for POP, mh, or GMail mailstores.
  75
  76 - No internationalization support. No wide characters, no subject
  77   demangling.
  78
  79 - Unix-centrism in MIME attachment handling and in sendmail
  80   invocation.
  81
  82 - Several obvious missing features, like undo, filters / saved
  83   searches, message annotations, etc.
  84
  85 == SYNOPSYS:
  86
  87   1. sup-import <source>+
  88   2. sup
  89   3. edit ~/.sup/config.yaml for the (very few) settings sup has
  90
  91   Where <source> is a filename (for mbox files), an imap or imaps URI,
  92   or a mbox+ssh URI (for remote mbox files). You will be prompted for
  93   a username and password if required.
  94
  95   sup-import has several options which control whether you want
  96   messages from particular mailboxes not to be added to the inbox, or
  97   not to be marked as new, so run it with -h for help.
  98
  99   Note that Sup never changes the contents of any mailboxes; it only
 100   indexes in to them. So it shouldn't ever corrupt your mail. The flip
 101   side is that if you change a mailbox (e.g. delete messages, or, in
 102   the case of mbox files, read an unread message) then Sup will be
 103   unable to load messages from that source and will ask you to run
 104   sup-import --rebuild.
 105
 106 == REQUIREMENTS:
 107
 108 * ferret >= 0.10.13
 109 * ncurses
 110 * rmail
 111 * highline
 112 * trollop
 113 * net-ssh
 114
 115 == INSTALL:
 116
 117 * gem install sup -y
 118
 119 == KNOWN BUGS IN OTHER PACKAGES:
 120
 121 * If you get an error about frozen strings in RubyMail when importing
 122   certain messages with attachments, in rmail, change line 159 of
 123   multipart.rb to:
 124     chunk = chunk[0..start]
 125   This is because RubyMail hasn't been updated since like Ruby 1.8.2.
 126   Please bug Matt Lickey.
 127 * Occasionally Ferret produces something the Ruby GC doesn't like
 128   (particularly when importing messages from very large sources).
 129   No worries, just re-run sup-import. (This is unresolved atm.)
 130 * If you are using IMAP or Maildir and see this error:
 131     /usr/local/lib/ruby/1.8/yaml.rb:133:in `transfer': allocator undefined for Bignum (TypeError)
 132   then you need to upgrade to Ruby 1.8.5. YAML in earlier versions
 133   can't parse BigNums.
 134
 135 == LICENSE:
 136
 137 Copyright (c) 2006, 2007 William Morgan.
 138
 139 This program is free software; you can redistribute it and/or
 140 modify it under the terms of the GNU General Public License
 141 as published by the Free Software Foundation; either version 2
 142 of the License, or (at your option) any later version.
 143
 144 This program is distributed in the hope that it will be useful,
 145 but WITHOUT ANY WARRANTY; without even the implied warranty of
 146 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 147 GNU General Public License for more details.
 148
 149 You should have received a copy of the GNU General Public License
 150 along with this program; if not, write to the Free Software
 151 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 152 02110-1301, USA.
 153