X-Git-Url: https://git.distorted.org.uk/~mdw/disorder/blobdiff_plain/00753f260a8cdb283cfde8cd096ed0ef6e0751cb..6151ae7e03c567cb5c2287386362f2fed68a225c:/doc/disorder_config.5.in diff --git a/doc/disorder_config.5.in b/doc/disorder_config.5.in index 952b2b9..58526c5 100644 --- a/doc/disorder_config.5.in +++ b/doc/disorder_config.5.in @@ -1,20 +1,18 @@ .\" .\" Copyright (C) 2004-2008 Richard Kettlewell .\" -.\" This program is free software; you can redistribute it and/or modify +.\" 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 -.\" the Free Software Foundation; either version 2 of the License, or +.\" the Free Software Foundation, either version 3 of the License, or .\" (at your option) any later version. -.\" -.\" This program is distributed in the hope that it will be useful, but -.\" WITHOUT ANY WARRANTY; without even the implied warranty of -.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -.\" General Public License for more details. -.\" +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" .\" You should have received a copy of the GNU General Public License -.\" along with this program; if not, write to the Free Software -.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 -.\" USA +.\" along with this program. If not, see . .\" .TH disorder_config 5 .SH NAME @@ -37,7 +35,7 @@ See \fBdisorder\fR(3) for more details about this. Each track can have a set of preferences associated with it. These are simple key-value pairs; they can be used for anything you like, but a number of keys have specific meanings. -See \fBdisorder\fR(1) for more details about these. +See \fBdisorder_preferences\fR(5) for more details about these. .SS "Track Names" Track names are derived from filenames under the control of regular expressions, rather than attempting to interpret format-specific embedded name @@ -50,6 +48,7 @@ the displayed track titles are not lexically sorted. .SS "Server State" A collection of global preferences define various bits of server state: whether random play is enabled, what tags to check for when picking at random, etc. +See \fBdisorder_preferences\fR(5) for more information. .SS "Users And Access Control" DisOrder distinguishes between multiple users. This is for access control and reporting, not to provide different @@ -478,7 +477,7 @@ namepart ext "(\\.[a-zA-Z0-9]+)$" $1 * .TP .B new_bias \fIWEIGHT\fR The weight for new tracks. -The default is 900000, i.e. recently added tracks are a hundred times as likely +The default is 450000, i.e. recently added tracks are a fifty times as likely to be picked as normal. .TP .B new_bias_age \fISECONDS\fR @@ -712,7 +711,7 @@ Specify password. .TP .B username \fIUSERNAME\fR Specify username. -The default is taken from the environment variable \fBLOGNAME\fR. +The default is inferred from the current UID. .SS "Web Interface Configuration" .\" TODO this section is misnamed really... .TP @@ -725,6 +724,12 @@ This must be set if you have online registration enabled. Specifies the maximum refresh period in seconds. Default 15. .TP +.B sendmail \fIPATH\fR +The path to the Sendmail executable. +This must support the \fB-bs\fR option (Postfix, Exim and Sendmail should all +work). +The default is the sendmail executable found at compile time. +.TP .B short_display \fICHARACTERS\fR Defines the maximum number of characters to include in a \fBshort\fR name part. @@ -733,6 +738,7 @@ Default 30. .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. +If \fBsendmail\fR is set then that is used instead. .TP .B transform \fITYPE\fR \fIREGEXP\fR \fISUBST\fR [\fICONTEXT\fR [\fIREFLAGS\fR]] Determines how names are sorted and displayed in track choice displays. @@ -773,34 +779,6 @@ longer needs to be specified. This must be the full URL, e.g. \fBhttp://myhost/cgi-bin/jukebox\fR and not \fB/cgi-bin/jukebox\fR. .SH "GLOBAL PREFERENCES" -These are the values set with \fBset\-global\fR. -.TP -.B required\-tags -If this is set an nonempty then randomly played tracks will always have at -least one of the listed tags. -.TP -.B prohibited\-tags -If this is set an nonempty then randomly played tracks will never have any of -the listed tags. -.TP -.B playing -If unset or \fByes\fR then play is enabled. -Otherwise it is disabled. -Use \fBdisable\fR rather than setting it directly. -.TP -.B random\-play -If unset or \fByes\fR then random play is enabled. -Otherwise it is disabled. -Use \fBdisable\fR rather than setting it directly. -.PP -Global preferences starting '_' are read-only (in the sense that you cannot -modify them; the server may modify them as part of its normal operation). -They are: -.TP -.B _dbversion -The database version string. -This is used by DisOrder to detect when it must -modify the database after an upgrade. .SH "LIBAO DRIVER" .SS "Raw Protocol Players" Raw protocol players are expected to use the \fBdisorder\fR libao driver. @@ -856,7 +834,7 @@ name and \fBext\fR which is the filename extension, including the initial dot .SH "SEE ALSO" \fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder\-dump\fR(8), \fBpcrepattern\fR(3), \fBdisorder_templates\fR(5), \fBdisorder_actions\fR(5), -\fBdisorder.cgi\fR(8) +\fBdisorder.cgi\fR(8), \fBdisorder_preferences\fR(5) .\" Local Variables: .\" mode:nroff .\" fill-column:79