From 405fea4e00dc6ef00b77079effaa555217967520 Mon Sep 17 00:00:00 2001 Message-Id: <405fea4e00dc6ef00b77079effaa555217967520.1714162762.git.mdw@distorted.org.uk> From: Mark Wooding Date: Sun, 8 Jul 2007 14:44:43 +0100 Subject: [PATCH] document speaker_command and sample_format Organization: Straylight/Edgeware From: rjk@greenend.org.uk <> --- doc/disorder_config.5.in | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/doc/disorder_config.5.in b/doc/disorder_config.5.in index e3e0258..220b8f8 100644 --- a/doc/disorder_config.5.in +++ b/doc/disorder_config.5.in @@ -1,5 +1,5 @@ .\" -.\" Copyright (C) 2004, 2005, 2006 Richard Kettlewell +.\" Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell .\" .\" 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 @@ -296,6 +296,26 @@ If multiple player commands match a track then the first match is used. The interval at which the preferences log file will be synchronised. Defaults to 3600, i.e. one hour. .TP +.B sample_format \fIBITS\fB/\fIRATE\fB/\fICHANNELS +Describes the sample format expected by the \fBspeaker_command\fR (below). The +components of the format specification are as follows: +.RS +.TP 10 +.I BITS +The number of bits per sample. Optionally, may be suffixed by \fBb\fR or +\fBl\fR for big-endian and little-endian words. If neither is used the native +byte order is assumed. +.TP +.I RATE +The number of samples per second. +.TP +.I CHANNELS +The number of channels. +.PP +The default is +.BR 16/44100/2 . +.RE +.TP .B signal \fINAME\fR Defines the signal to be sent to track player process groups when tracks are scratched. The default is \fBSIGKILL\fR. @@ -303,6 +323,13 @@ scratched. The default is \fBSIGKILL\fR. Signals are specified by their full C name, i.e. \fBSIGINT\fR and not \fBINT\fR or \fBInterrupted\fR or whatever. .TP +.B speaker_command \fICOMMAND +Causes the speaker subprocess to pipe audio data into shell command +\fICOMMAND\fR, rather than writing to a local sound card. The sample format is +determine by +.B sample_format +above. +.TP .B restrict \fR[\fBscratch\fR] [\fBremove\fR] [\fBmove\fR] Determine which operations are restricted to the submitter of a track. By default, no operations are restricted, i.e. anyone can -- [mdw]