|
- <!DOCTYPE html>
- <!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- https://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- -->
- <html lang="en">
-
- <head>
- <link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
- <title>Dirname Task</title>
- </head>
-
- <body>
-
- <h2 id="echo">Dirname</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
- (or directory) 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>
- <p><strong>Note</strong>: This is not the same as the UNIX <code>dirname</code> command, which is
- defined as "strip non-directory suffix from filename". <code><dirname></code> determines the
- full directory path of the specified file.</p>
- <h3>Parameters</h3>
- <table class="attr">
- <tr>
- <th scope="col">Attribute</th>
- <th scope="col">Description</th>
- <th scope="col">Required</th>
- </tr>
- <tr>
- <td>file</td>
- <td>The path to take the dirname of.</td>
- <td>Yes</td>
- </tr>
- <tr>
- <td>property</td>
- <td>The name of the property to set.</td>
- <td>Yes</td>
- </tr>
- </table>
-
- <h3>Examples</h3>
-
- <p>Set <code>antfile.dir</code> to the directory path for <samp>${ant.file}</samp>.</p>
- <pre><dirname property="antfile.dir" file="${ant.file}"/></pre>
-
- <p>Set <code>foo.dirname</code> to the project's <var>basedir</var>.</p>
- <pre><dirname property="foo.dirname" file="foo.txt"/></pre>
-
- </body>
- </html>
|