Annotation of src/usr.bin/radioctl/radioctl.1, Revision 1.10
1.10 ! jmc 1: .\" $OpenBSD: radioctl.1,v 1.9 2005/12/05 16:30:24 robert Exp $
1.1 gluk 2: .\"
3: .\" Copyright (c) 2001 Vladimir Popov
4: .\" All rights reserved.
5: .\"
6: .\" Redistribution and use in source and binary forms, with or without
7: .\" modification, are permitted provided that the following conditions
8: .\" are met:
9: .\" 1. Redistributions of source code must retain the above copyright
10: .\" notice, this list of conditions and the following disclaimer.
11: .\" 2. Redistributions in binary form must reproduce the above copyright
12: .\" notice, this list of conditions and the following disclaimer in the
13: .\" documentation and/or other materials provided with the distribution.
14: .\"
15: .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16: .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17: .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18: .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19: .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
20: .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
21: .\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
22: .\" ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23: .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24: .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25: .\"
26: .Dd September 16, 2001
27: .Dt RADIOCTL 1
28: .Os
29: .Sh NAME
30: .Nm radioctl
31: .Nd control radio tuners
32: .Sh SYNOPSIS
33: .Nm radioctl
34: .Op Fl f Ar file
1.9 robert 35: .Op Fl nv
1.1 gluk 36: .Fl a
37: .Nm radioctl
38: .Op Fl f Ar file
1.9 robert 39: .Op Fl nv
1.1 gluk 40: .Ar name
41: .Nm radioctl
42: .Op Fl f Ar file
43: .Op Fl n
1.8 jaredy 44: .Ar name Ns Li = Ns Ar value
1.1 gluk 45: .Sh DESCRIPTION
46: The
47: .Nm
48: command displays or sets various variables that affect the radio tuner
1.10 ! jmc 49: behavior.
! 50: If a variable is present on the command line,
1.1 gluk 51: .Nm
52: prints the current value of this variable for the specified device.
53: By default,
54: .Nm
55: operates on the
56: .Pa /dev/radio
57: device.
58: .Pp
59: The options are as follows:
60: .Bl -tag -width Ds
61: .It Fl a
62: Print all device variables and their current values.
1.8 jaredy 63: .It Fl f Ar file
64: Specify an alternative radio tuner device.
65: .It Fl n
66: Suppress printing of the variable name.
1.9 robert 67: .It Fl v
68: Show the possible values of queries.
1.8 jaredy 69: .It Ar name Ns Li = Ns Ar value
1.1 gluk 70: Attempt to set the specified variable
71: .Ar name
72: to
73: .Ar value .
74: .El
75: .Pp
76: Values may be specified in either absolute or relative forms.
77: The relative form is indicated by a prefix of
78: .Ql +
79: or
80: .Ql -
81: to denote an increase or decrease, respectively.
82: .Pp
83: The exact set of controls that can be manipulated depends on
84: the tuner.
1.10 ! jmc 85: The general format (in both getting and setting a value) is:
1.8 jaredy 86: .Bd -filled -offset indent
87: .Ar name Ns Li = Ns Ar value
88: .Ed
1.1 gluk 89: .Pp
90: The
1.8 jaredy 91: .Ar name
1.1 gluk 92: indicates what part of the tuner the control affects.
93: .Pp
94: Write only controls:
1.10 ! jmc 95: .Bl -tag -width Ds
1.6 deraadt 96: .It Ar search
1.10 ! jmc 97: Only for cards that allow hardware search.
! 98: Can be
1.1 gluk 99: .Ql up
100: or
101: .Ql down .
102: .El
103: .Pp
104: Read-write controls:
1.10 ! jmc 105: .Bl -tag -width Ds
1.9 robert 106: .It Ar channel
107: Integer value from 0 to 150.
108: .It Ar chnlset
109: Specifies the TV channel set currently being used
1.10 ! jmc 110: .Pf ( Dq weurope
! 111: being the default):
! 112: .Pp
! 113: .Bl -tag -width "australiaXX" -offset indent -compact
1.9 robert 114: .It nabcst
115: U.S.A. Broadcast
116: .It cableirc
117: U.S.A. Cable IRC
118: .It cablehrc
119: U.S.A. Cable HRC
120: .It weurope
121: Western Europe
122: .It jpnbcst
123: Japan Broadcast
124: .It jpncable
125: Japan Cable
126: .It xussr
1.10 ! jmc 127: Former U.S.S.R. and C.I.S. countries
1.9 robert 128: .It australia
129: Australia
130: .It france
131: France
132: .El
1.6 deraadt 133: .It Ar frequency
1.1 gluk 134: Float value from 87.5 to 108.0.
1.6 deraadt 135: .It Ar volume
1.1 gluk 136: Integer value from 0 to 255.
1.6 deraadt 137: .It Ar mute
1.1 gluk 138: Mutes the card (volume is not affected),
139: .Ql on
140: or
141: .Ql off .
1.6 deraadt 142: .It Ar mono
1.1 gluk 143: Forces card output to mono,
144: .Ql on
145: or
146: .Ql off .
147: Only for cards that allow forced mono.
1.6 deraadt 148: .It Ar reference
1.10 ! jmc 149: Reference frequency.
! 150: Can be 25 kHz, 50 kHz and 100 kHz.
! 151: Not all cards allow the reference frequency to be changed.
1.6 deraadt 152: .It Ar sensitivity
1.10 ! jmc 153: Station locking sensitivity.
! 154: Can be 5 mkV, 10 mkV, 30 mkV and 150 mkV.
! 155: Not all cards allow the station locking sensitivity to be changed.
1.1 gluk 156: .El
157: .Pp
158: All the remaining controls (signal, stereo and card capabilities) are read-only
159: and can be viewed using option
160: .Fl a .
1.7 jmc 161: .Sh ENVIRONMENT
162: The following environment variable affects the execution of
163: .Nm radioctl :
164: .Bl -tag -width RADIODEVICE
165: .It Ev RADIODEVICE
166: The radio tuner device to use.
167: .El
168: .Sh FILES
169: .Bl -tag -width /dev/radio
170: .It Pa /dev/radio
171: radio tuner device
172: .El
1.1 gluk 173: .Sh EXAMPLES
1.10 ! jmc 174: Print all device variables,
! 175: along with their current values:
! 176: .Bd -literal -offset indent
! 177: $ radioctl -a
1.1 gluk 178: volume=255
1.9 robert 179: channel=0
180: chnlset=weurope
1.1 gluk 181: frequency=106.30MHz
182: mute=off
183: reference=50kHz
184: signal=on
185: stereo=on
186: card capabilities:
187: manageable mono/stereo
188: .Ed
189: .Sh SEE ALSO
190: .Xr radio 4
1.4 mickey 191: .Sh HISTORY
192: .Nm
193: command first appeared in
194: .Ox 3.0 .
![[BACK]](/icons/back.gif){kind=icon}
Return to radioctl.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / radioctl