X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_terminfo.3x.html;h=3e964ef5bc2bda6d75d0f1bf5956cffd2240f38c;hb=58552e8c761a70f8f0bd591fecdf576fa8216e3e;hp=f0a6ecc39cdffc7197c3c24dba7113697a3ce7af;hpb=2e5d72d6396bb38a8d1d1b3534f62e28aebaa600;p=ncurses.git diff --git a/doc/html/man/curs_terminfo.3x.html b/doc/html/man/curs_terminfo.3x.html index f0a6ecc3..3e964ef5 100644 --- a/doc/html/man/curs_terminfo.3x.html +++ b/doc/html/man/curs_terminfo.3x.html @@ -1,7 +1,6 @@ - +
+ +- curs_terminfo(3x) curs_terminfo(3x) --
+
del_curterm, mvcur, putp, restartterm, set_curterm, setterm, setupterm, tigetflag, tigetnum, tigetstr, tiparm, tparm, tputs, vid_attr, vid_puts, vidattr, vidputs - curses interfaces to terminfo database --
+
#include <curses.h> #include <term.h> @@ -82,15 +80,15 @@ char *tiparm(const char *str, ...); --
+
These low-level routines must be called by programs that have to deal directly with the terminfo database to handle certain terminal capabilities, such as programming func- tion keys. For all other functionality, curses routines are more suitable and their use is recommended. - Initialization + +
Initially, setupterm should be called. Note that se- tupterm is automatically called by initscr and newterm. This defines the set of terminal-dependent variables @@ -151,14 +149,14 @@ for curses applications. setupterm determines if the entry is a hardcopy type - by checking the hc (hardcopy) capability. + by checking the hc (hardcopy) capability. 0 means that the terminal could not be found, or that it is a generic type, having too little information for curses applications to run. setupterm determines if the entry is a generic type - by checking the gn (generic) capability. + by checking the gn (generic) capability. -1 means that the terminfo database could not be found. @@ -178,7 +176,8 @@ setterm routine is provided for BSD compatibility, and is not recommended for new programs. - The Terminal State + +
The setupterm routine stores its information about the terminal in a TERMINAL structure pointed to by the global variable cur_term. If it detects an error, or decides @@ -214,7 +213,8 @@ tty state bits, calls setupterm, and then restores the bits. - Formatting Output + +
The tparm routine instantiates the string str with parame- ters pi. A pointer is returned to the result of str with the parameters applied. @@ -223,45 +223,52 @@ rather than a fixed-parameter list. Its numeric parame- ters are integers (int) rather than longs. - Output Functions + +
The tputs routine applies padding information to the - string str and outputs it. The str must be a terminfo - string variable or the return value from tparm, tgetstr, - or tgoto. affcnt is the number of lines affected, or 1 if - not applicable. putc is a putchar-like routine to which - the characters are passed, one at a time. - - The putp routine calls tputs(str, 1, putchar). Note that - the output of putp always goes to stdout, not to the + string str and outputs it: + + o The str must be a terminfo string variable or the re- + turn value from tparm, tgetstr, or tgoto. + + o affcnt is the number of lines affected, or 1 if not + applicable. + + o putc is a putchar-like routine to which the characters + are passed, one at a time. + + The putp routine calls tputs(str, 1, putchar). Note that + the output of putp always goes to stdout, not to the fildes specified in setupterm. The vidputs routine displays the string on the terminal in - the video attribute mode attrs, which is any combination - of the attributes listed in curses(3x). The characters + the video attribute mode attrs, which is any combination + of the attributes listed in curses(3x). The characters are passed to the putchar-like routine putc. - The vidattr routine is like the vidputs routine, except + The vidattr routine is like the vidputs routine, except that it outputs through putchar. - The vid_attr and vid_puts routines correspond to vidattr - and vidputs, respectively. They use a set of arguments - for representing the video attributes plus color, i.e., + The vid_attr and vid_puts routines correspond to vidattr + and vidputs, respectively. They use a set of arguments + for representing the video attributes plus color, i.e., one of type attr_t for the attributes and one of short for the color_pair number. The vid_attr and vid_puts routines - are designed to use the attribute constants with the WA_ - prefix. The opts argument is reserved for future use. - Currently, applications must provide a null pointer for + are designed to use the attribute constants with the WA_ + prefix. The opts argument is reserved for future use. + Currently, applications must provide a null pointer for that argument. - The mvcur routine provides low-level cursor motion. It - takes effect immediately (rather than at the next re- + The mvcur routine provides low-level cursor motion. It + takes effect immediately (rather than at the next re- fresh). - Terminal Capability Functions - The tigetflag, tigetnum and tigetstr routines return the + +
+ The tigetflag, tigetnum and tigetstr routines return the value of the capability corresponding to the terminfo cap- - name passed to them, such as xenl. The capname for each - capability is given in the table column entitled capname + name passed to them, such as xenl. The capname for each + capability is given in the table column entitled capname code in the capabilities section of terminfo(5). These routines return special values to denote errors. @@ -270,14 +277,14 @@ -1 if capname is not a boolean capability, or - 0 if it is canceled or absent from the terminal de- + 0 if it is canceled or absent from the terminal de- scription. The tigetnum routine returns -2 if capname is not a numeric capability, or - -1 if it is canceled or absent from the terminal de- + -1 if it is canceled or absent from the terminal de- scription. The tigetstr routine returns @@ -285,12 +292,13 @@ (char *)-1 if capname is not a string capability, or - 0 if it is canceled or absent from the terminal de- + 0 if it is canceled or absent from the terminal de- scription. - Terminal Capability Names - These null-terminated arrays contain the short terminfo - names ("codes"), the termcap names, and the long terminfo + +
+ These null-terminated arrays contain the short terminfo + names ("codes"), the termcap names, and the long terminfo names ("fnames") for each of the predefined terminfo vari- ables: char *boolnames[], *boolcodes[], *boolfnames[] @@ -300,133 +308,144 @@ char *strnames[], *strcodes[], *strfnames[] --
- Routines that return an integer return ERR upon failure - and OK (SVr4 only specifies "an integer value other than - ERR") upon successful completion, unless otherwise noted +
+ Routines that return an integer return ERR upon failure + and OK (SVr4 only specifies "an integer value other than + ERR") upon successful completion, unless otherwise noted in the preceding routine descriptions. Routines that return pointers always return NULL on error. - X/Open defines no error conditions. In this implementa- + X/Open defines no error conditions. In this implementa- tion del_curterm - returns an error if its terminal parameter is + returns an error if its terminal parameter is null. putp calls tputs, returning the same error-codes. restartterm - returns an error if the associated call to se- + returns an error if the associated call to se- tupterm returns an error. setupterm - returns an error if it cannot allocate enough - memory, or create the initial windows (stdscr, - curscr, newscr). Other error conditions are + returns an error if it cannot allocate enough + memory, or create the initial windows (stdscr, + curscr, newscr). Other error conditions are documented above. tputs - returns an error if the string parameter is - null. It does not detect I/O errors: X/Open - states that tputs ignores the return value of + returns an error if the string parameter is + null. It does not detect I/O errors: X/Open + states that tputs ignores the return value of the output function putc. --
+
X/Open notes that vidattr and vidputs may be macros. - The function setterm is not described by X/Open and must - be considered non-portable. All other functions are as + The function setterm is not described by X/Open and must + be considered non-portable. All other functions are as described by X/Open. - setupterm copies the terminal name to the array ttytype. - This is not part of X/Open Curses, but is assumed by some + setupterm copies the terminal name to the array ttytype. + This is not part of X/Open Curses, but is assumed by some applications. - If configured to use the terminal-driver, e.g., for the + If configured to use the terminal-driver, e.g., for the MinGW port, - o setupterm interprets a missing/empty TERM variable as + o setupterm interprets a missing/empty TERM variable as the special value "unknown". - o setupterm allows explicit use of the the windows con- + o setupterm allows explicit use of the the windows con- sole driver by checking if $TERM is set to "#win32con" or an abbreviation of that string. Older versions of ncurses assumed that the file descriptor - passed to setupterm from initscr or newterm uses buffered - I/O, and would write to the corresponding stream. In ad- - dition to the limitation that the terminal was left in - block-buffered mode on exit (like SystemV curses), it was - problematic because ncurses did not allow a reliable way + passed to setupterm from initscr or newterm uses buffered + I/O, and would write to the corresponding stream. In ad- + dition to the limitation that the terminal was left in + block-buffered mode on exit (like System V curses), it was + problematic because ncurses did not allow a reliable way to cleanup on receiving SIGTSTP. The current version uses - output buffers managed directly by ncurses. Some of the + output buffers managed directly by ncurses. Some of the low-level functions described in this manual page write to the standard output. They are not signal-safe. The high- level functions in ncurses use alternate versions of these functions using the more reliable buffering scheme. - In System V Release 4, set_curterm has an int return type - and returns OK or ERR. We have chosen to implement the + In System V Release 4, set_curterm has an int return type + and returns OK or ERR. We have chosen to implement the X/Open Curses semantics. In System V Release 4, the third argument of tputs has the type int (*putc)(char). At least one implementation of X/Open Curses (Solaris) re- - turns a value other than OK/ERR from tputs. That returns + turns a value other than OK/ERR from tputs. That returns the length of the string, and does no error-checking. - X/Open Curses prototypes tparm with a fixed number of pa- - rameters, rather than a variable argument list. This im- - plementation uses a variable argument list, but can be - configured to use the fixed-parameter list. Portable ap- - plications should provide 9 parameters after the format; + X/Open Curses prototypes tparm with a fixed number of pa- + rameters, rather than a variable argument list. This im- + plementation uses a variable argument list, but can be + configured to use the fixed-parameter list. Portable ap- + plications should provide 9 parameters after the format; zeroes are fine for this purpose. In response to comments by Thomas E. Dickey, X/Open Curses Issue 7 proposed the tiparm function in mid-2009. - X/Open notes that after calling mvcur, the curses state - may not match the actual terminal state, and that an ap- - plication should touch and refresh the window before re- + X/Open notes that after calling mvcur, the curses state + may not match the actual terminal state, and that an ap- + plication should touch and refresh the window before re- suming normal curses calls. Both ncurses and System V Re- lease 4 curses implement mvcur using the SCREEN data allo- cated in either initscr or newterm. So though it is docu- - mented as a terminfo function, mvcur is really a curses + mented as a terminfo function, mvcur is really a curses function which is not well specified. - X/Open states that the old location must be given for - mvcur. This implementation allows the caller to use -1's - for the old ordinates. In that case, the old location is + X/Open states that the old location must be given for + mvcur. This implementation allows the caller to use -1's + for the old ordinates. In that case, the old location is unknown. - Other implementions may not declare the capability name + Other implementions may not declare the capability name arrays. Some provide them without declaring them. X/Open does not specify them. - Extended terminal capability names, e.g., as defined by + Extended terminal capability names, e.g., as defined by tic -x, are not stored in the arrays described here. --
- curses(3x), curs_initscr(3x), curs_kernel(3x), curs_term- - cap(3x), curs_variables(3x), term_variables(3x), putc(3), +
+ curses(3x), curs_initscr(3x), curs_kernel(3x), curs_term- + cap(3x), curs_variables(3x), term_variables(3x), putc(3), terminfo(5) curs_terminfo(3x)-