X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_termattrs.3x.html;h=0961c0b0a4c734179a7b757f4cb0812ac76b71e1;hp=21191777d9cc49c434ed022ca505535d81c69f66;hb=db5f7f4f146a91ba8ec7f1df8e9d7f9d2d7c74fd;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/curs_termattrs.3x.html b/doc/html/man/curs_termattrs.3x.html index 21191777..0961c0b0 100644 --- a/doc/html/man/curs_termattrs.3x.html +++ b/doc/html/man/curs_termattrs.3x.html @@ -1,134 +1,167 @@ + + + + + +curs_termattrs 3x + + + +

curs_termattrs 3x

-
+curs_termattrs(3x)                                   curs_termattrs(3x)
+
 
-
-

NAME

-       baudrate,  erasechar,  has_ic, has_il, killchar, longname,
-       termattrs, termname - curses environment query routines
-

SYNOPSIS

-       #include <curses.h>
+
NAME
+       baudrate, erasechar, erasewchar, has_ic, has_il, killchar,
+       killwchar, longname,  term_attrs,  termattrs,  termname  -
+       curses environment query routines
 
-       int baudrate(void);
-       char erasechar(void);
-       bool has_ic(void);
-       bool has_il(void);
-       char killchar(void);
-       char *longname(void);
-       attr_t termattrs(void);
-       char *termname(void);
+
+

+
SYNOPSIS
+       #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);
 
 
 

-
DESCRIPTION
-       The baudrate routine returns the output speed of the  ter-
-       minal.   The  number  returned  is in bits per second, for
-       example 9600, and is an integer.
+
DESCRIPTION
+       The  baudrate routine returns the output speed of the ter-
+       minal.  The number returned is in  bits  per  second,  for
+       example 9600, and is an integer.
 
-       The erasechar routine returns  the  user's  current  erase
+       The  erasechar  routine  returns  the user's current erase
        character.
 
-       The has_ic routine is true if the terminal has insert- and
+       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  ref-
+       erenced by ch is not changed.
+
+       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
+       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.
+       scrollok.
 
-       The killchar routine returns the user's current line  kill
+       The killchar routine returns the user's current line  kill
        character.
 
-       The  longname  routine  returns a pointer to a static area
-       containing a verbose description of the current  terminal.
+       The killwchar routine stores the current line-kill charac-
+       ter 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 verbose description of the current terminal.
        The maximum length of a verbose description is 128 charac-
-       ters.  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
+       ters.   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 terminals.
 
-       If a given terminal doesn't support a video attribute that
-       an  application  program is trying to use, curses may sub-
-       stitute a different video attribute for it.  The termattrs
-       function returns a logical OR of all video attributes sup-
-       ported by the terminal.  This information is useful when a
-       curses  program needs complete control over the appearance
-       of the screen.
+       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 ter-
+       mattrs 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   value   of   the
-       environmental  variable TERM (truncated to 14 characters).
+       The termname routine returns the  terminal  name  used  by
+       setupterm.
 
 
 

-
RETURN VALUE
-       longname and termname return NULL on error.
+
RETURN VALUE
+       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 completion.
+       Routines  that  return  an integer return ERR upon failure
+       and OK (SVr4 only specifies "an integer value  other  than
+       ERR") upon successful completion.
 
 
 

-
NOTES
-       Note that termattrs may be a macro.
+
NOTES
+       Note that termattrs may be a macro.
 
 
 

-
PORTABILITY
-       The XSI Curses standard, Issue  4  describes  these  func-
-       tions.  It changes the return type of termattrs to the new
-       type attr_t.
+
PORTABILITY
+       The  XSI  Curses  standard,  Issue 4 describes these func-
+       tions.  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.
 
 
 

-
SEE ALSO
-       curses(3x), curs_initscr(3x), curs_outopts(3x)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
SEE ALSO
+       curses(3x), curs_initscr(3x), curs_outopts(3x)
 
 
 
+                                                     curs_termattrs(3x)
 

-

-

-Man(1) output converted with
-man2html
-

+

+
+