ncurses 6.2 - patch 20210213
[ncurses.git] / man / curs_bkgd.3x
index d93bbd4a995e1b5e197033f2c6814db266e68d4c..051d5fda06830f9471072a62a6991055944f85ff 100644 (file)
@@ -1,5 +1,6 @@
 .\"***************************************************************************
 .\"***************************************************************************
-.\" Copyright (c) 1998-2017,2018 Free Software Foundation, Inc.              *
+.\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
+.\" Copyright 1998-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            *
 .\"                                                                          *
 .\" 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.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_bkgd.3x,v 1.28 2018/12/09 00:45:05 tom Exp $
+.\" $Id: curs_bkgd.3x,v 1.31 2020/10/17 23:12:52 tom Exp $
 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 \fBvoid bkgdset(chtype \fP\fIch\fP\fB);\fR
 .br
 \fBvoid wbkgdset(WINDOW *\fP\fIwin, chtype \fP\fIch\fP\fB);\fR
 \fBvoid bkgdset(chtype \fP\fIch\fP\fB);\fR
 .br
 \fBvoid wbkgdset(WINDOW *\fP\fIwin, chtype \fP\fIch\fP\fB);\fR
-.br
+.sp
 \fBint bkgd(chtype \fP\fIch\fP\fB);\fR
 .br
 \fBint wbkgd(WINDOW *\fP\fIwin\fP\fB, chtype \fP\fIch\fP\fB);\fR
 \fBint bkgd(chtype \fP\fIch\fP\fB);\fR
 .br
 \fBint wbkgd(WINDOW *\fP\fIwin\fP\fB, chtype \fP\fIch\fP\fB);\fR
-.br
+.sp
 \fBchtype getbkgd(WINDOW *\fP\fIwin\fP\fB);\fR
 .br
 .SH DESCRIPTION
 \fBchtype getbkgd(WINDOW *\fP\fIwin\fP\fB);\fR
 .br
 .SH DESCRIPTION
@@ -112,6 +113,12 @@ and that does not match the color in the current background,
 the library updates only the non-color attributes,
 first removing those which may have come from the current background,
 and then adding attributes from the new background.
 the library updates only the non-color attributes,
 first removing those which may have come from the current background,
 and then adding attributes from the new background.
+.PP
+If the background's character value is zero, a space is assumed.
+.PP
+If the terminal does not support color,
+or if color has not been started with \fBstart_color\fP,
+the new background character's color attribute will be ignored.
 .SS getbkgd
 .PP
 The \fBgetbkgd\fR function returns the given window's current background
 .SS getbkgd
 .PP
 The \fBgetbkgd\fR function returns the given window's current background