ROARD(1)

NAME

roard - RoarAudio sound server

SYNOPSIS

roard [OPTIONS]...

DESCRIPTION

roard is the RoarAudio central daemon. It mixes up diffrent audio streams from it's clients to send them as a single stream to the soundcard.

GENERAL OPTIONS

NOTE: This list is incomplete!

--help Print some help text.

--daemon
Go into background after startup.
--realtime
Ask for higher priority. May be used multiple times.
--chroot DIR
Chroots to the given directory. This improves the security. This normally needs root privileg's.

USER AND GROUPS

--setgid
Sets GroupID to the audio group as specified via -G.
--setuid
Sets UserID to the audio user as specified via -U.
-G GROUP
Sets the group for the UNIX Domain Socket, (default: audio) You need the permittions to change the GID.
-U USER
Sets the user for the UNIX Domain Socket, (default: do not set) You need the permittions to change the UID (normaly only root has).

AUDIO OPTIONS

--rate RATE, -R RATE
Set server sample rate.
--bits BITS, -B BITS
Set server bits.
--chans CHANNELS, -C CHANNELS
Set server channels.

DRIVER OPTIONS

--list-driver
Shows a list of all available drivers.
--driver, -d
This option is obsolete. Use -o instead.
--device, -D
This option is obsolete. Use -O instead.
--odriver, -o
Set the output driver. To get a list of all drivers use --list-driver.
--odevice, -O
Set the device for the output driver. Possible devices depends on the driver. They may be a path to a device node or a hostname. Use --list-driver to get a hint.
-oO Sets options for the new stream. See STREAM OPTIONS.
-oN Adds another output.
-oP Marks the output primary.

SOURCE OPTIONS

--source, -s
Adds a source of the given type.
-S Sets the device or filename for the source. Type may depend on
the source type.
-sO Sets options for the current source.
-sN Adds another source.
-sP Marks the source as primary. If the source reaches EOF roard
will quit automatically.

NETWORK OPTIONS

--tcp, -t
Sets defaults for TCP/IP Socket.
--unix, -u
Sets defaults for UNIX Domain Socket.
--decnet, -n
Sets defaults for DECnet Socket.
--port, -p
Sets the port the server should listen on.
--bind, -b, --sock
Sets the hostname or path the server should listen on.
--no-listen
Do not listen for new clients (only useful for relaing, impleys --terminate).
--client-fh FH
Expects a client on the given FH. This may be useful with --no-listen.
--close-fh FH
Close the given FH. This is not useful for endusers but used internaly.

STREAM OPTIONS

rate Sets the sample rate.

channels
Sets the number of channels.
bits Sets the number of bits per sample.
codec Sets the codec.
blocks Sets the number of memory blocks that sould be used by the
devices. Most devices only support a few values or don't support this option at all. If this option or the specifyed value is not supported by the device this is not handled as fatal error.
blocksize
Sets the size of the memory blocks used by the device. Most devices only support a few values or don't support this option at all. If this option or the specifyed value is not supported by the device this is not handled as fatal error.
meta Sets the meta flag.
sync Sets the sync flag.
primary
Marks this stream as primary.
cleanmeta
Sets the cleanmeta flag.
autoconf
Sets the autoconf flag. This flag is not supported by all drivers. If the flag is set and the devices does not support this there is no fatal error if the device could be opend with defaults.
Example:
rate=44100,bits=16,channels=2,codec=pcm,sync

ENVIRONMENT VARIABLES

HOME The users home directory.

ROAR_SERVER
The address of the listening server. This may be in form of host:port for TCP/IP connections and /path/to/sock for UNIX Domain Sockets.
ROAR_DRIVER
The driver to select. Same as -d.
ROAR_DEVICE
The device to select. Same as -D.

BUGS

There are lots of bugs...

SEE ALSO

roar-config(1), roarcat(1), roarcat2sock(1), roarcatad(1), roarctl(1), roarfilt(1), roarfish(1), roarmon(1), roarsockconnect(1), roartypes(1), roarvorbis(1), RoarAudio(7).

HISTORY

For history information see RoarAudio(7).
Copyright © 2010-2025 Platon Technologies, s.r.o.           Home | Man pages | tLDP | Documents | Utilities | About
Design by styleshout