chiark / gitweb /
core audio support in speaker
[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 only has one option, "Quit", which terminates the program.
31 .SS "Edit Menu"
32 This has the following options:
33 .TP
34 .B "Select All"
35 Select all tracks in whichever of the Queue or Recent tabs are showing.
36 .TP
37 .B Properties
38 Edit the details of the selected tracks.  See
39 .B "Properties Window"
40 below.
41 .SS "Help Menu"
42 This has only one option, "About DisOrder", which pops up a box giving the
43 name, author and version number of the software.
44 .SS "Controls"
45 .TP
46 .B "Pause button"
47 The pause button can be used to pause and resume tracks.
48 .TP
49 .B "Scratch button"
50 The scratch button, a red cross, can be used to interrupt the currently playing
51 track.
52 .TP
53 .B "Random play button"
54 The random play button can be used to enable and disable random play.  It does
55 not take effect until the currently playing track finishes.
56 .TP
57 .B "Play button"
58 The play button controls whether tracks will be played at all.  As above it
59 does not take effect until the currently playing track finishes.
60 .TP
61 .B "Volume slider"
62 The volume slider indicates the current volume level and can be used to adjust
63 it.  0 is silent and 10 is maximum volume.
64 .TP
65 .B "Balance slider"
66 The balance slider indicates the current balance and can be used to adjust it.
67 -1 means only the left speaker, 0 means both speakers at equal volume and +1
68 means the only the right speaker.
69 .SS "Queue Tab"
70 This displays the currently playing track and the queue.  The currently playing
71 track is at the top and has a green background.  Queued tracks appear below it
72 and have alternating red and white backgrounds.
73 .PP
74 The left button can be use to select and deselect tracks.  On its own it just
75 selects the pointed track and deselects everything else.  With CTRL it flips
76 the state of the pointed track without affecting anything else.  With SHIFT it
77 selects every track from the last click to the current position and deselects
78 everything else.  With both CTRL and SHIFT it selects everything from the last
79 click to the current position without deselecting anything.
80 .PP
81 The right button pops up a menu.  This has the following options:
82 .TP
83 .B Properties
84 Edit the details of the selected tracks.  See
85 .B "Properties Window"
86 below.
87 .TP
88 .B "Select All"
89 Select all tracks.
90 .TP
91 .B Scratch
92 Interrupt the currently playing track.  (Note that this appears even if you
93 right click over a queued track rather than the currently playing track.)
94 .TP
95 .B Remove
96 Remove the selected tracks from the queue.
97 .SS "Recent Tab"
98 This displays recently played tracks, the most recent at the top.
99 .PP
100 The left button functions as above.  The right button pops up a menu with the
101 following options:
102 .TP
103 .B Properties
104 Edit the details of the selected tracks.  See
105 .B "Properties Window"
106 below.
107 .TP
108 .B "Select All"
109 Select all tracks.
110 .SS "Choose Tab"
111 This displays all the tracks known to the server in a tree structure.
112 .PP
113 Directories are represented with an arrow to their left.  This can be clicked
114 to reveal or hide the contents of the directory.  The top level "directories"
115 break up tracks by their first letter.
116 .PP
117 Playable files are represented by their name.  If they are playing or in the
118 queue then a notes icon appears next to them.
119 .PP
120 Left clicking on a file will select it.  As with the queue tab you can use
121 SHIFT and CTRL to select multiple files.
122 .PP
123 The text box at the top is a search form.  If you enter search terms here then
124 tracks containing all those words will be highlighted.  You can also
125 limit the results to tracks with particular tags, by including \fBtag:\fITAG\fR
126 for each tag.
127 .PP
128 To start a new search just edit the contents of the search box.  The cancel
129 button to its right clears the current search.
130 .PP
131 Right clicking over a track will pop up a menu with the following options:
132 .TP
133 .B Play
134 Play selected tracks.
135 .TP
136 .B Properties
137 Edit properties of selected tracks.  See
138 .B "Properties Window"
139 below.
140 .PP
141 A middle click on a track will add it to the queue.
142 .PP
143 Right clicking over a directory will pop up a menu with the following options:
144 .TP
145 .B "Play all tracks"
146 Play all the tracks in the directory, in the order they appear on screen.
147 .TP
148 .B "Track properties"
149 Edit properties of all tracks in the directory.
150 .TP
151 .B "Select all tracks"
152 Select all the tracks in the directory (and deselect everything else).
153 .PP
154 Note that these options do not apply recursively - only the tracks in the
155 relevant directory are affected, not those in its subdirectories.
156 .SS "Added Tab"
157 This displays a list of tracks recently added to the server's database.  The
158 most recently added track is at the top.
159 .PP
160 Left clicking a track will select it.  CTRL and SHIFT work as above to select
161 muliple files.
162 .PP
163 Right clicking over a track will pop up a menu with the following options:
164 .TP
165 .B "Track properties"
166 Edit properties of selected tracks.  See
167 .B "Properties Window"
168 below.
169 .TP
170 .B "Play track"
171 Play selected tracks.
172 .TP
173 .B "Select All Tracks"
174 Select all tracks.
175 .SS "Properties Window"
176 This window contains details of one or more tracks and allows them to be
177 edited.
178 .PP
179 The Artist, Album and Title fields determine how the tracks appear in
180 the queue and recently played tabs.
181 .PP
182 The Tags field determine which tags apply to the track.  Tags are separated by
183 commas and can contain any printing characters except comma.
184 .PP
185 The Random checkbox determines whether the track will be picked at random.
186 Random play is enabled for every track by default, but it can be turned off
187 here.
188 .PP
189 The double-headed arrow to the right of each preference will propagate its
190 value to all the other tracks in the window.  For instance, this can be used to
191 efficiently correct the artist or album fields, or bulk-disable random play for
192 many tracks.
193 .PP
194 Press "OK" to confirm all changes and close the window, "Apply" to confirm
195 changes but keep the window open and "Cancel" to close the window and discard
196 all changes.
197 .SH "KEYBOARD SHORTCUTS"
198 .TP
199 .B CTRL+A
200 Select all tracks (queue/recent)
201 .TP
202 .B CTRL+Q
203 Quit.
204 .SH OPTIONS
205 .TP
206 .B --config \fIPATH\fR, \fB-c \fIPATH
207 Set the configuration file.  The default is
208 .IR pkgconfdir/config .
209 .TP
210 .B --debug\fR, \fB-d
211 Enable debugging.
212 .TP
213 .B --help\fR, \fB-h
214 Display a usage message.
215 .TP
216 .B --version\fR, \fB-V
217 Display version number.
218 .SS "GTK+ Options"
219 Additional options are supported by the GTK+ library.  Refer to GTK+
220 documentation for further information.  Under X11 they include:
221 .TP
222 .B --display \fIDISPLAY\fR
223 The X display to use.
224 .TP
225 .B --screen \fISCREEN\fR
226 The screen number to use.
227 .\" If know enough to use it you know enough to find it
228 .\" .TP
229 .\" .B --sync
230 .\" Make all X requests synchronously.
231 .SH "GTK+ RESOURCES"
232 You can override these resources in order to customize the appearance of
233 Disobedience.
234 .\" TODO example that actually works.
235 .SS "Widget Names"
236 .TP
237 .B disobedience.*.choose
238 This is the panel containing the track choice tree.
239 .TP
240 .B disobedience.*.queue
241 This is the panel displaying the queue.
242 .TP
243 .B disobedience.*.choose
244 This is the panel listing recently played tracks.
245 .TP
246 .B disobedience.*.row-playing
247 This is the row listing the currently playing track.
248 .TP
249 .B disobedience.*.row-odd
250 This an odd-numbered row in the queue or recently played track list.
251 .TP
252 .B disobedience.*.row-even
253 This an even-numbered row in the queue or recently played track list.
254 .SH CONFIGURATION
255 If you are using
256 .B disobedience
257 on the same host as the server then no additional configuration should be
258 required.
259 .PP
260 If it is running on a different host then the server will need a
261 .B listen
262 directive in its configuration and the clien a matching
263 .B connect
264 directive.  Also the client will need user passwords, either in
265 .IR pkgconfdir/config. USER
266 or
267 .IR ~ USER /.disorder.passwd .
268 .PP
269 You might use commands such as the following to set up a standalone instance of
270 Disobedience:
271 .PP
272 .RS
273 .nf
274 cd
275 mkdir .disorder
276 echo password <your password> > .disorder/passwd
277 echo connect <hostname> <port> >> .disorder/passwd
278 chmod 600 .disorder/passwd
279 .fi
280 .RE
281 .SH "SEE ALSO"
282 .BR disorder_config (5)
283 .PP
284 .B http://www.greenend.org.uk/rjk/disorder/
285 .br
286 - DisOrder home page
287 .PP
288 .B http://www.gtk.org/api/2.6/gtk/gtk-x11.html
289 .br
290 - Using GTK+ on the X Window System
291 .\" Local Variables:
292 .\" mode:nroff
293 .\" fill-column:79
294 .\" End: