summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorAlexandre Ratchov <ratchov@cvs.openbsd.org>2011-12-09 14:38:10 +0000
committerAlexandre Ratchov <ratchov@cvs.openbsd.org>2011-12-09 14:38:10 +0000
commit34ca1a2c6b666fc98daf82367ae5c1bdfe2c0921 (patch)
tree447874bbf19b32292b83666e3bbe2087d1265b93 /lib
parent053a62add38eb0119c80db1a110d6e6cb2b5193d (diff)
mention sndiod rather than aucat when talking about the server
Diffstat (limited to 'lib')
-rw-r--r--lib/libsndio/mio_open.312
-rw-r--r--lib/libsndio/sio_open.318
-rw-r--r--lib/libsndio/sndio.740
3 files changed, 35 insertions, 35 deletions
diff --git a/lib/libsndio/mio_open.3 b/lib/libsndio/mio_open.3
index 030fabe2027..43ebd3b2989 100644
--- a/lib/libsndio/mio_open.3
+++ b/lib/libsndio/mio_open.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: mio_open.3,v 1.5 2011/10/17 21:09:11 ratchov Exp $
+.\" $OpenBSD: mio_open.3,v 1.6 2011/12/09 14:38:09 ratchov Exp $
.\"
.\" Copyright (c) 2007 Alexandre Ratchov <alex@caoua.org>
.\"
@@ -14,7 +14,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: October 17 2011 $
+.Dd $Mdocdate: December 9 2011 $
.Dt MIO_OPEN 3
.Os
.Sh NAME
@@ -51,7 +51,7 @@ The
library allows user processes to access
.Xr midi 4
hardware and
-.Xr aucat 1
+.Xr sndiod 1
MIDI thru boxes and control ports in a uniform way.
.Ss Opening and closing an MIDI stream
First the application must call the
@@ -63,7 +63,7 @@ argument of most other functions.
The
.Fn mio_open
function tries to connect to the
-.Xr aucat 1
+.Xr sndiod 1
MIDI thru box or to use the
.Xr midi 4
hardware port.
@@ -241,13 +241,13 @@ may be a value between 0 and 2.
.Bl -tag -width "/tmp/aucat-<uid>/aucat0" -compact
.It Pa /tmp/aucat-<uid>/aucat0
Default path to
-.Xr aucat 1
+.Xr sndiod 1
socket to connect to.
.It Pa /dev/rmidiX
.Xr midi 4
devices.
.El
.Sh SEE ALSO
-.Xr aucat 1 ,
+.Xr sndiod 1 ,
.Xr midi 4 ,
.Xr sndio 7
diff --git a/lib/libsndio/sio_open.3 b/lib/libsndio/sio_open.3
index d02d07e0fdb..001ed1f3402 100644
--- a/lib/libsndio/sio_open.3
+++ b/lib/libsndio/sio_open.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: sio_open.3,v 1.29 2011/10/17 21:09:11 ratchov Exp $
+.\" $OpenBSD: sio_open.3,v 1.30 2011/12/09 14:38:09 ratchov Exp $
.\"
.\" Copyright (c) 2007 Alexandre Ratchov <alex@caoua.org>
.\"
@@ -14,7 +14,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: October 17 2011 $
+.Dd $Mdocdate: December 9 2011 $
.Dt SIO_OPEN 3
.Os
.Sh NAME
@@ -80,11 +80,11 @@ The
library allows user processes to access
.Xr audio 4
hardware and the
-.Xr aucat 1
+.Xr sndiod 1
audio server in a uniform way.
It supports full-duplex operation, and when
used with the
-.Xr aucat 1
+.Xr sndiod 1
server it supports resampling and format
conversions on the fly.
.Ss Opening and closing an audio stream
@@ -97,7 +97,7 @@ argument of most other functions.
The
.Fn sio_open
function first tries to connect to the
-.Xr aucat 1
+.Xr sndiod 1
audio server.
If that fails, it then tries to use the
.Xr audio 4
@@ -273,7 +273,7 @@ must be called before parameters can be changed.
If
.Nm libsndio
is used to connect to the
-.Xr aucat 1
+.Xr sndiod 1
server, a transparent emulation layer will
automatically be set up, and in this case any
parameters are supported.
@@ -737,7 +737,7 @@ may be a value between 0 and 2.
.Bl -tag -width "/tmp/aucat-<uid>/aucat0" -compact
.It Pa /tmp/aucat-<uid>/aucat0
Default path to
-.Xr aucat 1
+.Xr sndiod 1
socket to connect to.
.It Pa /dev/audio
Default
@@ -748,7 +748,7 @@ device to use.
.\".Bd -literal -offset indent
.\".Ed
.Sh SEE ALSO
-.Xr aucat 1 ,
+.Xr sndiod 1 ,
.Xr audio 4 ,
.Xr sndio 7 ,
.Xr audio 9
@@ -765,7 +765,7 @@ the
function will stop playback immediately.
.Pp
The
-.Xr aucat 1
+.Xr sndiod 1
server doesn't implement flow control (for performance reasons).
If the application doesn't consume recorded data fast enough then
.Dq "control messages"
diff --git a/lib/libsndio/sndio.7 b/lib/libsndio/sndio.7
index 6336cb6e739..143117430f0 100644
--- a/lib/libsndio/sndio.7
+++ b/lib/libsndio/sndio.7
@@ -1,4 +1,4 @@
-.\" $OpenBSD: sndio.7,v 1.8 2011/11/15 08:05:22 ratchov Exp $
+.\" $OpenBSD: sndio.7,v 1.9 2011/12/09 14:38:09 ratchov Exp $
.\"
.\" Copyright (c) 2007 Alexandre Ratchov <alex@caoua.org>
.\"
@@ -14,7 +14,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: November 15 2011 $
+.Dd $Mdocdate: December 9 2011 $
.Dt SNDIO 7
.Os
.Sh NAME
@@ -25,7 +25,7 @@ The
.Nm sndio
audio and MIDI system provides access to audio and MIDI hardware and
to services provided by
-.Xr aucat 1 ,
+.Xr sndiod 1 ,
summarized below.
.Pp
Hardware
@@ -38,7 +38,7 @@ audio programs.
.Pp
To overcome hardware limitations and to allow multiple applications
to share the hardware,
-.Xr aucat 1
+.Xr sndiod 1
can be used.
It exposes one or more software subdevices backed by the underlying hardware,
while doing all necessary conversions on the fly.
@@ -57,15 +57,15 @@ Software MIDI thru boxes allow one application to send MIDI data to other
applications connected to the thru box (for instance a software sequencer
can send events to multiple software synthesizers).
There's no hardware involved: thru boxes are created by
-.Xr aucat 1 .
+.Xr sndiod 1 .
.Pp
Additionally,
-.Xr aucat 1
+.Xr sndiod 1
exposes a MIDI port used to control and monitor audio streams
in real time using MIDI.
.Sh DEVICE NAMES
From the user's perspective every audio interface, MIDI port, and
-.Xr aucat 1
+.Xr sndiod 1
service has a name of the form:
.Bd -literal -offset center
type[@hostname][,unit]/devnum[.option]
@@ -89,31 +89,31 @@ Raw
port.
.It Pa snd
Audio device exposed by
-.Xr aucat 1 .
+.Xr sndiod 1 .
.It Pa midithru
MIDI thru box created with
-.Xr aucat 1 .
+.Xr sndiod 1 .
.El
.It Pa hostname
The hostname or address where the remote
-.Xr aucat 1
+.Xr sndiod 1
server to connect to is running.
.It Pa unit
The number of the
-.Xr aucat 1
+.Xr sndiod 1
server to connect to, corresponding to the integer specified using the
.Fl U
option of
-.Xr aucat 1 .
+.Xr sndiod 1 .
Useful only if multiple
-.Xr aucat 1
+.Xr sndiod 1
servers are running on the same system.
.It Pa devnum
Device number.
For hardware audio or MIDI ports, this corresponds to
the character device minor number.
For audio devices or MIDI ports created with
-.Xr aucat 1
+.Xr sndiod 1
it corresponds to the number of the corresponding
.Fl fM
option on the command line.
@@ -121,7 +121,7 @@ option on the command line.
Corresponds to the sub-device string registered using the
.Fl s
option of
-.Xr aucat 1 .
+.Xr sndiod 1 .
.El
.Pp
For example:
@@ -133,17 +133,17 @@ First hardware audio device.
Hardware MIDI port number 5.
.It Pa snd/0
First audio device exposed by
-.Xr aucat 1 .
+.Xr sndiod 1 .
.It Pa snd/0.rear
Sub-device registered with
.Fl s Fa rear .
.It Pa midithru/0
First MIDI thru box created with
-.Xr aucat 1 .
+.Xr sndiod 1 .
.El
.Sh AUTHENTICATION
If a shared
-.Xr aucat 1
+.Xr sndiod 1
server is running, for privacy reasons only one user may have
connections to it at a given time
(though the same user could have multiple connections to it).
@@ -162,7 +162,7 @@ can connect to the server using the same cookie.
.It AUCAT_COOKIE
Path to file containing the session cookie to be used
when connecting to
-.Xr aucat 1 .
+.Xr sndiod 1 .
.It Ev AUDIODEVICE
Audio device to use if the application provides
no device chooser.
@@ -181,7 +181,7 @@ Audio devices.
MIDI ports.
.El
.Sh SEE ALSO
-.Xr aucat 1 ,
+.Xr sndiod 1 ,
.Xr mio_open 3 ,
.Xr sio_open 3 ,
.Xr audio 4 ,