doc:phd:install

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
doc:phd:install [2008/03/10 11:45]
felipe imported, originally written by Philip
doc:phd:install [2012/03/07 11:31]
bjori s/svn/git
Line 1: Line 1:
 ===== Installing PhD ===== ===== Installing PhD =====
 +The preferred method is using the pear channel, but all methods are documented below.
  
-==== Using PEAR ====+==== 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:
 <code> <code>
-bjori@lindsay:~$ pear install http://doc.php.net/phd/PhD-0.2.0.tgz +$ pear install doc.php.net/PhD
-downloading PhD-0.2.0.tgz ... +
-Starting to download PhD-0.2.0.tgz (23,669 bytes) +
-.......done: 23,669 bytes +
-install ok: channel://__uri/PhD-0.2.0 +
-bjori@lindsay:~$ mkdir build && cd build +
-bjori@lindsay:~/build$ phd /path/to/your/phpdoc/checkout+
 </code> </code>
 +And for upgrading:
 +<code>
 +$ pear upgrade doc.php.net/PhD
 +</code>
 +If by chance you already installed PhD by other means then be sure to uninstall that version first.
  
-==== Using CVS ====+To list all available packages:
 <code> <code>
-# cvs -d:pserver:cvsread@cvs.php.net/repository co phd +$ pear remote-list -c doc.php.net
-# cd phd +
-# vim config.php # Edit the xml_root to point to your phpdoc checkout and remove the die() line +
-# pear install -f package.xml +
-# phd -d/path/to/phpdoc/.manual.xml+
 </code> </code>
 +and to install optional packages:
 +<code>
 +$ pear install doc.php.net/PhD_PHP
 +$ pear install doc.php.net/PhD_IDE
 +</code>
 +
 +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:
 +<code>
 +$ pear install doc.php.net/PhD_PHP
 +</code>
 +to install everything that is required.
 +
 +==== Using PEAR directly ====
 +Installing by using a specific tarball is possible too, but is not recommended.
 +<code>
 +$ pear install http://doc.php.net/get/PhD-1.1.0.tgz
 +</code>
 +==== Using GIT ====
 +NOTE: Using PhD from GIT is not recommended.
 +
 +
 +Getting the code (anonymous checkout):
 +<code>
 +$ git clone git://git.php.net/phd.git
 +</code>
 +For developers:
 +<code>
 +$ git clone git@git.php.net:/phd.git
 +</code>
 +
 +
 +Install and run from GIT. There are several package_*.xml files, but in the very least you'll need:
 +<code>
 +$ cd phd
 +$ pear install package.xml package_generic.xml
 +</code>
 +
 +To then install the "PHP" package (needed to render the PHP documentations):
 +<code>
 +$ pear install package_php.xml
 +</code>
 +
 +Alternately you can run PhD directly from GIT, 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:
 +<code>
 +$ cd phd
 +$ php render.php --docbook /path/to/phpdoc/.manual.xml
 +</code>
 +
 +
 +Now go on and read the [[http://doc.php.net/phd/docs/|PhD Documentation]]
doc/phd/install.txt · Last modified: 2017/09/22 13:28 (external edit)