1 Sylpheed - a GTK+ based, lightweight, and fast e-mail client
3 Copyright(C) 1999-2004 Hiroyuki Yamamoto <hiro-y@kcn.ne.jp>
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)
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.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 For more details see the file COPYING.
25 Sylpheed is an e-mail client and news reader based on GTK+ GUI toolkit,
26 and runs on X Window System.
28 Sylpheed is a free software distributed under the GNU GPL.
30 The development of Sylpheed sets the following things as its goal:
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
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
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
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).
57 Currently implemented major features
58 ====================================
66 o SSL/TLSv1 (POP3, SMTP, IMAP4rev1, NNTP)
75 o integrated News reader
77 o CRAM-MD5 authentication (SMTP AUTH / IMAP4rev1)
78 o APOP authentication (POP3)
79 o PGP signature / encryption (requires GPGME)
82 o user-defined headers
84 o Mew/Wanderlust compatible key bind
85 o multiple MH folder support
86 o mbox importing / exporting
89 o automatic mail checking
94 o XML-based address book
95 o newly arrived and unread message management
98 o remote operation by command line
99 o per-folder configuration
100 o LDAP, vCard, and JPilot support
102 o autoconf, automake support
103 o internationalization of messages by gettext
104 o support of many code sets, including UTF-8 (Unicode)
111 See INSTALL for installation instructions.
116 Preparation before running
117 --------------------------
119 If you want to use characters other than English (aka US-ASCII),
120 you must specify some environmental variables related to locale.
123 % export LANG=de_DE (sh, bash etc.)
127 % setenv LANG de_DE (csh, tcsh etc.)
129 (replace de_DE to appropriate locale name)
131 If you don't want translated messages, set LC_MESSAGES to "C"
132 (and unset LC_ALL if specified).
137 Input `sylpheed' on a command line, or double-click the icon on a file
143 When Sylpheed is executed for the first time, it automatically creates the
144 configuration files under ~/.sylpheed/, and asks you the location of
145 mailbox. The default is ~/Mail. If some files which are non-MH format
146 already exist on the directory, you will have to specify another location.
151 Initially, you have to create at least one account to send or receive
152 messages (you can read messages that already exist without creating
153 accounts). The configuration dialog will be shown by clicking
154 "Configuration -> Create new account..." on the menu, or "Account" on
155 the toolbar. Then, fill the required settings.
157 Refer to the manual supplied with this program for the general usage.
162 You can configure most of the features in Sylpheed through the preferences
163 dialog, but there are a few parameters which don't have user interface
164 (you don't have to modify them in normal use). You must edit
165 ~/.sylpheed/sylpheedrc by an editor when Sylpheed is not running.
167 allow_jisx0201_kana allow JIS X 0201 Kana (half-width kana) on
169 0: off 1: on [default: 0]
170 bold_font bold font used in folder, summary and text view
171 small_font small font used in summary view etc.
172 enable_hscrollbar enable horizontal scroll bar in summary view
173 0: off 1: on [default: 1]
174 bold_unread show unread messages using bold font in
176 0: off 1: on [default: 1]
177 folderview_vscrollbar_policy specify the policy of vertical scroll bar
179 0: always 1: automatic 2: never [default: 0]
184 You can check the newest version and information about Sylpheed at:
186 http://sylpheed.good-day.net/
188 There's also the manual of Sylpheed written by
189 Yoichi Imai <yoichi@silver-forest.com> on:
191 http://y-imai.good-day.net/sylpheed/
196 Comments, ideas and (most of all) bug reports (and especially patches) are
202 You can get the newest source code with the anonymous cvs.
204 First, set your CVSROOT environment variable to:
206 :pserver:anonymous@sylpheed.good-day.net:/cvsroot/sylpheed
212 and just press Enter key to `CVS password:'.
214 Move to an appropriate directory, and with the command:
216 cvs -z3 checkout sylpheed
218 a source tree named `sylpheed' is created under the current directory.
220 To update to the newest source tree, run the command:
224 on the top directory of the source tree.
227 Hiroyuki Yamamoto <hiro-y@kcn.ne.jp>