this follows advice from Colin.
16 files changed:
Quit.
.SH "NETWORK PLAY"
Network play uses a background
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
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
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" .
-.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
Set the configuration file.
The default is
.IR pkgconfdir/config .
.TP
Display a usage message.
.TP
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
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
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
The screen number to use.
.\" If know enough to use it you know enough to find it
.\" .TP
.\" Make all X requests synchronously.
.SH CONFIGURATION
If you are using
.\" Make all X requests synchronously.
.SH CONFIGURATION
If you are using
Please send feedback.
.PP
There is no particular provision for multiple users of the same computer
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
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
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"
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
.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:
.br
- Using GTK+ on the X Window System
.\" Local Variables:
.\"
.TH disorder-dbupgrade 8
.SH NAME
.\"
.TH disorder-dbupgrade 8
.SH NAME
-disorder-dbupgrade \- DisOrder Database Upgrader
+disorder\-dbupgrade \- DisOrder Database Upgrader
.RI [ OPTIONS ]
.RI [ PATH ...]
.SH DESCRIPTION
.RI [ OPTIONS ]
.RI [ PATH ...]
.SH DESCRIPTION
is DisOrder's database upgrader.
It is invoked by DisOrder when necessary and does not normally need to
be invoked manually.
.SH OPTIONS
.TP
is DisOrder's database upgrader.
It is invoked by DisOrder when necessary and does not normally need to
be invoked manually.
.SH OPTIONS
.TP
-.B --delete-bad-keys\fR, -x
+.B \-\-delete\-bad\-keys\fR, \-x
If invalid keys are found in the database then delete them.
See
.B "INVALID KEYS"
below.
.TP
If invalid keys are found in the database then delete them.
See
.B "INVALID KEYS"
below.
.TP
-.B --fail-bad-keys\fR, -X
+.B \-\-fail\-bad\-keys\fR, \-X
If invalid keys are found in the database then fail.
See
.B "INVALID KEYS"
below.
.TP
If invalid keys are found in the database then fail.
See
.B "INVALID KEYS"
below.
.TP
-.B --config \fIPATH\fR, \fB-c \fIPATH
+.B \-\-config \fIPATH\fR, \fB\-c \fIPATH
Set the configuration file.
.TP
Set the configuration file.
.TP
Log to syslog.
This is the default if stderr is not a terminal.
.TP
Log to syslog.
This is the default if stderr is not a terminal.
.TP
Do not log to syslog.
This is the default if stderr is a terminal.
.TP
Do not log to syslog.
This is the default if stderr is a terminal.
.TP
Display a usage message.
.TP
Display a usage message.
.TP
+.B \-\-version\fR, \fB\-V
Display version number.
.SH "INVALID KEYS"
An invalid key is one that is not valid UTF-8 or cannot be converted
Display version number.
.SH "INVALID KEYS"
An invalid key is one that is not valid UTF-8 or cannot be converted
By default a warning message is issued and they are left in the
database (if doing so will not compromise its integrity).
The
By default a warning message is issued and they are left in the
database (if doing so will not compromise its integrity).
The
option can be used to delete them if they are known to be harmless.
.SH "SEE ALSO"
\fBdisorderd\fR(8), \fBdisorder_config\fR(5)
option can be used to delete them if they are known to be harmless.
.SH "SEE ALSO"
\fBdisorderd\fR(8), \fBdisorder_config\fR(5)
.\"
.TH disorder-deadlock 8
.SH NAME
.\"
.TH disorder-deadlock 8
.SH NAME
-disorder-deadlock \- DisOrder deadlock manager
+disorder\-deadlock \- DisOrder deadlock manager
.RI [ OPTIONS ]
.SH DESCRIPTION
.RI [ OPTIONS ]
.SH DESCRIPTION
is DisOrder's deadlock manager.
It is automatically started by the server and does not need to
be invoked manually.
.SH OPTIONS
.TP
is DisOrder's deadlock manager.
It is automatically started by the server and does not need to
be invoked manually.
.SH OPTIONS
.TP
-.B --config \fIPATH\fR, \fB-c \fIPATH
+.B \-\-config \fIPATH\fR, \fB\-c \fIPATH
Set the configuration file.
.TP
Set the configuration file.
.TP
Log to syslog.
This is the default if stderr is not a terminal.
.TP
Log to syslog.
This is the default if stderr is not a terminal.
.TP
Do not log to syslog.
This is the default if stderr is a terminal.
.TP
Do not log to syslog.
This is the default if stderr is a terminal.
.TP
Display a usage message.
.TP
Display a usage message.
.TP
+.B \-\-version\fR, \fB\-V
Display version number.
.SH "SEE ALSO"
\fBdisorderd\fR(8), \fBdisorder_config\fR(5)
Display version number.
.SH "SEE ALSO"
\fBdisorderd\fR(8), \fBdisorder_config\fR(5)
.SH NAME
disorder-decode \- DisOrder audio decoder
.SH SYNOPSIS
.SH NAME
disorder-decode \- DisOrder audio decoder
.SH SYNOPSIS
converts MP3, OGG, FLAC and WAV files into DisOrders "raw" format.
It is therefore suitable for use as an
.B execraw
converts MP3, OGG, FLAC and WAV files into DisOrders "raw" format.
It is therefore suitable for use as an
.B execraw
It is not intended to be used from the command line.
.SH OPTIONS
.TP
It is not intended to be used from the command line.
.SH OPTIONS
.TP
Display a usage message.
.TP
Display a usage message.
.TP
+.B \-\-version\fR, \fB\-V
Display version number.
.SH LIMITATIONS
OGG files with multiple bitstreams are not supported.
Display version number.
.SH LIMITATIONS
OGG files with multiple bitstreams are not supported.
.\"
.TH disorder-dump 8
.SH NAME
.\"
.TH disorder-dump 8
.SH NAME
-disorder-dump \- DisOrder dump/undump tool
+disorder\-dump \- DisOrder dump/undump tool
+.BR \-\-dump | \-\-undump
+.BR \-\-recompute\-aliases
is used to dump and restore preferences data.
.SH OPTIONS
.TP
is used to dump and restore preferences data.
.SH OPTIONS
.TP
Write preferences data to \fIPATH\fR.
This can safely be used whether or not the server is running.
.TP
Write preferences data to \fIPATH\fR.
This can safely be used whether or not the server is running.
.TP
Read preferences data from \fIPATH\fR, replacing (unrecoverably) the
current settings.
This should normally only be done while the server is not running.
.IP
If the server is running then it may hang while the undump completes.
.TP
Read preferences data from \fIPATH\fR, replacing (unrecoverably) the
current settings.
This should normally only be done while the server is not running.
.IP
If the server is running then it may hang while the undump completes.
.TP
Perform database recovery at startup.
The server should not be running if this option is used.
.TP
Perform database recovery at startup.
The server should not be running if this option is used.
.TP
+.B \-\-recompute\-aliases
Recompute aliases without dumping or undumping the databases.
Under normal circumstances this is never necessary.
.TP
Recompute aliases without dumping or undumping the databases.
Under normal circumstances this is never necessary.
.TP
Remove tracks with no associated path when undumping or when
recomputing aliases.
In normal use such tracks are all aliases.
.TP
Remove tracks with no associated path when undumping or when
recomputing aliases.
In normal use such tracks are all aliases.
.TP
-.B --config \fIPATH\fR, \fB-c \fIPATH
+.B \-\-config \fIPATH\fR, \fB\-c \fIPATH
Set the configuration file.
The default is
.IR /etc/disorder/config .
.TP
Set the configuration file.
The default is
.IR /etc/disorder/config .
.TP
Display a usage message.
.TP
Display a usage message.
.TP
+.B \-\-version\fR, \fB\-V
Display version number.
.SH NOTES
This program might be used for a number of purposes:
Display version number.
.SH NOTES
This program might be used for a number of purposes:
another.
.PP
The output file is versioned, so versions produced from a future
another.
.PP
The output file is versioned, so versions produced from a future
-version of DisOrder may be rejected by \fB--undump\fR.
+version of DisOrder may be rejected by \fB\-\-undump\fR.
It has an end marker so truncated inputs will also be rejected.
.PP
The input or output file must be a regular file, as it may be rewound
It has an end marker so truncated inputs will also be rejected.
.PP
The input or output file must be a regular file, as it may be rewound
The server performs normal database recovery on startup.
However if the database needs normal recovery before an undump can succeed and
you don't want to start the server for some reason then the
The server performs normal database recovery on startup.
However if the database needs normal recovery before an undump can succeed and
you don't want to start the server for some reason then the
operation is available for this purpose.
No other process should be accessing the database at the time.
.PP
operation is available for this purpose.
No other process should be accessing the database at the time.
.PP
.SH NAME
disorder-normalize \- DisOrder audio normalization process
.SH SYNOPSIS
.SH NAME
disorder-normalize \- DisOrder audio normalization process
.SH SYNOPSIS
is used by
.BR disorderd (8)
to convert audio data to a consistent encoding.
It is not intended to be used by ordinary users.
.SH OPTIONS
.TP
is used by
.BR disorderd (8)
to convert audio data to a consistent encoding.
It is not intended to be used by ordinary users.
.SH OPTIONS
.TP
-.B --config \fIPATH\fR, \fB-c \fIPATH
+.B \-\-config \fIPATH\fR, \fB\-c \fIPATH
Set the configuration file.
.TP
Set the configuration file.
.TP
Log to syslog.
This is the default if stderr is not a terminal.
.TP
Log to syslog.
This is the default if stderr is not a terminal.
.TP
Do not log to syslog.
This is the default if stderr is a terminal.
.TP
Do not log to syslog.
This is the default if stderr is a terminal.
.TP
Display a usage message.
.TP
Display a usage message.
.TP
+.B \-\-version\fR, \fB\-V
Display version number.
.SH "SEE ALSO"
.BR disorderd (8)
Display version number.
.SH "SEE ALSO"
.BR disorderd (8)
.SH NAME
disorder-playrtp \- play DisOrder network broadcasts
.SH SYNOPSIS
.SH NAME
disorder-playrtp \- play DisOrder network broadcasts
.SH SYNOPSIS
.RI [[ GROUP ]
.IR PORT ]
.SH DESCRIPTION
.RI [[ GROUP ]
.IR PORT ]
.SH DESCRIPTION
-\fBdisorder-playrtp\fR plays a network broadcast sent from the specified
+\fBdisorder\-playrtp\fR plays a network broadcast sent from the specified
address.
.PP
If neither a group nor port are specified then the local DisOrder
address.
.PP
If neither a group nor port are specified then the local DisOrder
The default sound API is the first of the ones listed below that are available.
Usually this implies ALSA under Linux and Core Audio under OS X.
.TP
The default sound API is the first of the ones listed below that are available.
Usually this implies ALSA under Linux and Core Audio under OS X.
.TP
Use ALSA to play sound.
.TP
Use ALSA to play sound.
.TP
Use OSS to play sound.
.TP
Use OSS to play sound.
.TP
-.B --core-audio\fR, \fB-c
+.B \-\-core\-audio\fR, \fB\-c
Use Core Audio to play sound.
.TP
Use Core Audio to play sound.
.TP
-.B --device \fIDEVICE\fR, \fB-D \fIDEVICE\fR
+.B \-\-device \fIDEVICE\fR, \fB\-D \fIDEVICE\fR
Specifies the audio device to use.
The exact meaning of this is platform-dependent; on Linux it is the
ALSA device name.
.TP
Specifies the audio device to use.
The exact meaning of this is platform-dependent; on Linux it is the
ALSA device name.
.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
Set the configuration file.
The default is
.IR pkgconfdir/config .
.TP
-.B --socket \fIPATH\fR, \fB-s \fIPATH
+.B \-\-socket \fIPATH\fR, \fB\-s \fIPATH
Set the control socket.
Normally this would not be used manually.
.TP
Set the control socket.
Normally this would not be used manually.
.TP
Display a usage message.
.TP
Display a usage message.
.TP
+.B \-\-version\fR, \fB\-V
Display version number.
.SS "Buffer Control Options"
You shouldn't need to use these options.
.TP
Display version number.
.SS "Buffer Control Options"
You shouldn't need to use these options.
.TP
-.B --min \fIFRAMES\fR, \fB-m \fIFRAMES\fR
+.B \-\-min \fIFRAMES\fR, \fB\-m \fIFRAMES\fR
Specifies the buffer low watermark in frames.
If the number of frames falls below this value then playing will be
stopped until the buffer fills up.
.TP
Specifies the buffer low watermark in frames.
If the number of frames falls below this value then playing will be
stopped until the buffer fills up.
.TP
-.B --buffer \fIFRAMES\fR, \fB-b \fIFRAMES\fR
+.B \-\-buffer \fIFRAMES\fR, \fB\-b \fIFRAMES\fR
Specifies the buffer high watermark in frames.
Once there are this many frames in the buffer, playing will be (re-)started.
.TP
Specifies the buffer high watermark in frames.
Once there are this many frames in the buffer, playing will be (re-)started.
.TP
-.B --max \fIFRAMES\fR, \fB-x \fIFRAMES\fR
+.B \-\-max \fIFRAMES\fR, \fB\-x \fIFRAMES\fR
Specifies the maximum buffer size in frames.
If there are this many frames in the buffer then reading from the
network socket will be suspended.
Specifies the maximum buffer size in frames.
If there are this many frames in the buffer then reading from the
network socket will be suspended.
-The default is four times the \fB--buffer\fR value.
+The default is four times the \fB\-\-buffer\fR value.
-.B --rcvbuf \fIBYTES\fR, \fB-R \fIBYTES\fR
+.B \-\-rcvbuf \fIBYTES\fR, \fB\-R \fIBYTES\fR
Specifies socket receive buffer size.
The default is 131072 (128Kbytes).
The buffer size will not be reduced below the operating system's default.
.SH "REMOTE CONTROL"
The
Specifies socket receive buffer size.
The default is 131072 (128Kbytes).
The buffer size will not be reduced below the operating system's default.
.SH "REMOTE CONTROL"
The
option is used by Disobedience to control a background
option is used by Disobedience to control a background
daemon.
The socket will be created as a UNIX domain stream socket.
When a connection is received a single line is read from it.
daemon.
The socket will be created as a UNIX domain stream socket.
When a connection is received a single line is read from it.
to terminate.
.TP
.B query
to terminate.
.TP
.B query
.SH NAME
disorder-rescan \- DisOrder rescanner
.SH SYNOPSIS
.SH NAME
disorder-rescan \- DisOrder rescanner
.SH SYNOPSIS
.RI [ OPTIONS ]
.RI [ PATH ...]
.SH DESCRIPTION
.RI [ OPTIONS ]
.RI [ PATH ...]
.SH DESCRIPTION
is DisOrder's database rescanner.
It is invoked by DisOrder when necessary and does not need to be
invoked manually.
.SH OPTIONS
.TP
is DisOrder's database rescanner.
It is invoked by DisOrder when necessary and does not need to be
invoked manually.
.SH OPTIONS
.TP
-.B --config \fIPATH\fR, \fB-c \fIPATH
+.B \-\-config \fIPATH\fR, \fB\-c \fIPATH
Set the configuration file.
.TP
Set the configuration file.
.TP
Log to syslog.
This is the default if stderr is not a terminal.
.TP
Log to syslog.
This is the default if stderr is not a terminal.
.TP
Do not log to syslog.
This is the default if stderr is a terminal.
.TP
Do not log to syslog.
This is the default if stderr is a terminal.
.TP
Display a usage message.
.TP
Display a usage message.
.TP
+.B \-\-version\fR, \fB\-V
Display version number.
.SH "SEE ALSO"
\fBdisorderd\fR(8), \fBdisorder_config\fR(5)
Display version number.
.SH "SEE ALSO"
\fBdisorderd\fR(8), \fBdisorder_config\fR(5)
It is not intended for direct invocation.
.SH OPTIONS
.TP
It is not intended for direct invocation.
.SH OPTIONS
.TP
-.B --config \fIPATH\fR, \fB-c \fIPATH
+.B \-\-config \fIPATH\fR, \fB\-c \fIPATH
Set the configuration file.
.TP
Set the configuration file.
.TP
Log to syslog.
This is the default if stderr is not a terminal.
.TP
Log to syslog.
This is the default if stderr is not a terminal.
.TP
Do not log to syslog.
This is the default if stderr is a terminal.
.TP
Do not log to syslog.
This is the default if stderr is a terminal.
.TP
Display a usage message.
.TP
Display a usage message.
.TP
+.B \-\-version\fR, \fB\-V
Display version number.
.SH "SEE ALSO"
.BR disorderd (8)
Display version number.
.SH "SEE ALSO"
.BR disorderd (8)
.SH NAME
disorder-stats \- DisOrder statistics
.SH SYNOPSIS
.SH NAME
disorder-stats \- DisOrder statistics
.SH SYNOPSIS
.RI [ OPTIONS ]
.SH DESCRIPTION
.RI [ OPTIONS ]
.SH DESCRIPTION
reports server statistics.
It is used by the server and would not normally be invoked manually.
.SH OPTIONS
.TP
reports server statistics.
It is used by the server and would not normally be invoked manually.
.SH OPTIONS
.TP
-.B --config \fIPATH\fR, \fB-c \fIPATH
+.B \-\-config \fIPATH\fR, \fB\-c \fIPATH
Set the configuration file.
.TP
Set the configuration file.
.TP
Log to syslog.
This is the default if stderr is not a terminal.
.TP
Log to syslog.
This is the default if stderr is not a terminal.
.TP
Do not log to syslog.
This is the default if stderr is a terminal.
.TP
Do not log to syslog.
This is the default if stderr is a terminal.
.TP
Display a usage message.
.TP
Display a usage message.
.TP
+.B \-\-version\fR, \fB\-V
Display version number.
.SH "SEE ALSO"
\fBdisorderd\fR(8), \fBdisorder_config\fR(5)
Display version number.
.SH "SEE ALSO"
\fBdisorderd\fR(8), \fBdisorder_config\fR(5)
.SH SYNOPSIS
.B disorder
.RI [ OPTIONS ]
.SH SYNOPSIS
.B disorder
.RI [ OPTIONS ]
.RI [ COMMANDS ...]
.SH DESCRIPTION
.B disorder
.RI [ COMMANDS ...]
.SH DESCRIPTION
.B disorder
Otherwise, it executes the commands specified.
.SH OPTIONS
.TP
Otherwise, it executes the commands specified.
.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
Set the configuration file.
The default is
.IR pkgconfdir/config .
.TP
Display a usage message.
.TP
Display a usage message.
.TP
+.B \-\-version\fR, \fB\-V
Display version number.
.TP
Display version number.
.TP
-.B --help-commands\fR, \fB-H
+.B \-\-help\-commands\fR, \fB\-H
List all known commands.
.SH COMMANDS
.TP
List all known commands.
.SH COMMANDS
.TP
.B get \fITRACK\fR \fIKEY\fR
Display the preference \fIKEY\fR for \fITRACK\fR.
.TP
.B get \fITRACK\fR \fIKEY\fR
Display the preference \fIKEY\fR for \fITRACK\fR.
.TP
+.B get\-global \fIKEY\fR
Get a global preference.
.TP
Get a global preference.
.TP
Display the current volume settings.
.TP
.B length \fITRACK\fR
Display the current volume settings.
.TP
.B length \fITRACK\fR
values towards the tail.
.IP
Note that if you specify a negative value then the
values towards the tail.
.IP
Note that if you specify a negative value then the
option separate (before all commands) becomes mandatory, as otherwise the
negative value is misinterpreted an an option.
.TP
option separate (before all commands) becomes mandatory, as otherwise the
negative value is misinterpreted an an option.
.TP
List the current queue.
The first entry in the list is the next track to play.
.TP
List the current queue.
The first entry in the list is the next track to play.
.TP
Enable random play.
.TP
.B recent
Enable random play.
.TP
.B recent
.B resume
Resume the current track after a pause.
.TP
.B resume
Resume the current track after a pause.
.TP
Report the RTP brodcast address used by the server (if any).
.TP
.B scratch
Scratch the currently playing track.
.TP
Report the RTP brodcast address used by the server (if any).
.TP
.B scratch
Scratch the currently playing track.
.TP
Scratch the currently playing track, provided it has the given ID.
.TP
.B search \fITERMS\fR
Scratch the currently playing track, provided it has the given ID.
.TP
.B search \fITERMS\fR
.B set \fITRACK\fR \fIKEY\fR \fIVALUE\fR
Set the preference \fIKEY\fR for \fITRACK\fR to \fIVALUE\fR.
.TP
.B set \fITRACK\fR \fIKEY\fR \fIVALUE\fR
Set the preference \fIKEY\fR for \fITRACK\fR to \fIVALUE\fR.
.TP
-.B set-global \fIKEY\fR \fIVALUE\fR
+.B set\-global \fIKEY\fR \fIVALUE\fR
Set a global preference.
.TP
Set a global preference.
.TP
-.B set-volume \fBLEFT\fR \fBRIGHT\fR
+.B set\-volume \fBLEFT\fR \fBRIGHT\fR
-.B setup-guest \fR[\fB--no-online-registration\fR]
+.B setup\-guest \fR[\fB\-\-no\-online\-registration\fR]
Create the "guest" user for use by the web interface.
This user will have no password and will only have the "read" and
"register" rights, the latter allowing new users to automatically
register themselves via the web interface.
.IP
Create the "guest" user for use by the web interface.
This user will have no password and will only have the "read" and
"register" rights, the latter allowing new users to automatically
register themselves via the web interface.
.IP
-With the option \fB--no-online-registration\fR, the "register" right is
+With the option \fB\-\-no-online\-registration\fR, the "register" right is
suppressed and users must be manually created by an administrator.
.IP
If online registration is desired then \fBmail_sender\fR must be set in the
suppressed and users must be manually created by an administrator.
.IP
If online registration is desired then \fBmail_sender\fR must be set in the
.B unset \fITRACK\fR \fIKEY\fR
Unset the preference \fIKEY\fR for \fITRACK\fR.
.TP
.B unset \fITRACK\fR \fIKEY\fR
Unset the preference \fIKEY\fR for \fITRACK\fR.
.TP
-.B unset-global \fIKEY\fR
+.B unset\-global \fIKEY\fR
Unset the global preference \fIKEY\fR.
.TP
.B userinfo \fIUSER PROPERTY
Unset the global preference \fIKEY\fR.
.TP
.B userinfo \fIUSER PROPERTY
Leading and trailing spaces are not significant but internal spaces are.
.IP
Using the
Leading and trailing spaces are not significant but internal spaces are.
.IP
Using the
global preferences, it is possible to limit the tracks that will be selected at
random.
.TP
global preferences, it is possible to limit the tracks that will be selected at
random.
.TP
.IP
\fIENCODING\fR defines the encoding of filenames in this collection.
For \fBfs\fR this would be the encoding you use for filenames.
.IP
\fIENCODING\fR defines the encoding of filenames in this collection.
For \fBfs\fR this would be the encoding you use for filenames.
-Examples might be \fBiso-8859-1\fR or \fButf-8\fR.
+Examples might be \fBiso\-8859\-1\fR or \fButf\-8\fR.
If no encoding is specified then the current locale's character encoding
is used.
.IP
If no encoding is specified then the current locale's character encoding
is used.
.IP
tracks.
The default is 31.
.TP
tracks.
The default is 31.
.TP
-.B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB--\fR]] \fIARGS\fR...
+.B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB\-\-\fR]] \fIARGS\fR...
Specifies the player for files matching the glob \fIPATTERN\fR.
\fIMODULE\fR specifies which plugin module to use.
.IP
The following options are supported:
.RS
.TP
Specifies the player for files matching the glob \fIPATTERN\fR.
\fIMODULE\fR specifies which plugin module to use.
.IP
The following options are supported:
.RS
.TP
-.B --wait-for-device\fR[\fB=\fIDEVICE\fR]
+.B \-\-wait\-for\-device\fR[\fB=\fIDEVICE\fR]
Waits (for up to a couple of seconds) for the default, or specified, libao
device to become openable.
.TP
Waits (for up to a couple of seconds) for the default, or specified, libao
device to become openable.
.TP
Defines the end of the list of options.
Defines the end of the list of options.
-Needed if the first argument to the plugin starts with a "-".
+Needed if the first argument to the plugin starts with a "\-".
.RE
.IP
The following are the standard modules:
.RE
.IP
The following are the standard modules:
or \fBInterrupted\fR or whatever.
.TP
.B sox_generation \fB0\fR|\fB1
or \fBInterrupted\fR or whatever.
.TP
.B sox_generation \fB0\fR|\fB1
-Determines whether calls to \fBsox\fR(1) should use \fB-b\fR, \fB-x\fR, etc (if
-the generation is 0) or \fB-\fIbits\fR, \fB-L\fR etc (if it is 1).
+Determines whether calls to \fBsox\fR(1) should use \fB\-b\fR, \fB\-x\fR, etc (if
+the generation is 0) or \fB\-\fIbits\fR, \fB\-L\fR etc (if it is 1).
See the documentation for your installed copy of \fBsox\fR to determine
which you need.
The default is 0.
See the documentation for your installed copy of \fBsox\fR to determine
which you need.
The default is 0.
Specify username.
The default is taken from the environment variable \fBLOGNAME\fR.
.SH "GLOBAL PREFERENCES"
Specify username.
The default is taken from the environment variable \fBLOGNAME\fR.
.SH "GLOBAL PREFERENCES"
-These are the values set with \fBset-global\fR.
+These are the values set with \fBset\-global\fR.
If this is set an nonempty then randomly played tracks will always have at
least one of the listed tags.
.TP
If this is set an nonempty then randomly played tracks will always have at
least one of the listed tags.
.TP
If this is set an nonempty then randomly played tracks will never have any of
the listed tags.
.TP
If this is set an nonempty then randomly played tracks will never have any of
the listed tags.
.TP
Otherwise it is disabled.
Use \fBdisable\fR rather than setting it directly.
.TP
Otherwise it is disabled.
Use \fBdisable\fR rather than setting it directly.
.TP
If unset or \fByes\fR then random play is enabled.
Otherwise it is disabled.
Use \fBdisable\fR rather than setting it directly.
If unset or \fByes\fR then random play is enabled.
Otherwise it is disabled.
Use \fBdisable\fR rather than setting it directly.
the current track.
The track at the head of the queue comes first.
.TP
the current track.
The track at the head of the queue comes first.
.TP
Expands to \fBtrue\fR if random play is currently enabled, otherwise to
\fBfalse\fR.
.TP
Expands to \fBtrue\fR if random play is currently enabled, otherwise to
\fBfalse\fR.
.TP
If you use \fBsort\fR for artist and album then you are likely to get
strange effects.
.TP
If you use \fBsort\fR for artist and album then you are likely to get
strange effects.
.TP
Expands to the server's version string.
.TP
.B @shell{\fICOMMAND\fB}@
Expands to the server's version string.
.TP
.B @shell{\fICOMMAND\fB}@
.IP
This is the default if \fBaction\fR is missing.
.TP
.IP
This is the default if \fBaction\fR is missing.
.TP
Disables random play.
.TP
Disables random play.
.TP
Enables random play.
.TP
.B "disable"
Enables random play.
.TP
.B "disable"
name and \fBext\fR which is the filename extension, including the initial dot
(or the empty string if there is not extension).
.SH "SEE ALSO"
name and \fBext\fR which is the filename extension, including the initial dot
(or the empty string if there is not extension).
.SH "SEE ALSO"
-\fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder-dump\fR(8),
+\fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder\-dump\fR(8),
\fBpcrepattern\fR(3)
.\" Local Variables:
.\" mode:nroff
\fBpcrepattern\fR(3)
.\" Local Variables:
.\" mode:nroff
This command can be used without logging in.
.TP
.B cookie \fICOOKIE
This command can be used without logging in.
.TP
.B cookie \fICOOKIE
-Log a user back in using a cookie created with \fBmake-cookie\fR.
+Log a user back in using a cookie created with \fBmake\-cookie\fR.
The response contains the username.
.TP
.B deluser \fIUSERNAME
The response contains the username.
.TP
.B deluser \fIUSERNAME
.IP
If the track or preference do not exist then the response code is 555.
.TP
.IP
If the track or preference do not exist then the response code is 555.
.TP
+.B get\-global \fIKEY\fR
Get a global preference.
.IP
If the preference does not exist then the response code is 555.
Get a global preference.
.IP
If the preference does not exist then the response code is 555.
.IP
See \fBEVENT LOG\fR below for more details.
.TP
.IP
See \fBEVENT LOG\fR below for more details.
.TP
Returns an opaque string that can be used by the \fBcookie\fR command to log
this user back in on another connection (until the cookie expires).
.TP
Returns an opaque string that can be used by the \fBcookie\fR command to log
this user back in on another connection (until the cookie expires).
.TP
at the head of the queue (i.e. next to be be played) first.
See below for the track information syntax.
.TP
at the head of the queue (i.e. next to be be played) first.
See below for the track information syntax.
.TP
Disable random play (but don't stop the current track).
Requires the \fBglobal prefs\fR right.
.TP
Disable random play (but don't stop the current track).
Requires the \fBglobal prefs\fR right.
.TP
Enable random play.
Requires the \fBglobal prefs\fR right.
.TP
Enable random play.
Requires the \fBglobal prefs\fR right.
.TP
Report whether random play is enabled.
The second field of the response line will be \fByes\fR or \fBno\fR.
.TP
Report whether random play is enabled.
The second field of the response line will be \fByes\fR or \fBno\fR.
.TP
Requires the \fBpause\fR right.
.TP
.B revoke \fBcookie\fR
Requires the \fBpause\fR right.
.TP
.B revoke \fBcookie\fR
-Revoke a cookie previously created with \fBmake-cookie\fR.
+Revoke a cookie previously created with \fBmake\-cookie\fR.
It will not be possible to use this cookie in the future.
.TP
It will not be possible to use this cookie in the future.
.TP
Report the RTP broadcast (or multicast) address, in the form \fIADDRESS
PORT\fR.
This command does not require authentication.
Report the RTP broadcast (or multicast) address, in the form \fIADDRESS
PORT\fR.
This command does not require authentication.
Set a preference.
Requires the \fBprefs\fR right.
.TP
Set a preference.
Requires the \fBprefs\fR right.
.TP
-.B set-global \fIKEY\fR \fIVALUE\fR
+.B set\-global \fIKEY\fR \fIVALUE\fR
Set a global preference.
Requires the \fBglobal prefs\fR right.
.TP
Set a global preference.
Requires the \fBglobal prefs\fR right.
.TP
Unset a preference.
Requires the \fBprefs\fR right.
.TP
Unset a preference.
Requires the \fBprefs\fR right.
.TP
-.B \fBunset-global\fR \fIKEY\fR
+.B \fBunset\-global\fR \fIKEY\fR
Unset a global preference.
Requires the \fBglobal prefs\fR right.
.TP
Unset a global preference.
Requires the \fBglobal prefs\fR right.
.TP
concerning what is to be played.
.SH OPTIONS
.TP
concerning what is to be played.
.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 .
Set the configuration file.
The default is
.IR pkgconfdir/config .
.BR disorder_config (5)
for further information.
.TP
.BR disorder_config (5)
for further information.
.TP
-.B --pidfile \fIPATH\fR, \fB-P \fIPATH
+.B \-\-pidfile \fIPATH\fR, \fB\-P \fIPATH
-.B --foreground\fR, \fB-f
+.B \-\-foreground\fR, \fB\-f
Run in the foreground.
(By default,
.B disorderd
detaches from its terminal and runs in the background.)
.TP
Run in the foreground.
(By default,
.B disorderd
detaches from its terminal and runs in the background.)
.TP
+.B \-\-syslog\fR, \fB\-s
Log to syslog.
This is the default if DisOrder runs in the background.
.TP
Log to syslog.
This is the default if DisOrder runs in the background.
.TP
Display a usage message.
.TP
Display a usage message.
.TP
+.B \-\-version\fR, \fB\-V
Display version number.
.SH NOTES
For configuration file documentation, see
Display version number.
.SH NOTES
For configuration file documentation, see
startup).
.PP
It is suggested that instead you just back up the output of
startup).
.PP
It is suggested that instead you just back up the output of
which saves only the parts of the database that cannot be regenerated
automatically, and thus has relatively modest storage requirements.
.SH SIGNALS
which saves only the parts of the database that cannot be regenerated
automatically, and thus has relatively modest storage requirements.
.SH SIGNALS
Current locale.
See \fBlocale\fR(7).
.SH "SEE ALSO"
Current locale.
See \fBlocale\fR(7).
.SH "SEE ALSO"
-\fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorder-dump\fR(8)
+\fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorder\-dump\fR(8)
.\" Local Variables:
.\" mode:nroff
.\" End:
.\" Local Variables:
.\" mode:nroff
.\" End:
.SH OPTIONS
.SS "Filename Format"
.TP
.SH OPTIONS
.SS "Filename Format"
.TP
-.B --from\fI ENCODING\fR, \fB-f\fI ENCODING
+.B \-\-from\fI ENCODING\fR, \fB\-f\fI ENCODING
Specifies the filename encoding used below
.IR SOURCE .
.TP
Specifies the filename encoding used below
.IR SOURCE .
.TP
-.B --to\fI ENCODING\fR, \fB-t\fI ENCODING
+.B \-\-to\fI ENCODING\fR, \fB\-t\fI ENCODING
Specifies the filename encoding used below
.IR DESTINATION .
.PP
Specifies the filename encoding used below
.IR DESTINATION .
.PP
-If neither of \fB--from\fR or \fB--to\fR are specified then no encoding
+If neither of \fB\-\-from\fR or \fB\-\-to\fR are specified then no encoding
translation is performed.
If only one is specified then the other is set to the current locale.
.TP
translation is performed.
If only one is specified then the other is set to the current locale.
.TP
-.B --windows-friendly\fR, \fB-w
+.B \-\-windows\-friendly\fR, \fB\-w
Specifies that filenames below
.I DESTINATION
must be Windows-friendly.
Specifies that filenames below
.I DESTINATION
must be Windows-friendly.
spaces.
.SS "File Selection"
.TP
spaces.
.SS "File Selection"
.TP
-.B --include\fI PATTERN\fR, \fB-i\fI PATTERN
+.B \-\-include\fI PATTERN\fR, \fB\-i\fI PATTERN
Include filenames matching the glob pattern \fIPATTERN\fR.
.TP
Include filenames matching the glob pattern \fIPATTERN\fR.
.TP
-.B --exclude\fI PATTERN\fR, \fB-e\fI PATTERN
+.B \-\-exclude\fI PATTERN\fR, \fB\-e\fI PATTERN
Exclude filenames matching the glob pattern \fIPATTERN\fR.
.PP
These options may be used more than once.
They will be checked in order and the first that matches any given
filename will determine whether that file is included or excluded.
.PP
Exclude filenames matching the glob pattern \fIPATTERN\fR.
.PP
These options may be used more than once.
They will be checked in order and the first that matches any given
filename will determine whether that file is included or excluded.
.PP
-If none of the options match and \fB--include\fR was used at all then the file
+If none of the options match and \fB\-\-include\fR was used at all then the file
-If none of the options match and \fB--include\fR was never used then the file
+If none of the options match and \fB\-\-include\fR was never used then the file
is included.
.SS "File Copying"
.TP
is included.
.SS "File Copying"
.TP
Files are hard-linked to their destination location.
This is the default action.
.TP
Files are hard-linked to their destination location.
This is the default action.
.TP
+.B \-\-symlink\fR, \fB\-s
Symlinks are made in the destination location pointing back into the source
directory.
.TP
Symlinks are made in the destination location pointing back into the source
directory.
.TP
Files are copied into their destination location.
.TP
Files are copied into their destination location.
.TP
-.B --no-action\fR, \fB-n
+.B \-\-no\-action\fR, \fB\-n
The destination location is not modified in any way.
Instead a report is written to standard output saying what would be done.
.SS "Other"
.TP
The destination location is not modified in any way.
Instead a report is written to standard output saying what would be done.
.SS "Other"
.TP
Display a usage message.
.TP
Display a usage message.
.TP
+.B \-\-version\fR, \fB\-V
Display version number.
.\" Local Variables:
.\" mode:nroff
Display version number.
.\" Local Variables:
.\" mode:nroff
track to be played at the top.
.SH OPTIONS
.TP
track to be played at the top.
.SH OPTIONS
.TP
Display a usage message.
.TP
Display a usage message.
.TP
+.B \-\-version\fR, \fB\-V
Display version number.
.SH "SEE ALSO"
\fBdisorder\fR(1), \fBdisobedience\fR(1), \fBdisorder_config\fR(5)
Display version number.
.SH "SEE ALSO"
\fBdisorder\fR(1), \fBdisobedience\fR(1), \fBdisorder_config\fR(5)
~mdw / disorder / commitdiff