Annotation of src/usr.bin/tunerctl/tunerctl.1, Revision 1.1
1.1 ! jakemsr 1: .\"
! 2: .\" Copyright (c) 2005 Jacob Meuser <jakemsr@jakemsr.com>
! 3: .\"
! 4: .\" Permission to use, copy, modify, and distribute this software for any
! 5: .\" purpose with or without fee is hereby granted, provided that the above
! 6: .\" copyright notice and this permission notice appear in all copies.
! 7: .\"
! 8: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
! 9: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
! 10: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
! 11: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
! 12: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
! 13: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
! 14: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
! 15: .\"
! 16: .\" $OpenBSD$
! 17: .\"
! 18: .Dd Mar 27, 2005
! 19: .Dt TUNERCTL 1
! 20: .Os
! 21: .Sh NAME
! 22: .Nm tunerctl
! 23: .Nd manipulate
! 24: .Xr bktr 4
! 25: tuner devices.
! 26: .Sh SYNOPSIS
! 27: .Nm
! 28: .Op Fl nv
! 29: .Op Fl f Ar file
! 30: .Fl a
! 31: .Nm
! 32: .Op Fl nv
! 33: .Op Fl f Ar file
! 34: .Ar name
! 35: .Op Ar ...
! 36: .Nm
! 37: .Op Fl q
! 38: .Pf \ \& Op Fl f Ar file
! 39: .Xo
! 40: .Ar name Ns = Ns Ar value
! 41: .Op Ar ...
! 42: .Xc
! 43: .Sh DESCRIPTION
! 44: The
! 45: .Nm
! 46: command displays or sets various variables that affect the behaviour of
! 47: .Xr bktr 4
! 48: device tuners.
! 49: If a list of variables is present on the command line,
! 50: .Nm
! 51: prints the current value of those variables for the specified device.
! 52: By default,
! 53: .Nm
! 54: operates on the
! 55: .Pa /dev/tuner0
! 56: device.
! 57: .Pp
! 58: The options are as follows:
! 59: .Bl -tag -width "name=value"
! 60: .It Fl a
! 61: Print all device variables and their current values.
! 62: .It Fl f Ar file
! 63: Specify an alternative tuner device.
! 64: .It Fl n
! 65: Suppress printing of the variable names.
! 66: .It Fl q
! 67: Suppress all printing when setting a variable.
! 68: .It Fl v
! 69: Show the possible values of enumeration and range valued queries.
! 70: Enumeration values are show in
! 71: .Dq []
! 72: and ranges are show in
! 73: .Dq () .
! 74: .It Ar name Ns = Ns Ar value
! 75: Attempt to set the specified variable
! 76: .Ar name
! 77: to
! 78: .Ar value .
! 79: .El
! 80: .Pp
! 81: Depending on the features of a specific tuner, the setting of some
! 82: variables may not have any effect.
! 83: .Pp
! 84: Variable names explained:
! 85: .Bl -tag -width contrast
! 86: .It Ic chanset
! 87: TV tuner channel set.
! 88: .It Ic channel
! 89: TV tuner channel.
! 90: .It Ic freq
! 91: Frequency in MHz.
! 92: .It Ic afc
! 93: Automatic Frequency Control.
! 94: .It Ic audio
! 95: Audio source.
! 96: .It Ic mute
! 97: Audio mute.
! 98: .It Ic bright
! 99: Video brightness.
! 100: .It Ic contrast
! 101: Video contrast.
! 102: .It Ic hue
! 103: Video hue.
! 104: .It Ic usat
! 105: Video
! 106: .Ql U
! 107: (blue) saturation.
! 108: .It Ic vsat
! 109: Video
! 110: .Ql V
! 111: (red) saturation.
! 112: .El
! 113: .Sh FILES
! 114: .Bl -tag -width /dev/tuner0
! 115: .It Pa /dev/tuner0
! 116: default tuner device
! 117: .El
! 118: .Sh EXAMPLES
! 119: The command
! 120: .Pp
! 121: .Dl "$ tunerctl chanset=nabcst channel=13"
! 122: .Pp
! 123: sets the tuner to North American broadcast TV channel 13.
! 124: .Sh SEE ALSO
! 125: .Xr bktr 4
! 126: .Sh AUTHORS
! 127: .Nm
! 128: and this manual page were written by
! 129: .An Jacob Meuser Aq jakemsr@jakemsr.com .