Package: github.com/gdamore/tcell/v2/terminfo

package terminfo Import Path github.com/gdamore/tcell/v2/terminfo (on go.dev) Dependency Relation imports 9 packages, and imported by 36 packages Involved Source Files terminfo.go Package-Level Type Names (only one) /* sort by: alphabet | popularity */ type Terminfo (struct) Terminfo represents a terminfo entry. Note that we use friendly names in Go, but when we write out JSON, we use the same names as terminfo. The name, aliases and smous, rmous fields do not come from terminfo directly. Fields (total 198) Aliases []string AltChars string // acsc AttrOff string // sgr0 AutoMargin bool // true if writing to last cell in line advances Bell string // bell Blink string // blink Bold string // bold Clear string // clear Colors int // colors Columns int // cols CurlyUnderline string // Smulx with param 3 CursorBack1 string // cub1 CursorBlinkingBar string CursorBlinkingBlock string CursorBlinkingUnderline string CursorColor string // nothing uses it yet CursorColorRGB string // Cs (but not really because Cs uses X11 color string) CursorColorReset string // Cr CursorDefault string CursorSteadyBar string CursorSteadyBlock string CursorSteadyUnderline string CursorUp1 string // cuu1 DashedUnderline string // Smulx with param 5 Dim string // dim DisableAutoMargin string // smam DisableFocusReporting string DisablePaste string DottedUnderline string // Smulx with param 4 DoubleUnderline string // Smulx with param 2 EnableAcs string // enacs EnableAutoMargin string // rmam EnableFocusReporting string EnablePaste string // bracketed paste mode EnterAcs string // smacs EnterCA string // smcup EnterKeypad string // smkx EnterUrl string ExitAcs string // rmacs ExitCA string // rmcup ExitKeypad string // rmkx ExitUrl string HideCursor string // civis InsertChar string // string to insert a character (ich1) Italic string // sitm KeyAltDown string // alt-left KeyAltEnd string KeyAltHome string KeyAltLeft string // alt-left KeyAltRight string // alt-right KeyAltShfDown string KeyAltShfEnd string KeyAltShfHome string KeyAltShfLeft string KeyAltShfRight string KeyAltShfUp string KeyAltUp string // alt-up KeyBackspace string // kbs KeyBacktab string // kcbt KeyCancel string // kcan KeyClear string // kclr KeyCtrlDown string // ctrl-left KeyCtrlEnd string KeyCtrlHome string KeyCtrlLeft string // ctrl-left KeyCtrlRight string // ctrl-right KeyCtrlShfDown string KeyCtrlShfEnd string KeyCtrlShfHome string KeyCtrlShfLeft string KeyCtrlShfRight string KeyCtrlShfUp string KeyCtrlUp string // ctrl-up KeyDelete string // kdch1 KeyDown string // kcud1 KeyEnd string // kend KeyExit string // kext KeyF1 string // kf1 KeyF10 string // kf10 KeyF11 string // kf11 KeyF12 string // kf12 KeyF13 string // kf13 KeyF14 string // kf14 KeyF15 string // kf15 KeyF16 string // kf16 KeyF17 string // kf17 KeyF18 string // kf18 KeyF19 string // kf19 KeyF2 string // kf2 KeyF20 string // kf20 KeyF21 string // kf21 KeyF22 string // kf22 KeyF23 string // kf23 KeyF24 string // kf24 KeyF25 string // kf25 KeyF26 string // kf26 KeyF27 string // kf27 KeyF28 string // kf28 KeyF29 string // kf29 KeyF3 string // kf3 KeyF30 string // kf30 KeyF31 string // kf31 KeyF32 string // kf32 KeyF33 string // kf33 KeyF34 string // kf34 KeyF35 string // kf35 KeyF36 string // kf36 KeyF37 string // kf37 KeyF38 string // kf38 KeyF39 string // kf39 KeyF4 string // kf4 KeyF40 string // kf40 KeyF41 string // kf41 KeyF42 string // kf42 KeyF43 string // kf43 KeyF44 string // kf44 KeyF45 string // kf45 KeyF46 string // kf46 KeyF47 string // kf47 KeyF48 string // kf48 KeyF49 string // kf49 KeyF5 string // kf5 KeyF50 string // kf50 KeyF51 string // kf51 KeyF52 string // kf52 KeyF53 string // kf53 KeyF54 string // kf54 KeyF55 string // kf55 KeyF56 string // kf56 KeyF57 string // kf57 KeyF58 string // kf58 KeyF59 string // kf59 KeyF6 string // kf6 KeyF60 string // kf60 KeyF61 string // kf61 KeyF62 string // kf62 KeyF63 string // kf63 KeyF64 string // kf64 KeyF7 string // kf7 KeyF8 string // kf8 KeyF9 string // kf9 KeyHelp string // khlp KeyHome string // khome KeyInsert string // kich1 KeyLeft string // kcub1 KeyMetaDown string // meta-left KeyMetaEnd string KeyMetaHome string KeyMetaLeft string // meta-left KeyMetaRight string // meta-right KeyMetaShfDown string KeyMetaShfEnd string KeyMetaShfHome string KeyMetaShfLeft string KeyMetaShfRight string KeyMetaShfUp string KeyMetaUp string // meta-up KeyPgDn string // knp KeyPgUp string // kpp KeyPrint string // kprt KeyRight string // kcuf1 KeyShfDelete string // kDC KeyShfDown string // shift-down KeyShfEnd string // kEND KeyShfHome string // kHOM KeyShfInsert string // kIC KeyShfLeft string // kLFT KeyShfPgDn string // shift-knp KeyShfPgUp string // shift-kpp KeyShfRight string // kRIT KeyShfUp string // shift-up KeyUp string // kcuu1 Lines int // lines Modifiers int Mouse string // kmous Name string PadChar string // pad PasteEnd string PasteStart string ResetFgBg string // op Reverse string // rev SetBg string // setab SetBgRGB string // setbrgb SetCursor string // cup SetFg string // setaf SetFgBg string // setfgbg SetFgBgRGB string // setfgbgrgb SetFgRGB string // setfrgb SetWindowSize string SetWindowTitle string // no terminfo extension ShowCursor string // cnorm StrikeThrough string // smxx TrueColor bool // true if the terminal supports direct color Underline string // smul UnderlineColor string // Setuc1 UnderlineColorRGB string // Setulc UnderlineColorReset string // ol XTermLike bool // (XT) has XTerm extensions Methods (total 4) (*Terminfo) TColor(fi, bi int) string TColor returns a string corresponding to the given foreground and background colors. Either fg or bg can be set to -1 to elide. (*Terminfo) TGoto(col, row int) string TGoto returns a string suitable for addressing the cursor at the given row and column. The origin 0, 0 is in the upper left corner of the screen. (*Terminfo) TParm(s string, p ...interface{}) string TParm takes a terminfo parameterized string, such as setaf or cup, and evaluates the string, and returns the result with the parameter applied. (*Terminfo) TPuts(w io.Writer, s string) TPuts emits the string to the writer, but expands inline padding indications (of the form $<[delay]> where [delay] is msec) to a suitable time (unless the terminfo string indicates this isn't needed by specifying npc - no padding). All Terminfo based strings should be emitted using this function. As Outputs Of (at least 3) func LookupTerminfo(name string) (*Terminfo, error) func github.com/gdamore/tcell/v2/terminfo/dynamic.LoadTerminfo(name string) (*Terminfo, string, error) func github.com/gdamore/tcell/v2.LookupTerminfo(name string) (ti *Terminfo, e error) As Inputs Of (at least 2) func AddTerminfo(t *Terminfo) func github.com/gdamore/tcell/v2.NewTerminfoScreenFromTtyTerminfo(tty tcell.Tty, ti *Terminfo) (s tcell.Screen, e error) Package-Level Functions (total 2) func AddTerminfo(t *Terminfo) AddTerminfo can be called to register a new Terminfo entry. func LookupTerminfo(name string) (*Terminfo, error) LookupTerminfo attempts to find a definition for the named $TERM. Package-Level Variables (only one) var ErrTermNotFound error ErrTermNotFound indicates that a suitable terminal entry could not be found. This can result from either not having TERM set, or from the TERM failing to support certain minimal functionality, in particular absolute cursor addressability (the cup capability) is required. For example, legacy "adm3" lacks this capability, whereas the slightly newer "adm3a" supports it. This failure occurs most often with "dumb". Package-Level Constants (total 2) const ModifiersNone = 0 const ModifiersXTerm = 1

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64) Golds is a Go 101 project developed by Tapir Liu. PR and bug reports are welcome and can be submitted to the issue list. Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.