chiark / gitweb /
leave a TODO relating to revno 78
[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 [ -- ]
26.I ADDRESS
27.I PORT
28.SH DESCRIPTION
29\fBdisorder-playrtp\fR plays a network broadcast sent from the specified
30address.
9086a105
RK
31.SH OPTIONS
32.TP
33.B --device \fIDEVICE\fR, \fB-D \fIDEVICE\fR
34Specifies the audio device to use. The exact meaning of this is
35platform-dependent; on Linux it is the ALSA device name.
36.TP
37.B --min \fIFRAMES\fR, \fB-m \fIFRAMES\fR
38Specifies the buffer low watermark in frames. If the number of frames falls
39below this value then playing will be stopped until the buffer fills up.
40.TP
41.B --buffer \fIFRAMES\fR, \fB-b \fIFRAMES\fR
42Specifies the buffer high watermark in frames. Once there are this many frames
43in the buffer, playing will be (re-)started.
44.TP
45.B --max \fIFRAMES\fR, \fB-x \fIFRAMES\fR
46Specifies the maximum buffer size in frames. If there are this many frames in
47the buffer then reading from the network socket will be suspended. The default
48is four times the \fB--buffer\fR value.
49.TP
803f6e52 50.B --rcvbuf \fIBYTES\fR, \fB-R \fIBYTES\fR
51Specifies socket receive buffer size.
52.TP
9086a105
RK
53.B --help\fR, \fB-h
54Display a usage message.
55.TP
56.B --version\fR, \fB-V
57Display version number.
58.SH "SEE ALSO"
59.BR disorder_config (5),
60.BR disorderd (8)
61.\" Local Variables:
62.\" mode:nroff
63.\" fill-column:79
64.\" End: