docs/manpages/override.1.sgml

   1 <!-- -*- mode: sgml -*- -->
   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_override</>
  14     <manvolnum>1</>
  15   </refmeta>
  16
  17   <!-- Man page title -->
  18   <refnamediv>
  19     <refname>dak override</>
  20     <refpurpose>Make micromodifications or queries to the overrides table</>
  21   </refnamediv>
  22
  23   <!-- Arguments -->
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>dak override</>
  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>dak override</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>-d/--done=<replaceable>BUG#</replaceable></option></>
  49         <ListItem>
  50           <Para>Close the listed bugs as part of adjusting the overrides</PARA>
  51         </LISTITEM>
  52       </VarListEntry>
  53       <VarListEntry><term><option>-n/--no-action</option></>
  54         <ListItem>
  55           <Para>Show what dak override would do but make no changes</PARA>
  56         </LISTITEM>
  57       </VarListEntry>
  58       <VarListEntry><term><option>-s/--suite=<replaceable>suite</replaceable></option></>
  59         <ListItem>
  60           <Para>Affect the overrides in suite listed.  The default is <literal>unstable</literal></PARA>
  61         </LISTITEM>
  62       </VarListEntry>
  63
  64     </VariableList>
  65   </RefSect1>
  66
  67   <RefSect1><Title>Common use</>
  68     <para>
  69       <command>dak override</command> when invoked with only a package name will tell you what section and priority the given package has.
  70     </PARA>
  71     <para>
  72       <command>dak override</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.
  73     </PARA>
  74   </RefSect1>
  75   <RefSect1><Title>Notes</>
  76
  77   <Para><command>dak override</command> essentially lets you do what <command>dak control-overrides</command> does only on the microscopic scale rather than the macroscopic scale of <command>dak control-overrides</command>. Use with care.</>
  78
  79   <RefSect1><Title>Diagnostics</>
  80     <para>
  81       <command>dak override</command> returns zero on normal operation, non-zero on error.
  82     </PARA>
  83   </RefSect1>
  84
  85   &manauthor;
  86
  87 </refentry>