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   </REFSECT1>
  41
  42   <RefSect1><Title>Options</>
  43
  44     <variablelist>
  45       <VarListEntry><term><option>-h/--help</option></>
  46         <ListItem>
  47           <Para>Show help and then exit.</PARA>
  48         </LISTITEM>
  49       </VarListEntry>
  50
  51     </VariableList>
  52   </RefSect1>
  53
  54   <refsect1>
  55     <title>New versus Old output format</title>
  56     <para>Converting the new output format to the old output format is easy with some simple sed + awk, e.g.
  57 <literallayout>sed -e "s/~[^  ]*\([   ]\)/\1/"  | awk '{printf "%-20s ", $1; for (i=2; i<=NF; i++) printf "%s ", $i; printf "\n";}'</literallayout>
  58 </para>
  59   </refsect1>
  60
  61   <RefSect1><Title>Diagnostics</>
  62     <para>
  63       <command>charisma</command> returns zero on normal operation, non-zero on error.
  64     </PARA>
  65   </RefSect1>
  66
  67   &manauthor;
  68
  69 </refentry>