Author: crossley
Date: Thu Oct 1 07:23:09 2009
New Revision: 820548
URL: http://svn.apache.org/viewvc?rev=820548&view=rev
Log:
Explained how to enable coloured output using the Ant AnsiColorLogger.
Issue: FOR-1178
Modified:
forrest/trunk/site-author/content/xdocs/docs_0_90/faq.xml
forrest/trunk/site-author/content/xdocs/site.xml
forrest/trunk/site-author/status.xml
Modified: forrest/trunk/site-author/content/xdocs/docs_0_90/faq.xml
URL:
http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/docs_0_90/faq.xml?rev=820548&r1=820547&r2=820548&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_90/faq.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_90/faq.xml Thu Oct 1
07:23:09 2009
@@ -1480,6 +1480,30 @@
</p>
</answer>
</faq>
+ <faq id="coloured-ant">
+ <question> How to enabled coloured standard output messages? </question>
+ <answer>
+ <p>
+ Adding colour to the forrest output messages will greatly assist
+ readability.
+ </p>
+ <p>
+ Set the ANT_ARGS environment variable like so:<br />
+ <code>export ANT_ARGS="$ANT_ARGS -logger
org.apache.tools.ant.listener.AnsiColorLogger"</code>
+ </p>
+ <p>
+ To change the default colours, set the ANT_OPTS environment variable
+ like so:<br />
+ <code>export ANT_OPTS="$ANT_OPTS
-Dant.logger.defaults=$FORREST_HOME/etc/AnsiColorLogger.properties"</code><br />
+ and create that configuration file as
+ <link
href="http://ant.apache.org/manual/listeners.html#AnsiColorLogger";>explained</link>
+ in the Apache Ant Manual.
+ </p>
+ <p>
+ Note that not all terminals support ANSI color codes.
+ </p>
+ </answer>
+ </faq>
<faq id="how_can_I_help">
<question> How to help? </question>
<answer>
Modified: forrest/trunk/site-author/content/xdocs/site.xml
URL:
http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/site.xml?rev=820548&r1=820547&r2=820548&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/site.xml (original)
+++ forrest/trunk/site-author/content/xdocs/site.xml Thu Oct 1 07:23:09 2009
@@ -311,6 +311,7 @@
<docbook href="#docbook"/>
<docs href="#docs"/>
<checksums href="#checksums"/>
+ <coloured-ant href="#coloured-ant"/>
<edit-content href="#edit-content"/>
<ignoring_javadocs href="#ignoring_javadocs"/>
<jobs href="#jobs"/>
Modified: forrest/trunk/site-author/status.xml
URL:
http://svn.apache.org/viewvc/forrest/trunk/site-author/status.xml?rev=820548&r1=820547&r2=820548&view=diff
==============================================================================
--- forrest/trunk/site-author/status.xml (original)
+++ forrest/trunk/site-author/status.xml Thu Oct 1 07:23:09 2009
@@ -155,8 +155,10 @@
</action>
<!-- 2009-10 -->
<action context="code" type="add" dev="DC" fixes-bug="FOR-1178"
importance="high">
- Enabled the filtering of output messages from Ant.
- See <link href="site:faq/verbose-ant">FAQ</link>
+ Enabled the filtering of output messages from Ant
+ (see <link href="site:faq/verbose-ant">FAQ</link>)
+ and explained how to enable coloured output
+ (see <link href="site:faq/coloured-ant">FAQ</link>).
</action>
<action context="code" type="add" dev="DC">
Assist with xml debugging. Show list of catalog descriptors being used.
