chiark / gitweb /
Documentation tweaks
[disorder] / doc / disobedience.1.in
index b6c3f734e0663011332ecf0a0ca88f59571e621a..57e3addc1263679f42416bfb38cf2e9ffe2d9fda 100644 (file)
@@ -1,5 +1,5 @@
 .\"
-.\" Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell
+.\" Copyright (C) 2004-2008 Richard Kettlewell
 .\"
 .\" 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
@@ -26,12 +26,15 @@ disobedience \- GUI client for DisOrder jukebox
 .B disobedience
 is a graphical client for DisOrder.
 .SH "WINDOWS AND ICONS"
-.SS "File Menu"
+.SS "Server Menu"
 This has the following options:
 .TP
 .B Login
 Brings up the \fBLogin Details Window\fR; see below.
 .TP
+.B "Manage Users"
+Brings up the \fBUser Management Window\fR; see below.
+.TP
 .B Quit
 Terminates the program.
 .SS "Edit Menu"
@@ -258,6 +261,10 @@ The Tags field determine which tags apply to the track.
 Tags are separated by commas and can contain any printing characters except
 comma.
 .PP
+The Weight field determines the track weight.  Tracks with higher weights are
+proportionately more likely to be picked at random.  The default weight is
+90000, and the maximum weight is 2147483647.
+.PP
 The Random checkbox determines whether the track will be picked at random.
 Random play is enabled for every track by default, but it can be turned off
 here.
@@ -270,6 +277,23 @@ fields, or bulk-disable random play for many tracks.
 Press "OK" to confirm all changes and close the window, "Apply" to confirm
 changes but keep the window open and "Cancel" to close the window and discard
 all changes.
+.SS "User Management Window"
+This window is primarily of interest to adminstrators, and will not be
+available to users without admin rights.  The left hand side is a list of all
+users; the right hand side contains the editable details of the currently
+selected user.
+.PP
+When you select any user you can edit their email address or change their
+password.  It is also possible to edit the individual user rights.  Click on
+the "Apply" button to commit any changes you make.
+.PP
+The "Add" button creates a new user.  You must enter at least a username.
+Default rights are setting according to local configuration, \fInot\fR server
+configuration (but this may be changed in the future).  As above, click on
+"Apply" to actually create the new user.
+.PP
+The "Delete" button deletes the selected user.  This operation cannot be
+undone.
 .SH "KEYBOARD SHORTCUTS"
 .TP
 .B CTRL+A
@@ -282,45 +306,45 @@ Brings up the \fBLogin Details Window\fR.
 Quit.
 .SH "NETWORK PLAY"
 Network play uses a background
-.BR disorder-playrtp (1)
+.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
+.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" .
+.BR "killall disorder\-playrtp" .
 .SH OPTIONS
 .TP
-.B --config \fIPATH\fR, \fB-c \fIPATH
+.B \-\-config \fIPATH\fR, \fB\-c \fIPATH
 Set the configuration file.
 The default is
 .IR pkgconfdir/config .
 .TP
-.B --debug\fR, \fB-d
+.B \-\-debug\fR, \fB\-d
 Enable debugging.
 .TP
-.B --help\fR, \fB-h
+.B \-\-help\fR, \fB\-h
 Display a usage message.
 .TP
-.B --version\fR, \fB-V
+.B \-\-version\fR, \fB\-V
 Display version number.
 .SS "GTK+ Options"
 Additional options are supported by the GTK+ library.
 Refer to GTK+ documentation for further information.
 Under X11 they include:
 .TP
-.B --display \fIDISPLAY\fR
+.B \-\-display \fIDISPLAY\fR
 The X display to use.
 .TP
-.B --screen \fISCREEN\fR
+.B \-\-screen \fISCREEN\fR
 The screen number to use.
 .\" If know enough to use it you know enough to find it
 .\" .TP
-.\" .B --sync
+.\" .B \-\-sync
 .\" Make all X requests synchronously.
 .SH CONFIGURATION
 If you are using
@@ -343,25 +367,25 @@ There are bound to be bugs.
 Please send feedback.
 .PP
 There is no particular provision for multiple users of the same computer
-sharing a single \fBdisorder-playrtp\fR process.
+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
+.I ~/.disorder/HOSTNAME\-rtp
 Socket for communication with RTP player.
 .TP
-.I ~/.disorder/HOSTNAME-rtp.log
+.I ~/.disorder/HOSTNAME\-rtp.log
 Log file for RTP player.
 .SH "SEE ALSO"
-.BR disorder-playrtp (1),
+.BR disorder\-playrtp (1),
 .BR disorder_config (5)
 .PP
 .B http://www.greenend.org.uk/rjk/disorder/
 .br
 - DisOrder home page
 .PP
-.B http://www.gtk.org/api/2.6/gtk/gtk-x11.html
+.B http://www.gtk.org/api/2.6/gtk/gtk\-x11.html
 .br
 - Using GTK+ on the X Window System
 .\" Local Variables: