chiark / gitweb /
Support arbitrary Core Audio devices.
[disorder] / doc / disobedience.1.in
index 6ac4202442246d0fbe5372ae4810c7189dfe9551..fa4bd4264c71ebf6b9629213e11ada43fd2a2f7f 100644 (file)
@@ -1,20 +1,18 @@
 .\"
 .\" Copyright (C) 2004-2008 Richard Kettlewell
 .\"
-.\" This program is free software; you can redistribute it and/or modify
+.\" This program is free software: you can redistribute it and/or modify
 .\" it under the terms of the GNU General Public License as published by
-.\" the Free Software Foundation; either version 2 of the License, or
+.\" the Free Software Foundation, either version 3 of the License, or
 .\" (at your option) any later version.
-.\"
-.\" This program is distributed in the hope that it will be useful, but
-.\" WITHOUT ANY WARRANTY; without even the implied warranty of
-.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-.\" General Public License for more details.
-.\"
+.\" 
+.\" This program is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.\" GNU General Public License for more details.
+.\" 
 .\" You should have received a copy of the GNU General Public License
-.\" along with this program; if not, write to the Free Software
-.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
-.\" USA
+.\" along with this program.  If not, see <http://www.gnu.org/licenses/>.
 .\"
 .TH disobedience 1
 .SH NAME
@@ -26,19 +24,25 @@ disobedience \- GUI client for DisOrder jukebox
 .B disobedience
 is a graphical client for DisOrder.
 .SH "WINDOWS AND ICONS"
-.SS "File Menu"
+.SS "Server Menu"
 This has the following options:
 .TP
 .B Login
 Brings up the \fBLogin Details Window\fR; see below.
 .TP
+.B "Manage Users"
+Brings up the \fBUser Management Window\fR; see below.
+.TP
 .B Quit
 Terminates the program.
 .SS "Edit Menu"
 This has the following options:
 .TP
-.B "Select All"
-Select all tracks in whichever of the Queue or Recent tabs are showing.
+.B "Select All Tracks"
+Select all tracks.
+.TP
+.B "Deselect All Tracks"
+Deselect all tracks.
 .TP
 .B Properties
 Edit the details of the selected tracks.
@@ -70,6 +74,8 @@ name, author and version number of the software.
 .TP
 .B "Pause button"
 The pause button can be used to pause and resume tracks.
+This button shows either a pause symbol (two vertical bars) or a resume symbol
+(a right-pointing arrow).
 .TP
 .B "Scratch button"
 The scratch button, a red cross, can be used to interrupt the currently playing
@@ -78,16 +84,22 @@ track.
 .B "Random play button"
 The random play button can be used to enable and disable random play.
 It does not take effect until the currently playing track finishes.
+When the button is green, random play is enabled.
+When it is grey, random play is disabled.
 .TP
 .B "Play button"
 The play button controls whether tracks will be played at all.
 As above it does not take effect until the currently playing track finishes.
+When the button is green, play is enabled.
+When it is grey, play is disabled.
 .TP
 .B "Network play button"
 The network play buttons enables or disables network play.
 See
 .B "NETWORK PLAY"
 below.
+When the button is green, network play is enabled.
+When it is grey, network play is disabled.
 .TP
 .B "Volume slider"
 The volume slider indicates the current volume level and can be used to adjust
@@ -100,8 +112,9 @@ The balance slider indicates the current balance and can be used to adjust it.
 means the only the right speaker.
 .SS "Queue Tab"
 This displays the currently playing track and the queue.
-The currently playing track is at the top and has a green background.
-Queued tracks appear below it and have alternating red and white backgrounds.
+The currently playing track is at the top, and can be distinguished by
+the constantly updating timer.
+Queued tracks appear below it.
 .PP
 The left button can be use to select and deselect tracks.
 On its own it just selects the pointed track and deselects everything else.
@@ -112,6 +125,9 @@ and deselects everything else.
 With both CTRL and SHIFT it selects everything from the last click to the
 current position without deselecting anything.
 .PP
+Tracks can be moved within the queue by dragging them to a new position with
+the left button.
+.PP
 The right button pops up a menu.
 This has the following options:
 .TP
@@ -121,20 +137,27 @@ See
 .B "Properties Window"
 below.
 .TP
-.B "Select All"
+.B "Select All Tracks"
 Select all tracks.
 .TP
+.B "Deselect All Tracks"
+Deselect all tracks.
+.TP
 .B Scratch
 Interrupt the currently playing track.
 (Note that this appears even if you right click over a queued track rather
 than the currently playing track.)
 .TP
-.B Remove
+.B "Remove track from queue"
 Remove the selected tracks from the queue.
+.TP
+.B "Adopt track"
+Sets the submitter of a randomly picked track to you.
 .SS "Recent Tab"
 This displays recently played tracks, the most recent at the top.
 .PP
-The left button functions as above.
+The left button functions as above, except that drag-and-drop rearrangement
+is not possible.
 The right button pops up a menu with the following options:
 .TP
 .B Properties
@@ -143,8 +166,14 @@ See
 .B "Properties Window"
 below.
 .TP
-.B "Select All"
+.B "Play track"
+Play the select track(s);
+.TP
+.B "Select All Tracks"
 Select all tracks.
+.TP
+.B "Deselect All Tracks"
+Deselect all tracks.
 .SS "Choose Tab"
 This displays all the tracks known to the server in a tree structure.
 .PP
@@ -158,7 +187,7 @@ If they are playing or in the queue then a notes icon appears next to them.
 Left clicking on a file will select it.
 As with the queue tab you can use SHIFT and CTRL to select multiple files.
 .PP
-The text box at the top is a search form.
+The text box at the bottom is a search form.
 If you enter search terms here then tracks containing all those words will be
 highlighted.
 You can also limit the results to tracks with particular tags, by including
@@ -190,11 +219,11 @@ Play all the tracks in the directory, in the order they appear on screen.
 .B "Track properties"
 Edit properties of all tracks in the directory.
 .TP
-.B "Select all tracks"
+.B "Select children"
 Select all the tracks in the directory (and deselect everything else).
-.PP
-Note that these options do not apply recursively - only the tracks in the
-relevant directory are affected, not those in its subdirectories.
+.TP
+.B "Deselect all tracks"
+Deselect everything.
 .SS "Added Tab"
 This displays a list of tracks recently added to the server's database.
 The most recently added track is at the top.
@@ -215,10 +244,20 @@ Play selected tracks.
 .TP
 .B "Select All Tracks"
 Select all tracks.
+.TP
+.B "Deselect All Tracks"
+Deselect all tracks.
 .SS "Login Details Window"
 The login details window allows you to edit the connection details and
 authorization information used by Disobedience.
-It has four text entry fields:
+.PP
+At the top is a 'remote' switch.
+If this is enabled then you can use the \fBHostname\fR and \fBService\fR
+fields to connect to a remote server.
+If it is disabled then then Disobedience will connect to a local server
+instead.
+.PP
+Below this are four text entry fields:
 .TP
 .B Hostname
 The host to connect to.
@@ -234,16 +273,14 @@ The password to use when logging in.
 Note that this is NOT your login password but is your password to the
 DisOrder server.
 .PP
-It has three buttons:
+It has two buttons:
 .TP
 .B Login
 This button attempts to (re-)connect to the server with the currently displayed
 settings.
-The settings are not saved.
-.TP
-.B Save
-This button saves the current settings in 
+The settings are saved in
 .IR $HOME/.disorder/passwd .
+on success.
 .TP
 .B Close
 This button closes the window, discarding any unsaved changes.
@@ -274,6 +311,23 @@ fields, or bulk-disable random play for many tracks.
 Press "OK" to confirm all changes and close the window, "Apply" to confirm
 changes but keep the window open and "Cancel" to close the window and discard
 all changes.
+.SS "User Management Window"
+This window is primarily of interest to adminstrators, and will not be
+available to users without admin rights.  The left hand side is a list of all
+users; the right hand side contains the editable details of the currently
+selected user.
+.PP
+When you select any user you can edit their email address or change their
+password.  It is also possible to edit the individual user rights.  Click on
+the "Apply" button to commit any changes you make.
+.PP
+The "Add" button creates a new user.  You must enter at least a username.
+Default rights are setting according to local configuration, \fInot\fR server
+configuration (but this may be changed in the future).  As above, click on
+"Apply" to actually create the new user.
+.PP
+The "Delete" button deletes the selected user.  This operation cannot be
+undone.
 .SH "KEYBOARD SHORTCUTS"
 .TP
 .B CTRL+A
@@ -342,14 +396,18 @@ setting up with Disobedience, tools such as
 .BR disorder (1)
 should work as well.
 .SH BUGS
-Disobedience is newly introduced with DisOrder 2.0.
-There are bound to be bugs.
-Please send feedback.
-.PP
 There is no particular provision for multiple users of the same computer
 sharing a single \fBdisorder\-playrtp\fR process.
 This shouldn't be too much of a problem in practice but something could
 perhaps be done given demand.
+.PP
+Try to do remote user management when the server is configured to refuse this
+produces rather horrible error behavior.
+.PP
+Only one track can be dragged at a time.
+.PP
+Resizing columns doesn't work very well.
+This is a GTK+ bug.
 .SH FILES
 .TP
 .I ~/.disorder/HOSTNAME\-rtp