even chattier logging

[disorder] / doc / disorder_config.5.in

diff --git a/doc/disorder_config.5.in b/doc/disorder_config.5.in
index 8fea1ec..744bf13 100644 (file)
--- a/doc/disorder_config.5.in
+++ b/doc/disorder_config.5.in
@@ -1,3 +1,4 @@
+

 .\"
 .\" Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell
 .\"
 .\"
 .\" Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell
 .\"


@@ -116,6 +117,7 @@ start up without a valid config file.)
 .B home \fIDIRECTORY\fR
 The home directory for state files.  Defaults to
 .IR pkgstatedir .
 .B home \fIDIRECTORY\fR
 The home directory for state files.  Defaults to
 .IR pkgstatedir .

+The server will create this directory on startup if it does not exist.

 .TP
 .B plugin \fIPATH\fR
 Adds a directory to the plugin path.  (This is also used by the web
 .TP
 .B plugin \fIPATH\fR
 Adds a directory to the plugin path.  (This is also used by the web


@@ -345,6 +347,16 @@ The number of channels.
 .PP
 The default is
 .BR 16/44100/2 .
 .PP
 The default is
 .BR 16/44100/2 .

+.PP
+With the
+.B network
+backend the sample format is forced to
+.B 16b/44100/2
+and with the
+.B coreaudio
+backend it is forced to
+.BR 16/44100/2 ,
+in both cases regardless of what is specified in the configuration file.

 .RE
 .TP
 .B signal \fINAME\fR
 .RE
 .TP
 .B signal \fINAME\fR


@@ -363,10 +375,18 @@ available:
 Use the ALSA API.  This is only available on Linux systems, on which it is the
 default.
 .TP
 Use the ALSA API.  This is only available on Linux systems, on which it is the
 default.
 .TP

+.B coreaudio
+Use Apple Core Audio.  This only available on OS X systems, on which it is the
+default.
+.TP
+.B oss
+Use the OSS (/dev/dsp) API.  Not available on all platforms.  Not well
+maintained at the moment.
+.TP

 .B command
 Execute a command.  This is the default if
 .B speaker_command
 .B command
 Execute a command.  This is the default if
 .B speaker_command

-is specified, or (currently) on non-Linux systems.
+is specified, or if no native is available.

 .TP
 .B network
 Transmit audio over the network.  This is the default if
 .TP
 .B network
 Transmit audio over the network.  This is the default if


@@ -489,6 +509,9 @@ Configuration files are read in the following order:
 .I pkgconfdir/config.private
 Should be readable only by the jukebox group, and contain \fBallow\fR
 commands for authorised users.
 .I pkgconfdir/config.private
 Should be readable only by the jukebox group, and contain \fBallow\fR
 commands for authorised users.

+.IP
+If this file does not exist at startup then the server will create it with a
+randomly chosen password for the root user.

 .TP
 .I pkgconfdir/config.\fRUSER
 Per-user system-controlled client configuration.  Optional but if it
 .TP
 .I pkgconfdir/config.\fRUSER
 Per-user system-controlled client configuration.  Optional but if it