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