Merge of Steve Brown's patch
[squirrelmail.git] / doc / index.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <!-- $Id$ -->
3 <html>
4 <head>
5 <meta name="robots" content="noindex,nofollow">
6 <title>SquirrelMail Documentation</title>
7 </head>
8 <body text="#000000" bgcolor="#ffffff" link="#0000cc" vlink="#0000cc" alink="#0000cc">
9 <img src="../images/sm_logo.png" alt="SquirrelMail Logo" width="308" height="111" align="right" />
10
11 <h1>SquirrelMail Documentation</h1>
12
13 <p>Sorry for the lack of cohesion in the SquirrelMail documentation, but here is a conglomeration
14 of all the docs that we have accumulated so far. We are working on a more comprehensive user
15 manual.</p>
16
17 <dl>
18 <dt><a href="translating.txt">Translating</a></dt>
19 <dd>
20 If you would like to make a translation of SquirrelMail, here are some guidelines to help
21 you along the way. These were compiled, thanks to Gustav Foseid.
22 </dd>
23
24 <dt><a href="translating_help.txt">Translating the Help System</a></dt>
25 <dd>
26 We have a rather extensive help system in SquirrelMail. This document contains
27 information about translating those help documents.
28 </dd>
29
30 <dt><a href="themes.txt">Themes</a></dt>
31 <dd>
32 You can create your own color themes and add them in the themes/ directory
33 if you wish. This describes the format of the theme files.
34 </dd>
35
36 <dt><a href="russian_apache.txt">Russian Apache</a></dt>
37 <dd>
38 There are special instructions if you are running Russian Apache. This
39 document, thanks to Konstantin Riabitsev, will help you out.
40 </dd>
41
42 <dt><a href="authentication.txt">Authentication</a></dt>
43 <dd>
44 SquirrelMail allows you to log in to your IMAP and SMTP servers using
45 plaintext, CRAM-MD5 or DIGEST-MD5, as well as use SSL for extra security.
46 This document describes how to use this new code, and the requirements.
47 </dd>
48
49 <dt><a href="db-backend.txt">Database Backend</a></dt>
50 <dd>
51 SquirrelMail allows you to store user's preferences and address books
52 in database that is compatible with PHP Pear DB libraries. This document
53 describes how to setup database.
54 </dd>
55
56 <dt><a href="presets.txt">Specific IMAP server setups</a></dt>
57 <dd>
58 SquirrelMail configuration utility allows adjusting settings for selected
59 IMAP server with one quick command. D command asks for IMAP server name and
60 modifies all settings that are specific to selected IMAP server. This
61 document provides quick description of all IMAP presets.
62 </dd>
63
64 <dt><a href="i18n.txt">SquirrelMail internationalization</a></dt>
65 <dd>
66 Some information about SquirrelMail internationalization (interface
67 translations, time zones, reading emails in different charsets.)
68 internals.
69 </dd>
70
71 <dt><a href="ie_ssl.txt">Internet Explorer and SSL</a></dt>
72 <dd>
73 Information about possible issues in Internet Explorer, when SquirrelMail
74 is used in SSL enabled webserver.
75 </dd>
76
77 <dt><a href="Development/">SquirrelMail Development</a></dt>
78 <dd>
79 Want to code on SquirrelMail? Change behaviour or fix bugs? Create your own
80 plugin? See this set of documentation for some pointers.
81 </dd>
82
83 <dt>Basic documentation that comes with distribution:</dt>
84 <dd>
85 <a href="../AUTHORS">AUTHORS</a> - Who's behind all this?<br />
86 <a href="../INSTALL">INSTALL</a> - Installation instructions<br />
87 <a href="../UPGRADE">UPGRADE</a> - Upgrading instructions<br />
88 <a href="../README">README</a> - Everyone should read this.<br />
89 <a href="../COPYING">COPYING</a> - Licencing of SquirrelMail<br/>
90 <a href="../ChangeLog">ChangeLog</a> - Differences between SquirrelMail
91 versions.<br />
92 <a href="../ReleaseNotes">ReleaseNotes</a> - SquirrelMail release notes.<br />
93 <a href="ReleaseNotes/">ReleaseNotes archive</a> - Notes for older SquirrelMail versions<br />
94 </dd>
95 </dl>
96
97 </body>
98 </html>