ant/docs/manual/CoreTasks/dirname.html
Stefan Bodewig 895ef094bb Make sure <basename> and <dirname> don't break property immutability
rules.

Minor corrections to their documentation.


git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@272341 13f79535-47bb-0310-9956-ffa450edef68
2002-04-10 13:47:46 +00:00

55 lines
1.5 KiB
HTML

<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
<title>Dirname Task</title>
</head>
<body>
<h2><a name="echo">Dirname</a></h2>
<h3>Description</h3>
<p>
Task to determine the directory path of a specified file.
</p>
<p>
When this task executes, it will set the specified property to the
value of the specified file up to, but not including, the last path
element. If the specified file is a path that ends in a filename,
the filename will be dropped. If the specified file is just a filename,
the directory will be the current directory.
</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">file</td>
<td valign="top">The path to take the basename of.</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
<td valign="top">property</td>
<td valign="top">The name of the property to set.</td>
<td valign="top" align="center">Yes</td>
</tr>
</table>
<h3>Examples</h3>
<pre> &lt;dirname property=&quot;antfile.dir&quot; file=&quot;${ant.file}&quot;/&gt;</pre>
will set <code>antfile.dir</code> to the directory path for
<code>${ant.file}</code>.
<pre> &lt;dirname property=&quot;foo.dirname&quot; file=&quot;foo.txt&quot;/&gt;</pre>
will set <code>foo.dirname</code> to the project's basedir.</p>
<hr>
<p align="center">Copyright &copy; 2002 Apache Software Foundation.
All rights Reserved.</p>
</body>
</html>