+.\"***************************************************************************
+.\" Copyright 2018-2020,2021 Thomas E. Dickey *
+.\" Copyright 1998-2010,2015 Free Software Foundation, Inc. *
+.\" *
+.\" Permission is hereby granted, free of charge, to any person obtaining a *
+.\" copy of this software and associated documentation files (the *
+.\" "Software"), to deal in the Software without restriction, including *
+.\" without limitation the rights to use, copy, modify, merge, publish, *
+.\" distribute, distribute with modifications, sublicense, and/or sell *
+.\" copies of the Software, and to permit persons to whom the Software is *
+.\" furnished to do so, subject to the following conditions: *
+.\" *
+.\" The above copyright notice and this permission notice shall be included *
+.\" in all copies or substantial portions of the Software. *
+.\" *
+.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
+.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
+.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
+.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
+.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
+.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
+.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
+.\" *
+.\" Except as contained in this notice, the name(s) of the above copyright *
+.\" holders shall not be used in advertising or otherwise to promote the *
+.\" sale, use or other dealings in this Software without prior written *
+.\" authorization. *
+.\"***************************************************************************
+.\"
+.\" $Id: curs_termattrs.3x,v 1.18 2021/12/25 21:41:58 tom Exp $
.TH curs_termattrs 3X ""
.SH NAME
-\fBbaudrate\fR, \fBerasechar\fR, \fBhas_ic\fR,
-\fBhas_il\fR, \fBkillchar\fR, \fBlongname\fR, \fBtermattrs\fR,
-\fBtermname\fR - \fBcurses\fR environment query routines
+\fBbaudrate\fP,
+\fBerasechar\fP,
+\fBerasewchar\fP,
+\fBhas_ic\fP,
+\fBhas_il\fP,
+\fBkillchar\fP,
+\fBkillwchar\fP,
+\fBlongname\fP,
+\fBterm_attrs\fP,
+\fBtermattrs\fP,
+\fBtermname\fP \- \fBcurses\fP environment query routines
.SH SYNOPSIS
-\fB#include <curses.h>\fR
-
-\fBint baudrate(void);\fR
+\fB#include <curses.h>\fP
+.PP
+\fBint baudrate(void);\fP
.br
-\fBchar erasechar(void);\fR
+\fBchar erasechar(void);\fP
.br
-\fBint has_ic(void);\fR
+\fBint erasewchar(wchar_t *\fP\fIch\fP\fB);\fP
.br
-\fBint has_il(void);\fR
+\fBbool has_ic(void);\fP
.br
-\fBchar killchar(void);\fR
+\fBbool has_il(void);\fP
.br
-\fBchar *longname(void);\fR
+\fBchar killchar(void);\fP
.br
-\fBattr_t termattrs(void);\fR
+\fBint killwchar(wchar_t *\fP\fIch\fP\fB);\fP
.br
-\fBchar *termname(void);\fR
+\fBchar *longname(void);\fP
+.br
+\fBattr_t term_attrs(void);\fP
+.br
+\fBchtype termattrs(void);\fP
+.br
+\fBchar *termname(void);\fP
.br
.SH DESCRIPTION
-The \fBbaudrate\fR routine returns the output speed of the terminal. The
-number returned is in bits per second, for example \fB9600\fR, and is an
+.SS baudrate
+The \fBbaudrate\fP routine returns the output speed of the terminal.
+The
+number returned is in bits per second, for example \fB9600\fP, and is an
integer.
-
-The \fBerasechar\fR routine returns the user's current erase character.
-
-The \fBhas_ic\fR routine is true if the terminal has insert- and delete-
+.SS erasechar, erasewchar
+.PP
+The \fBerasechar\fP routine returns the user's current erase character.
+.PP
+The \fBerasewchar\fP routine stores the current erase character
+in the location referenced by \fIch\fP.
+If no erase character has been defined, the routine fails
+and the location referenced by \fIch\fP is not changed.
+.SS has_is, has_il
+.PP
+The \fBhas_ic\fP routine is true if the terminal has insert- and delete-
character capabilities.
-
-The \fBhas_il\fR routine is true if the terminal has insert- and delete-line
-capabilities, or can simulate them using scrolling regions. This might
+.PP
+The \fBhas_il\fP 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 \fBscrollok\fR.
-
-The \fBkillchar\fR routine returns the user's current line kill character.
-
-The \fBlongname\fR 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 \fBinitscr\fR or \fBnewterm\fR. The area is
-overwritten by each call to \fBnewterm\fR and is not restored by
-\fBset_term\fR, so the value should be saved between calls to
-\fBnewterm\fR if \fBlongname\fR is going to be used with multiple
+scrolling using \fBscrollok\fP.
+.SS killchar, killwchar
+.PP
+The \fBkillchar\fP routine returns the user's current line kill character.
+.PP
+The \fBkillwchar\fP routine stores the current line-kill character
+in the location referenced by \fIch\fP.
+If no line-kill character has been defined,
+the routine fails and the location referenced by \fIch\fP is not changed.
+.SS longname
+.PP
+The \fBlongname\fP 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 \fBinitscr\fP or \fBnewterm\fP. The area is
+overwritten by each call to \fBnewterm\fP and is not restored by
+\fBset_term\fP, so the value should be saved between calls to
+\fBnewterm\fP if \fBlongname\fP 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, \fBcurses\fR may substitute a
-different video attribute for it. The \fBtermattrs\fR function
-returns a logical \fBOR\fR of all video attributes supported by the
-terminal. This information is useful when a \fBcurses\fR program
+.SS termattrs, term_attrs
+.PP
+If a given terminal does not support a video attribute that an
+application program is trying to use, \fBcurses\fP may substitute a
+different video attribute for it.
+The \fBtermattrs\fP and \fBterm_attrs\fP functions
+return a logical \fBOR\fP of all video attributes supported by the
+terminal using \fBA_\fP and \fBWA_\fP constants respectively.
+This information is useful when a \fBcurses\fP program
needs complete control over the appearance of the screen.
-
-The \fBtermname\fR routine returns the value of the environmental
-variable \fBTERM\fR (truncated to 14 characters).
+.SS termname
+.PP
+The \fBtermname\fP routine returns the terminal name used by \fBsetupterm\fP.
.SH RETURN VALUE
-\fBlongname\fR and \fBtermname\fR return \fBNULL\fR on error.
-
-Routines that return an integer return \fBERR\fR upon failure and \fBOK\fR
-(SVr4 only specifies "an integer value other than \fBERR\fR") upon successful
+\fBlongname\fP and \fBtermname\fP return \fBNULL\fP on error.
+.PP
+Routines that return an integer return \fBERR\fP upon failure and \fBOK\fP
+(SVr4 only specifies "an integer value other than \fBERR\fP") upon successful
completion.
.SH NOTES
-Note that \fBtermattrs\fR may be a macro.
+Note that \fBtermattrs\fP may be a macro.
.SH PORTABILITY
-The XSI Curses standard, Issue 4 describes these functions. It changes the
-return type of \fBtermattrs\fR to the new type \fBattr_t\fR.
+The XSI Curses standard, Issue 4 describes these functions.
+It changes the
+return type of \fBtermattrs\fP to the new type \fBattr_t\fP.
+Most versions of curses truncate the result returned by \fBtermname\fP to
+14 characters.
.SH SEE ALSO
-\fBcurses\fR(3X), \fBcurs_initscr\fR(3X), \fBcurs_outopts\fR(3X)
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End:
+\fBcurses\fP(3X), \fBcurs_initscr\fP(3X), \fBcurs_outopts\fP(3X)
projects / ncurses.git / blobdiff