2006-09-11 04:19:00 +00:00
|
|
|
<!--
|
|
|
|
|
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
|
|
|
|
|
|
|
|
|
|
http://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.
|
|
|
|
|
-->
|
2001-02-13 12:32:01 +00:00
|
|
|
<html>
|
|
|
|
|
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="Content-Language" content="en-us">
|
2005-04-29 18:58:16 +00:00
|
|
|
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
|
2002-02-03 22:00:42 +00:00
|
|
|
<title>Chmod Task</title>
|
2001-02-13 12:32:01 +00:00
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
2018-01-22 23:52:21 +01:00
|
|
|
<h2 id="chmod">Chmod</h2>
|
2001-02-13 12:32:01 +00:00
|
|
|
<h3>Description</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>Changes the permissions of a file or all files inside specified directories. Right now it has
|
|
|
|
|
effect only under Unix or NonStop Kernel (Tandem). The permissions are also UNIX style, like the
|
2018-03-10 20:17:33 +01:00
|
|
|
argument for the <kbd>chmod</kbd> command.</p>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>See the section on <a href="../dirtasks.html#directorybasedtasks">directory based tasks</a>, on
|
|
|
|
|
how the inclusion/exclusion of files works, and how to write patterns.</p>
|
|
|
|
|
|
|
|
|
|
<p>This task holds an implicit <a href="../Types/fileset.html">FileSet</a> and supports all of
|
|
|
|
|
FileSet's attributes and nested elements directly. More sets can be specified using
|
|
|
|
|
nested <code><fileset></code> or <code><dirset></code> (<em>since Apache Ant 1.6</em>)
|
|
|
|
|
elements.</p>
|
|
|
|
|
|
|
|
|
|
<p><em>Since Ant 1.6</em>, this task also supports
|
|
|
|
|
nested <a href="../Types/filelist.html">filelist</a>s.</p>
|
|
|
|
|
|
|
|
|
|
<p><em>Since Ant 1.7</em>, this task supports
|
2018-03-05 17:35:30 +01:00
|
|
|
arbitrary <a href="../Types/resources.html#collection">resource collections</a> as nested
|
2018-02-28 07:58:59 +01:00
|
|
|
elements.</p>
|
|
|
|
|
|
2018-03-10 20:17:33 +01:00
|
|
|
<p>By default this task will use a single invocation of the underlying <kbd>chmod</kbd> command.
|
2018-02-28 07:58:59 +01:00
|
|
|
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 <var>maxparallel</var>
|
|
|
|
|
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) and your operating system, so you'll have to
|
|
|
|
|
experiment a little. POSIX recommends command line length limits of at least 4096 characters, this
|
|
|
|
|
may give you an approximation for the number you could use as initial value for these
|
|
|
|
|
experiments.</p>
|
|
|
|
|
|
|
|
|
|
<p>By default this task won't do anything unless it detects it is running on a Unix system. If you
|
2018-03-10 20:17:33 +01:00
|
|
|
know for sure that you have a <kbd>chmod</kbd> executable on your <code>PATH</code> that is
|
2018-02-28 07:58:59 +01:00
|
|
|
command line compatible with the Unix 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>
|
2016-04-17 17:30:07 +02:00
|
|
|
|
2001-02-13 12:32:01 +00:00
|
|
|
<h3>Parameters</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
<table class="attr">
|
2001-02-13 12:32:01 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<th>Attribute</th>
|
|
|
|
|
<th>Description</th>
|
|
|
|
|
<th>Required</th>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>file</td>
|
|
|
|
|
<td>the file or single directory of which the permissions must be changed.</td>
|
2018-03-01 23:14:03 +01:00
|
|
|
<td rowspan="2">Exactly one of the two, unless
|
|
|
|
|
nested <code><fileset|filelist|dirset></code> elements are specified</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>dir</td>
|
|
|
|
|
<td class="left">the directory which holds the files whose permissions must be
|
|
|
|
|
changed.<br/><strong>Note</strong>: for backwards compatibility reasons <code><chmod
|
|
|
|
|
dir="some-dir"/></code> will only change the permissions on <samp>some-dir</samp> but not
|
|
|
|
|
recurse into it, unless you also specify any patterns.</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>perm</td>
|
|
|
|
|
<td>the new permissions.</td>
|
|
|
|
|
<td>Yes</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>includes</td>
|
|
|
|
|
<td>comma- or space-separated list of patterns of files that must be included.</td>
|
|
|
|
|
<td>No; defaults to all (<q>**</q>)</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>excludes</td>
|
|
|
|
|
<td>comma- or space-separated list of patterns of files that must be excluded.</td>
|
|
|
|
|
<td>No; defaults to default excludes or none if <var>defaultexcludes</var> is <q>no</q></td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>defaultexcludes</td>
|
|
|
|
|
<td>indicates whether default excludes should be used or not (<q>yes|no</q>).</td>
|
|
|
|
|
<td>No; defaults to <q>yes</q></td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>parallel</td>
|
2018-03-10 20:17:33 +01:00
|
|
|
<td>process all specified files using a single <kbd>chmod</kbd> command.</td>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>No; defaults to <q>true</q></td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
2003-05-19 12:18:08 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2003-05-19 12:18:08 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>verbose</td>
|
|
|
|
|
<td>Whether to print a summary after execution or not. <em>Since Ant 1.6</em>.</td>
|
|
|
|
|
<td>No; defaults to <q>false</q></td>
|
2003-05-19 12:18:08 +00:00
|
|
|
</tr>
|
2008-11-14 15:12:26 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>os</td>
|
|
|
|
|
<td>list of Operating Systems on which the command may be executed.</td>
|
|
|
|
|
<td>No</td>
|
2008-11-14 15:12:26 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>osfamily</td>
|
|
|
|
|
<td>OS family as used in the <a href="conditions.html#os"><os></a> condition.</td>
|
|
|
|
|
<td>No; defaults to <q>unix</q></td>
|
2008-11-14 15:12:26 +00:00
|
|
|
</tr>
|
2001-02-13 12:32:01 +00:00
|
|
|
</table>
|
|
|
|
|
<h3>Examples</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
<pre><chmod file="${dist}/start.sh" perm="ugo+rx"/></pre>
|
|
|
|
|
<p>makes the <samp>start.sh</samp> file readable and executable for anyone on a UNIX system.</p>
|
|
|
|
|
|
|
|
|
|
<pre><chmod file="${dist}/start.sh" perm="700"/></pre>
|
|
|
|
|
<p>makes the <samp>start.sh</samp> file readable, writable and executable only for the owner on a
|
2003-08-24 14:24:53 +00:00
|
|
|
UNIX system.</p>
|
2018-02-28 07:58:59 +01:00
|
|
|
|
2001-02-13 12:32:01 +00:00
|
|
|
<pre>
|
2018-01-22 23:52:21 +01:00
|
|
|
<chmod dir="${dist}/bin" perm="ugo+rx"
|
2018-02-28 07:58:59 +01:00
|
|
|
includes="**/*.sh"/></pre>
|
|
|
|
|
<p>makes all <samp>.sh</samp> files below <samp>${dist}/bin</samp> readable and executable for
|
|
|
|
|
anyone on a UNIX system.</p>
|
2018-02-09 06:54:03 +01:00
|
|
|
|
2001-02-13 12:32:01 +00:00
|
|
|
<pre>
|
|
|
|
|
<chmod perm="g+w">
|
|
|
|
|
<fileset dir="shared/sources1">
|
|
|
|
|
<exclude name="**/trial/**"/>
|
|
|
|
|
</fileset>
|
|
|
|
|
<fileset refid="other.shared.sources"/>
|
2018-02-28 07:58:59 +01:00
|
|
|
</chmod></pre>
|
|
|
|
|
<p>makes all files below <samp>shared/sources1</samp> (except those below any directory named trial)
|
|
|
|
|
writable for members of the same group on a UNIX system. In addition all files belonging to a
|
|
|
|
|
FileSet with <var>id</var> <samp>other.shared.sources</samp> get the same permissions.</p>
|
|
|
|
|
|
2003-06-24 09:16:10 +00:00
|
|
|
<pre>
|
|
|
|
|
<chmod perm="go-rwx" type="file">
|
|
|
|
|
<fileset dir="/web">
|
|
|
|
|
<include name="**/*.cgi"/>
|
|
|
|
|
<include name="**/*.old"/>
|
|
|
|
|
</fileset>
|
|
|
|
|
<dirset dir="/web">
|
|
|
|
|
<include name="**/private_*"/>
|
|
|
|
|
</dirset>
|
2018-02-28 07:58:59 +01:00
|
|
|
</chmod></pre>
|
|
|
|
|
<p>keeps non-owners from touching cgi scripts, files with a <samp>.old</samp> extension or
|
|
|
|
|
directories beginning with <samp>private_</samp>. A directory ending in <samp>.old</samp> or a file
|
|
|
|
|
beginning with <samp>private_</samp> would remain unaffected.</p>
|
|
|
|
|
|
|
|
|
|
<h3>Note on <var>maxparallel</var> attribute</h3>
|
|
|
|
|
<p>Some shells have a limit of the number of characters that a command line may contain. This
|
|
|
|
|
maximum limit varies from shell to shell and from operating system to operating system. If one has
|
|
|
|
|
a large number of files to change mode on, consider using the <var>maxparallel</var> attribute. For
|
|
|
|
|
example when using AIX and the limit is reached, the system responds with a warning: <code>"Warning:
|
|
|
|
|
UNIXProcess.forkAndExec native error: The parameter or environment lists are too long"</code>. A
|
|
|
|
|
value of about 300 seems to result in a command line that is acceptable.</p>
|
2001-02-13 12:32:01 +00:00
|
|
|
</body>
|
|
|
|
|
</html>
|
