[pandora_liveinfo.git] / readme.txt

Live info
---------

This is a tool that shows CPU, memory, I/O, network and battery
information on an always-visible layer, updated once a second.
Uses system-reserved OMAP hardware layer, so should be visible
in most programs that don't use tv-out (tv-out needs that same
layer to send video to TV).

When you want to exit Live info, just run this pnd again.


Fields
------

 17:40:05    real time clock, hours:minutes:seconds

 CPU:  100%  total CPU usage, in percent
 SYS:    0%  CPU usage by the kernel only
 IRQ:   29   CPU interrupts per second
 CS:    30   CPU context switches per second
 f:   1000M  CPU clock frequency, in MHz
 V:  1.375V  CPU voltage

 mem
 M:    414M  free RAM, in megabytes
 S:    125M  free swap space, in megabytes
 H:      0M  memory used in huge pages, MB (only shown if nonzero)

 i/o
 R:  0.0M/s  current read throughput from SD cards, in megabytes/s
 W:  0.0M/s  current write throughput to SD cards, in megabytes/s

 net
 D:    0K/s  download throughput, kilobytes/s
 U:    0K/s  upload throughput, kilobytes/s
 S:  -45dBm  wifi signal strength, in dBm

 batt
 C:     91%  estimated battery charge level (from monitoring chip)
 t:  13:14   estimated time to empty/full, hours:minutes
 V:  3.960V  current battery voltage
 P: -1.140W  electric power going into battery, negative means discharge
 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, see COPYING file.
Source code is included in pnd itself.
Commit	Line	Data
063ae4be	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
3a836137	47	Configuration
	48	-------------
	49
	50	Currently only the layer's position can be changed by editing config.cfg
	51	in appdata (file is automatically created on first run).
	52
	53
b7d8fc1a	54	Controlling live info
	55	---------------------
	56
	57	It's possible to hide Live info by sending it USR1 signal and show it
	58	again by sending the same signal. This can be done by simply running
	59	"killall -USR1 liveinfo" command. This command can also be bound to
	60	xfce keyboard shortcuts or similar.
3a836137	61
b7d8fc1a	62	Sending the TERM signal ("killall liveinfo") causes it to cleanly exit
	63	(sending it KILL / -9 signal will leave the layer enabled and visible,
	64	so is not recommended).
	65
	66
	67	Showing custom fields and alternative control
	68	---------------------------------------------
	69
	70	There is a tool called 'custom' included inside of .pnd, it can be used
	71	to also send commands and display custom fields. The code is included
	72	inside the .pnd and can be integrated in other programs, it's simple
	73	communication over local/unix sockets.
	74
	75	Any command containing a semicolon ":" is interpreted as a field to
	76	display on screen. For example, running
	77	./custom "fps: 60"
	78	will show that string on screen. There is no removal command, the
	79	string will time out by itself.
	80
	81	Other understood commands are:
	82	quit - self explanatory
	83	hide
	84	show
	85	poke - if hidden, show up; if visible, exit
	86
	87
063ae4be	88	License
	89	-------
	90
3a836137	91	3-clause BSD, see COPYING file.
3a836137	92	Source code is included in pnd itself.