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

editing the man page, let's see if it improves.

Browse source
This commit is contained in:
inxi-svn 2014-04-03 18:28:18 +00:00
parent 92d2c23330
commit 7e517ce378
1 changed files with 6 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
inxi.1
View file

@ -1,7 +1,6 @@
.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,17 +9,13 @@ 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 \fI/home\fR username directory in partitions,
and a few other things.
@ -28,19 +23,16 @@ 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
.SH STANDARD OPTIONS
.TP
.B \-A
Show Audio/sound card information.
@ -52,7 +44,6 @@ 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
@ -82,7 +73,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.
@ -148,9 +138,7 @@ Show Network card information. With \fB\-x\fR, shows PCI BusID, Port number.
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 \fI/etc/sudoers\fR (sudo v. 1.7 or newer):
.B <username> ALL = NOPASSWD: /usr/bin/file (sample)
Does not show components (partitions that create the md raid array) of md\-raid arrays.
.TP
.B \-p
@ -205,14 +193,15 @@ 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: \fI/usr/share/man/man8\fR
This requires that you be root to write to that directory.
@ -262,6 +251,7 @@ To get weather for an alternate location, use \fB\-W <location_string>\fR. See a
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 '\fB+\fR' sign. No spaces around \fB,\fR (comma).
Use only ascii letters in city/state/country names, sorry.
@ -269,6 +259,7 @@ Examples: \fB\-W 95623\fR OR \fB\-W Boston,MA\fR OR \fB\-W45.5234,\-122.6762\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\fR
.TP
.B \-z
@ -276,9 +267,7 @@ Adds security filters for IP addresses, Mac, location (\fB\-w\fR), and user home
.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
@ -289,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.
@ -306,7 +294,6 @@ The following shows which lines / items get extra information with each extra da
.B \-x \-D
\- Hdd temp with disk data if you have hddtemp installed, if you are root OR if you have added to
\fI/etc/sudoers\fR (sudo v. 1.7 or newer):
.B <username> ALL = NOPASSWD: /usr/sbin/hddtemp (sample)
.TP
.B \-x \-G
@ -404,7 +391,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
@ -413,7 +399,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 \-%
@ -439,9 +424,7 @@ Less than 8 just triggers inxi debugger output on screen.
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
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 \fI/sys
@ -454,23 +437,18 @@ 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:
@ -485,7 +463,6 @@ Then you can start inxi directly, like this:
.B WeeChat
.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]
@ -513,7 +490,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:
@ -525,14 +501,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
@ -543,7 +517,6 @@ 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