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>
|
|
|
|
|
|
|
|
|
|
<h2><a name="chmod">Chmod</a></h2>
|
|
|
|
|
<h3>Description</h3>
|
2003-03-14 16:01:04 +00:00
|
|
|
<p>Changes the permissions of a file or all files inside specified
|
2003-05-23 13:40:37 +00:00
|
|
|
directories. Right now it has effect only under Unix or NonStop Kernel (Tandem).
|
2001-02-13 12:32:01 +00:00
|
|
|
The permissions are also UNIX style, like the argument for the chmod command.</p>
|
|
|
|
|
<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>
|
2003-06-24 09:16:10 +00:00
|
|
|
|
|
|
|
|
<p>This task holds an implicit <a
|
|
|
|
|
href="../CoreTypes/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 Ant 1.6</em>) elements. </p>
|
2003-05-19 12:18:08 +00:00
|
|
|
|
|
|
|
|
<p>Starting with Ant 1.6, this task also supports nested <a
|
|
|
|
|
href="../CoreTypes/filelist.html">filelist</a>s.</p>
|
|
|
|
|
|
2005-09-28 18:48:41 +00:00
|
|
|
<p>Starting with Ant 1.7, this task supports arbitrary <a
|
|
|
|
|
href="../CoreTypes/resources.html#collection">Resource Collection</a>s
|
|
|
|
|
as nested elements.</p>
|
|
|
|
|
|
2005-03-22 11:11:48 +00:00
|
|
|
<p>By default this task will use a single invocation of the underlying
|
|
|
|
|
chmod 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) 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>
|
|
|
|
|
|
2008-11-14 15:12:26 +00:00
|
|
|
<p>By default this task won't do anything unless it detects it is
|
|
|
|
|
running on a Unix system. If you know for sure that you have a
|
|
|
|
|
"chmod" executable on your PATH that is command line compatible with
|
|
|
|
|
the Unix command, you can use the task's os attribute and set its
|
|
|
|
|
value to your current os.</p>
|
|
|
|
|
|
2001-02-13 12:32:01 +00:00
|
|
|
<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 file or single directory of which the permissions
|
|
|
|
|
must be changed.</td>
|
2003-05-21 08:55:35 +00:00
|
|
|
<td valign="top" valign="middle" rowspan="2">exactly one of the two or nested <code><fileset/list></code> elements.</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">dir</td>
|
|
|
|
|
<td valign="top">the directory which holds the files whose permissions
|
2008-08-21 13:58:19 +00:00
|
|
|
must be changed.<br/>
|
|
|
|
|
<b>Note:</b> for backwards compatibility
|
|
|
|
|
reasons <code><chmod dir="some-dir"/></code> will
|
|
|
|
|
only change the permissions on "some-dir" but not recurse into
|
|
|
|
|
it, unless you also specify any patterns.</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">perm</td>
|
|
|
|
|
<td valign="top">the new permissions.</td>
|
|
|
|
|
<td valign="top" align="center">Yes</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">includes</td>
|
2002-06-22 23:38:38 +00:00
|
|
|
<td valign="top">comma- or space-separated list of patterns of files that must be
|
2001-08-30 13:23:14 +00:00
|
|
|
included.</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
<td valign="top" align="center">No</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">excludes</td>
|
2002-06-22 23:38:38 +00:00
|
|
|
<td valign="top">comma- or space-separated list of patterns of files that must be
|
2001-02-13 12:32:01 +00:00
|
|
|
excluded. No files (except default excludes) are excluded when omitted.</td>
|
|
|
|
|
<td valign="top" align="center">No</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">defaultexcludes</td>
|
|
|
|
|
<td valign="top">indicates whether default excludes should be used or not
|
|
|
|
|
("yes"/"no"). Default excludes are used when omitted.</td>
|
|
|
|
|
<td valign="top" align="center">No</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">parallel</td>
|
|
|
|
|
<td valign="top">process all specified files using a single
|
|
|
|
|
<code>chmod</code> command. Defaults to true.</td>
|
|
|
|
|
<td valign="top" align="center">No</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">type</td>
|
|
|
|
|
<td valign="top">One of <i>file</i>, <i>dir</i> or
|
|
|
|
|
<i>both</i>. If set to <i>file</i>, only the permissions of
|
|
|
|
|
plain files are going to be changed. If set to <i>dir</i>, only
|
2003-06-24 09:16:10 +00:00
|
|
|
the directories are considered.<br>
|
|
|
|
|
<strong>Note:</strong> The type attribute does not apply to
|
|
|
|
|
nested <i>dirset</i>s - <i>dirset</i>s always implicitly
|
|
|
|
|
assume type to be <i>dir</i>.</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
<td align="center" valign="top">No, default is <i>file</i></td>
|
|
|
|
|
</tr>
|
2003-05-19 12:18:08 +00:00
|
|
|
<tr>
|
|
|
|
|
<td valign="top">maxparallel</td>
|
|
|
|
|
<td valign="top">Limit the amount of parallelism by passing at
|
|
|
|
|
most this many sourcefiles at once. Set it to <= 0 for
|
|
|
|
|
unlimited. Defaults to unlimited. <em>Since Ant 1.6.</em></td>
|
|
|
|
|
<td align="center" valign="top">No</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">verbose</td>
|
|
|
|
|
<td valign="top">Whether to print a summary after execution or not.
|
|
|
|
|
Defaults to <code>false</code>. <em>Since Ant 1.6.</em></td>
|
|
|
|
|
<td align="center" valign="top">No</td>
|
|
|
|
|
</tr>
|
2008-11-14 15:12:26 +00:00
|
|
|
<tr>
|
|
|
|
|
<td valign="top">os</td>
|
|
|
|
|
<td valign="top">list of Operating Systems on which the command may be
|
|
|
|
|
executed.</td>
|
|
|
|
|
<td align="center" valign="top">No</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">osfamily</td>
|
|
|
|
|
<td valign="top">OS family as used in
|
|
|
|
|
the <a href="conditions.html#os"><os></a> condition.</td>
|
|
|
|
|
<td align="center" valign="top">No - defaults to "unix"</td>
|
|
|
|
|
</tr>
|
2001-02-13 12:32:01 +00:00
|
|
|
</table>
|
|
|
|
|
<h3>Examples</h3>
|
2005-03-09 11:30:12 +00:00
|
|
|
<blockquote><pre>
|
|
|
|
|
<chmod file="${dist}/start.sh" perm="ugo+rx"/>
|
|
|
|
|
</pre></blockquote>
|
2001-02-13 12:32:01 +00:00
|
|
|
<p>makes the "start.sh" file readable and executable for anyone on a
|
|
|
|
|
UNIX system.</p>
|
2005-03-09 11:30:12 +00:00
|
|
|
<blockquote><pre>
|
|
|
|
|
<chmod file="${dist}/start.sh" perm="700"/>
|
|
|
|
|
</pre></blockquote>
|
2003-08-24 14:24:53 +00:00
|
|
|
<p>makes the "start.sh" file readable, writable and executable only for the owner on a
|
|
|
|
|
UNIX system.</p>
|
2001-02-13 12:32:01 +00:00
|
|
|
<blockquote>
|
|
|
|
|
<pre>
|
2003-06-24 09:16:10 +00:00
|
|
|
<chmod dir="${dist}/bin" perm="ugo+rx"
|
|
|
|
|
includes="**/*.sh"/>
|
2001-02-13 12:32:01 +00:00
|
|
|
</pre>
|
|
|
|
|
</blockquote>
|
|
|
|
|
<p>makes all ".sh" files below <code>${dist}/bin</code>
|
|
|
|
|
readable and executable for anyone on a UNIX system.</p>
|
|
|
|
|
<blockquote>
|
|
|
|
|
<pre>
|
|
|
|
|
<chmod perm="g+w">
|
|
|
|
|
<fileset dir="shared/sources1">
|
|
|
|
|
<exclude name="**/trial/**"/>
|
|
|
|
|
</fileset>
|
|
|
|
|
<fileset refid="other.shared.sources"/>
|
|
|
|
|
</chmod>
|
|
|
|
|
</pre>
|
|
|
|
|
</blockquote>
|
|
|
|
|
<p>makes all files below <code>shared/sources1</code> (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 <code>id</code> <code>other.shared.sources</code> get the same
|
|
|
|
|
permissions.</p>
|
2003-06-24 09:16:10 +00:00
|
|
|
|
|
|
|
|
<blockquote>
|
|
|
|
|
<pre>
|
|
|
|
|
<chmod perm="go-rwx" type="file">
|
|
|
|
|
<fileset dir="/web">
|
|
|
|
|
<include name="**/*.cgi"/>
|
|
|
|
|
<include name="**/*.old"/>
|
|
|
|
|
</fileset>
|
|
|
|
|
<dirset dir="/web">
|
|
|
|
|
<include name="**/private_*"/>
|
|
|
|
|
</dirset>
|
|
|
|
|
</chmod>
|
|
|
|
|
</pre>
|
2005-03-09 11:30:12 +00:00
|
|
|
</blockquote>
|
2003-06-24 09:16:10 +00:00
|
|
|
|
|
|
|
|
<p>keeps non-owners from touching cgi scripts, files with a <code>.old</code>
|
2004-11-16 08:12:35 +00:00
|
|
|
extension or directories beginning with <code>private_</code>. A directory
|
|
|
|
|
ending in <code>.old</code> or a file beginning with private_ would remain
|
2003-06-24 09:16:10 +00:00
|
|
|
unaffected.</p>
|
|
|
|
|
|
2006-09-11 04:33:25 +00:00
|
|
|
|
2007-01-07 15:24:29 +00:00
|
|
|
<h3>Note on maxparallel 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 <em>maxparallel</em> attribute. For example
|
|
|
|
|
when using AIX and the limit is reached, the system responds
|
|
|
|
|
with a warning: "Warning:
|
|
|
|
|
UNIXProcess.forkAndExec native error: The parameter or environment lists
|
|
|
|
|
are too long". 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>
|
|
|
|
|
|
