xref: /netbsd/usr.sbin/envstat/envstat.8 (revision bf9ec67e)
1.\"	$NetBSD: envstat.8,v 1.3 2002/01/19 03:11:44 wiz 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 March 8, 2000
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 fl
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.  Readings are displayed in columns, one column per sensor.  Column
56widths as well as displayed sensors are fully customizable.  The column
57headers display the name (stored in the device driver) as well as
58the units of each sensor.
59.Pp
60The options are as follows:
61.Bl -tag -width flag
62.It Fl f
63Display any temperature values in degrees Fahrenheit.  The default is to
64display temperature values in degrees Celsius.
65.It Fl l
66List the names of all supported sensors, one per line.  Use of this
67flag causes
68.Nm
69to ignore all other option flags.
70.It Fl i
71Repeat the display every
72.Ar interval
73seconds.  Note that some devices do not provide fresh values on demand.
74See the individual device's manual page for meaningful values for
75.Ar interval .
76If not specified, or specified as 0,
77.Nm
78produces one line of values and exits.
79.It Fl n
80Display a new header every
81.Ar headrep
82lines.  An argument of 0 disables header line printing completely.
83The default is every 22 lines.
84.It Fl s
85Restrict the display to the named sensors.  The sensor names must be
86supplied as a comma separated list.  Sensor names are case sensitive.
87.It Fl w
88Use
89.Ar width
90as the column width for the output. Each column is additionally separated
91by a single space.  The default is either the length of the longest sensor
92name or spread evenly to fill 80 columns, whichever is greater.
93.El
94.Sh SEE ALSO
95.Xr envsys 4 ,
96.Xr lm 4
97.Sh HISTORY
98.Nm
99appeared in
100.Nx 1.5 .
101