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 disobedience \- GUI client for DisOrder jukebox
27 is a graphical client for DisOrder.
28 .SH "WINDOWS AND ICONS"
30 This has the following options:
33 Brings up the \fBLogin Details Window\fR; see below.
36 Terminates the program.
38 This has the following options:
41 Select all tracks in whichever of the Queue or Recent tabs are showing.
44 Edit the details of the selected tracks. See
45 .B "Properties Window"
48 This has only one option, "About DisOrder", which pops up a box giving the
49 name, author and version number of the software.
53 The pause button can be used to pause and resume tracks.
56 The scratch button, a red cross, can be used to interrupt the currently playing
59 .B "Random play button"
60 The random play button can be used to enable and disable random play. It does
61 not take effect until the currently playing track finishes.
64 The play button controls whether tracks will be played at all. As above it
65 does not take effect until the currently playing track finishes.
67 .B "Network play button"
68 The network play buttons enables or disables a background
69 .BR disorder-playrtp (1)
70 process. If you quit Disobedience the player will continue playing and can be
71 disabled from a later run of Disobedience.
73 The player will log to
74 .I ~/.disorder/HOSTNAME-rtp.log
75 so look there if it does not seem to be working.
78 The volume slider indicates the current volume level and can be used to adjust
79 it. 0 is silent and 10 is maximum volume.
82 The balance slider indicates the current balance and can be used to adjust it.
83 -1 means only the left speaker, 0 means both speakers at equal volume and +1
84 means the only the right speaker.
86 This displays the currently playing track and the queue. The currently playing
87 track is at the top and has a green background. Queued tracks appear below it
88 and have alternating red and white backgrounds.
90 The left button can be use to select and deselect tracks. On its own it just
91 selects the pointed track and deselects everything else. With CTRL it flips
92 the state of the pointed track without affecting anything else. With SHIFT it
93 selects every track from the last click to the current position and deselects
94 everything else. With both CTRL and SHIFT it selects everything from the last
95 click to the current position without deselecting anything.
97 The right button pops up a menu. This has the following options:
100 Edit the details of the selected tracks. See
101 .B "Properties Window"
108 Interrupt the currently playing track. (Note that this appears even if you
109 right click over a queued track rather than the currently playing track.)
112 Remove the selected tracks from the queue.
114 This displays recently played tracks, the most recent at the top.
116 The left button functions as above. The right button pops up a menu with the
120 Edit the details of the selected tracks. See
121 .B "Properties Window"
127 This displays all the tracks known to the server in a tree structure.
129 Directories are represented with an arrow to their left. This can be clicked
130 to reveal or hide the contents of the directory. The top level "directories"
131 break up tracks by their first letter.
133 Playable files are represented by their name. If they are playing or in the
134 queue then a notes icon appears next to them.
136 Left clicking on a file will select it. As with the queue tab you can use
137 SHIFT and CTRL to select multiple files.
139 The text box at the top is a search form. If you enter search terms here then
140 tracks containing all those words will be highlighted. You can also
141 limit the results to tracks with particular tags, by including \fBtag:\fITAG\fR
144 To start a new search just edit the contents of the search box. The cancel
145 button to its right clears the current search. The up and down arrows will
146 scroll the window to make the previous or next search result visible.
148 Right clicking over a track will pop up a menu with the following options:
151 Play selected tracks.
154 Edit properties of selected tracks. See
155 .B "Properties Window"
158 A middle click on a track will add it to the queue.
160 Right clicking over a directory will pop up a menu with the following options:
163 Play all the tracks in the directory, in the order they appear on screen.
165 .B "Track properties"
166 Edit properties of all tracks in the directory.
168 .B "Select all tracks"
169 Select all the tracks in the directory (and deselect everything else).
171 Note that these options do not apply recursively - only the tracks in the
172 relevant directory are affected, not those in its subdirectories.
174 This displays a list of tracks recently added to the server's database. The
175 most recently added track is at the top.
177 Left clicking a track will select it. CTRL and SHIFT work as above to select
180 Right clicking over a track will pop up a menu with the following options:
182 .B "Track properties"
183 Edit properties of selected tracks. See
184 .B "Properties Window"
188 Play selected tracks.
190 .B "Select All Tracks"
192 .SS "Login Details Window"
193 The login details window allows you to edit the connection details and
194 authorization information used by Disobedience. It has four text entry fields:
197 The host to connect to.
200 The service name or port number to connect to.
203 The user name to log in as.
206 The password to use when logging in. Note that this is NOT your login password
207 but is your password to the DisOrder server.
209 It has three buttons:
212 This button attempts to (re-)connect to the server with the currently displayed
213 settings. The settings are not saved.
216 This button saves the current settings in
217 .IR $HOME/.disorder/passwd .
220 This button closes the window, discarding any unsaved changes.
221 .SS "Properties Window"
222 This window contains details of one or more tracks and allows them to be
225 The Artist, Album and Title fields determine how the tracks appear in
226 the queue and recently played tabs.
228 The Tags field determine which tags apply to the track. Tags are separated by
229 commas and can contain any printing characters except comma.
231 The Random checkbox determines whether the track will be picked at random.
232 Random play is enabled for every track by default, but it can be turned off
235 The double-headed arrow to the right of each preference will propagate its
236 value to all the other tracks in the window. For instance, this can be used to
237 efficiently correct the artist or album fields, or bulk-disable random play for
240 Press "OK" to confirm all changes and close the window, "Apply" to confirm
241 changes but keep the window open and "Cancel" to close the window and discard
243 .SH "KEYBOARD SHORTCUTS"
246 Select all tracks (queue/recent)
249 Brings up the \fBLogin Details Window\fR.
255 .B --config \fIPATH\fR, \fB-c \fIPATH
256 Set the configuration file. The default is
257 .IR pkgconfdir/config .
263 Display a usage message.
265 .B --version\fR, \fB-V
266 Display version number.
268 Additional options are supported by the GTK+ library. Refer to GTK+
269 documentation for further information. Under X11 they include:
271 .B --display \fIDISPLAY\fR
272 The X display to use.
274 .B --screen \fISCREEN\fR
275 The screen number to use.
276 .\" If know enough to use it you know enough to find it
279 .\" Make all X requests synchronously.
281 You can override these resources in order to customize the appearance of
283 .\" TODO example that actually works.
286 .B disobedience.*.choose
287 This is the panel containing the track choice tree.
289 .B disobedience.*.queue
290 This is the panel displaying the queue.
292 .B disobedience.*.choose
293 This is the panel listing recently played tracks.
295 .B disobedience.*.row-playing
296 This is the row listing the currently playing track.
298 .B disobedience.*.row-odd
299 This an odd-numbered row in the queue or recently played track list.
301 .B disobedience.*.row-even
302 This an even-numbered row in the queue or recently played track list.
306 on the same host as the server then no additional configuration should be
309 If it is running on a different host then the easiest way to set it up is to
310 use the login details window in Disobedience. Enter the connection details,
311 use Login to connect to the server, and then use Save to store them for future
314 The other clients read their configuration from the same location so after
315 setting up with Disobedience, tools such as
320 .I ~/.disorder/HOSTNAME-rtp
321 Socket for communication with RTP player.
323 .I ~/.disorder/HOSTNAME-rtp.log
324 Log file for RTP player.
326 .BR disorder-playrtp (1),
327 .BR disorder_config (5)
329 .B http://www.greenend.org.uk/rjk/disorder/
333 .B http://www.gtk.org/api/2.6/gtk/gtk-x11.html
335 - Using GTK+ on the X Window System
~mdw / disorder / blob