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.

exec.html 17 KiB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413
  1. <!--
  2. Licensed to the Apache Software Foundation (ASF) under one or more
  3. contributor license agreements. See the NOTICE file distributed with
  4. this work for additional information regarding copyright ownership.
  5. The ASF licenses this file to You under the Apache License, Version 2.0
  6. (the "License"); you may not use this file except in compliance with
  7. the License. You may obtain a copy of the License at
  8. http://www.apache.org/licenses/LICENSE-2.0
  9. Unless required by applicable law or agreed to in writing, software
  10. distributed under the License is distributed on an "AS IS" BASIS,
  11. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. See the License for the specific language governing permissions and
  13. limitations under the License.
  14. -->
  15. <html>
  16. <head>
  17. <meta http-equiv="Content-Language" content="en-us">
  18. <link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
  19. <title>Exec Task</title>
  20. <link rel="stylesheet" type="text/css" href="../stylesheets/antmanual.css">
  21. </head>
  22. <body>
  23. <h2><a name="exec">Exec</a></h2>
  24. <h3>Description</h3>
  25. <p>Executes a system command. When the <i>os</i> attribute is specified, then
  26. the command is only executed when Ant is run on one of the specified operating
  27. systems.</p>
  28. <p>Note that you cannot interact with the forked program, the only way
  29. to send input to it is via the input and inputstring attributes. Also note that
  30. since Ant 1.6, any attempt to read input in the forked program will receive an
  31. EOF (-1). This is a change from Ant 1.5, where such an attempt would block.</p>
  32. <h4>Windows Users</h4>
  33. <p>The <code>&lt;exec&gt;</code> task delegates to <code>Runtime.exec</code> which in turn
  34. apparently calls <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dllproc/base/createprocess.asp">
  35. <code>::CreateProcess</code></a>. It is the latter Win32 function that defines
  36. the exact semantics of the call. In particular, if you do not put a file extension
  37. on the executable, only ".EXE" files are looked for, not ".COM", ".CMD" or other file
  38. types listed in the environment variable PATHEXT. That is only used by the shell.
  39. </p>
  40. <h4>Cygwin Users</h4>
  41. <p>In general the <code>&lt;exec&gt;</code> task will not understand paths such as /bin/sh for
  42. the executable parameter. This is because the Java VM in which Ant is running is a
  43. Windows executable and is not aware of Cygwin conventions.
  44. </p>
  45. <h4>OpenVMS Users</h4>
  46. <p>The command specified using <code>executable</code> and
  47. <code>&lt;arg&gt;</code> elements is executed exactly as specified
  48. inside a temporary DCL script. This has some implications:
  49. <ul>
  50. <li>paths have to be written in VMS style</li>
  51. <li>if your <code>executable</code> points to a DCL script remember to
  52. prefix it with an <code>@</code>-sign
  53. (e.g. <code>executable="@[FOO]BAR.COM"</code>), just as you would in a
  54. DCL script</li>
  55. </ul>
  56. For <code>&lt;exec&gt;</code> to work in an environment with a Java VM
  57. older than version 1.4.1-2 it is also <i>required</i> that the logical
  58. <code>JAVA$FORK_SUPPORT_CHDIR</code> is set to <code>TRUE</code> in
  59. the job table (see the <i>JDK Release Notes</i>).</p>
  60. <p>Please note that the Java VM provided by HP doesn't follow OpenVMS'
  61. conventions of exit codes. If you run a Java VM with this task, the
  62. task may falsely claim that an error occurred (or silently ignore an
  63. error). Don't use this task to run <code>JAVA.EXE</code>, use a
  64. <code>&lt;java&gt;</code> task with the <code>fork</code> attribute
  65. set to <code>true</code> instead as this task will follow the VM's
  66. interpretation of exit codes.</p>
  67. <h4>RedHat S/390 Users</h4>
  68. <p>It has been <a
  69. href="http://listserv.uark.edu/scripts/wa.exe?A1=ind0404&L=vmesa-l#33">reported
  70. on the VMESA-LISTSERV</a> that shell scripts invoked via the Ant Exec
  71. task must have their interpreter specified, i.e., the scripts must
  72. start with something like:
  73. <blockquote>
  74. <pre>
  75. #!/bin/bash
  76. </pre>
  77. </blockquote>
  78. or the task will fail as follows:
  79. <blockquote>
  80. <pre>
  81. [exec] Warning: UNIXProcess.forkAndExec native error: Exec format error
  82. [exec] Result: 255
  83. </pre>
  84. </blockquote>
  85. </p>
  86. <h3>Parameters</h3>
  87. <table border="1" cellpadding="2" cellspacing="0">
  88. <tr>
  89. <td valign="top"><b>Attribute</b></td>
  90. <td valign="top"><b>Description</b></td>
  91. <td align="center" valign="top"><b>Required</b></td>
  92. </tr>
  93. <tr>
  94. <td valign="top">command</td>
  95. <td valign="top">the command to execute with all command line
  96. arguments. <b>deprecated, use executable and nested
  97. <code>&lt;arg&gt;</code> elements instead</b>.</td>
  98. <td align="center" rowspan="2">Exactly one of the two.</td>
  99. </tr>
  100. <tr>
  101. <td valign="top">executable</td>
  102. <td valign="top">the command to execute without any command line
  103. arguments.</td>
  104. </tr>
  105. <tr>
  106. <td valign="top">dir</td>
  107. <td valign="top">the directory in which the command should be executed.</td>
  108. <td align="center" valign="top">No</td>
  109. </tr>
  110. <tr>
  111. <td valign="top">os</td>
  112. <td valign="top">list of Operating Systems on which the command may be
  113. executed. If the current OS's name is contained in this list, the command will
  114. be executed. The OS's name is determined by the Java Virtual machine and is set
  115. in the &quot;os.name&quot; system property.
  116. </td>
  117. <td align="center" valign="top">No</td>
  118. </tr>
  119. <tr>
  120. <td valign="top">osfamily</td>
  121. <td valign="top">OS family as used in the &lt;os&gt; condition.
  122. <em>since Ant 1.7</em></td>
  123. <td align="center" valign="top">No</td>
  124. </tr>
  125. <tr>
  126. <td valign="top">spawn</td>
  127. <td valign="top">whether or not you want the command to be spawned<br>
  128. Default is false.<br>
  129. If you spawn a command, its output will not be logged by ant.<br>
  130. The input, output, error, and result property settings are not active when spawning a process.<br>
  131. <em>since Ant 1.6</em>
  132. </td>
  133. <td align="center" valign="top">No</td>
  134. </tr>
  135. <tr>
  136. <td valign="top">output</td>
  137. <td valign="top">Name of a file to which to write the output. If the error stream
  138. is not also redirected to a file or property, it will appear in this output.</td>
  139. <td align="center" valign="top">No</td>
  140. </tr>
  141. <tr>
  142. <td valign="top">error</td>
  143. <td valign="top">The file to which the standard error of the
  144. command should be redirected. <em>since Ant 1.6</em></td>
  145. <td align="center" valign="top">No</td>
  146. </tr>
  147. <tr>
  148. <td valign="top">logError</td>
  149. <td valign="top">This attribute is used when you wish to see error output in Ant's
  150. log and you are redirecting output to a file/property. The error
  151. output will not be included in the output file/property. If you
  152. redirect error with the &quot;error&quot; or &quot;errorProperty&quot;
  153. attributes, this will have no effect. <em>since Ant 1.6</em></td>
  154. <td align="center" valign="top">No</td>
  155. </tr>
  156. <tr>
  157. <td valign="top">append</td>
  158. <td valign="top">Whether output and error files should be appended to or overwritten.
  159. Defaults to false.</td>
  160. <td align="center" valign="top">No</td>
  161. </tr>
  162. <tr>
  163. <td valign="top">outputproperty</td>
  164. <td valign="top">The name of a property in which the output of the
  165. command should be stored. Unless the error stream is redirected to a separate
  166. file or stream, this property will include the error output.</td>
  167. <td align="center" valign="top">No</td>
  168. </tr>
  169. <tr>
  170. <td valign="top">errorproperty</td>
  171. <td valign="top">The name of a property in which the standard error of the
  172. command should be stored. <em>since Ant 1.6</em></td>
  173. <td align="center" valign="top">No</td>
  174. </tr>
  175. <tr>
  176. <td valign="top">input</td>
  177. <td valign="top">A file from which the executed command's standard input
  178. is taken. This attribute is mutually exclusive with the
  179. inputstring attribute. <em>since Ant 1.6</em></td>
  180. <td align="center" valign="top">No</td>
  181. </tr>
  182. <tr>
  183. <td valign="top">inputstring</td>
  184. <td valign="top">A string which serves as the input stream for the
  185. executed command. This attribute is mutually exclusive with the
  186. input attribute. <em>since Ant 1.6</em></td>
  187. <td align="center" valign="top">No</td>
  188. </tr>
  189. <tr>
  190. <td valign="top">resultproperty</td>
  191. <td valign="top">the name of a property in which the return code of the
  192. command should be stored. Only of interest if failonerror=false.</td>
  193. <td align="center" valign="top">No</td>
  194. </tr>
  195. <tr>
  196. <td valign="top">timeout</td>
  197. <td valign="top">Stop the command if it doesn't finish within the
  198. specified time (given in milliseconds).</td>
  199. <td align="center" valign="top">No</td>
  200. </tr>
  201. <tr>
  202. <td valign="top">failonerror</td>
  203. <td valign="top">Stop the buildprocess if the command exits with a
  204. return code signaling failure. Defaults to false.</td>
  205. <td align="center" valign="top">No</td>
  206. </tr>
  207. <tr>
  208. <td valign="top">failifexecutionfails</td>
  209. <td valign="top">Stop the build if we can't start the program.
  210. Defaults to true. </td>
  211. <td align="center" valign="top">No</td>
  212. </tr> <tr>
  213. <td valign="top">newenvironment</td>
  214. <td valign="top">Do not propagate old environment when new environment
  215. variables are specified.</td>
  216. <td align="center" valign="top">No, default is <i>false</i></td>
  217. </tr>
  218. <tr>
  219. <td valign="top">vmlauncher</td>
  220. <td valign="top">Run command using the Java VM's execution facilities
  221. where available. If set to false the underlying OS's shell,
  222. either directly or through the antRun scripts, will be used.
  223. Under some operating systems, this gives access to facilities
  224. not normally available through the VM including, under Windows,
  225. being able to execute scripts, rather than their associated
  226. interpreter. If you want to specify the name of the
  227. executable as a relative path to the directory given by the
  228. dir attribute, it may become necessary to set vmlauncher to
  229. false as well.</td>
  230. <td align="center" valign="top">No, default is <i>true</i></td>
  231. </tr>
  232. <tr>
  233. <td valign="top">resolveexecutable</td>
  234. <td valign="top">When this attribute is true, the name of the executable
  235. is resolved firstly against the project basedir and
  236. if that does not exist, against the execution
  237. directory if specified. On Unix systems, if you only
  238. want to allow execution of commands in the user's path,
  239. set this to false. <em>since Ant 1.6</em></td>
  240. <td align="center" valign="top">No, default is <i>false</i></td>
  241. </tr>
  242. <tr>
  243. <td valign="top">searchpath</td>
  244. <td valign="top">When this attribute is true, then
  245. system path environment variables will
  246. be searched when resolving the location
  247. of the executable. <em>since Ant 1.6.3</em></td>
  248. <td align="center" valign="top">No, default is <i>false</i></td>
  249. </tr>
  250. </table>
  251. <h3>Examples</h3>
  252. <blockquote>
  253. <pre>
  254. &lt;exec dir=&quot;${src}&quot; executable=&quot;cmd.exe&quot; os=&quot;Windows 2000&quot; output=&quot;dir.txt&quot;&gt;
  255. &lt;arg line=&quot;/c dir&quot;/&gt;
  256. &lt;/exec&gt;</pre>
  257. </blockquote>
  258. <h3>Parameters specified as nested elements</h3>
  259. <h4>arg</h4>
  260. <p>Command line arguments should be specified as nested
  261. <code>&lt;arg&gt;</code> elements. See <a
  262. href="../using.html#arg">Command line arguments</a>.</p>
  263. <h4><a name="env">env</a></h4>
  264. <p>It is possible to specify environment variables to pass to the
  265. system command via nested <code>&lt;env&gt;</code> elements.</p>
  266. <table border="1" cellpadding="2" cellspacing="0">
  267. <tr>
  268. <td valign="top"><b>Attribute</b></td>
  269. <td valign="top"><b>Description</b></td>
  270. <td align="center" valign="top"><b>Required</b></td>
  271. </tr>
  272. <tr>
  273. <td valign="top">key</td>
  274. <td valign="top">
  275. The name of the environment variable.
  276. <br/>
  277. <em>Note: (Since Ant 1.7)</em>
  278. For windows, the name is case-insensitive.
  279. </td>
  280. <td align="center" valign="top">Yes</td>
  281. </tr>
  282. <tr>
  283. <td valign="top">value</td>
  284. <td valign="top">The literal value for the environment variable.</td>
  285. <td align="center" rowspan="3">Exactly one of these.</td>
  286. </tr>
  287. <tr>
  288. <td valign="top">path</td>
  289. <td valign="top">The value for a PATH like environment
  290. variable. You can use ; or : as path separators and Ant will
  291. convert it to the platform's local conventions.</td>
  292. </tr>
  293. <tr>
  294. <td valign="top">file</td>
  295. <td valign="top">The value for the environment variable. Will be
  296. replaced by the absolute filename of the file by Ant.</td>
  297. </tr>
  298. </table>
  299. <a name="redirector"><h4>redirector</h4></a>
  300. <i><b>Since Ant 1.6.2</b></i>
  301. <p>A nested <a href="../CoreTypes/redirector.html">I/O Redirector</a>
  302. can be specified. In general, the attributes of the redirector behave
  303. as the corresponding attributes available at the task level. The most
  304. notable peculiarity stems from the retention of the &lt;exec&gt;
  305. attributes for backwards compatibility. Any file mapping is done
  306. using a <CODE>null</CODE> sourcefile; therefore not all
  307. <a href="../CoreTypes/mapper.html">Mapper</a> types will return
  308. results. When no results are returned, redirection specifications
  309. will fall back to the task level attributes. In practice this means that
  310. defaults can be specified for input, output, and error output files.
  311. </p>
  312. <h3>Errors and return codes</h3>
  313. By default the return code of a <code>&lt;exec&gt;</code> is ignored; when you set
  314. <code>failonerror="true"</code> then any return code signaling failure
  315. (OS specific) causes the build to fail. Alternatively, you can set
  316. <code>resultproperty</code> to the name of a property and have it assigned to
  317. the result code (barring immutability, of course).
  318. <p>
  319. If the attempt to start the program fails with an OS dependent error code,
  320. then <code>&lt;exec&gt;</code> halts the build unless <code>failifexecutionfails</code>
  321. is set to <code>false</code>. You can use that to run a program if it exists, but
  322. otherwise do nothing.
  323. <p>
  324. What do those error codes mean? Well, they are OS dependent. On Windows
  325. boxes you have to look at
  326. <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/debug/base/system_error_codes__0-499_.asp">
  327. the documentation</a>; error code 2 means 'no such program', which usually means
  328. it is not on the path. Any time you see such an error from any Ant task, it is
  329. usually not an Ant bug, but some configuration problem on your machine.
  330. <h3>Examples</h3>
  331. <blockquote><pre>
  332. &lt;exec executable=&quot;emacs&quot;&gt;
  333. &lt;env key=&quot;DISPLAY&quot; value=&quot;:1.0&quot;/&gt;
  334. &lt;/exec&gt;
  335. </pre></blockquote>
  336. <p>starts <code>emacs</code> on display 1 of the X Window System.</p>
  337. <blockquote><pre>
  338. &lt;property environment=&quot;env&quot;/&gt;
  339. &lt;exec ... &gt;
  340. &lt;env key=&quot;PATH&quot; path=&quot;${env.PATH}:${basedir}/bin&quot;/&gt;
  341. &lt;/exec&gt;
  342. </pre></blockquote>
  343. <p>adds <code>${basedir}/bin</code> to the <code>PATH</code> of the
  344. system command.</p>
  345. <blockquote><pre>
  346. &lt;property name="browser" location="C:/Program Files/Internet Explorer/iexplore.exe"/&gt;
  347. &lt;property name="file" location="ant/docs/manual/index.html"/&gt;
  348. &lt;exec executable="${browser}" spawn="true"&gt;
  349. &lt;arg value="${file}"/&gt;
  350. &lt;/exec&gt;
  351. </pre></blockquote>
  352. <p>Starts the <i>${browser}</i> with the specified <i>${file}</i> and end the
  353. Ant process. The browser will remain.</p>
  354. <blockquote><pre>
  355. &lt;exec executable=&quot;cat&quot;&gt;
  356. &lt;redirector outputproperty=&quot;redirector.out&quot;
  357. errorproperty=&quot;redirector.err&quot;
  358. inputstring=&quot;blah before blah&quot;&gt;
  359. &lt;inputfilterchain&gt;
  360. &lt;replacestring from=&quot;before&quot; to=&quot;after&quot;/&gt;
  361. &lt;/inputfilterchain&gt;
  362. &lt;outputmapper type=&quot;merge&quot; to=&quot;redirector.out&quot;/&gt;
  363. &lt;errormapper type=&quot;merge&quot; to=&quot;redirector.err&quot;/&gt;
  364. &lt;/redirector&gt;
  365. &lt;/exec&gt;
  366. </pre></blockquote>
  367. Sends the string &quot;blah before blah&quot; to the &quot;cat&quot; executable,
  368. using an <a href="../CoreTypes/filterchain.html">&lt;inputfilterchain&gt;</a>
  369. to replace &quot;before&quot; with &quot;after&quot; on the way in.
  370. Output is sent to the file &quot;redirector.out&quot; and stored
  371. in a property of the same name. Similarly, error output is sent to
  372. a file and a property, both named &quot;redirector.err&quot;.
  373. <p><b>Note:</b> do not try to specify arguments using
  374. a simple arg-element and separate them by spaces. This results in
  375. only a single argument containing the entire string.</p>
  376. <p>
  377. <b>Timeouts: </b> If a timeout is specified, when it is reached the
  378. sub process is killed and a message printed to the log. The return
  379. value of the execution will be "-1", which will halt the build if
  380. <tt>failonerror=true</tt>, but be ignored otherwise.
  381. </body>
  382. </html>