Commit | Line | Data |
---|---|---|
460b9539 | 1 | .\" |
5aff007d | 2 | .\" Copyright (C) 2004-2008 Richard Kettlewell |
460b9539 | 3 | .\" |
e7eb3a27 | 4 | .\" This program is free software: you can redistribute it and/or modify |
460b9539 | 5 | .\" it under the terms of the GNU General Public License as published by |
e7eb3a27 | 6 | .\" the Free Software Foundation, either version 3 of the License, or |
460b9539 | 7 | .\" (at your option) any later version. |
e7eb3a27 RK |
8 | .\" |
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. | |
13 | .\" | |
460b9539 | 14 | .\" You should have received a copy of the GNU General Public License |
e7eb3a27 | 15 | .\" along with this program. If not, see <http://www.gnu.org/licenses/>. |
460b9539 | 16 | .\" |
17 | .TH disobedience 1 | |
18 | .SH NAME | |
19 | disobedience \- GUI client for DisOrder jukebox | |
20 | .SH SYNOPSIS | |
21 | .B disobedience | |
22 | .RI [ OPTIONS ] | |
23 | .SH DESCRIPTION | |
24 | .B disobedience | |
d8e369d5 | 25 | is a graphical client for DisOrder. |
460b9539 | 26 | .SH "WINDOWS AND ICONS" |
eb80584d | 27 | .SS "Server Menu" |
afc2fe2e RK |
28 | This has the following options: |
29 | .TP | |
30 | .B Login | |
31 | Brings up the \fBLogin Details Window\fR; see below. | |
32 | .TP | |
5d25fbdc RK |
33 | .B "Manage Users" |
34 | Brings up the \fBUser Management Window\fR; see below. | |
35 | .TP | |
afc2fe2e RK |
36 | .B Quit |
37 | Terminates the program. | |
460b9539 | 38 | .SS "Edit Menu" |
39 | This has the following options: | |
40 | .TP | |
a0e78d96 RK |
41 | .B "Select All Tracks" |
42 | Select all tracks. | |
43 | .TP | |
44 | .B "Deselect All Tracks" | |
45 | Deselect all tracks. | |
460b9539 | 46 | .TP |
47 | .B Properties | |
c0c23a60 RK |
48 | Edit the details of the selected tracks. |
49 | See | |
d8e369d5 RK |
50 | .B "Properties Window" |
51 | below. | |
79ab6bd2 RK |
52 | .TP |
53 | .B "Edit Playlists" | |
54 | Edit playlists. | |
55 | See | |
56 | .B "Playlists Window" | |
57 | below. | |
ab560bd2 RK |
58 | .SS "Control Menu" |
59 | This has the following options: | |
60 | .TP | |
61 | .B Scratch | |
62 | Interrupts the currently playing track. | |
63 | .TP | |
64 | .B Playing | |
65 | Pause and resume the current track. | |
66 | .TP | |
67 | .B "Random play" | |
c0c23a60 RK |
68 | Enable and disable random play. |
69 | Does not take effect until the currently playing track finishes. | |
ab560bd2 RK |
70 | .TP |
71 | .B "Network player" | |
c0c23a60 RK |
72 | Enables or disables network play. |
73 | See | |
ab560bd2 RK |
74 | .B "NETWORK PLAY" |
75 | below. | |
79ab6bd2 RK |
76 | .TP |
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. | |
460b9539 | 80 | .SS "Help Menu" |
81 | This has only one option, "About DisOrder", which pops up a box giving the | |
82 | name, author and version number of the software. | |
83 | .SS "Controls" | |
84 | .TP | |
85 | .B "Pause button" | |
86 | The pause button can be used to pause and resume tracks. | |
5c739b23 RK |
87 | This button shows either a pause symbol (two vertical bars) or a resume symbol |
88 | (a right-pointing arrow). | |
460b9539 | 89 | .TP |
90 | .B "Scratch button" | |
91 | The scratch button, a red cross, can be used to interrupt the currently playing | |
92 | track. | |
93 | .TP | |
94 | .B "Random play button" | |
c0c23a60 RK |
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. | |
5c739b23 RK |
97 | When the button is green, random play is enabled. |
98 | When it is grey, random play is disabled. | |
460b9539 | 99 | .TP |
100 | .B "Play button" | |
c0c23a60 RK |
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. | |
5c739b23 RK |
103 | When the button is green, play is enabled. |
104 | When it is grey, play is disabled. | |
460b9539 | 105 | .TP |
ab23e130 | 106 | .B "Network play button" |
c0c23a60 RK |
107 | The network play buttons enables or disables network play. |
108 | See | |
ab560bd2 RK |
109 | .B "NETWORK PLAY" |
110 | below. | |
5c739b23 RK |
111 | When the button is green, network play is enabled. |
112 | When it is grey, network play is disabled. | |
ab23e130 | 113 | .TP |
460b9539 | 114 | .B "Volume slider" |
115 | The volume slider indicates the current volume level and can be used to adjust | |
c0c23a60 RK |
116 | it. |
117 | 0 is silent and 10 is maximum volume. | |
460b9539 | 118 | .TP |
119 | .B "Balance slider" | |
120 | The balance slider indicates the current balance and can be used to adjust it. | |
3db7469f | 121 | \-1 means only the left speaker, 0 means both speakers at equal volume and +1 |
460b9539 | 122 | means the only the right speaker. |
123 | .SS "Queue Tab" | |
c0c23a60 | 124 | This displays the currently playing track and the queue. |
cda70ecc RK |
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. | |
460b9539 | 128 | .PP |
c0c23a60 RK |
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 | |
132 | else. | |
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. | |
460b9539 | 137 | .PP |
cda70ecc RK |
138 | Tracks can be moved within the queue by dragging them to a new position with |
139 | the left button. | |
140 | .PP | |
c0c23a60 RK |
141 | The right button pops up a menu. |
142 | This has the following options: | |
460b9539 | 143 | .TP |
144 | .B Properties | |
c0c23a60 RK |
145 | Edit the details of the selected tracks. |
146 | See | |
460b9539 | 147 | .B "Properties Window" |
148 | below. | |
149 | .TP | |
a0e78d96 | 150 | .B "Select All Tracks" |
460b9539 | 151 | Select all tracks. |
152 | .TP | |
a0e78d96 RK |
153 | .B "Deselect All Tracks" |
154 | Deselect all tracks. | |
155 | .TP | |
460b9539 | 156 | .B Scratch |
c0c23a60 RK |
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.) | |
460b9539 | 160 | .TP |
edff49e6 | 161 | .B "Remove track from queue" |
460b9539 | 162 | Remove the selected tracks from the queue. |
edff49e6 RK |
163 | .TP |
164 | .B "Adopt track" | |
165 | Sets the submitter of a randomly picked track to you. | |
460b9539 | 166 | .SS "Recent Tab" |
167 | This displays recently played tracks, the most recent at the top. | |
168 | .PP | |
cda70ecc RK |
169 | The left button functions as above, except that drag-and-drop rearrangement |
170 | is not possible. | |
c0c23a60 | 171 | The right button pops up a menu with the following options: |
460b9539 | 172 | .TP |
173 | .B Properties | |
c0c23a60 RK |
174 | Edit the details of the selected tracks. |
175 | See | |
460b9539 | 176 | .B "Properties Window" |
177 | below. | |
178 | .TP | |
a0e78d96 RK |
179 | .B "Play track" |
180 | Play the select track(s); | |
181 | .TP | |
182 | .B "Select All Tracks" | |
460b9539 | 183 | Select all tracks. |
a0e78d96 RK |
184 | .TP |
185 | .B "Deselect All Tracks" | |
186 | Deselect all tracks. | |
460b9539 | 187 | .SS "Choose Tab" |
188 | This displays all the tracks known to the server in a tree structure. | |
189 | .PP | |
c0c23a60 RK |
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. | |
460b9539 | 193 | .PP |
c0c23a60 RK |
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. | |
460b9539 | 196 | .PP |
c0c23a60 RK |
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. | |
460b9539 | 199 | .PP |
0c841c9e RK |
200 | Files may be played by dragging them to the queue tab and thence to a |
201 | destination position in the queue. | |
202 | .PP | |
d5a2a8dd | 203 | The text box at the bottom is a search form. |
c0c23a60 RK |
204 | If you enter search terms here then tracks containing all those words will be |
205 | highlighted. | |
206 | You can also limit the results to tracks with particular tags, by including | |
207 | \fBtag:\fITAG\fR for each tag. | |
460b9539 | 208 | .PP |
c0c23a60 RK |
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. | |
460b9539 | 213 | .PP |
d8e369d5 | 214 | Right clicking over a track will pop up a menu with the following options: |
460b9539 | 215 | .TP |
216 | .B Play | |
217 | Play selected tracks. | |
218 | .TP | |
219 | .B Properties | |
c0c23a60 RK |
220 | Edit properties of selected tracks. |
221 | See | |
d8e369d5 RK |
222 | .B "Properties Window" |
223 | below. | |
224 | .PP | |
225 | A middle click on a track will add it to the queue. | |
460b9539 | 226 | .PP |
d8e369d5 RK |
227 | Right clicking over a directory will pop up a menu with the following options: |
228 | .TP | |
229 | .B "Play all tracks" | |
230 | Play all the tracks in the directory, in the order they appear on screen. | |
231 | .TP | |
232 | .B "Track properties" | |
233 | Edit properties of all tracks in the directory. | |
234 | .TP | |
a0e78d96 | 235 | .B "Select children" |
d8e369d5 | 236 | Select all the tracks in the directory (and deselect everything else). |
a0e78d96 RK |
237 | .TP |
238 | .B "Deselect all tracks" | |
239 | Deselect everything. | |
655cae67 | 240 | .SS "Added Tab" |
c0c23a60 RK |
241 | This displays a list of tracks recently added to the server's database. |
242 | The most recently added track is at the top. | |
655cae67 | 243 | .PP |
c0c23a60 RK |
244 | Left clicking a track will select it. |
245 | CTRL and SHIFT work as above to select muliple files. | |
655cae67 RK |
246 | .PP |
247 | Right clicking over a track will pop up a menu with the following options: | |
248 | .TP | |
249 | .B "Track properties" | |
c0c23a60 RK |
250 | Edit properties of selected tracks. |
251 | See | |
655cae67 RK |
252 | .B "Properties Window" |
253 | below. | |
254 | .TP | |
255 | .B "Play track" | |
256 | Play selected tracks. | |
257 | .TP | |
258 | .B "Select All Tracks" | |
259 | Select all tracks. | |
a0e78d96 RK |
260 | .TP |
261 | .B "Deselect All Tracks" | |
262 | Deselect all tracks. | |
afc2fe2e RK |
263 | .SS "Login Details Window" |
264 | The login details window allows you to edit the connection details and | |
c0c23a60 | 265 | authorization information used by Disobedience. |
47623e11 RK |
266 | .PP |
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 | |
271 | instead. | |
272 | .PP | |
273 | Below this are four text entry fields: | |
afc2fe2e RK |
274 | .TP |
275 | .B Hostname | |
276 | The host to connect to. | |
277 | .TP | |
278 | .B Service | |
279 | The service name or port number to connect to. | |
280 | .TP | |
281 | .B "User name" | |
282 | The user name to log in as. | |
283 | .TP | |
284 | .B Password | |
c0c23a60 RK |
285 | The password to use when logging in. |
286 | Note that this is NOT your login password but is your password to the | |
287 | DisOrder server. | |
afc2fe2e | 288 | .PP |
47623e11 | 289 | It has two buttons: |
afc2fe2e RK |
290 | .TP |
291 | .B Login | |
292 | This button attempts to (re-)connect to the server with the currently displayed | |
c0c23a60 | 293 | settings. |
47623e11 | 294 | The settings are saved in |
afc2fe2e | 295 | .IR $HOME/.disorder/passwd . |
47623e11 | 296 | on success. |
afc2fe2e | 297 | .TP |
0f24b368 RK |
298 | .B Close |
299 | This button closes the window, discarding any unsaved changes. | |
460b9539 | 300 | .SS "Properties Window" |
301 | This window contains details of one or more tracks and allows them to be | |
302 | edited. | |
303 | .PP | |
304 | The Artist, Album and Title fields determine how the tracks appear in | |
305 | the queue and recently played tabs. | |
306 | .PP | |
c0c23a60 RK |
307 | The Tags field determine which tags apply to the track. |
308 | Tags are separated by commas and can contain any printing characters except | |
309 | comma. | |
460b9539 | 310 | .PP |
68a1bff0 RK |
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. | |
314 | .PP | |
460b9539 | 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 | |
317 | here. | |
318 | .PP | |
f4b9ba55 | 319 | The double-headed arrow to the right of each preference will propagate its |
c0c23a60 RK |
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. | |
f4b9ba55 | 323 | .PP |
460b9539 | 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 | |
326 | all changes. | |
5d25fbdc RK |
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 | |
331 | selected user. | |
332 | .PP | |
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. | |
336 | .PP | |
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. | |
341 | .PP | |
342 | The "Delete" button deletes the selected user. This operation cannot be | |
343 | undone. | |
79ab6bd2 RK |
344 | .SS "Playlists Window" |
345 | A playlist is a collection of tracks that can be prepared in advance and then | |
346 | played as a unit. | |
347 | Playlists come in three kinds: | |
348 | .TP | |
349 | .B shared | |
350 | A playlist that anyone can edit. | |
351 | These are not owned by any user. | |
352 | .TP | |
353 | .B public | |
354 | A playlist that only one user (its owner) can edit, | |
355 | but that anyone can see the contents of. | |
356 | .TP | |
357 | .B private | |
358 | A playlist that is entirely private to one user. | |
359 | .PP | |
360 | Public and private playlists start with the owner's username. | |
361 | .PP | |
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. | |
368 | .PP | |
369 | The add button creates a new playlist. | |
370 | You must selected whether it will be a shared, public or private playlist. | |
371 | .PP | |
372 | At the bottom of the window are radio buttons showing which kind of playlist it | |
373 | is. | |
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 | |
376 | greyed out. | |
460b9539 | 377 | .SH "KEYBOARD SHORTCUTS" |
378 | .TP | |
379 | .B CTRL+A | |
380 | Select all tracks (queue/recent) | |
381 | .TP | |
afc2fe2e RK |
382 | .B CTRL+L |
383 | Brings up the \fBLogin Details Window\fR. | |
384 | .TP | |
460b9539 | 385 | .B CTRL+Q |
386 | Quit. | |
ab560bd2 RK |
387 | .SH "NETWORK PLAY" |
388 | Network play uses a background | |
0d350ff0 | 389 | .BR disorder\-playrtp (1) |
c0c23a60 RK |
390 | process. |
391 | If you quit Disobedience the player will continue playing and can be | |
ab560bd2 RK |
392 | disabled from a later run of Disobedience. |
393 | .PP | |
394 | The player will log to | |
0d350ff0 | 395 | .I ~/.disorder/HOSTNAME\-rtp.log |
ab560bd2 RK |
396 | so look there if it does not seem to be working. |
397 | .PP | |
398 | You can stop it without running Disobedience by the command | |
0d350ff0 | 399 | .BR "killall disorder\-playrtp" . |
d8e369d5 RK |
400 | .SH OPTIONS |
401 | .TP | |
0d350ff0 | 402 | .B \-\-config \fIPATH\fR, \fB\-c \fIPATH |
c0c23a60 RK |
403 | Set the configuration file. |
404 | The default is | |
d8e369d5 RK |
405 | .IR pkgconfdir/config . |
406 | .TP | |
0d350ff0 | 407 | .B \-\-debug\fR, \fB\-d |
d8e369d5 RK |
408 | Enable debugging. |
409 | .TP | |
0d350ff0 | 410 | .B \-\-help\fR, \fB\-h |
d8e369d5 RK |
411 | Display a usage message. |
412 | .TP | |
0d350ff0 | 413 | .B \-\-version\fR, \fB\-V |
d8e369d5 RK |
414 | Display version number. |
415 | .SS "GTK+ Options" | |
c0c23a60 RK |
416 | Additional options are supported by the GTK+ library. |
417 | Refer to GTK+ documentation for further information. | |
418 | Under X11 they include: | |
d8e369d5 | 419 | .TP |
0d350ff0 | 420 | .B \-\-display \fIDISPLAY\fR |
d8e369d5 RK |
421 | The X display to use. |
422 | .TP | |
0d350ff0 | 423 | .B \-\-screen \fISCREEN\fR |
d8e369d5 RK |
424 | The screen number to use. |
425 | .\" If know enough to use it you know enough to find it | |
426 | .\" .TP | |
0d350ff0 | 427 | .\" .B \-\-sync |
d8e369d5 | 428 | .\" Make all X requests synchronously. |
a8161466 RK |
429 | .SH CONFIGURATION |
430 | If you are using | |
431 | .B disobedience | |
432 | on the same host as the server then no additional configuration should be | |
433 | required. | |
434 | .PP | |
afc2fe2e | 435 | If it is running on a different host then the easiest way to set it up is to |
c0c23a60 RK |
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. | |
f4b9ba55 | 439 | .PP |
afc2fe2e RK |
440 | The other clients read their configuration from the same location so after |
441 | setting up with Disobedience, tools such as | |
442 | .BR disorder (1) | |
443 | should work as well. | |
b6579a61 | 444 | .SH BUGS |
b6579a61 | 445 | There is no particular provision for multiple users of the same computer |
0d350ff0 | 446 | sharing a single \fBdisorder\-playrtp\fR process. |
c0c23a60 RK |
447 | This shouldn't be too much of a problem in practice but something could |
448 | perhaps be done given demand. | |
29f30bb0 RK |
449 | .PP |
450 | Try to do remote user management when the server is configured to refuse this | |
451 | produces rather horrible error behavior. | |
cda70ecc RK |
452 | .PP |
453 | Only one track can be dragged at a time. | |
454 | .PP | |
455 | Resizing columns doesn't work very well. | |
456 | This is a GTK+ bug. | |
ab23e130 RK |
457 | .SH FILES |
458 | .TP | |
0d350ff0 | 459 | .I ~/.disorder/HOSTNAME\-rtp |
ab23e130 RK |
460 | Socket for communication with RTP player. |
461 | .TP | |
0d350ff0 | 462 | .I ~/.disorder/HOSTNAME\-rtp.log |
ab23e130 | 463 | Log file for RTP player. |
460b9539 | 464 | .SH "SEE ALSO" |
0d350ff0 | 465 | .BR disorder\-playrtp (1), |
460b9539 | 466 | .BR disorder_config (5) |
467 | .PP | |
d8e369d5 RK |
468 | .B http://www.greenend.org.uk/rjk/disorder/ |
469 | .br | |
470 | - DisOrder home page | |
471 | .PP | |
0d350ff0 | 472 | .B http://www.gtk.org/api/2.6/gtk/gtk\-x11.html |
460b9539 | 473 | .br |
474 | - Using GTK+ on the X Window System | |
475 | .\" Local Variables: | |
476 | .\" mode:nroff | |
477 | .\" fill-column:79 | |
478 | .\" End: |