dmitriy.kazimirov/inxi
1
0
Fork 0
mirror of https://github.com/smxi/inxi.git synced 2024-11-16 16:21:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

This is a small syntax fix that will have essentially no impact on anyone. I've just cleaned

Browse source 
up the man code to make it simple enough for roffit man to html conversion. There should be
no real visible differences as far as I know.
This commit is contained in:
Harald Hope 2016-10-29 15:15:43 -07:00
parent 1f5a06471e
commit dbf6904051
2 changed files with 60 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

71
inxi.1
View file

@ -1,19 +1,23 @@
.TH INXI 1 "2016\-10\-20" inxi "inxi manual" .TH INXI 1 "2016\-10\-29" inxi "inxi manual"
.SH NAME .SH NAME
inxi \- Command line system information script for console and IRC inxi \- Command line system information script for console and IRC
.SH SYNOPSIS .SH SYNOPSIS
.B inxi \fR \- Single line, short form. Very basic output. .B inxi
\fR \- Single line, short form. Very basic output.
.B inxi \fR[\fB\-AbBCdDfFGhHiIlmMnNopPrRsSuw\fR] \fR[\fB\-c NUMBER\fR] \fR[\fB\-v NUMBER\fR] .B inxi
\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)] .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] .B inxi
\fR[\fB\-\-help\fR] \fR[\fB\-\-recommends\fR] \fR[\fB\-\-version\fR] \fR[\fB\-@ NUMBER\fR]
.SH DESCRIPTION .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 .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 hardware, CPU, drivers, Xorg, Desktop, Kernel, GCC version(s), Processes, RAM usage, and a wide variety of other
useful information. 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
.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. 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 .SH PRIVACY AND SECURITY
In order to maintain basic privacy and security, inxi filters out automatically on IRC things like In order to maintain basic privacy and security, inxi filters out automatically on IRC things like
@ -30,8 +34,9 @@ together or separate them.
Letters with numbers can have no gap or a gap at your discretion unless using \fB \-t\fR. Letters with numbers can have no gap or a gap at your discretion unless using \fB \-t\fR.
For example: 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 .SH STANDARD OPTIONS
.TP .TP
.B \-A .B \-A
@ -59,12 +64,15 @@ example, the battery capacity is only 61% of it's original amount.
For example: \fB22.2/36.4 Wh 61%\fR For example: \fB22.2/36.4 Wh 61%\fR
.TP .TP
.B \-c \fR[\fB0\fR\-\fB32\fR] .B \-c
\fR[\fB0\fR\-\fB32\fR]
Available color schemes. Scheme number is required. Available color schemes. Scheme number is required.
Supported color schemes: \fB0\-42\fR Supported color schemes: \fB0\-42\fR
.TP .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 Color selectors run a color selector option prior to inxi starting which lets
you set the config file value for the selection. you set the config file value for the selection.
@ -152,7 +160,7 @@ 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. 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. 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 .TP
.B \-M .B \-M
Show machine data. Device, Motherboard, Bios, and if present, System Builder (Like Lenovo). Show machine data. Device, Motherboard, Bios, and if present, System Builder (Like Lenovo).
@ -230,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 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. 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 .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 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) (default: \fB5\fR; if in irc, max: \fB5\fR)
@ -255,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. 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, 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. This requires that you be root to write to that directory.
.TP .TP
.B \-V .B \-V
@ -503,8 +512,8 @@ Overrides defective or corrupted data.
Triggers debugger output. Requires debugging level \fB1\-14\fR (\fB8\-10\fR \- logging of 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. Less than 8 just triggers inxi debugger output on screen.
.TP .TP
.B \-@ \fR[\fB1\fR\-\fB7\fR] .B \-@
\- On screen debugger output. \fR[\fB1\fR\-\fB7\fR] \- On screen debugger output.
.TP .TP
.B \-@ 8 .B \-@ 8
\- Basic logging. Check \fB/home/yourname/.inxi/inxi*.log \- Basic logging. Check \fB/home/yourname/.inxi/inxi*.log
@ -523,7 +532,8 @@ To automatically upload debugger data tar.gz file to \fIftp.techpatterns.com\fR:
For alternate ftp upload locations: Example: 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 .TP
.B \-@ 11 .B \-@ 11
\- With data file of xiin read of \fB/sys \- With data file of xiin read of \fB/sys
@ -542,12 +552,16 @@ are capable of displaying either built in or external script output.
.SH RUNNING IN IRC CLIENT .SH RUNNING IN IRC CLIENT
To trigger inxi output in your IRC client, pick the appropriate method from the list below: To trigger inxi output in your IRC client, pick the appropriate method from the list below:
.TP .TP
.B Xchat, irssi \fR(and many other IRC clients) .B Xchat, irssi
.B /exec \-o inxi \fR[\fBoptions\fR] \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. If you leave off the \fB\-o\fR, only you will see the output on your local IRC client.
.TP .TP
.B Konversation .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, 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: create this symbolic link:
@ -557,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: Then you can start inxi directly, like this:
.B /inxi \fR[\fBoptions\fR] .B /inxi
\fR[\fBoptions\fR]
.TP .TP
.B WeeChat .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 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 clients, with \fB/exec \-o inxi \fR[\fBoptions\fR]. Also, newer WeeChats have dropped
@ -618,8 +635,8 @@ post on inxi developer forums:
.I http://techpatterns.com/forums/forum\-32.html .I http://techpatterns.com/forums/forum\-32.html
.TP .TP
You can also visit You can also visit
.I irc.oftc.net \fRchannel:\fI #smxi .I irc.oftc.net
to post issues. \fRchannel:\fI #smxi\fR to post issues.
.SH HOMEPAGE .SH HOMEPAGE
.I https://github.com/smxi/inxi .I https://github.com/smxi/inxi
.I http://smxi.org/ .I http://smxi.org/

16
inxi.changelog
View file

@ -1,3 +1,19 @@
=====================================================================================
Version: 2.3.3
Patch Version: 00
Script Date: 2016-10-25
-----------------------------------
Changes:
-----------------------------------
No version change, updated man page.
This is a small syntax fix that will have essentially no impact on anyone. I've just cleaned
up the man code to make it simple enough for roffit man to html conversion. There should be
no real visible differences as far as I know.
-----------------------------------
-- Harald Hope - Sat, 29 Oct 2016 15:13:40 -0700
===================================================================================== =====================================================================================
Version: 2.3.3 Version: 2.3.3
Patch Version: 00 Patch Version: 00