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.)
152 Remove the selected tracks from the queue.
154 This displays recently played tracks, the most recent at the top.
156 The left button functions as above, except that drag-and-drop rearrangement
158 The right button pops up a menu with the following options:
161 Edit the details of the selected tracks.
163 .B "Properties Window"
167 Play the select track(s);
169 .B "Select All Tracks"
172 .B "Deselect All Tracks"
175 This displays all the tracks known to the server in a tree structure.
177 Directories are represented with an arrow to their left.
178 This can be clicked to reveal or hide the contents of the directory.
179 The top level "directories" break up tracks by their first letter.
181 Playable files are represented by their name.
182 If they are playing or in the queue then a notes icon appears next to them.
184 Left clicking on a file will select it.
185 As with the queue tab you can use SHIFT and CTRL to select multiple files.
187 The text box at the bottom is a search form.
188 If you enter search terms here then tracks containing all those words will be
190 You can also limit the results to tracks with particular tags, by including
191 \fBtag:\fITAG\fR for each tag.
193 To start a new search just edit the contents of the search box.
194 The cancel button to its right clears the current search.
195 The up and down arrows will scroll the window to make the previous or next
196 search result visible.
198 Right clicking over a track will pop up a menu with the following options:
201 Play selected tracks.
204 Edit properties of selected tracks.
206 .B "Properties Window"
209 A middle click on a track will add it to the queue.
211 Right clicking over a directory will pop up a menu with the following options:
214 Play all the tracks in the directory, in the order they appear on screen.
216 .B "Track properties"
217 Edit properties of all tracks in the directory.
220 Select all the tracks in the directory (and deselect everything else).
222 .B "Deselect all tracks"
225 This displays a list of tracks recently added to the server's database.
226 The most recently added track is at the top.
228 Left clicking a track will select it.
229 CTRL and SHIFT work as above to select muliple files.
231 Right clicking over a track will pop up a menu with the following options:
233 .B "Track properties"
234 Edit properties of selected tracks.
236 .B "Properties Window"
240 Play selected tracks.
242 .B "Select All Tracks"
245 .B "Deselect All Tracks"
247 .SS "Login Details Window"
248 The login details window allows you to edit the connection details and
249 authorization information used by Disobedience.
251 At the top is a 'remote' switch.
252 If this is enabled then you can use the \fBHostname\fR and \fBService\fR
253 fields to connect to a remote server.
254 If it is disabled then then Disobedience will connect to a local server
257 Below this are four text entry fields:
260 The host to connect to.
263 The service name or port number to connect to.
266 The user name to log in as.
269 The password to use when logging in.
270 Note that this is NOT your login password but is your password to the
276 This button attempts to (re-)connect to the server with the currently displayed
278 The settings are saved in
279 .IR $HOME/.disorder/passwd .
283 This button closes the window, discarding any unsaved changes.
284 .SS "Properties Window"
285 This window contains details of one or more tracks and allows them to be
288 The Artist, Album and Title fields determine how the tracks appear in
289 the queue and recently played tabs.
291 The Tags field determine which tags apply to the track.
292 Tags are separated by commas and can contain any printing characters except
295 The Weight field determines the track weight. Tracks with higher weights are
296 proportionately more likely to be picked at random. The default weight is
297 90000, and the maximum weight is 2147483647.
299 The Random checkbox determines whether the track will be picked at random.
300 Random play is enabled for every track by default, but it can be turned off
303 The double-headed arrow to the right of each preference will propagate its
304 value to all the other tracks in the window.
305 For instance, this can be used to efficiently correct the artist or album
306 fields, or bulk-disable random play for many tracks.
308 Press "OK" to confirm all changes and close the window, "Apply" to confirm
309 changes but keep the window open and "Cancel" to close the window and discard
311 .SS "User Management Window"
312 This window is primarily of interest to adminstrators, and will not be
313 available to users without admin rights. The left hand side is a list of all
314 users; the right hand side contains the editable details of the currently
317 When you select any user you can edit their email address or change their
318 password. It is also possible to edit the individual user rights. Click on
319 the "Apply" button to commit any changes you make.
321 The "Add" button creates a new user. You must enter at least a username.
322 Default rights are setting according to local configuration, \fInot\fR server
323 configuration (but this may be changed in the future). As above, click on
324 "Apply" to actually create the new user.
326 The "Delete" button deletes the selected user. This operation cannot be
328 .SH "KEYBOARD SHORTCUTS"
331 Select all tracks (queue/recent)
334 Brings up the \fBLogin Details Window\fR.
339 Network play uses a background
340 .BR disorder\-playrtp (1)
342 If you quit Disobedience the player will continue playing and can be
343 disabled from a later run of Disobedience.
345 The player will log to
346 .I ~/.disorder/HOSTNAME\-rtp.log
347 so look there if it does not seem to be working.
349 You can stop it without running Disobedience by the command
350 .BR "killall disorder\-playrtp" .
353 .B \-\-config \fIPATH\fR, \fB\-c \fIPATH
354 Set the configuration file.
356 .IR pkgconfdir/config .
358 .B \-\-debug\fR, \fB\-d
361 .B \-\-help\fR, \fB\-h
362 Display a usage message.
364 .B \-\-version\fR, \fB\-V
365 Display version number.
367 Additional options are supported by the GTK+ library.
368 Refer to GTK+ documentation for further information.
369 Under X11 they include:
371 .B \-\-display \fIDISPLAY\fR
372 The X display to use.
374 .B \-\-screen \fISCREEN\fR
375 The screen number to use.
376 .\" If know enough to use it you know enough to find it
379 .\" Make all X requests synchronously.
383 on the same host as the server then no additional configuration should be
386 If it is running on a different host then the easiest way to set it up is to
387 use the login details window in Disobedience.
388 Enter the connection details, use Login to connect to the server, and then
389 use Save to store them for future sessions.
391 The other clients read their configuration from the same location so after
392 setting up with Disobedience, tools such as
396 There is no particular provision for multiple users of the same computer
397 sharing a single \fBdisorder\-playrtp\fR process.
398 This shouldn't be too much of a problem in practice but something could
399 perhaps be done given demand.
401 Try to do remote user management when the server is configured to refuse this
402 produces rather horrible error behavior.
404 Only one track can be dragged at a time.
406 Resizing columns doesn't work very well.
410 .I ~/.disorder/HOSTNAME\-rtp
411 Socket for communication with RTP player.
413 .I ~/.disorder/HOSTNAME\-rtp.log
414 Log file for RTP player.
416 .BR disorder\-playrtp (1),
417 .BR disorder_config (5)
419 .B http://www.greenend.org.uk/rjk/disorder/
423 .B http://www.gtk.org/api/2.6/gtk/gtk\-x11.html
425 - Using GTK+ on the X Window System
~mdw / disorder / blob