2 .\" Copyright (C) 2004-2008 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 3 of the License, or
7 .\" (at your option) any later version.
9 .\" This program is distributed in the hope that it will be useful,
10 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 .\" GNU 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, see <http://www.gnu.org/licenses/>.
19 disobedience \- GUI client for DisOrder jukebox
25 is a graphical client for DisOrder.
26 .SH "WINDOWS AND ICONS"
28 This has the following options:
31 Brings up the \fBLogin Details Window\fR; see below.
34 Brings up the \fBUser Management Window\fR; see below.
37 Terminates the program.
39 This has the following options:
41 .B "Select All Tracks"
44 .B "Deselect All Tracks"
48 Edit the details of the selected tracks.
50 .B "Properties Window"
53 This has the following options:
56 Interrupts the currently playing track.
59 Pause and resume the current track.
62 Enable and disable random play.
63 Does not take effect until the currently playing track finishes.
66 Enables or disables network play.
71 This has only one option, "About DisOrder", which pops up a box giving the
72 name, author and version number of the software.
76 The pause button can be used to pause and resume tracks.
77 This button shows either a pause symbol (two vertical bars) or a resume symbol
78 (a right-pointing arrow).
81 The scratch button, a red cross, can be used to interrupt the currently playing
84 .B "Random play button"
85 The random play button can be used to enable and disable random play.
86 It does not take effect until the currently playing track finishes.
87 When the button is green, random play is enabled.
88 When it is grey, random play is disabled.
91 The play button controls whether tracks will be played at all.
92 As above it does not take effect until the currently playing track finishes.
93 When the button is green, play is enabled.
94 When it is grey, play is disabled.
96 .B "Network play button"
97 The network play buttons enables or disables network play.
101 When the button is green, network play is enabled.
102 When it is grey, network play is disabled.
105 The volume slider indicates the current volume level and can be used to adjust
107 0 is silent and 10 is maximum volume.
110 The balance slider indicates the current balance and can be used to adjust it.
111 \-1 means only the left speaker, 0 means both speakers at equal volume and +1
112 means the only the right speaker.
114 This displays the currently playing track and the queue.
115 The currently playing track is at the top, and can be distinguished by
116 the constantly updating timer.
117 Queued tracks appear below it.
119 The left button can be use to select and deselect tracks.
120 On its own it just selects the pointed track and deselects everything else.
121 With CTRL it flips the state of the pointed track without affecting anything
123 With SHIFT it selects every track from the last click to the current position
124 and deselects everything else.
125 With both CTRL and SHIFT it selects everything from the last click to the
126 current position without deselecting anything.
128 Tracks can be moved within the queue by dragging them to a new position with
131 The right button pops up a menu.
132 This has the following options:
135 Edit the details of the selected tracks.
137 .B "Properties Window"
140 .B "Select All Tracks"
143 .B "Deselect All Tracks"
147 Interrupt the currently playing track.
148 (Note that this appears even if you right click over a queued track rather
149 than the currently playing track.)
151 .B "Remove track from queue"
152 Remove the selected tracks from the queue.
155 Sets the submitter of a randomly picked track to you.
157 This displays recently played tracks, the most recent at the top.
159 The left button functions as above, except that drag-and-drop rearrangement
161 The right button pops up a menu with the following options:
164 Edit the details of the selected tracks.
166 .B "Properties Window"
170 Play the select track(s);
172 .B "Select All Tracks"
175 .B "Deselect All Tracks"
178 This displays all the tracks known to the server in a tree structure.
180 Directories are represented with an arrow to their left.
181 This can be clicked to reveal or hide the contents of the directory.
182 The top level "directories" break up tracks by their first letter.
184 Playable files are represented by their name.
185 If they are playing or in the queue then a notes icon appears next to them.
187 Left clicking on a file will select it.
188 As with the queue tab you can use SHIFT and CTRL to select multiple files.
190 Files may be played by dragging them to the queue tab and thence to a
191 destination position in the queue.
193 The text box at the bottom is a search form.
194 If you enter search terms here then tracks containing all those words will be
196 You can also limit the results to tracks with particular tags, by including
197 \fBtag:\fITAG\fR for each tag.
199 To start a new search just edit the contents of the search box.
200 The cancel button to its right clears the current search.
201 The up and down arrows will scroll the window to make the previous or next
202 search result visible.
204 Right clicking over a track will pop up a menu with the following options:
207 Play selected tracks.
210 Edit properties of selected tracks.
212 .B "Properties Window"
215 A middle click on a track will add it to the queue.
217 Right clicking over a directory will pop up a menu with the following options:
220 Play all the tracks in the directory, in the order they appear on screen.
222 .B "Track properties"
223 Edit properties of all tracks in the directory.
226 Select all the tracks in the directory (and deselect everything else).
228 .B "Deselect all tracks"
231 This displays a list of tracks recently added to the server's database.
232 The most recently added track is at the top.
234 Left clicking a track will select it.
235 CTRL and SHIFT work as above to select muliple files.
237 Right clicking over a track will pop up a menu with the following options:
239 .B "Track properties"
240 Edit properties of selected tracks.
242 .B "Properties Window"
246 Play selected tracks.
248 .B "Select All Tracks"
251 .B "Deselect All Tracks"
253 .SS "Login Details Window"
254 The login details window allows you to edit the connection details and
255 authorization information used by Disobedience.
257 At the top is a 'remote' switch.
258 If this is enabled then you can use the \fBHostname\fR and \fBService\fR
259 fields to connect to a remote server.
260 If it is disabled then then Disobedience will connect to a local server
263 Below this are four text entry fields:
266 The host to connect to.
269 The service name or port number to connect to.
272 The user name to log in as.
275 The password to use when logging in.
276 Note that this is NOT your login password but is your password to the
282 This button attempts to (re-)connect to the server with the currently displayed
284 The settings are saved in
285 .IR $HOME/.disorder/passwd .
289 This button closes the window, discarding any unsaved changes.
290 .SS "Properties Window"
291 This window contains details of one or more tracks and allows them to be
294 The Artist, Album and Title fields determine how the tracks appear in
295 the queue and recently played tabs.
297 The Tags field determine which tags apply to the track.
298 Tags are separated by commas and can contain any printing characters except
301 The Weight field determines the track weight. Tracks with higher weights are
302 proportionately more likely to be picked at random. The default weight is
303 90000, and the maximum weight is 2147483647.
305 The Random checkbox determines whether the track will be picked at random.
306 Random play is enabled for every track by default, but it can be turned off
309 The double-headed arrow to the right of each preference will propagate its
310 value to all the other tracks in the window.
311 For instance, this can be used to efficiently correct the artist or album
312 fields, or bulk-disable random play for many tracks.
314 Press "OK" to confirm all changes and close the window, "Apply" to confirm
315 changes but keep the window open and "Cancel" to close the window and discard
317 .SS "User Management Window"
318 This window is primarily of interest to adminstrators, and will not be
319 available to users without admin rights. The left hand side is a list of all
320 users; the right hand side contains the editable details of the currently
323 When you select any user you can edit their email address or change their
324 password. It is also possible to edit the individual user rights. Click on
325 the "Apply" button to commit any changes you make.
327 The "Add" button creates a new user. You must enter at least a username.
328 Default rights are setting according to local configuration, \fInot\fR server
329 configuration (but this may be changed in the future). As above, click on
330 "Apply" to actually create the new user.
332 The "Delete" button deletes the selected user. This operation cannot be
334 .SH "KEYBOARD SHORTCUTS"
337 Select all tracks (queue/recent)
340 Brings up the \fBLogin Details Window\fR.
345 Network play uses a background
346 .BR disorder\-playrtp (1)
348 If you quit Disobedience the player will continue playing and can be
349 disabled from a later run of Disobedience.
351 The player will log to
352 .I ~/.disorder/HOSTNAME\-rtp.log
353 so look there if it does not seem to be working.
355 You can stop it without running Disobedience by the command
356 .BR "killall disorder\-playrtp" .
359 .B \-\-config \fIPATH\fR, \fB\-c \fIPATH
360 Set the configuration file.
362 .IR pkgconfdir/config .
364 .B \-\-debug\fR, \fB\-d
367 .B \-\-help\fR, \fB\-h
368 Display a usage message.
370 .B \-\-version\fR, \fB\-V
371 Display version number.
373 Additional options are supported by the GTK+ library.
374 Refer to GTK+ documentation for further information.
375 Under X11 they include:
377 .B \-\-display \fIDISPLAY\fR
378 The X display to use.
380 .B \-\-screen \fISCREEN\fR
381 The screen number to use.
382 .\" If know enough to use it you know enough to find it
385 .\" Make all X requests synchronously.
389 on the same host as the server then no additional configuration should be
392 If it is running on a different host then the easiest way to set it up is to
393 use the login details window in Disobedience.
394 Enter the connection details, use Login to connect to the server, and then
395 use Save to store them for future sessions.
397 The other clients read their configuration from the same location so after
398 setting up with Disobedience, tools such as
402 There is no particular provision for multiple users of the same computer
403 sharing a single \fBdisorder\-playrtp\fR process.
404 This shouldn't be too much of a problem in practice but something could
405 perhaps be done given demand.
407 Try to do remote user management when the server is configured to refuse this
408 produces rather horrible error behavior.
410 Only one track can be dragged at a time.
412 Resizing columns doesn't work very well.
416 .I ~/.disorder/HOSTNAME\-rtp
417 Socket for communication with RTP player.
419 .I ~/.disorder/HOSTNAME\-rtp.log
420 Log file for RTP player.
422 .BR disorder\-playrtp (1),
423 .BR disorder_config (5)
425 .B http://www.greenend.org.uk/rjk/disorder/
429 .B http://www.gtk.org/api/2.6/gtk/gtk\-x11.html
431 - Using GTK+ on the X Window System
~mdw / disorder / blob