From 02579b3a1685a01872a57da6b45214b8e34a4862 Mon Sep 17 00:00:00 2001 From: inxi-svn Date: Sun, 6 May 2012 23:38:13 +0000 Subject: [PATCH] Added man pages, including the gz part. No idea why I forgot to do this, this is by aus9 by the way. So there's the man pages, needs some work, but at least it's something. --- inxi | 40 +++++- man/inxi.8 | 380 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 419 insertions(+), 1 deletion(-) create mode 100644 man/inxi.8 diff --git a/inxi b/inxi index c1e83f7..36d036f 100755 --- a/inxi +++ b/inxi @@ -146,6 +146,8 @@ ######################################################################## #### Valuable Resources #### gawk arrays: http://www.math.utah.edu/docs/info/gawk_12.html +#### raid mdstat: http://www-01.ibm.com/support/docview.wss?uid=isg3T1011259 +#### http://www.howtoforge.com/replacing_hard_disks_in_a_raid1_array ######################################################################## #### TESTING FLAGS #### inxi supports advanced testing triggers to do various things, using -! @@ -208,6 +210,7 @@ A_NETWORK_DATA='' A_OPTICAL_DRIVE_DATA='' A_PARTITION_DATA='' A_PS_DATA='' +A_RAID_DATA='' A_SENSORS_DATA='' A_UNMOUNTED_PARTITION_DATA='' A_X_DATA='' @@ -276,6 +279,7 @@ B_SHOW_PARTITIONS='false' B_SHOW_PARTITIONS_FULL='false' B_SHOW_PS_CPU_DATA='false' B_SHOW_PS_MEM_DATA='false' +B_SHOW_RAID='false' B_SHOW_REPOS='false' B_RUNNING_IN_X='false' B_SHOW_SENSORS='false' @@ -301,6 +305,7 @@ B_ASOUND_VERSION_FILE='false' B_BASH_ARRAY='false' B_CPUINFO_FILE='false' B_LSB_FILE='false' +B_MDSTAT_FILE='false' B_MEMINFO_FILE='false' B_MODULES_FILE='false' # B_MOUNTS_FILE='false' @@ -314,6 +319,7 @@ FILE_ASOUND_MODULES='/proc/asound/modules' # not used but maybe for -A? FILE_ASOUND_VERSION='/proc/asound/version' FILE_CPUINFO='/proc/cpuinfo' FILE_LSB_RELEASE='/etc/lsb-release' +FILE_MDSTAT='/proc/mdstat' FILE_MEMINFO='/proc/meminfo' FILE_MODULES='/proc/modules' FILE_MOUNTS='/proc/mounts' @@ -717,6 +723,10 @@ initialize_script_data() B_SHOW_X_DATA='true' B_RUNNING_IN_X='true' fi + + if [[ -e $FILE_MDSTAT ]];then + B_MDSTAT_FILE='true' + fi if [[ -e $FILE_MODULES ]];then B_MODULES_FILE='true' @@ -1789,7 +1799,7 @@ get_parameters() # no need to run through these if there are no args # reserved for future use: -g for extra Graphics; -m for extra Machine; -d for extra Disk elif [[ -n $1 ]];then - while getopts Abc:CdDfFGhHiIlMnNopPrsSt:uv:VxzZ%@:${update_flags} opt + while getopts Abc:CdDfFGhHiIlMnNopPrRsSt:uv:VxzZ%@:${update_flags} opt do case $opt in A) B_SHOW_AUDIO='true' @@ -1911,6 +1921,9 @@ get_parameters() r) B_SHOW_REPOS='true' use_short='false' ;; + R) B_SHOW_RAID='true' + use_short='false' + ;; s) B_SHOW_SENSORS='true' use_short='false' ;; @@ -1965,6 +1978,7 @@ get_parameters() B_SHOW_SENSORS='true' B_SHOW_LABELS='true' B_SHOW_UUIDS='true' + B_SHOW_RAID='true' fi if [[ $OPTARG -ge 6 ]];then B_SHOW_FULL_OPTICAL='true' @@ -2157,6 +2171,7 @@ show_options() print_screen_output "-P Show Partition information (shows what -v 4 would show, but without extra data)." print_screen_output " Shows, if detected: / /boot /home /tmp /usr /var. Use -p to see all mounted partitions." print_screen_output "-r Show distro repository data. Currently supported repo types: APT; PACMAN; PISI; YUM." + print_screen_output "-R (COMING - NEW FEATURE) Show RAID data. Shows RAID devices and components, and extra data with -x/-xx" print_screen_output "-s Show sensors output (if sensors installed/configured): mobo/cpu/gpu temp; detected fan speeds." print_screen_output " Gpu temp only for Fglrx/Nvidia drivers. Nvidia shows screen number for > 1 screens." print_screen_output "-S Show System information: host name, kernel, desktop environment (if in X), distro" @@ -2187,12 +2202,14 @@ show_options() print_screen_output " -I - Show system GCC, default. With -xx, also show other installed GCC versions." print_screen_output " -N -A - Adds version/port(s)/driver version (if available) for Network/Audio;" print_screen_output " -N -A -G - Network, audio, graphics, shows PCI Bus ID/Usb ID number of card;" + print_screen_output " -R - Show RAID chunk size" print_screen_output " -S - Desktop toolkit if avaliable (GNOME/XFCE/KDE only); Kernel gcc version" print_screen_output " -t - Adds memory use output to cpu (-xt c), and cpu use to memory (-xt m)." print_screen_output "-xx Show extra, extra data (only works with verbose or line output, not short form): " print_screen_output " -D - Adds disk serial number." print_screen_output " -I - Adds other detected installed gcc versions to primary gcc output (if present)." print_screen_output " -M - Adds chassis information, if any data for that is available." + print_screen_output " -R - Adds block count and algorythm used to RAID." print_screen_output " -xx -@ <11-14> - Automatically uploads debugger data tar.gz file to ftp.techpatterns.com." print_screen_output "-z Adds security filters for IP addresses, Mac, and user home directory name. Default on for irc clients." print_screen_output "-Z Absolute override for output filters. Useful for debugging networking issues in irc for example." @@ -5435,6 +5452,27 @@ get_ps_data() eval $LOGFE } +# mdstat syntax information: http://www-01.ibm.com/support/docview.wss?uid=isg3T1011259 +# note that this does NOT use either Disk or Partition information for now, ie, there +# is no connection between the data types, but the output should still be consistent +get_raid_data() +{ + eval $LOGFS + + local mdstat='' + + if [[ $B_MDSTAT_FILE ]];then + # dump the first line, which is not data + mdstat="$( grep -vi '^Personalities' $FILE_MDSTAT )" + fi + + if [[ -n $mdstat ]];then + : + fi + + eval $LOGFE +} + # Repos will be added as we get distro package manager data to create the repo data. # This method will output the file name also, which is useful to create output that's # neat and readable. diff --git a/man/inxi.8 b/man/inxi.8 new file mode 100644 index 0000000..f756268 --- /dev/null +++ b/man/inxi.8 @@ -0,0 +1,380 @@ +.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-A\fR] [\fB-b\fR] [\fB-C\fR] [\fB-d\fR] [\fB-D\fR] [\fB-f\fR] + +.B inxi \fR[\fB-F\fR] [\fB-G\fR] [\fB-h\fR] [\fB-H\fR] [\fB-i\fR] [\fB-I\fR] + +.B inxi \fR[\fB-l\fR] [\fB-M\fR] [\fB-n\fR] [\fB-N\fR] [\fB-o\fR] [\fB-p\fR] + +.B inxi \fR[\fB-P\fR] [\fB-r\fR] [\fB-s\fR] [\fB-S\fR] [\fB-u\fR] + +.B inxi \fR[\fB-c NUMBER\fR] + +.B inxi -t \fR[\fBc\fR or\fB m\fR or\fB cm\fR or\fB cm NUMBER\fR] + +.B inxi \fR[\fB-v NUMBER\fR] + +.B inxi \fR[\fB-x LETTER\fR] + +.B inxi \fR[\fB-xx LETTER\fR] + +.B inxi \fR[\fB--help\fR] + +.B inxi \fR[\fB--recommends\fR] + +.B inxi \fR[\fB--version\fR] + +.B inxi \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 or \fB94\fR-\fB99\fR] +Available color schemes. Scheme number is required. +Color selectors run a color selector option prior to inxi starting which lets +you set the config file value for the selection. + +Supported color schemes: 0-32, 94-99 + +\fB-c 0\fR-\fB32\fR are mainly in X windows colors + +-c 0 is no color. +.TP +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). +.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 + 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; PACMAN; PISI; YUM. +.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), partion 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): 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 -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 -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 -@ <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: inxi -! ftp.yourserver.com/incoming -xx@ 14 + +.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 +Irssi +.TP +Xchat +.TP +Konversation +.TP +BitchX +.TP +KSirc +.TP +.TP +ircII +.TP +Gaim/Pidgin +.TP +Weechat +.TP +KVIrc +.TP +Kopete + +.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-11 Scott Rogers & Harald Hope + +Further fixes (listed as known): Horst Tritremmel + +Steven Barrett (aka: damentz) - usb audio patch; swap percent used patch + + +.SH COPYRIGHT FOR CODE AND MANPAGE + +are released under GPL law of which full text of the GPL is here: +http://www.gnu.org/licenses/gpl.txt + +They are free software; you can redistribute them and/or modify them +under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 of the License, or +(at your option) any later version. + +They are distributed in the hope that they will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR +PURPOSE. See the GNU General Public License for more details. \ No newline at end of file