From 52ea35c1c6852dd8bacd218e32547afd99c23ba9 Mon Sep 17 00:00:00 2001 From: Clint Adams Date: Sun, 21 Oct 2007 19:53:44 +0000 Subject: 24004: align documentation with UI changes in 24002. --- Doc/Zsh/mod_curses.yo | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) (limited to 'Doc/Zsh/mod_curses.yo') diff --git a/Doc/Zsh/mod_curses.yo b/Doc/Zsh/mod_curses.yo index 8243c1ee2..8404b2940 100644 --- a/Doc/Zsh/mod_curses.yo +++ b/Doc/Zsh/mod_curses.yo @@ -6,42 +6,42 @@ 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(-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) ) -xitem(tt(zcurses) tt(-b) var(targetwin) var(border) )( -item(tt(zcurses) tt(-A) var(targetwin) var({+/-}attribute) [var({+/-}attribute)] [...])( +xitem(tt(zcurses) tt(init)) +xitem(tt(zcurses) tt(endwin)) +xitem(tt(zcurses) tt(addwin) var(targetwin) var(nlines) var(ncols) var(begin_y) var(begin_x) ) +xitem(tt(zcurses) tt(delwin) var(targetwin) ) +xitem(tt(zcurses) tt(refresh) [ var(targetwin) ] ) +xitem(tt(zcurses) tt(move) 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) ) +xitem(tt(zcurses) tt(border) var(targetwin) var(border) )( +item(tt(zcurses) tt(addwin) var(targetwin) var({+/-}attribute) [var({+/-}attribute)] [...])( 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 +bracketed by `tt(zcurses init)' to initialise use of curses, and +`tt(zcurses endwin)' to end it; omitting `tt(zcurses endwin)' can cause the terminal to be in an unwanted state. -With tt(-a), create a window with var(nlines) lines and var(ncols) columns. +With tt(addwin), 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) is a string and refers to the name of a window that is not currently assigned. -Use tt(-d) to delete a window created with tt(-a). +Use tt(delwin) to delete a window created with tt(addwin). -The tt(-r) command will refresh window var(targetwin); this is necessary to +The tt(refresh) 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. If no argument is given, +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 +tt(move) moves the cursor position in var(targetwin) to new coordinates var(new_y) and var(new_x). -Outputting characters and strings are achieved by tt(-c) and tt(-s) +Outputting characters and strings are achieved by tt(c) and tt(s) respectively. -To draw a border around window var(targetwin), use tt(-b). +To draw a border around window var(targetwin), use tt(border). -tt(-A) will set var(targetwin)'s attributes for any successive character +tt(addwin) will set var(targetwin)'s attributes for any successive character output. Each var(attribute) given on the line should be prepended by a tt(+) to set or a tt(-) to unset that attribute. The attributes supported are tt(blink), tt(bold), tt(dim), tt(reverse), tt(standout), and -- cgit 1.4.1