X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/eb5dc014179415a0e5476e986519ac96c36221f9..4a4c673c7705370b080f225d959293b845168a0c:/doc/disorder_config.5.in diff --git a/doc/disorder_config.5.in b/doc/disorder_config.5.in index a90d029..3cb36af 100644 --- a/doc/disorder_config.5.in +++ b/doc/disorder_config.5.in @@ -300,6 +300,15 @@ Examples might be \fBiso-8859-1\fR or \fButf-8\fR. \fIROOT\fR is the root in the filesystem of the filenames and is passed to the plugin module. .TP +.B default_rights \fIRIGHTS\fR +Defines the set of rights given to new users. The argument is a +comma-separated list of rights. For the possible values see +.B "Users And Access Control" +above. +.IP +The default is to allow everything except \fBadmin\fR and \fBregister\fR +(modified in legacy configurations by the obsolete \fBrestrict\fR directive). +.TP .B device \fINAME\fR ALSA device to play raw-format audio. Default is \fBdefault\fR, i.e. to use the whatever the ALSA configured default is. @@ -627,7 +636,8 @@ transform dir "[[:punct:]]" "" sort g .TP .B url \fIURL\fR Specifies the URL of the web interface. This URL will be used in -generated web pages. +generated web pages. The default is inferred at runtime, so this option no +longer needs to be specified. .IP This must be the full URL, e.g. \fBhttp://myhost/cgi-bin/jukebox\fR and not \fB/cgi-bin/jukebox\fR. @@ -738,9 +748,10 @@ Additionally, other standard files are included by these: Included at the end of the main content \fB
\fR element. .TP .B topbar.html -Included at the start of the \fB\fR element. (This supplants -\fBsidebar.html\fR, though the latter is still available; override label -\fBmenu\fR to choose between them.) +Included at the start of the \fB\fR element. +.TP +.B topbarend.html +Included at the end of the \fB\fR element. .TP .B stdhead.html Included in the \fB\fR element. @@ -901,6 +912,10 @@ file for full documentation of the labels used by the standard templates. .B @length@ Expands to the length of the current track. .TP +.B @movable@ +Expands to \fBtrue\fR if the current track is movable, otherwise to +\fBfalse\fR. +.TP .B @navigate{\fIDIRECTORY\fB}{\fITEMPLATE\fB} Expands \fITEMPLATE\fR for each component of \fIDIRECTORY\fR in turn. Use \fB@dirname\fR and \fB@basename@\fR to get the components of the path to @@ -982,9 +997,25 @@ Expands to \fBtrue\fR if random play is currently enabled, otherwise to Expands \fITEMPLATE\fR repeatedly using the each recently played track in turn as the current track. The most recently played track comes first. .TP +.B @removable@ +Expands to \fBtrue\fR if the current track is removable, otherwise to +\fBfalse\fR. +.TP .B @resolve{\fITRACK\fB}@ Resolve aliases for \fITRACK\fR and expands to the result. .TP +.B @right{\fIRIGHT\fB}@ +Exapnds to \fBtrue\fR if the user has right \fIRIGHT\fR, otherwise to +\fBfalse\fR. +.TP +.B @right{\fIRIGHT\fB}{\fITRUEPART\fB}{\fIFALSEPART\fB}@ +Expands to \fITRUEPART\fR if the user right \fIRIGHT\fR, otherwise to +\fIFALSEPART\fR (which may be omitted). +.TP +.B @scratchable@ +Expands to \fBtrue\fR if the currently playing track is scratchable, otherwise +to \fBfalse\fR. +.TP .B @search{\fIPART\fB}\fR[\fB{\fICONTEXT\fB}\fR]\fB{\fITEMPLATE\fB}@ Expands \fITEMPLATE\fR once for each group of search results that have a common value of track part \fIPART\fR. @@ -1081,6 +1112,9 @@ Expands to the canonical URL as defined in \fIpkgconfdir/config\fR. .B @urlquote{\fISTRING\fB}@ URL-quote \fISTRING\fR. .TP +.B @user@ +The current username. This will be "guest" if nobody is logged in. +.TP .B @version@ Expands to \fBdisorder.cgi\fR's version string. .TP