README.txt - mainline in sup

sup
    by William Morgan <wmorgan-sup@masanjin.net>
    http://sup.rubyforge.org

== DESCRIPTION:

Sup is a console-based email client for people with a lot of email.
It supports tagging, very fast full-text search, automatic contact-
list management, and more. If you're the type of person who treats
email as an extension of your long-term memory, Sup is for you.

Sup makes it easy to:
- Handle massive amounts of email.

- Mix email from different sources: mbox files and Maildirs.

- Instantaneously search over your entire email collection. Search over
  body text, or use a query language to combine search predicates in any
  way.

- Handle multiple accounts. Replying to email sent to a particular
  account will use the correct SMTP server, signature, and from address.

- Add custom code to customize Sup to whatever particular and bizarre
  needs you may have.

- Organize email with user-defined labels, automatically track recent
  contacts, and much more!

The goal of Sup is to become the email client of choice for nerds
everywhere.

== FEATURES/PROBLEMS:

Features:

- Scalability to massive amounts of email. Immediate startup and
  operability, regardless of how much amount of email you have.

- Immediate full-text search of your entire email archive, using the
  Xapian query language. Search over message bodies, labels, from: and
  to: fields, or any combination thereof.

- Thread-centrism. Operations are performed at the thread, not the
  message level. Entire threads are manipulated and viewed (with
  redundancies removed) at a time.

- Labels instead of folders. Drop that tired old metaphor and you'll see
  how much easier it is to organize email.

- GMail-style thread management. Archive a thread, and it will disappear
  from your inbox until someone replies. Kill a thread, and it will
  never come back to your inbox (but will still show up in searches.)
  Mark a thread as spam and you'll never again see it unless explicitly
  searching for spam.

- Console based interface. No mouse clicking required!

- Programmability. It's in Ruby. The code is good. It has an extensive
  hook system that makes it easy to extend and customize.

- Multiple buffer support. Why be limited to viewing one thing at a
  time?

- Tons of other little features, like automatic context-sensitive help,
  multi-message operations, MIME attachment viewing, recent contact list
  generation, etc.

Current limitations which will be fixed:

- Sup doesn't play nicely with other mail clients. If you alter a mail
  source (read, move, delete, etc) with another client Sup will punish
  you with a lengthy reindexing process.

- Unix-centrism in MIME attachment handling and in sendmail invocation.

== SYNOPSYS:

  0. sup-config
  1. sup

  Note that Sup never changes the contents of any mailboxes; it only
  indexes in to them. So it shouldn't ever corrupt your mail. The flip
  side is that if you change a mailbox (e.g. delete messages, or, in the
  case of mbox files, read an unread message) then Sup will be unable to
  load messages from that source and will ask you to run sup-sync
  --changed.

== REQUIREMENTS:

 - xapian-full >= 1.1.3.2
 - ncurses >= 0.9.1
 - rmail >= 0.17
 - highline
 - net-ssh
 - trollop >= 1.12
 - lockfile
 - mime-types
 - gettext
 - fastthread

== INSTALL:

* gem install sup

== PROBLEMS:

See FAQ.txt for some common problems and their solutions.

== LICENSE:

Copyright (c) 2006--2009 William Morgan.

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.

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

Gitorious