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