Mitochondrion Files

MitoView 2.0

The MitoView tools are used to transform text records from the MitoLog or
other software logging facility into HTML or RTF documentation. The source
of the text records may be either an on-line source, such as an embedded
MitoLog object in a live software process or may be a text file produced by
some process.

The Mitochondrion.jar file holds all of the software and tools needed to
provide a web service or a command-line tool to transform this data. The JAR
file is intended to be platform independent and has been implemented in such
a way as to avoid any platform-specific resources.

The two most useful main functions in the JAR are 'Server' and 'Parse'. The
'Server' class may be used to start an httpd server on any local port to
act as a web proxy between the history requester or browser and the history
source. The command line argument is the TCP port on which to run the http
service. The following example runs the service on port '3456' of the local
machine.

    java -classpath Mitochondrion.jar Server 3456

The 'Parse' class may be used to directly transform history records into
documentation without the use of the server or proxy flow. The following
example transforms the history records served by a web process running on
TCP post '8765' of the local machine into an RTF document named 'test.rtf'.

    java -classpath Mitochondrion.jar \
        mitochondrion.MitoView.Tools.Parse \
        -rtf -url http://localhost:8765/history -output test.rtf

The following example transforms the history records in the 'example.trace'
file into an RTF document named 'test.rtf'.

    java -classpath Mitochondrion.jar \
        mitochondrion.MitoView.Tools.Parse \
        -rtf -file example.trace -output test.rtf