Statistics
| Revision:

root / README @ 1024

History | View | Annotate | Download (7.8 kB)

1
	Sylpheed - lightweight and user-friendly e-mail client
2
3
   Copyright(C) 1999-2006 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 Foundation, 
17
   Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  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 based on GTK+ GUI toolkit.
26
It runs on X Window System, and Microsoft Windows.
27
28
Sylpheed is a free software distributed under the GNU GPL.
29
30
Sylpheed has the following features:
31
32
    * Simple, beautiful, and well-polished user interface
33
    * Comfortable operationality which is built in detail
34
    * Immediately available with minimal configuration
35
    * Lightweight operation
36
    * High reliability
37
    * Internationalization and Multilingualization support
38
    * High-level Japanese processing
39
    * Various protocols support
40
    * Powerful filtering and search
41
    * Junk mail control
42
    * Flexible cooperation with external commands
43
44
The appearance and interface are similar to some popular e-mail clients for
45
Windows, such as Outlook Express, Becky!. Many commands are accessible with
46
the keyboard like the Emacs-based mailers such as Mew and Wanderlust.
47
So you will able to migrate to Sylpheed without much discomfort in the case
48
where you are accustomed to other mailers.
49
50
The messages are managed by MH format, and you'll be able to use it together
51
with another mailer based on MH format (like Mew). It has less possibility
52
of losing mails on failures since one file corresponds to one mail. You can
53
import or export mbox format messages. You can also utilize fetchmail or/and
54
procmail, and external programs on receiving (like inc or imget).
55
56
Currently implemented major features
57
====================================
58
59
Supported protocols
60
61
	o POP3
62
	o IMAP4rev1
63
	o SMTP
64
	o NNTP
65
	o SSL/TLSv1 (POP3, SMTP, IMAP4rev1, NNTP)
66
	o IPv6
67
68
Features
69
70
	o multiple accounts
71
	o powerful filtering
72
	o powerful search (query search, quick search, search folder)
73
	o Junk mail control
74
	o thread display
75
	o display and transfer of attachments by MIME
76
	o inline image display
77
	o News reader
78
	o SMTP AUTH support (PLAIN / LOGIN / CRAM-MD5)
79
	o CRAM-MD5 authentication (SMTP AUTH / IMAP4rev1)
80
	o APOP authentication (POP3)
81
	o PGP signature / encryption (requires GPGME)
82
	o spell checking (requires GtkSpell)
83
	o X-Face display
84
	o user-defined headers
85
	o mark / color label
86
	o Mew/Wanderlust compatible key bind
87
	o multiple MH folder support
88
	o mbox importing / exporting
89
	o action function to work with external commands
90
	o external editor
91
	o message queueing
92
	o automatic mail checking
93
	o draft message
94
	o template
95
	o line-wrapping
96
	o autosave
97
	o clickable URI
98
	o address book
99
	o newly arrived and unread message management
100
	o printing
101
	o offline mode
102
	o remote operation by command line
103
	o per-folder configuration
104
	o LDAP, vCard, and JPilot support
105
	o Drag & Drop
106
	o autoconf, automake support
107
	o internationalization of messages by gettext
108
	o m17n (multilingualization) support
109
110
and more.
111
112
Installation
113
============
114
115
See INSTALL for installation instructions.
116
117
Usage
118
=====
119
120
Preparation before running
121
--------------------------
122
123
If you are using a character encodings other than UTF-8 for filename,
124
you must set the following environmental variable (it will not work if
125
it is not specified):
126
127
(use locale-specific encoding)
128
% export G_FILENAME_ENCODING=@locale
129
130
or
131
132
(manually specifying encoding)
133
% export G_FILENAME_ENCODING=ISO-8859-1
134
135
If you want to display messages translated to your language,
136
you must specify some environmental variables related to locale.
137
For example:
138
139
% export LANG=de_DE
140
141
(replace de_DE to the actual locale name)
142
143
If you don't want translated messages, set LC_MESSAGES to "C"
144
(and unset LC_ALL if specified).
145
146
How to run
147
----------
148
149
Input `sylpheed' on a command line, or double-click the icon on a file
150
manager to execute.
151
152
Initial startup
153
---------------
154
155
When Sylpheed is executed for the first time, it automatically creates the
156
configuration files under ~/.sylpheed-2.0/, and asks you the location of
157
mailbox. The default is ~/Mail. If some files which are non-MH format
158
already exist on the directory, you will have to specify another location.
159
160
If ~/.sylpheed-2.0/ doesn't exist, but the previous version of configuration
161
exists in ~/.sylpheed/, migration will be made automatically after the
162
confirmation.
163
164
If the locale encoding is not UTF-8 and the environmental variable
165
G_FILENAME_ENCODING is not set, an alert dialog will be displayed.
166
167
Required settings
168
-----------------
169
170
Initially, you have to create at least one account to send or receive
171
messages (you can read messages that already exist without creating
172
accounts). The configuration dialog will be shown by clicking
173
"Configuration -> Create new account..." on the menu, or "Account" on
174
the toolbar. Then, fill the required settings.
175
176
Refer to the manual supplied with this program for the general usage.
177
178
Hidden settings
179
---------------
180
181
You can configure most of the features in Sylpheed through the preferences
182
dialog, but there are a few parameters which don't have user interface
183
(you don't have to modify them in normal use). You must edit
184
~/.sylpheed-2.0/sylpheedrc by an editor when Sylpheed is not running.
185
186
allow_jisx0201_kana		allow JIS X 0201 Kana (half-width kana) on
187
				sending
188
				0: off  1: on   [default: 0]
189
translate_header		translate headers such as 'From:', 'To:' and
190
				'Subject:'
191
				0: off  1: on   [default: 1]
192
enable_rules_hint		enable alternating row colors for summary view
193
				0: off  1: on   [default: 1]
194
bold_unread			show unread messages using bold font in
195
				summary view
196
				0: off  1: on   [default: 1]
197
textview_cursor_visible		show cursor in the text view
198
				0: off  1: on   [default: 0]
199
logwindow_line_limit		specify the limit of line numbers of log
200
				window
201
				0: unlimited  n (> 0): n lines [default: 1000]
202
203
Unlike 1.0.x, this version doesn't allow the direct modification of menu
204
shortcuts by default. You can use the follwing methods to configure them:
205
206
1. Using GNOME 2.8 or later
207
   Run gconf-editor from 'Applications - System Tools - Configuration Editor'.
208
   Select 'desktop - gnome - interface' and check 'can-change-accels' in it.
209
210
2. Using before GNOME 2.8 or other environments
211
   Add (or create a new one) gtk-can-change-accels = 1 to ~/.gtkrc-2.0.
212
213
3. When Sylpheed is not running, directly edit ~/.sylpheed-2.0/menurc using
214
   editors.
215
216
Information
217
===========
218
219
You can check the newest version and information about Sylpheed at:
220
221
	http://sylpheed.good-day.net/
222
223
There's also the manual of Sylpheed written by
224
Yoichi Imai <yoichi@silver-forest.com> on:
225
226
	http://y-imai.good-day.net/sylpheed/
227
228
Feedback
229
========
230
231
Comments, ideas and (most of all) bug reports (and especially patches) are
232
very welcome.
233
234
Subversion
235
==========
236
237
You can get the newest source code from the Subversion repository.
238
239
Move to an appropriate directory, and with the command:
240
241
	svn checkout svn://sylpheed.good-day.net/sylpheed/trunk
242
243
a source tree named 'trunk' is created under the current directory.
244
245
The subdirectory of sylpheed is divided as following:
246
247
    * trunk/     Main tree
248
    * branches/  Miscellaneous experimental branches
249
    * tags/      Release-tagged branches
250
251
To update to the newest source tree, run the command:
252
253
	svn update
254
255
at the target directory.
256
257
-- 
258
Hiroyuki Yamamoto <hiro-y@kcn.ne.jp>