diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 12:36:05 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 12:36:05 +0000 |
commit | 8bc37fc67193505a5a346fd2f1bee70476eb3942 (patch) | |
tree | 24bc012bd3fa1f2e7cb96ac12c041bafe31b0670 /debian/man/icingadb.8.xml | |
parent | Adding upstream version 1.1.0. (diff) | |
download | icingadb-aa24aa43987d77ac70f2c3944853527f2307d4eb.tar.xz icingadb-aa24aa43987d77ac70f2c3944853527f2307d4eb.zip |
Adding debian version 1.1.0-1.debian/1.1.0-1debian
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'debian/man/icingadb.8.xml')
-rw-r--r-- | debian/man/icingadb.8.xml | 108 |
1 files changed, 108 insertions, 0 deletions
diff --git a/debian/man/icingadb.8.xml b/debian/man/icingadb.8.xml new file mode 100644 index 0000000..8366dc9 --- /dev/null +++ b/debian/man/icingadb.8.xml @@ -0,0 +1,108 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> +<refentry id='icingadb'> + + <refmeta> + <refentrytitle>icingadb</refentrytitle> + <manvolnum>8</manvolnum> + </refmeta> + + <refnamediv> + <refname>icingadb</refname> + <refpurpose>Database connector for Icinga 2</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>icingadb</command> + <arg choice='opt'><option>-h</option></arg> + <arg choice='opt'><option>--version</option></arg> + <arg choice='opt'><option>-c</option> <replaceable>PATH</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>icingadb</command> is a database connector for Icinga 2. + </para> + <para> + It is part of a set of components for publishing, synchronizing and + visualizing monitoring data in the Icinga ecosystem, consisting of: + <itemizedlist> + <listitem> + <para> + The Icinga DB daemon, which synchronizes monitoring data + between a Redis server and a database. + </para> + </listitem> + <listitem> + <para> + Icinga 2 with its Icinga DB feature enabled, responsible for + publishing the data to the Redis server, i.e. configuration + and its runtime updates, check results, state changes, + downtimes, acknowledgements, notifications, and other events + such as flapping. + </para> + </listitem> + <listitem> + <para> + And Icinga Web with the Icinga DB Web module enabled, which + connects to both Redis and the database to display and work + with the most up-to-date data. + </para> + </listitem> + </itemizedlist> + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + + <para> + Application Options: + </para> + <variablelist> + + <varlistentry> + <term><option>--version</option></term> + <listitem> + <para> + Print version and exit + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-c</option>=<replaceable>PATH</replaceable></term> + <term><option>--config</option>=<replaceable>PATH</replaceable></term> + <listitem> + <para> + Path to config file + (default: <filename>/etc/icingadb/config.yml</filename>) + </para> + </listitem> + </varlistentry> + + </variablelist> + + <para> + Help Options: + </para> + <variablelist> + + <varlistentry> + <term><option>-h</option></term> + <term><option>--help</option></term> + <listitem> + <para> + Show usage information and exit + </para> + </listitem> + </varlistentry> + + </variablelist> + + </refsect1> + +</refentry> |