Diffstat (limited to 'kmicromail/libetpan/doc/README.sgml') (more/less context) (ignore whitespace changes)
-rw-r--r-- | kmicromail/libetpan/doc/README.sgml | 319 |
1 files changed, 319 insertions, 0 deletions
diff --git a/kmicromail/libetpan/doc/README.sgml b/kmicromail/libetpan/doc/README.sgml new file mode 100644 index 0000000..1ddbf96 --- a/dev/null +++ b/kmicromail/libetpan/doc/README.sgml | |||
@@ -0,0 +1,319 @@ | |||
1 | <!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN"> | ||
2 | |||
3 | <book id="libetpan-readme"> | ||
4 | <bookinfo> | ||
5 | <date>2003-12-03</date> | ||
6 | <title>libEtPan!</title> | ||
7 | <authorgroup> | ||
8 | <author> | ||
9 | <firstname>Viet Hoa</firstname> | ||
10 | <surname>DINH</surname> | ||
11 | </author> | ||
12 | </authorgroup> | ||
13 | <copyright> | ||
14 | <year>2003</year> | ||
15 | <holder>DINH Viet Hoa</holder> | ||
16 | </copyright> | ||
17 | </bookinfo> | ||
18 | <toc></toc> | ||
19 | |||
20 | <chapter id="introduction"> | ||
21 | <title>Introduction</title> | ||
22 | |||
23 | <!-- description --> | ||
24 | <sect1 id="description"> | ||
25 | <title>Description</title> | ||
26 | <para> | ||
27 | The purpose of this mail library is to provide a portable, | ||
28 | efficient middleware for different kinds of mail access | ||
29 | (IMAPrev4, POP3, NNTP, mbox, MH, Maildir). | ||
30 | </para> | ||
31 | |||
32 | <para> | ||
33 | You have two kinds of mailbox access, either using low-level | ||
34 | functions with a different interface for each kind of access | ||
35 | or using higher-level functions, using a driver to wrap the | ||
36 | higher-level API. The API will be the same for each kind of | ||
37 | mail access using the higher-level API. | ||
38 | </para> | ||
39 | </sect1> | ||
40 | |||
41 | <!-- authors --> | ||
42 | <sect1 id="author"> | ||
43 | <title>Author</title> | ||
44 | <sect2 id="main-auth"> | ||
45 | <title>Main author</title> | ||
46 | <para> | ||
47 | DINH Viet Hoa <email>hoa@users.sourceforge.net</email> | ||
48 | </para> | ||
49 | </sect2> | ||
50 | <sect2 id="contrib"> | ||
51 | <title>Contributors</title> | ||
52 | <para> | ||
53 | <itemizedlist> | ||
54 | <listitem> | ||
55 | <para> | ||
56 | Wim Delvaux <!-- wim.delvaux.adaptiveplanet.com --> | ||
57 | </para> | ||
58 | </listitem> | ||
59 | <listitem> | ||
60 | <para> | ||
61 | Melvin Hadasht <!-- melvin.hadasht@free.fr --> | ||
62 | </para> | ||
63 | </listitem> | ||
64 | <listitem> | ||
65 | <para> | ||
66 | David Woodhouse <!-- dwmw2@infradead.org --> | ||
67 | </para> | ||
68 | </listitem> | ||
69 | <listitem> | ||
70 | <para> | ||
71 | Juergen Graf <!-- libetpan@codeguy.org --> | ||
72 | </para> | ||
73 | </listitem> | ||
74 | <listitem> | ||
75 | <para> | ||
76 | Zsolt VARGA <!-- redax@redax.hu --> | ||
77 | </para> | ||
78 | </listitem> | ||
79 | <listitem> | ||
80 | <para> | ||
81 | Gael Roualland <!-- gael.roualland@dial.oleane.com --> | ||
82 | </para> | ||
83 | </listitem> | ||
84 | </itemizedlist> | ||
85 | </para> | ||
86 | </sect2> | ||
87 | </sect1> | ||
88 | </chapter> | ||
89 | |||
90 | <!-- installation --> | ||
91 | <chapter id="installation"> | ||
92 | <title>Installation</title> | ||
93 | |||
94 | <sect1 id="dependencies"> | ||
95 | <title>Dependencies</title> | ||
96 | |||
97 | <!-- dependencies for users --> | ||
98 | <sect2 id="depend-users"> | ||
99 | <title>Dependencies for users</title> | ||
100 | |||
101 | <itemizedlist> | ||
102 | <listitem> | ||
103 | <para> | ||
104 | <ulink url="http://www.openssl.org">OpenSSL</ulink> | ||
105 | (optional but recommended) | ||
106 | </para> | ||
107 | </listitem> | ||
108 | <listitem> | ||
109 | <para> | ||
110 | <ulink url="http://www.sleepycat.com">Berkeley | ||
111 | DB</ulink> (optional but recommended) | ||
112 | </para> | ||
113 | </listitem> | ||
114 | <listitem> | ||
115 | <para> | ||
116 | POSIX Thread (required) | ||
117 | </para> | ||
118 | </listitem> | ||
119 | </itemizedlist> | ||
120 | </sect2> | ||
121 | <!-- dependencies for developers --> | ||
122 | <sect2 id="depend-developers"> | ||
123 | <title>Dependencies for developers</title> | ||
124 | |||
125 | <itemizedlist> | ||
126 | <listitem> | ||
127 | <para> | ||
128 | <ulink url="http://www.gnu.org/software/autoconf"> | ||
129 | autoconf | ||
130 | </ulink> | ||
131 | 2.13 | ||
132 | </para> | ||
133 | </listitem> | ||
134 | <listitem> | ||
135 | <para> | ||
136 | <ulink url="http://www.gnu.org/software/automake"> | ||
137 | automake | ||
138 | </ulink> | ||
139 | 1.4 | ||
140 | </para> | ||
141 | </listitem> | ||
142 | <listitem> | ||
143 | <para> | ||
144 | <ulink | ||
145 | url="http://www.gnu.org/software/libtool/libtool.html"> | ||
146 | libtool | ||
147 | </ulink> | ||
148 | 1.4.3 | ||
149 | </para> | ||
150 | </listitem> | ||
151 | </itemizedlist> | ||
152 | </sect2> | ||
153 | </sect1> | ||
154 | <!-- packages --> | ||
155 | <sect1 id="packages"> | ||
156 | <title>Existing packages</title> | ||
157 | |||
158 | <itemizedlist> | ||
159 | <listitem> | ||
160 | <para> | ||
161 | Before you try to compile it, you have to know that packages | ||
162 | exist for FreeBSD. (ports/mail/libetpan). | ||
163 | This is currently 0.29 for -stable, 0.30 for -current. | ||
164 | </para> | ||
165 | </listitem> | ||
166 | </itemizedlist> | ||
167 | </sect1> | ||
168 | |||
169 | <!-- compilation --> | ||
170 | <sect1 id="compilation"> | ||
171 | <title>Compilation</title> | ||
172 | |||
173 | <para> | ||
174 | Generic installation instructions are in the | ||
175 | <filename>INSTALL</filename> file | ||
176 | You can pass the following extra options to configure : | ||
177 | </para> | ||
178 | |||
179 | <!-- FreeBSD --> | ||
180 | <sect2 id="freebsd"> | ||
181 | <title>FreeBSD</title> | ||
182 | <itemizedlist> | ||
183 | <listitem> | ||
184 | <para> | ||
185 | make sure libiconv is installed from the ports collection (see | ||
186 | <command>pkg_info</command>). | ||
187 | </para> | ||
188 | </listitem> | ||
189 | <listitem> | ||
190 | <para> | ||
191 | issue configure with the following parameter: | ||
192 | <screen> | ||
193 | <prompt>$</prompt> <userinput>./configure --with-libiconv-prefix=/usr/local</userinput> | ||
194 | </screen> | ||
195 | </para> | ||
196 | </listitem> | ||
197 | </itemizedlist> | ||
198 | </sect2> | ||
199 | |||
200 | <!-- MacOS X --> | ||
201 | <sect2 id="macosx"> | ||
202 | <title>Mac OS X</title> | ||
203 | <itemizedlist> | ||
204 | <listitem> | ||
205 | <para> | ||
206 | You have to configure using the following command line : | ||
207 | <command>CPPFLAGS=-I/sw/include LDFLAGS=-L/sw/lib | ||
208 | ./configure</command> | ||
209 | </para> | ||
210 | </listitem> | ||
211 | <listitem> | ||
212 | <para> | ||
213 | in tests/option-parser.c, change the inclusion | ||
214 | of <filename>getopt.h</filename> to | ||
215 | <filename>gnugetopt/getopt.h</filename> | ||
216 | </para> | ||
217 | </listitem> | ||
218 | <listitem> | ||
219 | <para> | ||
220 | in <filename>tests/Makefile</filename>, add | ||
221 | <command>-I/sw/include</command> for the | ||
222 | <command>CFLAGS</command> and | ||
223 | -L/sw/lib -lgnugetopt for the LDFLAGS. | ||
224 | </para> | ||
225 | </listitem> | ||
226 | </itemizedlist> | ||
227 | </sect2> | ||
228 | |||
229 | <!-- Linux --> | ||
230 | <sect2 id="linux"> | ||
231 | <title>Linux</title> | ||
232 | <itemizedlist> | ||
233 | <listitem> | ||
234 | <warning> | ||
235 | <para> | ||
236 | Since libEtPan! is making high usage of | ||
237 | <command>mmap()</command> even for | ||
238 | writing, when your mailboxes are on | ||
239 | <command>NFS</command> filesystem with | ||
240 | a Linux server, it is advised to use option | ||
241 | <command>no_subtree_check</command> in | ||
242 | <filename>/etc/exports</filename>. | ||
243 | This should avoid corruption of data. | ||
244 | </para> | ||
245 | <para> | ||
246 | The problem exist in Linux 2.4.22 and earlier versions. | ||
247 | </para> | ||
248 | </warning> | ||
249 | </listitem> | ||
250 | <listitem> | ||
251 | <para> | ||
252 | On RedHat systems, you have to configure using the | ||
253 | following command line : | ||
254 | <command>./configure --with-openssl=/usr/kerberos</command> | ||
255 | </para> | ||
256 | </listitem> | ||
257 | <listitem> | ||
258 | <para> | ||
259 | On Debian systems, if the <command>./autogen</command> | ||
260 | script fails on missing <command>AM_ICONV</command>, you | ||
261 | have to install <command>gettext</command> package. | ||
262 | </para> | ||
263 | </listitem> | ||
264 | </itemizedlist> | ||
265 | </sect2> | ||
266 | |||
267 | <!-- configure --> | ||
268 | <sect2 id="configure"> | ||
269 | <title>configure</title> | ||
270 | <para> | ||
271 | You can use the following options : | ||
272 | </para> | ||
273 | <itemizedlist> | ||
274 | <listitem> | ||
275 | <para> | ||
276 | <command>--enable-debug</command> Compiles with | ||
277 | debugging turned on | ||
278 | </para> | ||
279 | </listitem> | ||
280 | <listitem> | ||
281 | <para> | ||
282 | <command>--enable-optim</command> Turns on some | ||
283 | optimizations flags for gcc | ||
284 | </para> | ||
285 | </listitem> | ||
286 | <listitem> | ||
287 | <para> | ||
288 | <command>--without-openssl</command> Disables OpenSSL (do | ||
289 | not look for it) | ||
290 | </para> | ||
291 | </listitem> | ||
292 | </itemizedlist> | ||
293 | </sect2> | ||
294 | <sect2 id="install"> | ||
295 | <title>Compile and install</title> | ||
296 | <para> | ||
297 | Download the package and do the following : | ||
298 | </para> | ||
299 | <programlisting> | ||
300 | $ tar xzvf libetpan-XX.XX.tar.gz # to decompress the package | ||
301 | |||
302 | $ cd libetpan-XX.XX | ||
303 | |||
304 | $ ./configure --help # to get options of configure | ||
305 | |||
306 | $ ./configure # you can specify your own options | ||
307 | |||
308 | $ make # to compile the package | ||
309 | |||
310 | $ su | ||
311 | |||
312 | # make install | ||
313 | |||
314 | # logout | ||
315 | </programlisting> | ||
316 | </sect2> | ||
317 | </sect1> | ||
318 | </chapter> | ||
319 | </book> | ||