ntpa/docs/ntpa.1

67 lines
1.8 KiB
Groff

.TH ntpa 1 "22 July 2017"
.ad
.fi
.SH NAME
\fBntpa\fR
\-
NTP Analyzer daemon program
.SH SYNOPSIS
.na
.nf
.fi
\fBntpa\fR \fB\--config \fIfile\fR [\fB\--temp \fIpath\fR] [\fB\--writepid \fIfile\fR] [\fB\--daemon \fIname\fR]
.SH DESCRIPTION
The
.B ntpa
daemon is the core process in the NTP Analyzer system.
.B ntpa(1)
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 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
Pages can be made responsive by configuring them with Bootstrap and jQuery.
This way they are viewable on mobile devices and not only on traditional PC
screens.
.SH OPTIONS
.PP
.B ntpa
can be started with the following options:
.IP "\fB\--config\fR \fIfile\fR"
Mandatory configuration file.
.IP "\fB\--temp\fR \fIpath\fR"
Specifies the working directory. Default is /tmp
.IP "\fB\--writepid\fR \fIfile\fR"
Specifies where the pid file should be written.
.IP "\fB\--daemon\fR \fIname\fR"
The name of the instance.
.IP "\fB\--help\fR"
Show help and version info.
.SH BUGS
.sp
Please report any bug that you encounter via:
.br
\fIhttps://bitbucket.org/anguist/ntpa/issues\fR.
.SH HOMEPAGE
http://ntpa.innolan.net/
.SH FILES
.na
.nf
/usr/local/etc/ntpa/ntpa.conf, Default NTP Analyzer configuration parameters
/usr/local/www/ntpa/index.html, Default web start page
/usr/log/ntpa/ntpa.log, Default log file
.SH SEE ALSO
.na
.nf
ntpd(8), NTP daemon program
ntpq(8), NTP query program
ntpctl(8), Open NTP query program
ntp.conf(5), NTP daemon configuration file format
.SH AUTHORS
.na
.nf
Carsten Sonne Larsen <cs@innolan.net>