sync with sylpheed 0.6.2cvs8
[claws.git] / README
1         Sylpheed - a GTK+ based, lightweight, and fast e-mail client
2
3    Copyright(C) 1999-2001 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+, running on
26 X Window System, and aiming for
27
28   * Quick response
29   * Graceful, and sophisticated interface
30   * Easy configuration, intuitive operation
31   * Abundant features
32
33 The appearance and interface are similar to some popular e-mail clients for
34 Windows, such as Outlook Express, Becky!, and Datula. The interface is also
35 designed to emulate the mailers on Emacsen, and almost all commands are
36 accessible with the keyboard. You'll figure out the usage if you have ever
37 used some e-mail clients for Windows, or Mew or Wanderlust.
38
39 The messages are managed by MH format, and you'll be able to use it together
40 with another mailer based on MH format (like Mew). You can also utilize
41 fetchmail or/and procmail, and external programs on receiving (like inc or
42 imget).
43
44 Currently implemented features are:
45
46         o POP3 support
47         o IMAP4rev1 support
48         o integrated NetNews client
49         o unlimited multiple account handling
50         o thread display
51         o filtering
52         o MIME (attachments)
53         o built-in image view
54         o X-Face support
55         o multiple MH folder support
56         o mbox importing / exporting
57         o external editor support
58         o message queueing
59         o automatic mail checking
60         o draft message function
61         o line-wrapping
62         o clickable URI
63         o XML-based address book
64         o LDAP, vCard, and JPilot support
65         o newly arrived and unread message management
66         o Mew/Wanderlust-like key bind
67         o printing
68         o APOP authentication support
69         o SMTP AUTH support
70         o SSL support (POP3, SMTP, IMAP4rev1)
71         o IPv6 support
72         o drag & drop (partially implemented)
73         o GnuPG support (currently implementing)
74         o automake + autoconf support
75         o internationalization of messages by gettext
76         o support of many code sets, including UTF-8 (Unicode) (when using
77           libjconv)
78
79 and more.
80
81 Installation
82 ============
83
84 See INSTALL for installation instructions.
85
86 Usage
87 =====
88
89 How to run
90 ----------
91
92 Input `sylpheed' on a command line, or double-click the icon on a file
93 manager to execute.
94
95 Initial startup
96 ---------------
97
98 When Sylpheed is executed for the first time, it automatically creates the
99 configuration files under ~/.sylpheed/, and asks you the location of
100 mailbox. The default is ~/Mail. If some files which are non-MH format
101 already exist on the directory, you will have to specify another location.
102
103 Required settings
104 -----------------
105
106 Initially, you have to create at least one account to send or receive
107 messages (you can read messages that already exist without creating
108 accounts). The configuration dialog will be shown by clicking
109 "Configuration -> Create new account..." on the menu, or "Account" on
110 the toolbar. Then, fill the required settings.
111
112 Refer to the manual supplied with this program for the general usage.
113
114 Information
115 ===========
116
117 You can check the newest version and information about Sylpheed at:
118
119         http://sylpheed.good-day.net/
120
121 There's also the manual of Sylpheed written by
122 Yoichi Imai <yoichi@silver-forest.com> on:
123
124         http://y-imai.good-day.net/sylpheed/
125
126 Feedback
127 ========
128
129 Comments, ideas and (most of all) bug reports (and especially patches) are
130 very welcome.
131
132 Anonymous cvs
133 =============
134
135 You can get the newest source code with the anonymous cvs.
136
137 First, set your CVSROOT environment variable to:
138
139         :pserver:anonymous@sylpheed.good-day.net:/cvsroot/sylpheed
140
141 Next, login with:
142
143         cvs login
144
145 and just press Enter key to `CVS password:'.
146
147 Move to an appropriate directory, and with the command:
148
149         cvs -z3 checkout sylpheed
150
151 a source tree named `sylpheed' is created under the current directory.
152
153 To update to the newest source tree, run the command:
154
155         cvs -z3 update
156
157 on the top directory of the source tree.
158
159 --
160 Hiroyuki Yamamoto <hiro-y@kcn.ne.jp>