mirror of https://github.com/ericonr/sndio.git
move sndiod manual to sec 8
This commit is contained in:
Alexandre Ratchov
parent
5219e9d39d
commit
aa4fc43964
|
|
@ -87,7 +87,7 @@ Increase log verbosity.
|
|||
Encoding of the audio file.
|
||||
The default is
|
||||
.Va s16 .
|
||||
Encoding names use the follwing scheme: signedness
|
||||
Encoding names use the following scheme: signedness
|
||||
.Po
|
||||
.Va s
|
||||
or
|
||||
|
|
@ -223,7 +223,7 @@ back to the starting position.
|
|||
.El
|
||||
.Pp
|
||||
MIDI control is intended to be used together with
|
||||
.Xr sndiod 1 .
|
||||
.Xr sndiod 8 .
|
||||
For instance, the following command will create two devices:
|
||||
the default
|
||||
.Va snd/0
|
||||
|
|
@ -280,9 +280,9 @@ $ aucat -n -i stereo.wav -c 0:0 -o left.wav \e
|
|||
.Xr audioctl 1 ,
|
||||
.Xr cdio 1 ,
|
||||
.Xr mixerctl 1 ,
|
||||
.Xr sndiod 1 ,
|
||||
.Xr audio 4 ,
|
||||
.Xr sndio 7
|
||||
.Xr sndio 7 ,
|
||||
.Xr sndiod 8
|
||||
.Sh BUGS
|
||||
Resampling is low quality.
|
||||
.Pp
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@ The
|
|||
library allows user processes to access
|
||||
.Xr midi 4
|
||||
hardware and
|
||||
.Xr sndiod 1
|
||||
.Xr sndiod 8
|
||||
MIDI thru boxes and control ports in a uniform way.
|
||||
.Ss Opening and closing an MIDI stream
|
||||
First the application must call the
|
||||
|
|
@ -243,7 +243,7 @@ The debug level:
|
|||
may be a value between 0 and 2.
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr sndiod 1 ,
|
||||
.Xr poll 2 ,
|
||||
.Xr midi 4 ,
|
||||
.Xr sndio 7
|
||||
.Xr sndio 7 ,
|
||||
.Xr sndiod 8
|
||||
|
|
|
|||
|
|
@ -80,7 +80,7 @@ The
|
|||
library allows user processes to access
|
||||
.Xr audio 4
|
||||
hardware and the
|
||||
.Xr sndiod 1
|
||||
.Xr sndiod 8
|
||||
audio server in a uniform way.
|
||||
.Ss Opening and closing an audio device
|
||||
First the application must call the
|
||||
|
|
@ -255,7 +255,7 @@ has been called,
|
|||
must be called before parameters can be changed.
|
||||
.Pp
|
||||
If the device is exposed by the
|
||||
.Xr sndiod 1
|
||||
.Xr sndiod 8
|
||||
server, which is the default configuration,
|
||||
a transparent emulation layer will
|
||||
automatically be set up, and in this case any combination of
|
||||
|
|
@ -709,9 +709,9 @@ The debug level:
|
|||
may be a value between 0 and 2.
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr sndiod 1 ,
|
||||
.Xr audio 4 ,
|
||||
.Xr sndio 7 ,
|
||||
.Xr sndiod 8 ,
|
||||
.Xr audio 9
|
||||
.Sh BUGS
|
||||
The
|
||||
|
|
@ -727,7 +727,7 @@ function will stop playback immediately.
|
|||
If the application doesn't consume recorded data fast enough then
|
||||
.Dq "control messages"
|
||||
from the
|
||||
.Xr sndiod 1
|
||||
.Xr sndiod 8
|
||||
server are delayed and consequently
|
||||
.Fn sio_onmove
|
||||
callback or volume changes may be delayed.
|
||||
|
|
|
|||
|
|
@ -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,8 +216,8 @@ Audio devices.
|
|||
MIDI ports.
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr sndiod 1 ,
|
||||
.Xr mio_open 3 ,
|
||||
.Xr sio_open 3 ,
|
||||
.Xr audio 4 ,
|
||||
.Xr midi 4
|
||||
.Xr midi 4 ,
|
||||
.Xr sndiod 8
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@
|
|||
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
.\"
|
||||
.Dd $Mdocdate$
|
||||
.Dt SNDIOD 1
|
||||
.Dt SNDIOD 8
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm sndiod
|
||||
|
|
@ -160,7 +160,7 @@ logs on
|
|||
Attempt to configure the device to use this encoding.
|
||||
The default is
|
||||
.Va s16 .
|
||||
Encoding names use the follwing scheme: signedness
|
||||
Encoding names use the following scheme: signedness
|
||||
.Po
|
||||
.Va s
|
||||
or
|
||||
Loading…
Reference in New Issue