diff --git a/reference/ncurses/functions/ncurses-border.xml b/reference/ncurses/functions/ncurses-border.xml index e105827a4e..92d927b7f7 100644 --- a/reference/ncurses/functions/ncurses-border.xml +++ b/reference/ncurses/functions/ncurses-border.xml @@ -1,28 +1,37 @@ - + ncurses_border - Draw a border around the screen using attributed characters + Draw a border around the screen using attributed characters Description - - intncurses_border - intleft - intright - inttop - intbottom - inttl_corner - inttr_corner - intbl_corner - intbr_corner - - &warn.experimental.func; - - &warn.undocumented.func; - + + intncurses_border + intleft + intright + inttop + intbottom + inttl_corner + inttr_corner + intbl_corner + intbr_corner + + &warn.experimental.func; + + ncurses_border draws the specified lines and + corners around the main window. Each parameter expects 0 to draw + a line and 1 to skip it. The corners are top left, top right, + bottom left and bottom right. + + + Use ncurses_wborder for borders around subwindows! + + + See also ncurses_wborder. + diff --git a/reference/ncurses/functions/ncurses-getmaxyx.xml b/reference/ncurses/functions/ncurses-getmaxyx.xml index 119999c887..643d671f4f 100644 --- a/reference/ncurses/functions/ncurses-getmaxyx.xml +++ b/reference/ncurses/functions/ncurses-getmaxyx.xml @@ -1,12 +1,9 @@ - - - + + ncurses_getmaxyx - - Returns the size of a window - + Returns the size of a window Description @@ -16,9 +13,15 @@ int&y int&x - - &warn.undocumented.func; - + &warn.experimental.func; + + ncurses_getmaxyx puts the horizontal and + vertical size of the window window + into the given variables &y and + &x. Variables must be passed + as reference, so they are updated when the user changes terminal + size. + diff --git a/reference/ncurses/functions/ncurses-init.xml b/reference/ncurses/functions/ncurses-init.xml index c4e8f093b5..1bf1ffab5f 100644 --- a/reference/ncurses/functions/ncurses-init.xml +++ b/reference/ncurses/functions/ncurses-init.xml @@ -1,21 +1,22 @@ - + ncurses_init - Initialize ncurses + Initialize ncurses Description - - intncurses_init - - - &warn.experimental.func; - - &warn.undocumented.func; - + + intncurses_init + + + &warn.experimental.func; + + ncurses_init initializes the ncurses + interface and must be used before any other ncurses function. + diff --git a/reference/ncurses/functions/ncurses-newwin.xml b/reference/ncurses/functions/ncurses-newwin.xml index 5034345c2b..377ac3924f 100644 --- a/reference/ncurses/functions/ncurses-newwin.xml +++ b/reference/ncurses/functions/ncurses-newwin.xml @@ -1,24 +1,32 @@ - + ncurses_newwin - Create a new window + Create a new window Description - - intncurses_newwin - introws - intcols - inty - intx - - &warn.experimental.func; - - &warn.undocumented.func; - + + resourcencurses_newwin + introws + intcols + inty + intx + + &warn.experimental.func; + + ncurses_newwin creates a new window + to draw elements in. Windows can be positioned using + x, y, + rows and cols. + When creating additional windows, + remember to use ncurses_getmaxyx to check for + available space, as terminal size is individual and may vary. + The return value is a resource ID used to differ between multiple + windows. + diff --git a/reference/ncurses/functions/ncurses-wborder.xml b/reference/ncurses/functions/ncurses-wborder.xml index 235eeb9251..193e91d9c7 100644 --- a/reference/ncurses/functions/ncurses-wborder.xml +++ b/reference/ncurses/functions/ncurses-wborder.xml @@ -1,12 +1,10 @@ - - + + ncurses_wborder - - Draws a border around the window using attributed characters - + Draws a border around the window using attributed characters Description @@ -22,9 +20,20 @@ intbl_corner intbr_corner - - &warn.undocumented.func; - + &warn.experimental.func; + + ncurses_wborder draws the specified lines and + corners around the passed window window. Each + parameter expects 0 to draw a line and 1 to skip it. The corners are + top left, top right, bottom left and bottom right. + + + Use ncurses_border for borders around the main + window. + + + See also ncurses_border. +