WEB-INF/lib/pear/PEAR/Command/Remote.xml

   1 <commands version="1.0">
   2  <remote-info>
   3   <summary>Information About Remote Packages</summary>
   4   <function>doRemoteInfo</function>
   5   <shortcut>ri</shortcut>
   6   <options />
   7   <doc>&lt;package&gt;
   8 Get details on a package from the server.</doc>
   9  </remote-info>
  10  <list-upgrades>
  11   <summary>List Available Upgrades</summary>
  12   <function>doListUpgrades</function>
  13   <shortcut>lu</shortcut>
  14   <options>
  15    <channelinfo>
  16     <shortopt>i</shortopt>
  17     <doc>output fully channel-aware data, even on failure</doc>
  18    </channelinfo>
  19   </options>
  20   <doc>[preferred_state]
  21 List releases on the server of packages you have installed where
  22 a newer version is available with the same release state (stable etc.)
  23 or the state passed as the second parameter.</doc>
  24  </list-upgrades>
  25  <remote-list>
  26   <summary>List Remote Packages</summary>
  27   <function>doRemoteList</function>
  28   <shortcut>rl</shortcut>
  29   <options>
  30    <channel>
  31     <shortopt>c</shortopt>
  32     <doc>specify a channel other than the default channel</doc>
  33     <arg>CHAN</arg>
  34    </channel>
  35   </options>
  36   <doc>
  37 Lists the packages available on the configured server along with the
  38 latest stable release of each package.</doc>
  39  </remote-list>
  40  <search>
  41   <summary>Search remote package database</summary>
  42   <function>doSearch</function>
  43   <shortcut>sp</shortcut>
  44   <options>
  45    <channel>
  46     <shortopt>c</shortopt>
  47     <doc>specify a channel other than the default channel</doc>
  48     <arg>CHAN</arg>
  49    </channel>
  50    <allchannels>
  51     <shortopt>a</shortopt>
  52     <doc>search packages from all known channels</doc>
  53    </allchannels>
  54    <channelinfo>
  55     <shortopt>i</shortopt>
  56     <doc>output fully channel-aware data, even on failure</doc>
  57    </channelinfo>
  58   </options>
  59   <doc>[packagename] [packageinfo]
  60 Lists all packages which match the search parameters.  The first
  61 parameter is a fragment of a packagename.  The default channel
  62 will be used unless explicitly overridden.  The second parameter
  63 will be used to match any portion of the summary/description</doc>
  64  </search>
  65  <list-all>
  66   <summary>List All Packages</summary>
  67   <function>doListAll</function>
  68   <shortcut>la</shortcut>
  69   <options>
  70    <channel>
  71     <shortopt>c</shortopt>
  72     <doc>specify a channel other than the default channel</doc>
  73     <arg>CHAN</arg>
  74    </channel>
  75    <channelinfo>
  76     <shortopt>i</shortopt>
  77     <doc>output fully channel-aware data, even on failure</doc>
  78    </channelinfo>
  79   </options>
  80   <doc>
  81 Lists the packages available on the configured server along with the
  82 latest stable release of each package.</doc>
  83  </list-all>
  84  <download>
  85   <summary>Download Package</summary>
  86   <function>doDownload</function>
  87   <shortcut>d</shortcut>
  88   <options>
  89    <nocompress>
  90     <shortopt>Z</shortopt>
  91     <doc>download an uncompressed (.tar) file</doc>
  92    </nocompress>
  93   </options>
  94   <doc>&lt;package&gt;...
  95 Download package tarballs.  The files will be named as suggested by the
  96 server, for example if you download the DB package and the latest stable
  97 version of DB is 1.6.5, the downloaded file will be DB-1.6.5.tgz.</doc>
  98  </download>
  99  <clear-cache>
 100   <summary>Clear Web Services Cache</summary>
 101   <function>doClearCache</function>
 102   <shortcut>cc</shortcut>
 103   <options />
 104   <doc>
 105 Clear the XML-RPC/REST cache.  See also the cache_ttl configuration
 106 parameter.
 107 </doc>
 108  </clear-cache>
 109 </commands>