aboutsummaryrefslogtreecommitdiffstats
path: root/inxi.1
diff options
context:
space:
mode:
authorLibravatarUnit 193 <unit193@ubuntu.com>2014-04-05 16:43:59 -0400
committerLibravatarUnit 193 <unit193@ubuntu.com>2014-04-05 16:43:59 -0400
commit5c16a288fa85499c3ba92465388462919a7a76e2 (patch)
treeff1b381fea1cefb99bf23f4999baf02979f72142 /inxi.1
parentfe8ed1091f620062af5c9804b0cd51b691e3e1e0 (diff)
downloadinxi-5c16a288fa85499c3ba92465388462919a7a76e2.tar.bz2
inxi-5c16a288fa85499c3ba92465388462919a7a76e2.tar.xz
inxi-5c16a288fa85499c3ba92465388462919a7a76e2.tar.zst
Imported Upstream version 2.1.18upstream/2.1.18
Diffstat (limited to 'inxi.1')
-rwxr-xr-xinxi.1117
1 files changed, 52 insertions, 65 deletions
diff --git a/inxi.1 b/inxi.1
index 74d5453..ef393d6 100755
--- a/inxi.1
+++ b/inxi.1
@@ -1,7 +1,6 @@
-.TH INXI 1 "2014\-03\-14" inxi "inxi manual"
+.TH INXI 1 "2014\-04\-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.
@@ -10,37 +9,30 @@ inxi \- Command line system information script for console and IRC
.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)]
.B inxi \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
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
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
-your network card mac address, WAN and LAN IP, your /home username directory in partitions,
+your network card mac address, WAN and LAN IP, your \fB/home\fR username directory in partitions,
and a few other things.
Because inxi is often used on forums for support, you can also trigger this filtering with the \fB\-z\fR
option (\fB\-Fz\fR, for example). To override the IRC filter, you can use the \fB\-Z\fR option. This can be useful
to debug network connection issues online in a private chat, for example.
-
.SH USING OPTIONS
-
Options can be combined if they do not conflict. Either group the letters
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 \-AG\fR or \fBinxi \-A \-G\fR or \fBinxi \-c10
+.B inxi \-AG\fR or \fBinxi \-A \-G\fR or \fBinxi \-c10
.SH STANDARD OPTIONS
-
.TP
.B \-A
Show Audio/sound card information.
@@ -52,15 +44,12 @@ Shows basic output, short form (previously \fB\-d\fR). Same as: \fBinxi \-v 2
Available color schemes. Scheme number is required.
Supported color schemes: \fB0\-32
-
.TP
.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.
-Color selectors for each type display.
-
-(NOTE: irc and global only show safe color set):
+Color selectors for each type display (NOTE: irc and global only show safe color set):
.TP
.B \-c 94\fR
\- Console, out of X.
@@ -82,7 +71,6 @@ Konversation etc.
\- Global \- Overrides/removes all settings.
Setting specific color type removes the global color selection.
-
.TP
.B \-C
Show full CPU output, including per CPU clockspeed if available. See \fB\-x\fR for more options.
@@ -92,7 +80,7 @@ Shows optical drive data. Same as \fB\-Dd\fR. With \fB\-x\fR, adds features line
\fB\-xx\fR adds a few more features.
.TP
.B \-D
-Show full hard Disk info, not only model, ie: \fI/dev/sda ST380817AS 80.0GB.
+Show full hard Disk info, not only model, ie: \fB/dev/sda ST380817AS 80.0GB.
.TP
.B \-f
Show all cpu flags used, not just the short list. Not shown with \fB\-F\fR to avoid
@@ -111,7 +99,7 @@ may be added once enough data has been collected.
.TP
.B \-h
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.
+if you want a different default value, or use \fB-y <width>\fR to temporarily override the defaults or actual window width.
.TP
.B \-\-help
Same as \fB\-h\fR
@@ -134,7 +122,7 @@ Show partition labels. Default: short partition \fB\-P\fR. For full \fB\-p\fR ou
.TP
.B \-M
Show machine data. Motherboard, Bios, and if present, System Builder (Like Lenovo).
-Older systems/kernels without the required /sys data can use dmidecode instead, run as root. If using dmidecode,
+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.
.TP
.B \-n
@@ -146,8 +134,8 @@ Show Network card information. With \fB\-x\fR, shows PCI BusID, Port number.
.TP
.B \-o
Show unmounted partition information (includes UUID and LABEL if available).
-Shows file system type if you have file installed, if you are root OR if you have
-added to /etc/sudoers (sudo v. 1.7 or newer):
+Shows file system type if you have \fBfile\fR installed, if you are root OR if you have
+added to \fB/etc/sudoers\fR (sudo v. 1.7 or newer):
.B <username> ALL = NOPASSWD: /usr/bin/file (sample)
@@ -158,19 +146,20 @@ Show full partition information (\fB\-P\fR plus all other detected partitions).
.TP
.B \-P
Show Partition information (shows what \fB\-v 4\fR would show, but without extra data).
-Shows, if detected: / /boot /home /tmp /usr /var. Use \fB\-p\fR to see all mounted partitions.
+Shows, if detected: \fB/ /boot /home /tmp /usr /var\fR. Use \fB\-p\fR to see all mounted partitions.
.TP
.B \-r
Show distro repository data. Currently supported repo types:
-APT (Debian, Ubuntu + derived versions)
-PACMAN (Arch Linux + derived versions)
+\fBAPT\fR (Debian, Ubuntu + derived versions)
+
+\fBPACMAN\fR (Arch Linux + derived versions)
-PISI (Pardus + derived versions)
+\fBPISI\fR (Pardus + derived versions)
-URPMQ (Mandriva, Mageia + derived versions)
+\fBURPMQ\fR (Mandriva, Mageia + derived versions)
-YUM. (Fedora, Redhat, maybe Suse + derived versions)
+\fBYUM\fR (Fedora, Redhat, maybe Suse + derived versions)
(as distro data is collected more will be added. If your's is missing please show us how to get this
information and we'll try to add it.)
@@ -205,23 +194,24 @@ Make sure to have no space between letters and numbers (\fB\-t cm10\fR \- right,
.TP
.B \-t cm\fR
\- cpu+memory. With \fB\-x\fR, shows also cpu or memory for that process on same line.
-
.TP
.B \-u
Show partition UUIDs. Default: short partition \fB\-P\fR. For full \fB\-p\fR output, use: \fB\-pu\fR (or \fB\-plu\fR).
.TP
.B \-U
Note \- Maintainer may have disabled this function.
-If inxi \-h has no listing for U then its disabled.
+
+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/man8\fR
This requires that you be root to write to that directory.
.TP
.B \-V
inxi version information. Prints information then exits.
.TP
.B \-\-version
-same as \fB\-V
+same as \fB\-V\fR
.TP
.B \-v
Script verbosity levels. Verbosity level number is required. Should not be used with \fB\-b\fR or \fB\-F\fR.
@@ -242,7 +232,7 @@ Supported levels: \fB0\-7\fR Examples :\fB inxi \-v 4 \fR or \fB inxi \-v4\fR
\- Adds advanced CPU (\fB\-C\fR); network (\fB\-n\fR) data; triggers \fB\-x\fR advanced data option.
.TP
.B \-v 4
-\- Adds partition size/filled data (\fB\-P\fR) for (if present):/, /home, /var/, /boot
+\- Adds partition size/filled data (\fB\-P\fR) for (if present):\fB/ /home /var/ /boot\fR
Shows full disk data (\fB\-D\fR)
.TP
.B \-v 5
@@ -254,29 +244,30 @@ optical drives.
triggers \fB\-xx\fR extra data option.
.TP
.B \-v 7
-\- Adds network IP data (\fB\-i\fR); triggers \fB\-xxx
+\- Adds network IP data (\fB\-i\fR); triggers \fB\-xxx\fR
.TP
.B \-w
Adds weather line. Note, this depends on an unreliable api so it may not always be working in the future.
-To get weather for an alternate location, use \-W <location_string>. See also \-x, \-xx, \-xxx option.
-Please note, your distribution's maintainer may chose to disable this feature, so if \-w or \-W don't work, that's why.
+To get weather for an alternate location, use \fB\-W <location_string>\fR. See also \fB\-x\fR, \fB\-xx\fR, \fB\-xxx\fR option.
+Please note, your distribution's maintainer may chose to disable this feature, so if \fB\-w\fR or \fB\-W\fR don't work, that's why.
.TP
.B \-W <location_string>
Get weather/time for an alternate location. Accepts postal/zip code, city,state pair, or latitude,longitude.
-Note: city/country/state names must not contain spaces. Replace spaces with '+' sign. No spaces around , (comma).
+Note: city/country/state names must not contain spaces. Replace spaces with '\fB+\fR' sign. No spaces around \fB,\fR (comma).
Use only ascii letters in city/state/country names, sorry.
-Examples: \-W 95623 OR \-W Boston,MA OR \-W45.5234,\-122.6762 OR \-W new+york,ny
-OR \-W bodo,norway.
+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 \-y <integer >= 80>
+This is an absolute width override which sets the output line width max. Overrides \fBCOLS_MAX_IRC\fR / \fBCOLS_MAX_CONSOLE\fR globals, or the actual widths of the terminal. If used with \fB\-h\fR or \fB\-c 94-99\fR, put \fB\-y\fR option first or the override will be ignored. Cannot be used with \fB\-\-help\fR/\fB\-\-version\fR/\fB\-\-recommends\fR type long options. Example: \fBinxi \-y 130 -Fxx\fR
.TP
.B \-z
-Adds security filters for IP addresses, Mac, location (\-w), and user home directory name. Default on for irc clients.
+Adds security filters for IP addresses, Mac, location (\fB\-w\fR), and user home directory name. Default on for irc clients.
.TP
.B \-Z
Absolute override for output filters. Useful for debugging networking issues in irc for example.
-
.SH EXTRA DATA OPTIONS
-
These options are for long form only, and can be triggered by one or more \fB\-x\fR, like \fB\-xx\fR.
Alternately, the \fB\-v\fR options trigger them in the following way:
\fB\-v 3\fR adds \fB\-x\fR; \fB\-v 6\fR adds \fB\-xx\fR; \fB\-v 7\fR adds \fB\-xxx\fR
@@ -287,7 +278,6 @@ Can be added to any long form option list, like: \fB\-bxx\fR or \fB\-Sxxx\fR
There are 3 extra data levels: \fB\-x\fR; \fB\-xx\fR; and \fB\-xxx\fR
The following shows which lines / items get extra information with each extra data level.
-
.TP
.B \-x \-A
\- Adds version/port(s)/driver version (if available) for each Audio device.
@@ -303,7 +293,7 @@ The following shows which lines / items get extra information with each extra da
.TP
.B \-x \-D
\- Hdd temp with disk data if you have hddtemp installed, if you are root OR if you have added to
-/etc/sudoers (sudo v. 1.7 or newer):
+\fB/etc/sudoers\fR (sudo v. 1.7 or newer):
.B <username> ALL = NOPASSWD: /usr/sbin/hddtemp (sample)
.TP
@@ -319,7 +309,6 @@ The following shows which lines / items get extra information with each extra da
.B \-x \-i
\- Show IPv6 as well for LAN interface (IF) devices.
.TP
-.TP
.B \-x \-I
\- Show current init system (and init rc in some cases, like OpenRC). With \-xx, shows init/rc
version number, if available.
@@ -341,6 +330,7 @@ version number, if available.
.B \-x \-R
\- md\-raid: Shows component raid id. Adds second RAID Info line: raid level; report on drives
(like 5/5); blocks; chunk size; bitmap (if present). Resync line, shows blocks synced/total blocks.
+
\- zfs\-raid: Shows raid array full size; available size; portion allocated to RAID (ie, not available as storage)."
.TP
.B \-x \-S
@@ -370,7 +360,7 @@ version number, if available.
.B \-xx \-I
\- Show, if detected, system default runlevel. Supports Systemd/Upstart/Sysvinit type defaults. Note that
not all systemd systems have the default value set, in that case, if present, it will use the data from
-\fI/etc/inittab\fR.
+\fB/etc/inittab\fR.
.TP
.B \-xx \-I
\- Adds parent program (or tty) that started shell, if not IRC client, to shell information.
@@ -403,7 +393,6 @@ Supports some current desktop extras like gnome\-panel, lxde\-panel, and others.
.B \-xxx \-w / \-W
\- Adds location (city state country), weather observation time, altitude of system.
If wind chill, heat index, or dew point are available, shows that data as well.
-
.SH ADVANCED OPTIONS
.TP
.B \-! 31
@@ -412,7 +401,6 @@ forums or IRC.
.TP
.B \-! 32
Turns on hostname in System line. Overrides inxi config file value (if set): B_SHOW_HOST='false'.
-
.SH DEBUGGING OPTIONS
.TP
.B \-%
@@ -426,7 +414,7 @@ Less than 8 just triggers inxi debugger output on screen.
\- On screen debugger output.
.TP
.B \-@ 8
-\- Basic logging. Check \fI /home/yourname/.inxi/inxi*.log
+\- Basic logging. Check \fB/home/yourname/.inxi/inxi*.log
.TP
.B \-@ 9
\- Full file/sys info logging.
@@ -436,14 +424,16 @@ Less than 8 just triggers inxi debugger output on screen.
.TP
.B \-@ <11\-14>
The following create a tar.gz file of system data, plus collecting the inxi output to file:
-To automatically upload debugger data tar.gz file to \fIftp.techpatterns.com\fR: \fBinxi \-xx@ <11\-14>\fR
+To automatically upload debugger data tar.gz file to \fIftp.techpatterns.com\fR:
+
+\fBinxi \-xx@ <11\-14>\fR
+
For alternate ftp upload locations: Example:
.B inxi \-! \fIftp.yourserver.com/incoming\fB \-xx@ 14\fR
-
.TP
.B \-@ 11
-\- With data file of xiin read of /sys
+\- With data file of xiin read of \fB/sys
.TP
.B \-@ 12
\- With xorg conf and log data, xrandr, xprop, xdpyinfo, glxinfo etc.
@@ -453,36 +443,39 @@ For alternate ftp upload locations: Example:
.TP
.B \-@ 14
\- Everything, full data collection.
-
.SH SUPPORTED IRC CLIENTS
BitchX, Gaim/Pidgin, ircII, Irssi, Konversation, Kopete, KSirc, KVIrc, Weechat, and Xchat. Plus any others that
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]
-
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]
-
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:
.B ln \-s /usr/local/bin/inxi /usr/share/kde4/apps/konversation/scripts/inxi
-If inxi is somewhere else, change the path /usr/local/bin to wherever it is located.
+If inxi is somewhere else, change the path \fB/usr/local/bin\fR to wherever it is located.
Then you can start inxi directly, like this:
.B /inxi \fR[\fBoptions\fR]
.TP
.B WeeChat
-.B /shell \-o inxi \fR[\fBoptions\fR]
+.B NEW: /exec \-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
+the \fB\-curses\fR part of their program name, ie: \fBweechat\fR instead of \fBweechat-curses\fR.
+
+Deprecated:
Before WeeChat can run external scripts like inxi, you need to install the
weechat\-plugins package. This is automatically installed for Debian users.
@@ -496,7 +489,7 @@ Make the script executable by
.B chmod +x shell.py
-Move it to your home folder: \fI/.weechat/python/autoload/\fR then logout, and start WeeChat with
+Move it to your home folder: \fB/.weechat/python/autoload/\fR then logout, and start WeeChat with
.B weechat\-curses
@@ -507,7 +500,6 @@ you would enter a command like this:
If you leave off the \fB\-o\fR, only you will see the output on your local weechat. WeeChat
users may also like to check out the weeget.py
-
.SH INITIALIZATION FILE
.TP
inxi will read the following configuration/initialization files in the following order:
@@ -519,14 +511,12 @@ inxi will read the following configuration/initialization files in the following
See wiki pages for more information on how to set these up:
.TP
.I http://code.google.com/p/inxi/wiki/script_configuration_files
-
.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 all
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/svn/wiki, file an issue report:
.I http://code.google.com/p/inxi/issues/list
@@ -537,12 +527,9 @@ post on inxi developer forums:
You can also visit
.I irc.oftc.net \fRchannel:\fI #smxi
to post issues.
-
.SH HOMEPAGE
.I http://code.google.com/p/inxi
-
.SH AUTHOR AND CONTRIBUTORS TO CODE
-
.B inxi
is is a fork of locsmif's largely unmaintained yet very clever, infobash script.