X-Git-Url: https://git.distorted.org.uk/~mdw/disorder/blobdiff_plain/0d350ff0f9e835fe30e599d437374fecf5e3bd44..90ad6c6efcbcdb2d12ffe9abf232da980b9ea446:/doc/disorder_config.5.in diff --git a/doc/disorder_config.5.in b/doc/disorder_config.5.in index 3641adf..a9549ed 100644 --- a/doc/disorder_config.5.in +++ b/doc/disorder_config.5.in @@ -214,12 +214,12 @@ Configuration files are read in the following order: Should be readable only by the jukebox group. Not really useful any more and will be abolished in future. .TP -.I ~\fRUSER\fI/.disorder/passwd +.I ~\fRUSERNAME\fI/.disorder/passwd Per-user client configuration. Optional but if it exists must be readable only by the relevant user. Would normally contain a \fBpassword\fR directive. .TP -.I pkgconfdir/config.\fRUSER +.I pkgconfdir/config.\fRUSERNAME Per-user system-controlled client configuration. Optional but if it exists must be readable only by the relevant user. Would normally contain a \fBpassword\fR directive. @@ -368,6 +368,15 @@ It's best to explicitly specify it to be certain. passed to the plugin module. It must be an absolute path and should not end with a "/". .TP +.B cookie_key_lifetime \fISECONDS\fR +Lifetime of the signing key used in constructing cookies. The default is one +week. +.TP +.B cookie_login_lifetime \fISECONDS\fR +Lifetime of a cookie enforced by the server. When the cookie expires the user +will have to log in again even if their browser has remembered the cookie that +long. The default is one day. +.TP .B default_rights \fIRIGHTS\fR Defines the set of rights given to new users. The argument is a comma-separated list of rights. @@ -395,6 +404,9 @@ default is. .B gap \fISECONDS\fR Specifies the number of seconds to leave between tracks. The default is 0. +.IP +NB this option currently DOES NOT WORK. If there is genuine demand it might be +reinstated. .TP .B history \fIINTEGER\fR Specifies the number of recently played tracks to remember (including @@ -581,6 +593,12 @@ The default is 10. The minimum number of seconds that must elapse between password reminders. The default is 600, i.e. 10 minutes. .TP +.B replay_min \fISECONDS\fR +The minimum number of seconds that must elapse after a track has been played +before it can be picked at random. The default is 8 hours. If this is set to +0 then there is no limit, though current \fBdisorder-choose\fR will not pick +anything currently listed in the recently-played list. +.TP .B sample_format \fIBITS\fB/\fIRATE\fB/\fICHANNELS Describes the sample format expected by the \fBspeaker_command\fR (below). The components of the format specification are as follows: @@ -673,7 +691,7 @@ Specifies the module used to calculate the length of files matching If \fBtracklength\fR is used without arguments then the list of modules is cleared. .TP -.B user \fIUSER\fR +.B user \fIUSERNAME\fR Specifies the user to run as. Only makes sense if invoked as root (or the target user). .SS "Client Configuration" @@ -750,8 +768,9 @@ 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. .SS "Authentication Configuration" -These options would normally be used in \fI~\fRUSER\fI/.disorder/passwd\fR or -\fIpkgconfdir/config.\fRUSER. +These options would normally be used in \fI~\fRUSERNAME\fI/.disorder/passwd\fR +or +\fIpkgconfdir/config.\fRUSERNAME. .TP .B password \fIPASSWORD\fR Specify password.