pkgin_all: script to auto-install all packages
[minix.git] / lib / libcurses / curses_termcap.3
blob19247b66d9007196cc755bd968ac5ab37eb51a3a
1 .\"     $NetBSD: curses_termcap.3,v 1.6 2012/04/21 12:27:28 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 .Nd curses termcap querying routines
40 .Sh LIBRARY
41 .Lb libcurses
42 .Sh SYNOPSIS
43 .In curses.h
44 .Ft char *
45 .Fn fullname "char *termbuf" "char *name"
46 .Sh DESCRIPTION
47 The
48 .Fn fullname
49 function takes the termcap entry in
50 .Fa termbuf
51 and copies the full name of the terminal from the entry into the
52 target variable
53 .Fa name .
54 The full name of the terminal is assumed to be the last alias in the
55 termcap entry name.
56 It is assumed that the
57 .Fa name
58 variable has sufficient storage to hold the full name of the terminal.
59 .Sh RETURN VALUES
60 Functions returning pointers will return
61 .Dv NULL
62 if an error is detected.
63 The functions that return an int will return one of the following
64 values:
65 .Pp
66 .Bl -tag -width ERR -compact
67 .It Er OK
68 The function completed successfully.
69 .It Er ERR
70 An error occurred in the function.
71 .El
72 .Sh SEE ALSO
73 .Xr terminfo 5
74 .Sh STANDARDS
75 The
76 .Lb libcurses
77 library complies with the X/Open Curses specification, part of the
78 Single Unix Specification.
79 .Sh HISTORY
80 The Curses package appeared in
81 .Bx 4.0 .