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:
42 Select all tracks in whichever of the Queue or Recent tabs are showing.
45 Edit the details of the selected tracks.
47 .B "Properties Window"
50 This has the following options:
53 Interrupts the currently playing track.
56 Pause and resume the current track.
59 Enable and disable random play.
60 Does not take effect until the currently playing track finishes.
63 Enables or disables network play.
68 This has only one option, "About DisOrder", which pops up a box giving the
69 name, author and version number of the software.
73 The pause button can be used to pause and resume tracks.
74 This button shows either a pause symbol (two vertical bars) or a resume symbol
75 (a right-pointing arrow).
78 The scratch button, a red cross, can be used to interrupt the currently playing
81 .B "Random play button"
82 The random play button can be used to enable and disable random play.
83 It does not take effect until the currently playing track finishes.
84 When the button is green, random play is enabled.
85 When it is grey, random play is disabled.
88 The play button controls whether tracks will be played at all.
89 As above it does not take effect until the currently playing track finishes.
90 When the button is green, play is enabled.
91 When it is grey, play is disabled.
93 .B "Network play button"
94 The network play buttons enables or disables network play.
98 When the button is green, network play is enabled.
99 When it is grey, network play is disabled.
102 The volume slider indicates the current volume level and can be used to adjust
104 0 is silent and 10 is maximum volume.
107 The balance slider indicates the current balance and can be used to adjust it.
108 -1 means only the left speaker, 0 means both speakers at equal volume and +1
109 means the only the right speaker.
111 This displays the currently playing track and the queue.
112 The currently playing track is at the top, and can be distinguished by
113 the constantly updating timer.
114 Queued tracks appear below it.
116 The left button can be use to select and deselect tracks.
117 On its own it just selects the pointed track and deselects everything else.
118 With CTRL it flips the state of the pointed track without affecting anything
120 With SHIFT it selects every track from the last click to the current position
121 and deselects everything else.
122 With both CTRL and SHIFT it selects everything from the last click to the
123 current position without deselecting anything.
125 Tracks can be moved within the queue by dragging them to a new position with
128 The right button pops up a menu.
129 This has the following options:
132 Edit the details of the selected tracks.
134 .B "Properties Window"
141 Interrupt the currently playing track.
142 (Note that this appears even if you right click over a queued track rather
143 than the currently playing track.)
146 Remove the selected tracks from the queue.
148 This displays recently played tracks, the most recent at the top.
150 The left button functions as above, except that drag-and-drop rearrangement
152 The right button pops up a menu with the following options:
155 Edit the details of the selected tracks.
157 .B "Properties Window"
163 This displays all the tracks known to the server in a tree structure.
165 Directories are represented with an arrow to their left.
166 This can be clicked to reveal or hide the contents of the directory.
167 The top level "directories" break up tracks by their first letter.
169 Playable files are represented by their name.
170 If they are playing or in the queue then a notes icon appears next to them.
172 Left clicking on a file will select it.
173 As with the queue tab you can use SHIFT and CTRL to select multiple files.
175 The text box at the bottom is a search form.
176 If you enter search terms here then tracks containing all those words will be
178 You can also limit the results to tracks with particular tags, by including
179 \fBtag:\fITAG\fR for each tag.
181 To start a new search just edit the contents of the search box.
182 The cancel button to its right clears the current search.
183 The up and down arrows will scroll the window to make the previous or next
184 search result visible.
186 Right clicking over a track will pop up a menu with the following options:
189 Play selected tracks.
192 Edit properties of selected tracks.
194 .B "Properties Window"
197 A middle click on a track will add it to the queue.
199 Right clicking over a directory will pop up a menu with the following options:
202 Play all the tracks in the directory, in the order they appear on screen.
204 .B "Track properties"
205 Edit properties of all tracks in the directory.
207 .B "Select all tracks"
208 Select all the tracks in the directory (and deselect everything else).
210 Note that these options do not apply recursively - only the tracks in the
211 relevant directory are affected, not those in its subdirectories.
213 This displays a list of tracks recently added to the server's database.
214 The most recently added track is at the top.
216 Left clicking a track will select it.
217 CTRL and SHIFT work as above to select muliple files.
219 Right clicking over a track will pop up a menu with the following options:
221 .B "Track properties"
222 Edit properties of selected tracks.
224 .B "Properties Window"
228 Play selected tracks.
230 .B "Select All Tracks"
232 .SS "Login Details Window"
233 The login details window allows you to edit the connection details and
234 authorization information used by Disobedience.
236 At the top is a 'remote' switch.
237 If this is enabled then you can use the \fBHostname\fR and \fBService\fR
238 fields to connect to a remote server.
239 If it is disabled then then Disobedience will connect to a local server
242 Below this are four text entry fields:
245 The host to connect to.
248 The service name or port number to connect to.
251 The user name to log in as.
254 The password to use when logging in.
255 Note that this is NOT your login password but is your password to the
261 This button attempts to (re-)connect to the server with the currently displayed
263 The settings are saved in
264 .IR $HOME/.disorder/passwd .
268 This button closes the window, discarding any unsaved changes.
269 .SS "Properties Window"
270 This window contains details of one or more tracks and allows them to be
273 The Artist, Album and Title fields determine how the tracks appear in
274 the queue and recently played tabs.
276 The Tags field determine which tags apply to the track.
277 Tags are separated by commas and can contain any printing characters except
280 The Weight field determines the track weight. Tracks with higher weights are
281 proportionately more likely to be picked at random. The default weight is
282 90000, and the maximum weight is 2147483647.
284 The Random checkbox determines whether the track will be picked at random.
285 Random play is enabled for every track by default, but it can be turned off
288 The double-headed arrow to the right of each preference will propagate its
289 value to all the other tracks in the window.
290 For instance, this can be used to efficiently correct the artist or album
291 fields, or bulk-disable random play for many tracks.
293 Press "OK" to confirm all changes and close the window, "Apply" to confirm
294 changes but keep the window open and "Cancel" to close the window and discard
296 .SS "User Management Window"
297 This window is primarily of interest to adminstrators, and will not be
298 available to users without admin rights. The left hand side is a list of all
299 users; the right hand side contains the editable details of the currently
302 When you select any user you can edit their email address or change their
303 password. It is also possible to edit the individual user rights. Click on
304 the "Apply" button to commit any changes you make.
306 The "Add" button creates a new user. You must enter at least a username.
307 Default rights are setting according to local configuration, \fInot\fR server
308 configuration (but this may be changed in the future). As above, click on
309 "Apply" to actually create the new user.
311 The "Delete" button deletes the selected user. This operation cannot be
313 .SH "KEYBOARD SHORTCUTS"
316 Select all tracks (queue/recent)
319 Brings up the \fBLogin Details Window\fR.
324 Network play uses a background
325 .BR disorder\-playrtp (1)
327 If you quit Disobedience the player will continue playing and can be
328 disabled from a later run of Disobedience.
330 The player will log to
331 .I ~/.disorder/HOSTNAME\-rtp.log
332 so look there if it does not seem to be working.
334 You can stop it without running Disobedience by the command
335 .BR "killall disorder\-playrtp" .
338 .B \-\-config \fIPATH\fR, \fB\-c \fIPATH
339 Set the configuration file.
341 .IR pkgconfdir/config .
343 .B \-\-debug\fR, \fB\-d
346 .B \-\-help\fR, \fB\-h
347 Display a usage message.
349 .B \-\-version\fR, \fB\-V
350 Display version number.
352 Additional options are supported by the GTK+ library.
353 Refer to GTK+ documentation for further information.
354 Under X11 they include:
356 .B \-\-display \fIDISPLAY\fR
357 The X display to use.
359 .B \-\-screen \fISCREEN\fR
360 The screen number to use.
361 .\" If know enough to use it you know enough to find it
364 .\" Make all X requests synchronously.
368 on the same host as the server then no additional configuration should be
371 If it is running on a different host then the easiest way to set it up is to
372 use the login details window in Disobedience.
373 Enter the connection details, use Login to connect to the server, and then
374 use Save to store them for future sessions.
376 The other clients read their configuration from the same location so after
377 setting up with Disobedience, tools such as
381 There is no particular provision for multiple users of the same computer
382 sharing a single \fBdisorder\-playrtp\fR process.
383 This shouldn't be too much of a problem in practice but something could
384 perhaps be done given demand.
386 Try to do remote user management when the server is configured to refuse this
387 produces rather horrible error behavior.
389 Only one track can be dragged at a time.
391 Resizing columns doesn't work very well.
395 .I ~/.disorder/HOSTNAME\-rtp
396 Socket for communication with RTP player.
398 .I ~/.disorder/HOSTNAME\-rtp.log
399 Log file for RTP player.
401 .BR disorder\-playrtp (1),
402 .BR disorder_config (5)
404 .B http://www.greenend.org.uk/rjk/disorder/
408 .B http://www.gtk.org/api/2.6/gtk/gtk\-x11.html
410 - Using GTK+ on the X Window System
~mdw / disorder / blob