awesome-widgets/readme_diff.patch
2014-05-29 18:13:32 +04:00

158 lines
5.1 KiB
Diff

--- README.md.orig 2014-05-28 20:30:26.685205144 +0400
+++ README.md 2014-05-29 18:11:33.604651513 +0400
@@ -3,13 +3,16 @@
Information
-----------
+
PyTextMonitor is a minimalistic Plasmoid script written on Python2. It looks like widgets in awesome-wm.
**NOTE** [LOOKING FOR TRANSLATORS!](https://github.com/arcan1s/pytextmonitor/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
@@ -27,9 +30,13 @@
* 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`
@@ -56,8 +63,24 @@
**NOTE** you don't may set to show `$cpu` tag in swap label for example. **`$cpu` will work only in cpu label**.
+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.
+
+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.
+
Advanced settings
-----------------
+
+**Vertical layout**
+
+Use vertical layout instead of horizontal.
+
+**Enable popup**
+
+Uncheck box if you do not use popup messages.
+
**Custom time**
* tag `$dddd` - weekday in long format
@@ -130,16 +153,14 @@
File with AC information. File (`/sys/class/power_supply/AC/online` by default) must contain `1` if AC is online.
-**Music player**
-
-Select one of supported music playes for player label.
-
Tooltip settings
----------------
+
Since version 1.7.0 CPU, CPU clock, memory, swap and network labels support graphical tooltip. To enable them just make the needed checkboxes a fully checked. The number of stored values can be set in the tab. Colors of graphs are configurable too.
DataEngine settings
-------------------
+
**Custom command**
*NOTE* This can cause the computer freeze.
@@ -148,11 +169,15 @@
**GPU device**
-Select one of supported GPU devices. `auto` will enable auto selection. Default is `auto`.
+Select one of supported GPU devices. `auto` will enable auto selection, `disable` will disable definition of GPU states. Default is `auto`.
**HDD**
-Select one of HDDs for HDD temperature monitor. `all` will enable monitor for all devices. Default is `all`.
+Select one of HDDs for HDD temperature monitor. `all` will enable monitor for all devices, `disable` will disable definition of HDD temperature. Default is `all`.
+
+**hddtemp cmd**
+
+Type a command which will be run for hddtemp DataEngine. Default is `sudo hddtemp`.
**MPD address**
@@ -165,6 +190,7 @@
**Package manager**
List of commands, which will be run. Number of null lines is a number of unneeded lines. Defaults:
+
* *Arch*: `PKGCMD=pacman -Qu`, `PKGNULL=0`
* *Debian*: `PKGCMD=apt-show-versions -u -b`, `PKGNULL=0`
* *Ubuntu*: `PKGCMD=aptitude search '~U'`, `PKGNULL=0`
@@ -172,9 +198,13 @@
* *FreeBSD*: `PKGCMD=pkg_version -I -l '<'`, `PKGNULL=0`
* *Mandriva*: `PKGCMD=urpmq --auto-select`, `PKGNULL=0`
+**Music player**
+
+Select one of supported music playes for player label.
DataEngine configuration
------------------------
+
You may edit DataEngine configuration. It is `/usr/share/config/extsysmon.conf` or `$HOME/share/config/extsysmon.conf` depending on the type of installation. Uncomment needed line and edit it.
Instruction
@@ -182,25 +212,29 @@
Dependencies
------------
+
* kdebase-workspace
* kdebindings-python2
* lm_sensors (*for definition temperature device*)
-* sysstat (*for notification*)
Optional dependencies
---------------------
+
+* sysstat (*for notification*)
* proprietary video driver
* hddtemp (make sure that it may be run with `sudo` without password. Just add following line to `/etc/sudoers`: `$USERNAME ALL=NOPASSWD: /usr/bin/hddtemp`)
-* music player (amarok, mpd or qmmp)
+* music player (amarok, clementine, mpd or qmmp)
Make dependencies
-----------------
+
* automoc4
* cmake
* kdebase-runtime
Installation
------------
+
* download sources
* install
@@ -222,6 +256,7 @@
Links
-----
+
* [Homepage](http://arcanis.name/projects/pytextmonitor/)
* 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)