Switch to GPL v3
[disorder] / doc / disobedience.1.in
index e8b7973..3e3d386 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
@@ -73,6 +71,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
@@ -81,16 +81,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
@@ -166,7 +172,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
@@ -226,7 +232,14 @@ Select 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.
@@ -242,16 +255,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.