X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_util.3x;h=652628a873f3ecdac22554c48fb6b2ded0b3440d;hp=6679de19f6afbb9fb816340a5a7d0ecf3292ac37;hb=71c0306f0824ef2b10c4c5813fb003db48f3012e;hpb=f6718d80c998008de6cfe8e6296bee3958ff86d7 diff --git a/man/curs_util.3x b/man/curs_util.3x index 6679de19..652628a8 100644 --- a/man/curs_util.3x +++ b/man/curs_util.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2007,2008 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2008,2010 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,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_util.3x,v 1.26 2008/10/11 20:32:56 tom Exp $ +.\" $Id: curs_util.3x,v 1.28 2010/07/31 16:10:55 tom Exp $ .TH curs_util 3X "" .na .hy 0 @@ -41,7 +41,7 @@ \fBputwin\fR, \fBunctrl\fR, \fBuse_env\fR, -\fBwunctrl\fR - miscellaneous \fBcurses\fR utility routines +\fBwunctrl\fR \- miscellaneous \fBcurses\fR utility routines .ad .hy .SH SYNOPSIS @@ -80,28 +80,28 @@ a wide-character. The \fBkeyname\fR routine returns a character string corresponding to the key \fIc\fR: .RS 3 .TP 3 -- +\- Printable characters are displayed as themselves, e.g., a one-character string containing the key. .TP 3 -- +\- Control characters are displayed in the \fB^\fR\fIX\fR notation. .TP 3 -- +\- DEL (character 127) is displayed as \fB^?\fP. .TP 3 -- +\- 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), -shown in the \fBM-\fR\fIX\fR notation, +shown in the \fBM\-\fR\fIX\fR notation, or are displayed as themselves. In the latter case, the values may not be printable; this follows the X/Open specification. .TP 3 -- +\- Values above 256 may be the names of the names of function keys. .TP 3 -- +\- Otherwise (if there is no corresponding name) the function returns null, to denote an error. X/Open also lists an "UNKNOWN KEY" return value, which some implementations @@ -161,11 +161,14 @@ Routines that return pointers return \fBNULL\fR on error. .PP X/Open does not define any error conditions. In this implementation -.RS +.RS 3 .TP 5 \fBflushinp\fR returns an error if the terminal was not initialized. .TP 5 +\fBmeta\fR +returns an error if the terminal was not initialized. +.TP 5 \fBputwin\fP returns an error if the associated \fBfwrite\fP calls return an error. .RE @@ -176,12 +179,12 @@ unsuccessful, but does not define any error conditions. This implementation checks for three cases: .RS .TP 5 -- -the parameter is a 7-bit US-ASCII code. +\- +the parameter is a 7-bit US\-ASCII code. This is the case that X/Open Curses documented. .TP 5 -- -the parameter is in the range 128-159, i.e., a C1 control code. +\- +the parameter is in the range 128\-159, i.e., a C1 control code. If \fBuse_legacy_coding\fP has been called with a \fB2\fP parameter, \fBunctrl\fP returns the parameter, i.e., a one-character string with the parameter as the first character. @@ -192,7 +195,7 @@ initializing curses. This implementation permits that, and returns the ``~@'', etc., values in that case. .TP 5 -- +\- parameter values outside the 0 to 255 range. \fBunctrl\fP returns a null pointer. .RE @@ -216,17 +219,17 @@ change the output of \fBunctrl\fP. .PP Likewise, the \fBmeta\fP function allows the caller to change the output of \fBkeyname\fP, i.e., -it determines whether to use the `M-' prefix +it determines whether to use the `M\-' prefix for ``meta'' keys (codes in the range 128 to 255). Both \fBuse_legacy_coding\fP and \fBmeta\fP succeed only after curses is initialized. X/Open Curses does not document the treatment of codes 128 to 159. When treating them as ``meta'' keys (or if \fBkeyname\fP is called before initializing curses), -this implementation returns strings ``M-^@'', ``M-^A'', etc. +this implementation returns strings ``M\-^@'', ``M\-^A'', etc. .PP The \fBkeyname\fP function may return the names of user-defined -string capabilities which are defined in the terminfo entry via the \fB-x\fP +string capabilities which are defined in the terminfo entry via the \fB\-x\fP option of \fBtic\fP. This implementation automatically assigns at run-time keycodes to user-defined strings which begin with "k".