From 0f1386ff4c0d88a533050138de2f3a4f2796863f Mon Sep 17 00:00:00 2001
From: Greg King <gregdk@users.sf.net>
Date: Thu, 25 Mar 2021 08:28:15 -0400
Subject: [PATCH] Added documentation about the slightly different behavior of
 cpeekcolor() on the cx16 platform.

---
 doc/cx16.sgml    | 69 ++++++++++++++++++++++++++----------------------
 doc/funcref.sgml |  2 ++
 2 files changed, 40 insertions(+), 31 deletions(-)

diff --git a/doc/cx16.sgml b/doc/cx16.sgml
index 490d07849..9e743064f 100644
--- a/doc/cx16.sgml
+++ b/doc/cx16.sgml
@@ -142,13 +142,20 @@ The functions listed below are special for the CX16. See the <url
 url="funcref.html" name="function reference"> for declarations and usage.
 
 <itemize>
-<item>get_ostype
-<item>set_tv
-<item>videomode
-<item>vpeek
-<item>vpoke
+<item>get_ostype()
+<item>set_tv()
+<item>videomode()
+<item>vpeek()
+<item>vpoke()
 </itemize>
 
+<tt/cpeekcolor()/ works differently on the Commander X16 than it does on other
+platforms.  Each character has two colors: background and text (foreground).
+<tt/cpeekcolor()/ returns both colors.  The high nybble describes the
+background color, the low nybble describes the text color.  For example, if the
+function is used on the default screen, then it returns &dollar;61, which means
+white-on-blue.
+
 
 <sect1>CBM-specific functions<p>
 
@@ -157,32 +164,32 @@ machines. See the <url url="funcref.html" name="function reference"> for
 declarations and usage.
 
 <itemize>
-<item>cbm_close
-<item>cbm_closedir
-<item>cbm_k_basin
-<item>cbm_k_bsout
-<item>cbm_k_chkin
-<item>cbm_k_ckout
-<item>cbm_k_close
-<item>cbm_k_clrch
-<item>cbm_k_getin
-<item>cbm_k_load
-<item>cbm_k_open
-<item>cbm_k_readst
-<item>cbm_k_save
-<item>cbm_k_second
-<item>cbm_k_setlfs
-<item>cbm_k_setnam
-<item>cbm_k_tksa
-<item>cbm_load
-<item>cbm_open
-<item>cbm_opendir
-<item>cbm_read
-<item>cbm_readdir
-<item>cbm_save
-<item>cbm_write
-<item>get_tv
-<item>waitvsync
+<item>cbm_close()
+<item>cbm_closedir()
+<item>cbm_k_basin()
+<item>cbm_k_bsout()
+<item>cbm_k_chkin()
+<item>cbm_k_ckout()
+<item>cbm_k_close()
+<item>cbm_k_clrch()
+<item>cbm_k_getin()
+<item>cbm_k_load()
+<item>cbm_k_open()
+<item>cbm_k_readst()
+<item>cbm_k_save()
+<item>cbm_k_second()
+<item>cbm_k_setlfs()
+<item>cbm_k_setnam()
+<item>cbm_k_tksa()
+<item>cbm_load()
+<item>cbm_open()
+<item>cbm_opendir()
+<item>cbm_read()
+<item>cbm_readdir()
+<item>cbm_save()
+<item>cbm_write()
+<item>get_tv()
+<item>waitvsync()
 </itemize>
 
 
diff --git a/doc/funcref.sgml b/doc/funcref.sgml
index a954c6581..3b3db2e09 100644
--- a/doc/funcref.sgml
+++ b/doc/funcref.sgml
@@ -2813,6 +2813,8 @@ location of the cursor in the display screen RAM.  That number can be passed to
 done to make it obvious that peeking doesn't move the cursor in any way.  Your
 program must place the cursor where it wants to peek before it calls any of
 those functions.
+<item>On the cx16 (Commander X16) target, this function returns two values: the
+background color, in the high nybble, and the text color, in the low nybble.
 </itemize>
 <tag/Availability/cc65
 <tag/See also/