docs/cindy.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>cindy</>
  14     <manvolnum>1</>
  15   </refmeta>
  16
  17   <!-- Man page title -->
  18   <refnamediv>
  19     <refname>cindy</>
  20     <refpurpose>Utility to alter or display the contents of a suite</>
  21   </refnamediv>
  22
  23   <!-- Arguments -->
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>cindy</>
  27       <arg><option><replaceable>options</replaceable></></arg>
  28     </cmdsynopsis>
  29   </refsynopsisdiv>
  30
  31   <RefSect1><Title>Description</>
  32     <para>
  33       <command>cindy</command> is a cruft checker for overrides.
  34     </PARA>
  35   </REFSECT1>
  36
  37   <RefSect1><Title>Options</>
  38
  39     <VariableList>
  40       <VarListEntry><term><option>-h/--help</option></>
  41         <ListItem>
  42           <Para>Show help and then exit.</PARA>
  43         </LISTITEM>
  44       </VarListEntry>
  45
  46     </VariableList>
  47   </RefSect1>
  48
  49   <RefSect1><Title>Notes</>
  50
  51   <Para>cindy is not a good idea with New Incoming as she doesn't take into account queue/accepted.  You can minimize the impact of this by running her immediately after kelly but that's still racy because lisa doesn't lock with elly.  A better long term fix is the evil plan for accepted to be in the DB.</>
  52
  53   <RefSect1><Title>Diagnostics</>
  54     <para>
  55       <command>cindy</command> returns zero on normal operation, non-zero on error.
  56     </PARA>
  57   </RefSect1>
  58
  59   &manauthor;
  60
  61 </refentry>