0697da03125dc622ba9d032b638aca7cdcc6514f
[squirrelmail.git] / contrib / phpdoc / README
1 This directory contains files, that can be used to create
2 SquirrelMail documentation with phpdoc (http://www.phpdoc.org/)
3 tools.
4
5 squirrelmail.ini - SquirrelMail CVS squirrelmail module
6 HEAD branch
7 decode.ini - SquirrelMail CVS decode module HEAD branch
8 smdoc.ini - SquirrelMail CVS smdoc module HEAD branch
9 plugins.ini - SM-Plugins CVS plugins module HEAD branch
10
11 .ini files can be used in phpdoc with -c option. Option
12 was added to phpdoc on 2002-11-16.
13
14 PHP configure options:
15 ----------------------
16 configure --enable-cli --with-pear --disable-cgi \
17 --prefix=/home/user/bin/php \
18 --with-zlib
19
20 php is installed in user's space in order to avoid
21 modifications in stock php install. You need php 4.3.0
22 or better in order to use tokenizer functions in phpdoc.
23
24 Output of php 'pear list' command:
25 ----------------------------------
26 Installed packages:
27 ===================
28 Package Version State
29 Archive_Tar 1.1 stable
30 Console_Getopt 1.2 stable
31 DB 1.6.2 stable
32 HTTP 1.2.2 stable
33 Mail 1.1.3 stable
34 Net_SMTP 1.2.6 stable
35 Net_Socket 1.0.1 stable
36 PEAR 1.3.2 stable
37 PhpDocumentor 1.3.0RC3 beta
38 XML_Beautifier 1.1 stable
39 XML_Parser 1.0.1 stable
40 XML_RPC 1.1.0 stable
41 XML_Util 1.1.1 stable
42
43 Specific changes:
44 -----------------
45 [_phpDocumentor_phpfile_exts] section in phpDocumentor.ini needs
46 mod and tpl extensions.