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

   1 <commands version="1.0">
   2  <package>
   3   <summary>Build Package</summary>
   4   <function>doPackage</function>
   5   <shortcut>p</shortcut>
   6   <options>
   7    <nocompress>
   8     <shortopt>Z</shortopt>
   9     <doc>Do not gzip the package file</doc>
  10    </nocompress>
  11    <showname>
  12     <shortopt>n</shortopt>
  13     <doc>Print the name of the packaged file.</doc>
  14    </showname>
  15   </options>
  16   <doc>[descfile] [descfile2]
  17 Creates a PEAR package from its description file (usually called
  18 package.xml).  If a second packagefile is passed in, then
  19 the packager will check to make sure that one is a package.xml
  20 version 1.0, and the other is a package.xml version 2.0.  The
  21 package.xml version 1.0 will be saved as &quot;package.xml&quot; in the archive,
  22 and the other as &quot;package2.xml&quot; in the archive&quot;
  23 </doc>
  24  </package>
  25  <package-validate>
  26   <summary>Validate Package Consistency</summary>
  27   <function>doPackageValidate</function>
  28   <shortcut>pv</shortcut>
  29   <options />
  30   <doc>
  31 </doc>
  32  </package-validate>
  33  <cvsdiff>
  34   <summary>Run a &quot;cvs diff&quot; for all files in a package</summary>
  35   <function>doCvsDiff</function>
  36   <shortcut>cd</shortcut>
  37   <options>
  38    <quiet>
  39     <shortopt>q</shortopt>
  40     <doc>Be quiet</doc>
  41    </quiet>
  42    <reallyquiet>
  43     <shortopt>Q</shortopt>
  44     <doc>Be really quiet</doc>
  45    </reallyquiet>
  46    <date>
  47     <shortopt>D</shortopt>
  48     <doc>Diff against revision of DATE</doc>
  49     <arg>DATE</arg>
  50    </date>
  51    <release>
  52     <shortopt>R</shortopt>
  53     <doc>Diff against tag for package release REL</doc>
  54     <arg>REL</arg>
  55    </release>
  56    <revision>
  57     <shortopt>r</shortopt>
  58     <doc>Diff against revision REV</doc>
  59     <arg>REV</arg>
  60    </revision>
  61    <context>
  62     <shortopt>c</shortopt>
  63     <doc>Generate context diff</doc>
  64    </context>
  65    <unified>
  66     <shortopt>u</shortopt>
  67     <doc>Generate unified diff</doc>
  68    </unified>
  69    <ignore-case>
  70     <shortopt>i</shortopt>
  71     <doc>Ignore case, consider upper- and lower-case letters equivalent</doc>
  72    </ignore-case>
  73    <ignore-whitespace>
  74     <shortopt>b</shortopt>
  75     <doc>Ignore changes in amount of white space</doc>
  76    </ignore-whitespace>
  77    <ignore-blank-lines>
  78     <shortopt>B</shortopt>
  79     <doc>Ignore changes that insert or delete blank lines</doc>
  80    </ignore-blank-lines>
  81    <brief>
  82     <shortopt></shortopt>
  83     <doc>Report only whether the files differ, no details</doc>
  84    </brief>
  85    <dry-run>
  86     <shortopt>n</shortopt>
  87     <doc>Don&#039;t do anything, just pretend</doc>
  88    </dry-run>
  89   </options>
  90   <doc>&lt;package.xml&gt;
  91 Compares all the files in a package.  Without any options, this
  92 command will compare the current code with the last checked-in code.
  93 Using the -r or -R option you may compare the current code with that
  94 of a specific release.
  95 </doc>
  96  </cvsdiff>
  97  <svntag>
  98   <summary>Set SVN Release Tag</summary>
  99   <function>doSvnTag</function>
 100   <shortcut>sv</shortcut>
 101   <options>
 102    <quiet>
 103     <shortopt>q</shortopt>
 104     <doc>Be quiet</doc>
 105    </quiet>
 106    <slide>
 107     <shortopt>F</shortopt>
 108     <doc>Move (slide) tag if it exists</doc>
 109    </slide>
 110    <delete>
 111     <shortopt>d</shortopt>
 112     <doc>Remove tag</doc>
 113    </delete>
 114    <dry-run>
 115     <shortopt>n</shortopt>
 116     <doc>Don&#039;t do anything, just pretend</doc>
 117    </dry-run>
 118   </options>
 119   <doc>&lt;package.xml&gt; [files...]
 120  Sets a SVN tag on all files in a package.  Use this command after you have
 121  packaged a distribution tarball with the &quot;package&quot; command to tag what
 122  revisions of what files were in that release.  If need to fix something
 123  after running svntag once, but before the tarball is released to the public,
 124  use the &quot;slide&quot; option to move the release tag.
 125
 126  to include files (such as a second package.xml, or tests not included in the
 127  release), pass them as additional parameters.
 128  </doc>
 129  </svntag>
 130  <cvstag>
 131   <summary>Set CVS Release Tag</summary>
 132   <function>doCvsTag</function>
 133   <shortcut>ct</shortcut>
 134   <options>
 135    <quiet>
 136     <shortopt>q</shortopt>
 137     <doc>Be quiet</doc>
 138    </quiet>
 139    <reallyquiet>
 140     <shortopt>Q</shortopt>
 141     <doc>Be really quiet</doc>
 142    </reallyquiet>
 143    <slide>
 144     <shortopt>F</shortopt>
 145     <doc>Move (slide) tag if it exists</doc>
 146    </slide>
 147    <delete>
 148     <shortopt>d</shortopt>
 149     <doc>Remove tag</doc>
 150    </delete>
 151    <dry-run>
 152     <shortopt>n</shortopt>
 153     <doc>Don&#039;t do anything, just pretend</doc>
 154    </dry-run>
 155   </options>
 156   <doc>&lt;package.xml&gt; [files...]
 157 Sets a CVS tag on all files in a package.  Use this command after you have
 158 packaged a distribution tarball with the &quot;package&quot; command to tag what
 159 revisions of what files were in that release.  If need to fix something
 160 after running cvstag once, but before the tarball is released to the public,
 161 use the &quot;slide&quot; option to move the release tag.
 162
 163 to include files (such as a second package.xml, or tests not included in the
 164 release), pass them as additional parameters.
 165 </doc>
 166  </cvstag>
 167  <package-dependencies>
 168   <summary>Show package dependencies</summary>
 169   <function>doPackageDependencies</function>
 170   <shortcut>pd</shortcut>
 171   <options />
 172   <doc>&lt;package-file&gt; or &lt;package.xml&gt; or &lt;install-package-name&gt;
 173 List all dependencies the package has.
 174 Can take a tgz / tar file, package.xml or a package name of an installed package.</doc>
 175  </package-dependencies>
 176  <sign>
 177   <summary>Sign a package distribution file</summary>
 178   <function>doSign</function>
 179   <shortcut>si</shortcut>
 180   <options>
 181    <verbose>
 182     <shortopt>v</shortopt>
 183     <doc>Display GnuPG output</doc>
 184    </verbose>
 185   </options>
 186   <doc>&lt;package-file&gt;
 187 Signs a package distribution (.tar or .tgz) file with GnuPG.</doc>
 188  </sign>
 189  <makerpm>
 190   <summary>Builds an RPM spec file from a PEAR package</summary>
 191   <function>doMakeRPM</function>
 192   <shortcut>rpm</shortcut>
 193   <options>
 194    <spec-template>
 195     <shortopt>t</shortopt>
 196     <doc>Use FILE as RPM spec file template</doc>
 197     <arg>FILE</arg>
 198    </spec-template>
 199    <rpm-pkgname>
 200     <shortopt>p</shortopt>
 201     <doc>Use FORMAT as format string for RPM package name, %s is replaced
 202 by the PEAR package name, defaults to &quot;PEAR::%s&quot;.</doc>
 203     <arg>FORMAT</arg>
 204    </rpm-pkgname>
 205   </options>
 206   <doc>&lt;package-file&gt;
 207
 208 Creates an RPM .spec file for wrapping a PEAR package inside an RPM
 209 package.  Intended to be used from the SPECS directory, with the PEAR
 210 package tarball in the SOURCES directory:
 211
 212 $ pear makerpm ../SOURCES/Net_Socket-1.0.tgz
 213 Wrote RPM spec file PEAR::Net_Geo-1.0.spec
 214 $ rpm -bb PEAR::Net_Socket-1.0.spec
 215 ...
 216 Wrote: /usr/src/redhat/RPMS/i386/PEAR::Net_Socket-1.0-1.i386.rpm
 217 </doc>
 218  </makerpm>
 219  <convert>
 220   <summary>Convert a package.xml 1.0 to package.xml 2.0 format</summary>
 221   <function>doConvert</function>
 222   <shortcut>c2</shortcut>
 223   <options>
 224    <flat>
 225     <shortopt>f</shortopt>
 226     <doc>do not beautify the filelist.</doc>
 227    </flat>
 228   </options>
 229   <doc>[descfile] [descfile2]
 230 Converts a package.xml in 1.0 format into a package.xml
 231 in 2.0 format.  The new file will be named package2.xml by default,
 232 and package.xml will be used as the old file by default.
 233 This is not the most intelligent conversion, and should only be
 234 used for automated conversion or learning the format.
 235 </doc>
 236  </convert>
 237 </commands>