Skip to content

usage.md

Latest commit

 

History

History
180 lines (154 loc) · 4.98 KB

usage.md

File metadata and controls

180 lines (154 loc) · 4.98 KB
Raw

Usage

Table of Contents

Keybindings

Key Action
q Quit application (saves configuration)
? Toggle help overlay
t Next color theme
T Previous color theme
l Next layout mode (cycles through built-in and custom layouts)
f Toggle full-screen mode for the current widget
F Cycle full-screen focus through all available widgets
/ Open process search / filter
Enter Confirm search filter
Backspace Delete character in search input
Esc Cancel search / close help overlay

Modules

  1. Header -- Shows system uptime, load average, current theme name, and active layout mode.

  2. CPU -- Horizontal usage bars for each CPU core. If hardware sensors are available, displays the maximum CPU temperature.

  3. Memory -- Gauges for RAM and Swap usage, plus a line chart showing RAM usage over a configurable history window.

  4. Storage -- Disk usage gauges per mount point showing capacity and used space.

  5. Network -- Total downloaded (RX) and uploaded (TX) data per interface, with current transfer rates.

  6. Disk I/O -- Read and write speeds per disk device in bytes per second.

  7. Processes -- Scrolling list of the top 50 processes sorted by CPU usage, with live search filtering by process name.

  8. GPU -- GPU usage gauges (available on supported hardware).

  9. Battery -- Battery charge level gauges (available on supported hardware).

Help Overlay

Press ? at any time to display a full list of available keybindings on screen. Press ? again or Esc to close the overlay.

Command Palette

xtop provides an interactive search overlay for filtering processes in real time:

  • Press / to open the search bar at the top of the process list.
  • Type any query -- results filter instantly by process name.
  • Press Enter to confirm the filter, Esc to cancel, Backspace to delete characters.
  • A centered overlay with a /query_ indicator shows the current search input.

The help overlay (?) serves as a quick-reference command palette for all available keybindings and actions.

Full-Screen Mode

  • Press f to toggle full-screen mode for the currently focused widget. The widget expands to fill the entire terminal area (minus the header bar).
  • Press F to cycle full-screen focus through widgets in sequence: CPU, Memory, Storage, Network, Processes, Disk I/O, GPU, Battery, then exit.

Responsive Layouts

The interface adapts automatically to the terminal size:

Terminal Size Behavior
Wider than 100 cols and taller than 30 rows Full dashboard layout with 2 columns
Wider than 80 cols and taller than 24 rows Compact layout
Narrower than 80 cols Vertically stacked layout
Narrower than 60 cols or shorter than 18 rows Minimal layout: CPU, Memory, and Processes only
Smaller than 40 x 8 Warning message displayed (terminal too small)

Back to README