mirror/ zsh
1
0
Fork 0
mirror of git://git.code.sf.net/p/zsh/code synced 2024-06-01 21:06:04 +02:00
Code

23954: documentation for zsh/curses module.

This commit is contained in:
Clint Adams 2007-10-14 17:14:22 +00:00
parent 7c87209cee
commit ca1c691a74
3 changed files with 44 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -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

2
Doc/Makefile.in
View File

@ -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 \

38
Doc/Zsh/mod_curses.yo Normal file
View File

@ -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()