X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/6f3acea989cf8191569cc59d492722662fb25464..afc2fe2e800a23478aaeb0b62c03513233a92c66:/doc/disobedience.1.in diff --git a/doc/disobedience.1.in b/doc/disobedience.1.in index 82916fb..d68feec 100644 --- a/doc/disobedience.1.in +++ b/doc/disobedience.1.in @@ -24,52 +24,16 @@ disobedience \- GUI client for DisOrder jukebox .RI [ OPTIONS ] .SH DESCRIPTION .B disobedience -is a graphical client for DisOrder. It is a work in progress and many features -are not implemented yet. However everything in this man page is either -implemented or marked as missing. -.SH "SETTING UP" -You might use commands such as the following to set up a standalone instance of -Disobedience: -.PP -.RS -.nf -cd -mkdir .disorder -echo password > .disorder/passwd -echo connect >> .disorder/passwd -chmod 600 .disorder/passwd -.fi -.RE -.SH OPTIONS -.TP -.B --config \fIPATH\fR, \fB-c \fIPATH -Set the configuration file. The default is -.IR pkgconfdir/config . -.TP -.B --debug\fR, \fB-d -Enable debugging. -.TP -.B --help\fR, \fB-h -Display a usage message. -.TP -.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 -The X display to use. -.TP -.B --screen \fISCREEN\fR -The screen number to use. -.\" If know enough to use it you know enough to find it -.\" .TP -.\" .B --sync -.\" Make all X requests synchronously. +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 @@ -77,7 +41,9 @@ This has the following options: Select all tracks in whichever of the Queue or Recent tabs are showing. .TP .B Properties -Edit the details of the selected tracks. +Edit the details of the selected tracks. See +.B "Properties Window" +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. @@ -161,22 +127,87 @@ 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 will pop up a menu with the following options: +Right clicking over a track will pop up a menu with the following options: .TP .B Play Play selected tracks. .TP .B Properties -Edit properties of selected tracks. +Edit properties of selected tracks. See +.B "Properties Window" +below. +.PP +A middle click on a track will add it to the queue. +.PP +Right clicking over a directory will pop up a menu with the following options: +.TP +.B "Play all tracks" +Play all the tracks in the directory, in the order they appear on screen. +.TP +.B "Track properties" +Edit properties of all tracks in the directory. +.TP +.B "Select all tracks" +Select all the tracks in the directory (and deselect everything else). .PP -A middle click on a file will add it to the queue. +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 Cancel +This button closes the window. .SS "Properties Window" This window contains details of one or more tracks and allows them to be edited. @@ -191,6 +222,11 @@ 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. .PP +The double-headed arrow to the right of each preference will propagate its +value to all the other tracks in the window. For instance, this can be used to +efficiently correct the artist or album fields, or bulk-disable random play for +many tracks. +.PP 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. @@ -199,11 +235,42 @@ 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 +.TP +.B --config \fIPATH\fR, \fB-c \fIPATH +Set the configuration file. The default is +.IR pkgconfdir/config . +.TP +.B --debug\fR, \fB-d +Enable debugging. +.TP +.B --help\fR, \fB-h +Display a usage message. +.TP +.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 +The X display to use. +.TP +.B --screen \fISCREEN\fR +The screen number to use. +.\" If know enough to use it you know enough to find it +.\" .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. +Disobedience. +.\" TODO example that actually works. .SS "Widget Names" .TP .B disobedience.*.choose @@ -229,17 +296,22 @@ 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 +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 "SEE ALSO" .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 .br - Using GTK+ on the X Window System