diff options
| author | Mattias Andrée <maandree@operamail.com> | 2015-12-01 10:06:11 +0100 |
|---|---|---|
| committer | Mattias Andrée <maandree@operamail.com> | 2015-12-01 10:06:11 +0100 |
| commit | ca7334841f34ce517c2db22ce36ec6c8858890ff (patch) | |
| tree | 835bfa68bc887d2586f6e51f4bd58cf586783997 /doc | |
| parent | misc improvements (diff) | |
| download | slack-2.2.tar.gz slack-2.2.tar.bz2 slack-2.2.tar.xz | |
add man page2.2
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to '')
| -rw-r--r-- | doc/man/slack.1 | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/doc/man/slack.1 b/doc/man/slack.1 new file mode 100644 index 0000000..fffe191 --- /dev/null +++ b/doc/man/slack.1 @@ -0,0 +1,82 @@ +.TH SLACK 1 SLACK +.SH NAME +slack - Spawn processes with customised timer slack +.SH SYNOPSIS +.B slack +(get | GET) +.br +.B slack +.RI ((reset\ |\ INTERVAL ) +[\-\-fatal] [--] +.IR COMMAND ...) +.SH DESCRIPTION +If the verb +.B get +or +.B GET +is used, the current timer slack value and exit. If get is used, the +program shall use as high prefix as possible. If +.V GET +is used the value shall be printed in nanoseconds but not unit shall +be printed. +.PP +If the verb reset is used, the process shall set the timer slack value +for the process to the default timer slack value, and +.BR exec (3) +to +.IR COMMAND . +.PP +If an +.I INTERVAL +is given, the process shall set the timer slack value for the process +to +.IR INTERVAL , +and +.BR exec (3) +to +.IR COMMAND . +.PP +.I INTERVAL +must be a positive number, optionally with a prefix. Recognised +prefixes (and units) are: +.TP +.BR ns ,\ n +nanoseconds (default) +.TP +.BR µs ,\ µ ,\ us \,\ u +microseconds +.TP +.BR ms ,\ m +milliseconds +.TP +.BR s +seconds +.PP +The default timer slack value is the timer slack value on PID 1. +.SH OPTIONS +.TP +.B \-\-fatal +Fail if the timer slack value cannot be set. +.SH NOTES +Real-time threads do not slack around. +.SH RATIONALE +Could be useful increase the performance of your computer. +.SH "SEE ALSO" +.BR nice (1), +.BR ionice (1), +.BR prctl (2) +.SH AUTHORS +Principal author, Mattias Andrée. See the COPYING file for the full +list of authors. +.SH LICENSE +Copyright \(co 2014, 2015 Mattias Andrée +.br +License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>. +.br +This is free software: you are free to change and redistribute it. +.br +There is NO WARRANTY, to the extent permitted by law. +.SH BUGS +Please report bugs to https://github.com/maandree/slack/issues or to +maandree@member.fsf.org + |