Sort out static content. There is a new expansion @image:NAME@ which

[disorder] / doc / disorder_config.5.in

diff --git a/doc/disorder_config.5.in b/doc/disorder_config.5.in
index a57a33708b2d46bf989f4215efb381aecb690692..a2e638395e4c61ded25d2d26b1011ce7213b6251 100644 (file)
--- a/doc/disorder_config.5.in
+++ b/doc/disorder_config.5.in
@@ -1,5 +1,5 @@
 .\"
-.\" Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell
+.\" Copyright (C) 2004-2008 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
@@ -313,7 +313,8 @@ it affects all output devices.
 .IP
 You can also specify channels by number, if you know the right value.
 .IP
-For \fBapi alsa\fR, volume setting is not currently supported.
+For \fBapi alsa\fR, this is the name of the mixer control to use.  The default
+is \fBPCM\fR.  Use \fBamixer scontrols\fR or similar to get a full list.
 .IP
 For \fBapi coreaudio\fR, volume setting is not currently supported.
 .TP
@@ -361,7 +362,8 @@ For \fBapi alsa\fR this is the device name to use.
 .IP
 For \fBapi coreaudio\fR this is currently ignored.
 .IP
-The default is \fBdefault\fR.
+The default is \fBdefault\fR, which is intended to map to whatever the system's
+default is.
 .TP
 .B gap \fISECONDS\fR
 Specifies the number of seconds to leave between tracks.  The default
@@ -390,7 +392,8 @@ The mixer device name, if it needs to be specified separately from
 For \fBapi oss\fR this should be the path to the mixer device and the default
 is \fI/dev/mixer\fR.
 .IP
-For \fBapi alsa\fR, volume setting is not currently supported.
+For \fBapi alsa\fR, this is the index of the mixer control to use.  The default
+is 0.
 .IP
 For \fBapi coreaudio\fR, volume setting is not currently supported.
 .TP
@@ -908,7 +911,18 @@ The ID of the current track.
 If \fIBOOL\fR expands to \fBtrue\fR then expands to \fITRUEPART\fR, otherwise
 to \fIFALSEPART\fR (which may be omitted).
 .TP
-.B @include:\fIPATH\fR@
+.B @image:\fINAME\fB@
+Expands to the (possibly relative) URL for image \fINAME\fR.
+.IP
+If there is a label \fBimages.\fINAME\fR then that will be the image base name.
+Otherwise the image base name is \fINAME\fB.png\fR or just \fINAME\fR if it
+alraedy has an extension.  Thus labels may be defined to give images role
+names.
+.IP
+If there is a label \fBurl.static\fR then that is the base URL for images.  If
+it is not defined then \fB/disorder\fR is used as a default.
+.TP
+.B @include:\fIPATH\fB@
 Include the named file as if it were a template file.  If \fIPATH\fR
 starts with a \fB/\fR then it is used as-is; otherwise, ".html" is
 appended and the template path is searched.
@@ -1158,6 +1172,9 @@ URL-quote \fISTRING\fR.
 .B @user@
 The current username.  This will be "guest" if nobody is logged in.
 .TP
+.B @userinfo{\fIPROPERTY\fB}@
+Look up a property of the logged-in user.
+.TP
 .B @version@
 Expands to \fBdisorder.cgi\fR's version string.
 .TP