summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPhilip Knirsch <pknirsch@hamburg.stuttgart.redhat.com>2009-02-25 12:30:07 +0100
committerPhilip Knirsch <pknirsch@hamburg.stuttgart.redhat.com>2009-02-25 12:30:07 +0100
commitc6e97c54cf38923f8c5cd515d53dc92af3c310b4 (patch)
tree506aaae4582c9e47d626e8b6a23293cebddf7c6f
parent60663d4e347ca6a114294b3dfd60d5f8539db1f6 (diff)
downloadtuned-c6e97c54cf38923f8c5cd515d53dc92af3c310b4.zip
tuned-c6e97c54cf38923f8c5cd515d53dc92af3c310b4.tar.gz
tuned-c6e97c54cf38923f8c5cd515d53dc92af3c310b4.tar.xz
- Added a manpage and updated the readme with it (as a start).
-rw-r--r--Makefile6
-rw-r--r--README24
-rw-r--r--doc/tuned.823
-rw-r--r--tuned.spec3
4 files changed, 52 insertions, 4 deletions
diff --git a/Makefile b/Makefile
index 4b13f60..6646f42 100644
--- a/Makefile
+++ b/Makefile
@@ -9,7 +9,7 @@ GITTAG = r$(subst .,-,$(VERSION))
DIRS = doc contrib tuningplugins monitorplugins
FILES = tuned tuned.spec Makefile tuned.py tuned.initscript tuned.conf
-FILES_doc = doc/README.txt doc/TIPS.txt
+FILES_doc = doc/README.txt doc/TIPS.txt doc/tuned.8
FILES_contrib = contrib/diskdevstat contrib/netdevstat
FILES_tuningplugins = tuningplugins/disk.py tuningplugins/net.py tuningplugins/__init__.py
FILES_monitorplugins = monitorplugins/disk.py monitorplugins/net.py monitorplugins/__init__.py
@@ -75,6 +75,10 @@ install:
mkdir -p $(DESTDIR)/etc/rc.d/init.d
install -m 0755 tuned.initscript $(DESTDIR)/etc/rc.d/init.d/tuned
+ # Install manpage
+ mkdir -p $(DESTDIR)/usr/share/man/man8
+ install -m 0644 doc/tuned.8 $(DESTDIR)/usr/share/man/man8
+
changelog:
git-log > ChangeLog
diff --git a/README b/README
index ecb1afb..ca20a43 100644
--- a/README
+++ b/README
@@ -1,4 +1,24 @@
-Tuned, a dynamic adaptive system tuning daemon
-==============================================
+NAME
+ tuned - dynamic adaptive system tuning daemon
+SYNOPSIS
+ tuned [options]
+DESCRIPTION
+ tuned is a dynamic adaptive system tuning daemon that tunes system settings dynamically depending on usage.
+
+OPTIONS
+ -d, --daemon
+ This options starts tuned as a daemon as opposed to in the foreground without forking at startup.
+
+ -c, --conffile="conffile"
+ Specify the name and path of the configuration file, default is /etc/tuned.conf.
+
+BUGS
+ There are no known bugs. To file bug reports, see AUTHORS below.
+
+AUTHOR
+ Written by Phil Knirsch <pknirsch@redhat.com>.
+
+REPORTING BUGS
+ Report bugs to <pknirsch@redhat.com>.
diff --git a/doc/tuned.8 b/doc/tuned.8
new file mode 100644
index 0000000..85b1209
--- /dev/null
+++ b/doc/tuned.8
@@ -0,0 +1,23 @@
+.TH tuned 8 "25 Feb 2009"
+.SH NAME
+tuned \- dynamic adaptive system tuning daemon
+.SH SYNOPSIS
+\fBtuned\fP [\fIoptions\fP]
+.SH DESCRIPTION
+\fBtuned\fR is a dynamic adaptive system tuning daemon
+that tunes system settings dynamically depending on
+usage.
+.SH OPTIONS
+.TP 12
+.BI \-d "\fR, \fP" \--daemon
+This options starts tuned as a daemon as opposed to
+in the foreground without forking at startup.
+.TP 12
+.BI \-c "\fR, \fP" \--conffile=" conffile"
+Specify the name and path of the configuration file, default is \fB/etc/tuned.conf\fR.
+.SH BUGS
+There are no known bugs. To file bug reports, see \fBAUTHORS\fP below.
+.SH AUTHOR
+Written by Phil Knirsch <pknirsch@redhat.com>.
+.SH REPORTING BUGS
+Report bugs to <pknirsch@redhat.com>.
diff --git a/tuned.spec b/tuned.spec
index e40e159..aa90258 100644
--- a/tuned.spec
+++ b/tuned.spec
@@ -53,11 +53,12 @@ fi
%files
%defattr(-,root,root)
-%doc AUTHORS ChangeLog COPYING INSTALL NEWS README doc/*
+%doc AUTHORS ChangeLog COPYING INSTALL NEWS README doc/README.txt doc/TIPS.txt
%{_initddir}/tuned
%config(noreplace) %{_sysconfdir}/tuned.conf
%{_sbindir}/tuned
%{_datadir}/tuned
+%{_mandir}/man8/*
%files utils
%defattr(-,root,root)