Core LibraryunreleasedAPI Reference

Choose documentation 1

latest

Current version

latest
English

Unreleased libtmux_erlang has not been released. Its API may change during development. This site's structure and URLs may change too.

function libtmux-erlang latest

tmux_session:select/3

Switch one attached client, selected by its literal native client name or TTY path, to the session's registered stable ID. Performs I/O and returns the command result; existing rows remain captured values. Obtain the name from the caller's own client context, such as tmux's client_name format. There is no default client and this call never attaches one.

Source and package
Qualified name
tmux_session:select/3
Declared in
tmux_session
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_session.erl
select(Session, Client, Options) -spec select(tmux_model:session(), binary(), select_options()) -> {ok, map()} | {error, map()}.

Description#

update_environment defaults to false (switch-client -E). When true, tmux updates the destination session environment using its update-environment option and that client's environment; listed variables absent from the client can be marked for removal. Running pane processes retain their environment.

Names are nonempty NUL-free binaries of at most 32 KiB. Trailing-colon aliases are rejected. Native lookup matches an exact name or TTY path, including its /dev/-relative alias; there is no prefix or pattern matching. A disconnected name returns client_not_found. Names and TTY paths can be reused by a later connection; this API does not identify a client incarnation atomically. A missing destination returns target_gone. See tmux_server:bind/2 for detached session rows and tmux_window_link:select/1 for window selection.

tmux command#

The tmux commands behind select/3.

tmux C API#

The C declarations in tmux that implement these commands.

Guides#

Pages that discuss select/3.

Concepts
Esc

Type to search.

Reference previewOpen reference