Annotation of src/usr.bin/radioctl/radioctl.1, Revision 1.16
1.16 ! schwarze 1: .\" $OpenBSD: radioctl.1,v 1.15 2008/10/16 14:32:57 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: .\"
1.15 jmc 26: .Dd $Mdocdate: October 16 2008 $
1.1 gluk 27: .Dt RADIOCTL 1
28: .Os
29: .Sh NAME
30: .Nm radioctl
31: .Nd control radio tuners
32: .Sh SYNOPSIS
33: .Nm radioctl
1.15 jmc 34: .Op Fl anv
1.1 gluk 35: .Op Fl f Ar file
36: .Nm radioctl
1.13 sobrado 37: .Op Fl nv
1.1 gluk 38: .Op Fl f Ar file
39: .Ar name
40: .Nm radioctl
1.13 sobrado 41: .Op Fl n
1.1 gluk 42: .Op Fl f Ar file
1.16 ! schwarze 43: .Ar name Ns = Ns Ar value
1.1 gluk 44: .Sh DESCRIPTION
45: The
46: .Nm
47: command displays or sets various variables that affect the radio tuner
1.10 jmc 48: behavior.
49: If a variable is present on the command line,
1.1 gluk 50: .Nm
51: prints the current value of this variable for the specified device.
52: By default,
53: .Nm
54: operates on the
55: .Pa /dev/radio
56: device.
57: .Pp
58: The options are as follows:
59: .Bl -tag -width Ds
60: .It Fl a
61: Print all device variables and their current values.
1.14 jakemsr 62: This is the default, if no parameters are given to
63: .Nm .
1.8 jaredy 64: .It Fl f Ar file
65: Specify an alternative radio tuner device.
66: .It Fl n
67: Suppress printing of the variable name.
1.9 robert 68: .It Fl v
69: Show the possible values of queries.
1.16 ! schwarze 70: .It Ar name Ns = Ns Ar value
1.1 gluk 71: Attempt to set the specified variable
72: .Ar name
73: to
74: .Ar value .
75: .El
76: .Pp
77: Values may be specified in either absolute or relative forms.
78: The relative form is indicated by a prefix of
79: .Ql +
80: or
81: .Ql -
82: to denote an increase or decrease, respectively.
83: .Pp
84: The exact set of controls that can be manipulated depends on
85: the tuner.
1.10 jmc 86: The general format (in both getting and setting a value) is:
1.8 jaredy 87: .Bd -filled -offset indent
1.16 ! schwarze 88: .Ar name Ns = Ns Ar value
1.8 jaredy 89: .Ed
1.1 gluk 90: .Pp
91: The
1.8 jaredy 92: .Ar name
1.1 gluk 93: indicates what part of the tuner the control affects.
94: .Pp
95: Write only controls:
1.10 jmc 96: .Bl -tag -width Ds
1.6 deraadt 97: .It Ar search
1.10 jmc 98: Only for cards that allow hardware search.
99: Can be
1.1 gluk 100: .Ql up
101: or
102: .Ql down .
103: .El
104: .Pp
105: Read-write controls:
1.10 jmc 106: .Bl -tag -width Ds
1.9 robert 107: .It Ar channel
1.11 jakemsr 108: Specifies the TV channel.
1.9 robert 109: Integer value from 0 to 150.
1.11 jakemsr 110: Using the
111: .Ar channel
112: control puts the tuner in
113: .Dq TV
114: mode.
1.9 robert 115: .It Ar chnlset
1.11 jakemsr 116: Specifies the TV channel set.
117: The tuner uses the current channel set to derive a frequency from the
118: .Ar channel .
119: The following is a list of valid channel sets:
1.10 jmc 120: .Pp
121: .Bl -tag -width "australiaXX" -offset indent -compact
1.9 robert 122: .It nabcst
123: U.S.A. Broadcast
124: .It cableirc
125: U.S.A. Cable IRC
126: .It cablehrc
127: U.S.A. Cable HRC
128: .It weurope
129: Western Europe
130: .It jpnbcst
131: Japan Broadcast
132: .It jpncable
133: Japan Cable
134: .It xussr
1.10 jmc 135: Former U.S.S.R. and C.I.S. countries
1.9 robert 136: .It australia
137: Australia
138: .It france
139: France
140: .El
1.6 deraadt 141: .It Ar frequency
1.11 jakemsr 142: Specifies the FM frequency in MHz.
1.1 gluk 143: Float value from 87.5 to 108.0.
1.11 jakemsr 144: Using the
145: .Ar frequency
146: control puts the tuner in
147: .Dq radio
148: mode.
1.6 deraadt 149: .It Ar volume
1.1 gluk 150: Integer value from 0 to 255.
1.6 deraadt 151: .It Ar mute
1.1 gluk 152: Mutes the card (volume is not affected),
153: .Ql on
154: or
155: .Ql off .
1.6 deraadt 156: .It Ar mono
1.1 gluk 157: Forces card output to mono,
158: .Ql on
159: or
160: .Ql off .
161: Only for cards that allow forced mono.
1.6 deraadt 162: .It Ar reference
1.10 jmc 163: Reference frequency.
164: Can be 25 kHz, 50 kHz and 100 kHz.
165: Not all cards allow the reference frequency to be changed.
1.6 deraadt 166: .It Ar sensitivity
1.10 jmc 167: Station locking sensitivity.
168: Can be 5 mkV, 10 mkV, 30 mkV and 150 mkV.
169: Not all cards allow the station locking sensitivity to be changed.
1.1 gluk 170: .El
171: .Pp
1.11 jakemsr 172: All the remaining controls (mode, signal, stereo and card capabilities)
173: are read-only and can be viewed using option
1.1 gluk 174: .Fl a .
1.7 jmc 175: .Sh ENVIRONMENT
176: The following environment variable affects the execution of
177: .Nm radioctl :
178: .Bl -tag -width RADIODEVICE
179: .It Ev RADIODEVICE
180: The radio tuner device to use.
181: .El
182: .Sh FILES
183: .Bl -tag -width /dev/radio
184: .It Pa /dev/radio
185: radio tuner device
186: .El
1.1 gluk 187: .Sh EXAMPLES
1.10 jmc 188: Print all device variables,
189: along with their current values:
190: .Bd -literal -offset indent
191: $ radioctl -a
1.1 gluk 192: volume=255
1.9 robert 193: channel=0
194: chnlset=weurope
1.1 gluk 195: frequency=106.30MHz
196: mute=off
197: reference=50kHz
198: signal=on
199: stereo=on
1.11 jakemsr 200: mode: radio
1.1 gluk 201: card capabilities:
202: manageable mono/stereo
203: .Ed
204: .Sh SEE ALSO
205: .Xr radio 4
1.4 mickey 206: .Sh HISTORY
207: .Nm
208: command first appeared in
209: .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