chiark - git - mdw - disorder/blob - doc/disorder-playrtp.1.in

   1 .\"
   2 .\" Copyright (C) 2007-2009 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 [[ ADDRESS ]
  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 an address 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 an address and a port are specified then the RTP stream is assumed to be
  38 multicast to that group address 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 See
  55 .B "DEVICE NAMES"
  56 below for more information.
  57 .TP
  58 .B \-\-config \fIPATH\fR, \fB\-C \fIPATH
  59 Set the configuration file.
  60 The default is
  61 .IR pkgconfdir/config .
  62 .TP
  63 .B \-\-socket \fIPATH\fR, \fB\-s \fIPATH
  64 Set the control socket.
  65 Normally this would not be used manually.
  66 .TP
  67 .B \-\-help\fR, \fB\-h
  68 Display a usage message.
  69 .TP
  70 .B \-\-version\fR, \fB\-V
  71 Display version number.
  72 .SS "Buffer Control Options"
  73 You shouldn't need to use these options.
  74 .TP
  75 .B \-\-min \fIFRAMES\fR, \fB\-m \fIFRAMES\fR
  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.
  79 .TP
  80 .B \-\-buffer \fIFRAMES\fR, \fB\-b \fIFRAMES\fR
  81 Specifies the buffer high watermark in frames.
  82 Once there are this many frames in the buffer, playing will be (re-)started.
  83 .TP
  84 .B \-\-max \fIFRAMES\fR, \fB\-x \fIFRAMES\fR
  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.
  88 The default is four times the \fB\-\-buffer\fR value.
  89 .TP
  90 .B \-\-rcvbuf \fIBYTES\fR, \fB\-R \fIBYTES\fR
  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.
  94 .SH "REMOTE CONTROL"
  95 The
  96 .B \-\-socket
  97 option is used by Disobedience to control a background
  98 .B disorder\-playrtp
  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:
 103 .TP
 104 .B stop
 105 Causes
 106 .B disorder\-playrtp
 107 to terminate.
 108 .TP
 109 .B query
 110 Causes the string "running" to be sent back.
 111 .PP
 112 Other commands are ignored.
 113 After the first command the connection is closed.
 114 Only one connection at a time will be serviced.
 115 .PP
 116 This protocol is not guaranteed to be stable.
 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.
 127 .SH "SEE ALSO"
 128 .BR disobedience (1),
 129 .BR disorder_config (5),
 130 .BR disorderd (8)
 131 .\" Local Variables:
 132 .\" mode:nroff
 133 .\" fill-column:79
 134 .\" End: