commands over unix socket
[pandora_liveinfo.git] / readme.txt
1 Live info
2 ---------
3
4 This is a tool that shows CPU, memory, I/O, network and battery
5 information on an always-visible layer, updated once a second.
6 Uses system-reserved OMAP hardware layer, so should be visible
7 in most programs that don't use tv-out (tv-out needs that same
8 layer to send video to TV).
9
10 When you want to exit Live info, just run this pnd again.
11
12
13 Fields
14 ------
15
16  17:40:05    real time clock, hours:minutes:seconds
17
18  CPU:  100%  total CPU usage, in percent
19  SYS:    0%  CPU usage by the kernel only
20  IRQ:   29   CPU interrupts per second
21  CS:    30   CPU context switches per second
22  f:   1000M  CPU clock frequency, in MHz
23  V:  1.375V  CPU voltage
24
25  mem
26  M:    414M  free RAM, in megabytes
27  S:    125M  free swap space, in megabytes
28  H:      0M  memory used in huge pages, MB (only shown if nonzero)
29
30  i/o
31  R:  0.0M/s  current read throughput from SD cards, in megabytes/s
32  W:  0.0M/s  current write throughput to SD cards, in megabytes/s
33
34  net
35  D:    0K/s  download throughput, kilobytes/s
36  U:    0K/s  upload throughput, kilobytes/s
37  S:  -45dBm  wifi signal strength, in dBm
38
39  batt
40  C:     91%  estimated battery charge level (from monitoring chip)
41  t:  13:14   estimated time to empty/full, hours:minutes
42  V:  3.960V  current battery voltage
43  P: -1.140W  electric power going into battery, negative means discharge
44  T:   23.2C  battery temperature
45
46
47 Controlling live info
48 ---------------------
49
50 It's possible to hide Live info by sending it USR1 signal and show it
51 again by sending the same signal. This can be done by simply running
52 "killall -USR1 liveinfo" command. This command can also be bound to
53 xfce keyboard shortcuts or similar.
54 Sending the TERM signal ("killall liveinfo") causes it to cleanly exit
55 (sending it KILL / -9 signal will leave the layer enabled and visible,
56 so is not recommended).
57
58
59 Showing custom fields and alternative control
60 ---------------------------------------------
61
62 There is a tool called 'custom' included inside of .pnd, it can be used
63 to also send commands and display custom fields. The code is included
64 inside the .pnd and can be integrated in other programs, it's simple
65 communication over local/unix sockets.
66
67 Any command containing a semicolon ":" is interpreted as a field to
68 display on screen. For example, running
69 ./custom "fps: 60"
70 will show that string on screen. There is no removal command, the
71 string will time out by itself.
72
73 Other understood commands are:
74   quit   - self explanatory
75   hide
76   show
77   poke   - if hidden, show up; if visible, exit
78
79
80 License
81 -------
82
83 3-clause BSD. Source code included in pnd itself.