[BACK]Return to radioctl.1 CVS log [TXT][DIR] Up to [local] / src / usr.bin / radioctl

Annotation of src/usr.bin/radioctl/radioctl.1, Revision 1.9

1.9     ! robert      1: .\"    $OpenBSD: radioctl.1,v 1.8 2004/08/08 00:21:55 jaredy 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
                     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.
1.9     ! robert     66: .It Fl v
        !            67: Show the possible values of queries.
1.8       jaredy     68: .It Ar name Ns Li = Ns Ar value
1.1       gluk       69: Attempt to set the specified variable
                     70: .Ar name
                     71: to
                     72: .Ar value .
                     73: .El
                     74: .Pp
                     75: Values may be specified in either absolute or relative forms.
                     76: The relative form is indicated by a prefix of
                     77: .Ql +
                     78: or
                     79: .Ql -
                     80: to denote an increase or decrease, respectively.
                     81: .Pp
                     82: The exact set of controls that can be manipulated depends on
                     83: the tuner.
                     84: The general format (in both getting and setting a value) is
                     85: .Pp
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:
                     95: .Bl -tag -width search
1.6       deraadt    96: .It Ar search
1.1       gluk       97: Only for cards that allow hardware search. Can be
                     98: .Ql up
                     99: or
                    100: .Ql down .
                    101: .El
                    102: .Pp
                    103: Read-write controls:
                    104: .Bl -tag -width volume
1.9     ! robert    105: .It Ar channel
        !           106: Integer value from 0 to 150.
        !           107: .It Ar chnlset
        !           108: Specifies the TV channel set currently being used
        !           109: (weurope being the default):
        !           110: .Bl -tag -width indent
        !           111: .It nabcst
        !           112: U.S.A. Broadcast
        !           113: .It cableirc
        !           114: U.S.A. Cable IRC
        !           115: .It cablehrc
        !           116: U.S.A. Cable HRC
        !           117: .It weurope
        !           118: Western Europe
        !           119: .It jpnbcst
        !           120: Japan Broadcast
        !           121: .It jpncable
        !           122: Japan Cable
        !           123: .It xussr
        !           124: Former U.S.S.R. and C.I.S. Countries
        !           125: .It australia
        !           126: Australia
        !           127: .It france
        !           128: France
        !           129: .El
1.6       deraadt   130: .It Ar frequency
1.1       gluk      131: Float value from 87.5 to 108.0.
1.6       deraadt   132: .It Ar volume
1.1       gluk      133: Integer value from 0 to 255.
1.6       deraadt   134: .It Ar mute
1.1       gluk      135: Mutes the card (volume is not affected),
                    136: .Ql on
                    137: or
                    138: .Ql off .
1.6       deraadt   139: .It Ar mono
1.1       gluk      140: Forces card output to mono,
                    141: .Ql on
                    142: or
                    143: .Ql off .
                    144: Only for cards that allow forced mono.
1.6       deraadt   145: .It Ar reference
1.1       gluk      146: Reference frequency. Can be 25 kHz, 50 kHz and 100 kHz. Not all cards allow
1.6       deraadt   147: the reference frequency to be changed.
                    148: .It Ar sensitivity
1.1       gluk      149: Station locking sensitivity. Can be 5 mkV, 10 mkV, 30 mkV and 150 mkV. Not all
1.6       deraadt   150: cards allow the station locking sensitivity to be changed.
1.1       gluk      151: .El
                    152: .Pp
                    153: All the remaining controls (signal, stereo and card capabilities) are read-only
                    154: and can be viewed using option
                    155: .Fl a .
1.7       jmc       156: .Sh ENVIRONMENT
                    157: The following environment variable affects the execution of
                    158: .Nm radioctl :
                    159: .Bl -tag -width RADIODEVICE
                    160: .It Ev RADIODEVICE
                    161: The radio tuner device to use.
                    162: .El
                    163: .Sh FILES
                    164: .Bl -tag -width /dev/radio
                    165: .It Pa /dev/radio
                    166: radio tuner device
                    167: .El
1.1       gluk      168: .Sh EXAMPLES
                    169: The command
                    170: .Pp
1.5       deraadt   171: .Dl "$ radioctl -a"
1.1       gluk      172: .Pp
                    173: can produce
                    174: .Bd -literal
                    175: volume=255
1.9     ! robert    176: channel=0
        !           177: chnlset=weurope
1.1       gluk      178: frequency=106.30MHz
                    179: mute=off
                    180: reference=50kHz
                    181: signal=on
                    182: stereo=on
                    183: card capabilities:
                    184:         manageable mono/stereo
                    185: .Ed
                    186: .Sh SEE ALSO
                    187: .Xr radio 4
1.4       mickey    188: .Sh HISTORY
                    189: .Nm
                    190: command first appeared in
                    191: .Ox 3.0 .