| 1 | .\" |
| 2 | .\" Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell |
| 3 | .\" |
| 4 | .\" This program is free software; you can redistribute it and/or modify |
| 5 | .\" it under the terms of the GNU General Public License as published by |
| 6 | .\" the Free Software Foundation; either version 2 of the License, or |
| 7 | .\" (at your option) any later version. |
| 8 | .\" |
| 9 | .\" This program is distributed in the hope that it will be useful, but |
| 10 | .\" WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 12 | .\" General Public License for more details. |
| 13 | .\" |
| 14 | .\" You should have received a copy of the GNU General Public License |
| 15 | .\" along with this program; if not, write to the Free Software |
| 16 | .\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 |
| 17 | .\" USA |
| 18 | .\" |
| 19 | .TH disobedience 1 |
| 20 | .SH NAME |
| 21 | disobedience \- GUI client for DisOrder jukebox |
| 22 | .SH SYNOPSIS |
| 23 | .B disobedience |
| 24 | .RI [ OPTIONS ] |
| 25 | .SH DESCRIPTION |
| 26 | .B disobedience |
| 27 | is a graphical client for DisOrder. It is a work in progress and many features |
| 28 | are not implemented yet. However everything in this man page is either |
| 29 | implemented or marked as missing. |
| 30 | .SH OPTIONS |
| 31 | .TP |
| 32 | .B --config \fIPATH\fR, \fB-c \fIPATH |
| 33 | Set the configuration file. The default is |
| 34 | .IR pkgconfdir/config . |
| 35 | .TP |
| 36 | .B --debug\fR, \fB-d |
| 37 | Enable debugging. |
| 38 | .TP |
| 39 | .B --help\fR, \fB-h |
| 40 | Display a usage message. |
| 41 | .TP |
| 42 | .B --version\fR, \fB-V |
| 43 | Display version number. |
| 44 | .SS "GTK+ Options" |
| 45 | Additional options are supported by the GTK+ library. Refer to GTK+ |
| 46 | documentation for further information. Under X11 they include: |
| 47 | .TP |
| 48 | .B --display \fIDISPLAY\fR |
| 49 | The X display to use. |
| 50 | .TP |
| 51 | .B --screen \fISCREEN\fR |
| 52 | The screen number to use. |
| 53 | .\" If know enough to use it you know enough to find it |
| 54 | .\" .TP |
| 55 | .\" .B --sync |
| 56 | .\" Make all X requests synchronously. |
| 57 | .SH "WINDOWS AND ICONS" |
| 58 | .SS "File Menu" |
| 59 | This only has one option, "Quit", which terminates the program. |
| 60 | .SS "Edit Menu" |
| 61 | This has the following options: |
| 62 | .TP |
| 63 | .B "Select All" |
| 64 | Select all tracks in whichever of the Queue or Recent tabs are showing. |
| 65 | .TP |
| 66 | .B Properties |
| 67 | Edit the details of the selected tracks. |
| 68 | .SS "Help Menu" |
| 69 | This has only one option, "About DisOrder", which pops up a box giving the |
| 70 | name, author and version number of the software. |
| 71 | .SS "Controls" |
| 72 | .TP |
| 73 | .B "Pause button" |
| 74 | The pause button can be used to pause and resume tracks. |
| 75 | .TP |
| 76 | .B "Scratch button" |
| 77 | The scratch button, a red cross, can be used to interrupt the currently playing |
| 78 | track. |
| 79 | .TP |
| 80 | .B "Random play button" |
| 81 | The random play button can be used to enable and disable random play. It does |
| 82 | not take effect until the currently playing track finishes. |
| 83 | .TP |
| 84 | .B "Play button" |
| 85 | The play button controls whether tracks will be played at all. As above it |
| 86 | does not take effect until the currently playing track finishes. |
| 87 | .TP |
| 88 | .B "Volume slider" |
| 89 | The volume slider indicates the current volume level and can be used to adjust |
| 90 | it. 0 is silent and 10 is maximum volume. |
| 91 | .TP |
| 92 | .B "Balance slider" |
| 93 | The balance slider indicates the current balance and can be used to adjust it. |
| 94 | -1 means only the left speaker, 0 means both speakers at equal volume and +1 |
| 95 | means the only the right speaker. |
| 96 | .SS "Queue Tab" |
| 97 | This displays the currently playing track and the queue. The currently playing |
| 98 | track is at the top and has a green background. Queued tracks appear below it |
| 99 | and have alternating red and white backgrounds. |
| 100 | .PP |
| 101 | The left button can be use to select and deselect tracks. On its own it just |
| 102 | selects the pointed track and deselects everything else. With CTRL it flips |
| 103 | the state of the pointed track without affecting anything else. With SHIFT it |
| 104 | selects every track from the last click to the current position and deselects |
| 105 | everything else. With both CTRL and SHIFT it selects everything from the last |
| 106 | click to the current position without deselecting anything. |
| 107 | .PP |
| 108 | The right button pops up a menu. This has the following options: |
| 109 | .TP |
| 110 | .B Properties |
| 111 | Edit the details of the selected tracks. See |
| 112 | .B "Properties Window" |
| 113 | below. |
| 114 | .TP |
| 115 | .B "Select All" |
| 116 | Select all tracks. |
| 117 | .TP |
| 118 | .B Scratch |
| 119 | Interrupt the currently playing track. (Note that this appears even if you |
| 120 | right click over a queued track rather than the currently playing track.) |
| 121 | .TP |
| 122 | .B Remove |
| 123 | Remove the selected tracks from the queue. |
| 124 | .SS "Recent Tab" |
| 125 | This displays recently played tracks, the most recent at the top. |
| 126 | .PP |
| 127 | The left button functions as above. The right button pops up a menu with the |
| 128 | following options: |
| 129 | .TP |
| 130 | .B Properties |
| 131 | Edit the details of the selected tracks. See |
| 132 | .B "Properties Window" |
| 133 | below. |
| 134 | .TP |
| 135 | .B "Select All" |
| 136 | Select all tracks. |
| 137 | .SS "Choose Tab" |
| 138 | This displays all the tracks known to the server in a tree structure. |
| 139 | .PP |
| 140 | Directories are represented with an arrow to their left. This can be clicked |
| 141 | to reveal or hide the contents of the directory. The top level "directories" |
| 142 | break up tracks by their first letter. |
| 143 | .PP |
| 144 | Playable files are represented by their name. If they are playing or in the |
| 145 | queue then a notes icon appears next to them. |
| 146 | .PP |
| 147 | Left clicking on a file will select it. As with the queue tab you can use |
| 148 | SHIFT and CTRL to select multiple files. |
| 149 | .PP |
| 150 | The text box at the top is a search form. If you enter search terms here then |
| 151 | the display will be limited to tracks containing all those words. You can also |
| 152 | limit the results to tracks with particular tags, by including \fBtag:\fITAG\fR |
| 153 | for each tag. |
| 154 | .PP |
| 155 | To start a new search just edit the contents of the search box. The cancel |
| 156 | button to its right clears the current search. |
| 157 | .PP |
| 158 | Right clicking will pop up a menu with the following options: |
| 159 | .TP |
| 160 | .B Play |
| 161 | Play selected tracks. |
| 162 | .TP |
| 163 | .B Properties |
| 164 | Edit properties of selected tracks. |
| 165 | .PP |
| 166 | A middle click on a file will add it to the queue. |
| 167 | .SS "Properties Window" |
| 168 | This window contains details of one or more tracks and allows them to be |
| 169 | edited. |
| 170 | .PP |
| 171 | The Artist, Album and Title fields determine how the tracks appear in |
| 172 | the queue and recently played tabs. |
| 173 | .PP |
| 174 | The Tags field determine which tags apply to the track. Tags are separated by |
| 175 | commas and can contain any printing characters except comma. |
| 176 | .PP |
| 177 | The Random checkbox determines whether the track will be picked at random. |
| 178 | Random play is enabled for every track by default, but it can be turned off |
| 179 | here. |
| 180 | .PP |
| 181 | Press "OK" to confirm all changes and close the window, "Apply" to confirm |
| 182 | changes but keep the window open and "Cancel" to close the window and discard |
| 183 | all changes. |
| 184 | .SH "KEYBOARD SHORTCUTS" |
| 185 | .TP |
| 186 | .B CTRL+A |
| 187 | Select all tracks (queue/recent) |
| 188 | .TP |
| 189 | .B CTRL+Q |
| 190 | Quit. |
| 191 | .SH "GTK+ RESOURCES" |
| 192 | You can override these resources in order to customize the appearance of |
| 193 | Disobedience. TODO example that actually works. |
| 194 | .SS "Widget Names" |
| 195 | .TP |
| 196 | .B disobedience.*.choose |
| 197 | This is the panel containing the track choice tree. |
| 198 | .TP |
| 199 | .B disobedience.*.queue |
| 200 | This is the panel displaying the queue. |
| 201 | .TP |
| 202 | .B disobedience.*.choose |
| 203 | This is the panel listing recently played tracks. |
| 204 | .TP |
| 205 | .B disobedience.*.row-playing |
| 206 | This is the row listing the currently playing track. |
| 207 | .TP |
| 208 | .B disobedience.*.row-odd |
| 209 | This an odd-numbered row in the queue or recently played track list. |
| 210 | .TP |
| 211 | .B disobedience.*.row-even |
| 212 | This an even-numbered row in the queue or recently played track list. |
| 213 | .SH CONFIGURATION |
| 214 | If you are using |
| 215 | .B disobedience |
| 216 | on the same host as the server then no additional configuration should be |
| 217 | required. |
| 218 | .PP |
| 219 | If it is running on a different host then the server will need a |
| 220 | .B listen |
| 221 | directive in its configuration and the clien a matching |
| 222 | .B connect |
| 223 | directive. Also the client will need user passwords, either in |
| 224 | .IR pkgconfdir/config. USER |
| 225 | or |
| 226 | .IR ~ USER /.disorder.passwd . |
| 227 | .SH "SEE ALSO" |
| 228 | .BR disorder_config (5) |
| 229 | .PP |
| 230 | .B http://www.gtk.org/api/2.6/gtk/gtk-x11.html |
| 231 | .br |
| 232 | - Using GTK+ on the X Window System |
| 233 | .\" Local Variables: |
| 234 | .\" mode:nroff |
| 235 | .\" fill-column:79 |
| 236 | .\" End: |