Creating Device Descriptions

The easiest way to create a new entry for a device is to find one that is similar, modify it, and compile it using the tic utility. The tic utility installs the new definition in the TERMINFO directory hierarchy. You can change the location of the directory hierarchy by redefining the TERMINFO environment variable.

You can test your description in small segments using VI. Keep in mind that a unusual device may not be adequately described by TERMINFO or adequately tested by VI.

A terminal can be defined as having certain capabilties that are equivalent to those of another terminal. These capabilities are then read from one terminal description into the other. The use capability names the terminal from which to read the capabilities. Any capabilities listed before the use string override those put in place by use. A capability that should not be used in the terminal desciption can be cancelled by typing an at sign (@) after the name of the capability. The following example bases the definition of a VT-100 terminal without automatic margins on a standard VT-100 terminal definition.

   vt100-nam|VT100 without automatic margins,

   am@, use=vt100,

A crude test for getting the right amount of padding for insert-line (if not documented) is to comment out xon, edit a large file at 9600 baud with VI, delete 16 or so lines from the middle of the screen, and press the u key several times quickly. If the display becomes corrupted, insert-line requires more padding.

Special Characters

Table 3-6 “Characters with Special Values” summarizes all the special characters sequences discussed to this point.

Table 3-6 Characters with Special Values

Character	Meaning
,	Separates capabilities
#	Precedes integer value in numeric capabilities
=	Separates string capability name from string sequence
@	Cancels capability
#	At the beginning of line, comments out the line
.	When directly preceding a capability, period comments it out
^x	Control x sequence
\E	Escape character
\e	Escape character
\n	Newline character
\r	Return character
\t	Tab character
\v	Vertical tab character
\b	Backspace character
\f	Formfeed character
\s	Space character
\l	Linefeed character
\a	Alert character
\xxx	Octal characters (must be three characters)
\,	Escapes a comma
\\	Escapes a backslash
\^	Escapes a caret
\:	Escapes a colon
\0	Escapes a null character
%x	String using format operator
$<n>	Indicates a delay in n milliseconds
$<n/>	Indicates the delay is mandatory
$<n*>	Indicates the padding required per affected line
$<n/*>	Indicates mandatory padding required per affected line

 

Names of Capabilities

Capability names are normally kept to two to five characters and normally comply with ANSI X3.64-1979. Each capability has a corresponding variable name used in the program to access it; for example, the variable defined for am is auto_left_margin.

The Boolean, number, and string capabilities are listed in the tables on the following pages. Within these tables, each TERMINFO capability name is listed, along with the equivalent termcap name, the variable name, and a brief description. The #i symbol that sometimes appears in the description section of the table refers to the ith parameter.

Additional tables sorted by variable name may be found in Table 3-20 “Boolean Capabilities”, Table 3-21 “Numeric Capabilities”, and Table 3-22 “String Capabilities” as a reference for programmers. Table 3-20 “Boolean Capabilities” lists the capabilities by the Boolean variable name; Table 3-21 “Numeric Capabilities” lists the capabilities by the numeric variable name, and Table 3-22 “String Capabilities” lists the capabilities by the string variable name.

Boolean Capabilities

Table 3-7 “Boolean Capabilities” lists the Boolean capabilities.

Table 3-7 Boolean Capabilities

TInfo	TCap	Variable	Description
am	am	auto_right_margin	Terminal has automatic margins
bw	bw	auto_left_margin	cub1 wraps from column 0 to last column
ccc	cc	can_change	Terminal can redefine existing color
chts	HC	hard_cursor	Cursor is hard to see
cpix	YF	cpi_changes_res	Changing character pitch changes resolution
crxm	YB	cr_cancels_micro_mode	Using cr turns off micro mode
da	da	memory_above	Display may be retained above the screen
daisy	YC	has_print_wheel	Printer needs operator to change character set
db	db	memory_below	Display may be retained below the screen
eo	eo	erase_overstrike	Terminal can erase overstrikes with a blank
eslok	es	status_line_esc_ok	Escape can be used on the status line
gn	gn	generic_type	Generic line type (e.g. dialup, switch)
hc	hc	hard_copy	Hardcopy terminal
hls	hl	hue_lightness_saturation	Terminal uses only HLS color notation (Tektronix)
hs	hs	has_status_line	Terminal has extra status line
hz	hz	tilde_glitch	Hazeltine: cannot print tilde (~)
in	in	insert_null_glitch	Insert mode distinguishes nulls
km	km	has_meta_key	Terminal has meta key (shift, sets parity bit)
lpix	YG	lpi_changes_res	Changing line pitch changes resolution
mc5i	5i	prtr_silent	Printer will not echo on screen
mir	mi	move_insert_mode	Safe to move in insert mode
msgr	ms	move_standout_mode	Safe to move in standout mode
npc	NP	no_pad_char	Pad character does not exist
nrrmc	NR	non_rev_rmcup	smcup does not reverse rmcup
nxon	nx	needs_xon_xoff	Padding will not work, XON/XOFF required
os	os	over_strike	Terminal overstrikes
sam	YE	semi_auto_right_margin	Printing in last column causes cr
ul	ul	transparent_underline	Underline character overstrikes
xenl	xn	eat_newline_glitch	Newline ignored after 80 columns (Concept)
xhp	xs	ceol_standout_glitch	Standout not erased by overwriting (hp)
xhpa	YA	col_addr_glitch	Only positive motion for hpa/mhpa capabilities
xon	xo	xon_xoff	Terminal uses XON/XOFF handshaking
xsb	xb	no_esc_ctlc	Beehive (f 1=escape, f2=ctrl C)
xt	xt	dest_tabs_magic_smso	Tabs destructive, magic smso character (Teleray 1061)
xvpa	YD	row_addr_glitch	Only positive motion for vpa/mvpa capabilities

 

Numeric Capabilities

Table 3-8 “Numeric Capabilities” lists the numeric capabilities.

Table 3-8 Numeric Capabilities

TInfo	TCap	Variable	Description
bufsz	Ya	buffer_capacity	Number of bytes buffered before printing
colors	Co	max_colors	Maximum number of colors on the screen
cols	co	columns	Number of columns in a line
it	it	init_tabs	Number of spaces between initial tabs
lh	lh	label_height	Number of rows in each label
lines	li	lines	Number of lines on screen or page
lm	lm	lines_of_memory	Lines of memory if > 0; 0 means unfixed
lw	lw	label_width	Number of columns in each label
maddr	Yd	max_micro_address	Maximum value in micro_..._address
mcs	Yf	micro_col_size	Character step size when in micro mode
mjump	Ye	max_micro_jump	Maximum value in parm_..._micro
mls	Yg	micro_line_size	Line step size when in micro mode
ncv	NC	no_color_video	Video attributes that cannot be used with colors
nlab	Nl	num_labels	Number of labels on screen (start at 1)
npins	yH	number_of_pins	Number of pins in print-head
orc	Yi	output_res_char	Horz. res. in units per character
orhi	Yk	output_res_horz_inch	Horz. res. in units per inch
orl	Yj	output_res_line	Vert. res. in units per line
orvi	Yl	output_res_vert_inch	Vert. res. in units per inch
pairs	pa	max_pairs	Maximum number of color pairs on the screen
pb	pb	padding_baud_rate	Lowest baud rate where cr/nl padding needed
spinh	Yc	dot_horz_spacing	Spacing of dots horizontally in dots per inch
spinv	Yb	dot_vert_spacing	Spacing of pins vertically in pins per inch
vt	vt	virtual_termina	Virtual terminal number (CB/UNIX)
widcs	Yn	wide_char_size	Character step size when in double wide mode
wsl	ws	width_status_line	Number of columns in status line
xmc	sg	magic_cookie_glitch	Number of blank chars left by smso or rmso

 

String Capabilities

Table 3-9 “String Capabilities” lists the string capabilities.

Table 3-9 String Capabilities

TInfo	TCap	Variable	Description
acsc	ac	acs_chars	Graphics character set pairs aAbBcC-defn=vt100
bel	bl	bell	Produce audible signal (bell or beep)
blink	mb	enter_blink_mode	Turn on blinking
bold	md	enter_bold_mode	Turn on bold (extra bright) mode
cbt	bt	back_tab	Back tab
chr	ZC	change_res_horz	Change horizontal resolution
civis	vi	cursor_invisible	Make cursor invisible
clear	<cl	clear_screen	Clear screen
cmdch	CC	command_character	Terminal settable command character in prototype
cnorm	ve	cursor_normal	Make cursor appear normal (undo cvvis/civis)
cpi	ZA	change_char_pitch	Change number of characters per inch
cr	cr	carriage_return	Move cursor to left edge of screen
csnm	Zy	char_set_names	List of character set names
csr	cs	change_scroll_region	Change to lines #1 through #2 (vt100)
cub	LE	parm_left_cursor	Move cursor left #1 spaces
cub1	le	cursor_left	Move cursor left one space
cud	DO	parm_down_cursor	Move cursor down #1 lines
cud1	do	cursor_down	Move cursor down one line
cuf	RI	parm_right_cursor	Move cursor right #1 spaces
cuf1	nd	cursor_right	Non-destructive space (cursor right)
cup	cm	cursor_address	Cursor motion to row #1 col #2
cuu	UP	parm_up_cursor	Move cursor up #1 lines
cuu1	up	cursor_up	Move cursor up
cvr	ZD	change_res_vert	Change vertical resolution
cvvis	vs	cursor_visible	Make cursor very visible
dch	DC	parm_dch	Delete #1 characters
dch1	dc	delete_character	Delete character
defc	ZE	define_char	Define a character in a character set
dim	mh	enter_dim_mode	Turn on half-bright mode
dl	DL	parm_delete_line	Delete #1 lines
dl1	dl	delete_line	Delete line
docr	Zw	these_cause_cr	Printing any of these chars causes cr
dsl	ds	dis_status_line	Disable status line
ech	ec	erase_chars	Erase #1 characters
ed	cd	clr_eos	Clear to end of display
el	ce	clr_eol	Clear to end of line
el1	cb	clr_bol	Clear to beginning of line, inclusive
enacs	eA	ena_acs	Enable alternate character set
ff	ff	form_feed	Hardcopy terminal page eject
flash	vb	flash_screen	Visible bell (may not move cursor)
fsl	fs	from_status_line	Return from status line
hd	hd	down_half_line	Half-line down (forward 1/2 linefeed)
home	ho	cursor_home	Home cursor (if no cup)
hpa	ch	column_address	Set cursor column
ht	ta	tab	Tab to next 8 space hardware tab stop
hts	st	set_tab	Set a tab in all rows, current column
hu	hu	up_half_line	Half-line up (reverse 1/2 linefeed)
ich	IC	parm_ich	Insert #1 blank characters
ich1	ic	insert_character	Insert character
if	if	init_file	Name of file containing is
il	AL	parm_insert_line	Add #1 new blank lines
il1	al	insert_line	Add new blank line
ind	sf	scroll_forward	Scroll text up
indn	SF	parm_index	Scroll forward #1 lines
initc	Ic	initialize_color	Initialize the definition of color
initp	Ip	initialize_pair	Initialize color pair
invis	mk	enter_secure_mode	Turn on blank mode (characters invisible)
ip	ip	insert_padding	Insert pad after character inserted
iprog	iP	init_prog	Pathname of program for initialization
is1=	i1	init_1string	Terminal initialization string
is2=	is	init_2string	Terminal initialization string
is3=	i3	init_3string	Terminal initialization string
kBEG	&9	key_sbeg	Sent by shift-beginning key
kCAN	&0	key_scancel	Sent by shift-cancel key
kCMD	*1	key_scommand	Sent by shift-command key
kCPY	*2	key_scopy	Sent by shift-copy key
kCRT	*3	key_screate	Sent by shift-create key
kDC	*4	key_sdc	Sent by shift-delete-char key
kDL	*5	key_sdl	Sent by shift-delete-line key
kEND	*7	key_send	Sent by shift-end key
kEOL	*8	key_seol	Sent by shift-eol key
kEXT	*9	key_sexit	Sent by shift-exit key
kFND	*0	key_sfind	Sent by shift-find key
kHLP	#1	key_shelp	Sent by shift-help key
kHOM	#2	key_shome	Sent by shift-home key
kIC	#3	key_sic	Sent by shift-insert-char key
kLFT	#4	key_sleft	Sent by shift-left key
kMOV	%b	key_smove	Sent by shift-move key
kMSG	%a	key_smessage	Sent by shift-message key
kNXT	%c	key_snext	Sent by shift-next key
kOPT	%d	key_soptions	Sent by shift-options key
kPRT	%f	key_sprint	Sent by shift-print key
kPRV	%e	key_sprevious	Sent by shift-prev key
kRDO	g	key_sredo	Sent by shift-redo key
kRES	%j	key_srsume	Sent by shift-resume key
kRIT	%i	key_sright	Sent by shift-right key
kRPL	%h	key_sreplace	Sent by shift-replace key
kSAV	!1	key_ssave	Sent by shift-save key
kSPD	!2	key_ssuspend	Sent by shift-suspend key
kUND	!3	key_sundo	Sent by shift-undo key
ka1	K1	key_a1	Upper left of keypad
ka3	K3	key_a3	Upper right of keypad
kb2	K2	key_b2	Center of keypad
kbeg	@1	key_beg	Sent by beginning key
kbs	kb	key_backspace	Sent by backspace key
kc1	K4	key_c1	Lower left of keypad
kc3	K5	key_c3	Lower right of keypad
kcan	@2	key_cancel	Sent by cancel key
kcbt	kB	key_btab	Sent by BackTab key
kclo	@3	key_close	Sent by close key
kclr	kC	key_clear	Sent by clear screen or erase key
kcmd	@4	key_command	Sent by command key
kcpy	@5	key_copy	Sent by copy key
kcreate	@6	key_create	Sent by create key
kctab	kt	key_ctab	Sent by clear-tab key
kcub1	kl	key_left	Sent by terminal left arrow key