nethack-gwaa-kiwi/nethack
1
0
Fork 0
Code Pull Requests Activity

'windowcolors' documentation

Browse Source 
The construct "\\'#rrggbb'" seemed strange and while fixing that
I made several other changes.  There's an escape sequence for
apostrophe but "#rrggbb" doesn't actually need any quoting in the
first place (except for "\#" in the TeX version).

There was unwanted indentation after the OPTIONS=windowcolors line
in the 'roff version.  For the TeX version, avoid 'verbatim' since
it contains both literal text and placeholders that are now being
distinguished with italics.

Also, "trueblack" is Windows-specific rather than an ordinary named
color.
This commit is contained in:
PatR
2024-03-21 09:59:43 -07:00
parent a0bea150e1
commit a8fbb96f2b
2 changed files with 32 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
doc/Guidebook.mn
View File

@@ -1,4 +1,4 @@
.\" $NHDT-Branch: keni-regex $:$NHDT-Revision: 1.571 $ $NHDT-Date: 1710008891 2024/03/09 18:28:11 $ .\" $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.574 $ $NHDT-Date: 1711040379 2024/03/21 16:59:39 $
.\" .\"
.\" This is an excerpt from the 'roff' man page from the 'groff' package. .\" This is an excerpt from the 'roff' man page from the 'groff' package.
.\"+-- .\"+--
@@ -46,7 +46,7 @@
.ds f0 \*(vr .ds f0 \*(vr
.ds f1 \" empty .ds f1 \" empty
.\"DO NOT REMOVE NH_DATESUB .ds f2 DATE(%B %-d, %Y) .\"DO NOT REMOVE NH_DATESUB .ds f2 DATE(%B %-d, %Y)
.ds f2 February 29, 2024 .ds f2 March 21, 2024
. .
.\" A note on some special characters: .\" A note on some special characters:
.\" \(lq = left double quote .\" \(lq = left double quote
@@ -4994,23 +4994,24 @@ setting the value to 3 or 4 instead will keep borders for the map, message,
and status windows but have room for two additional lines of inventory and status windows but have room for two additional lines of inventory
plus widen each inventory line by two columns. plus widen each inventory line by two columns.
.lp windowcolors .lp windowcolors
If NetHack can, it should display windows with the specified If NetHack can, it should display all windows of a particular style
foreground/background colors. with the specified foreground and background colors.
Windows GUI and curses windowport only. Windows GUI and curses windowport only.
The format is The format is
.si .si
.lp "OPTION=windowcolors:wintype foreground/background" .lp "\f(CROPTION=windowcolors:\fIstyle foreground\f(CR/\fIbackground\fR"
.ei .ei
.pg .lp ""
where wintype is one of \(lqmenu\(rq, \(lqmessage\(rq, \(lqstatus\(rq, where \fIstyle\fP is one of \(lqmenu\(rq, \(lqmessage\(rq, \(lqstatus\(rq,
or \(lqtext\(rq, and or \(lqtext\(rq, and
foreground and background are colors, either a hexadecimal \\'#rrggbb', \fIforeground\fP and \fIbackground\fP are colors, either numeric (hash
sign followed by three pairs of hexadecimal digits, \fI#rrggbb\fP),
one of the named colors (black, red, green, brown, one of the named colors (black, red, green, brown,
blue, magenta, cyan, orange, brightgreen, yellow, brightblue, blue, magenta, cyan, orange, bright-green, yellow, bright-blue,
brightmagenta, brightcyan, white, trueblack, gray, purple, bright-magenta, bright-cyan, white, gray, purple,
silver, maroon, fuchsia, lime, olive, navy, teal, aqua), silver, maroon, fuchsia, lime, olive, navy, teal, aqua),
or one of Windows UI colors (activeborder, activecaption, or (for Windows only) one of Windows UI colors (trueblack, activeborder,
appworkspace, background, btnface, btnshadow, btntext, activecaption, appworkspace, background, btnface, btnshadow, btntext,
captiontext, graytext, greytext, highlight, highlighttext, captiontext, graytext, greytext, highlight, highlighttext,
inactiveborder, inactivecaption, menu, menutext, scrollbar, inactiveborder, inactivecaption, menu, menutext, scrollbar,
window, windowframe, windowtext). window, windowframe, windowtext).

37
doc/Guidebook.tex
View File

@@ -1,5 +1,5 @@
\documentstyle[titlepage,longtable]{article} \documentstyle[titlepage,longtable]{article}
% NetHack 3.7 Guidebook.tex $NHDT-Date: 1710008891 2024/03/09 18:28:11 $ $NHDT-Branch: keni-regex $:$NHDT-Revision: 1.559 $ */ % NetHack 3.7 Guidebook.tex $NHDT-Date: 1711040379 2024/03/21 16:59:39 $ $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.562 $ */
%+% we're still limping along in LaTeX 2.09 compatibility mode %+% we're still limping along in LaTeX 2.09 compatibility mode
%-%\documentclass{article} %-%\documentclass{article}
%-%\usepackage{hyperref} % before longtable %-%\usepackage{hyperref} % before longtable
@@ -48,7 +48,7 @@
\author{Original version - Eric S. Raymond\\ \author{Original version - Eric S. Raymond\\
(Edited and expanded for 3.7.0 by Mike Stephenson and others)} (Edited and expanded for 3.7.0 by Mike Stephenson and others)}
%DO NOT REMOVE NH_DATESUB \date{DATE(%B %-d, %Y)} %DO NOT REMOVE NH_DATESUB \date{DATE(%B %-d, %Y)}
\date{February 29, 2024} \date{March 21, 2024}
\maketitle \maketitle
@@ -5511,27 +5511,28 @@ and status windows but have room for two additional lines of inventory
plus widen each inventory line by two columns. plus widen each inventory line by two columns.
%.lp %.lp
\item[\ib{windowcolors}] \item[\ib{windowcolors}]
If {\it NetHack\/} can, it should display windows with the specified If {\it NetHack\/} can, it should display all windows of a particular style
foreground/background colors. with the specified foreground and background colors.
Windows GUI and curses windowport only. Windows GUI and curses windowport only.
The format is The format is\\
\begin{verbatim} {\tt ~~~~OPTION=windowcolors:}{\it style foreground\/}{\tt /}{\it background}\\
OPTION=windowcolors:wintype foreground/background where {\it style} is one of {\tt menu}, {\tt message}, {\tt status},
\end{verbatim} or {\tt text}, and
{\it foreground} and {\it background} are colors, either numeric (hash
%.pg sign followed by three pairs of hexadecimal digits, {\it \#rrggbb\/}),
where wintype is one of {\it menu}, {\it message}, {\it status}, or {\it text}, and
foreground and background are colors, either a hexadecimal {\it \#rrggbb},
one of the named colors ({\it black}, {\it red}, {\it green}, {\it brown}, one of the named colors ({\it black}, {\it red}, {\it green}, {\it brown},
{\it blue}, {\it magenta}, {\it cyan}, {\it orange}, {\it blue}, {\it magenta}, {\it cyan}, {\it orange},
{\it brightgreen}, {\it yellow}, {\it brightblue}, {\it brightmagenta}, {\it bright-green}, {\it yellow}, {\it bright-blue}, {\it bright-magenta},
{\it brightcyan}, {\it white}, {\it trueblack}, {\it gray}, {\it purple}, {\it bright-cyan}, {\it white}, {\it gray}, {\it purple},
{\it silver}, {\it maroon}, {\it fuchsia}, {\it lime}, {\it olive}, {\it silver}, {\it maroon}, {\it fuchsia}, {\it lime}, {\it olive},
{\it navy}, {\it teal}, {\it aqua}), or one of Windows UI colors ({\it activeborder}, {\it navy}, {\it teal}, {\it aqua}),
{\it activecaption}, {\it appworkspace}, {\it background}, {\it btnface}, {\it btnshadow}, or (for Windows only) one of Windows UI colors ({\it trueblack},
{\it btntext}, {\it captiontext}, {\it graytext}, {\it greytext}, {\it highlight}, {\it activeborder}, {\it activecaption}, {\it appworkspace}, {\it background},
{\it btnface}, {\it btnshadow}, {\it btntext}, {\it captiontext},
{\it graytext}, {\it greytext}, {\it highlight},
{\it highlighttext}, {\it inactiveborder}, {\it inactivecaption}, {\it menu}, {\it highlighttext}, {\it inactiveborder}, {\it inactivecaption}, {\it menu},
{\it menutext}, {\it scrollbar}, {\it window}, {\it windowframe}, {\it windowtext}). {\it menutext}, {\it scrollbar}, {\it window}, {\it windowframe},
{\it windowtext}).
%.lp %.lp
\item[\ib{wraptext}] \item[\ib{wraptext}]