Doxygen file headers for most files

[disorder] / doc / disobedience.1.in

.\"
.\" 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
.\" the Free Software Foundation, either version 3 of the License, or
.\" (at your option) any later version.
.\" 
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\" 
.\" You should have received a copy of the GNU General Public License
.\" along with this program.  If not, see <http://www.gnu.org/licenses/>.
.\"
.TH disobedience 1
.SH NAME
disobedience \- GUI client for DisOrder jukebox
.SH SYNOPSIS
.B disobedience
.RI [ OPTIONS ]
.SH DESCRIPTION
.B disobedience
is a graphical client for DisOrder.
.SH "WINDOWS AND ICONS"
.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"
This has the following options:
.TP
.B "Select All"
Select all tracks in whichever of the Queue or Recent tabs are showing.
.TP
.B Properties
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.
.SS "Controls"
.TP
.B "Pause button"
The pause button can be used to pause and resume tracks.
This button shows either a pause symbol (two vertical bars) or a resume symbol
(a right-pointing arrow).
.TP
.B "Scratch button"
The scratch button, a red cross, can be used to interrupt the currently playing
track.
.TP
.B "Random play button"
The random play button can be used to enable and disable random play.
It does not take effect until the currently playing track finishes.
When the button is green, random play is enabled.
When it is grey, random play is disabled.
.TP
.B "Play button"
The play button controls whether tracks will be played at all.
As above it does not take effect until the currently playing track finishes.
When the button is green, play is enabled.
When it is grey, play is disabled.
.TP
.B "Network play button"
The network play buttons enables or disables network play.
See
.B "NETWORK PLAY"
below.
When the button is green, network play is enabled.
When it is grey, network play is disabled.
.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.
.TP
.B "Balance slider"
The balance slider indicates the current balance and can be used to adjust it.
-1 means only the left speaker, 0 means both speakers at equal volume and +1
means the only the right speaker.
.SS "Queue Tab"
This displays the currently playing track and the queue.
The currently playing track is at the top, and can be distinguished by
the constantly updating timer.
Queued tracks appear below it.
.PP
The left button can be use to select and deselect tracks.
On its own it just selects the pointed track and deselects everything else.
With CTRL it flips the state of the pointed track without affecting anything
else.
With SHIFT it selects every track from the last click to the current position
and deselects everything else.
With both CTRL and SHIFT it selects everything from the last click to the
current position without deselecting anything.
.PP
Tracks can be moved within the queue by dragging them to a new position with
the left button.
.PP
The right button pops up a menu.
This has the following options:
.TP
.B Properties
Edit the details of the selected tracks.
See
.B "Properties Window"
below.
.TP
.B "Select All"
Select all tracks.
.TP
.B Scratch
Interrupt the currently playing track.
(Note that this appears even if you right click over a queued track rather
than the currently playing track.)
.TP
.B Remove
Remove the selected tracks from the queue.
.SS "Recent Tab"
This displays recently played tracks, the most recent at the top.
.PP
The left button functions as above, except that drag-and-drop rearrangement
is not possible.
The right button pops up a menu with the following options:
.TP
.B Properties
Edit the details of the selected tracks.
See
.B "Properties Window"
below.
.TP
.B "Select All"
Select all tracks.
.SS "Choose Tab"
This displays all the tracks known to the server in a tree structure.
.PP
Directories are represented with an arrow to their left.
This can be clicked to reveal or hide the contents of the directory.
The top level "directories" break up tracks by their first letter.
.PP
Playable files are represented by their name.
If they are playing or in the queue then a notes icon appears next to them.
.PP
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 bottom is a search form.
If you enter search terms here then 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.
The up and down arrows will scroll the window to make the previous or next
search result visible.
.PP
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.
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
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.
.PP
At the top is a 'remote' switch.
If this is enabled then you can use the \fBHostname\fR and \fBService\fR
fields to connect to a remote server.
If it is disabled then then Disobedience will connect to a local server
instead.
.PP
Below this are 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 two buttons:
.TP
.B Login
This button attempts to (re-)connect to the server with the currently displayed
settings.
The settings are saved in
.IR $HOME/.disorder/passwd .
on success.
.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.
.PP
The Artist, Album and Title fields determine how the tracks appear in
the queue and recently played tabs.
.PP
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.
.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.
.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
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
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 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 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 BUGS
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.
.PP
Try to do remote user management when the server is configured to refuse this
produces rather horrible error behavior.
.PP
Only one track can be dragged at a time.
.PP
Resizing columns doesn't work very well.
This is a GTK+ bug.
.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/
.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
.\" Local Variables:
.\" mode:nroff
.\" fill-column:79
.\" End: