Annotation of src/usr.bin/radioctl/radioctl.1, Revision 1.8
1.8 ! jaredy 1: .\" $OpenBSD: radioctl.1,v 1.7 2003/06/10 09:12:11 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
35: .Op Fl n
36: .Fl a
37: .Nm radioctl
38: .Op Fl f Ar file
39: .Op Fl n
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
49: behavior. If a variable is present on the command line,
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.8 ! jaredy 62: .It Fl f Ar file
! 63: Specify an alternative radio tuner device.
! 64: .It Fl n
! 65: Suppress printing of the variable name.
! 66: .It Ar name Ns Li = Ns Ar value
1.1 gluk 67: Attempt to set the specified variable
68: .Ar name
69: to
70: .Ar value .
71: .El
72: .Pp
73: Values may be specified in either absolute or relative forms.
74: The relative form is indicated by a prefix of
75: .Ql +
76: or
77: .Ql -
78: to denote an increase or decrease, respectively.
79: .Pp
80: The exact set of controls that can be manipulated depends on
81: the tuner.
82: The general format (in both getting and setting a value) is
83: .Pp
1.8 ! jaredy 84: .Bd -filled -offset indent
! 85: .Ar name Ns Li = Ns Ar value
! 86: .Ed
1.1 gluk 87: .Pp
88: The
1.8 ! jaredy 89: .Ar name
1.1 gluk 90: indicates what part of the tuner the control affects.
91: .Pp
92: Write only controls:
93: .Bl -tag -width search
1.6 deraadt 94: .It Ar search
1.1 gluk 95: Only for cards that allow hardware search. Can be
96: .Ql up
97: or
98: .Ql down .
99: .El
100: .Pp
101: Read-write controls:
102: .Bl -tag -width volume
1.6 deraadt 103: .It Ar frequency
1.1 gluk 104: Float value from 87.5 to 108.0.
1.6 deraadt 105: .It Ar volume
1.1 gluk 106: Integer value from 0 to 255.
1.6 deraadt 107: .It Ar mute
1.1 gluk 108: Mutes the card (volume is not affected),
109: .Ql on
110: or
111: .Ql off .
1.6 deraadt 112: .It Ar mono
1.1 gluk 113: Forces card output to mono,
114: .Ql on
115: or
116: .Ql off .
117: Only for cards that allow forced mono.
1.6 deraadt 118: .It Ar reference
1.1 gluk 119: Reference frequency. Can be 25 kHz, 50 kHz and 100 kHz. Not all cards allow
1.6 deraadt 120: the reference frequency to be changed.
121: .It Ar sensitivity
1.1 gluk 122: Station locking sensitivity. Can be 5 mkV, 10 mkV, 30 mkV and 150 mkV. Not all
1.6 deraadt 123: cards allow the station locking sensitivity to be changed.
1.1 gluk 124: .El
125: .Pp
126: All the remaining controls (signal, stereo and card capabilities) are read-only
127: and can be viewed using option
128: .Fl a .
1.7 jmc 129: .Sh ENVIRONMENT
130: The following environment variable affects the execution of
131: .Nm radioctl :
132: .Bl -tag -width RADIODEVICE
133: .It Ev RADIODEVICE
134: The radio tuner device to use.
135: .El
136: .Sh FILES
137: .Bl -tag -width /dev/radio
138: .It Pa /dev/radio
139: radio tuner device
140: .El
1.1 gluk 141: .Sh EXAMPLES
142: The command
143: .Pp
1.5 deraadt 144: .Dl "$ radioctl -a"
1.1 gluk 145: .Pp
146: can produce
147: .Bd -literal
148: volume=255
149: frequency=106.30MHz
150: mute=off
151: reference=50kHz
152: signal=on
153: stereo=on
154: card capabilities:
155: manageable mono/stereo
156: .Ed
157: .Sh SEE ALSO
158: .Xr radio 4
1.4 mickey 159: .Sh HISTORY
160: .Nm
161: command first appeared in
162: .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