summaryrefslogtreecommitdiffstats
path: root/inxi.1
diff options
context:
space:
mode:
authorLibravatarUnit 193 <unit193@ubuntu.com>2018-06-04 23:20:59 -0400
committerLibravatarUnit 193 <unit193@ubuntu.com>2018-06-04 23:20:59 -0400
commitd04e6727be6cbf207739eb675f0cda4012a1274e (patch)
tree7b973830b51f5f9902dc9013013a1c7c123d5fbb /inxi.1
parent8e2439019187be5e6576b6a400d48aed4731354a (diff)
downloadinxi-d04e6727be6cbf207739eb675f0cda4012a1274e.tar.bz2
inxi-d04e6727be6cbf207739eb675f0cda4012a1274e.tar.xz
inxi-d04e6727be6cbf207739eb675f0cda4012a1274e.tar.zst
New upstream version 3.0.11-1upstream/3.0.11-1
Diffstat (limited to 'inxi.1')
-rw-r--r--inxi.1110
1 files changed, 84 insertions, 26 deletions
diff --git a/inxi.1 b/inxi.1
index eef1304..b7d6872 100644
--- a/inxi.1
+++ b/inxi.1
@@ -1,4 +1,4 @@
-.TH INXI 1 "2018\-05\-11" inxi "inxi manual"
+.TH INXI 1 "2018\-06\-04" inxi "inxi manual"
.SH NAME
inxi \- Command line system information script for console and IRC
.SH SYNOPSIS
@@ -8,11 +8,11 @@ inxi \- Command line system information script for console and IRC
\fBinxi\fR [\fB\-c NUMBER\fR] [\fB\-t\fR [\fBc\fR|\fBm\fR|\fBcm\fR|\fBmc\fR]
[\fBNUMBER\fR]] [\fB\-v NUMBER\fR] [\fB\-W LOCATION\fR]
-[\fB\-\-weather\-unit\fR {\fBc\fR|\fBf\fR|\fBcf\fR|\fBfc\fR}] [\fB\-y WIDTH\fR]
+[\fB\-\-weather\-unit\fR {\fBm\fR|\fBi\fR|\fBmi\fR|\fBim\fR}] [\fB\-y WIDTH\fR]
\fBinxi\fR [\fB\-\-recommends\fR] \fR[\fB\-\-slots\fR] \fR[\fB\-\-usb\fR]
-\fBinxi\fB \-x\fR|\fB\-xx\fR|\fB\-xxx\fR \fB\-OPTION(s) \fR
+\fBinxi\fB [\-x\fR|\fB\-xx\fR|\fB\-xxx\fR|\-\-admin] \fB\-OPTION(s) \fR
All options have long form variants \- see below for these and more advanced options.
@@ -62,10 +62,11 @@ Show Audio/sound card(s) information, including card driver.
Show basic output, short form. Same as: \fBinxi \-v 2\fR
.TP
.B \-B\fR,\fB \-\-battery\fR
-Show Battery data, charge, condition, plus extra information (if battery present).
-Uses \fB/sys\fR or, for BSDs without systctl battery data, \fBdmidecode\fR.
-\fBdmidecode\fR does not have very much information, and none about current battery
-state/charge/voltage. Supports multiple batteries when using \fB/sys\fR data.
+Show system battery (\fBID\-x\fR) data, charge, condition, plus extra information
+(if battery present). Uses \fB/sys\fR or, for BSDs without systctl battery data,
+\fBdmidecode\fR. \fBdmidecode\fR does not have very much information, and none
+about current battery state/charge/voltage. Supports multiple batteries when
+using \fB/sys\fR data.
Note that for \fBcharge\fR, the output shows the current charge, as well as its
value as a percentage of the available capacity, which can be less than the original design
@@ -79,6 +80,9 @@ capacity, and then this figure as a percentage of original capacity available in
\fBcondition: 22.2/36.4 Wh (61%)\fR
+With \fB\-x\fR shows attached \fBDevice\-x\fR information (mouse, keyboard, etc.)
+if they are battery powered.
+
.TP
.B \-c\fR,\fB \-\-color\fR \fR[\fB0\fR\-\fB42\fR]
Set color scheme. If no scheme number is supplied, 0 is assumed.
@@ -428,10 +432,10 @@ Use only ASCII letters in city/state/country names, sorry.
Examples: \fB\-W 95623\fR OR \fB\-W Boston,MA\fR OR \fB\-W45.5234,\-122.6762\fR
OR \fB\-W new+york,ny\fR OR \fB\-W bodo,norway\fR.
.TP
-.B \-w\fR,\fB \-\-weather\-unit <unit>\fR
-[\fBc\fR|\fBf\fR|\fBcf\fR|\fBfc\fR] Sets weather units to metric (\fBc\fR), imperial (\fBf\fR),
-metric (imperial) (\fBcf\fR), imperial (metric) (\fBfc\fR). If metric or imperial not found,
-sets to default values, or \fBN/A\fR.
+.B \-\-weather\-unit <unit>\fR
+[\fBm\fR|\fBi\fR|\fBmi\fR|\fBim\fR] Sets weather units to metric (\fBm\fR), imperial (\fBi\fR),
+metric (imperial) (\fBmi\fR, default), imperial (metric) (\fBim\fR). If metric or imperial
+not found,sets to default value, or \fBN/A\fR.
.TP
.B \-y\fR,\fB \-\-width <integer>\fR
This is an absolute width override which sets the output line width max.
@@ -477,8 +481,15 @@ device.
.B \-x \-B\fR
\- Adds vendor/model, battery status (if battery present).
.TP
+.B \-x \-B\fR
+\- Adds attached battery powered peripherals (\fBDevice\-[number]:\fR) if
+detected (keyboard, mouse, etc.).
+.TP
.B \-x \-C\fR
-\- Adds bogomips on CPU (if available); CPU Flags (short list).
+\- Adds bogomips on CPU (if available)
+.TP
+.B \-x \-C\fR
+\- Adds CPU Flags (short list).
.TP
.B \-x \-C\fR
\- Adds CPU microarchitecture + revision (e.g. Sandy Bridge, K8, ARMv8, P6,
@@ -496,7 +507,6 @@ dds rev version to optical drive.
or if you have added to \fB/etc/sudoers\fR (sudo v. 1.7 or newer):
.B <username> ALL = NOPASSWD: /usr/sbin/hddtemp (sample)
-
.TP
.B \-x \-G\fR
\- Adds direct rendering status.
@@ -596,6 +606,24 @@ data (if available) as the voltage now / minimum design voltage.
.B \-xx \-D\fR
\- Adds disk serial number.
.TP
+.B \-xx \-D\fR
+\- Adds disk speed (if available). This is the theoretical top speed of the
+device as reported. This speed may be restricted by system board limits, eg.
+a SATA 3 drive on a SATA 2 board may report SATA 2 speeds, but this is not
+completely consistent, sometimes a SATA 3 device on a SATA 2 board reports
+its design speed.
+
+NVMe drives: adds lanes, and (per direction) speed is calculated with
+lane speed * lanes * PCIe overhead. PCIe 1 and 2 have data rates of
+GT/s * .8 = Gb/s (10 bits required to transfer 8 bits of data).
+PCIe 3 and greater transfer data at a rate of GT/s * 128/130 * lanes = Gb/s
+(130 bits required to transfer 128 bits of data).
+
+For a PCIe 3 NVMe drive, with speed of \fB8 GT/s\fR and \fB4\fR lanes
+(\fB8GT/s * 128/130 * 4 = 31.6 Gb/s\fR):
+
+\fBspeed: 31.6 Gb/s lanes: 4\fR
+.TP
.B \-xx \-G\fR
\- Adds vendor:product ID of each Graphics card.
.TP
@@ -671,11 +699,21 @@ always shows \fB0\fR. There's nothing that can be done about this glitch, the
data is simply not available as of 2018\-04\-03), location (only available from
\fBdmidecode\fR derived output).
.TP
+.B \-xxx \-B\fR
+\- Adds attached device \fBrechargeable: [yes|no]\fR information.
+.TP
.B \-xxx \-D\fR
\- Adds disk firmware revision number (if available).
.TP
.B \-xxx \-D\fR
-\- Adds disk partition scheme (in some but not all cases), e.g. \fBscheme: GPT\fR
+\- Adds disk partition scheme (in most cases), e.g. \fBscheme: GPT\fR. Currently not
+able to detect all schemes, but handles the most common, e.g. \fBGPT\fR or \fBMBR\fR.
+.TP
+.B \-xxx \-D\fR
+\- Adds disk rotation speed (in some but not all cases), e.g. \fBrotation: 7200 rpm\fR.
+Only appears if detected (SSD drives do not have rotation speeds, for example). If none
+found, nothing shows. Not all disks report this speed, so even if they are spinnning,
+no data will show.
.TP
.B \-xxx \-I\fR
\- For \fBShell:\fR adds \fB(su|sudo|login)\fR to shell name if present.
@@ -719,6 +757,22 @@ If none found, shows nothing.
.B \-xxx \-w\fR,\fB \-W\fR
\- Adds location (city state country), altitude, weather observation time.
+.SH ADMIN EXTRA DATA OPTIONS
+These options are triggered with \fB\-\-admin\fR. Admin options are advanced output options,
+and are more technical, and mostly of interest to system administrators or other machine admins.
+The \fB\-\-admin\fR option only has to be used once, and will trigger the following features.
+
+.TP
+.B \-\-admin \-C\fR
+\- Adds CPU family, model\-id, and stepping (replaces \fBrev\fR of \fB\-Cx\fR).
+Format is \fBhexadecimal (decimal)\fR if greater than 9, otherwise \fBhexadecimal\fR.
+.TP
+.B \-\-admin \-C\fR
+\- Adds CPU microcode. Format is \fBhexadecimal\fR.
+.TP
+.B \-\-admin \-C\fR
+\- Adds CPU Errata (bugs) as known by your current kernel.
+
.SH ADVANCED OPTIONS
.TP
@@ -854,16 +908,12 @@ Overrides default internal value and user configuration value:
\- Full file/system info logging.
.TP
-.B \-\-debug [20\-22]\fR
-Debugger output generator.
-
-.TP
.B \-\-debug 20\fR
Creates a tar.gz file of system data and collects the inxi output
in a file.
-* tree traversal data file read from \fB/sys\fR, and other system
-data.
+* tree traversal data file(s) read from \fB/proc\fR and \fB/sys\fR, and
+other system data.
* xorg conf and log data, xrandr, xprop, xdpyinfo, glxinfo etc.
@@ -960,7 +1010,8 @@ See the documentation page for more complete information on how to set
these up, and for a complete list of options:
.I https://smxi.org/docs/inxi\-configuration.htm
-
+.TP
+.B Basic Options
Here's a brief overview of the basic options you are likely to want to use:
\fBCOLS_MAX_CONSOLE\fR The max display column width on terminal.
@@ -996,6 +1047,8 @@ above configuration page on smxi.org for full info.
\fBWEATHER_UNIT\fR Values: [\fBc\fR|\fBf\fR|\fBcf\fR|\fBfc\fR]. Same as \fB\-\-weather\-unit\fR.
+.TP
+.B Color Options
It's best to use the \fB\-c [94\-99]\fR color selector tool to set the following values
because it will correctly update the configuration file and remove any invalid
or conflicting items, but if you prefer to create your own configuration files,
@@ -1017,19 +1070,24 @@ here are the options. All take the integer value from the options available in
.SH BUGS
Please report bugs using the following resources.
-You may be asked to run the inxi debugger tool which will upload a data dump of
-system files for use in debugging inxi. These data dumps are very important since
-they provide us with all the real system data inxi uses to parse out its report.
+You may be asked to run the inxi debugger tool (see \fB\-\-debug 21/22\fR), which will
+upload a data dump of system files for use in debugging inxi. These data dumps are
+very important since they provide us with all the real system data inxi uses to parse
+out its report.
.TP
-inxi main website/source/wiki, file an issue report:
+.B Issue Report
+File an issue report:
.I https://github.com/smxi/inxi/issues
.TP
-post on inxi developer forums:
+.B Developer Forums
+Post on inxi developer forums:
.I https://techpatterns.com/forums/forum\-32.html
.TP
+.B IRC irc.oftc.net#smxi
You can also visit
.I irc.oftc.net
\fRchannel:\fI #smxi\fR to post issues.
+
.SH HOMEPAGE
.I https://github.com/smxi/inxi
.I https://smxi.org/