1 .\"
2 .\" Copyright (c) 2023 Benjamin Stürz
3 .\"
4 .\" Permission to use, copy, modify, and distribute this software for any
5 .\" purpose with or without fee is hereby granted, provided that the above
6 .\" copyright notice and this permission notice appear in all copies.
7 .\"
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 .\"
16 .Dd $Mdocdate$
17 .Dt APMTOP 1
18 .Os
19 .Sh NAME
20 .Nm apmtop
21 .Nd monitor power-usage-related statistics
22 .Sh SYNOPSIS
23 .Nm
24 .Op Fl d Ar delay
25 .Op Fl V
26 .Sh DESCRIPTION
27 .Nm
28 is a little utility useful for monitoring power-usage-related statistics.
29 .Pp
30 .Sy Note: This program is still in development and will change.
31 .Pp
32 The options are as follows:
33 .Bl -tag -width -Ds
34 .It Fl d Ar delay
35 The refresh delay in tenths of seconds. (default: 10)
36 .It Fl V
37 Print the version of apmtop(1) and exit.
38 .El
39 .Pp
40 .Bl -tag -width 8n
41 The keybindings are as follows:
42 .It Ar q
43 Quit the program.
44 .It Ar 1-5
45 Show/hide panes 1 through 5.
46 .It Ar +/-
47 Increase/decrease delay.
48 .It Ar (space)
49 Pause/resume measuring.
50 .El
51 .Sh TODO
52 .Bl -bullet
53 .It
54 Fancier graphs using Unicode characters.
55 .It
56 Being able to specify which sensors to use,
57 .It 
58 or just show all sensors.
59 .It
60 Show a warning instead of showing -1 (or similar), when a sensor is missing.
61 .It
62 Show something, when min=max.
63 .It
64 Put an empty line before the keybindings-subsection.
65 .El
66 .Sh EXIT STATUS
67 .Ex -std
68 .Sh SEE ALSO
69 .Xr apm 8 ,
70 .Xr sysctl 8 ,
71 .Xr top 1
72 .Sh COMPATIBILITY
73 OpenBSD does not support all kinds of temperature/power/battery sensors.
74 So, make sure that you actually have the sensors you want to measure.
75 This can be done, by comparing apmtop's graphs with the output of the following command:
76 .Pp
77 .Dl $ sysctl hw.sensors
78 .Pp
79 If you still think, that apmtop(1) shows incorrect data,
80 please contact the maintainer.
81 .Sh AUTHORS
82 .An Benjamin Stürz Aq Mt benni@stuerz.xyz