From: PatR <rankin@nethack.org>
Date: Wed, 25 Nov 2020 17:15:20 +0000 (-0800)
Subject: Guidebook bit: ascii_map and tiled_map
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=dde70b8d4aa4f535900e257db19ffaf3ff4e6713;p=nethack

Guidebook bit: ascii_map and tiled_map

|ascii_map:
|If NetHack can, it should display an ascii character map if it can.
|tiled_map:
|If NetHack can, it should display a tiled map if it can.

Remove the "if {NetHack,it} can" redundancy and expand a little bit.

Also, alphabetize "tiled_map" as if the underscore were a space
instead of something that happens to collate after letters.

As usual, the Guidebook.tex changes are untested.
---

diff --git a/doc/Guidebook.mn b/doc/Guidebook.mn
index bf4b30385..e26ba1a19 100644
--- a/doc/Guidebook.mn
+++ b/doc/Guidebook.mn
@@ -1,4 +1,4 @@
-.\" $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.398 $ $NHDT-Date: 1605618309 2020/11/17 13:05:09 $
+.\" $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.399 $ $NHDT-Date: 1606324515 2020/11/25 17:15:15 $
 .\"
 .\" This is an excerpt from the 'roff' man page from the 'groff' package.
 .\" Guidebook.mn currently does *not* fully adhere to these guidelines.
@@ -35,7 +35,7 @@
 .ds vr "NetHack 3.7
 .ds f0 "\*(vr
 .ds f1
-.ds f2 "November 16, 2020
+.ds f2 "November 25, 2020
 .
 .\" A note on some special characters:
 .\" \(lq = left double quote
@@ -4172,7 +4172,19 @@ Where to align or place the message window (top, bottom, left, or right)
 .lp align_status
 Where to align or place the status window (top, bottom, left, or right).
 .lp ascii_map
-If NetHack can, it should display an ascii character map if it can.
+.hw DECgraphics IBMgraphics \" don't hyphenate these
+If NetHack can, it should display the map using simple
+characters (letters and punctuation) rather than \fItiles\fP graphics.
+In some cases, characters can be augmented with line-drawing symbols;
+use the
+.op symset
+option to select a symbol set such as \fIDECgraphics\fP
+or \fIIBMgraphics\fP if your display supports them.
+Setting
+.op ascii_map
+to \fITrue\fP forces
+.op tiled_map
+to be \fIFalse\fP.
 .lp color
 If NetHack can, it should display color if it can for different monsters,
 objects, and dungeon features.
@@ -4275,14 +4287,21 @@ Number of columns and rows to use for the display.
 Curses will attempt to resize to the values specified but will settle
 for smaller sizes if they are too big.
 Default is the current window size.
-.lp tiled_map
-If NetHack can, it should display a tiled map if it can.
 .lp tile_file
 Specify the name of an alternative tile file to override the default.
 .lp tile_height
 Specify the preferred height of each tile in a tile capable port.
 .lp tile_width
 Specify the preferred width of each tile in a tile capable port
+.lp tiled_map
+If NetHack can, it should display the map using \fItiles\fP graphics
+rather than simple characters (letters and punctuation, possibly
+augmented by line-drawing symbols).
+Setting
+.op tiled_map
+to \fITrue\fP forces
+.op ascii_map
+to be \fIFalse\fP.
 .lp use_darkgray
 Use bold black instead of blue for black glyphs (TTY only).
 .lp use_inverse
diff --git a/doc/Guidebook.tex b/doc/Guidebook.tex
index df603a3ae..7eee96e54 100644
--- a/doc/Guidebook.tex
+++ b/doc/Guidebook.tex
@@ -45,7 +45,7 @@
 %.au
 \author{Original version - Eric S. Raymond\\
 (Edited and expanded for 3.7 by Mike Stephenson and others)}
-\date{November 16, 2020}
+\date{November 25, 2020}
 
 \maketitle
 
@@ -4529,7 +4529,16 @@ with the `{\tt O}' command.
  Where to align or place the status window (top, bottom, left, or right).
 %.lp
 \item[\ib{ascii\verb+_+map}]
-If {\it NetHack\/} can, it should display an ascii map.
+%.hw DECgraphics IBMgraphics \% don't hyphenate these
+\hyphenation{DECgraphics IBMgraphics}
+If {\it NetHack\/} can, it should display the map using simple
+characters (letters and punctuation) rather than {\it tiles\/} graphics.
+In some cases, characters can be augmented with line-drawing symbols;
+use the {\tt symset}
+option to select a symbol set such as {\it DECgraphics\/}
+or {\it IBMgraphics\/} if your display supports them.
+Setting {\tt ascii\verb+_+map} to {\it True\/} forces
+{\tt tiled\verb+_+map} to be {\it False}.
 %.lp
 \item[\ib{color}]
 If {\it NetHack\/} can, it should display color for different monsters,
@@ -4661,9 +4670,6 @@ Curses will attempt to resize to the values specified but will settle
 for smaller sizes if they are too big.
 Default is the current window size.
 %.lp
-\item[\ib{tiled\verb+_+map}]
-If {\it NetHack\/} can, it should display a tiled map if it can.
-%.lp
 \item[\ib{tile\verb+_+file}]
 Specify the name of an alternative tile file to override the default.
 %.lp
@@ -4673,6 +4679,13 @@ Specify the preferred height of each tile in a tile capable port.
 \item[\ib{tile\verb+_+width}]
 Specify the preferred width of each tile in a tile capable port
 %.lp
+\item[\ib{tiled\verb+_+map}]
+If {\it NetHack\/} can, it should display the map using \fItiles\fP graphics
+rather than simple characters (letters and punctuation, possibly
+augmented by line-drawing symbols).
+Setting {\tt tiled\verb+_+map} to {\it True\/} forces
+{\tt ascii\verb+_+map} to be {\it False}.
+%.lp
 \item[\ib{use\verb+_+darkgray}]
 Use bold black instead of blue for black glyphs (TTY only).
 %.lp