* src/summaryview.c
[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 \-\-status folder[/subfolder]\fR
100 .br 
101 \fB \-\-status\-full\fR
102 .br 
103 \fB \-\-online\fR
104 .br 
105 \fB \-\-offline\fR
106 .br 
107 \fB \-\-debug\fR
108 .br 
109 \fB \-\-help\fR
110 .br 
111 \fB \-\-version\fR
112 .SH "FILES"
113 .LP 
114 .TP 
115 $HOME/Mail
116 Default directory for mail storage
117 .TP 
118 $PREFIX/share/sylpheed
119 Global program directory
120 .TP 
121 $PREFIX/share/sylpheed/manual
122 Manual files in HTML format
123 .TP 
124 $PREFIX/share/sylpheed/faq
125 FAQ files in HTML format
126 .TP 
127 $HOME/.sylpheed 
128 User's configuration files directory
129 .TP 
130 $HOME/.sylpheed/accountrc
131 Configuration for account(s)
132 .TP 
133 $HOME/.sylpheed/addrbook*
134 Addressbook files
135 .TP 
136 $HOME/.sylpheed/command_history
137 User\-specified commands
138 .TP 
139 $HOME/.sylpheed/customheaderrc
140 Configuration for custom headers for sending mail
141 .TP 
142 $HOME/.sylpheed/dispheaderrc
143 Configuration for custom display of headers in message view
144 .TP 
145 $HOME/.sylpheed/filterrc
146 Filter function configuration
147 .TP 
148 $HOME/.sylpheed/folderlist.xml
149 Folder hierachy listing
150 .TP 
151 $HOME/.sylpheed/menurc
152 Menu shortcut\-key configuration
153 .TP 
154 $HOME/.sylpheed/sylpheed.log
155 Sylpheed logfile
156 .TP 
157 $HOME/.sylpheed/sylpheedrc
158 Main configuration file
159
160
161 .SH "EXAMPLES"
162 .LP 
163 To run this program the standard way type:
164 .LP 
165 sylpheed
166 .LP 
167 Alternatively you can run it with the following options:
168 .TP 
169 \fB\-\-debug\fR
170 for debug mode
171 .TP 
172 \fB\-\-compose [address]\fR 
173 to open a Compose window
174 .TP 
175 \fB\-\-attach file1 [file2]...\fR
176 open composition window with specified files attached
177 .TP 
178 \fB\-\-compose\fR "mailto:\fI%t\fR?subject=\fI%s\fR&cc=\fI%c\fR&body=\fI%b\fR"
179 this syntax can be used in web\-browsers and CLI to open a pre\-populated Compose window
180 .TP 
181 \fB\-\-receive\fR
182 receive new messages
183 .TP 
184 \fB\-\-receive\-all\fR
185 receive new messages from all accounts
186 .TP 
187 \fB\-\-send\fR
188 .br 
189 send all queued messages
190 .TP 
191 \fB\-\-status\fR
192 show the total number of messages
193 .br 
194 [new][unread][unread answers to marked][total]
195 .TP 
196 \fB\-\-status folder[/subfolder]\fR
197 show the total number of messages in specified folder
198 .br 
199 [new][unread][unread answers to marked][total]
200 .TP 
201 \fB\-\-status\-full\fR
202 show the total number of messages per folder
203 .br 
204 [new][unread][unread answers to marked][total]
205 .TP 
206 \fB\-\-online\fR
207 Start sylpheed in (or switch to, if already running) online mode
208 .TP 
209 \fB\-\-offline\fR
210 Start sylpheed in (or switch to, if already running) offline mode
211 .TP 
212 \fB\-\-help\fR
213 .br 
214 display the help message and exit
215 .TP 
216 \fB\-\-version\fR
217 display version number and exit
218 .SH "INSTALLATION"
219 .LP 
220 This program requires GTK+ 1.2.6 or higher to be compiled.
221 .LP 
222 Please make sure that gtk\-devel and glib\-devel (or similar) packages are
223 installed before the compilation (you may also require flex (lex) and bison
224 (yacc)).
225 .LP 
226 To compile and install, just type:
227 .LP 
228 % ./configure
229 .br 
230 % make
231 .br 
232 % su
233 .br 
234 Password: [Enter password]
235 .br 
236 # make install
237 .LP 
238 See INSTALL from the source distribution package for full installation instructions.
239 .SH "AUTHORS"
240 .LP 
241 .TP 
242 main\-branch (http://sylpheed.good\-day.net)
243 Hiroyuki Yamamoto   <hiro\-y@kcn.ne.jp>
244                     <yamamoto@good\-day.co.jp>
245 .TP 
246 claws\-branch (http://sylpheed\-claws.sourceforge.net)
247 Hoa viet Dinh       <dinh.viet.hoa@free.fr>
248 .br 
249 Match Grun              <match@dimensional.com>
250 .br 
251 Melvin Hadasht          <melvin.hadasht@free.fr>
252 .br 
253 Christoph Hohmann       <reboot@gmx.ch>
254 .br 
255 Alfons Hoogervorst      <alfons@proteus.demon.nl>
256 .br 
257 Darko Koruga            <darko.koruga@hermes.si>
258 .br 
259 Colin Leroy             <colin@colino.net>
260 .br 
261 Thorsten Maerz          <torte@netztorte.de>
262 .br 
263 Paul Mangan             <claws@thewildbeast.co.uk>
264 .br 
265 Martin Schaaf           <mascha@ma\-scha.de>
266 .br 
267 Carsten Schurig     <Carsten.Schurig@web.de>
268 .br 
269 Sergey Vlasov           <vsu@users.sourceforge.net>
270 .br 
271 Hiroyuki Yamamoto       <hiro\-y@kcn.ne.jp>
272 .TP 
273 sylpheed\-w32 (http://www.gnupg.org/cvs\-access.html)
274 Werner Koch             <wk@gnupg.org>
275 .TP 
276 sylpheed\-claws\-w32 (http://claws\-w32.sourceforge.net)
277 Thorsten Maerz          <torte@netztorte.de>\fR
278
279
280 .SH "SEE ALSO"
281 .LP 
282 .TP 
283 Sylpheed Homepage
284 <http://sylpheed.good\-day.net>
285 .TP 
286 Sylpheed\-Claws Homepage
287 <http://www.sf.net/sylpheed\-claws>
288 .TP 
289 Sylpheed Win32
290 <http://www.gnupg.org/cvs\-access.html>
291 .TP 
292 Sylpheed\-Claws Win32 Homepage
293 <http://www.sf.net/claws\-w32>