]> git.decadent.org.uk Git - dak.git/blob - docs/rhona.1.sgml
cleanup patch from tbm + real_arch filter
[dak.git] / docs / rhona.1.sgml
1 <!-- -*- mode: sgml; mode: fold -*- -->
2 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
3
4 <!ENTITY % katieent SYSTEM "katie.ent">
5 %katieent;
6
7 ]>
8
9 <refentry>
10   &katie-docinfo;
11
12   <refmeta>
13     <refentrytitle>rhona</>
14     <manvolnum>1</>
15   </refmeta>
16
17   <!-- Man page title -->
18   <refnamediv>
19     <refname>rhona</>
20     <refpurpose>Utility to clean out old packages</>
21   </refnamediv>
22
23   <!-- Arguments -->
24   <refsynopsisdiv>
25     <cmdsynopsis>
26       <command>rhona</>
27       <arg><option><replaceable>options</replaceable></></arg>
28     </cmdsynopsis>
29   </refsynopsisdiv>
30
31   <RefSect1><Title>Description</>
32     <para>
33       <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.
34     </PARA>
35   </REFSECT1>
36
37   <RefSect1><Title>Options</>
38
39     <variablelist>
40       <VarListEntry><term><option>-n/--no-action</option></>
41         <ListItem>
42           <Para>Don't actually clean any packages.</PARA>
43         </LISTITEM>
44       </VarListEntry>
45
46       <VarListEntry><term><option>-h/--help</option></>
47         <ListItem>
48           <Para>Show help and then exit.</PARA>
49         </LISTITEM>
50       </VarListEntry>
51
52     </VariableList>
53   </RefSect1>
54
55   <refsect1>
56     <title>Configuration</title>
57     <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>
58     <variablelist>
59       <varlistentry>
60         <term>Rhona::StayOfExecution</term>
61         <listitem>
62           <para>This is the number of seconds unreferenced packages are left before being cleaned.</para>
63         </listitem>
64       </varlistentry>
65       <varlistentry>
66         <term>Rhona::MorgueSubDir</term>
67         <listitem>
68           <para>If not blank, this is the subdirectory in the morgue used to hold removed packages.</para>
69         </listitem>
70       </varlistentry>
71     </variablelist>
72   </refsect1>
73
74   <RefSect1><Title>Diagnostics</>
75     <para>
76       <command>rhona</command> returns zero on normal operation, non-zero on error.
77     </PARA>
78   </RefSect1>
79
80   &manauthor;
81
82 </refentry>