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.

struct libtmux-go latest

TmuxFilter

TmuxFilter is a raw tmux -f format expression. It is distinct from the generated local filter structs and is evaluated only by tmux. A nil filter omits -f; a nonnil empty filter sends an explicit empty expression.

Source and package
Qualified name
tmux.TmuxFilter
Package
tmux
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/server_buffers.go
struct tmux.TmuxFilter

Description#

The expression is tmux's own, so it is written the way tmux's FORMATS section describes rather than built from Go values:

active := tmux.TmuxFilter("#{==:#{window_active},1}")
windows, err := session.SearchWindows(ctx, &active)

tmux evaluates this while listing. Generated model filters run in Go after materialization.

revive:disable-next-line:exported TmuxFilter preserves tmux vocabulary beside local model filters.

Guides#

Pages that discuss TmuxFilter.

Esc

Type to search.

Reference previewOpen reference