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

Cleaned up man page formatting, so there's also a new inxi.tar.gz full tarball file.

Browse source
This commit is contained in:
inxi-svn 2012-05-13 17:29:35 +00:00
parent 7c9ac0c690
commit e7323c0512
1 changed files with 95 additions and 77 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

172
man/inxi.8
View file

@ -1,4 +1,4 @@
.TH INXI 8 2011-09-21 Linux "inxi"
.TH INXI 8 2011-05-13 Linux "inxi"
.SH NAME
inxi - Info script for console and IRC.
@ -16,13 +16,9 @@ inxi - Info script for console and IRC.
.SH DESCRIPTION
.B inxi
.R is an system info script for console and IRC. However some people use inxi in their
forum posts as well - for the same reason.
It is is a fork of locsmif's largely unmaintained yet very clever, infobash script.
inxi is a read-only script.
inxi is co-developed, a group project, primarily with trash80 on the programming side.
forum posts as well - for the same reason. It is is a fork of locsmif's largely unmaintained yet
very clever, infobash script. inxi is co-developed, a group project, primarily with trash80 on
the programming side.
But the nice people at irc.oftc.net channel #linux-smokers-club all really have to
be considered to be co-developers because of their non-stop enthusiasm and
@ -35,7 +31,6 @@ And of course, locsmif, who figured out a lot of the core methods, logic, and tr
used in inxi, has to be considered as a primary author as well, even if inxi has been
officially forked from his infobash script.
.SH NOTES FOR ALL USERS FOR THE OPTIONS SECTION
Options can be combined if they do not conflict. Either group the letters
@ -70,17 +65,18 @@ Color selectors for each type display
(NOTE: irc and global only show safe color set):
.TP
\fB -c 94 \fR Console, out of X
\fB -c 94 \fR Console, out of X
.TP
\fB -c 95 \fR Terminal, running in X - like xTerm
\fB -c 95 \fR Terminal, running in X - like xTerm
.TP
\fB -c 96 \fR Gui IRC, running in X - like Xchat, Quassel, Konversation etc.
\fB -c 96 \fR Gui IRC, running in X - like Xchat, Quassel,
Konversation etc.
.TP
\fB -c 97 \fR Console IRC running in X - like irssi in xTerm
\fB -c 97 \fR Console IRC running in X - like irssi in xTerm
.TP
\fB -c 98 \fR Console IRC not in X
\fB -c 98 \fR Console IRC not in X
.TP
\fB -c 99 \fR Global - Overrides/removes all settings.
\fB -c 99 \fR Global - Overrides/removes all settings.
Setting specific removes global.
@ -143,8 +139,7 @@ Show Network card information. With -x, 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 /etc/sudoers (sudo v. 1.7 or newer):
.TP
<username> ALL = NOPASSWD: /usr/bin/file (sample)
<username> ALL = NOPASSWD: /usr/bin/file (sample)
.TP
.B -p
Show full partition information (-P plus all other detected partitions).
@ -163,31 +158,33 @@ PISI (Pardus + derived versions)
YUM. (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.)
(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.)
.TP
.B -R
Show RAID data. Shows RAID devices, states, levels, and components, and extra data with -x/-xx. If device is resyncing, shows resync progress line as well.
Show RAID data. Shows RAID devices, states, levels, and components, and extra data with -x/-xx.
If device is resyncing, shows resync progress line as well.
.TP
.B --recommends
Checks inxi application dependencies + recommends, and directories, then shows
what package(s) you need to install to add support for that feature.
what package(s) you need to install to add support for that feature.
.TP
.B -s
Show sensors output (if sensors installed/configured): mobo/cpu/gpu temp; detected
fan speeds.
Gpu temp only for Fglrx/Nvidia drivers. Nvidia shows screen number for > 1 screens.
fan speeds. Gpu temp only for Fglrx/Nvidia drivers. Nvidia shows screen number for > 1 screens.
.TP
.B -S
Show System information: host name, kernel, desktop environment (if in X), distro
.TP
.B -t \fR[\fBc\fR or\fB m\fR or\fB cm\fR or\fB cm NUMBER\fR]
Show processes.
.B -t \fR[\fBc\fR or\fB m\fR or\fB cm\fR or\fB cm NUMBER\fR]\fR- Show processes.
.TP
.B -t c \fRcpu
.B -t c
cpu
.TP
.B -t m \fRmemory
.B -t m
memory
.TP
.B -t cm \fRcpu+memory.
.B -t cm c \fRcpu+memory.
If followed by numbers \fB1\fR-\fB20 \fR, shows that number of processes for each type
(default: 5; if in irc, max: 5)
@ -214,70 +211,93 @@ Script verbosity levels. Verbosity level number is required. Should not be used
Supported levels: 0-7 Examples :\fI inxi -v 4 \fR or \fI inxi -v4
.TP
.B -v 0 \fR - Short output, same as: inxi
.B -v 0
- Short output, same as: inxi
.TP
.B -v 1 \fR - Basic verbose, -S + basic CPU + -G + basic Disk + -I.
.B -v 1
- Basic verbose, -S + basic CPU + -G + basic Disk + -I.
.TP
.B -v 2 \fR - Adds networking card (-N), Machine (-M) data, and shows basic hard disk data (names only).
Same as: inxi -b
.B -v 2
- Adds networking card (-N), Machine (-M) data, and shows basic hard disk data
(names only). Same as: inxi -b
.TP
.B -v 3 \fR - Adds advanced CPU (-C), network (-n) data, and switches on -x advanced data option.
.B -v 3
- Adds advanced CPU (-C), network (-n) data, and switches on -x advanced data option.
.TP
.B -v 4 \fR - Adds partition size/filled data (-P) for (if present):/, /home, /var/, /boot
Shows full disk data (-D)
.B -v 4
- Adds partition size/filled data (-P) for (if present):/, /home, /var/, /boot
Shows full disk data (-D)
.TP
.B -v 5 \fR - Adds audio card (-A); sensors (-s), partition label (-l) and UUID (-u), short form of optical drives.
.TP
.B -v 6 \fR - Adds full partition data (-p), unmounted partition data (-o), optical drive data (-d).
.TP
.B -v 7 \fR - Adds network IP data (-i); triggers -xx.
.B -v 5
- Adds audio card (-A); sensors (-s), partition label (-l) and UUID (-u), short form of
optical drives.
.TP
.B -v 6
- Adds full partition data (-p), unmounted partition data (-o), optical drive data (-d).
.TP
.B -v 7
- Adds network IP data (-i); triggers -xx.
.TP
.B -x
Show extra data (only works with verbose or line output, not short form):
.TP
.B -x -C \fR- bogomips on Cpu
.B -x -C
- bogomips on Cpu
.TP
.B -x -d \fR- Adds items to features line of optical drive; adds rev version to optical drive.
.B -x -d
- Adds items to features line of optical drive; adds rev version to optical drive.
.TP
.B -x -D \fR- 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): <username> ALL = NOPASSWD: /usr/sbin/hddtemp (sample)
.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):
<username> ALL = NOPASSWD: /usr/sbin/hddtemp (sample)
.TP
.B -x -G \fR- Direct rendering status for Graphics (in X).
.B -x -G
- Direct rendering status for Graphics (in X).
.TP
.B -x -G \fR- (for single gpu, nvidia driver) screen number gpu is running on.
.B -x -G
- (for single gpu, nvidia driver) screen number gpu is running on.
.TP
.B -x -i \fR- Show IPv6 as well for LAN interface (IF) devices.
.B -x -i
- Show IPv6 as well for LAN interface (IF) devices.
.TP
.B -x -I \fR- Show system GCC, default. With -xx, also show other installed GCC versions.
.B -x -I
- Show system GCC, default. With -xx, also show other installed GCC versions.
.TP
.B -x -N -A \fR- Adds version/port(s)/driver version (if available) for Network/Audio;
.B -x -N -A \fR- Adds version/port(s)/driver version (if available) for Network/Audio;
.TP
.B -x -N -A -G \fR- Network, audio, graphics, shows PCI Bus ID/Usb ID number of card
.B -x -N -A -G \fR- Network, audio, graphics, shows PCI Bus ID/Usb ID number of card
.TP
.B -x -R \fR- 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.
.B -x -R
- 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.
.TP
.B -x -S \fR- Desktop toolkit if avaliable (GNOME/XFCE/KDE only); Kernel gcc version
.B -x -S
- Desktop toolkit if avaliable (GNOME/XFCE/KDE only); Kernel gcc version
.TP
.B -x -t \fR- Adds memory use output to cpu (-xt c), and cpu use to memory (-xt m).
.B -x -t
- Adds memory use output to cpu (-xt c), and cpu use to memory (-xt m).
.TP
.B -xx
Show extra, extra data (only works with verbose or line output, not short form):
.TP
.B -xx -D \fR - Adds disk serial number
.B -xx -D
- Adds disk serial number
.TP
.B -xx -I \fR- Adds other detected installed gcc versions to primary gcc output (if present).
.B -xx -I
- Adds other detected installed gcc versions to primary gcc output (if present).
.TP
.B -xx -M \fR- Adds chassis information, if any data for that is available.
.B -xx -M
- Adds chassis information, if any data for that is available.
.TP
.B -xx -R\fR - Adds superblock (if present); algorythm, U data.
Adds system info line (kernel support, read ahead, raid events).
Adds if present, unused device line. If device is resyncing, shows resync progress line as well
.B -xx -R
- Adds superblock (if present); algorythm, U data. Adds system info line (kernel support,
read ahead, raid events). Adds if present, unused device line. If device is resyncing, shows
resync progress line as well
.TP
.B -xx -@ <11-14> \fR - Automatically uploads debugger data tar.gz file to ftp.techpatterns.com.
.B -xx -@ <11-14>
- Automatically uploads debugger data tar.gz file to ftp.techpatterns.com.
.TP
.B -z
Adds security filters for IP addresses, Mac, and user home directory name. Default on for irc clients.
@ -286,7 +306,6 @@ Adds security filters for IP addresses, Mac, and user home directory name. Defau
Absolute override for output filters. Useful for debugging networking issues in irc for example.
.TP
.SH DEBUGGING OPTIONS
.TP
.B -%
@ -294,7 +313,7 @@ Overrides defective or corrupted data.
.TP
.B -@
Triggers debugger output. Requires debugging level 1-14 (8-10 - logging of data).
Less than 8 just triggers inxi debugger output on screen.
Less than 8 just triggers inxi debugger output on screen.
.TP
.B -@ \fR[\fB1\fR-\fB7\fR]
- On screen debugger output
@ -310,10 +329,10 @@ Triggers debugger output. Requires debugging level 1-14 (8-10 - logging of data)
.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 ftp.techpatterns.com: inxi -xx@ <11-14>
For alternate ftp upload locations: Example:
For alternate ftp upload locations: Example: \fIinxi -! ftp.yourserver.com/incoming -xx@ 14\fR
\fIinxi -! ftp.yourserver.com/incoming -xx@ 14\fR
.TP
.B -@ 11
@ -331,19 +350,19 @@ For alternate ftp upload locations: Example: \fIinxi -! ftp.yourserver.com/incom
.SH SUPPORTED IRC CLIENTS
.TP
BitchX Gaim/Pidgin ircII Irssi
Konversation Kopete KSirc
KVIrc Weechat Xchat
BitchX Gaim/Pidgin ircII Irssi Konversation Kopete KSirc KVIrc Weechat Xchat
.SH INITIALIZATION FILE
.TP
inxi will read the following configuration/initialization files in the following order:
.TP
/etc/inxi.conf
.TP
$HOME/.inxi/inxi.conf
See wiki pages for more information on how to set these up:
.TP
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
@ -359,17 +378,16 @@ You can also visit
.I irc.oftc.net channel: #smxi
to post issues.
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.
.SH HOMEPAGE
.I http://code.google.com/p/inxi
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.
.SH HOMEPAGE: \fI http://code.google.com/p/inxi
.SH
.SH AUTHOR AND CONTRIBUTORS TO CODE
Original infobash author and copyright holder:
Copyright (C) 2005-2007 Michiel de Boer a.k.a. locsmif
inxi version: Copyright (C) 2008-12 Scott Rogers & Harald Hope