23970: zcurses -i/-e, fix leak, add zcurses -r with no argument

23968 (Vin Shelton): yodl fix

1 files changed, 9 insertions, 5 deletions

diff --git a/Doc/Zsh/mod_curses.yo b/Doc/Zsh/mod_curses.yo
index 386074cd9..f2b442e98 100644
--- a/Doc/Zsh/mod_curses.yo
+++ b/Doc/Zsh/mod_curses.yo
@@ -6,14 +6,19 @@ The tt(zsh/curses) module makes available one builtin command:
 startitem()
 findex(zcurses)
 cindex(windows, curses)
+xitem(tt(zcurses) tt(-i))
+xitem(tt(zcurses) tt(-e))
 xitem(tt(zcurses) tt(-a) var(targetwin) var(nlines) var(ncols) var(begin_y) var(begin_x) )
 xitem(tt(zcurses) tt(-d) var(targetwin) )
-xitem(tt(zcurses) tt(-r) 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.
+Manipulate curses windows.  All uses of this command should be
+bracketed by `tt(zcurses -i)' to initialise use of curses, and
+`tt(zcurses -e)' to end it; omitting `tt(zcurses -e)' can cause
+the terminal to be in an unwanted state.
 
 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
@@ -24,7 +29,8 @@ 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.
+with tt(-c)) visible on the screen.  If no argument is given,
+all windows are refreshed; this is necessary after deleting a window.
 
 tt(-m) moves the cursor position in var(targetwin) to new coordinates
 var(new_y) and var(new_x).
@@ -35,5 +41,3 @@ respectively.
 To draw a border around window var(targetwin), use tt(-b).
 )
 enditem()
-
-enditem()