X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/22b9fa74de8e80471a5033ea067d3b360930b91d..6fba990cea5342a2101b4acceb5c9ee02cb87c92:/doc/disorder-playrtp.1.in diff --git a/doc/disorder-playrtp.1.in b/doc/disorder-playrtp.1.in index 18ca149..74ce6e3 100644 --- a/doc/disorder-playrtp.1.in +++ b/doc/disorder-playrtp.1.in @@ -23,17 +23,35 @@ disorder-playrtp \- play DisOrder network broadcasts .B disorder-playrtp .RI [ OPTIONS ] .RB [ -- ] -.I ADDRESS -.I PORT +.RI [[ GROUP ] +.II PORT ] .SH DESCRIPTION \fBdisorder-playrtp\fR plays a network broadcast sent from the specified address. +.PP +If neither a group nor port are specified then the local DisOrder +configuration is consulted to find the server and the server is asked where the +RTP stream is. +.PP +If just a port is specified then the RTP stream is assumed to be unicast or +broadcast to that port. +.PP +If a group and a port are specified then the RTP stream is assumed to be +multicast to that group and port. .SH OPTIONS .TP .B --device \fIDEVICE\fR, \fB-D \fIDEVICE\fR Specifies the audio device to use. The exact meaning of this is platform-dependent; on Linux it is the ALSA device name. .TP +.B --help\fR, \fB-h +Display a usage message. +.TP +.B --version\fR, \fB-V +Display version number. +.SS "Buffer Control Options" +You shouldn't need to use these options. +.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. @@ -48,13 +66,8 @@ the buffer then reading from the network socket will be suspended. The default is four times the \fB--buffer\fR value. .TP .B --rcvbuf \fIBYTES\fR, \fB-R \fIBYTES\fR -Specifies socket receive buffer size. -.TP -.B --help\fR, \fB-h -Display a usage message. -.TP -.B --version\fR, \fB-V -Display version number. +Specifies socket receive buffer size. The default is 131072 (128Kbytes). The +buffer size will not be reduced below the operating system's default. .SH "SEE ALSO" .BR disorder_config (5), .BR disorderd (8)