'collection' no longer requires an encoding to be specified (or a module).

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

index eeef352daa801e3ae49c127c9944732e46b79aab..ffabeb8d8d6dc273b5b73fc3e4256e29b90d6f2b 100644 (file)
--- a/doc/disorder_config.5.in
+++ b/doc/disorder_config.5.in
@@ -287,18 +287,29 @@ You can also specify channels by number, if you know the right value.  NB that
  volume setting only works on OSS systems (including ALSA, via emulation).
  .TP
  .B collection \fIMODULE\fR \fIENCODING\fR \fIROOT\fR
+.TP
+.B collection \fIMODULE\fR \fIROOT\fR
+.TP
+.B collection \fIROOT\fR
  Define a collection of tracks.
  .IP
  \fIMODULE\fR defines which plugin module should be used for this
-collection.  Use the supplied \fBfs\fR module for tracks that exists
-as ordinary files in the filesystem.
+collection.  Use the supplied \fBfs\fR module for tracks that exist
+as ordinary files in the filesystem.  If no \fIMODULE\fR is specified
+then \fBfs\fR is assumed.
  .IP
-\fIENCODING\fR defines the encoding of filenames in this collection.
-For \fBfs\fR this would be the encoding you use for filenames.
-Examples might be \fBiso-8859-1\fR or \fButf-8\fR.
+\fIENCODING\fR defines the encoding of filenames in this collection.  For
+\fBfs\fR this would be the encoding you use for filenames.  Examples might be
+\fBiso-8859-1\fR or \fButf-8\fR.  If no encoding is specified then the current
+locale's character encoding is used.
+.IP
+NB that this default depends on the locale the server runs in, which is not
+necessarily the same as that of ordinary users, depending how the system is
+configured.  It's best to explicitly specify it to be certain.
  .IP
  \fIROOT\fR is the root in the filesystem of the filenames and is
-passed to the plugin module.
+passed to the plugin module.  It must be an absolute path and should not
+end with a "/".
  .TP
  .B default_rights \fIRIGHTS\fR
  Defines the set of rights given to new users.  The argument is a
@@ -571,6 +582,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 +603,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 +614,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 +770,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.