X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_bkgrnd.3x;h=2bbb4fce4581b8ed8e8f2507de1da75000bdbeca;hp=43112a79ab79360c0423e4743e817a560add005a;hb=59c1a9740d123db3cecafe76e18f7848081a670b;hpb=96d6b16de0d487e5d3aed0302a179dbce11b5d96 diff --git a/man/curs_bkgrnd.3x b/man/curs_bkgrnd.3x index 43112a79..2bbb4fce 100644 --- a/man/curs_bkgrnd.3x +++ b/man/curs_bkgrnd.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2002-2006,2010 Free Software Foundation, Inc. * +.\" Copyright (c) 2002-2012,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -26,7 +26,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_bkgrnd.3x,v 1.4 2010/12/04 18:49:20 tom Exp $ +.\" $Id: curs_bkgrnd.3x,v 1.6 2015/07/21 00:18:42 tom Exp $ +.de bP +.IP \(bu 4 +.. .TH curs_bkgrnd 3X "" .SH NAME \fBbkgrnd\fR, @@ -52,6 +55,8 @@ \fBint wgetbkgrnd(WINDOW *\fR\fIwin\fR\fB, cchar_t *\fR\fIwch\fR\fB);\fR .br .SH DESCRIPTION +.SS bkgrndset +.PP The \fBbkgrndset\fR and \fBwbkgrndset\fR routines manipulate the background of the named window. The window background is a \fBcchar_t\fR consisting of @@ -67,29 +72,29 @@ insert/delete line/character operations. To the extent possible on a particular terminal, the attribute part of the background is displayed as the graphic rendition of the character put on the screen. +.SS bkgrnd .PP The \fBbkgrnd\fR and \fBwbkgrnd\fR functions set the background property of the current or specified window and then apply this setting to every character position in that window: -.RS -.PP +.bP The rendition of every character on the screen is changed to the new background rendition. -.PP +.bP Wherever the former background character appears, it is changed to the new background character. -.RE +.SS getbkgrnd .PP The \fBgetbkgrnd\fR function returns the given window's current background character/attribute pair via the \fBwch\fR pointer. -. .SH NOTES Note that \fBbkgrnd\fR, \fBbkgrndset\fR, and \fBgetbkgrnd\fR may be macros. -.SH RETURN VALUES +.SH RETURN VALUE +.PP The \fBbkgrndset\fR and \fBwbkgrndset\fR routines do not return a value. .PP Upon successful completion, the other functions return \fBOK\fR.