Update for current code, and edited for clarity.

This commit is contained in:
Markus Armbruster 2006-05-29 20:06:34 +00:00
parent 2b57a13d94
commit 26110320c0
2 changed files with 53 additions and 71 deletions

View file

@ -1,15 +1,17 @@
.TH Command LAND .TH Command LAND
.NA land "Report status of unit, army or units in a given area" .NA land "Report status of land units"
.LV Basic .LV Basic
.SY "land [<UNIT/ARMY> | <SECTS>]" .SY "land <UNITS>"
The unit report command is a census of your units and lists all the The land unit report command is a census of your land units. For
info available in readable format. example:
.s1 .EX land *
The <UNIT/ARMY> and <SECTS> arguments are provided in case you only .NF
wish to look at one unit or one army or all units within a given area. # unit type x,y a eff mil frt mu fd tch retr rd xl ln carry
.s1 0 cav cavalry 1,-1 100% 10 0 127 12 992 75% 3 0 0
Land expects an argument. To see every unit you own, give it 1 cav cavalry 0,0 100% 0 0 127 12 968 75% 3 0 0
the argument '*', i.e. type "land *". 2 cav cavalry 0,0 100% 10 0 127 12 40 75% 3 0 0
3 units
.FI
.s1 .s1
The report format contains the following fields: The report format contains the following fields:
.s1 .s1
@ -17,45 +19,35 @@ The report format contains the following fields:
.L # .L #
the unit number the unit number
.L "unit type" .L "unit type"
the type of unit; \*Qwar band\*U, \*Qengineer\*U, etc, the type of land unit; \*Qcavalry\*U, \*Qengineer\*U, etc.,
.L x,y .L x,y
the unit's current location (relative to your capital), the land unit's current location,
.L a .L a
the army designation letter (set by \*Qarmy\*U command), the army designation letter (set by \*Qarmy\*U command),
.L eff .L eff
the unit's efficiency, the land unit's efficiency,
.L mil .L mil
the number of mil currently in the land unit the number of mil currently in the land unit,
.L frt .L frt
the unit's fortification level (0-127) the land unit's fortification level,
.L mu .L mu
the mobility of the unit the mobility of the land unit,
.L fd .L fd
the amount of food on board the amount of food on board,
.L fuel .L fl
the amount of fuel on board (if the FUEL option is enabled) the amount of fuel on board (only if the FUEL option is enabled),
.L tch .L tch
the tech level of the unit the tech level of the land unit,
.L retr .L retr
the retreat percentage of the unit (see info attack) the retreat percentage of the land unit (see info \*morale\*U),
.L rd .L rd
the unit's reaction radius (see info attack) the land unit's reaction radius (see info \*Qfortify\*U),
.L xl .L xl
the number of extra-light planes on board (if the XLIGHT option is enabled) the number of extra-light planes on board,
.L ln .L ln
the number of land units on board the number of land units on board,
.L l/s .L carry
the ship or land unit the unit is on, if any the ship or land unit the carrying the land unit, if any.
.in .in
.s1 .s1
For example:
.EX land *
.NF
# unit type x,y a eff mil frt mu fd fl tch retr rd xl ln l/s
0 cav cavalry 1,-1 100% 10 0 127 12 0 992 75% 3 0 0
1 cav cavalry 0,0 100% 0 0 127 12 0 968 75% 3 0 0
2 cav cavalry 0,0 100% 10 0 127 12 0 40 75% 3 0 0
3 units
.FI
.s1
.SA "lstat, upgrade, build, cargo, army, march, attack, assault, lload, llookout, scrap, lmine, LandUnits" .SA "lstat, upgrade, build, cargo, army, march, attack, assault, lload, llookout, scrap, lmine, LandUnits"

View file

@ -1,61 +1,51 @@
.TH Command SHIP .TH Command SHIP
.NA ship "Report status of ship, fleet or ships in a given area" .NA ship "Report status of ships"
.LV Basic .LV Basic
.SY "ship [<SHIP/FLEET> | <SECTS>]" .SY "ship <SHIPS>"
The ship report command is a census of your ships and lists all the The ship report command is a census of your ships. For example:
info available in readable format. .EX ship *
.s1 .NF
The <SHIP/FLEET> and <SECTS> arguments are provided in case you only shp# ship type x,y fl eff civ mil uw fd pn he xl ln mob tech
wish to look at one ship 0 dd destroyer 1,1 100% 0 0 0 0 0 0 0 0 127 140
or one fleet or all ships within a given area. 1 bb battleship 1,1 100% 0 0 0 0 0 0 0 0 120 200
.s1 2 ships
Ship expects an argument. To see every ship you own, give it .FI
the argument '*', or type "ship *".
.s1 .s1
The report format contains the following fields: The report format contains the following fields:
.s1 .s1
.in \w'shiptype\0\0'u .in \w'ship type\0\0'u
.L shp# .L shp#
the ship number the ship number
.L shiptype .L "ship type"
the type of ship; \*Qpatrol boat\*U, \*Qsubmarine\*U, etc, the type of ship; \*Qpatrol boat\*U, \*Qsubmarine\*U, etc.,
.L x,y .L x,y
the ship's current location (relative to your capital), the ship's current location,
.L flt .L flt
the fleet designation letter (set by \*Qfleetadd\*U command), the fleet designation letter (set by \*Qfleetadd\*U command),
.L eff .L eff
the ship's efficiency, the ship's efficiency,
.L civ .L civ
the number of civilians on board the number of civilians on board,
.L mil .L mil
mil is the number of military on board mil is the number of military on board,
.L uw .L uw
the number of uncompensated workers on board, the number of uncompensated workers on board,
.L fd .L fd
the amount of food on board the amount of food on board,
.L pn .L pn
the number of planes on the ship the number of planes on the ship,
.L he .L he
the number of helicopters on board (if the SHIPCHOPPERS option is enabled) the number of helicopters on board,
.L xl .L xl
the number of extra-light planes on board (if the XLIGHT option is enabled) the number of extra-light planes on board,
.L ln .L ln
the number of land units on board the number of land units on board,
.L fuel .L fuel
the amount of fuel on board (if the FUEL option is enabled) the amount of fuel on board (only if the FUEL option is enabled)
.L mu .L mob
the mobility of the ship the mobility of the ship,
.L tech .L tech
the tech level of the ship the tech level of the ship.
.in .in
.s1 .s1
For example:
.EX ship *
.NF
shp# ship type x,y fl eff civ mil uw fd pn he xl ln mob fuel tech
0 dd destroyer 1,1 100% 0 0 0 0 0 0 0 0 127 30 140
1 bb battleship 1,1 100% 0 0 0 0 0 0 0 0 120 50 200
2 ships
.FI
.s1
.SA "sstat, build, cargo, fleetadd, navigate, load, lookout, scrap, sonar, torpedo, upgrade, land, Ships" .SA "sstat, build, cargo, fleetadd, navigate, load, lookout, scrap, sonar, torpedo, upgrade, land, Ships"