You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ant.apache.org by ma...@apache.org on 2010/10/06 23:25:35 UTC
svn commit: r1005260 [44/45] - in /ant/ivy/site/target/history/2.2.0: ./
configuration/ configuration/caches/ configuration/macrodef/
configuration/namespace/ dev/ images/ ivyfile/ js/ resolver/ samples/
settings/ settings/caches/ settings/macrodef/ se...
Added: ant/ivy/site/target/history/2.2.0/use/resolve.html
URL: http://svn.apache.org/viewvc/ant/ivy/site/target/history/2.2.0/use/resolve.html?rev=1005260&view=auto
==============================================================================
--- ant/ivy/site/target/history/2.2.0/use/resolve.html (added)
+++ ant/ivy/site/target/history/2.2.0/use/resolve.html Wed Oct 6 21:25:29 2010
@@ -0,0 +1,263 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<!--
+ 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-Type" CONTENT="text/html; charset=ISO-8859-1">
+ <script type="text/javascript">var xookiConfig = {level: 1};</script>
+
+
+<title>resolve | Apache Ivy</title>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ <link rel="stylesheet" type="text/css" href="../style/style.css" />
+ <script src="../js/jquery.pack.js" type="text/javascript"></script>
+ <script src="../js/jquery.treeview.js" type="text/javascript"></script>
+ <script type="text/javascript">
+ $(document).ready(function(){$("#treemenu").Treeview({speed: "fast",store: true});});
+ </script>
+
+<script language="javascript" type="text/javascript">xooki = {u: function(url) {return "../xooki/"+url;}};</script>
+</head>
+<body>
+
+<div id="body">
+<table id="header" summary="Navigation elements." border="0"
+ cellpadding="0" cellspacing="0" width="100%">
+ <tr>
+ <td id="home" width="30%"><a href="http://ant.apache.org/"
+ title="Apache Ant"><img src="../images/ant-group-logo.gif" alt="Apache Ant"
+ border="0" /></a></td>
+
+ <td class="product" width="70%" align="right" valign="middle"><img
+ src="../images/logo.png" alt="ivy" border="0" /></td>
+ </tr>
+</table>
+
+<table id="top-menu" summary="Navigation elements." border="0"
+ cellpadding="0" cellspacing="0" width="100%">
+ <tr>
+ <td>
+
+ <div style="float:right;margin: 0 10px;">
+ <!-- Google CSE Search Box Begins -->
+ <form id="searchbox_014292259695392975429:5y6qypnrni8" action="http://ant.apache.org/ivy/search.html">
+ <input type="hidden" name="cx" value="014292259695392975429:5y6qypnrni8" />
+ <input type="hidden" name="cof" value="FORID:11" />
+ <input name="q" type="text" size="30" />
+ <input type="submit" name="sa" value="Search" />
+ </form>
+ <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=searchbox_014292259695392975429%3A5y6qypnrni8"></script>
+<!-- Google CSE Search Box Ends -->
+ </div>
+
+ <div id="navcontainer">
+ <a href="http://ant.apache.org/">Apache Ant</a> > <a href="http://ant.apache.org/ivy/">Ivy</a> > <a href="http://ant.apache.org/ivy/history.html">History</a> > <span class="breadCrumb"><a href="../index.html" >Documentation (2.2.0)</a> > <a href="../reference.html" >Reference</a> > <a href="../ant.html" >Ant Tasks</a> > <a href="../use/resolve.html" class="current">resolve</a></span>
+ </div>
+ </td>
+ </tr>
+
+</table>
+
+<table id="content" border="0" cellpadding="0" cellspacing="0"
+ width="100%">
+ <tr>
+ <td id="sidebar-left">
+ <div class="block block-book" id="block-book-0">
+ <h2>Ivy</h2>
+
+ <div class="content"><ul id="treemenu" class="treeview"><li id="xooki-index" class="submenu"><a href="../index.html" >Documentation (2.2.0)</a><ul class="open"><li id="xooki-release-notes"><a href="../release-notes.html" >Release Notes</a></li><li id="xooki-tutorial" class="submenu"><a href="../tutorial.html" >Tutorials</a><ul class="closed"><li id="xooki-tutorial/start"><a href="../tutorial/start.html" >Quick Start</a></li><li id="xooki-tutorial/defaultconf"><a href="../tutorial/defaultconf.html" >Adjusting default settings</a></li><li id="xooki-tutorial/multiple"><a href="../tutorial/multiple.html" >Multiple Resolvers</a></li><li id="xooki-tutorial/dual"><a href="../tutorial/dual.html" >Dual Resolver</a></li><li id="xooki-tutorial/dependence"><a href="../tutorial/dependence.html" >Project dependencies</a></li><li id="xooki-tutorial/multiproject"><a href="../tutorial/multiproject.html" >Using Ivy in multiple projects environment</a></li><li id="xooki-tutorial/conf"><a hre
f="../tutorial/conf.html" >Using Ivy Module Configurations</a></li><li id="xooki-tutorial/build-repository" class="submenu"><a href="../tutorial/build-repository.html" >Building a repository</a><ul class="closed"><li id="xooki-tutorial/build-repository/basic"><a href="../tutorial/build-repository/basic.html" >Basic repository copy</a></li><li id="xooki-tutorial/build-repository/advanced"><a href="../tutorial/build-repository/advanced.html" >Using namespaces</a></li></ul></li><li id="xooki-moreexamples"><a href="../moreexamples.html" >More examples</a></li></ul></li><li id="xooki-reference" class="submenu"><a href="../reference.html" >Reference</a><ul class="open"><li id="xooki-intro" class="submenu">Introduction<ul class="closed"><li id="xooki-terminology"><a href="../terminology.html" >Terminology</a></li><li id="xooki-concept"><a href="../concept.html" >Main Concepts</a></li><li id="xooki-textual"><a href="../textual.html" >Text Conventions</a></li><li id="xooki-principle"
><a href="../principle.html" >How does it work ?</a></li><li id="xooki-bestpractices"><a href="../bestpractices.html" >Best practices</a></li><li id="xooki-install"><a href="../install.html" >Installation</a></li></ul></li><li id="xooki-settings" class="submenu"><a href="../settings.html" >Settings Files</a><ul class="closed"><li id="xooki-settings/property"><a href="../settings/property.html" >property</a></li><li id="xooki-settings/properties"><a href="../settings/properties.html" >properties</a></li><li id="xooki-settings/settings"><a href="../settings/settings.html" >settings</a></li><li id="xooki-settings/include"><a href="../settings/include.html" >include</a></li><li id="xooki-settings/classpath"><a href="../settings/classpath.html" >classpath</a></li><li id="xooki-settings/typedef"><a href="../settings/typedef.html" >typedef</a></li><li id="xooki-settings/credentials"><a href="../settings/credentials.html" >credentials</a></li><li id="xooki-settings/signers"><a href=
"../settings/signers.html" >signers</a></li><li id="xooki-settings/lock-strategies"><a href="../settings/lock-strategies.html" >lock-strategies</a></li><li id="xooki-settings/caches" class="submenu"><a href="../settings/caches.html" >caches</a><ul class="closed"><li id="xooki-settings/caches/cache" class="submenu"><a href="../settings/caches/cache.html" >cache</a><ul class="closed"><li id="xooki-settings/caches/ttl"><a href="../settings/caches/ttl.html" >ttl</a></li></ul></li></ul></li><li id="xooki-settings/latest-strategies"><a href="../settings/latest-strategies.html" >latest-strategies</a></li><li id="xooki-settings/parsers"><a href="../settings/parsers.html" >parsers</a></li><li id="xooki-settings/namespaces" class="submenu"><a href="../settings/namespaces.html" >namespaces</a><ul class="closed"><li id="xooki-settings/namespace" class="submenu"><a href="../settings/namespace.html" >namespace</a><ul class="closed"><li id="xooki-settings/namespace/rule" class="submenu"><a
href="../settings/namespace/rule.html" >rule</a><ul class="closed"><li id="xooki-settings/namespace/fromtosystem" class="submenu"><a href="../settings/namespace/fromtosystem.html" >fromsystem / tosystem</a><ul class="closed"><li id="xooki-settings/namespace/src"><a href="../settings/namespace/src.html" >src</a></li><li id="xooki-settings/namespace/dest"><a href="../settings/namespace/dest.html" >dest</a></li></ul></li></ul></li></ul></li></ul></li><li id="xooki-settings/macrodef" class="submenu"><a href="../settings/macrodef.html" >macrodef</a><ul class="closed"><li id="xooki-settings/macrodef/attribute"><a href="../settings/macrodef/attribute.html" >attribute</a></li></ul></li><li id="xooki-settings/resolvers" class="submenu"><a href="../settings/resolvers.html" >resolvers</a><ul class="closed"><li id="xooki-resolver/ivyrep"><a href="../resolver/ivyrep.html" >IvyRep Resolver</a></li><li id="xooki-resolver/ibiblio"><a href="../resolver/ibiblio.html" >IBiblio Resolver</a></l
i><li id="xooki-resolver/packager"><a href="../resolver/packager.html" >Packager resolver</a></li><li id="xooki-resolver/filesystem"><a href="../resolver/filesystem.html" >File System resolver</a></li><li id="xooki-resolver/url"><a href="../resolver/url.html" >Url Resolver</a></li><li id="xooki-resolver/chain"><a href="../resolver/chain.html" >Chain Resolver</a></li><li id="xooki-resolver/dual"><a href="../resolver/dual.html" >Dual resolver</a></li><li id="xooki-resolver/sftp"><a href="../resolver/sftp.html" >sftp resolver</a></li><li id="xooki-resolver/ssh"><a href="../resolver/ssh.html" >ssh resolver</a></li><li id="xooki-resolver/vfs"><a href="../resolver/vfs.html" >vfs</a></li></ul></li><li id="xooki-settings/conflict-managers"><a href="../settings/conflict-managers.html" >conflict-managers</a></li><li id="xooki-settings/modules" class="submenu"><a href="../settings/modules.html" >modules</a><ul class="closed"><li id="xooki-settings/module"><a href="../settings/module.ht
ml" >module</a></li></ul></li><li id="xooki-settings/outputters"><a href="../settings/outputters.html" >outputters</a></li><li id="xooki-settings/statuses" class="submenu"><a href="../settings/statuses.html" >statuses</a><ul class="closed"><li id="xooki-settings/status"><a href="../settings/status.html" >status</a></li></ul></li><li id="xooki-settings/triggers"><a href="../settings/triggers.html" >triggers</a></li><li id="xooki-settings/version-matchers"><a href="../settings/version-matchers.html" >version-matchers</a></li></ul></li><li id="xooki-ivyfile" class="submenu"><a href="../ivyfile.html" >Ivy Files</a><ul class="closed"><li id="xooki-ivyfile/info" class="submenu"><a href="../ivyfile/info.html" >info</a><ul class="closed"><li id="xooki-ivyfile/extends"><a href="../ivyfile/extends.html" >extends</a></li><li id="xooki-ivyfile/license"><a href="../ivyfile/license.html" >license</a></li><li id="xooki-ivyfile/ivyauthor"><a href="../ivyfile/ivyauthor.html" >ivyauthor</a></
li><li id="xooki-ivyfile/repository"><a href="../ivyfile/repository.html" >repository</a></li><li id="xooki-ivyfile/description"><a href="../ivyfile/description.html" >description</a></li></ul></li><li id="xooki-ivyfile/configurations" class="submenu"><a href="../ivyfile/configurations.html" >configurations</a><ul class="closed"><li id="xooki-ivyfile/conf"><a href="../ivyfile/conf.html" >conf</a></li><li id="xooki-ivyfile/include"><a href="../ivyfile/include.html" >include</a></li></ul></li><li id="xooki-ivyfile/publications" class="submenu"><a href="../ivyfile/publications.html" >publications</a><ul class="closed"><li id="xooki-ivyfile/artifact" class="submenu"><a href="../ivyfile/artifact.html" >artifact</a><ul class="closed"><li id="xooki-ivyfile/artifact-conf"><a href="../ivyfile/artifact-conf.html" >conf</a></li></ul></li></ul></li><li id="xooki-ivyfile/dependencies" class="submenu"><a href="../ivyfile/dependencies.html" >dependencies</a><ul class="closed"><li id="xooki
-ivyfile/dependency" class="submenu"><a href="../ivyfile/dependency.html" >dependency</a><ul class="closed"><li id="xooki-ivyfile/dependency-conf" class="submenu"><a href="../ivyfile/dependency-conf.html" >conf</a><ul class="closed"><li id="xooki-ivyfile/mapped"><a href="../ivyfile/mapped.html" >mapped</a></li></ul></li><li id="xooki-ivyfile/dependency-artifact" class="submenu"><a href="../ivyfile/dependency-artifact.html" >artifact</a><ul class="closed"><li id="xooki-ivyfile/dependency-artifact-conf"><a href="../ivyfile/dependency-artifact-conf.html" >conf</a></li></ul></li><li id="xooki-ivyfile/artifact-exclude" class="submenu"><a href="../ivyfile/artifact-exclude.html" >exclude</a><ul class="closed"><li id="xooki-ivyfile/artifact-exclude-conf"><a href="../ivyfile/artifact-exclude-conf.html" >conf</a></li></ul></li><li id="xooki-ivyfile/dependency-include" class="submenu"><a href="../ivyfile/dependency-include.html" >include</a><ul class="closed"><li id="xooki-ivyfile/depe
ndency-include-conf"><a href="../ivyfile/dependency-include-conf.html" >conf</a></li></ul></li></ul></li><li id="xooki-ivyfile/exclude"><a href="../ivyfile/exclude.html" >exclude</a></li><li id="xooki-ivyfile/override"><a href="../ivyfile/override.html" >override</a></li><li id="xooki-ivyfile/conflict"><a href="../ivyfile/conflict.html" >conflict</a></li></ul></li><li id="xooki-ivyfile/conflicts" class="submenu"><a href="../ivyfile/conflicts.html" >conflicts</a><ul class="closed"><li id="xooki-ivyfile/manager"><a href="../ivyfile/manager.html" >manager</a></li></ul></li></ul></li><li id="xooki-ant" class="submenu"><a href="../ant.html" >Ant Tasks</a><ul class="open"><li id="xooki-use/artifactproperty"><a href="../use/artifactproperty.html" >artifactproperty</a></li><li id="xooki-use/artifactreport"><a href="../use/artifactreport.html" >artifactreport</a></li><li id="xooki-use/buildlist"><a href="../use/buildlist.html" >buildlist</a></li><li id="xooki-use/buildnumber"><a href
="../use/buildnumber.html" >buildnumber</a></li><li id="xooki-use/cachefileset"><a href="../use/cachefileset.html" >cachefileset</a></li><li id="xooki-use/cachepath"><a href="../use/cachepath.html" >cachepath</a></li><li id="xooki-use/cleancache"><a href="../use/cleancache.html" >cleancache</a></li><li id="xooki-use/configure"><a href="../use/configure.html" >configure</a></li><li id="xooki-use/deliver"><a href="../use/deliver.html" >deliver</a></li><li id="xooki-use/findrevision"><a href="../use/findrevision.html" >findrevision</a></li><li id="xooki-use/info"><a href="../use/info.html" >info</a></li><li id="xooki-use/install"><a href="../use/install.html" >install</a></li><li id="xooki-use/listmodules"><a href="../use/listmodules.html" >listmodules</a></li><li id="xooki-use/makepom"><a href="../use/makepom.html" >makepom</a></li><li id="xooki-use/postresolvetask"><a href="../use/postresolvetask.html" >post resolve tasks</a></li><li id="xooki-use/publish"><a href="../use/pub
lish.html" >publish</a></li><li id="xooki-use/repreport"><a href="../use/repreport.html" >repreport</a></li><li id="xooki-use/resolve"><a href="../use/resolve.html" class="current">resolve</a></li><li id="xooki-use/retrieve"><a href="../use/retrieve.html" >retrieve</a></li><li id="xooki-use/report" class="submenu"><a href="../use/report.html" >report</a><ul class="closed"><li id="xooki-yed"><a href="../yed.html" >Using yEd to layout report graphs</a></li></ul></li><li id="xooki-use/settings"><a href="../use/settings.html" >settings</a></li><li id="xooki-use/var"><a href="../use/var.html" >var</a></li></ul></li><li id="xooki-standalone"><a href="../standalone.html" >Using standalone</a></li></ul></li><li id="xooki-dev" class="submenu"><a href="../dev.html" >Developer doc</a><ul class="closed"><li id="xooki-extend"><a href="../extend.html" >Extending Ivy</a></li><li id="xooki-dev/makerelease"><a href="../dev/makerelease.html" >Making a release</a></li><li id="xooki-dev/updates
ite"><a href="../dev/updatesite.html" >Updating the updatesite</a></li></ul></li></ul></li></ul></div>
+
+ <center><iframe src="http://www.apache.org/ads/buttonbar.html"
+ style="border-width:0;" frameborder="0" scrolling="no"
+ width="135" height="265"></iframe>
+ </center>
+
+ </div>
+
+ </td>
+
+ <td valign="top">
+ <div id="main">
+
+ <h1 class="title">resolve</h1>
+ <br class="xooki-br"/>The resolve task actually resolve dependencies described in an <a href="../ivyfile.html">ivy file</a>, and put the resolved dependencies in the ivy cache.<br class="xooki-br"/>If configure has not been called before resolve is called, a default configuration will be used (equivalent to call configure with no attributes).<br class="xooki-br"/><br class="xooki-br"/>After the call to this task, four properties are set in ant:
+<ul>
+<li>ivy.organisation</li>
+set to the organisation name found in the ivyfile which was used for resolve
+<li>ivy.module</li>
+set to the module name found in the ivyfile which was used for resolve
+<li>ivy.revision</li>
+set to the revision name found in the ivyfile which was used for resolve, or a generated revision name if no revision was specified in the file
+<li>ivy.resolved.configurations</li>
+set to the comma separated list of configurations resolved
+</ul>
+<b>Since 1.2:</b><br class="xooki-br"/>An additional property is set to true if the resolved dependencies are changes since the last resolve, and to false otherwise: <pre>ivy.deps.changed</pre>
+<b>Since 2.0:</b><br class="xooki-br"/>The property ivy.deps.changed will not be set (and not be computed) if you set the parameter <i>checkIfChanged</i> to false. (by default it is true to keep backward compatibility). This allow to optimize your build when you have multi-module build with multiple configurations.<br class="xooki-br"/><br class="xooki-br"/><b>Since 2.0:</b><br class="xooki-br"/>In addition, if the <i>resolveId</i> attribute has been set, the following properties are set as well:
+<ul>
+<li>ivy.organisation.${resolveId}</li>
+<li>ivy.module.${resolveId}</li>
+<li>ivy.revision.${resolveId}</li>
+<li>ivy.resolved.configurations.${resolveId}</li>
+<li>ivy.deps.changed.${resolveId}</li>
+</ul>
+
+When ivy has finished the resolve task, it outputs a summary of what has been resolved. This summary looks like this:
+<pre>
+---------------------------------------------------------------------<br class="xooki-br"/>| | modules || artifacts |<br class="xooki-br"/>| conf | number| search|dwnlded|evicted|| number|dwnlded|<br class="xooki-br"/>---------------------------------------------------------------------<br class="xooki-br"/>| default | 4 | 0 | 0 | 0 || 4 | 0 |<br class="xooki-br"/>---------------------------------------------------------------------
+</pre>
+This table gives some statistics about the dependency resolution. Each line correspond to a configuration resolved. Then the table is divided in two parts:
+<ul>
+<li>modules</li>
+<ul>
+<li>number</li>
+This is the total number of dependency modules resolved in this configuration, including transitive ones
+<li>search</li>
+This is the number of dependency modules that required a repository access. The repository access is needed if the module is not yet in cache, or if a latest version is required, or in some other cases (depending on checkModified, for instance)
+<li>dwnlded</li>
+This is the number of dependency ivy files downloaded from the repository. This number can be less than the total number of modules even with a clean cache, if no ivy file is provided for some dependencies.
+<li>evicted</li>
+This is the number of dependency module evicted by conflict managers.
+</ul>
+<li>artifacts</li>
+<ul>
+<li>number</li>
+This is the total number of artifacts resolved in the given configuration.
+<li>dwnlded</li>
+This is the number of artifacts actually downloaded from the repository.
+</ul>
+</ul>
+
+<h2>Inline mode</h2>
+<span class="since">since 1.4</span> The inline mode allow to call a resolve without an ivy file, by setting directly the module which should be resolved from the repository. It is particularly useful to install released software, like an ant task for example. When inline is set to true, the organisation module and revision attributes are used to specify which module should be resolved from the repository. <br class="xooki-br"/><br class="xooki-br"/><b>Remark:</b> if you want the standard ivy properties to be set or to reuse the results of an inline resolve by other post-resolve tasks like retrieve, cachepath, report, ..., you must set the keep attribute to true!<br class="xooki-br"/><br class="xooki-br"/><h2>Resolve mode</h2>
+<span class="since">since 2.0</span> The resolve mode allows to define how Ivy should use dependency revision constraints when performing the resolution.<br class="xooki-br"/><br class="xooki-br"/>Two modes are available:
+<ul>
+<li>default</li> In this mode the default revision constraint (expressed with the rev attribute in the <a href="../ivyfile/dependency.html">dependency</a> element) is used.
+<li>dynamic</li> In this mode the dynamic revision constraint (expressed with the revConstraint attribute in the <a href="../ivyfile/dependency.html">dependency</a> element) is used.
+</ul>
+
+<h2>Concurrency</h2>
+During resolve, Ivy creates a file in the <a href="../settings/caches.html">resolution cache</a>. The creation of this file is not aimed to support concurrency, meaning that you can't have two concurrent resolve of the same module, in the same resolution cache, with the same resolveId. <br class="xooki-br"/><br class="xooki-br"/><i>Note for developers:<br class="xooki-br"/>After the call to this task, a reference to the module descriptor resolved is put in the ant project under the id <pre>"ivy.resolved.descriptor"</pre>.</i><br class="xooki-br"/><br class="xooki-br"/><h1>Attributes</h1>
+<table class="ant">
+<thead>
+ <tr><th class="ant-att">Attribute</th><th class="ant-desc">Description</th><th class="ant-req">Required</th></tr>
+</thead>
+<tbody>
+ <tr><td>file</td><td>path to the ivy file to use for resolution</td>
+ <td>No. Defaults to ${ivy.dep.file} or nothing in inline mode</td></tr>
+
+ <tr><td>conf</td><td>a comma separated list of the configurations to resolve, or '*'. <br class="xooki-br"/><span class="since">Since 2.0</span>, you can also use '*(private)', '*(public)'. Note that when inline is true, the configuration '*' is equivalent as '*(public)'.</td><td>No. Defaults to ${ivy.configurations}</td></tr>
+
+ <tr><td>refresh</td><td>true to force Ivy to resolve dynamic revision in this resolve process, false to use cached resolved revision <span class="since">since 2.0</span></td><td>No. defaults to false</td></tr>
+
+ <tr><td>resolveMode</td><td>the resolve mode to use for this dependency resolution process <span class="since">since 2.0</span></td><td>No. defaults to using the resolve mode set in the <a href="../settings.html">settings</a></td></tr>
+
+ <tr><td>inline</td><td>true to use inline mode, false to resolve an ivy file <span class="since">since 1.4</span></td><td>No. defaults to false</td></tr>
+
+ <tr><td>keep</td><td>true to keep the results of the resolve in memory, false to discard them. When this is false, the standard ivy properties won't be set and other postresolve-tasks (like retrieve and cachepath) won't be able to resuse the results of this resolve!</td><td>No. defaults to false for an inline resolve and to true in any other case</td></tr>
+
+ <tr><td>organisation</td><td>the organisation of the module to resolve in inline mode <span class="since">since 1.4</span></td><td>Yes in inline mode, no otherwise.</td></tr>
+
+ <tr><td>module</td><td>the name of the module to resolve in inline mode <span class="since">since 1.4</span></td><td>Yes in inline mode, no otherwise.</td></tr>
+
+ <tr><td>revision</td><td>the revision constraint to apply to the module to resolve in inline mode <span class="since">since 1.4</span></td><td>No. Defaults to "latest.integration" in inline mode, nothing in standard mode.</td></tr>
+
+ <tr><td>branch</td><td>the name of the branch to resolve in inline mode <span class="since">(since 2.1.0)</span></td><td>Defaults to no branch in inline mode, nothing in standard mode.</td></tr>
+
+ <tr><td>changing</td><td>indicates that the module may change when resolving in inline mode. See <a href="../concept.html#change">cache and change management</a> for details. Ignored when resolving in standard mode. <span class="since">(since 1.4)</span></td><td>No. Defaults to false.</td></tr>
+
+ <tr><td>type</td><td>comma separated list of accepted artifact types (<span class="since">since 1.2</span>)</td><td>No. defaults to ${ivy.resolve.default.type.filter}</td></tr>
+
+ <tr><td>haltonfailure</td><td>true to halt the build on ivy failure, false to continue</td><td>No. Defaults to true</td></tr>
+
+ <tr><td>failureproperty</td><td>the name of the property to set if the resolve failed <span class="since">since 1.4</span></td><td>No. No property is set by default.</td></tr>
+
+ <tr><td>transitive</td><td>true to resolve dependencies transitively, false otherwise <span class="since">since 1.4</span></td><td>No. Defaults to true</td></tr>
+
+ <tr><td>showprogress</td><td>true to show dots while downloading, false otherwise</td><td>No. Defaults to true</td></tr>
+
+ <tr><td>validate</td><td>true to force ivy files validation against ivy.xsd, false to force no validation</td><td>No. Defaults to default ivy value (as configured in configuration file)</td></tr>
+
+ <tr><td>settingsRef</td><td>A reference to the ivy settings that must be used by this task <span class="since">(since 2.0)</span></td><td>No, 'ivy.instance' is taken by default.</td></tr>
+
+ <tr><td>resolveId</td><td>An id which can be used later to refer to the results of this resolve <span class="since">(since 2.0)</span></td><td>No, defaults to '[org]-[module]'.</td></tr>
+
+ <tr><td>log</td><td>the log setting to use during the resolve process. <span class="since">(since 2.0)</span><br/>
+Available options are:
+<ul><li>default</li> the default log settings, where all usual messages are output to the console
+<li>download-only</li> disable all usual messages but download ones. A resolve with everything in cache won't output any message.
+<li>quiet</li> disable all usual messages, making the whole resolve process quiet unless errors occur
+</ul></td><td>No, defaults to 'default'.</td></tr>
+
+ <tr><td>checkIfChanged</td><td>When set to true, the resolve will compare the result with the last resolution done on this module, with those configurations in order to define the property ivy.deps.changed. Put it to false may provides slightly better performance. <span class="since">(since 2.0)</span></td><td>No, default to 'true'</td></tr>
+
+
+</tbody>
+</table>
+<h1>Examples</h1>
+<pre>
+<ivy:resolve file="path/to/ivy.xml"/>
+</pre>
+Resolve all dependencies declared in path/to/ivy.xml file.<br class="xooki-br"/><br class="xooki-br"/><hr/>
+
+<pre>
+<ivy:resolve file="path/to/ivy.xml" transitive="false" />
+</pre>
+Same as above, but with transitive dependencies disabled.<br class="xooki-br"/><br class="xooki-br"/><hr/>
+
+<pre>
+<ivy:resolve file="path/to/ivy.xml" conf="default, test"/>
+</pre>
+Resolve the dependencies declared in the configuration default and test of the path/to/ivy.xml file.<br class="xooki-br"/><br class="xooki-br"/><hr/>
+
+<pre>
+<ivy:resolve file="path/to/ivy.xml" type="jar"/>
+</pre>
+Resolve all dependencies declared in path/to/ivy.xml file, but download only jar artifacts.<br class="xooki-br"/><br class="xooki-br"/><hr/>
+<pre>
+<ivy:resolve organisation="apache" module="commons-lang" revision="2+" inline="true" />
+</pre>
+Resolve the commons-lang module revision 2+ from the repository, with its dependencies.<br class="xooki-br"/><br class="xooki-br"/>
+ </div><!-- main -->
+ </td>
+ </tr>
+</table>
+
+<table id="footer-menu" summary="Navigation elements." border="0"
+ cellpadding="0" cellspacing="0" width="100%">
+ <tr>
+ <td align="center" valign="middle">
+ <div class="primary-links">::
+ <a href="../index.html">Home</a> ::
+ <a href="../download.html">Download</a> ::
+ <a href="../history/latest-milestone/index.html">Documentation</a> ::
+ <a href="../get-involved.html">Get Involved</a> ::
+ <a href="../search.html">Search</a> ::
+ </div>
+ </td>
+ </tr>
+</table>
+
+
+
+<div id="footer-message"></div>
+
+
+</div><!-- body -->
+</body>
+</html>
Added: ant/ivy/site/target/history/2.2.0/use/retrieve.html
URL: http://svn.apache.org/viewvc/ant/ivy/site/target/history/2.2.0/use/retrieve.html?rev=1005260&view=auto
==============================================================================
--- ant/ivy/site/target/history/2.2.0/use/retrieve.html (added)
+++ ant/ivy/site/target/history/2.2.0/use/retrieve.html Wed Oct 6 21:25:29 2010
@@ -0,0 +1,195 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<!--
+ 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-Type" CONTENT="text/html; charset=ISO-8859-1">
+ <script type="text/javascript">var xookiConfig = {level: 1};</script>
+
+
+<title>retrieve | Apache Ivy</title>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ <link rel="stylesheet" type="text/css" href="../style/style.css" />
+ <script src="../js/jquery.pack.js" type="text/javascript"></script>
+ <script src="../js/jquery.treeview.js" type="text/javascript"></script>
+ <script type="text/javascript">
+ $(document).ready(function(){$("#treemenu").Treeview({speed: "fast",store: true});});
+ </script>
+
+<script language="javascript" type="text/javascript">xooki = {u: function(url) {return "../xooki/"+url;}};</script>
+</head>
+<body>
+
+<div id="body">
+<table id="header" summary="Navigation elements." border="0"
+ cellpadding="0" cellspacing="0" width="100%">
+ <tr>
+ <td id="home" width="30%"><a href="http://ant.apache.org/"
+ title="Apache Ant"><img src="../images/ant-group-logo.gif" alt="Apache Ant"
+ border="0" /></a></td>
+
+ <td class="product" width="70%" align="right" valign="middle"><img
+ src="../images/logo.png" alt="ivy" border="0" /></td>
+ </tr>
+</table>
+
+<table id="top-menu" summary="Navigation elements." border="0"
+ cellpadding="0" cellspacing="0" width="100%">
+ <tr>
+ <td>
+
+ <div style="float:right;margin: 0 10px;">
+ <!-- Google CSE Search Box Begins -->
+ <form id="searchbox_014292259695392975429:5y6qypnrni8" action="http://ant.apache.org/ivy/search.html">
+ <input type="hidden" name="cx" value="014292259695392975429:5y6qypnrni8" />
+ <input type="hidden" name="cof" value="FORID:11" />
+ <input name="q" type="text" size="30" />
+ <input type="submit" name="sa" value="Search" />
+ </form>
+ <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=searchbox_014292259695392975429%3A5y6qypnrni8"></script>
+<!-- Google CSE Search Box Ends -->
+ </div>
+
+ <div id="navcontainer">
+ <a href="http://ant.apache.org/">Apache Ant</a> > <a href="http://ant.apache.org/ivy/">Ivy</a> > <a href="http://ant.apache.org/ivy/history.html">History</a> > <span class="breadCrumb"><a href="../index.html" >Documentation (2.2.0)</a> > <a href="../reference.html" >Reference</a> > <a href="../ant.html" >Ant Tasks</a> > <a href="../use/retrieve.html" class="current">retrieve</a></span>
+ </div>
+ </td>
+ </tr>
+
+</table>
+
+<table id="content" border="0" cellpadding="0" cellspacing="0"
+ width="100%">
+ <tr>
+ <td id="sidebar-left">
+ <div class="block block-book" id="block-book-0">
+ <h2>Ivy</h2>
+
+ <div class="content"><ul id="treemenu" class="treeview"><li id="xooki-index" class="submenu"><a href="../index.html" >Documentation (2.2.0)</a><ul class="open"><li id="xooki-release-notes"><a href="../release-notes.html" >Release Notes</a></li><li id="xooki-tutorial" class="submenu"><a href="../tutorial.html" >Tutorials</a><ul class="closed"><li id="xooki-tutorial/start"><a href="../tutorial/start.html" >Quick Start</a></li><li id="xooki-tutorial/defaultconf"><a href="../tutorial/defaultconf.html" >Adjusting default settings</a></li><li id="xooki-tutorial/multiple"><a href="../tutorial/multiple.html" >Multiple Resolvers</a></li><li id="xooki-tutorial/dual"><a href="../tutorial/dual.html" >Dual Resolver</a></li><li id="xooki-tutorial/dependence"><a href="../tutorial/dependence.html" >Project dependencies</a></li><li id="xooki-tutorial/multiproject"><a href="../tutorial/multiproject.html" >Using Ivy in multiple projects environment</a></li><li id="xooki-tutorial/conf"><a hre
f="../tutorial/conf.html" >Using Ivy Module Configurations</a></li><li id="xooki-tutorial/build-repository" class="submenu"><a href="../tutorial/build-repository.html" >Building a repository</a><ul class="closed"><li id="xooki-tutorial/build-repository/basic"><a href="../tutorial/build-repository/basic.html" >Basic repository copy</a></li><li id="xooki-tutorial/build-repository/advanced"><a href="../tutorial/build-repository/advanced.html" >Using namespaces</a></li></ul></li><li id="xooki-moreexamples"><a href="../moreexamples.html" >More examples</a></li></ul></li><li id="xooki-reference" class="submenu"><a href="../reference.html" >Reference</a><ul class="open"><li id="xooki-intro" class="submenu">Introduction<ul class="closed"><li id="xooki-terminology"><a href="../terminology.html" >Terminology</a></li><li id="xooki-concept"><a href="../concept.html" >Main Concepts</a></li><li id="xooki-textual"><a href="../textual.html" >Text Conventions</a></li><li id="xooki-principle"
><a href="../principle.html" >How does it work ?</a></li><li id="xooki-bestpractices"><a href="../bestpractices.html" >Best practices</a></li><li id="xooki-install"><a href="../install.html" >Installation</a></li></ul></li><li id="xooki-settings" class="submenu"><a href="../settings.html" >Settings Files</a><ul class="closed"><li id="xooki-settings/property"><a href="../settings/property.html" >property</a></li><li id="xooki-settings/properties"><a href="../settings/properties.html" >properties</a></li><li id="xooki-settings/settings"><a href="../settings/settings.html" >settings</a></li><li id="xooki-settings/include"><a href="../settings/include.html" >include</a></li><li id="xooki-settings/classpath"><a href="../settings/classpath.html" >classpath</a></li><li id="xooki-settings/typedef"><a href="../settings/typedef.html" >typedef</a></li><li id="xooki-settings/credentials"><a href="../settings/credentials.html" >credentials</a></li><li id="xooki-settings/signers"><a href=
"../settings/signers.html" >signers</a></li><li id="xooki-settings/lock-strategies"><a href="../settings/lock-strategies.html" >lock-strategies</a></li><li id="xooki-settings/caches" class="submenu"><a href="../settings/caches.html" >caches</a><ul class="closed"><li id="xooki-settings/caches/cache" class="submenu"><a href="../settings/caches/cache.html" >cache</a><ul class="closed"><li id="xooki-settings/caches/ttl"><a href="../settings/caches/ttl.html" >ttl</a></li></ul></li></ul></li><li id="xooki-settings/latest-strategies"><a href="../settings/latest-strategies.html" >latest-strategies</a></li><li id="xooki-settings/parsers"><a href="../settings/parsers.html" >parsers</a></li><li id="xooki-settings/namespaces" class="submenu"><a href="../settings/namespaces.html" >namespaces</a><ul class="closed"><li id="xooki-settings/namespace" class="submenu"><a href="../settings/namespace.html" >namespace</a><ul class="closed"><li id="xooki-settings/namespace/rule" class="submenu"><a
href="../settings/namespace/rule.html" >rule</a><ul class="closed"><li id="xooki-settings/namespace/fromtosystem" class="submenu"><a href="../settings/namespace/fromtosystem.html" >fromsystem / tosystem</a><ul class="closed"><li id="xooki-settings/namespace/src"><a href="../settings/namespace/src.html" >src</a></li><li id="xooki-settings/namespace/dest"><a href="../settings/namespace/dest.html" >dest</a></li></ul></li></ul></li></ul></li></ul></li><li id="xooki-settings/macrodef" class="submenu"><a href="../settings/macrodef.html" >macrodef</a><ul class="closed"><li id="xooki-settings/macrodef/attribute"><a href="../settings/macrodef/attribute.html" >attribute</a></li></ul></li><li id="xooki-settings/resolvers" class="submenu"><a href="../settings/resolvers.html" >resolvers</a><ul class="closed"><li id="xooki-resolver/ivyrep"><a href="../resolver/ivyrep.html" >IvyRep Resolver</a></li><li id="xooki-resolver/ibiblio"><a href="../resolver/ibiblio.html" >IBiblio Resolver</a></l
i><li id="xooki-resolver/packager"><a href="../resolver/packager.html" >Packager resolver</a></li><li id="xooki-resolver/filesystem"><a href="../resolver/filesystem.html" >File System resolver</a></li><li id="xooki-resolver/url"><a href="../resolver/url.html" >Url Resolver</a></li><li id="xooki-resolver/chain"><a href="../resolver/chain.html" >Chain Resolver</a></li><li id="xooki-resolver/dual"><a href="../resolver/dual.html" >Dual resolver</a></li><li id="xooki-resolver/sftp"><a href="../resolver/sftp.html" >sftp resolver</a></li><li id="xooki-resolver/ssh"><a href="../resolver/ssh.html" >ssh resolver</a></li><li id="xooki-resolver/vfs"><a href="../resolver/vfs.html" >vfs</a></li></ul></li><li id="xooki-settings/conflict-managers"><a href="../settings/conflict-managers.html" >conflict-managers</a></li><li id="xooki-settings/modules" class="submenu"><a href="../settings/modules.html" >modules</a><ul class="closed"><li id="xooki-settings/module"><a href="../settings/module.ht
ml" >module</a></li></ul></li><li id="xooki-settings/outputters"><a href="../settings/outputters.html" >outputters</a></li><li id="xooki-settings/statuses" class="submenu"><a href="../settings/statuses.html" >statuses</a><ul class="closed"><li id="xooki-settings/status"><a href="../settings/status.html" >status</a></li></ul></li><li id="xooki-settings/triggers"><a href="../settings/triggers.html" >triggers</a></li><li id="xooki-settings/version-matchers"><a href="../settings/version-matchers.html" >version-matchers</a></li></ul></li><li id="xooki-ivyfile" class="submenu"><a href="../ivyfile.html" >Ivy Files</a><ul class="closed"><li id="xooki-ivyfile/info" class="submenu"><a href="../ivyfile/info.html" >info</a><ul class="closed"><li id="xooki-ivyfile/extends"><a href="../ivyfile/extends.html" >extends</a></li><li id="xooki-ivyfile/license"><a href="../ivyfile/license.html" >license</a></li><li id="xooki-ivyfile/ivyauthor"><a href="../ivyfile/ivyauthor.html" >ivyauthor</a></
li><li id="xooki-ivyfile/repository"><a href="../ivyfile/repository.html" >repository</a></li><li id="xooki-ivyfile/description"><a href="../ivyfile/description.html" >description</a></li></ul></li><li id="xooki-ivyfile/configurations" class="submenu"><a href="../ivyfile/configurations.html" >configurations</a><ul class="closed"><li id="xooki-ivyfile/conf"><a href="../ivyfile/conf.html" >conf</a></li><li id="xooki-ivyfile/include"><a href="../ivyfile/include.html" >include</a></li></ul></li><li id="xooki-ivyfile/publications" class="submenu"><a href="../ivyfile/publications.html" >publications</a><ul class="closed"><li id="xooki-ivyfile/artifact" class="submenu"><a href="../ivyfile/artifact.html" >artifact</a><ul class="closed"><li id="xooki-ivyfile/artifact-conf"><a href="../ivyfile/artifact-conf.html" >conf</a></li></ul></li></ul></li><li id="xooki-ivyfile/dependencies" class="submenu"><a href="../ivyfile/dependencies.html" >dependencies</a><ul class="closed"><li id="xooki
-ivyfile/dependency" class="submenu"><a href="../ivyfile/dependency.html" >dependency</a><ul class="closed"><li id="xooki-ivyfile/dependency-conf" class="submenu"><a href="../ivyfile/dependency-conf.html" >conf</a><ul class="closed"><li id="xooki-ivyfile/mapped"><a href="../ivyfile/mapped.html" >mapped</a></li></ul></li><li id="xooki-ivyfile/dependency-artifact" class="submenu"><a href="../ivyfile/dependency-artifact.html" >artifact</a><ul class="closed"><li id="xooki-ivyfile/dependency-artifact-conf"><a href="../ivyfile/dependency-artifact-conf.html" >conf</a></li></ul></li><li id="xooki-ivyfile/artifact-exclude" class="submenu"><a href="../ivyfile/artifact-exclude.html" >exclude</a><ul class="closed"><li id="xooki-ivyfile/artifact-exclude-conf"><a href="../ivyfile/artifact-exclude-conf.html" >conf</a></li></ul></li><li id="xooki-ivyfile/dependency-include" class="submenu"><a href="../ivyfile/dependency-include.html" >include</a><ul class="closed"><li id="xooki-ivyfile/depe
ndency-include-conf"><a href="../ivyfile/dependency-include-conf.html" >conf</a></li></ul></li></ul></li><li id="xooki-ivyfile/exclude"><a href="../ivyfile/exclude.html" >exclude</a></li><li id="xooki-ivyfile/override"><a href="../ivyfile/override.html" >override</a></li><li id="xooki-ivyfile/conflict"><a href="../ivyfile/conflict.html" >conflict</a></li></ul></li><li id="xooki-ivyfile/conflicts" class="submenu"><a href="../ivyfile/conflicts.html" >conflicts</a><ul class="closed"><li id="xooki-ivyfile/manager"><a href="../ivyfile/manager.html" >manager</a></li></ul></li></ul></li><li id="xooki-ant" class="submenu"><a href="../ant.html" >Ant Tasks</a><ul class="open"><li id="xooki-use/artifactproperty"><a href="../use/artifactproperty.html" >artifactproperty</a></li><li id="xooki-use/artifactreport"><a href="../use/artifactreport.html" >artifactreport</a></li><li id="xooki-use/buildlist"><a href="../use/buildlist.html" >buildlist</a></li><li id="xooki-use/buildnumber"><a href
="../use/buildnumber.html" >buildnumber</a></li><li id="xooki-use/cachefileset"><a href="../use/cachefileset.html" >cachefileset</a></li><li id="xooki-use/cachepath"><a href="../use/cachepath.html" >cachepath</a></li><li id="xooki-use/cleancache"><a href="../use/cleancache.html" >cleancache</a></li><li id="xooki-use/configure"><a href="../use/configure.html" >configure</a></li><li id="xooki-use/deliver"><a href="../use/deliver.html" >deliver</a></li><li id="xooki-use/findrevision"><a href="../use/findrevision.html" >findrevision</a></li><li id="xooki-use/info"><a href="../use/info.html" >info</a></li><li id="xooki-use/install"><a href="../use/install.html" >install</a></li><li id="xooki-use/listmodules"><a href="../use/listmodules.html" >listmodules</a></li><li id="xooki-use/makepom"><a href="../use/makepom.html" >makepom</a></li><li id="xooki-use/postresolvetask"><a href="../use/postresolvetask.html" >post resolve tasks</a></li><li id="xooki-use/publish"><a href="../use/pub
lish.html" >publish</a></li><li id="xooki-use/repreport"><a href="../use/repreport.html" >repreport</a></li><li id="xooki-use/resolve"><a href="../use/resolve.html" >resolve</a></li><li id="xooki-use/retrieve"><a href="../use/retrieve.html" class="current">retrieve</a></li><li id="xooki-use/report" class="submenu"><a href="../use/report.html" >report</a><ul class="closed"><li id="xooki-yed"><a href="../yed.html" >Using yEd to layout report graphs</a></li></ul></li><li id="xooki-use/settings"><a href="../use/settings.html" >settings</a></li><li id="xooki-use/var"><a href="../use/var.html" >var</a></li></ul></li><li id="xooki-standalone"><a href="../standalone.html" >Using standalone</a></li></ul></li><li id="xooki-dev" class="submenu"><a href="../dev.html" >Developer doc</a><ul class="closed"><li id="xooki-extend"><a href="../extend.html" >Extending Ivy</a></li><li id="xooki-dev/makerelease"><a href="../dev/makerelease.html" >Making a release</a></li><li id="xooki-dev/updates
ite"><a href="../dev/updatesite.html" >Updating the updatesite</a></li></ul></li></ul></li></ul></div>
+
+ <center><iframe src="http://www.apache.org/ads/buttonbar.html"
+ style="border-width:0;" frameborder="0" scrolling="no"
+ width="135" height="265"></iframe>
+ </center>
+
+ </div>
+
+ </td>
+
+ <td valign="top">
+ <div id="main">
+
+ <h1 class="title">retrieve</h1>
+ <br class="xooki-br"/>The retrieve task copies resolved dependencies anywhere you want in your file system.<br class="xooki-br"/><br class="xooki-br"/>This is a <a href="../use/postresolvetask.html">post resolve task</a>, with all the behaviour and attributes common to all post resolve tasks.<br class="xooki-br"/><br class="xooki-br"/><span class="since">since 1.4</span> This task can even be used to synchronize the destination directory with what should actually be in according to the dependency resolution. This means that by setting sync="true", Ivy will not only copy the necessary files, but it will also remove the files which do not need to be there.<br class="xooki-br"/><br class="xooki-br"/>The synchronisation actually consists in deleting all filles and directories in the root destination directory which are not required by the retrieve.<br class="xooki-br"/><br class="xooki-br"/>The root destination directory is the the directory denoted by the first leve
l up the first token in the destination pattern.<br class="xooki-br"/>Example:<br class="xooki-br"/>pattern: lib/[conf]/[artifact].[ext]<br class="xooki-br"/>root: lib<br class="xooki-br"/><br class="xooki-br"/>
+<table class="ant">
+<thead>
+ <tr><th class="ant-att">Attribute</th><th class="ant-desc">Description</th><th class="ant-req">Required</th></tr>
+</thead>
+<tbody>
+ <tr><td>pattern</td><td>the pattern to use to copy the dependencies</td>
+ <td>No. Defaults to ${ivy.retrieve.pattern}</td></tr>
+ <tr><td>ivypattern</td><td>the pattern to use to copy the ivy files of dependencies <span class="since">since 1.3</span></td>
+ <td>No. Dependencies ivy files are not retrieved by default.</td></tr>
+ <tr><td>conf</td><td>a comma separated list of the configurations to retrieve</td>
+ <td>No. Defaults to the configurations resolved by the last resolve call, or * if no resolve was explicitly called</td></tr>
+ <tr><td>sync</td><td>true to synchronize the destination, false to just make a copy <span class="since">since 1.4</span></td>
+ <td>No. Defaults to false</td></tr>
+ <tr><td>type</td><td>comma separated list of accepted artifact types <span class="since">since 1.4</span></td>
+ <td>No. All artifact types are accepted by default.</td></tr>
+ <tr><td>overwriteMode</td><td>option to configure when the destination file should be overwritten if it exist <span class="since">(since 2.2.0)</span>. Possible values are:
+<ul><li><b>newer</b> (default)</li> overwrite the destination file if a more recent one is available (based on timestamp)
+<li><b>different</b></li> overwrite the destination file if the timestamp is different
+<li><b>always</b></li> always overwrite the destination file
+<li><b>never</b></li> never overwrite the destination file
+</ul></td><td>No. Defaults to 'newer'.</td></tr>
+ <tr><td>symlink</td><td>true to create symbolic links, false to copy the artifacts. The destination of the symbolic links depends on the value of the useOrigin attribute <span class="since">(since 2.0)</span></td><td>No. Defaults to false</td></tr>
+ <tr><td>settingsRef</td><td>A reference to the ivy settings that must be used by this task <span class="since">(since 2.0)</span></td><td>No, 'ivy.instance' is taken by default.</td></tr></tbody>
+ <tr><td>log</td><td>the log setting to use during the resolve and retrieve process. <span class="since">(since 2.0)</span><br/>
+Available options are the same as for <a href="../use/resolve.html">resolve</a> when used to trigger resolve automatically (see <a href="../use/postresolvetask.html">postresolvetask</a>), or the following for the retrieve process only:
+<ul><li><b>default</b></li> the default log settings, where all usual messages are output to the console
+<li><b>quiet</b></li> disable all usual messages, making the whole retrieve process quiet unless errors occur
+</ul></td><td>No, defaults to 'default'.</td></tr>
+</table>
+<h1>Examples</h1>
+<pre>
+<ivy:retrieve />
+</pre>
+Retrieves dependencies using default parameters. This usually retrieves all the dependencies of the last resolve call to a lib directory.<br class="xooki-br"/><br class="xooki-br"/><hr/>
+<pre>
+<ivy:retrieve pattern="${lib.dir}/[conf]/[artifact].[ext]"/>
+</pre>
+Retrieves all dependencies of the last resolve call to a lib directory, dependencies being separated in directories named by configuration, each conf directory containing corresponding artifacts without the revision.<br class="xooki-br"/>For instance, if the ivy file declares two configurations default and test, the resulting lib dir could look like this:
+<pre>
+lib<br class="xooki-br"/> default<br class="xooki-br"/> commons-lang.jar<br class="xooki-br"/> commons-logging.jar<br class="xooki-br"/> test<br class="xooki-br"/> junit.jar
+</pre>
+Note that if a dependency is required in the two configurations, it will be copied in the two directories. The download of the dependency is however only made once at resolve time.<br class="xooki-br"/><br class="xooki-br"/><hr/>
+<pre>
+<ivy:retrieve pattern="${lib.dir}/[conf]/[artifact].[ext]" sync="true" />
+</pre>
+Same as before, but with synchronisation enabled.<br class="xooki-br"/><br class="xooki-br"/>For instance, if the ivy file declares two configurations default and test, the resulting lib dir could look like this:
+<pre>
+lib<br class="xooki-br"/> default<br class="xooki-br"/> commons-lang.jar<br class="xooki-br"/> commons-logging.jar<br class="xooki-br"/> test<br class="xooki-br"/> junit.jar
+</pre>
+And now suppose commons-logging is no longer part of the dependencies of the default configuration, then a new call to retrieve will result in:
+<pre>
+lib<br class="xooki-br"/> default<br class="xooki-br"/> commons-lang.jar<br class="xooki-br"/> test<br class="xooki-br"/> junit.jar
+</pre>
+With no synchronisation, commons-logging would not have been removed by the call.<br class="xooki-br"/><br class="xooki-br"/><hr/>
+<pre>
+<ivy:retrieve pattern="${lib.dir}/[type]/[artifact]-[revision].[ext]" conf="runtime"/>
+</pre>
+Retrieves only the dependencies of the <pre>runtime</pre> configuration in directories named by artifact type. The resulting lib dir could look like this:
+<pre>
+lib<br class="xooki-br"/> jar<br class="xooki-br"/> commons-lang-1.0.jar<br class="xooki-br"/> looks-1.1.jar<br class="xooki-br"/> source<br class="xooki-br"/> looks-1.1.zip
+</pre>
+
+
+<hr/>
+<pre>
+<ivy:retrieve organisation="foo" module="bar" inline="true" pattern="${my.install.dir}/[artifact].[ext]"/>
+</pre>
+Resolves and retrieve the latest version of the module bar and its dependencies in the directory pointed by ${my.install.dir}.<br class="xooki-br"/>
+ </div><!-- main -->
+ </td>
+ </tr>
+</table>
+
+<table id="footer-menu" summary="Navigation elements." border="0"
+ cellpadding="0" cellspacing="0" width="100%">
+ <tr>
+ <td align="center" valign="middle">
+ <div class="primary-links">::
+ <a href="../index.html">Home</a> ::
+ <a href="../download.html">Download</a> ::
+ <a href="../history/latest-milestone/index.html">Documentation</a> ::
+ <a href="../get-involved.html">Get Involved</a> ::
+ <a href="../search.html">Search</a> ::
+ </div>
+ </td>
+ </tr>
+</table>
+
+
+
+<div id="footer-message"></div>
+
+
+</div><!-- body -->
+</body>
+</html>
Added: ant/ivy/site/target/history/2.2.0/use/settings.html
URL: http://svn.apache.org/viewvc/ant/ivy/site/target/history/2.2.0/use/settings.html?rev=1005260&view=auto
==============================================================================
--- ant/ivy/site/target/history/2.2.0/use/settings.html (added)
+++ ant/ivy/site/target/history/2.2.0/use/settings.html Wed Oct 6 21:25:29 2010
@@ -0,0 +1,175 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<!--
+ 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>
+ <script type="text/javascript">var xookiConfig = {level: 1};</script>
+
+
+<title>settings | Apache Ivy</title>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ <link rel="stylesheet" type="text/css" href="../style/style.css" />
+ <script src="../js/jquery.pack.js" type="text/javascript"></script>
+ <script src="../js/jquery.treeview.js" type="text/javascript"></script>
+ <script type="text/javascript">
+ $(document).ready(function(){$("#treemenu").Treeview({speed: "fast",store: true});});
+ </script>
+
+<script language="javascript" type="text/javascript">xooki = {u: function(url) {return "../xooki/"+url;}};</script>
+</head>
+<body>
+
+<div id="body">
+<table id="header" summary="Navigation elements." border="0"
+ cellpadding="0" cellspacing="0" width="100%">
+ <tr>
+ <td id="home" width="30%"><a href="http://ant.apache.org/"
+ title="Apache Ant"><img src="../images/ant-group-logo.gif" alt="Apache Ant"
+ border="0" /></a></td>
+
+ <td class="product" width="70%" align="right" valign="middle"><img
+ src="../images/logo.png" alt="ivy" border="0" /></td>
+ </tr>
+</table>
+
+<table id="top-menu" summary="Navigation elements." border="0"
+ cellpadding="0" cellspacing="0" width="100%">
+ <tr>
+ <td>
+
+ <div style="float:right;margin: 0 10px;">
+ <!-- Google CSE Search Box Begins -->
+ <form id="searchbox_014292259695392975429:5y6qypnrni8" action="http://ant.apache.org/ivy/search.html">
+ <input type="hidden" name="cx" value="014292259695392975429:5y6qypnrni8" />
+ <input type="hidden" name="cof" value="FORID:11" />
+ <input name="q" type="text" size="30" />
+ <input type="submit" name="sa" value="Search" />
+ </form>
+ <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=searchbox_014292259695392975429%3A5y6qypnrni8"></script>
+<!-- Google CSE Search Box Ends -->
+ </div>
+
+ <div id="navcontainer">
+ <a href="http://ant.apache.org/">Apache Ant</a> > <a href="http://ant.apache.org/ivy/">Ivy</a> > <a href="http://ant.apache.org/ivy/history.html">History</a> > <span class="breadCrumb"><a href="../index.html" >Documentation (2.2.0)</a> > <a href="../reference.html" >Reference</a> > <a href="../ant.html" >Ant Tasks</a> > <a href="../use/settings.html" class="current">settings</a></span>
+ </div>
+ </td>
+ </tr>
+
+</table>
+
+<table id="content" border="0" cellpadding="0" cellspacing="0"
+ width="100%">
+ <tr>
+ <td id="sidebar-left">
+ <div class="block block-book" id="block-book-0">
+ <h2>Ivy</h2>
+
+ <div class="content"><ul id="treemenu" class="treeview"><li id="xooki-index" class="submenu"><a href="../index.html" >Documentation (2.2.0)</a><ul class="open"><li id="xooki-release-notes"><a href="../release-notes.html" >Release Notes</a></li><li id="xooki-tutorial" class="submenu"><a href="../tutorial.html" >Tutorials</a><ul class="closed"><li id="xooki-tutorial/start"><a href="../tutorial/start.html" >Quick Start</a></li><li id="xooki-tutorial/defaultconf"><a href="../tutorial/defaultconf.html" >Adjusting default settings</a></li><li id="xooki-tutorial/multiple"><a href="../tutorial/multiple.html" >Multiple Resolvers</a></li><li id="xooki-tutorial/dual"><a href="../tutorial/dual.html" >Dual Resolver</a></li><li id="xooki-tutorial/dependence"><a href="../tutorial/dependence.html" >Project dependencies</a></li><li id="xooki-tutorial/multiproject"><a href="../tutorial/multiproject.html" >Using Ivy in multiple projects environment</a></li><li id="xooki-tutorial/conf"><a hre
f="../tutorial/conf.html" >Using Ivy Module Configurations</a></li><li id="xooki-tutorial/build-repository" class="submenu"><a href="../tutorial/build-repository.html" >Building a repository</a><ul class="closed"><li id="xooki-tutorial/build-repository/basic"><a href="../tutorial/build-repository/basic.html" >Basic repository copy</a></li><li id="xooki-tutorial/build-repository/advanced"><a href="../tutorial/build-repository/advanced.html" >Using namespaces</a></li></ul></li><li id="xooki-moreexamples"><a href="../moreexamples.html" >More examples</a></li></ul></li><li id="xooki-reference" class="submenu"><a href="../reference.html" >Reference</a><ul class="open"><li id="xooki-intro" class="submenu">Introduction<ul class="closed"><li id="xooki-terminology"><a href="../terminology.html" >Terminology</a></li><li id="xooki-concept"><a href="../concept.html" >Main Concepts</a></li><li id="xooki-textual"><a href="../textual.html" >Text Conventions</a></li><li id="xooki-principle"
><a href="../principle.html" >How does it work ?</a></li><li id="xooki-bestpractices"><a href="../bestpractices.html" >Best practices</a></li><li id="xooki-install"><a href="../install.html" >Installation</a></li></ul></li><li id="xooki-settings" class="submenu"><a href="../settings.html" >Settings Files</a><ul class="closed"><li id="xooki-settings/property"><a href="../settings/property.html" >property</a></li><li id="xooki-settings/properties"><a href="../settings/properties.html" >properties</a></li><li id="xooki-settings/settings"><a href="../settings/settings.html" >settings</a></li><li id="xooki-settings/include"><a href="../settings/include.html" >include</a></li><li id="xooki-settings/classpath"><a href="../settings/classpath.html" >classpath</a></li><li id="xooki-settings/typedef"><a href="../settings/typedef.html" >typedef</a></li><li id="xooki-settings/credentials"><a href="../settings/credentials.html" >credentials</a></li><li id="xooki-settings/signers"><a href=
"../settings/signers.html" >signers</a></li><li id="xooki-settings/lock-strategies"><a href="../settings/lock-strategies.html" >lock-strategies</a></li><li id="xooki-settings/caches" class="submenu"><a href="../settings/caches.html" >caches</a><ul class="closed"><li id="xooki-settings/caches/cache" class="submenu"><a href="../settings/caches/cache.html" >cache</a><ul class="closed"><li id="xooki-settings/caches/ttl"><a href="../settings/caches/ttl.html" >ttl</a></li></ul></li></ul></li><li id="xooki-settings/latest-strategies"><a href="../settings/latest-strategies.html" >latest-strategies</a></li><li id="xooki-settings/parsers"><a href="../settings/parsers.html" >parsers</a></li><li id="xooki-settings/namespaces" class="submenu"><a href="../settings/namespaces.html" >namespaces</a><ul class="closed"><li id="xooki-settings/namespace" class="submenu"><a href="../settings/namespace.html" >namespace</a><ul class="closed"><li id="xooki-settings/namespace/rule" class="submenu"><a
href="../settings/namespace/rule.html" >rule</a><ul class="closed"><li id="xooki-settings/namespace/fromtosystem" class="submenu"><a href="../settings/namespace/fromtosystem.html" >fromsystem / tosystem</a><ul class="closed"><li id="xooki-settings/namespace/src"><a href="../settings/namespace/src.html" >src</a></li><li id="xooki-settings/namespace/dest"><a href="../settings/namespace/dest.html" >dest</a></li></ul></li></ul></li></ul></li></ul></li><li id="xooki-settings/macrodef" class="submenu"><a href="../settings/macrodef.html" >macrodef</a><ul class="closed"><li id="xooki-settings/macrodef/attribute"><a href="../settings/macrodef/attribute.html" >attribute</a></li></ul></li><li id="xooki-settings/resolvers" class="submenu"><a href="../settings/resolvers.html" >resolvers</a><ul class="closed"><li id="xooki-resolver/ivyrep"><a href="../resolver/ivyrep.html" >IvyRep Resolver</a></li><li id="xooki-resolver/ibiblio"><a href="../resolver/ibiblio.html" >IBiblio Resolver</a></l
i><li id="xooki-resolver/packager"><a href="../resolver/packager.html" >Packager resolver</a></li><li id="xooki-resolver/filesystem"><a href="../resolver/filesystem.html" >File System resolver</a></li><li id="xooki-resolver/url"><a href="../resolver/url.html" >Url Resolver</a></li><li id="xooki-resolver/chain"><a href="../resolver/chain.html" >Chain Resolver</a></li><li id="xooki-resolver/dual"><a href="../resolver/dual.html" >Dual resolver</a></li><li id="xooki-resolver/sftp"><a href="../resolver/sftp.html" >sftp resolver</a></li><li id="xooki-resolver/ssh"><a href="../resolver/ssh.html" >ssh resolver</a></li><li id="xooki-resolver/vfs"><a href="../resolver/vfs.html" >vfs</a></li></ul></li><li id="xooki-settings/conflict-managers"><a href="../settings/conflict-managers.html" >conflict-managers</a></li><li id="xooki-settings/modules" class="submenu"><a href="../settings/modules.html" >modules</a><ul class="closed"><li id="xooki-settings/module"><a href="../settings/module.ht
ml" >module</a></li></ul></li><li id="xooki-settings/outputters"><a href="../settings/outputters.html" >outputters</a></li><li id="xooki-settings/statuses" class="submenu"><a href="../settings/statuses.html" >statuses</a><ul class="closed"><li id="xooki-settings/status"><a href="../settings/status.html" >status</a></li></ul></li><li id="xooki-settings/triggers"><a href="../settings/triggers.html" >triggers</a></li><li id="xooki-settings/version-matchers"><a href="../settings/version-matchers.html" >version-matchers</a></li></ul></li><li id="xooki-ivyfile" class="submenu"><a href="../ivyfile.html" >Ivy Files</a><ul class="closed"><li id="xooki-ivyfile/info" class="submenu"><a href="../ivyfile/info.html" >info</a><ul class="closed"><li id="xooki-ivyfile/extends"><a href="../ivyfile/extends.html" >extends</a></li><li id="xooki-ivyfile/license"><a href="../ivyfile/license.html" >license</a></li><li id="xooki-ivyfile/ivyauthor"><a href="../ivyfile/ivyauthor.html" >ivyauthor</a></
li><li id="xooki-ivyfile/repository"><a href="../ivyfile/repository.html" >repository</a></li><li id="xooki-ivyfile/description"><a href="../ivyfile/description.html" >description</a></li></ul></li><li id="xooki-ivyfile/configurations" class="submenu"><a href="../ivyfile/configurations.html" >configurations</a><ul class="closed"><li id="xooki-ivyfile/conf"><a href="../ivyfile/conf.html" >conf</a></li><li id="xooki-ivyfile/include"><a href="../ivyfile/include.html" >include</a></li></ul></li><li id="xooki-ivyfile/publications" class="submenu"><a href="../ivyfile/publications.html" >publications</a><ul class="closed"><li id="xooki-ivyfile/artifact" class="submenu"><a href="../ivyfile/artifact.html" >artifact</a><ul class="closed"><li id="xooki-ivyfile/artifact-conf"><a href="../ivyfile/artifact-conf.html" >conf</a></li></ul></li></ul></li><li id="xooki-ivyfile/dependencies" class="submenu"><a href="../ivyfile/dependencies.html" >dependencies</a><ul class="closed"><li id="xooki
-ivyfile/dependency" class="submenu"><a href="../ivyfile/dependency.html" >dependency</a><ul class="closed"><li id="xooki-ivyfile/dependency-conf" class="submenu"><a href="../ivyfile/dependency-conf.html" >conf</a><ul class="closed"><li id="xooki-ivyfile/mapped"><a href="../ivyfile/mapped.html" >mapped</a></li></ul></li><li id="xooki-ivyfile/dependency-artifact" class="submenu"><a href="../ivyfile/dependency-artifact.html" >artifact</a><ul class="closed"><li id="xooki-ivyfile/dependency-artifact-conf"><a href="../ivyfile/dependency-artifact-conf.html" >conf</a></li></ul></li><li id="xooki-ivyfile/artifact-exclude" class="submenu"><a href="../ivyfile/artifact-exclude.html" >exclude</a><ul class="closed"><li id="xooki-ivyfile/artifact-exclude-conf"><a href="../ivyfile/artifact-exclude-conf.html" >conf</a></li></ul></li><li id="xooki-ivyfile/dependency-include" class="submenu"><a href="../ivyfile/dependency-include.html" >include</a><ul class="closed"><li id="xooki-ivyfile/depe
ndency-include-conf"><a href="../ivyfile/dependency-include-conf.html" >conf</a></li></ul></li></ul></li><li id="xooki-ivyfile/exclude"><a href="../ivyfile/exclude.html" >exclude</a></li><li id="xooki-ivyfile/override"><a href="../ivyfile/override.html" >override</a></li><li id="xooki-ivyfile/conflict"><a href="../ivyfile/conflict.html" >conflict</a></li></ul></li><li id="xooki-ivyfile/conflicts" class="submenu"><a href="../ivyfile/conflicts.html" >conflicts</a><ul class="closed"><li id="xooki-ivyfile/manager"><a href="../ivyfile/manager.html" >manager</a></li></ul></li></ul></li><li id="xooki-ant" class="submenu"><a href="../ant.html" >Ant Tasks</a><ul class="open"><li id="xooki-use/artifactproperty"><a href="../use/artifactproperty.html" >artifactproperty</a></li><li id="xooki-use/artifactreport"><a href="../use/artifactreport.html" >artifactreport</a></li><li id="xooki-use/buildlist"><a href="../use/buildlist.html" >buildlist</a></li><li id="xooki-use/buildnumber"><a href
="../use/buildnumber.html" >buildnumber</a></li><li id="xooki-use/cachefileset"><a href="../use/cachefileset.html" >cachefileset</a></li><li id="xooki-use/cachepath"><a href="../use/cachepath.html" >cachepath</a></li><li id="xooki-use/cleancache"><a href="../use/cleancache.html" >cleancache</a></li><li id="xooki-use/configure"><a href="../use/configure.html" >configure</a></li><li id="xooki-use/deliver"><a href="../use/deliver.html" >deliver</a></li><li id="xooki-use/findrevision"><a href="../use/findrevision.html" >findrevision</a></li><li id="xooki-use/info"><a href="../use/info.html" >info</a></li><li id="xooki-use/install"><a href="../use/install.html" >install</a></li><li id="xooki-use/listmodules"><a href="../use/listmodules.html" >listmodules</a></li><li id="xooki-use/makepom"><a href="../use/makepom.html" >makepom</a></li><li id="xooki-use/postresolvetask"><a href="../use/postresolvetask.html" >post resolve tasks</a></li><li id="xooki-use/publish"><a href="../use/pub
lish.html" >publish</a></li><li id="xooki-use/repreport"><a href="../use/repreport.html" >repreport</a></li><li id="xooki-use/resolve"><a href="../use/resolve.html" >resolve</a></li><li id="xooki-use/retrieve"><a href="../use/retrieve.html" >retrieve</a></li><li id="xooki-use/report" class="submenu"><a href="../use/report.html" >report</a><ul class="closed"><li id="xooki-yed"><a href="../yed.html" >Using yEd to layout report graphs</a></li></ul></li><li id="xooki-use/settings"><a href="../use/settings.html" class="current">settings</a></li><li id="xooki-use/var"><a href="../use/var.html" >var</a></li></ul></li><li id="xooki-standalone"><a href="../standalone.html" >Using standalone</a></li></ul></li><li id="xooki-dev" class="submenu"><a href="../dev.html" >Developer doc</a><ul class="closed"><li id="xooki-extend"><a href="../extend.html" >Extending Ivy</a></li><li id="xooki-dev/makerelease"><a href="../dev/makerelease.html" >Making a release</a></li><li id="xooki-dev/updates
ite"><a href="../dev/updatesite.html" >Updating the updatesite</a></li></ul></li></ul></li></ul></div>
+
+ <center><iframe src="http://www.apache.org/ads/buttonbar.html"
+ style="border-width:0;" frameborder="0" scrolling="no"
+ width="135" height="265"></iframe>
+ </center>
+
+ </div>
+
+ </td>
+
+ <td valign="top">
+ <div id="main">
+
+ <h1 class="title">settings</h1>
+ <br class="xooki-br"/><span class="since">(since 2.0)</span>
+
+The settings declaration is used to configure ivy with an xml settings file. The difference with the <a href="../use/configure.html">configure</a> task is that when using the settings declaration, the configuration of Ivy will be done when the settings are first needed (for instance when you do a resolve), while the configure task will perform a configuration of Ivy instantly, which makes it easier to see the problem if something goes wrong.<br class="xooki-br"/><br class="xooki-br"/>See <a href="../settings.html">Settings Files</a> for details about the settings file itself.<br/><br/>
+
+Multiple settings can be defined in a build script. Every task can reference its own settings.<br class="xooki-br"/><br class="xooki-br"/>All Ivy variables set during the settings are available in the Ant project as long as they were not set in Ant before (Ant properties are immutable). <br class="xooki-br"/>Moreover, the variables are exposed under two names: the variable name, and the variable name suffixed by dot + the settings id. <br class="xooki-br"/>For instance, if you load a settings with the id 'myid', and define a variable my.variable=my.value in the Ivy settings, both my.variable and my.variable.myid will now be available as properties in Ant and equal to 'my.value'. If you later load another settings with the id 'yourid', and in this settings assign the variable 'my.variable' the value 'your.value', in the Ant project you will have:
+<pre>
+my.variable=my.value<br class="xooki-br"/>my.variable.myid=my.value<br class="xooki-br"/>my.variable.yourid=your.value
+</pre>
+
+<h2>Attributes</h2>
+<table class="ant">
+<thead>
+ <tr><th class="ant-att">Attribute</th><th class="ant-desc">Description</th><th class="ant-req">Required</th></tr>
+</thead>
+<tbody>
+ <tr><td>id</td><td>The settings id useable in the settingsRef attributes of the ivy task that needs a setting. Note that the ivy tasks will search by default for the settings with the id "ivy.instance", which is the default value.</td><td>No, defaults to "ivy.instance"</td></tr>
+ <tr><td>file</td><td>path to the settings file to use</td>
+ <td rowspan="2">No. If a file is provided, url is ignored. If none are provided, then it attempts to find a file at ${ivy.settings.file}, and if this file does not exist, it uses a <a href="../tutorial/defaultconf.html">default settings file</a></td></tr>
+ <tr><td>url</td><td>url of the settings file to use</td></tr>
+ <tr><td>host</td><td>http authentication host</td><td rowspan="4">No, unless authentication is required</td></tr>
+ <tr><td>realm</td><td>http authentication realm</td></tr>
+ <tr><td>username</td><td>http authentication user name</td></tr>
+ <tr><td>passwd</td><td>http authentication password</td></tr>
+</tbody>
+</table>
+<h2>HTTP Authentication</h2>
+<i>Note: HTTP Authentication can be used only if <a href="http://jakarta.apache.org/commons/httpclient/">commons-httpclient.jar</a> is in your classpath</i><br class="xooki-br"/>If any of the url you use in ivy (especially in dependency resolvers) need http<br class="xooki-br"/>authentication, then you have to provide the host, realm, username and passwd<br class="xooki-br"/>attributes of the configure task. These settings will then be used in any<br class="xooki-br"/>further call to ivy tasks.<br/><br/>
+
+<h2>Multiple classloader</h2>
+A special attention should be applied when you have a multi-project build with <i>subant</i> call, using ivy task loaded by a <i>typedef</i>. Indeed in this situation, it is possible to pass settings reference to a subbuild. When you do that, you should take of the classloader. The ivy task of your subant should not be defined in a different classloader than the parent one. This can be achieved by using the <i>loader</i> parameter of the antlib declaration, or avoid to reload the ivy antlib in the subbuild (place the taskdef in a target only executed when the antlib is not yet loaded).<br/><br/>
+
+
+<h2>Examples</h2>
+<h3>Simplest settings</h3>
+<pre><ivy:settings /></pre>
+Use either ${ivy.settings.file} if it exists, or the <a href="../samples/ivysettings-default.xml">default settings file</a><br>
+This simplest setting is implicit.<br class="xooki-br"/><h3>Configure with a file</h3>
+<pre><ivy:settings file="mysettings.xml" /></pre>
+<h3>Configure with an url</h3>
+<pre><ivy:settings url="<a href="http://mysite.com/mysettings.xml">http://mysite.com/mysettings.xml</a>" /></pre>
+<h3>Configure multiple realms which require autentication</h3>
+<pre>
+<ivy:settings file="path/to/my/ivysettings.xml"><br class="xooki-br"/> <credentials host="myhost.com" realm="My Realm" username="myuser" passwd="mypasswd" /><br class="xooki-br"/> <credentials host="yourhost.com" realm="Your Realm" username="myuser" passwd="myotherpasswd" /><br class="xooki-br"/></ivy:settings>
+</pre>
+<h3>Configure 2 different settings</h3>
+You can use multiple ivy settings during a build. Then every ivy task should specify the settings it uses using the settingsRef attribute.
+<pre>
+ <ivy:settings id="ivy.normal.settings" file="normal_settings.xml" /><br class="xooki-br"/> <ivy:settings id="ivy.release.settings" file="release_settings.xml" /><br class="xooki-br"/><br class="xooki-br"/> <ivy:resolve settingsRef="ivy.normal.settings" /><br class="xooki-br"/> <ivy:resolve settingsRef="ivy.release.settings" />
+</pre>
+
+ </div><!-- main -->
+ </td>
+ </tr>
+</table>
+
+<table id="footer-menu" summary="Navigation elements." border="0"
+ cellpadding="0" cellspacing="0" width="100%">
+ <tr>
+ <td align="center" valign="middle">
+ <div class="primary-links">::
+ <a href="../index.html">Home</a> ::
+ <a href="../download.html">Download</a> ::
+ <a href="../history/latest-milestone/index.html">Documentation</a> ::
+ <a href="../get-involved.html">Get Involved</a> ::
+ <a href="../search.html">Search</a> ::
+ </div>
+ </td>
+ </tr>
+</table>
+
+
+
+<div id="footer-message"></div>
+
+
+</div><!-- body -->
+</body>
+</html>