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

NotificationOptions

NotificationOptions configures which notifications a stream receives. The zero value retains notifications other than pane output.

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

Fields3#

NotificationOptions fields
NameTypeDescription
BacklogBytes int BacklogBytes bounds the notifications this stream holds while the caller is not reading, counting each notification's text and a small fixed overhead. Zero means 16 MiB. Once a notification would cross the bound, reads return the queued prefix and then ErrControlNotificationOverflow. A larger bound trades memory for headroom on a chatty pane; a smaller one makes a slow reader fail sooner. It may not be below 64 KiB.
IncludePaneOutput bool IncludePaneOutput includes output and extended-output notifications.
PauseAfter time.Duration PauseAfter asks tmux to hold a pane's output once this stream is that far behind on it, and to say so with a pause notification. Zero leaves tmux's own behavior, which ends a stream that falls five minutes behind rather than pausing it. tmux resolves this to whole seconds, and it governs pane output, so it requires IncludePaneOutput.
Esc

Type to search.

Reference previewOpen reference