Statistics
| Revision:

root / README @ 1

History | View | Annotate | Download (6.6 KB)

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 multiple accounts
72
	o thread display
73
	o powerful 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
102
	o autoconf, automake support
103
	o internationalization of messages by gettext
104
	o support of many code sets, including UTF-8 (Unicode)
105

    
106
and more.
107

    
108
Installation
109
============
110

    
111
See INSTALL for installation instructions.
112

    
113
Usage
114
=====
115

    
116
Preparation before running
117
--------------------------
118

    
119
If you want to use characters other than English (aka US-ASCII),
120
you must specify some environmental variables related to locale.
121
For example:
122

    
123
% export LANG=de_DE	(sh, bash etc.)
124

    
125
or
126

    
127
% setenv LANG de_DE	(csh, tcsh etc.)
128

    
129
(replace de_DE to appropriate locale name)
130

    
131
If you don't want translated messages, set LC_MESSAGES to "C"
132
(and unset LC_ALL if specified).
133

    
134
How to run
135
----------
136

    
137
Input `sylpheed' on a command line, or double-click the icon on a file
138
manager to execute.
139

    
140
Initial startup
141
---------------
142

    
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.
147

    
148
Required settings
149
-----------------
150

    
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.
156

    
157
Refer to the manual supplied with this program for the general usage.
158

    
159
Hidden settings
160
---------------
161

    
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.
166

    
167
allow_jisx0201_kana		allow JIS X 0201 Kana (half-width kana) on
168
				sending.
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
175
				summary view
176
				0: off  1: on   [default: 1]
177
folderview_vscrollbar_policy	specify the policy of vertical scroll bar
178
				of folder view
179
				0: always  1: automatic  2: never [default: 0]
180

    
181
Information
182
===========
183

    
184
You can check the newest version and information about Sylpheed at:
185

    
186
	http://sylpheed.good-day.net/
187

    
188
There's also the manual of Sylpheed written by
189
Yoichi Imai <yoichi@silver-forest.com> on:
190

    
191
	http://y-imai.good-day.net/sylpheed/
192

    
193
Feedback
194
========
195

    
196
Comments, ideas and (most of all) bug reports (and especially patches) are
197
very welcome.
198

    
199
Anonymous cvs
200
=============
201

    
202
You can get the newest source code with the anonymous cvs.
203

    
204
First, set your CVSROOT environment variable to:
205

    
206
	:pserver:anonymous@sylpheed.good-day.net:/cvsroot/sylpheed
207

    
208
Next, login with:
209

    
210
	cvs login
211

    
212
and just press Enter key to `CVS password:'.
213

    
214
Move to an appropriate directory, and with the command:
215

    
216
	cvs -z3 checkout sylpheed
217

    
218
a source tree named `sylpheed' is created under the current directory.
219

    
220
To update to the newest source tree, run the command:
221

    
222
	cvs -z3 update
223

    
224
on the top directory of the source tree.
225

    
226
-- 
227
Hiroyuki Yamamoto <hiro-y@kcn.ne.jp>