terminfo(5)

'\" t

terminfo - terminal capability database

\*d/*/*

is a database describing terminals, used by screen-oriented programs such as nvi(1), lynx(1), mutt(1), and other curses applications, using high-level calls to libraries such as ncurses(3NCURSES). It is also used via low-level calls by non-curses applications which may be screen-oriented (such as clear(1)) or non-screen (such as tabs(1)).

describes terminals by giving a set of capabilities which they have, by specifying how to perform screen operations, and by specifying padding requirements and initialization sequences.

This manual describes ncurses version 6.4 (patch 20221231).

Entries in

consist of a sequence of fields:

Each field ends with a comma \*(``,\*('' (embedded commas may be escaped with a backslash or written as \*(``\\054\*('').

White space between fields is ignored.

The first field in a terminfo entry begins in the first column.

Newlines and leading whitespace (spaces or tabs) may be used for formatting entries for readability. These are removed from parsed entries.

The infocmp -f and -W options rely on this to format if-then-else expressions, or to enforce maximum line-width. The resulting formatted terminal description can be read by tic.

The first field for each terminal gives the names which are known for the terminal, separated by \*(``|\*('' characters.

The first name given is the most common abbreviation for the terminal (its primary name), the last name given should be a long name fully identifying the terminal (see longname(3X)), and all others are treated as synonyms (aliases) for the primary terminal name.

X/Open Curses advises that all names but the last should be in lower case and contain no blanks; the last name may well contain upper case and blanks for readability.

This implementation is not so strict; it allows mixed case in the primary name and aliases. If the last name has no embedded blanks, it allows that to be both an alias and a verbose name (but will warn about this ambiguity).

Lines beginning with a \*(``#\*('' in the first column are treated as comments.

While comment lines are legal at any point, the output of captoinfo and infotocap (aliases for tic) will move comments so they occur only between entries.

Terminal names (except for the last, verbose entry) should be chosen using the following conventions. The particular piece of hardware making up the terminal should have a root name, thus \*(``hp2621\*(''. This name should not contain hyphens. Modes that the hardware can be in, or user preferences, should be indicated by appending a hyphen and a mode suffix. Thus, a vt100 in 132-column mode would be vt100-w. The following suffixes should be used where possible:

center ; l c l l l l. Suffix Meaning Example -nn Number of lines on the screen aaa-60 -np Number of pages of memory c100-4p -am With automargins (usually the default) vt100-am -m Mono mode; suppress color ansi-m -mc Magic cookie; spaces when highlighting wy30-mc -na No arrow keys (leave them in local) c100-na -nam Without automatic margins vt100-nam -nl No status line att4415-nl -ns No status line hp2626-ns -rv Reverse video c100-rv -s Enable status line vt100-s -vb Use visible bell instead of beep wy370-vb -w Wide mode (> 80 columns, usually 132) vt100-w

For more on terminal naming conventions, see the term(7) manual page.

The terminfo entry consists of several capabilities, i.e., features that the terminal has, or methods for exercising the terminal's features.

After the first field (giving the name(s) of the terminal entry), there should be one or more capability fields. These are boolean, numeric or string names with corresponding values:

Boolean capabilities are true when present, false when absent. There is no explicit value for boolean capabilities.

Numeric capabilities have a \*(``#\*('' following the name, then an unsigned decimal integer value.

String capabilities have a \*(``=\*('' following the name, then an string of characters making up the capability value.

String capabilities can be split into multiple lines, just as the fields comprising a terminal entry can be split into multiple lines. While blanks between fields are ignored, blanks embedded within a string value are retained, except for leading blanks on a line.

Any capability can be canceled, i.e., suppressed from the terminal entry, by following its name with \*(``@\*('' rather than a capability value.

If there are two very similar terminals, one (the variant) can be defined as being just like the other (the base) with certain exceptions. In the definition of the variant, the string capability use can be given with the name of the base terminal:

The capabilities given before

override those in the base type named by

If there are multiple use capabilities, they are merged in reverse order. That is, the rightmost use reference is processed first, then the one to its left, and so forth.

Capabilities given explicitly in the entry override those brought in by use references.

A capability can be canceled by placing xx@ to the left of the use reference that imports it, where xx is the capability. For example, the entry

2621-nl, smkx@, rmkx@, use=2621,

defines a 2621-nl that does not have the smkx or rmkx capabilities, and hence does not turn on the function key labels when in visual mode. This is useful for different modes for a terminal, or for different user preferences.

An entry included via use can contain canceled capabilities, which have the same effect as if those cancels were inline in the using terminal entry.

The following is a complete table of the capabilities included in a terminfo description block and available to terminfo-using code. In each line of the table,

The variable is the name by which the programmer (at the terminfo level) accesses the capability.

The capname is the short name used in the text of the database, and is used by a person updating the database. Whenever possible, capnames are chosen to be the same as or similar to the ANSI X3.64-1979 standard (now superseded by ECMA-48, which uses identical or very similar names). Semantics are also intended to match those of the specification.

The termcap code is the old

capability name (some capabilities are new, and have names which termcap did not originate).

Capability names have no hard length limit, but an informal limit of 5 characters has been adopted to keep them short and to allow the tabs in the source file

to line up nicely.

Finally, the description field attempts to convey the semantics of the capability. You may find some codes in the description field:

(P) indicates that padding may be specified

#[1-9] in the description field indicates that the string is passed through tparm(3X) with parameters as given (#i).

If no parameters are listed in the description, passing the string through tparm(3X) may give unexpected results, e.g., if it contains percent (%%) signs.

(P*) indicates that padding may vary in proportion to the number of lines affected

(#\di\u) indicates the i\uth\d parameter.

These are the boolean capabilities:

center; c l l c c l l c lw25 lw7 lw2 lw20. Variable Cap- TCap Description Booleans name Code auto_left_margin bw bw T{ cub1 wraps from column 0 to last column T} auto_right_margin am am T{ terminal has automatic margins T} back_color_erase bce ut T{ screen erased with background color T} can_change ccc cc T{ terminal can re-define existing colors T} ceol_standout_glitch xhp xs T{ standout not erased by overwriting (hp) T} col_addr_glitch xhpa YA T{ only positive motion for hpa/mhpa caps T} cpi_changes_res cpix YF T{ changing character pitch changes resolution T} cr_cancels_micro_mode crxm YB T{ using cr turns off micro mode T} dest_tabs_magic_smso xt xt T{ tabs destructive, magic so char (t1061) T} eat_newline_glitch xenl xn T{ newline ignored after 80 cols (concept) T} erase_overstrike eo eo T{ can erase overstrikes with a blank T} generic_type gn gn T{ generic line type T} hard_copy hc hc T{ hardcopy terminal T} hard_cursor chts HC T{ cursor is hard to see T} has_meta_key km km T{ Has a meta key (i.e., sets 8th-bit) T} has_print_wheel daisy YC T{ printer needs operator to change character set T} has_status_line hs hs T{ has extra status line T} hue_lightness_saturation hls hl T{ terminal uses only HLS color notation (Tektronix) T} insert_null_glitch in in T{ insert mode distinguishes nulls T} lpi_changes_res lpix YG T{ changing line pitch changes resolution T} memory_above da da T{ display may be retained above the screen T} memory_below db db T{ display may be retained below the screen T} move_insert_mode mir mi T{ safe to move while in insert mode T} move_standout_mode msgr ms T{ safe to move while in standout mode T} needs_xon_xoff nxon nx T{ padding will not work, xon/xoff required T} no_esc_ctlc xsb xb T{ beehive (f1=escape, f2=ctrl C) T} no_pad_char npc NP T{ pad character does not exist T} non_dest_scroll_region ndscr ND T{ scrolling region is non-destructive T} non_rev_rmcup nrrmc NR T{ smcup does not reverse rmcup T} over_strike os os T{ terminal can overstrike T} prtr_silent mc5i 5i T{ printer will not echo on screen T} row_addr_glitch xvpa YD T{ only positive motion for vpa/mvpa caps T} semi_auto_right_margin sam YE T{ printing in last column causes cr T} status_line_esc_ok eslok es T{ escape can be used on the status line T} tilde_glitch hz hz T{ cannot print ~'s (Hazeltine) T} transparent_underline ul ul T{ underline character overstrikes T} xon_xoff xon xo T{ terminal uses xon/xoff handshaking T}

These are the numeric capabilities:

center; c l l c c l l c lw25 lw7 lw2 lw20. Variable Cap- TCap Description Numeric name Code columns cols co T{ number of columns in a line T} init_tabs it it T{ tabs initially every # spaces T} label_height lh lh T{ rows in each label T} label_width lw lw T{ columns in each label T} lines lines li T{ number of lines on screen or page T} lines_of_memory lm lm T{ lines of memory if > line. 0 means varies T} magic_cookie_glitch xmc sg T{ number of blank characters left by smso or rmso T} max_attributes ma ma T{ maximum combined attributes terminal can handle T} max_colors colors Co T{ maximum number of colors on screen T} max_pairs pairs pa T{ maximum number of color-pairs on the screen T} maximum_windows wnum MW T{ maximum number of definable windows T} no_color_video ncv NC T{ video attributes that cannot be used with colors T} num_labels nlab Nl T{ number of labels on screen T} padding_baud_rate pb pb T{ lowest baud rate where padding needed T} virtual_terminal vt vt T{ virtual terminal number (CB/unix) T} width_status_line wsl ws T{ number of columns in status line T}

The following numeric capabilities are present in the SVr4.0 term structure, but are not yet documented in the man page. They came in with SVr4's printer support.

center; c l l c c l l c lw25 lw7 lw2 lw20. Variable Cap- TCap Description Numeric name Code bit_image_entwining bitwin Yo T{ number of passes for each bit-image row T} bit_image_type bitype Yp T{ type of bit-image device T} buffer_capacity bufsz Ya T{ numbers of bytes buffered before printing T} buttons btns BT T{ number of buttons on mouse T} dot_horz_spacing spinh Yc T{ spacing of dots horizontally in dots per inch T} dot_vert_spacing spinv Yb T{ spacing of pins vertically in pins per inch T} max_micro_address maddr Yd T{ maximum value in micro_..._address T} max_micro_jump mjump Ye T{ maximum value in parm_..._micro T} micro_col_size mcs Yf T{ character step size when in micro mode T} micro_line_size mls Yg T{ line step size when in micro mode T} number_of_pins npins Yh T{ numbers of pins in print-head T} output_res_char orc Yi T{ horizontal resolution in units per line T} output_res_horz_inch orhi Yk T{ horizontal resolution in units per inch T} output_res_line orl Yj T{ vertical resolution in units per line T} output_res_vert_inch orvi Yl T{ vertical resolution in units per inch T} print_rate cps Ym T{ print rate in characters per second T} wide_char_size widcs Yn T{ character step size when in double wide mode T}

These are the string capabilities:

center; c l l c c l l c lw25 lw7 lw2 lw20. Variable Cap- TCap Description String name Code acs_chars acsc ac T{ graphics charset pairs, based on vt100 T} back_tab cbt bt T{ back tab (P) T} bell bel bl T{ audible signal (bell) (P) T} carriage_return cr cr T{ carriage return (P*) (P*) T} change_char_pitch cpi ZA T{ Change number of characters per inch to #1 T} change_line_pitch lpi ZB T{ Change number of lines per inch to #1 T} change_res_horz chr ZC T{ Change horizontal resolution to #1 T} change_res_vert cvr ZD T{ Change vertical resolution to #1 T} change_scroll_region csr cs T{ change region to line #1 to line #2 (P) T} char_padding rmp rP T{ like ip but when in insert mode T} clear_all_tabs tbc ct T{ clear all tab stops (P) T} clear_margins mgc MC T{ clear right and left soft margins T} clear_screen clear cl T{ clear screen and home cursor (P*) T} clr_bol el1 cb T{ Clear to beginning of line T} clr_eol el ce T{ clear to end of line (P) T} clr_eos ed cd T{ clear to end of screen (P*) T} column_address hpa ch T{ horizontal position #1, absolute (P) T} command_character cmdch CC T{ terminal settable cmd character in prototype !? T} create_window cwin CW T{ define a window #1 from #2,#3 to #4,#5 T} cursor_address cup cm T{ move to row #1 columns #2 T} cursor_down cud1 do T{ down one line T} cursor_home home ho T{ home cursor (if no cup) T} cursor_invisible civis vi T{ make cursor invisible T} cursor_left cub1 le T{ move left one space T} cursor_mem_address mrcup CM T{ memory relative cursor addressing, move to row #1 columns #2 T} cursor_normal cnorm ve T{ make cursor appear normal (undo civis/cvvis) T} cursor_right cuf1 nd T{ non-destructive space (move right one space) T} cursor_to_ll ll ll T{ last line, first column (if no cup) T} cursor_up cuu1 up T{ up one line T} cursor_visible cvvis vs T{ make cursor very visible T} define_char defc ZE T{ Define a character #1, #2 dots wide, descender #3 T} delete_character dch1 dc T{ delete character (P*) T} delete_line dl1 dl T{ delete line (P*) T} dial_phone dial DI T{ dial number #1 T} dis_status_line dsl ds T{ disable status line T} display_clock dclk DK T{ display clock T} down_half_line hd hd T{ half a line down T} ena_acs enacs eA T{ enable alternate char set T} enter_alt_charset_mode smacs as T{ start alternate character set (P) T} enter_am_mode smam SA T{ turn on automatic margins T} enter_blink_mode blink mb T{ turn on blinking T} enter_bold_mode bold md T{ turn on bold (extra bright) mode T} enter_ca_mode smcup ti T{ string to start programs using cup T} enter_delete_mode smdc dm T{ enter delete mode T} enter_dim_mode dim mh T{ turn on half-bright mode T} enter_doublewide_mode swidm ZF T{ Enter double-wide mode T} enter_draft_quality sdrfq ZG T{ Enter draft-quality mode T} enter_insert_mode smir im T{ enter insert mode T} enter_italics_mode sitm ZH T{ Enter italic mode T} enter_leftward_mode slm ZI T{ Start leftward carriage motion T} enter_micro_mode smicm ZJ T{ Start micro-motion mode T} enter_near_letter_quality snlq ZK T{ Enter NLQ mode T} enter_normal_quality snrmq ZL T{ Enter normal-quality mode T} enter_protected_mode prot mp T{ turn on protected mode T} enter_reverse_mode rev mr T{ turn on reverse video mode T} enter_secure_mode invis mk T{ turn on blank mode (characters invisible) T} enter_shadow_mode sshm ZM T{ Enter shadow-print mode T} enter_standout_mode smso so T{ begin standout mode T} enter_subscript_mode ssubm ZN T{ Enter subscript mode T} enter_superscript_mode ssupm ZO T{ Enter superscript mode T} enter_underline_mode smul us T{ begin underline mode T} enter_upward_mode sum ZP T{ Start upward carriage motion T} enter_xon_mode smxon SX T{ turn on xon/xoff handshaking T} erase_chars ech ec T{ erase #1 characters (P) T} exit_alt_charset_mode rmacs ae T{ end alternate character set (P) T} exit_am_mode rmam RA T{ turn off automatic margins T} exit_attribute_mode sgr0 me T{ turn off all attributes T} exit_ca_mode rmcup te T{ strings to end programs using cup T} exit_delete_mode rmdc ed T{ end delete mode T} exit_doublewide_mode rwidm ZQ T{ End double-wide mode T} exit_insert_mode rmir ei T{ exit insert mode T} exit_italics_mode ritm ZR T{ End italic mode T} exit_leftward_mode rlm ZS T{ End left-motion mode T} exit_micro_mode rmicm ZT T{ End micro-motion mode T} exit_shadow_mode rshm ZU T{ End shadow-print mode T} exit_standout_mode rmso se T{ exit standout mode T} exit_subscript_mode rsubm ZV T{ End subscript mode T} exit_superscript_mode rsupm ZW T{ End superscript mode T} exit_underline_mode rmul ue T{ exit underline mode T} exit_upward_mode rum ZX T{ End reverse character motion T} exit_xon_mode rmxon RX T{ turn off xon/xoff handshaking T} fixed_pause pause PA T{ pause for 2-3 seconds T} flash_hook hook fh T{ flash switch hook T} flash_screen flash vb T{ visible bell (may not move cursor) T} form_feed ff ff T{ hardcopy terminal page eject (P*) T} from_status_line fsl fs T{ return from status line T} goto_window wingo WG T{ go to window #1 T} hangup hup HU T{ hang-up phone T} init_1string is1 i1 T{ initialization string T} init_2string is2 is T{ initialization string T} init_3string is3 i3 T{ initialization string T} init_file if if T{ name of initialization file T} init_prog iprog iP T{ path name of program for initialization T} initialize_color initc Ic T{ initialize color #1 to (#2,#3,#4) T} initialize_pair initp Ip T{ Initialize color pair #1 to fg=(#2,#3,#4), bg=(#5,#6,#7) T} insert_character ich1 ic T{ insert character (P) T} insert_line il1 al T{ insert line (P*) T} insert_padding ip ip T{ insert padding after inserted character T} key_a1 ka1 K1 T{ upper left of keypad T} key_a3 ka3 K3 T{ upper right of keypad T} key_b2 kb2 K2 T{ center of keypad T} key_backspace kbs kb T{ backspace key T} key_beg kbeg @1 T{ begin key T} key_btab kcbt kB T{ back-tab key T} key_c1 kc1 K4 T{ lower left of keypad T} key_c3 kc3 K5 T{ lower right of keypad T} key_cancel kcan @2 T{ cancel key T} key_catab ktbc ka T{ clear-all-tabs key T} key_clear kclr kC T{ clear-screen or erase key T} key_close kclo @3 T{ close key T} key_command kcmd @4 T{ command key T} key_copy kcpy @5 T{ copy key T} key_create kcrt @6 T{ create key T} key_ctab kctab kt T{ clear-tab key T} key_dc kdch1 kD T{ delete-character key T} key_dl kdl1 kL T{ delete-line key T} key_down kcud1 kd T{ down-arrow key T} key_eic krmir kM T{ sent by rmir or smir in insert mode T} key_end kend @7 T{ end key T} key_enter kent @8 T{ enter/send key T} key_eol kel kE T{ clear-to-end-of-line key T} key_eos ked kS T{ clear-to-end-of-screen key T} key_exit kext @9 T{ exit key T} key_f0 kf0 k0 T{ F0 function key T} key_f1 kf1 k1 T{ F1 function key T} key_f10 kf10 k; T{ F10 function key T} key_f11 kf11 F1 T{ F11 function key T} key_f12 kf12 F2 T{ F12 function key T} key_f13 kf13 F3 T{ F13 function key T} key_f14 kf14 F4 T{ F14 function key T} key_f15 kf15 F5 T{ F15 function key T} key_f16 kf16 F6 T{ F16 function key T} key_f17 kf17 F7 T{ F17 function key T} key_f18 kf18 F8 T{ F18 function key T} key_f19 kf19 F9 T{ F19 function key T} key_f2 kf2 k2 T{ F2 function key T} key_f20 kf20 FA T{ F20 function key T} key_f21 kf21 FB T{ F21 function key T} key_f22 kf22 FC T{ F22 function key T} key_f23 kf23 FD T{ F23 function key T} key_f24 kf24 FE T{ F24 function key T} key_f25 kf25 FF T{ F25 function key T} key_f26 kf26 FG T{ F26 function key T} key_f27 kf27 FH T{ F27 function key T} key_f28 kf28 FI T{ F28 function key T} key_f29 kf29 FJ T{ F29 function key T} key_f3 kf3 k3 T{ F3 function key T} key_f30 kf30 FK T{ F30 function key T} key_f31 kf31 FL T{ F31 function key T} key_f32 kf32 FM T{ F32 function key T} key_f33 kf33 FN T{ F33 function key T} key_f34 kf34 FO T{ F34 function key T} key_f35 kf35 FP T{ F35 function key T} key_f36 kf36 FQ T{ F36 function key T} key_f37 kf37 FR T{ F37 function key T} key_f38 kf38 FS T{ F38 function key T} key_f39 kf39 FT T{ F39 function key T} key_f4 kf4 k4 T{ F4 function key T} key_f40 kf40 FU T{ F40 function key T} key_f41 kf41 FV T{ F41 function key T} key_f42 kf42 FW T{ F42 function key T} key_f43 kf43 FX T{ F43 function key T} key_f44 kf44 FY T{ F44 function key T} key_f45 kf45 FZ T{ F45 function key T} key_f46 kf46 Fa T{ F46 function key T} key_f47 kf47 Fb T{ F47 function key T} key_f48 kf48 Fc T{ F48 function key T} key_f49 kf49 Fd T{ F49 function key T} key_f5 kf5 k5 T{ F5 function key T} key_f50 kf50 Fe T{ F50 function key T} key_f51 kf51 Ff T{ F51 function key T} key_f52 kf52 Fg T{ F52 function key T} key_f53 kf53 Fh T{ F53 function key T} key_f54 kf54 Fi T{ F54 function key T} key_f55 kf55 Fj T{ F55 function key T} key_f56 kf56 Fk T{ F56 function key T} key_f57 kf57 Fl T{ F57 function key T} key_f58 kf58 Fm T{ F58 function key T} key_f59 kf59 Fn T{ F59 function key T} key_f6 kf6 k6 T{ F6 function key T} key_f60 kf60 Fo T{ F60 function key T} key_f61 kf61 Fp T{ F61 function key T} key_f62 kf62 Fq T{ F62 function key T} key_f63 kf63 Fr T{ F63 function key T} key_f7 kf7 k7 T{ F7 function key T} key_f8 kf8 k8 T{ F8 function key T} key_f9 kf9 k9 T{ F9 function key T} key_find kfnd @0 T{ find key T} key_help khlp %1 T{ help key T} key_home khome kh T{ home key T} key_ic kich1 kI T{ insert-character key T} key_il kil1 kA T{ insert-line key T} key_left kcub1 kl T{ left-arrow key T} key_ll kll kH T{ lower-left key (home down) T} key_mark kmrk %2 T{ mark key T} key_message kmsg %3 T{ message key T} key_move kmov %4 T{ move key T} key_next knxt %5 T{ next key T} key_npage knp kN T{ next-page key T} key_open kopn %6 T{ open key T} key_options kopt %7 T{ options key T} key_ppage kpp kP T{ previous-page key T} key_previous kprv %8 T{ previous key T} key_print kprt %9 T{ print key T} key_redo krdo %0 T{ redo key T} key_reference kref &1 T{ reference key T} key_refresh krfr &2 T{ refresh key T} key_replace krpl &3 T{ replace key T} key_restart krst &4 T{ restart key T} key_resume kres &5 T{ resume key T} key_right kcuf1 kr T{ right-arrow key T} key_save ksav &6 T{ save key T} key_sbeg kBEG &9 T{ shifted begin key T} key_scancel kCAN &0 T{ shifted cancel key T} key_scommand kCMD *1 T{ shifted command key T} key_scopy kCPY *2 T{ shifted copy key T} key_screate kCRT *3 T{ shifted create key T} key_sdc kDC *4 T{ shifted delete-character key T} key_sdl kDL *5 T{ shifted delete-line key T} key_select kslt *6 T{ select key T} key_send kEND *7 T{ shifted end key T} key_seol kEOL *8 T{ shifted clear-to-end-of-line key T} key_sexit kEXT *9 T{ shifted exit key T} key_sf kind kF T{ scroll-forward key T} key_sfind kFND *0 T{ shifted find key T} key_shelp kHLP #1 T{ shifted help key T} key_shome kHOM #2 T{ shifted home key T} key_sic kIC #3 T{ shifted insert-character key T} key_sleft kLFT #4 T{ shifted left-arrow key T} key_smessage kMSG %a T{ shifted message key T} key_smove kMOV %b T{ shifted move key T} key_snext kNXT %c T{ shifted next key T} key_soptions kOPT %d T{ shifted options key T} key_sprevious kPRV %e T{ shifted previous key T} key_sprint kPRT %f T{ shifted print key T} key_sr kri kR T{ scroll-backward key T} key_sredo kRDO %g T{ shifted redo key T} key_sreplace kRPL %h T{ shifted replace key T} key_sright kRIT %i T{ shifted right-arrow key T} key_srsume kRES %j T{ shifted resume key T} key_ssave kSAV !1 T{ shifted save key T} key_ssuspend kSPD !2 T{ shifted suspend key T} key_stab khts kT T{ set-tab key T} key_sundo kUND !3 T{ shifted undo key T} key_suspend kspd &7 T{ suspend key T} key_undo kund &8 T{ undo key T} key_up kcuu1 ku T{ up-arrow key T} keypad_local rmkx ke T{ leave 'keyboard_transmit' mode T} keypad_xmit smkx ks T{ enter 'keyboard_transmit' mode T} lab_f0 lf0 l0 T{ label on function key f0 if not f0 T} lab_f1 lf1 l1 T{ label on function key f1 if not f1 T} lab_f10 lf10 la T{ label on function key f10 if not f10 T} lab_f2 lf2 l2 T{ label on function key f2 if not f2 T} lab_f3 lf3 l3 T{ label on function key f3 if not f3 T} lab_f4 lf4 l4 T{ label on function key f4 if not f4 T} lab_f5 lf5 l5 T{ label on function key f5 if not f5 T} lab_f6 lf6 l6 T{ label on function key f6 if not f6 T} lab_f7 lf7 l7 T{ label on function key f7 if not f7 T} lab_f8 lf8 l8 T{ label on function key f8 if not f8 T} lab_f9 lf9 l9 T{ label on function key f9 if not f9 T} label_format fln Lf T{ label format T} label_off rmln LF T{ turn off soft labels T} label_on smln LO T{ turn on soft labels T} meta_off rmm mo T{ turn off meta mode T} meta_on smm mm T{ turn on meta mode (8th-bit on) T} micro_column_address mhpa ZY T{ Like column_address in micro mode T} micro_down mcud1 ZZ T{ Like cursor_down in micro mode T} micro_left mcub1 Za T{ Like cursor_left in micro mode T} micro_right mcuf1 Zb T{ Like cursor_right in micro mode T} micro_row_address mvpa Zc T{ Like row_address #1 in micro mode T} micro_up mcuu1 Zd T{ Like cursor_up in micro mode T} newline nel nw T{ newline (behave like cr followed by lf) T} order_of_pins porder Ze T{ Match software bits to print-head pins T} orig_colors oc oc T{ Set all color pairs to the original ones T} orig_pair op op T{ Set default pair to its original value T} pad_char pad pc T{ padding char (instead of null) T} parm_dch dch DC T{ delete #1 characters (P*) T} parm_delete_line dl DL T{ delete #1 lines (P*) T} parm_down_cursor cud DO T{ down #1 lines (P*) T} parm_down_micro mcud Zf T{ Like parm_down_cursor in micro mode T} parm_ich ich IC T{ insert #1 characters (P*) T} parm_index indn SF T{ scroll forward #1 lines (P) T} parm_insert_line il AL T{ insert #1 lines (P*) T} parm_left_cursor cub LE T{ move #1 characters to the left (P) T} parm_left_micro mcub Zg T{ Like parm_left_cursor in micro mode T} parm_right_cursor cuf RI T{ move #1 characters to the right (P*) T} parm_right_micro mcuf Zh T{ Like parm_right_cursor in micro mode T} parm_rindex rin SR T{ scroll back #1 lines (P) T} parm_up_cursor cuu UP T{ up #1 lines (P*) T} parm_up_micro mcuu Zi T{ Like parm_up_cursor in micro mode T} pkey_key pfkey pk T{ program function key #1 to type string #2 T} pkey_local pfloc pl T{ program function key #1 to execute string #2 T} pkey_xmit pfx px T{ program function key #1 to transmit string #2 T} plab_norm pln pn T{ program label #1 to show string #2 T} print_screen mc0 ps T{ print contents of screen T} prtr_non mc5p pO T{ turn on printer for #1 bytes T} prtr_off mc4 pf T{ turn off printer T} prtr_on mc5 po T{ turn on printer T} pulse pulse PU T{ select pulse dialing T} quick_dial qdial QD T{ dial number #1 without checking T} remove_clock rmclk RC T{ remove clock T} repeat_char rep rp T{ repeat char #1 #2 times (P*) T} req_for_input rfi RF T{ send next input char (for ptys) T} reset_1string rs1 r1 T{ reset string T} reset_2string rs2 r2 T{ reset string T} reset_3string rs3 r3 T{ reset string T} reset_file rf rf T{ name of reset file T} restore_cursor rc rc T{ restore cursor to position of last save_cursor T} row_address vpa cv T{ vertical position #1 absolute (P) T} save_cursor sc sc T{ save current cursor position (P) T} scroll_forward ind sf T{ scroll text up (P) T} scroll_reverse ri sr T{ scroll text down (P) T} select_char_set scs Zj T{ Select character set, #1 T} set_attributes sgr sa T{ define video attributes #1-#9 (PG9) T} set_background setb Sb T{ Set background color #1 T} set_bottom_margin smgb Zk T{ Set bottom margin at current line T} set_bottom_margin_parm smgbp Zl T{ Set bottom margin at line #1 or (if smgtp is not given) #2 lines from bottom T} set_clock sclk SC T{ set clock, #1 hrs #2 mins #3 secs T} set_color_pair scp sp T{ Set current color pair to #1 T} set_foreground setf Sf T{ Set foreground color #1 T} set_left_margin smgl ML T{ set left soft margin at current column. (ML is not in BSD termcap). T} set_left_margin_parm smglp Zm T{ Set left (right) margin at column #1 T} set_right_margin smgr MR T{ set right soft margin at current column T} set_right_margin_parm smgrp Zn T{ Set right margin at column #1 T} set_tab hts st T{ set a tab in every row, current columns T} set_top_margin smgt Zo T{ Set top margin at current line T} set_top_margin_parm smgtp Zp T{ Set top (bottom) margin at row #1 T} set_window wind wi T{ current window is lines #1-#2 cols #3-#4 T} start_bit_image sbim Zq T{ Start printing bit image graphics T} start_char_set_def scsd Zr T{ Start character set definition #1, with #2 characters in the set T} stop_bit_image rbim Zs T{ Stop printing bit image graphics T} stop_char_set_def rcsd Zt T{ End definition of character set #1 T} subscript_characters subcs Zu T{ List of subscriptable characters T} superscript_characters supcs Zv T{ List of superscriptable characters T} tab ht ta T{ tab to next 8-space hardware tab stop T} these_cause_cr docr Zw T{ Printing any of these characters causes CR T} to_status_line tsl ts T{ move to status line, column #1 T} tone tone TO T{ select touch tone dialing T} underline_char uc uc T{ underline char and move past it T} up_half_line hu hu T{ half a line up T} user0 u0 u0 T{ User string #0 T} user1 u1 u1 T{ User string #1 T} user2 u2 u2 T{ User string #2 T} user3 u3 u3 T{ User string #3 T} user4 u4 u4 T{ User string #4 T} user5 u5 u5 T{ User string #5 T} user6 u6 u6 T{ User string #6 T} user7 u7 u7 T{ User string #7 T} user8 u8 u8 T{ User string #8 T} user9 u9 u9 T{ User string #9 T} wait_tone wait WA T{ wait for dial-tone T} xoff_character xoffc XF T{ XOFF character T} xon_character xonc XN T{ XON character T} zero_motion zerom Zx T{ No motion for subsequent character T}

The following string capabilities are present in the SVr4.0 term structure, but were originally not documented in the man page.

center; c l l c c l l c lw25 lw7 lw2 lw18. Variable Cap- TCap Description String name Code alt_scancode_esc scesa S8 T{ Alternate escape for scancode emulation T} bit_image_carriage_return bicr Yv T{ Move to beginning of same row T} bit_image_newline binel Zz T{ Move to next row of the bit image T} bit_image_repeat birep Xy T{ Repeat bit image cell #1 #2 times T} char_set_names csnm Zy T{ Produce #1'th item from list of character set names T} code_set_init csin ci T{ Init sequence for multiple codesets T} color_names colornm Yw T{ Give name for color #1 T} define_bit_image_region defbi Yx T{ Define rectangular bit image region T} device_type devt dv T{ Indicate language/codeset support T} display_pc_char dispc S1 T{ Display PC character #1 T} end_bit_image_region endbi Yy T{ End a bit-image region T} enter_pc_charset_mode smpch S2 T{ Enter PC character display mode T} enter_scancode_mode smsc S4 T{ Enter PC scancode mode T} exit_pc_charset_mode rmpch S3 T{ Exit PC character display mode T} exit_scancode_mode rmsc S5 T{ Exit PC scancode mode T} get_mouse getm Gm T{ Curses should get button events, parameter #1 not documented. T} key_mouse kmous Km T{ Mouse event has occurred T} mouse_info minfo Mi T{ Mouse status information T} pc_term_options pctrm S6 T{ PC terminal options T} pkey_plab pfxl xl T{ Program function key #1 to type string #2 and show string #3 T} req_mouse_pos reqmp RQ T{ Request mouse position T} scancode_escape scesc S7 T{ Escape for scancode emulation T} set0_des_seq s0ds s0 T{ Shift to codeset 0 (EUC set 0, ASCII) T} set1_des_seq s1ds s1 T{ Shift to codeset 1 T} set2_des_seq s2ds s2 T{ Shift to codeset 2 T} set3_des_seq s3ds s3 T{ Shift to codeset 3 T} set_a_background setab AB T{ Set background color to #1, using ANSI escape T} set_a_foreground setaf AF T{ Set foreground color to #1, using ANSI escape T} set_color_band setcolor Yz T{ Change to ribbon color #1 T} set_lr_margin smglr ML T{ Set both left and right margins to #1, #2. (ML is not in BSD termcap). T} set_page_length slines YZ T{ Set page length to #1 lines T} set_tb_margin smgtb MT T{ Sets both top and bottom margins to #1, #2 T}

The XSI Curses standard added these hardcopy capabilities. They were used in some post-4.1 versions of System V curses, e.g., Solaris 2.5 and IRIX 6.x. Except for YI, the ncurses termcap names for them are invented. According to the XSI Curses standard, they have no termcap names. If your compiled terminfo entries use these, they may not be binary-compatible with System V terminfo entries after SVr4.1; beware!

center; c l l c c l l c lw25 lw7 lw2 lw20. Variable Cap- TCap Description String name Code enter_horizontal_hl_mode ehhlm Xh T{ Enter horizontal highlight mode T} enter_left_hl_mode elhlm Xl T{ Enter left highlight mode T} enter_low_hl_mode elohlm Xo T{ Enter low highlight mode T} enter_right_hl_mode erhlm Xr T{ Enter right highlight mode T} enter_top_hl_mode ethlm Xt T{ Enter top highlight mode T} enter_vertical_hl_mode evhlm Xv T{ Enter vertical highlight mode T} set_a_attributes sgr1 sA T{ Define second set of video attributes #1-#6 T} set_pglen_inch slength YI T{ Set page length to #1 hundredth of an inch (some implementations use sL for termcap). T}

. The preceding section listed the predefined capabilities. They deal with some special features for terminals no longer (or possibly never) produced. Occasionally there are special features of newer terminals which are awkward or impossible to represent by reusing the predefined capabilities.

ncurses addresses this limitation by allowing user-defined capabilities. The tic and infocmp programs provide the -x option for this purpose. When -x is set, tic treats unknown capabilities as user-defined. That is, if tic encounters a capability name which it does not recognize, it infers its type (boolean, number or string) from the syntax and makes an extended table entry for that capability. The use_extended_names(3X) function makes this information conditionally available to applications. The ncurses library provides the data leaving most of the behavior to applications:

User-defined capability strings whose name begins with \*(``k\*('' are treated as function keys.

The types (boolean, number, string) determined by tic can be inferred by successful calls on tigetflag, etc.

If the capability name happens to be two characters, the capability is also available through the termcap interface.

While termcap is said to be extensible because it does not use a predefined set of capabilities, in practice it has been limited to the capabilities defined by terminfo implementations. As a rule, user-defined capabilities intended for use by termcap applications should be limited to booleans and numbers to avoid running past the 1023 byte limit assumed by termcap implementations and their applications. In particular, providing extended sets of function keys (past the 60 numbered keys and the handful of special named keys) is best done using the longer names available using terminfo. .

. The following entry, describing an ANSI-standard terminal, is representative of what a terminfo entry for a modern terminal typically looks like.

ansi|ansi/pc-term compatible with color, am, mc5i, mir, msgr, colors#8, cols#80, it#8, lines#24, ncv#3, pairs#64, acsc=+\\020\\,\\021-\\030.^Y0\\333`\\004a\\261f\\370g\\361h\\260 j\\331k\\277l\\332m\\300n\\305o~p\\304q\\304r\\304s_t\\303 u\\264v\\301w\\302x\\263y\\363z\\362{\\343|\\330}\\234~\\376, bel=^G, blink=\\E[5m, bold=\\E[1m, cbt=\\E[Z, clear=\\E[H\\E[J, cr=^M, cub=\\E[%p1%dD, cub1=\\E[D, cud=\\E[%p1%dB, cud1=\\E[B, cuf=\\E[%p1%dC, cuf1=\\E[C, cup=\\E[%i%p1%d;%p2%dH, cuu=\\E[%p1%dA, cuu1=\\E[A, dch=\\E[%p1%dP, dch1=\\E[P, dl=\\E[%p1%dM, dl1=\\E[M, ech=\\E[%p1%dX, ed=\\E[J, el=\\E[K, el1=\\E[1K, home=\\E[H, hpa=\\E[%i%p1%dG, ht=\\E[I, hts=\\EH, ich=\\E[%p1%d@, il=\\E[%p1%dL, il1=\\E[L, ind=^J, indn=\\E[%p1%dS, invis=\\E[8m, kbs=^H, kcbt=\\E[Z, kcub1=\\E[D, kcud1=\\E[B, kcuf1=\\E[C, kcuu1=\\E[A, khome=\\E[H, kich1=\\E[L, mc4=\\E[4i, mc5=\\E[5i, nel=\\r\\E[S, op=\\E[39;49m, rep=%p1%c\\E[%p2%{1}%-%db, rev=\\E[7m, rin=\\E[%p1%dT, rmacs=\\E[10m, rmpch=\\E[10m, rmso=\\E[m, rmul=\\E[m, s0ds=\\E(B, s1ds=\\E)B, s2ds=\\E*B, s3ds=\\E+B, setab=\\E[4%p1%dm, setaf=\\E[3%p1%dm, sgr=\\E[0;10%?%p1%t;7%; %?%p2%t;4%; %?%p3%t;7%; %?%p4%t;5%; %?%p6%t;1%; %?%p7%t;8%; %?%p9%t;11%;m, sgr0=\\E[0;10m, smacs=\\E[11m, smpch=\\E[11m, smso=\\E[7m, smul=\\E[4m, tbc=\\E[3g, u6=\\E[%i%d;%dR, u7=\\E[6n, u8=\\E[?%[;0123456789]c, u9=\\E[c, vpa=\\E[%i%p1%dd,

Entries may continue onto multiple lines by placing white space at the beginning of each line except the first. Comments may be included on lines beginning with \*(``#\*(''. Capabilities in

are of three types:

Boolean capabilities which indicate that the terminal has some particular feature,

numeric capabilities giving the size of the terminal or the size of particular delays, and

string capabilities, which give a sequence which can be used to perform particular terminal operations.

All capabilities have names. For instance, the fact that ANSI-standard terminals have

(i.e., an automatic return and line-feed when the end of a line is reached) is indicated by the capability am. Hence the description of ansi includes am. Numeric capabilities are followed by the character \*(``#\*('' and then a positive value. Thus cols, which indicates the number of columns the terminal has, gives the value \*(``80\*('' for ansi. Values for numeric capabilities may be specified in decimal, octal or hexadecimal, using the C programming language conventions (e.g., 255, 0377 and 0xff or 0xFF).

Finally, string valued capabilities, such as el (clear to end of line sequence) are given by the two-character code, an \*(``=\*('', and then a string ending at the next following \*(``,\*(''.

A number of escape sequences are provided in the string valued capabilities for easy encoding of characters there:

Both \eE and \ee map to an ESCAPE character,

^x maps to a control-x for any appropriate x, and

the sequences

\en, \el, \er, \et, \eb, \ef, and \es

produce

newline, line-feed, return, tab, backspace, form-feed, and space,

respectively.

X/Open Curses does not say what \*(``appropriate x\*('' might be. In practice, that is a printable ASCII graphic character. The special case \*(``^?\*('' is interpreted as DEL (127). In all other cases, the character value is AND'd with 0x1f, mapping to ASCII control codes in the range 0 through 31.

Other escapes include

\e^ for ^,

\e\e for \e,

\e, for comma,

\e: for :,

and \e0 for null.

\e0 will produce \e200, which does not terminate a string but behaves as a null character on most terminals, providing CS7 is specified. See stty(1).

The reason for this quirk is to maintain binary compatibility of the compiled terminfo files with other implementations, e.g., the SVr4 systems, which document this. Compiled terminfo files use null-terminated strings, with no lengths. Modifying this would require a new binary format, which would not work with other implementations.

Finally, characters may be given as three octal digits after a \e.

A delay in milliseconds may appear anywhere in a string capability, enclosed in $<..> brackets, as in el=\eEK$<5>, and padding characters are supplied by tputs(3X) to provide this delay.

The delay must be a number with at most one decimal place of precision; it may be followed by suffixes \*(``*\*('' or \*(``/\*('' or both.

A \*(``*\*('' indicates that the padding required is proportional to the number of lines affected by the operation, and the amount given is the per-affected-unit padding required. (In the case of insert character, the factor is still the number of lines affected.)