Changeset 4570:e67d768ce684 in roaraudio

Timestamp:

10/31/10 13:35:36 (13 years ago)

Author:

phi

Branch:

default

Phase:

public

Message:

updated manpage

File:

• doc/man1/roard.1 (modified) (11 diffs)

doc/man1/roard.1

@@ -1 +1 @@
 .\" roard.1:
 
-.TH "ROARD" "1" "July 2008" "RoarAudio" "System Manager's Manual: roard"
+.TH "ROARD" "1" "October 2010" "RoarAudio" "System Manager's Manual: roard"
 
 .SH NAME
@@ -13 +13 @@
 .SH "DESCRIPTION"
 
-\fBroard\fR 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.
+\fBroard\fR 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 and more.
 
 .SH "GENERAL OPTIONS"
@@ -30 +33 @@
 \fB--realtime\fR
 Ask for higher priority. May be used multiple times.
+
+.TP
+\fB--memlock LEVEL\fR
+Sets default memory locking level to LEVEL.
+
+.TP
+\fB--pidfile PIDFILE\fR
+Asks the server to use the given pidfile. This is recommended.
+
+.TP
+\fB--sysclocksync\fR
+Messure exact audio clock frequency based on system time. obsolete.
+
+.SH "SERVER INFO"
+.TP
+\fB--location  LOC\fR
+Sets lion-readable location of server.
+Examples: livingroom, room 32
+
+.TP
+\fB--description  DESC\fR
+Sets lion-readable description of server.
+Examples: Stereo, UKW Transmitter
+
+.SH "STARTUP AND SHUTDOWN"
+.TP
+\fB--start\fR
+Start a new server.
+
+.TP
+\fB--stop\fR
+Stop the currently running server.
+See also \fB--shutdown\fR.
+
+.TP
+\fB--restart\fR
+Stop the currently running server and start up a new server.
+
+.TP
+\fB--shutdown\fR
+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 \fB--terminate\fR.
+
+.TP
+\fB--terminate\fR
+Auto terminates the new server after last client has quit.
+This option must not be confused with \fB--shutdown\fR.
+
+.SH "STANDBY MODE"
+.TP
+\fB--standby\fR
+Start in standby mode.
+
+.TP
+\fB--auto-standby\fR
+Go into standby mode if no streams are active.
+
+.SH "LOGGING"
+.TP
+\fB--verbose\fR
+Increment the verbosity level. Can be used multiple times.
+
+.TP
+\fB--log-syslog\fR
+Log to syslog.
+
+.SH "PLUGINS"
+.TP
+\fB--plugin-load\fR
+Load the given plugin.
+
+.SH "SECURITY"
 
 .TP
@@ -54 +131 @@
 You need the permittions to change the UID (normaly only root has).
 
+.SH "AUTH OPTIONS"
+.TP
+\fB--guest-acclev\fR
+Sets the access level for guest connections.
+
+.TP
+\fB--trust-acclev\fR
+Sets the access level for clients authenticated by trust auth.
+
+.TP
+\fB--trust-root\fR
+Trust root user.
+
+.TP
+\fB--no-trust-root\fR
+Do not trust root user.
 
 .SH "AUDIO OPTIONS"
@@ -67 +160 @@
 \fB--chans CHANNELS\fR, \fB-C CHANNELS\fR
 Set server channels.
+
+.TP
+\fB--aiprofile  PROFILE\fR
+Use a existing audio profile.
+
+.SH "GENERAL STREAM OPTIONS"
+.TP
+\fB--stream-flags\fR
+Sets default flags for a given stream directions.
+Examples: play=-meta, bidir=+antiecho
 
 .SH "DRIVER OPTIONS"
@@ -113 +216 @@
 .SH "SOURCE OPTIONS"
 .TP
+\fB--list-sources\fR
+List all supported sources.
+
+.TP
 \fB--source\fR, \fB-s\fR
 Adds a source of the given type.
@@ -132 +239 @@
 Marks the source as primary. If the source reaches EOF roard will quit automatically.
 
+.SH "HARDWARE MIXER OPTIONS"
+.TP
+\fB--list-mixers\fR
+List all supported hardware mixers.
+
+.TP
+\fB--mixer\fR, \fB-m\fR
+Add a hardware mixer of given type.
+
+.TP
+\fB-M\fR
+Sets the device used for the hardware mixer.
+
+.TP
+\fB-mO\fR
+Sets options for the hardware mixer.
+See MIXER OPTIONS.
+
+.TP
+\fB-mN\fR
+Adds another hardware mixer.
+
+.TP
+\fB-mP\fR
+Marks the mixer primary.
+
+.SH "CODEC FILTER"
+.TP
+\fB--list-cf\fR
+List all supported codecfilters and codecs.
+
+.SH "MIDI OPTIONS"
+.TP
+\fB--midi-no-console\fR
+Disable console based MIDI synth.
+
+.TP
+\fB--midi-console-enable\fR
+Enables console based MIDI synth.
+
+.TP
+\fB--midi-console\fR
+Sets device for MIDI console.
+Example: /dev/console
+
+.TP
+\fB--ssynth-enable\fR
+Enables simple software synth.
+
+.TP
+\fB--ssynth-disable\fR
+Disables simple software synth.
+
+.SH "LIGHT CONTROL OPTIONS"
+.TP
+\fB--light-channels\fR
+Sets the number of light channels.
+Examples: 512, 1024
+
+.SH "RADIO DATA SYSTEM OPTIONS"
+.TP
+\fB--rds-pi\fR
+Sets the Programme Identification (PI).
+
+.TP
+\fB--rds-ps\fR
+Sets the Programme Service Name (PS).
+
+.TP
+\fB--rds-pty\fR
+Sets the Programme Type (PTY).
+
+.TP
+\fB--rds-tp\fR
+Sets the Traffic Programme (TP) flag
+
+.TP
+\fB--rds-ct\fR
+Enables sending of RDS Clock Time (CT).
+
+.SH "X11 OPTIONS"
+.TP
+\fB--x11-display\fR, \fB--display\fR
+Sets the display to use.
+
+.TP
+\fB--x11\fR
+Enable X11 support.
+
 .SH "NETWORK OPTIONS"
 .TP
@@ -138 +334 @@
 
 .TP
+\fB-4\fR, \fB-6\fR
+Use IPv4 or IPv6 mode.
+
+.TP
+\fB-64\fR
+Try to downgrade IPv6 sockets into IPv4 sockets.
+
+.TP
 \fB--unix\fR, \fB-u\fR
 Sets defaults for UNIX Domain Socket.
@@ -154 +358 @@
 
 .TP
+\fB--list-proto\fR
+List supported protocols.
+
+.TP
+\fB--proto\fR
+Sets the protocol used for the listening socket.
+
+.TP
+\fB--proto-dir\fR, \fB--proto-rate\fR, \fB--proto-bits\fR, \fB--proto-codec\fR, \fB--proto-chans\fR, \fB--proto-aiprofile\fR
+Set stream parameters for protocols needing stream options.
+Defaults to server defaults.
+
+.TP
+\fB--list-profiles\fR
+List supported profiles.
+
+\fB--proto-profile\fR
+Use the given profile for the listening socket.
+
+.TP
+\fB--new-sock\fR
+Adds a new listening socket.
+
+.TP
 \fB--no-listen\fR
 Do not listen for new clients (only useful for relaing, impleys \-\-terminate).
@@ -165 +393 @@
 Close the given FH. This is not useful for endusers but used internaly.
 
+.TP
+\fB--jumbo-mtu\fR
+Sets the MTU for Jambo Packets.
+
+.SH "OPENSLP OPTIONS"
+.TP
+\fB--slp\fR
+Enable OpenSLP support.
 
 .SH "STREAM OPTIONS"
@@ -223 +459 @@
 Example:
 rate=44100,bits=16,channels=2,codec=pcm,sync
+
+.SH "MIXER OPTIONS"
+.TP
+\fRprimary\fR
+Makes this stream as primary.
+
+.TP
+\fBautoconf\fR
+Sets the autoconf flag.
+
+.TP
+\fBpassmixer\fR
+Sets the passmixer flag.
+
+.TP
+\fBname\fR
+Sets the name for the device.
+
+.TP
+\fBsubs\fR
+Sets list of subdevices. This is driver specific.
 
 .SH "ENVIRONMENT VARIABLES"