xref: /freebsd/share/termcap/termcap.5 (revision bb15ca603fa442c72dde3f3cb8b46db6970e3950)
1.\" Copyright (c) 1985, 1991, 1993, 1994
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``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 REGENTS OR CONTRIBUTORS 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.\"     @(#)termcap.5	8.3 (Berkeley) 4/16/94
33.\"
34.\" /***************************************************************************
35.\" *                            COPYRIGHT NOTICE                              *
36.\" ****************************************************************************
37.\" *                ncurses is copyright (C) 1992-1995                        *
38.\" *                          Zeyd M. Ben-Halim                               *
39.\" *                          zmbenhal@netcom.com                             *
40.\" *                          Eric S. Raymond                                 *
41.\" *                          esr@snark.thyrsus.com                           *
42.\" *                                                                          *
43.\" *        Permission is hereby granted to reproduce and distribute ncurses  *
44.\" *        by any means and for any fee, whether alone or as part of a       *
45.\" *        larger distribution, in source or in binary form, PROVIDED        *
46.\" *        this notice is included with any such distribution, and is not    *
47.\" *        removed from any of its header files. Mention of ncurses in any   *
48.\" *        applications linked with it is highly appreciated.                *
49.\" *                                                                          *
50.\" *        ncurses comes AS IS with no warranty, implied or expressed.       *
51.\" *                                                                          *
52.\" ***************************************************************************/
53.\"
54.\" $FreeBSD$
55.\"
56.Dd December 13, 2009
57.Dt TERMCAP 5
58.Os
59.Sh NAME
60.Nm termcap
61.Nd terminal capability data base
62.Sh SYNOPSIS
63.Nm
64.Sh DESCRIPTION
65The
66.Nm
67file
68is a data base describing terminals,
69used,
70for example,
71by
72.Xr \&vi 1
73and
74.Xr ncurses 3 .
75Terminals are described in
76.Nm
77by giving a set of capabilities that they have and by describing
78how operations are performed.
79Padding requirements and initialization sequences
80are included in
81.Nm .
82.Pp
83Entries in
84.Nm
85consist of a number of `:'-separated fields.
86The first entry for each terminal gives the names that are known for the
87terminal, separated by `|' characters.
88The first name given is the most common abbreviation for the terminal.
89The last name given should be a long name fully identifying the terminal,
90and all others are understood as synonyms for the terminal name.
91All names but the last should be in lower case and contain no blanks;
92the last name may well contain upper case characters and blanks for
93readability.
94.Pp
95Terminal names (except for the last, verbose entry)
96should be chosen using the following conventions.
97The particular piece of hardware making up the terminal
98should have a root name chosen, thus
99.Dq hp2621
100This name should not contain hyphens.
101Modes that the hardware can be in
102or user preferences
103should be indicated by appending a hyphen and an indicator of the mode.
104Therefore, a
105.Dq vt100
106in 132-column mode would be
107.Dq vt100-w .
108The following suffixes should be used where possible:
109.Bl -column indent "With automatic margins (usually default)xx" -offset indent
110.Sy "Suffix	Meaning	Example"
111-w	Wide mode (more than 80 columns)	vt100-w
112-am	With automatic margins (usually default)	vt100-am
113-nam	Without automatic margins	vt100-nam
114.Pf \- Ar n Ta No "Number of lines on screen	aaa-60"
115-na	No arrow keys (leave them in local)	concept100-na
116.Pf \- Ar \&np Ta No "Number of pages of memory	concept100-4p"
117-rv	Reverse video	concept100-rv
118.El
119.Sh CAPABILITIES
120The description field attempts to convey the semantics of the
121capability.
122You may find some codes in the description field:
123.Bl -tag -width #[1-9]
124.It (P)
125indicates that padding may be specified.
126.It #[1-9]
127in the description field indicates that the string is passed through
128.Xr tparm 3
129or
130.Xr tgoto 3
131with parms as given (#\fIi\fP).
132.It (P*)
133indicates that padding may vary in proportion to the number of
134lines affected.
135.It (#\d\fIi\fP\u)
136indicates the \fIi\fP\uth\d parameter.
137.El
138.Pp
139These are the boolean capabilities:
140.Bd -literal
141\fBBoolean			TCap	Description\fR
142\fBVariables		Code\fR
143auto_left_margin	bw	cursor_left wraps from column 0	to last
144				column
145auto_right_margin	am	terminal has automatic margins
146no_esc_ctlc		xb	beehive	(f1=escape, f2=ctrl C)
147ceol_standout_glitch	xs	standout not erased by overwriting (hp)
148eat_newline_glitch	xn	newline	ignored	after 80 cols (concept)
149erase_overstrike	eo	can erase overstrikes with a blank
150generic_type		gn	generic	line type
151hard_copy		hc	hardcopy terminal
152has_meta_key		km	Has a meta key,	sets msb high
153has_status_line		hs	has extra status line
154insert_null_glitch	in	insert mode distinguishes nulls
155memory_above		da	display	may be retained	above the screen
156memory_below		db	display	may be retained	below the screen
157move_insert_mode	mi	safe to	move while in insert mode
158move_standout_mode	ms	safe to	move while in standout mode
159over_strike		os	terminal can overstrike
160status_line_esc_ok	es	escape can be used on the status line
161dest_tabs_magic_smso	xt	tabs destructive, magic	so char	(t1061)
162tilde_glitch		hz	cannot print ~'s (hazeltine)
163transparent_underline	ul	underline character overstrikes
164xon_xoff		xo	terminal uses xon/xoff handshaking
165needs_xon_xoff		nx	padding	will not work, xon/xoff required
166prtr_silent		5i	printer	will not echo on screen
167hard_cursor		HC	cursor is hard to see
168non_rev_rmcup		NR	enter_ca_mode does not reverse exit_ca_mode
169no_pad_char		NP	pad character does not exist
170non_dest_scroll_region	ND	scrolling region is non-destructive
171can_change		cc	terminal can re-define existing	colors
172back_color_erase	ut	screen erased with background color
173hue_lightness_saturation	hl	terminal uses only HLS color
174					notation (tektronix)
175col_addr_glitch		YA	only positive motion for column	address	and
176				micro_column_address caps
177cr_cancels_micro_mode	YB	using cr turns off micro mode
178has_print_wheel		YC	printer	needs operator to change character
179				set
180row_addr_glitch		YD	only positive motion for row_address and
181				micro_row_address caps
182semi_auto_right_margin	YE	printing in last column	causes cr
183cpi_changes_res		YF	changing character pitch changes resolution
184lpi_changes_res		YG	changing line pitch changes resolution
185.Ed
186.Pp
187These are the numeric capabilities:
188.Bd -literal
189\fBNumeric			TCap	Description\fR
190\fBVariables		Code\fR
191columns			co	number of columns in aline
192init_tabs		it	tabs initially every # spaces
193lines			li	number of lines	on screen or page
194lines_of_memory		lm	lines of memory	if > line. 0 =>	varies
195magic_cookie_glitch	sg	number of blank	chars left by
196				enter_standout_mode or exit_standout_mode
197padding_baud_rate	pb	lowest baud rate where padding needed
198virtual_terminal	vt	virtual	terminal number	(CB/unix)
199width_status_line	ws	columns	in status line
200num_labels		Nl	number of labels on screen
201label_height		lh	rows in	each label
202label_width		lw	columns	in each	label
203max_attributes		ma	maximum	combined attributes terminal can
204				handle
205maximum_windows		MW	maximum	number of definable windows
206magic_cookie_glitch_ul	ug	number of blanks left by underline
207#
208# These came in with SVr4's color support
209#
210max_colors		Co	maximum	numbers	of colors on screen
211max_pairs		pa	maximum	number of color-pairs on the screen
212no_color_video		NC	video attributes that cannot be used with
213				colors
214#
215# The following	numeric	capabilities are present in the	SVr4.0 term
216# structure, but are not yet documented	in the man page.
217# They came in with SVr4's printer support.
218#
219buffer_capacity		Ya	numbers	of bytes buffered before printing
220dot_vert_spacing	Yb	spacing	of pins	vertically in pins per inch
221dot_horz_spacing	Yc	spacing	of dots	horizontally in	dots per
222				inch
223max_micro_address	Yd	maximum	value in micro_..._address
224max_micro_jump		Ye	maximum	value in parm_..._micro
225micro_char_size		Yf	character size when in micro mode
226micro_line_size		Yg	line size when in micro	mode
227number_of_pins		Yh	numbers	of pins	in print-head
228output_res_char		Yi	horizontal resolution in units per line
229output_res_line		Yj	vertical resolution in units per line
230output_res_horz_inch	Yk	horizontal resolution in units per inch
231output_res_vert_inch	Yl	vertical resolution in units per inch
232print_rate		Ym	print rate in chars per	second
233wide_char_size		Yn	character step size when in double wide
234				mode
235buttons			BT	number of buttons on mouse
236bit_image_entwining	Yo	number of passed for each bit-image row
237bit_image_type		Yp	type of	bit-image device
238.Ed
239.Pp
240These are the string capabilities:
241.Bd -literal
242\fBString			TCap	Description\fR
243\fBVariables		Code\fR
244back_tab		bt	back tab (P)
245bell			bl	audible	signal (bell) (P)
246carriage_return		cr	carriage return	(P*)
247change_scroll_region	cs	change region to line #1 to line #2 (P)
248clear_all_tabs		ct	clear all tab stops (P)
249clear_screen		cl	clear screen and home cursor (P*)
250clr_eol			ce	clear to end of	line (P)
251clr_eos			cd	clear to end of	screen (P*)
252column_address		ch	horizontal position #1,	absolute (P)
253command_character	CC	terminal settable cmd character	in
254				prototype
255cursor_address		cm	move to	row #1 columns #2
256cursor_down		do	down one line
257cursor_home		ho	home cursor
258cursor_invisible	vi	make cursor invisible
259cursor_left		le	move left one space
260cursor_mem_address	CM	memory relative	cursor addressing
261cursor_normal		ve	make cursor appear normal (undo
262				cursor_invisible/cursor_visible)
263cursor_right		nd	move right one space
264cursor_to_ll		ll	last line, first column
265cursor_up		up	up one line
266cursor_visible		vs	make cursor very visible
267delete_character	dc	delete character (P*)
268delete_line		dl	delete line (P*)
269dis_status_line		ds	disable	status line
270down_half_line		hd	half a line down
271enter_alt_charset_mode	as	start alternate	character set (P)
272enter_blink_mode	mb	turn on	blinking
273enter_bold_mode		md	turn on	bold (extra bright) mode
274enter_ca_mode		ti	string to start	programs using
275				cursor_address
276enter_delete_mode	dm	enter delete mode
277enter_dim_mode		mh	turn on	half-bright mode
278enter_insert_mode	im	enter insert mode
279enter_secure_mode	mk	turn on	blank mode (characters invisible)
280enter_protected_mode	mp	turn on	protected mode
281enter_reverse_mode	mr	turn on	reverse	video mode
282enter_standout_mode	so	begin standout mode
283enter_underline_mode	us	begin underline	mode
284erase_chars		ec	erase #1 characters (P)
285exit_alt_charset_mode	ae	end alternate character	set (P)
286exit_attribute_mode	me	turn off all attributes
287exit_ca_mode		te	strings	to end programs	using cup
288exit_delete_mode	ed	end delete mode
289exit_insert_mode	ei	exit insert mode
290exit_standout_mode	se	exit standout mode
291exit_underline_mode	ue	exit underline mode
292flash_screen		vb	visible	bell (may not move cursor)
293form_feed		ff	hardcopy terminal page eject (P*)
294from_status_line	fs	return from status line
295init_1string		i1	initialization string
296init_2string		is	initialization string
297init_3string		i3	initialization string
298init_file		if	name of	initialization file
299insert_character	ic	insert character (P)
300insert_line		al	insert line (P*)
301insert_padding		ip	insert padding after inserted character
302key_backspace		kb	backspace key
303key_catab		ka	clear-all-tabs key
304key_clear		kC	clear-screen or	erase key
305key_ctab		kt	clear-tab key
306key_dc			kD	delete-character key
307key_dl			kL	delete-line key
308key_down		kd	down-arrow key
309key_eic			kM	sent by	rmir or	smir in	insert mode
310key_eol			kE	clear-to-end-of-line key
311key_eos			kS	clear-to-end-of-screen key
312key_f0			k0	F0 function key
313key_f1			k1	F1 function key
314key_f10			k;	F10 function key
315key_f2			k2	F2 function key
316key_f3			k3	F3 function key
317key_f4			k4	F4 function key
318key_f5			k5	F5 function key
319key_f6			k6	F6 function key
320key_f7			k7	F7 function key
321key_f8			k8	F8 function key
322key_f9			k9	F9 function key
323key_home		kh	home key
324key_ic			kI	insert-character key
325key_il			kA	insert-line key
326key_left		kl	left-arrow key
327key_ll			kH	last-line key
328key_npage		kN	next-page key
329key_ppage		kP	prev-page key
330key_right		kr	right-arrow key
331key_sf			kF	scroll-forward key
332key_sr			kR	scroll-backward	key
333key_stab		kT	set-tab	key
334key_up			ku	up-arrow key
335keypad_local		ke	leave 'keyboard_transmit' mode
336keypad_xmit		ks	enter 'keyboard_transmit' mode
337lab_f0			l0	label on function key f0 if not	f0
338lab_f1			l1	label on function key f1 if not	f1
339lab_f10			la	label on function key f10 if not f10
340lab_f2			l2	label on function key f2 if not	f2
341lab_f3			l3	label on function key f3 if not	f3
342lab_f4			l4	label on function key f4 if not	f4
343lab_f5			l5	label on function key f5 if not	f5
344lab_f6			l6	label on function key f6 if not	f6
345lab_f7			l7	label on function key f7 if not	f7
346lab_f8			l8	label on function key f8 if not	f8
347lab_f9			l9	label on function key f9 if not	f9
348meta_off		mo	turn off meta mode
349meta_on			mm	turn on	meta mode (8th-bit on)
350newline			nw	newline	(behave	like cr	followed by lf)
351pad_char		pc	padding	char (instead of null)
352parm_dch		DC	delete #1 chars	(P*)
353parm_delete_line	DL	delete #1 lines	(P*)
354parm_down_cursor	DO	down #1	lines (P*)
355parm_ich		IC	insert #1 chars	(P*)
356parm_index		SF	scroll forward #1 lines	(P)
357parm_insert_line	AL	insert #1 lines	(P*)
358parm_left_cursor	LE	move #1	chars to the left (P)
359parm_right_cursor	RI	move #1	chars to the right (P*)
360parm_rindex		SR	scroll back #1 lines (P)
361parm_up_cursor		UP	up #1 lines (P*)
362pkey_key		pk	program	function key #1	to type	string #2
363pkey_local		pl	program	function key #1	to execute
364				string #2
365pkey_xmit		px	program	function key #1	to transmit
366				string #2
367print_screen		ps	print contents of screen
368prtr_off		pf	turn off printer
369prtr_on			po	turn on	printer
370repeat_char		rp	repeat char #1 #2 times	(P*)
371reset_1string		r1	reset string
372reset_2string		r2	reset string
373reset_3string		r3	reset string
374reset_file		rf	name of	reset file
375restore_cursor		rc	restore	cursor to last position	of
376				save_cursor
377row_address		cv	vertical position #1 absolute (P)
378save_cursor		sc	save current cursor position (P)
379scroll_forward		sf	scroll text up (P)
380scroll_reverse		sr	scroll text down (P)
381set_attributes		sa	define video attributes	#1-#9 (PG9)
382set_tab			st	set a tab in every row,	current	columns
383set_window		wi	current	window is lines	#1-#2 cols #3-#4
384tab			ta	tab to next 8-space hardware tab stop
385to_status_line		ts	move to	status line
386underline_char		uc	underline char and move	past it
387up_half_line		hu	half a line up
388init_prog		iP	path name of program for initialization
389key_a1			K1	upper left of keypad
390key_a3			K3	upper right of keypad
391key_b2			K2	center of keypad
392key_c1			K4	lower left of keypad
393key_c3			K5	lower right of keypad
394prtr_non		pO	turn on	printer	for #1 bytes
395termcap_init2		i2	secondary initialization string
396termcap_reset		rs	terminal reset string
397#
398# SVr1 capabilities stop here.	IBM's version of terminfo is the same as
399# SVr4 up to this point, but has a different set afterwards.
400#
401char_padding		rP	like insert_padding but	when in	insert mode
402acs_chars		ac	graphics charset pairs - def=vt100
403plab_norm		pn	program	label #1 to show string	#2
404key_btab		kB	back-tab key
405enter_xon_mode		SX	turn on	xon/xoff handshaking
406exit_xon_mode		RX	turn off xon/xoff handshaking
407enter_am_mode		SA	turn on	automatic margins
408exit_am_mode		RA	turn off automatic margins
409xon_character		XN	XON character
410xoff_character		XF	XOFF character
411ena_acs			eA	enable alternate char set
412label_on		LO	turn on	soft labels
413label_off		LF	turn off soft labels
414key_beg			@1	begin key
415key_cancel		@2	cancel key
416key_close		@3	close key
417key_command		@4	command	key
418key_copy		@5	copy key
419key_create		@6	create key
420key_end			@7	end key
421key_enter		@8	enter/send key
422key_exit		@9	exit key
423key_find		@0	find key
424key_help		%1	help key
425key_mark		%2	mark key
426key_message		%3	message	key
427key_move		%4	move key
428key_next		%5	next key
429key_open		%6	open key
430key_options		%7	options	key
431key_previous		%8	previous key
432key_print		%9	print key
433key_redo		%0	redo key
434key_reference		&1	reference key
435key_refresh		&2	refresh	key
436key_replace		&3	replace	key
437key_restart		&4	restart	key
438key_resume		&5	resume key
439key_save		&6	save key
440key_suspend		&7	suspend	key
441key_undo		&8	undo key
442key_sbeg		&9	shifted	key
443key_scancel		&0	shifted	key
444key_scommand		*1	shifted	key
445key_scopy		*2	shifted	key
446key_screate		*3	shifted	key
447key_sdc			*4	shifted	key
448key_sdl			*5	shifted	key
449key_select		*6	select key
450key_send		*7	shifted	key
451key_seol		*8	shifted	key
452key_sexit		*9	shifted	key
453key_sfind		*0	shifted	key
454key_shelp		#1	shifted	key
455key_shome		#2	shifted	key
456key_sic			#3	shifted	key
457key_sleft		#4	shifted	key
458key_smessage		%a	shifted	key
459key_smove		%b	shifted	key
460key_snext		%c	shifted	key
461key_soptions		%d	shifted	key
462key_sprevious		%e	shifted	key
463key_sprint		%f	shifted	key
464key_sredo		%g	shifted	key
465key_sreplace		%h	shifted	key
466key_sright		%i	shifted	key
467key_srsume		%j	shifted	key
468key_ssave		!1	shifted	key
469key_ssuspend		!2	shifted	key
470key_sundo		!3	shifted	key
471req_for_input		RF	send next input	char (for ptys)
472key_f11			F1	F11 function key
473key_f12			F2	F12 function key
474key_f13			F3	F13 function key
475key_f14			F4	F14 function key
476key_f15			F5	F15 function key
477key_f16			F6	F16 function key
478key_f17			F7	F17 function key
479key_f18			F8	F18 function key
480key_f19			F9	F19 function key
481key_f20			FA	F20 function key
482key_f21			FB	F21 function key
483key_f22			FC	F22 function key
484key_f23			FD	F23 function key
485key_f24			FE	F24 function key
486key_f25			FF	F25 function key
487key_f26			FG	F26 function key
488key_f27			FH	F27 function key
489key_f28			FI	F28 function key
490key_f29			FJ	F29 function key
491key_f30			FK	F30 function key
492key_f31			FL	F31 function key
493key_f32			FM	F32 function key
494key_f33			FN	F33 function key
495key_f34			FO	F34 function key
496key_f35			FP	F35 function key
497key_f36			FQ	F36 function key
498key_f37			FR	F37 function key
499key_f38			FS	F38 function key
500key_f39			FT	F39 function key
501key_f40			FU	F40 function key
502key_f41			FV	F41 function key
503key_f42			FW	F42 function key
504key_f43			FX	F43 function key
505key_f44			FY	F44 function key
506key_f45			FZ	F45 function key
507key_f46			Fa	F46 function key
508key_f47			Fb	F47 function key
509key_f48			Fc	F48 function key
510key_f49			Fd	F49 function key
511key_f50			Fe	F50 function key
512key_f51			Ff	F51 function key
513key_f52			Fg	F52 function key
514key_f53			Fh	F53 function key
515key_f54			Fi	F54 function key
516key_f55			Fj	F55 function key
517key_f56			Fk	F56 function key
518key_f57			Fl	F57 function key
519key_f58			Fm	F58 function key
520key_f59			Fn	F59 function key
521key_f60			Fo	F60 function key
522key_f61			Fp	F61 function key
523key_f62			Fq	F62 function key
524key_f63			Fr	F63 function key
525clr_bol			cb	Clear to beginning of line
526clear_margins		MC	clear right and	left soft margins
527set_left_margin		ML	set left soft margin
528set_right_margin	MR	set right soft margin
529label_format		Lf	label format
530set_clock		SC	set clock, #1 hrs #2 mins #3 secs
531display_clock		DK	display	clock at (#1,#2)
532remove_clock		RC	remove clock
533create_window		CW	define a window	#1 from	#2, #3 to #4, #5
534goto_window		WG	go to window #1
535hangup			HU	hang-up	phone
536dial_phone		DI	dial number #1
537quick_dial		QD	dial number #1 without checking
538tone			TO	select touch tone dialing
539pulse			PU	select pulse dialling
540flash_hook		fh	flash switch hook
541fixed_pause		PA	pause for 2-3 seconds
542wait_tone		WA	wait for dial-tone
543user0			u0	User string #0
544user1			u1	User string #1
545user2			u2	User string #2
546user3			u3	User string #3
547user4			u4	User string #4
548user5			u5	User string #5
549user6			u6	User string #6
550user7			u7	User string #7
551user8			u8	User string #8
552user9			u9	User string #9
553#
554# SVr4 added these capabilities to support color
555#
556orig_pair		op	Set default pair to its	original value
557orig_colors		oc	Set all	color pairs to the original ones
558initialize_color	Ic	initialize color #1 to (#2,#3,#4)
559initialize_pair		Ip	Initialize color pair #1 to fg=(#2,#3,#4),
560				bg=(#5,#6,#7)
561set_color_pair		sp	Set current color pair to #1
562set_foreground		Sf	Set foreground color #1
563set_background		Sb	Set background color #1
564#
565# SVr4 added these capabilities to support printers
566#
567change_char_pitch	ZA	Change number of characters per	inch
568change_line_pitch	ZB	Change number of lines per inch
569change_res_horz		ZC	Change horizontal resolution
570change_res_vert		ZD	Change vertical	resolution
571define_char		ZE	Define a character
572enter_doublewide_mode	ZF	Enter double-wide mode
573enter_draft_quality	ZG	Enter draft-quality mode
574enter_italics_mode	ZH	Enter italic mode
575enter_leftward_mode	ZI	Start leftward carriage	motion
576enter_micro_mode	ZJ	Start micro-motion mode
577enter_near_letter_quality	ZK	Enter NLQ mode
578enter_normal_quality	ZL	Enter normal-quality mode
579enter_shadow_mode	ZM	Enter shadow-print mode
580enter_subscript_mode	ZN	Enter subscript	mode
581enter_superscript_mode	ZO	Enter superscript mode
582enter_upward_mode	ZP	Start upward carriage motion
583exit_doublewide_mode	ZQ	End double-wide	mode
584exit_italics_mode	ZR	End italic mode
585exit_leftward_mode	ZS	End left-motion	mode
586exit_micro_mode		ZT	End micro-motion mode
587exit_shadow_mode	ZU	End shadow-print mode
588exit_subscript_mode	ZV	End subscript mode
589exit_superscript_mode	ZW	End superscript	mode
590exit_upward_mode	ZX	End reverse character motion
591micro_column_address	ZY	Like column_address in micro mode
592micro_down		ZZ	Like cursor_down in micro mode
593micro_left		Za	Like cursor_left in micro mode
594micro_right		Zb	Like cursor_right in micro mode
595micro_row_address	Zc	Like row_address in micro mode
596micro_up		Zd	Like cursor_up in micro	mode
597order_of_pins		Ze	Match software bits to print-head pins
598parm_down_micro		Zf	Like parm_down_cursor in micro mode
599parm_left_micro		Zg	Like parm_left_cursor in micro mode
600parm_right_micro	Zh	Like parm_right_cursor in micro	mode
601parm_up_micro		Zi	Like parm_up_cursor in micro mode
602select_char_set		Zj	Select character set
603set_bottom_margin	Zk	Set bottom margin at current line
604set_bottom_margin_parm	Zl	Set bottom margin at line #1 or	#2 lines
605				from bottom
606set_left_margin_parm	Zm	Set left (right) margin	at column #1 (#2)
607set_right_margin_parm	Zn	Set right margin at column #1
608set_top_margin		Zo	Set top	margin at current line
609set_top_margin_parm	Zp	Set top	(bottom) margin	at row #1 (#2)
610start_bit_image		Zq	Start printing bit image graphics
611start_char_set_def	Zr	Start character	set definition
612stop_bit_image		Zs	Stop printing bit image	graphics
613stop_char_set_def	Zt	End definition of character aet
614subscript_characters	Zu	List of	subscriptible characters
615superscript_characters	Zv	List of	superscriptible	characters
616these_cause_cr		Zw	Printing any of	these chars causes CR
617zero_motion		Zx	No motion for subsequent character
618#
619# The following	string capabilities are	present	in the SVr4.0 term
620# structure, but are not documented in the man page.
621#
622char_set_names		Zy	List of	character set names
623key_mouse		Km	Mouse event has	occurred
624mouse_info		Mi	Mouse status information
625req_mouse_pos		RQ	Request	mouse position
626get_mouse		Gm	Curses should get button events
627set_a_foreground	AF	Set ANSI foreground color
628set_a_background	AB	Set ANSI background color
629pkey_plab		xl	Program	function key #1	to type	string #2
630				and show string	#3
631device_type		dv	Indicate language/codeset support
632code_set_init		ci	Init sequence for multiple codesets
633set0_des_seq		s0	Shift to code set 0 (EUC set 0,	ASCII)
634set1_des_seq		s1	Shift to code set 1
635set2_des_seq		s2	Shift to code set 2
636set3_des_seq		s3	Shift to code set 3
637set_lr_margin		ML	Set both left and right	margins	to #1, #2
638set_tb_margin		MT	Sets both top and bottom margins to #1,	#2
639bit_image_repeat	Xy	Repeat bit image cell #1 #2 times
640bit_image_newline	Zz	Move to	next row of the	bit image
641bit_image_carriage_return	Yv	Move to	beginning of same row
642color_names		Yw	Give name for color #1
643define_bit_image_region	Yx	Define rectangular bit image region
644end_bit_image_region	Yy	End a bit-image	region
645set_color_band		Yz	Change to ribbon color #1
646set_page_length		YZ	Set page length	to #1 lines
647#
648# SVr4 added these capabilities for direct PC-clone support
649#
650display_pc_char		S1	Display	PC character
651enter_pc_charset_mode	S2	Enter PC character display mode
652exit_pc_charset_mode	S3	Exit PC	character display mode
653enter_scancode_mode	S4	Enter PC scancode mode
654exit_scancode_mode	S5	Exit PC	scancode mode
655pc_term_options		S6	PC terminal options
656scancode_escape		S7	Escape for scancode emulation
657alt_scancode_esc	S8	Alternate escape for scancode emulation
658#
659# The XSI Curses standard added	these.
660#
661enter_horizontal_hl_mode	Xh	Enter horizontal highlight mode
662enter_left_hl_mode	Xl	Enter left highlight mode
663enter_low_hl_mode	Xo	Enter low highlight mode
664enter_right_hl_mode	Xr	Enter right highlight mode
665enter_top_hl_mode	Xt	Enter top highlight mode
666enter_vertical_hl_mode	Xv	Enter vertical highlight mode
667.Ed
668.Pp
669Obsolete termcap capabilities.
670New software should not rely on them at all.
671.Bd -literal
672\fBBoolean			TCap	Description\fR
673\fBVariables		Code\fR
674linefeed_is_newline	NL	move down with ^J
675even_parity		EP	terminal requires even parity
676odd_parity		OP	terminal requires odd parity
677half_duplex		HD	terminal is half-duplex
678lower_case_only		LC	terminal has only lower	case
679upper_case_only		UC	terminal has only upper	case
680has_hardware_tabs	pt	has 8-char tabs	invoked	with ^I
681return_does_clr_eol	xr	return clears the line
682tek_4025_insert_line	xx	Tektronix 4025 insert-line glitch
683backspaces_with_bs	bs	uses ^H	to move	left
684crt_no_scrolling	ns	crt cannot scroll
685no_correctly_working_cr	nc	no way to go to	start of line
686.Ed
687.Bd -literal
688\fBNumber			TCap	Description\fR
689\fBVariables		Code\fR
690backspace_delay		dB	padding	required for ^H
691form_feed_delay		dF	padding	required for ^L
692horizontal_tab_delay	dT	padding	required for ^I
693vertical_tab_delay	dV	padding	required for ^V
694number_of_function_keys	kn	count of function keys
695carriage_return_delay	dC	pad needed for CR
696new_line_delay		dN	pad needed for LF
697.Ed
698.Bd -literal
699\fBString			TCap	Description\fR
700\fBVariables		Code\fR
701other_non_function_keys	ko	list of	self-mapped keycaps
702arrow_key_map		ma	map arrow keys
703memory_lock_above	ml	lock visible screen memory above the
704				current	line
705memory_unlock		mu	unlock visible screen memory above the
706				current	line
707linefeed_if_not_lf	nl	use to move down
708backspace_if_not_bs	bc	move left, if not ^H
709.Ed
710.Ss A Sample Entry
711The following entry, which describes the Concept\-100, is among the more
712complex entries in the
713.Nm
714file as of this writing.
715.Bd -literal
716ca\||\|concept100\||\|c100\||\|concept\||\|c104\||\|concept100-4p\||\|HDS Concept\-100:\e
717	:al=3*\eE^R:am:bl=^G:cd=16*\eE^C:ce=16\eE^U:cl=2*^L:cm=\eEa%+ %+ :\e
718	:co#80:.cr=9^M:db:dc=16\eE^A:dl=3*\eE^B:do=^J:ei=\eE\e200:eo:im=\eE^P:in:\e
719	:ip=16*:is=\eEU\eEf\eE7\eE5\eE8\eEl\eENH\eEK\eE\e200\eEo&\e200\eEo\e47\eE:k1=\eE5:\e
720	:k2=\eE6:k3=\eE7:kb=^h:kd=\eE<:ke=\eEx:kh=\eE?:kl=\eE>:kr=\eE=:ks=\eEX:\e
721	:ku=\eE;:le=^H:li#24:mb=\eEC:me=\eEN\e200:mh=\eEE:mi:mk=\eEH:mp=\eEI:\e
722	:mr=\eED:nd=\eE=:pb#9600:rp=0.2*\eEr%.%+ :se=\eEd\eEe:sf=^J:so=\eEE\eED:\e
723	:.ta=8\et:te=\eEv    \e200\e200\e200\e200\e200\e200\eEp\er\en:\e
724	:ti=\eEU\eEv  8p\eEp\er:ue=\eEg:ul:up=\eE;:us=\eEG:\e
725	:vb=\eEk\e200\e200\e200\e200\e200\e200\e200\e200\e200\e200\e200\e200\e200\e200\eEK:\e
726	:ve=\eEw:vs=\eEW:vt#8:xn:\e
727	:bs:cr=^M:dC#9:dT#8:nl=^J:ta=^I:pt:
728.Ed
729.Pp
730Entries may continue onto multiple lines by giving a \e as the last
731character of a line, and empty fields
732may be included for readability (here between the last field on a line
733and the first field on the next).
734Comments may be included on lines beginning with
735.Dq # .
736.Ss Types of Capabilities
737Capabilities in
738.Nm
739are of three types: Boolean capabilities,
740which indicate particular features that the terminal has;
741numeric capabilities,
742giving the size of the display or the size of other attributes;
743and string capabilities,
744which give character sequences that can be used to perform particular
745terminal operations.
746All capabilities have two-letter codes.
747For instance, the fact that
748the Concept has
749.Em automatic margins
750(an automatic return and linefeed
751when the end of a line is reached) is indicated by the Boolean capability
752.Sy \&am .
753Hence the description of the Concept includes
754.Sy \&am .
755.Pp
756Numeric capabilities are followed by the character `#' then the value.
757In the example above
758.Sy \&co ,
759which indicates the number of columns the display has,
760gives the value `80' for the Concept.
761.Pp
762Finally, string-valued capabilities, such as
763.Sy \&ce
764(clear-to-end-of-line
765sequence) are given by the two-letter code, an `=', then a string
766ending at the next following `:'.
767A delay in milliseconds may appear after
768the `=' in such a capability,
769which causes padding characters to be supplied by
770.Xr tputs 3
771after the remainder of the string is sent to provide this delay.
772The delay can be either a number,
773such as `20', or a number followed by
774an `*',
775such as `3*'.
776An `*' indicates that the padding required is proportional
777to the number of lines affected by the operation, and the amount given is
778the per-affected-line padding required.
779(In the case of insert-character,
780the factor is still the number of
781.Em lines
782affected;
783this is always 1 unless the terminal has
784.Sy \&in
785and the software uses it.)
786When an `*' is specified, it is sometimes useful to give a delay of the form
787`3.5' to specify a delay per line to tenths of milliseconds.
788(Only one decimal place is allowed.)
789.Pp
790A number of escape sequences are provided in the string-valued capabilities
791for easy encoding of control characters there.
792.Sy \&\eE
793maps to an
794.Dv ESC
795character,
796.Sy \&^X
797maps to a control-X for any appropriate X,
798and the sequences
799.Sy \&\en
800.Sy \&\er
801.Sy \&\et
802.Sy \&\eb
803.Sy \&\ef
804map to linefeed, return, tab, backspace, and formfeed, respectively.
805Finally, characters may be given as three octal digits after a
806.Sy \&\e ,
807and the characters
808.Sy \&^
809and
810.Sy \&\e
811may be given as
812.Sy \&\e^
813and
814.Sy \&\e\e .
815If it is necessary to place a
816.Sy \&:
817in a capability it must be escaped as
818.Sy \e:
819or be encoded as
820.Sy \&\e072 .
821If it is necessary to place a
822.Dv NUL
823character in a string capability it
824must be encoded as
825.Sy \&\e200 .
826(The routines that deal with
827.Nm
828use C strings and strip the high bits of the output very late, so that
829a
830.Sy \&\e200
831comes out as a
832.Sy \&\e000
833would.)
834.Pp
835Sometimes individual capabilities must be commented out.
836To do this, put a period before the capability name.
837For example, see the first
838.Sy \&cr
839and
840.Sy \&ta
841in the example above.
842.Ss Preparing Descriptions
843The most effective way to prepare a terminal description is by imitating
844the description of a similar terminal in
845.Nm
846and to build up a description gradually, using partial descriptions
847with
848.Xr \&vi 1
849to check that they are correct.
850Be aware that a very unusual terminal may expose deficiencies in
851the ability of the
852.Nm
853file to describe it
854or bugs in
855.Xr \&vi 1 .
856To easily test a new terminal description you are working on
857you can put it in your home directory in a file called
858.Pa .termcap
859and programs will look there before looking in
860.Pa /usr/share/misc/termcap .
861You can also set the environment variable
862.Ev TERMPATH
863to a list of absolute file pathnames (separated by spaces or colons),
864one of which contains the description you are working on,
865and programs will search them in the order listed, and nowhere else.
866See
867.Xr termcap 3 .
868The
869.Ev TERMCAP
870environment variable is usually set to the
871.Nm
872entry itself
873to avoid reading files when starting up a program.
874.Pp
875To get the padding for insert-line right
876(if the terminal manufacturer did not document it),
877a severe test is to use
878.Xr \&vi 1
879to edit
880.Pa /etc/passwd
881at 9600 baud, delete roughly 16 lines from the middle of the screen,
882then hit the `u' key several times quickly.
883If the display messes up, more padding is usually needed.
884A similar test can be used for insert-character.
885.Ss Basic Capabilities
886The number of columns on each line of the display is given by the
887.Sy \&co
888numeric capability.
889If the display is a
890.Tn CRT ,
891then the
892number of lines on the screen is given by the
893.Sy \&li
894capability.
895If the display wraps around to the beginning of the next line when
896the cursor reaches the right margin, then it should have the
897.Sy \&am
898capability.
899If the terminal can clear its screen,
900the code to do this is given by the
901.Sy \&cl
902string capability.
903If the terminal overstrikes
904(rather than clearing the position when a character is overwritten),
905it should have the
906.Sy \&os
907capability.
908If the terminal is a printing terminal,
909with no soft copy unit,
910give it both
911.Sy \&hc
912and
913.Sy \&os .
914.Pf ( Sy \&os
915applies to storage scope terminals,
916such as the Tektronix 4010 series,
917as well as to hard copy and
918.Tn APL
919terminals.)
920If there is a code to move the cursor to the left edge of the current row,
921give this as
922.Sy \&cr .
923(Normally this will be carriage-return,
924.Sy \&^M . )
925If there is a code to produce an audible signal (bell, beep,
926etc.),
927give this as
928.Sy \&bl .
929.Pp
930If there is a code (such as backspace)
931to move the cursor one position to the left,
932that capability should be given as
933.Sy \&le .
934Similarly,
935codes to move to the right, up, and down
936should be given as
937.Sy \&nd ,
938.Sy \&up ,
939and
940.Sy \&do ,
941respectively.
942These
943.Em local cursor motions
944should not alter the text they pass over;
945for example, you would not normally use
946.Dq nd=\ \&
947unless the terminal has the
948.Sy \&os
949capability,
950because the space would erase the character moved over.
951.Pp
952A very important point here is that the local cursor motions encoded
953in
954.Nm
955have undefined behavior at the left and top edges of a
956.Tn CRT
957display.
958Programs should never attempt to backspace around the left edge,
959unless
960.Sy \&bw
961is given, and never attempt to go up off the top
962using local cursor motions.
963.Pp
964In order to scroll text up,
965a program goes to the bottom left corner of the screen and sends the
966.Sy \&sf
967(index) string.
968To scroll text down,
969a program goes to the top left corner of the screen and sends the
970.Sy \&sr
971(reverse index) string.
972The strings
973.Sy \&sf
974and
975.Sy \&sr
976have undefined behavior
977when not on their respective corners of the screen.
978Parameterized versions of the scrolling sequences are
979.Sy \&SF
980and
981.Sy \&SR ,
982which have the same semantics as
983.Sy \&sf
984and
985.Sy \&sr
986except that they take one parameter
987and scroll that many lines.
988They also have undefined behavior
989except at the appropriate corner of the screen.
990.Pp
991The
992.Sy \&am
993capability tells whether the cursor sticks at the right
994edge of the screen when text is output there,
995but this does not necessarily apply to
996.Sy \&nd
997from the last column.
998Leftward local motion is defined from the left edge only when
999.Sy \&bw
1000is given; then an
1001.Sy \&le
1002from the left edge will move to the right edge of the previous row.
1003This is useful for drawing a box around the edge of the screen,
1004for example.
1005If the terminal has switch-selectable automatic margins,
1006the
1007.Nm
1008description usually assumes that this feature is on,
1009.Em i.e . ,
1010.Sy \&am .
1011If the terminal has a command
1012that moves to the first column of the next line,
1013that command can be given as
1014.Sy \&nw
1015(newline).
1016It is permissible for this to clear the remainder of the current line,
1017so if the terminal has no correctly-working
1018.Tn \&CR
1019and
1020.Tn \&LF
1021it may still be possible to craft a working
1022.Sy \&nw
1023out of one or both of them.
1024.Pp
1025These capabilities suffice to describe hardcopy and
1026.Dq glass-tty
1027terminals.
1028Thus the Teletype model 33 is described as
1029.Bd -literal -offset indent
1030T3\||\|tty33\||\|33\||\|tty\||\|Teletype model 33:\e
1031	:bl=^G:co#72:cr=^M:do=^J:hc:os:
1032.Ed
1033.Pp
1034and the Lear Siegler
1035.Tn ADM Ns \-3
1036is described as
1037.Bd -literal -offset indent
1038l3\||\|adm3\||\|3\||\|LSI ADM-3:\e
1039:am:bl=^G:cl=^Z:co#80:cr=^M:do=^J:le=^H:li#24:sf=^J:
1040.Ed
1041.Ss Parameterized Strings
1042Cursor addressing and other strings requiring parameters
1043are described by a
1044parameterized string capability, with
1045.Xr printf 3 Ns \-like
1046escapes
1047.Sy \&%x
1048in it,
1049while other characters are passed through unchanged.
1050For example, to address the cursor the
1051.Sy \&cm
1052capability is given, using two parameters: the row and column to move to.
1053(Rows and columns are numbered from zero and refer to the physical screen
1054visible to the user, not to any unseen memory.
1055If the terminal has memory-relative cursor addressing,
1056that can be indicated by an analogous
1057.Sy \&CM
1058capability.)
1059.Pp
1060The
1061.Sy \&%
1062encodings have the following meanings:
1063.Bl -column xxxxx
1064.It "%%	output `%'"
1065.It "%d	output value as in"
1066.Xr printf 3
1067%d
1068.It "%2	output value as in"
1069.Xr printf 3
1070%2d
1071.It "%3	output value as in"
1072.Xr printf 3
1073%3d
1074.It "%.	output value as in"
1075.Xr printf 3
1076%c
1077.It "%+" Ns Em x Ta No add
1078.Em x
1079to value, then do %.
1080.It "%>" Ns Em \&xy Ta No if
1081value >
1082.Em x
1083then add
1084.Em y ,
1085no output
1086.It "%r	reverse order of two parameters, no output"
1087.It "%i	increment by one, no output"
1088.It "%n	exclusive-or all parameters with 0140 (Datamedia 2500)"
1089.It "\&%B" Ta Tn BCD No "(16*(value/10)) + (value%10), no output"
1090.It "%D	Reverse coding (value \- 2*(value%16)), no output (Delta Data)."
1091.El
1092.Pp
1093Consider the Hewlett-Packard 2645, which, to get to row 3 and column 12, needs
1094to be sent
1095.Dq \eE&a12c03Y
1096padded for 6 milliseconds.
1097Note that the order
1098of the row and column coordinates is reversed here
1099and that the row and column
1100are sent as two-digit integers.
1101Thus its
1102.Sy \&cm
1103capability is
1104.Dq Li cm=6\eE&%r%2c%2Y .
1105.Pp
1106The Datamedia 2500 needs the current row and column sent
1107encoded in binary using
1108.Dq \&%. .
1109Terminals that use
1110.Dq %.\&
1111need to be able to
1112backspace the cursor
1113.Pq Sy \&le
1114and to move the cursor up one line on the screen
1115.Pq Sy \&up .
1116This is necessary because it is not always safe to transmit
1117.Sy \&\en ,
1118.Sy \&^D ,
1119and
1120.Sy \&\er ,
1121as the system may change or discard them.
1122(Programs using
1123.Nm
1124must set terminal modes so that tabs are not expanded, so
1125.Sy \&\et
1126is safe to send.
1127This turns out to be essential for the Ann Arbor 4080.)
1128.Pp
1129A final example is the Lear Siegler
1130.Tn ADM Ns \-3a ,
1131which offsets row and column
1132by a blank character, thus
1133.Dq Li cm=\eE=%+ %+\ \& .
1134.Pp
1135Row or column absolute cursor addressing
1136can be given as single parameter capabilities
1137.Sy \&ch
1138(horizontal position absolute) and
1139.Sy \&cv
1140(vertical position absolute).
1141Sometimes these are shorter than the more general two-parameter sequence
1142(as with the Hewlett-Packard 2645) and can be used in preference to
1143.Sy \&cm .
1144If there are parameterized local motions
1145.Pf ( Em e.g . ,
1146move
1147.Ar n
1148positions to the right)
1149these can be given as
1150.Sy \&DO ,
1151.Sy \&LE ,
1152.Sy \&RI ,
1153and
1154.Sy \&UP
1155with a single parameter indicating how many positions to move.
1156These are primarily useful if the terminal does not have
1157.Sy \&cm ,
1158such as the Tektronix 4025.
1159.Ss Cursor Motions
1160.Pp
1161If the terminal has a fast way to home the cursor
1162(to the very upper left corner of the screen), this can be given as
1163.Sy \&ho .
1164Similarly, a fast way of getting to the lower left-hand corner
1165can be given as
1166.Sy \&ll ;
1167this may involve going up with
1168.Sy \&up
1169from the home position,
1170but a program should never do this itself (unless
1171.Sy \&ll
1172does), because it can
1173make no assumption about the effect of moving up from the home position.
1174Note that the home position is the same as
1175cursor address (0,0): to the top left corner of the screen, not of memory.
1176(Therefore, the
1177.Dq \eEH
1178sequence on Hewlett-Packard terminals
1179cannot be used for
1180.Sy \&ho . )
1181.Ss Area Clears
1182If the terminal can clear from the current position to the end of the
1183line, leaving the cursor where it is, this should be given as
1184.Sy \&ce .
1185If the terminal can clear from the current position to the end of the
1186display, this should be given as
1187.Sy \&cd .
1188.Sy \&cd
1189must only be invoked from the first column of a line.
1190(Therefore,
1191it can be simulated by a request to delete a large number of lines,
1192if a true
1193.Sy \&cd
1194is not available.)
1195.Ss Insert/Delete Line
1196If the terminal can open a new blank line
1197before the line containing the cursor,
1198this should be given as
1199.Sy \&al ;
1200this must be invoked only from the first
1201position of a line.
1202The cursor must then appear at the left of the newly blank line.
1203If the terminal can delete the line that the cursor is on, this
1204should be given as
1205.Sy \&dl ;
1206this must only be used from the first position on
1207the line to be deleted.
1208Versions of
1209.Sy \&al
1210and
1211.Sy \&dl
1212which take a single parameter
1213and insert or delete that many lines
1214can be given as
1215.Sy \&AL
1216and
1217.Sy \&DL .
1218If the terminal has a settable scrolling region
1219(like the VT100),
1220the command to set this can be described with the
1221.Sy \&cs
1222capability,
1223which takes two parameters: the top and bottom lines of the scrolling region.
1224The cursor position is, alas, undefined after using this command.
1225It is possible to get the effect of insert or delete line
1226using this command \(em the
1227.Sy \&sc
1228and
1229.Sy \&rc
1230(save and restore cursor) commands are also useful.
1231Inserting lines at the top or bottom of the screen can also be done using
1232.Sy \&sr
1233or
1234.Sy \&sf
1235on many terminals without a true insert/delete line,
1236and is often faster even on terminals with those features.
1237.Pp
1238If the terminal has the ability to define a window as part of memory
1239which all commands affect, it should be given as the parameterized string
1240.Sy \&wi .
1241The four parameters are the starting and ending lines in memory
1242and the starting and ending columns in memory, in that order.
1243(This
1244.Xr terminfo 5
1245capability is described for completeness.
1246It is unlikely that any
1247.Nm Ns \-using
1248program will support it.)
1249.Pp
1250If the terminal can retain display memory above the screen, then the
1251.Sy \&da
1252capability should be given;
1253if display memory can be retained
1254below, then
1255.Sy \&db
1256should be given.
1257These indicate
1258that deleting a line or scrolling may bring non-blank lines up from below
1259or that scrolling back with
1260.Sy \&sr
1261may bring down non-blank lines.
1262.Ss Insert/Delete Character
1263There are two basic kinds of intelligent terminals with respect to
1264insert/delete character that can be described using
1265.Nm .
1266The most common insert/delete character operations affect only the characters
1267on the current line and shift characters off the end of the line rigidly.
1268Other terminals, such as the Concept\-100 and the Perkin Elmer Owl, make
1269a distinction between typed and untyped blanks on the screen, shifting
1270upon an insert or delete only to an untyped blank on the screen which is
1271either eliminated or expanded to two untyped blanks.
1272You can determine
1273the kind of terminal you have by clearing the screen then typing
1274text separated by cursor motions.
1275Type
1276.Dq Li abc\ \ \ \ def
1277using local
1278cursor motions (not spaces) between the
1279.Dq abc
1280and the
1281.Dq def .
1282Then position the cursor before the
1283.Dq abc
1284and put the terminal in insert
1285mode.
1286If typing characters causes the rest of the line to shift
1287rigidly and characters to fall off the end, then your terminal does
1288not distinguish between blanks and untyped positions.
1289If the
1290.Dq abc
1291shifts over to the
1292.Dq def
1293which then move together around the end of the
1294current line and onto the next as you insert, then you have the second type of
1295terminal and should give the capability
1296.Sy \&in ,
1297which stands for
1298.Dq insert null .
1299While these are two logically separate attributes
1300(one line
1301.Em \&vs .
1302multi-line insert mode,
1303and special treatment of untyped spaces),
1304we have seen no terminals whose insert
1305mode cannot be described with the single attribute.
1306.Pp
1307The
1308.Nm
1309entries can describe both terminals that have an insert mode and terminals
1310that send a simple sequence to open a blank position on the current line.
1311Give as
1312.Sy \&im
1313the sequence to get into insert mode.
1314Give as
1315.Sy \&ei
1316the sequence to leave insert mode.
1317Now give as
1318.Sy \&ic
1319any sequence that needs to be sent just before
1320each character to be inserted.
1321Most terminals with a true insert mode
1322will not give
1323.Sy \&ic ;
1324terminals that use a sequence to open a screen
1325position should give it here.
1326(If your terminal has both,
1327insert mode is usually preferable to
1328.Sy \&ic .
1329Do not give both unless the terminal actually requires both to be used
1330in combination.)
1331If post-insert padding is needed, give this as a number of milliseconds
1332in
1333.Sy \&ip
1334(a string option).
1335Any other sequence that may need to be
1336sent after insertion of a single character can also be given in
1337.Sy \&ip .
1338If your terminal needs to be placed into an `insert mode'
1339and needs a special code preceding each inserted character,
1340then both
1341.Sy \&im Ns / Sy \&ei
1342and
1343.Sy \&ic
1344can be given, and both will be used.
1345The
1346.Sy \&IC
1347capability, with one parameter
1348.Em n ,
1349will repeat the effects of
1350.Sy \&ic
1351.Em n
1352times.
1353.Pp
1354It is occasionally necessary to move around while in insert mode
1355to delete characters on the same line
1356.Pf ( Em e.g . ,
1357if there is a tab after
1358the insertion position).
1359If your terminal allows motion while in
1360insert mode, you can give the capability
1361.Sy \&mi
1362to speed up inserting
1363in this case.
1364Omitting
1365.Sy \&mi
1366will affect only speed.
1367Some terminals
1368(notably Datamedia's) must not have
1369.Sy \&mi
1370because of the way their
1371insert mode works.
1372.Pp
1373Finally, you can specify
1374.Sy \&dc
1375to delete a single character,
1376.Sy \&DC
1377with one parameter
1378.Em n
1379to delete
1380.Em n
1381characters,
1382and delete mode by giving
1383.Sy \&dm
1384and
1385.Sy \&ed
1386to enter and exit delete mode
1387(which is any mode the terminal needs to be placed in for
1388.Sy \&dc
1389to work).
1390.Ss Highlighting, Underlining, and Visible Bells
1391If your terminal has one or more kinds of display attributes,
1392these can be represented in a number of different ways.
1393You should choose one display form as
1394.Em standout mode ,
1395representing a good high-contrast, easy-on-the-eyes format
1396for highlighting error messages and other attention getters.
1397(If you have a choice, reverse video plus half-bright is good,
1398or reverse video alone.)
1399The sequences to enter and exit standout mode
1400are given as
1401.Sy \&so
1402and
1403.Sy \&se ,
1404respectively.
1405If the code to change into or out of standout
1406mode leaves one or even two blank spaces or garbage characters on the screen,
1407as the
1408.Tn TVI
1409912 and Teleray 1061 do,
1410then
1411.Sy \&sg
1412should be given to tell how many characters are left.
1413.Pp
1414Codes to begin underlining and end underlining can be given as
1415.Sy \&us
1416and
1417.Sy \&ue ,
1418respectively.
1419Underline mode change garbage is specified by
1420.Sy \&ug ,
1421similar to
1422.Sy \&sg .
1423If the terminal has a code to underline the current character and move
1424the cursor one position to the right,
1425such as the Microterm Mime,
1426this can be given as
1427.Sy \&uc .
1428.Pp
1429Other capabilities to enter various highlighting modes include
1430.Sy \&mb
1431(blinking),
1432.Sy \&md
1433(bold or extra bright),
1434.Sy \&mh
1435(dim or half-bright),
1436.Sy \&mk
1437(blanking or invisible text),
1438.Sy \&mp
1439(protected),
1440.Sy \&mr
1441(reverse video),
1442.Sy \&me
1443(turn off
1444.Em all
1445attribute modes),
1446.Sy \&as
1447(enter alternate character set mode), and
1448.Sy \&ae
1449(exit alternate character set mode).
1450Turning on any of these modes singly may or may not turn off other modes.
1451.Pp
1452If there is a sequence to set arbitrary combinations of mode,
1453this should be given as
1454.Sy \&sa
1455(set attributes), taking 9 parameters.
1456Each parameter is either 0 or 1,
1457as the corresponding attributes is on or off.
1458The 9 parameters are, in order: standout, underline, reverse, blink,
1459dim, bold, blank, protect, and alternate character set.
1460Not all modes need be supported by
1461.Sy \&sa ,
1462only those for which corresponding attribute commands exist.
1463(It is unlikely that a
1464.Nm Ns \-using
1465program will support this capability, which is defined for compatibility
1466with
1467.Xr terminfo 5 . )
1468.Pp
1469Terminals with the
1470.Dq magic cookie
1471glitches
1472.Pf ( Sy \&sg
1473and
1474.Sy \&ug ) ,
1475rather than maintaining extra attribute bits for each character cell,
1476instead deposit special
1477.Dq cookies ,
1478or
1479.Dq garbage characters ,
1480when they receive mode-setting sequences,
1481which affect the display algorithm.
1482.Pp
1483Some terminals,
1484such as the Hewlett-Packard 2621,
1485automatically leave standout
1486mode when they move to a new line or when the cursor is addressed.
1487Programs using standout mode
1488should exit standout mode on such terminals
1489before moving the cursor or sending a newline.
1490On terminals where this is not a problem,
1491the
1492.Sy \&ms
1493capability should be present
1494to say that this overhead is unnecessary.
1495.Pp
1496If the terminal has
1497a way of flashing the screen to indicate an error quietly
1498(a bell replacement),
1499this can be given as
1500.Sy \&vb ;
1501it must not move the cursor.
1502.Pp
1503If the cursor needs to be made more visible than normal
1504when it is not on the bottom line
1505(to change, for example, a non-blinking underline into an easier-to-find
1506block or blinking underline),
1507give this sequence as
1508.Sy \&vs .
1509If there is a way to make the cursor completely invisible, give that as
1510.Sy \&vi .
1511The capability
1512.Sy \&ve ,
1513which undoes the effects of both of these modes,
1514should also be given.
1515.Pp
1516If your terminal correctly displays underlined characters
1517(with no special codes needed)
1518even though it does not overstrike,
1519then you should give the capability
1520.Sy \&ul .
1521If overstrikes are erasable with a blank,
1522this should be indicated by giving
1523.Sy \&eo .
1524.Ss Keypad
1525If the terminal has a keypad that transmits codes when the keys are pressed,
1526this information can be given.
1527Note that it is not possible to handle
1528terminals where the keypad only works in local mode
1529(this applies, for example, to the unshifted Hewlett-Packard 2621 keys).
1530If the keypad can be set to transmit or not transmit,
1531give these codes as
1532.Sy \&ks
1533and
1534.Sy \&ke .
1535Otherwise the keypad is assumed to always transmit.
1536The codes sent by the left-arrow, right-arrow, up-arrow, down-arrow,
1537and home keys can be given as
1538.Sy \&kl ,
1539.Sy \&kr ,
1540.Sy \&ku ,
1541.Sy \&kd ,
1542and
1543.Sy \&kh ,
1544respectively.
1545If there are function keys such as f0, f1, ..., f9, the codes they send
1546can be given as
1547.Sy \&k0 ,
1548.Sy \&k1 ,
1549\&...,
1550.Sy \&k9 .
1551If these keys have labels other than the default f0 through f9, the labels
1552can be given as
1553.Sy \&l0 ,
1554.Sy \&l1 ,
1555\&...,
1556.Sy \&l9 .
1557The codes transmitted by certain other special keys can be given:
1558.Sy \&kH
1559(home down),
1560.Sy \&kb
1561(backspace),
1562.Sy \&ka
1563(clear all tabs),
1564.Sy \&kt
1565(clear the tab stop in this column),
1566.Sy \&kC
1567(clear screen or erase),
1568.Sy \&kD
1569(delete character),
1570.Sy \&kL
1571(delete line),
1572.Sy \&kM
1573(exit insert mode),
1574.Sy \&kE
1575(clear to end of line),
1576.Sy \&kS
1577(clear to end of screen),
1578.Sy \&kI
1579(insert character or enter insert mode),
1580.Sy \&kA
1581(insert line),
1582.Sy \&kN
1583(next page),
1584.Sy \&kP
1585(previous page),
1586.Sy \&kF
1587(scroll forward/down),
1588.Sy \&kR
1589(scroll backward/up), and
1590.Sy \&kT
1591(set a tab stop in this column).
1592In addition, if the keypad has a 3 by 3 array of keys
1593including the four arrow keys, then the other five keys can be given as
1594.Sy \&K1 ,
1595.Sy \&K2 ,
1596.Sy \&K3 ,
1597.Sy \&K4 ,
1598and
1599.Sy \&K5 .
1600These keys are useful when the effects of a 3 by 3 directional pad are needed.
1601The obsolete
1602.Sy \&ko
1603capability formerly used to describe
1604.Dq other
1605function keys has been
1606completely supplanted by the above capabilities.
1607.Pp
1608The
1609.Sy \&ma
1610entry is also used to indicate arrow keys on terminals that have
1611single-character arrow keys.
1612It is obsolete but still in use in
1613version 2 of
1614.Sy \&vi
1615which must be run on some minicomputers due to
1616memory limitations.
1617This field is redundant with
1618.Sy \&kl ,
1619.Sy \&kr ,
1620.Sy \&ku ,
1621.Sy \&kd ,
1622and
1623.Sy \&kh .
1624It consists of groups of two characters.
1625In each group, the first character is what an arrow key sends, and the
1626second character is the corresponding
1627.Sy \&vi
1628command.
1629These commands are
1630.Ar h
1631for
1632.Sy \&kl ,
1633.Ar j
1634for
1635.Sy \&kd ,
1636.Ar k
1637for
1638.Sy \&ku ,
1639.Ar l
1640for
1641.Sy \&kr ,
1642and
1643.Ar H
1644for
1645.Sy \&kh .
1646For example, the Mime would have
1647.Dq Li ma=^Hh^Kj^Zk^Xl
1648indicating arrow keys left (^H), down (^K), up (^Z), and right (^X).
1649(There is no home key on the Mime.)
1650.Ss Tabs and Initialization
1651If the terminal needs to be in a special mode when running
1652a program that uses these capabilities,
1653the codes to enter and exit this mode can be given as
1654.Sy \&ti
1655and
1656.Sy \&te .
1657This arises, for example, from terminals like the Concept with more than
1658one page of memory.
1659If the terminal has only memory-relative cursor addressing and not
1660screen-relative cursor addressing,
1661a screen-sized window must be fixed into
1662the display for cursor addressing to work properly.
1663This is also used for the Tektronix 4025, where
1664.Sy \&ti
1665sets the command character to be the one used by
1666.Nm .
1667.Pp
1668Other capabilities
1669include
1670.Sy \&is ,
1671an initialization string for the terminal,
1672and
1673.Sy \&if ,
1674the name of a file containing long initialization strings.
1675These strings are expected to set the terminal into modes
1676consistent with the rest of the
1677.Nm
1678description.
1679They are normally sent to the terminal by the
1680.Xr tset 1
1681program each time the user logs in.
1682They will be printed in the following order:
1683.Sy \&is ;
1684setting tabs using
1685.Sy \&ct
1686and
1687.Sy \&st ;
1688and finally
1689.Sy \&if .
1690.Pf ( Xr Terminfo
1691uses
1692.Sy \&i\&1-i2
1693instead of
1694.Sy \&is
1695and runs the program
1696.Sy \&iP
1697and prints
1698.Sy "\&i\&3"
1699after the other initializations.)
1700A pair of sequences that does a harder reset from a totally unknown state
1701can be analogously given as
1702.Sy \&rs
1703and
1704.Sy \&if .
1705These strings are output by the
1706.Xr reset 1
1707program, which is used when the terminal gets into a wedged state.
1708.Pf ( Xr Terminfo
1709uses
1710.Sy "\&r1-r3"
1711instead of
1712.Sy \&rs . )
1713Commands are normally placed in
1714.Sy \&rs
1715and
1716.Sy \&rf
1717only if they produce annoying effects on the screen and are not necessary
1718when logging in.
1719For example, the command to set the VT100 into 80-column mode
1720would normally be part of
1721.Sy \&is ,
1722but it causes an annoying glitch of the screen and is not normally needed
1723since the terminal is usually already in 80-column mode.
1724.Pp
1725If the terminal has hardware tabs,
1726the command to advance to the next tab stop can be given as
1727.Sy \&ta
1728(usually
1729.Sy \&^I ) .
1730A
1731.Dq backtab
1732command which moves leftward to the previous tab stop
1733can be given as
1734.Sy \&bt .
1735By convention,
1736if the terminal driver modes indicate that tab stops are being expanded
1737by the computer rather than being sent to the terminal,
1738programs should not use
1739.Sy \&ta
1740or
1741.Sy \&bt
1742even if they are present,
1743since the user may not have the tab stops properly set.
1744If the terminal has hardware tabs that are initially set every
1745.Ar n
1746positions when the terminal is powered up, then the numeric parameter
1747.Sy \&it
1748is given, showing the number of positions between tab stops.
1749This is normally used by the
1750.Xr tset 1
1751command to determine whether to set the driver mode for hardware tab
1752expansion, and whether to set the tab stops.
1753If the terminal has tab stops that can be saved in nonvolatile memory, the
1754.Nm
1755description can assume that they are properly set.
1756.Pp
1757If there are commands to set and clear tab stops, they can be given as
1758.Sy \&ct
1759(clear all tab stops) and
1760.Sy \&st
1761(set a tab stop in the current column of every row).
1762If a more complex sequence is needed to set the tabs than can be
1763described by this, the sequence can be placed in
1764.Sy \&is
1765or
1766.Sy \&if .
1767.Ss Delays
1768Certain capabilities control padding in the terminal driver.
1769These are primarily needed by hardcopy terminals and are used by the
1770.Xr tset 1
1771program to set terminal driver modes appropriately.
1772Delays embedded in the capabilities
1773.Sy \&cr ,
1774.Sy \&sf ,
1775.Sy \&le ,
1776.Sy \&ff ,
1777and
1778.Sy \&ta
1779will cause the appropriate delay bits to be set in the terminal driver.
1780If
1781.Sy \&pb
1782(padding baud rate) is given, these values can be ignored at baud rates
1783below the value of
1784.Sy \&pb .
1785For
1786.Bx 4.2
1787.Xr tset 1 ,
1788the delays are given as numeric capabilities
1789.Sy \&dC ,
1790.Sy \&dN ,
1791.Sy \&dB ,
1792.Sy \&dF ,
1793and
1794.Sy \&dT
1795instead.
1796.Ss Miscellaneous
1797If the terminal requires other than a
1798.Dv NUL
1799(zero) character as a pad,
1800this can be given as
1801.Sy \&pc .
1802Only the first character of the
1803.Sy \&pc
1804string is used.
1805.Pp
1806If the terminal has commands to save and restore the position of the
1807cursor, give them as
1808.Sy \&sc
1809and
1810.Sy \&rc .
1811.Pp
1812If the terminal has an extra
1813.Dq status line
1814that is not normally used by
1815software, this fact can be indicated.
1816If the status line is viewed as an extra line below the bottom line,
1817then the capability
1818.Sy \&hs
1819should be given.
1820Special strings to go to a position in the status line and to return
1821from the status line can be given as
1822.Sy \&ts
1823and
1824.Sy \&fs .
1825.Pf ( Xr \&fs
1826must leave the cursor position in the same place that it was before
1827.Sy \&ts .
1828If necessary, the
1829.Sy \&sc
1830and
1831.Sy \&rc
1832strings can be included in
1833.Sy \&ts
1834and
1835.Sy \&fs
1836to get this effect.)
1837The capability
1838.Sy \&ts
1839takes one parameter, which is the column number of the status line
1840to which the cursor is to be moved.
1841If escape sequences and other special commands such as tab work while in
1842the status line, the flag
1843.Sy \&es
1844can be given.
1845A string that turns off the status line (or otherwise erases its contents)
1846should be given as
1847.Sy \&ds .
1848The status line is normally assumed to be the same width as the
1849rest of the screen,
1850.Em i.e . ,
1851.Sy \&co .
1852If the status line is a different width (possibly because the terminal
1853does not allow an entire line to be loaded), then its width in columns
1854can be indicated with the numeric parameter
1855.Sy \&ws .
1856.Pp
1857If the terminal can move up or down half a line, this can be
1858indicated with
1859.Sy \&hu
1860(half-line up) and
1861.Sy \&hd
1862(half-line down).
1863This is primarily useful for superscripts and subscripts on hardcopy
1864terminals.
1865If a hardcopy terminal can eject to the next page (form feed),
1866give this as
1867.Sy \&ff
1868(usually
1869.Sy \&^L ) .
1870.Pp
1871If there is a command to repeat a given character a given number of times
1872(to save time transmitting a large number of identical characters),
1873this can be indicated with the parameterized string
1874.Sy \&rp .
1875The first parameter is the character to be repeated and the second is
1876the number of times to repeat it.
1877(This is a
1878.Xr terminfo 5
1879feature that is unlikely to be supported by a program that uses
1880.Nm . )
1881.Pp
1882If the terminal has a settable command character, such as the
1883Tektronix 4025, this can be indicated with
1884.Sy \&CC .
1885A prototype command character is chosen which is used in all capabilities.
1886This character is given in the
1887.Sy \&CC
1888capability to identify it.
1889The following convention is supported on some
1890.Ux
1891systems:
1892The environment is to be searched for a
1893.Ev \&CC
1894variable,
1895and if found,
1896all occurrences of the prototype character are replaced by the character
1897in the environment variable.
1898This use of the
1899.Ev \&CC
1900environment variable
1901is a very bad idea, as it conflicts with
1902.Xr make 1 .
1903.Pp
1904Terminal descriptions that do not represent a specific kind of known
1905terminal, such as
1906.Em switch ,
1907.Em dialup ,
1908.Em patch ,
1909and
1910.Em network ,
1911should include the
1912.Sy \&gn
1913(generic) capability so that programs can complain that they do not know
1914how to talk to the terminal.
1915(This capability does not apply to
1916.Em virtual
1917terminal descriptions for which the escape sequences are known.)
1918.Pp
1919If the terminal uses xoff/xon
1920.Pq Tn DC3 Ns / Ns Tn DC1
1921handshaking for flow control, give
1922.Sy \&xo .
1923Padding information should still be included so that routines can make
1924better decisions about costs, but actual pad characters will not be
1925transmitted.
1926.Pp
1927If the terminal has a
1928.Dq meta key
1929which acts as a shift key, setting the
19308th bit of any character transmitted, then this fact can be indicated with
1931.Sy \&km .
1932Otherwise, software will assume that the 8th bit is parity and it will
1933usually be cleared.
1934If strings exist to turn this
1935.Dq meta mode
1936on and off, they can be given as
1937.Sy \&mm
1938and
1939.Sy \&mo .
1940.Pp
1941If the terminal has more lines of memory than will fit on the screen at once,
1942the number of lines of memory can be indicated with
1943.Sy \&lm .
1944An explicit value of 0 indicates that the number of lines is not fixed,
1945but that there is still more memory than fits on the screen.
1946.Pp
1947If the terminal is one of those supported by the
1948.Ux
1949system virtual
1950terminal protocol, the terminal number can be given as
1951.Sy \&vt .
1952.Pp
1953Media copy strings which control an auxiliary printer
1954connected to the terminal can be given as
1955.Sy \&ps :
1956print the contents of the screen;
1957.Sy \&pf :
1958turn off the printer; and
1959.Sy \&po :
1960turn on the printer.
1961When the printer is on, all text sent to the terminal will be sent to the
1962printer.
1963It is undefined whether the text is also displayed on the terminal screen
1964when the printer is on.
1965A variation
1966.Sy \&pO
1967takes one parameter and leaves the printer on for as many characters as the
1968value of the parameter, then turns the printer off.
1969The parameter should not exceed 255.
1970All text, including
1971.Sy \&pf ,
1972is transparently passed to the printer while
1973.Sy \&pO
1974is in effect.
1975.Pp
1976Strings to program function keys can be given as
1977.Sy \&pk ,
1978.Sy \&pl ,
1979and
1980.Sy \&px .
1981Each of these strings takes two parameters: the function key number
1982to program (from 0 to 9) and the string to program it with.
1983Function key numbers out of this range may program undefined keys
1984in a terminal-dependent manner.
1985The differences among the capabilities are that
1986.Sy \&pk
1987causes pressing the given key to be the same as the user typing the given
1988string;
1989.Sy \&pl
1990causes the string to be executed by the terminal in local mode;
1991and
1992.Sy \&px
1993causes the string to be transmitted to the computer.
1994Unfortunately, due to lack of a definition for string parameters in
1995.Nm ,
1996only
1997.Xr terminfo 5
1998supports these capabilities.
1999.Pp
2000For the
2001.Xr xterm 1
2002terminal emulator the traditional behavior in
2003.Fx
2004when exiting a pager such as
2005.Xr less 1
2006or
2007.Xr more 1 ,
2008or an editor such as
2009.Xr vi 1
2010is
2011.Em NOT
2012to clear the screen after the program exits.
2013If you prefer to clear the screen there are a number of
2014.Dq xterm-clear
2015entries that add this capability in the
2016.Nm
2017file that you can use directly, or as examples.
2018.Ss Glitches and Braindamage
2019Hazeltine terminals, which do not allow `~' characters to be displayed,
2020should indicate
2021.Sy \&hz .
2022.Pp
2023The
2024.Sy \&nc
2025capability, now obsolete, formerly indicated Datamedia terminals,
2026which echo
2027.Sy \&\er \en
2028for
2029carriage return then ignore a following linefeed.
2030.Pp
2031Terminals that ignore a linefeed immediately after an
2032.Sy \&am
2033wrap, such as the Concept, should indicate
2034.Sy \&xn .
2035.Pp
2036If
2037.Sy \&ce
2038is required to get rid of standout
2039(instead of merely writing normal text on top of it),
2040.Sy \&xs
2041should be given.
2042.Pp
2043Teleray terminals, where tabs turn all characters moved over to blanks,
2044should indicate
2045.Sy \&xt
2046(destructive tabs).
2047This glitch is also taken to mean that it is not possible
2048to position the cursor on top of a
2049.Dq magic cookie ,
2050and that
2051to erase standout mode it is necessary to use delete and insert line.
2052.Pp
2053The Beehive Superbee, which is unable to correctly transmit the
2054.Dv ESC
2055or
2056.Sy \&^C
2057characters, has
2058.Sy \&xb ,
2059indicating that the
2060.Dq \&f\&1
2061key is used for
2062.Dv ESC
2063and
2064.Dq \&f\&2
2065for ^C.
2066(Only certain Superbees have this problem, depending on the
2067.Tn ROM . )
2068.Pp
2069Other specific terminal problems may be corrected by adding more
2070capabilities of the form
2071.Sy x Em x .
2072.Ss Similar Terminals
2073If there are two very similar terminals,
2074one can be defined as being just like the other with certain exceptions.
2075The string capability
2076.Sy \&tc
2077can be given
2078with the name of the similar terminal.
2079This capability must be
2080.Em last ,
2081and the combined length of the entries
2082must not exceed 1024.
2083The capabilities given before
2084.Sy \&tc
2085override those in the terminal type invoked by
2086.Sy \&tc .
2087A capability can be canceled by placing
2088.Sy \&xx@
2089to the left of the
2090.Sy \&tc
2091invocation, where
2092.Sy \&xx
2093is the capability.
2094For example, the entry
2095.Bd -literal -offset indent
2096hn\||\|2621\-nl:ks@:ke@:tc=2621:
2097.Ed
2098.Pp
2099defines a
2100.Dq 2621\-nl
2101that does not have the
2102.Sy \&ks
2103or
2104.Sy \&ke
2105capabilities,
2106hence does not turn on the function key labels when in visual mode.
2107This is useful for different modes for a terminal, or for different
2108user preferences.
2109.Sh FILES
2110.Bl -tag -width /usr/share/misc/termcap.db -compact
2111.It Pa /usr/share/misc/termcap
2112File containing terminal descriptions.
2113.It Pa /usr/share/misc/termcap.db
2114Hash database file containing terminal descriptions (see
2115.Xr cap_mkdb 1 ) .
2116.El
2117.Sh SEE ALSO
2118.Xr cap_mkdb 1 ,
2119.Xr ex 1 ,
2120.Xr more 1 ,
2121.Xr tset 1 ,
2122.Xr ul 1 ,
2123.Xr vi 1 ,
2124.Xr xterm 1 ,
2125.Xr ncurses 3 ,
2126.Xr printf 3 ,
2127.Xr termcap 3 ,
2128.Xr term 5
2129.Sh CAVEATS AND BUGS
2130The
2131.Em Note :
2132.Nm
2133functions
2134were replaced by
2135.Xr terminfo 5
2136in
2137.At V
2138Release 2.0.
2139The transition will be relatively painless if capabilities flagged as
2140.Dq obsolete
2141are avoided.
2142.Pp
2143Lines and columns are now stored by the kernel as well as in the termcap
2144entry.
2145Most programs now use the kernel information primarily; the information
2146in this file is used only if the kernel does not have any information.
2147.Pp
2148The
2149.Xr \&vi 1
2150program allows only 256 characters for string capabilities, and the routines
2151in
2152.Xr termlib 3
2153do not check for overflow of this buffer.
2154The total length of a single entry (excluding only escaped newlines)
2155may not exceed 1024.
2156.Pp
2157Not all programs support all entries.
2158.Sh HISTORY
2159The
2160.Nm
2161file format appeared in
2162.Bx 3 .
2163