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:rename_command/2

Build a literal rename command without tmux I/O. Validates the row and keeps its captured origin; endpoint liveness is checked during execution. Submit the value to tmux_server:command/3 or tmux_operation:start/3 with its original endpoint. Existing session records retain their captured name.

Source and package
Qualified name
tmux_session:rename_command/2
Declared in
tmux_session
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_session.erl
rename_command(Session, Name) -spec rename_command(tmux_model:session(), binary()) -> {ok, tmux_command:t()} | {error, map()}.

Description#

Detached rows require tmux_server:bind/2 first. Building a command does not execute it or make a repeated mutation safe.

Examples#

1> tmux_session:rename_command(invalid_row, <<"work">>).
{error,#{code => invalid_row,path => []}}
Parameters
Esc

Type to search.

Reference previewOpen reference