X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_util.3x.html;h=7e61efad79fa7d94beb8246dcda990bfe0ec15c5;hb=493e2f7b3fc309879f561a094fdfc15e5304b3d6;hp=f7ee7b399ede7db78ba41e8f51403bf40f7784d3;hpb=cd142df6d9934f1bda19f5b968cc666291be5072;p=ncurses.git diff --git a/doc/html/man/curs_util.3x.html b/doc/html/man/curs_util.3x.html index f7ee7b39..7e61efad 100644 --- a/doc/html/man/curs_util.3x.html +++ b/doc/html/man/curs_util.3x.html @@ -1,7 +1,8 @@ -
- +#include <curses.h> - char *unctrl(chtype c); - wchar_t *wunctrl(cchar_t *c); - char *keyname(int c); - char *key_name(wchar_t w); + const char *unctrl(chtype c); + wchar_t *wunctrl(cchar_t *c); + + const char *keyname(int c); + const char *key_name(wchar_t w); + void filter(void); void nofilter(void); - void use_env(bool f); - void use_tioctl(bool f); - int putwin(WINDOW *win, FILE *filep); - WINDOW *getwin(FILE *filep); - int delay_output(int ms); + + void use_env(bool f); + void use_tioctl(bool f); + + int putwin(WINDOW *win, FILE *filep); + WINDOW *getwin(FILE *filep); + + int delay_output(int ms); int flushinp(void); @@ -175,6 +181,7 @@ uses operating system calls unless over- ridden by $LINES or $COLUMNS environment variables. + TRUE TRUE ncurses updates $LINES and $COLUMNS based on operating system calls. FALSE TRUE ncurses ignores $LINES and $COLUMNS, us- @@ -196,7 +203,7 @@ o the data written is a copy of the WINDOW structure, and its associ- ated character cells. The format differs between the wide-charac- - ter (ncursesw) and non-wide (ncurses) libraries. You can transfer + ter (ncursesw) and non-wide (ncurses) libraries. You can transfer data between the two, however. o the retrieved window is always created as a top-level window (or @@ -301,9 +308,9 @@ X/Open Curses documented. o the parameter is in the range 128-159, i.e., a C1 control code. If - use_legacy_coding has been called with a 2 parameter, unctrl re- - turns the parameter, i.e., a one-character string with the parame- - ter as the first character. Otherwise, it returns "~@", "~A", + use_legacy_coding(3x) has been called with a 2 parameter, unctrl + returns the parameter, i.e., a one-character string with the param- + eter as the first character. Otherwise, it returns "~@", "~A", etc., analogous to "^@", "^A", C0 controls. X/Open Curses does not document whether unctrl can be called before @@ -320,16 +327,20 @@ "^", and strip the parameter to 7 bits. Or they may ignore C1 controls and treat all of the upper-128 codes as printable. This implementation uses 8 bits but does not modify the string to reflect locale. The - use_legacy_coding function allows the caller to change the output of - unctrl. + use_legacy_coding(3x) function allows the caller to change the output + of unctrl. Likewise, the meta(3x) function allows the caller to change the output of keyname, i.e., it determines whether to use the "M-" prefix for - "meta" keys (codes in the range 128 to 255). Both use_legacy_coding - and meta 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 keyname is called before initializing curses), this - implementation returns strings "M-^@", "M-^A", etc. + "meta" keys (codes in the range 128 to 255). Both use_legacy_cod- + ing(3x) and meta(3x) 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 keyname is called before initializ- + ing curses), this implementation returns strings "M-^@", "M-^A", etc. + + X/Open Curses documents unctrl as declared in <unctrl.h>, which ncurses + does. However, ncurses' <curses.h> includes <unctrl.h>, matching the + behavior of SVr4 curses. Other implementations may not do that.
@@ -340,9 +351,9 @@
- legacy_coding(3x), curses(3x), curs_initscr(3x), curs_inopts(3x), - curs_kernel(3x), curs_scr_dump(3x), curs_sp_funcs(3x), curs_vari- - ables(3x), legacy_coding(3x). + curses(3x), curs_initscr(3x), curs_inopts(3x), curs_kernel(3x), + curs_scr_dump(3x), curs_sp_funcs(3x), curs_variables(3x), legacy_cod- + ing(3x).