From a08292f4e6c5f1ccb7d6430e959c4bd18d13915a Mon Sep 17 00:00:00 2001 From: "Bjoern B. Brandenburg" Date: Sun, 27 May 2007 20:29:42 -0400 Subject: added README for release --- README | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 README (limited to 'README') diff --git a/README b/README new file mode 100644 index 0000000..5a6ad11 --- /dev/null +++ b/README @@ -0,0 +1,44 @@ +LITMUS^RT User-Space Library: liblitmus +======================================= + + Copyright (c) 2007 + The University of North Carolina at Chapel Hill + Department of Computer Science + Real-Time Systems Group + Dr. Anderson & students + http://www.cs.unc.edu/~anderson/litmus-rt/ + +Released as open source under the terms of the GNU General Public License +(GPL). + +Overview +======== +This library and the included tools provide the user-space interface to +LITMUS^RT. Real-time tasks should link against this library. The header file +"litmus.h" contains all necessary system calls and definitions to interact with +the kernel services provided for real-time tasks. + +Tools +===== + +* set_rt_mode {on|off} + Enter or exit real-time mode. Real-time tasks are only scheduled by the + kernel if the system is in real-time mode. + +* showsched + Print the name of the currently active scheduler. Schedulers are selected at + boot time with the "rtsched=" kernel parameter. + +* rt_launch {-p } ... + Launch the program as a real-time task provisioned with the given + worst-case execution time and priod. Any additional parameters are passed on + to the real-time task. + +Install +======= +The library and the included tools must be compiled from source. Currently, +the library and all tools are compiled by by issuing the +command: + + $ make + -- cgit v1.2.2