pumo-system-info/pumo-system-info.1

51 lines
1.5 KiB
Groff

.TH PUMO-SYSTEM-INFO 1 pumo-system-info
.SH NAME
pumo-system-info \- Gather and output system information
.SH SYNOPSIS
.B pumo-system-info
.RB [-h, --help]
.RB [-V, --version]
.RB [-j, --json]
.RB [-s, --seconds]
.RB [-c, --critical-level <CRITICAL_LEVEL>]
.RB [-w, --warning-level <WARNING_LEVEL>]
.RB [-W, --width <WIDTH>]
.SH DESCRIPTOR
pumo-system-info is a simple system information gatherer which can
output its result either as a beautiful banner for ANSI-compatible
shells (including Powershell), or as JSON data so it can be used in
any other way by external programs and libraries. It displays the OS,
kernel version, hostname, and uptime of a system as well as its RAM,
Swap, and partitions usage displayed as colored ramps, the color
depending on how much of it is used.
By default, the usage ramp is colored in green, but it is turned
orange once it reaches the warning level (by default 75%), and red
when it reaches the critical level (default: 90%).
.SH FLAGS
.TP
.B \-h \-\-help
Prints help information.
.TP
.B \-V \-\-version
Prints version information.
.TP
.B \-j \-\-json
Output JSON.
.TP
.B \-s \-\-seconds
Display seconds in uptime.
.TP
.B \-w \-\-warning\-level <WARNING_LEVEL> (default: 75)
Set warning level of memory usage.
.TP
.B \-c \-\-critical\-level <CRITICAL_LEVEL> (default: 90)
Set critical level of memory usage.
.TP
.B \-W \-\-width <WIDTH>
Width of the banner.
.SH BUGS
Although I try to hunt for bugs, but if you ever find one, please do not
hesitate reporting it at lucien@phundrak.com or on
https://labs.phundrak.com/phundrak/pumo-system-info