merge the autotools branch
[super-star-trek.git] / doc / sst.xml
diff --git a/doc/sst.xml b/doc/sst.xml
new file mode 100644 (file)
index 0000000..5a56584
--- /dev/null
@@ -0,0 +1,67 @@
+<!DOCTYPE refentry PUBLIC 
+   "-//OASIS//DTD DocBook XML V4.1.2//EN"
+   "docbook/docbookx.dtd">
+<refentry id='sst.6'>
+<refmeta>
+<refentrytitle>sst</refentrytitle>
+<manvolnum>6</manvolnum>
+<refmiscinfo class='date'>Nov 1 2004</refmiscinfo>
+</refmeta>
+<refnamediv id='name'>
+<refname>sst</refname>
+<refpurpose>the classic Super Star Trek game</refpurpose>
+</refnamediv>
+<refsynopsisdiv id='synopsis'>
+
+<cmdsynopsis>
+<command>sst</command>
+<arg choice='opt'>-t </arg> 
+<arg rep='repeat' ><replaceable>command</replaceable></arg>  
+</cmdsynopsis>
+
+</refsynopsisdiv>
+
+<refsect1 id='description'><title>DESCRIPTION</title>
+
+<para>The Organian Peace Treaty has collapsed, and the Federation is
+at war with the Klingon Empire. Joining the Klingons against the
+Federation are the members of the Romulan Star Empire. As commander
+of the Starship U.S.S. Enterprise, your job is to wipe out the Klingon
+invasion fleet and make the galaxy safe for democracy.</para>
+
+<para>This is one of the great early classic computer games from the
+1970s and still has a remarkable amount of play value. Run
+<command>sst</command> in a terminal window to start it.  Typing
+'comands' at the prompt will list all commands; help is available for
+each one individually as well.  Full documentation is <ulink
+url='http://sst.berlios.de/sst-doc.html'>browseable</ulink>.  On
+systems where <filename>/usr/share/doc/sst/</filename> is a legal
+filename, it will probably be installed there as well.</para>
+
+<para>There is one option -t, which forces the original pure-tty mode.
+Normally sst tries to come up in full-screen mode that assumes it is
+running on a cursor-addressable terminal or terminal emulator.</para>
+
+<para>Input tokens for the setup prompts will be read from the
+remainder of the command line before standard input.  Thus, for
+example, you can invoke the program as</para>
+
+<programlisting>
+sst regular medium good fancy
+</programlisting>
+
+<para>to start a regular medium game as a good player in 'fancy'
+mode (all features enabled).</para>
+</refsect1>
+
+<refsect1 id='authors'><title>AUTHORS</title> 
+<para>Super Star Trek was designed and written by David Matuszek, Paul
+Reynolds, and Don Smith in the 1970s.  It was resurrected by Tom Almy.
+The screen-oriented interface is by Stas Sergeev. This version has
+been cleaned up and documented by Eric S. Raymond
+<email>esr@snark.thyrsus.com</email>.  There is a <ulink
+url='https://developer.berlios.de/projects/sst/'>project
+page</ulink>.</para>
+</refsect1>
+</refentry>
+