2 .\" Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell
4 .\" This program is free software; you can redistribute it and/or modify
5 .\" it under the terms of the GNU General Public License as published by
6 .\" the Free Software Foundation; either version 2 of the License, or
7 .\" (at your option) any later version.
9 .\" This program is distributed in the hope that it will be useful, but
10 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 .\" General Public License for more details.
14 .\" You should have received a copy of the GNU General Public License
15 .\" along with this program; if not, write to the Free Software
16 .\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
21 disorder \- DisOrder jukebox client
29 is used to query the \fBdisorderd\fR(8) daemon from the command line.
30 It may be used to request tracks, scratch tracks, query the current
31 state, etc, and by an administrator to shutdown or reconfigure the
34 If no commands are specified then \fBdisorder\fR connects to the
35 daemon and then immediately disconnects. This can be used to test
36 whether the daemon is running. Otherwise, it executes the commands
40 .B --config \fIPATH\fR, \fB-c \fIPATH
41 Set the configuration file. The default is
42 .IR pkgconfdir/config .
48 Display a usage message.
50 .B --version\fR, \fB-V
51 Display version number.
53 .B --help-commands\fR, \fB-H
54 List all known commands.
57 .B adduser \fIUSER PASSWORD\fR
58 Create a new user with default rights.
63 .B dirs \fIDIRECTORY\fR [\fB~\fIREGEXP\fR]
64 List all the directories in \fIDIRECTORY\fR.
66 An optional regexp may be specified, marked with an initial \fB~\fR. Only
67 directories with a basename matching the regexp will be returned.
70 Disables playing after the current track finishes.
72 .B edituser \fIUSER PROPERTY VALUE
73 Set some property of a user.
78 .B files \fIDIRECTORY\fR [\fB~\fIREGEXP\fR]
79 List all the files in \fIDIRECTORY\fR.
81 An optional regexp may be specified, marked with an initial \fB~\fR. Only
82 files with a basename matching the regexp will be returned.
84 .B get \fITRACK\fR \fIKEY\fR
85 Display the preference \fIKEY\fR for \fITRACK\fR.
87 .B get-global \fIKEY\fR
88 Get a global preference.
91 Displays the current volume settings.
94 Reports the length of \fITRACK\fR in seconds.
97 Writes event log messages to standard output, until the server is terminated.
98 See \fBdisorder_protocol\fR (5) for details of the output syntax.
100 .B move \fITRACK\fR \fIDELTA\fR
105 within the queue. Positive values move towards the head of the queue, negative
106 values towards the tail.
108 Note that if you specify a negative value then the
110 option separate (before all commands) becomes mandatory, as otherwise the
111 negative value is misinterpreted an an option.
113 .B part \fITRACK\fR \fICONTEXT\fI \fIPART\fR
114 Get a track name part.
116 \fICONTEXT\fR should be either \fBsort\fR or \fBdisplay\fR. \fBpart\fR is the
117 part of the name desired, typically \fBartist\fR, \fBalbum\fR or \fBtitle\fR.
120 Pause the current track. (Note that not all players support pausing.)
122 .B play \fITRACKS\fR...
123 Add \fITRACKS\fR to the end of the queue.
126 Report the currently playing track.
129 Display all the preferences for \fITRACK\fR.
132 List the current queue. The first entry in the list is the next track to play.
141 List recently played tracks. The first entry is the oldest track, the last
142 entry is the most recently played one.
144 .B remove \fITRACK\fR
145 Remove a track from the queue.
147 .B resolve \fITRACK\fR
148 Resolve aliases for \fITRACK\fR and print out the real track name.
151 Resume the current track after a pause.
154 Report the RTP brodcast address used by the server (if any).
157 Scratch the currently playing track.
159 .B scratch-id \fIID\fR
160 Scratch the currently playing track, provided it has the given ID.
162 .B search \fITERMS\fR
163 Search for tracks containing all of the listed terms. The terms are
164 separated by spaces and form a single argument, so must be quoted,
167 .B "disorder search 'bowie china'"
169 You can limit the search to tracks with a particular tag, too, using the
170 \fBtag:\fR modifier. For example:
172 .B "disorder search 'love tag:depressing'"
174 .B set \fITRACK\fR \fIKEY\fR \fIVALUE\fR
175 Set the preference \fIKEY\fR for \fITRACK\fR to \fIVALUE\fR.
177 .B set-global \fIKEY\fR \fIVALUE\fR
178 Set a global preference.
180 .B set-volume \fBLEFT\fR \fBRIGHT\fR
184 List server statistics.
189 .B unset \fITRACK\fR \fIKEY\fR
190 Unset the preference \fIKEY\fR for \fITRACK\fR.
192 .B unset-global \fIKEY\fR
193 Unset the global preference \fIKEY\fR.
199 Report the daemon's version number.
205 tracks may be specified by name or by ID. If you use the name and a track
206 appears twice in the queue it is undefined which is affected.
207 .SS "Privileged Commands"
208 These commands are only available to privileged users.
214 Make the daemon reload its configuration file.
217 Rescan the filesystem for new tracks. There is an automatic daily rescan but
218 if you've just added some tracks and want them to show up immediately, use this
222 Shut down the daemon.
224 Currently the following preferences are supported. Some are expected
225 to be set by users, others updated automatically by plugins.
228 If this preference is present and set to "0" then the track will not
229 be picked for random play. Otherwise it may be.
232 A decimal integer giving the number times the track was played. This
233 includes tracks that are scratched or were picked at random.
236 The last time the track was played, as a \fBtime_t\fR converted to a
240 The number of times the track has been scratched.
243 A decimal integer giving the number of times the track was requested.
244 (Tracks that are removed before being played are not counted.)
247 Tags that apply to this track, separated by commas. Tags can contain any
248 printing character except comma. Leading and trailing spaces are not
249 significant but internal spaces are.
255 global preferences, it is possible to limit the tracks that will be selected at
258 .B trackname_\fICONTEXT\fB_\fIPART\fR
259 These preferences can be used to override the filename parsing rules
260 to find a track name part. For backwards compatibility,
261 \fBtrackname_\fIPART\fR will be used if the full version
265 The number of times the track has been played to completion without
267 .SH "Superuser Commands"
268 These commands will (generally) only work for root, who must be a privileged
271 .B authorize \fIUSER\fR
272 Chooses a password for \fIUSER\fR and adds it to \fIconfig.private\fR. Also
273 creates an appropriate \fIconfig.USER\fR, be owned by the user.
275 If at least one \fBauthorize\fR command succeeds then the server is
276 automatically told to re-read its configuration.
279 is locale-aware. If you do not set the locale correctly then it may
280 not handle non-ASCII data properly.
282 The client determines which user to attempt to authenticate as by
283 examining the current UID.
285 This program is not intended to run in a setuid environment.
287 The regexp syntax used by the \fBfiles\fR and \fBdirs\fR commands use the
288 syntax described in \fBpcrepattern\fR(3). Matching is case-independent. It is
289 strongly recommended that you quote regexps, since they often contain
290 characters treated specially by the shell. For example:
292 .B "disorder dirs /Music ~'^(?!the [^t])t'"
294 If you cannot play a track, or it does not appear in the database even after a
295 rescan, check the following things:
298 Are there any error messages in the system log? The server logs to
299 \fBLOG_DAEMON\fR, which typically ends up in
300 .I /var/log/daemon.log
302 .IR /var/log/messages ,
303 though this depends on local configuration.
306 Is the track in a known format? Have a look at
308 for the formats recognized by the local installation. The filename matching is
312 Do permissions on the track allow the server to read it?
315 Do the permissions on the containing directories allow the server to read and
318 The user the server runs as is determined by the \fBuser\fR directive in the
319 configuration file. The README recommends using \fBjukebox\fR for this purpose
320 but it could be different locally.
324 The default username.
327 The user's home directory.
329 .B LC_ALL\fR, \fBLANG\fR, etc
330 Current locale. See \fBlocale\fR(7).
334 Global configuration file. See \fBdisorder_config\fR(5).
336 .I ~/.disorder/passwd
337 Per-user password file
339 .I pkgstatedir/socket
340 Communication socket for \fBdisorder\fR(1).
342 \fBdisorderd\fR(8), \fBdisorder_config\fR(5), \fBsyslog\fR(3), \fBtime\fR(2),
343 \fBpcrepattern\fR(3), \fBdisobedience\fR(1)
345 "\fBpydoc disorder\fR" for the Python API documentation.