README.rst 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. *************************
  2. PEAR - The PEAR Installer
  3. *************************
  4. .. image:: https://travis-ci.org/pear/pear-core.svg?branch=stable
  5. :target: https://travis-ci.org/pear/pear-core
  6. =========================================
  7. What is the PEAR Installer? What is PEAR?
  8. =========================================
  9. PEAR is the PHP Extension and Application Repository, found at
  10. http://pear.php.net.
  11. The **PEAR Installer** is this software, which contains executable
  12. files and PHP code that is used to **download and install** PEAR code
  13. from pear.php.net.
  14. PEAR contains useful **software libraries and applications** such as
  15. MDB2 (database abstraction), HTML_QuickForm (HTML forms management),
  16. PhpDocumentor (auto-documentation generator), DB_DataObject
  17. (Data Access Abstraction), and many hundreds more.
  18. Browse all available packages at http://pear.php.net, the list is
  19. constantly growing and updating to reflect improvements in the PHP language.
  20. .. warning::
  21. Do not run PEAR without installing it - if you downloaded this
  22. tarball manually, you MUST install it. Read the instructions in INSTALL
  23. prior to use.
  24. =============
  25. Documentation
  26. =============
  27. Documentation for PEAR can be found at http://pear.php.net/manual/.
  28. Installation documentation can be found in the INSTALL file included
  29. in this tarball.
  30. =====
  31. Tests
  32. =====
  33. Run the tests without installation as follows::
  34. $ ./scripts/pear.sh run-tests -r tests
  35. You should have the ``Text_Diff`` package installed to get nicer error output.
  36. To run the tests with another PHP version, modify ``php_bin`` and set the
  37. ``PHP_PEAR_PHP_BIN`` environment variable::
  38. $ pear config-set php_bin /usr/local/bin/php7
  39. $ PHP_PEAR_PHP_BIN=/usr/local/bin/php7 ./scripts/pear.sh run-tests -r tests
  40. Happy PHPing, we hope PEAR will be a great tool for your development work!
  41. Test dependencies
  42. =================
  43. * ``zlib``
  44. =========
  45. Releasing
  46. =========
  47. Create a PEAR package as well as phars for pear-less installation::
  48. $ rm -f PEAR-*.tgz
  49. $ pear package package2.xml
  50. $ cd go-pear-tarballs
  51. $ rm -f PEAR-*
  52. $ cp ../PEAR-*.tgz .
  53. $ gunzip PEAR-*.tgz
  54. $ pear download -Z Archive_Tar Console_Getopt Structures_Graph XML_Util
  55. $ mkdir src && cd src
  56. $ for i in ../*.tar; do tar xvf $i; done
  57. $ mv *\/* .
  58. $ cd ../../
  59. $ php make-gopear-phar.php
  60. $ php make-installpear-nozlib-phar.php
  61. (Or simply run ``build-release.sh``).
  62. ``go-pear.phar`` is contains the PEAR installer installer that asks questions
  63. where to install it.
  64. It is available from http://pear.php.net/go-pear.phar.
  65. ``install-pear-nozlib.phar`` installs PEAR automatically without asking
  66. anything.
  67. It is shipped with PHP itself.