--- properties.xml	2004-08-09 17:47:58.000000000 +0200
+++ D:\cvs-local\maven-plugins\cruisecontrol\xdocs\properties.xml	2004-08-18 17:04:16.000000000 +0200
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="UTF-8"?>
+﻿<?xml version="1.0" encoding="UTF-8"?>
 <!-- 
 /*
  * Copyright 2001-2004 The Apache Software Foundation.
@@ -23,7 +23,7 @@
     <title>Maven Cruise Control Plug-in Properties</title>
   </properties>
   <body>
-    <section name="Maven Cruise Control Plug-in Settings">
+    <section name="Maven Cruise Control Plug-in Global Settings">
       <table>
         <tr>
           <th>Property</th>
@@ -114,6 +114,14 @@
           </td>
         </tr>
         <tr>
+          <td>maven.cruisecontrol.currentbuildstatus.filename</td>
+          <td>Yes</td>
+          <td>
+            <p>The filename to write the currentbuildstatus. Default value is
+              <code>currentbuildstatus.txt</code>.</p>
+          </td>
+        </tr>
+        <tr>
           <td>maven.cruisecontrol.goals</td>
           <td>Yes</td>
           <td>
@@ -134,6 +142,66 @@
           </td>
         </tr>
         <tr>
+          <td>maven.cruisecontrol.template</td>
+          <td>Yes</td>
+          <td>
+            <p>Template file to use in generating the cruisecontrol.xml file.</p>
+            <p>
+        <strong>NOTE: </strong>It may be more appropriate to set this in build.properties
+        on the CruiseControl server since the value may differ from developer to developer.
+            </p>
+          </td>
+        </tr>     
+        <tr>
+          <td>maven.cruisecontrol.trigger.projects</td>
+          <td>Yes</td>
+          <td>
+            <p>
+				A comma separated list of projects that should trigger this project to build when 
+				they are built.  Allows you to build a project whose dependencies
+				have changed.
+            </p>
+            <p>
+        <strong>NOTE: </strong>You may need to edit the config file to ensure that dependent
+        project appear prior to the project.  This is because CruiseControl builds projects in
+        the order that appear in the config file.  Failure to order the project properly may 
+        results in continuious rebuilding of project and/or avoidable build failures.
+            </p>
+          </td>
+        </tr> 		
+        <tr>
+          <td>maven.cruisecontrol.buildresults.site</td>
+          <td>Yes</td>
+          <td>
+            <p>
+				The root of the cruisecontrol site used in generating the link to
+				CruiseControl.  By default this is 
+        <code>${pom.url}/cruisecontrol</code>.  While not required,
+				typically you will need to set this.
+            </p>
+          </td>
+        </tr> 		   
+        <tr>
+          <td>maven.cruisecontrol.buildresults.url</td>
+          <td>Yes</td>
+          <td>
+            <p>
+				The url of the cruisecontrol site used in generating the link to
+				CruiseControl.  By default this is 
+        <code>${maven.cruisecontrol.site}/buildresults/${pom.artifactId}</code>.  
+            </p>
+            <p>
+        <strong>Note: </strong>Since the cruisecontrol report is not one of the
+        defaults reports, you must add the cruisecontrol report to see a
+        link to the Cruise Control Build Results under Project Reports.  
+            </p>
+          </td>
+        </tr> 		   
+      </table>
+    </section>
+    <section name="Maven Cruise Control Plug-in Mail Settings">
+      <table>
+       <tr>
           <td>maven.cruisecontrol.mail.host</td>
           <td>Yes</td>
           <td>
@@ -184,64 +252,222 @@
             <p>Default value is the domain name of the first email in
               <code>${pom.build.nagEmailAddress}</code>.</p>
           </td>
-        </tr>
+        </tr>    
+      </table>
+    </section>
+    <section name="Maven Cruise Control Plug-in FTP Publisher Settings">
+      <table>
         <tr>
-          <td>maven.cruisecontrol.template</td>
+          <td>maven.cruisecontrol.ftp.targetHost</td>
           <td>Yes</td>
           <td>
-            <p>Template file to use in generating the cruisecontrol.xml file.</p>
+            <p>Host name of the FTP server.</p>
             <p>
-        <strong>NOTE: </strong>It may be more appropriate to set this in build.properties
-        on the CruiseControl server since the value may differ from developer to developer.
-            </p>
+        <strong>NOTE: </strong>This property doesn't have any default value, a value is required if 
+        <code>maven.cruisecontrol.currentbuildstatusftppublisher</code> property or 
+        <code>maven.cruisecontrol.ftppublisher</code> property is set to <code>true</code>.</p>
           </td>
-        </tr>     
+        </tr>
         <tr>
-          <td>maven.cruisecontrol.trigger.projects</td>
+          <td>maven.cruisecontrol.ftp.targetUser</td>
           <td>Yes</td>
           <td>
+            <p>The user used for logging into the FTP site. Default value is
+              <code>anonymous</code>.</p>
+          </td>
+        </tr>
+        <tr>
+          <td>maven.cruisecontrol.ftp.targetPasswd</td>
+          <td>Yes</td>
+          <td>
+            <p>The password used during FTP log in for the <code>maven.cruisecontrol.ftp.targetUser</code>. Default value is
+              <code>anonymous</code>.</p>
+          </td>
+        </tr>
+        <tr>
+          <td>maven.cruisecontrol.ftp.targetPort</td>
+          <td>Yes</td>
+          <td>
+            <p>Port number of the FTP server. Default value is
+              <code>21</code>.</p>
+          </td>
+        </tr>
+        <tr>
+          <td>maven.cruisecontrol.ftp.targetDir</td>
+          <td>Yes</td>
+          <td>
+            <p>Base directory in the FTP server to put the files. Default value is
+              <code>.</code>.</p>
+          </td>
+        </tr>
+        <tr>
+          <td>maven.cruisecontrol.ftp.targetSeparator</td>
+          <td>Yes</td>
+          <td>
+            <p>Directory separator character used by the FTP server. Default value is
+              <code>/</code>.</p>
+          </td>
+        </tr>
+        <tr>
+          <td>maven.cruisecontrol.currentbuildstatusftppublisher</td>
+          <td>Yes</td>
+          <td>
+            <p>Copies the file containing the current build status in a remote directory onto the FTP server. Default value is
+              <code>false</code>.</p>
             <p>
-				A comma separated list of projects that should trigger this project to build when 
-				they are built.  Allows you to build a project whose dependencies
-				have changed.
-            </p>
+        <strong>NOTE: </strong>To use this CruiseControl property you need to add this line
+        <code>currentbuildstatusftppublisher=net.sourceforge.cruisecontrol.publishers.CurrentBuildStatusFTPPublisher</code>
+         in the default-plugins.properties file before building CruiseControl
+          (you can find it, in INSTALL_DIR/main/src/net/sourceforge/cruisecontrol/).</p>
+          </td>
+        </tr>
+        <tr>
+          <td>maven.cruisecontrol.currentbuildstatusftppublisher.file</td>
+          <td>Yes</td>
+          <td>
+            <p>The filename to write.</p>
             <p>
-        <strong>NOTE: </strong>You may need to edit the config file to ensure that dependent
-        project appear prior to the project.  This is because CruiseControl builds projects in
-        the order that appear in the config file.  Failure to order the project properly may 
-        results in continuious rebuilding of project and/or avoidable build failures.
-            </p>
+        <strong>NOTE: </strong>This property doesn't have any default value, a value is required if 
+        <code>maven.cruisecontrol.currentbuildstatusftppublisher</code> property is set to <code>true</code>.</p>
           </td>
-        </tr> 		
+        </tr>
         <tr>
-          <td>maven.cruisecontrol.buildresults.site</td>
+          <td>maven.cruisecontrol.currentbuildstatusftppublisher.destDir</td>
           <td>Yes</td>
           <td>
+            <p>The remote directory to write the file.</p>
             <p>
-				The root of the cruisecontrol site used in generating the link to
-				CruiseControl.  By default this is 
-        <code>${pom.url}/cruisecontrol</code>.  While not required,
-				typically you will need to set this.
-            </p>
+        <strong>NOTE: </strong>This property doesn't have any default value, a value is required if 
+        <code>maven.cruisecontrol.currentbuildstatusftppublisher</code> property is set to <code>true</code>.</p>
           </td>
-        </tr> 		   
+        </tr>
         <tr>
-          <td>maven.cruisecontrol.buildresults.url</td>
+          <td>maven.cruisecontrol.ftppublisher</td>
           <td>Yes</td>
           <td>
+            <p>Copies the XML log file from the build onto the FTP server. Default value is
+              <code>false</code>.</p>
             <p>
-				The url of the cruisecontrol site used in generating the link to
-				CruiseControl.  By default this is 
-        <code>${maven.cruisecontrol.site}/buildresults/${pom.artifactId}</code>.  
-            </p>
+        <strong>NOTE: </strong>To use this CruiseControl property you need to add this line
+        <code>ftppublisher=net.sourceforge.cruisecontrol.publishers.FTPPublisher</code>
+         in the default-plugins.properties file before building CruiseControl
+          (you can find it, in INSTALL_DIR/main/src/net/sourceforge/cruisecontrol/).</p>
+          </td>
+        </tr>
+        <tr>
+          <td>maven.cruisecontrol.ftppublisher.destDir</td>
+          <td>Yes</td>
+          <td>
+            <p>The remote directory to publish the files.</p>
             <p>
-        <strong>Note: </strong>Since the cruisecontrol report is not one of the
-        defaults reports, you must add the cruisecontrol report to see a
-        link to the Cruise Control Build Results under Project Reports.  
-            </p>
+        <strong>NOTE: </strong>This property doesn't have any default value, a value is required if 
+        <code>maven.cruisecontrol.ftppublisher</code> property is set to <code>true</code>.</p>
           </td>
-        </tr> 		   
+        </tr>
+        <tr>
+          <td>maven.cruisecontrol.ftppublisher.srcDir</td>
+          <td>Yes</td>
+          <td>
+            <p>To publish the XML log file, this must be the same as <code>maven.cruisecontrol.logs.dir</code>. Default value is
+              <code>${maven.cruisecontrol.logs.dir}</code>.</p>
+          </td>
+        </tr>
+        <tr>
+          <td>maven.cruisecontrol.ftppublisher.deleteArtifacts</td>
+          <td>Yes</td>
+          <td>
+            <p>If <code>yes</code>, then all files successfully sent to the FTP server will be deleted locally. Default value is
+              <code>no</code>.</p>
+          </td>
+        </tr>
       </table>
     </section>
+    <section name="Maven Cruise Control Plug-in SCP Publisher Settings">
+     <table>
+      <tr>
+        <td>maven.cruisecontrol.scppublisher</td>
+        <td>Yes</td>
+        <td>
+          <p>Copies the XML log file from the build with a SCP command onto a remote host. Default value is
+            <code>false</code>.</p>
+        </td>
+      </tr>
+      <tr>
+        <td>maven.cruisecontrol.scp.sourcedir</td>
+        <td>Yes</td>
+        <td>
+          <p>The directory to copy from. Default value is
+            <code>${maven.cruisecontrol.logs.dir}</code>.</p>
+        </td>
+      </tr>
+      <tr>
+        <td>maven.cruisecontrol.scp.targetuser</td>
+        <td>Yes</td>
+        <td>
+          <p>Log in to the target machine as this user.</p>
+          <p>
+        <strong>NOTE: </strong>This property doesn't have any default value, a value is required if 
+        <code>maven.cruisecontrol.scppublisher</code> property is set to <code>true</code>.</p>
+        </td>
+      </tr>
+      <tr>
+        <td>maven.cruisecontrol.scp.targethost</td>
+        <td>Yes</td>
+        <td>
+          <p>SCP to this machine.</p>
+          <p>
+        <strong>NOTE: </strong>This property doesn't have any default value, a value is required if 
+        <code>maven.cruisecontrol.scppublisher</code> property is set to <code>true</code>.</p>
+        </td>
+      </tr>
+      <tr>
+        <td>maven.cruisecontrol.scp.targetlogdir</td>
+        <td>Yes</td>
+        <td>
+          <p>The directory to copy the log files. Default value is
+            <code>.</code>.</p>
+        </td>
+      </tr>
+      <tr>
+        <td>maven.cruisecontrol.scp.targetstatusfiledir</td>
+        <td>Yes</td>
+        <td>
+          <p>The directory to copy the currentstatusfile. Default value is
+            <code>.</code>.</p>
+        </td>
+      </tr>
+      <tr>
+        <td>maven.cruisecontrol.scp.targetseparator</td>
+        <td>Yes</td>
+        <td>
+          <p>The file separator on the target machine. Default value is
+            <code>/</code>.</p>
+        </td>
+      </tr>
+      <tr>
+        <td>maven.cruisecontrol.scp.ssh</td>
+        <td>Yes</td>
+        <td>
+          <p>The ssh application. Default value is
+            <code>ssh</code>.</p>
+        </td>
+      </tr>
+      <tr>
+        <td>maven.cruisecontrol.scp.file</td>
+        <td>Yes</td>
+        <td>
+          <p>The filename to copy. Default value is the current log file.</p>
+        </td>
+      </tr>
+      <tr>
+        <td>maven.cruisecontrol.scp.statusfile</td>
+        <td>Yes</td>
+        <td>
+          <p>The statusfilename to copy. Default value is 
+          <code>${maven.cruisecontrol.currentbuildstatus.filename}</code>.</p>
+        </td>
+      </tr>
+     </table>
+    </section>
   </body>
 </document>
