mirror of
https://github.com/arcan1s/awesome-widgets.git
synced 2025-07-15 06:45:48 +00:00
edit supported information
update desktop panel to tag changes
This commit is contained in:
218
README.md
218
README.md
@ -1,79 +1,83 @@
|
||||
pytextmonitor
|
||||
=============
|
||||
awesome-widgets
|
||||
===============
|
||||
|
||||
Information
|
||||
-----------
|
||||
|
||||
PyTextMonitor is a minimalistic Plasmoid script written on Python2. It looks like widgets in awesome-wm.
|
||||
A collection of minimalistic widgets which looks like Awesome WM widgets.
|
||||
|
||||
**NOTE** [LOOKING FOR TRANSLATORS!](https://github.com/arcan1s/pytextmonitor/issues/14)
|
||||
**NOTE** [LOOKING FOR TRANSLATORS!](https://github.com/arcan1s/awesome-widgets/issues/14)
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
For edited output you must open Settings window and setup output format in lines:
|
||||
|
||||
* tag `$time` - time in default format. For example, *fri Nov 6 04:48:01 2013*
|
||||
* tag `$isotime` - time in iso format
|
||||
* tag `$shorttime` - time in short locale format
|
||||
* tag `$longtime` - time in long locale format
|
||||
* tag `$custom` - custom time format
|
||||
* tag `$uptime` - uptime, *---d--h--m*
|
||||
* tag `$custom` - custom uptime format
|
||||
* tag `$cpu` - total load cpu, *%*
|
||||
* tag `$cpuN` - load CPU for core N, *%*
|
||||
* tag `$cpucl` - average cpu clock, *MHz*
|
||||
* tag `$cpuclN` - cpu clock for core N, *MHz*
|
||||
* tag `$tempN` - temperature for device N. For example, `$temp0`
|
||||
* tag `$gpu` - GPU usage, *%*. `aticonfig` or `nvidia-smi` must be installed
|
||||
* tag `$gputemp` - GPU temperature. `aticonfig` or `nvidia-smi` must be installed
|
||||
* tag `$mem` - usage memory, *%*
|
||||
* tag `$memmb` - usage memory, *MB*
|
||||
* tag `$memgb` - usage memory, *GB*
|
||||
* tag `$memtotmb` - total RAM, *MB*
|
||||
* tag `$memtotgb` - total RAM, *GB*
|
||||
* tag `$swap` - swap, *%*
|
||||
* tag `$swapmb` - swap, *MB*
|
||||
* tag `$swapgb` - swap, *GB*
|
||||
* tag `$swaptotmb` - total swap, *MB*
|
||||
* tag `$swaptotgb` - total swap, *GB*
|
||||
* tag `$hddN` - usage for mount point N, *%*. For example, `$hdd0`
|
||||
* tag `$hddmbN` - usage for mount point N, *MB*. For example, `$hddmb0`
|
||||
* tag `$hddgbN` - usage for mount point N, *GB*. For example, `$hddgb0`
|
||||
* tag `$hddtotmbN` - total size of mount point N, *MB*. For example, `$hddtotmb0`
|
||||
* tag `$hddtotgbN` - total size of mount point N, *GB*. For example, `$hddtotgb0`
|
||||
* tag `$hddrN` - read speed of disk N, *KB/s*. For example, `$hddr0`
|
||||
* tag `$hddwN` - write speed of disk N, *KB/s*. For example, `$hddw0`
|
||||
* tag `$hddtempN` - temperature for HDD N. For example, `$hddtemp0`
|
||||
* tag `$down` - download speed, *KB/s*
|
||||
* tag `$up` - upload speed, *KB/s*
|
||||
* tag `$netdev` - current network device
|
||||
* tag `$bat` - battery charge, *%*
|
||||
* tag `$ac` - status AC device. Return (\*) if AC device is online or *( )* if offline
|
||||
* tag `$album` - current song album. One of supported music players must be installed
|
||||
* tag `$artist` - current song artist. One of supported music players must be installed
|
||||
* tag `$progress` - current song progress. One of supported music players must be installed
|
||||
* tag `$time` - current song duration. One of supported music players must be installed
|
||||
* tag `$title` - current song title. One of supported music players must be installed
|
||||
* tag `$pscount` - number of running processes
|
||||
* tag `$pstotal` - total number of processes
|
||||
* tag `$ps` - list of running processes
|
||||
* tag `$pkgcountN` - number of packages, which available to upgrade for command N. For example, `$pkgcount0`
|
||||
* tag `$customN` - returns output for custom command N. For example, `$custom0`
|
||||
* tag `$name` - name of the current desktop
|
||||
* tag `$number` - number of the current desktop
|
||||
* tag `$total` - total number of desktops
|
||||
|
||||
Label order will changed if you change slider position. HTML tags in label work normally.
|
||||
|
||||
**NOTE** you don't may set to show `$cpu` tag in swap label for example. **`$cpu` will work only in cpu label**.
|
||||
* tag `$time$` - time in default format. For example, *fri Nov 6 04:48:01 2013*
|
||||
* tag `$isotime$` - time in iso format
|
||||
* tag `$shorttime$` - time in short locale format
|
||||
* tag `$longtime$` - time in long locale format
|
||||
* tag `$ctime$` - custom time format
|
||||
* tag `$uptime$` - uptime, *---d--h--m*
|
||||
* tag `$cuptime$` - custom uptime format
|
||||
* tag `$cpu$` - total load cpu, *%*
|
||||
* tag `$cpuN$` - load CPU for core N, *%*
|
||||
* tag `$cpucl$` - average cpu clock, *MHz*
|
||||
* tag `$cpuclN$` - cpu clock for core N, *MHz*
|
||||
* tag `$tempN$` - temperature for device N. For example, `$temp0`
|
||||
* tag `$gpu$` - GPU usage, *%*. `aticonfig` or `nvidia-smi` must be installed
|
||||
* tag `$gputemp$` - GPU temperature. `aticonfig` or `nvidia-smi` must be installed
|
||||
* tag `$mem$` - usage memory, *%*
|
||||
* tag `$memmb$` - usage memory, *MB*
|
||||
* tag `$memgb$` - usage memory, *GB*
|
||||
* tag `$memfreemb$` - free RAM, *MB*
|
||||
* tag `$memfreegb$` - free RAM, *GB*
|
||||
* tag `$memtotmb$` - total RAM, *MB*
|
||||
* tag `$memtotgb$` - total RAM, *GB*
|
||||
* tag `$memusedmb$` - used and cached RAM, *MB*
|
||||
* tag `$memusedgb$` - used and cached RAM, *GB*
|
||||
* tag `$swap$` - swap, *%*
|
||||
* tag `$swapmb$` - swap, *MB*
|
||||
* tag `$swapgb$` - swap, *GB*
|
||||
* tag `$swapfreemb$` - free swap, *MB*
|
||||
* tag `$swapfreegb$` - free swap, *GB*
|
||||
* tag `$swaptotmb$` - total swap, *MB*
|
||||
* tag `$swaptotgb$` - total swap, *GB*
|
||||
* tag `$hddN$` - usage for mount point N, *%*. For example, `$hdd0`
|
||||
* tag `$hddmbN$` - usage for mount point N, *MB*. For example, `$hddmb0`
|
||||
* tag `$hddgbN$` - usage for mount point N, *GB*. For example, `$hddgb0`
|
||||
* tag `$hddfreembN$` - free space for mount point N, *MB*. For example, `$hddfreemb0`
|
||||
* tag `$hddfreegbN$` - free space for mount point N, *GB*. For example, `$hddfreegb0`
|
||||
* tag `$hddtotmbN$` - total size of mount point N, *MB*. For example, `$hddtotmb0`
|
||||
* tag `$hddtotgbN$` - total size of mount point N, *GB*. For example, `$hddtotgb0`
|
||||
* tag `$hddrN$` - read speed of disk N, *KB/s*. For example, `$hddr0`
|
||||
* tag `$hddwN$` - write speed of disk N, *KB/s*. For example, `$hddw0`
|
||||
* tag `$hddtempN$` - temperature for HDD N. For example, `$hddtemp0`
|
||||
* tag `$down$` - download speed, *KB/s*
|
||||
* tag `$up$` - upload speed, *KB/s*
|
||||
* tag `$netdev$` - current network device
|
||||
* tag `$bat$` - battery charge, *%*
|
||||
* tag `$ac$` - status AC device. Return (\*) if AC device is online or *( )* if offline
|
||||
* tag `$album$` - current song album. One of supported music players must be installed
|
||||
* tag `$artist$` - current song artist. One of supported music players must be installed
|
||||
* tag `$duration$` - current song duration. One of supported music players must be installed
|
||||
* tag `$progress$` - current song progress. One of supported music players must be installed
|
||||
* tag `$title$` - current song title. One of supported music players must be installed
|
||||
* tag `$pscount$` - number of running processes
|
||||
* tag `$pstotal$` - total number of processes
|
||||
* tag `$ps$` - list of running processes
|
||||
* tag `$pkgcountN$` - number of packages, which available to upgrade for command N. For example, `$pkgcount0`
|
||||
* tag `$customN$` - returns output for custom command N. For example, `$custom0`
|
||||
* tag `$desktop$` - name of the current desktop
|
||||
* tag `$ndesktop$` - number of the current desktop
|
||||
* tag `$tdesktops$` - total number of desktops
|
||||
|
||||
Tips & tricks
|
||||
-------------
|
||||
|
||||
You may use different colors for labels. Just put label text into html code. See [issue](https://github.com/arcan1s/pytextmonitor/issues/9) for more details.
|
||||
You may use different colors for labels. Just put label text into html code. See [issue](https://github.com/arcan1s/awesome-widgets/issues/9) for more details.
|
||||
|
||||
Numbering of elements of temperature, HDD usage, HDD speed, HDD temperature refers to elements order from second tab (*Advanced settings*). You should add item to the required listWidget first. And the first element in the listWidget will be `$tag0`. See [issue](https://github.com/arcan1s/pytextmonitor/issues/17) for more details.
|
||||
Numbering of elements of temperature, HDD usage, HDD speed, HDD temperature refers to elements order from second tab (*Advanced settings*). You should add item to the required listWidget first. And the first element in the listWidget will be `$tag0`. See [issue](https://github.com/arcan1s/awesome-widgets/issues/17) for more details.
|
||||
|
||||
Advanced settings
|
||||
-----------------
|
||||
@ -96,63 +100,55 @@ Add stretch (spacer) to the selected side of the widget.
|
||||
|
||||
**Custom time**
|
||||
|
||||
* tag `$dddd` - weekday in long format
|
||||
* tag `$ddd` - weekday in short format
|
||||
* tag `$dd` - day
|
||||
* tag `$d` - day without zero
|
||||
* tag `$MMMM` - month in long format
|
||||
* tag `$MMM` - month in short format
|
||||
* tag `$MM` - month
|
||||
* tag `$M` - month without zero
|
||||
* tag `$yyyy` - year
|
||||
* tag `$yy` - year in short format
|
||||
* tag `$hh` - hours
|
||||
* tag `$h` - hours without zero
|
||||
* tag `$mm` - minutes
|
||||
* tag `$m` - minutes without zero
|
||||
* tag `$ss` - seconds
|
||||
* tag `$s` - seconds without zero
|
||||
* tag `$dddd$` - weekday in long format
|
||||
* tag `$ddd$` - weekday in short format
|
||||
* tag `$dd$` - day
|
||||
* tag `$d$` - day without zero
|
||||
* tag `$MMMM$` - month in long format
|
||||
* tag `$MMM$` - month in short format
|
||||
* tag `$MM$` - month
|
||||
* tag `$M$` - month without zero
|
||||
* tag `$yyyy$` - year
|
||||
* tag `$yy$` - year in short format
|
||||
* tag `$hh$` - hours
|
||||
* tag `$h$` - hours without zero
|
||||
* tag `$mm$` - minutes
|
||||
* tag `$m$` - minutes without zero
|
||||
* tag `$ss$` - seconds
|
||||
* tag `$s$` - seconds without zero
|
||||
|
||||
**Custom uptime**
|
||||
|
||||
* tag `$dd` - uptime days
|
||||
* tag `$d` - uptime days without zero
|
||||
* tag `$hh` - uptime hours
|
||||
* tag `$h` - uptime hours without zero
|
||||
* tag `$mm` - uptime minutes
|
||||
* tag `$m` - uptime minutes without zero
|
||||
* tag `$dd$` - uptime days
|
||||
* tag `$d$` - uptime days without zero
|
||||
* tag `$hh$` - uptime hours
|
||||
* tag `$h$` - uptime hours without zero
|
||||
* tag `$mm$` - uptime minutes
|
||||
* tag `$m$` - uptime minutes without zero
|
||||
|
||||
**Temperature units**
|
||||
|
||||
Select units for temperature. Available units are Celsius, Farenheit and Kelvin.
|
||||
Select units for temperature. Available units are Celsius, Farenheit, Kelvin, Reaumur, cm^-1, kJ/mol, kcal/mol.
|
||||
|
||||
**Temperature devices**
|
||||
|
||||
List of devices, which will be observed in temp label (combo box items come from `sensors`). List widget is editable, delete key will remove current item.
|
||||
List of devices, which will be observed in temp label (items come from `sensors`). List widget is editable,
|
||||
|
||||
**Mount points**
|
||||
|
||||
List of mount points, which will be observed in hdd label (combo box items come from `mount`). List widget is editable, delete key will remove current item.
|
||||
List of mount points, which will be observed in hdd label (items come from `mount`). List widget is editable.
|
||||
|
||||
**HDD (speed)**
|
||||
|
||||
List of hard disk devices, which will be observed in hddspeed label (combo box items come from DataEngine). List widget is editable, delete key will remove current item.
|
||||
List of hard disk devices, which will be observed in hddspeed label (items come from DataEngine). List widget is editable.
|
||||
|
||||
**HDD (temperature)**
|
||||
|
||||
List of hard disk devices, which will be observed in hddtemp label (combo box items come from `find`). List widget is editable, delete key will remove current item.
|
||||
|
||||
**Network directory**
|
||||
|
||||
Path to directory, which contains network devices information. Default is `/sys/class/net`. Required for auto select network device.
|
||||
List of hard disk devices, which will be observed in hddtemp label (items come from `find`). List widget is editable.
|
||||
|
||||
**Network device**
|
||||
|
||||
Use specified device as active. Combo box items come from **network directory**. Will disable auto select network device.
|
||||
|
||||
**Battery device**
|
||||
|
||||
File with battery information. File (`/sys/class/power_supply/BAT0/capacity` by default) should contain only battery charge in percent.
|
||||
Use specified device as active. Will disable auto select network device.
|
||||
|
||||
**AC online tag**
|
||||
|
||||
@ -162,10 +158,6 @@ Line which will be shown when AC is online.
|
||||
|
||||
Line which will be shown when AC is offline.
|
||||
|
||||
**AC device**
|
||||
|
||||
File with AC information. File (`/sys/class/power_supply/AC/online` by default) must contain `1` if AC is online.
|
||||
|
||||
Tooltip settings
|
||||
----------------
|
||||
|
||||
@ -174,9 +166,15 @@ Since version 1.7.0 CPU, CPU clock, memory, swap and network labels support grap
|
||||
DataEngine settings
|
||||
-------------------
|
||||
|
||||
**Custom command**
|
||||
**AC device**
|
||||
|
||||
*NOTE* This can cause the computer freeze.
|
||||
File with AC information. File (`/sys/class/power_supply/AC/online` by default) must contain `1` if AC is online.
|
||||
|
||||
**Battery device**
|
||||
|
||||
File with battery information. File (`/sys/class/power_supply/BAT0/capacity` by default) should contain only battery charge in percent.
|
||||
|
||||
**Custom command**
|
||||
|
||||
Commands, which will be run for custom label.
|
||||
|
||||
@ -226,7 +224,7 @@ Select one of supported music playes for player label.
|
||||
PTM desktop panel
|
||||
=================
|
||||
|
||||
Since version 1.11.0 PyTextMonitor provides a minimalistic panel for monitoring on desktops written on `C++`. And yes, it looks like the same panel in Awesome.
|
||||
Since version 1.11.0 it provides a minimalistic panel for monitoring on desktops written on `C++`. And yes, it looks like the same panel in Awesome.
|
||||
|
||||
Desktop panel configuration
|
||||
---------------------------
|
||||
@ -249,14 +247,14 @@ Type symbol (or string) which will be shown if this desktop is active now.
|
||||
|
||||
**Pattern tags**
|
||||
|
||||
* tag `$mark` - show mark if this desktop is active
|
||||
* tag `$name` - name of the current desktop
|
||||
* tag `$number` - number of the current desktop
|
||||
* tag `$total` - total number of desktops
|
||||
* tag `$mark$` - show mark if this desktop is active
|
||||
* tag `$name$` - name of the current desktop
|
||||
* tag `$number$` - number of the current desktop
|
||||
* tag `$total$` - total number of desktops
|
||||
|
||||
**Command**
|
||||
|
||||
Type command which will be run on left click on the selected desktop. Available variables are same as for pattern. Default is `dbus org.kde.kwin /KWin setCurrentDesktop $number`.
|
||||
Type command which will be run on left click on the selected desktop. Available variables are same as for pattern. Default is `dbus org.kde.kwin /KWin setCurrentDesktop $number$`.
|
||||
|
||||
Instruction
|
||||
===========
|
||||
@ -307,7 +305,7 @@ TODO (wish list)
|
||||
Links
|
||||
-----
|
||||
|
||||
* [Homepage](http://arcanis.name/projects/pytextmonitor/)
|
||||
* [Homepage](http://arcanis.name/projects/awesome-widgets/)
|
||||
* Plasmoid on [kde-look](http://kde-look.org/content/show.php/Py+Text+Monitor?content=157124)
|
||||
* DataEngine on [kde-look](http://kde-look.org/content/show.php/Extended+Systemmonitor+DataEngine?content=158773)
|
||||
* Archlinux [AUR](https://aur.archlinux.org/packages/kdeplasma-applets-pytextmonitor/) package
|
||||
* Archlinux [AUR](https://aur.archlinux.org/packages/kdeplasma-applets-awesome-widgets/) package
|
||||
|
Reference in New Issue
Block a user