Statistics
| Revision:

root / README @ 3179

History | View | Annotate | Download (8.91 KB)

1
	Sylpheed - lightweight and user-friendly e-mail client
2

    
3
   Copyright(C) 1999-2012 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
Sylpheed runs on Unix-like systems such as Linux, BSD and Mac OS X, or
27
Microsoft Windows (2000 or later).
28

    
29
Sylpheed is a free software distributed under the GNU GPL (the library part
30
LibSylph is GNU LGPL).
31

    
32
Sylpheed has the following features:
33

    
34
    * Simple, beautiful, and well-polished user interface
35
    * Comfortable operationality which is built in detail
36
    * Well-organized, easy-to-understand configuration
37
    * Lightweight operation
38
    * High reliability
39
    * Internationalization and Multilingualization support
40
    * High-level Japanese processing
41
    * Various protocols support
42
    * Multi-thread support
43
    * Security feature (GnuPG, SSL/TLSv1)
44
    * Powerful filtering and search
45
    * Junk mail control
46
    * Flexible cooperation with external commands
47
    * Plug-in faculty
48

    
49
The appearance and interface are similar to some popular e-mail clients for
50
Windows, such as Outlook Express or Becky!. Many commands are accessible with
51
the keyboard like the Emacs-based mailers such as Mew and Wanderlust.
52
So you will be able to migrate to Sylpheed without much discomfort, even if
53
you are accustomed to other mailers.
54

    
55
The messages are managed by MH format, and you will be able to use it together
56
with another mailer based on MH format (like Mew). It has less possibility
57
of losing mails on failures since one file corresponds to one mail. You can
58
import or export mbox and eml format messages. You can also utilize fetchmail
59
and/or procmail, and external programs on receiving (like inc or imget).
60

    
61
Currently implemented major features
62
====================================
63

    
64
Supported protocols
65

    
66
	o POP3
67
	o IMAP4rev1
68
	o SMTP
69
	o NNTP
70
	o SSL/TLSv1 (POP3, SMTP, IMAP4rev1, NNTP)
71
	o IPv6
72
	o SOCKS4/5
73

    
74
Features
75

    
76
	o multiple accounts
77
	o powerful filtering (POP3, IMAP4, local spool)
78
	o powerful search (query search, quick search, search folder)
79
	o Junk mail control
80
	o plug-in faculty
81
	o thread display
82
	o display and transfer of attachments by MIME
83
	o inline image display
84
	o News reader
85
	o SMTP AUTH support (PLAIN / LOGIN / CRAM-MD5)
86
	o CRAM-MD5 authentication (SMTP AUTH / IMAP4rev1)
87
	o APOP authentication (POP3)
88
	o PGP signature / encryption (requires GPGME)
89
	o spell checking (requires GtkSpell)
90
	o SOCKS4/5 proxy support
91
	o X-Face display
92
	o user-defined headers
93
	o mark / color label
94
	o Mew/Wanderlust compatible key bind
95
	o multiple MH folder support
96
	o mbox and eml import / export
97
	o action function to work with external commands
98
	o external editor
99
	o message queueing
100
	o automatic mail checking
101
	o draft message
102
	o template
103
	o line-wrapping
104
	o autosave
105
	o clickable URI
106
	o address book
107
	o newly arrived and unread message management
108
	o printing
109
	o POP3 remote mailbox
110
	o offline mode
111
	o tray icon (minimize to tray icon, new mail notification)
112
	o customization of toolbar
113
	o remote operation by command line
114
	o per-folder configuration
115
	o LDAP, vCard, and JPilot support in address book
116
	o CSV, LDIF file import in address book
117
	o auto-registration of recipient's addresses to address book
118
	o auto-completion of addresses
119
	o Drag & Drop
120
	o autoconf, automake support
121
	o internationalization of messages by gettext
122
	o m17n (multilingualization) support
123

    
124
and more.
125

    
126
Installation
127
============
128

    
129
See INSTALL for installation instructions.
130

    
131
Usage
132
=====
133

    
134
Preparation before running
135
--------------------------
136

    
137
If you are using a character encoding other than UTF-8 for filename,
138
you must set the following environmental variable (it will not work if
139
it is not specified):
140

    
141
(use locale-specific encoding)
142
% export G_FILENAME_ENCODING=@locale
143

    
144
or
145

    
146
(manually specifying encoding)
147
% export G_FILENAME_ENCODING=ISO-8859-1
148

    
149
If you want to display messages translated to your language,
150
you must specify some environmental variables related to locale.
151
For example:
152

    
153
% export LANG=de_DE.UTF-8
154

    
155
(replace de_DE.UTF-8 to the actual locale name)
156

    
157
If you don't want translated messages, set LC_MESSAGES to "C"
158
(and unset LC_ALL if specified).
159

    
160
How to run
161
----------
162

    
163
Input `sylpheed' on a command line, or double-click the icon in a file
164
manager to execute.
165

    
166
Initial startup
167
---------------
168

    
169
When Sylpheed is executed for the first time, it automatically creates the
170
configuration files under ~/.sylpheed-2.0/, and asks you the location of
171
mailbox. The default is ~/Mail. If some files, which are non-MH format,
172
already exist on the directory, you will have to specify another location.
173

    
174
If ~/.sylpheed-2.0/ doesn't exist, but the previous version of configuration
175
exists in ~/.sylpheed/, migration will be made automatically after the
176
confirmation.
177

    
178
If the locale encoding is not UTF-8 and the environmental variable
179
G_FILENAME_ENCODING is not set, an alert dialog will be displayed.
180

    
181
Required settings
182
-----------------
183

    
184
Initially, you have to create at least one account to send or receive
185
messages (you can read messages that already exist without creating
186
accounts). The configuration dialog will be shown by clicking
187
"Configuration -> Create new account..." in the menu, or "Account" on
188
the toolbar. Then, fill the required settings.
189

    
190
Refer to the manual supplied with this program for the general usage.
191

    
192
Hidden settings
193
---------------
194

    
195
You can configure most of the features in Sylpheed through the preferences
196
dialog, but there are a few parameters which don't have user interface
197
(you don't need to modify them in normal use). You must edit
198
~/.sylpheed-2.0/sylpheedrc by an editor while Sylpheed is not running.
199

    
200
allow_jisx0201_kana		allow JIS X 0201 Kana (half-width kana) on
201
				sending
202
				0: off  1: on   [default: 0]
203
translate_header		translate headers such as 'From:', 'To:' and
204
				'Subject:'
205
				0: off  1: on   [default: 1]
206
enable_rules_hint		enable alternating row colors for summary view
207
				0: off  1: on   [default: 1]
208
bold_unread			show unread messages using bold font in
209
				summary view
210
				0: off  1: on   [default: 1]
211
textview_cursor_visible		show cursor in the text view
212
				0: off  1: on   [default: 0]
213
mime_image_viewer		specify the command to open attached image
214
				files [default: none]
215
mime_audio_player		specify the command to open attached audio
216
				files [default: none]
217
mime_command			specify the command to open MIME attachments
218
				[default: none]
219
logwindow_line_limit		specify the limit of line numbers of log
220
				window
221
				0: unlimited  n (> 0): n lines [default: 1000]
222
mark_as_read_on_new_window	only mark messages as read when they are
223
				opened with new window
224
				0: off  1: on   [default: 0]
225

    
226
Unlike 1.0.x, this version doesn't allow direct modification of the menu
227
shortcuts by default. You can use the following methods to configure them:
228

    
229
1. Using GNOME 2.8 or later
230
   Run gconf-editor from 'Applications - System Tools - Configuration Editor'.
231
   Select 'desktop - gnome - interface' and check 'can-change-accels' in it.
232

    
233
2. Using GNOME before 2.8, or other environments
234
   Add gtk-can-change-accels = 1 to the file ~/.gtkrc-2.0 (or create a new
235
   one, if it doesn't exist).
236

    
237
3. When Sylpheed is not running, directly edit ~/.sylpheed-2.0/menurc with
238
   an editor.
239

    
240
Information
241
===========
242

    
243
You can check the newest version and information about Sylpheed at:
244

    
245
	http://sylpheed.sraoss.jp/
246

    
247
You can also download files from the SourceForce.JP project page:
248

    
249
	http://sourceforge.jp/projects/sylpheed/
250

    
251
The bug tracking system of Sylpheed is:
252

    
253
	http://sylpheed.sraoss.jp/redmine/projects/sylpheed
254

    
255
The Sylpheed documentation in English and several other languages can be
256
obtained from:
257

    
258
	http://sylpheeddoc.sourceforge.net/
259

    
260
Feedback
261
========
262

    
263
Comments, ideas and (most of all) bug reports (and especially patches) are
264
very welcome.
265

    
266
Subversion
267
==========
268

    
269
You can get the newest source code from the Subversion repository.
270

    
271
Move to an appropriate directory, and with the command:
272

    
273
	svn checkout svn://sylpheed.sraoss.jp/sylpheed/trunk
274

    
275
a source tree named 'trunk' is created under the current directory.
276

    
277
The subdirectory of sylpheed is divided as following:
278

    
279
    * trunk/     Main tree
280
    * branches/  Miscellaneous experimental branches
281
    * tags/      Release-tagged branches
282

    
283
To update to the newest source tree, run the command:
284

    
285
	svn update
286

    
287
at the target directory.
288

    
289
-- 
290
Hiroyuki Yamamoto <hiro-y@kcn.ne.jp>