docs/natalie.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>natalie</>
  14     <manvolnum>1</>
  15   </refmeta>
  16
  17   <!-- Man page title -->
  18   <refnamediv>
  19     <refname>natalie</>
  20     <refpurpose>Override Utility to remove/add packages from suites</>
  21   </refnamediv>
  22
  23   <!-- Arguments -->
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>natalie</>
  27       <arg><option><replaceable>options</replaceable></></arg>
  28     </cmdsynopsis>
  29   </refsynopsisdiv>
  30
  31   <RefSect1><Title>Description</>
  32     <para>
  33       <command>natalie</command> is the command line tool to handle override files.  Override files can be listed to stdout or updated from stdin.
  34
  35   <RefSect1><Title>Options</>
  36
  37       <VariableList>
  38         <VarListEntry><term><option>-c/--component=<replaceable>component</replaceable></option></>
  39           <ListItem><Para>Uses the override DB for the component listed.  The default is <literal>main</literal>.</PARA></LISTITEM>
  40         </VarListEntry>
  41
  42         <varlistentry>
  43           <term><option>-l/--list</option></term>
  44           <listitem>
  45             <para>Lists the override DB to stdout.</para>
  46           </listitem>
  47         </varlistentry>
  48
  49         <VarListEntry><term><option>-s/--suite=<replaceable>suite</replaceable></option></>
  50           <ListItem><Para>Uses the override DB for the suite listed.  The default is <literal>unstable</literal>.</PARA></LISTITEM>
  51         </VarListEntry>
  52
  53         <VarListEntry><term><option>-S/--set</option></term>
  54           <ListItem><Para>Update the override DB based on the contents of stdin.  Information on the results of the update are printed to stdout.</PARA></LISTITEM>
  55         </VarListEntry>
  56
  57         <varlistentry>
  58           <term><option>-t/--type=<replaceable>type</replaceable></option></term>
  59           <listitem>
  60             <para>Uses the override DB for the type listed.  The default is <literal>deb</literal>.  Possible values are: <literal>deb</literal>, <literal>udeb</literal> and <literal>dsc</literal>.</para>
  61           </listitem>
  62         </varlistentry>
  63
  64     </VariableList>
  65   </RefSect1>
  66
  67   <RefSect1><Title>Diagnostics</>
  68     <para>
  69       <command>natalie</command> returns zero on normal operation, non-zero on error.
  70   </RefSect1>
  71
  72   &manauthor;
  73
  74 </refentry>