Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

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

method libtmux latest

Server.search_windows

All windows across sessions, optionally filtered by tmux.

Source and package
Qualified name
libtmux.Server.search_windows
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
search_windows ( self, filter: str | None = None, # noqa: A002 ) → QueryList[Window]

Description#

Like Server.windows but with a filter kwarg passed to $ tmux list-windows -a -f <filter>.

Examples#

>>> sess = server.new_session(session_name='gap7_win_demo')
>>> _ = sess.new_window(window_name='gap7_target')
>>> _ = sess.new_window(window_name='other_window')
>>> matches = server.search_windows(filter='#{m:gap7_*,#{window_name}}')
>>> any(w.window_name == 'gap7_target' for w in matches)
True
>>> any(w.window_name == 'other_window' for w in matches)
False
Parameters
  • filter (str | None) # – tmux format expression (-f flag). 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 of tmux(1). Warning: added 0.57

  • # noqa: A002 #

tmux command#

The tmux commands behind search_windows.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Filter every window with a tmux expression

Equivalents of Filter every window with a tmux expression 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.SearchWindows
Java no equivalent on Server
C# LibTmux.Server.SearchWindowsAsync
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#.

Esc

Type to search.

Reference previewOpen reference