API reference

There is an Executor.pm module which creates parsers for any API or Hotkeys calls. API is a simple text protocol over a TCP connection. CRLF endings are also supported in order to use it via telnet(1).

Possible tokens:

• <COLUMN NUM> -- desired column
• <DIRECTION> -- any vimish direction: h, j, k, l
• <FLOAT> -- floating point number, dot is mandatory: 0.00, 0.1, -3.145
• <FOCUS DIRECTION> -- empty or backward
• <ROW NUM> -- desired row
• <SCREEN NUM> -- desired screen
• <STRING> -- any arbitrary UTF-8 string
• <TAG NUM> -- desired tag

Supported API functions are:

• Run shell command: exec(<STRING>)
• Set active tag: tag_select(<TAG NUM>):
• Close focused window: win_close()
• Window close or toggle floating / maximize / always_on: win_toggle_<floating|maximize|always_on>()
• Window move to a particular tag: win_move_tag(<TAG NUM>):
• Set active screen: screen_select(<SCREEN NUM>)
• Window move to particular screen: win_move_screen(<SCREEN NUM>)
• Focus previous window (screen independent): focus_prev()
• Cycle focus: focus_cycle(<FOCUS DIRECTION>)
• Focus move: focus_move(<DIRECTION>)
• Focus swap: focus_swap(<DIRECTION>)
• Resize the layout: layout_resize(<DIRECTION>)
• Expose windows: expose()
• Resize the layout from API: layout_resize(<SCREEN NUM>, <TAG NUM>, <ROW NUM>, <COLUMN NUM>, <FLOAT>, <FLOAT>)
• Exit from WM: exit()

Debug API

Several API calls are also available in case debug mode is ON. All of them will respond with the dump of certain data structures.

• dump_windows()
• dump_screen(<SCREEN NUMBER>)
• dump_tag(<SCREEN NUMBER>, <TAG NUMBER>)