speech-dispatcher: Address specification
3.2 Address specification
=========================
Speech Dispatcher provies several methods of communication and can be
used both locally and over network. Communication mechanisms.
Client applications and interface libraries need to recognize an
address, which specifies how and where to contact the appropriate
server.
Address specification consits from the method and one or more of its
parameters, each item separated by a colon:
method:parameter1:parameter2
The method is either 'unix_socket' or 'inet_socket'. Parameters are
optional. If not used in the address line, their default value will be
used.
Two forms are currently recognized:
unix_socket:full/path/to/socket
inet_socket:host_ip:port
Examples of valid address lines are:
unix_socket
unix_socket:/tmp/test.sock
inet_socket
inet_socket:192.168.0.34
inet_socket:192.168.0.34:6563
Clients implement different mechanisms how the user can set the
address. Clients should respect the SPEECHD_ADDRESS environment
variable Setting Communication Method, unless the user
ovverrides its value by settins in the client application itself.
Clients should fallback to the default address, if neither the
environment variable or their specific configuration is set.
The default communication address currently is:
unix_socket:/$XDG_RUNTIME_DIR/speech-dispatcher/speechd.sock
where '~' stands for the path to the users home directory.