Server.search_panes
All panes across the server, optionally filtered by tmux.
Source and package
-
Description#
Like
Server.panesbut with afilterkwarg passed to$ tmux list-panes -a -f <filter>. tmux drops non-matching panes before libtmux builds objects.Examples#
>>> sess = server.new_session(session_name='gap7_pane_demo')>>> window = sess.active_window>>> target_pane = window.split()>>> matches = server.search_panes(... filter=f'#{{m:{target_pane.pane_id},#{{pane_id}}}}'... )>>> [p.pane_id for p in matches] == [target_pane.pane_id]True- Parameters
-
-
filter(str | None) # – tmux format expression (-fflag). Example:'#{m:%5,#{pane_id}}'(id match) or'#{C/i:libtmux,#{pane_current_command}}'(case-insensitive substring on the current command). tmux silently expands a malformed filter (unclosed#{...}, unknown format token) to empty, which the filter treats as false — every row is suppressed and no stderr is emitted. A bad filter is indistinguishable from "filter matched nothing"; verify filter syntax against the FORMATS section oftmux(1). Warning: added 0.57
-
In other ports Filter every pane with a tmux expression
- PowerShell No source-verified PowerShell equivalent is recorded for this operation.
- Julia No source-verified Julia equivalent is recorded for this operation.
- Ruby
- Lua
- TypeScript no equivalent on
Server - Rust no equivalent on
Server - Go
- Java no equivalent on
Server - C#
- C++ no equivalent on
Server - Swift no equivalent on
Server - Kotlin No source-verified Kotlin equivalent is recorded for this operation.
- Scala No source-verified Scala equivalent is recorded for this operation.
- F# No source-verified F# equivalent is recorded for this operation.