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