Return to sndioctl.1 CVS log

Up to [local] / src / usr.bin / sndioctl

Annotation of src/usr.bin/sndioctl/sndioctl.1, Revision 1.8

1.8     ! ratchov     1: .\" $OpenBSD: sndioctl.1,v 1.7 2020/04/21 13:05:04 ratchov Exp $
1.1       ratchov     2: .\"
                      3: .\" Copyright (c) 2014-2020 Alexandre Ratchov <alex@caoua.org>
                      4: .\"
                      5: .\" Permission to use, copy, modify, and distribute this software for any
                      6: .\" purpose with or without fee is hereby granted, provided that the above
                      7: .\" copyright notice and this permission notice appear in all copies.
                      8: .\"
                      9: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     10: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     11: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     12: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     13: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     14: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     15: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
                     16: .\"
1.8     ! ratchov    17: .Dd $Mdocdate: April 21 2020 $
1.1       ratchov    18: .Dt SNDIOCTL 1
                     19: .Os
                     20: .Sh NAME
                     21: .Nm sndioctl
                     22: .Nd control audio parameters
                     23: .Sh SYNOPSIS
                     24: .Nm
                     25: .Bk -words
1.6       ratchov    26: .Op Fl dimnqv
1.1       ratchov    27: .Op Fl f Ar device
                     28: .Op Ar command ...
                     29: .Ek
                     30: .Sh DESCRIPTION
                     31: The
                     32: .Nm
                     33: utility can display or change parameters of
                     34: .Xr sndio 7
                     35: audio devices.
                     36: The options are as follows:
                     37: .Bl -tag -width Ds
                     38: .It Fl d
                     39: Dump the raw list of available parameters and exit.
                     40: Useful as a debugging tool.
                     41: .It Fl f Ar device
                     42: Use this
                     43: .Xr sndio 7
                     44: audio device.
                     45: .It Fl i
                     46: Display characteristics of requested parameters
                     47: instead of their values.
                     48: .It Fl m
                     49: Monitor and display audio parameter changes.
1.5       ratchov    50: .It Fl n
                     51: Suppress printing of the variable name.
1.6       ratchov    52: .It Fl q
                     53: Suppress all printing when setting a variable.
1.1       ratchov    54: .It Fl v
                     55: Enable verbose mode, a.k.a. multi-channel mode.
                     56: By default parameters affecting different channels
                     57: of the same stream are disguised as a single mono
                     58: parameter to hide details that are not essential.
                     59: .El
                     60: .Pp
                     61: If no commands are specified all valid parameters are displayed on
                     62: .Em stdout .
                     63: Unless
                     64: .Fl d ,
                     65: .Fl m ,
1.5       ratchov    66: .Fl n ,
1.1       ratchov    67: or
                     68: .Fl i
                     69: are used, displayed parameters are valid commands.
                     70: The set of available controls depends on the control device.
                     71: .Pp
                     72: Commands use the following two formats to display and set
                     73: parameters respectively:
                     74: .Pp
                     75: .Dl group/stream[channel].function
                     76: .Dl group/stream[channel].function=value
                     77: .Pp
                     78: On the left-hand side are specified the optional parameter group,
                     79: the affected stream name, and the optional channel number.
                     80: Examples of left-hand side terms:
                     81: .Pp
                     82: .Dl output.level
1.8     ! ratchov    83: .Dl output[0].level
1.1       ratchov    84: .Pp
1.4       ratchov    85: Values are numbers between 0 and 1.
1.1       ratchov    86: Two-state controls (switches) take either 0 or 1 as value,
                     87: typically corresponding to the
                     88: .Em off
                     89: and
                     90: .Em on
                     91: states respectively.
                     92: .Pp
                     93: If a decimal is prefixed by the plus (minus) sign then
                     94: the given value is added to (subtracted from) the
                     95: current value of the control.
                     96: If
                     97: .Qq \&!
                     98: is used instead of a number, then the switch is toggled.
                     99: .Sh EXAMPLES
                    100: The following will set all
1.8     ! ratchov   101: .Ar output
        !           102: channels
1.1       ratchov   103: .Ar level
1.8     ! ratchov   104: control to zero:
1.1       ratchov   105: .Pp
1.8     ! ratchov   106: .Dl $ sndioctl output.level=0
1.1       ratchov   107: .Pp
1.8     ! ratchov   108: The following set all
        !           109: .Ar output
        !           110: channels
        !           111: .Ar mute
        !           112: control:
1.1       ratchov   113: .Pp
1.8     ! ratchov   114: .Dl $ sndioctl output.mute=0
1.1       ratchov   115: .Sh SEE ALSO
                    116: .Xr sioctl_open 3