summaryrefslogtreecommitdiffstats
path: root/inxi.1
diff options
context:
space:
mode:
Diffstat (limited to 'inxi.1')
-rw-r--r--inxi.183
1 files changed, 59 insertions, 24 deletions
diff --git a/inxi.1 b/inxi.1
index 3e76365..a411d1e 100644
--- a/inxi.1
+++ b/inxi.1
@@ -1,5 +1,5 @@
.\" inxi.1 - manpage for inxi system information tool
-.\" Copyright (C) 2022 Harald Hope
+.\" Copyright (C) 2023 Harald Hope
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
@@ -15,7 +15,7 @@
.\" with this program; if not, write to the Free Software Foundation, Inc.,
.\" 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
.\"
-.TH INXI 1 "2022\-11\-02" "inxi" "inxi manual"
+.TH INXI 1 "2023\-02\-07" "inxi" "inxi manual"
.SH NAME
inxi \- Command line system information script for console and IRC
@@ -178,6 +178,10 @@ See \fB\-E\fR.
See \fBOUTPUT CONTROL OPTIONS\fR.
.TP
+.B \-\-config\fR, \fB\-\-configuration\fR
+Show active configuration values, by file, and exit.
+
+.TP
.B \-C \fR, \fB\-\-cpu\fR
Show full CPU output (if each item available): basic CPU topology, model, type,
L2 cache, average speed of all cores (if > 1 core, otherwise speed of the core),
@@ -324,7 +328,7 @@ and active \fBgpu:\fR drivers), display protocol (if available), display server
\fBDisplay: x11 server: Xorg v: 1.15.1\fR
-or
+or:
\fBDisplay: wayland server: X.org v: 1.20.1 with: Xwayland v: 20.1\fR
@@ -332,6 +336,9 @@ If protocol is not detected, shows:
\fBDisplay: server: Xorg 1.15.1\fR
+Adds \fBwith: Xwayland v:...\fR if xwayland server is installed, regardless of
+protocol.
+
Also shows screen resolution(s) (per monitor/X screen). Shows graphics API used,
like OpenGL. For X.org: OpenGL renderer, OpenGL core profile version/OpenGL
version; for VESA: data (for Xvesa); for Wayland: GBM/EGL data (not
@@ -347,7 +354,7 @@ advanced monitor data (full modes, chroma, etc.).
.B \-h \fR, \fB\-\-help\fR
The help menu. Features dynamic sizing to fit into terminal window. Set script
global \fBCOLS_MAX_CONSOLE\fR if you want a different default value, or use
-\fB\-y <width>\fR to temporarily override the defaults or actual window width.
+\fB\-y [width]\fR to temporarily override the defaults or actual window width.
.TP
.B \-i \fR, \fB\-\-ip\fR
@@ -850,7 +857,7 @@ weather when you need to see it, for example, on a remote server. If you did not
type the weather option in manually, it's an automated request.
.TP
-.B \-W\fR, \fB\-\-weather\-location <location_string>\fR
+.B \-W\fR, \fB\-\-weather\-location [location_string]\fR
Get weather/time for an alternate location. Accepts postal/zip code[, country],
city,state pair, or latitude,longitude. Note: city/country/state names must
not contain spaces. Replace spaces with '\fB+\fR' sign. Don't place spaces
@@ -875,7 +882,7 @@ weather when you need to see it, for example, on a remote server. If you did not
type the weather option in manually, it's an automated request.
.TP
-.B \-\-weather\-source\fR, \fB\-\-ws <unit>\fR
+.B \-\-weather\-source\fR, \fB\-\-ws [unit]\fR
[\fB1\-9\fR] Switches weather data source. Possible values are \fB1\-9\fR.
\fB1\-4\fR will generally be active, and \fB5\-9\fR may or may not be active,
so check. \fB1\fR may not support city / country names with spaces (even if
@@ -889,7 +896,7 @@ on occasions, so try each one and see which you prefer. If you get unsupported
source message, it means that number has not been implemented.
.TP
-.B \-\-weather\-unit <unit>\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.
@@ -973,7 +980,7 @@ These color selectors run a color selector option prior to inxi starting
which lets you set the config file value for the selection.
NOTE: All configuration file set color values are removed when output is
-piped or redirected. You must use the explicit runtime \fB\-c <color number>\fR
+piped or redirected. You must use the explicit runtime \fB\-c [color number]\fR
option if you want color codes to be present in the piped/redirected output.
Color selectors for each type display (NOTE: IRC and global only show safe
@@ -1007,6 +1014,11 @@ Konversation etc.
Setting a specific color type removes the global color selection.
.TP
+.B \-\-export [json|screen|xml]\fR
+.br
+See \fB\-\-output\fR.
+
+.TP
.B \-\-indent [11\-xx]\fR
Change primary wide indent width. Generally useless. Only applied if output
width is greater than max wrap width (see \fB\-\-max\-wrap\fR). Use
@@ -1036,11 +1048,18 @@ of line starter occurs. If \fB80\fR or less, no wrapping will occur. Overrides
internal default value (110) and user configuration value \fBMAX_WRAP\fR.
.TP
-.B \-\-output [json|screen|xml]\fR
+.B \-\-output\fR, \fB \-\-export [json|screen|xml]\fR
Change data output type. Requires \-\-output\-file if not \fBscreen\fR.
+See this page \fIhttps://smxi.org/docs/inxi-json-xml-output.htm\fR BEFORE you
+post an issue about not understanding, or being unable to use, the output
+format! That gives a fairly complete explanation of what the output means, and
+how to work with it. It is not a tutorial, and it will not teach you to program,
+if you don't know how to work with json/xml structures using a proper language,
+then this feature is not meant for you.
+
.TP
-.B \-\-output\-file [full path to output file|print]\fR
+.B \-\-output\-file, \fB \-\-export\-file [full path to output file|print]\fR
The given directory path must exist. The directory path given must exist,
The \fBprint\fR options prints to stdout.
Required for non\-screen \fB\-\-output\fR formats (json|xml).
@@ -1070,6 +1089,11 @@ sort will be random.
\fBused\fR \- KiB used of partition.
.TP
+.B \-\-separator\fR, \fB\-\-sep [character(s)]\fR
+Change the default output key: value separator \fB:\fR to something else. Make
+permanent with configuration item \fBSEP2_CONSOLE\fR.
+
+.TP
.B \-\-wrap\-max [integer]\fR
.br
See \fB\-\-max-wrap\fR.
@@ -2100,7 +2124,7 @@ Graphics:
size: 376x301mm (14.8x11.85") diag: 482mm (19") ratio: 5:4 modes:
max: 1280x1024 min: 720x400
API: OpenGL renderer: AMD CEDAR (DRM 2.50.0 / 5.16.0-11.1\-liquorix-amd64 LLVM
- 12.0.1) v: 3.3 Mesa 21.2.6 compat\-v: 3.1 direct render: Yes
+ 12.0.1) v: 3.3 Mesa 21.2.6 compat\-v: 3.1 direct-render: Yes
....\fR
.fi
Wayland sample, with Sway/swaymsg:
@@ -2595,6 +2619,13 @@ removes the debug data directory and the tar.gz file.
See \fB\-\-ftp\fR for uploading to alternate locations.
.TP
+.B \-\-debug\-id [string]\fR
+Insert string to file name for debugger. This is helpful so you can add for
+instance a username to a debugger dataset to make it easy to find.
+
+Sample: \fB\-\-debug 22 \-\-debug\-id mrmazda\fR
+
+.TP
.B \-\-fake\-data\-dir\fR
Developer only: Change default location of $fake_data_dir, which is where files
are for \fB\-\-fake {item}\fR items.
@@ -2703,23 +2734,23 @@ inxi will read its configuration/initialization files in the
following order:
\fB/etc/inxi.conf\fR contains the default configurations. These can be
-overridden by creating a \fB/etc/inxi.d/inxi.conf\fR file (global override,
+overridden by creating a \fB/etc/inxi.d/inxi.conf\fR file (global override),
which will prevent distro packages from changing or overwriting your edits. This
method is recommended if you are using a distro packaged inxi and want to
-override some configuration items from the package's default
+override some global configuration items from the package's default
\fB/etc/inxi.conf\fR file but don't want to lose your changes on a package
update.
-You can old override, per user, with a user configuration file found in one of
+You can also override, per user, with a user configuration file found in one of
the following locations (inxi will store its config file using the following
-precedence:
+precedence):
if \fB$XDG_CONFIG_HOME\fR is not empty, it will go there, else if
-\fB$HOME/.conf/inxi.conf\fR exists, it will go there, and as a last default,
+\fB$HOME/.config/inxi.conf\fR exists, it will go there, and as a last default,
the legacy location is used), i.e.:
-\fB$XDG_CONFIG_HOME/inxi.conf\fR > \fB$HOME/.conf/inxi.conf\fR >
-\fB$HOME/.inxi/inxi.conf\fR
+\fB$XDG_CONFIG_HOME/inxi.conf\fR > \fB$HOME/.config/inxi.conf\fR >
+\fB$HOME/.inxi/inxi.conf\fR > \fB/etc/inxi.d/inxi.conf\fR > \fB/etc/inxi.conf\fR
.SH CONFIGURATION OPTIONS
@@ -2800,7 +2831,8 @@ Override with \fB\-\-sensors\-default\fR. See \fB\-\-sensors\-exclude\fR.
\fBSENSORS_USE\fR Use only supplied sensor array[s]. Override with
\fB\-\-sensors\-default\fR. See \fB\-\-sensors\-use\fR.
-\fBSEP2_CONSOLE\fR Replaces default key / value separator of '\fB:\fR'.
+\fBSEP2_CONSOLE\fR Replaces default key / value separator of '\fB:\fR'. Test
+with \fB\-\-separator\fR.
\fBUSB_SYS\fR Forces all USB data to use \fB/sys\fR instead of \fBlsusb\fR.
@@ -2830,7 +2862,7 @@ options available in \fB\-c 94\-99\fR.
NOTE: All default and configuration file set color values are removed when
output is piped or redirected. You must use the explicit
-\fB\-c <color number>\fR option if you want colors to be present in the
+\fB\-c [color number]\fR option if you want colors to be present in the
piped/redirected output (creating a PDF for example).
\fBCONSOLE_COLOR_SCHEME\fR The color scheme for console output (not in
@@ -2874,13 +2906,16 @@ Post on inxi forums:
You can also visit \fRchannel:\fI #smxi\fR to post issues on either network.
.SH HOMEPAGE
-.I https://github.com/smxi/inxi\fR \- Home of the source code, and tech docs
+.I https://github.com/smxi/inxi
+\fR \- Home of the source code, and tech docs
(\fIinxi\-perl/docs\fR).
-.I https://smxi.org/docs/inxi.htm\fR \- The main docs for inxi. See
+.I https://smxi.org/docs/inxi.htm
+\fR \- The main docs for inxi. See
\fIinxi\-perl/docs\fR for more technical docs.
-.I https://fosstodon.org/@smxi\fR \- Follow @smxi on Mastodon!
+.I https://fosstodon.org/@smxi
+\fR \- Follow @smxi on Mastodon!
.SH AUTHOR AND CONTRIBUTORS TO CODE
@@ -2890,7 +2925,7 @@ is a fork of \fBlocsmif\fR's very clever \fBinfobash\fR script.
Original infobash author and copyright holder:
Copyright (C) 2005\-2007 Michiel de Boer aka locsmif
-inxi version: Copyright (C) 2008\-2021 Harald Hope
+inxi version: Copyright (C) 2008\-2023 Harald Hope
This man page was originally created by Gordon Spencer (aka aus9) and is
maintained by Harald Hope (aka h2 or TechAdmin).