<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<!--
****************************************************************************
- * Copyright (c) 1998-2010,2011 Free Software Foundation, Inc. *
+ * Copyright (c) 1998-2012,2013 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.27 2011/10/15 21:11:24 tom Exp @
+ * @Id: curs_termcap.3x,v 1.30 2013/01/19 15:58:48 tom Exp @
-->
<HTML>
<HEAD>
bilities of entries for which a terminfo entry has been
compiled.
+ <STRONG>INITIALIZATION</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 (or that it is a generic
- type, having too little information for curses ap-
+ 0 if there is no such entry (or that it is a generic
+ type, having too little information for curses ap-
plications to run), and
-1 if the terminfo database could not be found.
This differs from the <EM>termcap</EM> library in two ways:
- - The emulation ignores the buffer pointer <EM>bp</EM>. The
- <EM>termcap</EM> library would store a copy of the terminal
- description in the area referenced by this pointer.
- However, ncurses stores its terminal descriptions in
- compiled binary form, which is not the same thing.
+ <STRONG>o</STRONG> The emulation ignores the buffer pointer <EM>bp</EM>. The
+ <EM>termcap</EM> library would store a copy of the terminal
+ description in the area referenced by this pointer.
+ However, ncurses stores its terminal descriptions
+ in compiled binary form, which is not the same
+ thing.
- - There is a difference in return codes. The <EM>termcap</EM>
- library does not check if the terminal description
- is marked with the <EM>generic</EM> capability, or if the
- terminal description has cursor-addressing.
+ <STRONG>o</STRONG> There is a difference in return codes. The <EM>termcap</EM>
+ library does not check if the terminal description
+ is marked with the <EM>generic</EM> capability, or if the
+ terminal description has cursor-addressing.
+ <STRONG>CAPABILITY</STRONG> <STRONG>VALUES</STRONG>
The <STRONG>tgetflag</STRONG> routine gets the boolean entry for <EM>id</EM>, or ze-
ro if it is not available.
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.
+ <STRONG>FORMATTING</STRONG> <STRONG>CAPABILITIES</STRONG>
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>.
manual page. It can retrieve capabilities by either term-
cap or terminfo name.
+ <STRONG>GLOBAL</STRONG> <STRONG>VARIABLES</STRONG>
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
guishing between input and output. In particular, some
applications are reported to declare and/or modify <STRONG>ospeed</STRONG>.
+ The comment that only the first two characters of the <STRONG>id</STRONG>
+ parameter are used escapes many application developers.
+ The original BSD 4.2 termcap library (and historical
+ relics thereof) did not require a trailing null NUL on the
+ parameter name passed to <STRONG>tgetstr</STRONG>, <STRONG>tgetnum</STRONG> and <STRONG>tgetflag</STRONG>.
+ Some applications assume that the termcap interface does
+ not require the trailing NUL for the parameter name. Tak-
+ ing into account these issues:
+
+ <STRONG>o</STRONG> As a special case, <STRONG>tgetflag</STRONG> matched against a single-
+ character identifier provided that was at the end of
+ the terminal description. You should not rely upon
+ this behavior in portable programs. This implementa-
+ tion disallows matches against single-character capa-
+ bility names.
+
+ <STRONG>o</STRONG> This implementation disallows matches by the termcap
+ interface against extended capability names which are
+ longer than two characters.
+
</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="term_variables.3x.html">term_variables(3x)</A></STRONG>, <STRONG><A HREF="putc.3.html">putc(3)</A></STRONG>.
+ http://invisible-island.net/ncurses/tctest.html
+
<STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG>
projects / ncurses.git / blobdiff