inxi/man/inxi.8

.TH INXI 8 2011-09-21 Linux  "inxi"
.SH NAME
inxi  - Info script for console and IRC. 


.SH SYNOPSIS
.B inxi

.B inxi \fR[\fB-AbCdDfFGhHiIlMnNopPrsSu\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 cm NUMBER\fR)] \fR[\fB-x LETTER\fR(\fBs\fR)] \fR[\fB-xx LETTER\fR]

.B inxi \fR[\fB--help\fR] \fR[\fB--recommends\fR] \fR[\fB--version\fR] \fR[\fB-@ NUMBER\fR] 


.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. 

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 
willingness to provide real time testing and debugging of inxi development.

Without a wide range of diverse Linux kernel based Free Desktop systems to test 
on, we could never have gotten inxi to be as reliable and solid as it's turning out to be.

And of course, locsmif, who figured out a lot of the core methods, logic, and tricks 
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 
together or separate them.

Letters with numbers can have no gap or a gap at your discretion unless using \fB -t

eg  
.I inxi -AG \fRor\fI inxi -A -G \fRor\fI inxi -c10


.SH OPTIONS 

.TP
.B -A  
Show Audio/sound card information.
.TP
.B -b  
Shows basic output, short form (previously -d). Same as: inxi -v 2
.TP
.B -c \fR[\fB0\fR-\fB32\fR] 
Available color schemes. Scheme number is required. 
  
Supported color schemes: 0-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):
.TP
     \fB -c 94 \fR   Console, out of X
.TP
	\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.
.TP
	\fB -c 97 \fR	Console IRC running in X - like irssi in xTerm
.TP
	\fB -c 98 \fR	Console IRC not in  X
.TP
	\fB -c 99 \fR	Global - Overrides/removes all settings.

Setting specific removes global.

.TP
.B -C  
Show full CPU output, including per CPU clockspeed.
.TP
.B -d  
Shows optical drive data. Same as -Dd. With -x, adds features line to output. 
-xx adds a few more features.
.TP
.B -D  
Show full hard Disk info, not only model, ie: /dev/sda ST380817AS 80.0GB.
.TP
.B -f  
Show all cpu flags used, not just the short list. Not shown with -F to avoid 
spamming.
.TP
.B -F  
Show Full output for inxi. Includes all Upper Case line letters, plus -s and -n.
Does not show extra verbose options like -x -d -f -u -l -o -p -t -r unless you use 
that argument.
.TP
.B -G  
Show Graphic card information (card, x type, resolution, glx renderer, version).
.TP
.B -h    
This help menu.
.TP
.B --help   
Same as -h
.TP
.B -H             
This help menu, plus developer options. Do not use dev options in normal 
operation!
.TP
.B -i  
Show Wan IP address, and shows local interfaces (requires ifconfig network tool). 
Same as -Nni. Not shown with -F for user security reasons, you shouldn't 
paste your local/wan IP.
.TP
.B -I  
Show Information: processes, uptime, memory, irc client, inxi version.
.TP
.B -l  
Show partition labels. Default: short partition -P. For full -p output, use: -pl (or -plu).
.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.
.TP
.B -n  
Show Advanced Network card information. Same as -Nn. Shows interface, speed, 
mac id, state, etc.
.TP
.B -N  
Show Network card information. With -x, 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): 
.TP
	<username> ALL = NOPASSWD: /usr/bin/file (sample)
.TP
.B -p  
Show full partition information (-P plus all other detected partitions).
.TP
.B -P  
Show Partition information (shows what -v 4 would show, but without extra data).
Shows, if detected: / /boot /home /tmp /usr /var. Use -p 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)

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.)
.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.
.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.
.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.
.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. 
.TP
.B 	-t c \fRcpu
.TP
.B 	-t m \fRmemory 
.TP
.B 	-t cm \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)

Make sure to have 
.I no space 
.R between letters and numbers (-t cm10 -right, -t cm 10 -wrong).
.TP
.B -u  
Show partition UUIDs. Default: short partition -P. For full -p output, use: -pu (or -plu).
.TP
.B -U             
Auto-update script. Note: if you installed as root, you must be root to update, 
otherwise user is fine.
.TP
.B -V 
inxi version information. Prints information then exits.
.TP
.B --version   
same as -V
.TP
.B -v	
Script verbosity levels. Verbosity level number is required. Should not be used with -b or -F. 

Supported levels: 0-7 Examples :\fI inxi -v 4 \fR or \fI inxi -v4
.TP
.B 	-v 0 \fR - Short output, same as: inxi
.TP
.B 	-v 1 \fR - 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
.TP
.B 	-v 3 \fR - 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)
.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.
.TP
.TP
.TP
.B -x  
Show extra data (only works with verbose or line output, not short form): 
.TP 
.B 	-x -C \fR- bogomips on Cpu
.TP
.B 	-x -d \fR- 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)
.TP
.B 	-x -G \fR- Direct rendering status for Graphics (in X).
.TP
.B 	-x  -G \fR- (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.
.TP
.B 	-x -I \fR- 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;
.TP
.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.
.TP
.B 	-x -S \fR- 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).
.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
.TP
.B 	-xx -I \fR- 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.
.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
.TP
.B 	-xx -@ <11-14> \fR - 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.
.TP
.B -Z  
Absolute override for output filters. Useful for debugging networking issues in irc for example.
.TP


.SH DEBUGGING OPTIONS
.TP
.B -%  
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.
.TP
.B -@  \fR[\fB1\fR-\fB7\fR] 
- On screen debugger output
.TP
.B -@ 8    
- Basic logging. Check \fI /home/yourname/.inxi/inxi*.log 
.TP
.B -@ 9    
- Full file/sys info logging
.TP
.B -@ 10  
- Color logging.
.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: \fIinxi -! ftp.yourserver.com/incoming -xx@ 14\fR

.TP
.B -@ 11 
- With data file of xiin read of /sys
.TP
.B -@ 12 
- With xorg conf and log data, xrandr, xprop, xdpyinfo, glxinfo etc.
.TP
.B -@ 13 
- With data from dev, disks, partitions, etc., plus xiin data file.
.TP
.B -@ 14 
- Everything, full data collection


.SH SUPPORTED IRC CLIENTS  
.TP
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: 
/etc/inxi.conf 

$HOME/.inxi/inxi.conf 

See wiki pages for more information on how to set these up: 
.I http://code.google.com/p/inxi/wiki/script_configuration_files 

.SH BUGS 
Please report bugs using the following resources: 

inxi wiki, file an issue report: 
.I http://code.google.com/p/inxi/issues/list 

post on inxi developer forums: 
.I http://techpatterns.com/forums/forum-32.html 

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


.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

Further fixes (listed as known): Horst Tritremmel <hjt at sidux.com>

Steven Barrett (aka: damentz) - usb audio patch; swap percent used patch

Man page creator with help from Harald, aus9