mcconnell 2004/01/19 04:33:51
Modified: merlin/platform/xdocs/starting/installation index.xml
navigation.xml
Added: merlin/platform/xdocs/starting/installation cvs.xml
install.3.0.xml install.3.2.xml install.3.3.xml
Log:
Add revised binary install instructions.
Revision Changes Path
1.2 +6 -2 avalon/merlin/platform/xdocs/starting/installation/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/avalon/merlin/platform/xdocs/starting/installation/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 10 Dec 2003 08:21:54 -0000 1.1
+++ index.xml 19 Jan 2004 12:33:51 -0000 1.2
@@ -60,12 +60,16 @@
<table>
<tr><th>Topic</th><th>Summary</th></tr>
<tr>
- <td><a href="3.2/index.html">Merlin 3.2 Installation</a></td>
+ <td><a href="install.3.2.html">Merlin 3.2 Installation</a></td>
<td>Installation instructions for Merlin 3.2.</td>
</tr>
<tr>
- <td><a href="3.0/index.html">Merlin 3.0 Installation</a></td>
+ <td><a href="install.3.0.html">Merlin 3.0 Installation</a></td>
<td>Installation instructions for Merlin 3.0.</td>
+ </tr>
+ <tr>
+ <td><a href="cvs.html">Building from CVS</a></td>
+ <td>Instructions for building an installation from CVS.</td>
</tr>
</table>
</section>
1.4 +4 -2
avalon/merlin/platform/xdocs/starting/installation/navigation.xml
Index: navigation.xml
===================================================================
RCS file:
/home/cvs/avalon/merlin/platform/xdocs/starting/installation/navigation.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- navigation.xml 23 Dec 2003 17:30:33 -0000 1.3
+++ navigation.xml 19 Jan 2004 12:33:51 -0000 1.4
@@ -66,8 +66,10 @@
<item name="Overview" href="/about/index.html"/>
<item name="Getting Started" href="/starting/index.html">
<item name="Installation" href="/starting/installation/index.html">
- <item name="Version 3.2" href="/starting/installation/3.2/index.html"/>
- <item name="Version 3.0" href="/starting/installation/3.0/index.html"/>
+ <item name="CVS" href="/starting/installation/cvs.html"/>
+ <item name="3.0" href="/starting/installation/install.3.0.html"/>
+ <item name="3.2.5 (current)"
href="/starting/installation/install.3.2.html"/>
+ <item name="3.3 (bleeding edge)"
href="/starting/installation/install.3.3.html"/>
</item>
<item name="Using Merlin" href="/starting/tutorial/index.html"/>
<item name="Advanced Features" href="/starting/advanced/index.html"/>
1.1 avalon/merlin/platform/xdocs/starting/installation/cvs.xml
Index: cvs.xml
===================================================================
<?xml version="1.0"?>
<!--
============================================================================
The Apache Software License, Version 1.1
============================================================================
Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
Redistribution and use in source and binary forms, with or without modifica-
tion, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. The end-user documentation included with the redistribution, if any, must
include the following acknowledgment: "This product includes software
developed by the Apache Software Foundation (http://www.apache.org/)."
Alternately, this acknowledgment may appear in the software itself, if
and wherever such third-party acknowledgments normally appear.
4. The names "Jakarta", "Apache Avalon", "Avalon Framework" and
"Apache Software Foundation" must not be used to endorse or promote
products derived from this software without prior written
permission. For written permission, please contact [EMAIL PROTECTED]
5. Products derived from this software may not be called "Apache", nor may
"Apache" appear in their name, without prior written permission of the
Apache Software Foundation.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This software consists of voluntary contributions made by many individuals
on behalf of the Apache Software Foundation. For more information on the
Apache Software Foundation, please see http://www.apache.org/.
-->
<document>
<header>
<title>Installation - Merlin CVS</title>
<authors>
<person name="Stephen McConnell" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<section name="Building Merlin from CVS">
<subsection name="Checkout">
<p>
To build the Merlin installation you need to checkout the
Merlin project from CVS. The commands in this document
assume a unix-style system; the procedure under windows is
similar, and identical if you have <a
href="http://www.cygwin.com";>cygwin</a> installed.
</p>
<source><![CDATA[
$ cvs -d :pserver:[EMAIL PROTECTED]:/home/cvspublic login
$ cvs -z3 -d :pserver:[EMAIL PROTECTED]:/home/cvspublic co avalon/util
$ cvs -z3 -d :pserver:[EMAIL PROTECTED]:/home/cvspublic co avalon/meta
$ cvs -z3 -d :pserver:[EMAIL PROTECTED]:/home/cvspublic co avalon/repository
$ cvs -z3 -d :pserver:[EMAIL PROTECTED]:/home/cvspublic co avalon/merlin
]]></source>
</subsection>
<subsection name="Build">
<p>
Once checkout is complete you can build Merlin using <a
href="http://maven.apache.org/";>Maven</a> as follows:
</p>
<source><![CDATA[
$ cd avalon/meta
$ maven
$ cd ../util
$ maven
$ cd ../repository
$ maven
$ cd ../merlin
$ maven
]]></source>
<p>
The above build procedure will create a installation
directory containing the Merlin system at
</p>
<source><![CDATA[
+-- avalon
+-- merlin
+-- target
+-- merlin
]]></source>
</subsection>
<subsection name="Replicate">
<p>
Copy the 'merlin' directory to your preferred location
installation location. For example, you may want to copy
the installation dir to the /opt dir:
</p>
<source><![CDATA[
$ cp -Rf merlin/target/merlin /opt/merlin
]]></source>
<p>
Continue with the <a href="install.3.3.html">binary install</a>
instructions concerning the setup of environment variables to
complete your installation.
</p>
</subsection>
</section>
</body>
</document>
1.1
avalon/merlin/platform/xdocs/starting/installation/install.3.0.xml
Index: install.3.0.xml
===================================================================
<?xml version="1.0"?>
<!--
============================================================================
The Apache Software License, Version 1.1
============================================================================
Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
Redistribution and use in source and binary forms, with or without modifica-
tion, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. The end-user documentation included with the redistribution, if any, must
include the following acknowledgment: "This product includes software
developed by the Apache Software Foundation (http://www.apache.org/)."
Alternately, this acknowledgment may appear in the software itself, if
and wherever such third-party acknowledgments normally appear.
4. The names "Jakarta", "Apache Avalon", "Avalon Framework" and
"Apache Software Foundation" must not be used to endorse or promote
products derived from this software without prior written
permission. For written permission, please contact [EMAIL PROTECTED]
5. Products derived from this software may not be called "Apache", nor may
"Apache" appear in their name, without prior written permission of the
Apache Software Foundation.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This software consists of voluntary contributions made by many individuals
on behalf of the Apache Software Foundation. For more information on the
Apache Software Foundation, please see http://www.apache.org/.
-->
<document>
<header>
<title>Installation</title>
<authors>
<person name="Stephen McConnell" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<section name="Installation">
<subsection name="Declare MERLIN_HOME environment variable">
<p>
To use Merlin command line support or the Merlin NT Service
you will need to define the MERLIN_HOME environment
variable for your system and include MERLIN_HOME/bin in
your system path:
</p>
<source><![CDATA[
$ echo '
> # set location of merlin
> export MERLIN_HOME=/opt/merlin
> # include it in the path
> export PATH=$PATH:$MERLIN_HOME/bin
> ' >> ~/.bash_profile
$ source ~/.bash_profile
]]></source>
</subsection>
<subsection name="Validating your installation.">
<p>
The following instructions assume that you have defined the
MERLIN_HOME environment variable that points the directory
containing the Merlin installation.
</p>
<p>
To confirm that you MERLIN_HOME variable is correct, you
should open a new command line window and invoke the Merlin
CLI application. The following command should list the
Merlin CLI help information.
</p>
<source><![CDATA[
$ merlin.sh -help
usage: merlin [block] [-debug] [-config <file>] [-lang
<code>] [-repository <directory>] [-kernel <file>] [-home
<directory>] [-version] [-help]
...
]]></source>
</subsection>
<subsection name="Next Steps">
<p>
Now that you have installed Merlin on your system you can
proceed to the <a href="../tutorial/index.html">Using Merlin</a>
tutorial page.
</p>
</subsection>
</section>
</body>
</document>
1.1
avalon/merlin/platform/xdocs/starting/installation/install.3.2.xml
Index: install.3.2.xml
===================================================================
<?xml version="1.0"?>
<!--
============================================================================
The Apache Software License, Version 1.1
============================================================================
Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
Redistribution and use in source and binary forms, with or without modifica-
tion, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. The end-user documentation included with the redistribution, if any, must
include the following acknowledgment: "This product includes software
developed by the Apache Software Foundation (http://www.apache.org/)."
Alternately, this acknowledgment may appear in the software itself, if
and wherever such third-party acknowledgments normally appear.
4. The names "Jakarta", "Apache Avalon", "Avalon Framework" and
"Apache Software Foundation" must not be used to endorse or promote
products derived from this software without prior written
permission. For written permission, please contact [EMAIL PROTECTED]
5. Products derived from this software may not be called "Apache", nor may
"Apache" appear in their name, without prior written permission of the
Apache Software Foundation.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This software consists of voluntary contributions made by many individuals
on behalf of the Apache Software Foundation. For more information on the
Apache Software Foundation, please see http://www.apache.org/.
-->
<document>
<header>
<title>Installation - Merlin 3.2</title>
<authors>
<person name="Stephen McConnell" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<section name="Installation - Merlin 3.2">
<subsection name="Build Procedure">
<p>
After downloading the Merlin 3.2 binary distribution and
inpacking the archive into you preferred location, you should
have a directory structure that looks like the following:
</p>
<source><![CDATA[
/merlin
/bin
/config
/ext
/system
README.TXT
LICENSE.TXT
/plugins
avalon-meta-plugin-1.3.1.jar
merlin-plugin-3.2.3.jar
]]></source>
<p>
To use Merlin command line support or the Merlin NT Service
you will need to define the MERLIN_HOME environment
variable for your system and include MERLIN_HOME/bin in
your system path. The MERLIN_HOME environment variable
should point to the merlin directory.
</p>
<p>
Under Lunix you can do this as follows:
</p>
<source><![CDATA[
$ echo '
> # set location of merlin
> export MERLIN_HOME=/opt/merlin
> # include it in the path
> export PATH=$PATH:$MERLIN_HOME/bin
> ' >> ~/.bash_profile
$ source ~/.bash_profile
]]></source>
<p>
Under Windows you can set environment variables by selecting the
Environment Tab from the System Control Panel.
</p>
<p>
Versions of Merlin prior to the 3.2-dev 20031210 build maintained
a local repository of jar files under the %MERLIN_HOME%/repository
directory. As of the 20031210 build the repository is maintained
under AVALON_HOME which defaults to ${user.home}/.avalon. To
override this behaviour you can either define a AVALON_HOME
environment variable or you can add a merlin.properties file to
${user.home} containing the "merlin.repository" property key and
a value point to you preferred repository location.
</p>
<p>
To confirm that your environment variables are correct, you
should open a new command window and invoke the Merlin
CLI application.
</p>
<source><![CDATA[
Under DOS:
$ merlin -version
Under Lunix:
$ merlin.sh -version
]]></source>
<p>
The installation of Merlin is now complete, however, two plugins are
provided with the installation supporting merlin development under the
Maven platform. These plugins should be placed in the Maven plugin
directory (%MAVEN_HOME%\plugins).
</p>
<source><![CDATA[
%MAVEN_HOME%\plugins\avalon-meta-plugin-1.3.1.jar
%MAVEN_HOME%\plugins\merlin-plugin-3.2.3.jar
]]></source>
<p>
The installation of Merlin is now complete, however, two plugins are
provided with the installation supporting merlin development under the
Maven platform. These plugins should be placed in the Maven plugin
directory (%MAVEN_HOME%\plugins).
</p>
<source><![CDATA[
%MAVEN_HOME%\plugins\avalon-meta-plugin-1.3.1.jar
%MAVEN_HOME%\plugins\merlin-plugin-3.2.3.jar
]]></source>
<p>
Please note that if you are upgrading an existing installation you must
delete the following two directories:
</p>
<source><![CDATA[
%MAVEN_HOME%\plugins\merlin-plugin-*
%MAVEN_HOME%\plugins\avalon-meta-plugin-*
]]></source>
</subsection>
<subsection name="Validating your installation.">
<p>
The following instructions assume that you have defined the
MERLIN_HOME environment variable that points the directory
containing the Merlin installation.
</p>
<p>
To confirm that you MERLIN_HOME variable is correct, you
should open a new command line window and invoke the Merlin
CLI application. The following command should list the
Merlin CLI help information.
</p>
<source><![CDATA[
$ merlin.sh -help
usage: merlin [block] [-lang <code>] [-install <url>]
[-library <directory>] [-help] [-version] [-home <directory>]
[-impl <artifact>] [-debug] [-info] [-config <url>]
[-context <directory>] [-system <directory>] [-execute]
[-repository <directory>] [-kernel <url>]...
]]></source>
</subsection>
<subsection name="Next Steps">
<p>
Now that you have installed Merlin on your system you can
proceed to the <a href="../tutorial/index.html">Using Merlin</a>
tutorial page.
</p>
</subsection>
</section>
</body>
</document>
1.1
avalon/merlin/platform/xdocs/starting/installation/install.3.3.xml
Index: install.3.3.xml
===================================================================
<?xml version="1.0"?>
<!--
============================================================================
The Apache Software License, Version 1.1
============================================================================
Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
Redistribution and use in source and binary forms, with or without modifica-
tion, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. The end-user documentation included with the redistribution, if any, must
include the following acknowledgment: "This product includes software
developed by the Apache Software Foundation (http://www.apache.org/)."
Alternately, this acknowledgment may appear in the software itself, if
and wherever such third-party acknowledgments normally appear.
4. The names "Jakarta", "Apache Avalon", "Avalon Framework" and
"Apache Software Foundation" must not be used to endorse or promote
products derived from this software without prior written
permission. For written permission, please contact [EMAIL PROTECTED]
5. Products derived from this software may not be called "Apache", nor may
"Apache" appear in their name, without prior written permission of the
Apache Software Foundation.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This software consists of voluntary contributions made by many individuals
on behalf of the Apache Software Foundation. For more information on the
Apache Software Foundation, please see http://www.apache.org/.
-->
<document>
<header>
<title>Installation - Merlin 3.3</title>
<authors>
<person name="Stephen McConnell" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<section name="Installation - Merlin 3.3">
<subsection name="Structure">
<p>
After downloading the Merlin 3.3 binary distribution and
inpacking the archive into you preferred location, you should
have a directory structure that looks like the following:
</p>
<source><![CDATA[
/merlin
/bin
/config
/docs
/plugins
/system
README.TXT
LICENSE.TXT
]]></source>
</subsection>
<subsection name="MERLIN_HOME Environment Variable">
<p>
To use Merlin command line support or the Merlin NT Service
you will need to define the MERLIN_HOME environment
variable for your system and include MERLIN_HOME/bin in
your system path. The MERLIN_HOME environment variable
should point to the merlin directory.
</p>
<p>
Under Windows you can set environment variables by selecting the
Environment Tab from the System Control Panel.
</p>
<p>
Under Lunix you can do this as follows:
</p>
<source><![CDATA[
$ echo '
> # set location of merlin
> export MERLIN_HOME=/opt/merlin
> # include it in the path
> export PATH=$PATH:$MERLIN_HOME/bin
> ' >> ~/.bash_profile
$ source ~/.bash_profile
]]></source>
</subsection>
<subsection name="AVALON_HOME Environment Variable">
<p>
Versions of Merlin prior to the 3.2-dev 20031210 build maintained
a local repository of jar files under the %MERLIN_HOME%/repository
directory. As of the 20031210 build the repository is maintained
under AVALON_HOME which defaults to ${user.home}/.avalon. To
override this behaviour you can either define a AVALON_HOME
environment variable or you can add a merlin.properties file to
${user.home} containing the "merlin.repository" property key and
a value point to you preferred repository location.
</p>
</subsection>
<subsection name="Maven Plugin Installation">
<p>
The installation of Merlin is now complete, however, two plugins are
provided with the installation supporting merlin development under the
Maven platform. These plugins should be placed in the Maven plugin
directory (%MAVEN_HOME%\plugins).
</p>
<source><![CDATA[
%MAVEN_HOME%\plugins\avalon-meta-plugin-1.3.2.jar
%MAVEN_HOME%\plugins\merlin-plugin-3.3-SNAPSHOT.jar
]]></source>
<p>
Please note that if you are upgrading an existing Maven installation you must
delete the following two directories:
</p>
<source><![CDATA[
%MAVEN_HOME%\plugins\merlin-plugin-*
%MAVEN_HOME%\plugins\avalon-meta-plugin-*
]]></source>
</subsection>
<subsection name="Validating your installation.">
<p>
The following instructions assume that you have defined the
MERLIN_HOME environment variable that points the directory
containing the Merlin installation.
</p>
<p>
To confirm that you MERLIN_HOME variable is correct, you
should open a new command line window and invoke the Merlin
CLI application. The following command should list the
Merlin CLI help information.
</p>
<source><![CDATA[
$ merlin.sh -help
usage: merlin [block] [-lang <code>] [-install <url>]
[-library <directory>] [-help] [-version] [-home <directory>]
[-impl <artifact>] [-debug] [-info] [-config <url>]
[-context <directory>] [-system <directory>] [-execute]
[-repository <directory>] [-kernel <url>]...
]]></source>
</subsection>
<subsection name="Next Steps">
<p>
Now that you have installed Merlin on your system you can
proceed to the <a href="../tutorial/index.html">Using Merlin</a>
tutorial page.
</p>
</subsection>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
