4a9a66cf758ecc5e43cea33bc46281726005930a
[squirrelmail.git] / doc / index.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <!-- $Id$ -->
3 <html>
4 <head>
5 <title>SquirrelMail Documentation</title>
6 </head>
7 <body>
8
9 <h1>SquirrelMail Documentation</h1>
10
11 <p>Sorry for the lack of cohesion in the SquirrelMail documentation, but here is a conglomeration
12 of all the docs that we have accumulated so far. Maybe some time in the future we will put
13 together a good documentation system. This is just meant to get you up and running.</p>
14
15
16 <dl>
17 <dt><a href="translating.txt">Translating</a></dt>
18 <dd>
19 If you would like to make a translation of SquirrelMail, here are some guidelines to help
20 you along the way. These were compiled, thanks to Gustav Foseid.
21 </dd>
22
23 <dt><a href="translating_help.txt">Translating the Help System</a></dt>
24 <dd>
25 We have a rather extensive help system in SquirrelMail. This document contains
26 information about translating those help documents.
27 </dd>
28
29 <dt><a href="tree.txt">The Mailbox Tree</a></dt>
30 <dd>
31 This explains the algorithms and arrays behind the mailbox tree used in deleting folders.
32 This was compiled thanks to Nathan Ehresman.
33 </dd>
34
35 <dt><a href="addressbook.txt">The Addressbook</a></dt>
36 <dd>
37 This explains how the addressbook works internally.
38 </dd>
39
40 <dt><a href="mime.txt">MIME</a></dt>
41 <dd>
42 Ever wonder how SquirrelMail handles MIME support? You need not search
43 any longer. This document gives an overview of how it works and how
44 we decode MIME encoded messages.
45 </dd>
46
47 <dt><a href="plugin.txt">Plugins</a></dt>
48 <dd>
49 If you would like to create plugins for SquirrelMail, this is the place
50 to start. It gives an overview and tells what needs to be in place for
51 all plugins.
52 </dd>
53
54 <dt><a href="themes.txt">Themes</a></dt>
55 <dd>
56 You can create your own color themes and add them in the themes/ directory
57 if you wish. This describes the format of the theme files.
58 </dd>
59
60 <dt><a href="README.russian_apache">Russian Apache</a></dt>
61 <dd>
62 There are special instructions if you are running Russian Apache. This
63 document, thanks to Konstantin Riabitsev, will help you out.
64 </dd>
65
66 <dt><a href="authentication.txt">Authentication</a></dt>
67 <dd>
68 SquirrelMail allows you to log in to your IMAP and SMTP servers using
69 plaintext, CRAM-MD5 or DIGEST-MD5, as well as use SSL for extra security.
70 This document describes how to use this new code, and the requirements.
71 </dd>
72
73 <dt>Basic documentation that comes with distrbution:</dt>
74 <dd>
75 <a href="../AUTHORS">AUTHORS</a> - Who's behind all this?<br />
76 <a href="../INSTALL">INSTALL</a> - Installation instructions<br />
77 <a href="../UPGRADE">UPGRADE</a> - Upgrading instructions<br />
78 <a href="../README">README</a> - Everyone should read this.<br />
79 <a href="../COPYING">COPYING</a> - Licencing of SquirrelMail<br/>
80 <a href="../ChangeLog">ChangeLog</a> - Differences between SquirrelMail versions.<br />
81 </dd>
82 </dl>
83
84 </body>
85 </html>