chiark / gitweb /
New icons for Disobedience. They are bigger and more colorful than
[disorder] / doc / disobedience.1.in
1 .\"
2 .\" Copyright (C) 2004-2008 Richard Kettlewell
3 .\"
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.
8 .\"
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.
13 .\"
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
17 .\" USA
18 .\"
19 .TH disobedience 1
20 .SH NAME
21 disobedience \- GUI client for DisOrder jukebox
22 .SH SYNOPSIS
23 .B disobedience
24 .RI [ OPTIONS ]
25 .SH DESCRIPTION
26 .B disobedience
27 is a graphical client for DisOrder.
28 .SH "WINDOWS AND ICONS"
29 .SS "Server Menu"
30 This has the following options:
31 .TP
32 .B Login
33 Brings up the \fBLogin Details Window\fR; see below.
34 .TP
35 .B "Manage Users"
36 Brings up the \fBUser Management Window\fR; see below.
37 .TP
38 .B Quit
39 Terminates the program.
40 .SS "Edit Menu"
41 This has the following options:
42 .TP
43 .B "Select All"
44 Select all tracks in whichever of the Queue or Recent tabs are showing.
45 .TP
46 .B Properties
47 Edit the details of the selected tracks.
48 See
49 .B "Properties Window"
50 below.
51 .SS "Control Menu"
52 This has the following options:
53 .TP
54 .B Scratch
55 Interrupts the currently playing track.
56 .TP
57 .B Playing
58 Pause and resume the current track.
59 .TP
60 .B "Random play"
61 Enable and disable random play.
62 Does not take effect until the currently playing track finishes.
63 .TP
64 .B "Network player"
65 Enables or disables network play.
66 See
67 .B "NETWORK PLAY"
68 below.
69 .SS "Help Menu"
70 This has only one option, "About DisOrder", which pops up a box giving the
71 name, author and version number of the software.
72 .SS "Controls"
73 .TP
74 .B "Pause button"
75 The pause button can be used to pause and resume tracks.
76 This button shows either a pause symbol (two vertical bars) or a resume symbol
77 (a right-pointing arrow).
78 .TP
79 .B "Scratch button"
80 The scratch button, a red cross, can be used to interrupt the currently playing
81 track.
82 .TP
83 .B "Random play button"
84 The random play button can be used to enable and disable random play.
85 It does not take effect until the currently playing track finishes.
86 When the button is green, random play is enabled.
87 When it is grey, random play is disabled.
88 .TP
89 .B "Play button"
90 The play button controls whether tracks will be played at all.
91 As above it does not take effect until the currently playing track finishes.
92 When the button is green, play is enabled.
93 When it is grey, play is disabled.
94 .TP
95 .B "Network play button"
96 The network play buttons enables or disables network play.
97 See
98 .B "NETWORK PLAY"
99 below.
100 When the button is green, network play is enabled.
101 When it is grey, network play is disabled.
102 .TP
103 .B "Volume slider"
104 The volume slider indicates the current volume level and can be used to adjust
105 it.
106 0 is silent and 10 is maximum volume.
107 .TP
108 .B "Balance slider"
109 The balance slider indicates the current balance and can be used to adjust it.
110 -1 means only the left speaker, 0 means both speakers at equal volume and +1
111 means the only the right speaker.
112 .SS "Queue Tab"
113 This displays the currently playing track and the queue.
114 The currently playing track is at the top, and can be distinguished by
115 the constantly updating timer.
116 Queued tracks appear below it.
117 .PP
118 The left button can be use to select and deselect tracks.
119 On its own it just selects the pointed track and deselects everything else.
120 With CTRL it flips the state of the pointed track without affecting anything
121 else.
122 With SHIFT it selects every track from the last click to the current position
123 and deselects everything else.
124 With both CTRL and SHIFT it selects everything from the last click to the
125 current position without deselecting anything.
126 .PP
127 Tracks can be moved within the queue by dragging them to a new position with
128 the left button.
129 .PP
130 The right button pops up a menu.
131 This has the following options:
132 .TP
133 .B Properties
134 Edit the details of the selected tracks.
135 See
136 .B "Properties Window"
137 below.
138 .TP
139 .B "Select All"
140 Select all tracks.
141 .TP
142 .B Scratch
143 Interrupt the currently playing track.
144 (Note that this appears even if you right click over a queued track rather
145 than the currently playing track.)
146 .TP
147 .B Remove
148 Remove the selected tracks from the queue.
149 .SS "Recent Tab"
150 This displays recently played tracks, the most recent at the top.
151 .PP
152 The left button functions as above, except that drag-and-drop rearrangement
153 is not possible.
154 The right button pops up a menu with the following options:
155 .TP
156 .B Properties
157 Edit the details of the selected tracks.
158 See
159 .B "Properties Window"
160 below.
161 .TP
162 .B "Select All"
163 Select all tracks.
164 .SS "Choose Tab"
165 This displays all the tracks known to the server in a tree structure.
166 .PP
167 Directories are represented with an arrow to their left.
168 This can be clicked to reveal or hide the contents of the directory.
169 The top level "directories" break up tracks by their first letter.
170 .PP
171 Playable files are represented by their name.
172 If they are playing or in the queue then a notes icon appears next to them.
173 .PP
174 Left clicking on a file will select it.
175 As with the queue tab you can use SHIFT and CTRL to select multiple files.
176 .PP
177 The text box at the bottom is a search form.
178 If you enter search terms here then tracks containing all those words will be
179 highlighted.
180 You can also limit the results to tracks with particular tags, by including
181 \fBtag:\fITAG\fR for each tag.
182 .PP
183 To start a new search just edit the contents of the search box.
184 The cancel button to its right clears the current search.
185 The up and down arrows will scroll the window to make the previous or next
186 search result visible.
187 .PP
188 Right clicking over a track will pop up a menu with the following options:
189 .TP
190 .B Play
191 Play selected tracks.
192 .TP
193 .B Properties
194 Edit properties of selected tracks.
195 See
196 .B "Properties Window"
197 below.
198 .PP
199 A middle click on a track will add it to the queue.
200 .PP
201 Right clicking over a directory will pop up a menu with the following options:
202 .TP
203 .B "Play all tracks"
204 Play all the tracks in the directory, in the order they appear on screen.
205 .TP
206 .B "Track properties"
207 Edit properties of all tracks in the directory.
208 .TP
209 .B "Select all tracks"
210 Select all the tracks in the directory (and deselect everything else).
211 .PP
212 Note that these options do not apply recursively - only the tracks in the
213 relevant directory are affected, not those in its subdirectories.
214 .SS "Added Tab"
215 This displays a list of tracks recently added to the server's database.
216 The most recently added track is at the top.
217 .PP
218 Left clicking a track will select it.
219 CTRL and SHIFT work as above to select muliple files.
220 .PP
221 Right clicking over a track will pop up a menu with the following options:
222 .TP
223 .B "Track properties"
224 Edit properties of selected tracks.
225 See
226 .B "Properties Window"
227 below.
228 .TP
229 .B "Play track"
230 Play selected tracks.
231 .TP
232 .B "Select All Tracks"
233 Select all tracks.
234 .SS "Login Details Window"
235 The login details window allows you to edit the connection details and
236 authorization information used by Disobedience.
237 .PP
238 At the top is a 'remote' switch.
239 If this is enabled then you can use the \fBHostname\fR and \fBService\fR
240 fields to connect to a remote server.
241 If it is disabled then then Disobedience will connect to a local server
242 instead.
243 .PP
244 Below this are four text entry fields:
245 .TP
246 .B Hostname
247 The host to connect to.
248 .TP
249 .B Service
250 The service name or port number to connect to.
251 .TP
252 .B "User name"
253 The user name to log in as.
254 .TP
255 .B Password
256 The password to use when logging in.
257 Note that this is NOT your login password but is your password to the
258 DisOrder server.
259 .PP
260 It has two buttons:
261 .TP
262 .B Login
263 This button attempts to (re-)connect to the server with the currently displayed
264 settings.
265 The settings are saved in
266 .IR $HOME/.disorder/passwd .
267 on success.
268 .TP
269 .B Close
270 This button closes the window, discarding any unsaved changes.
271 .SS "Properties Window"
272 This window contains details of one or more tracks and allows them to be
273 edited.
274 .PP
275 The Artist, Album and Title fields determine how the tracks appear in
276 the queue and recently played tabs.
277 .PP
278 The Tags field determine which tags apply to the track.
279 Tags are separated by commas and can contain any printing characters except
280 comma.
281 .PP
282 The Weight field determines the track weight.  Tracks with higher weights are
283 proportionately more likely to be picked at random.  The default weight is
284 90000, and the maximum weight is 2147483647.
285 .PP
286 The Random checkbox determines whether the track will be picked at random.
287 Random play is enabled for every track by default, but it can be turned off
288 here.
289 .PP
290 The double-headed arrow to the right of each preference will propagate its
291 value to all the other tracks in the window.
292 For instance, this can be used to efficiently correct the artist or album
293 fields, or bulk-disable random play for many tracks.
294 .PP
295 Press "OK" to confirm all changes and close the window, "Apply" to confirm
296 changes but keep the window open and "Cancel" to close the window and discard
297 all changes.
298 .SS "User Management Window"
299 This window is primarily of interest to adminstrators, and will not be
300 available to users without admin rights.  The left hand side is a list of all
301 users; the right hand side contains the editable details of the currently
302 selected user.
303 .PP
304 When you select any user you can edit their email address or change their
305 password.  It is also possible to edit the individual user rights.  Click on
306 the "Apply" button to commit any changes you make.
307 .PP
308 The "Add" button creates a new user.  You must enter at least a username.
309 Default rights are setting according to local configuration, \fInot\fR server
310 configuration (but this may be changed in the future).  As above, click on
311 "Apply" to actually create the new user.
312 .PP
313 The "Delete" button deletes the selected user.  This operation cannot be
314 undone.
315 .SH "KEYBOARD SHORTCUTS"
316 .TP
317 .B CTRL+A
318 Select all tracks (queue/recent)
319 .TP
320 .B CTRL+L
321 Brings up the \fBLogin Details Window\fR.
322 .TP
323 .B CTRL+Q
324 Quit.
325 .SH "NETWORK PLAY"
326 Network play uses a background
327 .BR disorder\-playrtp (1)
328 process.
329 If you quit Disobedience the player will continue playing and can be
330 disabled from a later run of Disobedience.
331 .PP
332 The player will log to
333 .I ~/.disorder/HOSTNAME\-rtp.log
334 so look there if it does not seem to be working.
335 .PP
336 You can stop it without running Disobedience by the command
337 .BR "killall disorder\-playrtp" .
338 .SH OPTIONS
339 .TP
340 .B \-\-config \fIPATH\fR, \fB\-c \fIPATH
341 Set the configuration file.
342 The default is
343 .IR pkgconfdir/config .
344 .TP
345 .B \-\-debug\fR, \fB\-d
346 Enable debugging.
347 .TP
348 .B \-\-help\fR, \fB\-h
349 Display a usage message.
350 .TP
351 .B \-\-version\fR, \fB\-V
352 Display version number.
353 .SS "GTK+ Options"
354 Additional options are supported by the GTK+ library.
355 Refer to GTK+ documentation for further information.
356 Under X11 they include:
357 .TP
358 .B \-\-display \fIDISPLAY\fR
359 The X display to use.
360 .TP
361 .B \-\-screen \fISCREEN\fR
362 The screen number to use.
363 .\" If know enough to use it you know enough to find it
364 .\" .TP
365 .\" .B \-\-sync
366 .\" Make all X requests synchronously.
367 .SH CONFIGURATION
368 If you are using
369 .B disobedience
370 on the same host as the server then no additional configuration should be
371 required.
372 .PP
373 If it is running on a different host then the easiest way to set it up is to
374 use the login details window in Disobedience.
375 Enter the connection details, use Login to connect to the server, and then
376 use Save to store them for future sessions.
377 .PP
378 The other clients read their configuration from the same location so after
379 setting up with Disobedience, tools such as
380 .BR disorder (1)
381 should work as well.
382 .SH BUGS
383 There is no particular provision for multiple users of the same computer
384 sharing a single \fBdisorder\-playrtp\fR process.
385 This shouldn't be too much of a problem in practice but something could
386 perhaps be done given demand.
387 .PP
388 Try to do remote user management when the server is configured to refuse this
389 produces rather horrible error behavior.
390 .PP
391 Only one track can be dragged at a time.
392 .PP
393 Resizing columns doesn't work very well.
394 This is a GTK+ bug.
395 .SH FILES
396 .TP
397 .I ~/.disorder/HOSTNAME\-rtp
398 Socket for communication with RTP player.
399 .TP
400 .I ~/.disorder/HOSTNAME\-rtp.log
401 Log file for RTP player.
402 .SH "SEE ALSO"
403 .BR disorder\-playrtp (1),
404 .BR disorder_config (5)
405 .PP
406 .B http://www.greenend.org.uk/rjk/disorder/
407 .br
408 - DisOrder home page
409 .PP
410 .B http://www.gtk.org/api/2.6/gtk/gtk\-x11.html
411 .br
412 - Using GTK+ on the X Window System
413 .\" Local Variables:
414 .\" mode:nroff
415 .\" fill-column:79
416 .\" End: