chiark / gitweb /
Build fixes for GCC 4.1
[disorder] / doc / disorder-playrtp.1.in
CommitLineData
9086a105 1.\"
5aff007d 2.\" Copyright (C) 2007, 2008 Richard Kettlewell
9086a105
RK
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
0d350ff0 23.B disorder\-playrtp
9086a105 24.RI [ OPTIONS ]
0d350ff0 25.RB [ \-\- ]
6fba990c 26.RI [[ GROUP ]
18e5cbdc 27.IR PORT ]
9086a105 28.SH DESCRIPTION
0d350ff0 29\fBdisorder\-playrtp\fR plays a network broadcast sent from the specified
9086a105 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 41.SH OPTIONS
b6579a61
RK
42The default sound API is the first of the ones listed below that are available.
43Usually this implies ALSA under Linux and Core Audio under OS X.
44.TP
0d350ff0 45.B \-\-alsa\fR, \fB-\a
b6579a61
RK
46Use ALSA to play sound.
47.TP
0d350ff0 48.B \-\-oss\fR, \fB\-o
b6579a61
RK
49Use OSS to play sound.
50.TP
0d350ff0 51.B \-\-core\-audio\fR, \fB\-c
b6579a61 52Use Core Audio to play sound.
9086a105 53.TP
0d350ff0 54.B \-\-device \fIDEVICE\fR, \fB\-D \fIDEVICE\fR
c0c23a60
RK
55Specifies the audio device to use.
56The exact meaning of this is platform-dependent; on Linux it is the
57ALSA device name.
9086a105 58.TP
0d350ff0 59.B \-\-config \fIPATH\fR, \fB\-C \fIPATH
c0c23a60
RK
60Set the configuration file.
61The default is
b6579a61
RK
62.IR pkgconfdir/config .
63.TP
0d350ff0 64.B \-\-socket \fIPATH\fR, \fB\-s \fIPATH
c0c23a60
RK
65Set the control socket.
66Normally this would not be used manually.
b6579a61 67.TP
0d350ff0 68.B \-\-help\fR, \fB\-h
f2a6202f
RK
69Display a usage message.
70.TP
0d350ff0 71.B \-\-version\fR, \fB\-V
f2a6202f
RK
72Display version number.
73.SS "Buffer Control Options"
74You shouldn't need to use these options.
75.TP
0d350ff0 76.B \-\-min \fIFRAMES\fR, \fB\-m \fIFRAMES\fR
c0c23a60
RK
77Specifies the buffer low watermark in frames.
78If the number of frames falls below this value then playing will be
79stopped until the buffer fills up.
9086a105 80.TP
0d350ff0 81.B \-\-buffer \fIFRAMES\fR, \fB\-b \fIFRAMES\fR
c0c23a60
RK
82Specifies the buffer high watermark in frames.
83Once there are this many frames in the buffer, playing will be (re-)started.
9086a105 84.TP
0d350ff0 85.B \-\-max \fIFRAMES\fR, \fB\-x \fIFRAMES\fR
c0c23a60
RK
86Specifies the maximum buffer size in frames.
87If there are this many frames in the buffer then reading from the
88network socket will be suspended.
0d350ff0 89The default is four times the \fB\-\-buffer\fR value.
9086a105 90.TP
0d350ff0 91.B \-\-rcvbuf \fIBYTES\fR, \fB\-R \fIBYTES\fR
c0c23a60
RK
92Specifies socket receive buffer size.
93The default is 131072 (128Kbytes).
94The buffer size will not be reduced below the operating system's default.
b6579a61
RK
95.SH "REMOTE CONTROL"
96The
0d350ff0 97.B \-\-socket
b6579a61 98option is used by Disobedience to control a background
0d350ff0 99.B disorder\-playrtp
c0c23a60
RK
100daemon.
101The socket will be created as a UNIX domain stream socket.
102When a connection is received a single line is read from it.
103The following commands are known:
b6579a61
RK
104.TP
105.B stop
106Causes
0d350ff0 107.B disorder\-playrtp
b6579a61
RK
108to terminate.
109.TP
110.B query
111Causes the string "running" to be sent back.
112.PP
c0c23a60
RK
113Other commands are ignored.
114After the first command the connection is closed.
b6579a61
RK
115Only one connection at a time will be serviced.
116.PP
117This protocol is not guaranteed to be stable.
9086a105 118.SH "SEE ALSO"
b6579a61 119.BR disobedience (1),
9086a105
RK
120.BR disorder_config (5),
121.BR disorderd (8)
122.\" Local Variables:
123.\" mode:nroff
124.\" fill-column:79
125.\" End: