X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_util.3x;h=4d027dbade11aa8337dce634df4ab57bd684c285;hp=1b7b9e804b8fa32f99b33d7adb9b5c0f5d5c0b98;hb=21c8ffa0edf2e389f3f674f0c08009002c6f357d;hpb=87f20fc6e737084b06b6343c8c7206404daec4a2 diff --git a/man/curs_util.3x b/man/curs_util.3x index 1b7b9e80..4d027dba 100644 --- a/man/curs_util.3x +++ b/man/curs_util.3x @@ -27,7 +27,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_util.3x,v 1.40 2015/03/15 13:58:59 tom Exp $ +.\" $Id: curs_util.3x,v 1.43 2015/06/06 23:36:27 tom Exp $ .TH curs_util 3X "" .ie \n(.g .ds `` \(lq .el .ds `` `` @@ -81,12 +81,15 @@ \fBint flushinp(void);\fR .br .SH DESCRIPTION +.SS unctrl +.PP The \fBunctrl\fR routine returns a character string which is a printable representation of the character \fIc\fR, ignoring attributes. Control characters are displayed in the \fB^\fR\fIX\fR notation. Printing characters are displayed as is. The corresponding \fBwunctrl\fR returns a printable representation of a wide character. +.SS keyname/key_name .PP The \fBkeyname\fR routine returns a character string corresponding to the key \fIc\fR: @@ -100,7 +103,7 @@ DEL (character 127) is displayed as \fB^?\fP. .bP Values above 128 are either meta characters (if the screen has not been initialized, -or if \fBmeta\fP has been called with a TRUE parameter), +or if \fBmeta\fP has been called with a \fBTRUE\fP parameter), shown in the \fBM\-\fR\fIX\fR notation, or are displayed as themselves. In the latter case, the values may not be printable; @@ -117,6 +120,7 @@ The corresponding \fBkey_name\fR returns a character string corresponding to the wide-character value \fIw\fR. The two functions do not return the same set of strings; the latter returns null where the former would display a meta character. +.SS filter/nofilter .PP The \fBfilter\fR routine, if used, must be called before \fBinitscr\fR or \fBnewterm\fR are called. @@ -131,6 +135,7 @@ That allows the caller to initialize a screen on a different device, using a different value of \fB$TERM\fP. The limitation arises because the \fBfilter\fP routine modifies the in-memory copy of the terminal information. +.SS use_env .PP The \fBuse_env\fR routine, if used, should be called before \fBinitscr\fR or @@ -156,6 +161,7 @@ from the operating system or terminal database. .IP Ncurses also updates the screen size in response to SIGWINCH, unless overridden by the \fBLINES\fR or \fBCOLUMNS\fR environment variables, +.SS use_tioctl .PP The \fBuse_tioctl\fR routine, if used, should be called before \fBinitscr\fR or \fBnewterm\fR are called @@ -196,6 +202,7 @@ FALSE/FALSE/T{ ncurses relies on the terminal database to determine size. T} .TE +.SS putwin/getwin .PP The \fBputwin\fR routine writes all data associated with window (or pad) \fIwin\fR into @@ -224,6 +231,7 @@ but not the actual color \fInumbers\fP. If cells in the retrieved window use color pairs which have not been created in the application using \fBinit_pair\fP, they will not be colored when the window is refreshed. +.SS delay_output .PP The \fBdelay_output\fR routine inserts an \fIms\fR millisecond pause in output. @@ -231,6 +239,7 @@ This routine should not be used extensively because padding characters are used rather than a CPU pause. If no padding character is specified, this uses \fBnapms\fR to perform the delay. +.SS flushinp .PP The \fBflushinp\fR routine throws away any typeahead that has been typed by the user and has not yet been read by the program. @@ -307,7 +316,7 @@ A few applications may happen to write extra data in the file using these functions. Doing that can run into problems mixing block- and buffered-I/O. This implementation reduces the problem on writes by flushing the output. -However, reading from a file written using mixed schemes may not be succesful. +However, reading from a file written using mixed schemes may not be successful. .SS unctrl/wunctrl .PP The XSI Curses standard, Issue 4 describes these functions.