Core LibraryunreleasedAPI Reference

Choose documentation 2

latest

Current version

latest
English

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

function libtmux-lisp latest

libtmux:rename-session

Rename SESSION with literal TEXT, or an explicit FORMAT-P expression. Return a COMMAND-OUTCOME. OBSERVE defaults true and supplies a replacement through OUTCOME-VALUE; observation failure is retained separately. Tmux enforces session-name restrictions and uniqueness. Signals STALE-TARGET or an operational condition. Timeout and byte limits cover preflight, mutation and observation.

Source and package
Qualified name
libtmux:rename-session
Declared in
libtmux
Package
libtmux
Source
src/operations.lisp
(rename-session client session text &key format-p (observe t) cancel-token timeout output-limit)

Public owner: libtmux

tmux command#

The tmux commands behind rename-session.

tmux C API#

The C declarations in tmux that implement these commands.

Guides#

Pages that discuss rename-session.

Esc

Type to search.

Reference previewOpen reference