Python

Choose a port 22

Scripting & web

RubyNo matching page

LuaNo matching page

JuliaNo matching page

TypeScriptNo matching page

PerlNo matching page

Compiled & native

RustNo matching page

C++No matching page

Common LispNo matching page

SwiftNo matching page

OCamlNo matching page

HaskellNo matching page

JVM

JavaNo matching page

KotlinNo matching page

ScalaNo matching page

ClojureNo matching page

.NET

F#No matching page

PowerShellNo matching page

BEAM

ErlangNo matching page

ElixirNo matching page

tmux

Packages

Packages and source 10

Source

libtmuxtmux-python/libtmux pytest pluginplugin · src/libtmux/pytest_plugin.py libtmux.testmodule · src/libtmux/test libtmux-mcplibtmux-mcp/src/libtmux_mcp libtmux-mcptmux-python/libtmux-mcp tmuxptmuxp/src/tmuxp tmuxptmux-python/tmuxp

Packages

libtmux-mcpPyPI

Python · tmux-python/libtmux

Auto Light Dark

Core Library0.xAPI Reference

Choose documentation 3

Core Library API reference and guides

Home Guides Topics Concepts Examples API Reference

Other references Upstream reference

0.x Released; the API may change. Read more

MCP Tools for connected assistants

Home Guides Topics Examples Tools Prompts Resources API Reference

pre-alpha Early development; expect breaking changes. Read more

Workspace Manager Repeatable development environments

Home Guides Topics Examples CLI Manual API Reference Configuration Internals

1.x Released; the API may change. Read more

latest

Current version

English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

Python API

method libtmux latest

Server.lock_client

Lock a client via $ tmux lock-client.

Source and package

Qualified name: libtmux.Server.lock_client
Module: libtmux
Declared in: Server
Package: libtmux
Source: src/libtmux/server.py
Other languages: Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Ruby Lua TypeScript Rust Go Java C# C++ Swift Kotlin Scala OCaml F# Clojure

lock_client (self, target_client: str | None = None) → None method [source] ¶

Description#

Requires an attached client.

Examples#

>>> with control_mode() as ctl:
...     server.lock_client()

Parameters

target_client (str | None) # – Target client (-t flag).

tmux command#

The tmux commands behind lock_client.

tmux C API#

The C declarations in tmux that implement these commands.

cmd_lock_client_entry cmd_lock_server_exec

In other ports#

Lock one client

Equivalents of Lock one client in other languages
Language	Equivalent
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	no equivalent on `Server`
Rust	no equivalent on `Server`
Go	`tmux.Server.LockClient`
Java	no equivalent on `Server`
C#	`LibTmux.Server.LockClientAsync`
C++	no equivalent on `Server`
Swift	no equivalent on `Server`
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#.

Reference preview