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