Home / Alt manpages / byobu-status-detail(1)

  • byobu-status-detail(1)
  • User command
  • linux

Read Byobu's Detailed Status Without Losing Your Place

You will finish with a repeatable way to inspect the detailed output from Byobu's status scripts, use the installed pager deliberately, and separate display problems from status-script failures. The examples were checked on Ubuntu's byobu package version 6.11-0ubuntu1.1, where byobu-status-detail is installed as /usr/bin/byobu-status-detail.

Allow about ten minutes. You need a shell and a Byobu installation. This command reads status information and opens it for viewing. It does not enable Byobu, start a session, change a status script or edit your configuration. No elevated privileges are normally needed.

1. Confirm the installed command

Start by checking the executable and package version. These are ordinary, read-only commands:

$ command -v byobu-status-detail
/usr/bin/byobu-status-detail
$ dpkg-query -W -f='${Package} ${Version}\n' byobu
byobu 6.11-0ubuntu1.1

Your path or package revision may differ. The command is a wrapper, not a separate status collector. The manual describes it as a simple script that displays the detailed status from all Byobu status scripts through a sensible pager.

Checkpoint: if command -v finds nothing, stop here. Install or repair Byobu through your normal package-management process. Do not copy a script into /usr/bin as a quick fix.

2. Run the normal detailed view

Run the command without arguments:

$ byobu-status-detail

Byobu gathers the detailed output and presents it in a pager. The first line normally identifies the package and version, followed by navigation hints when the Vim folding path is selected. The remaining sections show each installed status script, its short status value and any detail text that script provides. The exact values depend on your machine, network, storage and enabled status scripts, so do not compare the text with a fixed transcript.

Use the pager's normal quit key when the view is open. If Vim is used, q exits the read-only view. If another pager is used, follow that pager's own help. The command itself does not offer a Byobu-specific interactive menu.

3. Understand which viewer you received

The installed wrapper checks for Vim with folding support. When it finds a suitable Vim, it pipes byobu-status --detail into Vim read-only mode and sets a small folding layout. The visible hints are:

Expand all - zr        Collapse all - zm
Expand one - zo       Collapse one - zc

Those keys control Vim folds, not Byobu status collection. A status section can therefore be collapsed without disabling or changing that status script. If Vim is missing or does not advertise folding support, the wrapper sends the same detailed output to $BYOBU_PAGER instead.

Do not assume that a screen full of escape characters means the status command failed. Vim may emit terminal control sequences when its output is redirected or when there is no real interactive terminal. Run it from a terminal window first. For a deliberately plain diagnostic, inspect the producer directly:

$ byobu-status --detail | sed -n '1,40p'

This bypasses the wrapper's viewer. It is useful for confirming that Byobu produced data before investigating pager behaviour.

4. Use the configured pager intentionally

Byobu's common shell code normally chooses sensible-pager when it is available, otherwise less. The wrapper honours the resulting BYOBU_PAGER only on the non-Vim path. You can inspect the effective variable without changing anything:

$ sh -c '. /usr/lib/byobu/include/common; printf "%s\n" "$BYOBU_PAGER"'
sensible-pager

The exact result can be less or another configured pager. If you need plain output for a short troubleshooting capture, set the variable for one invocation, but remember that a working Vim installation may still take precedence:

$ BYOBU_PAGER=cat byobu-status-detail

That command may still open Vim on this package because the wrapper checks Vim first. To capture the producer without any viewer, use the direct byobu-status --detail pipeline from the previous step. Avoid replacing BYOBU_PAGER globally until you know which programs share the setting.

5. Check configuration only when the output looks wrong

Before Byobu selects its defaults, the wrapper reads ~/.byoburc when that file is readable. It also honours BYOBU_PREFIX; if it is unset, the installed script uses /usr. A user configuration can therefore change the prefix or other Byobu variables before the status command runs.

Inspect the file as your own user:

$ if [ -r "$HOME/.byoburc" ]; then
    sed -n '1,160p' "$HOME/.byoburc"
  else
    printf '%s\n' 'No readable ~/.byoburc'
  fi

Do not source an unfamiliar configuration file merely to inspect it. A shell configuration is executable code, so read it first and treat changes as security-sensitive. If you own a broken setting and need to undo it, remove only the line you added or restore the previous value from your backup. There is no reason to use sudo for a personal ~/.byoburc.

6. Distinguish an empty result from a broken viewer

If the direct producer prints no useful sections, check whether status collection has been disabled in your Byobu configuration and whether the status scripts are present:

$ test -f "$HOME/.byobu/status.disable" && echo 'status disabled'
$ find /usr/lib/byobu -maxdepth 1 -type f -printf '%f\n' | sort | sed -n '1,80p'

The first check is silent when the marker is absent. The second lists installed files; it does not run them. Do not delete status.disable as a blind repair. That changes Byobu behaviour. If you deliberately created the marker and want status output back, remove that file as your own user, then rerun the command. If another administrator or package created it, identify the owner first.

If the direct command has sensible output but the wrapper does not display it, focus on Vim, the pager, terminal allocation and BYOBU_PAGER. If both commands fail, capture the error and check the installed Byobu files before changing permissions or running as root. Elevated privileges cannot repair a missing terminal capability.

7. Keep the command in its proper boundary

byobu-status-detail is a viewing helper. It does not refresh a running Byobu session, change the selected backend, enable status scripts or edit status configuration. It is safe to use while investigating a session because the command only asks Byobu to calculate and print its detailed status.

For automation, call byobu-status --detail directly and decide how much output to retain. A pager is useful for a person at a terminal, but it is a poor dependency for a service check or log collector. Keep those paths separate so a scheduled job cannot wait for interactive input.

Done means

  • You confirmed the installed command and package version.
  • You can run the detailed view and identify whether Vim or another pager is displaying it.
  • You know that Vim folding keys hide sections without changing status scripts.
  • You can bypass the wrapper with byobu-status --detail when diagnosing output.
  • You checked BYOBU_PAGER and ~/.byoburc before changing configuration.
  • You have not used elevated privileges or altered Byobu state without an explicit reason and recovery path.