X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_bkgd.3x;h=757186cf558bbc1964fd5ec501fa115468be901b;hp=a256999765611ad3425118ee3b021b3833d4e4c9;hb=8556933f52df71cf1b58eeaeae1865ebf7c005cc;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce diff --git a/man/curs_bkgd.3x b/man/curs_bkgd.3x index a2569997..757186cf 100644 --- a/man/curs_bkgd.3x +++ b/man/curs_bkgd.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright (c) 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 * @@ -26,27 +26,31 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_bkgd.3x,v 1.12 1998/03/14 23:43:31 tom Exp $ +.\" $Id: curs_bkgd.3x,v 1.25 2017/11/18 23:56:00 tom Exp $ +.de bP +.ie n .IP \(bu 4 +.el .IP \(bu 2 +.. .TH curs_bkgd 3X "" .SH NAME -\fBbkgdset\fR, \fBwbkgdset\fR, \fBbkgd\fR, -\fBwbkgd\fR - \fBcurses\fR window background manipulation routines -.. +\fBbkgdset\fR, \fBwbkgdset\fR, +\fBbkgd\fR, \fBwbkgd\fR, +\fBgetbkgd\fR \- \fBcurses\fR window background manipulation routines .SH SYNOPSIS \fB#include \fR - -\fBvoid bkgdset(const chtype ch);\fR +.PP +\fBvoid bkgdset(chtype \fP\fIch\fP\fB);\fR .br -\fBvoid wbkgdset(WINDOW *win, const chtype ch);\fR +\fBvoid wbkgdset(WINDOW *\fP\fIwin, chtype \fP\fIch\fP\fB);\fR .br -\fBint bkgd(const chtype ch);\fR +\fBint bkgd(chtype \fP\fIch\fP\fB);\fR .br -\fBint wbkgd(WINDOW *win, const chtype ch);\fR +\fBint wbkgd(WINDOW *\fP\fIwin\fP\fB, chtype \fP\fIch\fP\fB);\fR .br -\fBchtype getbkgd(WINDOW *win);\fR +\fBchtype getbkgd(WINDOW *\fP\fIwin\fP\fB);\fR .br -.. .SH DESCRIPTION +.SS bkgdset The \fBbkgdset\fR and \fBwbkgdset\fR routines manipulate the background of the named window. The window background is a \fBchtype\fR consisting of @@ -57,45 +61,43 @@ the character and attribute parts of the background are combined with 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 the background is displayed +.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. - +.SS bkgd +.PP The \fBbkgd\fR and \fBwbkgd\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 +.bP The rendition of every character on the screen is changed to the new background rendition. - +.bP Wherever the former background character appears, it is changed to the new background character. -.RE - +.SS getbkgd +.PP The \fBgetbkgd\fR function returns the given window's current background character/attribute pair. -.. .SH RETURN VALUE +.PP The routines \fBbkgd\fR and \fBwbkgd\fR return the integer \fBOK\fR. The SVr4.0 manual says "or a non-negative integer if \fBimmedok\fR is set", but this appears to be an error. -.. .SH NOTES +.PP Note that \fBbkgdset\fR and \fBbkgd\fR may be macros. -.. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. The draft -does not include \fBconst\fR qualifiers on the arguments. The standard -specifies that \fBbkgd\fR and \fBwbkgd\fR return \fBERR\fR, on failure. but -gives no failure conditions. -.. +.PP +These functions are described in the XSI Curses standard, Issue 4. +It specifies that \fBbkgd\fR and \fBwbkgd\fR return \fBERR\fR on failure, +but gives no failure conditions. .SH SEE ALSO -\fBcurses\fR(3X), \fBcurs_addch\fR(3X), \fBcurs_outopts\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +.na +.PP +\fBcurses\fR(3X), +\fBcurs_addch\fR(3X), +\fBcurs_attr\fR(3X), +\fBcurs_outopts\fR(3X)