X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/4ecbdbd99dea3236c3c6d5ea5401a08c56de5d3c..86214c4a61b9ab346d7c4b6a12c9825a13caf921:/doc/disorder-playrtp.1.in diff --git a/doc/disorder-playrtp.1.in b/doc/disorder-playrtp.1.in index f4bcfd6..5e0d091 100644 --- a/doc/disorder-playrtp.1.in +++ b/doc/disorder-playrtp.1.in @@ -1,32 +1,30 @@ .\" -.\" Copyright (C) 2007 Richard Kettlewell +.\" Copyright (C) 2007, 2008 Richard Kettlewell .\" -.\" This program is free software; you can redistribute it and/or modify +.\" This program is free software: you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by -.\" the Free Software Foundation; either version 2 of the License, or +.\" the Free Software Foundation, either version 3 of the License, or .\" (at your option) any later version. -.\" -.\" This program is distributed in the hope that it will be useful, but -.\" WITHOUT ANY WARRANTY; without even the implied warranty of -.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -.\" General Public License for more details. -.\" +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" .\" You should have received a copy of the GNU General Public License -.\" along with this program; if not, write to the Free Software -.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 -.\" USA +.\" along with this program. If not, see . .\" .TH disorder-playrtp 1 .SH NAME disorder-playrtp \- play DisOrder network broadcasts .SH SYNOPSIS -.B disorder-playrtp +.B disorder\-playrtp .RI [ OPTIONS ] -.RB [ -- ] +.RB [ \-\- ] .RI [[ GROUP ] .IR PORT ] .SH DESCRIPTION -\fBdisorder-playrtp\fR plays a network broadcast sent from the specified +\fBdisorder\-playrtp\fR plays a network broadcast sent from the specified address. .PP If neither a group nor port are specified then the local DisOrder @@ -39,36 +37,84 @@ broadcast to that port. If a group and a port are specified then the RTP stream is assumed to be multicast to that group and port. .SH OPTIONS +The default sound API is the first of the ones listed below that are available. +Usually this implies ALSA under Linux and Core Audio under OS X. +.TP +.B \-\-alsa\fR, \fB-\a +Use ALSA to play sound. +.TP +.B \-\-oss\fR, \fB\-o +Use OSS to play sound. +.TP +.B \-\-core\-audio\fR, \fB\-c +Use Core Audio to play sound. +.TP +.B \-\-device \fIDEVICE\fR, \fB\-D \fIDEVICE\fR +Specifies the audio device to use. +The exact meaning of this is platform-dependent; on Linux it is the +ALSA device name. .TP -.B --device \fIDEVICE\fR, \fB-D \fIDEVICE\fR -Specifies the audio device to use. The exact meaning of this is -platform-dependent; on Linux it is the ALSA device name. +.B \-\-config \fIPATH\fR, \fB\-C \fIPATH +Set the configuration file. +The default is +.IR pkgconfdir/config . .TP -.B --help\fR, \fB-h +.B \-\-socket \fIPATH\fR, \fB\-s \fIPATH +Set the control socket. +Normally this would not be used manually. +.TP +.B \-\-help\fR, \fB\-h Display a usage message. .TP -.B --version\fR, \fB-V +.B \-\-version\fR, \fB\-V Display version number. .SS "Buffer Control Options" You shouldn't need to use these options. .TP -.B --min \fIFRAMES\fR, \fB-m \fIFRAMES\fR -Specifies the buffer low watermark in frames. If the number of frames falls -below this value then playing will be stopped until the buffer fills up. +.B \-\-min \fIFRAMES\fR, \fB\-m \fIFRAMES\fR +Specifies the buffer low watermark in frames. +If the number of frames falls below this value then playing will be +stopped until the buffer fills up. +.TP +.B \-\-buffer \fIFRAMES\fR, \fB\-b \fIFRAMES\fR +Specifies the buffer high watermark in frames. +Once there are this many frames in the buffer, playing will be (re-)started. +.TP +.B \-\-max \fIFRAMES\fR, \fB\-x \fIFRAMES\fR +Specifies the maximum buffer size in frames. +If there are this many frames in the buffer then reading from the +network socket will be suspended. +The default is four times the \fB\-\-buffer\fR value. .TP -.B --buffer \fIFRAMES\fR, \fB-b \fIFRAMES\fR -Specifies the buffer high watermark in frames. Once there are this many frames -in the buffer, playing will be (re-)started. +.B \-\-rcvbuf \fIBYTES\fR, \fB\-R \fIBYTES\fR +Specifies socket receive buffer size. +The default is 131072 (128Kbytes). +The buffer size will not be reduced below the operating system's default. +.SH "REMOTE CONTROL" +The +.B \-\-socket +option is used by Disobedience to control a background +.B disorder\-playrtp +daemon. +The socket will be created as a UNIX domain stream socket. +When a connection is received a single line is read from it. +The following commands are known: .TP -.B --max \fIFRAMES\fR, \fB-x \fIFRAMES\fR -Specifies the maximum buffer size in frames. If there are this many frames in -the buffer then reading from the network socket will be suspended. The default -is four times the \fB--buffer\fR value. +.B stop +Causes +.B disorder\-playrtp +to terminate. .TP -.B --rcvbuf \fIBYTES\fR, \fB-R \fIBYTES\fR -Specifies socket receive buffer size. The default is 131072 (128Kbytes). The -buffer size will not be reduced below the operating system's default. +.B query +Causes the string "running" to be sent back. +.PP +Other commands are ignored. +After the first command the connection is closed. +Only one connection at a time will be serviced. +.PP +This protocol is not guaranteed to be stable. .SH "SEE ALSO" +.BR disobedience (1), .BR disorder_config (5), .BR disorderd (8) .\" Local Variables: