diff options
Diffstat (limited to 'debian/man')
| -rw-r--r-- | debian/man/icingadb-migrate.8.xml | 80 | ||||
| -rw-r--r-- | debian/man/icingadb.8.xml | 108 |
2 files changed, 188 insertions, 0 deletions
diff --git a/debian/man/icingadb-migrate.8.xml b/debian/man/icingadb-migrate.8.xml new file mode 100644 index 0000000..f688b33 --- /dev/null +++ b/debian/man/icingadb-migrate.8.xml @@ -0,0 +1,80 @@ +<?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-migrate'> + + <refmeta> + <refentrytitle>icingadb-migrate</refentrytitle> + <manvolnum>8</manvolnum> + </refmeta> + + <refnamediv> + <refname>icingadb-migrate</refname> + <refpurpose>IDO to Icinga DB migrator</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>icingadb-migrate</command> + <arg choice='opt'><option>-h</option></arg> + <arg choice='opt'><option>-c</option> <replaceable>PATH</replaceable></arg> + <arg choice='opt'><option>-t</option> <replaceable>PATH</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>icingadb-migrate</command> migrates IDO history to Icinga DB. + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + + <para> + Application Options: + </para> + <variablelist> + + <varlistentry> + <term><option>-c</option>=<replaceable>PATH</replaceable></term> + <term><option>--config</option>=<replaceable>PATH</replaceable></term> + <listitem> + <para> + Path to config file + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-t</option>=<replaceable>PATH</replaceable></term> + <term><option>--cache</option>=<replaceable>PATH</replaceable></term> + <listitem> + <para> + Path for caching + </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> 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> |