You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

overview.html 11 KiB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Language" content="en-us">
  4. <title>Overview of Ant core tasks</title>
  5. <base target="mainFrame">
  6. </head>
  7. <body>
  8. <h2>Overview of Ant core tasks</h2>
  9. <p>Given the large number of tasks available to a build designer, it may be
  10. difficult to get an overall view of what each task can do. The following
  11. table provides a short description of each task and a link to the complete
  12. documentation.</p>
  13. <table border="1" cellpadding="4" cellspacing="0">
  14. <tr valign="top">
  15. <th>Task Name</th>
  16. <th>Description</th>
  17. </tr>
  18. <tr valign="top">
  19. <td><a href="ant.html">Ant</a></td>
  20. <td><p>Runs Ant on a supplied buildfile. This can be used to build subprojects.</p></td>
  21. </tr>
  22. <tr valign="top">
  23. <td><a href="antcall.html">AntCall</a></td>
  24. <td><p>Call another target within the same build-file optionally specifying some
  25. properties.</p></td>
  26. </tr>
  27. <tr valign="top">
  28. <td><a href="antstructure.html">AntStructure</a></td>
  29. <td><p>Generates a DTD for Ant buildfiles which contains information
  30. about all tasks currently known to Ant.</p></td>
  31. </tr>
  32. <tr valign="top">
  33. <td><a href="apply.html">Apply/<i>ExecOn</i></a></td>
  34. <td><p>Executes a system command. When the <i>os</i> attribute is specified, then
  35. the command is only executed when Ant is run on one of the specified operating
  36. systems.</p></td>
  37. </tr>
  38. <tr valign="top">
  39. <td><a href="available.html">Available</a></td>
  40. <td><p>Sets a property if a resource is available at runtime. This resource can be a
  41. file, a directory, a class in the classpath, or a JVM system resource.</p></td>
  42. </tr>
  43. <tr valign="top">
  44. <td><a href="chmod.html">Chmod</a></td>
  45. <td><p>Changes the permissions of a file or all files inside specified directories.
  46. Right now it has effect only under Unix. The permissions are also UNIX style, like
  47. the argument for the chmod command.</p></td>
  48. </tr>
  49. <tr valign="top">
  50. <td><a href="condition.html">Condition</a></td>
  51. <td><p>Sets a property if a certain condition holds true - this is a
  52. generalization of <a href="available.html">Available</a> and
  53. <a href="uptodate.html">Uptodate</a>.</p></td>
  54. </tr>
  55. <tr valign="top">
  56. <td><a href="copy.html">Copy</a></td>
  57. <td><p>Copies a file or Fileset to a new file or directory.</p></td>
  58. </tr>
  59. <tr valign="top">
  60. <td><a href="copydir.html"><i>Copydir</i></a></td>
  61. <td><p><i>This task has been deprecated. Use the Copy task instead.</i></p></td>
  62. </tr>
  63. <tr valign="top">
  64. <td><a href="copyfile.html"><i>Copyfile</i></a></td>
  65. <td><p><i>This task has been deprecated. Use the Copy task instead.</i></p></td>
  66. </tr>
  67. <tr valign="top">
  68. <td><a href="cvs.html">Cvs</a></td>
  69. <td><p>Handles packages/modules retrieved from a
  70. <a href="http://www.cvshome.org/" target="_top">CVS</a> repository.</p></td>
  71. </tr>
  72. <tr valign="top">
  73. <td><a href="cvspass.html">CVSPass</a></td>
  74. <td><p>Adds entries to a .cvspass file. Adding entries to this file has the same
  75. affect as a cvs login command.</p></td>
  76. </tr>
  77. <tr valign="top">
  78. <td><a href="delete.html">Delete</a></td>
  79. <td><p>Deletes either a single file, all files in a specified directory
  80. and its sub-directories, or a set of files specified by one or more
  81. <a href="../CoreTypes/fileset.html">FileSet</a>s.</p></td>
  82. </tr>
  83. <tr valign="top">
  84. <td><a href="deltree.html"><i>Deltree</i></a></td>
  85. <td><p><i>This task has been deprecated. Use the Delete task instead.</i></p></td>
  86. </tr>
  87. <tr valign="top">
  88. <td><a href="dependset.html">Dependset</a></td>
  89. <td><p>The dependset task compares a set of source files with a set of target
  90. files. If any of the source files is more recent than any of
  91. the target files, all of the target files are removed. </p></td>
  92. </tr>
  93. <tr valign="top">
  94. <td><a href="ear.html">Ear</a></td>
  95. <td><p>An extension of the <a href="jar.html">Jar</a> task with special
  96. treatment for files that should end up in an Enterprise Application archive.</p></td>
  97. </tr>
  98. <tr valign="top">
  99. <td><a href="echo.html">Echo</a></td>
  100. <td><p>Echoes a message to System.out or a file.</p></td>
  101. </tr>
  102. <tr valign="top">
  103. <td><a href="exec.html">Exec</a></td>
  104. <td><p>Executes a system command. When the <i>os</i> attribute is specified, then
  105. the command is only executed when Ant is run on one of the specified operating
  106. systems.</p></td>
  107. </tr>
  108. <tr valign="top">
  109. <td><a href="fail.html">Fail</a></td>
  110. <td><p>Exits the current build (just throwing a BuildException), optionally printing additional information.</p></td>
  111. </tr>
  112. <tr valign="top">
  113. <td><a href="filter.html">Filter</a></td>
  114. <td><p>Sets a token filter for this project or read multiple token filter from
  115. an input file and sets these as filters.
  116. Token filters are used by all tasks that perform file copying operations
  117. through the Project commodity methods.</p></td>
  118. </tr>
  119. <tr valign="top">
  120. <td><a href="fixcrlf.html">FixCRLF</a></td>
  121. <td><p>Modifies a file to add or remove tabs, carriage returns, linefeeds, and
  122. EOF characters.</p></td>
  123. </tr>
  124. <tr valign="top">
  125. <td><a href="genkey.html">GenKey</a></td>
  126. <td><p>Generates a key in keystore.</p></td>
  127. </tr>
  128. <tr valign="top">
  129. <td><a href="get.html">Get</a></td>
  130. <td><p>Gets a file from a URL.</p></td>
  131. </tr>
  132. <tr valign="top">
  133. <td><a href="gunzip.html">GUnzip</a></td>
  134. <td><p>Expands a GZip file.</p></td>
  135. </tr>
  136. <tr valign="top">
  137. <td><a href="gzip.html">GZip</a></td>
  138. <td><p>GZips a file.</p></td>
  139. </tr>
  140. <tr valign="top">
  141. <td><a href="jar.html">Jar</a></td>
  142. <td><p>Jars a set of files.</p></td>
  143. </tr>
  144. <tr valign="top">
  145. <td><a href="java.html">Java</a></td>
  146. <td><p>Executes a Java class within the running (Ant) VM or forks another VM if
  147. specified.</p></td>
  148. </tr>
  149. <tr valign="top">
  150. <td><a href="javac.html">Javac</a></td>
  151. <td><p>Compiles a source tree within the running (Ant) VM.</p></td>
  152. </tr>
  153. <tr valign="top">
  154. <td><a href="javadoc.html">Javadoc/<i>Javadoc2</i></a></td>
  155. <td><p>Generates code documentation using the javadoc tool.</p>
  156. <p><i>The Javadoc2 task is deprecated. Use the Javadoc task
  157. instead.</i></p></td>
  158. </tr>
  159. <tr valign="top">
  160. <td><a href="mail.html">Mail</a></td>
  161. <td><p>A task to send SMTP email.</p></td>
  162. </tr>
  163. <tr valign="top">
  164. <td><a href="mkdir.html">Mkdir</a></td>
  165. <td><p>Creates a directory. Also non-existent parent directories are created, when
  166. necessary.</p></td>
  167. </tr>
  168. <tr valign="top">
  169. <td><a href="move.html">Move</a></td>
  170. <td><p>Moves a file to a new file or directory, or sets of files to
  171. a new directory.</p></td>
  172. </tr>
  173. <tr valign="top">
  174. <td><a href="parallel.html">Parallel</a></td>
  175. <td><p>Parallel is a container task - it can contain other Ant tasks. Each nested
  176. task within the parallel task will be executed in its own thread. </p> </td>
  177. </tr>
  178. <tr valign="top">
  179. <td><a href="patch.html">Patch</a></td>
  180. <td><p>Applies a diff file to originals.</p></td>
  181. </tr>
  182. <tr valign="top">
  183. <td><a href="pathconvert.html">PathConvert</a></td>
  184. <td><p>Converts a nested path, path reference, or fileset reference to the form usable on a
  185. specified platform and stores the result in a given property.</p></td>
  186. </tr>
  187. <tr valign="top">
  188. <td><a href="property.html">Property</a></td>
  189. <td><p>Sets a property (by name and value), or set of properties (from file or
  190. resource) in the project.</p></td>
  191. </tr>
  192. <tr valign="top">
  193. <td><a href="recorder.html">Record</a></td>
  194. <td><p>A recorder is a listener to the current build process that records the
  195. output to a file.</p></td>
  196. </tr>
  197. <tr valign="top">
  198. <td><a href="rename.html"><i>Rename</i></a></td>
  199. <td><p><i>This task has been deprecated. Use the Move task instead.</i></p></td>
  200. </tr>
  201. <tr valign="top">
  202. <td><a href="replace.html">Replace</a></td>
  203. <td><p>Replace is a directory based task for replacing the occurrence of a given string with another string
  204. in selected file.</p></td>
  205. </tr>
  206. <tr valign="top">
  207. <td><a href="rmic.html">Rmic</a></td>
  208. <td><p>Runs the rmic compiler for a certain class.</p></td>
  209. </tr>
  210. <tr valign="top">
  211. <td><a href="sequential.html">Sequential</a></td>
  212. <td><p>Sequential is a container task - it can contain other Ant tasks. The nested
  213. tasks are simply executed in sequence. Sequential's primary use is to support
  214. the sequential execution of a subset of tasks within the
  215. <a href="parallel.html">parallel</a> task</p></td>
  216. </tr>
  217. <tr valign="top">
  218. <td><a href="signjar.html">SignJar</a></td>
  219. <td><p>Signs a jar or zip file with the javasign command line tool.</p></td>
  220. </tr>
  221. <tr valign="top">
  222. <td><a href="sleep.html">Sleep</a></td>
  223. <td><p> A task for sleeping a short period of time, useful when a build or
  224. deployment process requires an interval between tasks.</p></td>
  225. </tr>
  226. <tr valign="top">
  227. <td><a href="sql.html">Sql</a></td>
  228. <td><p>Executes a series of SQL statements via JDBC to a database. Statements
  229. can either be read in from a text file using the <i>src</i> attribute or from
  230. between the enclosing SQL tags.</p></td>
  231. </tr>
  232. <tr valign="top">
  233. <td><a href="style.html">Style</a></td>
  234. <td><p>Process a set of documents via XSLT.</p></td>
  235. </tr>
  236. <tr valign="top">
  237. <td><a href="tar.html">Tar</a></td>
  238. <td><p>Creates a tar archive.</p></td>
  239. </tr>
  240. <tr valign="top">
  241. <td><a href="taskdef.html">Taskdef</a></td>
  242. <td><p>Adds a task definition to the current project, such that this new task can be
  243. used in the current project.</p></td>
  244. </tr>
  245. <tr valign="top">
  246. <td><a href="touch.html">Touch</a></td>
  247. <td><p>Changes the modification time of a file and possibly creates it at
  248. the same time.</p></td>
  249. </tr>
  250. <tr valign="top">
  251. <td><a href="tstamp.html">TStamp</a></td>
  252. <td><p>Sets the <code>DSTAMP</code>, <code>TSTAMP</code>, and
  253. <code>TODAY</code> properties in the current project based on
  254. the current date and time.</p></td>
  255. </tr>
  256. <tr valign="top">
  257. <td><a href="typedef.html">Typedef</a></td>
  258. <td><p>Adds a data type definition to the current project, such that this
  259. new type can be used in the current project.</p></td>
  260. </tr>
  261. <tr valign="top">
  262. <td><a href="unzip.html">Unjar</a></td>
  263. <td><p>Unzips a jarfile.</p></td>
  264. </tr>
  265. <tr valign="top">
  266. <td><a href="untar.html">Untar</a></td>
  267. <td><p>Untars a tarfile.</p></td>
  268. </tr>
  269. <tr valign="top">
  270. <td><a href="unzip.html">Unwar</a></td>
  271. <td><p>Unzips a warfile.</p></td>
  272. </tr>
  273. <tr valign="top">
  274. <td><a href="unzip.html">Unzip</a></td>
  275. <td><p>Unzips a zipfile.</p></td>
  276. </tr>
  277. <tr valign="top">
  278. <td><a href="uptodate.html">Uptodate</a></td>
  279. <td><p>Sets a property if a target files are more up to date than a set of
  280. Source files.</p></td>
  281. </tr>
  282. <tr valign="top">
  283. <td><a href="war.html">War</a></td>
  284. <td><p>An extension of the <a href="jar.html">Jar</a> task with special
  285. treatment for files that should end up in the <code>WEB-INF/lib</code>,
  286. <code>WEB-INF/classes</code> or <code>WEB-INF</code> directories of the
  287. Web Application Archive.</p></td>
  288. </tr>
  289. <tr valign="top">
  290. <td><a href="zip.html">Zip</a></td>
  291. <td><p>Creates a zipfile.</p></td>
  292. </tr>
  293. </table>
  294. <hr>
  295. <p align="center">Copyright &copy; 2000,2001 Apache Software Foundation. All rights
  296. Reserved.</p>
  297. </body>
  298. </html>