X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/rocl/blobdiff_plain/8e91ba5d9bc942bb65d6d954abd8895a75a63392..1ded87baa037e0d9a72ae58b86bdf34244464f01:/README

diff --git a/README b/README
index 8d09408..14659d3 100644
--- a/README
+++ b/README
@@ -226,6 +226,120 @@ RIGHT ON COMMAND-LINE
 			as the variables described above.
 
 
+  elite-cmdr [FILE] [-OPTION | ATTR | ATTR=VALUE | FILE] ...
+
+	A command-line Elite commander editor and viewer.  With a single
+	argument, reads a commander file and displays its contents as a
+	human readable table.  The arguments may be special options,
+	attribute names, attribute assignments, or filenames.
+
+	The special options are:
+
+	-show		Write the commander data to standard output as a
+			human-readable table.  This is the default if no
+			other output action is requested.
+
+	-load FILE	Read the commander file named FILE.
+
+	-save FILE	Write the modified commander data to FILE.
+
+	-reset		Reset the commander to the default `JAMESON'
+			settings.
+
+	-dump		Write the commander data to standard output in
+			the form of a script which can be read back by
+			the `-read' option.
+
+	-read FILE	Read attribute/value pairs from FILE, and modify
+			the commander accordingly.
+
+	An attribute name on its own is a request to print the current
+	value of that attribute.  An assignment ATTR=VALUE makes ATTR
+	have the requested VALUE.
+
+	The attributes, their meanings, and the acceptable values are as
+	follows:
+
+	mission		The commander's current mission.  (0 is no
+			mission; 1 is searching for the Constrictor; 2
+			is killed the Constrictor; 3 is waiting for the
+			second mission; 4 is heading for Ceerdi; 5 is
+			heading for Birera; and 6 is all missions
+			completed.)  Must be an integer between 0 and
+			255.
+
+	score		Current number of kills.  Must be an integer
+			between 0 a 65535, or one of the strings
+			`harmless', `mostly-harmless', `poor',
+			`average', `above-average', `competent',
+			`dangerous', `deadly', or `elite'.
+
+	credits		Number of credits.  Must be between 0 and
+			429496729.5.
+
+	cargo		Size of cargo bay.  Must be between 4 and 255.
+
+	gal-number	Number of the current galaxy.  Note that this
+			doesn't affect which galaxy the commander is
+			actually in -- set gal-seed for that.  Must be
+			between 1 and 8.
+
+	gal-seed	Which galaxy the commander is in.  May be any
+			galaxy-spec.
+
+	world		Which world the commander is docked at.  May be
+			any planet-spec describing a world in the
+			correct galaxy.  (Note that, since the commander
+			file actually stores the location as an x, y
+			pair and chooses the closest world to those
+			coordinates, and there are coincident pairs of
+			worlds, it is not possible to have a commander
+			start at some worlds.)
+
+	market-fluc	The market fluctuation byte.  Affects prices at
+			the space station.  Must be an integer between 0
+			and 255.
+
+	fuel		Amount of fuel.  Must be between 0 and 25.5.
+
+	energy-unit	Strength of the ship's energy unit.  May be an
+			integer between 0 (none) and 255 (scary cheat)
+			or one of the strings `none', `standard', or
+			`naval'.
+
+	front-laser, rear-laser, left-laser, light-laser
+			Strength of appropriate laser.  May be an
+			integer between 0 (none) and 255 (scary cheat)
+			or one of the strings `none', `pulse', `beam',
+			`mining', or `military'.
+
+	ecm, fuel-scroop, enery-bomb, escape-pod,
+	docking-computer, gal-hyperdrive
+			Whether the ship has various bits of equipment.
+			One of `yes', `true', or `on' for yes, or `no',
+			`false' or `off' for no.
+
+	missiles	Number of missiles carried.  Must be an integer
+			between 0 and 255.
+
+	hold-ITEM, station-ITEM
+			Quantity of some item in the ship's hold, or at
+			the station.  Must be an integer between 0 and
+			255.  ITEM must be one of `food', `textiles',
+			`radioactives', `slaves', `liquor-wines',
+			`luxuries', `narcotics', `computers',
+			`machinery', `alloys', `firearms', `furs',
+			`minerals', `gold', `platinum', `gem-stones', or
+			`alien-items'.
+
+	#		A special attribute which is never printed.  Its
+			value is ignored.  This may be used to insert
+			comments in script files.
+
+	Anything else is assumed to be a filename, and loaded as for the
+	`-load' option.
+
+
   elite-prices [-g GALAXY] [-s SORT] [FROM TO]
 
 	Shows minimum, average and maximum profit (in that order, in
@@ -336,7 +450,7 @@ RIGHT ON COMMAND-LINE
 	unrewarding) or pirates (risky and tedious), and start trading
 	food and other cheap items.
 
-$Id: README,v 1.3 2003/02/26 01:12:30 mdw Exp $
+$Id: README,v 1.4 2003/03/01 17:47:07 mdw Exp $
 
 Local variables:
 mode: text