cvs commit: jakarta-log4j/src/xdocs/lf5 examples.xml
[email protected] 12 Jun 2002 21:31:35 -0000
| Newsgroups | gmane.comp.jakarta.log4j.cvs |
|---|---|
| Message-ID | <[email protected]> |
ceki 2002/06/12 14:31:35
Modified: . Tag: v1_2-branch build.xml
docs Tag: v1_2-branch HISTORY
src/xdocs Tag: v1_2-branch documentation.xml index.xml
plan.xml
src/xdocs/lf5 Tag: v1_2-branch examples.xml
Added: src/java/org/apache/log4j/lf5 Tag: v1_2-branch
lf5.properties
src/java/org/apache/log4j/lf5/config Tag: v1_2-branch
defaultconfig.properties
Log:
Changes corrections in documentation.
Revision Changes Path
No revision
No revision
1.34.2.6 +12 -0 jakarta-log4j/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-log4j/build.xml,v
retrieving revision 1.34.2.5
retrieving revision 1.34.2.6
diff -u -r1.34.2.5 -r1.34.2.6
--- build.xml 12 Jun 2002 01:29:33 -0000 1.34.2.5
+++ build.xml 12 Jun 2002 21:31:33 -0000 1.34.2.6
@@ -189,6 +189,13 @@
<classpath refid="compile.classpath"/>
</javac>
+ <copy todir="${javac.dest}">
+ <fileset dir="${java.source.dir}"
+ includes="${stem}/lf5/**/*.properties"/>
+ <fileset dir="${java.source.dir}"
+ includes="${stem}/lf5/viewer/images/*"/>
+ </copy>
+
</target>
<target name="build.examples" depends="build.core">
@@ -203,6 +210,11 @@
<rmic base="${javac.dest}"
classname="examples.NumberCruncherServer"
/>
+
+ <copy todir="${javac.dest}">
+ <fileset dir="." includes="examples/lf5/**/*.properties"/>
+ </copy>
+
</target>
<target name="build.xml" depends="init, jaxp" if="jaxp-present">
No revision
No revision
1.97.2.7 +4 -0 jakarta-log4j/docs/HISTORY
Index: HISTORY
===================================================================
RCS file: /home/cvs/jakarta-log4j/docs/HISTORY,v
retrieving revision 1.97.2.6
retrieving revision 1.97.2.7
diff -u -r1.97.2.6 -r1.97.2.7
--- HISTORY 11 Jun 2002 13:21:57 -0000 1.97.2.6
+++ HISTORY 12 Jun 2002 21:31:34 -0000 1.97.2.7
@@ -5,8 +5,12 @@
client code.
[***] Changes requiring important modifications to existing client code.
+ June 12th, 2002,
- Release of version 1.2.4
+
+ - Added LF5 documentation and examples. Further tests are required
+ for full integration. [*]
- XMLLayout can now output messages which contain embedded CDATA
sections. This resolves bug #9750. Many thanks Michael
No revision
No revision
1.1.2.1 +8 -0 jakarta-log4j/src/java/org/apache/log4j/lf5/Attic/lf5.properties
No revision
No revision
1.1.2.1 +16 -0 jakarta-log4j/src/java/org/apache/log4j/lf5/config/Attic/defaultconfig.properties
No revision
No revision
1.15.2.2 +6 -0 jakarta-log4j/src/xdocs/documentation.xml
Index: documentation.xml
===================================================================
RCS file: /home/cvs/jakarta-log4j/src/xdocs/documentation.xml,v
retrieving revision 1.15.2.1
retrieving revision 1.15.2.2
diff -u -r1.15.2.1 -r1.15.2.2
--- documentation.xml 17 May 2002 12:48:49 -0000 1.15.2.1
+++ documentation.xml 12 Jun 2002 21:31:35 -0000 1.15.2.2
@@ -24,6 +24,12 @@
<a href="api/index.html"><b>javadoc documentation</b></a>,
</li>
</p>
+
+ <p>
+ <li>
+ <a href="lf5/overview.html"><b>LogFactor5 documentation</b></a>,
+ </li>
+ </p>
<p>
<li>
1.8.2.1 +7 -8 jakarta-log4j/src/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-log4j/src/xdocs/index.xml,v
retrieving revision 1.8
retrieving revision 1.8.2.1
diff -u -r1.8 -r1.8.2.1
--- index.xml 6 Mar 2002 13:31:48 -0000 1.8
+++ index.xml 12 Jun 2002 21:31:35 -0000 1.8.2.1
@@ -53,14 +53,13 @@
remote log4j server, a remote Unix Syslog daemon, or even a NT
Event logger among many other output targets.</p>
- <p>On a 233 MHz ThinkPad running JDK 1.1.7B, it costs about 46
- nanoseconds to determine if that statement should be logged or
- not. Actual logging is also quite fast, ranging from 79
- microseconds using the SimpleLayout, 164 microseconds using
- the TTCCLayout and around a millisecond when printing
- exceptions. The performance of the PatternLayout is almost as
- good as the dedicated layouts, except that it is a lot more
- flexible.</p>
+ <p>On an AMD Duron clocked at 800Mhz running JDK 1.3.1, it costs
+ about 5 nanoseconds to determine if a logging statement should
+ be logged or not. Actual logging is also quite fast, ranging
+ from 21 microseconds microseconds using the SimpleLayout, 37
+ microseconds using the TTCCLayout. The performance of the
+ PatternLayout is almost as good as the dedicated layouts,
+ except that it is much more flexible.</p>
<p>The package is being constantly improved thanks to input from
users and code contributed by authors in the community.
1.7.2.1 +9 -10 jakarta-log4j/src/xdocs/plan.xml
Index: plan.xml
===================================================================
RCS file: /home/cvs/jakarta-log4j/src/xdocs/plan.xml,v
retrieving revision 1.7
retrieving revision 1.7.2.1
diff -u -r1.7 -r1.7.2.1
--- plan.xml 12 Apr 2002 10:01:11 -0000 1.7
+++ plan.xml 12 Jun 2002 21:31:35 -0000 1.7.2.1
@@ -3,7 +3,7 @@
<properties>
<author email="[email protected]">Ceki Gulcu</author>
- <title>Release plan for log4j 1.2</title>
+ <title>Release plan for log4j 1.3</title>
</properties>
<body>
@@ -35,10 +35,13 @@
<section name="Workplan for log4j 1.3">
- <p>With log4j 1.2 still in beta, the workplan for log4j 1.3 is
- obviously not final. It is included here to give you an idea
- of the future. The items are not listed in any particular
- order.
+ <p>The workplan for log4j 1.3 is not final. It is included here
+ to give you an idea of the future. The items are not listed in
+ any particular order. As always, there is no scheduled
+ release date. The lack of schedule suprises and disturbs some
+ people. Writing good software, like good cooking, takes
+ time. If we make you wait, it is to create a better and more
+ reliable product.
</p>
<table border="1" cellpadding="3" cellspacing="2">
@@ -234,11 +237,7 @@
<section name="Workplan for log4j 1.2">
<p>
- Here is workplan for the 1.2 release. As always, there is no
- scheduled release date. The lack of schedule suprises and
- disturbs some people. Writing good software, like good
- cooking, takes time. If we make you wait, it is to create a
- better and more reliable product.
+ Here is workplan for the 1.2 release.
</p>
<table border="1" cellpadding="3" cellspacing="2">
No revision
No revision
1.1.2.2 +187 -245 jakarta-log4j/src/xdocs/lf5/Attic/examples.xml
Index: examples.xml
===================================================================
RCS file: /home/cvs/jakarta-log4j/src/xdocs/lf5/Attic/examples.xml,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- examples.xml 11 Jun 2002 21:18:26 -0000 1.1.2.1
+++ examples.xml 12 Jun 2002 21:31:35 -0000 1.1.2.2
@@ -24,30 +24,20 @@
be done for you.</p>
<h4>Running the Example:</h4>
- <h4>Option 1:</h4>
+ <p>Let <code>LOG4J_HOME</code> be the the directory where you
+ installed log4j.</p>
<ul>
- <li>Navigate to the <b>examples\lf5</b> directory and double
- click the <b>InitUsingDefaultConfigurator.bat</b>
- file. </li>
- </ul>
-
-
- <h4>Option 2:</h4>
- <ul>
- <li>Ensure that the log4j.jar file is in your CLASSPATH</li>
-
- <li>Ensure that the LOG4J_HOME environment variable is set to
- the directory where you installed log4j</li>
+ <li>Ensure that <i>LOG4J_HOME/dist/classes</i> is in your
+ CLASSPATH.</li>
- <li>At the command line, change to the <font face="Courier
- New, Courier, mono">LOG4J_HOME\dist\classes</font>
- directory</li>
-
- <li>Type<b> </b>the following at the command line:<b> java
- examples.lf5.InitUsingDefaultConfigurator.InitUsingDefaultConfigurator</b>
+ <li>Ensure that a JAXP compatible XML parser is in is in your
+ CLASSPATH.</li>
+ <li>Type<b> </b>the following at the command line:
+
+ <p><b> java examples.lf5.InitUsingDefaultConfigurator.InitUsingDefaultConfigurator</b></p>
</li>
</ul>
@@ -58,49 +48,43 @@
programmatically. However, it is far more flexible to
configure log4j using configuration files. One common method
of configuring log4j involves using a properties file, and the
- <i>org.apache.log4j.PropertyConfigurator</i> class. The
- PropertyConfigurator class allows you to load properties from
- a standard properties document consisting of key=value
- pairs. This example demonstrates how to load LogFactor5 via a
- configuration file used by a PropertyConfigurator.</p>
+ <code>org.apache.log4j.PropertyConfigurator</code> class. The
+ <code>PropertyConfigurator</code> class allows you to load
+ properties from a standard properties document consisting of
+ key=value pairs. This example demonstrates how to load
+ LogFactor5 via a configuration file used by a
+ PropertyConfigurator.</p>
<p>This example uses a very basic properties file, which is
- loaded via a PropertyConfigurator. The example.properties
- file has only one property, which registers a LF5Appender with
- the root of the Category tree. The
- InitUsingPropertiesFile.java class loads this file using the
- PropertyConfigurator class. </p>
-
- <p><b>Note:</b> The example.properties file used in this example
- is loaded as a resource via your CLASSPATH. For this reason, the
- example will only work if the directory where you installed
- LogFactor5 is in your CLASSPATH</p>
+ loaded via a PropertyConfigurator. The
+ <i>example.properties</i> file has only one property, which
+ registers a <code>LF5Appender</code> with the root of the
+ Category tree. The <code>InitUsingPropertiesFile</code> class
+ loads this file using the <code>PropertyConfigurator</code>
+ class. </p>
+
+ <p><b>Note:</b> The <i>example.properties</i> file used in this
+ example is loaded as a resource via your CLASSPATH. For this
+ reason, the example will only work if the
+ <i>LOG4J_HOME/dist/classes</i> directory is in your
+ CLASSPATH</p>
<h4>Running the Example:</h4>
- <h4>Option 1:</h4>
- <ul>
- <li>Navigate to the <b>examples/lf5</b> directory and double
- click the <b>InitUsingPropertiesFile.bat</b> file.
- </li>
- </ul>
+ <p>Let <code>LOG4J_HOME</code> be the the directory where you
+ installed log4j.</p>
- <h4>Option 2:</h4>
<ul>
- <li>Ensure that the log4j.jar file is in your CLASSPATH</li>
- <li>Ensure that the LOG4J_HOME environment variable is set to the directory
- where you installed log4j</li>
-
- <li>Copy the provided log4j.properties file to a directory
- that is currently in your CLASSPATH.</li>
-
- <li>At the command line, change to the <font face="Courier
- New, Courier, mono">LOG4J_HOME\dist\classes</font>
- directory
- </li>
+ <li>Ensure that <i>LOG4J_HOME/dist/classes</i> is in your
+ CLASSPATH.</li>
+
+ <li>Ensure that a JAXP compatible XML parser is in is in your
+ CLASSPATH.</li>
- <li>Type<b> </b>the following at the command line:<b> java
- examples.lf5.InitUsingPropertiesFile</b>.<b>InitUsingPropertiesFile</b>
+ <li>Type<b> </b>the following at the command line:
+
+ <p><b> java
+ examples.lf5.InitUsingPropertiesFile</b>.<b>InitUsingPropertiesFile</b></p>x
</li>
</ul>
@@ -124,36 +108,33 @@
<p>This example uses a very basic XML properties file. The
example.xml file registers an LF5Appender with the root of the
Category tree. The InitUsingXMLPropertiesFile.java class loads
- this file using the DOMConfigurator class. </p>
- <p><b>Note:</b> The example.xml file used in this example is
- loaded as a resource via your CLASSPATH. For this reason, the
- example will only work if the directory where you installed
- LogFactor5 is in your CLASSPATH. You will also need an XML
- parser (e.g. Xerces or JAXP) in order to run this example.
+ this file using the DOMConfigurator class.
+ </p>
+
+ <p><b>Note:</b> The <i>example.xml</i> file used in this example
+ is loaded as a resource via your CLASSPATH. For this reason,
+ the example will only work if the
+ <i>LOG4J_HOME/dist/classes</i> directory is in your
+ CLASSPATH. You will also need an XML parser in order to run
+ this example.
</p>
<h4>Running the Example:</h4>
- <h4>Option 1:</h4>
- <ul>
- <li>Navigate to the <b>examples/lf5</b> directory and double
- click the <b>InitUsingXMLPropertiesFile.bat</b> file.
- </li>
- </ul>
+ <p>Let <code>LOG4J_HOME</code> be the the directory where you
+ installed log4j.</p>
- <h4>Option 2:</h4>
<ul>
- <li>Ensure that the log4j.jar file is in your CLASSPATH</li>
+ <li>Ensure that <i>LOG4J_HOME/dist/classes</i> is in your
+ CLASSPATH.</li>
- <li>Ensure that the LOG4J_HOME environment variable is set to
- the directory where you installed log4j
- </li>
-
- <li>At the command line, change to the LOG4J_HOME\dist\classes
- directory</li>
+ <li>Ensure that a JAXP compatible XML parser is in is in your
+ CLASSPATH.</li>
- <li>Type<b> </b>the following at the command line:<b> java
- examples.lf5.InitUsingXMLPropertiesFile.InitUsingXMLPropertiesFile</b>
+ <li>Type<b> </b>the following at the command line:
+
+ <p><b> java
+ examples.lf5.InitUsingXMLPropertiesFile.InitUsingXMLPropertiesFile</b></p>
</li>
</ul>
@@ -161,85 +142,73 @@
<!-- Example 4 -->
<!-- ======================================================== -->
- <h3><b><font color="#000099">Example 4:
- InitUsingLog4JProperties</font></b> </h3>
+ <h3><b><font color="#000099">Example 4:
+ InitUsingLog4JProperties</font></b> </h3>
+
+ <h4>Example Description:</h4>
+
+ <p>The log4j library does not make any assumptions about its
+ environment. In particular, there are no default log4j
+ appenders. Under certain well-defined circumstances however,
+ the static initializer of the <i>org.apache.log4j.Category
+ </i>class will attempt to automatically configure log4j. The
+ Java language guarantees that the static initializer of a
+ class is called once and only during the loading of a class
+ into memory. This automatic configuration is done from a file
+ named <b>log4j.properties</b>. If you have a log4j.properties
+ file in your CLASSPATH at the time that you instantiate a
+ Category, log4j will register any appenders in this file at
+ the root of the Category tree.
+ </p>
- <h4>Example Description:</h4>
+ <p>This example provides you with a very basic log4j.properties
+ file that you can add to your CLASSPATH in order to register
+ the LF5Appender with the Category class. If you put this file
+ somewhere in your CLASSPATH, all logging requests will now
+ automatically be redirected to the LogFactor5 logging console
+ in addition to any other Appenders you may have enabled.
+ </p>
- <p>The log4j library does not make any assumptions about its
- environment. In particular, there are no default log4j
- appenders. Under certain well-defined circumstances however,
- the static initializer of the <i>org.apache.log4j.Category
- </i>class will attempt to automatically configure log4j. The
- Java language guarantees that the static initializer of a
- class is called once and only during the loading of a class
- into memory. This automatic configuration is done from a
- file named <b>log4j.properties</b>. If you have a
- log4j.properties file in your CLASSPATH at the time that you
- instantiate a Category, log4j will register any appenders in
- this file at the root of the Category tree.
- </p>
-
- <p>This example provides you with a very basic
- log4j.properties file that you can add to your CLASSPATH in
- order to register the LF5Appender with the Category
- class. If you put this file somewhere in your CLASSPATH, all
- logging requests will now automatically be redirected to the
- LogFactor5 logging console in addition to any other
- Appenders you may have enabled.
- </p>
-
- <p>If you look at the InitUsingLog4JProperties.java file you
- will notice that no Configurators are used in the code. A
- Category is instantiated using the getInstance() method, and
- logging calls such as cat.debug( ) can be used immediately.
- </p>
-
- <p><b>Note: </b>Adding the log4j.properties file to your
- CLASSPATH will reduce the number of lines of code you have
- to write (e.g. you will not need to add lines such as
- PropertyConfigurator.configure(configFileResource)). However,
- you should be aware that using this default static
- initialization has application wide effects. All logging
- will be directed to LogFactor5 if you use this approach!
- </p>
-
- <p><b>Note:</b> If you are using a log4j.properties file in a web application,
- you need to be aware of the fact that the static initialization process uses
- the <b>system</b> class loader. As a result, if you add the log4j.properties
- file to your web application CLASSPATH, the classloader <b>will not</b> find
- the file! g4jSpecial/LF5Update/jakarta-log4j/docs/lf5/UsersGuide/example4.html
- </p>
-
- <h4>Running the Example:</h4>
-
- <h4>Option 1:</h4>
-
- <ul>
- <li>Navigate to the <b>examples/lf5</b> directory and double
- click the <b>InitUsingLog4JProperties.bat</b> file.
- </li>
- </ul>
-
- <h4>Option 2:</h4>
- <ul>
- <li>Ensure that the log4j.jar file is in your CLASSPATH</li>
+ <p>If you look at the InitUsingLog4JProperties.java file you
+ will notice that no Configurators are used in the code. A
+ Category is instantiated using the getInstance() method, and
+ logging calls such as cat.debug( ) can be used immediately.
+ </p>
- <li>Ensure that the LOG4J_HOME environment variable is set
- to the directory where you installed log4j</li>
+ <p><b>Note: </b>Adding the
+ <i>LOG4J_HOME/examples/lf5/InitUsingLog4JProperties/log4j.properties</i>
+ file to your CLASSPATH will reduce the number of lines of code
+ you have to write (e.g. you will not need to add lines such as
+ PropertyConfigurator.configure(configFileResource)). However,
+ you should be aware that using this default static
+ initialization has application wide effects. All logging will
+ be directed to LogFactor5 if you use this approach!
+ </p>
+
+ <h4>Running the Example:</h4>
+
+ <ul>
+ <li>Ensure that <i>LOG4J_HOME/dist/classes</i> is in your
+ CLASSPATH.</li>
- <li>Copy the provided log4j.properties file to a directory
- that is currently in your CLASSPATH. </li>
+ <li>Ensure that a JAXP compatible XML parser is in is in your
+ CLASSPATH.</li>
- <li>At the command line, change to the <font face="Courier New, Courier, mono">LOG4J_HOME\dist\classes</font> directory</li>
+ <li>Copy the provided
+ <i>LOG4J_HOME/examples/lf5/InitUsingLog4JProperties/log4j.properties</i>
+ file to a directory that is currently in your
+ CLASSPATH. </li>
- <li>Type<b> </b>the following at the command line:<b> java
- examples.lf5.InitUsingLog4JProperties.InitUsingLog4JProperties</b></li>
+ <li>Type<b> </b>the following at the command line:
- <li>After you are done running the example, make sure to remove this file again,
- otherwise the logging console will always be registered at the Category root
- automatically.</li>
- </ul>
+ <p><b> java
+ examples.lf5.InitUsingLog4JProperties.InitUsingLog4JProperties</b></p>
+ </li>
+
+ <li>After you are done running the example, make sure to
+ remove the <i>log4j.properties</i> file again, otherwise the
+ log4j will always be using the same configuration.</li>
+ </ul>
<!-- ======================================================== -->
<!-- Example 5 -->
@@ -308,27 +277,18 @@
</p>
<h4>Running the Example:</h4>
- <h4>Option 1:</h4>
- <ul>
-
- <li>Navigate to the <b>examples/lf5</b> directory and double
- click the <b>InitUsingMultipleAppenders.bat</b> file. </li>
-
- </ul>
- <h4>Option 2:</h4>
<ul>
- <li>Ensure that the log4j.jar file is in your CLASSPATH</li>
+ <li>Ensure that <i>LOG4J_HOME/dist/classes</i> is in your
+ CLASSPATH.</li>
- <li>Ensure that the LOG4J_HOME environment variable is set to the directory
- where you installed log4j</li>
+ <li>Ensure that a JAXP compatible XML parser is in is in your
+ CLASSPATH.</li>
- <li>At the command line, change to the <font face="Courier
- New, Courier, mono">LOG4J_HOME\dist\classes</font>
- directory</li>
+ <li>Type<b> </b>the following at the command line:
- <li>Type<b> </b>the following at the command line:<b> java
- examples.lf5.InitUsingMultipleAppenders.InitUsingMultipleAppenders</b>
+ <p><b> java
+ examples.lf5.InitUsingMultipleAppenders.InitUsingMultipleAppenders</b></p>
</li>
</ul>
@@ -400,39 +360,23 @@
log4j documenation.
</p>
- <h4>Running the Example:</h4>ate/jakarta-log4j/docs/lf5/UsersGuide/example6.html
- <h4>Option 1:</h4>
- <ul>
- <li>Navigate to the <b>examples/lf5</b> directory and double click the <b>UsingSocketAppenders.bat</b>
- file. After the server has finished loading, switch to the console window
- with the "Press any key to continue message" and press a key. This
- will start the client, which will log messages to the SocketServer running
- on port 8887.</li>
- </ul>
- <h4>Option 2:</h4>
-
+ <h4>Running the Example:</h4>
<ul>
- <li>Navigate to the <b>examples/lf5</b> directory and double
- click the <b>StartLog4JSocketServer.bat</b> file. Wait until
- the server is finished loading, and the LogFactor5 GUI shows
- the log message "Waiting to accept a new
- client". You can now double click the
- <b>StartLogFactor5Client.bat</b>, which will start the
- client and log some messages to the SocketServer.
- </li>
- </ul>
+ <li>Ensure that <i>LOG4J_HOME/dist/classes</i> is in your
+ CLASSPATH.</li>
+
+ <li>Ensure that a JAXP compatible XML parser is in is in your
+ CLASSPATH.</li>
+
+ <li> Start the SocketServer using the following command: </li>
+
+ <p><b>java org.apache.log4j.net.SimpleSocketServer 8887
+ LOG4J_HOME/examples/lf5/UsingSocketAppenders/socketserver.properties</b></p>
+
+ <li>At another command line, start the client using the
+ following command:</li>
- <h4>Option 3:</h4>
- <ul>
- <li>Ensure that the log4j.jar file is in your CLASSPATH for both the SocketServer
- and the client class (UsingSocketAppenders.class).</li>
- <li>At the command line, change to the <font face="Courier New, Courier, mono">LOG4J_HOME\dist\classes</font>
- directory</li>
- <li>Start the SocketServer using the following command: </li>
-<pre><b>java org.apache.log4j.net.SocketServer 8887 socketserver.properties</b></pre>
- <li>At the command line, start the client using the following command:</li>
- <pre><b> java examples.lf5.UsingSocketAppenders.UsingSocketAppenders</b>
- </pre>
+ <p><b> java examples.lf5.UsingSocketAppenders.UsingSocketAppenders</b></p>
</ul>
<!-- ======================================================== -->
@@ -443,24 +387,28 @@
<h4>Example Description:</h4>
<p>Log4J's RollingFileAppender gives you the ability to output
- log messages to a series of rolling files. However, there are no
- utilities available for reading in and viewing those files once they
- have been written. LogFactor5 provides developers with two easy ways
- to open and view log files. Log files can be opened locally using
- the 'Open' menu item or log files can be opened from a remote server
- using the 'Open URL' menu item. </p>
+ log messages to a series of rolling files. However, there are
+ no utilities available for reading in and viewing those files
+ once they have been written. LogFactor5 provides developers
+ with two easy ways to open and view log files. Log files can
+ be opened locally using the 'Open' menu item or log files can
+ be opened from a remote server using the 'Open URL' menu
+ item.
+ </p>
<p>An additional feature that was added to LogFactor5 was the
- ability to start the console window independent of Log4J. That is to
- say, you do not need to add a LF5Appender to your properties file to
- use LogFactor5. The benefit of this feature is that developers who
- run utilities like Ant to test their applications can now view their
- log files off-line (i.e. after their application has completed the
- test and the JVM has shut down). Moreover, the ability to open log
- files on a remote server provides the ability for multiple
- developers working on the same application to view log files
- independently. It also gives developers the ability to view log
- files both internally and from remote locations. </p>
+ ability to start the console window independent of Log4J. That
+ is to say, you do not need to add a LF5Appender to your
+ properties file to use LogFactor5. The benefit of this feature
+ is that developers who run utilities like Ant to test their
+ applications can now view their log files off-line (i.e. after
+ their application has completed the test and the JVM has shut
+ down). Moreover, the ability to open log files on a remote
+ server provides the ability for multiple developers working on
+ the same application to view log files independently. It also
+ gives developers the ability to view log files both internally
+ and from remote locations.
+ </p>
<p>This example uses the sample.log file created by Log4J's
RollingFileAppender. 1The format of the log file can be set in
@@ -468,7 +416,8 @@
<b>must</b> follow the LogFactor5 layout conventions in order
for LogFactor5 to open the file. The following is an example
of a properties file with the LogFactor5 conversion pattern
- added:</p>
+ added:
+ </p>
<pre><font face="Times New Roman, Times, serif">log4j.rootCategory= R
@@ -518,10 +467,17 @@
log4j conversion character.</p>
<h4>Running the Example:</h4>
+
<ul>
+ <li>Ensure that <i>LOG4J_HOME/dist/classes</i> is in your
+ CLASSPATH.</li>
+
+ <li>Ensure that a JAXP compatible XML parser is in is in your
+ CLASSPATH.</li>
- <li>Navigate to the <b>examples/lf5</b> directory and double
- click the <b>StartLogFactor5Console.bat</b> file. </li>
+ <li>Type<b> </b>the following at the command line:<b> java
+ org.apache.log4j.lf5.StartLogFactor5</b>
+ </li>
<li>Under the 'File' menu, select 'Open'.</li>
@@ -564,20 +520,17 @@
</pre>
<h4>Running the Example:</h4>
- <h4>Option 1:</h4>
<ul>
- <li>Navigate to the <b>examples/lf5</b> directory and double click the <b>UsingLogMonitorAdapter.bat</b>
- file.</li>
- </ul>
+ <li>Ensure that <i>LOG4J_HOME/dist/classes</i> is in your
+ CLASSPATH.</li>
+
+ <li>Ensure that a JAXP compatible XML parser is in is in your
+ CLASSPATH.</li>
- <h4>Option 2:</h4>
- <ul>
- <li>Ensure that the log4j.jar file is in your CLASSPATH</li>
- <li>Ensure that the LOG4J_HOME environment variable is set to the directory
- where you installed log4j</li>
- <li>At the command line, change to the <font face="Courier New, Courier, mono">LOG4J_HOME\dist\classes</font>
- directory</li>
- <li>Type<b> </b>the following at the command line:<b> java examples.lf5.UsingLogMonitorAdapter.UsingLogMonitorAdapter</b>
+ <li>Type<b> </b>the following at the command line:
+
+ <p><b>java
+ examples.lf5.UsingLogMonitorAdapter.UsingLogMonitorAdapter</b></p>
</li>
</ul>
@@ -620,28 +573,17 @@
</pre>
<h4>Running the Example:</h4>
- <h4>Option 1:</h4>
- <ul>
-
- <li>Navigate to the <b>examples/lf5</b> directory and double
- click the
- <b>CustomizedLogLevels_UsingLogMonitorAdapter.bat</b>
- file.</li>
- </ul>
-
- <h4>Option 2:</h4>
<ul>
- <li>Ensure that the log4j.jar file is in your CLASSPATH</li>
-
- <li>Ensure that the LOG4J_HOME environment variable is set to
- the directory where you installed log4j</li>
+ <li>Ensure that <i>LOG4J_HOME/dist/classes</i> is in your
+ CLASSPATH.</li>
- <li>At the command line, change to the <font face="Courier
- New, Courier, mono">LOG4J_HOME\dist\classes</font>
- directory</li>
+ <li>Ensure that a JAXP compatible XML parser is in is in your
+ CLASSPATH.</li>
- <li>Type<b> </b>the following at the command line:<b> java
- examples.lf5.UsingLogMonitorAdapter.CustomizedLogLevels</b>
+ <li>Type<b> </b>the following at the command line:
+
+ <p><b> java
+ examples.lf5.UsingLogMonitorAdapter.CustomizedLogLevels</b></p>
</li>
</ul>
</section>