Window.rename/4
Renames an exact physical window across all its memberships.
Source and package
- Qualified name
-
LibTmux .Window .rename/4 - Module
- LibTmux
- Declared in
- Window
- Package
- libtmux
- Source
- lib/libtmux/entities.ex
- rename(connection, ref, name, options \\ []) @spec rename( Lib
Tmux (), Lib.Action .connection Tmux (), binary(), [Lib.Ref .t Tmux ()] ) :: {:ok, LibTmux.Action.result(:ok)} | {:error, Lib.Action .option Tmux ()}.Action .error -
Description#
Names contain 1..1024 UTF-8 bytes without Unicode control characters (Cc), with literal format syntax. tmux still applies name normalization, including dollar/backslash escaping. Control characters fail before I/O on both transports. Optional
session: session_refrequires membership in that exact session; it does not select a captured link index.timeoutdefaults to 5000ms. SeeLibTmux.Actionfor transport and outcomes.alias LibTmux.Window
Window.rename(control, window_ref, "editor")
- Parameters
-
-
ref(LibTmux ()) #.Ref .t -
options([LibTmux ()]) #.Action .option