+++ /dev/null
-#! /bin/make -f
-#
-# Copyright (c) 2005 The SquirrelMail Project Team
-# This file is part of SquirrelMail webmail interface documentation.
-#
-# SquirrelMail is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# SquirrelMail is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with SquirrelMail; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-#
-
-# old multiple commands way
-# COMMAND=sgml2
-
-# new single command approach
-COMMAND=linuxdoc --backend=
-
-# rtf and check outputs can't process multiple files
-SOURCE=admin.sgml user.sgml devel.sgml
-
-SITEPATH="/home/groups/s/sq/squirrelmail/htdocs/manuals/"
-
-all: admin user devel
- echo "all output formats are created!"
-
-site:
- $(COMMAND)html $(SOURCE) \
- --header=site_header.inc --footer=site_footer.inc \
- --imagebuttons
-
-html:
- $(COMMAND)$@ $(SOURCE)
-
-check:
- $(COMMAND)$@ admin.sgml
- $(COMMAND)$@ user.sgml
- $(COMMAND)$@ devel.sgml
-
-admin:
- $(COMMAND)txt $@.sgml
- $(COMMAND)html $@.sgml --split=2
- $(COMMAND)latex -o tex $@.sgml
- $(COMMAND)latex -o dvi $@.sgml
- $(COMMAND)latex -o ps $@.sgml
- $(COMMAND)latex -o pdf $@.sgml
- $(COMMAND)info $@.sgml
- $(COMMAND)lyx $@.sgml
- $(COMMAND)rtf $@.sgml
-user:
- $(COMMAND)txt $@.sgml
- $(COMMAND)html $@.sgml --split=2
- $(COMMAND)latex -o tex $@.sgml
- $(COMMAND)latex -o dvi $@.sgml
- $(COMMAND)latex -o ps $@.sgml
- $(COMMAND)latex -o pdf $@.sgml
- $(COMMAND)info $@.sgml
- $(COMMAND)lyx $@.sgml
- $(COMMAND)rtf $@.sgml
-
-devel:
- $(COMMAND)txt $@.sgml
- $(COMMAND)html $@.sgml --split=2
- $(COMMAND)latex -o tex $@.sgml
- $(COMMAND)latex -o dvi $@.sgml
- $(COMMAND)latex -o ps $@.sgml
- $(COMMAND)latex -o pdf $@.sgml
- $(COMMAND)info $@.sgml
- $(COMMAND)lyx $@.sgml
- $(COMMAND)rtf $@.sgml
-
-install-site: clean site
- cp *.html *.png *.php $(SITEPATH)
-
-install-packed: clean admin user devel
- tar -czf $(SITEPATH)admin-html.tar.gz admin*.html
- tar -czf $(SITEPATH)user-html.tar.gz user*.html
- tar -czf $(SITEPATH)devel-html.tar.gz devel*.html
- tar -czf $(SITEPATH)admin-rtf.tar.gz admin*.rtf
- tar -czf $(SITEPATH)user-rft.tar.gz user*.rtf
- tar -czf $(SITEPATH)devel-rtf.tar.gz devel*.rtf
- gzip -c admin.txt > $(SITEPATH)admin.txt.gz
- gzip -c devel.txt > $(SITEPATH)devel.txt.gz
- gzip -c user.txt > $(SITEPATH)user.txt.gz
- gzip -c admin.tex > $(SITEPATH)admin.tex.gz
- gzip -c devel.tex > $(SITEPATH)devel.tex.gz
- gzip -c user.tex > $(SITEPATH)user.tex.gz
- gzip -c admin.dvi > $(SITEPATH)admin.dvi.gz
- gzip -c devel.dvi > $(SITEPATH)devel.dvi.gz
- gzip -c user.dvi > $(SITEPATH)user.dvi.gz
- gzip -c admin.ps > $(SITEPATH)admin.ps.gz
- gzip -c devel.ps > $(SITEPATH)devel.ps.gz
- gzip -c user.ps > $(SITEPATH)user.ps.gz
- gzip -c admin.info > $(SITEPATH)admin.info.gz
- gzip -c devel.info > $(SITEPATH)devel.info.gz
- gzip -c user.info > $(SITEPATH)user.info.gz
- gzip -c admin.lyx > $(SITEPATH)admin.lyx.gz
- gzip -c devel.lyx > $(SITEPATH)devel.lyx.gz
- gzip -c user.lyx > $(SITEPATH)user.lyx.gz
- cp admin.pdf devel.pdf user.pdf $(SITEPATH)
-
-clean:
- rm -f *.txt *.html *.tex *.dvi *.ps *.pdf *.info *.lyx *.rtf
+++ /dev/null
-This directory contains sgml formated SquirrelMail documentation.
-
-In order to use it, you must compile appropriate documentation with
-linuxdoc-tools or other sgml processor.
-
-You can find information about SGML at
-http://www.linuxdocs.org/HOWTOs/mini/DocBook-Install/index.html
-
-You can find information about linuxdoc-tools at
-http://packages.debian.org/linuxdoc-tools/. If you don't have access
-to linuxdoc-tools, you might be able to use original SGMLTools or
-SGMLTools-lite http://sourceforge.net/projects/sgmltools-lite/
-
-Documentation can be compiled with 'make' command issued in this
-directory. You will need linuxdoc-tools package with txt, html,
-latex (tex, dvi, ps, pdf), info, lyx and rtf support.
-
-Minimal documentation can be compiled with 'make html' command.
-
-Documentation formating can be checked with 'make check' command.
+++ /dev/null
-<!doctype linuxdoc system>
-<!--
- Copyright (c) 2005 The SquirrelMail Project Team
- This file is part of SquirrelMail webmail interface documentation.
-
- SquirrelMail is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.
-
- SquirrelMail is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with SquirrelMail; if not, write to the Free Software
- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
--->
-<article>
-
-<title>SquirrelMail Administrator's Manual
-<author>
-by the SquirrelMail Project Team:
-<!-- put your name here -->
-</author>
-<date>$Date$
-<abstract>
-This document provides information about SquirrelMail webmail interface
-install procedures.
-</abstract>
-
-<toc>
-
-<p>
-Document version: $Revision$
-
-<sect>SquirrelMail overview
-<p>
-SquirrelMail is a standards-based webmail package written in PHP4. It includes
-built-in pure PHP support for the IMAP and SMTP protocols, and all pages render
-in pure HTML 4.0 (with no JavaScript required) for maximum compatibility across
-browsers. It has very few requirements and is very easy to configure and
-install. SquirrelMail has all the functionality you would want from an email
-client, including strong MIME support, address books, and folder manipulation.
-
-<sect1>SquirrelMail Requirements
-<sect2>Requirements for running SquirrelMail:
-<p>
-<itemize>
- <item>UNIX/Linux or Windows (UNIX/Linux version may be more functional)
- <item>IMAP4rev1 server (e.g. uw-imap, courier-imap, cyrus-imap, hMailServer,
- Binc IMAP, CommuniGate, MS Exchange Server, MercuryMail 32, Dovecot)
- <item>Web server with PHP4 installed (preferably <url
- url="http://httpd.apache.org/" name="Apache httpd">)
- <item>You need at least PHP 4.1.2. If you are using PHP 4.1.2 or 4.1.4, please
- upgrade to the latest version ( >= 4.1.2.11, >= 4.1.4.1 final).
- <item>Perl installed on the system. (If you don't have Perl, SquirrelMail will
- work fine but it's very helpful for the initial configuration.
- Alternatively, you can manually edit the configuration files.)
- <item>Unlike many PHP applications, SquirrelMail does not require MySQL or
- other database type.
- <item>If you use MySQL for the address book or for prefs, note that Pear DB
- lib is required to be installed and available in the include
- path.
- <item>Aspell installed if using the SquirrelSpell plugin, For UNIX/Linux see:
- <url url="http://aspell.sourceforge.net/" name="http://aspell.sourceforge.net/">
- or for Windows, see: <url url="http://aspell.net/win32/" name="http://aspell.net/win32/">
- <item>Japanese language support: PHP must be compiled with the
- <tt/--enable-mbstring/ option for SquirrelMail to read and write Japanese
- emails. Each user must also set their language option to Japanese.
-</itemize>
-
-<sect2>Preferred configuration:
-<p>
-<itemize>
- <item>php with gettext and mbstring support. Without gettext you lose in
- performance. mbstring is actually required if you want a good i18n webmail
- system.
- <item>imap server that supports sort and thread imap extensions. Without these
- extensions you lose in performance.
- <item>imap server should support unicode. CourierIMAP must be compiled with
- <tt/--enable-unicode/ option. Without it some translations might be unable to use
- sorting and threading.
-</itemize>
-
-<sect2>Browser Requirements:
-<p>
-<itemize>
- <item>Cookies must be enabled in your browser.
-</itemize>
-
-<sect>Quick Start Guide
-<p>
-download it, configure it, use it.
-
-<sect>Installing SquirrelMail
-<sect1>Quick and Dirty install
-<p>
-QuickAndDirty
-
-<sect1>Installing SquirrelMail on Unix and Linux systems
-<p>
-SquirrelMailInstallUnix
-
-<sect1>Installing Squirrelmail on Windows systems with Apache webserver
-<p>
-SquirrelMailInstallWin32Apache
-
-<sect1>Installing SquirrelMail on Windows systems with IIS webserver
-<p>
-SquirrelMailInstallIIS
-
-<sect1>Installing SquirrelMail on MaxOS X systems
-<p>
-MacInfoHere
-
-<sect>Upgrading SquirrelMail
-<p>
-Information for upgraders.
-
-<sect>Configuring SquirrelMail
-<p>
-run conf.pl script.
-
-<sect1>basic configuration
-<p>
-essential configuration steps.
-
-<sect1>Selecting IMAP server
-<p>
-Recommend use of presets. List main presets. Explain why setting only
-$imap_server_type does not work.
-
-<sect1>Authentication
-<p>
-login, cram-md5, digest-md5.
-
-<sect1>StartTLS, IMAPS, SSMTP
-<p>
-secure connection ways. supported and not supported. minimal requirements.
-
-<sect1>Using database backends
-<p>
-SquirrelMail can store preferences and address books in database.
-
-<sect1>Using more than one imap server
-<p>
-How to do that.
-
-<sect1>Other configuration issues
-<p>
-Other configuration issues.
-
-<sect>Optimizing SquirrelMail
-<p>
-What to do in order to make it fast without toasting the server.
-
-<sect>Customizing SquirrelMail
-<sect1>Plugins
-<p>
-SquirrelMail is modular system. Interface can be extented with extra features
-provided by various plugins.
-
-<sect1>Themes
-<p>
-Which color is da best.
-
-<sect1>Site customizations
-<p>
-Own login page. Site control with vlogin plugin.
-
-<sect1>Internationalization
-<p>
-Using interface with different languages.
-
-<sect1>Personal and shared address books
-<p>
-Information about global address books here.
-
-<sect>FAQ
-<p>
-Daily questions
-
-<sect>Solving problems
-<sect1>Common PHP error messages
-<sect2>unknown function session_id() call
-<p>
-missing session support
-
-<sect1>Common interface error messsages
-<sect2>Unknown username or password
-<p>
-password is not ********. you need cookies.
-
-<sect2>Session timeout
-<p>
-session.gc_maxlifetime
-
-<sect2>Can't delete emails. Quota exceeded.
-<p>
-DisableTrash
-
-<sect>Support
-<p>
-Where do I get support? How do I provide feedback, patches, feature
-suggestions, bug reports.
-
-<sect1>SquirrelMail bugtracker
-<p>
-We have it on SF.
-
-<sect1>SquirrelMail mailing lists
-<p>
-We have them too.
-
-<sect1>Security contacts
-<p>
-address used for security contact.
-
-</article>
+++ /dev/null
-<!doctype linuxdoc system>
-<!--
- Copyright (c) 2005 The SquirrelMail Project Team
- This file is part of SquirrelMail webmail interface documentation.
-
- SquirrelMail is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.
-
- SquirrelMail is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with SquirrelMail; if not, write to the Free Software
- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
--->
-<article>
-
-<title>SquirrelMail Developer's Manual
-<author>The SquirrelMail Project Team:
-<!-- put your name here -->
-</author>
-<date>$Date$
-<abstract>
-This document provides information for developers of SquirrelMail webmail interface.
-</abstract>
-
-<toc>
-
-<p>
-Document version: $Revision$
-
-<sect>SquirrelMail overview
-<p>
-SquirrelMail is a standards-based webmail package written in PHP4. It includes
-built-in pure PHP support for the IMAP and SMTP protocols, and all pages render
-in pure HTML 4.0 (with no JavaScript required) for maximum compatibility across
-browsers. It has very few requirements and is very easy to configure and
-install. SquirrelMail has all the functionality you would want from an email
-client, including strong MIME support, address books, and folder manipulation.
-
-<sect>General guidelines
-<p>
-This section should provide some generic information.
-
-<sect1>Coding guidelines
-<p>
-Import wiki page
-
-<sect1>SM_PATH
-<p>
-Information about SM_PATH constant
-
-<sect1>includes/validate.php
-<p>
-Information about files included by validate.php
-
-<sect1>Compatibility
-<p>
-Information about compatibility plugin.
-
-<sect>Developing plugins
-<p>
-This section should provide information about plugin development.
-<sect1>Hooks
-<p>
-We use hooks.
-
-<sect>Internationalization
-<p>
-import i18n.txt
-
-</article>
+++ /dev/null
-<?php
-/**
- * Copyright (c) 2005 The SquirrelMail Project Team
- * This file is part of SquirrelMail webmail interface documentation.
- *
- * SquirrelMail is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * SquirrelMail is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with SquirrelMail; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
- * @package squirrelmail
- */
-
-/**
- * Controls anti indexing headers
- * @global boolean $block_robots
- */
-$block_robots = true;
-
-/**
- * Controls page css
- * @global string $custom_css
- */
-$custom_css = '';
-
-/**
- * Controls display of links to other formats
- * @global boolean $htmlonly
- */
-$htmlonly = false;
-
-/**
- * Controls format of manual links
- * @global boolean $packed_manuals
- */
-$packed_manuals = false;
-
-/** include site configuration */
-if (file_exists('site_config.inc')) {
- // file can contain variables that are used to control header
- include_once('./site_config.inc');
-}
-
-/** Page header */
-header('Content-Type: text/html; charset=iso-8859-1');
-
-echo '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">';
-
-echo "\n<html lang=\"en_US\">\n<head>\n";
-
-if ($block_robots) echo "<meta name=\"robots\" content=\"noindex,nofollow\">\n";
-
-if ( $custom_css != '' ) {
- echo "<link rel=\"stylesheet\" type=\"text/css\" href=\"$custom_css\">\n";
-}
-
-echo "</head>\n<body>\n";
-
-/** check if main admin documentation file exists */
-if (!file_exists('admin.html')) {
- echo "<p>You must compile this documentation with linuxdoc tools.</p>\n";
- echo "<p>See <a href=\"README\">README</a> file.</p>\n";
-} else {
- echo "<h1>SquirrelMail Administrator's Manual</h1>\n";
- echo "<p>Read <a href=\"admin.html\">html version</a> online</p>\n";
- if (! $htmlonly) {
- if (! $packed_manuals) {
- echo "<p>Other formats</p>\n"
- ."<ul>\n"
- ."<li><a href=\"admin.dvi\">Dvi</a></li>\n"
- ."<li><a href=\"admin.info\">info</a></li>\n"
- ."<li><a href=\"admin.lyx\">lyx</a></li>\n"
- ."<li><a href=\"admin.pdf\">pdf</a></li>\n"
- ."<li><a href=\"admin.ps\">postscript</a></li>\n"
- ."<li><a href=\"admin.rtf\">rfc</a></li>\n"
- ."<li><a href=\"admin.sgml\">sgml (original)</a></li>\n"
- ."<li><a href=\"admin.tex\">tex</a></li>\n"
- ."<li><a href=\"admin.txt\">txt</a></li>\n"
- ."</ul>\n";
- } else {
- echo "<p>Other formats</p>\n"
- ."<ul>\n"
- ."<li><a href=\"admin.dvi.gz\">Dvi</a></li>\n"
- ."<li><a href=\"admin.info.gz\">info</a></li>\n"
- ."<li><a href=\"admin.lyx.gz\">lyx</a></li>\n"
- ."<li><a href=\"admin.pdf\">pdf</a></li>\n"
- ."<li><a href=\"admin.ps.gz\">postscript</a></li>\n"
- ."<li><a href=\"admin.rtf.gz\">rfc</a></li>\n"
- ."<li><a href=\"admin.sgml.gz\">sgml (original)</a></li>\n"
- ."<li><a href=\"admin.tex.gz\">tex</a></li>\n"
- ."<li><a href=\"admin.txt.gz\">txt</a></li>\n"
- ."</ul>";
- }
- }
- echo "<h1>SquirrelMail User's Manual</h1>\n";
- echo "<p>Read <a href=\"user.html\">html version</a> online</p>\n";
- if (! $htmlonly) {
- if (! $packed_manuals) {
- echo "<p>Other formats</p>\n"
- ."<ul>\n"
- ."<li><a href=\"user.dvi\">Dvi</a></li>\n"
- ."<li><a href=\"user.info\">info</a></li>\n"
- ."<li><a href=\"user.lyx\">lyx</a></li>\n"
- ."<li><a href=\"user.pdf\">pdf</a></li>\n"
- ."<li><a href=\"user.ps\">postscript</a></li>\n"
- ."<li><a href=\"user.rtf\">rfc</a></li>\n"
- ."<li><a href=\"user.sgml\">sgml (original)</a></li>\n"
- ."<li><a href=\"user.tex\">tex</a></li>\n"
- ."<li><a href=\"user.txt\">txt</a></li>\n"
- ."</ul>\n";
- } else {
- echo "<p>Other formats</p>\n"
- ."<ul>\n"
- ."<li><a href=\"user.dvi.gz\">Dvi</a></li>\n"
- ."<li><a href=\"user.info.gz\">info</a></li>\n"
- ."<li><a href=\"user.lyx.gz\">lyx</a></li>\n"
- ."<li><a href=\"user.pdf\">pdf</a></li>\n"
- ."<li><a href=\"user.ps.gz\">postscript</a></li>\n"
- ."<li><a href=\"user.rtf.gz\">rfc</a></li>\n"
- ."<li><a href=\"user.sgml.gz\">sgml (original)</a></li>\n"
- ."<li><a href=\"user.tex.gz\">tex</a></li>\n"
- ."<li><a href=\"user.txt.gz\">txt</a></li>\n"
- ."</ul>";
- }
- }
- echo "<h1>SquirrelMail Developer's Manual</h1>\n";
- echo "<p>Read <a href=\"devel.html\">html version</a> online</p>\n";
- if (! $htmlonly) {
- if (! $packed_manuals) {
- echo "<p>Other formats</p>\n"
- ."<ul>\n"
- ."<li><a href=\"devel.dvi\">Dvi</a></li>\n"
- ."<li><a href=\"devel.info\">info</a></li>\n"
- ."<li><a href=\"devel.lyx\">lyx</a></li>\n"
- ."<li><a href=\"devel.pdf\">pdf</a></li>\n"
- ."<li><a href=\"devel.ps\">postscript</a></li>\n"
- ."<li><a href=\"devel.rtf\">rfc</a></li>\n"
- ."<li><a href=\"devel.sgml\">sgml (original)</a></li>\n"
- ."<li><a href=\"devel.tex\">tex</a></li>\n"
- ."<li><a href=\"devel.txt\">txt</a></li>\n"
- ."</ul>\n";
- } else {
- echo "<p>Other formats</p>\n"
- ."<ul>\n"
- ."<li><a href=\"devel.dvi.gz\">Dvi</a></li>\n"
- ."<li><a href=\"devel.info.gz\">info</a></li>\n"
- ."<li><a href=\"devel.lyx.gz\">lyx</a></li>\n"
- ."<li><a href=\"devel.pdf\">pdf</a></li>\n"
- ."<li><a href=\"devel.ps.gz\">postscript</a></li>\n"
- ."<li><a href=\"devel.rtf.gz\">rfc</a></li>\n"
- ."<li><a href=\"devel.sgml.gz\">sgml (original)</a></li>\n"
- ."<li><a href=\"devel.tex.gz\">tex</a></li>\n"
- ."<li><a href=\"devel.txt.gz\">txt</a></li>\n"
- ."</ul>";
- }
- }
-}
-?>
-</body>
-</html>
\ No newline at end of file
+++ /dev/null
-</body></html>
\ No newline at end of file
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html>
- <head>
- <!-- we can add own site css here -->
-
\ No newline at end of file
+++ /dev/null
-<!doctype linuxdoc system>
-<!--
- Copyright (c) 2005 The SquirrelMail Project Team
- This file is part of SquirrelMail webmail interface documentation.
-
- SquirrelMail is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.
-
- SquirrelMail is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with SquirrelMail; if not, write to the Free Software
- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
--->
-<article>
-
-<title>SquirrelMail User's Manual
-<author>
-by the SquirrelMail Project Team:
-<!-- put your name here -->
-</author>
-<date>$Date$
-<abstract>
-This document provides information about usage of SquirrelMail webmail interface.
-</abstract>
-
-<toc>
-
-<p>
-Document version: $Revision$
-
-<sect>SquirrelMail overview
-<p>
-SquirrelMail is a standards-based webmail package written in PHP4. It includes
-built-in pure PHP support for the IMAP and SMTP protocols, and all pages render
-in pure HTML 4.0 (with no JavaScript required) for maximum compatibility across
-browsers. It has very few requirements and is very easy to configure and
-install. SquirrelMail has all the functionality you would want from an email
-client, including strong MIME support, address books, and folder manipulation.
-
-<sect>Using SquirrelMail
-<sect1>How do we to use SquirrelMail
-<p>
-See UserManual wiki sections.
-
-</article>
projects / squirrelmail.git / commitdiff
