chiark / gitweb /
Bump up default RTP player buffer sizes. Now big enough to keep ALSA
[disorder] / doc / disorder-playrtp.1.in
index 206be91e5a04f2fdb600c65d47f04922be0de019..480a9358138fad9f6f5bca9ec3cb1c5eca358707 100644 (file)
@@ -66,7 +66,7 @@ If \fICOMMAND\fR exits it is re-executed; any samples that had been written to
 the pipe but not processed by the previous instance will be lost.
 .IP
 .B \-\-device
 the pipe but not processed by the previous instance will be lost.
 .IP
 .B \-\-device
-is redundant with this option, but you might wan to set
+is redundant with this option, but you might want to set
 .BR \-\-pause\-mode .
 .IP
 As an example,
 .BR \-\-pause\-mode .
 .IP
 As an example,
@@ -98,25 +98,21 @@ Display a usage message.
 Display version number.
 .SS "Buffer Control Options"
 You shouldn't need to use these options.
 Display version number.
 .SS "Buffer Control Options"
 You shouldn't need to use these options.
+You should consult the source code for details of their effects.
 .TP
 .B \-\-min \fIFRAMES\fR, \fB\-m \fIFRAMES\fR
 Specifies the buffer low watermark in frames.
 .TP
 .B \-\-min \fIFRAMES\fR, \fB\-m \fIFRAMES\fR
 Specifies the buffer low watermark in frames.
-If the number of frames falls below this value then playing will be
-stopped until the buffer fills up.
-.TP
-.B \-\-buffer \fIFRAMES\fR, \fB\-b \fIFRAMES\fR
-Specifies the buffer high watermark in frames.
-Once there are this many frames in the buffer, playing will be (re-)started.
 .TP
 .B \-\-max \fIFRAMES\fR, \fB\-x \fIFRAMES\fR
 Specifies the maximum buffer size in frames.
 If there are this many frames in the buffer then reading from the
 network socket will be suspended.
 .TP
 .B \-\-max \fIFRAMES\fR, \fB\-x \fIFRAMES\fR
 Specifies the maximum buffer size in frames.
 If there are this many frames in the buffer then reading from the
 network socket will be suspended.
-The default is four times the \fB\-\-buffer\fR value.
+The default is twice the \fB\-\-min\fR value.
 .TP
 .B \-\-rcvbuf \fIBYTES\fR, \fB\-R \fIBYTES\fR
 Specifies socket receive buffer size.
 .TP
 .B \-\-rcvbuf \fIBYTES\fR, \fB\-R \fIBYTES\fR
 Specifies socket receive buffer size.
-The default is 131072 (128Kbytes).
+The default is not to change the buffer size, i.e. you get whatever the
+local operating system chooses.
 The buffer size will not be reduced below the operating system's default.
 .SH "REMOTE CONTROL"
 The
 The buffer size will not be reduced below the operating system's default.
 .SH "REMOTE CONTROL"
 The