Changeset View
Changeset View
Standalone View
Standalone View
usr.sbin/sndctl/sndctl.8
| Show All 21 Lines | |||||
| .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||||
| .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | ||||
| .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||||
| .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||
| .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||||
| .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||
| .\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||
| .\" | .\" | ||||
| .Dd May 5, 2025 | .Dd December 2, 2025 | ||||
| .Dt SNDCTL 8 | .Dt SNDCTL 8 | ||||
| .Os | .Os | ||||
| .Sh NAME | .Sh NAME | ||||
| .Nm sndctl | .Nm sndctl | ||||
| .Nd list and modify soundcard properties | .Nd list and modify soundcard properties | ||||
| .Sh SYNOPSIS | .Sh SYNOPSIS | ||||
| .Nm | .Nm | ||||
| .Op Fl -libxo | |||||
| .Op Fl f Ar device | .Op Fl f Ar device | ||||
| .Op Fl hov | .Op Fl hov | ||||
| .Op Ar control Ns Oo = Ns Ar value Oc Ar ... | .Op Ar control Ns Oo = Ns Ar value Oc Ar ... | ||||
| .Sh DESCRIPTION | .Sh DESCRIPTION | ||||
| The | The | ||||
| .Nm | .Nm | ||||
| utility is used to set and display sound card properties, using a | utility is used to set and display sound card properties, using a | ||||
| control-driven interface, in order to filter and/or set specific properties. | control-driven interface, in order to filter and/or set specific properties. | ||||
| .Pp | .Pp | ||||
| The options are as follows: | The options are as follows: | ||||
| .Bl -tag -width "-f device" | .Bl -tag -width "-f device" | ||||
| .It Fl -libxo | |||||
| Generate output via | |||||
| .Xr libxo 3 | |||||
| in a selection of different human and machine readable formats. | |||||
| See | |||||
| .Xr xo_options 7 | |||||
| for details on command line arguments. | |||||
| .It Fl f Ar device | .It Fl f Ar device | ||||
| Choose a specific audio device | Choose a specific audio device | ||||
| .Pq see Sx FILES . | .Pq see Sx FILES . | ||||
| Userland devices (e.g those registered by | Userland devices (e.g those registered by | ||||
| .Xr virtual_oss 8 | .Xr virtual_oss 8 | ||||
| can also be selected. | can also be selected. | ||||
| .It Fl h | .It Fl h | ||||
| Print a help message. | Print a help message. | ||||
| ▲ Show 20 Lines • Show All 112 Lines • ▼ Show 20 Lines | |||||
| information to a file and retrieve back later: | information to a file and retrieve back later: | ||||
| .Bd -literal -offset indent | .Bd -literal -offset indent | ||||
| $ sndctl -f /dev/dsp0 -o > info | $ sndctl -f /dev/dsp0 -o > info | ||||
| \&... | \&... | ||||
| $ sndctl -f /dev/dsp0 `cat info` | $ sndctl -f /dev/dsp0 `cat info` | ||||
| .Ed | .Ed | ||||
| .Sh SEE ALSO | .Sh SEE ALSO | ||||
| .Xr sndstat 4 , | .Xr sndstat 4 , | ||||
| .Xr sound 4 , | .Xr sound 4 , | ||||
| .Xr xo_options 7 , | |||||
ziaee: I think xo_options is really what's relevant to the reader of sndctl. That links to libxo(3) if… | |||||
Done Inline ActionsI followed what w(1) and wc(1)'s man pages say. christos: I followed what w(1) and wc(1)'s man pages say. | |||||
Done Inline ActionsI think it's wrong there too, but that isn't a good argument for why we should do it here. What does the reader or soundctl might want to see also? xo_options explains how to actually use it. ziaee: I think it's wrong there too, but that isn't a good argument for why we should do it here. | |||||
Done Inline ActionsI think xo_options(7) is the reasonable think to refer to, since this isn't a programing manual about how the internals of sndctl(8) work, but how to use the utility with --libxo, which is explained in xo_options(7). This isn't wrong. christos: I think xo_options(7) is the reasonable think to refer to, since this isn't a programing manual… | |||||
Done Inline ActionsThat is what I am saying. You should link to xo_options(7). The diff is currently linking to libxo(3) instead. ziaee: That is what I am saying. You should link to xo_options(7). The diff is currently linking to… | |||||
Done Inline Actions...Scratch that. I am an idiot. I thought you said the opposite, and I also thought the patch did the right thing. christos: ...Scratch that. I am an idiot. I thought you said the opposite, and I also thought the patch… | |||||
Not Done Inline ActionsActually it happens to everyone! ziaee: Actually it happens to everyone! | |||||
| .Xr mixer 8 , | .Xr mixer 8 , | ||||
| .Xr sysctl 8 | .Xr sysctl 8 | ||||
| .Sh AUTHORS | .Sh AUTHORS | ||||
| The | The | ||||
| .Nm | .Nm | ||||
| utility was implemented by | utility was implemented by | ||||
| .An Christos Margiolis Aq Mt christos@FreeBSD.org | .An Christos Margiolis Aq Mt christos@FreeBSD.org | ||||
| under sponsorship from the | under sponsorship from the | ||||
| .Fx | .Fx | ||||
| Foundation. | Foundation. | ||||
I think xo_options is really what's relevant to the reader of sndctl. That links to libxo(3) if they're curious.