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