doc.icinga2.8: rewrite man page

- Change man page section to 8.
- Update man page date.
- Describe how to invoke the program with command and options.
- Describe config and validate options for daemon (taken from docs).

fixes #10441

Signed-off-by: Gunnar Beutner <gunnar@beutner.name>
This commit is contained in:
Mhd Sulhan 2015-10-22 23:09:36 +07:00 committed by Gunnar Beutner
parent d5883000a9
commit d2722363dc

View File

@ -1,51 +1,87 @@
.TH ICINGA2 "1" "November 2014" "icinga2 - The Icinga 2 network monitoring daemon" "System Administration Utilities" .TH ICINGA2 "8" "October 2015" "icinga2 - The Icinga 2 network monitoring daemon"
.SH NAME .SH NAME
icinga2 \- manual page for icinga2 - The Icinga 2 network monitoring daemon
.SH DESCRIPTION
icinga2 \- The Icinga 2 network monitoring daemon icinga2 \- The Icinga 2 network monitoring daemon
.SS "Usage:"
.IP .SH SYNOPSIS
icinga2 daemon [<arguments>] .B icinga2
.PP .I command
Starts Icinga 2. [
.SS "Global options:" .I command options
][
.I global options
]
.I command
:= [
.B api | console | daemon | feature | node | object | pki | repository | troubleshoot | variable
]
.B --help
.SH DESCRIPTION
Icinga 2 is an open source monitoring system which checks the availability of your network resources, notifies users of outages, and generates performance data for reporting.
Scalable and extensible, Icinga 2 can monitor large, complex environments across multiple locations.
.SH OPTIONS
Details for specific command options can be viewed by invoking the command name with
.B --help
parameter.
.SS Global options
.TP .TP
\fB\-h\fR [ \fB\-\-help\fR ] .B -h,--help
show this help message Show this help message.
.TP .TP
\fB\-V\fR [ \fB\-\-version\fR ] .B -V,--version
show version information Show version information.
.TP .TP
\fB\-\-color\fR .B --color
use VT100 color codes even when stdout is not a terminal Use VT100 color codes even when stdout is not a terminal.
.TP .TP
\fB\-D\fR [ \fB\-\-define\fR ] arg .BI "-D, --define" " arg"
define a constant Define a constant.
.TP .TP
\fB\-l\fR [ \fB\-\-library\fR ] arg .BI "-l, --library" " arg"
load a library Load a library.
.TP .TP
\fB\-I\fR [ \fB\-\-include\fR ] arg .BI "-I, --include" " arg"
add include search directory Add include search directory.
.HP
\fB\-x\fR [ \fB\-\-log\-level\fR ] arg
specify the log level for the console log
.SS "Command options:"
.TP .TP
\fB\-c\fR [ \fB\-\-config\fR ] arg .BI "-x, --log-level" " [ debug | notice | information | warning | critical ]"
parse a configuration file Specify the log level for the console log, default is
.B information.
.SS daemon options
The CLI command daemon provides the functionality to start/stop Icinga 2.
Furthermore it provides the configuration validation.
.TP .TP
\fB\-z\fR [ \fB\-\-no\-config\fR ] .BI "-c, --config" " arg"
start without a configuration file Using this option you can specify one or more configuration files.
Config files are processed in the order they are specified on the command-line.
When no configuration file is specified and the
.B --no-config
is not used, Icinga 2 automatically falls back to using the configuration file
.B SysconfDir + "/icinga2/icinga2.conf"
(where SysconfDir is usually
.BI "/etc" ")."
.TP .TP
\fB\-C\fR [ \fB\-\-validate\fR ] .B "-z, --noconfig"
exit after validating the configuration Start without a configuration file.
.TP .TP
\fB\-e\fR [ \fB\-\-errorlog\fR ] arg log fatal errors to the specified log file (only works .B "-C, --validate"
in combination with \fB\-\-daemonize\fR) This option can be used to check if your configuration files contain errors.
If any errors are found the exit status is 1, otherwise 0 is returned.
.TP .TP
\fB\-d\fR [ \fB\-\-daemonize\fR ] .BI "-e, --errorlog" " arg"
detach from the controlling terminal Log fatal errors to the specified log file (only works in combination with
.BR "--daemonize" ")."
.TP
.B "-d, --daemonize"
Detach from the controlling terminal.
.SH "REPORTING BUGS" .SH "REPORTING BUGS"
Report bugs at <https://dev.icinga.org/> Report bugs at <https://dev.icinga.org/>
.br .br