chiark / gitweb /
The web interface now automaticallty figures out its own URL, so this
[disorder] / doc / disobedience.1.in
index 642a3a6ee26fd9c1d894542ce1d998999e4b1876..cc177566fbaf799194c34ccd493983afaa14f2d3 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
@@ -38,6 +44,23 @@ Select all tracks in whichever of the Queue or Recent tabs are showing.
 Edit the details of the selected tracks.  See
 .B "Properties Window"
 below.
+.SS "Control Menu"
+This has the following options:
+.TP
+.B Scratch
+Interrupts the currently playing track.
+.TP
+.B Playing
+Pause and resume the current track.
+.TP
+.B "Random play"
+Enable and disable random play.  Does not take effect until the currently
+playing track finishes.
+.TP
+.B "Network player"
+Enables or disables network play.  See
+.B "NETWORK PLAY"
+below.
 .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.
@@ -58,6 +81,11 @@ 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 network play.  See
+.B "NETWORK PLAY"
+below.
+.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.
@@ -173,6 +201,35 @@ 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.
@@ -200,8 +257,23 @@ 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 "NETWORK PLAY"
+Network play uses 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.
+.PP
+The player will log to
+.I ~/.disorder/HOSTNAME-rtp.log
+so look there if it does not seem to be working.
+.PP
+You can stop it without running Disobedience by the command
+.BR "killall disorder-playrtp" .
 .SH OPTIONS
 .TP
 .B --config \fIPATH\fR, \fB-c \fIPATH
@@ -229,57 +301,37 @@ The screen number to use.
 .\" .TP
 .\" .B --sync
 .\" Make all X requests synchronously.
-.SH "GTK+ RESOURCES"
-You can override these resources in order to customize the appearance of
-Disobedience.
-.\" TODO example that actually works.
-.SS "Widget Names"
-.TP
-.B disobedience.*.choose
-This is the panel containing the track choice tree.
-.TP
-.B disobedience.*.queue
-This is the panel displaying the queue.
-.TP
-.B disobedience.*.choose
-This is the panel listing recently played tracks.
-.TP
-.B disobedience.*.row-playing
-This is the row listing the currently playing track.
-.TP
-.B disobedience.*.row-odd
-This an odd-numbered row in the queue or recently played track list.
-.TP
-.B disobedience.*.row-even
-This an even-numbered row in the queue or recently played track list.
 .SH CONFIGURATION
 If you are using
 .B disobedience
 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:
+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 BUGS
+Disobedience is newly introduced with DisOrder 2.0.  There are bound to be
+bugs.  Please send feedback.
 .PP
-.RS
-.nf
-cd
-mkdir .disorder
-echo password <your password> > .disorder/passwd
-echo connect <hostname> <port> >> .disorder/passwd
-chmod 600 .disorder/passwd
-.fi
-.RE
+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.
+.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/