From: Eric S. Raymond <esr@thyrsus.com>
Date: Mon, 1 Nov 2004 23:51:38 +0000 (+0000)
Subject: Add a manual page.
X-Git-Tag: 2.0~439
X-Git-Url: https://jxself.org/git/?a=commitdiff_plain;h=546c3eac5680f10eb3d08962a151e37cda548e69;p=super-star-trek.git

Add a manual page.
---

diff --git a/TODO b/TODO
index 142160b..b07a100 100644
--- a/TODO
+++ b/TODO
@@ -2,8 +2,6 @@
 
 * Remove the assumption that sst.doc lives in the current directory.
 
-* Do a manual page.
-
 * Improve the internal pager.
 
 * Yes-no confirmations and "press-to-continue" situations should print
@@ -21,6 +19,8 @@
 
 * Write a curses-based interface.  Shouldn't be hard, all output goes through
   prout/proutn/prouts so we can split the screen into two panes with the upper
-  one for the charts.
+  one for the charts.  (Note, there's one fputs() used in the help reader to
+  avoid % expansion.)
+
 
 
diff --git a/makefile b/makefile
index b459f7e..2b7f50d 100644
--- a/makefile
+++ b/makefile
@@ -3,9 +3,11 @@ CFLAGS=     -O -g
 .c.o:
 	$(CC) $(CFLAGS) -c $<
 
-OFILES=     sst.o finish.o reports.o setup.o linux.o moving.o battle.o events.o ai.o planets.o
+CFILES= sst.c finish.c reports.c setup.c linux.c moving.c battle.c events.c ai.c planets.c
+OFILES= $(CFILES:.c=.o)
+HFILES=sst.h 
 
-HFILES=     sst.h
+SOURCES= $(CFILES) $(HFILES) sst-doc.xml TODO makehelp.py makefile sst.xml
 
 all: sst sst.doc
 
@@ -14,6 +16,9 @@ sst:  $(OFILES)
 
 $(OFILES):  $(HFILES)
 
+sst.6: sst.xml
+	xmlto man sst.xml
+
 sst-doc.txt: sst-doc.xml
 	xmlto --skip-validation txt sst-doc.xml
 sst.doc: sst-doc.txt
diff --git a/sst.xml b/sst.xml
new file mode 100644
index 0000000..608b323
--- /dev/null
+++ b/sst.xml
@@ -0,0 +1,47 @@
+<!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>
+</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>.</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.  This version has
+been cleaned up and documented by Eric S. Raymond
+&lt;esr@snark.thyrsus.com&gt;.  There is a <ulink
+url='https://developer.berlios.de/projects/sst/'>project
+page</ulink>.</para>
+</refsect1>
+</refentry>
+