]> git.decadent.org.uk Git - dak.git/blob - docs/katie.1.sgml
cleanup patch from tbm + real_arch filter
[dak.git] / 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 accepted</>
21   </refnamediv>
22
23   <!-- Arguments -->
24   <refsynopsisdiv>
25     <cmdsynopsis>
26       <command>katie</>
27       <arg><option><replaceable>options</replaceable></></arg>
28       <arg choice="plain"><replaceable>changes_file</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 the accepted directory 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>-m/--manual-reject=<replaceable>message</replaceable></option></term>
58         <listitem>
59           <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.
60         </listitem>
61       </varlistentry>
62
63       <varlistentry>
64         <term><option>-n/--no-action</option></term>
65         <listitem>
66           <para>Don't actually install anything; just show what would be done.</para>
67         </listitem>
68       </varlistentry>
69
70       <varlistentry>
71         <term><option>-p/--no-lock</option></term>
72         <listitem>
73           <para>Don't check the lockfile.  Obviously dangerous and should only be used for cron jobs (if at all).</para>
74         </listitem>
75       </varlistentry>
76
77       <varlistentry>
78         <term><option>-v/--version</option></term>
79         <listitem>
80           <para>Display the version number and then exit.</para>
81         </listitem>
82       </varlistentry>
83
84     </VariableList>
85   </RefSect1>
86
87   <RefSect1><Title>Diagnostics</>
88     <para>
89       <command>katie</command> returns zero on normal operation, non-zero on error.
90     </PARA>
91   </RefSect1>
92
93   <refsect1>
94     <title>Acknowledgements</title>
95     <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>
96   </refsect1>
97
98   &manauthor;
99
100
101   
102 </refentry>