doc/sst.xml

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