]> granicus.if.org Git - sysstat/blobdiff - man/mpstat.1
sar/mpstat: Update manual pages
[sysstat] / man / mpstat.1
index 1f1fdb3bf185219cabefe3d044a2985b5d6910f9..d0168bb087ef22422fe516d0149bf70f227bee92 100644 (file)
@@ -1,10 +1,12 @@
-.TH MPSTAT 1 "AUGUST 2011" Linux "Linux User's Manual" -*- nroff -*-
+.TH MPSTAT 1 "NOVEMBER 2016" Linux "Linux User's Manual" -*- nroff -*-
 .SH NAME
 mpstat \- Report processors related statistics.
 .SH SYNOPSIS
-.B mpstat [ -A ] [ -I { SUM | CPU | SCPU | ALL } ] [ -u ] [ -P {
-.I cpu
-.B [,...] | ON | ALL } ] [ -V ] [
+.B mpstat [ -A ] [ -u ] [ -V ] [ -I {
+.I keyword
+.B [,...] | ALL } ] [ -o JSON ] [ -P {
+.I cpu_list
+.B | ON | ALL } ] [
 .I interval
 .B [
 .I count
@@ -45,10 +47,16 @@ command generates reports continuously.
 .SH OPTIONS
 .IP -A
 This option is equivalent to specifying
-.BR "-I ALL -u -P ALL"
-.IP "-I { SUM | CPU | SCPU | ALL }"
+.BR "-u -I ALL -P ALL"
+.IP "-I { keyword [,...] | ALL }"
 Report interrupts statistics.
 
+Possible keywords are
+.BR SUM ,
+.BR CPU
+and
+.BR SCPU .
+
 With the
 .B SUM
 keyword, the
@@ -74,13 +82,15 @@ the CPU or CPUs.
 With the
 .B CPU
 keyword, the number of each individual interrupt received per
-second by the CPU or CPUs is displayed.
+second by the CPU or CPUs is displayed. Interrupts are those listed
+in /proc/interrupts file.
 
 With the
 .B SCPU
 keyword, the number of each individual software interrupt received per
 second by the CPU or CPUs is displayed. This option works only
-with kernels 2.6.31 and later.
+with kernels 2.6.31 and later. Software interrupts are those listed
+in /proc/softirqs file.
 
 The
 .B ALL
@@ -88,10 +98,18 @@ keyword is equivalent to specifying all the keywords above and
 therefore all the interrupts statistics are displayed.
 .RE
 .RE
-.IP "-P { cpu [,...] | ON | ALL }"
-Indicate the processor number for which statistics are to be reported.
-.I cpu
-is the processor number. Note that processor 0 is the first processor.
+.IP "-o JSON"
+Display the statistics in JSON (Javascript Object Notation) format.
+JSON output field order is undefined, and new fields may be added
+in the future.
+.IP "-P { cpu_list | ON | ALL }"
+Indicate the processors for which statistics are to be reported.
+.I cpu_list
+is a list of comma-separated values or range of values (e.g.,
+.BR 0,2,4-7,12- ).
+Note that processor 0 is the first processor, and processor
+.B all
+is the global average among all processors.
 The
 .B ON
 keyword indicates that statistics are to be reported for every
@@ -159,6 +177,12 @@ Show the percentage of time spent by the CPU or CPUs to run a virtual
 processor.
 .RE
 
+.B %gnice
+.RS
+Show the percentage of time spent by the CPU or CPUs to run a niced
+guest.
+.RE
+
 .B %idle
 .RS
 Show the percentage of time that the CPU or CPUs were idle and the system
@@ -176,6 +200,47 @@ The
 .B mpstat
 command takes into account the following environment variable:
 
+.IP S_COLORS
+When this variable is set, display statistics in color on the terminal.
+Possible values for this variable are
+.IR never ,
+.IR always 
+or
+.IR auto
+(the latter is the default).
+
+Please note that the color (being red, yellow, or some other color) used to display a value
+is not indicative of any kind of issue simply because of the color. It only indicates different
+ranges of values.
+
+.IP S_COLORS_SGR
+Specify the colors and other attributes used to display statistics on the terminal.
+Its value is a colon-separated list of capabilities that defaults to
+.BR H=31;1:I=32;22:M=34;1:N=33;1:Z=33;22 .
+Supported capabilities are:
+
+.RS
+.TP
+.B H=
+SGR (Select Graphic Rendition) substring for percentage values greater than or equal to 75%.
+
+.TP
+.B I=
+SGR substring for CPU number.
+
+.TP
+.B M=
+SGR substring for percentage values in the range from 50% to 75%.
+
+.TP
+.B N=
+SGR substring for non-zero statistics values.
+
+.TP
+.B Z=
+SGR substring for zero values.
+.RE
+
 .IP S_TIME_FORMAT
 If this variable exists and its value is
 .BR ISO
@@ -183,6 +248,7 @@ then the current locale will be ignored when printing the date in the report hea
 The
 .B mpstat
 command will use the ISO 8601 format (YYYY-MM-DD) instead.
+The timestamp will also be compliant with ISO 8601 format.
 
 .SH EXAMPLES
 .B mpstat 2 5