WEB-INF/lib/pear/README.rst

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