| 1 | _________________________ |
|---|
| 2 | P H I N G |
|---|
| 3 | |
|---|
| 4 | |
|---|
| 5 | Welcome to Phing! |
|---|
| 6 | ----------------- |
|---|
| 7 | |
|---|
| 8 | This is only a quick installation guide. For a more details procedure |
|---|
| 9 | see the usersguide pdf in docs/pdf. |
|---|
| 10 | |
|---|
| 11 | Prerequisites |
|---|
| 12 | ------------- |
|---|
| 13 | |
|---|
| 14 | At this point we assume you have a running Windows NT/2000/XP system |
|---|
| 15 | running and you properly installed PHP 5.0.2+. Windows 9x versions will |
|---|
| 16 | probably work, but are not supported. Make sure that XSL is enabled (e.g. |
|---|
| 17 | enable php_xsl.dll in your php.ini file) if you want to perform builds |
|---|
| 18 | that require XSLT transformation (e.g. many Binarycloud buildfiles, the |
|---|
| 19 | Phing "phing_guide" documentation buildfile). |
|---|
| 20 | |
|---|
| 21 | PEAR Installation |
|---|
| 22 | ----------------- |
|---|
| 23 | |
|---|
| 24 | NOTE: As of Phing 2.0.0b1, Phing is available as a PEAR package. This |
|---|
| 25 | makes installing Phing a million times easier than it already was (and |
|---|
| 26 | most people say that it wasn't too hard in the first place). Visit |
|---|
| 27 | http://phing.info to either download the latest Phing PEAR-installable |
|---|
| 28 | package or to learn how to install directly over the network. |
|---|
| 29 | |
|---|
| 30 | If you are reading this document, then you are probably wanting to do |
|---|
| 31 | the custom install, though, so read on ... |
|---|
| 32 | |
|---|
| 33 | Custom Installation |
|---|
| 34 | ------------------- |
|---|
| 35 | |
|---|
| 36 | First download a matching PHING distribution from http://phing.info and |
|---|
| 37 | unzip it to the desired install directory. |
|---|
| 38 | |
|---|
| 39 | +---------------------------------------------------------------------+ |
|---|
| 40 | | Note: On Windows 95 and Windows 98, the script used to launch | |
|---|
| 41 | | Phing will have problems if PHING_HOME is a long filename. This is | |
|---|
| 42 | | due to limitations in the OS's handling of the "for" batch-file | |
|---|
| 43 | | statement. It is recommended, therefore, that Phing be installed in | |
|---|
| 44 | | a short path, such as C:\opt\phing. | |
|---|
| 45 | +---------------------------------------------------------------------+ |
|---|
| 46 | |
|---|
| 47 | The batch script used to launch phing (bin\phing.bat) will attempt to |
|---|
| 48 | guess most settings if you do not provide them explicitly. At this point |
|---|
| 49 | you may want to try running Phing to see how you fare: |
|---|
| 50 | |
|---|
| 51 | C:\opt\phing\bin\phing -version |
|---|
| 52 | |
|---|
| 53 | If that worked, then no further setup is necessary; however, you probably |
|---|
| 54 | want to add C:\opt\phing\bin to your PATH environment variable to make it |
|---|
| 55 | easier to run Phing from any location. |
|---|
| 56 | |
|---|
| 57 | +---------------------------------------------------------------------+ |
|---|
| 58 | | Note: See http://www.cs.usask.ca/grads/wew036/latex/env.html for | |
|---|
| 59 | | information on how to set environment variables. | |
|---|
| 60 | +---------------------------------------------------------------------+ |
|---|
| 61 | |
|---|
| 62 | More Detailed Install Instruction |
|---|
| 63 | --------------------------------- |
|---|
| 64 | |
|---|
| 65 | If Phing did not run out-of-the-box, then you will probably need to set some |
|---|
| 66 | environment variables so that Phing knows where to find the PHP executable, |
|---|
| 67 | necessary classes, etc. |
|---|
| 68 | |
|---|
| 69 | * Setting %PHP_COMMAND% |
|---|
| 70 | |
|---|
| 71 | If your PHP executable is *not* on the PATH, then you should set the |
|---|
| 72 | PHP_COMMAND environment variable to point to the CLI binary of PHP. |
|---|
| 73 | |
|---|
| 74 | For example, if you use the default install dir of PHP, you have to |
|---|
| 75 | set: |
|---|
| 76 | |
|---|
| 77 | set PHP_COMMAND=C:\php\php.exe |
|---|
| 78 | |
|---|
| 79 | * Setting %PHING_HOME% |
|---|
| 80 | |
|---|
| 81 | You may also set the path to Phing's home directory. This is no longer |
|---|
| 82 | necessary if you have not moved any files around (i.e. if the phing.bat |
|---|
| 83 | file is in bin/ sub directory). If you encounter problems running Phing, |
|---|
| 84 | you probably want to set this variable (just to be sure): |
|---|
| 85 | |
|---|
| 86 | set PHING_HOME=C:\opt\phing |
|---|
| 87 | |
|---|
| 88 | * Setting %PHP_CLASSPATH% |
|---|
| 89 | |
|---|
| 90 | You may also set a PHP_CLASSPATH variable to add any other locations to |
|---|
| 91 | PHP's include_path (Of course, you may also simply add other locations |
|---|
| 92 | directly to the include_path variable in php.ini): |
|---|
| 93 | |
|---|
| 94 | set PHP_CLASSPATH=%PHING_HOME%\classes |
|---|
| 95 | |
|---|
| 96 | You can make additional classpath entries if there's a need for them. I.e. |
|---|
| 97 | adding %BCHOME% if you want to access binarycloud packages. |
|---|
| 98 | |
|---|
| 99 | * Setting %PATH% |
|---|
| 100 | |
|---|
| 101 | Now you can add the phing executable to your PATH environment: |
|---|
| 102 | |
|---|
| 103 | set PATH=%PATH%;%PHING_HOME%\bin |
|---|
| 104 | |
|---|
| 105 | You're Done! |
|---|
| 106 | ------------ |
|---|
| 107 | |
|---|
| 108 | You should now be able to execute Phing from everywhere in your system. |
|---|
| 109 | Try it by changing back to your home and type: |
|---|
| 110 | |
|---|
| 111 | > phing -version |
|---|
| 112 | |
|---|
| 113 | Congratulations, you successfully installed Phing. |
|---|
| 114 | |
|---|
| 115 | --$Id$ |
|---|
| 116 | |
|---|