summaryrefslogtreecommitdiff
path: root/lib/libsndio/sndio.7
diff options
context:
space:
mode:
authorAlexandre Ratchov <ratchov@cvs.openbsd.org>2016-01-07 07:41:02 +0000
committerAlexandre Ratchov <ratchov@cvs.openbsd.org>2016-01-07 07:41:02 +0000
commitd7f69232e0fb03e78831a578522925635817b46b (patch)
treede057eaea7a469978897783ccf918aa5f46ecc07 /lib/libsndio/sndio.7
parentab8a655c8ccbfc61525bcc23809c40e2df0480e2 (diff)
Move sndiod man page to section 8.
suggested by deraadt, fixes from jmc, ok millert
Diffstat (limited to 'lib/libsndio/sndio.7')
-rw-r--r--lib/libsndio/sndio.746
1 files changed, 23 insertions, 23 deletions
diff --git a/lib/libsndio/sndio.7 b/lib/libsndio/sndio.7
index aeca1afbb70..7332ce381c4 100644
--- a/lib/libsndio/sndio.7
+++ b/lib/libsndio/sndio.7
@@ -1,4 +1,4 @@
-.\" $OpenBSD: sndio.7,v 1.16 2015/11/25 17:22:36 ratchov Exp $
+.\" $OpenBSD: sndio.7,v 1.17 2016/01/07 07:41:01 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 25 2015 $
+.Dd $Mdocdate: January 7 2016 $
.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 sndiod 1 ,
+.Xr sndiod 8 ,
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 sndiod 1
+.Xr sndiod 8
can be used.
It exposes one or more software sub-devices 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 sndiod 1 .
+.Xr sndiod 8 .
.Pp
Additionally,
-.Xr sndiod 1
+.Xr sndiod 8
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 sndiod 1
+.Xr sndiod 8
service has a name of the form:
.Bd -literal -offset center
type[@hostname][,unit]/devnum[.option]
@@ -89,36 +89,36 @@ Raw
port.
.It Pa snd
Audio device exposed by
-.Xr sndiod 1 .
+.Xr sndiod 8 .
.It Pa midithru
MIDI thru box created with
-.Xr sndiod 1 .
+.Xr sndiod 8 .
.It Pa midi
MIDI port exposed by
-.Xr sndiod 1 .
+.Xr sndiod 8 .
.It Pa default
Default audio device or MIDI port (see below).
.El
.It Pa hostname
The hostname or address where the remote
-.Xr sndiod 1
+.Xr sndiod 8
server to connect to is running.
.It Pa unit
The number of the
-.Xr sndiod 1
+.Xr sndiod 8
server to connect to, corresponding to the integer specified using the
.Fl U
option of
-.Xr sndiod 1 .
+.Xr sndiod 8 .
Useful only if multiple
-.Xr sndiod 1
+.Xr sndiod 8
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 sndiod 1
+.Xr sndiod 8
it corresponds to the number of the corresponding
.Fl fq
option on the command line.
@@ -126,7 +126,7 @@ option on the command line.
Corresponds to the sub-device string registered using the
.Fl s
option of
-.Xr sndiod 1 .
+.Xr sndiod 8 .
.El
.Pp
For example:
@@ -138,13 +138,13 @@ First hardware audio device.
Hardware MIDI port number 5.
.It Pa snd/0
First audio device exposed by
-.Xr sndiod 1 .
+.Xr sndiod 8 .
.It Pa snd/0.rear
Sub-device registered with
.Fl s Fa rear .
.It Pa midithru/0
First MIDI thru box created with
-.Xr sndiod 1 .
+.Xr sndiod 8 .
.El
.Sh DEFAULTS
If
@@ -158,10 +158,10 @@ If it is not set, the program first tries to connect to
If that fails, it then tries to use
.Pa rsnd/0 .
This allows the
-.Xr sndiod 1
+.Xr sndiod 8
audio server to be used by default and the bare hardware as fallback;
programs don't have to be reconfigured when
-.Xr sndiod 1
+.Xr sndiod 8
is started or stopped.
.Pp
If
@@ -175,14 +175,14 @@ If it is not set, the program first tries to connect to
If that fails, it then tries to use
.Pa rmidi/0 .
As long as
-.Xr sndiod 1
+.Xr sndiod 8
is running, this allows programs to exchange MIDI data on
machines with no MIDI hardware by default, e.g. a MIDI player
could use a software synthesizer with no manual configuration
required.
.Sh AUTHENTICATION
If a shared
-.Xr sndiod 1
+.Xr sndiod 8
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).
@@ -216,7 +216,7 @@ Audio devices.
MIDI ports.
.El
.Sh SEE ALSO
-.Xr sndiod 1 ,
+.Xr sndiod 8 ,
.Xr mio_open 3 ,
.Xr sio_open 3 ,
.Xr audio 4 ,