blob: caa785425663c5f2da5a232ea5a83d1a1eca358d [file] [log] [blame]
<HTML>
<head>
<TITLE>write-calc-doc - Transform profiling data into an OpenOffice Calc document.</TITLE>
<LINK REV="made" HREF="mailto:feedback@suse.de">
<meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8">
</head>
<body>
<A NAME="__index__"></A>
<!-- INDEX BEGIN -->
<UL>
<LI><A HREF="#name">NAME</A></LI>
<LI><A HREF="#synopsis">SYNOPSIS</A></LI>
<LI><A HREF="#description">DESCRIPTION</A></LI>
<LI><A HREF="#see also">SEE ALSO</A></LI>
<LI><A HREF="#feedback">FEEDBACK</A></LI>
</UL>
<!-- INDEX END -->
<HR>
<P>
<H1><A NAME="name">NAME</A></H1>
<P>write-calc-doc - Transform profiling data into an OpenOffice Calc document.</P>
<P>
<HR>
<H1><A NAME="synopsis">SYNOPSIS</A></H1>
<P>write-calc-doc &lt;options&gt;* &lt;log-file-name&gt; [&lt;output-file-name&gt;]</P>
<P>Transforms the profiling data in log-file-name into a Zip file named
output-file-name containing XML files that form an OpenOffice Calc document.
If output-file-name is not given, then the output file name is constructed
from the log file name by replacing its .log extension by .sxc.
Options are:</P>
<DL>
<DT><STRONG><A NAME="item_%2Di_%3Cfile%2Dname%3E">-i &lt;file-name&gt;</A></STRONG><BR>
<DD>
File containing regular expressions for the inclusion filter.
<P></P>
<DT><STRONG><A NAME="item_%2De_%3Cfile%2Dname%3E">-e &lt;file-name&gt;</A></STRONG><BR>
<DD>
File containing regular expressions for the exclusion filter.
<P></P>
<DT><STRONG><A NAME="item_%2Dh">-h</A></STRONG><BR>
<DD>
Print this usage information.
<P></P></DL>
<P>
<HR>
<H1><A NAME="description">DESCRIPTION</A></H1>
<P>The given log file is transformed into a collection of XML files that are then
zippped into a single file. The created XML files are:</P>
<DL>
<DT><STRONG><A NAME="item_META%2DINF%2Fmanifest%2Exml">META-INF/manifest.xml</A></STRONG><BR>
<DD>
List of these three files.
<P></P>
<DT><STRONG><A NAME="item_meta%2Exml">meta.xml</A></STRONG><BR>
<DD>
Some meta informations.
<P></P>
<DT><STRONG><A NAME="item_content%2Exml">content.xml</A></STRONG><BR>
<DD>
This file contains the actual Calc document.
<P></P></DL>
<P>The data for each thread is displayed on two Calc pages.</P>
<P>The first is merely a pretty-printed version of the
profiling data. It lists all time stamps in the order in which they have been
written. The first column contains the time on which the time stamp has been
written or to be more precise on which its writing has been requested. The
second column contains the amount of time that a function has taken to compute.
The remaining columns are used to display the function names optionally
followed by messages. The indentation indicates the calling hierarchy.</P>
<P>The second combines all time stamps with the same text and provides statistical
information like average run time and number of calls.</P>
<P>
<HR>
<H1><A NAME="see also">SEE ALSO</A></H1>
<P>See also <A HREF="./LogFile/Parser.html">the LogFile::Parser manpage</A>, <A HREF="./LogFile/Filter.html">the LogFile::Filter manpage</A>, <A HREF="./LogFile/Processor.html">the LogFile::Processor manpage</A>,
and <A HREF="./LogFile/XML.html">the LogFile::XML manpage</A>.</P>
<P>
<HR>
<H1><A NAME="feedback">FEEDBACK</A></H1>
<P>Please feel free to send your feedback to <A HREF="mailto:andre.w.fischer@sun.com">andre.w.fischer@sun.com</A></P>
</body>
</HTML>