'\" t
.\"     Title: latency
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: 2008/04/19
.\"    Manual: Xenomai Manual
.\"    Source: Xenomai 2.6.3
.\"  Language: English
.\"
.TH "LATENCY" "1" "2008/04/19" "Xenomai 2\&.6\&.3" "Xenomai Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
latency \- Xenomai timer latency benchmark
.SH "SYNOPSIS"
.sp
\fBlatency\fR [ options ]
.SH "DESCRIPTION"
.sp
\fBlatency\fR is part of the Xenomai test suite\&. It is a timer latency benchmark program\&. The system must run a suitable Xenomai enabled kernel with the respective module (xeno_timerbench)\&.
.SH "OPTIONS"
.sp
\fBlatency\fR accepts the following options:
.PP
\fB\-h\fR
.RS 4
print histograms of min, avg, max latencies
.RE
.PP
\fB\-g <file>\fR
.RS 4
dump histogram to <file> in a format easily readable with gnuplot\&. An example script for gnuplot may be found in scripts/histo\&.gp in Xenomai sources distribution
.RE
.PP
\fB\-s\fR
.RS 4
print statistics of min, avg, max latencies
.RE
.PP
\fB\-H <histogram\-size>\fR
.RS 4
default = 200, increase if your last bucket is full
.RE
.PP
\fB\-B <bucket\-size>\fR
.RS 4
default = 1000ns, decrease for more resolution
.RE
.PP
\fB\-p <period_us>\fR
.RS 4
sampling period
.RE
.PP
\fB\-l <data\-lines per header>\fR
.RS 4
default=21, 0 to supress headers
.RE
.PP
\fB\-T <test_duration_seconds>\fR
.RS 4
default=0, so ^C to end
.RE
.PP
\fB\-q\fR
.RS 4
supresses RTD, RTH lines if \-T is used
.RE
.PP
\fB\-D <testing_device_no>\fR
.RS 4
number of testing device, default=0
.RE
.PP
\fB\-t <test_mode>\fR
.RS 4
0=user task (default), 1=kernel task, 2=timer IRQ
.RE
.PP
\fB\-f\fR
.RS 4
freeze trace for each new max latency
.RE
.PP
\fB\-c <cpu>\fR
.RS 4
pin measuring task down to given CPU
.RE
.PP
\fB\-P <priority>\fR
.RS 4
task priority (test mode 0 and 1 only)
.RE
.PP
\fB\-b\fR
.RS 4
break upon mode switch
.RE
.SH "AUTHOR"
.sp
\fBlatency\fR was written by Philippe Gerum\&. This man page was written by Roland Stigge\&.