Takashi Iwai <iwai@ww.uni-erlangen.de>

Initial code.

test/aconnect.1

@@ -0,0 +1,127 @@
+.TH aconnect 1 "January 1, 2000"
+.LO 1
+.SH NAME
+aconnect \- ALSA sequencer connection manager
+
+.SH SYNOPSIS
+.B aconnect
+[\-d] [-options] sender receiver
+.br
+.B aconnect
+\-i|-o [-options]
+
+.SH DESCRIPTION
+.B aconnect
+is a utility to connect and disconnect two existing ports on ALSA sequencer
+system.
+The ports with the arbitrary subscription permission, such as created
+by
+.B aseqview(1),
+can be connected to any (MIDI) device ports using
+.B aconnect.
+For example, to connect from port 64:0 to 65:0, run as follows:
+.IP "" 4
+% aconnect 64:0 65:0
+.PP
+The connection is one-way, and the whole data to the sender port (64:0)
+is redirected to the receiver port (65:0).  When another port (e.g. 65:1)
+is attached to the same sender port, the data is sent to both receiver
+ports.
+For disconnection, use
+.B \-d
+option.
+.IP "" 4
+% aconnect -d 64:0 65:0
+.PP
+Another function of
+.B aconnect
+is to list the present ports
+on the given condition.
+The input ports, which may become
+.I sender
+ports, can be listed with
+.B \-i
+option.
+.IP "" 4
+% aconnect -i
+.br
+client 0: 'System' [group=system] [type=kernel]
+.in +4
+0 'Timer           ' [group=system]
+.br
+1 'Announce        ' [group=system]
+.in -4
+client 64: '0: MIDI Synth' [group=] [type=kernel]
+.in +4
+0 'card 0: synth-midi: 0' [group=device]
+.in -4
+.PP
+Similary, to see the output ports, use
+.B \-o
+flag.
+
+.SH OPTIONS
+.SS CONNNECTION MANAGEMENT
+.TP
+.B \-d, --disconnect
+Disconnect the given subscription.
+.TP
+.B \-e, --exclusive
+Connect ports with exclusvie mode.
+Both sender and receiver ports can be no longer connected by any other ports.
+.TP
+.B \-r, --real queue
+Convert time-stamps of event packets to the current value of the given
+.I real-time
+queue.
+This is option is, however, not so useful, since
+the receiver port must use (not necessarily own) the specified queue.
+.TP
+.B \-t, --tick queue
+Like
+.B -r
+option, but 
+time-stamps are converted to the current value of the given
+.I tick
+queue.
+.TP
+.B \-g, --group name
+Specify the group name that
+.B aconnect
+uses.
+Some ports may have special permissions, so that only the same group
+may subscribe to them.  In such a case,
+.B aconnect
+can fake the group name
+with this option.
+
+.SS LIST PORTS
+.TP
+.B \-i, --input
+List existing input (readable) ports.
+This option is exclusive to
+.B \-o.
+.TP
+.B \-o, --output
+List existing output (writable) ports.
+This option is exclusive to
+.B \-i.
+.TP
+.B \-l, --list
+List the current connection status.  The connected and connecting ports
+from/to each port are listed together.
+The suffix flag
+.B [ex]
+means the connection is exclusive.
+The suffix flag
+.B [real:#]
+and
+.B [tick:#]
+mean the connection includes real-time and tick conversion on the listed
+queue, respectively.
+
+.SH "SEE ALSO"
+aseqnet(1), aseqview(1)
+
+.SH AUTHOR
+Takashi Iwai <iwai@ww.uni-erlangen.de>.

test/aseqnet.1

@@ -0,0 +1,78 @@
+.TH aseqnet 1 "January 1, 2000"
+.LO 1
+.SH NAME
+aseqnet \- ALSA sequencer connectors over network
+
+.SH SYNOPSIS
+.B aseqnet
+[remotehost]
+
+.SH DESCRIPTION
+.B aseqnet
+is an ALSA sequencer client which sends and receives event packets
+over network.
+Suppose two hosts connected by network,
+.I hostA
+as a server
+and
+.I hostB
+as a client.
+The ALSA sequencer system must be running on both hosts.
+For creating the server port, run the following on hostA:
+.IP "" 4
+hostA% aseqnet
+.br
+sequencer opened: 128:0
+.PP
+Then a user client 128 with port 0 was opened on hostA.
+(The client number may vary.)
+For creating the (network-)client port, run
+.B aseqnet
+with the hostname of the server:
+.IP "" 4
+hostB% aseqnet hostA
+.br
+sequencer opened: 132:0
+.PP
+Now all events sent to hostA:128:0 are transferred to hostB:132:0, and vice
+versa.
+.PP
+The ports created by
+.B aseqnet
+can be connected arbitrary to other sequencer ports via
+.B aconnect(1).
+For example, to connect hostB:132:0 to a MIDI output device 65:0:
+.IP "" 4
+hostB% aconnect 132:0 65:0
+.PP
+Then events to hostA:128:0 will be delivered to hostB:65:0.
+The following command plays MIDI on
+.I hostB.
+.IP "" 4
+hostA% pmidi -p 128:0 foo.mid
+.PP
+The multiple clients may exist simultaneously.  If
+.I hostC
+is connected as a client to hostA, events from from hostA are sent
+to all connected network clients, i.e. hostB and hostC.
+However, only one connection is allowed from a client to a server.
+.PP
+To disconnect network, stop all clients before server by ctrl-C or
+sending signal to them.  The server will automatically quit.
+
+.SH OPTIONS
+.TP
+.B \-p port
+Specify the TCP port number or TCP service name.
+.TP
+.B \-s addr
+Subscribe to the given address for read automatically.
+.TP
+.B \-d addr
+Subscribe to the given address for write automatically.
+
+.SH "SEE ALSO"
+aconnect(1), pmidi(1)
+
+.SH AUTHOR
+Takashi Iwai <iwai@ww.uni-erlangen.de>.