[src/curses-v3]: src/lib/libcurses Document new functions.

[jdc <jdc%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/6b00fa561d20
branches:  curses-v3
changeset: 479973:6b00fa561d20
user:      jdc <jdc%NetBSD.org@localhost>
date:      Sun Mar 05 23:28:57 2000 +0000

description:
Document new functions.

diffstat:

 lib/libcurses/PSD.doc/fns.doc |  63 ++++++++++++++++++++++++++++++++++++++++--
 lib/libcurses/curses.3        |  33 +++++++++++++++++++---
 2 files changed, 88 insertions(+), 8 deletions(-)

diffs (230 lines):

diff -r a23340b7174b -r 6b00fa561d20 lib/libcurses/PSD.doc/fns.doc
--- a/lib/libcurses/PSD.doc/fns.doc     Sun Mar 05 23:28:13 2000 +0000
+++ b/lib/libcurses/PSD.doc/fns.doc     Sun Mar 05 23:28:57 2000 +0000
@@ -32,7 +32,7 @@
 .\"     @(#)fns.doc    8.2 (Berkeley) 6/1/94
 .\"
 .Ds
-.Fn addch "char ch" \(dg
+.Fn addch "chtype ch" \(dg
 .De
 Add the character
 .Vn ch
@@ -117,7 +117,30 @@
 but has the ability to flash the screen, do that instead.  See also
 .Fn flash
 .Ds
-.Fn box "WINDOW win" "char vert" "char hor"
+.Fn border "chtype left" "chtype right" "chtype top" "chtype bottom" "chtype topleft" "chtype topright" "chtype botleft" "chtype botright"
+.De
+.Pp
+Draws a border around the window using the characters:
+.Vn left
+for drawing the left side, 
+.Vn right
+for drawing the left side, 
+.Vn top
+for drawing the top edge, 
+.Vn bottom
+for drawing the top edge, 
+.Vn topleft
+for drawing the top-left corner, 
+.Vn topright
+for drawing the top-right corner, 
+.Vn botleft
+for drawing the bottom-left corner, and 
+.Vn botright
+for drawing the bottom-right corner.  If scrolling is not allowed,
+and the window encompasses the lower right-hand corner of the terminal,
+the corners are left blank to avoid a scroll.
+.Ds
+.Fn box "WINDOW win" "chtype vert" "chtype hor"
 .De
 .Pp
 Draws a box around the window using
@@ -402,6 +425,28 @@
 and the last character disappears.
 \*(Es
 .Ds
+.Fn insdelln "int n"
+.De
+If
+.Vn n
+is positive insert
+.Vn n
+lines above the current one.
+Every line below the current line
+will be shifted down,
+and the last
+.Vn n
+lines will disappear.
+If
+.Vn n
+is negative, delete
+.Vn n
+lines starting from the current one.
+The last
+.Vn n
+lines are cleared.
+The current \*y will remain unchanged.
+.Ds
 .Fn insertln ""
 .De
 Insert a line above the current one.
@@ -745,6 +790,15 @@
 \*(Es
 .ne 1i
 .Ds
+.Fn scrl "int n"
+.De
+Scroll the window by
+.Vn n
+lines. If
+.Vn n
+is positive, scroll upward, otherwise
+scroll downward.
+.Ds
 .Fn scroll "WINDOW *win"
 .De
 Scroll the window upward one line.
@@ -931,12 +985,13 @@
 specification of a window, rather than the use of the default
 .Vn stdscr.\fP
 .Ds
-.Fn waddch "WINDOW *win" "char ch"
+.Fn waddch "WINDOW *win" "char chtype"
 .Fn waddstr "WINDOW *win" "char *str"
 .Fn waddnstr "WINDOW *win" "char *str" "int len"
 .Fn wattron  "WINDOW *win" "int attr"
 .Fn wattroff  "WINDOW *win" "int attr"
 .Fn wattrset  "WINDOW *win" "int attr"
+.Fn wborder "WINDOW *win" "chtype left" "chtype right" "chtype top" "chtype bottom" "chtype topleft" "chtype topright" "chtype botleft" "chtype botright"
 .Fn wclear "WINDOW *win"
 .Fn wclrtobot "WINDOW *win"
 .Fn wclrtoeol "WINDOW *win"
@@ -947,11 +1002,13 @@
 .Fn wgetstr "WINDOW *win" "char *str"
 .Fn winch "WINDOW *win" \(dg
 .Fn winsch "WINDOW *win" "char c"
+.Fn winsdelln "WINDOW *win" "int n"
 .Fn winsertln "WINDOW *win"
 .Fn wmove "WINDOW *win" "int y" int x"
 .Fn wprintw "WINDOW *win" "char *fmt" "..."
 .Fn wrefresh "WINDOW *win"
 .Fn wscanw "WINDOW *win" "char *fmt" "..."
+.Fn wscrl "WINDOW *win" "int n"
 .Fn wstandend "WINDOW *win"
 .Fn wstandout "WINDOW *win"
 .Fn wtimeout "WINDOW *win" "int delay"
diff -r a23340b7174b -r 6b00fa561d20 lib/libcurses/curses.3
--- a/lib/libcurses/curses.3    Sun Mar 05 23:28:13 2000 +0000
+++ b/lib/libcurses/curses.3    Sun Mar 05 23:28:57 2000 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: curses.3,v 1.15 1999/08/17 03:36:35 enami Exp $
+.\"    $NetBSD: curses.3,v 1.15.6.1 2000/03/05 23:28:57 jdc Exp $
 .\"
 .\" Copyright (c) 1985, 1991, 1993
 .\"    The Regents of the University of California.  All rights reserved.
@@ -84,12 +84,14 @@
 .It attroff(attribute) turn off attribute modes
 .It attrset(attribute) set attribute modes
 .It beep()     sound the terminal bell
+.It border(ls,rs,ts,bs,tl,tr,bl,br)    draw a border around
+.Em stdscr
 .It box(win,vert,hor)  draw a box around a window
 .It cbreak()   set cbreak mode
 .It clear()    clear
 .Em stdscr
-.It clearok(scr,boolf) set clear flag for
-.Em scr
+.It clearok(win,boolf) set clear flag for
+.Em win
 .It clrtobot() clear to bottom on
 .Em stdscr
 .It clrtoeol() clear to end of line on
@@ -106,6 +108,8 @@
 .It flushinp() flush terminal input
 .It flushok(win,boolf) set flush-on-refresh flag for
 .Em win
+.It fullname(termbuf,name) get full name from
+.Em termbuf
 .It getch()    get a char through
 .Em stdscr
 .It getcap(name)       get terminal capability
@@ -114,15 +118,19 @@
 .Em stdscr
 .It gettmode() get tty modes
 .It getyx(win,y,x)     get (y,x) co-ordinates
+.It idlok(win,boolf)   set insert/deleteln flags for
+.Em win
 .It inch()     get char at current (y,x) co-ordinates
 .It initscr()  initialize screens
 .It insch(c)   insert a char
+.It insdelln(n)        insert/delete n lines on
+.Em stdstr
 .It insertln() insert a line
 .It isendwin() check if endwin() or wrefresh() was called latest
 .It keypad(win,boolf)  set keypad flag for
 .Em win
 .It leaveok(win,boolf) set leave flag for
-.Em stdscr
+.Em win
 .It longname(termbuf,name)     get long name from
 .Em termbuf
 .It move(y,x)  move to (y,x) on
@@ -149,14 +157,20 @@
 .It savetty()  stored current tty flags
 .It scanw(fmt,arg1,arg2,...)   scanf through
 .Em stdscr
+.It scrl(n)    scroll
+.Em stdscr
+n lines
 .It scroll(win)        scroll
 .Em win
 one line
-.It scrollok(win,boolf)        set scroll flag
+.It scrollok(win,boolf)        set scroll flag for
+.Em win
 .It setterm(name)      set term variables for name
 .It standend() end standout mode
 .It standout() start standout mode
 .It subwin(win,lines,cols,begin_y,begin_x)\    create a subwindow
+.It timeout(delay)     set blocking or non-blocking read for
+.Em stdscr
 .It touchline(win,y,sx,ex)     mark line
 .Em y
 .Em sx
@@ -184,6 +198,8 @@
 .Em win
 .It wattrset(attribute)        set attribute modes for
 .Em win
+.It wborder(win,ls,rs,ts,bs,tl,tr,bl,br)       draw a border around
+.Em win
 .It wclear(win)        clear
 .Em win
 .It wclrtobot(win)     clear to bottom of
@@ -204,6 +220,8 @@
 .Em win
 .It winsch(win,c)      insert char into
 .Em win
+.It winsdelln(win,n)   insert/delete n lines on
+.Em win
 .It winsertln(win)     insert line into
 .Em win
 .It wmove(win,y,x)     set current (y,x) co-ordinates on
@@ -214,10 +232,15 @@
 .Em win
 .It wscanw(win,fmt,arg1,arg2,...)\     scanf through
 .Em win
+.It wscrl(win,n)       scroll
+.Em win
+n lines
 .It wstandend(win)     end standout mode on
 .Em win
 .It wstandout(win)     start standout mode on
 .Em win
+.It wtimeout(win,delay)        set blocking or non-blocking read for
+.Em win
 .It wunderend(win)     end underscore mode on
 .Em win
 .It wunderscore(win)   start underscore mode on