chiark / gitweb /
typo in man disorder-playrtp
[disorder] / doc / disorder-playrtp.1.in
CommitLineData
9086a105
RK
1.\"
2.\" Copyright (C) 2007 Richard Kettlewell
3.\"
4.\" This program is free software; you can redistribute it and/or modify
5.\" it under the terms of the GNU General Public License as published by
6.\" the Free Software Foundation; either version 2 of the License, or
7.\" (at your option) any later version.
8.\"
9.\" This program is distributed in the hope that it will be useful, but
10.\" WITHOUT ANY WARRANTY; without even the implied warranty of
11.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12.\" General Public License for more details.
13.\"
14.\" You should have received a copy of the GNU General Public License
15.\" along with this program; if not, write to the Free Software
16.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
17.\" USA
18.\"
19.TH disorder-playrtp 1
20.SH NAME
21disorder-playrtp \- play DisOrder network broadcasts
22.SH SYNOPSIS
23.B disorder-playrtp
24.RI [ OPTIONS ]
25.RB [ -- ]
6fba990c 26.RI [[ GROUP ]
18e5cbdc 27.IR PORT ]
9086a105
RK
28.SH DESCRIPTION
29\fBdisorder-playrtp\fR plays a network broadcast sent from the specified
30address.
f2a6202f 31.PP
6fba990c
RK
32If neither a group nor port are specified then the local DisOrder
33configuration is consulted to find the server and the server is asked where the
34RTP stream is.
35.PP
36If just a port is specified then the RTP stream is assumed to be unicast or
37broadcast to that port.
38.PP
39If a group and a port are specified then the RTP stream is assumed to be
40multicast to that group and port.
9086a105
RK
41.SH OPTIONS
42.TP
43.B --device \fIDEVICE\fR, \fB-D \fIDEVICE\fR
44Specifies the audio device to use. The exact meaning of this is
45platform-dependent; on Linux it is the ALSA device name.
46.TP
f2a6202f
RK
47.B --help\fR, \fB-h
48Display a usage message.
49.TP
50.B --version\fR, \fB-V
51Display version number.
52.SS "Buffer Control Options"
53You shouldn't need to use these options.
54.TP
9086a105
RK
55.B --min \fIFRAMES\fR, \fB-m \fIFRAMES\fR
56Specifies the buffer low watermark in frames. If the number of frames falls
57below this value then playing will be stopped until the buffer fills up.
58.TP
59.B --buffer \fIFRAMES\fR, \fB-b \fIFRAMES\fR
60Specifies the buffer high watermark in frames. Once there are this many frames
61in the buffer, playing will be (re-)started.
62.TP
63.B --max \fIFRAMES\fR, \fB-x \fIFRAMES\fR
64Specifies the maximum buffer size in frames. If there are this many frames in
65the buffer then reading from the network socket will be suspended. The default
66is four times the \fB--buffer\fR value.
67.TP
803f6e52 68.B --rcvbuf \fIBYTES\fR, \fB-R \fIBYTES\fR
f2a6202f
RK
69Specifies socket receive buffer size. The default is 131072 (128Kbytes). The
70buffer size will not be reduced below the operating system's default.
9086a105
RK
71.SH "SEE ALSO"
72.BR disorder_config (5),
73.BR disorderd (8)
74.\" Local Variables:
75.\" mode:nroff
76.\" fill-column:79
77.\" End: