Session.search_windows
Windows in this session, optionally filtered by tmux.
Source and package
-
Description#
Like
Session.windowsbut with afilterkwarg passed to$ tmux list-windows -t <session> -f <filter>.Examples#
>>> _ = session.new_window(window_name='gap7s_target')>>> _ = session.new_window(window_name='other_window')>>> matches = session.search_windows(filter='#{m:gap7s_*,#{window_name}}')>>> [w.window_name for w in matches]['gap7s_target']- Parameters
-
-
filter(str | None) # – tmux format expression (-fflag). 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
-
tmux command#
The tmux commands behind search_windows.
list-windows -t session scope, cmd_list_windows_exec tmux C API#
The C declarations in tmux that implement these commands.
In other ports#
Filter a session's windows with a tmux expression
| Language | Equivalent |
|---|---|
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | no equivalent on Session |
| Rust | 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#.