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 for people with a lot of email.
   8 It supports tagging, very fast full-text search, automatic contact-
   9 list management, and more. If you're the type of person who treats
  10 email as an extension of your long-term memory, Sup is for you.
  11
  12 Sup makes it easy to:
  13 - Handle massive amounts of email.
  14
  15 - Mix email from different sources: mbox files (even across different
  16   machines), Maildir directories, IMAP folders, and GMail accounts.
  17
  18 - Instantaneously search over your entire email collection. Search over
  19   body text, or use a query language to combine search predicates in any
  20   way.
  21
  22 - Handle multiple accounts. Replying to email sent to a particular
  23   account will use the correct SMTP server, signature, and from address.
  24
  25 - Add custom code to customize Sup to whatever particular and bizarre
  26   needs you may have.
  27
  28 - Organize email with user-defined labels, automatically track recent
  29   contacts, and much more!
  30
  31 The goal of Sup is to become the email client of choice for nerds
  32 everywhere.
  33
  34 == FEATURES/PROBLEMS:
  35
  36 Features:
  37
  38 - Scalability to massive amounts of email. Immediate startup and
  39   operability, regardless of how much amount of email you have.
  40
  41 - Immediate full-text search of your entire email archive, using the
  42   Ferret query language. Search over message bodies, labels, from: and
  43   to: fields, or any combination thereof.
  44
  45 - Thread-centrism. Operations are performed at the thread, not the
  46   message level. Entire threads are manipulated and viewed (with
  47   redundancies removed) at a time.
  48
  49 - Labels instead of folders. Drop that tired old metaphor and you'll see
  50   how much easier it is to organize email.
  51
  52 - GMail-style thread management. Archive a thread, and it will disappear
  53   from your inbox until someone replies. Kill a thread, and it will
  54   never come back to your inbox (but will still show up in searches.)
  55   Mark a thread as spam and you'll never again see it unless explicitly
  56   searching for spam.
  57
  58 - Console based interface. No mouse clicking required!
  59
  60 - Programmability. It's in Ruby. The code is good. It has an extensive
  61   hook system that makes it easy to extend and customize.
  62
  63 - Multiple buffer support. Why be limited to viewing one thing at a
  64   time?
  65
  66 - Tons of other little features, like automatic context-sensitive help,
  67   multi-message operations, MIME attachment viewing, recent contact list
  68   generation, etc.
  69
  70 Current limitations which will be fixed:
  71
  72 - Sup doesn't play nicely with other mail clients. If you alter a mail
  73   source (read, move, delete, etc) with another client Sup will punish
  74   you with a lengthy reindexing process.
  75
  76 - Support for mbox, Maildir, and IMAP only at this point. No support for
  77   POP or mh.
  78
  79 - IMAP support is very slow due mostly to Ruby's IMAP library.  You may
  80   consider something like offlineimap to mirror your IMAP folders with
  81   local Maildir ones.
  82
  83 - Unix-centrism in MIME attachment handling and in sendmail invocation.
  84
  85 == SYNOPSYS:
  86
  87   0. sup-config
  88   1. sup
  89
  90   Note that Sup never changes the contents of any mailboxes; it only
  91   indexes in to them. So it shouldn't ever corrupt your mail. The flip
  92   side is that if you change a mailbox (e.g. delete messages, or, in the
  93   case of mbox files, read an unread message) then Sup will be unable to
  94   load messages from that source and will ask you to run sup-sync
  95   --changed.
  96
  97 == REQUIREMENTS:
  98
  99  - ferret >= 0.11.6
 100  - ncurses >= 0.9.1
 101  - rmail >= 0.17
 102  - highline
 103  - net-ssh
 104  - trollop >= 1.12
 105  - lockfile
 106  - mime-types
 107  - gettext
 108  - fastthread
 109
 110 == INSTALL:
 111
 112 * gem install sup
 113
 114 == PROBLEMS:
 115
 116 See FAQ.txt for some common problems and their solutions.
 117
 118 == LICENSE:
 119
 120 Copyright (c) 2006--2009 William Morgan.
 121
 122 This program is free software; you can redistribute it and/or
 123 modify it under the terms of the GNU General Public License
 124 as published by the Free Software Foundation; either version 2
 125 of the License, or (at your option) any later version.
 126
 127 This program is distributed in the hope that it will be useful,
 128 but WITHOUT ANY WARRANTY; without even the implied warranty of
 129 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 130 GNU General Public License for more details.
 131
 132 You should have received a copy of the GNU General Public License
 133 along with this program; if not, write to the Free Software
 134 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 135 02110-1301, USA.
 136