docs/katie.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>katie</>
  14     <manvolnum>1</>
  15   </refmeta>
  16
  17   <!-- Man page title -->
  18   <refnamediv>
  19     <refname>katie</>
  20     <refpurpose>Installs packages from incoming</>
  21   </refnamediv>
  22
  23   <!-- Arguments -->
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>katie</>
  27       <arg><option><replaceable>options</replaceable></></arg>
  28       <arg choice="plain"><replaceable>package</replaceable></arg>
  29       <arg><option><replaceable>...</replaceable></option></arg>
  30     </cmdsynopsis>
  31   </refsynopsisdiv>
  32
  33   <RefSect1><Title>Description</>
  34     <para>
  35       <command>katie</command> is the program which installs packages from incoming into the distribution.
  36     </PARA></REFSECT1>
  37
  38   <RefSect1><Title>Options</>
  39
  40     <VariableList>
  41
  42       <varlistentry>
  43         <term><option>-a/--automatic</option></term>
  44         <listitem>
  45           <para>Run automatically; i.e. perform the default action if it's possible to do so without user interaction.  Intend for use in cron jobs and the like.</para>
  46         </listitem>
  47       </varlistentry>
  48
  49       <varlistentry>
  50         <term><option>-h/--help</option></term>
  51         <listitem>
  52           <para>Display usage help and then exit.</para>
  53         </listitem>
  54       </varlistentry>
  55
  56       <varlistentry>
  57         <term><option>-k/--ack-new</option></term>
  58         <listitem>
  59           <para>Acknowledge new packages.  <emphasis>WARNING:</emphasis> due to the sub-optimal implementation of new packages, this option should only be used when processing *all* packages (e.g. in cron jobs).</para>
  60         </listitem>
  61       </varlistentry>
  62
  63       <varlistentry>
  64         <term><option>-m/--manual-reject=<replaceable>message</replaceable></option></term>
  65         <listitem>
  66           <para>Perform a manual rejection of the package.  The <replaceable>message</replaceable> is included in the rejection notice sent to the uploader.  If no <replaceable>message</replaceable> is given, an editor will be spawned so one can be added to the rejection notice.
  67         </listitem>
  68       </varlistentry>
  69
  70       <varlistentry>
  71         <term><option>-n/--no-action</option></term>
  72         <listitem>
  73           <para>Don't actually install anything; just show what would be done.</para>
  74         </listitem>
  75       </varlistentry>
  76
  77       <varlistentry>
  78         <term><option>-p/--no-lock</option></term>
  79         <listitem>
  80           <para>Don't check the lockfile.  Obviously dangerous and should only be used for cron jobs (if at all).</para>
  81         </listitem>
  82       </varlistentry>
  83
  84       <varlistentry>
  85         <term><option>-u/--distribution=<replaceable>distribution</replaceable></option></term>
  86         <listitem>
  87           <para>Override the <literal>Distribution</Literal> field.  Should only be used for binary packages otherwise if used on a source package, all binary recompiles of that source will require a similar manual override.</para>
  88         </listitem>
  89       </varlistentry>
  90
  91       <varlistentry>
  92         <term><option>-v/--version</option></term>
  93         <listitem>
  94           <para>Display the version number and then exit.</para>
  95         </listitem>
  96       </varlistentry>
  97
  98     </VariableList>
  99   </RefSect1>
 100
 101   <RefSect1><Title>Diagnostics</>
 102     <para>
 103       <command>katie</command> returns zero on normal operation, non-zero on error.
 104     </PARA>
 105   </RefSect1>
 106
 107   <refsect1>
 108     <title>Acknowledgements</title>
 109     <para>katie is based very heavily on dinstall, written by Guy Maor <email>maor@debian.org</email>; in fact it started out life as a dinstall clone.</para>
 110   </refsect1>
 111
 112   &manauthor;
 113
 114
 115
 116 </refentry>