Changeset 5159:b226b74be970 in roaraudio for doc/man1/roarctl.1

Timestamp:

10/16/11 12:42:31 (13 years ago)

Author:

phi

Branch:

default

Phase:

public

Message:

Updated manpages (pr1)

File:

• doc/man1/roarctl.1 (modified) (5 diffs)

doc/man1/roarctl.1

@@ -21 +21 @@
 
 .TP
-\fB-v\fR
+\fB--verbose\fR, \fB\-v\fR
 Be verbose. May be used multiple times.
+
+.TP
+\fB--list-libstandards\fR
+Similar to serverstandards, reports the list of standard libroar supports.
+
+.TP
+\fB--list-aiprofiles\fR
+Show audio info profiles and exit.
+
+.TP
+\fB--enum-servers\fR
+List servers found on the network.
+Depending on the build options of libroar this includes results from many tests
+like standard server locations, OpenSLP located servers, X11 located servers,
+DECnet's neighbor and IP's ARP table and other sources.
 
 .SH "NETWORK OPTIONS"
@@ -35 +50 @@
 
 .TP
+\fBlistaiprofiles\fR
+List audio info profiles.
+
+.TP
+\fBaiprofileget PROFILE\fR
+Display a the given audio info profile.
+
+.TP
 \fBsleep TIME\fR
 Sleeps for TIME seconds.
+
+.TP
+\fBping NUM\fR
+Pings the server NUM times. This is done by sending NOOP commands to the server.
+The response time as well as as a small statistics section is printed.
+
+This is not supported on all platforms.
+
+.TP
+\fBwhoami\fR
+Report client ID of roarctl on the current server.
 
 .TP
@@ -84 +118 @@
 
 .TP
-\fBflag ID FLAGS\fR, \fBunflag ID FLAGS\fR
-Sets or removes flags from a stream. ID is the stream id.
+\fBnewvirtual P D E R B C\fR
+Adds a new virtual (child) stream.
+This is used with container formats such as RAUM, Ogg and Matroska.
+
+
+Parameters:
+.RS
+.TP
+\fBP\fR
+Stream ID of \fBP\fRarent stream.
+.TP
+\fBD\fR
+Stream \fBD\fRirection.
+.TP
+\fBE\fR
+Stream cod\fBE\fRc.
+.TP
+\fBR\fR
+Sample \fBR\fRate.
+.TP
+\fBB\fR
+\fBB\fRits per sample.
+.TP
+\fBC\fR
+Number of \fBC\fRhannels.
+.RE
+
+.TP
+\fBflag ID FLAGS\fR, \fBunflag ID FLAGS\fR, \fBtoogleflag ID FLAGS\fR
+Sets, removes or toggles flags on a stream. ID is the stream id.
 FLAGS is a comma separated list of flags.
 
 It is not possible to set all kinds of flags at runtime.
 
+.TP
+\fBprotectflag ID FLAGS\fR
+Protects flags on a stream. ID is the stream id.
+FLAGS is a comma separated list of flags.
+
+Protected flags can not be changed anymore after the they got protected.
+
 .SH "META DATA COMMANDS"
+.TP
+\fBrole ID ROLE\fR
+Set stream role ROLE on stream ID.
+
+.TP
+\fBmetaget ID TYPE\fR
+Read meta date of type TYPE from stream ID.
+
 .TP
 \fBmetasave ID FILE\fR
@@ -102 +179 @@
 as for \fBmetasave\fR.
 
-.SH "LISTING COMMANDS"
+.SH "SERVER INFO COMMANDS"
+.TP
+\fBserverinfo\fR
+Gets general information about the server.
+This includes software vendor and version.
+
+.TP
+\fBservertime\fR
+Reports the server's system time.
+
+.TP
+\fBserverstandards\fR
+Report a list of standards the server supports.
+
+.TP
+\fBlibstandards\fR
+Similar to serverstandards, reports the list of standard libroar supports.
+Same as \fB--list-libstandards\fR.
+
 .TP
 \fBserveroinfo\fR
@@ -111 +206 @@
 Gets Information about server output for a given direction.
 
+.SH "LISTING COMMANDS"
 .TP
 \fBlistclients\fR