aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--COPYING2
-rw-r--r--Makefile14
-rw-r--r--README10
-rw-r--r--doc/man/slack.182
4 files changed, 100 insertions, 8 deletions
diff --git a/COPYING b/COPYING
index ca6cb97..6a5da49 100644
--- a/COPYING
+++ b/COPYING
@@ -1,5 +1,5 @@
slack — Spawn processes with customised timer slack
-Copyright © 2014 Mattias Andrée (maandree@member.fsf.org)
+Copyright © 2014, 2015 Mattias Andrée (maandree@member.fsf.org)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
diff --git a/Makefile b/Makefile
index 8569981..b60ee82 100644
--- a/Makefile
+++ b/Makefile
@@ -18,6 +18,10 @@ DATADIR = $(PREFIX)$(DATA)
DOCDIR = $(DATADIR)/doc
# The info manual documentation path including prefix
INFODIR = $(DATADIR)/info
+# The man page documentation path including prefix
+MANDIR = $(DATADIR)/man
+# The man page section 1 path including prefix
+MAN1DIR = $(MANDIR)/man1
# The license base path including prefix.
LICENSEDIR = $(DATADIR)/licenses
@@ -109,7 +113,7 @@ bin/slack.fish: src/completion
# Install rules.
.PHONY: install
-install: install-base install-info install-shell
+install: install-base install-info install-man install-shell
.PHONY: install
install-all: install-base install-doc install-shell
@@ -140,7 +144,7 @@ install-license:
# Install documentation.
.PHONY: install-doc
-install-doc: install-info install-pdf install-ps install-dvi
+install-doc: install-info install-pdf install-ps install-dvi install-man
.PHONY: install-info
install-info: bin/slack.info
@@ -162,6 +166,11 @@ install-dvi: bin/slack.dvi
install -dm755 -- "$(DESTDIR)$(DOCDIR)"
install -m644 $< -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).dvi"
+.PHONY: install-man
+install-man: doc/man/slack.1
+ install -dm755 -- "$(DESTDIR)$(MAN1DIR)"
+ install -m644 $< -- "$(DESTDIR)$(MAN1DIR)/$(COMMAND).1"
+
# Install shell auto-completion.
.PHONY: install-shell
@@ -195,6 +204,7 @@ uninstall:
-rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).pdf"
-rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).ps"
-rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).dvi"
+ -rm -- "$(DESTDIR)$(MAN1DIR)/$(COMMAND).1"
-rm -- "$(DESTDIR)$(DATADIR)/fish/completions/$(COMMAND).fish"
-rmdir -- "$(DESTDIR)$(DATADIR)/fish/completions"
-rmdir -- "$(DESTDIR)$(DATADIR)/fish"
diff --git a/README b/README
index c95ef55..f37b858 100644
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
NAME
- slack - Control your timer slack
+ slack - Spawn processes with customised timer slack
SYNOPSIS
slack (get | GET)
@@ -23,7 +23,7 @@ DESCRIPTION
timer slack value for the process to INTERVAL, and
exec(3) to COMMAND.
- INTERVAL must be a positive number, optioanlly with
+ INTERVAL must be a positive number, optionally with
a prefix. Recognised prefixes (and units) are:
ns, n nanoseconds (default)
@@ -38,12 +38,12 @@ OPTIONS
--fatal
Fail if the timer slack value cannot be set.
+NOTES
+ Real-time threads do not slack around.
+
RATIONALE
Could be useful increase the performance of your computer.
-NOTES:
- Real-time threads do not slack around.
-
SEE ALSO
nice(1) ionice(1), prctl(2)
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
+