docs/madison.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>madison</>
  14     <manvolnum>1</>
  15   </refmeta>
  16
  17   <!-- Man page title -->
  18   <refnamediv>
  19     <refname>madison</>
  20     <refpurpose>Utility to display information about packages</>
  21   </refnamediv>
  22
  23   <!-- Arguments -->
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>madison</>
  27       <arg><option><replaceable>options</replaceable></></arg>
  28       <arg choice="plain"><replaceable>package</replaceable></arg>
  29     </cmdsynopsis>
  30   </refsynopsisdiv>
  31
  32   <RefSect1><Title>Description</>
  33     <para>
  34       <command>madison</command> is a utility to display information about packages, specificaly what suites they are in and for which architectures.
  35     </PARA>
  36   </REFSECT1>
  37
  38   <RefSect1><Title>Options</>
  39
  40     <VariableList>
  41       <VarListEntry><term><option>-a/--architecture=<replaceable>architecture</replaceable></option></>
  42         <ListItem>
  43           <Para>Restrict the packages being considered to the architecture(s) listed.</PARA>
  44         </LISTITEM>
  45       </VarListEntry>
  46
  47       <varlistentry>
  48         <term><option>-r/--regex</option></term>
  49         <listitem>
  50           <para>Treat the <replaceable>package</replaceable> argument as a regex, rather than doing an exact search.</para>
  51         </listitem>
  52       </varlistentry>
  53
  54       <VarListEntry><term><option>-s/--suite=<replaceable>suite</replaceable></option></>
  55         <ListItem>
  56           <Para>Only list package information for the suite(s) listed.</PARA>
  57         </LISTITEM>
  58       </VarListEntry>
  59
  60       <VarListEntry><term><option>-S/--source-and-binary</option></>
  61         <ListItem>
  62           <Para>For each package which is a source package, also show information about the binary packages it produces.</PARA>
  63         </LISTITEM>
  64       </VarListEntry>
  65
  66       <VarListEntry><term><option>-h/--help</option></>
  67         <ListItem>
  68           <Para>Show help and then exit.</PARA>
  69         </LISTITEM>
  70       </VarListEntry>
  71
  72     </VariableList>
  73   </RefSect1>
  74
  75   <RefSect1><Title>Diagnostics</>
  76     <para>
  77       <command>madison</command> returns zero on normal operation, non-zero on error.
  78     </PARA>
  79   </RefSect1>
  80
  81   &manauthor;
  82
  83 </refentry>