detect ALSA capability automatically

[disorder] / doc / disorder_config.5.in

diff --git a/doc/disorder_config.5.in b/doc/disorder_config.5.in
index 4cde04fcf7bd388c7453a47c6cdca0580e6f50c7..26b1efc5841eb48e150e374a775501c4c4a0f46b 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
 .\"


@@ -142,6 +143,12 @@ automatically included, but should include the proper extension.
 .IP
 The default is \fB{/artist}{/album}{/title}{ext}\fR.
 .TP
 .IP
 The default is \fB{/artist}{/album}{/title}{ext}\fR.
 .TP

+.B authorization_algorthm \fIALGORITHM\fR
+Defines the algorithm used to authenticate clients.  The valid options
+are sha1 (the default), sha256, sha384 and sha512.  See
+.BR disorder_protocol (5)
+for more details.
+.TP

 .B broadcast \fIADDRESS\fR \fIPORT\fR
 Transmit sound data to \fIADDRESS\fR using UDP port \fIPORT\fR.  This implies
 \fBspeaker_backend network\fR.
 .B broadcast \fIADDRESS\fR \fIPORT\fR
 Transmit sound data to \fIADDRESS\fR using UDP port \fIPORT\fR.  This implies
 \fBspeaker_backend network\fR.


@@ -247,7 +254,7 @@ them.  See the example config file for the defaults.
 Set the recan subprocess priority.  The default is 10.
 .IP
 (Note that higher values mean the process gets less CPU time; UNIX priority
 Set the recan subprocess priority.  The default is 10.
 .IP
 (Note that higher values mean the process gets less CPU time; UNIX priority

-values are the backwards.)
+values are backwards.)

 .TP
 .B nice_server \fIPRIORITY\fR
 Set the server priority.  This is applied to the server at startup time (and
 .TP
 .B nice_server \fIPRIORITY\fR
 Set the server priority.  This is applied to the server at startup time (and


@@ -262,6 +269,10 @@ is not massively CPU intensive by today's standards but depends on reasonably
 timely scheduling.  If you have limited CPU then it might help to set this to a
 small negative value.  The default is 0.
 .TP
 timely scheduling.  If you have limited CPU then it might help to set this to a
 small negative value.  The default is 0.
 .TP

+.B noticed_history
+The maximum days that a track can survive in the database of newly added
+tracks.  The default is 31.
+.TP

 .B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB--\fR]] \fIARGS\fR...
 Specifies the player for files matching the glob \fIPATTERN\fR.  \fIMODULE\fR
 specifies which plugin module to use.
 .B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB--\fR]] \fIARGS\fR...
 Specifies the player for files matching the glob \fIPATTERN\fR.  \fIMODULE\fR
 specifies which plugin module to use.


@@ -335,6 +346,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


@@ -353,10 +374,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


@@ -548,6 +577,9 @@ then the root directory is used.
 Provides a front end to \fBchoose.html\fR which allows subsets of the top level
 directories to be selected by initial letter.
 .TP
 Provides a front end to \fBchoose.html\fR which allows subsets of the top level
 directories to be selected by initial letter.
 .TP

+.B new.html
+Lists newly added tracks.
+.TP

 .B playing.html
 The "front page", which usually shows the currently playing tracks and
 the queue.
 .B playing.html
 The "front page", which usually shows the currently playing tracks and
 the queue.


@@ -578,8 +610,10 @@ Additionally, other standard files are included by these:
 .B credits.html
 Included at the end of the main content \fB<DIV>\fR element.
 .TP
 .B credits.html
 Included at the end of the main content \fB<DIV>\fR element.
 .TP

-.B sidebar.html
-Included at the start of the \fB<BODY>\fR element.
+.B topbar.html
+Included at the start of the \fB<BODY>\fR element.  (This supplants
+\fBsidebar.html\fR, though the latter is still available; override label
+\fBmenu\fR to choose between them.)

 .TP
 .B stdhead.html
 Included in the \fB<HEAD>\fR element.
 .TP
 .B stdhead.html
 Included in the \fB<HEAD>\fR element.


@@ -718,6 +752,10 @@ argument in a loop (\fB@queue\fR or similar), otherwise to \fBfalse\fR.
 Expands to \fBtrue\fR if this is the last repetition of a \fITEMPLATE\fR in a
 loop, otherwise to \fBfalse\fR.
 .TP
 Expands to \fBtrue\fR if this is the last repetition of a \fITEMPLATE\fR in a
 loop, otherwise to \fBfalse\fR.
 .TP

+.B @isnew@
+Expands to \fBtrue\fR if the newly added tracks list has any tracks in it,
+otherwise to \fBfalse\fR.
+.TP

 .B @isplaying@
 Expands to \fBtrue\fR if a track is playing, otherwise to \fBfalse\fR.
 .TP
 .B @isplaying@
 Expands to \fBtrue\fR if a track is playing, otherwise to \fBfalse\fR.
 .TP


@@ -745,6 +783,10 @@ Usually used in \fBchoose.html\fR.
 .B @ne{\fIA\fB}{\fIB\fB}
 Expands to \fBtrue\fR if \fIA\fR and \fIB\fR differ, otherwise to \fBfalse\fR.
 .TP
 .B @ne{\fIA\fB}{\fIB\fB}
 Expands to \fBtrue\fR if \fIA\fR and \fIB\fR differ, otherwise to \fBfalse\fR.
 .TP

+.B @new{\fITEMPLATE\fB}
+Expands \fITEMPLATE\fR for each track in the newly added tracks list, starting
+with the most recent.  Used in \fBnew.html\fR.
+.TP

 .B @nfiles@
 Expands to the number of files from \fB@files\fR (above).
 .TP
 .B @nfiles@
 Expands to the number of files from \fB@files\fR (above).
 .TP