sync

diff --git a/docs/Makefile b/docs/Makefile
index 8771e1f5eaee30bc2e0f4833c74904fe2363207d..dc5971a4bd114c6ec62e8432bd7ca0025c4cd150 100644 (file)
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -1,8 +1,8 @@
 #!/usr/bin/make -f
 
-# TODO: alyson andrea claire fernanda jenna neve rene rhona shania tea ziyi
+# TODO: alyson andrea claire fernanda jenna neve rene shania tea ziyi
 
-SGMLMANPAGES   = catherine.1.sgml charisma.1.sgml heidi.1.sgml julia.1.sgml katie.1.sgml madison.1.sgml melanie.1.sgml natalie.1.sgml
+SGMLMANPAGES   = catherine.1.sgml charisma.1.sgml heidi.1.sgml julia.1.sgml katie.1.sgml madison.1.sgml melanie.1.sgml natalie.1.sgml rhona.1.sgml
 
 MANPAGES       = $(patsubst %.sgml, %, $(SGMLMANPAGES))
 

diff --git a/docs/charisma.1.sgml b/docs/charisma.1.sgml
index 7a1ef8bacdad751d89bb91e6839d92e32c3d405b..6c5bbf1908acd795d1282172765980349b512ab3 100644 (file)
--- a/docs/charisma.1.sgml
+++ b/docs/charisma.1.sgml
@@ -36,6 +36,9 @@
       The input format of extra files can either be in this form or in the old style which is similar, but lacking the version number, i.e.:
 <literallayout>package maintainer</literallayout>
       Charisma will auto-detect the type of layout of the extra file.  If the extra file is in the old style format the records in it are assumed to supersed any that were seen earlier (i.e. either from earlier extra files or generated from the SQL).
+    </Para>
+    <para>
+      Charisma determines the maintainer of a package by comparing suite priority (see 'Configuration') and then version number.
     </PARA>
   </REFSECT1>
 
@@ -51,6 +54,19 @@
     </VariableList>
   </RefSect1>
 
+  <refsect1>
+    <title>Configuration</title>
+    <para><command>charisma</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>Suite::&lt;SUITE&gt;::Priority</term>
+       <listitem>
+         <para>Suite priority overrides the version checks charisma does.  A package in higher priority suite overrides versions in lower priority suites even if the version number in the higher priority suite is older.</para>
+       </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
   <refsect1>
     <title>New versus Old output format</title>
     <para>Converting the new output format to the old output format is easy with some simple sed + awk, e.g.

diff --git a/docs/rhona.1.sgml b/docs/rhona.1.sgml
new file mode 100644 (file)
index 0000000..00dd432
--- /dev/null
+++ b/docs/rhona.1.sgml
@@ -0,0 +1,82 @@
+<!-- -*- 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>