2004-11-08 [colin] 0.9.12cvs141
[claws.git] / README
1         Sylpheed - a GTK+ based, lightweight, and fast e-mail client
2
3    Copyright(C) 1999-2004 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+ GUI toolkit,
26 and runs on X Window System.
27
28 Sylpheed is a free software distributed under the GNU GPL.
29
30 The development of Sylpheed sets the following things as its goal:
31
32   * Quick response by keeping CPU and memory usage to a minimum
33   * Fast processing even though a folder contains large number of messages
34     (more than 10 thousand)
35   * Enables intuitive operation by simple, graceful, and well-polished
36     interface
37   * Similar operation methods to other mailers.
38   * Readily available with simple configuration
39   * Fully equipped with features required as a mailer
40   * Full support of Japanese, and support of i18n
41   * Enables flexible interaction with external commands
42   * Stable, and don't lose any data (to the utmost) in case of crash
43
44 The appearance and interface are similar to some popular e-mail clients for
45 Windows, such as Outlook Express, Becky!, and Datula. The interface is also
46 designed to emulate the Emacs-based mailers, and almost all commands are
47 accessible with the keyboard. So you will able to migrate to Sylpheed
48 without much discomfort in the case where you are accustomed to other
49 mailers.
50
51 The messages are managed by MH format, and you'll be able to use it together
52 with another mailer based on MH format (like Mew). It has less possibility
53 of losing mails on failures since one file corresponds to one mail. You can
54 import or export mbox format messages. You can also utilize fetchmail or/and
55 procmail, and external programs on receiving (like inc or imget).
56
57 Currently implemented major features
58 ====================================
59
60 Supported protocols
61
62         o POP3
63         o IMAP4rev1
64         o SMTP
65         o NNTP
66         o SSL/TLSv1 (POP3, SMTP, IMAP4rev1, NNTP)
67         o IPv6
68
69 Features
70
71         o unlimited multiple account handling
72         o thread display
73         o filtering
74         o MIME (attachments)
75         o integrated News reader
76         o SMTP AUTH support
77         o CRAM-MD5 authentication (SMTP AUTH / IMAP4rev1)
78         o APOP authentication (POP3)
79         o PGP signature / encryption (requires GPGME)
80         o built-in image view
81         o X-Face display
82         o user-defined headers
83         o color label
84         o Mew/Wanderlust compatible key bind
85         o multiple MH folder support
86         o mbox importing / exporting
87         o external editor
88         o message queueing
89         o automatic mail checking
90         o draft message
91         o template
92         o line-wrapping
93         o clickable URI
94         o XML-based address book
95         o newly arrived and unread message management
96         o printing
97         o offline mode
98         o remote operation by command line
99         o per-folder configuration
100         o LDAP, vCard, and JPilot support
101         o drag & drop (partially implemented)
102
103 Others
104
105         o autoconf, automake support
106         o internationalization of messages by gettext
107         o support of many code sets, including UTF-8 (Unicode)
108
109 and more.
110
111 Installation
112 ============
113
114 See INSTALL for installation instructions.
115
116 Usage
117 =====
118
119 Preparation before running
120 --------------------------
121
122 If you want to use characters other than English (aka US-ASCII),
123 you must specify some environmental variables related to locale.
124 For example:
125
126 % export LANG=de_DE     (sh, bash etc.)
127
128 or
129
130 % setenv LANG de_DE     (csh, tcsh etc.)
131
132 (replace de_DE to appropriate locale name)
133
134 If you don't want translated messages, set LC_MESSAGES to "C"
135 (and unset LC_ALL if specified).
136
137 How to run
138 ----------
139
140 Input `sylpheed' on a command line, or double-click the icon on a file
141 manager to execute.
142
143 Initial startup
144 ---------------
145
146 When Sylpheed is executed for the first time, it automatically creates the
147 configuration files under ~/.sylpheed/, and asks you the location of
148 mailbox. The default is ~/Mail. If some files which are non-MH format
149 already exist on the directory, you will have to specify another location.
150
151 Required settings
152 -----------------
153
154 Initially, you have to create at least one account to send or receive
155 messages (you can read messages that already exist without creating
156 accounts). The configuration dialog will be shown by clicking
157 "Configuration -> Create new account..." on the menu, or "Account" on
158 the toolbar. Then, fill the required settings.
159
160 Refer to the manual supplied with this program for the general usage.
161
162 Hidden settings
163 ---------------
164
165 You can configure most of the features in Sylpheed through the preferences
166 dialog, but there are a few parameters which don't have user interface
167 (you don't have to modify them in normal use). You must edit
168 ~/.sylpheed/sylpheedrc by an editor when Sylpheed is not running.
169
170 allow_jisx0201_kana             allow JIS X 0201 Kana (hankaku kana) on
171                                 sending.
172                                 0: off  1: on   [default: 0]
173 bold_font                       bold font used in folder, summary and text view
174 small_font                      small font used in summary view etc.
175 enable_hscrollbar               enable horizontal scroll bar in summary view
176                                 0: off  1: on   [default: 1]
177 bold_unread                     show unread messages using bold font in
178                                 summary view
179                                 0: off  1: on   [default: 1]
180 folderview_vscrollbar_policy    specify the policy of vertical scroll bar
181                                 of folder view
182                                 0: always  1: automatic  2: never [default: 0]
183
184 Information
185 ===========
186
187 You can check the newest version and information about Sylpheed at:
188
189         http://sylpheed.good-day.net/
190
191 There's also the manual of Sylpheed written by
192 Yoichi Imai <yoichi@silver-forest.com> on:
193
194         http://y-imai.good-day.net/sylpheed/
195
196 Feedback
197 ========
198
199 Comments, ideas and (most of all) bug reports (and especially patches) are
200 very welcome.
201
202 Anonymous cvs
203 =============
204
205 You can get the newest source code with the anonymous cvs.
206
207 First, set your CVSROOT environment variable to:
208
209         :pserver:anonymous@sylpheed.good-day.net:/cvsroot/sylpheed
210
211 Next, login with:
212
213         cvs login
214
215 and just press Enter key to `CVS password:'.
216
217 Move to an appropriate directory, and with the command:
218
219         cvs -z3 checkout sylpheed
220
221 a source tree named `sylpheed' is created under the current directory.
222
223 To update to the newest source tree, run the command:
224
225         cvs -z3 update
226
227 on the top directory of the source tree.
228
229 -- 
230 Hiroyuki Yamamoto <hiro-y@kcn.ne.jp>