docs/heidi.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>heidi</>
  14     <manvolnum>1</>
  15   </refmeta>
  16
  17   <!-- Man page title -->
  18   <refnamediv>
  19     <refname>heidi</>
  20     <refpurpose>Utility to alter or display the contents of a suite</>
  21   </refnamediv>
  22
  23   <!-- Arguments -->
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>heidi</>
  27       <arg><option><replaceable>options</replaceable></></arg>
  28       <arg choice="plain"><replaceable>file...</replaceable></arg>
  29     </cmdsynopsis>
  30   </refsynopsisdiv>
  31
  32   <RefSect1><Title>Description</>
  33     <para>
  34       <command>heidi</command> is a utility to alter or display the contents of a suite.  Input for alterations is taken either from filename(s) supplied or stdin.  The format for both input and output is lines each with a whitespace separated list of: <literal>package</literal>, <literal>version</literal> and <literal>architecture</literal>.
  35     </PARA>
  36   </REFSECT1>
  37
  38   <RefSect1><Title>Options</>
  39
  40     <VariableList>
  41       <VarListEntry><term><option>-a/--add=<replaceable>suite</replaceable></option></>
  42         <ListItem>
  43           <Para>Add to the suite.</PARA>
  44         </LISTITEM>
  45       </VarListEntry>
  46
  47       <VarListEntry><term><option>-l/--list=<replaceable>suite</replaceable></option></>
  48         <ListItem>
  49           <Para>List the contents of the suite.</PARA>
  50         </LISTITEM>
  51       </VarListEntry>
  52
  53       <VarListEntry><term><option>-r/--remove=<replaceable>suite</replaceable></option></>
  54         <ListItem>
  55           <Para>Remove from the suite.</PARA>
  56         </LISTITEM>
  57       </VarListEntry>
  58
  59       <VarListEntry><term><option>-s/--set=<replaceable>suite</replaceable></option></>
  60         <ListItem>
  61           <Para>Set the suite to exactly the input.</PARA>
  62         </LISTITEM>
  63       </VarListEntry>
  64
  65       <VarListEntry><term><option>-h/--help</option></>
  66         <ListItem>
  67           <Para>Show help and then exit.</PARA>
  68         </LISTITEM>
  69       </VarListEntry>
  70
  71     </VariableList>
  72   </RefSect1>
  73
  74   <RefSect1><Title>Diagnostics</>
  75     <para>
  76       <command>heidi</command> returns zero on normal operation, non-zero on error.
  77     </PARA>
  78   </RefSect1>
  79
  80   &manauthor;
  81
  82 </refentry>