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