ncurses 6.5 - patch 20240511

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

diff --git a/man/curs_termattrs.3x b/man/curs_termattrs.3x
index 8df5e357c07e3fd49e9c084b2f16cbe6d4e657cc..019522e74a92fc6b71c4007c5a99cace57e64562 100644 (file)
--- a/man/curs_termattrs.3x
+++ b/man/curs_termattrs.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright 2018-2022,2023 Thomas E. Dickey                                *
+.\" Copyright 2018-2023,2024 Thomas E. Dickey                                *

 .\" Copyright 1998-2010,2015 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" Copyright 1998-2010,2015 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *


@@ -27,8 +27,8 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_termattrs.3x,v 1.31 2023/10/07 21:19:07 tom Exp $
-.TH curs_termattrs 3X 2023-10-07 "ncurses 6.4" "Library calls"
+.\" $Id: curs_termattrs.3x,v 1.42 2024/05/11 20:39:53 tom Exp $
+.TH curs_termattrs 3X 2024-05-11 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"

 .SH NAME
 \fB\%baudrate\fP,
 \fB\%erasechar\fP,
 .SH NAME
 \fB\%baudrate\fP,
 \fB\%erasechar\fP,


@@ -41,18 +41,18 @@
 \fB\%term_attrs\fP,
 \fB\%termattrs\fP,
 \fB\%termname\fP \-
 \fB\%term_attrs\fP,
 \fB\%termattrs\fP,
 \fB\%termname\fP \-

-\fIcurses\fR environment query routines
+get and set terminal attributes with \fIcurses\fP

 .SH SYNOPSIS
 .nf
 \fB#include <curses.h>
 .PP
 \fBint baudrate(void);
 \fBchar erasechar(void);
 .SH SYNOPSIS
 .nf
 \fB#include <curses.h>
 .PP
 \fBint baudrate(void);
 \fBchar erasechar(void);

-\fBint erasewchar(wchar_t *\fIch\fP);
+\fBint erasewchar(wchar_t *\fIwc\fP);

 \fBbool has_ic(void);
 \fBbool has_il(void);
 \fBchar killchar(void);
 \fBbool has_ic(void);
 \fBbool has_il(void);
 \fBchar killchar(void);

-\fBint killwchar(wchar_t *\fIch\fP);
+\fBint killwchar(wchar_t *\fIwc\fP);

 \fBchar *longname(void);
 \fBattr_t term_attrs(void);
 \fBchtype termattrs(void);
 \fBchar *longname(void);
 \fBattr_t term_attrs(void);
 \fBchtype termattrs(void);


@@ -64,14 +64,14 @@ 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
 number returned is in bits per second, for example \fB9600\fP, and is an
 integer.

-.SS erasechar, erasewchar
+.SS "erasechar, erasewchar"

 The \fBerasechar\fP routine returns the user's current erase character.
 .PP
 The \fBerasewchar\fP routine stores the current erase character
 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.
+in the location referenced by \fIwc\fP.

 If no erase character has been defined, the routine fails
 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
+and the location referenced by \fIwc\fP is not changed.
+.SS "has_ic, has_il"

 The \fBhas_ic\fP routine is true if the terminal has insert- and delete-
 character capabilities.
 .PP
 The \fBhas_ic\fP routine is true if the terminal has insert- and delete-
 character capabilities.
 .PP


@@ -80,13 +80,13 @@ 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\fP(3X).
 This might
 be used to determine if it would be appropriate to turn on physical
 scrolling using \fBscrollok\fP(3X).

-.SS killchar, killwchar
+.SS "killchar, killwchar"

 The \fBkillchar\fP routine returns the user's current line kill character.
 .PP
 The \fBkillwchar\fP routine stores the current line-kill character
 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.
+in the location referenced by \fIwc\fP.

 If no line-kill character has been defined,
 If no line-kill character has been defined,

-the routine fails and the location referenced by \fIch\fP is not changed.
+the routine fails and the location referenced by \fIwc\fP is not changed.

 .SS longname
 The \fBlongname\fP routine returns a pointer to a static area
 containing a verbose description of the current terminal.
 .SS longname
 The \fBlongname\fP routine returns a pointer to a static area
 containing a verbose description of the current terminal.


@@ -98,7 +98,7 @@ 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.
 \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.

-.SS termattrs, term_attrs
+.SS "termattrs, term_attrs"

 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.
 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.


@@ -118,7 +118,7 @@ completion.
 .SH NOTES
 Note that \fBtermattrs\fP may be a macro.
 .SH PORTABILITY
 .SH NOTES
 Note that \fBtermattrs\fP may be a macro.
 .SH PORTABILITY

-The XSI Curses standard, Issue 4 describes these functions.
+X/Open Curses, 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
 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