.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "xentrace_format 1"
.TH xentrace_format 1 2024-03-09 4.17.4-pre Xen
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
xentrace_format \- pretty\-print Xen trace data
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBxentrace_format\fR [ \fIDEFS-FILE\fR ]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBxentrace_format\fR parses trace data in \fBxentrace\fR binary format from
standard input and reformats it according to the rules in a file of
definitions (\fIDEFS-FILE\fR), printing to standard output.
.PP
The rules in \fIDEFS-FILE\fR should have the format shown below:
.PP
\&\fIevent_id\fR \fIwhitespace\fR \fIformat\fR
.PP
Each rule should start on a new line.
.PP
The format string may include format specifiers, such as:
%(cpu)d, %(tsc)d, %(event)d, %(1)d, %(2)d, %(3)d, %(4)d, %(5)d
.PP
[ the `d' format specifier output in decimal, alternatively `x'
  will output in hexadecimal and `o' will output in octal ]
.PP
These correspond to the CPU number, event ID, timestamp counter and
the 5 data fields from the trace record.  There should be one such
rule for each type of event to be pretty-printed (events which do not
have formatting rules are ignored).
.PP
A sample format file for Xen's predefined trace events is available
in the file tools/xentrace/formats in the Xen source tree.
.PP
Depending on your system and the rate at which trace data is produced,
this script may not be able to keep up with the output of
\&\fBxentrace\fR if it is piped directly.  In these circumstances you
should have \fBxentrace\fR output to a file for processing off-line.
.SH AUTHOR
.IX Header "AUTHOR"
Mark A. Williamson <mark.a.williamson@intel.com>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBxentrace\fR\|(8)