src - FreeBSD source tree

diff options


context:
space:
mode:

author	Baptiste Daroussin <bapt@FreeBSD.org>	2020-02-07 08:36:41 +0000
committer	Baptiste Daroussin <bapt@FreeBSD.org>	2020-02-07 08:36:41 +0000
commit	f0179cb6083cc92e5947ae56e6a0a5c5328aead0 (patch)
tree	bcee0ba9c2149b71f0bfc036df1e61e3105bf980 /doc/html/man/curs_termattrs.3x.html
parent	cea297eb34d2361e79529034397465068ae34ecd (diff)
download	src-f0179cb6083cc92e5947ae56e6a0a5c5328aead0.tar.gz src-f0179cb6083cc92e5947ae56e6a0a5c5328aead0.zip

Vendor import ncurses 6.1-20200118vendor/ncurses/6.1-20200118

Notes

Notes: svn path=/vendor/ncurses/dist/; revision=357645 svn path=/vendor/ncurses/6.1-20200118/; revision=357646; tag=vendor/ncurses/6.1-20200118

Diffstat (limited to 'doc/html/man/curs_termattrs.3x.html')

-rw-r--r--

doc/html/man/curs_termattrs.3x.html

187

1 files changed, 100 insertions, 87 deletions

diff --git a/doc/html/man/curs_termattrs.3x.html b/doc/html/man/curs_termattrs.3x.html
index 54a73dfc1d66..bdee4a11ef9f 100644
--- a/doc/html/man/curs_termattrs.3x.html
+++ b/doc/html/man/curs_termattrs.3x.html

@@ -1,7 +1,6 @@

-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">

<!--

****************************************************************************

* *

* Permission is hereby granted, free of charge, to any person obtaining a *

* copy of this software and associated documentation files (the *

@@ -27,33 +26,32 @@

* sale, use or other dealings in this Software without prior written *

* authorization. *

****************************************************************************

- * @Id: curs_termattrs.3x,v 1.12 2010/12/04 18:40:45 tom Exp @

+ * @Id: curs_termattrs.3x,v 1.14 2018/07/28 21:34:06 tom Exp @

-->

+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">

<HTML>

<HEAD>

+<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">

+<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">

<TITLE>curs_termattrs 3x</TITLE>

-<link rev=made href="mailto:bug-ncurses@gnu.org">

+<link rel="author" href="mailto:bug-ncurses@gnu.org">

</HEAD>

<BODY>

-<H1>curs_termattrs 3x</H1>

-<HR>

+<H1 class="no-header">curs_termattrs 3x</H1>

<PRE>

-

-<STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG> <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>

+<STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG> <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>

-</PRE>

-<H2>NAME</H2><PRE>

- <STRONG>baudrate</STRONG>, <STRONG>erasechar</STRONG>, <STRONG>erasewchar</STRONG>, <STRONG>has_ic</STRONG>, <STRONG>has_il</STRONG>, <STRONG>killchar</STRONG>,

- <STRONG>killwchar</STRONG>, <STRONG>longname</STRONG>, <STRONG>term_attrs</STRONG>, <STRONG>termattrs</STRONG>, <STRONG>termname</STRONG> -

- <STRONG>curses</STRONG> environment query routines

+</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>

+ <STRONG>baudrate</STRONG>, <STRONG>erasechar</STRONG>, <STRONG>erasewchar</STRONG>, <STRONG>has_ic</STRONG>, <STRONG>has_il</STRONG>, <STRONG>killchar</STRONG>, <STRONG>killwchar</STRONG>,

+ <STRONG>longname</STRONG>, <STRONG>term_attrs</STRONG>, <STRONG>termattrs</STRONG>, <STRONG>termname</STRONG> - <STRONG>curses</STRONG> environment query

+ routines

-</PRE>

-<H2>SYNOPSIS</H2><PRE>

+</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>

<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>

<STRONG>int</STRONG> <STRONG>baudrate(void);</STRONG>

@@ -69,93 +67,108 @@

<STRONG>char</STRONG> <STRONG>*termname(void);</STRONG>

-</PRE>

-<H2>DESCRIPTION</H2><PRE>

- The <STRONG>baudrate</STRONG> routine returns the output speed of the ter-

- minal. The number returned is in bits per second, for

- example <STRONG>9600</STRONG>, and is an integer.

- The <STRONG>erasechar</STRONG> routine returns the user's current erase

- character.

- The <STRONG>erasewchar</STRONG> routine stores the current erase character

- in the location referenced by <EM>ch</EM>. If no erase character

- has been defined, the routine fails and the location ref-

- erenced by <EM>ch</EM> is not changed.

- The <STRONG>has_ic</STRONG> routine is true if the terminal has insert- and

- delete- character capabilities.

- The <STRONG>has_il</STRONG> 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

- <STRONG>scrollok</STRONG>.

- The <STRONG>killchar</STRONG> routine returns the user's current line kill

- character.

- The <STRONG>killwchar</STRONG> routine stores the current line-kill charac-

- ter in the location referenced by <EM>ch</EM>. If no line-kill

- character has been defined, the routine fails and the

- location referenced by <EM>ch</EM> is not changed.

- The <STRONG>longname</STRONG> 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 <STRONG>initscr</STRONG> or

- <STRONG>newterm</STRONG>. The area is overwritten by each call to <STRONG>newterm</STRONG>

- and is not restored by <STRONG>set_term</STRONG>, so the value should be

- saved between calls to <STRONG>newterm</STRONG> if <STRONG>longname</STRONG> 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, <STRONG>curses</STRONG> may

- substitute a different video attribute for it. The <STRONG>ter-</STRONG>

- <STRONG>mattrs</STRONG> and <STRONG>term_attrs</STRONG> functions return a logical <STRONG>OR</STRONG> of all

- video attributes supported by the terminal using <EM>A</EM><STRONG>_</STRONG> and

- <EM>WA</EM><STRONG>_</STRONG> constants respectively. This information is useful

- when a <STRONG>curses</STRONG> program needs complete control over the

- appearance of the screen.

- The <STRONG>termname</STRONG> routine returns the terminal name used by

- <STRONG>setupterm</STRONG>.

+</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>

+</PRE><H3><a name="h3-baudrate">baudrate</a></H3><PRE>

+ The <STRONG>baudrate</STRONG> routine returns the output speed of the terminal. The

+ number returned is in bits per second, for example <STRONG>9600</STRONG>, and is an

+ integer.

-</PRE>

-<H2>RETURN VALUE</H2><PRE>

+</PRE><H3><a name="h3-erasechar_-erasewchar">erasechar, erasewchar</a></H3><PRE>

+ The <STRONG>erasechar</STRONG> routine returns the user's current erase character.

+ The <STRONG>erasewchar</STRONG> routine stores the current erase character in the loca-

+ tion referenced by <EM>ch</EM>. If no erase character has been defined, the

+ routine fails and the location referenced by <EM>ch</EM> is not changed.

+</PRE><H3><a name="h3-has_is_-has_il">has_is, has_il</a></H3><PRE>

+ The <STRONG>has_ic</STRONG> routine is true if the terminal has insert- and delete-

+ character capabilities.

+ The <STRONG>has_il</STRONG> 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 <STRONG>scrollok</STRONG>.

+</PRE><H3><a name="h3-killchar_-killwchar">killchar, killwchar</a></H3><PRE>

+ The <STRONG>killchar</STRONG> routine returns the user's current line kill character.

+ The <STRONG>killwchar</STRONG> routine stores the current line-kill character in the

+ location referenced by <EM>ch</EM>. If no line-kill character has been defined,

+ the routine fails and the location referenced by <EM>ch</EM> is not changed.

+</PRE><H3><a name="h3-longname">longname</a></H3><PRE>

+ The <STRONG>longname</STRONG> 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 <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG>. The area is overwritten by each call to

+ <STRONG>newterm</STRONG> and is not restored by <STRONG>set_term</STRONG>, so the value should be saved

+ between calls to <STRONG>newterm</STRONG> if <STRONG>longname</STRONG> is going to be used with multiple

+ terminals.

+</PRE><H3><a name="h3-termattrs_-term_attrs">termattrs, term_attrs</a></H3><PRE>

+ If a given terminal does not support a video attribute that an applica-

+ tion program is trying to use, <STRONG>curses</STRONG> may substitute a different video

+ attribute for it. The <STRONG>termattrs</STRONG> and <STRONG>term_attrs</STRONG> functions return a log-

+ ical <STRONG>OR</STRONG> of all video attributes supported by the terminal using <EM>A</EM><STRONG>_</STRONG> and

+ <EM>WA</EM><STRONG>_</STRONG> constants respectively. This information is useful when a <STRONG>curses</STRONG>

+ program needs complete control over the appearance of the screen.

+</PRE><H3><a name="h3-termname">termname</a></H3><PRE>

+ The <STRONG>termname</STRONG> routine returns the terminal name used by <STRONG>setupterm</STRONG>.

+</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>

<STRONG>longname</STRONG> and <STRONG>termname</STRONG> return <STRONG>NULL</STRONG> on error.

- Routines that return an integer return <STRONG>ERR</STRONG> upon failure

- and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than

- <STRONG>ERR</STRONG>") upon successful completion.

+ Routines that return an integer return <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> (SVr4

+ only specifies "an integer value other than <STRONG>ERR</STRONG>") upon successful com-

+ pletion.

-</PRE>

-<H2>NOTES</H2><PRE>

+</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>

Note that <STRONG>termattrs</STRONG> may be a macro.

-</PRE>

-<H2>PORTABILITY</H2><PRE>

- The XSI Curses standard, Issue 4 describes these func-

- tions. It changes the return type of <STRONG>termattrs</STRONG> to the new

- type <STRONG>attr_t</STRONG>. Most versions of curses truncate the result

- returned by <STRONG>termname</STRONG> to 14 characters.

+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>

+ The XSI Curses standard, Issue 4 describes these functions. It changes

+ the return type of <STRONG>termattrs</STRONG> to the new type <STRONG>attr_t</STRONG>. Most versions of

+ curses truncate the result returned by <STRONG>termname</STRONG> to 14 characters.

-</PRE>

-<H2>SEE ALSO</H2><PRE>

+</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>

<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>

- <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>

+ <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>

</PRE>

-<HR>

-<ADDRESS>

-Man(1) output converted with

-<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>

-</ADDRESS>

+<div class="nav">

+<ul>

+<li><a href="#h2-NAME">NAME</a></li>

+<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>

+<li><a href="#h2-DESCRIPTION">DESCRIPTION</a>

+<ul>

+<li><a href="#h3-baudrate">baudrate</a></li>

+<li><a href="#h3-erasechar_-erasewchar">erasechar, erasewchar</a></li>

+<li><a href="#h3-has_is_-has_il">has_is, has_il</a></li>

+<li><a href="#h3-killchar_-killwchar">killchar, killwchar</a></li>

+<li><a href="#h3-longname">longname</a></li>

+<li><a href="#h3-termattrs_-term_attrs">termattrs, term_attrs</a></li>

+<li><a href="#h3-termname">termname</a></li>

+</ul>

+</li>

+<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>

+<li><a href="#h2-NOTES">NOTES</a></li>

+<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>

+<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>

+</ul>

+</div>

</BODY>

</HTML>