| 1 |
lars |
1 |
$Id: INSTALL 256227 2008-03-28 02:27:12Z ashnazg $
|
|
|
2 |
|
|
|
3 |
phpDocumentor Installation instructions
|
|
|
4 |
---------------------------------------
|
|
|
5 |
|
|
|
6 |
phpDocumentor is very easy to install. The hardest part is installing PHP
|
|
|
7 |
and possibly a Web Server, if you plan to use the web interface phpdoc.php.
|
|
|
8 |
|
|
|
9 |
To install phpDocumentor, use a compression program to decompress the
|
|
|
10 |
contents to a directory, preserving internal directory structure of the
|
|
|
11 |
archive. If you wish to use the web interface, you must unzip the
|
|
|
12 |
archive into a subdirectory accessible by the web server.
|
|
|
13 |
|
|
|
14 |
NOTE:
|
|
|
15 |
There have been problems with the non GNU tar not being able to extracts some
|
|
|
16 |
of the long directory paths properly. The simplest solution for BSD users is
|
|
|
17 |
to download the zip version of phpDocumentor.
|
|
|
18 |
|
|
|
19 |
PEAR installation
|
|
|
20 |
-----------------
|
|
|
21 |
This is by far the easiest way to install phpDocumentor. Included in this
|
|
|
22 |
release is a package.xml file.
|
|
|
23 |
|
|
|
24 |
If you plan to use the web interface, you must run this command prior to installation:
|
|
|
25 |
|
|
|
26 |
pear config-set data_dir /path/to/public_html/pear
|
|
|
27 |
|
|
|
28 |
The line above assumes that /path/to/public_html is the location of index.html if you browse
|
|
|
29 |
to http://localhost/index.html
|
|
|
30 |
|
|
|
31 |
To install or upgrade phpDocumentor, simply run
|
|
|
32 |
|
|
|
33 |
pear upgrade PhpDocumentor
|
|
|
34 |
|
|
|
35 |
To use the web interface, browse to http://localhost/pear/PhpDocumentor/index.html
|
|
|
36 |
|
|
|
37 |
The cli interface is installed in the pear bin_dir, you can find this directory by running:
|
|
|
38 |
pear config-show
|
|
|
39 |
|
|
|
40 |
Command-line interface installation and usage instructions
|
|
|
41 |
----------------------------------------------------------
|
|
|
42 |
To use phpDocumentor as a command-line interface, you need to install PHP
|
|
|
43 |
version 4.1.0 or greater.
|
|
|
44 |
|
|
|
45 |
*IMPORTANT* any version of PHP below 4.1.0 will not work with version 1.3.0 or later of
|
|
|
46 |
phpDocumentor!!! To use the advanced tokenizer-based parser, you must have php 4.3.0
|
|
|
47 |
|
|
|
48 |
Windows
|
|
|
49 |
-------
|
|
|
50 |
You need the cli version of PHP (php-cli.exe or cli/php.exe in 4.3.0+).
|
|
|
51 |
Either run phpDocumentor from the directory that PHP resides in, or put
|
|
|
52 |
php.exe in your DOS PATH enviroment variable. The simplest usage of phpDocumentor is:
|
|
|
53 |
|
|
|
54 |
C:\>php.exe "C:\Path\To\phpdoc" -t targetdir -o HTML:default:default -d parsedir
|
|
|
55 |
|
|
|
56 |
where targetdir is the directory you wish phpDocumentor to create output,
|
|
|
57 |
and parsedir is the directory you wish to parse.
|
|
|
58 |
|
|
|
59 |
Unix
|
|
|
60 |
----
|
|
|
61 |
Make sure that the cgi/cli version of PHP is in your path. The simplest usage
|
|
|
62 |
of phpDocumentor is:
|
|
|
63 |
|
|
|
64 |
phpdoc -t targetdir -o HTML:default:default -d parsedir
|
|
|
65 |
|
|
|
66 |
You can also use makedoc.sh. Simply copy it to your project path and edit it.
|
|
|
67 |
When you wish to (re)build your project's documentation, simply run it.
|
|
|
68 |
|
|
|
69 |
|
|
|
70 |
Web interface installation and usage instructions
|
|
|
71 |
-------------------------------------------------
|
|
|
72 |
To use phpDocumentor as a web interface, you need to install a Web server
|
|
|
73 |
and configure it, as well as install PHP version 4.1.0 or greater. Consult
|
|
|
74 |
the documentation of your webserver and of PHP for installation support.
|
|
|
75 |
|
|
|
76 |
Windows and Unix
|
|
|
77 |
----------------
|
|
|
78 |
Open a web browser and browse to index.html at the location that you set up.
|
|
|
79 |
Instructions are in the web interface.
|
|
|
80 |
|
|
|
81 |
vim: set expandtab :
|