rainlance/ntpa
1
0
Fork 0
mirror of https://bitbucket.org/anguist/ntpa synced 2025-11-21 10:13:00 +00:00
Code Releases Activity

Updated documentation

Browse Source
This commit is contained in:
Carsten Sonne Larsen
2016-06-26 21:07:01 +02:00
parent d4f5f1dd8a
commit 504b9e91be
4 changed files with 93 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
docs/ntpa.8
View File

@ -1,8 +1,8 @@
.TH ntpa 8 "27 May 2016"
.TH ntpa 8 "26 June 2016"
.ad
.fi
.SH "NAME"
ntpa
\fBntpa\fR
\-
NTP Analyzer daemon program
.SH "SYNOPSIS"
@ -13,19 +13,20 @@ NTP Analyzer daemon program
.SH "DESCRIPTION"
The
.B ntpa
deamon is the core process in the NTP Analyzer system.
daemon is the core process in the NTP Analyzer system.
.B ntpa(8)
is responsible
for collecting data from NTP daemons and for generating graphs and web pages.
.B ntpa(8)
also perform other tasks like sending status mails.
is responsible for collecting data from NTP daemons. Data are collected using
\fBntpq(8)\fR and \fBntpctl(8)\fR.
The ntpa daemon also generates graphs and web pages and perform other tasks
like sending status mails.
.PP
The graphs and html pages generated by ntpa are placed in the ntpa www directory and
can be presented by any web server. Supporting javascript and css files are also
located in the ntpa www directory.
The graphs and HTML files generated by ntpa are placed in the ntpa www
directory and can be presented by any web server. Additional JavaScript
and CSS files are also located in the ntpa www directory.
.PP
NTP Analyzer uses the Twitter Bootstrap and the jQuery framework to make webpages
responsive. Pages can not only be viewed on traditional PC screens but also on mobile devices.
NTP Analyzer uses the Twitter Bootstrap and the jQuery framework to
make web pages responsive. Pages can not only be viewed on traditional
PC screens but also on mobile devices.
.PP
.B ntpa
can be started with the following options:
@ -40,6 +41,23 @@ The name of the instance.
.IP "\fB\--help\fR"
Show help and version info.
.SH "KNOWN BUGS"
Counters for packets received, Packets received accumulated and Packets
received since reset are signed 32 bit and overflows are not handled.
Values above 2,147,483,647 are shown as 0.
.PP
When a host page is configured to be shown in UTC but data was recorded in
local time graphs and time stamps mismatch. The same applies for host pages
shown in local time but data is recorded in UTC.
.PP
Due to a thread issue
.B ntpa(8)
sometimes make a SEG FAULT upon start up. This apparently happens if too
many graph are drawn at the same time.
.PP
Configuration setting which are not recognized are ignored. No errors
are shown for faulty keywords.
.SH "SEE ALSO"
.na
.nf

39
docs/workman Executable file
View File

@ -0,0 +1,39 @@
#! /bin/sh
# Taken from the tz distribution. Used to create the README file.
# This file is in the public domain, so clarified as of
# 2009-05-17 by Arthur David Olson.
# Tell groff not to emit SGR escape sequences (ANSI color escapes).
GROFF_NO_SGR=1
export GROFF_NO_SGR
# Tell groff to emit SGR escape sequences (ANSI color escapes).
#GROFF_SGR=1
#export GROFF_SGR
echo ".am TH
.hy 0
.na
..
.rm }H
.rm }F" | nroff -man - ${1+"$@"} | perl -ne '
binmode STDIN, '\'':encoding(utf8)'\'';
binmode STDOUT, '\'':encoding(utf8)'\'';
chomp;
s/.\010//g;
s/\s*$//;
if (/^$/) {
$sawblank = 1;
next;
} else {
if ($sawblank && $didprint) {
print "\n";
$sawblank = 0;
}
print "$_\n";
$didprint = 1;
}
'