libtmux
Go

Choose a port 22

Scripting & web

PythonNo matching page
RubyNo matching page
LuaNo matching page
JuliaNo matching page
TypeScriptNo matching page
PerlNo matching page

Compiled & native

RustNo matching page
Go
C++No matching page
Common LispNo matching page
SwiftNo matching page
OCamlNo matching page
HaskellNo matching page

JVM

JavaNo matching page
KotlinNo matching page
ScalaNo matching page
ClojureNo matching page

.NET

C#No matching page
F#No matching page
PowerShellNo matching page

BEAM

ErlangNo matching page
ElixirNo matching page

tmux

tmux CLI

GitHub pkg.go.dev
Packages

Packages and source 16

Source

tmuxpackage · tmux libtmux-golibtmux/libtmux-go tmuxqpackage · tmuxq tmux/tmuxtestpackage · tmux/tmuxtest mcpmodule · mcp libtmux-mcpcommand · mcp/cmd/libtmux-mcp workspacemodule · workspace tmux-workspacecommand · workspace/cmd/tmux-workspace

Packages

tmuxpackage · libtmux-go/tmux libtmux-gomodule · libtmux-go tmuxqpackage · libtmux-go/tmuxq tmux/tmuxtestpackage · libtmux-go/tmux/tmuxtest mcpmodule · libtmux-go/mcp libtmux-mcpcommand · libtmux-go/mcp/cmd/libtmux-mcp workspacemodule · libtmux-go/workspace tmux-workspacecommand · libtmux-go/workspace/cmd/tmux-workspace

Go · libtmux/libtmux-go
Search
Colour scheme
Menu
Reference MCP
GitHub pkg.go.dev
Packages

Packages and source 16

Source

tmuxpackage · tmux libtmux-golibtmux/libtmux-go tmuxqpackage · tmuxq tmux/tmuxtestpackage · tmux/tmuxtest mcpmodule · mcp libtmux-mcpcommand · mcp/cmd/libtmux-mcp workspacemodule · workspace tmux-workspacecommand · workspace/cmd/tmux-workspace

Packages

tmuxpackage · libtmux-go/tmux libtmux-gomodule · libtmux-go tmuxqpackage · libtmux-go/tmuxq tmux/tmuxtestpackage · libtmux-go/tmux/tmuxtest mcpmodule · libtmux-go/mcp libtmux-mcpcommand · libtmux-go/mcp/cmd/libtmux-mcp workspacemodule · libtmux-go/workspace tmux-workspacecommand · libtmux-go/workspace/cmd/tmux-workspace

Go · libtmux/libtmux-go
Core Library0.xAPI Reference

Choose documentation 3

Go · latest · en
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.

Go API

Up Root

method libtmux-go latest

WindowOptionValues.ModeKeys

ModeKeys returns materialized "mode-keys" as OptionValue with value type OptionValueModeKeys from window option values; it does not query tmux. Available as CHOICE (choices: "emacs", "vi"); set it with Window.SetModeKeys or GlobalWindowScope.SetModeKeys.

Source and package
Qualified name
tmux.WindowOptionValues.ModeKeys
Package
tmux
Declared in
WindowOptionValues
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/option_generated.go
func (v WindowOptionValues) ModeKeys() OptionValue[ModeKeys]
method [source]

tmux options#

Settings for the server, sessions, windows and panes, with their types, defaults and allowed values.

Options

Related types#

WindowOptionValues

WindowOptionValues is an immutable materialized view of known window option values; its zero value is empty and it does not refresh. Obtain it with Window.Options or GlobalWindowScope.Options. OptionValue.Get reports presence and OptionValue.Origin reports inheritance. Use Window.RawOption or GlobalWindowScope.RawOption for caller-named or undecoded values.

OptionValue

OptionValue preserves option presence and resolution origin. Its zero value is absent. Copies of reference-bearing T values are shallow.

ModeKeys

ModeKeys is a typed value for the "mode-keys" tmux option. Its zero value is invalid.

Esc

Type to search.

 Reference previewOpen reference