chiark / gitweb /
update disobedience.1 for latest changes
[disorder] / doc / disobedience.1.in
index db7c27b65ed38787c6d9f6323ab0e65bf16ca692..b8710610b8f4795fe2937bee36b6e0882338c6fd 100644 (file)
@@ -27,7 +27,13 @@ disobedience \- GUI client for DisOrder jukebox
 is a graphical client for DisOrder.
 .SH "WINDOWS AND ICONS"
 .SS "File Menu"
-This only has one option, "Quit", which terminates the program.
+This has the following options:
+.TP
+.B Login
+Brings up the \fBLogin Details Window\fR; see below.
+.TP
+.B Quit
+Terminates the program.
 .SS "Edit Menu"
 This has the following options:
 .TP
@@ -58,6 +64,16 @@ not take effect until the currently playing track finishes.
 The play button controls whether tracks will be played at all.  As above it
 does not take effect until the currently playing track finishes.
 .TP
+.B "Network play button"
+The network play buttons enables or disables a background
+.BR disorder-playrtp (1)
+process.  If you quit Disobedience the player will continue playing and can be
+disabled from a later run of Disobedience.
+.IP
+The player will log to
+.I ~/.disorder/HOSTNAME-rtp.log
+so look there if it does not seem to be working.
+.TP
 .B "Volume slider"
 The volume slider indicates the current volume level and can be used to adjust
 it.  0 is silent and 10 is maximum volume.
@@ -121,12 +137,13 @@ 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.  If you enter search terms here then
-the display will be limited to tracks containing all those words.  You can also
+tracks containing all those words will be highlighted.  You can also
 limit the results to tracks with particular tags, by including \fBtag:\fITAG\fR
 for each tag.
 .PP
 To start a new search just edit the contents of the search box.  The cancel
-button to its right clears the current search.
+button to its right clears the current search.  The up and down arrows will
+scroll the window to make the previous or next search result visible.
 .PP
 Right clicking over a track will pop up a menu with the following options:
 .TP
@@ -153,6 +170,54 @@ 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.
+.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.
+.PP
+Left clicking a track will select it.  CTRL and SHIFT work as above to select
+muliple files.
+.PP
+Right clicking over a track will pop up a menu with the following options:
+.TP
+.B "Track properties"
+Edit properties of selected tracks.  See
+.B "Properties Window"
+below.
+.TP
+.B "Play track"
+Play selected tracks.
+.TP
+.B "Select All Tracks"
+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:
+.TP
+.B Hostname
+The host to connect to.
+.TP
+.B Service
+The service name or port number to connect to.
+.TP
+.B "User name"
+The user name to log in as.
+.TP
+.B Password
+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:
+.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 
+.IR $HOME/.disorder/passwd .
+.TP
+.B Close
+This button closes the window, discarding any unsaved changes.
 .SS "Properties Window"
 This window contains details of one or more tracks and allows them to be
 edited.
@@ -180,6 +245,9 @@ all changes.
 .B CTRL+A
 Select all tracks (queue/recent)
 .TP
+.B CTRL+L
+Brings up the \fBLogin Details Window\fR.
+.TP
 .B CTRL+Q
 Quit.
 .SH OPTIONS
@@ -238,28 +306,24 @@ If you are using
 on the same host as the server then no additional configuration should be
 required.
 .PP
-If it is running on a different host then the server will need a
-.B listen
-directive in its configuration and the clien a matching
-.B connect
-directive.  Also the client will need user passwords, either in
-.IR pkgconfdir/config. USER
-or
-.IR ~ USER /.disorder.passwd .
+If it is running on a different host then the easiest way to set it up is to
+use the login details window in Disobedience.  Enter the connection details,
+use Login to connect to the server, and then use Save to store them for future
+sessions.
 .PP
-You might use commands such as the following to set up a standalone instance of
-Disobedience:
-.PP
-.RS
-.nf
-cd
-mkdir .disorder
-echo password <your password> > .disorder/passwd
-echo connect <hostname> <port> >> .disorder/passwd
-chmod 600 .disorder/passwd
-.fi
-.RE
+The other clients read their configuration from the same location so after
+setting up with Disobedience, tools such as
+.BR disorder (1)
+should work as well.
+.SH FILES
+.TP
+.I ~/.disorder/HOSTNAME-rtp
+Socket for communication with RTP player.
+.TP
+.I ~/.disorder/HOSTNAME-rtp.log
+Log file for RTP player.
 .SH "SEE ALSO"
+.BR disorder-playrtp (1),
 .BR disorder_config (5)
 .PP
 .B http://www.greenend.org.uk/rjk/disorder/