X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/d0b4f0acd54eeebcde98a1b4476b232dbece6048..591bec8587c71a025bcc83092145b0ef9ffbe944:/doc/disorder-playrtp.1.in diff --git a/doc/disorder-playrtp.1.in b/doc/disorder-playrtp.1.in index c313ece..c92c55a 100644 --- a/doc/disorder-playrtp.1.in +++ b/doc/disorder-playrtp.1.in @@ -98,26 +98,30 @@ Display a usage message. Display version number. .SS "Buffer Control Options" You shouldn't need to use these options. +Their effects are subject to change between version without warning. +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. -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. +This also acts as the target buffer occupancy. .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. -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. +.TP +.B \-\-monitor\fR, \fB\-M +Periodically report how close to the buffer low watermark the buffer is. +If you have trouble with poor playback quality, enable this option to see if +the buffer is emptying out (or overfilling, though there are measures to +prevent that from happening). .SH "REMOTE CONTROL" The .B \-\-socket