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"
59 This has the following options:
62 Interrupts the currently playing track.
65 Pause and resume the current track.
68 Enable and disable random play.
69 Does not take effect until the currently playing track finishes.
72 Enables or disables network play.
77 .B "Activate Playlist"
78 This submenu has the selection of playlists which you are able to play.
79 Picking one will add its contents to the queue.
81 This has only one option, "About DisOrder", which pops up a box giving the
82 name, author and version number of the software.
86 The pause button can be used to pause and resume tracks.
87 This button shows either a pause symbol (two vertical bars) or a resume symbol
88 (a right-pointing arrow).
91 The scratch button, a red cross, can be used to interrupt the currently playing
94 .B "Random play button"
95 The random play button can be used to enable and disable random play.
96 It does not take effect until the currently playing track finishes.
97 When the button is green, random play is enabled.
98 When it is grey, random play is disabled.
101 The play button controls whether tracks will be played at all.
102 As above it does not take effect until the currently playing track finishes.
103 When the button is green, play is enabled.
104 When it is grey, play is disabled.
106 .B "Network play button"
107 The network play buttons enables or disables network play.
111 When the button is green, network play is enabled.
112 When it is grey, network play is disabled.
115 The volume slider indicates the current volume level and can be used to adjust
117 0 is silent and 10 is maximum volume.
120 The balance slider indicates the current balance and can be used to adjust it.
121 \-1 means only the left speaker, 0 means both speakers at equal volume and +1
122 means the only the right speaker.
124 This displays the currently playing track and the queue.
125 The currently playing track is at the top, and can be distinguished by
126 the constantly updating timer.
127 Queued tracks appear below it.
129 The left button can be use to select and deselect tracks.
130 On its own it just selects the pointed track and deselects everything else.
131 With CTRL it flips the state of the pointed track without affecting anything
133 With SHIFT it selects every track from the last click to the current position
134 and deselects everything else.
135 With both CTRL and SHIFT it selects everything from the last click to the
136 current position without deselecting anything.
138 Tracks can be moved within the queue by dragging them to a new position with
141 The right button pops up a menu.
142 This has the following options:
145 Edit the details of the selected tracks.
147 .B "Properties Window"
150 .B "Select All Tracks"
153 .B "Deselect All Tracks"
157 Interrupt the currently playing track.
158 (Note that this appears even if you right click over a queued track rather
159 than the currently playing track.)
161 .B "Remove track from queue"
162 Remove the selected tracks from the queue.
165 Sets the submitter of a randomly picked track to you.
167 This displays recently played tracks, the most recent at the top.
169 The left button functions as above, except that drag-and-drop rearrangement
171 The right button pops up a menu with the following options:
174 Edit the details of the selected tracks.
176 .B "Properties Window"
180 Play the select track(s);
182 .B "Select All Tracks"
185 .B "Deselect All Tracks"
188 This displays all the tracks known to the server in a tree structure.
190 Directories are represented with an arrow to their left.
191 This can be clicked to reveal or hide the contents of the directory.
192 The top level "directories" break up tracks by their first letter.
194 Playable files are represented by their name.
195 If they are playing or in the queue then a notes icon appears next to them.
197 Left clicking on a file will select it.
198 As with the queue tab you can use SHIFT and CTRL to select multiple files.
200 Files may be played by dragging them to the queue tab and thence to a
201 destination position in the queue.
203 The text box at the bottom is a search form.
204 If you enter search terms here then tracks containing all those words will be
206 You can also limit the results to tracks with particular tags, by including
207 \fBtag:\fITAG\fR for each tag.
209 To start a new search just edit the contents of the search box.
210 The cancel button to its right clears the current search.
211 The up and down arrows will scroll the window to make the previous or next
212 search result visible.
214 Right clicking over a track will pop up a menu with the following options:
217 Play selected tracks.
220 Edit properties of selected tracks.
222 .B "Properties Window"
225 A middle click on a track will add it to the queue.
227 Right clicking over a directory will pop up a menu with the following options:
230 Play all the tracks in the directory, in the order they appear on screen.
232 .B "Track properties"
233 Edit properties of all tracks in the directory.
236 Select all the tracks in the directory (and deselect everything else).
238 .B "Deselect all tracks"
241 This displays a list of tracks recently added to the server's database.
242 The most recently added track is at the top.
244 Left clicking a track will select it.
245 CTRL and SHIFT work as above to select muliple files.
247 Right clicking over a track will pop up a menu with the following options:
249 .B "Track properties"
250 Edit properties of selected tracks.
252 .B "Properties Window"
256 Play selected tracks.
258 .B "Select All Tracks"
261 .B "Deselect All Tracks"
263 .SS "Login Details Window"
264 The login details window allows you to edit the connection details and
265 authorization information used by Disobedience.
267 At the top is a 'remote' switch.
268 If this is enabled then you can use the \fBHostname\fR and \fBService\fR
269 fields to connect to a remote server.
270 If it is disabled then then Disobedience will connect to a local server
273 Below this are four text entry fields:
276 The host to connect to.
279 The service name or port number to connect to.
282 The user name to log in as.
285 The password to use when logging in.
286 Note that this is NOT your login password but is your password to the
292 This button attempts to (re-)connect to the server with the currently displayed
294 The settings are saved in
295 .IR $HOME/.disorder/passwd .
299 This button closes the window, discarding any unsaved changes.
300 .SS "Properties Window"
301 This window contains details of one or more tracks and allows them to be
304 The Artist, Album and Title fields determine how the tracks appear in
305 the queue and recently played tabs.
307 The Tags field determine which tags apply to the track.
308 Tags are separated by commas and can contain any printing characters except
311 The Weight field determines the track weight. Tracks with higher weights are
312 proportionately more likely to be picked at random. The default weight is
313 90000, and the maximum weight is 2147483647.
315 The Random checkbox determines whether the track will be picked at random.
316 Random play is enabled for every track by default, but it can be turned off
319 The double-headed arrow to the right of each preference will propagate its
320 value to all the other tracks in the window.
321 For instance, this can be used to efficiently correct the artist or album
322 fields, or bulk-disable random play for many tracks.
324 Press "OK" to confirm all changes and close the window, "Apply" to confirm
325 changes but keep the window open and "Cancel" to close the window and discard
327 .SS "User Management Window"
328 This window is primarily of interest to adminstrators, and will not be
329 available to users without admin rights. The left hand side is a list of all
330 users; the right hand side contains the editable details of the currently
333 When you select any user you can edit their email address or change their
334 password. It is also possible to edit the individual user rights. Click on
335 the "Apply" button to commit any changes you make.
337 The "Add" button creates a new user. You must enter at least a username.
338 Default rights are setting according to local configuration, \fInot\fR server
339 configuration (but this may be changed in the future). As above, click on
340 "Apply" to actually create the new user.
342 The "Delete" button deletes the selected user. This operation cannot be
344 .SS "Playlists Window"
345 A playlist is a collection of tracks that can be prepared in advance and then
347 Playlists come in three kinds:
350 A playlist that anyone can edit.
351 These are not owned by any user.
354 A playlist that only one user (its owner) can edit,
355 but that anyone can see the contents of.
358 A playlist that is entirely private to one user.
360 Public and private playlists start with the owner's username.
362 The left side of the playlist window is a list of all playlists that you can
363 see: all shared and public playlists plus your private playlists.
364 Selecting one will bring it up in the right hand side of the window,
365 allowing it to be reviewed or edited.
366 You can drag tracks from the choose tab in the main window into it and
367 rearrange tracks already in the playlist by selecting and dragging them.
369 The add button creates a new playlist.
370 You must selected whether it will be a shared, public or private playlist.
372 At the bottom of the window are radio buttons showing which kind of playlist it
374 If you own the playlist you can use these to switch it between public and
375 private, but if it is shared or owned by someone else these buttons will be
377 .SH "KEYBOARD SHORTCUTS"
380 Select all tracks (queue/recent)
383 Brings up the \fBLogin Details Window\fR.
388 Network play uses a background
389 .BR disorder\-playrtp (1)
391 If you quit Disobedience the player will continue playing and can be
392 disabled from a later run of Disobedience.
394 The player will log to
395 .I ~/.disorder/HOSTNAME\-rtp.log
396 so look there if it does not seem to be working.
398 You can stop it without running Disobedience by the command
399 .BR "killall disorder\-playrtp" .
402 .B \-\-config \fIPATH\fR, \fB\-c \fIPATH
403 Set the configuration file.
405 .IR pkgconfdir/config .
407 .B \-\-debug\fR, \fB\-d
410 .B \-\-help\fR, \fB\-h
411 Display a usage message.
413 .B \-\-version\fR, \fB\-V
414 Display version number.
416 Additional options are supported by the GTK+ library.
417 Refer to GTK+ documentation for further information.
418 Under X11 they include:
420 .B \-\-display \fIDISPLAY\fR
421 The X display to use.
423 .B \-\-screen \fISCREEN\fR
424 The screen number to use.
425 .\" If know enough to use it you know enough to find it
428 .\" Make all X requests synchronously.
432 on the same host as the server then no additional configuration should be
435 If it is running on a different host then the easiest way to set it up is to
436 use the login details window in Disobedience.
437 Enter the connection details, use Login to connect to the server, and then
438 use Save to store them for future sessions.
440 The other clients read their configuration from the same location so after
441 setting up with Disobedience, tools such as
445 There is no particular provision for multiple users of the same computer
446 sharing a single \fBdisorder\-playrtp\fR process.
447 This shouldn't be too much of a problem in practice but something could
448 perhaps be done given demand.
450 Try to do remote user management when the server is configured to refuse this
451 produces rather horrible error behavior.
453 Only one track can be dragged at a time.
455 Resizing columns doesn't work very well.
459 .I ~/.disorder/HOSTNAME\-rtp
460 Socket for communication with RTP player.
462 .I ~/.disorder/HOSTNAME\-rtp.log
463 Log file for RTP player.
465 .BR disorder\-playrtp (1),
466 .BR disorder_config (5)
468 .B http://www.greenend.org.uk/rjk/disorder/
472 .B http://www.gtk.org/api/2.6/gtk/gtk\-x11.html
474 - Using GTK+ on the X Window System