-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathosdhud.mandoc
217 lines (217 loc) · 6.38 KB
/
osdhud.mandoc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
.\" -*- mode:nroff; indent-tabs-mode:nil; -*-
.Dd $Mdocdate$
.Dt OSDHUD 1
.Os
.Sh NAME
.Nm osdhud
.Nd heads-up system status display for X11
.Sh SYNOPSIS
.Nm osdhud
.Op Fl vkgtknFDUSNCwh?
.Op Fl T Ar fmt
.Op Fl d Ar msec
.Op Fl p Ar msec
.Op Fl P Ar msec
.Op Fl f Ar font
.Op Fl s Ar path
.Op Fl i Ar iface
.Op Fl X Ar mb/s
.Op Fl m Ar sensor
.Op Fl M Ar max_temp
.Sh DESCRIPTION
.Nm
provides a heads-up display style view of the activity on your local
machine. It uses the
.Xr xosd 3
library to create a transparent window with an on screen-display
that appears to float over whatever else is displayed.
.Pp
.Nm
normally runs as a daemon and listens on a Unix-domain socket in your
home directory for commands. When first started it will fork a daemon
child if it cannot make contact with an existing daemon via the
socket. The daemon gathers statistics in the background and responds
to commands on its socket. You can disable the daemon by running
.Nm
in the foreground via the
.Fl F
option. When run in the foreground any output from
.Nm
goes to stderr. Otherwise the
.Nm
daemon will log to
.Xr syslog
once daemonized and to stderr if it encounters an error before
daemonizing.
.Ss USAGE
Normally,
.Nm
is started as a part of your X session. For instance addining the following
lines to your
.Pa ~/.xinitrc
file:
.Bd -literal -offset indent -compact
osdhud -Cwn -i egress
.Ed
will start the
.Nm
daemon watching interfaces in the
.Oq egress
group, will not show swap statistics, will show the display countdown
and will not display anything when it starts up. Running
.Dl osdhud
on the command line or from a key binding will bring the HUD up
for the display interval. Running
.Dl osdhud
while the HUD is up will increase the display time for the current
display; thus by default hitting a key bound to
.Dl osdhud
will first bring the HUD up and then increase the amount of time it
remains visible. You can force the HUD to disappear with
.Dl osdhud -D
.Ss OPTIONS
.Bl -tag -width Ds
.It Fl v
Turn up verbosity.
.Nm
does not normally produce any output other than its display.
Increasing verbosity with multiple
.Fl v
options will increase the level of log output.
.It Fl g
Turn on debugging, which produces much more copious
log output, either to stderr or
.Xr syslog
.It Fl k
Ask the daemon listening on the Unix-domain socket to shut down (kill
itself) and clean up. The socket will be removed before the daemon
exits.
.It Fl n
Do not bring the HUD up when first started. If this option
is not present then
.Nm
will display the HUD immediately upon daemonizing.
.It Fl t
Tell the daemon to toggle its display regardless of other
settings. If the HUD is not displayed then it will be displayed
and
.Dq stuck
to the screen. If the HUD is up then it will be brought down.
It is useful to bind
.Dl osdhud -t
to a key in your windowing environment; hitting this key causes
the HUD to toggle.
.It Fl F
Force
.Nm
to run in the foreground and not fork a daemon if needed or talk
to an existing daemon. You can terminate it by hitting ^C.
.It Fl D
Bring the HUD down if it is up.
.It Fl U
Bring the HUD up if it is down. It will stay up for at least
the standard display time (c.f. the
.Fl d
option).
.It Fl S
Stick the HUD to the display: the display time is ignored and
the HUD will stay up until some command arrives that has
that effect, e.g. the
.Fl D ,
.Fl N
or
.Fl t
options.
.It Fl N
Unstick the display if it is stuck. The display will fade
after however much of the display time that is left has expired.
.It Fl C
Display a countdown of the number of seconds left in the
HUD display or the string
.Oq -stuck-
if the HUD is stuck to the display. The countdown is displayed in
the bottom right corner of the screen when enabled.
.It Fl w
Do not display swap statistics.
.It Fl h Fl ?
Produce a usage message on stdout and exit.
.It Fl T Ar fmt
Specify a
.Xr strftime 3
style format string for the date/time display at the bottom
of the HUD. The default is
.Oq %Y-%m-%d %H:%M:%S
.It Fl d Ar msec
Specify the display time in milliseconds. The default is
4000 milliseconds (4 seconds).
.It Fl p Ar msec
Set the short sampling pause milliseconds.
.It Fl P Ar msec
Set the long sampling pause in milliseconds.
.It Fl f Ar font
Set the font used in the HUD display. The default is
.Oq -adobe-helvetica-bold-r-normal-*-*-320-*-*-p-*-*-*
.It Fl s Ar path
Set the location of the Unix-domain socket used for communication
between the command line and the daemon. The default is
.Pa ~/.osdhud_@VERSION@
It is not usually necessary to tweak this but might be if
e.g. your home directory is on a remote filesystem.
.It Fl i Ar iface
Set the network interface being watched by
the network statistics gathering code. Under OpenBSD interface
group names can be specified, e.g.
.Oq egress
in which case interfaces in that group will have their
aggregate statistics displayed in the HUD.
.It Fl X Ar mb/s
Fix our idea of the maximum network bandwidth available in
megabits/second. Must be an integer. If not specified
then
.Nm
will attempt to automatically guess the maximum speed
based on the media flags available from the
.Li SIOCGIFMEDIA
option of the
.Xr ioctl 2
system call. The guess may not be perfect so depending on your
networking hardware you might have to use
.Fl X
to get the percentage bar display for network utilization to appear in
the HUD or to scale properly. One common situation is when you are
directly connected to a network that is much faster than your real
uplink to the Internet. If your LAN is 100mbit but your DSL line can
only do 2 mbit/sec, giving a value of 2 for
.Fl X
will give you a more realistic display, assuming you care more about
connections to the Internet than to your LAN.
.It Fl m Ar sensor
Specify the full name of the temperature sensor to display; the
argument should be the same as the name you would give to the
.Xr sysctl 8
program. Giving a value of
.Li list
will cause
.Nm
to print out the list of available temperature sensors on the
system and their current values. If
.Fl m
is not specified, the first temperature sensor found will be
used.
.It Fl M Ar maxtemp
Specify the maximum temperature that should ever be seen, in Celsius;
the default is 120 degrees. This is used to determine the value
and color displayed in the temperature graph.
.El
.Sh FILES
.Pa ~/.osdhud_@VERSION@
Unix-domain socket used by
.Nm
for communication with the daemon.
.Sh SEE ALSO
.Xr sysctl 3
.Xr ioctl 2
.Xr ifconfig 8
.Xr xosd 3
.Sh AUTHORS
attila <[email protected]>