chiark / gitweb /
DisOrder 4.2
[disorder] / doc / disobedience.1.in
CommitLineData
460b9539 1.\"
5aff007d 2.\" Copyright (C) 2004-2008 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"
eb80584d 29.SS "Server Menu"
afc2fe2e
RK
30This has the following options:
31.TP
32.B Login
33Brings up the \fBLogin Details Window\fR; see below.
34.TP
5d25fbdc
RK
35.B "Manage Users"
36Brings up the \fBUser Management Window\fR; see below.
37.TP
afc2fe2e
RK
38.B Quit
39Terminates the program.
460b9539 40.SS "Edit Menu"
41This has the following options:
42.TP
43.B "Select All"
44Select all tracks in whichever of the Queue or Recent tabs are showing.
45.TP
46.B Properties
c0c23a60
RK
47Edit the details of the selected tracks.
48See
d8e369d5
RK
49.B "Properties Window"
50below.
ab560bd2
RK
51.SS "Control Menu"
52This has the following options:
53.TP
54.B Scratch
55Interrupts the currently playing track.
56.TP
57.B Playing
58Pause and resume the current track.
59.TP
60.B "Random play"
c0c23a60
RK
61Enable and disable random play.
62Does not take effect until the currently playing track finishes.
ab560bd2
RK
63.TP
64.B "Network player"
c0c23a60
RK
65Enables or disables network play.
66See
ab560bd2
RK
67.B "NETWORK PLAY"
68below.
460b9539 69.SS "Help Menu"
70This has only one option, "About DisOrder", which pops up a box giving the
71name, author and version number of the software.
72.SS "Controls"
73.TP
74.B "Pause button"
75The pause button can be used to pause and resume tracks.
76.TP
77.B "Scratch button"
78The scratch button, a red cross, can be used to interrupt the currently playing
79track.
80.TP
81.B "Random play button"
c0c23a60
RK
82The random play button can be used to enable and disable random play.
83It does not take effect until the currently playing track finishes.
460b9539 84.TP
85.B "Play button"
c0c23a60
RK
86The play button controls whether tracks will be played at all.
87As above it does not take effect until the currently playing track finishes.
460b9539 88.TP
ab23e130 89.B "Network play button"
c0c23a60
RK
90The network play buttons enables or disables network play.
91See
ab560bd2
RK
92.B "NETWORK PLAY"
93below.
ab23e130 94.TP
460b9539 95.B "Volume slider"
96The volume slider indicates the current volume level and can be used to adjust
c0c23a60
RK
97it.
980 is silent and 10 is maximum volume.
460b9539 99.TP
100.B "Balance slider"
101The balance slider indicates the current balance and can be used to adjust it.
102-1 means only the left speaker, 0 means both speakers at equal volume and +1
103means the only the right speaker.
104.SS "Queue Tab"
c0c23a60 105This displays the currently playing track and the queue.
cda70ecc
RK
106The currently playing track is at the top, and can be distinguished by
107the constantly updating timer.
108Queued tracks appear below it.
460b9539 109.PP
c0c23a60
RK
110The left button can be use to select and deselect tracks.
111On its own it just selects the pointed track and deselects everything else.
112With CTRL it flips the state of the pointed track without affecting anything
113else.
114With SHIFT it selects every track from the last click to the current position
115and deselects everything else.
116With both CTRL and SHIFT it selects everything from the last click to the
117current position without deselecting anything.
460b9539 118.PP
cda70ecc
RK
119Tracks can be moved within the queue by dragging them to a new position with
120the left button.
121.PP
c0c23a60
RK
122The right button pops up a menu.
123This has the following options:
460b9539 124.TP
125.B Properties
c0c23a60
RK
126Edit the details of the selected tracks.
127See
460b9539 128.B "Properties Window"
129below.
130.TP
131.B "Select All"
132Select all tracks.
133.TP
134.B Scratch
c0c23a60
RK
135Interrupt the currently playing track.
136(Note that this appears even if you right click over a queued track rather
137than the currently playing track.)
460b9539 138.TP
139.B Remove
140Remove the selected tracks from the queue.
141.SS "Recent Tab"
142This displays recently played tracks, the most recent at the top.
143.PP
cda70ecc
RK
144The left button functions as above, except that drag-and-drop rearrangement
145is not possible.
c0c23a60 146The right button pops up a menu with the following options:
460b9539 147.TP
148.B Properties
c0c23a60
RK
149Edit the details of the selected tracks.
150See
460b9539 151.B "Properties Window"
152below.
153.TP
154.B "Select All"
155Select all tracks.
156.SS "Choose Tab"
157This displays all the tracks known to the server in a tree structure.
158.PP
c0c23a60
RK
159Directories are represented with an arrow to their left.
160This can be clicked to reveal or hide the contents of the directory.
161The top level "directories" break up tracks by their first letter.
460b9539 162.PP
c0c23a60
RK
163Playable files are represented by their name.
164If they are playing or in the queue then a notes icon appears next to them.
460b9539 165.PP
c0c23a60
RK
166Left clicking on a file will select it.
167As with the queue tab you can use SHIFT and CTRL to select multiple files.
460b9539 168.PP
d5a2a8dd 169The text box at the bottom is a search form.
c0c23a60
RK
170If you enter search terms here then tracks containing all those words will be
171highlighted.
172You can also limit the results to tracks with particular tags, by including
173\fBtag:\fITAG\fR for each tag.
460b9539 174.PP
c0c23a60
RK
175To start a new search just edit the contents of the search box.
176The cancel button to its right clears the current search.
177The up and down arrows will scroll the window to make the previous or next
178search result visible.
460b9539 179.PP
d8e369d5 180Right clicking over a track will pop up a menu with the following options:
460b9539 181.TP
182.B Play
183Play selected tracks.
184.TP
185.B Properties
c0c23a60
RK
186Edit properties of selected tracks.
187See
d8e369d5
RK
188.B "Properties Window"
189below.
190.PP
191A middle click on a track will add it to the queue.
460b9539 192.PP
d8e369d5
RK
193Right clicking over a directory will pop up a menu with the following options:
194.TP
195.B "Play all tracks"
196Play all the tracks in the directory, in the order they appear on screen.
197.TP
198.B "Track properties"
199Edit properties of all tracks in the directory.
200.TP
201.B "Select all tracks"
202Select all the tracks in the directory (and deselect everything else).
203.PP
204Note that these options do not apply recursively - only the tracks in the
205relevant directory are affected, not those in its subdirectories.
655cae67 206.SS "Added Tab"
c0c23a60
RK
207This displays a list of tracks recently added to the server's database.
208The most recently added track is at the top.
655cae67 209.PP
c0c23a60
RK
210Left clicking a track will select it.
211CTRL and SHIFT work as above to select muliple files.
655cae67
RK
212.PP
213Right clicking over a track will pop up a menu with the following options:
214.TP
215.B "Track properties"
c0c23a60
RK
216Edit properties of selected tracks.
217See
655cae67
RK
218.B "Properties Window"
219below.
220.TP
221.B "Play track"
222Play selected tracks.
223.TP
224.B "Select All Tracks"
225Select all tracks.
afc2fe2e
RK
226.SS "Login Details Window"
227The login details window allows you to edit the connection details and
c0c23a60 228authorization information used by Disobedience.
47623e11
RK
229.PP
230At the top is a 'remote' switch.
231If this is enabled then you can use the \fBHostname\fR and \fBService\fR
232fields to connect to a remote server.
233If it is disabled then then Disobedience will connect to a local server
234instead.
235.PP
236Below this are four text entry fields:
afc2fe2e
RK
237.TP
238.B Hostname
239The host to connect to.
240.TP
241.B Service
242The service name or port number to connect to.
243.TP
244.B "User name"
245The user name to log in as.
246.TP
247.B Password
c0c23a60
RK
248The password to use when logging in.
249Note that this is NOT your login password but is your password to the
250DisOrder server.
afc2fe2e 251.PP
47623e11 252It has two buttons:
afc2fe2e
RK
253.TP
254.B Login
255This button attempts to (re-)connect to the server with the currently displayed
c0c23a60 256settings.
47623e11 257The settings are saved in
afc2fe2e 258.IR $HOME/.disorder/passwd .
47623e11 259on success.
afc2fe2e 260.TP
0f24b368
RK
261.B Close
262This button closes the window, discarding any unsaved changes.
460b9539 263.SS "Properties Window"
264This window contains details of one or more tracks and allows them to be
265edited.
266.PP
267The Artist, Album and Title fields determine how the tracks appear in
268the queue and recently played tabs.
269.PP
c0c23a60
RK
270The Tags field determine which tags apply to the track.
271Tags are separated by commas and can contain any printing characters except
272comma.
460b9539 273.PP
68a1bff0
RK
274The Weight field determines the track weight. Tracks with higher weights are
275proportionately more likely to be picked at random. The default weight is
27690000, and the maximum weight is 2147483647.
277.PP
460b9539 278The Random checkbox determines whether the track will be picked at random.
279Random play is enabled for every track by default, but it can be turned off
280here.
281.PP
f4b9ba55 282The double-headed arrow to the right of each preference will propagate its
c0c23a60
RK
283value to all the other tracks in the window.
284For instance, this can be used to efficiently correct the artist or album
285fields, or bulk-disable random play for many tracks.
f4b9ba55 286.PP
460b9539 287Press "OK" to confirm all changes and close the window, "Apply" to confirm
288changes but keep the window open and "Cancel" to close the window and discard
289all changes.
5d25fbdc
RK
290.SS "User Management Window"
291This window is primarily of interest to adminstrators, and will not be
292available to users without admin rights. The left hand side is a list of all
293users; the right hand side contains the editable details of the currently
294selected user.
295.PP
296When you select any user you can edit their email address or change their
297password. It is also possible to edit the individual user rights. Click on
298the "Apply" button to commit any changes you make.
299.PP
300The "Add" button creates a new user. You must enter at least a username.
301Default rights are setting according to local configuration, \fInot\fR server
302configuration (but this may be changed in the future). As above, click on
303"Apply" to actually create the new user.
304.PP
305The "Delete" button deletes the selected user. This operation cannot be
306undone.
460b9539 307.SH "KEYBOARD SHORTCUTS"
308.TP
309.B CTRL+A
310Select all tracks (queue/recent)
311.TP
afc2fe2e
RK
312.B CTRL+L
313Brings up the \fBLogin Details Window\fR.
314.TP
460b9539 315.B CTRL+Q
316Quit.
ab560bd2
RK
317.SH "NETWORK PLAY"
318Network play uses a background
0d350ff0 319.BR disorder\-playrtp (1)
c0c23a60
RK
320process.
321If you quit Disobedience the player will continue playing and can be
ab560bd2
RK
322disabled from a later run of Disobedience.
323.PP
324The player will log to
0d350ff0 325.I ~/.disorder/HOSTNAME\-rtp.log
ab560bd2
RK
326so look there if it does not seem to be working.
327.PP
328You can stop it without running Disobedience by the command
0d350ff0 329.BR "killall disorder\-playrtp" .
d8e369d5
RK
330.SH OPTIONS
331.TP
0d350ff0 332.B \-\-config \fIPATH\fR, \fB\-c \fIPATH
c0c23a60
RK
333Set the configuration file.
334The default is
d8e369d5
RK
335.IR pkgconfdir/config .
336.TP
0d350ff0 337.B \-\-debug\fR, \fB\-d
d8e369d5
RK
338Enable debugging.
339.TP
0d350ff0 340.B \-\-help\fR, \fB\-h
d8e369d5
RK
341Display a usage message.
342.TP
0d350ff0 343.B \-\-version\fR, \fB\-V
d8e369d5
RK
344Display version number.
345.SS "GTK+ Options"
c0c23a60
RK
346Additional options are supported by the GTK+ library.
347Refer to GTK+ documentation for further information.
348Under X11 they include:
d8e369d5 349.TP
0d350ff0 350.B \-\-display \fIDISPLAY\fR
d8e369d5
RK
351The X display to use.
352.TP
0d350ff0 353.B \-\-screen \fISCREEN\fR
d8e369d5
RK
354The screen number to use.
355.\" If know enough to use it you know enough to find it
356.\" .TP
0d350ff0 357.\" .B \-\-sync
d8e369d5 358.\" Make all X requests synchronously.
a8161466
RK
359.SH CONFIGURATION
360If you are using
361.B disobedience
362on the same host as the server then no additional configuration should be
363required.
364.PP
afc2fe2e 365If it is running on a different host then the easiest way to set it up is to
c0c23a60
RK
366use the login details window in Disobedience.
367Enter the connection details, use Login to connect to the server, and then
368use Save to store them for future sessions.
f4b9ba55 369.PP
afc2fe2e
RK
370The other clients read their configuration from the same location so after
371setting up with Disobedience, tools such as
372.BR disorder (1)
373should work as well.
b6579a61 374.SH BUGS
b6579a61 375There is no particular provision for multiple users of the same computer
0d350ff0 376sharing a single \fBdisorder\-playrtp\fR process.
c0c23a60
RK
377This shouldn't be too much of a problem in practice but something could
378perhaps be done given demand.
29f30bb0
RK
379.PP
380Try to do remote user management when the server is configured to refuse this
381produces rather horrible error behavior.
cda70ecc
RK
382.PP
383Only one track can be dragged at a time.
384.PP
385Resizing columns doesn't work very well.
386This is a GTK+ bug.
ab23e130
RK
387.SH FILES
388.TP
0d350ff0 389.I ~/.disorder/HOSTNAME\-rtp
ab23e130
RK
390Socket for communication with RTP player.
391.TP
0d350ff0 392.I ~/.disorder/HOSTNAME\-rtp.log
ab23e130 393Log file for RTP player.
460b9539 394.SH "SEE ALSO"
0d350ff0 395.BR disorder\-playrtp (1),
460b9539 396.BR disorder_config (5)
397.PP
d8e369d5
RK
398.B http://www.greenend.org.uk/rjk/disorder/
399.br
400- DisOrder home page
401.PP
0d350ff0 402.B http://www.gtk.org/api/2.6/gtk/gtk\-x11.html
460b9539 403.br
404- Using GTK+ on the X Window System
405.\" Local Variables:
406.\" mode:nroff
407.\" fill-column:79
408.\" End: