small fixes in README and adding of gitignore
This commit is contained in:
parent
f119cd4401
commit
7aa1bac13c
|
@ -0,0 +1 @@
|
||||||
|
*~
|
18
README.md
18
README.md
|
@ -152,7 +152,7 @@ Supported platforms: Linux (required tools: `sysfs`), FreeBSD (required tools:
|
||||||
level in percent, 3rd as remaining (charging or discharging) time and 4th
|
level in percent, 3rd as remaining (charging or discharging) time and 4th
|
||||||
as the wear level in percent
|
as the wear level in percent
|
||||||
* FreeBSD: see Linux, but there's is 5th value for the present dis-/charge
|
* FreeBSD: see Linux, but there's is 5th value for the present dis-/charge
|
||||||
rate in mW.
|
rate in Watt.
|
||||||
|
|
||||||
**vicious.widgets.cpu**
|
**vicious.widgets.cpu**
|
||||||
|
|
||||||
|
@ -276,7 +276,7 @@ Supported platforms: platform independent.
|
||||||
* takes the full path to the mbox as an argument, or a table with 1st field
|
* takes the full path to the mbox as an argument, or a table with 1st field
|
||||||
as path, 2nd as maximum length and 3rd (optional) as widget name - if 3rd
|
as path, 2nd as maximum length and 3rd (optional) as widget name - if 3rd
|
||||||
field is present scrolling will be used (note: the path will be escaped so
|
field is present scrolling will be used (note: the path will be escaped so
|
||||||
special variables like ~ will not work, use os.getenv("HOME").."mail"
|
special variables like `~` will not work, use `os.getenv("HOME").."mail"`
|
||||||
instead to access environment variables)
|
instead to access environment variables)
|
||||||
- Returns:
|
- Returns:
|
||||||
* returns 1st value as the subject of the last e-mail
|
* returns 1st value as the subject of the last e-mail
|
||||||
|
@ -387,8 +387,8 @@ correct number of updates.
|
||||||
Supported platforms: platform independent.
|
Supported platforms: platform independent.
|
||||||
|
|
||||||
- Arguments:
|
- Arguments:
|
||||||
* takes the Linux or BSD distribution name as an argument, i.e. "Arch",
|
* takes the Linux or BSD distribution name as an argument, i.e. `"Arch"`,
|
||||||
"FreeBSD"
|
`"FreeBSD"`
|
||||||
- Returns:
|
- Returns:
|
||||||
* returns 1st value as the count of available updates
|
* returns 1st value as the count of available updates
|
||||||
|
|
||||||
|
@ -411,9 +411,9 @@ Supported platforms: Linux, FreeBSD.
|
||||||
- Arguments (per platform):
|
- Arguments (per platform):
|
||||||
* Linux: takes the thermal zone as an argument, i.e. `"thermal_zone0"`, or a
|
* Linux: takes the thermal zone as an argument, i.e. `"thermal_zone0"`, or a
|
||||||
table with 1st field as thermal zone, 2nd as data source - available data
|
table with 1st field as thermal zone, 2nd as data source - available data
|
||||||
sources are "proc", "core" and "sys" (which is the default when only the
|
sources are `"proc"`, `"core"` and `"sys"` (which is the default when only
|
||||||
zone is provided) and 3rd optional argument as a temperature input file to
|
the zone is provided) and 3rd optional argument as a temperature input
|
||||||
read
|
file to read
|
||||||
* FreeBSD: takes the full sysctl path to a thermal zone as an argument, i.e.
|
* FreeBSD: takes the full sysctl path to a thermal zone as an argument, i.e.
|
||||||
`"hw.acpi.thermal.tz0.temperature"`, or a table with multiple paths
|
`"hw.acpi.thermal.tz0.temperature"`, or a table with multiple paths
|
||||||
- Returns:
|
- Returns:
|
||||||
|
@ -466,7 +466,7 @@ Provides wireless information for a requested interface.
|
||||||
Supported platforms: Linux.
|
Supported platforms: Linux.
|
||||||
|
|
||||||
- Arguments:
|
- Arguments:
|
||||||
* Takes the network interface as an argument, i.e. "wlan0"
|
* Takes the network interface as an argument, i.e. `"wlan0"`
|
||||||
- Returns:
|
- Returns:
|
||||||
* Returns a table with string keys: `{ssid}`, `{mode}`, `{chan}`, `{rate}`,
|
* Returns a table with string keys: `{ssid}`, `{mode}`, `{chan}`, `{rate}`,
|
||||||
`{link}`, `{linp}` (link quality in percent) and `{sign}` (signal level)
|
`{link}`, `{linp}` (link quality in percent) and `{sign}` (signal level)
|
||||||
|
@ -478,7 +478,7 @@ vicious.widgets.wifi, but uses iw instead of iwconfig).
|
||||||
Supported platforms: Linux.
|
Supported platforms: Linux.
|
||||||
|
|
||||||
- Arguments:
|
- Arguments:
|
||||||
* Takes the network interface as an argument, i.e. "wlan0"
|
* Takes the network interface as an argument, i.e. `"wlan0"`
|
||||||
- Returns:
|
- Returns:
|
||||||
* Returns a table with string keys: `{ssid}`, `{mode}`, `{chan}`, `{rate}`,
|
* Returns a table with string keys: `{ssid}`, `{mode}`, `{chan}`, `{rate}`,
|
||||||
`{freq}`, `{linp}` (link quality in percent), `{txpw}` (tx power) and
|
`{freq}`, `{linp}` (link quality in percent), `{txpw}` (tx power) and
|
||||||
|
|
Loading…
Reference in New Issue