update docs for mail_sender and smtp_server

[disorder] / doc / disorder_config.5.in
diff --git a/doc/disorder_config.5.in b/doc/disorder_config.5.in

index 269abe855c7aad4348030e997145d162328eb6f3..bd422d54f04c4129c3c46ee36defc5adead0f40d 100644 (file)
--- a/doc/disorder_config.5.in
+++ b/doc/disorder_config.5.in
@@ -571,6 +571,9 @@ over track names.
  .IP
  If \fBstopword\fR is used without arguments then the list of stopwords is
  cleared.
+.IP
+There is a default set of stopwords built in, but this option can be used to
+augment or replace that list.
  .TP
  .B tracklength \fIPATTERN\fR \fIMODULE\fR
  Specifies the module used to calculate the length of files matching
@@ -589,6 +592,10 @@ Connect to the address specified by \fIHOST\fR and port specified by
  \fISERVICE\fR.
  .SS "Web Interface Configuration"
  .TP
+.B mail_sender \fIADDRESS\fR
+The email address that appears in the From: field of any mail messages sent by
+the web interface.  This must be set if you have online registration enabled.
+.TP
  .B refresh \fISECONDS\fR
  Specifies the maximum refresh period in seconds.  Default 15.
  .TP
@@ -596,6 +603,10 @@ Specifies the maximum refresh period in seconds.  Default 15.
  Defines the maximum number of characters to include in a \fBshort\fR name
  part.  Default 30.
  .TP
+.B smtp_server \fIHOSTNAME\fR
+The hostname (or address) of the SMTP server to use for sending mail.  The
+default is 127.0.0.1.
+.TP
  .B templates \fIPATH\fR ...
  Specifies the directory containing templates used by the web
  interface.  If a template appears in more than one template directory
@@ -748,9 +759,10 @@ Additionally, other standard files are included by these:
  Included at the end of the main content \fB<DIV>\fR element.
  .TP
  .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.)
+Included at the start of the \fB<BODY>\fR element.
+.TP
+.B topbarend.html
+Included at the end of the \fB<BODY>\fR element.
  .TP
  .B stdhead.html
  Included in the \fB<HEAD>\fR element.
@@ -911,6 +923,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
@@ -992,9 +1008,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.