Changeset 1193:802c6cd9d484 in roaraudio for doc

Timestamp:

02/04/09 15:00:58 (15 years ago)

Author:

phi

Branch:

default

Phase:

public

Message:

list of stream options

File:

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

doc/man1/roard.1

@@ -100 +100 @@
 .TP
 \fB-oO\fR
-Sets options for the new stream.
+Sets options for the new stream. See STREAM OPTIONS.
 
 .TP
@@ -161 +161 @@
 Close the given FH. This is not useful for endusers but used internaly.
 
+
+.SH "STREAM OPTIONS"
+.TP
+\fBrate\fR
+Sets the sample rate.
+
+.TP
+\fBchannels\fR
+Sets the number of channels.
+
+.TP
+\fBbits\fR
+Sets the number of bits per sample.
+
+.TP
+\fBcodec\fR
+Sets the codec.
+
+.TP
+\fBmeta\fR
+Sets the meta flag.
+
+.TP
+\fBsync\fR
+Sets the sync flag.
+
+.TP
+Example:
+rate=44100,bits=16,channels=2,codec=pcm,sync
 
 .SH "ENVIRONMENT VARIABLES"