Yes another edit readme

This commit is contained in:
arcan1s 2013-11-06 01:54:35 +04:00
parent 4689a9054d
commit ddf1de6f8e

View File

@ -8,30 +8,30 @@ PyTextMonitor is a minimalistic Plasmoid script written on Python2. It looks lik
Configuration
-------------
For edited output you must open Settings window and setup output format in lines:
* label "$uptime" means uptime, ---d--h--m
* label "$cpu" means total load cpu, %
* label "$ccpu" means load CPU for each core, %
* label "$cpucl" - average cpu clock, MHz
* label "$ccpucl" - cpu clock for each core, MHz
* label "$temp" - average temperature in system
* label "$gpu" - GPU usage, %. `aticonfig` or `nvidia-smi` must be installed
* label "$gputemp" - GPU temperature. `aticonfig` or `nvidia-smi` must be installed
* label "$mem" - usage memory, %
* label "$memmb" - usage memory, MB
* label "$swap" - swap, %
* label "$swapmb" - swap, MB
* label "@@/@@" (in hdd label) - mount point ('/' in example) usage, %. Separator for mount points list is ';', for example "@@/;/home;/mnt/global@@". `hddtemp` must be installed
* label "@@/dev/sda@@" (in hddtemp label) - HDD ('/dev/sda' in example) temperature
* label "$net" - download and upload speed, KB/s. You may specify network device: something like @@eth0@@
* label "$netdev" - current network device
* label "$bat" - battery charge, %. Battery device may be set below. File ("/sys/class/power_supply/BAT0/capacity" by default) must contain only battery charge in percent
* label "$ac" - status AC device. Return (*) if AC device is online or ( ) if offline. AC device may be set below. FIle ("/sys/class/power_supply/AC/online" by default) must contain '1' if AC is online
* label "$artist" - current song artist. One of supported music players must be installed
* label "$title" - current song title. One of supported music players must be installed
* label `$uptime` means uptime, <i>---d--h--m</i>
* label `$cpu` means total load cpu, <i>%</i>
* label `$ccpu` means load CPU for each core, <i>%</i>
* label `$cpucl` - average cpu clock, <i>MHz</i>
* label `$ccpucl` - cpu clock for each core, <i>MHz</i>
* label `$temp` - average temperature in system
* label `$gpu` - GPU usage, <i>%</i>. `aticonfig` or `nvidia-smi` must be installed
* label `$gputemp` - GPU temperature. `aticonfig` or `nvidia-smi` must be installed
* label `$mem` - usage memory, <i>%</i>
* label `$memmb` - usage memory, <i>MB</i>
* label `$swap` - swap, <i>%</i>
* label `$swapmb` - swap, <i>MB</i>
* label `@@/@@` (in hdd label) - mount point (`/` in example) usage, <i>%</i>. Separator for mount points list is `;`, for example `@@/;/home;/mnt/global@@`
* label `@@/dev/sda@@` (in hddtemp label) - HDD (`/dev/sda` in example) temperature. `hddtemp` must be installed
* label `$net` - download and upload speed, <i>KB/s</i>. You may specify network device: something like `@@eth0@@`
* label `$netdev` - current network device
* label `$bat` - battery charge, <i>%</i>. Battery device may be set below. File (`/sys/class/power_supply/BAT0/capacity` by default) must contain only battery charge in percent
* label `$ac` - status AC device. Return <i>(*)</i> if AC device is online or <i>( )</i> if offline. AC device may be set below. FIle (`/sys/class/power_supply/AC/online` by default) must contain `1` if AC is online
* label `$artist` - current song artist. One of supported music players must be installed
* label `$title` - current song title. One of supported music players must be installed
Label order will changed if you change slider position. HTML tags in label work normally.
**NOTE** you don't may set to show $cpu in swap label for example. $cpu will work only in cpu label.
**NOTE** you don't may set to show $cpu in swap label for example. <b>$cpu will work only in cpu label</b>.
TODO (wish) list
----------------
@ -70,24 +70,22 @@ Installation
* download sources
* install dataengine
mkdir build && cd build
mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=`kde4-config --localprefix` ../
make && make install
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=`kde4-config --localprefix` ../
Also you may install it to "/":
make && make install
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=`kde4-config --prefix` ../
make && sudo make install
Also you may install it to "/":
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=`kde4-config --prefix` ../
make && sudo make install
* install plasmoid
plasmapkg -i py-text-monitor-1.5.0.plasmoid
plasmapkg -i py-text-monitor-1.5.0.plasmoid
Also you may install it to "/" too:
Also you may install it to "/" too:
plasmapkg -g -i py-text-monitor-1.5.0.plasmoid
plasmapkg -g -i py-text-monitor-1.5.0.plasmoid
Additional information
======================