termit(1)

1TERMIT(30)                       User Manuals                       TERMIT(30)
2
3
4

NAME

6       termit - lightweight terminal emulator
7
8

SYNOPSIS

10       termit [-option ...]
11
12

DESCRIPTION

14       termit  is a vte-based lightweight terminal emulator. All configuration
15       is done via Lua-scripts. The only other dependencies are Gtk+ and Vte.
16
17

OPTIONS

19       -h or --help
20              Print help
21       -v or --version
22              Print version number
23       -e or --execute cmd
24              Use cmd as shell
25
26              termit --execute=zsh
27
28       -i or --init file
29              Use file instead of default rc.lua
30
31              termit --init=session.lua
32

FILES

34       $HOME/.config/termit/rc.lua
35              Per user configuration file. See section TERMIT LUA API for fur‐
36              ther details.
37       /usr/share/doc/termit/rc.lua.example
38              Example  rc.lua file. Demonstrates usage of almost all available
39              settings.
40

TERMIT LUA API

42       Functions:
43
44       setOptions ( opts ) - Changes default options.
45           opts - table with new options:
46
47       setKeys ( keys ) - Changes default keybindings.
48           keys - table of TermitKeybindings type.
49
50       setKbPolicy ( kb_policy ) - Sets keyuboard policy for shortcuts.
51           kb_policy - string with one of those values:
52               keycode - use hardware keyboard codes (XkbLayout-independent)
53               keysym - use keysym values (XkbLayout-dependent)
54
55       setColormap ( colormap ) - Sets new colormap.
56           colormap - array with 8 or 16 or 24 colors.
57
58       bindKey ( keys , luaFunction ) - Sets new keybinding. If luaFunction is
59       nil removes keybinding.
60           keys - string with keybinding
61           luaFunction - callback function
62
63       bindMouse ( event , luaFunction ) - Sets new mouse-binding. If luaFunc‐
64       tion is nil removes mouse-binding.
65           event - string with one of those values: DoubleClick
66           luaFunction - callback function
67
68       openTab ( tabInfo ) - Opens new tab.
69           tabinfo - table of TermitTabInfo with tab settings.
70
71       prevTab () - Activates previous tab.
72
73       nextTab () - Activates next tab.
74
75       closeTab () - Closes active tab.
76
77       activateTab ( tab_index ) - Activates tab by index.
78           tab_index - index of tab to activate. Index of the first tab is 1.
79
80       copy () - Copies selection into tab's buffer.
81
82       paste () - Pastes tab's buffer.
83
84       selection () - Returns selected text from current tab.
85
86       addMenu ( menu ) - Adds menu in menubar.
87           menu - table of TermitMenuItem type.
88
89       addPopupMenu ( menu ) Adds menu in popup menu, similar to addMenu.
90           menu - table of TermitMenuItem type.
91
92       setEncoding ( encoding ) - Changes encoding for active tab.
93           encoding - string with encoding name.
94
95       setTabTitle ( tabTitle ) - Changes title for active tab.
96           tabTitle - string with new tab title.
97
98       setWindowTitle ( title ) - Changes termit window title.
99           title - string with new title.
100
101       setTabForegroundColor ( color ) - Changes foreground (e.g. font)  color
102       for active tab.
103           color - string with new color.
104
105       setTabBackgroundColor  (  color ) - Changes background color for active
106       tab.
107           color - string with new color.
108
109       spawn ( command ) - Spawns command (works via shell).
110           command - string with command and arguments.
111
112       reconfigure () - Sets all configurable variables to defaults and forces
113       rereading rc.lua.
114
115       currentTabIndex () - Returns current tab index.
116
117       currentTab () - Returns current tab of TermitTabInfo.
118
119       Types:
120
121       TermitTabInfo - table with termit options.
122           tabName - default tab name
123           encoding - default encoding
124           wordChars - word characters (double click selects word)
125           font - font name
126           foregroundColor
127           backgroundColor
128           showScrollbar
129           fillTabbar - expand tabs' titles to fill whole tabbar
130           allowChangingTitle - auto change title (similar to xterm)
131           audibleBell - enables audible bell
132           visibleBell - enables visible bell
133           urgencyOnBell - set WM-hint 'urgent' on termit window when bell
134           getWindowTitle - lua function to generate new window title
135           getTabTitle - lua function to generate new tab title
136           transparentBackground - use transparency
137           transparentSaturation - level of saturation [0,1]
138           hideSingleTab
139           hideMenubar
140           scrollbackLines
141           geometry - cols x rows to start with
142
143       TermitTabInfo - table with tab settings:
144           title
145           command
146           encoding
147           workingDir
148           pid - process id
149           font - font string
150           fontSize - font size
151
152       TermitMenuItem - table for menuitems.
153           name - name for menuitem
154           action  -  lua-function  or  string to execute when item activated.
155       String values are deprecated.
156
157       TermitKeybindings - table with predefined keybindings.
158           prevTab - 'Alt-Left'
159           nextTab - 'Alt-Right'
160           openTab - 'Ctrl-t'
161           closeTab - 'Ctrl-w'
162           copy - 'Ctrl-Insert'
163           paste - 'Shift-Insert'
164
165       Globals:
166
167       tabs - table with tab settings, access specific tabs by index.
168

EXAMPLES

170       Look inside provided rc.lua.example.
171

BUGS

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

AUTHOR

177       Evgeny Ratnikov <ratnikov.ev at gmail dot com>
178