Session.lock
Lock every client attached to this session.
Source and package
-
Description#
tmux runs the
lock-commandto lock, so what a locked client shows is that command's business rather than this one's.Errors
Returns an error when tmux cannot be reached or refuses the lock.
Examples#
let guard = libtmux::test::TestServer::new().await?;let session = guard.server().new_session("locked").await?;// Locking a session nobody is attached to is accepted and does nothing.session.lock().await?;guard.shutdown().await?;
tmux command#
The tmux commands behind lock.
tmux C API#
The C declarations in tmux that implement these commands.
In other ports#
Lock every client attached to a session
| Language | Equivalent |
|---|---|
| Python | libtmux |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | no equivalent on Session |
| Go | tmux |
| Java | no equivalent on Session |
| C# | Lib |
| C++ | no equivalent on Session |
| Swift | no equivalent on Session |
| OCaml | No direct public OCaml equivalent is recorded for this operation. |
| Perl | No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands. |
No equivalent is recorded in Ruby, Lua, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.