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>Utility to manipulate the packages overrides</>
  21   </refnamediv>
  22
  23   <!-- Arguments -->
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>natalie</>
  27       <arg><option><replaceable>options</replaceable></option></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 or updated.
  34     </para>
  35   </refsect1>
  36   <RefSect1><Title>Options</>
  37
  38     <VariableList>
  39       <varlistentry>
  40         <term><option>-a/--add</option></term>
  41         <listitem>
  42           <para>Add entries to the override DB.  Changes and deletions are ignored.</para>
  43         </listitem>
  44       </varlistentry>
  45
  46       <VarListEntry><term><option>-c/--component=<replaceable>component</replaceable></option></>
  47         <ListItem><Para>Uses the override DB for the component listed.</para>
  48         </listitem>
  49       </VarListEntry>
  50
  51       <varlistentry>
  52         <term><option>-h/--help</option></term>
  53         <listitem>
  54           <para>Display usage help and then exit.</para>
  55         </listitem>
  56       </varlistentry>
  57
  58       <varlistentry>
  59         <term><option>-l/--list</option></term>
  60         <listitem>
  61           <para>Lists the override DB to stdout.</para>
  62         </listitem>
  63       </varlistentry>
  64
  65       <varlistentry>
  66         <term><option>-q/--quiet</option></term>
  67         <listitem>
  68           <para>Be less verbose about what has been done.</para>
  69         </listitem>
  70       </varlistentry>
  71
  72       <VarListEntry><term><option>-s/--suite=<replaceable>suite</replaceable></option></>
  73         <ListItem><Para>Uses the override DB for the suite listed.</para></listitem>
  74       </varlistentry>
  75
  76       <VarListEntry><term><option>-S/--set</option></term>
  77         <ListItem><Para>Set the override DB to the provided input.</PARA></LISTITEM>
  78       </VarListEntry>
  79
  80       <varlistentry>
  81         <term><option>-t/--type=<replaceable>type</replaceable></option></term>
  82         <listitem>
  83           <para>Uses the override DB for the type listed.  Possible values are: <literal>deb</literal>, <literal>udeb</literal> and <literal>dsc</literal>.</para>
  84         </listitem>
  85       </varlistentry>
  86
  87     </VariableList>
  88   </RefSect1>
  89
  90   <RefSect1><Title>Diagnostics</>
  91     <para>
  92       <command>natalie</command> returns zero on normal operation, non-zero on error.
  93     </para>
  94   </RefSect1>
  95
  96   &manauthor;
  97
  98 </refentry>