]> git.decadent.org.uk Git - dak.git/blob - docs/manpages/control-suite.1.sgml
Merge from upstream
[dak.git] / docs / manpages / control-suite.1.sgml
1 <!-- -*- mode: sgml; mode: fold -*- -->
2 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
3
4 <!ENTITY % dakent SYSTEM "dak.ent">
5 %dakent;
6
7 ]>
8
9 <refentry>
10   &dak-docinfo;
11
12   <refmeta>
13     <refentrytitle>dak_control-suite</>
14     <manvolnum>1</>
15   </refmeta>
16
17   <!-- Man page title -->
18   <refnamediv>
19     <refname>dak control-suite</>
20     <refpurpose>Utility to alter or display the contents of a suite</>
21   </refnamediv>
22
23   <!-- Arguments -->
24   <refsynopsisdiv>
25     <cmdsynopsis>
26       <command>dak control-suite</>
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>dak control-suite</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>dak control-suite</command> returns zero on normal operation, non-zero on error.
77     </PARA>
78   </RefSect1>
79
80   &manauthor;
81
82 </refentry>