X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/7736e1cc4f9caf63686a425cf716ab54c67647e4..1bce463aca30f9a111ed8f0e8ec0605e01311f89:/doc/disorder.1.in diff --git a/doc/disorder.1.in b/doc/disorder.1.in index 61f6f02..9de40a9 100644 --- a/doc/disorder.1.in +++ b/doc/disorder.1.in @@ -55,25 +55,25 @@ Display version number. List all known commands. .SH COMMANDS .TP -.B adduser \fIUSER PASSWORD\fR [\fIRIGHTS\fR] +.B adduser \fIUSERNAME PASSWORD\fR [\fIRIGHTS\fR] Create a new user. If \fIRIGHTS\fR is not specified then the \fBdefault_rights\fR setting from the server's configuration file applies. .TP -.B authorize \fIUSER\fR [\fIRIGHTS\fR] -Create \fIUSER\fR with a random password. -\fIUSER\fR must be a UNIX login user (not just any old string). +.B authorize \fIUSERNAME\fR [\fIRIGHTS\fR] +Create user \fIUSERNAME\fR with a random password. +User \fIUSERNAME\fR must be a UNIX login user (not just any old string). If \fIRIGHTS\fR is not specified then the \fBdefault_rights\fR setting from the server's configuration file applies. .IP -\fI~USER/.disorder/passwd\fR is created with the password in it, so the new +\fI~USERNAME/.disorder/passwd\fR is created with the password in it, so the new user should be able to log in immediately. .IP If writing the \fIpasswd\fR file fails then the user will already have been created in DisOrder's user database. Use \fBdisorder deluser\fR to remove them before trying again. .TP -.B deluser \fIUSER\fR +.B deluser \fIUSERNAME\fR Delete a user. .TP .B dirs \fIDIRECTORY\fR [\fB~\fIREGEXP\fR] @@ -85,7 +85,7 @@ Only directories with a basename matching the regexp will be returned. .B disable Disable playing after the current track finishes. .TP -.B edituser \fIUSER PROPERTY VALUE +.B edituser \fIUSERNAME PROPERTY VALUE Set some property of a user. .TP .B enable @@ -182,6 +182,41 @@ Resume the current track after a pause. .B rtp\-address Report the RTP brodcast address used by the server (if any). .TP +.B schedule-del \fIEVENT\fR +Delete a scheduled event. +.TP +.B schedule-list +List scheduled events. +Each line contains the ID, a timestamp, 'N' or 'J' for normal or junk priority, +the user, the action and action-specific data. +.TP +.B schedule-play \fIWHEN PRIORITY TRACK\fI +Play \fITRACK\fR at time \fIWHEN\fR. +Various time/date formats are supported depending on locale but the following +three will always work: +.RS +.RS +.TP +.B "YYYY-MM-DD HH:MM:SS" +.TP +.B "HH:MM:SS" +.TP +.B "HH:MM" +.RE +.RE +.IP +\fIPRIORITY\fR should be \fBjunk\fR or \fBnormal\fR. +This determines how the event is handled if it becomes due when the server is +down. +Junk events are just discarded in this case, while normal events will be +executed when the server comes back up, even if this is much later. +.TP +.B schedule-set-global \fIWHEN PRIORITY NAME VALUE\fI +Set global preference \fINAME\fR to \fIVALUE\fR at time \fIWHEN\fR. +.TP +.B schedule-unset-global \fIWHEN PRIORITY NAME\fI +Unset global preference \fINAME\fR at time \fIWHEN\fR. +.TP .B scratch Scratch the currently playing track. .TP @@ -238,7 +273,7 @@ Unset the preference \fIKEY\fR for \fITRACK\fR. .B unset\-global \fIKEY\fR Unset the global preference \fIKEY\fR. .TP -.B userinfo \fIUSER PROPERTY +.B userinfo \fIUSERNAME PROPERTY Get some property of a user. .TP .B users @@ -393,7 +428,7 @@ Per-user password file Communication socket for \fBdisorder\fR(1). .SH "SEE ALSO" \fBdisorderd\fR(8), \fBdisorder_config\fR(5), \fBsyslog\fR(3), \fBtime\fR(2), -\fBpcrepattern\fR(3), \fBdisobedience\fR(1) +\fBpcrepattern\fR(3), \fBdisobedience\fR(1), \fBdisorder.cgi\fR(8) .PP "\fBpydoc disorder\fR" for the Python API documentation. .\" Local Variables: