Provided by: roaraudio_0.4-2_i386
roard - RoarAudio sound server
roard is the most common RoarAudio sound server. The RoarAudio sound
server is the central component in a RoarAudio setup. It mixes up
diffrent audio streams from it's clients to send them to it's outputs.
Such outputs include soundcards, monitoring clients, streaming servers
NOTE: This list is incomplete!
--help Print some help text.
Go into background after startup.
Ask for higher priority. May be used multiple times.
Sets default memory locking level to LEVEL.
Valid levels are:
none No memory is locked at all.
low Only very few (important) objects are locked in memory.
medium Few (important) objects are locked in memory.
high Many objects are locked in memory.
All known objects are locked in memory.
All known objects are locked in memory but also pages
provided by the system like stack and heap.
allcur All currently used pages are locked in memory.
all All pages (including future allocated pages) are locked
Use defaults (the default).
A higher memlock level may result in memory allocations problems at
runtime and even segfauls on some systems. (VM killed processes).
Check your current system limits before altering this value.
Asks the server to use the given pidfile. This is recommended.
Messure exact audio clock frequency based on system time.
Sets lion-readable location of server. Examples: livingroom,
Sets lion-readable description of server. Examples: Stereo, UKW
STARTUP AND SHUTDOWN
Start a new server.
--stop Stop the currently running server. See also --shutdown.
Stop the currently running server and start up a new server.
Terminates the currently running server after last client has
quit. This is the most clean way to shutdown a running server
as it does not kick any clients. This option must not be
confused with --terminate.
Auto terminates the new server after last client has quit. This
option must not be confused with --shutdown.
Run script S after server shutdown. The script is passed to a
shell. Any shell feature can be used within the string.
Start in standby mode.
Go into standby mode if no streams are active.
Increment the verbosity level. Can be used multiple times.
Log to syslog.
Load the given plugin.
Chroots to the given directory. This improves the security. This
normally needs root privileg's.
USER AND GROUPS
Sets GroupID to the audio group as specified via -G.
Sets UserID to the audio user as specified via -U.
Sets the group for the UNIX Domain Socket, (default: audio) You
need the permittions to change the GID.
Sets the user for the UNIX Domain Socket, (default: do not set)
You need the permittions to change the UID (normaly only root
The following options control the access rights of connections. Some
of them take an access level. The access level is one from the
none This is used to disable an authentication method.
Used internally. Should not be used.
conctl The client is only allowed to do some basic operations
only affecting it's own connection.
guest Guest access (read only). The client may list resources
but not alter them.
user Normal user. The client may create and alter most
Power User. The client can create and alter all resources
and do all operation but operations which would break the
POSIX right system. The user is not allowed to control
the server itself like terminating it or alter (system)
resources with the rights of the user runnung roard.
This is the access level a fully trusted user in a multi
user setup should have.
all The client can do everything. This includes operations
which may alter system resources (like files) with the
rights of the user running roard.
This accesslevel should be given to the user in case of a
single user setup or root or some administrator in a
multi user setup.
Sets the access level for guest connections. Set to "none" to
disable guest access.
Sets the access level for clients authenticated by trust auth.
Set to "none" to disable trust auth.
Trust root user.
Do not trust root user.
Generate a new authfile with a fresh cookie.
Load all keys from a given authfile.
Sets the type for the authfile.
Sets the access level for the given authfile.
Add another authfile.
--rate RATE, -R RATE
Set server sample rate.
--bits BITS, -B BITS
Set server bits.
--chans CHANNELS, -C CHANNELS
Set server channels.
Use a existing audio profile.
GENERAL STREAM OPTIONS
Sets default flags for a given stream directions. Examples:
Shows a list of all available drivers.
This option is obsolete. Use -o instead.
This option is obsolete. Use -O instead.
Set the output driver. To get a list of all drivers use --list-
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.
List all supported sources.
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.
HARDWARE MIXER OPTIONS
List all supported hardware mixers.
Add a hardware mixer of given type.
-M Sets the device used for the hardware mixer.
-mO Sets options for the hardware mixer. See MIXER OPTIONS.
-mN Adds another hardware mixer.
-mP Marks the mixer primary.
List all supported codecfilters and codecs.
Disable console based MIDI synth.
Enables console based MIDI synth.
Sets device for MIDI console. Example: /dev/console
Enables simple software synth.
Disables simple software synth.
LIGHT CONTROL OPTIONS
Sets the number of light channels. Examples: 512, 1024
RADIO DATA SYSTEM OPTIONS
Sets the Programme Identification (PI).
Sets the Programme Service Name (PS).
Sets the Programme Type (PTY).
Sets the Traffic Programme (TP) flag
Enables sending of RDS Clock Time (CT).
Sets the display to use.
--x11 Enable X11 support.
Sets defaults for TCP/IP Socket.
-4, -6 Use IPv4 or IPv6 mode.
-64 Try to downgrade IPv6 sockets into IPv4 sockets.
Sets defaults for UNIX Domain Socket.
Sets defaults for DECnet Socket.
Sets the port the server should listen on.
--bind, -b, --sock
Sets the hostname or path the server should listen on.
List supported protocols.
Sets the protocol used for the listening socket.
--proto-dir, --proto-rate, --proto-bits, --proto-codec, --proto-chans,
Set stream parameters for protocols needing stream options.
Defaults to server defaults.
List supported profiles.
--proto-profile Use the given profile for the listening socket.
Adds a new listening socket.
Do not listen for new clients (only useful for relaing, impleys
Expects a client on the given FH. This may be useful with --no-
Close the given FH. This is not useful for endusers but used
Sets the MTU for Jambo Packets.
--slp Enable OpenSLP support.
rate Sets the sample rate.
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
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.
Marks this stream as primary.
Sets the cleanmeta flag.
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
Makes this stream as primary.
Sets the autoconf flag.
Sets the passmixer flag.
name Sets the name for the device.
subs Sets list of subdevices. This is driver specific.
HOME The users home directory.
The address of the listening server. This may be in form of
host:port for TCP/IP connections and /path/to/sock for UNIX
The driver to select. Same as -d.
The device to select. Same as -D.
There are lots of bugs...
roar-config(1), roarcat(1), roarcat2sock(1), roarcatad(1), roarctl(1),
roarfilt(1), roarfish(1), roarmon(1), roarsockconnect(1), roartypes(1),
For history information see RoarAudio(7).