From bae7e5311ea6452697fdd7bb277ab8b60a6b830e Mon Sep 17 00:00:00 2001
From: Michael Hanselmann <hansmi@google.com>
Date: Fri, 25 Sep 2009 17:25:47 +0200
Subject: [PATCH] Add man page for ganeti-cleaner
Signed-off-by: Michael Hanselmann <hansmi@google.com>
Reviewed-by: Iustin Pop <iustin@google.com>
---
Makefile.am | 1 +
man/footer.sgml | 4 +++
man/ganeti-cleaner.sgml | 78 +++++++++++++++++++++++++++++++++++++++++
3 files changed, 83 insertions(+)
create mode 100644 man/ganeti-cleaner.sgml
diff --git a/Makefile.am b/Makefile.am
index 062f82729..26d6b1c2a 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -188,6 +188,7 @@ EXTRA_DIST = \
man_MANS = \
man/ganeti.7 \
+ man/ganeti-cleaner.8 \
man/ganeti-masterd.8 \
man/ganeti-noded.8 \
man/ganeti-os-interface.7 \
diff --git a/man/footer.sgml b/man/footer.sgml
index 70582739f..369c2aba1 100644
--- a/man/footer.sgml
+++ b/man/footer.sgml
@@ -59,6 +59,10 @@
<refentrytitle>ganeti-watcher</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> (automatic instance restarter),
+ <citerefentry>
+ <refentrytitle>ganeti-cleaner</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry> (job queue cleaner),
<citerefentry>
<refentrytitle>ganeti-noded</refentrytitle>
<manvolnum>8</manvolnum>
diff --git a/man/ganeti-cleaner.sgml b/man/ganeti-cleaner.sgml
new file mode 100644
index 000000000..ac60bdaf6
--- /dev/null
+++ b/man/ganeti-cleaner.sgml
@@ -0,0 +1,78 @@
+<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+
+ <!-- Fill in your name for FIRSTNAME and SURNAME. -->
+ <!-- Please adjust the date whenever revising the manpage. -->
+ <!ENTITY dhdate "<date>February 11, 2009</date>">
+ <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
+ allowed: see man(7), man(1). -->
+ <!ENTITY dhsection "<manvolnum>8</manvolnum>">
+ <!ENTITY dhucpackage "<refentrytitle>ganeti-cleaner</refentrytitle>">
+ <!ENTITY dhpackage "ganeti-cleaner">
+
+ <!ENTITY debian "<productname>Debian</productname>">
+ <!ENTITY gnu "<acronym>GNU</acronym>">
+ <!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
+ <!ENTITY footer SYSTEM "footer.sgml">
+]>
+
+<refentry>
+ <refentryinfo>
+ <copyright>
+ <year>2009</year>
+ <holder>Google Inc.</holder>
+ </copyright>
+ &dhdate;
+ </refentryinfo>
+ <refmeta>
+ &dhucpackage;
+
+ &dhsection;
+ <refmiscinfo>ganeti 2.0</refmiscinfo>
+ </refmeta>
+ <refnamediv>
+ <refname>&dhpackage;</refname>
+
+ <refpurpose>ganeti job queue cleaner</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>&dhpackage;</command>
+
+ </cmdsynopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>DESCRIPTION</title>
+
+ <para>
+ The <command>&dhpackage;</command> is a periodically run script to clean
+ old job files from the job queue archive.
+ </para>
+
+ <para>
+ <command>&dhpackage;</command> automatically removes all files older than
+ 21 days from
+ <filename>@LOCALSTATEDIR@/lib/ganeti/queue/archive</filename>.
+ </para>
+
+ </refsect1>
+
+ &footer;
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:2
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-default-dtd-file:nil
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+-->
--
GitLab