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