2005-11-06 [colin] 1.9.99cvs13
[claws.git] / doc / man / sylpheed-claws.1
1 .TH "Sylpheed-Claws" "1" "" "Hiroyuki Yamamoto & the Sylpheed-Claws team" ""
2 .SH "NAME"
3 .LP 
4 Sylpheed\-Claws \- a GTK+ based fast e\-mail and news client
5 .SH "DESCRIPTION"
6 .TP 
7 Sylpheed\-Claws 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 .br 
83 o support for plugins
84 \fR
85 .LP 
86 This list is not complete.
87 .SH "OPTIONS"
88 .LP 
89 \fB \-\-compose\fR [address]
90 .br 
91 \fB \-\-attach file1 [file2]...\fR
92 .br 
93 \fB \-\-receive\fR
94 .br 
95 \fB \-\-receive\-all\fR
96 .br 
97 \fB \-\-send\fR
98 .br 
99 \fB \-\-status\fR
100 .br 
101 \fB \-\-status folder[/subfolder]\fR
102 .br 
103 \fB \-\-status\-full\fR
104 .br 
105 \fB \-\-online\fR
106 .br 
107 \fB \-\-offline\fR
108 .br 
109 \fB \-\-debug\fR
110 .br 
111 \fB \-\-help\fR
112 .br 
113 \fB \-\-version\fR
114 .br 
115 \fB \-\-config\-dir\fR
116 .SH "FILES"
117 .LP 
118 .TP 
119 $HOME/Mail
120 Default directory for mail storage
121 .TP 
122 $PREFIX/share/sylpheed\-claws
123 Global program directory
124 .TP 
125 $PREFIX/share/sylpheed\-claws/manual
126 Manual files in HTML format
127 .TP 
128 $PREFIX/share/sylpheed\-claws/faq
129 FAQ files in HTML format
130 .TP 
131 $PREFIX/share/sylpheed\-claws/themes
132 Global themes directory
133 .TP 
134 $PREFIX/lib/sylpheed\-claws/plugins
135 Directory for plugins
136 .TP 
137 $PREFIX/include/sylpheed\-claws
138 Directory for header files
139 .TP 
140 $HOME/.sylpheed\-claws
141 Default directory for user's configuration files directory
142 .TP 
143 $HOME/.sylpheed\-claws/themes
144 User's themes directory
145 .TP 
146 $HOME/.sylpheed\-claws/accountrc
147 Configuration for account(s)
148 .TP 
149 $HOME/.sylpheed\-claws/addrbook*
150 Addressbook files
151 .TP 
152 $HOME/.sylpheed\-claws/command_history
153 User\-specified commands
154 .TP 
155 $HOME/.sylpheed\-claws/customheaderrc
156 Configuration for custom headers for sending mail
157 .TP 
158 $HOME/.sylpheed\-claws/dispheaderrc
159 Configuration for custom display of headers in message view
160 .TP 
161 $HOME/.sylpheed\-claws/matcherrc
162 Filtering and Processing function configuration
163 .TP 
164 $HOME/.sylpheed\-claws/folderlist.xml
165 Folder hierarchy listing
166 .TP 
167 $HOME/.sylpheed\-claws/menurc
168 Menu shortcut\-key configuration
169 .TP 
170 $HOME/.sylpheed\-claws/sylpheed\-claws.log
171 Sylpheed logfile
172 .TP 
173 $HOME/.sylpheed\-claws/sylpheedrc
174 Main configuration file
175
176
177 .SH "EXAMPLES"
178 .LP 
179 To run this program the standard way type:
180 .LP 
181 sylpheed\-claws
182 .LP 
183 Alternatively you can run it with the following options:
184 .TP 
185 \fB\-\-debug\fR
186 for debug mode
187 .TP 
188 \fB\-\-compose [address]\fR 
189 to open a Compose window
190 .TP 
191 \fB\-\-attach file1 [file2]...\fR
192 open composition window with specified files attached
193 .TP 
194 \fB\-\-compose\fR "mailto:\fI%t\fR?subject=\fI%s\fR&cc=\fI%c\fR&body=\fI%b\fR"
195 this syntax can be used in web\-browsers and CLI to open a pre\-populated Compose window
196 .TP 
197 \fB\-\-receive\fR
198 receive new messages
199 .TP 
200 \fB\-\-receive\-all\fR
201 receive new messages from all accounts
202 .TP 
203 \fB\-\-send\fR
204 .br 
205 send all queued messages
206 .TP 
207 \fB\-\-status\fR
208 show the total number of messages
209 .br 
210 [new][unread][unread answers to marked][total]
211 .TP 
212 \fB\-\-status folder[/subfolder]\fR
213 show the total number of messages in specified folder
214 .br 
215 [new][unread][unread answers to marked][total]
216 .TP 
217 \fB\-\-status\-full\fR
218 show the total number of messages per folder
219 .br 
220 [new][unread][unread answers to marked][total]
221 .TP 
222 \fB\-\-online\fR
223 Start sylpheed in (or switch to, if already running) online mode
224 .TP 
225 \fB\-\-offline\fR
226 Start sylpheed in (or switch to, if already running) offline mode
227 .TP 
228 \fB\-\-help\fR
229 display the help message and exit
230 .TP 
231 \fB\-\-version\fR
232 display version number and exit
233 .TP 
234 \fB\-\-config\-dir\fR
235 display the CONFIG\-DIR and exit
236 .SH "INSTALLATION"
237 .LP 
238 This program requires GTK+ 2.4.x or higher to be compiled.
239 .LP 
240 Please make sure that gtk\-devel and glib\-devel (or similar) packages are
241 installed before the compilation (you may also require flex (lex) and bison
242 (yacc)).
243 .LP 
244 To compile and install, just type:
245 .LP 
246 % ./configure
247 .br 
248 % make
249 .br 
250 % su
251 .br 
252 Password: [Enter password]
253 .br 
254 # make install
255 .LP 
256 Refer to ./configure \-\-help for further information.
257 .SH "AUTHORS"
258 .LP 
259 .TP 
260 The Sylpheed-Claws Team
261 Holger Berndt                   <berndth@users.sf.net>
262 .br
263 Hoà Viêt Dinh                   <hoa@users.sf.net>
264 .br
265 Darko Koruga                    <darko@users.sf.net>
266 .br
267 Ricardo Mones Lastra    <mones@users.sf.net>
268 .br
269 Colin Leroy                     <colinleroy@users.sf.net>
270 .br
271 Thorsten Maerz          <netztorte@users.sf.net>
272 .br
273 Paul Mangan                     <twb@users.sf.net>
274 .br
275 Martin Schaaf                   <mascha1@users.sf.net>
276 .br
277 wwp                                     <wwp@users.sf.net>
278
279 .TP
280 Previous team members
281 Keith Edmunds
282 .br
283 Match Grun
284 .br
285 Melvin Hadasht
286 .br
287 Oliver Haertel
288 .br
289 Christoph Hohmann
290 .br
291 Alfons Hoogervorst
292 .br
293 Leandro A. F. Pereira
294 .br
295 Luke Plant
296 .br
297 Martin Schaaf
298 .br
299 Carsten Schurig
300 .br
301 Sergey Vlasov
302 .br
303 Hiroyuki Yamamoto
304
305
306 .SH "SEE ALSO"
307 .LP 
308 .TP 
309 Sylpheed\-Claws Homepage
310 <http://claws.sylpheed.org>