Annotation of src/usr.bin/radioctl/radioctl.1, Revision 1.1
1.1 ! gluk 1: .\"
! 2: .\" Copyright (c) 2001 Vladimir Popov
! 3: .\" All rights reserved.
! 4: .\"
! 5: .\" Redistribution and use in source and binary forms, with or without
! 6: .\" modification, are permitted provided that the following conditions
! 7: .\" are met:
! 8: .\" 1. Redistributions of source code must retain the above copyright
! 9: .\" notice, this list of conditions and the following disclaimer.
! 10: .\" 2. Redistributions in binary form must reproduce the above copyright
! 11: .\" notice, this list of conditions and the following disclaimer in the
! 12: .\" documentation and/or other materials provided with the distribution.
! 13: .\"
! 14: .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
! 15: .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
! 16: .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
! 17: .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
! 18: .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
! 19: .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
! 20: .\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
! 21: .\" ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
! 22: .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
! 23: .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
! 24: .\"
! 25: .Dd September 16, 2001
! 26: .Dt RADIOCTL 1
! 27: .Os
! 28: .Sh NAME
! 29: .Nm radioctl
! 30: .Nd control radio tuners
! 31: .Sh SYNOPSIS
! 32: .Nm radioctl
! 33: .Op Fl f Ar file
! 34: .Op Fl n
! 35: .Fl a
! 36: .Nm radioctl
! 37: .Op Fl f Ar file
! 38: .Op Fl n
! 39: .Ar name
! 40: .Nm radioctl
! 41: .Op Fl f Ar file
! 42: .Op Fl n
! 43: .Fl w
! 44: .Ar name=value
! 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.
! 62: .It Fl w Ar name=value
! 63: Attempt to set the specified variable
! 64: .Ar name
! 65: to
! 66: .Ar value .
! 67: .It Fl f Ar file
! 68: Specify an alternative radio tuner device.
! 69: .It Fl n
! 70: Suppress printing of the variable name.
! 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
! 84: .Va name = value
! 85: .Pp
! 86: The
! 87: .Va name
! 88: indicates what part of the tuner the control affects.
! 89: .Pp
! 90: Write only controls:
! 91: .Bl -tag -width search
! 92: .It search
! 93: Only for cards that allow hardware search. Can be
! 94: .Ql up
! 95: or
! 96: .Ql down .
! 97: .El
! 98: .Pp
! 99: Read-write controls:
! 100: .Bl -tag -width volume
! 101: .It frequency
! 102: Float value from 87.5 to 108.0.
! 103: .It volume
! 104: Integer value from 0 to 255.
! 105: .It mute
! 106: Mutes the card (volume is not affected),
! 107: .Ql on
! 108: or
! 109: .Ql off .
! 110: .It mono
! 111: Forces card output to mono,
! 112: .Ql on
! 113: or
! 114: .Ql off .
! 115: Only for cards that allow forced mono.
! 116: .It reference
! 117: Reference frequency. Can be 25 kHz, 50 kHz and 100 kHz. Not all cards allow
! 118: to change the reference frequency.
! 119: .It sensitivity
! 120: Station locking sensitivity. Can be 5 mkV, 10 mkV, 30 mkV and 150 mkV. Not all
! 121: cards allow to change the station locking sensitivity.
! 122: .El
! 123: .Pp
! 124: All the remaining controls (signal, stereo and card capabilities) are read-only
! 125: and can be viewed using option
! 126: .Fl a .
! 127: .Sh EXAMPLES
! 128: The command
! 129: .Pp
! 130: .Dl "radioctl -a"
! 131: .Pp
! 132: can produce
! 133: .Bd -literal
! 134: volume=255
! 135: frequency=106.30MHz
! 136: mute=off
! 137: reference=50kHz
! 138: signal=on
! 139: stereo=on
! 140: card capabilities:
! 141: manageable mono/stereo
! 142: .Ed
! 143: .Sh ENVIRONMENT
! 144: The following environment variable affects the execution of
! 145: .Nm radioctl :
! 146: .Bl -tag -width RADIODEVICE
! 147: .It Ev RADIODEVICE
! 148: The radio tuner device to use.
! 149: .El
! 150: .Sh FILES
! 151: .Bl -tag -width /dev/radio
! 152: .It Pa /dev/radio
! 153: radio tuner device
! 154: .El
! 155: .Sh SEE ALSO
! 156: .Xr radio 4