doc:phd:install

This is an old revision of the document!


Installing PhD

The preferred method is using the pear channel, but all methods are documented below.

Using the PEAR Channel

At the time of this writing the latest version of PhD is in beta so the -beta tag is used below. PhD is chunked into multiple sub-packages (currently “Generic”, “PHP” and “PEAR”), the Generic package is installed by default.

To install just the PhD core and the Generic package, type:

$ pear install doc.php.net/PhD-beta

And for upgrading:

$ pear upgrade doc.php.net/PhD-beta

If by chance you already installed PhD by other means then be sure to uninstall that version first.

To list all available packages:

$ pear remote-list -c doc.php.net

and to install optional packages:

$ pear install doc.php.net/PhD_PHP-beta

Note that since the optional packages depend on the PhD core package they will pull down and automatically install the required packages if missing. That means it enough to simply write:

$ pear install doc.php.net/PhD_PHP-beta

to install everything that is required.

Using PEAR directly

Installing by using a specific tarball is possible too, but is not recommended.

$ pear install http://doc.php.net/phd/PhD-0.4.1.tgz

Using SVN

Getting the code:

$ svn co http://svn.php.net/repository/phd/trunk phd

Install and run from SVN:

$ cd phd
$ pear install -f package.xml

Alternately you can (although not recommended) run PhD directly from SVN, without needing to install it. The same holds true if using the tarball, because all the phd command really does is execute “php render.php” so:

$ cd phd
$ php render.php -d/path/to/phpdoc/.manual.xml

Now go on and read the PhD Documentation

doc/phd/install.1252676932.txt.gz · Last modified: 2017/09/22 13:28 (external edit)