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 an attempt to take the UI innovations of web-based email
   8 readers (ok, really just GMail) and to combine them with the
   9 traditional wholesome goodness of a console-based email client.
  10
  11 Sup is designed to work with massive amounts of email, potentially
  12 spread out across different mbox files, IMAP folders, and GMail
  13 accounts, and to pull them all together into a single interface.
  14
  15 The goal of Sup is to become the email client of choice for nerds
  16 everywhere.
  17
  18 == FEATURES/PROBLEMS:
  19
  20 Features:
  21
  22 - Scalability to massive amounts of email. Immediate startup and
  23   operability, regardless of how much amount of email you have.
  24   (At least, once everything's been indexed.)
  25
  26 - Immediate full-text search of your entire email archive, using
  27   the full Ferret query langauge. Search over message bodies, labels,
  28   from: and to: fields, or any combination thereof.
  29
  30 - Thread-centrism. Operations are performed at the thread, not the
  31   message level. Entire threads are manipulated and viewed (with
  32   redundancies removed) at a time.
  33
  34 - Labels instead of folders. Drop that tired old metaphor and you'll
  35   see how much easier it is to organize email.
  36
  37 - GMail-style thread management.  Archive a thread, and it will
  38   disappear from your inbox until someone replies. Kill a thread, and
  39   it will never come back to your inbox. (But it will still show up in
  40   searches, of course.)
  41
  42 - Console based interface. No mouse clicking required!
  43
  44 - Programmability. It's in Ruby. The code is good. It's easy to
  45   extend.
  46
  47 - Multiple buffer support. Why be limited to viewing one thread at a
  48   time?
  49
  50 - Tons of other little features, like automatic context-sensitive
  51   help, multi-message operations, MIME attachment viewing, recent
  52   contact list generation, etc.
  53
  54 Current limitations which will be fixed:
  55
  56 - Support for mbox and IMAP only at this point. No support for POP, mh,
  57   or GMail mailstores.
  58
  59 - No internationalization support. No wide characters, no subject
  60   demangling.
  61
  62 - Unix-centrism in MIME attachment handling and in sendmail
  63   invocation.
  64
  65 - Several obvious missing features, like undo, filters / saved
  66   searches, message annotations, etc.
  67
  68 == SYNOPSYS:
  69
  70   1. sup-import <source>+
  71   2. sup
  72   3. edit ~/.sup/config.yaml for the (very few) settings sup has
  73
  74   Where <source> is a filename (for mbox files), or an imap or imaps
  75   url. In the case of imap, don't put the username and password in
  76   the URI (which is a terrible, terrible idea). You will be prompted
  77   for them.
  78
  79   sup-import has several options which control whether you want
  80   messages from particular mailboxes not to be added to the inbox,
  81   or not to be marked as new, so run it with -h for help.
  82
  83   Note that Sup never changes the contents of any mailboxes; it only
  84   indexes in to them. So it shouldn't ever corrupt your mail. The flip
  85   side is that if you change a mailbox (e.g. delete messages, or, in
  86   the case of mbox files, read an unread message) then Sup may crash,
  87   and will tell you to run sup-import --rebuild to recalculate the
  88   offsets within the mailbox.
  89
  90 == REQUIREMENTS:
  91
  92 * ferret >= 0.10.13
  93 * ncurses >= 0.9.1
  94 * rmail >= 0.17
  95
  96 == INSTALL:
  97
  98 * gem install sup -y
  99 * Then, in rmail, change line 159 of multipart.rb to:
 100     chunk = chunk[0..start]
 101   (Sorry; it's an unsupported package.) You might be able to get away
 102   without doing this but if you get frozen string exceptions when
 103   reading in multipart messages, this is what you need to change.
 104
 105 == LICENSE:
 106
 107 Copyright (c) 2006 William Morgan.
 108
 109 This program is free software; you can redistribute it and/or
 110 modify it under the terms of the GNU General Public License
 111 as published by the Free Software Foundation; either version 2
 112 of the License, or (at your option) any later version.
 113
 114 This program is distributed in the hope that it will be useful,
 115 but WITHOUT ANY WARRANTY; without even the implied warranty of
 116 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 117 GNU General Public License for more details.
 118
 119 You should have received a copy of the GNU General Public License
 120 along with this program; if not, write to the Free Software
 121 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 122 02110-1301, USA.
 123