Core LibraryalphaAPI 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.

method libtmux-cxx latest

Pane.leave_mode

Leave whatever mode the pane is in.

Source and package
Qualified name
libtmux::Pane::leave_mode
Namespace
libtmux
Declared in
Pane
Package
libtmux-cxx
Source
include/libtmux/entities.hpp
[[C++ nodiscard attributeAsks the compiler to warn when a result is discarded. An explicit cast to void acknowledges that the result is intentionally ignored.Language documentation]] expected<void, CommandFailure> leave_mode() const;

Description#

A pane in no mode is refused, with tmux's "not in a mode". That is kept rather than smoothed into success: checking first would cost a round trip and still race, and a caller who cares can read in_mode() or ignore the failure.

tmux command#

The tmux commands behind leave_mode.

tmux C API#

The C declarations in tmux that implement these commands.

Esc

Type to search.

Reference previewOpen reference