]> git.pond.sub.org Git - empserver/blobdiff - info/xdump.t
New info Hvy-Plastic
[empserver] / info / xdump.t
index 9e566853552b8c43866bc0167c54ee986385d1c1..b6d36437fb601b373263cafd34c119fa2ed99c80 100644 (file)
@@ -3,15 +3,13 @@
 .LV Expert
 .SY "xdump <TYPE|NUMBER> <RECORDS>"
 .SY "xdump meta <TYPE|NUMBER>"
-.SY "xdump ver"
-.SY "xdump meta ver"
 The xdump command displays information on game configuration and state
 in machine readable format.  It is intended for use by clients and
-tools.  This info page explains little more than command syntax; see
-doc/xdump in the source distribution for complete documentation.
+tools.  This info page gives an overview; see doc/xdump in the source
+distribution for complete documentation.
 .s1
 Game configuration and state consists of a a number of tables or
-files.  xdump shows only things that are \fIcertainly\fP visible to
+files.  xdump shows only things that are \*(fIcertainly\*(fP visible to
 you: sectors you own, ship types known, etc.
 .s1
 The output of xdump is a table consisting of a header line, the table
@@ -38,11 +36,11 @@ Floating-point fields can be parsed by scanf %g (or equivalents %e,
 .s1
 String fields are in C syntax.  Funny characters including space,
 newline and double-quote are shown as octal escape sequences.  Example:
-"gold\\040mine".  If a field starts with a double-quote, it's a string
+"gold\e040mine".  If a field starts with a double-quote, it's a string
 field.
 .s1
 .L "FUTURE DIRECTIONS:"
-We might decide to support more C escape sequences, but never \\".
+We might decide to support more C escape sequences, but never \\\(dq.
 .s1
 Some fields can contain null strings.  A null string is the three
 letters \*Qnil\*U.  If a field contains nil, it's a string field.
@@ -85,20 +83,18 @@ The table \*Qtable\*U is the table of (non-meta-)tables.  It contains
 table names and numbers.  xdump accepts table numbers as well as
 names.
 .s1
-There's a special pseudo-table \*Qver\*U, which collects configuration
-parameters in a single record.  It is not listed in \*Qtable\*U, it
-doesn't have a table number, but it does have a meta-table.
-.s1
 .L BUGS:
 Still missing are game state files power, map, bmap; the list of
-commands; foreign relations and levels, contact and reject
-information, budget priorities; mortal access to sector selector
+commands; foreign levels, contact
+information, mortal access to sector selector
 mines, ship selectors xbuilt, ybuilt, trade selectors xloc, yloc,
 commodity selectors xbuy, ybuy, xsell, ysell.  Some information is not
 yet available in human-readable form: the lost file, sect-chr selector
 nav, ship and land plague status (deity only), plane theta (governs
 satellite movement), trade selectors xloc, yloc, commodity selectors
 xbuy, ybuy.
+Incremental dump doesn't work after importing news with the empdump
+utility.
 .s1
 .L "FUTURE DIRECTIONS:"
 xdump is still fairly new, and experience with it may lead to changes.