X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_terminfo.3x.html;h=3a9dee267ba2285fbfc34cf772ed327b31acebca;hp=68774963860b70a9eb53077e21b2fd64be63efd6;hb=761e4f0825b330e970558e82a4bd638383914429;hpb=f6718d80c998008de6cfe8e6296bee3958ff86d7 diff --git a/doc/html/man/curs_terminfo.3x.html b/doc/html/man/curs_terminfo.3x.html index 68774963..3a9dee26 100644 --- a/doc/html/man/curs_terminfo.3x.html +++ b/doc/html/man/curs_terminfo.3x.html @@ -1,7 +1,7 @@ - +
@@ -48,9 +48,9 @@del_curterm, mvcur, putp, restartterm, set_curterm, - setterm, setupterm, tigetflag, tigetnum, tigetstr, tparm, - tputs, vid_attr, vid_puts, vidattr, vidputs - curses - interfaces to terminfo database + setterm, setupterm, tigetflag, tigetnum, tigetstr, tiparm, + tparm, tputs, vid_attr, vid_puts, vidattr, vidputs - + curses interfaces to terminfo database@@ -68,12 +68,13 @@ int putp(const char *str); int vidputs(chtype attrs, int (*putc)(int)); int vidattr(chtype attrs); - int vid_puts(attr_t attrs, short pair, void *opts, int (*putc)(char)); + int vid_puts(attr_t attrs, short pair, void *opts, int (*putc)(int)); int vid_attr(attr_t attrs, short pair, void *opts); int mvcur(int oldrow, int oldcol, int newrow, int newcol); int tigetflag(char *capname); int tigetnum(char *capname); char *tigetstr(char *capname); + char *tiparm(const char *str, ...); @@ -180,6 +181,10 @@ ters pi. A pointer is returned to the result of str with the parameters applied. + tiparm is a newer form of tparm which uses <stdarg.h> + rather than a fixed-parameter list. Its numeric parame- + ters are integers (int) rather than longs. + 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, @@ -253,11 +258,11 @@ 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. @@ -267,23 +272,23 @@ tupterm returns an error. setupterm - returns an error if it cannot allocate enough + returns an error if it cannot allocate enough memory, or create the initial windows (stdscr, - curscr, newscr). Other error conditions are + 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.
- The setupterm routine should be used in place of setterm. - It may be useful when you want to test for terminal capa- - bilities without committing to the allocation of storage + The setupterm routine should be used in place of setterm. + It may be useful when you want to test for terminal capa- + bilities without committing to the allocation of storage involved in initscr. Note that vidattr and vidputs may be macros. @@ -291,54 +296,59 @@
- 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. - 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. Portable ap- + 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. - 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- + In response to comments by Thomas E. Dickey, X/Open Curses + Issue 7 proposed the tiparam 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- 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. - Extended terminal capability names, e.g., as defined by - tic -x, are not stored in the arrays described in this + Extended terminal capability names, e.g., as defined by + tic -x, are not stored in the arrays described in this section.
- curses(3x), curs_initscr(3x), curs_kernel(3x), curs_term- - cap(3x), putc(3), terminfo(5) + curses(3x), curs_initscr(3x), curs_kernel(3x), curs_term- + cap(3x), curs_variables(3x), term_variables(3x), putc(3), + terminfo(5)