aboutsummaryrefslogtreecommitdiffstats
path: root/inxi.1
diff options
context:
space:
mode:
authorLibravatarUnit 193 <unit193@ubuntu.com>2016-11-08 15:35:56 -0500
committerLibravatarUnit 193 <unit193@ubuntu.com>2016-11-08 15:35:56 -0500
commit6a486a5f6226f4c819b94de468f9694a9759da3b (patch)
treee3e7a2bc102540cd4b281b4ad7ef39491567c4ca /inxi.1
parentce221d3b19cb6cba1d4db90490939ebeabb2c408 (diff)
downloadinxi-upstream/2.3.4.tar.bz2
inxi-upstream/2.3.4.tar.xz
inxi-upstream/2.3.4.tar.zst
Imported Upstream version 2.3.4upstream/2.3.4
Diffstat (limited to 'inxi.1')
-rwxr-xr-xinxi.177
1 files changed, 51 insertions, 26 deletions
diff --git a/inxi.1 b/inxi.1
index dfc694b..9b97a30 100755
--- a/inxi.1
+++ b/inxi.1
@@ -1,19 +1,20 @@
-.TH INXI 1 "2016\-08\-25" inxi "inxi manual"
+.TH INXI 1 "2016\-11\-03" inxi "inxi manual"
.SH NAME
inxi \- Command line system information script for console and IRC
.SH SYNOPSIS
-.B inxi \fR \- Single line, short form. Very basic output.
+\fBinxi\fR \- Single line, short form. Very basic output.
-.B inxi \fR[\fB\-AbBCdDfFGhHiIlmMnNopPrRsSuw\fR] \fR[\fB\-c NUMBER\fR] \fR[\fB\-v NUMBER\fR]
+\fBinxi \fR[\fB\-AbBCdDfFGhHiIlmMnNopPrRsSuw\fR] \fR[\fB\-c NUMBER\fR] \fR[\fB\-v NUMBER\fR]
-.B inxi \fR[\fB\-t \fR(\fBc\fR or\fB m\fR or\fB cm\fR or\fB mc NUMBER\fR)] \fR[\fB\-x \-OPTION\fR(\fBs\fR)] \fR[\fB\-xx \-OPTION\fR(\fBs\fR)] \fR[\fB\-xxx \-OPTION\fR(\fBs\fR)]
+\fBinxi \fR[\fB\-t \fR(\fBc\fR or\fB m\fR or\fB cm\fR or\fB mc NUMBER\fR)] \fR[\fB\-x \-OPTION\fR(\fBs\fR)] \fR[\fB\-xx \-OPTION\fR(\fBs\fR)] \fR[\fB\-xxx \-OPTION\fR(\fBs\fR)]
-.B inxi \fR[\fB\-\-help\fR] \fR[\fB\-\-recommends\fR] \fR[\fB\-\-version\fR] \fR[\fB\-@ NUMBER\fR]
+\fBinxi \fR[\fB\-\-help\fR] \fR[\fB\-\-recommends\fR] \fR[\fB\-\-version\fR] \fR[\fB\-@ NUMBER\fR]
.SH DESCRIPTION
-.B inxi\fR is a command line system information script built for for console and IRC. It is also used for forum technical support, as a debugging tool, to quickly ascertain user system configuration and hardware. inxi shows system
+\fBinxi\fR is a command line system information script built for for console and IRC. It is also used for forum technical support, as a debugging tool, to quickly ascertain user system configuration and hardware. inxi shows system
hardware, CPU, drivers, Xorg, Desktop, Kernel, GCC version(s), Processes, RAM usage, and a wide variety of other
useful information.
-.B inxi\fR output varies between CLI and IRC, with some default filters and color options applied to IRC use. Script colors can
+
+\fBinxi\fR output varies between CLI and IRC, with some default filters and color options applied to IRC use. Script colors can
be turned off if desired with \fB\-c 0\fR, or changed using the \fB\-c\fR color options listed in the OPTIONS section below.
.SH PRIVACY AND SECURITY
In order to maintain basic privacy and security, inxi filters out automatically on IRC things like
@@ -30,8 +31,9 @@ together or separate them.
Letters with numbers can have no gap or a gap at your discretion unless using \fB \-t\fR.
For example:
+.B inxi
+\fB\-AG\fR or \fBinxi \-A \-G\fR or \fBinxi \-c10\fR
-.B inxi \-AG\fR or \fBinxi \-A \-G\fR or \fBinxi \-c10\fR
.SH STANDARD OPTIONS
.TP
.B \-A
@@ -59,12 +61,15 @@ example, the battery capacity is only 61% of it's original amount.
For example: \fB22.2/36.4 Wh 61%\fR
.TP
-.B \-c \fR[\fB0\fR\-\fB32\fR]
+.B \-c
+\fR[\fB0\fR\-\fB32\fR]
Available color schemes. Scheme number is required.
Supported color schemes: \fB0\-42\fR
.TP
-.B \-c \fR[\fB94\fR\-\fB99\fR]
+.B \-c
+\fR[\fB94\fR\-\fB99\fR]
+
Color selectors run a color selector option prior to inxi starting which lets
you set the config file value for the selection.
@@ -152,14 +157,25 @@ Memory (RAM) data. Does not show with \fB\-b\fR or \fB\-F\fR unless you use \
Note that \fB\-m\fR uses \fBdmidecode\fR, which must be run as root (or start \fBinxi\fR with \fBsudo\fR), unless you figure out how to set up sudo to permit dmidecode to read \fB/dev/mem\fR as user. Note that speed will not show if \fBNo Module Installed\fR is found in size. This will also turn off Bus Width data output if it is null.
-Because dmidecode data is extremely unreliable, inxi will try to make best guesses. If you see \fB(check)\fR after capacity number, you should check it for sure with specifications. \fB(est)\fR is slightly more reliable, but you should still check the real specifications before buying ram. Unfortunately there is nothing \fBinxi can do to get truly reliable data about the system ram, maybe one day the kernel devs will put this data into \fB/sys\fR, and make it real data, taken from the actual system, not dmi data. For most people, the data will be right, but a significant percentage of users will have either wron max module size, if present, or max capacity.
+If memory information was found, and if the \fB\-I\fR line or the \fB\-tm\fR item have not been triggered,
+will also print the ram used/total.
+
+Because dmidecode data is extremely unreliable, inxi will try to make best guesses. If you see \fB(check)\fR after capacity number, you should check it for sure with specifications. \fB(est)\fR is slightly more reliable, but you should still check the real specifications before buying ram. Unfortunately there is nothing \fBinxi\fR can do to get truly reliable data about the system ram, maybe one day the kernel devs will put this data into \fB/sys\fR, and make it real data, taken from the actual system, not dmi data. For most people, the data will be right, but a significant percentage of users will have either wron max module size, if present, or max capacity.
.TP
.B \-M
-Show machine data. Motherboard, Bios, and if present, System Builder (Like Lenovo).
+Show machine data. Device, Motherboard, Bios, and if present, System Builder (Like Lenovo).
Older systems/kernels without the required \fB/sys\fR data can use dmidecode instead, run as root. If using dmidecode,
may also show bios revision as well as version. \fB\-! 33\fR can force use of \fBdmidecode\fR data instead of \fB/sys\fR.
Will also attempt to show if the system was booted by BIOS, UEFI, or UEFI [Legacy]. The last one is legacy BIOS boot mode
in a systemboard using UEFI but booted as BIOS/Legacy.
+
+Device requires either /sys or dmidecode. Note that 'other-vm?' is a type that means it's usually a vm, but inxi
+failed to detect which type, or to positively confirm which vm it is. Primary vm identification is via systemd-detect-virt
+but fallback tests that should support some BSDs as well are used. Less commonly used or harder to detect VMs may not
+be correctly detected, if you get a wrong output, post an issue and we'll get it fixed if possible.
+
+Due to unreliable vendor data, device will show: desktop; laptop; notebook; server; blade plus some obscure stuff that
+inxi is unlikely to ever run on.
.TP
.B \-n
Show Advanced Network card information. Same as \fB\-Nn\fR. Shows interface, speed,
@@ -222,7 +238,8 @@ fan speeds. Gpu temp only for Fglrx/Nvidia drivers. Nvidia shows screen number f
Show System information: host name, kernel, desktop environment (if in X), distro. With \fB\-xx\fR show
dm \- or startx \- (only shows if present and running if out of X), and if in X, with \fB\-xxx\fR show more desktop info, like shell/panel etc.
.TP
-.B \-t \fR[\fBc\fR or\fB m\fR or\fB cm\fR or\fB mc NUMBER\fR]\fR
+.B \-t
+\fR[\fBc\fR or\fB m\fR or\fB cm\fR or\fB mc NUMBER\fR]\fR
Show processes. If followed by numbers \fB1\-20\fR, shows that number of processes for each type
(default: \fB5\fR; if in irc, max: \fB5\fR)
@@ -247,7 +264,7 @@ Note \- Maintainer may have disabled this function.
If inxi \fB\-h\fR has no listing for \fB\-U\fR then its disabled.
Auto\-update script. Note: if you installed as root, you must be root to update,
-otherwise user is fine. Also installs / updates this Man Page to: \fB/usr/share/man/man8\fR
+otherwise user is fine. Also installs / updates this Man Page to: \fB/usr/share/man/man1\fR
This requires that you be root to write to that directory.
.TP
.B \-V
@@ -457,7 +474,7 @@ Supports most known display managers, like xdm, gdm, kdm, slim, lightdm, or mdm.
.B \-xxx \-B
\- Adds battery chemistry (like: \fBLi-ion\fR), cycles (NOTE: there appears to be a problem with the Linux kernel
obtaining the cycle count, so this almost always shows \fB0\fR. There's nothing that can be done about this glitch, the
-data is simply not availabe as of 2016-04-18), location (only available from dmidecode derived output).
+data is simply not available as of 2016-04-18), location (only available from dmidecode derived output).
.TP
.B \-xxx \-m
\- Memory bus width: primary bus width, and if present, total width. eg: bus width: 64 bit (total: 72 bits). Note that total / data widths are mixed up sometimes in dmidecode output, so inxi will take the larger value as total if present. If no total width data is found, then inxi will not show that item.
@@ -495,8 +512,8 @@ Overrides defective or corrupted data.
Triggers debugger output. Requires debugging level \fB1\-14\fR (\fB8\-10\fR \- logging of data).
Less than 8 just triggers inxi debugger output on screen.
.TP
-.B \-@ \fR[\fB1\fR\-\fB7\fR]
-\- On screen debugger output.
+.B \-@
+\fR[\fB1\fR\-\fB7\fR] \- On screen debugger output.
.TP
.B \-@ 8
\- Basic logging. Check \fB/home/yourname/.inxi/inxi*.log
@@ -515,7 +532,8 @@ To automatically upload debugger data tar.gz file to \fIftp.techpatterns.com\fR:
For alternate ftp upload locations: Example:
-.B inxi \-! \fIftp.yourserver.com/incoming\fB \-xx@ 14\fR
+.B inxi \-!
+\fIftp.yourserver.com/incoming\fB \-xx@ 14\fR
.TP
.B \-@ 11
\- With data file of xiin read of \fB/sys
@@ -534,12 +552,16 @@ are capable of displaying either built in or external script output.
.SH RUNNING IN IRC CLIENT
To trigger inxi output in your IRC client, pick the appropriate method from the list below:
.TP
-.B Xchat, irssi \fR(and many other IRC clients)
-.B /exec \-o inxi \fR[\fBoptions\fR]
+.B Xchat, irssi
+\fR(and many other IRC clients)
+.B /exec \-o inxi
+\fR[\fBoptions\fR]
If you leave off the \fB\-o\fR, only you will see the output on your local IRC client.
.TP
.B Konversation
-.B /cmd inxi \fR[\fBoptions\fR]
+.B /cmd inxi
+\fR[\fBoptions\fR]
+
To run inxi in konversation as a native script if your distribution or inxi package did not do this for you,
create this symbolic link:
@@ -549,12 +571,15 @@ If inxi is somewhere else, change the path \fB/usr/local/bin\fR to wherever it i
Then you can start inxi directly, like this:
-.B /inxi \fR[\fBoptions\fR]
+.B /inxi
+\fR[\fBoptions\fR]
.TP
.B WeeChat
-.B NEW: /exec \-o inxi \fR[\fBoptions\fR]
+.B NEW: /exec \-o inxi
+\fR[\fBoptions\fR]
-.B OLD: /shell \-o inxi \fR[\fBoptions\fR]
+.B OLD: /shell \-o inxi
+\fR[\fBoptions\fR]
Newer (2014 and later) WeeChats work pretty much the same now as other console IRC
clients, with \fB/exec \-o inxi \fR[\fBoptions\fR]. Also, newer WeeChats have dropped
@@ -610,8 +635,8 @@ post on inxi developer forums:
.I http://techpatterns.com/forums/forum\-32.html
.TP
You can also visit
-.I irc.oftc.net \fRchannel:\fI #smxi
-to post issues.
+.I irc.oftc.net
+\fRchannel:\fI #smxi\fR to post issues.
.SH HOMEPAGE
.I https://github.com/smxi/inxi
.I http://smxi.org/