.\" Man page derived from README.IN
.
.TH rt\-app 1 "2016-01-25" "rt\-app"
.nf
.SH NAME
rt\-app \- Test application for simulating a real\-time periodic load
.
.SH SYNOPSIS
.B rt\-app 
.I <config-file>
.
.SH INTRODUCTION
.B rt\-app
is a test application that starts multiple periodic threads in order to
simulate a real\-time periodic load. 
.PP
The code is currently maintained on GitHub:
\fI\%https://github.com/scheduler-tools/rt\-app\fP
.
.fi
.SH REQUIREMENTS
.B rt\-app
runs on GNU/Linux.  It needs json-c to run, and a 3.14
or later linux kernel supporting the SCHED_DEADLINE policy
(unless built without the optional libdl).
.
.SH USAGE
.B rt\-app
.I <config_file>
.
where config file is a full/relative path to a JSON file or "\-" (without quotes) to read JSON data from stdin.
.PP
See 
.I /usr/share/doc/rt\-app/tutorial.txt
for details of the JSON config file format
.PP
.
.SH SEE ALSO
.B workgen
.I <config_file>
can be used instead of rt\-app directly. It allows more freedom in writing the JSON workload files, by having a less strict grammar which is useful for defining multiple similar events. It will parse, check and update the JSON workload file before passing it to rt\-app. See
.BR workgen (7)
.PP
.PP
The python merge script (
.I /usr/share/doc/rt\-app/examples/merge.py
) can be 
used to combine JSON snippets into the config file. e.g:
.br 
.B  \./merge.py 
\-o 
.I combined.json global.json resources.json thread0.json thread1.json thread2.json thread3.json
.
.SH FILES
.nf
Numerous example workloads and building blocks can be found in
.I /usr/share/doc/rt\-app/examples/*.json
.fi