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