ncurses 6.2 - patch 20210109
[ncurses.git] / man / curs_bkgrnd.3x
index 8a0920221eab6c307523bd96a0c5956dc49e2ee1..84a2984bc0ec268b7bc853cf6941c147ffe1a227 100644 (file)
@@ -1,5 +1,6 @@
 .\"***************************************************************************
-.\" Copyright (c) 2002-2017,2018 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,7 +27,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_bkgrnd.3x,v 1.9 2018/07/28 21:34:06 tom Exp $
+.\" $Id: curs_bkgrnd.3x,v 1.12 2020/10/17 23:13:15 tom Exp $
 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 \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
@@ -97,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.
@@ -107,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)