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