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
  15   different machines), IMAP folders, POP accounts, and GMail
  16   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   (At least, once everything's been indexed.)
  42
  43 - Immediate full-text search of your entire email archive, using
  44   the full Ferret query langauge. Search over message bodies, labels,
  45   from: and to: fields, or any combination thereof.
  46
  47 - Thread-centrism. Operations are performed at the thread, not the
  48   message level. Entire threads are manipulated and viewed (with
  49   redundancies removed) at a time.
  50
  51 - Labels instead of folders. Drop that tired old metaphor and you'll
  52   see how much easier it is to organize email.
  53
  54 - GMail-style thread management.  Archive a thread, and it will
  55   disappear from your inbox until someone replies. Kill a thread, and
  56   it will never come back to your inbox. (But it will still show up in
  57   searches, of course.)
  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 and IMAP only at this point. No support for POP, mh,
  74   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), or an imap or imaps
  92   url. In the case of imap, don't put the username and password in
  93   the URI (which is a terrible, terrible idea). You will be prompted
  94   for them.
  95
  96   sup-import has several options which control whether you want
  97   messages from particular mailboxes not to be added to the inbox,
  98   or not to be marked as new, so run it with -h for help.
  99
 100   Note that Sup never changes the contents of any mailboxes; it only
 101   indexes in to them. So it shouldn't ever corrupt your mail. The flip
 102   side is that if you change a mailbox (e.g. delete messages, or, in
 103   the case of mbox files, read an unread message) then Sup may crash,
 104   and will tell you to run sup-import --rebuild to recalculate the
 105   offsets within the mailbox.
 106
 107 == REQUIREMENTS:
 108
 109 * ferret >= 0.10.13
 110 * ncurses >= 0.9.1
 111 * rmail >= 0.17
 112
 113 == INSTALL:
 114
 115 * gem install sup -y
 116 * Then, in rmail, change line 159 of multipart.rb to:
 117     chunk = chunk[0..start]
 118   (Sorry; it's an unsupported package.) You might be able to get away
 119   without doing this but if you get frozen string exceptions when
 120   reading in multipart messages, this is what you need to change.
 121
 122 == LICENSE:
 123
 124 Copyright (c) 2006 William Morgan.
 125
 126 This program is free software; you can redistribute it and/or
 127 modify it under the terms of the GNU General Public License
 128 as published by the Free Software Foundation; either version 2
 129 of the License, or (at your option) any later version.
 130
 131 This program is distributed in the hope that it will be useful,
 132 but WITHOUT ANY WARRANTY; without even the implied warranty of
 133 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 134 GNU General Public License for more details.
 135
 136 You should have received a copy of the GNU General Public License
 137 along with this program; if not, write to the Free Software
 138 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 139 02110-1301, USA.
 140