4237cad330b63d722fbf67a0e98714ea05ddd33c
[claws.git] / doc / man / sylpheed.1
1 .TH "Sylpheed" "1" "" "Hiroyuki Yamamoto" ""
2 .SH "NAME"
3 .LP 
4 Sylpheed \- a GTK+ based fast e\-mail and news client
5 .SH "DESCRIPTION"
6 .TP 
7 Sylpheed is an e\-mail client (and news reader) based on GTK+, running on X Window System, and aiming for
8 .br 
9 * Quick response
10 .br 
11 * Graceful, and sophisticated interface
12 .br 
13 * Easy configuration, intuitive operation
14 .br 
15 * Abundant features
16 \fR
17 .TP 
18 Currently implemented features include:
19 o POP3 support
20 .br 
21 o IMAP4rev1 support
22 .br 
23 o integrated NetNews client
24 .br 
25 o unlimited multiple account handling
26 .br 
27 o thread display
28 .br 
29 o filtering
30 .br 
31 o MIME (attachments)
32 .br 
33 o built\-in image view
34 .br 
35 o X\-Face support
36 .br 
37 o multiple MH folder support
38 .br 
39 o mbox importing / exporting
40 .br 
41 o external editor support
42 .br 
43 o message queueing
44 .br 
45 o automatic mail checking
46 .br 
47 o draft message function
48 .br 
49 o template function
50 .br 
51 o line\-wrapping
52 .br 
53 o clickable URI
54 .br 
55 o XML\-based address book
56 .br 
57 o LDAP, vCard, and JPilot support
58 .br 
59 o newly arrived and unread message management
60 .br 
61 o Mew/Wanderlust\-like key bind
62 .br 
63 o printing
64 .br 
65 o APOP authentication support
66 .br 
67 o SMTP AUTH support
68 .br 
69 o SSL support (POP3, SMTP, IMAP4rev1)
70 .br 
71 o IPv6 support
72 .br 
73 o drag & drop (partially implemented)
74 .br 
75 o GnuPG support (currently implementing)
76 .br 
77 o automake + autoconf support
78 .br 
79 o internationalization of messages by gettext
80 .br 
81 o support of many code sets, including UTF\-8 (Unicode) (when using libjconv)
82 \fR
83 .LP 
84 This list is not complete.
85 .SH "OPTIONS"
86 .LP 
87 \fB \-\-compose\fR [address]
88 .br 
89 \fB \-\-attach file1 [file2]...\fR
90 .br 
91 \fB \-\-receive\fR
92 .br 
93 \fB \-\-receive\-all\fR
94 .br 
95 \fB \-\-send\fR
96 .br 
97 \fB \-\-status\fR
98 .br 
99 \fB \-\-debug\fR
100 .br 
101 \fB \-\-help\fR
102 .br 
103 \fB \-\-version\fR
104 .SH "FILES"
105 .LP 
106 .TP 
107 $HOME/Mail
108 Default directory for mail storage
109 .TP 
110 $PREFIX/share/sylpheed
111 Global program directory
112 .TP 
113 $PREFIX/share/sylpheed/manual
114 Manual files in HTML format
115 .TP 
116 $PREFIX/share/sylpheed/faq
117 FAQ files in HTML format
118 .TP 
119 $HOME/.sylpheed 
120 User's configuration files directory
121 .TP 
122 $HOME/.sylpheed/accountrc
123 Configuration for account(s)
124 .TP 
125 $HOME/.sylpheed/addrbook*
126 Addressbook files
127 .TP 
128 $HOME/.sylpheed/command_history
129 User\-specified commands
130 .TP 
131 $HOME/.sylpheed/customheaderrc
132 Configuration for custom headers for sending mail
133 .TP 
134 $HOME/.sylpheed/dispheaderrc
135 Configuration for custom display of headers in message view
136 .TP 
137 $HOME/.sylpheed/filterrc
138 Filter function configuration
139 .TP 
140 $HOME/.sylpheed/folderlist.xml
141 Folder hierachy listing
142 .TP 
143 $HOME/.sylpheed/menurc
144 Menu shortcut\-key configuration
145 .TP 
146 $HOME/.sylpheed/sylpheed.log
147 Sylpheed logfile
148 .TP 
149 $HOME/.sylpheed/sylpheedrc
150 Main configuration file
151
152
153 .SH "EXAMPLES"
154 .LP 
155 To run this program the standard way type:
156 .LP 
157 sylpheed
158 .LP 
159 Alternatively you can run it with the following options:
160 .TP 
161 \fB\-\-debug\fR
162 for debug mode
163 .TP 
164 \fB\-\-compose [address]\fR 
165 to open a Compose window
166 .TP 
167 \fB\-\-attach file1 [file2]...\fR
168 open composition window with specified files attached
169 .TP 
170 \fB\-\-compose\fR "mailto:\fI%t\fR?subject=\fI%s\fR&cc=\fI%c\fR&body=\fI%b\fR"
171 this syntax can be used in web\-browsers and CLI to open a pre\-populated Compose window
172 .TP 
173 \fB\-\-receive\fR
174 receive new messages
175 .TP 
176 \fB\-\-receive\-all\fR
177 receive new messages from all accounts
178 .TP 
179 \fB\-\-send\fR
180 .br 
181 send all queued messages
182 .TP 
183 \fB\-\-status\fR
184 show the total number of messages
185 .br 
186 [new][unread][total]
187 .TP 
188 \fB\-\-help\fR
189 .br 
190 display the help message and exit
191 .TP 
192 \fB\-\-version\fR
193 display version number and exit
194 .SH "INSTALLATION"
195 .LP 
196 This program requires GTK+ 1.2.6 or higher to be compiled.
197 .LP 
198 Please make sure that gtk\-devel and glib\-devel (or similar) packages are
199 installed before the compilation (you may also require flex (lex) and bison
200 (yacc)).
201 .LP 
202 To compile and install, just type:
203 .LP 
204 % ./configure
205 .br 
206 % make
207 .br 
208 % su
209 .br 
210 Password: [Enter password]
211 .br 
212 # make install
213 .LP 
214 See INSTALL from the source distribution package for full installation instructions.
215 .SH "AUTHORS"
216 .LP 
217 .TP 
218 main\-branch (http://sylpheed.good\-day.net)
219 Hiroyuki Yamamoto   <hiro\-y@kcn.ne.jp>
220                     <yamamoto@good\-day.co.jp>
221 .TP 
222 claws\-branch (http://sylpheed\-claws.sourceforge.net)
223 Hoa viet Dinh       <dinh.viet.hoa@free.fr>
224 .br 
225 Match Grun              <match@dimensional.com>
226 .br 
227 Melvin Hadasht          <melvin.hadasht@free.fr>
228 .br 
229 Christoph Hohmann       <reboot@gmx.ch>
230 .br 
231 Alfons Hoogervorst      <alfons@proteus.demon.nl>
232 .br 
233 Darko Koruga            <darko.koruga@hermes.si>
234 .br 
235 Colin Leroy             <colin@colino.net>
236 .br 
237 Thorsten Maerz          <torte@netztorte.de>
238 .br 
239 Paul Mangan             <claws@thewildbeast.co.uk>
240 .br 
241 Martin Schaaf           <mascha@ma\-scha.de>
242 .br 
243 Carsten Schurig     <Carsten.Schurig@web.de>
244 .br 
245 Sergey Vlasov           <vsu@users.sourceforge.net>
246 .br 
247 Hiroyuki Yamamoto       <hiro\-y@kcn.ne.jp>
248 .TP 
249 sylpheed\-w32 (http://www.gnupg.org/cvs\-access.html)
250 Werner Koch             <wk@gnupg.org>
251 .TP 
252 sylpheed\-claws\-w32 (http://claws\-w32.sourceforge.net)
253 Thorsten Maerz          <torte@netztorte.de>\fR
254
255
256 .SH "SEE ALSO"
257 .LP 
258 .TP 
259 Sylpheed Homepage
260 <http://sylpheed.good\-day.net>
261 .TP 
262 Sylpheed\-Claws Homepage
263 <http://www.sf.net/sylpheed\-claws>
264 .TP 
265 Sylpheed Win32
266 <http://www.gnupg.org/cvs\-access.html>
267 .TP 
268 Sylpheed\-Claws Win32 Homepage
269 <http://www.sf.net/claws\-w32>