← Back to branch summary

~ubuntu-branches/debian/sid/ncurses/sid

« back to all changes in this revision

Viewing changes to man/curs_bkgd.3x

  • Committer: Package Import Robot
  • Author(s): Sven Joachim
  • Date: 2015-08-17 18:01:53 UTC
  • mfrom: (1.32.11)
  • Revision ID: package-import@ubuntu.com-20150817180153-ywf02awpkuzvqwdv
Tags: 6.0+20150810-1
http://bugs.debian.org/790548
http://bugs.debian.org/788610
* New upstream release.
  - Fix comparison against "/usr/include" in misc/gen-pkgconfig.in
    (Closes: #790548).
* Configure with "--with-abi-version=5", upstream defaults to abi 6 now.
* Configure with "--with-versioned-syms" (Closes: #788610).
  - Bump minimal versions of all symbols as well as shlibs to 6.
* After building the wide library, install it into a temporary
  scratchdir so that test/configure can find the necessary auxiliary
  files (see #786436).
* Drop the libncursesw5-dev build-dependency.

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/curs_bkgd.3x
1
1
.\"***************************************************************************
2
 
.\" Copyright (c) 1998-2003,2010 Free Software Foundation, Inc.              *
 
2
.\" Copyright (c) 1998-2010,2015 Free Software Foundation, Inc.              *
3
3
.\"                                                                          *
4
4
.\" Permission is hereby granted, free of charge, to any person obtaining a  *
5
5
.\" copy of this software and associated documentation files (the            *
26
26
.\" authorization.                                                           *
27
27
.\"***************************************************************************
28
28
.\"
29
 
.\" $Id: curs_bkgd.3x,v 1.22 2010/12/04 18:36:44 tom Exp $
 
29
.\" $Id: curs_bkgd.3x,v 1.23 2015/07/21 00:11:05 tom Exp $
 
30
.de bP
 
31
.IP \(bu 4
 
32
..
30
33
.TH curs_bkgd 3X ""
31
34
.SH NAME
32
35
\fBbkgdset\fR, \fBwbkgdset\fR,
35
38
.SH SYNOPSIS
36
39
\fB#include <curses.h>\fR
37
40
.PP
38
 
\fBvoid bkgdset(chtype ch);\fR
39
 
.br
40
 
\fBvoid wbkgdset(WINDOW *win, chtype ch);\fR
41
 
.br
42
 
\fBint bkgd(chtype ch);\fR
43
 
.br
44
 
\fBint wbkgd(WINDOW *win, chtype ch);\fR
45
 
.br
46
 
\fBchtype getbkgd(WINDOW *win);\fR
 
41
\fBvoid bkgdset(chtype \fP\fIch\fP\fB);\fR
 
42
.br
 
43
\fBvoid wbkgdset(WINDOW *\fP\fIwin, chtype \fP\fIch\fP\fB);\fR
 
44
.br
 
45
\fBint bkgd(chtype \fP\fIch\fP\fB);\fR
 
46
.br
 
47
\fBint wbkgd(WINDOW *\fP\fIwin\fP\fB, chtype \fP\fIch\fP\fB);\fR
 
48
.br
 
49
\fBchtype getbkgd(WINDOW *\fP\fIwin\fP\fB);\fR
47
50
.br
48
51
.SH DESCRIPTION
 
52
.SS bkgdset
49
53
The \fBbkgdset\fR and \fBwbkgdset\fR routines manipulate the
50
54
background of the named window.
51
55
The window background is a \fBchtype\fR consisting of
60
64
To the extent possible on a particular terminal,
61
65
the attribute part of the background is displayed
62
66
as the graphic rendition of the character put on the screen.
 
67
.SS bkgd
63
68
.PP
64
69
The \fBbkgd\fR and \fBwbkgd\fR functions
65
70
set the background property of the current or specified window
66
71
and then apply this setting to every character position in that window:
67
72
.PP
68
 
.RS
 
73
.bP
69
74
The rendition of every character on the screen is changed to
70
75
the new background rendition.
71
 
.PP
 
76
.bP
72
77
Wherever the former background character
73
78
appears, it is changed to the new background character.
74
79
.RE
 
80
.SS getbkgd
75
81
.PP
76
82
The \fBgetbkgd\fR function returns the given window's current background
77
83
character/attribute pair.
78
84
.SH RETURN VALUE
 
85
.PP
79
86
The routines \fBbkgd\fR and \fBwbkgd\fR return the integer \fBOK\fR.
80
87
The SVr4.0 manual says "or a non-negative integer if \fBimmedok\fR is set",
81
88
but this appears to be an error.
82
89
.SH NOTES
 
90
.PP
83
91
Note that \fBbkgdset\fR and \fBbkgd\fR may be macros.
84
92
.SH PORTABILITY
 
93
.PP
85
94
These functions are described in the XSI Curses standard, Issue 4.
86
95
It specifies that \fBbkgd\fR and \fBwbkgd\fR return \fBERR\fR on failure,
87
96
but gives no failure conditions.
88
97
.SH SEE ALSO
 
98
.na
 
99
.PP
89
100
\fBcurses\fR(3X),
90
101
\fBcurs_addch\fR(3X),
91
102
\fBcurs_attr\fR(3X),