X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_termattrs.3x.html;h=da6091c7dedd39fe928e9402baabf6ffe4b7933c;hb=81304798ee736c467839c779c9ca5dca48db7bea;hp=5593ed0d3b32398e9131223cff96b2efeacfada5;hpb=9f479192e3ca3413d235c66bf058f8cc63764898;p=ncurses.git diff --git a/doc/html/man/curs_termattrs.3x.html b/doc/html/man/curs_termattrs.3x.html index 5593ed0d..da6091c7 100644 --- a/doc/html/man/curs_termattrs.3x.html +++ b/doc/html/man/curs_termattrs.3x.html @@ -34,122 +34,122 @@
--curs_termattrs(3X) curs_termattrs(3X) +curs_termattrs(3x) curs_termattrs(3x)
- baudrate, erasechar, erasewchar, has_ic, has_il, killchar, killwchar, - longname, term_attrs, termattrs, termname - curses environment query + baudrate, erasechar, erasewchar, has_ic, has_il, killchar, killwchar, + longname, term_attrs, termattrs, termname - curses environment query routines
- #include <curses.h> + #include <curses.h> - int baudrate(void); - char erasechar(void); - int erasewchar(wchar_t *ch); - bool has_ic(void); - bool has_il(void); - char killchar(void); - int killwchar(wchar_t *ch); - char *longname(void); - attr_t term_attrs(void); - chtype termattrs(void); - char *termname(void); + int baudrate(void); + char erasechar(void); + int erasewchar(wchar_t *ch); + bool has_ic(void); + bool has_il(void); + char killchar(void); + int killwchar(wchar_t *ch); + char *longname(void); + attr_t term_attrs(void); + chtype termattrs(void); + char *termname(void);
- The baudrate routine returns the output speed of the terminal. The - number returned is in bits per second, for example 9600, and is an + The baudrate routine returns the output speed of the terminal. The + number returned is in bits per second, for example 9600, and is an integer.
- The erasechar routine returns the user's current erase character. + The erasechar routine returns the user's current erase character. - The erasewchar routine stores the current erase character in the - location referenced by ch. If no erase character has been defined, the - routine fails and the location referenced by ch is not changed. + The erasewchar routine stores the current erase character in the + location referenced by ch. If no erase character has been defined, the + routine fails and the location referenced by ch is not changed.
- The has_ic routine is true if the terminal has insert- and delete- + The has_ic routine is true if the terminal has insert- and delete- character capabilities. - The has_il routine is true if the terminal has insert- and delete-line + The has_il routine is true if the terminal has insert- and delete-line capabilities, or can simulate them using scrolling regions. This might be used to determine if it would be appropriate to turn on physical - scrolling using scrollok. + scrolling using scrollok.
- The killchar routine returns the user's current line kill character. + The killchar routine returns the user's current line kill character. - The killwchar routine stores the current line-kill character in the - location referenced by ch. If no line-kill character has been defined, - the routine fails and the location referenced by ch is not changed. + The killwchar routine stores the current line-kill character in the + location referenced by ch. If no line-kill character has been defined, + the routine fails and the location referenced by ch is not changed.
- The longname routine returns a pointer to a static area containing a + The longname routine returns a pointer to a static area containing a verbose description of the current terminal. The maximum length of a verbose description is 128 characters. It is defined only after the - call to initscr or newterm. The area is overwritten by each call to - newterm and is not restored by set_term, so the value should be saved - between calls to newterm if longname is going to be used with multiple + call to initscr or newterm. The area is overwritten by each call to + newterm and is not restored by set_term, so the value should be saved + between calls to newterm if longname is going to be used with multiple terminals.
If a given terminal does not support a video attribute that an - application program is trying to use, curses may substitute a different - video attribute for it. The termattrs and term_attrs functions return - a logical OR of all video attributes supported by the terminal using A_ - and WA_ constants respectively. This information is useful when a - curses program needs complete control over the appearance of the + application program is trying to use, curses may substitute a different + video attribute for it. The termattrs and term_attrs functions return + a logical OR of all video attributes supported by the terminal using A_ + and WA_ constants respectively. This information is useful when a + curses program needs complete control over the appearance of the screen.
- The termname routine returns the terminal name used by setupterm. + The termname routine returns the terminal name used by setupterm.
- longname and termname return NULL on error. + longname and termname return NULL on error. - Routines that return an integer return ERR upon failure and OK (SVr4 - only specifies "an integer value other than ERR") upon successful + Routines that return an integer return ERR upon failure and OK (SVr4 + only specifies "an integer value other than ERR") upon successful completion.
- Note that termattrs may be a macro. + Note that termattrs may be a macro.
The XSI Curses standard, Issue 4 describes these functions. It changes - the return type of termattrs to the new type attr_t. Most versions of - curses truncate the result returned by termname to 14 characters. + the return type of termattrs to the new type attr_t. Most versions of + curses truncate the result returned by termname to 14 characters.
- curses(3X), curs_initscr(3X), curs_outopts(3X) + curses(3x), curs_initscr(3x), curs_outopts(3x) - curs_termattrs(3X) + curs_termattrs(3x)