Merge Disobedience playlist support.

[disorder] / doc / disobedience.1.in

diff --git a/doc/disobedience.1.in b/doc/disobedience.1.in
index b174824..f6ce906 100644 (file)
--- a/doc/disobedience.1.in
+++ b/doc/disobedience.1.in
@@ -49,6 +49,12 @@ 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
@@ -67,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.
@@ -108,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.
@@ -148,8 +158,11 @@ 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
@@ -184,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.
@@ -325,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