X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_bkgrnd.3x;h=08ea59f102173c004287864fe5ea358e4e2323a8;hp=3be0dced7b221ab3661637a028113a351423f8af;hb=67ab4b308e932639a3a832052228d445c41c54b4;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/man/curs_bkgrnd.3x b/man/curs_bkgrnd.3x index 3be0dced..08ea59f1 100644 --- a/man/curs_bkgrnd.3x +++ b/man/curs_bkgrnd.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2002 Free Software Foundation, Inc. * +.\" Copyright (c) 2002-2010,2012 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,10 +26,9 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_bkgrnd.3x,v 1.1 2002/02/23 23:23:42 tom Exp $ +.\" $Id: curs_bkgrnd.3x,v 1.5 2012/11/03 23:03:59 tom Exp $ .TH curs_bkgrnd 3X "" .SH NAME -.PP \fBbkgrnd\fR, \fBwbkgrnd\fR, \fBbkgrndset\fR, @@ -39,7 +38,7 @@ .SH SYNOPSIS .PP .B #include - +.sp \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 @@ -64,33 +63,33 @@ 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. - +.PP 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. - +.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 The rendition of every character on the screen is changed to the new background rendition. - +.PP Wherever the former background character appears, it is changed to the new background character. .RE - +.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 The \fBbkgrndset\fR and \fBwbkgrndset\fR routines do not return a value. .PP Upon successful completion, the other functions return \fBOK\fR. @@ -99,9 +98,3 @@ A null window pointer is treated as an error. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_bkgd\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: