diff options
| -rw-r--r-- | README.rst | 72 |
1 files changed, 61 insertions, 11 deletions
@@ -1,16 +1,66 @@ -# rts +rts +=== +rts - as in `*r*eal-*t*ime *s*settings` is a script used by a |systemd| |systemd.service|, allowing to set pre-defined real-time related scheduling settings. +This software and all of its components are licensed under the GPLv3. -## About -rts is a collection of systemd services and scripts that allow to set pre-defined real-time related scheduling settings (using [tuna](https://rt.wiki.kernel.org/index.php/Tuna) for example). +Requirements +------------ +* |linux-rt| +* |tuna| -## Requirements +"REALTIME" kernel parameter +--------------------------- +| *rts.service* and *rts@.service* are dependant on the |kernel_parameter| *"systemd.setenv=REALTIME=true"*. The option itself sets nothing but an Environment for systemd. +| This enables the services to by using *ConditionKernelCommandLine* in their *[Unit]* sections, if running a |real-time_kernel|. +| Simply add this to your kernel parameters (for |linux-rt|), using |grub|, |syslinux|, or |systemd-boot|: -* linux-rt -* tuna + .. code:: bash -## Usage -When starting the systemd service *rts.service*, the general settings file */etc/rts/rts* will be sourced. -Using *rts@.service* a configuration file (by the name of the word following the *@*) from the */etc/rts/* folder. + systemd.setenv=REALTIME=true + +Usage +----- +| When starting the systemd service *rts.service*, the general settings file */etc/rts/rts* will be sourced. +| Using *rts@.service* a configuration file (by the name of the word following the *@*) below `/etc/rts/` will be used. +| Some examples can be found in `/etc/rts/examples`. For further settings and a general overview, please have a look at the |tuna_documentation| + +.. |systemd| raw:: html + + <a href="https://en.wikipedia.org/wiki/Systemd" target="_blank">systemd</a> + +.. |systemd.service| raw:: html + + <a href="http://www.freedesktop.org/software/systemd/man/systemd.service.html" target="_blank">service</a> + +.. |real-time_kernel| raw:: html + + <a href="https://www.kernel.org/pub/linux/kernel/projects/rt/" target="_blank">real-time kernel</a> + +.. |linux-rt| raw:: html + + <a href="https://aur.archlinux.org/packages/linux-rt/" target="_blank">linux-rt</a> + +.. |kernel_parameter| raw:: html + + <a href="https://www.kernel.org/doc/Documentation/kernel-parameters.txt" target="_blank">kernel parameter</a> + +.. |grub| raw:: html + + <a href="https://wiki.archlinux.org/index.php/Kernel_parameters#GRUB" target="_blank">GRUB</a> + +.. |syslinux| raw:: html + + <a href="https://wiki.archlinux.org/index.php/Kernel_parameters#Syslinux" target="_blank">syslinux</a> + +.. |systemd-boot| raw:: html + + <a href="https://wiki.archlinux.org/index.php/Kernel_parameters#systemd-boot" target="_blank">systemd-boot</a> + +.. |tuna| raw:: html + + <a href="https://rt.wiki.kernel.org/index.php/Tuna" target="_blank">tuna</a> + +.. |tuna_documentation| raw:: html + + <a href="https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_MRG/1.3/html-single/Tuna_User_Guide/index.html" target="_blank">tuna documentation</a> -## License -This software and all of its components is licensed under the GPLv3. |