docs/charisma.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>charisma</>
  14     <manvolnum>1</>
  15   </refmeta>
  16
  17   <!-- Man page title -->
  18   <refnamediv>
  19     <refname>charisma</>
  20     <refpurpose>Utility to generate an index of package's maintainers</>
  21   </refnamediv>
  22
  23   <!-- Arguments -->
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>charisma</>
  27       <arg><option><replaceable>options</replaceable></></arg>
  28       <arg choice="plain"><replaceable>extra file...</replaceable></arg>
  29     </cmdsynopsis>
  30   </refsynopsisdiv>
  31
  32   <RefSect1><Title>Description</>
  33     <para>
  34       <command>charisma</command> is a utility to generate an index of package's maintainers.  The output format is:
  35 <literallayout>package~version  maintainer</literallayout>
  36       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.:
  37 <literallayout>package  maintainer</literallayout>
  38       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).
  39     </Para>
  40     <para>
  41       Charisma determines the maintainer of a package by comparing suite priority (see 'Configuration') and then version number.
  42     </PARA>
  43   </REFSECT1>
  44
  45   <RefSect1><Title>Options</>
  46
  47     <variablelist>
  48       <VarListEntry><term><option>-h/--help</option></>
  49         <ListItem>
  50           <Para>Show help and then exit.</PARA>
  51         </LISTITEM>
  52       </VarListEntry>
  53
  54     </VariableList>
  55   </RefSect1>
  56
  57   <refsect1>
  58     <title>Configuration</title>
  59     <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>
  60     <variablelist>
  61       <varlistentry>
  62         <term>Suite::&lt;SUITE&gt;::Priority</term>
  63         <listitem>
  64           <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>
  65         </listitem>
  66       </varlistentry>
  67     </variablelist>
  68   </refsect1>
  69
  70   <refsect1>
  71     <title>New versus Old output format</title>
  72     <para>Converting the new output format to the old output format is easy with some simple sed + awk, e.g.
  73 <literallayout>sed -e "s/~[^  ]*\([   ]\)/\1/"  | awk '{printf "%-20s ", $1; for (i=2; i<=NF; i++) printf "%s ", $i; printf "\n";}'</literallayout>
  74 </para>
  75   </refsect1>
  76
  77   <RefSect1><Title>Diagnostics</>
  78     <para>
  79       <command>charisma</command> returns zero on normal operation, non-zero on error.
  80     </PARA>
  81   </RefSect1>
  82
  83   &manauthor;
  84
  85 </refentry>