ncurses 6.2 - patch 20210626

[ncurses.git] / doc / html / man / curs_bkgrnd.3x.html
diff --git a/doc/html/man/curs_bkgrnd.3x.html b/doc/html/man/curs_bkgrnd.3x.html

index b3b03f62e948ffc167aa7909f298ef6a89eb083e..8e60e213d1b8b6638a613e034acb8817a8b8f57b 100644 (file)
--- a/doc/html/man/curs_bkgrnd.3x.html
+++ b/doc/html/man/curs_bkgrnd.3x.html
@@ -1,6 +1,7 @@
-<!-- 
+<!--
    ****************************************************************************
-  * 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,15 +27,15 @@
    * sale, use or other dealings in this Software without prior written       *
    * authorization.                                                           *
    ****************************************************************************
-  * @Id: curs_bkgrnd.3x,v 1.8 2017/11/18 23:47:37 tom Exp @
+  * @Id: curs_bkgrnd.3x,v 1.12 2020/10/17 23:13:15 tom Exp @
  -->
  <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  <HTML>
  <HEAD>
  <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
-<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
+<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  <TITLE>curs_bkgrnd 3x</TITLE>
-<link rev=made href="mailto:bug-ncurses@gnu.org">
+<link rel="author" href="mailto:bug-ncurses@gnu.org">
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  </HEAD>
  <BODY>
@@ -55,8 +56,10 @@
  
         <STRONG>int</STRONG> <STRONG>bkgrnd(</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
         <STRONG>int</STRONG> <STRONG>wbkgrnd(</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
+
         <STRONG>void</STRONG> <STRONG>bkgrndset(const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG>
         <STRONG>void</STRONG> <STRONG>wbkgrndset(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
+
         <STRONG>int</STRONG> <STRONG>getbkgrnd(cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
         <STRONG>int</STRONG> <STRONG>wgetbkgrnd(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
  
@@ -70,8 +73,8 @@
         The  attribute part of the background is combined (OR'ed) with all non-
         blank characters that are written into the window  with  <STRONG>waddch</STRONG>.   Both
         the  character  and attribute parts of the background are combined with
-       the blank characters.  The background becomes a property of the charac-
-       ter   and   moves   with   the  character  through  any  scrolling  and
+       the blank  characters.   The  background  becomes  a  property  of  the
+       character  and  moves  with  the  character  through  any scrolling and
         insert/delete line/character operations.
  
         To the extent possible on a particular terminal, the attribute part  of
@@ -81,8 +84,8 @@
  
  </PRE><H3><a name="h3-bkgrnd">bkgrnd</a></H3><PRE>
         The <STRONG>bkgrnd</STRONG> and <STRONG>wbkgrnd</STRONG> functions set the  background  property  of  the
-       current  or specified window and then apply this setting to every char-
-       acter position in that window:
+       current  or  specified  window  and  then  apply  this setting to every
+       character position in that window:
  
         <STRONG>o</STRONG>   The rendition of every character on the screen is  changed  to  the
             new background rendition.
@@ -100,6 +103,10 @@
  </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
         Note that <STRONG>bkgrnd</STRONG>, <STRONG>bkgrndset</STRONG>, and <STRONG>getbkgrnd</STRONG> may be macros.
  
+       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 <STRONG>wbkgd</STRONG>.
+
  
  </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
         The <STRONG>bkgrndset</STRONG> and <STRONG>wbkgrndset</STRONG> routines do not return a value.
@@ -112,6 +119,11 @@
         <STRONG>o</STRONG>   A null character pointer is treated as an error.
  
  
+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+       These  functions  are  described  in  the  XSI Curses standard, Issue 4
+       (X/Open Curses).
+
+
  </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
         <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>
  
@@ -132,6 +144,7 @@
  </li>
  <li><a href="#h2-NOTES">NOTES</a></li>
  <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
+<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
  <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
  </ul>
  </div>