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