Chmod Task

Chmod

Description

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 argument for the chmod command.

See the section on directory based tasks, on how the inclusion/exclusion of files works, and how to write patterns.

This task holds an implicit FileSet and supports all of FileSet's attributes and nested elements directly. More sets can be specified using nested <fileset> or <dirset> (since Ant 1.6) elements.

Starting with Ant 1.6, this task also supports nested filelists.

Parameters

Attribute	Description	Required
file	the file or single directory of which the permissions must be changed.	exactly one of the two or nested `<fileset/list>` elements.
dir	the directory which holds the files whose permissions must be changed.	exactly one of the two or nested `<fileset/list>` elements.
perm	the new permissions.	Yes
includes	comma- or space-separated list of patterns of files that must be included.	No
excludes	comma- or space-separated list of patterns of files that must be excluded. No files (except default excludes) are excluded when omitted.	No
defaultexcludes	indicates whether default excludes should be used or not ("yes"/"no"). Default excludes are used when omitted.	No
parallel	process all specified files using a single `chmod` command. Defaults to true.	No
type	One of file, dir or both. If set to file, only the permissions of plain files are going to be changed. If set to dir, only the directories are considered. Note: The type attribute does not apply to nested dirsets - dirsets always implicitly assume type to be dir.	No, default is file
maxparallel	Limit the amount of parallelism by passing at most this many sourcefiles at once. Set it to <= 0 for unlimited. Defaults to unlimited. Since Ant 1.6.	No
verbose	Whether to print a summary after execution or not. Defaults to `false`. Since Ant 1.6.	No

Examples

<chmod file="${dist}/start.sh" perm="ugo+rx"/>

makes the "start.sh" file readable and executable for anyone on a UNIX system.

<chmod file="${dist}/start.sh" perm="700"/>

makes the "start.sh" file readable, writable and executable only for the owner on a UNIX system.

<chmod dir="${dist}/bin" perm="ugo+rx" 
       includes="**/*.sh"/>

makes all ".sh" files below ${dist}/bin readable and executable for anyone on a UNIX system.

<chmod perm="g+w">
  <fileset dir="shared/sources1">
    <exclude name="**/trial/**"/>
  </fileset>
  <fileset refid="other.shared.sources"/>
</chmod>

makes all files below shared/sources1 (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 id other.shared.sources get the same permissions.

<chmod perm="go-rwx" type="file">
  <fileset dir="/web">
    <include name="**/*.cgi"/>
    <include name="**/*.old"/>
  </fileset>
  <dirset dir="/web">
    <include name="**/private_*"/>
  </dirset>
</chmod>

keeps non-owners from touching cgi scripts, files with a .old extension or directories begining with private_. A directory ending in .old or a file begining with private_ would remain unaffected.