Initial import

[dak.git] / docs / lisa.1.sgml

diff --git a/docs/lisa.1.sgml b/docs/lisa.1.sgml
new file mode 100644 (file)
index 0000000..a89234e
--- /dev/null
+++ b/docs/lisa.1.sgml
@@ -0,0 +1,95 @@
+<!-- -*- mode: sgml; mode: fold -*- -->
+<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
+
+<!ENTITY % katieent SYSTEM "katie.ent">
+%katieent;
+
+]>
+
+<refentry>
+  &katie-docinfo;
+
+  <refmeta>
+    <refentrytitle>lisa</>
+    <manvolnum>1</>
+  </refmeta>
+
+  <!-- Man page title -->
+  <refnamediv>
+    <refname>lisa</>
+    <refpurpose>Processes BYHAND and NEW packages</>
+  </refnamediv>
+
+  <!-- Arguments -->
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>lisa</>
+      <arg><option><replaceable>options</replaceable></></arg>
+      <arg choice="plain"><replaceable>changes_file</replaceable></arg>
+      <arg><option><replaceable>...</replaceable></option></arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <RefSect1><Title>Description</>
+    <para>
+      <command>lisa</command> is the program which installs packages from the accepted directory into the distribution.
+    </PARA></REFSECT1>
+
+  <RefSect1><Title>Options</>
+
+    <VariableList>
+
+      <varlistentry>
+       <term><option>-a/--automatic</option></term>
+       <listitem>
+         <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>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term><option>-h/--help</option></term>
+       <listitem>
+         <para>Display usage help and then exit.</para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term><option>-m/--manual-reject=<replaceable>message</replaceable></option></term>
+       <listitem>
+         <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.
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term><option>-n/--no-action</option></term>
+       <listitem>
+         <para>Don't actually install anything; just show what would be done.</para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term><option>-p/--no-lock</option></term>
+       <listitem>
+         <para>Don't check the lockfile.  Obviously dangerous and should only be used for cron jobs (if at all).</para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term><option>-v/--version</option></term>
+       <listitem>
+         <para>Display the version number and then exit.</para>
+       </listitem>
+      </varlistentry>
+
+    </VariableList>
+  </RefSect1>
+
+  <RefSect1><Title>Diagnostics</>
+    <para>
+      <command>lisa</command> returns zero on normal operation, non-zero on error.
+    </PARA>
+  </RefSect1>
+
+  &manauthor;
+
+</refentry>