.\"                                      Hey, EMACS: -*- nroff -*-
.TH CYCLICDEADLINE 8 "January 16, 2020"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
cyclicdeadline \- This program is used to test the deadline scheduler (SCHED_DEADLINE) using a cyclictest style program
.PP
.SH SYNOPSIS
.B cyclicdeadline
.RI "[-a [CPUSET]] [-D TIME] [-h]  [-i INTV] [--json FILENAME] [-s STEP] [-t NUM] [-q]"
.PP
.SH DESCRIPTION
.B cyclicdeadline
is a cyclictest style program for testing the deadline scheduler
.PP
.SH OPTIONS
.TP
.B \-a \-\-affinity [CPUSET]
Comma / hypen separated list of CPUs to run deadline tasks on
.TP
.B \-D \-\-duration TIME
Specify a length for the test to run
Append 'm', 'h', or 'd' to specify minutes, hours, or days
.TP
.B \-h \-\-help
Show this help menu
.TP
.B \-i \-\-interval INTV
The shortest deadline for the tasks in us. (default 1000us)
.TP
.B \-\-json=FILENAME
Write final results into FILENAME, JSON formatted.
.TP
.B \-s \-\-step STEP
The amount to increase the deadline for each task in us. (default 500us)
.TP
.B \-t \-\-threads NUM
The number of threads to run as deadline (default 1)
.TP
.B \-q, \-\-quiet
Print a summary only on exit. Useful for automated tests, where only
the summary output needs to be captured.
.TP
.B \-b, \-\-breaktrace=USEC
Send break trace command when latency > USEC
.TP
.B \-\-tracemark
write a trace mark when \-b latency is exceeded.
.br
.SH AUTHOR
cyclicdeadline was written by Steven Rostedt <rostedt@goodmis.org>
.PP
This manual page was written by John Kacur <jkacur@redhat.com>