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