.\"
-.\" Copyright (C) 2004, 2005, 2006 Richard Kettlewell
+.\" Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell
.\"
.\" 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
.RI [ OPTIONS ]
.RB [ -- ]
.RI [ COMMANDS ...]
-.br
-.B disorder
-.B --length
-.RI [ OPTIONS ]
-.RB [ -- ]
-.IR PATH ...
.SH DESCRIPTION
-Without the \fB--length\fR option,
.B disorder
is used to query the \fBdisorderd\fR(8) daemon from the command line.
It may be used to request tracks, scratch tracks, query the current
.B --help\fR, \fB-h
Display a usage message.
.TP
-.B --length\fR, \fB-L
-Calculate the length in seconds of the files specified using the tracklength
-plugin.
-.TP
.B --version\fR, \fB-V
Display version number.
.TP
List all known commands.
.SH COMMANDS
.TP
+.B adduser \fIUSER 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). If \fIRIGHTS\fR is not specified then the
+\fBdefault_rights\fR setting from the server's configuration file applies.
+.IP
+An appropriate \fIconfig.USER\fR is created, owned by the user, so they should
+be able to log in immediately.
+.TP
+.B deluser \fIUSER\fR
+Delete a user.
+.TP
.B dirs \fIDIRECTORY\fR [\fB~\fIREGEXP\fR]
List all the directories in \fIDIRECTORY\fR.
.IP
directories with a basename matching the regexp will be returned.
.TP
.B disable
-Disables playing after the current track finishes.
+Disable playing after the current track finishes.
+.TP
+.B edituser \fIUSER PROPERTY VALUE
+Set some property of a user.
.TP
.B enable
(Re-)enable playing.
Get a global preference.
.TP
.B get-volume
-Displays the current volume settings.
+Display the current volume settings.
.TP
.B length \fITRACK\fR
-Reports the length of \fITRACK\fR in seconds.
+Display the length of \fITRACK\fR in seconds.
.TP
.B log
-Writes event log messages to standard output, until the server is terminated.
+Write event log messages to standard output, until the server is terminated.
See \fBdisorder_protocol\fR (5) for details of the output syntax.
.TP
.B move \fITRACK\fR \fIDELTA\fR
List recently played tracks. The first entry is the oldest track, the last
entry is the most recently played one.
.TP
+.B reconfigure
+Make the daemon reload its configuration file.
+.TP
.B remove \fITRACK\fR
Remove a track from the queue.
.TP
+.B rescan
+Rescan the filesystem for new tracks. There is an automatic daily rescan but
+if you've just added some tracks and want them to show up immediately, use this
+command.
+.TP
.B resolve \fITRACK\fR
Resolve aliases for \fITRACK\fR and print out the real track name.
.TP
.B resume
Resume the current track after a pause.
.TP
+.B rtp-address
+Report the RTP brodcast address used by the server (if any).
+.TP
.B scratch
Scratch the currently playing track.
.TP
You can limit the search to tracks with a particular tag, too, using the
\fBtag:\fR modifier. For example:
.IP
-.B "disorder search 'love tag:depressing'
+.B "disorder search 'love tag:depressing'"
.TP
.B set \fITRACK\fR \fIKEY\fR \fIVALUE\fR
Set the preference \fIKEY\fR for \fITRACK\fR to \fIVALUE\fR.
Set a global preference.
.TP
.B set-volume \fBLEFT\fR \fBRIGHT\fR
-Sets the volume.
+Set the volume.
+.TP
+.B setup-guest \fR[\fB--no-online-registration\fR]
+Create the "guest" user for use by the web interface. This user will have no
+password and will only have the "read" and "register" rights, the latter
+allowing new users to automatically register themselves via the web interface.
+.IP
+With the option \fB--no-online-registration\fR, the "register" right is
+suppressed and users must be manually created by an administrator.
+.IP
+If online registration is desired then \fBmail_sender\fR must be set in the
+configuration file. See \fBdisorder_config\fR(5).
+.TP
+.B shutdown
+Shut down the daemon.
.TP
.B stats
List server statistics.
.B unset-global \fIKEY\fR
Unset the global preference \fIKEY\fR.
.TP
+.B userinfo \fIUSER PROPERTY
+Get some property of a user.
+.TP
+.B users
+List known users.
+.TP
.B version
Report the daemon's version number.
.PP
.BR remove ,
tracks may be specified by name or by ID. If you use the name and a track
appears twice in the queue it is undefined which is affected.
-.SS "Privileged Commands"
-These commands are only available to privileged users.
-.TP
-.B become \fIUSER\fR
-Become another user.
-.TP
-.B reconfigure
-Make the daemon reload its configuration file.
-.TP
-.B rescan
-Rescan the filesystem for new tracks. There is an automatic daily rescan but
-if you've just added some tracks and want them to show up immediately, use this
-command.
-.TP
-.B shutdown
-Shut down the daemon.
.SH PREFERENCES
Currently the following preferences are supported. Some are expected
to be set by users, others updated automatically by plugins.
.B unscratched
The number of times the track has been played to completion without
being scratched.
-.SH "Superuser Commands"
-These commands will (generally) only work for root, who must be a privileged
-user.
-.TP
-.B authorize \fIUSER\fR
-Chooses a password for \fIUSER\fR and adds it to \fIconfig.private\fR. Also
-creates an appropriate \fIconfig.USER\fR, be owned by the user.
-.IP
-If at least one \fBauthorize\fR command succeeds then the server is
-automatically told to re-read its configuration.
.SH NOTES
.B disorder
is locale-aware. If you do not set the locale correctly then it may
not handle non-ASCII data properly.
.PP
-The client determines which user to attempt to authenticate as by
-examining the current UID.
+The client determines which user to attempt to authenticate as by examining the
+current UID. This can be overridden in a per-user configuration file, see
+\fBdisorder_config\fR(5).
+.PP
+See \fBdisorder_protocol\fR(5) for the rights required to run each command.
+(For instance, \fBshutdown\fR requires the \fBadmin\fR right, which most users
+would not normally have.)
.PP
This program is not intended to run in a setuid environment.
.PP
~mdw / disorder / blobdiff