]> git.decadent.org.uk Git - dak.git/blobdiff - docs/rhona.1.sgml
Convert away from silly names
[dak.git] / docs / rhona.1.sgml
diff --git a/docs/rhona.1.sgml b/docs/rhona.1.sgml
deleted file mode 100644 (file)
index 00dd432..0000000
+++ /dev/null
@@ -1,82 +0,0 @@
-<!-- -*- mode: sgml; mode: fold -*- -->
-<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
-
-<!ENTITY % katieent SYSTEM "katie.ent">
-%katieent;
-
-]>
-
-<refentry>
-  &katie-docinfo;
-
-  <refmeta>
-    <refentrytitle>rhona</>
-    <manvolnum>1</>
-  </refmeta>
-
-  <!-- Man page title -->
-  <refnamediv>
-    <refname>rhona</>
-    <refpurpose>Utility to clean out old packages</>
-  </refnamediv>
-
-  <!-- Arguments -->
-  <refsynopsisdiv>
-    <cmdsynopsis>
-      <command>rhona</>
-      <arg><option><replaceable>options</replaceable></></arg>
-    </cmdsynopsis>
-  </refsynopsisdiv>
-
-  <RefSect1><Title>Description</>
-    <para>
-      <command>rhona</command> is a utility clean out old packages. It will clean out any binary packages not referenced by a suite and any source packages not referenced by a suite and not referenced by any binary packages.  Cleaning is not actual deletion, but rather, removal of packages from the pool to a 'morgue' directory.  The 'morgue' directory is split into dated sub-directories to keep things sane in big archives.
-    </PARA>
-  </REFSECT1>
-
-  <RefSect1><Title>Options</>
-
-    <variablelist>
-      <VarListEntry><term><option>-n/--no-action</option></>
-       <ListItem>
-         <Para>Don't actually clean any packages.</PARA>
-       </LISTITEM>
-      </VarListEntry>
-
-      <VarListEntry><term><option>-h/--help</option></>
-       <ListItem>
-         <Para>Show help and then exit.</PARA>
-       </LISTITEM>
-      </VarListEntry>
-
-    </VariableList>
-  </RefSect1>
-
-  <refsect1>
-    <title>Configuration</title>
-    <para><command>rhona</command> uses katie's configuration file. It follows the typical ISC configuration format as seen in ISC tools like bind 8 and dhcpd.  Apart from being able to alter the defaults for command line options, the following configuration items are used:</para>
-    <variablelist>
-      <varlistentry>
-       <term>Rhona::StayOfExecution</term>
-       <listitem>
-         <para>This is the number of seconds unreferenced packages are left before being cleaned.</para>
-       </listitem>
-      </varlistentry>
-      <varlistentry>
-       <term>Rhona::MorgueSubDir</term>
-       <listitem>
-         <para>If not blank, this is the subdirectory in the morgue used to hold removed packages.</para>
-       </listitem>
-      </varlistentry>
-    </variablelist>
-  </refsect1>
-
-  <RefSect1><Title>Diagnostics</>
-    <para>
-      <command>rhona</command> returns zero on normal operation, non-zero on error.
-    </PARA>
-  </RefSect1>
-
-  &manauthor;
-
-</refentry>