X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_bkgrnd.3x;h=84a2984bc0ec268b7bc853cf6941c147ffe1a227;hp=f9b4f41964f88c96148ad68f672343380b10d63e;hb=152c5a605234b7ea36ba3a03ec07e124bb6aac75;hpb=2e68dc325852af56f2ec6c315b323a4f9c3d62c9 diff --git a/man/curs_bkgrnd.3x b/man/curs_bkgrnd.3x index f9b4f419..84a2984b 100644 --- a/man/curs_bkgrnd.3x +++ b/man/curs_bkgrnd.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 2002-2015,2017 Free Software Foundation, Inc. * +.\" Copyright 2018,2020 Thomas E. Dickey * +.\" Copyright 2002-2015,2017 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,9 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_bkgrnd.3x,v 1.7 2017/03/25 21:49:00 tom Exp $ +.\" $Id: curs_bkgrnd.3x,v 1.12 2020/10/17 23:13:15 tom Exp $ .de bP -.IP \(bu 4 +.ie n .IP \(bu 4 +.el .IP \(bu 2 .. .TH curs_bkgrnd 3X "" .SH NAME @@ -45,11 +47,11 @@ \fBint bkgrnd(\fR\fB const cchar_t *\fR\fIwch\fR\fB);\fR .br \fBint wbkgrnd(\fR\fB WINDOW *\fR\fIwin\fR\fB, const cchar_t *\fR\fIwch\fR\fB);\fR -.br +.sp \fBvoid bkgrndset(const cchar_t *\fR\fIwch\fR \fB);\fR .br \fBvoid wbkgrndset(WINDOW *\fR\fIwin\fR\fB, const cchar_t *\fR\fIwch\fR\fB);\fR -.br +.sp \fBint getbkgrnd(cchar_t *\fR\fIwch\fR\fB);\fR .br \fBint wgetbkgrnd(WINDOW *\fR\fIwin\fR\fB, cchar_t *\fR\fIwch\fR\fB);\fR @@ -62,7 +64,8 @@ background of the named window. The window background is a \fBcchar_t\fR consisting of any combination of attributes (i.e., rendition) and a complex character. The attribute part of the background is combined (OR'ed) with all non-blank -characters that are written into the window with \fBwaddch\fR. Both +characters that are written into the window with \fBwaddch\fR. +Both the character and attribute parts of the background are combined with the blank characters. The background becomes a property of the @@ -95,6 +98,10 @@ Note that \fBbkgrndset\fR, and \fBgetbkgrnd\fR may be macros. +.PP +X/Open Curses does not provide details on how the rendition is changed. +This implementation follows the approach used in SVr4 curses, +which is explained in the manual page for \fBwbkgd\fP. .SH RETURN VALUE .PP The \fBbkgrndset\fR and \fBwbkgrndset\fR routines do not return a value. @@ -105,6 +112,10 @@ Otherwise, they return \fBERR\fR: A null window pointer is treated as an error. .bP A null character pointer is treated as an error. +.SH PORTABILITY +.PP +These functions are described in the XSI Curses standard, Issue 4 +(X/Open Curses). .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_bkgd\fR(3X)