chiark / gitweb /
align with disorder.unicode a bit
[disorder] / doc / disorder-playrtp.1.in
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
21 disorder-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
30 address.
31 .PP
32 Normally the \fIADDRESS\fR would be 0.0.0.0.  The \fIPORT\fR will depend on the
33 server configuration.  You may need to specify the \fB--multicast\fR option
34 (see below) and if you have more than one soundcard perhaps the \fB--device\fR
35 option.
36 .SH OPTIONS
37 .TP
38 .B --device \fIDEVICE\fR, \fB-D \fIDEVICE\fR
39 Specifies the audio device to use.  The exact meaning of this is
40 platform-dependent; on Linux it is the ALSA device name.
41 .TP
42 .B --multicast \fIGROUP\fR, \fB-M \fIGROUP\fR
43 Specifies a multicast group to join.  This is necessary if the network
44 broadcast is being multicasted rather than broadcast.
45 .TP
46 .B --help\fR, \fB-h
47 Display a usage message.
48 .TP
49 .B --version\fR, \fB-V
50 Display version number.
51 .SS "Buffer Control Options"
52 You shouldn't need to use these options.
53 .TP
54 .B --min \fIFRAMES\fR, \fB-m \fIFRAMES\fR
55 Specifies the buffer low watermark in frames.  If the number of frames falls
56 below this value then playing will be stopped until the buffer fills up.
57 .TP
58 .B --buffer \fIFRAMES\fR, \fB-b \fIFRAMES\fR
59 Specifies the buffer high watermark in frames.  Once there are this many frames
60 in the buffer, playing will be (re-)started.
61 .TP
62 .B --max \fIFRAMES\fR, \fB-x \fIFRAMES\fR
63 Specifies the maximum buffer size in frames.  If there are this many frames in
64 the buffer then reading from the network socket will be suspended.  The default
65 is four times the \fB--buffer\fR value.
66 .TP
67 .B --rcvbuf \fIBYTES\fR, \fB-R \fIBYTES\fR
68 Specifies socket receive buffer size.  The default is 131072 (128Kbytes).  The
69 buffer size will not be reduced below the operating system's default.
70 .SH "SEE ALSO"
71 .BR disorder_config (5),
72 .BR disorderd (8)
73 .\" Local Variables:
74 .\" mode:nroff
75 .\" fill-column:79
76 .\" End: