Describe USE_CURSES, FAKE_NCURSES and INCOMPAT_CURSES.

1 files changed, 29 insertions, 1 deletions

diff --git a/mk/curses.buildlink3.mk b/mk/curses.buildlink3.mk
index c62d2ece666..5330ebfe4c6 100644
--- a/mk/curses.buildlink3.mk
+++ b/mk/curses.buildlink3.mk
@@ -1,4 +1,4 @@
-# $NetBSD: curses.buildlink3.mk,v 1.25 2017/01/05 21:19:24 roy Exp $
+# $NetBSD: curses.buildlink3.mk,v 1.26 2017/03/20 00:30:30 roy Exp $
 #
 # This Makefile fragment is meant to be included by packages that require
 # any curses implementation instead of one particular one.  The available
@@ -19,6 +19,34 @@
 #	Possible: curses, ncurses, ncursesw, pdcurses
 #	Default: (depends)
 #
+# === Package-settable variables ===
+#
+# USE_CURSES
+#	This value represents the features the package needs from curses.
+#	If the system curses does not provide those features, then
+#	a more suitable curses is pulled in (normally ncurses).
+#
+#	Possible: wide
+#	For more possible values, see curses.builtin.mk.
+#	Default: (unset)
+#
+# FAKE_NCURSES
+#	Some packages look exclusively for ncurses or ncursesw,
+#	headers and libraries. This really is an error with the package,
+#	but patching it can be both challenging and cumbersome.
+#	Set this to YES to transform these to system curses.
+#
+#	Possible: YES, NO
+#	Default: NO
+#
+# INCOMPAT_CURSES
+#	If no test exists the missing curses feature then set this
+#	to match the platform where system curses isn't suitable.
+#	This can include the case where the system curses compiles fine,
+#	but for some reason fails to work.
+#
+#	Default: (unset)
+#
 # === Variables set by this file ===
 #
 # CURSES_TYPE