23954: documentation for zsh/curses module.

3 files changed, 44 insertions, 1 deletions

diff --git a/ChangeLog b/ChangeLog
index 871ce086a..a213aaa8d 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2007-10-14  Clint Adams  <clint@zsh.org>
+
+	* 23954: Doc/Makefile.in, Doc/Zsh/mod_curses.yo: documentation for
+	zsh/curses module.
+
 2007-10-14  Barton E. Schaefer  <schaefer@zsh.org>
 
 	* unposted: Functions/Prompts/prompt_bart_setup: make sure
diff --git a/Doc/Makefile.in b/Doc/Makefile.in
index 3938c4d03..e1c9446d7 100644
--- a/Doc/Makefile.in
+++ b/Doc/Makefile.in
@@ -57,7 +57,7 @@ YODLDOC = $(MAN) texi
 MODDOCSRC = \
 Zsh/mod_cap.yo Zsh/mod_clone.yo \
 Zsh/mod_compctl.yo Zsh/mod_complete.yo Zsh/mod_complist.yo \
-Zsh/mod_computil.yo \
+Zsh/mod_computil.yo Zsh/mod_curses.yo \
 Zsh/mod_datetime.yo Zsh/mod_deltochar.yo \
 Zsh/mod_example.yo Zsh/mod_files.yo \
 Zsh/mod_mapfile.yo Zsh/mod_mathfunc.yo Zsh/mod_newuser.yo \
diff --git a/Doc/Zsh/mod_curses.yo b/Doc/Zsh/mod_curses.yo
new file mode 100644
index 000000000..82b95ff51
--- /dev/null
+++ b/Doc/Zsh/mod_curses.yo
@@ -0,0 +1,38 @@
+COMMENT(!MOD!zsh/curses
+curses windowing commands
+!MOD!)
+The tt(zsh/curses) module makes available one builtin command:
+
+startitem()
+findex(zcurses)
+cindex(windows, curses)
+xitem(tt(zcurses) tt(-a) var(nlines) var(ncols) var(begin_y) var(begin_x) var(targetwin) )
+xitem(tt(zcurses) tt(-d) var(targetwin) )
+xitem(tt(zcurses) tt(-r) var(targetwin) )
+xitem(tt(zcurses) tt(-m) var(targetwin) var(new_y) var(new_x) )
+xitem(tt(zcurses) tt(-c) var(targetwin) var(character) )
+xitem(tt(zcurses) tt(-s) var(targetwin) var(string) )
+item(tt(zcurses) tt(-b) var(targetwin) var(border) )(
+Manipulate curses windows.
+
+With tt(-a), create a window with var(nlines) lines and var(ncols) columns.
+Its upper left corner will be placed at row var(begin_y) and column
+var(begin_x) of the screen.  var(targetwin) must be an integer between 1
+and 9 inclusive, and refer to a window that is not currently assigned.
+
+Use tt(-d) to delete a window created with tt(-a).
+
+The tt(-r) command will refresh window var(targetwin); this is necessary to
+make any pending changes (such as characters you have prepared for output
+with tt(-c)) visible on the screen.
+
+tt(-m) moves var(targetwin) to new coordinates var(new_y) and var(new_x).
+
+Outputting characters and strings are achieved by tt(-c) and tt(-s)
+respectively.
+
+To draw a border around window var(targetwin), use tt(-b).
+)
+enditem()
+
+enditem()