xref: /netbsd/usr.sbin/tadpolectl/tadpolectl.8 (revision bf9ec67e)
1.\" $NetBSD: tadpolectl.8,v 1.5 2002/02/02 02:00:19 wiz Exp $
2.\" Copyright (c) 1999 The NetBSD Foundation, Inc.
3.\" All rights reserved.
4.\"
5.\" This code is derived from software contributed to The NetBSD Foundation
6.\" by Tim Rightnour
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. All advertising materials mentioning features or use of this software
17.\"    must display the following acknowledgement:
18.\"        This product includes software developed by the NetBSD
19.\"        Foundation, Inc. and its contributors.
20.\" 4. Neither the name of The NetBSD Foundation nor the names of its
21.\"    contributors may be used to endorse or promote products derived
22.\"    from this software without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
25.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
26.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
27.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
28.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34.\" POSSIBILITY OF SUCH DAMAGE.
35.\"
36.Dd December 16, 1999
37.Dt TADPOLECTL 8 sparc
38.Os
39.Sh NAME
40.Nm tadpolectl
41.Nd get or set tadpole microcontroller state
42.Sh SYNOPSIS
43.Nm tadpolectl
44.Op Fl n
45.Ar name ...
46.Nm tadpolectl
47.Op Fl n
48.Fl w
49.Ar name=value ...
50.Nm tadpolectl
51.Op Fl n
52.Fl a
53.Sh DESCRIPTION
54The
55.Nm tadpolectl
56utility retrieves values from the ts102 microcontroller
57 and allows processes with appropriate privilege to set some values.
58The state to be retrieved or set is described using a
59``Management Information Base'' (``MIB'') style name,
60described as a dotted set of components.
61The
62.Fl a
63flag can be used to list all the currently available string or integer values.
64.Pp
65The
66.Fl n
67flag specifies that the printing of the field name should be
68suppressed and that only its value should be output.
69This flag is useful for setting shell variables.
70For example, to save the mains power status in variable mains, use:
71.Bd -literal -offset indent -compact
72set mains=`tadpolectl -n hw.power.mains`
73.Ed
74.Pp
75If just a MIB style name is given,
76the corresponding value is retrieved.
77If a value is to be set, the
78.Fl w
79flag must be specified and the MIB name followed
80by an equal sign and the new value to be used.
81.Pp
82The information available from
83.Nm tadpolectl
84consists of only integers.  Some registers can be modified, but have no
85way of reading what the current value is.  Those registers will allways
86display
87.Dq 0 .
88.Pp
89The changeable column indicates whether a process with appropriate
90privilege can change the value, and if a displayed value is valid.
91.Bl -column hw.power.battery.int.chargelevel Changeable Valid
92.It Sy Name	Changeable	Valid
93.It hw.microcontroller.version	no	yes
94.It hw.version	no	yes
95.It hw.poweroncycles	no	yes
96.It hw.poweronseconds	no	yes
97.It hw.power.mains	no	yes
98.It hw.power.battery.int	no	yes
99.It hw.power.battery.ext	no	yes
100.It hw.power.battery.chargedisabled	yes	yes
101.It hw.power.battery.int.chargerate	yes	yes
102.It hw.power.battery.ext.chargerate	yes	yes
103.It hw.power.battery.int.chargelevel	no	yes
104.It hw.power.battery.ext.chargelevel	no	yes
105.It hw.video.external	no	yes
106.It hw.video.lid	no	yes
107.It hw.video.syncinva	yes	yes
108.It hw.video.syncinvb	yes	yes
109.It hw.video.compsync	yes	yes
110.It hw.video.tft.brightness	yes	yes
111.It hw.speaker.freq	yes	no
112.It hw.speaker.volume	yes	yes
113.It hw.kbd.repeat.delay	yes	yes
114.It hw.kbd.repeat.speed	yes	yes
115.It hw.kbd.click	yes	yes
116.It hw.mouse.recalibrate	yes	no
117.It hw.mouse.disable	yes	yes
118.It hw.mouse.intclick	yes	yes
119.It hw.mouse.extclick	yes	yes
120.It hw.mouse.sensitivity	yes	yes
121.It hw.serial.power	yes	yes
122.El
123.Sh EXAMPLES
124For example, to retrieve the current internal battery charge level,
125one would use the following request:
126.Bd -literal -offset indent -compact
127tadpolectl hw.power.battery.int.chargelevel
128.Ed
129.Pp
130To set the speaker beep frequency of
131the system to 1000, one would use the following request:
132.Bd -literal -offset indent -compact
133tadpolectl -w hw.speaker.freq=1000
134.Ed
135.Sh SEE ALSO
136.Xr sysctl 8
137.Sh HISTORY
138.Nm tadpolectl
139first appeared in
140.Nx 1.5 .
141