Statistics
| Revision:

root / README @ 3024

History | View | Annotate | Download (8.69 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

    
73
Features
74

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

    
123
and more.
124

    
125
Installation
126
============
127

    
128
See INSTALL for installation instructions.
129

    
130
Usage
131
=====
132

    
133
Preparation before running
134
--------------------------
135

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

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

    
143
or
144

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

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

    
152
% export LANG=de_DE
153

    
154
(replace de_DE to the actual locale name)
155

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

    
159
How to run
160
----------
161

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

    
165
Initial startup
166
---------------
167

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

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

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

    
180
Required settings
181
-----------------
182

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

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

    
191
Hidden settings
192
---------------
193

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

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

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

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

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

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

    
239
Information
240
===========
241

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

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

    
246
The Sylpheed documentation in English and several other languages can be
247
obtained from:
248

    
249
	http://sylpheeddoc.sourceforge.net/
250

    
251
Feedback
252
========
253

    
254
Comments, ideas and (most of all) bug reports (and especially patches) are
255
very welcome.
256

    
257
Subversion
258
==========
259

    
260
You can get the newest source code from the Subversion repository.
261

    
262
Move to an appropriate directory, and with the command:
263

    
264
	svn checkout svn://sylpheed.sraoss.jp/sylpheed/trunk
265

    
266
a source tree named 'trunk' is created under the current directory.
267

    
268
The subdirectory of sylpheed is divided as following:
269

    
270
    * trunk/     Main tree
271
    * branches/  Miscellaneous experimental branches
272
    * tags/      Release-tagged branches
273

    
274
To update to the newest source tree, run the command:
275

    
276
	svn update
277

    
278
at the target directory.
279

    
280
-- 
281
Hiroyuki Yamamoto <hiro-y@kcn.ne.jp>