mdw@git.distorted.org.uk Git - disorder/blame_incremental

... / ...

Commit	Line	Data
	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	Only available on Linux.
	46	.TP
	47	.B \-\-oss\fR, \fB\-o
	48	Use OSS to play sound.
	49	Only available on Linux and FreeBSD.
	50	.TP
	51	.B \-\-core\-audio\fR, \fB\-c
	52	Use Core Audio to play sound.
	53	Only available on Macs.
	54	.TP
	55	.B \-\-device \fIDEVICE\fR, \fB\-D \fIDEVICE\fR
	56	Specifies the audio device to use.
	57	See
	58	.B "DEVICE NAMES"
	59	below for more information.
	60	.TP
	61	.B \-\-command \fICOMMAND\fR, \fB-e \fICOMMAND\fR
	62	Instead of sending to a physical audio device, invoke \fICOMMAND\fR using the
	63	shell and write audio samples to its standard input.
	64	Currently the input will be 44100KHz 16-bit signed stereo samples.
	65	If \fICOMMAND\fR exits it is re-executed; any samples that had been written to
	66	the pipe but not processed by the previous instance will be lost.
	67	.IP
	68	.B \-\-device
	69	is redundant with this option.
	70	.IP
	71	As an example,
	72	.B "-e \(aqcat > dump\(aq"
	73	would log audio data to a file for later processing.
	74	You could convert it to another format with, for instance:
	75	.IP
	76	.B "sox -c2 -traw -r44100 -s -w dump dump.wav"
	77	.TP
	78	.B \-\-config \fIPATH\fR, \fB\-C \fIPATH
	79	Set the configuration file.
	80	The default is
	81	.IR pkgconfdir/config .
	82	.TP
	83	.B \-\-socket \fIPATH\fR, \fB\-s \fIPATH
	84	Set the control socket.
	85	Normally this would not be used manually.
	86	.TP
	87	.B \-\-help\fR, \fB\-h
	88	Display a usage message.
	89	.TP
	90	.B \-\-version\fR, \fB\-V
	91	Display version number.
	92	.SS "Buffer Control Options"
	93	You shouldn't need to use these options.
	94	.TP
	95	.B \-\-min \fIFRAMES\fR, \fB\-m \fIFRAMES\fR
	96	Specifies the buffer low watermark in frames.
	97	If the number of frames falls below this value then playing will be
	98	stopped until the buffer fills up.
	99	.TP
	100	.B \-\-buffer \fIFRAMES\fR, \fB\-b \fIFRAMES\fR
	101	Specifies the buffer high watermark in frames.
	102	Once there are this many frames in the buffer, playing will be (re-)started.
	103	.TP
	104	.B \-\-max \fIFRAMES\fR, \fB\-x \fIFRAMES\fR
	105	Specifies the maximum buffer size in frames.
	106	If there are this many frames in the buffer then reading from the
	107	network socket will be suspended.
	108	The default is four times the \fB\-\-buffer\fR value.
	109	.TP
	110	.B \-\-rcvbuf \fIBYTES\fR, \fB\-R \fIBYTES\fR
	111	Specifies socket receive buffer size.
	112	The default is 131072 (128Kbytes).
	113	The buffer size will not be reduced below the operating system's default.
	114	.SH "REMOTE CONTROL"
	115	The
	116	.B \-\-socket
	117	option is used by Disobedience to control a background
	118	.B disorder\-playrtp
	119	daemon.
	120	The socket will be created as a UNIX domain stream socket.
	121	When a connection is received a single line is read from it.
	122	The following commands are known:
	123	.TP
	124	.B stop
	125	Causes
	126	.B disorder\-playrtp
	127	to terminate.
	128	.TP
	129	.B query
	130	Causes the string "running" to be sent back.
	131	.PP
	132	Other commands are ignored.
	133	After the first command the connection is closed.
	134	Only one connection at a time will be serviced.
	135	.PP
	136	This protocol is not guaranteed to be stable.
	137	.SH "DEVICE NAMES"
	138	.SS "Core Audio"
	139	On a Mac, the device name can either be the human-readable name of the desired
	140	output or its UID.
	141	To get a list of the human-readable names, visit System Preferences -> Sound;
	142	the Type column has the name you want.
	143	.PP
	144	For example, you might use "Built-in Output" for the built-in speaker
	145	or "Built-in Line Output" if you have connected external speakers.
	146	Remember to quote the name.
	147	.SH "SEE ALSO"
	148	.BR disobedience (1),
	149	.BR disorder_config (5),
	150	.BR disorderd (8)
	151	.\" Local Variables:
	152	.\" mode:nroff
	153	.\" fill-column:79
	154	.\" End: