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 over folders. Drop that tired old metaphor and you'll see how
  35   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, so instantaneous response to interaction. No mouse
  43   clicking required!
  44
  45 - Programmability. It's in Ruby. The code is good. It's easy to
  46   extend.
  47
  48 - Multiple buffer support. Why be limited to viewing one thread at a
  49   time?
  50
  51 - Automatic context-sensitive help.
  52
  53 - Message tagging and multi-message tagged operations.
  54
  55 - Mutt-style MIME attachment viewing.
  56
  57 Current limitations which will be fixed:
  58
  59 - Support for mbox ONLY at this point. No support for POP, IMAP, and
  60   GMail accounts.
  61
  62 - No internationalization support. No wide characters, no subject
  63   demangling.
  64
  65 - No GMail-style filters.
  66
  67 - Unix-centrism in MIME attachment handling.
  68
  69 == SYNOPSYS:
  70
  71   1. sup-import <mbox filename>+
  72   2. sup
  73   3. edit ~/.sup/config.yaml for the (very few) settings sup has
  74
  75   sup-import has several options which control whether you want
  76   messages from particular mailboxes not to be added to the inbox,
  77   or not to be marked as new, so run it with -h for help.
  78
  79   Note that Sup *never* changes the contents of any mailboxes. So it
  80   shouldn't ever corrupt your mail. The flip side is that if you
  81   change a mailbox (e.g. delete or read messages) then Sup may crash,
  82   and will tell you to run sup-import --rebuild to recalculate the
  83   offsets within the mailbox have changed.
  84
  85 == REQUIREMENTS:
  86
  87 * ferret >= 0.10.13
  88 * ncurses >= 0.9.1
  89 * rmail >= 0.17
  90
  91 == INSTALL:
  92
  93 * gem install sup -y
  94 * Then, in rmail, change line 159 of multipart.rb to:
  95     chunk = chunk[0..start]
  96   (Sorry. it's an unsupported package.) You might be able to get away
  97   without doing this but if you get frozen string exceptions when
  98   reading in multipart email messages, this is what you need to
  99   change.
 100
 101 == LICENSE:
 102
 103 Copyright (c) 2006 William Morgan.
 104
 105 This program is free software; you can redistribute it and/or
 106 modify it under the terms of the GNU General Public License
 107 as published by the Free Software Foundation; either version 2
 108 of the License, or (at your option) any later version.
 109
 110 This program is distributed in the hope that it will be useful,
 111 but WITHOUT ANY WARRANTY; without even the implied warranty of
 112 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 113 GNU General Public License for more details.
 114
 115 You should have received a copy of the GNU General Public License
 116 along with this program; if not, write to the Free Software
 117 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 118 02110-1301, USA.
 119