xref: /netbsd-src/usr.bin/radioctl/radioctl.1 (revision b2c35e17b976cf7ccd7250c86c6f5e95090ed636)
1.\"	$NetBSD: radioctl.1,v 1.3 2002/01/01 22:48:18 wiz Exp $
2.\"	$OpenBSD: radioctl.1,v 1.4 2001/12/06 10:14:32 mickey Exp $
3.\"
4.\" Copyright (c) 2001 Vladimir Popov
5.\" All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
22.\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
23.\" ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26.\"
27.Dd September 16, 2001
28.Dt RADIOCTL 1
29.Os
30.Sh NAME
31.Nm radioctl
32.Nd control radio tuners
33.Sh SYNOPSIS
34.Nm radioctl
35.Op Fl f Ar file
36.Op Fl n
37.Fl a
38.Nm radioctl
39.Op Fl f Ar file
40.Op Fl n
41.Ar name
42.Nm radioctl
43.Op Fl f Ar file
44.Op Fl n
45.Fl w
46.Ar name=value
47.Sh DESCRIPTION
48The
49.Nm
50command displays or sets various variables that affect the radio tuner
51behavior. If a variable is present on the command line,
52.Nm
53prints the current value of this variable for the specified device.
54By default,
55.Nm
56operates on the
57.Pa /dev/radio
58device.
59.Pp
60The options are as follows:
61.Bl -tag -width Ds
62.It Fl a
63Print all device variables and their current values.
64.It Fl w Ar name=value
65Attempt to set the specified variable
66.Ar name
67to
68.Ar value .
69.It Fl f Ar file
70Specify an alternative radio tuner device.
71.It Fl n
72Suppress printing of the variable name.
73.El
74.Pp
75Values may be specified in either absolute or relative forms.
76The relative form is indicated by a prefix of
77.Ql +
78or
79.Ql -
80to denote an increase or decrease, respectively.
81.Pp
82The exact set of controls that can be manipulated depends on
83the tuner.
84The general format (in both getting and setting a value) is
85.Pp
86.Va name = value
87.Pp
88The
89.Va name
90indicates what part of the tuner the control affects.
91.Pp
92Write only controls:
93.Bl -tag -width search
94.It search
95Only for cards that allow hardware search. Can be
96.Ql up
97or
98.Ql down .
99.El
100.Pp
101Read-write controls:
102.Bl -tag -width volume
103.It frequency
104Float value from 87.5 to 108.0.
105.It volume
106Integer value from 0 to 255.
107.It mute
108Mutes the card (volume is not affected),
109.Ql on
110or
111.Ql off .
112.It mono
113Forces card output to mono,
114.Ql on
115or
116.Ql off .
117Only for cards that allow forced mono.
118.It reference
119Reference frequency. Can be 25 kHz, 50 kHz and 100 kHz. Not all cards allow
120to change the reference frequency.
121.It sensitivity
122Station locking sensitivity. Can be 5 mkV, 10 mkV, 30 mkV and 150 mkV. Not all
123cards allow to change the station locking sensitivity.
124.El
125.Pp
126All the remaining controls (signal, stereo and card capabilities) are read-only
127and can be viewed using option
128.Fl a .
129.Sh ENVIRONMENT
130The following environment variable affects the execution of
131.Nm radioctl :
132.Bl -tag -width RADIODEVICE
133.It Ev RADIODEVICE
134The radio tuner device to use.
135.El
136.Sh FILES
137.Bl -tag -width /dev/radio
138.It Pa /dev/radio
139radio tuner device
140.El
141.Sh EXAMPLES
142The command
143.Pp
144.Dl "radioctl -a"
145.Pp
146can produce
147.Bd -literal
148volume=255
149frequency=106.30MHz
150mute=off
151reference=50kHz
152signal=on
153stereo=on
154card capabilities:
155        manageable mono/stereo
156.Ed
157.Sh SEE ALSO
158.Xr radio 4
159.Sh HISTORY
160.Nm
161command first appeared in
162.Ox 3.0
163and
164.Nx 1.6 .
165