chiark - git - mdw - disorder/blob - doc/disobedience.1.in

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