new tarball, added colors to man page to make it more readable and consistent, mostly highlighting options and commands.

This commit is contained in:
inxi-svn 2012-06-24 21:58:46 +00:00
parent e616482324
commit fa2c8a4617

115
inxi.8
View file

@ -18,7 +18,7 @@ hardware, CPU, drivers, Xorg, Desktop, Kernel, GCC version(s), Processes, RAM us
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 -c 0, or changed using the -c 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 RUNNING IN IRC CLIENT
To trigger inxi output in your IRC client, pick the appropriate method from the list below:
@ -27,7 +27,7 @@ To trigger inxi output in your IRC client, pick the appropriate method from the
.B Xchat, irssi \fR(and many other IRC clients)
.B /exec -o inxi \fR[\fBoptions\fR]
If you leave off the -o, 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
.B Konversation
.B /cmd inxi \fR[\fBoptions\fR]
@ -55,7 +55,7 @@ Then to run inxi, you would enter a comand like this:
.B /shell -o inxi -bx
If you leave off the -o, only you will see the output on your local weechat.
If you leave off the \fB-o\fR, only you will see the output on your local weechat.
.SH PRIVACY AND SECURITY
@ -63,8 +63,8 @@ In order to maintain basic privacy and security, inxi filters out automatically
your network card mac address, WAN and LAN IP, your /home 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 -z
option (-Fz, for example). To override the IRC filter, you can use the -Z option. This can be useful
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
@ -72,10 +72,10 @@ to debug network connection issues online in a private chat, for example.
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
Letters with numbers can have no gap or a gap at your discretion unless using \fB -t\fR.
eg
.I inxi -AG \fRor\fI inxi -A -G \fRor\fI inxi -c10
For example:
.B inxi -AG\fR or \fBinxi -A -G\fR or \fBinxi -c10
.SH STANDARD OPTIONS
@ -84,12 +84,12 @@ eg
Show Audio/sound card information.
.TP
.B -b
Shows basic output, short form (previously -d). Same as: inxi -v 2
Shows basic output, short form (previously \fB-d\fR). Same as: \fBinxi -v 2
.TP
.B -c \fR[\fB0\fR-\fB32\fR]
Available color schemes. Scheme number is required.
Supported color schemes: 0-32.
Supported color schemes: \fB0-32
.TP
.B -c \fR[\fB94\fR-\fB99\fR]
@ -120,19 +120,19 @@ Setting specific removes global.
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.
Shows optical drive data. Same as \fB-Dd\fR. With \fB-x\fR, adds features line to output.
\fB-xx\fR adds a few more features.
.TP
.B -D
Show full hard Disk info, not only model, ie: /dev/sda ST380817AS 80.0GB.
Show full hard Disk info, not only model, ie: \fI/dev/sda ST380817AS 80.0GB.
.TP
.B -f
Show all cpu flags used, not just the short list. Not shown with -F to avoid
Show all cpu flags used, not just the short list. Not shown with \fB-F\fR 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
Show Full output for inxi. Includes all Upper Case line letters, plus \fB-s\fR and \fB-n\fR.
Does not show extra verbose options like \fB-x -d -f -u -l -o -p -t -r\fR unless you use
that argument.
.TP
.B -G
@ -142,7 +142,7 @@ Show Graphic card information (card, x type, resolution, glx renderer, version).
This help menu.
.TP
.B --help
Same as -h
Same as \fB-h\fR
.TP
.B -H
This help menu, plus developer options. Do not use dev options in normal
@ -150,38 +150,39 @@ 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
Same as -Nni. Not shown with \fB-F\fR 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).
Show partition labels. Default: short partition \fB-P\fR. For full \fB-p\fR output, use: \fB-pl\fR (or \fB-plu\fR).
.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,
Show Advanced Network card information. Same as \fB-Nn\fR. Shows interface, speed,
mac id, state, etc.
.TP
.B -N
Show Network card information. With -x, shows PCI BusID, Port number.
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):
<username> ALL = NOPASSWD: /usr/bin/file (sample)
.B <username> ALL = NOPASSWD: /usr/bin/file (sample)
.TP
.B -p
Show full partition information (-P plus all other detected partitions).
Show full partition information (\fB-P\fR 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.
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.
.TP
.B -r
Show distro repository data. Currently supported repo types:
@ -197,7 +198,7 @@ YUM. (Fedora, Redhat, maybe Suse + derived versions)
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.
Show RAID data. Shows RAID devices, states, levels, and components, and extra data with \fB-x\fR / \fB-xx\fR.
If device is resyncing, shows resync progress line as well.
.TP
.B --recommends
@ -212,6 +213,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
.TP
.B -t \fR[\fBc\fR or\fB m\fR or\fB cm\fR or\fB cm NUMBER\fR]\fR- Show processes.
If followed by numbers \fB1-20\fR, shows that number of processes for each type
(default: 5; if in irc, max: 5)
.TP
.B -t c
cpu
@ -221,15 +224,12 @@ memory
.TP
.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)
Make sure to have
.I no space
.R between letters and numbers (-t cm10 -right, -t cm 10 -wrong).
.R between letters and numbers (\fB-t cm10\fR -right, \fB-t cm 10\fR -wrong).
.TP
.B -u
Show partition UUIDs. Default: short partition -P. For full -p output, use: -pu (or -plu).
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
Auto-update script. Note: if you installed as root, you must be root to update,
@ -239,40 +239,40 @@ otherwise user is fine.
inxi version information. Prints information then exits.
.TP
.B --version
same as -V
same as \fB-V
.TP
.B -v
Script verbosity levels. Verbosity level number is required. Should not be used with -b or -F.
Script verbosity levels. Verbosity level number is required. Should not be used with \fB-b\fR or \fB-F\fR.
Supported levels: 0-7 Examples :\fI inxi -v 4 \fR or \fI inxi -v4
Supported levels: \fB0-7\fR Examples :\fB inxi -v 4 \fR or \fB inxi -v4\fR
.TP
.B -v 0
- Short output, same as: inxi
- Short output, same as: \fBinxi\fR
.TP
.B -v 1
- Basic verbose, -S + basic CPU + -G + basic Disk + -I.
- Basic verbose, \fB-S\fR + basic CPU + \fB-G\fR + basic Disk + \fB-I\fR.
.TP
.B -v 2
- Adds networking card (-N), Machine (-M) data, and shows basic hard disk data
(names only). Same as: inxi -b
- Adds networking card (\fB-N\fR), Machine (\fB-M\fR) data, and shows basic hard disk data
(names only). Same as: \fBinxi -b
.TP
.B -v 3
- Adds advanced CPU (-C); network (-n) data; triggers -x advanced data option.
- 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 (-P) for (if present):/, /home, /var/, /boot
Shows full disk data (-D)
- Adds partition size/filled data (\fB-P\fR) for (if present):/, /home, /var/, /boot
Shows full disk data (\fB-D\fR)
.TP
.B -v 5
- Adds audio card (-A); sensors (-s), partition label (-l) and UUID (-u), short form of
- Adds audio card (\fB-A\fR); sensors (\fB-s\fR), partition label (\fB-l\fR) and UUID (\fB-u\fR), short form of
optical drives.
.TP
.B -v 6
- Adds full partition data (-p), unmounted partition data (-o), optical drive data (-d);
triggers -xx extra data option.
- Adds full partition data (\fB-p\fR), unmounted partition data (\fB-o\fR), optical drive data (\fB-d\fR);
triggers \fB-xx\fR extra data option.
.TP
.B -v 7
- Adds network IP data (-i); triggers -xxx.
- Adds network IP data (\fB-i\fR); triggers \fB-xxx.
.TP
.B -z
Adds security filters for IP addresses, Mac, and user home directory name. Default on for irc clients.
@ -282,14 +282,14 @@ Absolute override for output filters. Useful for debugging networking issues in
.SH EXTRA DATA OPTIONS
These options are for long form only, and can be triggered by one or more -x, like -xx.
Alternately, the -v options trigger them in the following way:
-v 3 adds -x; -v 6 adds -xx; -v 7 adds -xxx
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
These extra data triggers can be useful for getting more in-depth data on various options.
Can be added to any long form option list, like: -bxx or -Sxxx
Can be added to any long form option list, like: \fB-bxx\fR or \fB-Sxxx\fR
There are 3 extra data levels: -x; -xx; and -xxx
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.
@ -304,7 +304,7 @@ The following shows which lines / items get extra information with each extra da
- 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 <username> ALL = NOPASSWD: /usr/sbin/hddtemp (sample)
.TP
.B -x -G
- Direct rendering status for Graphics (in X).
@ -330,7 +330,7 @@ The following shows which lines / items get extra information with each extra da
- Desktop toolkit if avaliable (GNOME/XFCE/KDE only); Kernel gcc version
.TP
.B -x -t
- Adds memory use output to cpu (-xt c), and cpu use to memory (-xt m).
- Adds memory use output to cpu (\fB-xt c\fR), and cpu use to memory (\fB-xt m\fR).
.TP
.B -xx -D
- Adds disk serial number
@ -351,7 +351,7 @@ resync progress line as well
Supports most known display managers, like xdm, gdm, kdm, slim, lightdm, or mdm.
.TP
.B -xx -@ <11-14>
- Automatically uploads debugger data tar.gz file to ftp.techpatterns.com.
- Automatically uploads debugger data tar.gz file to \fIftp.techpatterns.com\fR.
.TP
.B -xxx -S
- Adds, if run in X, shell/panel type info to Desktop information, if present. If none, shows nothing.
@ -363,7 +363,7 @@ Supports some current desktop extras like gnome-panel, lxde-panel, and others. A
Overrides defective or corrupted data.
.TP
.B -@
Triggers debugger output. Requires debugging level 1-14 (8-10 - 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.
.TP
.B -@ \fR[\fB1\fR-\fB7\fR]
@ -380,10 +380,10 @@ 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 ftp.techpatterns.com: inxi -xx@ <11-14>
To automatically upload debugger data tar.gz file to \fIftp.techpatterns.com\fR: \fBinxi -xx@ <11-14>\fR
For alternate ftp upload locations: Example:
\fIinxi -! ftp.yourserver.com/incoming -xx@ 14\fR
\fBinxi -! \fIftp.yourserver.com/incoming\fB -xx@ 14\fR
.TP
.B -@ 11
@ -433,7 +433,8 @@ You can also visit
.I irc.oftc.net channel: #smxi
to post issues.
.SH HOMEPAGE: \fI http://code.google.com/p/inxi
.SH HOMEPAGE
.I http://code.google.com/p/inxi
.SH AUTHOR AND CONTRIBUTORS TO CODE