README.txt - ehabkost-hacks 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 (even across different
  machines), Maildir directories, IMAP folders, POP accounts, and
  GMail accounts.

- 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 handle certain types of messages or to handle
  certain types of text within messages.

- 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
  Ferret 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 (but better!). 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's easy to
  extend.

- Multiple buffer support. Why be limited to viewing one thread 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:

- Support for mbox, remote mbox, and IMAP only at this point. No
  support for POP, mh, or GMail mailstores.

- No internationalization support. No wide characters, no subject
  demangling. 

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

- Several obvious missing features, like undo, filters / saved
  searches, message annotations, etc.

== 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:

* ferret >= 0.10.13
* ncurses
* rmail
* highline
* net-ssh
* trollop >= 1.7
* lockfile
* mime-types

== INSTALL:

* gem install sup -y

== PROBLEMS:

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

== LICENSE:

Copyright (c) 2006, 2007 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 (even across different
16	machines), Maildir directories, IMAP folders, POP accounts, and
17	GMail accounts.
18
19	- Instantaneously search over your entire email collection. Search
20	over body text, or use a query language to combine search
21	predicates in any way.
22
23	- Handle multiple accounts. Replying to email sent to a particular
24	account will use the correct SMTP server, signature, and from
25	address.
26
27	- Add custom code to handle certain types of messages or to handle
28	certain types of text within messages.
29
30	- Organize email with user-defined labels, automatically track
31	recent contacts, and much more!
32
33	The goal of Sup is to become the email client of choice for nerds
34	everywhere.
35
36	== FEATURES/PROBLEMS:
37
38	Features:
39
40	- Scalability to massive amounts of email. Immediate startup and
41	operability, regardless of how much amount of email you have.
42
43	- Immediate full-text search of your entire email archive, using the
44	Ferret query language. Search over message bodies, labels, from: and
45	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 (but better!). Archive a thread, and
55	it will disappear from your inbox until someone replies. Kill a
56	thread, and it will never come back to your inbox (but will still
57	show up in searches.) Mark a thread as spam and you'll never again
58	see it unless explicitly searching for spam.
59
60	- Console based interface. No mouse clicking required!
61
62	- Programmability. It's in Ruby. The code is good. It's easy to
63	extend.
64
65	- Multiple buffer support. Why be limited to viewing one thread at a
66	time?
67
68	- Tons of other little features, like automatic context-sensitive
69	help, multi-message operations, MIME attachment viewing, recent
70	contact list generation, etc.
71
72	Current limitations which will be fixed:
73
74	- Support for mbox, remote mbox, and IMAP only at this point. No
75	support for POP, mh, or GMail mailstores.
76
77	- No internationalization support. No wide characters, no subject
78	demangling.
79
80	- Unix-centrism in MIME attachment handling and in sendmail
81	invocation.
82
83	- Several obvious missing features, like undo, filters / saved
84	searches, message annotations, etc.
85
86	== SYNOPSYS:
87
88	0. sup-config
89	1. sup
90
91	Note that Sup never changes the contents of any mailboxes; it only
92	indexes in to them. So it shouldn't ever corrupt your mail. The flip
93	side is that if you change a mailbox (e.g. delete messages, or, in
94	the case of mbox files, read an unread message) then Sup will be
95	unable to load messages from that source and will ask you to run
96	sup-sync --changed.
97
98	== REQUIREMENTS:
99
100	* ferret >= 0.10.13
101	* ncurses
102	* rmail
103	* highline
104	* net-ssh
105	* trollop >= 1.7
106	* lockfile
107	* mime-types
108
109	== INSTALL:
110
111	* gem install sup -y
112
113	== PROBLEMS:
114
115	See FAQ.txt for some common problems and their solutions.
116
117	== LICENSE:
118
119	Copyright (c) 2006, 2007 William Morgan.
120
121	This program is free software; you can redistribute it and/or
122	modify it under the terms of the GNU General Public License
123	as published by the Free Software Foundation; either version 2
124	of the License, or (at your option) any later version.
125
126	This program is distributed in the hope that it will be useful,
127	but WITHOUT ANY WARRANTY; without even the implied warranty of
128	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
129	GNU General Public License for more details.
130
131	You should have received a copy of the GNU General Public License
132	along with this program; if not, write to the Free Software
133	Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
134	02110-1301, USA.

Gitorious