PEAR
[ class tree: PEAR ] [ index: PEAR ] [ all elements ]

Source for file Install-init.php

Documentation is available at Install-init.php

  1. <?php
  2. // quick-load, small memory footprint command configuration
  3. $implements = array(
  4.         'install' => array(
  5.             'summary' => 'Install Package',
  6.             'function' => 'doInstall',
  7.             'shortcut' => 'i',
  8.             'options' => array(
  9.                 'force' => array(
  10.                     'shortopt' => 'f',
  11.                     'doc' => 'will overwrite newer installed packages',
  12.                     ),
  13.                 'nodeps' => array(
  14.                     'shortopt' => 'n',
  15.                     'doc' => 'ignore dependencies, install anyway',
  16.                     ),
  17.                 'register-only' => array(
  18.                     'shortopt' => 'r',
  19.                     'doc' => 'do not install files, only register the package as installed',
  20.                     ),
  21.                 'soft' => array(
  22.                     'shortopt' => 's',
  23.                     'doc' => 'soft install, fail silently, or upgrade if already installed',
  24.                     ),
  25.                 'nobuild' => array(
  26.                     'shortopt' => 'B',
  27.                     'doc' => 'don\'t build C extensions',
  28.                     ),
  29.                 'nocompress' => array(
  30.                     'shortopt' => 'Z',
  31.                     'doc' => 'request uncompressed files when downloading',
  32.                     ),
  33.                 'installroot' => array(
  34.                     'shortopt' => 'R',
  35.                     'arg' => 'DIR',
  36.                     'doc' => 'root directory used when installing files (ala PHP\'s INSTALL_ROOT)',
  37.                     ),
  38.                 'ignore-errors' => array(
  39.                     'doc' => 'force install even if there were errors',
  40.                     ),
  41.                 'alldeps' => array(
  42.                     'shortopt' => 'a',
  43.                     'doc' => 'install all required and optional dependencies',
  44.                     ),
  45.                 'onlyreqdeps' => array(
  46.                     'shortopt' => 'o',
  47.                     'doc' => 'install all required dependencies',
  48.                     ),
  49.                 'offline' => array(
  50.                     'shortopt' => 'O',
  51.                     'doc' => 'do not attempt to download any urls or contact channels',
  52.                     ),
  53.                 'pretend' => array(
  54.                     'shortopt' => 'p',
  55.                     'doc' => 'Only list the packages that would be downloaded',
  56.                     ),
  57.                 ),
  58.             'doc' => '[channel/]<package> ...
  59. Installs one or more PEAR packages.  You can specify a package to
  60. install in four ways:
  61.  
  62. "Package-1.0.tgz" : installs from a local file
  63.  
  64. "http://example.com/Package-1.0.tgz" : installs from
  65. anywhere on the net.
  66.  
  67. "package.xml" : installs the package described in
  68. package.xml.  Useful for testing, or for wrapping a PEAR package in
  69. another package manager such as RPM.
  70.  
  71. "Package[-version/state][.tar]" : queries your default channel\'s server
  72. ({config master_server}) and downloads the newest package with
  73. the preferred quality/state ({config preferred_state}).
  74.  
  75. To retrieve Package version 1.1, use "Package-1.1," to retrieve
  76. Package state beta, use "Package-beta."  To retrieve an uncompressed
  77. file, append .tar (make sure there is no file by the same name first)
  78.  
  79. To download a package from another channel, prefix with the channel name like
  80. "channel/Package"
  81.  
  82. More than one package may be specified at once.  It is ok to mix these
  83. four ways of specifying packages.
  84. '),
  85.         'upgrade' => array(
  86.             'summary' => 'Upgrade Package',
  87.             'function' => 'doInstall',
  88.             'shortcut' => 'up',
  89.             'options' => array(
  90.                 'force' => array(
  91.                     'shortopt' => 'f',
  92.                     'doc' => 'overwrite newer installed packages',
  93.                     ),
  94.                 'nodeps' => array(
  95.                     'shortopt' => 'n',
  96.                     'doc' => 'ignore dependencies, upgrade anyway',
  97.                     ),
  98.                 'register-only' => array(
  99.                     'shortopt' => 'r',
  100.                     'doc' => 'do not install files, only register the package as upgraded',
  101.                     ),
  102.                 'nobuild' => array(
  103.                     'shortopt' => 'B',
  104.                     'doc' => 'don\'t build C extensions',
  105.                     ),
  106.                 'nocompress' => array(
  107.                     'shortopt' => 'Z',
  108.                     'doc' => 'request uncompressed files when downloading',
  109.                     ),
  110.                 'installroot' => array(
  111.                     'shortopt' => 'R',
  112.                     'arg' => 'DIR',
  113.                     'doc' => 'root directory used when installing files (ala PHP\'s INSTALL_ROOT)',
  114.                     ),
  115.                 'ignore-errors' => array(
  116.                     'doc' => 'force install even if there were errors',
  117.                     ),
  118.                 'alldeps' => array(
  119.                     'shortopt' => 'a',
  120.                     'doc' => 'install all required and optional dependencies',
  121.                     ),
  122.                 'onlyreqdeps' => array(
  123.                     'shortopt' => 'o',
  124.                     'doc' => 'install all required dependencies',
  125.                     ),
  126.                 'offline' => array(
  127.                     'shortopt' => 'O',
  128.                     'doc' => 'do not attempt to download any urls or contact channels',
  129.                     ),
  130.                 'pretend' => array(
  131.                     'shortopt' => 'p',
  132.                     'doc' => 'Only list the packages that would be downloaded',
  133.                     ),
  134.                 ),
  135.             'doc' => '<package> ...
  136. Upgrades one or more PEAR packages.  See documentation for the
  137. "install" command for ways to specify a package.
  138.  
  139. When upgrading, your package will be updated if the provided new
  140. package has a higher version number (use the -f option if you need to
  141. upgrade anyway).
  142.  
  143. More than one package may be specified at once.
  144. '),
  145.         'upgrade-all' => array(
  146.             'summary' => 'Upgrade All Packages',
  147.             'function' => 'doInstall',
  148.             'shortcut' => 'ua',
  149.             'options' => array(
  150.                 'nodeps' => array(
  151.                     'shortopt' => 'n',
  152.                     'doc' => 'ignore dependencies, upgrade anyway',
  153.                     ),
  154.                 'register-only' => array(
  155.                     'shortopt' => 'r',
  156.                     'doc' => 'do not install files, only register the package as upgraded',
  157.                     ),
  158.                 'nobuild' => array(
  159.                     'shortopt' => 'B',
  160.                     'doc' => 'don\'t build C extensions',
  161.                     ),
  162.                 'nocompress' => array(
  163.                     'shortopt' => 'Z',
  164.                     'doc' => 'request uncompressed files when downloading',
  165.                     ),
  166.                 'installroot' => array(
  167.                     'shortopt' => 'R',
  168.                     'arg' => 'DIR',
  169.                     'doc' => 'root directory used when installing files (ala PHP\'s INSTALL_ROOT)',
  170.                     ),
  171.                 'ignore-errors' => array(
  172.                     'doc' => 'force install even if there were errors',
  173.                     ),
  174.                 ),
  175.             'doc' => '
  176. Upgrades all packages that have a newer release available.  Upgrades are
  177. done only if there is a release available of the state specified in
  178. "preferred_state" (currently {config preferred_state}), or a state considered
  179. more stable.
  180. '),
  181.         'uninstall' => array(
  182.             'summary' => 'Un-install Package',
  183.             'function' => 'doUninstall',
  184.             'shortcut' => 'un',
  185.             'options' => array(
  186.                 'nodeps' => array(
  187.                     'shortopt' => 'n',
  188.                     'doc' => 'ignore dependencies, uninstall anyway',
  189.                     ),
  190.                 'register-only' => array(
  191.                     'shortopt' => 'r',
  192.                     'doc' => 'do not remove files, only register the packages as not installed',
  193.                     ),
  194.                 'installroot' => array(
  195.                     'shortopt' => 'R',
  196.                     'arg' => 'DIR',
  197.                     'doc' => 'root directory used when installing files (ala PHP\'s INSTALL_ROOT)',
  198.                     ),
  199.                 'ignore-errors' => array(
  200.                     'doc' => 'force install even if there were errors',
  201.                     ),
  202.                 'offline' => array(
  203.                     'shortopt' => 'O',
  204.                     'doc' => 'do not attempt to uninstall remotely',
  205.                     ),
  206.                 ),
  207.             'doc' => '[channel/]<package> ...
  208. Uninstalls one or more PEAR packages.  More than one package may be
  209. specified at once.  Prefix with channel name to uninstall from a
  210. channel not in your default channel ({config default_channel})
  211. '),
  212.         'bundle' => array(
  213.             'summary' => 'Unpacks a Pecl Package',
  214.             'function' => 'doBundle',
  215.             'shortcut' => 'bun',
  216.             'options' => array(
  217.                 'destination' => array(
  218.                    'shortopt' => 'd',
  219.                     'arg' => 'DIR',
  220.                     'doc' => 'Optional destination directory for unpacking (defaults to current path or "ext" if exists)',
  221.                     ),
  222.                 'force' => array(
  223.                     'shortopt' => 'f',
  224.                     'doc' => 'Force the unpacking even if there were errors in the package',
  225.                 ),
  226.             ),
  227.             'doc' => '<package>
  228. Unpacks a Pecl Package into the selected location. It will download the
  229. package if needed.
  230. '),
  231.         'run-scripts' => array(
  232.             'summary' => 'Run Post-Install Scripts bundled with a package',
  233.             'function' => 'doRunScripts',
  234.             'shortcut' => 'rs',
  235.             'options' => array(
  236.             ),
  237.             'doc' => '<package>
  238. Run post-installation scripts in package <package>, if any exist.
  239. '),
  240.     );
  241. ?>

Documentation generated on Mon, 11 Mar 2019 14:15:32 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.