<?xml version="1.0"?>
<document>

  <properties>
    <author email="ceki at qos ddoott ch ">Ceki Gulcu</author>
    <author email="sebastien at qos ddoott ch ">Sebastien Pennec</author>
    <title>Logback Examples</title>
  </properties>
  
	<body>

<h2>Classpath Setup</h2>

<p>
In order to run the examples provided in the documentation,
you need to add the following jars to your class path:
</p>

<ul>
	<p>logback-core-${version}.jar</p>
	<p>logback-classic-${version}.jar</p>
	<p>logback-examples-${version}.jar</p>
	<p>slf4j-api-${slf4j.version}.jar</p>
</ul>

<h3>Example</h3>

<p>
Assuming your current directory is
<em>$LOGBACK_HOME/logback-examples</em>, where <em>$LOGBACK_HOME</em> stands
for the directory where you installed logback, you can launch the first
sample application, <em>chapter1.HelloWord1</em> with the following command:
</p>

<div class="source"><pre>java -cp
 lib/slf4j-api-${slf4j.version}.jar;../logback-core-${version}.jar;\
 ../logback-classic-${version}.jar;logback-examples-${version}.jar\
 chapter1.HelloWorld1</pre></div>

<p>
It is more convenient to set the CLASSPATH environment variable
once and for all before running the examples.
</p>
<p>The <em>setClasspath.cmd</em> script located in the $LOGBACK_HOME/logback-examples 
folder will configure the class path for the MS Windows platform. For Unix, you can
use <em>setClasspath.sh</em>.
</p>

<p>Please edit the script in order to adapt the <em>LB_HOME</em> variable 
to match your local environment.</p>

<p>
Please be aware that many examples will launch java classes along
with configuration files. To access these files by using
the same commands as written in the documentation, you will need to
issue the commands from within the <em>$LOGBACK_HOME/logback-examples</em> 
directory.
</p>


















	</body>
</document>