Move the replay debugging script iup from the C sources directory.
[super-star-trek.git] / doc / sst.xml
1 <!DOCTYPE refentry PUBLIC 
2    "-//OASIS//DTD DocBook XML V4.1.2//EN"
3    "docbook/docbookx.dtd">
4 <refentry id='sst.6'>
5 <refmeta>
6 <refentrytitle>sst</refentrytitle>
7 <manvolnum>6</manvolnum>
8 <refmiscinfo class='date'>Nov 1 2004</refmiscinfo>
9 </refmeta>
10 <refnamediv id='name'>
11 <refname>sst</refname>
12 <refpurpose>the classic Super Star Trek game</refpurpose>
13 </refnamediv>
14 <refsynopsisdiv id='synopsis'>
15
16 <cmdsynopsis>
17 <command>sst</command>
18       <arg choice='opt'>-r <replaceable>filename</replaceable></arg> 
19       <arg choice='opt'>-t </arg> 
20       <arg choice='opt'>-x </arg> 
21       <arg rep='repeat' ><replaceable>command</replaceable></arg>  
22 </cmdsynopsis>
23
24 </refsynopsisdiv>
25
26 <refsect1 id='description'><title>DESCRIPTION</title>
27
28 <para>The Organian Peace Treaty has collapsed, and the Federation is
29 at war with the Klingon Empire. Joining the Klingons against the
30 Federation are the members of the Romulan Star Empire. As commander
31 of the Starship U.S.S. Enterprise, your job is to wipe out the Klingon
32 invasion fleet and make the galaxy safe for democracy.</para>
33
34 <para>This is one of the great early classic computer games from the
35 1970s and still has a remarkable amount of play value. Run
36 <command>sst</command> in a terminal window to start it.  Typing
37 'comands' at the prompt will list all commands; help is available for
38 each one individually as well.  Full documentation is <ulink
39 url='http://sst.berlios.de/sst-doc.html'>browseable</ulink>.  On
40 systems where <filename>/usr/share/doc/sst/</filename> is a legal
41 filename, it will probably be installed there as well.</para>
42
43 <para>The option -t forces the original pure-tty mode.
44 Normally sst tries to come up in full-screen mode that assumes it is
45 running on a cursor-addressable terminal or terminal emulator.</para>
46
47 <para>The option -r sets up replay of a session logfile.  Commands
48 in the logfile are executed, then additional commands are taken
49 from stdin as normal.  The -r option forces -t mode.</para>
50
51 <para>The option -x enables some debugging features of interest
52 probably only to sst2k developers.</para>
53
54 <para>Input tokens for the setup prompts will be read from the
55 remainder of the command line before standard input.  Thus, for
56 example, you can invoke the program as</para>
57
58 <programlisting>
59 sst regular medium good fancy
60 </programlisting>
61
62 <para>to start a regular medium game as a good player in 'fancy'
63 mode (all features enabled).</para>
64 </refsect1>
65
66 <refsect1 id='files'><title>FILES</title>
67 <variablelist>
68 <varlistentry>
69 <term><filename>/usr/share/doc/sst/sst.doc</filename></term>
70 <listitem>
71 <para>Documentation file.</para>
72 </listitem>
73 </varlistentry>
74 <varlistentry>
75 <term><filename>$TMPDIR/sst-input.log</filename></term>
76 <listitem>
77 <para>Where user input is saved to (send this with your bug reports).
78 If TMPDIR is not set is defaults to <filename>/tmp</filename>.</para>
79 </listitem>
80 </varlistentry>
81 <varlistentry>
82 <term><filename>emsave.trk</filename></term>
83 <listitem>
84 <para>Save file produced by EMEXIT command.</para>
85 </listitem>
86 </varlistentry>
87 </variablelist>
88 </refsect1>
89
90 <refsect1 id='authors'><title>AUTHORS</title> 
91 <para>Super Star Trek was designed and written by David Matuszek, Paul
92 Reynolds, and Don Smith in the 1970s.  It was resurrected by Tom Almy.
93 The screen-oriented interface is by Stas Sergeev. This version has
94 been improved, cleaned up and documented by Eric S. Raymond
95 <email>esr@snark.thyrsus.com</email>.  There is a <ulink
96 url='https://developer.berlios.de/projects/sst/'>project
97 page</ulink>.</para>
98 </refsect1>
99 </refentry>
100