diff options
| author | Luke Yelavich <themuso@ubuntu.com> | 2010-01-18 14:27:02 +1100 |
|---|---|---|
| committer | Lennart Poettering <lennart@poettering.net> | 2010-02-17 02:41:30 +0100 |
| commit | d30db4ca250a2743872a525740d5177705072fda (patch) | |
| tree | 9f52ed7d8fbd98eca8065aa22fd252932fa1fa15 | |
| parent | ffad12e5f21f35c5b746d51fd1484909577528d4 (diff) | |
Add rtkitctl manpage
As Lennart asked about the rtkitctl manpage Ubuntu has, here is a patch against rtkit git.
| -rw-r--r-- | Makefile.am | 5 | ||||
| -rw-r--r-- | rtkitctl.8 | 46 |
2 files changed, 51 insertions, 0 deletions
diff --git a/Makefile.am b/Makefile.am index 65ab36c..725c191 100644 --- a/Makefile.am +++ b/Makefile.am @@ -68,3 +68,8 @@ rtkit_test_CFLAGS = \ org.freedesktop.RealtimeKit1.service: org.freedesktop.RealtimeKit1.service.in sed -e 's,@LIBEXECDIR\@,$(libexecdir),g' < $< > $@ + +man8_MANS = rtkitctl.8 + +EXTRA_DIST += \ + $(man8_MANS) diff --git a/rtkitctl.8 b/rtkitctl.8 new file mode 100644 index 0000000..403d477 --- /dev/null +++ b/rtkitctl.8 @@ -0,0 +1,46 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH RTKITCTL 8 "July 1, 2009" +.\" 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 +rtkitctl \- Realtime Policy and Watchdog daemon control +.SH SYNOPSIS +.B rtkitctl +.RI [ options ] +.SH DESCRIPTION +.B RealtimeKit +is a D-Bus system service that changes the scheduling policy of user processes/threads to SCHED_RR (i.e. realtime scheduling mode) on request. It is intended to be used as a secure mechanism to allow real-time scheduling to be used by normal user processes. +.SH OPTIONS +.TP +.B \-h, \-\-help +Show a summary of options. +.TP +.B \-\-version +Show version. +.TP +.B \-\-reset\-known +Reset real-time status of known threads. +.TP +.B \-\-reset\-all +Reset real-time status of all threads. +.TP +.B \-\-start +Start RealtimeKit if it is not running already. +.TP +.B \-k, \-\-exit +Terminate running RealtimeKit daemon. +.SH AUTHOR +RealtimeKit was written by Lennart Poettering <lennart@poettering.net>. |