Commit | Line | Data |
---|---|---|
9086a105 | 1 | .\" |
5aff007d | 2 | .\" Copyright (C) 2007, 2008 Richard Kettlewell |
9086a105 | 3 | .\" |
e7eb3a27 | 4 | .\" This program is free software: you can redistribute it and/or modify |
9086a105 | 5 | .\" it under the terms of the GNU General Public License as published by |
e7eb3a27 | 6 | .\" the Free Software Foundation, either version 3 of the License, or |
9086a105 | 7 | .\" (at your option) any later version. |
e7eb3a27 RK |
8 | .\" |
9 | .\" This program is distributed in the hope that it will be useful, | |
10 | .\" but WITHOUT ANY WARRANTY; without even the implied warranty of | |
11 | .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
12 | .\" GNU General Public License for more details. | |
13 | .\" | |
9086a105 | 14 | .\" You should have received a copy of the GNU General Public License |
e7eb3a27 | 15 | .\" along with this program. If not, see <http://www.gnu.org/licenses/>. |
9086a105 RK |
16 | .\" |
17 | .TH disorder-playrtp 1 | |
18 | .SH NAME | |
19 | disorder-playrtp \- play DisOrder network broadcasts | |
20 | .SH SYNOPSIS | |
0d350ff0 | 21 | .B disorder\-playrtp |
9086a105 | 22 | .RI [ OPTIONS ] |
0d350ff0 | 23 | .RB [ \-\- ] |
6fba990c | 24 | .RI [[ GROUP ] |
18e5cbdc | 25 | .IR PORT ] |
9086a105 | 26 | .SH DESCRIPTION |
0d350ff0 | 27 | \fBdisorder\-playrtp\fR plays a network broadcast sent from the specified |
9086a105 | 28 | address. |
f2a6202f | 29 | .PP |
6fba990c RK |
30 | If neither a group nor port are specified then the local DisOrder |
31 | configuration is consulted to find the server and the server is asked where the | |
32 | RTP stream is. | |
33 | .PP | |
34 | If just a port is specified then the RTP stream is assumed to be unicast or | |
35 | broadcast to that port. | |
36 | .PP | |
37 | If a group and a port are specified then the RTP stream is assumed to be | |
38 | multicast to that group and port. | |
9086a105 | 39 | .SH OPTIONS |
b6579a61 RK |
40 | The default sound API is the first of the ones listed below that are available. |
41 | Usually this implies ALSA under Linux and Core Audio under OS X. | |
42 | .TP | |
0d350ff0 | 43 | .B \-\-alsa\fR, \fB-\a |
b6579a61 RK |
44 | Use ALSA to play sound. |
45 | .TP | |
0d350ff0 | 46 | .B \-\-oss\fR, \fB\-o |
b6579a61 RK |
47 | Use OSS to play sound. |
48 | .TP | |
0d350ff0 | 49 | .B \-\-core\-audio\fR, \fB\-c |
b6579a61 | 50 | Use Core Audio to play sound. |
9086a105 | 51 | .TP |
0d350ff0 | 52 | .B \-\-device \fIDEVICE\fR, \fB\-D \fIDEVICE\fR |
c0c23a60 | 53 | Specifies the audio device to use. |
f5fd9a6b RK |
54 | See |
55 | .B "DEVICE NAMES" | |
56 | below for more information. | |
9086a105 | 57 | .TP |
0d350ff0 | 58 | .B \-\-config \fIPATH\fR, \fB\-C \fIPATH |
c0c23a60 RK |
59 | Set the configuration file. |
60 | The default is | |
b6579a61 RK |
61 | .IR pkgconfdir/config . |
62 | .TP | |
0d350ff0 | 63 | .B \-\-socket \fIPATH\fR, \fB\-s \fIPATH |
c0c23a60 RK |
64 | Set the control socket. |
65 | Normally this would not be used manually. | |
b6579a61 | 66 | .TP |
0d350ff0 | 67 | .B \-\-help\fR, \fB\-h |
f2a6202f RK |
68 | Display a usage message. |
69 | .TP | |
0d350ff0 | 70 | .B \-\-version\fR, \fB\-V |
f2a6202f RK |
71 | Display version number. |
72 | .SS "Buffer Control Options" | |
73 | You shouldn't need to use these options. | |
74 | .TP | |
0d350ff0 | 75 | .B \-\-min \fIFRAMES\fR, \fB\-m \fIFRAMES\fR |
c0c23a60 RK |
76 | Specifies the buffer low watermark in frames. |
77 | If the number of frames falls below this value then playing will be | |
78 | stopped until the buffer fills up. | |
9086a105 | 79 | .TP |
0d350ff0 | 80 | .B \-\-buffer \fIFRAMES\fR, \fB\-b \fIFRAMES\fR |
c0c23a60 RK |
81 | Specifies the buffer high watermark in frames. |
82 | Once there are this many frames in the buffer, playing will be (re-)started. | |
9086a105 | 83 | .TP |
0d350ff0 | 84 | .B \-\-max \fIFRAMES\fR, \fB\-x \fIFRAMES\fR |
c0c23a60 RK |
85 | Specifies the maximum buffer size in frames. |
86 | If there are this many frames in the buffer then reading from the | |
87 | network socket will be suspended. | |
0d350ff0 | 88 | The default is four times the \fB\-\-buffer\fR value. |
9086a105 | 89 | .TP |
0d350ff0 | 90 | .B \-\-rcvbuf \fIBYTES\fR, \fB\-R \fIBYTES\fR |
c0c23a60 RK |
91 | Specifies socket receive buffer size. |
92 | The default is 131072 (128Kbytes). | |
93 | The buffer size will not be reduced below the operating system's default. | |
b6579a61 RK |
94 | .SH "REMOTE CONTROL" |
95 | The | |
0d350ff0 | 96 | .B \-\-socket |
b6579a61 | 97 | option is used by Disobedience to control a background |
0d350ff0 | 98 | .B disorder\-playrtp |
c0c23a60 RK |
99 | daemon. |
100 | The socket will be created as a UNIX domain stream socket. | |
101 | When a connection is received a single line is read from it. | |
102 | The following commands are known: | |
b6579a61 RK |
103 | .TP |
104 | .B stop | |
105 | Causes | |
0d350ff0 | 106 | .B disorder\-playrtp |
b6579a61 RK |
107 | to terminate. |
108 | .TP | |
109 | .B query | |
110 | Causes the string "running" to be sent back. | |
111 | .PP | |
c0c23a60 RK |
112 | Other commands are ignored. |
113 | After the first command the connection is closed. | |
b6579a61 RK |
114 | Only one connection at a time will be serviced. |
115 | .PP | |
116 | This protocol is not guaranteed to be stable. | |
f5fd9a6b RK |
117 | .SH "DEVICE NAMES" |
118 | .SS "Core Audio" | |
119 | On a Mac, the device name can either be the human-readable name of the desired | |
120 | output or its UID. | |
121 | To get a list of the human-readable names, visit System Preferences -> Sound; | |
122 | the Type column has the name you want. | |
123 | .PP | |
124 | For example, you might use "Built-in Output" for the built-in speaker | |
125 | or "Built-in Line Output" if you have connected external speakers. | |
126 | Remember to quote the name. | |
9086a105 | 127 | .SH "SEE ALSO" |
b6579a61 | 128 | .BR disobedience (1), |
9086a105 RK |
129 | .BR disorder_config (5), |
130 | .BR disorderd (8) | |
131 | .\" Local Variables: | |
132 | .\" mode:nroff | |
133 | .\" fill-column:79 | |
134 | .\" End: |