Package.xml 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237
  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. to include files (such as a second package.xml, or tests not included in the
  126. release), pass them as additional parameters.
  127. </doc>
  128. </svntag>
  129. <cvstag>
  130. <summary>Set CVS Release Tag</summary>
  131. <function>doCvsTag</function>
  132. <shortcut>ct</shortcut>
  133. <options>
  134. <quiet>
  135. <shortopt>q</shortopt>
  136. <doc>Be quiet</doc>
  137. </quiet>
  138. <reallyquiet>
  139. <shortopt>Q</shortopt>
  140. <doc>Be really quiet</doc>
  141. </reallyquiet>
  142. <slide>
  143. <shortopt>F</shortopt>
  144. <doc>Move (slide) tag if it exists</doc>
  145. </slide>
  146. <delete>
  147. <shortopt>d</shortopt>
  148. <doc>Remove tag</doc>
  149. </delete>
  150. <dry-run>
  151. <shortopt>n</shortopt>
  152. <doc>Don&#039;t do anything, just pretend</doc>
  153. </dry-run>
  154. </options>
  155. <doc>&lt;package.xml&gt; [files...]
  156. Sets a CVS tag on all files in a package. Use this command after you have
  157. packaged a distribution tarball with the &quot;package&quot; command to tag what
  158. revisions of what files were in that release. If need to fix something
  159. after running cvstag once, but before the tarball is released to the public,
  160. use the &quot;slide&quot; option to move the release tag.
  161. to include files (such as a second package.xml, or tests not included in the
  162. release), pass them as additional parameters.
  163. </doc>
  164. </cvstag>
  165. <package-dependencies>
  166. <summary>Show package dependencies</summary>
  167. <function>doPackageDependencies</function>
  168. <shortcut>pd</shortcut>
  169. <options />
  170. <doc>&lt;package-file&gt; or &lt;package.xml&gt; or &lt;install-package-name&gt;
  171. List all dependencies the package has.
  172. Can take a tgz / tar file, package.xml or a package name of an installed package.</doc>
  173. </package-dependencies>
  174. <sign>
  175. <summary>Sign a package distribution file</summary>
  176. <function>doSign</function>
  177. <shortcut>si</shortcut>
  178. <options>
  179. <verbose>
  180. <shortopt>v</shortopt>
  181. <doc>Display GnuPG output</doc>
  182. </verbose>
  183. </options>
  184. <doc>&lt;package-file&gt;
  185. Signs a package distribution (.tar or .tgz) file with GnuPG.</doc>
  186. </sign>
  187. <makerpm>
  188. <summary>Builds an RPM spec file from a PEAR package</summary>
  189. <function>doMakeRPM</function>
  190. <shortcut>rpm</shortcut>
  191. <options>
  192. <spec-template>
  193. <shortopt>t</shortopt>
  194. <doc>Use FILE as RPM spec file template</doc>
  195. <arg>FILE</arg>
  196. </spec-template>
  197. <rpm-pkgname>
  198. <shortopt>p</shortopt>
  199. <doc>Use FORMAT as format string for RPM package name, %s is replaced
  200. by the PEAR package name, defaults to &quot;PEAR::%s&quot;.</doc>
  201. <arg>FORMAT</arg>
  202. </rpm-pkgname>
  203. </options>
  204. <doc>&lt;package-file&gt;
  205. Creates an RPM .spec file for wrapping a PEAR package inside an RPM
  206. package. Intended to be used from the SPECS directory, with the PEAR
  207. package tarball in the SOURCES directory:
  208. $ pear makerpm ../SOURCES/Net_Socket-1.0.tgz
  209. Wrote RPM spec file PEAR::Net_Geo-1.0.spec
  210. $ rpm -bb PEAR::Net_Socket-1.0.spec
  211. ...
  212. Wrote: /usr/src/redhat/RPMS/i386/PEAR::Net_Socket-1.0-1.i386.rpm
  213. </doc>
  214. </makerpm>
  215. <convert>
  216. <summary>Convert a package.xml 1.0 to package.xml 2.0 format</summary>
  217. <function>doConvert</function>
  218. <shortcut>c2</shortcut>
  219. <options>
  220. <flat>
  221. <shortopt>f</shortopt>
  222. <doc>do not beautify the filelist.</doc>
  223. </flat>
  224. </options>
  225. <doc>[descfile] [descfile2]
  226. Converts a package.xml in 1.0 format into a package.xml
  227. in 2.0 format. The new file will be named package2.xml by default,
  228. and package.xml will be used as the old file by default.
  229. This is not the most intelligent conversion, and should only be
  230. used for automated conversion or learning the format.
  231. </doc>
  232. </convert>
  233. </commands>