Annotation of src/usr.bin/radioctl/radioctl.1, Revision 1.11
1.11 ! jakemsr 1: .\" $OpenBSD: radioctl.1,v 1.10 2005/12/06 12:58:50 jmc 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
1.11 ! jakemsr 107: Specifies the TV channel.
1.9 robert 108: Integer value from 0 to 150.
1.11 ! jakemsr 109: Using the
! 110: .Ar channel
! 111: control puts the tuner in
! 112: .Dq TV
! 113: mode.
1.9 robert 114: .It Ar chnlset
1.11 ! jakemsr 115: Specifies the TV channel set.
! 116: The tuner uses the current channel set to derive a frequency from the
! 117: .Ar channel .
! 118: The following is a list of valid channel sets:
1.10 jmc 119: .Pp
120: .Bl -tag -width "australiaXX" -offset indent -compact
1.9 robert 121: .It nabcst
122: U.S.A. Broadcast
123: .It cableirc
124: U.S.A. Cable IRC
125: .It cablehrc
126: U.S.A. Cable HRC
127: .It weurope
128: Western Europe
129: .It jpnbcst
130: Japan Broadcast
131: .It jpncable
132: Japan Cable
133: .It xussr
1.10 jmc 134: Former U.S.S.R. and C.I.S. countries
1.9 robert 135: .It australia
136: Australia
137: .It france
138: France
139: .El
1.6 deraadt 140: .It Ar frequency
1.11 ! jakemsr 141: Specifies the FM frequency in MHz.
1.1 gluk 142: Float value from 87.5 to 108.0.
1.11 ! jakemsr 143: Using the
! 144: .Ar frequency
! 145: control puts the tuner in
! 146: .Dq radio
! 147: mode.
1.6 deraadt 148: .It Ar volume
1.1 gluk 149: Integer value from 0 to 255.
1.6 deraadt 150: .It Ar mute
1.1 gluk 151: Mutes the card (volume is not affected),
152: .Ql on
153: or
154: .Ql off .
1.6 deraadt 155: .It Ar mono
1.1 gluk 156: Forces card output to mono,
157: .Ql on
158: or
159: .Ql off .
160: Only for cards that allow forced mono.
1.6 deraadt 161: .It Ar reference
1.10 jmc 162: Reference frequency.
163: Can be 25 kHz, 50 kHz and 100 kHz.
164: Not all cards allow the reference frequency to be changed.
1.6 deraadt 165: .It Ar sensitivity
1.10 jmc 166: Station locking sensitivity.
167: Can be 5 mkV, 10 mkV, 30 mkV and 150 mkV.
168: Not all cards allow the station locking sensitivity to be changed.
1.1 gluk 169: .El
170: .Pp
1.11 ! jakemsr 171: All the remaining controls (mode, signal, stereo and card capabilities)
! 172: are read-only and can be viewed using option
1.1 gluk 173: .Fl a .
1.7 jmc 174: .Sh ENVIRONMENT
175: The following environment variable affects the execution of
176: .Nm radioctl :
177: .Bl -tag -width RADIODEVICE
178: .It Ev RADIODEVICE
179: The radio tuner device to use.
180: .El
181: .Sh FILES
182: .Bl -tag -width /dev/radio
183: .It Pa /dev/radio
184: radio tuner device
185: .El
1.1 gluk 186: .Sh EXAMPLES
1.10 jmc 187: Print all device variables,
188: along with their current values:
189: .Bd -literal -offset indent
190: $ radioctl -a
1.1 gluk 191: volume=255
1.9 robert 192: channel=0
193: chnlset=weurope
1.1 gluk 194: frequency=106.30MHz
195: mute=off
196: reference=50kHz
197: signal=on
198: stereo=on
1.11 ! jakemsr 199: mode: radio
1.1 gluk 200: card capabilities:
201: manageable mono/stereo
202: .Ed
203: .Sh SEE ALSO
204: .Xr radio 4
1.4 mickey 205: .Sh HISTORY
206: .Nm
207: command first appeared in
208: .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