Monitorix/man/man8/monitorix.8

58 lines
2.1 KiB
Groff
Raw Normal View History

2012-10-22 15:26:37 +01:00
.\" Monitorix manpage.
2013-01-09 11:44:43 +00:00
.\" Copyright (C) 2005-2013 by Jordi Sanfeliu <jordi@fibranet.cat>
2012-10-22 15:26:37 +01:00
.\"
.\" This is the man page for the monitorix collector daemon.
.\"
2013-01-31 08:27:42 +00:00
.TH monitorix 8 "Feb 2013" 3.0.0beta2 "Monitorix collector daemon"
2012-10-22 15:26:37 +01:00
.SH NAME
monitorix
.SH SYNOPSIS
\fBmonitorix\fR \fB-c configfile\fR [\fB-p pidfile\fR] [\fB-d none | graph[,graph] | all\fR] [\fB-v\fR]
.SH DESCRIPTION
This Perl daemon starts the main Monitorix process, which gathers statistics about the system it is running on and stores this information in a set of RRD files.
.SH OPTIONS
.TP
\fB\-c configfile\fR
The default location of the configuration file varies depending on the operating system:
.P
.RS
Linux: \fI/etc/monitorix.conf\fP
.br
FreeBSD: \fI/usr/local/etc/monitorix.conf\fP
.P
.RE
.TP
\fB\-p pidfile\fR
Stores the daemon's process ID into the specified file.
.TP
\fB\-d none | graph[,graph] | all\fR
Logs more information about what \fBmonitorix\fP is doing internally. The keys reflect if the data collected must be displayed on each case. If \fBall\fP is defined, the data collected of all enabled graphs will be shown. If \fBnone\fP is defined no data collected will be shown. Finally it is also possible to define a comma-separated list of graph names from which show their data collected.
.br
2013-01-09 11:44:43 +00:00
For a reference of all graph names check the option \fBgraph_name\fP in the \fImonitorix.conf\fP configuration file.
2012-10-22 15:26:37 +01:00
.TP
\fB\-v\fR
Displays version information.
.SH SIGNALS
On receipt of a SIGHUP, \fBmonitorix\fP will close and reopen its log file. This is useful in scripts which rotate and age log files.
.P
2013-01-09 11:44:43 +00:00
Note that the configuration file is not re-read.
2012-10-22 15:26:37 +01:00
.SH FILES
The following is the set of the special files created on every startup:
.TP 41
2013-01-09 11:44:43 +00:00
\fB<base_dir>/cgi-bin/monitorix.conf.path\fP
2012-10-22 15:26:37 +01:00
stores the path of \fIconfigfile\fP.
.TP 41
2013-01-09 11:44:43 +00:00
\fB<base_dir>/cgi-bin/monitorix.hplog\fP
2012-10-22 15:26:37 +01:00
stores the output of \fIhplog\fP.
.TP 41
2013-01-09 11:44:43 +00:00
\fB<base_dir>/index.html\fP
2012-10-22 15:26:37 +01:00
HTML main page.
.SH AUTHOR
Monitorix is written by Jordi Sanfeliu <jordi@fibranet.cat>
.SH COPYRIGHT
2013-01-09 11:44:43 +00:00
Copyright \(co 2005-2013 Jordi Sanfeliu
2012-10-22 15:26:37 +01:00
.br
Licensed under the GNU General Public License v2 (GPL).
.SH "SEE ALSO"
.BR monitorix.conf (5)