Statistics
| Revision:

root / README @ 775

History | View | Annotate | Download (7.7 kB)

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