xref: /onnv-gate/usr/src/cmd/terminfo/header (revision 0:68f95e015346)
1*0Sstevel@tonic-gate#ident	"%Z%%M%	%I%	%E% SMI"	/* SVr4.0 1.5	*/
2*0Sstevel@tonic-gate#
3*0Sstevel@tonic-gate# CDDL HEADER START
4*0Sstevel@tonic-gate#
5*0Sstevel@tonic-gate# The contents of this file are subject to the terms of the
6*0Sstevel@tonic-gate# Common Development and Distribution License, Version 1.0 only
7*0Sstevel@tonic-gate# (the "License").  You may not use this file except in compliance
8*0Sstevel@tonic-gate# with the License.
9*0Sstevel@tonic-gate#
10*0Sstevel@tonic-gate# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
11*0Sstevel@tonic-gate# or http://www.opensolaris.org/os/licensing.
12*0Sstevel@tonic-gate# See the License for the specific language governing permissions
13*0Sstevel@tonic-gate# and limitations under the License.
14*0Sstevel@tonic-gate#
15*0Sstevel@tonic-gate# When distributing Covered Code, include this CDDL HEADER in each
16*0Sstevel@tonic-gate# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
17*0Sstevel@tonic-gate# If applicable, add the following below this CDDL HEADER, with the
18*0Sstevel@tonic-gate# fields enclosed by brackets "[]" replaced with your own identifying
19*0Sstevel@tonic-gate# information: Portions Copyright [yyyy] [name of copyright owner]
20*0Sstevel@tonic-gate#
21*0Sstevel@tonic-gate# CDDL HEADER END
22*0Sstevel@tonic-gate#
23*0Sstevel@tonic-gate# ------------------------
24*0Sstevel@tonic-gate#
25*0Sstevel@tonic-gate# This file describes capabilities of various terminals, as needed by
26*0Sstevel@tonic-gate# software such as screen editors.  It does not attempt to describe
27*0Sstevel@tonic-gate# printing terminals very well, nor graphics terminals.  Someday.
28*0Sstevel@tonic-gate# See terminfo(5) in the Unix Programmers Manual for documentation.
29*0Sstevel@tonic-gate#
30*0Sstevel@tonic-gate# Conventions: First entry is two chars, first char is manufacturer,
31*0Sstevel@tonic-gate# second char is canonical name for model or mode.
32*0Sstevel@tonic-gate# Third entry is the one the editor will print with "set" command.
33*0Sstevel@tonic-gate# Last entry is verbose description.
34*0Sstevel@tonic-gate# Others are mnemonic synonyms for the terminal.
35*0Sstevel@tonic-gate#
36*0Sstevel@tonic-gate# Terminal naming conventions:
37*0Sstevel@tonic-gate# Terminal names look like <manufacturer> <model> - <modes/options>
38*0Sstevel@tonic-gate# Certain abbreviations (e.g. c100 for concept100) are also allowed
39*0Sstevel@tonic-gate# for upward compatibility.  The part to the left of the dash, if a
40*0Sstevel@tonic-gate# dash is present, describes the particular hardware of the terminal.
41*0Sstevel@tonic-gate# The part to the right can be used for flags indicating special ROM's,
42*0Sstevel@tonic-gate# extra memory, particular terminal modes, or user preferences.
43*0Sstevel@tonic-gate# All names are always in lower case, for consistency in typing.
44*0Sstevel@tonic-gate# Because of file naming restrictions, terminal names should not contain
45*0Sstevel@tonic-gate# period or slash, in fact, entirely alphanumeric characters plus dash are
46*0Sstevel@tonic-gate# highly recommended.  These restrictions do not apply to the verbose name.
47*0Sstevel@tonic-gate#
48*0Sstevel@tonic-gate# The following are conventionally used flags:
49*0Sstevel@tonic-gate#	rv	Terminal in reverse video mode (black on white)
50*0Sstevel@tonic-gate#	2p	Has two pages of memory.  Likewise 4p, 8p, etc.
51*0Sstevel@tonic-gate#	w	Wide - in 132 column mode.
52*0Sstevel@tonic-gate#	pp	Has a printer port which is used.
53*0Sstevel@tonic-gate#	na	No arrow keys - terminfo ignores arrow keys which are
54*0Sstevel@tonic-gate#		actually there on the terminal, so the user can use
55*0Sstevel@tonic-gate#		the arrow keys locally.
56*0Sstevel@tonic-gate#	#	The number of lines on the screen.
57*0Sstevel@tonic-gate#	s	With a status line.
58*0Sstevel@tonic-gate#
59*0Sstevel@tonic-gate# There are some cases where the same name is used for two different
60*0Sstevel@tonic-gate# terminals, e.g. "teleray" or "2621" or "vt100".  In these cases,
61*0Sstevel@tonic-gate# if a site has one of these, they should choose a local default and
62*0Sstevel@tonic-gate# bring that terminal to the front in the reorder script.  This works
63*0Sstevel@tonic-gate# because setupterm() picks the first match in /usr/share/lib/terminfo/*/*.
64*0Sstevel@tonic-gate#
65*0Sstevel@tonic-gate# If you absolutely MUST check for a specific terminal (this is discouraged)
66*0Sstevel@tonic-gate# check for the 1st entry (the canonical form) since all other codes are
67*0Sstevel@tonic-gate# subject to change.  We would much rather put in special capabilities to
68*0Sstevel@tonic-gate# describe your terminal rather than having you key on the name.
69