sync with sylpheed 0.5.3 release
[claws.git] / README
1         Sylpheed - a GTK+ based, lightweight, and fast e-mail client
2
3    Copyright(C) 1999-2001 Hiroyuki Yamamoto <hiro-y@kcn.ne.jp>
4
5    This program is free software; you can redistribute it and/or modify
6    it under the terms of the GNU General Public License as published by
7    the Free Software Foundation; either version 2, or (at your option)
8    any later version.
9
10    This program is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13    GNU General Public License for more details.
14
15    You should have received a copy of the GNU General Public License
16    along with this program; if not, write to the Free Software
17    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18
19    For more details see the file COPYING.
20
21
22 What's Sylpheed
23 ===============
24
25 Sylpheed is an e-mail client (and news reader) based on GTK+, running on
26 X Window System, and aiming for
27
28   * Quick response
29   * Graceful, and sophisticated interface
30   * Easy configuration, intuitive operation
31   * Abundant features
32
33 The appearance and interface are similar to some popular e-mail clients for
34 Windows, such as Outlook Express, Becky!, and Datula. The interface is also
35 designed to emulate the mailers on Emacsen, and almost all commands are
36 accessible with the keyboard.
37
38 The messages are managed by MH format, and you'll be able to use it together
39 with another mailer based on MH format (like Mew). You can also utilize
40 fetchmail or/and procmail, and external programs on receiving (like inc or
41 imget).
42
43 Currently implemented features are:
44
45         o user-friendly and intuitive interface
46         o 3-paned view like many Windoze-based mail client
47         o ability of keyboard-only operation
48         o Mew/Wanderlust-like key bind (most of normally used keys have been
49           implemented)
50         o IMAP4rev1 support
51         o multipart MIME
52         o built-in image view
53         o X-Face support
54         o external editor support
55         o unlimited multiple account handling
56         o message queueing
57         o filtering
58         o draft message function
59         o line-wrapping
60         o XML-based address book
61         o APOP support
62         o unread message management
63         o multiple MH folder support
64         o integrated NetNews client
65         o IPv6 support
66         o GnuPG support (currently implementing)
67         o multithread support (experimental)
68         o mbox importing / exporting
69         o drag & drop (partially implemented)
70         o fast thread display
71         o high-speed message processing
72         o lightweight resource usage
73         o easily customizable configuration
74         o supports automake + autoconf, and internationalization of message
75           by gettext
76
77 You'll figure out the usage if you have used a mailer on Windows, or
78 Mew or Wanderlust.
79
80 Installation
81 ============
82
83 See INSTALL for installation instructions.
84
85 Usage
86 =====
87
88 How to run
89 ----------
90
91 Input `sylpheed' on a command line, or double-click the icon on a file
92 manager to execute.
93
94 Initial startup
95 ---------------
96
97 When Sylpheed is executed for the first time, it automatically creates the
98 configuration files under ~/.sylpheed/, and asks you the location of
99 mailbox. The default is ~/Mail. If some files which are non-MH format
100 already exist on the directory, you will have to specify another location.
101
102 Required settings
103 -----------------
104
105 Initially, you have to create at least one account to send or receive
106 messages (you can read messages that already exist without creating
107 accounts). The configuration dialog will be shown by clicking
108 "Configuration -> Create new account..." on the menu, or "Account" on
109 the toolbar. Then, fill the required settings.
110
111 Refer to the manual supplied with this program for the general usage.
112
113 Information
114 ===========
115
116 You can check the newest version and information about Sylpheed at:
117
118         http://sylpheed.good-day.net/
119
120 There's also the manual of Sylpheed written by
121 Yoichi Imai <yoichi@silver-forest.com> on:
122
123         http://y-imai.good-day.net/sylpheed/
124
125 Feedback
126 ========
127
128 Comments, ideas and (most of all) bug reports (and especially patches) are
129 very welcome.
130
131 Anonymous cvs
132 =============
133
134 You can get the newest source code with the anonymous cvs.
135
136 First, set your CVSROOT environment variable to:
137
138         :pserver:anonymous@sylpheed.good-day.net:/cvsroot/sylpheed
139
140 Next, login with:
141
142         cvs login
143
144 and just press Enter key to `CVS password:'.
145
146 Move to an appropriate directory, and with the command:
147
148         cvs -z3 checkout sylpheed
149
150 a source tree named `sylpheed' is created under the current directory.
151
152 To update to the newest source tree, run the command:
153
154         cvs -z3 update
155
156 on the top directory of the source tree.
157
158 --
159 Hiroyuki Yamamoto <hiro-y@kcn.ne.jp>