From 9457fde9fc4617ba1ee3c40477f09cdee06094b5 Mon Sep 17 00:00:00 2001
From: Pasi Kallinen <paxed@alt.org>
Date: Wed, 29 Aug 2018 19:39:30 +0300
Subject: [PATCH] Document windowcolors option

---
 doc/Guidebook.mn  | 17 ++++++++++++++++-
 doc/Guidebook.tex | 20 +++++++++++++++++++-
 2 files changed, 35 insertions(+), 2 deletions(-)

diff --git a/doc/Guidebook.mn b/doc/Guidebook.mn
index 49a854c07..e363527ef 100644
--- a/doc/Guidebook.mn
+++ b/doc/Guidebook.mn
@@ -3280,7 +3280,22 @@ If NetHack can, it should display this number of messages at a time in
 the message window.
 .lp windowcolors
 If NetHack can, it should display windows with the specified
-foreground/background colors if it can.
+foreground/background colors. Windows GUI only. The format is
+.si
+.lp "OPTION=windowcolors:wintype foreground/background"
+.ei
+.pg
+where wintype is one of "menu", "message", "status", or "text", and
+foreground and background are colors, either a hexadecimal \'#rrggbb',
+one of the named colors (black, red, green, brown,
+blue, magenta, cyan, orange, brightgreen, yellow, brightblue,
+brightmagenta, brightcyan, white, trueblack, gray, purple,
+silver, maroon, fuchsia, lime, olive, navy, teal, aqua),
+or one of Windows UI colors (activeborder, activecaption,
+appworkspace, background, btnface, btnshadow, btntext,
+captiontext, graytext, greytext, highlight, highlighttext,
+inactiveborder, inactivecaption, menu, menutext, scrollbar,
+window, windowframe, windowtext).
 .lp wraptext
 If NetHack can, it should wrap long lines of text if they don't fit in
 the visible area of the window.
diff --git a/doc/Guidebook.tex b/doc/Guidebook.tex
index e9a805e25..895dfe1ad 100644
--- a/doc/Guidebook.tex
+++ b/doc/Guidebook.tex
@@ -3850,7 +3850,25 @@ in the message window.
 %.lp
 \item[\ib{windowcolors}]
 If {\it NetHack\/} can, it should display windows with the specified
-foreground/background colors if it can.
+foreground/background colors. Windows GUI only. The format is
+\begin{verbatim}
+    OPTION=windowcolors:wintype foreground/background
+\end{verbatim}
+
+%.pg
+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},
+{\it blue}, {\it magenta}, {\it cyan}, {\it orange},
+{\it brightgreen}, {\it yellow}, {\it brightblue}, {\it brightmagenta},
+{\it brightcyan}, {\it white}, {\it trueblack}, {\it gray}, {\it purple},
+{\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 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 menutext}, {\it scrollbar}, {\it window}, {\it windowframe}, {\it windowtext}).
+
 %.lp
 \item[\ib{wraptext}]
 If {\it NetHack\/} can, it should wrap long lines of text if they don't fit
-- 
2.40.0