Termit Lua API - nonstop/termit GitHub Wiki

Functions

activateTab(tab_index) – Activates tab by index.
tab_index – index of tab to activate. Index of the first tab is 1.

addMenu(menu) – Adds menu in menubar.
menu – table of TermitMenuItem type.

addPopupMenu(menu) – Adds menu in popup menu, similar to addMenu.
menu – table of TermitMenuItem type.

bindKey(keys, luaFunction) – Sets new keybinding. If luaFunction is nil removes keybinding.
keys – string with keybinding. Available modifiers are Alt Ctrl Shift Meta Super Hyper.
luaFunction – callback function

Example: don't close tab with Ctrl-w, use CtrlShift-w
    bindKey('Ctrl-w', nil)
    bindKey('CtrlShift-w', closeTab)

bindMouse(event, luaFunction) – Sets new mouse-binding. If luaFunction is nil removes mouse-binding.
event – string with one of those values: DoubleClick
luaFunction – callback function

closeTab() – Closes active tab.

copy() – Copies selection into tab’s buffer.

currentTab() – Returns current tab of TermitTabInfo.

currentTabIndex() – Returns current tab index.

feed(data) – Interprets data as if it were data received from a terminal process.

feedChild(data) – Sends a data to the terminal as if it were data entered by the user at the keyboard.

findDlg() – Opens find entry. (Enabled when build with vte version >= 0.26)

findNext() – Searches the next string matching search regex.

findPrev() – Searches the previous string matching search regex.

forEachRow(func) – For each terminal row in entire scrollback buffer executes function passing row as argument.
func – function to be called.

forEachVisibleRow(func) – For each visible terminal row executes function passing row as argument.
func – function to be called.

loadSessionDlg() – Displays “Load session” dialog.

nextTab() – Activates next tab.

openTab(tabInfo) – Opens new tab.
tabinfo – table of TermitTabInfo with tab settings.

Example:
    tabInfo = {}
    tabInfo.title = 'Zsh tab'
    tabInfo.command = 'zsh'
    tabInfo.encoding = 'UTF-8'
    tabInfo.workingDir = '/tmp'
    openTab(tabInfo)

paste() – Pastes tab’s buffer.

preferencesDlg() – Displays “Preferences” dialog.

prevTab() – Activates previous tab.

quit() – Quit.

reconfigure() – Sets all configurable variables to defaults and forces rereading rc.lua.

saveSessionDlg() – Displays “Save session” dialog.

selection() – Returns selected text from current tab.

setColormap(colormap) – Changes colormap for active tab.
colormap – array with 8 or 16 or 24 colors.

setEncoding(encoding) – Changes encoding for active tab.
encoding – string with encoding name.

Example:
    setEncoding('UTF-8')

setKbPolicy(kb_policy) – Sets keyuboard policy for shortcuts.
kb_policy – string with one of those values:

keycode – use hardware keyboard codes (XkbLayout-independent)
keysym – use keysym values (XkbLayout-dependent)

Example: treat keys via current XkbLayout
    setKbPolicy('keysym')

setOptions(opts) – Changes default options.
opts – table of TermitOptions type with new options:

setTabBackgroundColor(color) – Changes background color for active tab.
color – string with new color.

setTabFont(font) – Changes font for active tab.
font – string with new font.

setTabForegroundColor(color) – Changes foreground (e.g. font) color for active tab.
color – string with new color.

setTabTitle(tabTitle) – Changes title for active tab.
tabTitle – string with new tab title.

setTabTitleDlg() – Displays “Set tab title” dialog.

setWindowTitle(title) – Changes termit window title.
title – string with new title.

*spawn(command) – Spawns command (works via shell).
command – string with command and arguments.

toggleMenubar() – Displays or hides menubar.

toggleTabbar() – Displays or hides tabbar.

Types

TermitCursorBlinkMode – one of those string values:

System – Follow GTK+ settings for cursor blinking
BlinkOn – Cursor blinks
BlinkOff – Cursor does not blink

TermitCursorShape – one of those string values:

Block – Draw a block cursor
Ibeam – Draw a vertical bar on the left side of character
Underline – Draw a horizontal bar below the character

TermitEraseBinding – one of those string values:

Auto – VTE_ERASE_AUTO
AsciiBksp – VTE_ERASE_ASCII_BACKSPACE
AsciiDel – VTE_ERASE_ASCII_DELETE
EraseDel – VTE_ERASE_DELETE_SEQUENCE
EraseTty – VTE_ERASE_TTY

For detailed description look into Vte docs.

TermitKeybindings – table with predefined keybindings.

closeTab – ‘Ctrl-w’
copy – ‘Ctrl-Insert’
nextTab – ‘Alt-Right’
openTab – ‘Ctrl-t’
paste – ‘Shift-Insert’
prevTab – ‘Alt-Left’

Example: enable Gnome-like tab switching
    keys = {}
    keys.nextTab = 'Ctrl-Page_Down'
    keys.prevTab = 'Ctrl-Page_Up'
    setKeys(keys)

TermitMenuItem – table for menuitems.

accel – accelerator for menuitem. String with keybinding
action – lua-function to execute when item activated
name – name for menuitem

TermitOptions – table with termit options.

allowChangingTitle – auto change title (similar to xterm)
audibleBell – enables audible bell
backgroundColor – background color
backspaceBinding – reaction on backspace key (one of TermitEraseBinding)
colormap – array with 8 or 16 or 24 colors
cursorBlinkMode – cursor blink mode (one of TermitCursorBlinkMode)
cursorShape – cursor shape (one of TermitCursorShape)
deleteBinding – reaction on delete key (one of TermitEraseBinding)
encoding – default encoding
fillTabbar – expand tabs’ titles to fill whole tabbar
font – font name
foregroundColor – foreground color
geometry – cols x rows to start with
getTabTitle – lua function to generate new tab title
getWindowTitle – lua function to generate new window title
hideMenubar – hide menubar
hideTabbar – hide tabbar
hideSingleTab – hide tabbar when only 1 tab present
hideTitlebarWhenMaximized – hide window titlebar when mazimized
matches – table with items of TermitMatch type
scrollbackLines – the length of scrollback buffer
scrollOnKeystroke – enables scroll to the bottom when the user presses a key
scrollOnOutput – enables scroll to the bottom when new data is received
setStatusbar – lua function to generate new statusbar message
showBorder – show notebook border
showScrollbar – display scrollbar
startMaximized – maximize window on start
tabName – default tab name
tabPos – tabbar position (Top, Bottom, Left, Right)
tabs – table with items of TermitTabInfo type
urgencyOnBell – set WM-hint ‘urgent’ on termit window when bell
wordCharExceptions – additional word characters (double click selects word)

TermitTabInfo – table with tab settings:

command
encoding
font – font string
fontSize – font size
pid – process id
title
workingDir

Globals

tabs – Readonly table with tab settings, access specific tabs by index.

Bugs

After start sometimes there is black screen. Resizing termit window helps.

In options table ‘tabs’ field should be the last one. When loading all settings are applied in the same order as they are set in options table. So if you set tabs and only then colormap, these tabs would have default colormap.