<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<!--
****************************************************************************
- * Copyright (c) 1998-2002,2003 Free Software Foundation, Inc. *
+ * Copyright (c) 1998-2007,2010 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.18 2003/02/08 22:25:47 tom Exp @
+ * @Id: curs_termcap.3x,v 1.26 2010/12/04 18:38:55 tom Exp @
-->
<HTML>
<HEAD>
</PRE>
<H2>NAME</H2><PRE>
- <STRONG>tgetent</STRONG>, <STRONG>tgetflag</STRONG>, <STRONG>tgetnum</STRONG>, <STRONG>tgetstr</STRONG>, <STRONG>tgoto</STRONG>, <STRONG>tputs</STRONG> - direct
- <STRONG>curses</STRONG> interface to the terminfo capability database
+ <STRONG>PC</STRONG>, <STRONG>UP</STRONG>, <STRONG>BC</STRONG>, <STRONG>ospeed</STRONG>, <STRONG>tgetent</STRONG>, <STRONG>tgetflag</STRONG>, <STRONG>tgetnum</STRONG>, <STRONG>tgetstr</STRONG>,
+ <STRONG>tgoto</STRONG>, <STRONG>tputs</STRONG> - direct <STRONG>curses</STRONG> interface to the terminfo
+ capability database
</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>
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>.
+ terminfo database could not be found. The emulation ig-
+ nores the buffer pointer <EM>bp</EM>.
- The <STRONG>tgetflag</STRONG> routine gets the boolean entry for <EM>id</EM>, or
- zero if it is not available.
+ The <STRONG>tgetflag</STRONG> routine gets the boolean entry for <EM>id</EM>, or ze-
+ ro if it is not available.
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
+ zero if it is not available. Use <STRONG>tputs</STRONG> to output the re-
+ turned 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.
minal 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
- specifies "an integer value other than <STRONG>ERR</STRONG>") upon success-
- ful completion.
+ Except where explicitly noted, routines that return an in-
+ teger return <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> (SVr4 only specifies
+ "an integer value other than <STRONG>ERR</STRONG>") upon successful comple-
+ tion.
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
- 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
- does not appear to be terminfo).
+ string, be aware that it will be returned in terminfo no-
+ tation, not the older and not-quite-compatible termcap no-
+ tation. This will not 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 con-
+ figured 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>
</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="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>, <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>, <STRONG><A HREF="putc.3.html">putc(3)</A></STRONG>.
projects / ncurses.git / blobdiff