lib/libterminfo/terminfo.5.in

*0a6a1f1dSLionel Sambuc.\"	$NetBSD: terminfo.5.in,v 1.20 2014/03/18 18:20:38 riastradh Exp $
51e66a47SVivek Prakash.\"
84d9c625SLionel Sambuc.\" Copyright (c) 2009, 2010, 2011, 2013 The NetBSD Foundation, Inc.
51e66a47SVivek Prakash.\" All rights reserved.
51e66a47SVivek Prakash.\"
51e66a47SVivek Prakash.\" This code is derived from software contributed to The NetBSD Foundation
51e66a47SVivek Prakash.\" by Roy Marples.
51e66a47SVivek Prakash.\"
51e66a47SVivek Prakash.\" Redistribution and use in source and binary forms, with or without
51e66a47SVivek Prakash.\" modification, are permitted provided that the following conditions
51e66a47SVivek Prakash.\" are met:
51e66a47SVivek Prakash.\" 1. Redistributions of source code must retain the above copyright
51e66a47SVivek Prakash.\"    notice, this list of conditions and the following disclaimer.
51e66a47SVivek Prakash.\" 2. Redistributions in binary form must reproduce the above copyright
51e66a47SVivek Prakash.\"    notice, this list of conditions and the following disclaimer in the
51e66a47SVivek Prakash.\"    documentation and/or other materials provided with the distribution.
51e66a47SVivek Prakash.\"
51e66a47SVivek Prakash.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
51e66a47SVivek Prakash.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
51e66a47SVivek Prakash.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
51e66a47SVivek Prakash.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
51e66a47SVivek Prakash.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
51e66a47SVivek Prakash.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
51e66a47SVivek Prakash.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
51e66a47SVivek Prakash.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
51e66a47SVivek Prakash.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
51e66a47SVivek Prakash.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
51e66a47SVivek Prakash.\" POSSIBILITY OF SUCH DAMAGE.
51e66a47SVivek Prakash.\"
84d9c625SLionel Sambuc.Dd January 25, 2013
51e66a47SVivek Prakash.Dt TERMINFO 5
51e66a47SVivek Prakash.Os
51e66a47SVivek Prakash.Sh NAME
51e66a47SVivek Prakash.Nm terminfo
51e66a47SVivek Prakash.Nd terminal capability definition
51e66a47SVivek Prakash.Sh DESCRIPTION
51e66a47SVivek Prakash.Nm
51e66a47SVivek Prakashdescribes the capabilities of terminals, used by programs such as
51e66a47SVivek Prakash.Xr vi 1 ,
51e66a47SVivek Prakash.Xr rogue 6
51e66a47SVivek Prakashand libraries such as
51e66a47SVivek Prakash.Xr curses 3 .
51e66a47SVivek PrakashThe
51e66a47SVivek Prakash.Nm
51e66a47SVivek Prakashsource described here needs to be compiled with
51e66a47SVivek Prakash.Xr tic 1
51e66a47SVivek Prakashto be of any use.
51e66a47SVivek Prakash.Pp
51e66a47SVivek PrakashEntries in
51e66a47SVivek Prakash.Nm
51e66a47SVivek Prakashconsist of a number of comma separated fields.
51e66a47SVivek PrakashWhite space after each comma is ignored.
51e66a47SVivek PrakashEmbedded commas must be escaped by using a backslash.
51e66a47SVivek PrakashLines beginning with
51e66a47SVivek Prakash.Sq #
51e66a47SVivek Prakashin the first column are treated as comments.
51e66a47SVivek PrakashBlank lines are ignored.
51e66a47SVivek Prakash.Pp
51e66a47SVivek PrakashThe header line must begin in column one and end with a comma.
51e66a47SVivek PrakashInside the header line are terminal name and aliases,
51e66a47SVivek Prakashseparated by vertical bars, the last one being the long
51e66a47SVivek Prakashdescription of the terminal.
51e66a47SVivek Prakash.Pp
51e66a47SVivek PrakashCapability lines then follow, starting on column two and ending with a comma.
51e66a47SVivek PrakashEach capability is listed by its name, followed by its value if applicable.
51e66a47SVivek PrakashBooleans have no values, numeric values are prefixed by
51e66a47SVivek Prakash.Sq #
51e66a47SVivek Prakashand strings are prefixed by
51e66a47SVivek Prakash.Sq = .
51e66a47SVivek PrakashNumbers can range from 0 to 32767 and string values can be up to 1000
51e66a47SVivek Prakashcharacters long.
51e66a47SVivek PrakashThis implementation supports strings upto 32767 characters long, including the
51e66a47SVivek Prakash.Dv NUL
51e66a47SVivek Prakashterminator.
51e66a47SVivek Prakash.Pp
51e66a47SVivek PrakashSome escapes are available for strings - both
51e66a47SVivek Prakash.Sy \eE
51e66a47SVivek Prakashand
51e66a47SVivek Prakash.Sy \ee
51e66a47SVivek Prakashmap to the
51e66a47SVivek Prakash.Dv ESC
51e66a47SVivek Prakashcharacter,
51e66a47SVivek Prakash.Sy ^X
51e66a47SVivek Prakashmaps to a control-X for any appropriate X, and the sequences
51e66a47SVivek Prakash.Sy \en ,
51e66a47SVivek Prakash.Sy \er ,
51e66a47SVivek Prakash.Sy \et ,
51e66a47SVivek Prakash.Sy \eb
51e66a47SVivek Prakashand
51e66a47SVivek Prakash.Sy \ef
51e66a47SVivek Prakashmap to linefeed, return, tab, backspace, and formfeed respectively.
51e66a47SVivek PrakashAny character can be escaped in octal, such as
51e66a47SVivek Prakash.Sy \e072 .
51e66a47SVivek PrakashIf you need to encode a
51e66a47SVivek Prakash.Dv NUL
51e66a47SVivek Prakashcharacter, it should be escaped as
51e66a47SVivek Prakash.Sy \e200 .
51e66a47SVivek Prakash.Pp
51e66a47SVivek PrakashA delay in milliseconds may appear anywhere in a string capability,
51e66a47SVivek Prakashprefixed with a dollar sign and enclosed by angled brackets, such as
51e66a47SVivek Prakash.Sy $\*[Lt]5\*[Gt] .
51e66a47SVivek Prakash.Ss String Parameters
51e66a47SVivek PrakashString capabilities sometimes require parameters.
51e66a47SVivek PrakashNormally this just involves replacing the parameter with a supplied
51e66a47SVivek Prakashvariable; however, there are cases where the variable needs to be manipulated
51e66a47SVivek Prakashor used in conditional expressions.
51e66a47SVivek PrakashA stack is also provided for simple pop and push operations.
51e66a47SVivek Prakash.Pp
51e66a47SVivek PrakashThe below % encodings have the following meanings:
51e66a47SVivek Prakash.Bl -tag -width %P[a-z]
51e66a47SVivek Prakash.It Sy %%
51e66a47SVivek Prakashoutputs %
51e66a47SVivek Prakash.It Sy %[[:]flags][width[.precision]][doxXs]
51e66a47SVivek Prakashflags are
51e66a47SVivek Prakash.Dq [-+#] .
51e66a47SVivek PrakashPrefix with
51e66a47SVivek Prakash.Sq \&:
51e66a47SVivek Prakashto avoid interpreting
51e66a47SVivek Prakash.Dq %-
51e66a47SVivek Prakashas an operator.
51e66a47SVivek Prakash.It Sy %c
51e66a47SVivek Prakashpop a parameter and print the character representation of it.
51e66a47SVivek Prakash.It Sy %s
51e66a47SVivek Prakashpop a parameter and print the string representation of it.
51e66a47SVivek Prakash.It Sy %p[1-9]
51e66a47SVivek Prakashpush the parameter [1-9].
51e66a47SVivek Prakash.It Sy %P[a-z]
51e66a47SVivek Prakashpop a parameter and push it to dynamic variable [a-z].
51e66a47SVivek Prakash.It Sy %g[a-z]
51e66a47SVivek Prakashpush the dynamic variable [a-z].
51e66a47SVivek Prakash.It Sy %P[A-Z]
51e66a47SVivek Prakashpop a parameter and push it to static variable [a-z].
51e66a47SVivek Prakash.It Sy %g[A-Z]
51e66a47SVivek Prakashpush the dynamic variable [A-Z].
51e66a47SVivek Prakash.Pp
51e66a47SVivek PrakashStatic variables persist over
51e66a47SVivek Prakash.Fn tparm
51e66a47SVivek Prakashwhereas dynamic variables do not.
51e66a47SVivek Prakash.It Sy %'c'
51e66a47SVivek Prakashchar constant c.
51e66a47SVivek Prakash.It Sy %{nn}
51e66a47SVivek Prakashinteger constant nn.
51e66a47SVivek Prakash.It Sy %l
51e66a47SVivek Prakashpush the string length of the previously popped parameter.
51e66a47SVivek Prakash.It Sy %+ Sy %- Sy %* Sy %/ Sy %m
51e66a47SVivek Prakasharithmetic: pop two parameters and push the result.
51e66a47SVivek Prakash.It Sy %& Sy %| Sy %^
51e66a47SVivek Prakashbit operations: pop two parameters and push the result.
51e66a47SVivek Prakash.It Sy %! Sy %~
51e66a47SVivek Prakashunary operations: pop two parameters and push the result.
51e66a47SVivek Prakash.It Sy %i
51e66a47SVivek Prakashadd 1 to parameters 1 and 2.
51e66a47SVivek Prakash.It Sy %? Va expr Sy %t Ic then Sy %e Ic else Sy %;
51e66a47SVivek PrakashIf expr equates to zero then control passes to the optional else part.
51e66a47SVivek Prakash.El
51e66a47SVivek Prakash.Ss Boolean Capabilities
84d9c625SLionel Sambuc.Bl -column "enter_near_quality_letter" "setcolor" "TC" "desc"
84d9c625SLionel Sambuc.It Sy "Long name" Ta Sy "Code" Ta Sy "TC" Ta Sy "Description"
51e66a47SVivek Prakash@BOOLCAPS@
51e66a47SVivek Prakash.El
51e66a47SVivek Prakash.Ss Numeric Capabilities
84d9c625SLionel Sambuc.Bl -column "enter_near_quality_letter" "setcolor" "TC" "Desc"
84d9c625SLionel Sambuc.It Sy "Long name" Ta Sy "Code" Ta Sy "TC" Ta Sy "Description"
51e66a47SVivek Prakash@NUMCAPS@
51e66a47SVivek Prakash.El
51e66a47SVivek Prakash.Ss String Capabilities
84d9c625SLionel Sambuc.Bl -column "enter_near_quality_letter" "setcolor" "TC" "Desc"
84d9c625SLionel Sambuc.It Sy "Long name" Ta Sy "Code" Ta Sy "TC" Ta Sy "Description"
51e66a47SVivek Prakash@STRCAPS@
51e66a47SVivek Prakash.El
51e66a47SVivek Prakash.Ss A Sample Entry
51e66a47SVivek Prakash.Bd -literal
51e66a47SVivek Prakashvt100\||dec vt100 (w/advanced video),
51e66a47SVivek Prakasham, xenl, msgr, mc5i, xon,
51e66a47SVivek Prakashcols#80, it#8, lines#24, vt#3,
51e66a47SVivek Prakashacsc=``aaffggjjkkllmmnnooppqqrrssttuuvvwwxxyyzz{{||}}~~, bel=^G,
51e66a47SVivek Prakashcr=^M, csr=\eE[%i%p1%d;%p2%dr, tbc=\eE[3g, clear=\eE[H\eE[J$\*[Lt]50\*[Gt],
51e66a47SVivek Prakashel1=\eE[1K$\*[Lt]3\*[Gt], el=\eE[K$\*[Lt]3\*[Gt], ed=\eE[J$\*[Lt]50\*[Gt],
51e66a47SVivek Prakashcup=\eE[%i%p1%d;%p2%dH$\*[Lt]5\*[Gt], cud1=^J, home=\eE[H, cub1=^H,
51e66a47SVivek Prakashcuf1=\eE[C$\*[Lt]2\*[Gt], cuu1=\eE[A$\*[Lt]2\*[Gt], enacs=\eE(B\eE)0, smacs=^N,
51e66a47SVivek Prakashsmam=\eE[?7h, blink=\eE[5m$\*[Lt]2\*[Gt], bold=\eE[1m$\*[Lt]2\*[Gt], rev=\eE[7m$\*[Lt]2\*[Gt],
51e66a47SVivek Prakashsmso=\eE[7m$\*[Lt]2\*[Gt], smul=\eE[4m$\*[Lt]2\*[Gt], rmacs=^O, rmam=\eE[?7l,
51e66a47SVivek Prakashsgr0=\eE[m017$\*[Lt]2\*[Gt], rmso=\eE[m$\*[Lt]2\*[Gt], rmul=\eE[m$\*[Lt]2\*[Gt], ka1=\eEOq,
51e66a47SVivek Prakashka3=\eEOs, kb2=\eEOr, kbs=^H, kc1=\eEOp, kc3=\eEOn, kcud1=\eEOB,
51e66a47SVivek Prakashkent=\eEOM, kf0=\eEOy, kf1=\eEOP, kf2=\eEOQ, kf3=\eEOR, kf4=\eEOS,
51e66a47SVivek Prakashkf5=\eEOt, kf6=\eEOu, kf7=\eEOv, kf8=\eEOl, kf9=\eEOw, kf10=\eEOx,
51e66a47SVivek Prakashkcub1=\eEOD, kcuf1=\eEOC, kcuu1=\eEOA, rmkx=\eE[?1l\eE\*[Gt],
51e66a47SVivek Prakashsmkx=\eE[?1h\eE=, lf1=pf1, lf2=pf2, lf3=pf3, lf4=pf4,
51e66a47SVivek Prakashcud=\eE[%p1%dB, cub=\eE[%p1%dD, cuf=\eE[%p1%dC, cuu=\eE[%p1%dA,
51e66a47SVivek Prakashmc0=\eE[0i, mc4=\eE[4i, mc5=\eE[5i,
51e66a47SVivek Prakashrs2=\eE\*[Gt]\eE[?3l\eE[?4l\eE[?5l\eE[?7h\eE[?8h, rc=\eE8, sc=\eE7,
51e66a47SVivek Prakashind=^J, ri=\eEM$\*[Lt]5\*[Gt],
51e66a47SVivek Prakashsgr=\eE[0%?%p1%p6%|%t;1%;%?%p2%t;4%;%?%p1%p3%|%t;7%;%?%p4%t;5%;m%?%p9%t016%e017%;$\*[Lt]2\*[Gt],
51e66a47SVivek Prakashhts=\eEH, ht=^I,
51e66a47SVivek Prakash.Ed
51e66a47SVivek Prakash.Ss Fetching Compiled Descriptions
51e66a47SVivek PrakashThis implementation uses hashed databases managed by
0c3ae37fSLionel Sambuc.Xr cdb 5
51e66a47SVivek Prakashinstead of directories.
51e66a47SVivek PrakashTo maintain compatability with other implementations,
0c3ae37fSLionel Sambuc.Pa .cdb
51e66a47SVivek Prakashis appended to each file checked.
51e66a47SVivek Prakash.Pp
51e66a47SVivek PrakashIf the environment variable
51e66a47SVivek Prakash.Ev TERMINFO
51e66a47SVivek Prakashis available, does not begin with
51e66a47SVivek Prakash.Pq Sq / ,
51e66a47SVivek Prakashcan be compiled with the above rules and whose name matches
51e66a47SVivek Prakash.Ev TERM
51e66a47SVivek Prakashthen it is used.
51e66a47SVivek Prakash.Pp
51e66a47SVivek PrakashIf the environment variable
51e66a47SVivek Prakash.Ev TERMCAP
51e66a47SVivek Prakashis available and does not begin with a slash
51e66a47SVivek Prakash.Pq Sq /
51e66a47SVivek Prakashthen it will be translated into
51e66a47SVivek Prakashterminfo and compiled as above.
51e66a47SVivek PrakashIf its name matches
51e66a47SVivek Prakash.Ev TERM
51e66a47SVivek Prakashthen it is used.
51e66a47SVivek Prakash.Pp
51e66a47SVivek PrakashIf the environment variable
51e66a47SVivek Prakash.Ev TERMINFO
51e66a47SVivek Prakashis available and begins with a slash
51e66a47SVivek Prakash.Pq Sq /
51e66a47SVivek Prakashthen only this file is searched.
51e66a47SVivek PrakashOtherwise
51e66a47SVivek Prakash.Nm
51e66a47SVivek Prakashwill first look for
51e66a47SVivek Prakash.Pa $HOME/.terminfo ,
51e66a47SVivek Prakashfollowed by
51e66a47SVivek Prakash.Pa /usr/share/misc/terminfo
51e66a47SVivek Prakashunless
51e66a47SVivek Prakash.Ev TERMINFO_DIRS
51e66a47SVivek Prakashis available.
51e66a47SVivek PrakashIf a matching description is not found then a small embedded database is
51e66a47SVivek Prakashsearched, which currently holds descriptions for ansi, dumb, vt100, vt220,
51e66a47SVivek Prakashwsvt25, and xterm.
51e66a47SVivek Prakash.Sh FILES
0c3ae37fSLionel Sambuc.Bl -tag -width /usr/share/misc/terminfo.cdb -compact
0c3ae37fSLionel Sambuc.It Pa $HOME/.terminfo.cdb
51e66a47SVivek PrakashDatabase of terminal descriptions for personal use.
51e66a47SVivek Prakash.It Pa /usr/share/misc/terminfo
51e66a47SVivek PrakashFile containing terminal descriptions.
0c3ae37fSLionel Sambuc.It Pa /usr/share/misc/terminfo.cdb
51e66a47SVivek PrakashDatabase of terminal descriptions.
51e66a47SVivek Prakash.El
51e66a47SVivek Prakash.Sh SEE ALSO
51e66a47SVivek Prakash.Xr infocmp 1 ,
51e66a47SVivek Prakash.Xr tic 1 ,
51e66a47SVivek Prakash.Xr tput 1 ,
51e66a47SVivek Prakash.Xr curses 3 ,
0c3ae37fSLionel Sambuc.Xr cdb 5
51e66a47SVivek Prakash.Sh STANDARDS
51e66a47SVivek Prakash.Nm
51e66a47SVivek Prakashcomplies with the
51e66a47SVivek Prakash.St -xcurses4.2
51e66a47SVivek Prakashstandard.
51e66a47SVivek Prakash.Pp
51e66a47SVivek PrakashExtensions to the standard are noted in
51e66a47SVivek Prakash.Xr tic 1 .
51e66a47SVivek Prakash.Sh AUTHORS
84d9c625SLionel Sambuc.An Roy Marples Aq Mt roy@NetBSD.org