man/collectyd.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS/DTD DocBook XML V4.2//EN"
   3         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <refentry id="collectyd">
   6         <refentryinfo>
   7                 <title>collectyd</title>
   8                 <productname>collectyd</productname>
   9
  10                 <authorgroup>
  11                         <author>
  12                                 <contrib>Developer</contrib>
  13                                 <firstname>Michael</firstname>
  14                                 <surname>Tremer</surname>
  15                                 <email>michael.tremer@ipfire.org</email>
  16                         </author>
  17                 </authorgroup>
  18         </refentryinfo>
  19
  20         <refmeta>
  21                 <refentrytitle>collectyd</refentrytitle>
  22                 <manvolnum>1</manvolnum>
  23         </refmeta>
  24
  25         <refnamediv>
  26                 <refname>collectyd</refname>
  27                 <refpurpose>Statistics collection daemon</refpurpose>
  28         </refnamediv>
  29
  30         <refsynopsisdiv>
  31                 <cmdsynopsis>
  32                         <command>collectyd</command>
  33                         <arg choice="opt" rep="repeat">OPTIONS</arg>
  34                         <arg choice="plain">COMMAND</arg>
  35                 </cmdsynopsis>
  36         </refsynopsisdiv>
  37
  38         <refsect1>
  39                 <title>Description</title>
  40
  41                 <para>
  42                         <command>collectyd</command> is a simple and extensible
  43                         framework for collecting system statistics of IPFire systems.
  44                 </para>
  45         </refsect1>
  46
  47         <refsect1>
  48                 <title>Options</title>
  49
  50                 <para>
  51                         The following options are understood:
  52                 </para>
  53
  54                 <variablelist>
  55                         <varlistentry>
  56                                 <term>
  57                                         <option>-d</option>
  58                                 </term>
  59                                 <term>
  60                                         <option>--debug</option>
  61                                 </term>
  62
  63                                 <listitem>
  64                                         <para>
  65                                                 Enables the debugging output.
  66                                         </para>
  67                                 </listitem>
  68                         </varlistentry>
  69
  70                         <varlistentry>
  71                                 <term>
  72                                         <option>-h</option>
  73                                 </term>
  74                                 <term>
  75                                         <option>--help</option>
  76                                 </term>
  77
  78                                 <listitem>
  79                                         <para>
  80                                                 Shows the help message provided by the program and exit.
  81                                         </para>
  82                                 </listitem>
  83                         </varlistentry>
  84                 </variablelist>
  85         </refsect1>
  86
  87         <refsect1>
  88                 <title>Exit Codes</title>
  89
  90                 <para>
  91                         <command>collectyd</command> will normally exit with code 0.
  92                         If there has been a problem and the daemon cannot recover from that
  93                         it will exit with an exit code unequal to zero.
  94                 </para>
  95         </refsect1>
  96
  97         <refsect1>
  98                 <title>Bugs</title>
  99
 100                 <para>
 101                         Please report all bugs to the official bugtracker at
 102                         http://bugs.ipfire.org/.
 103                 </para>
 104         </refsect1>
 105 </refentry>