]> git.pond.sub.org Git - empserver/blobdiff - info/retreat.t
info/retreat info/lretreat: Fix and clean up
[empserver] / info / retreat.t
index 9005ac777af3b639277605278b900c9a4941d054..5ded60683cc45c8b240a0abea1f28579b3ca9e49 100644 (file)
@@ -1,44 +1,39 @@
 .TH Command RETREAT
 .NA retreat "Set retreat conditions/paths for ships or fleets"
 .LV Expert
-.SY "retreat [<SHIP/FLEET> | <SECTS>] [<PATH>] [<CONDITIONS>]"
-.SY "lretreat [<UNIT/ARMY> | <SECTS>] [<PATH>] [<CONDITIONS>]"
+.SY "retreat <SHIP/FLEET> [<PATH> <CONDITIONS>]"
 The retreat command allows you to examine or modify the retreat
-paths and conditions of your ships or units. The following description
-is for ships. Land units are exactly the same, except of course that
-some of the retreat conditions (being sonared, depth charged, etc) don't apply.
+paths and conditions of your ships.
 .s1
-The <SHIP/FLEET> and <SECTS> arguments are provided to specify which
-ships to view or give orders for. If a fleet designation is given when
-specifying orders, the orders apply to all ships within that fleet.
-.s1
-Retreat expects an argument.  To see every ship you own, give it
-the argument '*', or type "retreat *".
+The first argument selects ships to view or give orders for.
+If a fleet designation is given when specifying orders, the orders
+apply to all members of that fleet.
 .s1
+Without further arguments, current retreat orders are shown.
 The report format contains the following fields:
 .s1
-.in \w'shiptype\0\0'u
+.in \w'ship type\0\0'u
 .L shp#
 the ship number
-.L shiptype
+.L ship type
 the type of ship; \*Qpatrol boat\*U, \*Qsubmarine\*U, etc,
 .L x,y
-the ship's current location (relative to your capital),
+the ship's current location,
 .L flt
 the fleet designation letter (set by \*Qfleetadd\*U command),
 .L path
-the ship's current retreat path.
-.L as_flt?
-whether or not the ship's retreat path is a fleet retreat path
+the current retreat path,
+.L as flt?
+whether these are fleet retreat orders,
 .L flags
-what conditions the ship will retreat under
+what conditions will trigger retreat.
 .in
 .s1
 For example:
 .EX retreat *
 .NF
 shp#     ship type       x,y   fl path       as flt?  flags
-   0 battleship 4        2,0      jjuuj               I
+   0 bb   battleship     2,0      jjuuj               i
 1 ship
 .FI
 .s1
@@ -62,21 +57,21 @@ Retreat conditions are:
 .nf
 
        Condition       Meaning
-       I               Retreat when the ship is injured,
-                       i.e. whenever the ship is damaged by fire,
-                       bombs, or torping
-       T               Retreat when a sub torpedos or tries to
+       i               Retreat when the ship is injured,
+                       i.e. whenever the ship is damaged by gun fire,
+                       bombs or torpedoes
+       t               Retreat when a sub torpedoes or tries to
                        torpedo the ship
-       B               Retreat when a plane bombs or tries to bomb
+       b               Retreat when a plane bombs or tries to bomb
                        the ship
-       S               Retreat when the ship detects a sonar ping
-       D               Retreat when the ship is depth-charged
-       H               Retreat when helpless --- a ship is helpless
+       s               Retreat when the ship detects a sonar ping
+       d               Retreat when the ship is depth-charged
+       h               Retreat when helpless --- a ship is helpless
                        when it is fired upon, and no friendly
                        ships/sectors (including the ship itself) are
                        able to fire back at the aggressor
-       U               Retreat upon a failed boarding attempt
-       C               Cancel retreat order
+       u               Retreat upon a failed boarding attempt
+       c               Cancel retreat order
 .fi
 .s1
 For example, if the battleship above was fired at, it would attempt to
@@ -84,7 +79,7 @@ retreat 2 sectors, jj, using the normal amount of mobility for moving
 2 sectors. It would then look like:
 .NF
 shp#     ship type       x,y   fl path       as flt?  flags
-   0 battleship 4        2,0      uuj                 I
+   0 bb   battleship     2,0      uuj                 i
 1 ship
 .FI
 .s1