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

« back to all changes in this revision

Viewing changes to man/curs_util.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
* 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:
27
27
.\" authorization.                                                           *
28
28
.\"***************************************************************************
29
29
.\"
30
 
.\" $Id: curs_util.3x,v 1.42 2015/04/26 14:27:03 Sven.Joachim Exp $
 
30
.\" $Id: curs_util.3x,v 1.43 2015/06/06 23:36:27 tom Exp $
31
31
.TH curs_util 3X ""
32
32
.ie \n(.g .ds `` \(lq
33
33
.el       .ds `` ``
81
81
\fBint flushinp(void);\fR
82
82
.br
83
83
.SH DESCRIPTION
 
84
.SS unctrl
 
85
.PP
84
86
The \fBunctrl\fR routine returns a character string which is a printable
85
87
representation of the character \fIc\fR, ignoring attributes.
86
88
Control characters are displayed in the \fB^\fR\fIX\fR notation.
87
89
Printing characters are displayed as is.
88
90
The corresponding \fBwunctrl\fR returns a printable representation of
89
91
a wide character.
 
92
.SS keyname/key_name
90
93
.PP
91
94
The \fBkeyname\fR routine returns a character string
92
95
corresponding to the key \fIc\fR:
117
120
to the wide-character value \fIw\fR.
118
121
The two functions do not return the same set of strings;
119
122
the latter returns null where the former would display a meta character.
 
123
.SS filter/nofilter
120
124
.PP
121
125
The \fBfilter\fR routine, if used, must be called before \fBinitscr\fR or
122
126
\fBnewterm\fR are called.
131
135
using a different value of \fB$TERM\fP.
132
136
The limitation arises because the \fBfilter\fP routine modifies the
133
137
in-memory copy of the terminal information.
 
138
.SS use_env
134
139
.PP
135
140
The \fBuse_env\fR routine, if used,
136
141
should be called before \fBinitscr\fR or
156
161
.IP
157
162
Ncurses also updates the screen size in response to SIGWINCH,
158
163
unless overridden by the \fBLINES\fR or \fBCOLUMNS\fR environment variables,
 
164
.SS use_tioctl
159
165
.PP
160
166
The \fBuse_tioctl\fR routine, if used,
161
167
should be called before \fBinitscr\fR or \fBnewterm\fR are called
196
202
ncurses relies on the terminal database to determine size.
197
203
T}
198
204
.TE
 
205
.SS putwin/getwin
199
206
.PP
200
207
The \fBputwin\fR routine writes all data associated
201
208
with window (or pad) \fIwin\fR into
224
231
If cells in the retrieved window use color pairs which have not been
225
232
created in the application using \fBinit_pair\fP,
226
233
they will not be colored when the window is refreshed.
 
234
.SS delay_output
227
235
.PP
228
236
The \fBdelay_output\fR routine inserts an \fIms\fR millisecond pause
229
237
in output.
231
239
padding characters are used rather than a CPU pause.
232
240
If no padding character is specified,
233
241
this uses \fBnapms\fR to perform the delay.
 
242
.SS flushinp
234
243
.PP
235
244
The \fBflushinp\fR routine throws away any typeahead that has been typed by the
236
245
user and has not yet been read by the program.