<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<!--
****************************************************************************
- * Copyright (c) 1998-2001,2002 Free Software Foundation, Inc. *
+ * Copyright (c) 1998-2005,2006 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 *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_termcap.3x,v 1.16 2002/02/16 19:26:41 tom Exp @
+ * @Id: curs_termcap.3x,v 1.20 2006/02/25 21:50:01 tom Exp @
-->
<HTML>
<HEAD>
<HR>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
+<STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG> <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG>
+
+
+
</PRE>
<H2>NAME</H2><PRE>
<H2>SYNOPSIS</H2><PRE>
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
<STRONG>#include</STRONG> <STRONG><term.h></STRONG>
- <STRONG>extern</STRONG> <STRONG>char</STRONG> <STRONG>PC;</STRONG> <STRONG>extern</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>UP;</STRONG> <STRONG>extern</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>BC;</STRONG> <STRONG>extern</STRONG>
- <STRONG>short</STRONG> <STRONG>ospeed;</STRONG>
+
+ <STRONG>extern</STRONG> <STRONG>char</STRONG> <STRONG>PC;</STRONG>
+ <STRONG>extern</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>UP;</STRONG>
+ <STRONG>extern</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>BC;</STRONG>
+ <STRONG>extern</STRONG> <STRONG>short</STRONG> <STRONG>ospeed;</STRONG>
+
<STRONG>int</STRONG> <STRONG>tgetent(char</STRONG> <STRONG>*bp,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*name);</STRONG>
<STRONG>int</STRONG> <STRONG>tgetflag(char</STRONG> <STRONG>*id);</STRONG>
<STRONG>int</STRONG> <STRONG>tgetnum(char</STRONG> <STRONG>*id);</STRONG>
</PRE>
<H2>DESCRIPTION</H2><PRE>
- These routines are included as a conversion aid for pro-
- grams that use the <EM>termcap</EM> library. Their parameters are
- the same and the routines are emulated using the <EM>terminfo</EM>
- database. Thus, they can only be used to query the capa-
- bilities of entries for which a terminfo entry has been
+ These routines are included as a conversion aid for pro-
+ grams that use the <EM>termcap</EM> library. Their parameters are
+ the same and the routines are emulated using the <EM>terminfo</EM>
+ database. Thus, they can only be used to query the capa-
+ bilities of entries for which a terminfo entry has been
compiled.
- The <STRONG>tgetent</STRONG> routine loads the entry for <EM>name</EM>. It returns
- 1 on success, 0 if there is no such entry, and -1 if the
- terminfo database could not be found. The emulation
+ The <STRONG>tgetent</STRONG> routine loads the entry for <EM>name</EM>. It returns
+ 1 on success, 0 if there is no such entry, and -1 if the
+ terminfo database could not be found. The emulation
ignores the buffer pointer <EM>bp</EM>.
- The <STRONG>tgetflag</STRONG> routine gets the boolean entry for <EM>id</EM>, or
+ The <STRONG>tgetflag</STRONG> routine gets the boolean entry for <EM>id</EM>, or
zero if it is not available.
- The <STRONG>tgetnum</STRONG> routine gets the numeric entry for <EM>id</EM>, or -1
+ The <STRONG>tgetnum</STRONG> routine gets the numeric entry for <EM>id</EM>, or -1
if it is not available.
- The <STRONG>tgetstr</STRONG> routine returns the string entry for <EM>id</EM>, or
- zero if it is not available. Use <STRONG>tputs</STRONG> to output the
- returned string. The return value will also be copied to
- the buffer pointed to by <EM>area</EM>, and the <EM>area</EM> value will be
+ The <STRONG>tgetstr</STRONG> routine returns the string entry for <EM>id</EM>, or
+ zero if it is not available. Use <STRONG>tputs</STRONG> to output the
+ returned string. The return value will also be copied to
+ the buffer pointed to by <EM>area</EM>, and the <EM>area</EM> value will be
updated to point past the null ending this value.
Only the first two characters of the <STRONG>id</STRONG> parameter of <STRONG>tget-</STRONG>
<STRONG>flag</STRONG>, <STRONG>tgetnum</STRONG> and <STRONG>tgetstr</STRONG> are compared in lookups.
- The <STRONG>tgoto</STRONG> routine instantiates the parameters into the
- given capability. The output from this routine is to be
+ The <STRONG>tgoto</STRONG> routine instantiates the parameters into the
+ given capability. The output from this routine is to be
passed to <STRONG>tputs</STRONG>.
- The
<STRONG>tputs</STRONG> routine is described on the <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
+ The
<STRONG>tputs</STRONG> routine is described on the <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
manual page. It can retrieve capabilities by either term-
cap or terminfo name.
The variables <STRONG>PC</STRONG>, <STRONG>UP</STRONG> and <STRONG>BC</STRONG> are set by <STRONG>tgetent</STRONG> to the ter-
minfo entry's data for <STRONG>pad_char</STRONG>, <STRONG>cursor_up</STRONG> and
- <STRONG>backspace_if_not_bs</STRONG>, respectively. <STRONG>UP</STRONG> is not used by
+ <STRONG>backspace_if_not_bs</STRONG>, respectively. <STRONG>UP</STRONG> is not used by
ncurses. <STRONG>PC</STRONG> is used in the <STRONG>tdelay_output</STRONG> function. <STRONG>BC</STRONG> is
- used in the <STRONG>tgoto</STRONG> emulation. The variable <STRONG>ospeed</STRONG> is set
- by ncurses in a system-specific coding to reflect the ter-
- minal speed.
-
+ used in the <STRONG>tgoto</STRONG> emulation. The variable <STRONG>ospeed</STRONG> is set
+ by ncurses in a system-specific coding to reflect the
+ terminal speed.
</PRE>
<H2>RETURN VALUE</H2><PRE>
- Except where explicitly noted, routines that return an
- integer return <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> (SVr4 only speci-
- fies "an integer value other than <STRONG>ERR</STRONG>") upon successful
+ Except where explicitly noted, routines that return an
+ integer return <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> (SVr4 only speci-
+ fies "an integer value other than <STRONG>ERR</STRONG>") upon successful
completion.
Routines that return pointers return <STRONG>NULL</STRONG> on error.
</PRE>
<H2>BUGS</H2><PRE>
If you call <STRONG>tgetstr</STRONG> to fetch <STRONG>ca</STRONG> or any other parameterized
- string, be aware that it will be returned in terminfo
- notation, not the older and not-quite-compatible termcap
+ string, be aware that it will be returned in terminfo
+ notation, not the older and not-quite-compatible termcap
notation. This won't cause problems if all you do with it
- is call <STRONG>tgoto</STRONG> or <STRONG>tparm</STRONG>, which both expand terminfo-style
- strings as terminfo. (The <STRONG>tgoto</STRONG> function, if configured
- to support termcap, will check if the string is indeed
- terminfo-style by looking for "%p" parameters or "$<..>"
- delays, and invoke a termcap-style parser if the string
+ is call <STRONG>tgoto</STRONG> or <STRONG>tparm</STRONG>, which both expand terminfo-style
+ strings as terminfo. (The <STRONG>tgoto</STRONG> function, if configured
+ to support termcap, will check if the string is indeed
+ terminfo-style by looking for "%p" parameters or "$<..>"
+ delays, and invoke a termcap-style parser if the string
does not appear to be terminfo).
- Because terminfo conventions for representing padding in
- string capabilities differ from termcap's, <STRONG>tputs("50");</STRONG>
- will put out a literal "50" rather than busy-waiting for
+ Because terminfo conventions for representing padding in
+ string capabilities differ from termcap's, <STRONG>tputs("50");</STRONG>
+ will put out a literal "50" rather than busy-waiting for
50 milliseconds. Cope with it.
+ Note that termcap has nothing analogous to terminfo's <STRONG>sgr</STRONG>
+ string. One consequence of this is that termcap applica-
+ tions assume me (terminfo <STRONG>sgr0</STRONG>) does not reset the alter-
+ nate character set. This implementation checks for, and
+ modifies the data shown to the termcap interface to accom-
+ modate termcap's limitation in this respect.
+
</PRE>
<H2>PORTABILITY</H2><PRE>
</PRE>
<H2>SEE ALSO</H2><PRE>
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>, <STRONG><A HREF="putc.3S.html">putc(3S)</A></STRONG>.
+
+
+
+ <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG>
</PRE>
<HR>
<ADDRESS>
projects / ncurses.git / blobdiff