1.\" $NetBSD: curses_termcap.3,v 1.5 2011/10/04 11:01:14 roy Exp $ 2.\" 3.\" Copyright (c) 2002 4.\" Brett Lymn (blymn@NetBSD.org, brett_lymn@yahoo.com.au) 5.\" 6.\" This code is donated to the NetBSD Foundation by the Author. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation and/or other materials provided with the distribution. 16.\" 3. The name of the Author may not be used to endorse or promote 17.\" products derived from this software without specific prior written 18.\" permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" 33.Dd October 4, 2011 34.Dt CURSES_TERMCAP 3 35.Os 36.Sh NAME 37.Nm curses_termcap , 38.Nm fullname , 39.Nm getcap 40.Nd curses termcap querying routines 41.Sh LIBRARY 42.Lb libcurses 43.Sh SYNOPSIS 44.In curses.h 45.Ft char * 46.Fn fullname "char *termbuf" "char *name" 47.Ft char * 48.Fn getcap "char *name" 49.Sh DESCRIPTION 50The 51.Fn fullname 52function takes the termcap entry in 53.Fa termbuf 54and copies the full name of the terminal from the entry into the 55target variable 56.Fa name . 57The full name of the terminal is assumed to be the last alias in the 58termcap entry name. 59It is assumed that the 60.Fa name 61variable has sufficient storage to hold the full name of the terminal. 62.Pp 63A termcap entry can be retrieved by calling the 64.Fn getcap 65function with the name of the capability in 66.Fa name . 67The matching capability string for the terminal is returned. 68.Sh RETURN VALUES 69Functions returning pointers will return 70.Dv NULL 71if an error is detected. 72The functions that return an int will return one of the following 73values: 74.Pp 75.Bl -tag -width ERR -compact 76.It Er OK 77The function completed successfully. 78.It Er ERR 79An error occurred in the function. 80.El 81.Sh SEE ALSO 82.Xr termcap 5 83.Sh STANDARDS 84The 85.Lb libcurses 86library complies with the X/Open Curses specification, part of the 87Single Unix Specification. 88.Sh HISTORY 89The Curses package appeared in 90.Bx 4.0 . 91