Session.rename
Rename the session and update this handle.
Source and package
-
Description#
A name given as text reaches tmux as that text,
#included. Only aTmuxArg::format()value is expanded as a format, so#(command)in one runs a shell command. See [the crate documentation][crate#a-name-reaches-tmux-as-text].Errors
Returns an error when tmux refuses the name, which includes one that is empty or already taken.
tmux command#
The tmux commands behind rename.
tmux C API#
The C declarations in tmux that implement these commands.
In other ports#
Rename a session
| Language | Equivalent |
|---|---|
| Python | libtmux |
| Ruby | Lib |
| Lua | libtmux |
| Erlang | tmux |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | session |
| Go | tmux |
| Java | io |
| C# | Lib |
| C++ | libtmux:: |
| Swift | Server |
| OCaml | Libtmux |
| Perl | Lib Explicit Server operation. Captured entities remain local observations; use a new snapshot to observe changes. |
No equivalent is recorded in PowerShell, Julia, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.