Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

class libtmux-java latest

Keys

The server's key bindings, in one key table or across all of them.

Source and package
Qualified name
io.github.libtmux.Keys
Package
io.github.libtmux
Distribution
io.github.libtmux:libtmux
Source
libtmux/src/main/java/io/github/libtmux/Keys.java
class io.github.libtmux.Keys

Description#

tmux keeps bindings in named tables: prefix, pressed after the prefix key, is where a binding goes unless another table is named; root is pressed without it; the copy-mode tables belong to copy mode. Server#keys() answers for prefix when binding and for every table when listing; #in() names one.

Examples#

server.keys().bind("F12", List.of("display-message", "hello"));
server.keys().in("root").bind("F11", List.of("next-window"));

Members5#

Collections and queries1#

  • list method The bindings as tmux lists them, one per line.

Common operations2#

  • bind method Binds a key to a tmux command, given as its words.
  • unbind method Removes a key's binding.

Other members2#

  • in method The same bindings, in one named table.
  • Keys method
Esc

Type to search.

Reference previewOpen reference