summaryrefslogtreecommitdiff
path: root/lib/libsndio/sndio.7
diff options
context:
space:
mode:
Diffstat (limited to 'lib/libsndio/sndio.7')
-rw-r--r--lib/libsndio/sndio.736
1 files changed, 33 insertions, 3 deletions
diff --git a/lib/libsndio/sndio.7 b/lib/libsndio/sndio.7
index fd4632d0b84..1c5237c66c2 100644
--- a/lib/libsndio/sndio.7
+++ b/lib/libsndio/sndio.7
@@ -1,4 +1,4 @@
-.\" $OpenBSD: sndio.7,v 1.3 2011/04/16 11:58:41 ratchov Exp $
+.\" $OpenBSD: sndio.7,v 1.4 2011/04/28 06:19:57 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: April 16 2011 $
+.Dd $Mdocdate: April 28 2011 $
.Dt SNDIO 7
.Os
.Sh NAME
@@ -72,7 +72,7 @@ or
.Xr midicat 1
service has a name of the form:
.Bd -literal -offset center
-type:unit[.option]
+type:[hostname/]unit[.option]
.Ed
.Pp
This information is used by audio and MIDI applications to determine
@@ -101,6 +101,12 @@ software MIDI thru boxes, hardware
ports and
.Xr aucat 1
control through MIDI respectively.
+.It Pa hostname
+The hostname where the remote
+.Xr aucat 1
+or
+.Xr midicat 1
+server to connect to is running.
.It Pa unit
For hardware audio or MIDI devices, this corresponds to
the character device minor number.
@@ -146,8 +152,32 @@ MIDI port controlling the first
.Xr aucat 1
audio server.
.El
+.Sh AUTHENTICATION
+If a shared
+.Xr aucat 1
+or
+.Xr midicat 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).
+Users are identified by their
+.Em session cookie ,
+which is automatically generated by audio or MIDI applications
+upon the first connection to the server.
+The cookie is stored in
+.Pa "$HOME/.aucat_cookie"
+and contains 128 bits of raw random data.
+.Pp
+If a session needs to be shared between multiple users, they
+can connect to the server using the same cookie.
.Sh ENVIRONMENT
.Bl -tag -width "AUDIODEVICEXXX" -compact
+.It AUCAT_COOKIE
+Path to file containing the session cookie to be used
+when connecting to
+.Xr aucat
+or
+.Xr midicat .
.It Ev AUDIODEVICE
Audio device to use if the application provides
no device chooser.