update readme

This commit is contained in:
arcan1s
2014-09-08 01:57:18 +04:00
parent ab966504cc
commit 5406f6f66f

178
README.md
View File

@ -13,64 +13,64 @@ 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 `$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
* 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
-------------
@ -86,45 +86,37 @@ Advanced settings
Uncheck to disable default background and set transparent one.
**Vertical layout**
Use vertical layout instead of horizontal one.
**Enable popup**
Uncheck box if you do not use popup messages.
**Add stretch**
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**
@ -247,14 +239,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
===========