manual/Tasks/attrib.html - ant - Git at Google

 <!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>Apache Ant User Manual</title>
 </head>

 <body>

 <h2 id="attrib">Attrib</h2>
 <p><em>Since Apache Ant 1.6</em>.</p>
 <h3>Description</h3>

 <p>Changes the attributes of a file or all files inside specified directories.  Right now it has
 effect only under Windows. Each of the 4 possible permissions has its own attribute, matching the
 arguments for the attrib command.</p>

 <p><a href="../Types/fileset.html">FileSet</a>s, <a href="../Types/dirset.html">DirSet</a>s
 or <a href="../Types/filelist.html">FileList</a>s can be specified using
 nested <code>&lt;fileset&gt;</code>, <code>&lt;dirset&gt;</code> and <code>&lt;filelist&gt;</code>
 elements.</p>

 <p><em>Since Ant 1.7</em>, this task supports
 arbitrary <a href="../Types/resources.html#collection">resource collections</a> as nested
 elements.</p>

 <!--p>By default this task will use a single invocation of the underlying
 attrib command.  If you are working on a large number of files this
 may result in a command line that is too long for your operating
 system.  If you encounter such problems, you should set the
 maxparallel attribute of this task to a non-zero value.  The number to
 use highly depends on the length of your file names (the depth of your
 directory tree), so you'll have to experiment a little.</p-->

 <p>By default this task won't do anything unless it detects it is running on a Windows system.  If
 you know for sure that you have a <code>attrib</code> executable on your <code>PATH</code> that is
 command line compatible with the Windows command, you can use the task's <var>os</var> attribute and
 set its value to your current OS.</p>

 <p>See the <a href="setpermissions.html">setpermissions</a> task for a platform independent
 alternative.</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 file or directory of which the permissions must be changed.</td>
     <td>Yes, or nested <code>&lt;fileset/list&gt;</code> elements</td>
   </tr>
   <tr>
     <td>readonly</td>
     <td>the readonly permission.</td>
     <td rowspan="4">At least one of the four</td>
   </tr>
   <tr>
     <td>archive</td>
     <td class="left">the archive permission.</td>
   </tr>
   <tr>
     <td>system</td>
     <td class="left">the system permission.</td>
   </tr>
   <tr>
     <td>hidden</td>
     <td class="left">the hidden permission.</td>
   </tr>
   <tr>
     <td>type</td>
     <td>One of <q>file</q>, <q>dir</q> or <q>both</q>. If set to <q>file</q>, only the permissions
       of plain files are going to be changed.  If set to <q>dir</q>, only the directories are
       considered.<br/>
       <strong>Note</strong>: The type attribute does not apply to
       nested <code>dirset</code>s&mdash;<code>dirset</code>s always implicitly assume type to
       be <q>dir</q>.</td>
     <td>No; default is <q>file</q></td>
   </tr>
   <tr>
     <td>verbose</td>
     <td>Whether to print a summary after execution or not.</td>
     <td>No; defaults to <q>false</q></td>
   </tr>
   <!--tr>
     <td>parallel</td>
     <td>process all specified files using a single
       <kbd>chmod</kbd> command.</td>
     <td>No; defaults to <q>true</q></td>
   </tr>
   <tr>
     <td>maxparallel</td>
     <td>Limit the amount of parallelism by passing at
       most this many sourcefiles at once.  Set it to negative integer for
       unlimited.  <em>Since Ant 1.6</em>.</td>
     <td>No, defaults to unlimited</td>
   </tr-->
   <tr>
     <td>os</td>
     <td>list of Operating Systems on which the command may be executed.</td>
     <td>No</td>
   </tr>
   <tr>
     <td>osfamily</td>
     <td>OS family as used in the <a href="../Tasks/conditions.html#os">&lt;os&gt;</a>
       condition.</td>
     <td>No; defaults to <q>windows</q></td>
   </tr>
 </table>

 <h3>Examples</h3>

 <p>Make the <code>run.bat</code> file read-only and hidden.</p>
 <pre>&lt;attrib file=&quot;${dist}/run.bat&quot; readonly=&quot;true&quot; hidden=&quot;true&quot;/&gt;</pre>

 <p>Make all <samp>.xml</samp> files below <samp>${meta.inf}</samp> readable.</p>
 <pre>&lt;attrib readonly=&quot;false&quot;&gt;
   &lt;fileset dir=&quot;${meta.inf}&quot; includes=&quot;**/*.xml&quot;/&gt;
 &lt;/attrib&gt;</pre>

 <p>Make all files below <samp>shared/sources1</samp> (except those below any directory
 named <samp>trial</samp>) read-only and archived. In addition all files belonging to a FileSet
 with <var>id</var> <samp>other.shared.sources</samp> get the same attributes.</p>
 <pre>
 &lt;attrib readonly=&quot;true&quot; archive=&quot;true&quot;&gt;
   &lt;fileset dir=&quot;shared/sources1&quot;&gt;
     &lt;exclude name=&quot;**/trial/**&quot;/&gt;
   &lt;/fileset&gt;
   &lt;fileset refid=&quot;other.shared.sources&quot;/&gt;
 &lt;/attrib&gt;</pre>

 </body>
 </html>
	<!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>Apache Ant User Manual</title>
	</head>

	<body>

	<h2 id="attrib">Attrib</h2>
	<p><em>Since Apache Ant 1.6</em>.</p>
	<h3>Description</h3>

	<p>Changes the attributes of a file or all files inside specified directories. Right now it has
	effect only under Windows. Each of the 4 possible permissions has its own attribute, matching the
	arguments for the attrib command.</p>

	<p><a href="../Types/fileset.html">FileSet</a>s, <a href="../Types/dirset.html">DirSet</a>s
	or <a href="../Types/filelist.html">FileList</a>s can be specified using
	nested <code><fileset></code>, <code><dirset></code> and <code><filelist></code>
	elements.</p>

	<p><em>Since Ant 1.7</em>, this task supports
	arbitrary <a href="../Types/resources.html#collection">resource collections</a> as nested
	elements.</p>

	<!--p>By default this task will use a single invocation of the underlying
	attrib command. If you are working on a large number of files this
	may result in a command line that is too long for your operating
	system. If you encounter such problems, you should set the
	maxparallel attribute of this task to a non-zero value. The number to
	use highly depends on the length of your file names (the depth of your
	directory tree), so you'll have to experiment a little.</p-->

	<p>By default this task won't do anything unless it detects it is running on a Windows system. If
	you know for sure that you have a <code>attrib</code> executable on your <code>PATH</code> that is
	command line compatible with the Windows command, you can use the task's <var>os</var> attribute and
	set its value to your current OS.</p>

	<p>See the <a href="setpermissions.html">setpermissions</a> task for a platform independent
	alternative.</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 file or directory of which the permissions must be changed.</td>
	<td>Yes, or nested <code><fileset/list></code> elements</td>
	</tr>
	<tr>
	<td>readonly</td>
	<td>the readonly permission.</td>
	<td rowspan="4">At least one of the four</td>
	</tr>
	<tr>
	<td>archive</td>
	<td class="left">the archive permission.</td>
	</tr>
	<tr>
	<td>system</td>
	<td class="left">the system permission.</td>
	</tr>
	<tr>
	<td>hidden</td>
	<td class="left">the hidden permission.</td>
	</tr>
	<tr>
	<td>type</td>
	<td>One of <q>file</q>, <q>dir</q> or <q>both</q>. If set to <q>file</q>, only the permissions
	of plain files are going to be changed. If set to <q>dir</q>, only the directories are
	considered.<br/>
	<strong>Note</strong>: The type attribute does not apply to
	nested <code>dirset</code>s—<code>dirset</code>s always implicitly assume type to
	be <q>dir</q>.</td>
	<td>No; default is <q>file</q></td>
	</tr>
	<tr>
	<td>verbose</td>
	<td>Whether to print a summary after execution or not.</td>
	<td>No; defaults to <q>false</q></td>
	</tr>
	<!--tr>
	<td>parallel</td>
	<td>process all specified files using a single
	<kbd>chmod</kbd> command.</td>
	<td>No; defaults to <q>true</q></td>
	</tr>
	<tr>
	<td>maxparallel</td>
	<td>Limit the amount of parallelism by passing at
	most this many sourcefiles at once. Set it to negative integer for
	unlimited. <em>Since Ant 1.6</em>.</td>
	<td>No, defaults to unlimited</td>
	</tr-->
	<tr>
	<td>os</td>
	<td>list of Operating Systems on which the command may be executed.</td>
	<td>No</td>
	</tr>
	<tr>
	<td>osfamily</td>
	<td>OS family as used in the <a href="../Tasks/conditions.html#os"><os></a>
	condition.</td>
	<td>No; defaults to <q>windows</q></td>
	</tr>
	</table>

	<h3>Examples</h3>

	<p>Make the <code>run.bat</code> file read-only and hidden.</p>
	<pre><attrib file="${dist}/run.bat" readonly="true" hidden="true"/></pre>

	<p>Make all <samp>.xml</samp> files below <samp>${meta.inf}</samp> readable.</p>
	<pre><attrib readonly="false">
	<fileset dir="${meta.inf}" includes="*/.xml"/>
	</attrib></pre>

	<p>Make all files below <samp>shared/sources1</samp> (except those below any directory
	named <samp>trial</samp>) read-only and archived. In addition all files belonging to a FileSet
	with <var>id</var> <samp>other.shared.sources</samp> get the same attributes.</p>
	<pre>
	<attrib readonly="true" archive="true">
	<fileset dir="shared/sources1">
	<exclude name="/trial/"/>
	</fileset>
	<fileset refid="other.shared.sources"/>
	</attrib></pre>

	</body>
	</html>