[Sommaire] [Imprimer]

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