'\" t
.\"     Title: cyclictest
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: 2008/04/01
.\"    Manual: Xenomai Manual
.\"    Source: Xenomai 2.6.4
.\"  Language: English
.\"
.TH "CYCLICTEST" "1" "2008/04/01" "Xenomai 2\&.6\&.4" "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"
cyclictest \- Xenomai high resolution timer test
.SH "SYNOPSIS"
.sp
\fBcyclictest\fR [options]
.SH "DESCRIPTION"
.sp
\fBcyclictest\fR is part of the Xenomai test suite and tests the POSIX skin of Xenomai with a cyclic timer test\&.
.sp
For this program to work, you need to run a suitable Xenomai enabled kernel with the respective module (xeno_posix)\&.
.SH "OPTIONS"
.sp
\fBcyclictest\fR accepts the following options:
.PP
\fB\-b USEC, \-\-breaktrace=USEC\fR
.RS 4
send break trace command when latency > USEC
.RE
.PP
\fB\-c CLOCK, \-\-clock=CLOCK\fR
.RS 4
select clock: 0 = CLOCK_MONOTONIC (default) 1 = CLOCK_REALTIME
.RE
.PP
\fB\-d DIST, \-\-distance=DIST\fR
.RS 4
distance of thread intervals in us default=500
.RE
.PP
\fB\-i INTV, \-\-interval=INTV\fR
.RS 4
base interval of thread in us default=1000
.RE
.PP
\fB\-l LOOPS, \-\-loops=LOOPS\fR
.RS 4
number of loops: default=0 (endless)
.RE
.PP
\fB\-n, \-\-nanosleep\fR
.RS 4
use clock_nanosleep
.RE
.PP
\fB\-p PRIO, \-\-prio=PRIO\fR
.RS 4
priority of highest prio thread
.RE
.PP
\fB\-q, \-\-quiet\fR
.RS 4
print only a summary on exit
.RE
.PP
\fB\-r, \-\-relative\fR
.RS 4
use relative timer instead of absolute
.RE
.PP
\fB\-t NUM, \-\-threads=NUM\fR
.RS 4
number of threads: default=1
.RE
.PP
\fB\-v, \-\-verbose\fR
.RS 4
output values on stdout for statistics

format: n:c:v n=tasknum c=count v=value in us
.RE
.SH "AUTHOR"
.sp
\fBcyclictest\fR was written by Thomas Gleixner\&. This man page was written by Roland Stigge\&.