docs/alicia.1.sgml

   1 <!-- -*- mode: sgml -*- -->
   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>alicia</>
  14     <manvolnum>1</>
  15   </refmeta>
  16
  17   <!-- Man page title -->
  18   <refnamediv>
  19     <refname>alicia</>
  20     <refpurpose>Make micromodifications or queries to the overrides table</>
  21   </refnamediv>
  22
  23   <!-- Arguments -->
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>alicia</>
  27       <arg><option><replaceable>options</replaceable></></arg>
  28       <arg choice="plain"><replaceable>package</replaceable></arg>
  29       <arg><option><replaceable>section</replaceable></></arg>
  30       <arg><option><replaceable>priority</replaceable></></arg>
  31     </cmdsynopsis>
  32   </refsynopsisdiv>
  33
  34   <RefSect1><Title>Description</>
  35     <para>
  36       <command>alicia</command> makes micromodifications and queries the overrides.
  37     </PARA>
  38   </REFSECT1>
  39
  40   <RefSect1><Title>Options</>
  41
  42     <VariableList>
  43       <VarListEntry><term><option>-h/--help</option></>
  44         <ListItem>
  45           <Para>Show help and then exit.</PARA>
  46         </LISTITEM>
  47       </VarListEntry>
  48       <VarListEntry><term><option>-n/--no-action</option></>
  49         <ListItem>
  50           <Para>Show what alicia would do but make no changes</PARA>
  51         </LISTITEM>
  52       </VarListEntry>
  53       <VarListEntry><term><option>-s/--suite=<replaceable>suite</replaceable></option></>
  54         <ListItem>
  55           <Para>Affect the overrides in suite listed.  The default is <literal>unstable</literal></PARA>
  56         </LISTITEM>
  57       </VarListEntry>
  58
  59     </VariableList>
  60   </RefSect1>
  61
  62   <RefSect1><Title>Common use</>
  63     <para>
  64       <command>alicia</command> when invoked with only a package name will tell you what section and priority the given package has.
  65     </PARA>
  66     <para>
  67       <command>alicia</command> when invoked with a package and one or two other values will set the section and/or priority to the values given. You may use a single period ('.') to represent "do not change" or you can ommit the value you do not want to change.
  68     </PARA>
  69   </RefSect1>
  70   <RefSect1><Title>Notes</>
  71
  72   <Para>alicia essentially lets you do what natalie does only on the microscopic scale rather than the macroscopic scale of natalie. Use with care.</>
  73
  74   <RefSect1><Title>Diagnostics</>
  75     <para>
  76       <command>alicia</command> returns zero on normal operation, non-zero on error.
  77     </PARA>
  78   </RefSect1>
  79
  80   &manauthor;
  81
  82 </refentry>