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

fixed man pages, made more consistent highlights for I and R types.

Browse source 
Updated weechat data to reflect that weechat is now like most other irc console clients
with /exec -o functionality.
This commit is contained in:
inxi-svn 2014-04-03 18:15:23 +00:00
parent 46308502e4
commit b981dbdcce
1 changed files with 26 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
inxi.1
View file

@ -22,7 +22,7 @@ be turned off if desired with \fB\-c 0\fR, or changed using the \fB\-c\fR color
.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 /home username directory in partitions,
your network card mac address, WAN and LAN IP, your \fI/home\fR 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 \fB\-z\fR
@ -111,7 +111,7 @@ may be added once enough data has been collected.
.TP
.B \-h
The help menu. Features dynamic sizing to fit into terminal window. Set script global \fBCOLS_MAX_CONSOLE\fR
if you want a different default value.
if you want a different default value, or use \fB-y <width>\fR to temporarily override the defaults or actual window width.
.TP
.B \-\-help
Same as \fB\-h\fR
@ -134,7 +134,7 @@ Show partition labels. Default: short partition \fB\-P\fR. For full \fB\-p\fR ou
.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. If using dmidecode,
Older systems/kernels without the required \fI/sys\fR data can use dmidecode instead, run as root. If using dmidecode,
may also show bios revision as well as version.
.TP
.B \-n
@ -147,7 +147,7 @@ Show Network card information. With \fB\-x\fR, shows PCI BusID, Port number.
.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):
added to \fI/etc/sudoers\fR (sudo v. 1.7 or newer):
.B <username> ALL = NOPASSWD: /usr/bin/file (sample)
@ -158,7 +158,7 @@ Show full partition information (\fB\-P\fR plus all other detected partitions).
.TP
.B \-P
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.
Shows, if detected: \fI/ /boot /home /tmp /usr /var\fR. Use \fB\-p\fR to see all mounted partitions.
.TP
.B \-r
Show distro repository data. Currently supported repo types:
@ -214,14 +214,14 @@ Show partition UUIDs. Default: short partition \fB\-P\fR. For full \fB\-p\fR out
Note \- Maintainer may have disabled this function.
If inxi \-h has no listing for U 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: \fB/usr/share/man/man8\fR
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.
.TP
.B \-V
inxi version information. Prints information then exits.
.TP
.B \-\-version
same as \fB\-V
same as \fB\-V\fR
.TP
.B \-v
Script verbosity levels. Verbosity level number is required. Should not be used with \fB\-b\fR or \fB\-F\fR.
@ -242,7 +242,7 @@ Supported levels: \fB0\-7\fR Examples :\fB inxi \-v 4 \fR or \fB inxi \-v4\fR
\- 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 (\fB\-P\fR) for (if present):/, /home, /var/, /boot
\- Adds partition size/filled data (\fB\-P\fR) for (if present):\fI/ /home /var/ /boot\fR
Shows full disk data (\fB\-D\fR)
.TP
.B \-v 5
@ -254,25 +254,25 @@ optical drives.
triggers \fB\-xx\fR extra data option.
.TP
.B \-v 7
\- Adds network IP data (\fB\-i\fR); triggers \fB\-xxx
\- Adds network IP data (\fB\-i\fR); triggers \fB\-xxx\fR
.TP
.B \-w
Adds weather line. Note, this depends on an unreliable api so it may not always be working in the future.
To get weather for an alternate location, use \-W <location_string>. See also \-x, \-xx, \-xxx option.
Please note, your distribution's maintainer may chose to disable this feature, so if \-w or \-W don't work, that's why.
To get weather for an alternate location, use \fB\-W <location_string>\fR. See also \fB\-x\fR, \fB\-xx\fR, \fB\-xxx\fR option.
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 '+' sign. No spaces around , (comma).
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.
Examples: \fB\-W 95623\fR OR \fB\-W Boston,MA\fR OR \fB\-W45.5234,\-122.6762\fR OR \fB\-W new+york,ny\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 \-h or \-c 94-99, put \-y option first or the override will be ignored. Cannot be used with \-\-help/\-\-version/\-\-recommends type long options. Example: \fBinxi \-y 130\fR
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
Adds security filters for IP addresses, Mac, location (\-w), and user home directory name. Default on for irc clients.
Adds security filters for IP addresses, Mac, location (\fB\-w\fR), 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.
@ -305,7 +305,7 @@ The following shows which lines / items get extra information with each extra da
.TP
.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):
\fI/etc/sudoers\fR (sudo v. 1.7 or newer):
.B <username> ALL = NOPASSWD: /usr/sbin/hddtemp (sample)
.TP
@ -445,7 +445,7 @@ For alternate ftp upload locations: Example:
.TP
.B \-@ 11
\- With data file of xiin read of /sys
\- With data file of xiin read of \fI/sys
.TP
.B \-@ 12
\- With xorg conf and log data, xrandr, xprop, xdpyinfo, glxinfo etc.
@ -477,15 +477,20 @@ create this symbolic link:
.B ln \-s /usr/local/bin/inxi /usr/share/kde4/apps/konversation/scripts/inxi
If inxi is somewhere else, change the path /usr/local/bin to wherever it is located.
If inxi is somewhere else, change the path \fI/usr/local/bin\fR to wherever it is located.
Then you can start inxi directly, like this:
.B /inxi \fR[\fBoptions\fR]
.TP
.B WeeChat
.B /shell \-o inxi \fR[\fBoptions\fR]
.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]
Deprecated:
Before WeeChat can run external scripts like inxi, you need to install the
weechat\-plugins package. This is automatically installed for Debian users.
Next, if you don't already have it, you need to install shell.py,
@ -514,9 +519,9 @@ users may also like to check out the weeget.py
.TP
inxi will read the following configuration/initialization files in the following order:
.TP
.B /etc/inxi.conf
.I /etc/inxi.conf
.TP
.B $HOME/.inxi/inxi.conf
.I $HOME/.inxi/inxi.conf
.TP
See wiki pages for more information on how to set these up:
.TP