initial working release

1 files changed, 47 insertions, 123 deletions

diff --git a/docs/guprecords.1 b/docs/guprecords.1
index ab84c6c..06050bd 100644
--- a/docs/guprecords.1
+++ b/docs/guprecords.1
@@ -123,146 +123,70 @@
 .rm #[ #] #H #V #F C
 .\" ========================================================================
 .\"
-.IX Title "FOO 1"
-.TH FOO 1 "2014-02-03" "guprecords 0.0.0.0" "User Commands"
+.IX Title "GUPRECORDS 1"
+.TH GUPRECORDS 1 "2014-03-02" "guprecords 0.0.0.0" "User Commands"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
 .nh
 .SH "NAME"
-guprecords \- A template project
-.SH "WTF?"
-.IX Header "WTF?"
-You may use this project in order to build your own Debian package for your own project. This has been tested with Debian GNU/Linux Squeeze and Debian GNU/Linux Wheezy.
-.PP
-Feel free to modify any aspects. This project is just an empty example guprecords.
-.PP
-Follow these steps:
-.SS "Install required packages"
-.IX Subsection "Install required packages"
-Run the following:
+guprecords \- Global uptime records
+.PP
+Shows uprecord stats of several hosts at once.
+.SS "Synopsis"
+.IX Subsection "Synopsis"
+guprecords [\-\-help] [\-\-total|\-\-all] [\-\-count=i] [\-\-indir=s]
+.SS "Parameters"
+.IX Subsection "Parameters"
+.IP "\-\-help" 4
+.IX Item "--help"
+Shows the help
+.IP "\-\-total" 4
+.IX Item "--total"
+Aggregates a total uptime for every single host.
+.IP "\-\-all" 4
+.IX Item "--all"
+Shows every individual uptime of all hosts.
+.IP "\-\-count=i" 4
+.IX Item "--count=i"
+Show i num of entries. Default is 23.
+.IP "\-\-indir=s" 4
+.IX Item "--indir=s"
+Read all the *.records files from dir s. Default is ./
+.SS "Quick getting started"
+.IX Subsection "Quick getting started"
+\fIUptimed\fR
+.IX Subsection "Uptimed"
+.PP
+Firstival, you need to collect uprecords using the uptimed deaemon. To install it run:
 .PP
 .Vb 1
-\&    sudo aptitude install lintian devscripts dpkg\-dev make perl
+\&    sudo aptitude install uptimed
 .Ve
 .PP
-Todo: Ensure this are the correct packages. In order to test that I would have to setup a blank Debian system.
-.SS "Compile the project"
-.IX Subsection "Compile the project"
-Go to the to level directory and run
-.PP
-.Vb 1
-\&    make
-.Ve
+Please consult the uptimed and uprecords manpages. Please ensure to understand how it works and what it does.
 .PP
-To test run
+uptimed collects uprecords to
 .PP
 .Vb 1
-\&    ./bin/guprecords
+\&  /var/spool/uptimed/records
 .Ve
 .PP
-It should print out the version number of the project.
-.SS "Create a Debian package"
-.IX Subsection "Create a Debian package"
-Go to the to level directory and run
-.PP
-.Vb 1
-\&    make deb
-.Ve
-.PP
-It will create the files like:
-.PP
-.Vb 4
-\&    ../guprecords_0.0.0.0_all.deb
-\&    ../guprecords_0.0.0.0.dsc
-\&    ../guprecords_0.0.0.0_amd64.changes
-\&    ../guprecords_0.0.0.0.tar.gz
-.Ve
+And this file is used by guprecords for further processing.
 .PP
-It should create a debian package in ../. Check and install it, e.g:
-.PP
-.Vb 2
-\&    lintian \-\-pedantic ../guprecords_0.0.0.0_all.deb 
-\&    sudo dpkg \-i ../guprecords_0.0.0.0_all.deb
-.Ve
-.PP
-Run
-.PP
-.Vb 1
-\&    dpkg \-L guprecords
-.Ve
-.PP
-to see whats in there. You can now run
-.PP
-.Vb 1
-\&    /usr/bin/guprecords
-.Ve
+\fICollect all the uprecords\fR
+.IX Subsection "Collect all the uprecords"
 .PP
-or for example
+You may have several hosts with uptimed running already. Collect all the records file to a central repository (e.g. git).  Name each file \s-1FQDN\s0.records and run
 .PP
 .Vb 1
-\&    man guprecords
+\&  guprecords \-\-indir ./
 .Ve
-.SS "Read the Makefile"
-.IX Subsection "Read the Makefile"
-Read the Makefile in order to understand what's going on.
-.SH "Customize"
-.IX Header "Customize"
-Now, since you understood everything feel free to customize everything the way you want it. E.g.:
 .PP
-.Vb 1
-\&    Don\*(Aqt use POD for documentation but LaTeX
-\&
-\&    Compile a C program
-\&
-\&    Include a ./lib dir, add it to the \*(Aqinstall\*(Aq Makefile rule
-\&
-\&    etc etc.
-.Ve
-.PP
-You should also consider the following:
-.SS "Manual page"
-.IX Subsection "Manual page"
-This template is using \s-1POD\s0 for creating manual pages. Edit ./docs/guprecords.pod and run
-.PP
-.Vb 1
-\&    make documentation
-.Ve
-.PP
-in order to build ./docs/guprecords.1. The page will be included in the resulting debian package automatically. You can review the page with
-.PP
-.Vb 1
-\&    man ./docs/guprecords.1
-.Ve
-.SS "Renaming guprecords into your project name"
-.IX Subsection "Renaming guprecords into your project name"
-Rename all files which have *guprecords* included into your own new package name. You can do that with:
-.PP
-.Vb 3
-\&    PROJECTNAME=yourproject
-\&    find . \-name \e*guprecords\e* | 
-\&    while read guprecords; do git mv $guprecords ${guprecords/guprecords/$PROJECTNAME}; done
-.Ve
-.PP
-Search all content and rename *guprecords* into your own new package name. You can do that with:
-.PP
-.Vb 2
-\&    grep \-R guprecords . | grep \-v .git | 
-\&    cut \-d: \-f1 | uniq | xargs sed \-i "s/guprecords/$PROJECTNAME/g"
-.Ve
-.SS "Updating ./debian"
-.IX Subsection "Updating ./debian"
-Edit the following files accordingly to your new project (e.g. with vim):
-.PP
-.Vb 3
-\&    ./debian/control
-\&    ./debian/copyright
-\&    ./debian/README
-.Ve
-.SS "Update changelog"
-.IX Subsection "Update changelog"
-Go to the to level directory and run
-.PP
-.Vb 1
-\&    dch \-i
-.Ve
+You may automate the collecting of all the uprecords using something like cron or puppet.
+.SH "LICENSE"
+.IX Header "LICENSE"
+Se package description or project website.
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+Paul Buetow \- <http://guprecords.buetow.org>