You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by mc...@apache.org on 2003/12/10 10:57:35 UTC
cvs commit: avalon/merlin/platform/xdocs/merlin/kernel properties.xml
mcconnell 2003/12/10 01:57:35
Added: merlin/platform/xdocs/merlin/kernel properties.xml
Log:
Properties documentation.
Revision Changes Path
1.1 avalon/merlin/platform/xdocs/merlin/kernel/properties.xml
Index: properties.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 apache@apache.org.
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>Merlin Properties</title>
<authors>
<person name="Stephen McConnell" email="mcconnell@apache.org"/>
</authors>
</header>
<body>
<section name="Merlin Properties">
<subsection name="Overview">
<p>
Merlin 3.2 introduces a complete property configuration model as part of the unification of the embedding strategy. Merlin properties are included in a file named "merlin.properties". Merlin will look for this file in the following locations:
</p>
<table>
<tr><th>Location</th><th>Description</th></tr>
<tr>
<td>${merlin.dir}</td><td></td>
<td>This is equivalent to the ${user.dir} location unless
modified by the command line -home command parameter.</td>
</tr>
<tr>
<td>${user.home}</td><td></td>
<td>The user's home directory.</td>
</tr>
</table>
<p>
Values defined under the ${merlin.dir}/merlin.properties take precedence over ${user.home}/merlin.properties.
</p>
</subsection>
<subsection name="Bootstrap Properties">
<p>
The following properties are established by Merlin during the bootstrap phase and cannot be override.
</p>
<table>
<tr><th>Property</th><th>Default Value</th><th>Description</th></tr>
<tr>
<td>${merlin.dir}</td>
<td>${user.dir}</td>
<td>The working directory used by Merlin. This value derfaults to
${user.dir} under normal circumstances. If a System property
of ${basedir} is present it will be assigned as ${merlin.dir}.</td>
</tr>
</table>
</subsection>
<subsection name="Standard Properties">
<p>
The following table details the set of standard properties
supported by Merlin as of 3.2.
</p>
<table>
<tr><th>Property</th><th>Default Value</th><th>Description</th></tr>
<tr>
<td>${merlin.home}</td>
<td>${user.home}/.merlin</td>
<td>The merlin installation directory. Can be overriden with the
environment variable MERLIN_HOME.</td>
</tr>
<tr>
<td>${merlin.system}</td>
<td>${merlin.home}/system</td>
<td>The merlin system repository.</td>
</tr>
<tr>
<td>${merlin.repository}</td>
<td>${avalon.home}</td>
<td>The application repository root directory. The default value
of ${avalon.home} is resolved relative to the environment variable
AVALON_HOME and if undefined, will fall back to ${user.home}/.avalon.</td>
</tr>
<tr>
<td>${merlin.config}</td>
<td>${merlin.home}/config</td>
<td>The merlin system configuration directory.</td>
</tr>
<tr>
<td>${merlin.kernel}</td>
<td>file:///${merlin.config}/kernel.xml</td>
<td>The merlin kernel configuration.</td>
</tr>
<tr>
<td>${merlin.context}</td>
<td>${merlin.dir}/home</td>
<td>The root directory used by merlin to construct the
persistent home directory supplied to a component under
the context key urn:avalon:home.</td>
</tr>
<tr>
<td>${merlin.ext}</td>
<td>${merlin.dir}</td>
<td>The root directory used by merlin to resolve jar
optional extension jar files.</td>
</tr>
<tr>
<td>${merlin.info}</td>
<td>false</td>
<td>The info generation policy. If 'true' a short
information header is generated on startup detailing the
kernel parameterization state.</td>
</tr>
<tr>
<td>${merlin.debug}</td>
<td>false</td>
<td>The debug generation policy. If 'true' all logging
channels are assigned the DEBUG logging priority.</td>
</tr>
<tr>
<td>${merlin.server}</td>
<td>true</td>
<td>
The default execution mode. If 'true' the merlin
kernel will continue until expliciy stopped or process
termination is invoked. If 'false' the kernel will
initiate decommissioning on completion of the deployment
phase.</td>
</tr>
<tr>
<td>${merlin.deployment}</td>
<td></td>
<td>
A comma seperated sequence of blocks to be included in the
root merlin application block on startup.</td>
</tr>
<tr>
<td>${merlin.override}</td>
<td></td>
<td>
The path to a configuration override targets file. Relative
path statements will be resolved relative to ${merlin.dir}.</td>
</tr>
</table>
</subsection>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org