X-Git-Url: https://notaz.gp2x.de/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=readme.txt;h=8bb2aae596056179d312a2f9e4ef93d94dfc3ef7;hb=3a836137bd76589725e60064bc4f923ff251ba53;hp=fbcacbd86fe90ea17b4fbfbf3f98d908c3e2271b;hpb=063ae4be6676b3b6c48183e3753238b05547b124;p=pandora_liveinfo.git diff --git a/readme.txt b/readme.txt index fbcacbd..8bb2aae 100644 --- a/readme.txt +++ b/readme.txt @@ -44,7 +44,49 @@ Fields T: 23.2C battery temperature +Configuration +------------- + +Currently only the layer's position can be changed by editing config.cfg +in appdata (file is automatically created on first run). + + +Controlling live info +--------------------- + +It's possible to hide Live info by sending it USR1 signal and show it +again by sending the same signal. This can be done by simply running +"killall -USR1 liveinfo" command. This command can also be bound to +xfce keyboard shortcuts or similar. + +Sending the TERM signal ("killall liveinfo") causes it to cleanly exit +(sending it KILL / -9 signal will leave the layer enabled and visible, +so is not recommended). + + +Showing custom fields and alternative control +--------------------------------------------- + +There is a tool called 'custom' included inside of .pnd, it can be used +to also send commands and display custom fields. The code is included +inside the .pnd and can be integrated in other programs, it's simple +communication over local/unix sockets. + +Any command containing a semicolon ":" is interpreted as a field to +display on screen. For example, running +./custom "fps: 60" +will show that string on screen. There is no removal command, the +string will time out by itself. + +Other understood commands are: + quit - self explanatory + hide + show + poke - if hidden, show up; if visible, exit + + License ------- -3-clause BSD. Source code included in pnd itself. +3-clause BSD, see COPYING file. +Source code is included in pnd itself.