EPIC Enhanced Programmable IRC-II Client

set status_hold_lines

Synopsis

/set status_hold_lines [<text>]
/set -status_hold_lines

Default: %B. With no text, set displays the current value. Unsetting removes the count field's format rather than restoring the default.

Description

Sets the format of the held-output count displayed for %B in status_format. The first %B inside status_hold_lines is replaced with the rounded count before insertion into the outer status line. Other status percent fields are not recursively expanded there.

EPIC takes the greater of the window's holding and scrollback distances, subtracts its display height, and rounds the positive result down to a multiple of that window's hold_interval. A zero interval is treated as one for this calculation. If the backlog or rounded count is zero, the field is empty. Counts are display rows, including wrapping, rather than necessarily whole messages.

For example, with an interval of 10, a backlog of 9 rows supplies no field, 19 supplies 10, and 20 supplies 20. Multiples of ten are not mandatory: the window's interval determines the rounding. The count can appear while browsing scrollback even with hold mode off.

Related fields and effects

The outer global or per-window format must contain %B. Each window uses its own state; the field is not restricted to the selected input window by show_status_all.

Status_hold, represented by %H, supplies a separate backlog label. It can appear before this count becomes large enough to display, and clearing either setting does not clear the other. Status_holdmode represents a different hold-mode condition.

Changing this text rebuilds status formats and requests updates. It does not change the count, interval, hold mode, or queued text, and does not release output. Ordinary command parsing can expand dollar expressions on assignment; status_does_expandos can additionally expand dollar expressions in the assembled status line.

Example

Display a self-contained count:

/set status_hold_lines (Held: %B)

An outer %B field then supplies, for example, (Held: 20) when the rounded backlog is 20. Use /set status_hold_lines %B to restore the default format, or /set -status_hold_lines to hide this field without discarding held output.

Source references