Merge Disobedience playlist support.
[disorder] / doc / disobedience.1.in
index ef1f482..f6ce906 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
@@ -40,14 +38,23 @@ 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.
 See
 .B "Properties Window"
 below.
+.TP
+.B "Edit Playlists"
+Edit playlists.
+See
+.B "Playlists Window"
+below.
 .SS "Control Menu"
 This has the following options:
 .TP
@@ -66,6 +73,10 @@ Enables or disables network play.
 See
 .B "NETWORK PLAY"
 below.
+.TP
+.B "Activate Playlist"
+This submenu has the selection of playlists which you are able to play.
+Picking one will add its contents to the queue.
 .SS "Help Menu"
 This has only one option, "About DisOrder", which pops up a box giving the
 name, author and version number of the software.
@@ -107,7 +118,7 @@ it.
 .TP
 .B "Balance slider"
 The balance slider indicates the current balance and can be used to adjust it.
--1 means only the left speaker, 0 means both speakers at equal volume and +1
+\-1 means only the left speaker, 0 means both speakers at equal volume and +1
 means the only the right speaker.
 .SS "Queue Tab"
 This displays the currently playing track and the queue.
@@ -136,16 +147,22 @@ 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
@@ -159,8 +176,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
@@ -174,6 +197,9 @@ 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
+Files may be played by dragging them to the queue tab and thence to a
+destination position in the queue.
+.PP
 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.
@@ -206,11 +232,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.
@@ -231,6 +257,9 @@ 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.
@@ -312,6 +341,39 @@ configuration (but this may be changed in the future).  As above, click on
 .PP
 The "Delete" button deletes the selected user.  This operation cannot be
 undone.
+.SS "Playlists Window"
+A playlist is a collection of tracks that can be prepared in advance and then
+played as a unit.
+Playlists come in three kinds:
+.TP
+.B shared
+A playlist that anyone can edit.
+These are not owned by any user.
+.TP
+.B public
+A playlist that only one user (its owner) can edit,
+but that anyone can see the contents of.
+.TP
+.B private
+A playlist that is entirely private to one user.
+.PP
+Public and private playlists start with the owner's username.
+.PP
+The left side of the playlist window is a list of all playlists that you can
+see: all shared and public playlists plus your private playlists.
+Selecting one will bring it up in the right hand side of the window,
+allowing it to be reviewed or edited.
+You can drag tracks from the choose tab in the main window into it and
+rearrange tracks already in the playlist by selecting and dragging them.
+.PP
+The add button creates a new playlist.
+You must selected whether it will be a shared, public or private playlist.
+.PP
+At the bottom of the window are radio buttons showing which kind of playlist it
+is.
+If you own the playlist you can use these to switch it between public and
+private, but if it is shared or owned by someone else these buttons will be
+greyed out.
 .SH "KEYBOARD SHORTCUTS"
 .TP
 .B CTRL+A