]> git.decadent.org.uk Git - dak.git/blob - docs/madison.1.sgml
remove direct call to reading the config file
[dak.git] / 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><term><option>-s/--suite=<replaceable>suite</replaceable></option></>
48         <ListItem>
49           <Para>Only list package information for the suite(s) listed.</PARA>
50         </LISTITEM>
51       </VarListEntry>
52
53       <VarListEntry><term><option>-h/--help</option></>
54         <ListItem>
55           <Para>Show help and then exit.</PARA>
56         </LISTITEM>
57       </VarListEntry>
58
59     </VariableList>
60   </RefSect1>
61
62   <RefSect1><Title>Diagnostics</>
63     <para>
64       <command>madison</command> returns zero on normal operation, non-zero on error.
65     </PARA>
66   </RefSect1>
67
68   &manauthor;
69
70 </refentry>