Commit | Line | Data |
---|---|---|
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 | |
21 | disorder-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 | |
30 | address. | |
f2a6202f | 31 | .PP |
6fba990c RK |
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. | |
9086a105 | 41 | .SH OPTIONS |
b6579a61 RK |
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. | |
9086a105 RK |
53 | .TP |
54 | .B --device \fIDEVICE\fR, \fB-D \fIDEVICE\fR | |
55 | Specifies the audio device to use. The exact meaning of this is | |
56 | platform-dependent; on Linux it is the ALSA device name. | |
57 | .TP | |
b6579a61 RK |
58 | .B --config \fIPATH\fR, \fB-C \fIPATH |
59 | Set the configuration file. The default is | |
60 | .IR pkgconfdir/config . | |
61 | .TP | |
62 | .B --socket \fIPATH\fR, \fB-s \fIPATH | |
63 | Set the control socket. Normally this would not be used manually. | |
64 | .TP | |
f2a6202f RK |
65 | .B --help\fR, \fB-h |
66 | Display a usage message. | |
67 | .TP | |
68 | .B --version\fR, \fB-V | |
69 | Display version number. | |
70 | .SS "Buffer Control Options" | |
71 | You shouldn't need to use these options. | |
72 | .TP | |
9086a105 RK |
73 | .B --min \fIFRAMES\fR, \fB-m \fIFRAMES\fR |
74 | Specifies the buffer low watermark in frames. If the number of frames falls | |
75 | below this value then playing will be stopped until the buffer fills up. | |
76 | .TP | |
77 | .B --buffer \fIFRAMES\fR, \fB-b \fIFRAMES\fR | |
78 | Specifies the buffer high watermark in frames. Once there are this many frames | |
79 | in the buffer, playing will be (re-)started. | |
80 | .TP | |
81 | .B --max \fIFRAMES\fR, \fB-x \fIFRAMES\fR | |
82 | Specifies the maximum buffer size in frames. If there are this many frames in | |
83 | the buffer then reading from the network socket will be suspended. The default | |
84 | is four times the \fB--buffer\fR value. | |
85 | .TP | |
803f6e52 | 86 | .B --rcvbuf \fIBYTES\fR, \fB-R \fIBYTES\fR |
f2a6202f RK |
87 | Specifies socket receive buffer size. The default is 131072 (128Kbytes). The |
88 | buffer size will not be reduced below the operating system's default. | |
b6579a61 RK |
89 | .SH "REMOTE CONTROL" |
90 | The | |
91 | .B --socket | |
92 | option is used by Disobedience to control a background | |
93 | .B disorder-playrtp | |
94 | daemon. The socket will be created as a UNIX domain stream socket. When a | |
95 | connection is received a single line is read from it. The following commands | |
96 | are known: | |
97 | .TP | |
98 | .B stop | |
99 | Causes | |
100 | .B disorder-playrtp | |
101 | to terminate. | |
102 | .TP | |
103 | .B query | |
104 | Causes the string "running" to be sent back. | |
105 | .PP | |
106 | Other commands are ignored. After the first command the connection is closed. | |
107 | Only one connection at a time will be serviced. | |
108 | .PP | |
109 | This protocol is not guaranteed to be stable. | |
9086a105 | 110 | .SH "SEE ALSO" |
b6579a61 | 111 | .BR disobedience (1), |
9086a105 RK |
112 | .BR disorder_config (5), |
113 | .BR disorderd (8) | |
114 | .\" Local Variables: | |
115 | .\" mode:nroff | |
116 | .\" fill-column:79 | |
117 | .\" End: |