xref: /netbsd-src/usr.sbin/envstat/envstat.8 (revision de1dfb1250df962f1ff3a011772cf58e605aed11)
1.\"	$NetBSD: envstat.8,v 1.7 2004/04/25 03:13:00 kochi Exp $
2.\"
3.\" Copyright (c) 2000 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Bill Squier.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"        This product includes software developed by the NetBSD
20.\"        Foundation, Inc. and its contributors.
21.\" 4. Neither the name of The NetBSD Foundation nor the names of its
22.\"    contributors may be used to endorse or promote products derived
23.\"    from this software without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35.\" POSSIBILITY OF SUCH DAMAGE.
36.\"
37.Dd April 25, 2004
38.Dt ENVSTAT 8
39.Os
40.Sh NAME
41.Nm envstat
42.Nd display environmental sensor readings
43.Sh SYNOPSIS
44.Nm
45.Op Fl flr
46.Op Fl i Ar interval
47.Op Fl n Ar headrep
48.Op Fl s Ar sensor1,sensor2,...
49.Op Fl w Ar width
50.Op Ar device
51.Sh DESCRIPTION
52.Nm
53displays sensor readings from any device which supports the
54.Xr envsys 4
55API.
56Readings are displayed in columns, one column per sensor.
57Column widths as well as displayed sensors are fully customizable.
58The column headers display the name (stored in the device driver) as
59well as the units of each sensor.
60.Pp
61The options are as follows:
62.Bl -tag -width flag
63.It Fl f
64Display any temperature values in degrees Fahrenheit.
65The default is to display temperature values in degrees Celsius.
66.It Fl l
67List the names of all supported sensors, one per line.
68Use of this flag causes
69.Nm
70to ignore all other option flags.
71.It Fl i
72Repeat the display every
73.Ar interval
74seconds.
75Note that some devices do not provide fresh values on demand.
76See the individual device's manual page for meaningful values for
77.Ar interval .
78If not specified, or specified as 0,
79.Nm
80produces one line of values and exits.
81.It Fl n
82Display a new header every
83.Ar headrep
84lines.
85An argument of 0 disables header line printing completely.
86The default is every 22 lines.
87.It Fl r
88Display the sensors row wise.
89This is useful when the number of sensors is large.
90This option also displays fractional values when present
91(e.g., the percentage battery charge).
92.It Fl s
93Restrict the display to the named sensors.
94The sensor names must be supplied as a comma separated list.
95Sensor names are case sensitive.
96.It Fl w
97Use
98.Ar width
99as the column width for the output.
100Each column is additionally separated by a single space.
101The default is either the length of the longest sensor
102name or spread evenly to fill 80 columns, whichever is greater.
103.El
104.Sh SEE ALSO
105.Xr acpiacad 4 ,
106.Xr acpibat 4 ,
107.Xr acpitz 4 ,
108.Xr envsys 4 ,
109.Xr lm 4
110.Sh HISTORY
111.Nm
112appeared in
113.Nx 1.5 .
114