diff options
Diffstat (limited to 'framework/src/ant/apache-ant-1.9.6/manual/Tasks/sync.html')
| -rw-r--r-- | framework/src/ant/apache-ant-1.9.6/manual/Tasks/sync.html | 166 |
1 files changed, 166 insertions, 0 deletions
diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sync.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sync.html new file mode 100644 index 00000000..1d34aeef --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/sync.html @@ -0,0 +1,166 @@ +<!-- + 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. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Sync Task</title> +</head> + +<body> + +<h2><a name="get">Sync</a></h2> +<p><em>Since Apache Ant 1.6</em></p> +<h3>Description</h3> + +<p>Synchronize a target directory from the files defined in one or +more <a href="../Types/resources.html#collection">Resource Collection</a>s.</p> + +<p>Any file in the target directory that has not been matched by at +least one of the nested resource collections gets removed. I.e. if you exclude a +file in your sources and a file of that name is present in the target +dir, it will get removed from the target.</p> + +<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">todir</td> + <td valign="top">the target directory to sync with the resource collections</td> + <td align="center" valign="top">Yes</td> + </tr> + <tr> + <td valign="top">overwrite</td> + <td valign="top">Overwrite existing files even if the destination + files are newer.</td> + <td valign="top" align="center">No; defaults to false.</td> + </tr> + <tr> + <td valign="top">includeEmptyDirs</td> + <td valign="top">Copy any empty directories included in the + resource collection(s).<br/> + <b>Note</b> this attribute also controls the behavior for any + nested <preserveintarget> element. If this attribute is + false (the default) empty directories that only exist in the + target directory will be removed even if they are matched by + the patterns of <preserveintarget>. This can be + overridden by <preserveintarget>'s + preserveEmptyDirs attribute. + </td> + <td valign="top" align="center">No; defaults to false.</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">If is set to false, log a warning message, but do not stop the build, + when one of the nested filesets points to a directory that + doesn't exist. + </td> + <td valign="top" align="center">No; defaults to true.</td> + </tr> + <tr> + <td valign="top">verbose</td> + <td valign="top">Log the files that are being copied.</td> + <td valign="top" align="center">No; defaults to false.</td> + </tr> + <tr> + <td valign="top">granularity</td> + <td valign="top">The number of milliseconds leeway to give before + deciding a file is out of date. This is needed because not every + file system supports tracking the last modified time to the + millisecond level. Default is 0 milliseconds, or 2 seconds on DOS + systems. This can also be useful if source and target files live + on separate machines with clocks being out of sync. <em>since Ant + 1.6.2</em>.</td> + <td valign="top" align="center">No.</td> + </tr> +</table> + +<h3>Parameters specified as nested elements</h3> + +<h4>fileset or any other resource collection</h4> +<p><a href="../Types/resources.html#collection">Resource +Collection</a>s are used to select groups of files to copy.</p> +<p>Prior to Ant 1.7 only <code><fileset></code> has been +supported as a nested element.</p> + +<h4>preserveInTarget</h4> + +<p><em>Since Ant 1.7.0</em></p> + +<p>Specifies files or directories that should be kept in the target +directory even if they are not present in one of the source +directories.</p> + +<p>This nested element is like a <a +href="../Types/fileset.html">FileSet</a> except that it doesn't +support the dir attribute and the usedefaultexcludes attribute +defaults to false.</p> + +<h5>Additional Parameters</h5> +<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">preserveEmptyDirs</td> + <td valign="top">Overrules the includeEmptydirs setting for + directories matched by this element. If you want to preserve + empty directories that are not in your source directory you can + either set the task's includeemptydirs attribute or this one. + If the two attribute values conflict, this attribute + "wins".</td> + <td align="center" valign="top">No, defaults to the value of the + task's includeemptydirs attribute</td> + </tr> +</table> + +<h3>Examples</h3> + +<blockquote><pre> +<sync todir="site"> + <fileset dir="generated-site"/> +</sync> +</pre></blockquote> +<p>overwrites all files in <em>site</em> with newer files from +<em>generated-site</em>, deletes files from <em>site</em> that are not +present in <em>generated-site</em>.</p> + +<blockquote><pre> +<sync todir="site"> + <fileset dir="generated-site"/> + <preserveintarget> + <include name="**/CVS/**"/> + </preserveintarget> +</sync> +</pre></blockquote> +<p>overwrites all files in <em>site</em> with newer files from +<em>generated-site</em>, deletes files from <em>site</em> that are not +present in <em>generated-site</em> but keeps all files in any +<em>CVS</em> sub-directory.</p> + + + +</body> +</html> + |