mods/phpdoc2/PhpDocumentor/INSTALL

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