ncurses 5.3

[ncurses.git] / man / curs_termattrs.3x

diff --git a/man/curs_termattrs.3x b/man/curs_termattrs.3x
index 3938bc0f0326ed236cbdb513259216c701358b97..d285b8663345c97c0333662e18fcdbaab5d36c80 100644 (file)
--- a/man/curs_termattrs.3x
+++ b/man/curs_termattrs.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 1998,2000 Free Software Foundation, Inc.                   *
+.\" Copyright (c) 1998-2000,2002 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            *
@@ -26,11 +26,19 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_termattrs.3x,v 1.6 2000/07/08 12:53:34 tom Exp $
+.\" $Id: curs_termattrs.3x,v 1.8 2002/05/11 21:32:26 tom Exp $
 .TH curs_termattrs 3X ""
 .SH NAME
-\fBbaudrate\fR, \fBerasechar\fR, \fBhas_ic\fR,
-\fBhas_il\fR, \fBkillchar\fR, \fBlongname\fR, \fBtermattrs\fR,
+\fBbaudrate\fR,
+\fBerasechar\fR,
+\fBerasewchar\fR,
+\fBhas_ic\fR,
+\fBhas_il\fR,
+\fBkillchar\fR,
+\fBkillwchar\fR,
+\fBlongname\fR,
+\fBterm_attrs\fR,
+\fBtermattrs\fR,
 \fBtermname\fR - \fBcurses\fR environment query routines
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
@@ -39,15 +47,21 @@
 .br
 \fBchar erasechar(void);\fR
 .br
+\fBint erasewchar(wchar_t *\fR\fIch\fR\fB);\fR
+.br
 \fBbool has_ic(void);\fR
 .br
 \fBbool has_il(void);\fR
 .br
 \fBchar killchar(void);\fR
 .br
+\fBint killwchar(wchar_t *\fR\fIch\fR\fB);\fR
+.br
 \fBchar *longname(void);\fR
 .br
-\fBattr_t termattrs(void);\fR
+\fBattr_t term_attrs(void);\fR
+.br
+\fBchtype termattrs(void);\fR
 .br
 \fBchar *termname(void);\fR
 .br
@@ -58,6 +72,11 @@ integer.
 
 The \fBerasechar\fR routine returns the user's current erase character.
 
+The \fBerasewchar\fR routine stores the current erase character
+in the location referenced by \fIch\fR.
+If no erase character has been defined, the routine fails
+and the location referenced by \fIch\fR is not changed.
+
 The \fBhas_ic\fR routine is true if the terminal has insert- and delete-
 character capabilities.
 
@@ -68,6 +87,11 @@ scrolling using \fBscrollok\fR.
 
 The \fBkillchar\fR routine returns the user's current line kill character.
 
+The \fBkillwchar\fR routine stores the current line-kill character
+in the location referenced by \fIch\fR.
+If no line-kill character has been defined,
+the routine fails and the location referenced by \fIch\fR is not changed.
+
 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
@@ -79,9 +103,11 @@ 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
+different video attribute for it.
+The \fBtermattrs\fR and \fBterm_attrs\fR functions
+return a logical \fBOR\fR of all video attributes supported by the
+terminal using \fIA_\fR and \fIWA_\fR constants respectively.
+This information is useful when a \fBcurses\fR program
 needs complete control over the appearance of the screen.
 
 The \fBtermname\fR routine returns the value of the environmental