documentation update

Incorporate the diff from entrez describing the travel_debug wizard
mode option and removing obsolete M prefix from the Guidebook.  That
missed a reference to it in the description of '_'.

I put M back in case someone who has used it with earlier versions
tries to use it and gets a no-such-command complaint so goes looking
for it.

Also, make the mention of ^X at the end of the discussion of status
stand out a bit.  The indentation of its paragraph made it line up
with the preceding text instead of making it be distinct from that.

The TeX changes are untested and given the amount of punctuation
characters used, it will be surprising if they all have been quoted
properly.

diff --git a/dat/opthelp b/dat/opthelp
index 6fc5cc94196f047472b39f0d926deda770be58e7..9d63831e9a510a5aa0696a3b2b04ff6a70192a7f 100644 (file)
--- a/dat/opthelp
+++ b/dat/opthelp
@@ -134,7 +134,7 @@ tiled_map      show map as tiles, forces ascii_map Off; Qt, X11
 Boolean options available when running in debug mode (aka wizard mode):
 menu_tab_sep   menu formatting--do not touch
 monpolycontrol have player choose shape-changing monsters' new shapes
-travel_debug   not implemented?
+travel_debug   show state of travel pathfindinging algorithm on the map
 wizweight      include item weights in inventory display
 
 Any Boolean option can be set to True by including it among options being

diff --git a/doc/Guidebook.mn b/doc/Guidebook.mn
index a420585923368e061de5bce11536ad4ca4abd2a9..c0b92b4a61021b418531b5cbfdc8e6de82eed83d 100644 (file)
--- a/doc/Guidebook.mn
+++ b/doc/Guidebook.mn
@@ -1,4 +1,4 @@
-.\" $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.463 $ $NHDT-Date: 1655161563 2022/06/13 23:06:03 $
+.\" $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.464 $ $NHDT-Date: 1655461129 2022/06/17 10:18:49 $
 .\"
 .\" This is an excerpt from the 'roff' man page from the 'groff' package.
 .\" Guidebook.mn currently does *not* fully adhere to these guidelines.
@@ -415,7 +415,13 @@ Movement modifiers:
 .lp ""
 Other conditions and modifiers exist, but there isn't enough room to
 display them with the other status fields.
-The \(oq\(haX\(cq command shows all relevant status conditions.
+.pg
+.in -5n .\" outdent this paragraph
+The \f(CR#doattributes\fP command (default key \f(CR\(haX\fP) will show
+all current status information in unabbreviated format.
+It also shows other information which might be included on the status
+lines if those had more room.
+.in 0 .\" reset indentation
 .hn 2
 The message line (top)
 .pg
@@ -662,13 +668,22 @@ In debug mode (aka \(lqwizard mode\(rq), the \(oqm\(cq prefix may also be
 used with the \(lq#teleport\(rq and \(lq#wizlevelport\(rq commands.
 .lp F[yuhjklbn]
 Prefix:  fight a monster (even if you only guess one is there).
-.lp M[yuhjklbn]
-Prefix:  move far, no pickup.
 .lp "g[yuhjklbn]"
 Prefix:  move until something interesting is found.
-.lp "G[yuhjklbn] or <CONTROL->[yuhjklbn]"
-Prefix:  same as \(oqg\(cq, but forking of corridors is not considered
+.lp "G[yuhjklbn] or <Control>[yuhjklbn]"
+Prefix:  similar to \(oqg\(cq, but forking of corridors is not considered
 interesting.
+.lp ""
+Note:  <Control>+<key> means using the holding the <Control> or <Ctrl> key
+down like <Shift> while typing and releasing <key>, then releasing <Control>.
+Control characters are case-insensitive so \(hax and \(haX are the same.
+.lp "M<direction>"
+Old versions supported \(oq\f(CRM\fP\(cq as a movement prefix which
+combined the effect of \(oq\f(CRm\fP\(cq with \f(CR<Control>\fP+<direction>.
+That is no longer supported as a prefix but similar effect can be achieved
+by using \f(CRm\fP and \f(CRG\fP+<direction> in combination.
+\f(CRm\fP can also be used in combination with \f(CRg\fP+<direction>,
+\f(CR<Control>\fP+<direction>, or \f(CR<Shift>\fP+<direction>.
 .lp _
 Travel to a map location via a shortest-path algorithm.
 .lp ""
@@ -677,13 +692,14 @@ is computed over map locations the hero knows about (e.g. seen or
 previously traversed).
 If there is no known path, a guess is made instead.
 Stops on most of
-the same conditions as the \(oqG\(cq command, but without picking up
-objects, similar to the \(oqM\(cq command.
+the same conditions as the \f(CRG\fP prefix, but without picking up
+objects, so implicitly forces the \f(CRm\fP prefix.
 For ports with mouse
 support, the command is also invoked when a mouse-click takes place on a
 location other than the current position.
 .lp .
-Wait or rest, do nothing for one turn. Precede with the \(oqm\(cq prefix
+Wait or rest, do nothing for one turn.
+Precede with the \(oqm\(cq prefix
 to wait for a turn even next to a hostile monster, if
 .op safe_wait
 is on.
@@ -691,7 +707,8 @@ is on.
 Apply (use) a tool (pick-axe, key, lamp...).
 .lp ""
 If used on a wand, that wand will be broken, releasing its magic in the
-process.  Confirmation is required.
+process.
+Confirmation is required.
 .lp A
 Remove one or more worn items, such as armor.
 .lp ""

diff --git a/doc/Guidebook.tex b/doc/Guidebook.tex
index 8782ca5f31613cd66fad30fe358ed425bfc40f21..9c09495d352b914d85c92ceb028965e8e46ddbdd 100644 (file)
--- a/doc/Guidebook.tex
+++ b/doc/Guidebook.tex
@@ -474,8 +474,14 @@ Movement~modifiers:
 
 %.lp ""
 Other conditions and modifiers exist, but there isn't enough room to
-display them with the other status fields.  The `{\tt \^{}X}' command shows
-all relevant status conditions.
+display them with the other status fields.
+\\
+% unindented paragraph
+The {\tt \#doattributes} command (default key {\tt \^{}X} will show
+all current status information in unabbreviated format.
+It also shows other information which might be included on the status
+lines if those had more room.
+
 \elist
 
 %.hn 2
@@ -758,30 +764,43 @@ used with the ``{\tt \#teleport}'' and ``{\tt \#wizlevelport}'' commands.
 \item[\tb{F[yuhjklbn]}]
 Prefix:  fight a monster (even if you only guess one is there).
 %.lp
-\item[\tb{M[yuhjklbn]}]
-Prefix:  Move far, no pickup.
-%.lp
 \item[\tb{g[yuhjklbn]}]
 Prefix:  Move until something interesting is found.
 %.lp
-\item[\tb{G[yuhjklbn] {\rm or} <CONTROL->[yuhjklbn]}]
-Prefix:  Same as `{\tt g}', but forking of corridors is not considered
+\item[\tb{G[yuhjklbn] {\rm or} <Control>+[yuhjklbn]}]
+Prefix:  Similar to `{\tt g}', but forking of corridors is not considered
 interesting.
+\\
+Note:  <Control>+<key> means using the holding the <Control> or <Ctrl> key
+down like <Shift> while typing and releasing <key>, then releasing <Control>.
+Control characters are case-insensitive so {\tt \^{}x} and {\tt \^{}X}
+are the same.
+%.lp
+\item[\tb(M<direction>}]
+Old versions supported `{\tt M}' as a movement prefix which
+combined the effect of `{\tt m}' with {\tt <Control>}+<direction>.
+That is no longer supported as a prefix but similar effect can be achieved
+by using {\tt m} and {\tt G}+<direction> in combination.
+{\tt m} can also be used in combination with {\tt g}+<direction>,
+{\tt <Control>}+<direction>, or {\tt <Shift>}+<direction>.
 %.lp
 \item[\tb{_}]
 Travel to a map location via a shortest-path algorithm.\\
 %.lp ""
 The shortest path
 is computed over map locations the hero knows about (e.g. seen or
-previously traversed).  If there is no known path, a guess is made instead.
+previously traversed).
+If there is no known path, a guess is made instead.
 Stops on most of
 the same conditions as the `G' command, but without picking up
-objects, similar to the `M' command.  For ports with mouse
+objects, so implicitly forces the `m' prefix.
+For ports with mouse
 support, the command is also invoked when a mouse-click takes place on a
 location other than the current position.
 %.lp
 \item[\tb{.}]
-Wait or rest, do nothing for one turn. Precede with the `{\tt m}' prefix
+Wait or rest, do nothing for one turn.
+Precede with the `{\tt m}' prefix
 to wait for a turn even next to a hostile monster, if {\it safe\verb+_+wait\/}
 is on.
 %.lp
@@ -789,7 +808,8 @@ is on.
 Apply (use) a tool (pick-axe, key, lamp \ldots).\\
 %.lp ""
 If used on a wand, that wand will be broken, releasing its magic in the
-process.  Confirmation is required.
+process.
+Confirmation is required.
 %.lp
 \item[\tb{A}]
 Remove one or more worn items, such as armor.\\